Get Payment Purpose Codes - Currencycloud API Documentation

Home > Manage > Reference > Get Payment Purpose Codes

/v2/reference/payment_purpose_codes

GET

Get a list of payment purpose codes for a given currency and entity type. When initiating cross-border payments, the central bank of the country may require a purpose to be included with your transaction in order for your payment to be accepted and processed. If a payment purpose code is required but not provided, your payment may be delayed or rejected by the beneficiary bank.

The API responses shown below are static. If you want to try out the API please login, or register for an API key

API parameters

Required

Name	In	Type	Description	Enum
X-Auth-Token	header	string	Authentication token.
currency	query	string	Currency in which payment made. Three-digit currency code.
Optional
Name	In	Type	Description	Enum
entity_type	query	string	Legal entity type. Can be either 'company' or 'individual'.	company individual

curl -X GET  --header "X-Auth-Token: XXXX-XXXXX-XXXX"  https://devapi.currencycloud.com/v2/reference/payment_purpose_codes

Response

{
    "purpose_codes": []
}

Error Codes

HTTP Status	Code	Description	Params
400	currency_is_required	currency is required
	invalid_currency	The currency specified was invalid
	currency_is_too_short	currency can not be shorter than 3 character(s)	`{ "minlength" => 3 }`
	currency_is_too_long	currency can not be longer than 3 character(s)	`{ "maxlength" => 3 }`
401	invalid_supplied_credentials	Authentication failed with the supplied credentials
429	too_many_requests	Too many requests have been made to the api. Please refer to the Developer Center for more information
500	internal_server_error	Internal server error
503	service_unavailable	Service is temporary unavailable

Was this page helpful?

Yes

/v2/reference/payment_purpose_codes

GET

API parameters

Required

Optional

Response

Error Codes

Start your borderless payments journey today

Cookies