Get payment details - ZEN transfers API

Endpoint is used to get payment or refund details using the specified payment 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 payment 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}

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

Receive the ZEN.COM response

Receive the ZEN.COM response.

Parameters

Parameter	Description	Type	Nullable
`id`	payment id	string ($uuid)	no
`title`	title	string	no
`createdAt`	creation date	string ($datetime) mask yyyy-MM-dd'T'HH:mm:ssX	no
`lastModifiedAt`	modification date	string ($datetime) mask yyyy-MM-dd'T'HH:mm:ssX	no
`bookedAt`	booked date	string ($datetime) mask yyyy-MM-dd'T'HH:mm:ssX	yes
`status`	status	enum `IN_PROGRESS`, `SETTLED`, `REJECTED`	no
`direction`	direction	enum `INCOMING`, `OUTGOING`	no
`transactionType`	transaction type	string	no
`amount.value`	payment amount	number ($double)	no
`amount.currency`	payment currency	string (ISO 4217 standard)	no
`senderFees.amount.value`	fee amount	number ($double)	no
`senderFees.amount.currency`	currency	string (ISO 4217 standard)	no
`senderFees.name	fee name`	enum `STANDARD_FEE`, `ADDITIONAL_FEE`	no
`senderFees.type	fee type`	string	no
`receiverFees.amount.value`	fee amount	number ($double)	no
`receiverFees.amount.currency`	currency amount	string (ISO 4217 standard)	no
`receiverFees.name`	fee name	enum `STANDARD_FEE`, `ADDITIONAL_FEE`	no
`receiverFees.type`	fee type	string	no
`relatedTransaction`	original transaction ID	string	yes
`channel`	channel	enum `SWIFT`, `SEPA`, `LOCAL`	no
`chargeType`	charge type	enum `SHA`, `OUT`, `LOCAL`, `STANDARD`, `INSTANT`	yes
`purposeCode`	the purpose for which the payment is made, required for BH, AE, CN countries	string	yes
`sender.name`	sender's name	string	no
`sender.country`	sender's country	string (two-letter ISO country code)	no
`sender.address`	sender's address	string	yes
`sender.accountNumber`	sender's account number	string	no
`sender.bic`	bic the sender	string	yes
`sender.routingCode`	sender's routing code	string	yes
`sender.routingCodeType`	sender's code routing type	enum `SORT_CODE`	yes
`receiver.name`	receiver's name	string	no
`receiver.country`	receiver's country	string (two-letter ISO country code)	no
`receiver.address`	receiver's address	string	yes
`receiver.accountNumber`	receiver's account number	string	no
`receiver.bic`	bic the receiver	string	yes
`receiver.routingCode`	receiver's routing code	string	yes
`receiver.routingCodeType`	receiver's code routing type	enum `SORT_CODE`	yes
`relatedTransaction`	ID of related transaction	string	no

💡

Example response

{
   "id":"e7688140-657c-44dc-9139-b3602893bed6",
   "title":"2wA5ZyrFFV",
   "createdAt":"2024-07-22T08:39:46Z",
   "lastModifiedAt":"2024-07-22T08:39:47Z",
   "bookedAt":null,
   "status":"IN_PROGRESS",
   "direction":"OUTGOING",
   "transactionType":"PAYMENT",
   "amount":{
      "value":"1.000000",
      "currency":"GBP"
   },
   "senderFees":[
      {
         "amount":{
            "value":"0.420000",
            "currency":"GBP"
         },
         "name":"STANDARD_FEE",
         "type":"STANDARD"
      }
   ],
   "receiverFees":[
      {
         "amount":{
            "value":"0.000000",
            "currency":"GBP"
         },
         "name":"STANDARD_FEE",
         "type":"STANDARD"
      }
   ],
   "channel":"LOCAL",
   "chargeType":"STANDARD",
   "purposeCode":null,
   "sender":{
      "name":"Jacques Stoltenberg",
      "country":"AU",
      "address":"3583 Rex Neck Apt. 268 8316 West Robby",
      "accountNumber":"LT833130010196284123",
      "bic":"BZENLT22XXX",
      "routingCode":null,
      "routingCodeType":null
   },
   "receiver":{
      "name":"M2gIqhc9gN pJ91VIcY60",
      "country":"GB",
      "address":"2iN9vVrt00",
      "accountNumber":"53060604",
      "bic":null,
      "routingCode":"922469",
      "routingCodeType":"SORT_CODE"
   }
}

Errors

HTTP code	Business code	Description
400	`VALIDATION_ERROR`	the data has not been validated
403	`FORBIDDEN`	no access to the resource
404	`ACCOUNT_NOT_FOUND`	no account with the specified accountId was found
500	`INTERNAL_SERVER_ERROR`	server error, please contact ZEN

💡

Example error response

{
   "error":{
      "code":"INTERNAL_SERVER_ERROR",
      "message":"Unexpected error. Contact ZEN"
   }
}