ZEN transfers API
Go to zen.comGo to myZEN.com
Documentation
Documentation
  • Sandbox
  • Plugin integration
  • Checkout integration
  • API business
  • API reference
  • Merchant panel
  • Brandbook
Go to zen.comGo to myZEN.com
Documentation
Documentation
  • Sandbox
  • Plugin integration
  • Checkout integration
  • API business
  • API reference
  • Merchant panel
  • Brandbook
  1. Information about accounts
  • Overview
  • Dictionary
  • Environments
  • Authentication
    • mTLS
    • API key
  • Notifications
    • About
  • Information about accounts
    • Get the list of accounts
    • Get account details
  • Payment management
    • About
    • Calculation of available channels, fees and payment limits
    • Get the list of purpose codes
    • Create a payment
    • Get payment details
  • Manage payment drafts
    • About
    • Create a draft payment
    • Get the draft list
    • Get payment draft details
    • Delete a saved payment draft
  • Transaction History Management
    • Get payment history on account
    • Get payment confirmation
  1. Information about accounts

Get account details

Picture2.jpg
Endpoint is used to get the Customer account details by the unique account ID accountId. The parameter is returned in the endpoint to get the list of accounts.
The account parameters and balance are returned in response.
1
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.
Path parameters
ParameterDescriptionTypeRequired
accountIdunique account idstring ($uuid)yes
💡
Example of JSON
2
Send the request
Send the GET request to:
1.
test environment: https://api-services.zen-test.com/accounts/v1.0/{accountId}
2.
production environment: https://api-services.zen.com/accounts/v1.0/{accountId}
3
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
ParameterDescriptionTypeNullable
accountIdunique account idstring ($uuid)no
productNameaccount type (related to its purpose)stringno
currencyCodeaccount currencystring (ISO 4217 standard)no
balanceaccounting balance (not including account blockages)number ($double)no
avaliableBalanceavailable balance (including account blockages)number ($double)no
aliasaccount aliasstringyes
💡
Example response
{
   "accountId":"db29ac40-f2ab-4e60-a311-5171ed8f42f1",
   "productName":"Accounts for IND",
   "currencyCode":"EUR",
   "balance":"0.00",
   "availableBalance":"0.00",
   "alias":"ABCDE"
}
Errors
HTTP codeBusiness codeDescription
400VALIDATION_ERRORthe data has not been validated
403FORBIDDENno access to the resource
404ACCOUNT_NOT_FOUNDno account with the specified accountId was found
500INTERNAL_SERVER_ERRORserver error, please contact ZEN
💡
Example error response
{
   "error":{
      "code":"INTERNAL_SERVER_ERROR",
      "message":"Unexpected error. Contact ZEN"
   }
}
Modified at 2026-03-17 14:22:37
Previous
Get the list of accounts
Next
About
Built with