Use the getTransactionStatus endpoint to get the status of the submitted transaction.
Please provide a call-back URL that can be used to notify you of any change in the transaction status timely.
For example, from complete to pending, from pending to complete, or from pending to canceled.
Syntax
POST https://nairagrambasket.com/api/getTransactionStatus
Response Codes
The following table lists the status codes that are returned in response to the getTransactionStatus request.
Code | Status |
---|---|
200 | Completed |
201 | Pending The Pending status can show any of the following descriptions: • Awaiting bank confirmation • Company limit exceeded • Wallet holding limit exceeded • Wrong bank account/wallet • Restricted/Dormant account: Account cannot receive payment Note: For Company limit exceeded and Wallet holding limit exceeded in the description, please reach out to the business team or the finance team. |
202 | Canceled |
203 | Declined |
Input Parameters
The following table lists the parameters that you need to provide in the getTransactionStatus request.
Field | Value Format | Required/Optional | Description |
---|---|---|---|
username | yourmail@mail.com | Required | Input the valid email address that you submitted to your Partner Company. |
password | yourPassword | Required | Input your secure password. |
secretKey | yourSerectKey | Required | Input the API key provided to you by your Partner Company. |
transaction_pin | 123456789098 | — | The transaction PIN would be returned from the submitTransaction or transaction_number request. |
Sample Request
curl --location --request POST 'https://nairagrambasket.com/api/getTransactionStatus' \
--form 'username="yourmail@mail.com"' \
--form 'password="yourPassword"' \
--form 'secretKey="yourSerectKey"' \
--form 'transaction_pin="1234567890"'
Sample Response
{
"Code": "200",
"Message": "Success",
"Content": {
transaction_pin: NGN1234567890
transaction_status: "Completed"
}
}
OR
{
"Code": "201",
"Message": "Success"
"Content": {
transaction_pin: NGN1234567890
transaction_status: "Pending"
description:"Wrong bank account/wallet"
}
}