Requery Payment Code by Transaction Reference

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

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 by making use of its transaction reference.

Method: POST

Media Type: application/json

Request Parameter Definition

S/N	Parameter Name	Type	Description
1	channel_code	string	Client application code.
2	transaction_ref	string	A unique string associated with the payment.

Expected Response

S/N	Parameter Name	Description
1	response_code	Response code to indicate success or failure.
2	response_message	Response description to provide more details, e.g., error description.
3	post_resp_code	Indicates the response code from the debit of the customer’s account. "00" confirms that the transaction was successfully posted.
4	post_resp_message	A message confirming the status of the debit of the customer’s account.
5	account_number	Represents the account number involved in the transaction.
6	status	Indicates the current status of a payment or transaction code.
7	code_status	Description of the current status of a payment or transaction code.
8	reversal_status	Indicates whether the transaction has been reversed.
9	release_status	Indicates whether funds held when the code was generated have been released.
10	settlement_status	Describes the status of settlement processing for the transaction.

Sample Payload

Request:

{
    "transaction_ref": "FLP999TJEU3884959",
    "channel_code": "YOUR CHANNEL CODE"
}

Response:

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