v1

latestOpenAPI 3.0.12026-07-24128351404.9 KB
Payouts

Get required fields for a payee

Get the required fields for making payments to corporate or individual bank accounts in various countries and currencies

get/open-api/v3/payees/required-fields

Query parameters

paymentType'COMPANY' | 'INDIVIDUAL' required

Payment to company or individual bank account.

Example:COMPANY

Payment to company or individual bank account.

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

Currency code.

Example:USD

Currency code.

countrystring required

Country code. Formatted as a two-letter country code specified in ISO 3166-1 alpha-2.

Example:US

Country code. Formatted as a two-letter country code specified in ISO 3166-1 alpha-2.

Response

OK

codestring

Error code

messagestring

Error message

Example response

{
  "code": "400001",
  "message": "Invalid parameter"
}