Single Transfers
To authorize a single transfer, you will need to send a request to the endpoint below:
...
| Code Block |
|---|
| language | js |
|---|
| theme | Midnight |
|---|
| title | Authorize Transfer Response (Single) |
|---|
|
{
"requestSuccessful": true,
"responseMessage": "success",
"responseCode": "0",
"responseBody": {
"amount": 10,
"reference": "reference12934",
"status": "SUCCESS",
"dateCreated": "13/11/2019 09:34:32 PM"
}
} |
Bulk Transfers
To authorize a bulk transfer, you will need to send a request to the endpoint below:
...
| Code Block |
|---|
| language | js |
|---|
| theme | Midnight |
|---|
| title | Authorize Transfer Response (Bulk) |
|---|
|
{
"requestSuccessful": true,
"responseMessage": "success",
"responseCode": "0",
"responseBody": {
"totalAmount": 2108.48,
"totalFee": 8.48,
"batchReference": "batch-reference12934",
"batchStatus": "AWAITING_PROCESSING",
"totalTransactions": 3,
"dateCreated": "13/11/2019 10:45:08 PM"
}
} |
Field Reference
(M) indicates fields that are mandatory in the request body. (m) Indicates fields that are mandatory only if the parent object is not empty.
| Field | Description |
|---|
| authorizationCode (M) | The One Time Password sent to the specified email to be used to authenticate the transaction |
| reference (M) | The unique reference for a transaction. Also to be specified for each transaction in a bulk transaction request. |
| amount (M) | The amount to be disbursed to the beneficiary |
| batchReference (M) | The unique reference for the entire batch of transactions being sent. |
| totalAmount | The total amount deducted for all the transactions in the batch |
| totalFee | The total transaction fees deducted for all the transactions in the batch. |
| 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. |
Related Articles
| Filter by label (Content by label) |
|---|
| showLabels | false |
|---|
| showSpace | false |
|---|
| cql | label in ("disbursements","disbursements-api","OTP") |
|---|
|
...