BreezePay

Code generation

Generate a unique, time-bound seven-digit payment code, cancel it while unused, or retrieve its current state and transaction details.

POST

Generate payment code

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

This API is used to generate the payment code that is required to carry out BreezePay transactions.

Parameters

account_numberstringrequiredCustomer’s account number.

amountstringrequiredTransaction amount.

channel_codestringrequiredClient application code.

phone_numberstringrequiredCustomer’s phone number.

transaction_referencestringrequiredClient transaction reference generated for the generate code request, e.g. BZ56787895717798678.

transaction_typestringrequiredType of transaction, e.g. POS or WEB.

debit_statusstringStatus of funds held on customer account.

hash_valuestringSHA-256 of selected transaction data.

// request
{
  "account_number": "0729399845",
  "amount": 10,
  "channel_code": "YOUR CHANNELCODE",
  "phone_no": "08143567932",
  "transaction_ref": "TEST123OPI1249l9Gae",
  "transaction_type": "POS",
  "debit_status": "00",
  "hash_value": " c22cf7c1b0070e5903fa9fb6e49ea1e1",
  "inst_code": ""
}

POST

Cancel payment code

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

This API is used to cancel an unused payment code.

Parameters

payment_codestringrequiredCode generated for payment.

transaction_refstringrequiredClient transaction reference generated for payment, e.g. BZ56787895717798678.

channel_codestringrequiredClient application code.

account_nostringCustomer’s account number.

hash_valuestringSHA-256 of selected transaction data.

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

POST

Requery payment code

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

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.

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_codestringrequiredUnique code associated with the payment.

// request
{
  "payment_code": "2775351",
  "terminal_id": "209840G",
  "amount": "1400",
  "channel_code": "YOUR CHANNEL CODE"
}