Get the list of accounts - ZEN transfers API

Endpoint is used to get a list of the Client's active accounts from which the Client can send a payment. The account parameters and available balance are returned in response.

The accountId returned in the response is used as the identifier of the account from which the payment is made.

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/accounts/v1.0

production environment: https://api-services.zen.com/accounts/v1.0

Receive the ZEN.COM response

Receive the ZEN.COM response. The accountId returned in the response is used as the identifier of the account from which the payment is made.

Parameters

Parameter	Description	Type	Nullable
`accountId`	unique account id	string ($uuid)	no
`productName`	account type (related to its purpose)	string	no
`currencyCode`	account currency	string (ISO 4217 standard)	no
`balance`	accounting balance (not including account blockages)	number ($double)	no
`avaliableBalance`	available balance (including account blockages)	number ($double)	no
`alias`	account alias	string	yes
`accountNumbers.accountNumber`	account number	string	yes
`accountNumbers.accountType`	account type	string	yes
`accountNumbers.bic`	bic	string	yes
`accountNumbers.routingCode`	routing code	string	yes
`accountNumbers.routingCodeType`	routing code type	string	yes

💡

Example response

[
   {
      "accountId":"db29ac40-f2ab-4e60-a311-5171ed8f42f1",
      "productName":"Accounts for IND",
      "currencyCode":"EUR",
      "balance":"0.00",
      "availableBalance":"0.00",
      "alias":"ABCDE"
   },
   {
      "accountId":"f19d2114-63ea-482b-b531-86b12deff6a9",
      "productName":"Accounts for IND",
      "currencyCode":"USD",
      "balance":"0.00",
      "availableBalance":"0.00",
      "alias":null
   },
   {
      "accountId":"3fa85f64-5717-4562-b3fc-2c963f66afa6",
      "productName":"string",
      "currencyCode":"string",
      "balance":0,
      "availableBalance":0,
      "alias":"string",
      "accountNumbers":[
         {
            "accountNumber":"string",
            "accountType":"string",
            "bic":"string",
            "routingCode":"string",
            "routingCodeType":"string"
         }
      ]
   }
]

Errors

HTTP code	Business code	Description
400	`VALIDATION_ERROR`	the data has not been validated
403	`FORBIDDEN`	no access to the resource
500	`INTERNAL_SERVER_ERROR`	server error, please contact ZEN

💡

Example error response

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