...
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. |
DUPLICATE REQUEST (D07) | This response is gotten when a transfer request is made to the same destination account with the same transaction amount within a 2 minutes interval. |
...
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 |
---|---|
amount (M) | The amount to be disbursed to the beneficiary |
reference (M) | The unique reference for a transaction. Also to be specified for each transaction in a bulk transaction request. |
batchReference (M) | The unique reference for the entire batch of transactions being sent. |
narration (M) | The Narration for the transactions being processed |
bankCode (M) | The 3 digit bank code representing the destination bank |
destinationAcountNumber (M) | The beneficiary account number |
destinationAccountName | The beneficiary account name. This will be used if provided, |
currency (M) | The currency of the transaction being initialised - "NGN" |
sourceAccountNumber (M) | Unique identifier of your wallet. Can be obtained on the disbursements page on the web portal and is represented as WALLET ACCOUNT NUMBER. |
onValidationFailure | Used to determine how Monnify should handle failed transaction validations in a batch. The two options are BREAK & CONTINUE. Use Break to tell Monnify to reject the entire batch and use CONTINUE to tell Monnify to process the valid transactions. |
notificationInterval | Used to determine how often Monnify should notify the merchant of progress when processing a batch transfer. The options are 10, 20, 50 and 100 and they represent percentages. i.e. 20 means notify me at intervals of 20% (20%, 40%, 60%, 80% ,100%). |
status | The status of a single transfer request. (SUCCESS, FAILED, PENDING, IN_PROGRESS, OTP_EMAIL_DISPATCH_FAILED, PENDING_AUTHORIZATION). A status of PENDING or IN_PROGRESS should NOT be treated as FAILED nor SUCCESS. Kindly do a requery to get the final status of the transfer. |
batchStatus | The status of the processing of the entire Batch. (FAILED_ON_ACCOUNTS_VALIDATION, OTP_EMAIL_DISPATCH_FAILED, PENDING, IN_PROGRESS, 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 |
totalFee | The total transaction fees deducted for all the transactions in the batch. |
...
Response Codes
When a request is initiated, a response code is returned indicating what happened with initiated request. Please see table below describing how each response code should be handled.
Response Code | Description | Comment |
---|---|---|
0 | Request was processed. | Please check transaction status in response body to ascertain status of the transaction. |
99 | An unexpected error occurred while processing transaction | Re-query to ascertain transaction status. |
D01 | Something went wrong and transaction could not be processed. Actual error message will be displayed in 'responseMessage' field. | Treat as FAILED. |
D02 | Transaction does not exist. | Treat as FAILED. |
D03 | Invalid account details supplied. | Treat as FAILED |
D04 | Insufficient wallet balance. | Treat as FAILED |
D05 | Supplied reference already exists The reference you are using has already been used by you | Retry with unique reference |
D06 | Unauthorized Request. This would imply that only whitelisted IP addresses can initiate the request | Treat as FAILED |
...
Related Articles
Filter by label (Content by label) | ||||||
---|---|---|---|---|---|---|
|
...