List Payment Orders

GET 
/openapi/2024-07/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, use the cursor from the response for pagination

limit int32

A limit on the number of objects to be returned. Limit can range between 1 and 100, and the default is 10.

created_at_min string

Filter option: created_at, in Unix timestamp

created_at_max string

Filter option: created_at, in Unix timestamp

status string

succeeded: The payment has been completed successfully, and the funds are confirmed. failed: The payment has failed, and the funds were not successfully processed. requires_action: Additional action is required to complete the payment, such as user verification (e.g., 3D authentication) or additional information. init: The payment order has been created but not yet processed. canceled: The payment order has been canceled, and no funds were processed or they have been returned. processing: The payment is currently in process, with the final result pending confirmation.

Responses

200

OK

application/json

Schema

Schema

codestring

error code

messagestring

error message

data object

Response: Payment order list

has_moreboolean

Whether there is more data

list object[]

List of payment orders

Array [

idstring

Payment order ID

fee_details object

Fee details

trans_fee_amountstring

Acquiring fee amount

fee_currencystring

Fee currency

foreign_settlement_feestring

Foreign settlement fee

created_atstring

Creation time, in Unix timestamp

finished_atstring

Payment completion time, in Unix timestamp

payment_statusstring

Payment status (e.g., "succeeded", "failed","requires_action","init","canceled","processing") succeeded: The payment has been completed successfully, and the funds are confirmed. failed: The payment has failed, and the funds were not successfully processed. requires_action: Additional action is required to complete the payment, such as user verification (e.g., 3D authentication) or additional information. init: The payment order has been created but not yet processed. canceled: The payment order has been canceled, and no funds were processed or they have been returned. processing: The payment is currently in process, with the final result pending confirmation.

payment_methodstring

Payment method

card_brandstring

Card brand (e.g., Visa, Mastercard)

pay_currencystring

Transaction currency

pay_amountstring

Transaction amount in the original currency

converted_amountstring

Amount after currency conversion

reserve_amountstring

Frozen reserve amount

order_idstring

Order number

]

cursorstring

cursor for pagination

Example

json

{
  "code": "string",
  "message": "string",
  "data": {
    "has_more": true,
    "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"
      }
    ],
    "cursor": "string"
  }
}

422

invalid parameter

application/json

Schema

Schema

codestring

error code

messagestring

error message

Example

json

{
  "code": "string",
  "message": "string"
}

Example

json

{
  "code": "InvalidParameter",
  "message": "wrong cursor"
}