BreezePay

Code fulfilment

Use a generated seven-digit code to complete a payment, then requery the transaction by its client reference to retrieve the resulting payment state.

POST

Code fulfillment

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

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

Parameters

terminal_idstringrequiredRepresents the terminal identifier for the transaction, likely indicating the source or device handling the transaction.

amountstringrequiredTransaction amount.

channel_codestringrequiredClient application code.

payment_codestringrequiredA unique code associated with the payment.

transaction_refstringrequiredUnique identifier for the transaction.

transaction_typestringType of transaction (POS or WEB).

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

POST

Requery payment code by transaction reference

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

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.

Parameters

channel_codestringClient application code.

transaction_refstringA unique string associated with the payment.

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