Skip to main content

Requery Payment Code

URL: https://api-sandbox.accessbankplc.com/breezepay/requeryPayment

Description : This API is used to retrieve the status of a payment code, including details on whether the code has been used, its validity, and associated transaction details. 

Method: POST

Media Type: application/json

Request Parameter Definition

S/NParameter NameTypeParameter RequiredDescription
1terminal_idstringRequiredRepresents the terminal identifier for the transaction, likely indicating the source or device handling the transaction .
2amountstringRequiredTransaction amount. 
3channel_codestringRequiredClient application code.
4payment_codestringRequiredUnique code associated with the payment.

Expected Response

S/NParameter NameDescription
1response_codeResponse code to indicate success or failure.
2response_messageResponse description to provide more details, e.g., error description.
3post_resp_codeIndicates the response code from the debit of the customer’s account. "00" confirms that the transaction was successfully posted.
4post_resp_messageA message confirming the status of the debit of the customer’s account.
5account_numberRepresents the account number involved in the transaction.
6statusIndicates the current status of a payment or transaction code.
7code_statusDescription of the current status of a payment or transaction code.
8reversal_statusIndicates whether the transaction has been reversed.
9release_statusIndicates whether funds held when the code was generated have been released.
10settlement_statusDescribes the status of settlement processing for the transaction.

Sample Payload

Request:

{ 
    "payment_code": "2775351",
    "terminal_id": "209840G",
    "amount": "1400",
    "channel_code": "YOUR CHANNEL CODE"
}

Response:

{ 
"response_code": "00",
"response_message": "Successful Request",
"transaction_details": {
"post_resp_code": "00",
"account_number": "09485829003",
"post_resp_message": "Successful",
"status": "0",
"code_status": "USED",
"reversal_status": "N",
"release_status": "Y",
"settlement_status": "Successful Request"
}
}