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. Transaction History Management
  • 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. Transaction History Management

Get payment history on account

transaction history.jpg
Endpoint is used to get the payment history of the account.
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.
Query parameters
ParameterDescriptionTypeRequired
accountIdunique account idstring ($uuid)no
createdAtFromcreation date fromstring ($date) yyyy-MM-ddno
createdAtTocreation date tostring ($date) yyyy-MM-ddno
bookedAtFrombooking date fromstring ($date) yyyy-MM-ddno
bookedAtTobooking date tostring ($date) yyyy-MM-ddno
limitnumber of expected resultsnumber ($int32)no
lastEntryIdthe last id from which further results are to be returnedstring ($uuid)no
💡
Example of JSON
2
Send the request
Send the GET request to:
1.
test environment: https://api-services.zen-test.com/payments/v1.0
2.
production environment: https://api-services.zen.com/payments/v1.0
3
Receive the ZEN.COM response
Receive the ZEN.COM response.
Parameters
ParameterDescriptionTypeNullable
data.idpayment idstring ($uuid)no
data.titletitlestringno
data.createdAtcreation datestring ($datetime) yyyy-MM-dd'T'HH:mm:ssXno
data.bookedAtbooked datestring ($datetime) yyyy-MM-dd'T'HH:mm:ssXyes
data.statusstatusenum SETTLED, IN_PROGRESS, REJECTEDno
data.directiondirectionenum INCOMING, OUTGOINGno
data.amount.valuepayment amountnumber ($double)no
data.amount.currencypayment currencystring (ISO 4217 standard)no
data.sender.namesender's namestringno
data.sender.addresssender's addressstringyes
data.sender.accountNumbersender's account numberstringno
data.sender.bicbicsender's bicstring
data.sender.routingCoderouting codestringyes
data.sender.routingCodeTyperouting code typeenum SORT_CODEyes
data.receiver.namereceiver's namestringno
data.receiver.addressreceiver's addressstringyes
data.receiver.accountNumberreceiver's account numberstringno
data.receiver.bicreceiver's bicstringyes
data.receiver.routingCoderouting codestringyes
data.receiver.routingCodeTyperouting code typeenum SORT_CODEyes
transactionTypeType of transactionenum PAYMENT, RETURNno
meta.lastEntryIdthe last id returned in the responsestring ($uuid)yes
meta.hasNextthe field informs whether it is possible to get further entriesbooleanno
meta.directiondirectionenum DESC, ASCno
meta.sortedBysortingstringno
💡
Example response
{
   "data":[
      {
         "id":"552f9d42-2e30-45e3-aca8-24b04e9c7246",
         "title":"acTNJAg9dt",
         "createdAt":"2024-08-07T10:57:06Z",
         "bookedAt":null,
         "status":"IN_PROGRESS",
         "direction":"OUTGOING",
         "amount":{
            "value":"1.00",
            "currency":"USD"
         },
         "sender":{
            "name":"Jacques Stoltenberg",
            "address":"3583 Rex Neck Apt. 268 8316 West Robbynull",
            "accountNumber":"LT093130010187172305",
            "bic":null,
            "routingCode":null,
            "routingCodeType":null
         },
         "receiver":{
            "name":"el323rGtno lXGhm6ICnE",
            "address":"oklfaS51bDnull",
            "accountNumber":"PL10241477434169818188057910",
            "bic":null,
            "routingCode":null,
            "routingCodeType":null
         }
      }
   ],
   "meta":{
      "lastEntryId":"552f9d42-2e30-45e3-aca8-24b04e9c7246",
      "hasNext":true,
      "direction":"DESC",
      "sortedBy":"createdAt"
   }
}
Errors
HTTP codeBusiness codeDescription
400VALIDATION_ERRORthe data has not been validated
403FORBIDDENno access to the resource
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:27:02
Previous
Delete a saved payment draft
Next
Get payment confirmation
Built with