Skip to main content
GET
/
payment-purposes
List payment purposes
curl --request GET \
  --url https://api.equalsmoney.com/v2/payment-purposes \
  --header 'Authorization: <api-key>'
{
  "rows": [
    {
      "defaultPurpose": "Commission",
      "additionalPurpose": "string",
      "defaultCode": "string"
    }
  ]
}

Authorizations

​
Authorization
string
header
required

Query Parameters

​
accountId
string
required

The ID of the account to work with.

Example:

"F50091"

​
currencyCode
string
required

The currency code, in ISO-4217 format.

Pattern: ^[A-Z]{3}$
Example:

"USD"

​
countryCode
string
required

The country code, in ISO-3166 format.

Pattern: ^[A-Z]{2}$
Example:

"GB"

​
recipientType
enum<string>
required

The type of the recipient.

Available options:
business,
charity,
individual
Example:

"business"

Response

200 - application/json

OK

​
rows
object[]
required