Non-transferrable data entities

The purpose of the non-transferable additional data entities is to identify the specific application or business process that initiated the payment. These entities will not pass through the settlement and remain stored within Tuum.

You may use one of two non-transferable additional data entities when creating an outgoing payment - Source and contractSource.

Source data entities

The source contains two data entities.

Parameter	Description
sourceName	Generally the name of the application that is initiating the payment.
sourceRef	Typically the technical ID of the business item associated with the source application.

In the example below, you can see how the source data entities should be presented in the payment.

{
   "paymentParties": [...],
      
   "money": {...},
   
   "details": "...",
   "source": {
       "sourceName": "EXTERNAL.SOURCE",
       "sourceRef": "ID-12345"
   }
}

Contract source data entities

The contractSource consists of three data entities.

Parameter	Description
sourceName	Typically the name of the business item for which the payment is being initiated.
sourceRef	The technical ID of the business item for which the payment is being initiated.
contractNumber	The contract number related to the business item for which the payment is being initiated.

In the example below, you can see how the contractSource data entities should be presented in the payment.

{
   "paymentParties": [...],
      
   "money": {...},
   
   "details": "...",
   "contractSource": {
       "sourceName": "EXTERNAL.CONTRACT",
       "sourceRef": "ID-181922",
       "contractNumber": "1122241515"
   }
}

Sample API call

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