v1

latestOpenAPI 3.1.0UNLICENSED2026-07-2613101.1 MB
Payment purposes

List payment purposes

Returns a list of payment purposes based on the recipient's country and currency

get/payment-purposes

Query parameters

accountIdstring required

The ID of the account to work with.

Example:F50091
currencyCodestring required

The currency code, in ISO-4217 format.

Example:USD
countryCodestring required

The country code, in ISO-3166 format.

Example:GB
recipientType'business' | 'charity' | 'individual' required

The type of the recipient.

Example:business

Response

OK

Example response

{
  "rows": [
    {
      "defaultPurpose": "Commission",
      "additionalPurpose": "string",
      "defaultCode": "string"
    }
  ]
}