**Version: 202601**

# List payment orders

**GET** `/openapi/2026-01/shoplazza-payment/payment-orders`

Returns a paginated list of payment orders, optionally filtered by status and creation time range.

## Request

**Query Parameters**

- `cursor` string

  Cursor for pagination
- `page_size` int32

  Page size (1-100, default 10)
- `created_at_min` string

  Filter payment orders created at or after this Unix timestamp (e.g., 1730548810)
- `created_at_max` string

  Filter payment orders created at or before this Unix timestamp (e.g., 1730548810)
- `status` string

  Filter payment orders by status:

  *   `succeeded`: payment completed successfully and funds are confirmed
  *   `failed`: payment failed and funds were not processed
  *   `requires_action`: additional action required to complete the payment (e.g., 3D Secure verification)
  *   `init`: payment order created but not yet processed
  *   `canceled`: payment order canceled; funds were not processed or have been returned
  *   `processing`: payment is being processed; final result pending

## Responses

**200**

OK

**application/json**

**Schema | Example**

**Schema**

- `code` string

  error code
- `message` string

  error message
- `data` object

  - `list` object[]

    List of payment order records

    *   Array \[

    - `id` string

      Payment order ID
    - `fee_details` object

      Breakdown of transaction fees charged on this payment order

      - `trans_fee_amount` string

        Transaction fee amount charged on the payment order
      - `fee_currency` string

        Currency code of the transaction fee (e.g., USD, EUR)
      - `foreign_settlement_fee` string

        Foreign settlement fee charged when settling across regions or currencies
    - `created_at` string

      Time when the payment order was created (e.g., 2018-11-02T12:30:10Z)
    - `finished_at` string

      Time when the payment order reached its final state (e.g., 2018-11-02T12:30:10Z)
    - `payment_status` string

      Current payment status of the order:

      *   `succeeded`: payment completed successfully and funds are confirmed
      *   `failed`: payment failed and funds were not processed
      *   `requires_action`: additional action required to complete the payment (e.g., 3D Secure verification)
      *   `init`: payment order created but not yet processed
      *   `canceled`: payment order canceled; funds were not processed or have been returned
      *   `processing`: payment is being processed; final result pending
    - `payment_method` string

      Payment method used for the order (e.g., credit card, PayPal)
    - `card_brand` string

      Brand of the credit card used for the payment (e.g., Visa, Mastercard)
    - `pay_currency` string

      Currency in which the shopper paid (e.g., USD, EUR)
    - `pay_amount` string

      Amount paid by the shopper in pay\_currency
    - `converted_amount` string

      Payment amount converted into the store's base currency
    - `reserve_amount` string

      Reserve amount
    - `order_id` string

      Identifier of the order this payment is associated with
    - `fee_amount` string

      Total service charge amount for this payment order
    *   \]
  - `cursor` string

    Cursor for pagination
  - `has_more` boolean

    Whether there are more records

```json
{
  "code": "string",
  "message": "string",
  "data": {
    "list": [
      {
        "id": "string",
        "fee_details": {
          "trans_fee_amount": "string",
          "fee_currency": "string",
          "foreign_settlement_fee": "string"
        },
        "created_at": "string",
        "finished_at": "string",
        "payment_status": "string",
        "payment_method": "string",
        "card_brand": "string",
        "pay_currency": "string",
        "pay_amount": "string",
        "converted_amount": "string",
        "reserve_amount": "string",
        "order_id": "string",
        "fee_amount": "string"
      }
    ],
    "cursor": "string",
    "has_more": true
  }
}
```