Payment purposes

List payment purposes

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

get/payment-purposes

Request

Base URL
https://api.equalsmoney.com/v2
Auth
API key in header Authorization
TypeScript
https://skmtc.dev/equalsmoney/apis/cis-api/docs/payment-purposes/get.ts
A function with typed inputs. Its response is checked against the schema.

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

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

No recorded changes to this operation across all 1 revision of this API.