Get the list of purpose codes - ZEN transfers API

Endpoint is used to get a list of available purpose codes for payments ordered to the United Arab Emirates, Bahrain and China. The value from the code field should be entered in the purposeCode field in the endpoint for creating a payment or creating a draft payment.

Create a GET request

WARNING

Request header with Authorization parameter is obliged for all requests sent to ZEN.COM API. Authorization value is the apiKey parameter which is generated and provided by ZEN.COM to the Client. This key is unique to each Customer and should not be shared or used by third parties.

Create a GET request.

💡

Example of JSON

Send the request

Send the GET request to:

test environment: https://api-services.zen-test.com/constants/v1.0/purpose-codes

production environment: https://api-services.zen.com/constants/v1.0/purpose-codes

Receive the ZEN.COM response

Receive the ZEN.COM response.

Parameters

Parameter	Description	Type	Nullable
`country`	country code	string (two-letter ISO country code)	no
`code`	code that should be provided when creating a payment draft or creating a payment in the `purpose_code` field	string	no
`description`	description	string	no

💡

Example response

[
   {
      "country":"AE",
      "code":"FAM",
      "description":"Family Support"
   },
   {
      "country":"AE",
      "code":"GDE",
      "description":"Goods sold"
   }
]

Errors

HTTP code	Business code	Description
400	`VALIDATION_ERROR`	the data has not been validated
403	`FORBIDDEN`	no access to the resource
404	`ACCOUNT_NOT_FOUND`	no account with the specified accountId was found
500	`INTERNAL_SERVER_ERROR`	server error, please contact ZEN

💡

Example error response

{
   "error":{
      "code":"INTERNAL_SERVER_ERROR",
      "message":"Unexpected error. Contact ZEN"
   }
}