List payment purposes

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

SecurityCommonAuth
Request
query Parameters
accountId
required
string

The ID of the account to work with.

Example: accountId=F50091
currencyCode
required
string^[A-Z]{3}$

The currency code, in ISO-4217 format.

Example: currencyCode=USD
countryCode
required
string^[A-Z]{2}$

The country code, in ISO-3166 format.

Example: countryCode=GB
recipientType
required
string

The type of the recipient.

Enum: "business" "charity" "individual"
Example: recipientType=business
Responses
200

OK

get/payment-purposes
Request samples 
Response samples 
application/json
{
  • "rows": [
    ]
}