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.| Parameter | Description | Type | Required |
|---|---|---|---|
accountId | unique account id | string ($uuid) | no |
createdAtFrom | creation date from | string ($date) yyyy-MM-dd | no |
createdAtTo | creation date to | string ($date) yyyy-MM-dd | no |
bookedAtFrom | booking date from | string ($date) yyyy-MM-dd | no |
bookedAtTo | booking date to | string ($date) yyyy-MM-dd | no |
limit | number of expected results | number ($int32) | no |
lastEntryId | the last id from which further results are to be returned | string ($uuid) | no |
| Parameter | Description | Type | Nullable |
|---|---|---|---|
data.id | payment id | string ($uuid) | no |
data.title | title | string | no |
data.createdAt | creation date | string ($datetime) yyyy-MM-dd'T'HH:mm:ssX | no |
data.bookedAt | booked date | string ($datetime) yyyy-MM-dd'T'HH:mm:ssX | yes |
data.status | status | enum SETTLED, IN_PROGRESS, REJECTED | no |
data.direction | direction | enum INCOMING, OUTGOING | no |
data.amount.value | payment amount | number ($double) | no |
data.amount.currency | payment currency | string (ISO 4217 standard) | no |
data.sender.name | sender's name | string | no |
data.sender.address | sender's address | string | yes |
data.sender.accountNumber | sender's account number | string | no |
data.sender.bic | bic | sender's bic | string |
data.sender.routingCode | routing code | string | yes |
data.sender.routingCodeType | routing code type | enum SORT_CODE | yes |
data.receiver.name | receiver's name | string | no |
data.receiver.address | receiver's address | string | yes |
data.receiver.accountNumber | receiver's account number | string | no |
data.receiver.bic | receiver's bic | string | yes |
data.receiver.routingCode | routing code | string | yes |
data.receiver.routingCodeType | routing code type | enum SORT_CODE | yes |
transactionType | Type of transaction | enum PAYMENT, RETURN | no |
meta.lastEntryId | the last id returned in the response | string ($uuid) | yes |
meta.hasNext | the field informs whether it is possible to get further entries | boolean | no |
meta.direction | direction | enum DESC, ASC | no |
meta.sortedBy | sorting | string | no |
{
"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"
}
}| 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 |
{
"error":{
"code":"INTERNAL_SERVER_ERROR",
"message":"Unexpected error. Contact ZEN"
}
}