Authorize Transfer (2FA)

Single Transfers

To authorize a single transfer, you will need to send a request to the endpoint below:

This endpoint is protected with OAuth 2.0 Bearer token. To find out more about authorization for Monnify endpoints, check Here.

Endpoint URL: {{base_url}}/api/v2/disbursements/single/validate-otp

HTTP Method: POST

The {{base_url}} for test is https://sandbox.monnify.com but when you go live, it changes to the live url

Below is a sample request for authorizing a transfer

Authorize Transfer Request (Single)

{ "reference":"reference12934", "authorizationCode":"40538652" }

If the merchant does not have Two Factor Authentication (2FA) enabled, the transaction will be processed instantly and the response will be as follows:

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:

Endpoint URL: {{base_url}}/api/v2/disbursements/batch/validate-otp

HTTP Method: POST

This endpoint is protected with OAuth 2.0 Bearer token. To find out more about authorization for Monnify endpoints, check Here.

Below is a sample request for authorizing a transfer

Authorize Transfer Request (Bulk)

{ "reference":"batch-reference12934", "authorizationCode":"40538652" }

Authorize Transfer Response (Bulk)


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

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