v1

latestOpenAPI 3.0.12026-07-24128351404.9 KB

Payouts

List all payee bank accounts

Retrieves a paginated list of all payee bank accounts under the current user.

get/open-api/v3/payees

Query parameters

accountIdstring required

The UUID of the account.

limitstring number

Limits the number of items to be returned.

pagestring number

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

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

Currency code.

Example:USD

Currency code.

userNamestring

Recipient's username, automatically generated by concatenating first name and last name. Example: JohnSmith

Example:JohnSmith

Recipient's username, automatically generated by concatenating first name and last name. Example: JohnSmith

Response

codestring

Error code

messagestring

Error message

Example response

{
  "code": "400001",
  "message": "Invalid parameter",
  "data": {
    "list": [
      {
        "userName": "JohnSmith",
        "payeeAddress": {
          "addressLine1": "123 Main St",
          "addressLine2": "Apt 4B",
          "city": "New York",
          "country": "US",
          "postalCode": "10001"
        }
      }
    ]
  }
}