List payment orders

GET 
/openapi/2025-06/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

Schema

codestring

error code

messagestring

error message

data object

list object[]

List of payment order records

Array [

idstring

Payment order ID

fee_details object

Breakdown of transaction fees charged on this payment order

trans_fee_amountstring

Transaction fee amount charged on the payment order

fee_currencystring

Currency code of the transaction fee (e.g., USD, EUR)

foreign_settlement_feestring

Foreign settlement fee charged when settling across regions or currencies

created_atstring

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

finished_atstring

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

payment_statusstring

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_methodstring

Payment method used for the order (e.g., credit card, PayPal)

card_brandstring

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

pay_currencystring

Currency in which the shopper paid (e.g., USD, EUR)

pay_mountstring

Amount paid by the shopper in pay_currency

converted_amountstring

Payment amount converted into the store's base currency

reserve_amountstring

Reserve amount

order_idstring

Identifier of the order this payment is associated with

fee_amountstring

Total service charge amount for this payment order

]

cursorstring

Cursor for pagination

has_moreboolean

Whether there are more records

Example

{
  "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_mount": "string",
        "converted_amount": "string",
        "reserve_amount": "string",
        "order_id": "string",
        "fee_amount": "string"
      }
    ],
    "cursor": "string",
    "has_more": true
  }
}