Description

Retrieves the details of a transaction using its unique transaction identifier.

Depending on the transaction type, the response may include transfer information such as source and destination accounts, bank information, session ID, and transaction reference.

Path Parameters

Parameter	Type	Required	Description
transactionID	String	Yes	Unique identifier of the transaction

Example URL

Success Response

HTTP Status

Response Parameters

Common Fields

Field	Type	Description
id	Integer	Internal transaction identifier
nuban	String	Customer account number
amount	Number	Transaction amount
note	String	Transaction narration
transactionType	String	Transaction type (`Deposit` or `Withdrawal`)
balance	Number	Account balance after the transaction (may not be returned for all transaction types)
createdDate	String (ISO 8601)	Date and time the transaction was created
currency	String	Transaction currency
transactionReference	String	Unique transaction reference (available for external transfers)
transferDetails	Object	Additional transfer information (available for transfer transactions)

Transfer Details Object

Field	Type	Description
amount	Number	Transfer amount
type	String	Transfer type
transactionStatus	String	Status of the transfer
transactionReference	String	Transaction reference
sessionId	String	NIP Session ID (external transfers only)
narration	String	Transaction narration
sourceAccountNUBAN	String	Debit account number
sourceAccountName	String	Debit account name
sourceBankName	String	Debit bank
sourceInstitutionCode	String	Source institution code (external transfers only)
destinationAccountNUBAN	String	Credit account number
destinationAccountName	String	Credit account name
destinationBankName	String	Destination bank
destinationInstitutionCode	String	Destination institution code (external transfers only)

Example Responses

1. Inward Transfer

{
  "id": 1445,
  "nuban": "0020000015",
  "amount": 20,
  "note": "Inward Test - Sample Customer 3",
  "transactionType": "Deposit",
  "balance": 66,
  "createdDate": "2024-10-27T06:00:48Z",
  "currency": "NGN",
  "transactionReference": "000012241027065934422656001526",
  "transferDetails": {
    "amount": 20,
    "sourceBankName": "STANBICIBTC BANK",
    "transactionStatus": "CONFIRMED",
    "transactionReference": "000012241027065934422656001526",
    "sessionId": "000012241027065934422656001526",
    "type": "INWARD_TRANSFER",
    "destinationAccountNUBAN": "0020000015",
    "destinationAccountName": "Sample Customer 4",
    "destinationInstitutionCode": "090605",
    "sourceAccountNUBAN": "0040088210",
    "sourceAccountName": "Sample Customer 3",
    "sourceInstitutionCode": "0000122",
    "sourceBankName": "STANBICIBTC BANK",
    "destinationBankName": "Sample Organisation 3",
    "narration": "Inward Test"
  }
}

2. Outward Transfer

{
  "id": 1445,
  "nuban": "0020000015",
  "amount": 20,
  "note": "Outward Test - Sample Customer 3",
  "transactionType": "Withdrawal",
  "balance": 66,
  "createdDate": "2024-10-27T06:00:48Z",
  "currency": "NGN",
  "transactionReference": "000012241027065934422656001526",
  "transferDetails": {
    "amount": 20,
    "sourceBankName": "STANBICIBTC BANK",
    "transactionStatus": "CONFIRMED",
    "transactionReference": "000012241027065934422656001526",
    "sessionId": "000012241027065934422656001526",
    "type": "OUTWARD_TRANSFER",
    "destinationAccountNUBAN": "0020000015",
    "destinationAccountName": "Sample Customer 4",
    "destinationInstitutionCode": "090605",
    "sourceAccountNUBAN": "0040088210",
    "sourceAccountName": "Sample Customer 3",
    "sourceInstitutionCode": "0000122",
    "sourceBankName": "STANBICIBTC BANK",
    "destinationBankName": "Sample Organisation 3",
    "narration": "Outward Test"
  }
}

3. Intra-bank Withdrawal

{
  "id": 35,
  "nuban": "0020000228",
  "amount": 1,
  "note": "Transfer Test",
  "transactionType": "Withdrawal",
  "createdDate": "2025-03-28T12:18:42Z",
  "currency": "NGN",
  "transferDetails": {
    "amount": 1,
    "type": "INTRABANK_TRANSFER",
    "transactionStatus": "CONFIRMED",
    "sourceBankName": "Sample Organisation 4",
    "sourceAccountNUBAN": "0020000228",
    "sourceAccountName": "Sample Customer 11",
    "destinationAccountNUBAN": "0020001050",
    "destinationAccountName": "Sample Customer 9",
    "destinationBankName": "Sample Organisation 4",
    "narration": "Transfer Test"
  }
}

4. Intra-bank Deposit

{
  "id": 35,
  "nuban": "0020001050",
  "amount": 1,
  "note": "Transfer Test",
  "transactionType": "Deposit",
  "createdDate": "2025-03-28T12:18:42Z",
  "currency": "NGN",
  "transferDetails": {
    "amount": 1,
    "type": "INTRABANK_TRANSFER",
    "transactionStatus": "CONFIRMED",
    "sourceBankName": "Sample Organisation 4",
    "sourceAccountNUBAN": "0020001050",
    "sourceAccountName": "Sample Customer 9",
    "destinationAccountNUBAN": "0020000228",
    "destinationAccountName": "Sample Customer 11",
    "destinationBankName": "Sample Organisation 4",
    "narration": "Transfer Test"
  }
}

5. Withdrawal

{
  "id": 1444,
  "nuban": "0020000015",
  "amount": 93,
  "note": "Balance - Cash",
  "transactionType": "Withdrawal",
  "balance": 46,
  "createdDate": "2024-10-27T05:50:22Z",
  "currency": "NGN"
}

6. Deposit

{
  "id": 1444,
  "nuban": "0020000015",
  "amount": 93,
  "note": "Balance - Cash",
  "transactionType": "Deposit",
  "balance": 46,
  "createdDate": "2024-10-27T05:50:22Z",
  "currency": "NGN"
}

7. Interest Posting

{
  "id": 1444,
  "nuban": "0020000015",
  "amount": 93,
  "transactionType": "Interest posting",
  "balance": 46,
  "createdDate": "2024-10-27T05:50:22Z",
  "currency": "NGN"
}

8. Withholding Tax

{
  "id": 1444,
  "nuban": "0020000015",
  "amount": 93,
  "note": "Balance - Cash",
  "transactionType": "Withhold Tax",
  "balance": 46,
  "createdDate": "2024-10-27T05:50:22Z",
  "currency": "NGN"
}

Transfer Types

Type	Description
INWARD_TRANSFER	Incoming inter-bank transfer
OUTWARD_TRANSFER	Outgoing inter-bank transfer
INTRABANK_TRANSFER	Transfer between accounts within the same bank

Notes

The transferDetails object is returned only for transfer transactions.

deposits and withdrawals do not include transfer details.

External (inter-bank) transfers include NIP-specific fields such as sessionId, transactionReference, and institution codes.

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

application/json

Success

Bodyapplication/json

{
  "id": 1445,
  "nuban": "0020000015",
  "amount": 20,
  "note": "Inward Test - Sample Customer 3",
  "transactionType": "Deposit",
  "balance": 66,
  "createdDate": "2024-10-27T06:00:48Z",
  "currency": "NGN",
  "transactionReference": "000012241027065934422656001526",
  "transferDetails": {
    "amount": 20,
    "sourceBankName": "STANBICIBTC BANK",
    "transactionStatus": "CONFIRMED",
    "transactionReference": "000012241027065934422656001526",
    "sessionId": "000012241027065934422656001526",
    "type": "INWARD_TRANSFER",
    "destinationAccountNUBAN": "0020000015",
    "destinationAccountName": "Sample Customer 4",
    "destinationInstitutionCode": "090605",
    "sourceAccountNUBAN": "0040088210",
    "narration": "Inward Test",
    "sourceInstitutionCode": "0000122",
    "destinationBankName": "Sample Organisation 3",
    "sourceAccountName": "Sample Customer 3"
  }
}

Transaction Details

Description

Path Parameters

Example URL

Success Response

HTTP Status

Response Parameters

Common Fields

Transfer Details Object

Example Responses

1. Inward Transfer

2. Outward Transfer

3. Intra-bank Withdrawal

4. Intra-bank Deposit

5. Withdrawal

6. Deposit

7. Interest Posting

8. Withholding Tax

Transfer Types

Notes

Request

Request Code Samples

Responses

Transaction Details

Description#

Path Parameters#

Example URL#

Success Response#

HTTP Status#

Response Parameters#

Common Fields#

Transfer Details Object#

Example Responses#

1. Inward Transfer#

2. Outward Transfer#

3. Intra-bank Withdrawal#

4. Intra-bank Deposit#

5. Withdrawal#

6. Deposit#

7. Interest Posting#

8. Withholding Tax#

Transfer Types#

Notes#

Request

Request Code Samples

Responses

Description

Path Parameters

Example URL

Success Response

HTTP Status

Response Parameters

Common Fields

Transfer Details Object

Example Responses

1. Inward Transfer

2. Outward Transfer

3. Intra-bank Withdrawal

4. Intra-bank Deposit

5. Withdrawal

6. Deposit

7. Interest Posting

8. Withholding Tax

Transfer Types

Notes