The API endpoint requests return appropriate response codes that state the success or failure of the request.
Success Codes
The following table lists the success codes that the endpoint request returns.
Code | Title | Content | Description | Example |
---|---|---|---|---|
200 | Successful | The request has been processed successfully | This response code is generated when the request is processed successfully. | The transaction is complete NGNC211462007 |
201 | Success without payout | This response code is generated when the transaction gets timed out. Do not retry the operation, instead, perform the getTransactionStatus operation for the status update or speak to your client success team. |
Error Messages
The following table lists the error codes and messages that the endpoint request returns.
Code | Title | Content | Description |
---|---|---|---|
400 | Invalid Request | {error: “###”} | This response code is generated when all of the required parameters are not passed. |
401 | Unauthorized | {error: “Invalid Token”} | This response code is generated when the API access_token is expired or invalid. |
403 | Forbidden | {error: “You are not allowed to use this service”} | This response code is generated when you are not authorized to use this service. |
440 | Failed | {error: “An error has occurred while processing the request. A corresponding error message is always sent back”} | This response code is generated when the account is invalid. For example, a dormant account, a restricted account, a foreign denominated account rather than a local currency account. This response code is generated also occurs when excess or less than the required digits have been entered. For example, Nigerian bank accounts numbers have 10 digits. |
503 | Bank Offline or Service Unavailable | {error: “Server undergoing maintenance”} | This response code occurs when the server is unavailable. |