Get Transfer Details

This API retrieves detailed information about a specific transfer transaction using the provided transaction ID. The response includes comprehensive details such as institution codes, account details, transferred amount, charges, and any associated split payments.

Path Parameters

Field Name	Type	Required	Description
transactionId	string	TRUE	The unique identifier for the transfer transaction (provided as a path variable).

Response Body

Field Name	Type	Description
sourceInstitutionCode	string	Code representing the source institution.
destinationInstitutionCode	string	Code representing the destination institution.
sourceBankName	string	Name of the source bank.
sourceAccountName	string	Name of the source account holder.
sourceAccountNUBAN	string	NUBAN (account number) of the source account.
destinationBankName	string	Name of the destination bank.
destinationAccountName	string	Name of the destination account holder.
destinationAccountNUBAN	string	NUBAN (account number) of the destination account.
amount	number	Amount transferred.
narration	string	Description or note associated with the transfer.
classificationCode	string	Code classifying the transaction (if available).
transactionStatus	string	Current status of the transaction (e.g., CONFIRMED).
traceID	string	Identifier used for tracking the transaction (if available).
transactionReference	string	Unique reference number for the transaction.
totalCharges	number	Total charges applied to the transfer.
splitPayments	array	Array of split payment objects detailing individual payment splits.
merchantSplitPayments	array	Array of merchant split payment objects detailing specific deductions.

Split Payment Object

Field Name	Type	Description
id	integer	Unique identifier for the split payment.
name	string	Name or description of the split payment.
groupCode	string	Group code associated with the split payment.
type	string	Type of split (e.g., FIXED).
amount	number	Amount deducted in the split payment.

Merchant Split Payment Object

Field Name	Type	Description
id	integer	Unique identifier for the merchant split payment.
name	string	Name or description of the merchant split payment.
groupCode	string	Group code associated with the merchant split payment.
type	string	Type of split (e.g., FIXED).
amount	number	Amount deducted in the merchant split payment.

OAuth 2.0

Client Credentials

Add the parameter

Authorization

to Headers，whose value is to concatenate the Token after the Bearer.

Example:

Authorization: Bearer ********************

Token URL: {{tpGatewayHostUrl}}/security/authenticate

Responses

🟢200Response

application/json

Bodyapplication/json

Example

{
  "sourceInstitutionCode": "000012",
  "destinationInstitutionCode": "090682",
  "sourceBankName": "Sample Bank",
  "sourceAccountName": "Sample Customer",
  "sourceAccountNUBAN": "4032350505",
  "destinationBankName": "Sample Bank",
  "destinationAccountName": "Sample Customer",
  "destinationAccountNUBAN": "6982935088",
  "amount": 100,
  "narration": "Sample narration",
  "classificationCode": null,
  "transactionStatus": "CONFIRMED",
  "traceID": null,
  "transactionReference": "025513965398458501072410171301",
  "totalCharges": 15,
  "splitPayments": [
    {
      "id": 2,
      "name": "Sample Customer",
      "groupCode": "T0OADVCJ5E",
      "type": "FIXED",
      "amount": 5
    }
  ],
  "merchantSplitPayments": [
    {
      "id": 2,
      "name": "Sample Customer",
      "groupCode": "T0OADVCJ5E",
      "type": "FIXED",
      "amount": 10
    }
  ]
}

🟠400| Source | Error | When |

🟠401| Source | Error | When |

🟠403| Source | Error | When |

🟠404| Source | Error | When |

🔴500| Source | Error | When |

Path Parameters

Response Body

Split Payment Object

Merchant Split Payment Object

Request

Request Code Samples

Responses

Get Transfer Details

Path Parameters#

Response Body#

Split Payment Object#

Merchant Split Payment Object#

Request

Request Code Samples

Responses

Path Parameters

Response Body

Split Payment Object

Merchant Split Payment Object