List payouts

GET 
/openapi/2025-06/shoplazza-payment/payout/details

Returns a paginated list of payout detail records, optionally filtered by currency, region, and creation time range.

Request

Query Parameters

cursor string

Cursor for pagination

page_size int32

Page size (1-100, default 10)

currency string

Currency of the payout account. Defaults to the merchant's default currency. Must match the specified region

created_at_min string

Filter payout records created at or after this Unix timestamp (e.g., 1730548810)

created_at_max string

Filter payout records created at or before this Unix timestamp (e.g., 1730548810)

region string

Region of the merchant account (e.g., US, HK). Defaults to the merchant's default region

Responses

200

OK

application/json

Schema

Schema

codestring

error code

messagestring

error message

data object

list object[]

List of payout detail records

Array [

idstring

Payout record ID

store_idstring

Store ID associated with the payout

created_atstring

Creation time of the payout record (Unix timestamp)

statusstring

Status of the payout record. Possible values: completed, pending, failed

currencystring

Currency of the payout

amountstring

Total amount of the payout

bank_namestring

Bank name associated with the payout

last4string

Last 4 digits of the bank account number

routing_numberstring

Routing number of the bank account

]

cursorstring

Cursor for pagination

has_moreboolean

Whether there are more records

Example

{
  "code": "string",
  "message": "string",
  "data": {
    "list": [
      {
        "id": "string",
        "store_id": "string",
        "created_at": "string",
        "status": "string",
        "currency": "string",
        "amount": "string",
        "bank_name": "string",
        "last4": "string",
        "routing_number": "string"
      }
    ],
    "cursor": "string",
    "has_more": true
  }
}