Skip to main content

Code Fulfillment

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

Description : This API is used to fulfill the payment code that was previously generated, ensuring the transaction is processed and recorded appropriately.

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_codestringRequiredA unique code associated with the payment.
5transaction_refstringRequiredUnique identifier for the transaction.
6transaction_typestringType of transaction. (POS or WEB)

Expected Response

S/NTypeParameter NameDescription
1stringresponse_codeResponse code to indicate success or failure.
2stringresponse_messageResponse description to provide more details, e.g., error description.

Sample Payload

Request:

{
"terminal_id": "2044NH50",
"payment_code": "4267824",
"amount": 10,
"channel_code": "YOUR CHANNEL CODE",
"transaction_type": "POS",
"transaction_ref": "TEST123OPI1249l9Fae"
}

Response:

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