Single Transfers
To get the details of a single transfer, you will need to send a request to the endpoint below:
Info |
---|
This endpoint is protected with OAuth 2.0 Bearer token |
Endpoint
...
URL:{{base_url}}/api/v2/disbursements/single/summary?reference={{reference}}
...
This endpoint is protected with OAuth 2.0 Bearer Token
HTTP Method: GET
Info |
---|
The {{base_url}} for test is |
Below is a sample response for getting the details of a single transfer
...
...
Get Single Transfer Details Response
Code Block | ||
---|---|---|
| ||
{ "requestSuccessful": true, "responseMessage": "success", "responseCode": "0", "responseBody": { "amount": 230.00, "reference": "Final-Reference-3a", "narration": "911 Transaction", "currency": "NGN", "fee": 20.00, "twoFaEnabled": false, "status": "SUCCESS", "transactionDescription": "Approved or completed successfully", "transactionReference": "MFDS2020080523" "destinationBankCode": "058", "destinationAccountNumber": "0111946768", "destinationAccountName": "MEKILIUWA, SMART CHINONSO", "destinationBankName": "GTBank", "createdOn": "13/11/2019 09:42:07 PM" } } |
Info |
---|
You can also use this endpoint to get the details of individual transactions in a batch |
...
Bulk Transfers
To get the details of a bulk transfer, you will need to send a request to the endpoint below:
...
title | Endpoint |
---|
...
Endpoint URL: {{base_url}}/api/v2/disbursements/batch/summary?reference={{batchReference}}
This endpoint is protected with Basic AuthenticationHTTP Method: GET
Below is a sample response for getting the details of a bulk transfer
Sample Response
Code Block | ||||||
---|---|---|---|---|---|---|
| ||||||
{ "requestSuccessful": true, "responseMessage": "success", "responseCode": "0", "responseBody": { "title": "Final Batch - Continue on Failure", "totalAmount": 2108.48, "totalFee": 8.48, "batchReference": "batch-1573685090035", "totalTransactions": 3, "failedCount": 0, "successfulCount": 0, "pendingCount": 3, "batchStatus": "COMPLETED", "dateCreated": "13/11/2019 10:45:08 PM" } } |
...
Field Reference
Field | Description |
---|---|
amount | The amount to be disbursed to the beneficiary |
reference | The unique reference for a transaction. Also to be specified for each transaction in a bulk transaction request. |
batchReference | The unique reference for the entire batch of transactions being sent. |
narration | The Narration for the transactions being processed |
destinationBankCode | The 3 digit bank code representing the destination bank |
destinationBankName | The name of the destination bank |
destinationAccountNumber | The beneficiary account number |
destinationAccountName | The name tied to the account in the destination bank |
currency (M) | The currency of the transaction being initialized. "NGN" |
status | The status of a single transfer request. (SUCCESS, FAILED, PENDING, OTP_EMAIL_DISPATCH_FAILED, PENDING_AUTHORIZATION) |
batchStatus | The status of the processing of the entire Batch. (FAILED_ON_ACCOUNTS_VALIDATION, OTP_EMAIL_DISPATCH_FAILED, PENDING, PENDING_AUTHORIZATION, AWAITING_PROCESSING, IN_PROGRESS ,COMPLETED) |
totalTransactions | The total number of transactions in the batch. |
totalAmount | The total amount deducted for all the transactions in the batch |
fee | The total transaction fees deducted for a single transaction |
totalFee | The total transaction fees deducted for all the transactions in the batch. |
failedCount | Total number of failed transactions in the batch |
successfulCount | Total number of successful transactions in the batch |
pendingCount | Total number of pending transactions in the batch |
Related Articles
Filter by label (Content by label) | ||||||
---|---|---|---|---|---|---|
|