Get the draft list - ZEN transfers API

The endpoint is used to get a list of payment drafts saved by the Customer for later approval. Endpoint allows you to filter data according to defined parameters.

Results are always returned from newest to oldest.

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

Parameter	Description	Type	Required	Validation
`receiverName`	receiver's name	string	no	min=1 max=70
`receiverAccountNumber`	receiver's account number	string	no	min=1 max=34
`currency`	currency	string (ISO 4217 standard)	no	min=3 max=3
`dateFrom`	date from	string ($date)	no	yyyy-MM-dd
`dateTo`	date to	string ($date)	no	yyyy-MM-dd
`limit`	the number of expected results, if not provided, the accepted one is the default	number	no
`lastEntryId`	the last id from which further results are to be returned; if it is not provided, it is taken from the latest one	string ($uuid)	no

💡

Example of JSON

Send the request

Send the GET request to:

test environment: https://api-services.zen-test.com/payments/v1.0/drafts

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

Receive the ZEN.COM response

Receive the ZEN.COM response.

Parameters

Parameter	Description	Type	Nullable
`data.id`	draft id	string ($uuid)	no
`data.amount.value`	payment amount	number ($double)	no
`data.amount.currency`	currency amount	string (ISO 4217 standard)	no
`title`	title	string	no
`createdAt`	creation date	string ($datetime) yyyy-MM-dd'T'HH:mm:ssX	no
`receiver.firstName`	receiver's first name	string	yes
`receiver.lastName`	receiver's last name	string	yes
`receiver.companyName`	receiver's company name	string	yes
`receiver.type`	receiver's type	enum `INDIVIDUAL`, `BUSINESS`	no
`receiver.accountNumber`	receiver's account number	string	no
`receiver.bic`	bic	string	yes
`receiver.routingCode`	routing code	string	yes
`receiver.routingCodeType`	routing code type	enum `SORT_CODE`	yes
`senderAccountId`	id of the sender's account from which the payment is ordered	string ($uuid)	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

💡

Example response

{
   "drafts":[
      {
         "id":"16606098-a231-493d-ac06-dee54e030095",
         "amount":{
            "value":"0.350000",
            "currency":"EUR"
         },
         "title":"V8wxz1LncY",
         "createdAt":"2024-06-27T12:27:30Z",
         "receiver":{
            "firstName":"7d03lsOQno",
            "lastName":"pom3RCQfky",
            "companyName":null,
            "type":"INDIVIDUAL",
            "accountNumber":"PL09518547941553423933476296",
            "bic":"BPKOPLPW",
            "routingCodeType":null,
            "routingCode":null
         },
         "senderAccountId":"db29ac40-f2ab-4e60-a311-5171ed8f42f1"
      }
   ]
}

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"
   }
}