Get payment draft details - ZEN transfers API

Endpoint is used to get draft payment details by its id.

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

Parameter	Description	Type	Required
`paymentId`	unique draft id	string ($uuid)	yes

💡

Example of JSON

Send the request

Send the GET request to:

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

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

Receive the ZEN.COM response

Receive the ZEN.COM response.

Parameters

Parameter	Description	Type	Nullable
`id`	draft id	string ($uuid)	no
`amount.value`	payment amount	number ($double)	no
`amount.currency`	payment currency	string (ISO 4217 standard)	no
`fees.amount.value`	payment fee amount	number ($double)	no
`fees.amount.currency`	payment fee currency	string (ISO 4217 standard)	no
`fees.name`	fee name	enum `STANDARD_FEE`, `ADDITIONAL_FEE`	no
`fees.type`	fee type	string
`chargeType`	charge type	enum `SHA`, `OUR`, `LOCAL`, `STANDARD`, `INSTANT`	yes
`title`	title	string	no
`channel`	channel	enum `SWIFT`, `SEPA`, `LOCAL`	no
`purposeCode`	the purpose for which the payment is made, required for BH, AE, CN countries	required for payments to AE, BH, CN countries	yes
`createdAt`	creation date	string ($datetime) yyyy-MM-dd'T'HH:mm:ssX	no
`receiver.firstName`	receiver's first name	string	yes if exists then companyName empty
`receiver.lastName`	receiver's last name	string	yes if exists then companyName empty
`receiver.companyName`	receiver's company name	string	yes if exists then firstName and lastName empty
`receiver.type`	receiver 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
`receiver.address.city`	receiver's city	string	no
`receiver.address.postCode`	receiver's post code	string	no
`receiver.address.addressLine`	receiver's address	string	no
`receiver.address.country`	receiver's county	string (two-letter ISO country code)	no
`senderAccountId`	id of the sender's account from which the payment is ordered	`string ($uuid)	no

💡

Example response

{
   "id":"31aa86e4-7303-4d1c-b18e-227993501148",
   "amount":{
      "value":"1.490000",
      "currency":"GBP"
   },
   "fees":[
      {
         "amount":{
            "value":"0.420000",
            "currency":"GBP"
         },
         "name":"STANDARD_FEE",
         "type":"STANDARD",
         "chargeType":"STANDARD"
      }
   ],
   "chargeType":null,
   "title":"ZlkcdLkb7A",
   "channel":"LOCAL",
   "purposeCode":null,
   "createdAt":"2024-07-01T11:38:31Z",
   "receiver":{
      "firstName":"OBRlw5wPCP",
      "lastName":"30V3yqlW1I",
      "companyName":null,
      "type":"INDIVIDUAL",
      "accountNumber":"13205093",
      "bic":null,
      "routingCodeType":"SORT_CODE",
      "routingCode":"406885",
      "address":{
         "city":"fkT7q6jUqN",
         "postCode":"p6tFES6RnU",
         "addressLine":"WucBE6K9Ot",
         "country":"GB"
      }
   },
   "senderAccountId":"26681bc6-7888-4c0b-a7da-e29c60aa7c46"
}

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