Versions Compared

Key

  • This line was added.
  • This line was removed.
  • Formatting was changed.

...

HTTP Method: POST

Info

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

Below is a sample request for initiating a single transfer:

...

Code Block
languagejson
{
    "requestSuccessful": true,
    "responseMessage": "success",
    "responseCode": "0",
    "responseBody": {
        "totalAmount": 2108.48,
        "totalFee": 8.48,
        "batchReference": "batch-1573684027157",
        "batchStatus": "PENDING_AUTHORIZATION",
        "totalTransactions": 3,
        "dateCreated": "13/11/2019 10:27:25 PM"
    }
}

...

Transaction Status Description

Status

Description

PENDING, AWAITING_PROCESSING and IN_PROGRESS

This response is gotten when transaction is still pending.

PENDING_AUTHORIZATION

This response is gotten if the merchant has 2FA enabled and authorization is needed for the disbursement to be initiated.

PENDING_BATCH_AUTHORIZATION

This response is gotten if merchant has 2FA enabled but the transaction is part of a batch.

OTP_EMAIL_DISPATCH_FAILED

This is very rare, but it happens when Monnify failed to send the OTP.

SUCCESS and COMPLETED

This response is gotten if the disbursement was successful.

REVERSED

This response is gotten if disbursement was reversed.

FAILED

This response is gotten when disbursement was not successful.

EXPIRED

A batch transaction has an expiry time. Once the transaction time has elapsed, you will get an EXPIRED response.

...

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.

...