Skip to main content

Cancel Payment Code

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

Description : This API is used to cancel an unused payment code.

Method: POST

Media Type: application/json

Request Parameter Definition

S/NParameter NameTypeParameter RequiredDescription
1payment_codestringRequiredCode generated for payment
2transaction_refstringRequiredClient transaction reference generated for payment. e.g BZ56787895717798678
3channel_codestringRequiredClient application code
4account_nostringCustomer’s account number
5hash_valuestringSha256 of selected transaction data

Response Parameter

S/NParameter NameDescription
1response_codeResponse code to indicate success or failure.
2response_messageResponse description to provide more details, e.g., error description.

Sample Payload

Request:

{
"payment_code": "4321586",
    "channel_code": "YOUR CHANNEL CODE",
    "account_number": "09485829003",
"hash_value": " c22cf7c1b0070e5903fa9fb6e49ea1e1",
    "transaction_ref": "12112566222"
}

Response

{
"response_code": "00",
"response_message": "Successful Request"
}