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/N | Parameter Name | Type | Parameter Required | Description |
|---|---|---|---|---|
| 1 | payment_code | string | Required | Code generated for payment |
| 2 | transaction_ref | string | Required | Client transaction reference generated for payment. e.g BZ56787895717798678 |
| 3 | channel_code | string | Required | Client application code |
| 4 | account_no | string | Customer’s account number | |
| 5 | hash_value | string | Sha256 of selected transaction data |
Response Parameter
| 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. |
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"
}
