List Payouts

Retrieve single or batch payout transactions with cursor-based pagination. Filter records by transaction type, status, and a required creation-time range of up to 100 days.
Request Parameters
typestring
required
Type of payout transaction to return.

Valid Values:

SINGLE — A single payout.
BATCH — A batch payout.
statusstring
Transaction status filter. For SINGLE, see Payout Status. For BATCH, see BatchPayoutStatus. Omit this field to return transactions in any status.
fromCreatedAtdatetime
required
Start of the creation-time range, in ISO 8601 extended format. Provide together with toCreatedAt; the range must not exceed 100 days. See Data Types.
toCreatedAtdatetime
required
End of the creation-time range, in ISO 8601 extended format. Provide together with fromCreatedAt; the range must not exceed 100 days. See Data Types.
limitinteger
Number of results per page. Value range: 1–100. Defaults to 20 if omitted.
cursorstring
Pagination cursor returned in nextCursor or prevCursor. Omit this field for the first request.
Response Parameters
resultResult
See Result.
itemsarray
Payout transactions matching the filters. Each item is discriminated by its type field. - When type is SINGLE, the item follows the Query a Payout response schema. - When type is BATCH, the item follows the Query a Batch Payout response schema.
nextCursorstring
Cursor for retrieving the next page. Returned when another page is available.
prevCursorstring
Cursor for retrieving the previous page. Returned when a previous page is available.
Error Codes
resultCoderesultStatusresultMessageTroubleshooting
SUCCESSSSuccessN/A
PARAM_ILLEGALFIllegal parameters exist.Check that `limit` is between 1 and 100, `type` is valid, and the `fromCreatedAt`–`toCreatedAt` interval spans no more than 100 days in ISO 8601 format.
Definition
POST /api/open/v1/payouts/list
Request
{
"limit": 20,
"type": "BATCH",
"fromCreatedAt": "2026-08-08T00:00:00+08:00",
"toCreatedAt": "2026-08-08T23:59:59+08:00",
"status": "SUCCESS"
}
Response
{
"result": {
  "resultCode": "SUCCESS",
  "resultMessage": "success",
  "resultStatus": "S"
},
"items": [
  {
    "type": "BATCH",
    "id": "20260808BATCH00001",
    "status": "COMPLETED",
    "createdAt": "2026-08-08T09:15:00+08:00",
    "updatedAt": "2026-08-09T10:30:00+08:00",
    "submittedAt": "2026-08-08T14:00:00+08:00",
    "completedAt": "2026-08-09T10:30:00+08:00",
    "batchName": "Aug 8 supplier payouts",
    "requiresApproval": true,
    "totalItemCount": 3,
    "validItemCount": 2,
    "calculationSummary": {
      "lastCalculatedAt": "2026-08-08T13:55:00+08:00",
      "currencyPairs": [
        {
          "currencyPair": "USD/USD",
          "clientRate": "1.000000",
          "sourceAmount": {
            "currency": "USD",
            "value": "5000.00"
          },
          "payoutAmount": {
            "currency": "USD",
            "value": "5000.00"
          },
          "feeRate": "0.001",
          "feeAmount": {
            "currency": "USD",
            "value": "5.00"
          },
          "feeItemList": [
            {
              "feeItemType": "PAYOUT_SERVICE_FEE",
              "feeItemAmount": {
                "currency": "USD",
                "value": "5.00"
              }
            }
          ]
        },
        {
          "currencyPair": "USD/EUR",
          "clientRate": "0.923400",
          "sourceAmount": {
            "currency": "USD",
            "value": "3000.00"
          },
          "payoutAmount": {
            "currency": "EUR",
            "value": "2770.20"
          },
          "feeRate": "0.0005",
          "feeAmount": {
            "currency": "USD",
            "value": "1.50"
          },
          "feeItemList": [
            {
              "feeItemType": "PAYOUT_SERVICE_FEE",
              "feeItemAmount": {
                "currency": "USD",
                "value": "1.50"
              }
            }
          ],
          "originalFeeRate": "0.001",
          "originalFeeAmount": {
            "currency": "USD",
            "value": "3.00"
          },
          "promotionList": [
            {
              "promotionName": "August Fee Discount",
              "promotionType": "FEE_DISCOUNT",
              "activeTime": "2026-08-01T00:00:00+08:00",
              "expiredTime": "2026-08-31T23:59:59+08:00"
            }
          ]
        }
      ]
    }
  }
],
"nextCursor": "eyJnbXRDcmVhdGUiOjE3NTQ2MDQ4MDAsIm9yZGVySWQiOiIyMDI2MDgwODAwMDAxIn0="
}