v1

latestOpenAPI 3.0.12026-07-24128351404.9 KB
Payouts

List all payouts

Retrieves a list of all payout transactions for the current user, optionally supporting pagination and filtering.

get/open-api/v3/payments

Query parameters

limitstring number

Limits the number of items to be returned.

Limits the number of items to be returned.

pagestring number

The page to be returned, counting from 1 as the first page.

The page to be returned, counting from 1 as the first page.

accountIdstring required

The UUID of the account.

The UUID of the account.

idstring

Id

Id

currency'CNH' | 'USD' | 'HKD' | 'GBP' | 'EUR' | 'AUD' | 'AED' | 'ILS' | 'CAD' | 'SGD' | 'MYR' | 'JPY' | 'IDR'

Currency code.

Example:USD

Currency code.

clientTransactionIdstring

Client transaction id (Idempotent ID)

Client transaction id (Idempotent ID)

Response

OK

codestring

Error code

messagestring

Error message

Example response

{
  "code": "400001",
  "message": "Invalid parameter",
  "data": {
    "list": [
      {
        "fees": [
          {
            "amount": "3.14"
          }
        ]
      }
    ]
  }
}