Transferable data entities

The purpose of the transferable additional data entities is to provide further information about the payment-related transaction. These entities will pass through the settlement.

You may use one or more of the transferable additional data entities listed in the table below when creating an outgoing payment.

Parameter	Description
details	Payment-related explanations. Also known as unstructured reference.
referenceNumber	A unique identifier assigned to a specific transaction, used to track and manage payments. Also known as structured reference.
endToEndId	A unique identifier assigned to a financial transaction, ensuring traceability and consistency throughout the payment process from initiation to completion.
purposeCode	A standardised code defining a payment purpose.
chargeBearer	Defines the party responsible for paying any fees or charges associated with a payment transaction.

Details

In the example below, you can see how the transferable data entity details should be presented in the payment.

{
   "paymentParties": [...],
   
   "money": {...},
   
   "details": "Example payment"
}

Other transferable data entities

In the example below, you can see how the transferable data entities referenceNumber, endToEndId, purposeCode and chargeBearer should be presented in the payment.

{
   "paymentParties": [...],
      
   "money": {...},
   
   "details": "...",
   "referenceNumber": "123",
   "endToEndId": "20240103-E000003",
   "purposeCode": "SALA",
   "chargeBearer": "SHAR"
}

Sample API call

To view the sample API call demonstrating payment creation with transferable data entities, refer to the following example in the API cookbook.