Generate Payment Code

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

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

Method: POST

Media Type: application/json

Request Parameter Definition

S/N	Type	Parameter Name	Parameter Required	Description
1	string	account_number	Required	Customer’s account number
2	string	amount	Required	Transaction amount.
3	string	channel_code	Required	Client application code.
4	string	phone_number	Required	Customer’s phone number.
5	string	transaction_reference	Required	Client transaction reference generated for the generate code request. e.g BZ56787895717798678
6	string	transaction_type	Required	Type of transaction e.g POS, WEB etc
7	string	debit_status		Status of funds held on customer account
8	string	hash_value		Sha256 of selected transaction data

Expected Response

S/N	Type	Parameter Name	Description
1	string	response_code	Response code to indicate success or failure.
2	string	response_message	Response description to provide more details, e.g., error description.
3	string	payment_code	Code generated by the request
4	string	expiry_datetime	Date and time that generated payment code will expire.

Sample Payload

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": "" 
}

Response:

{
    "response_code": "00", 
    "response_message": "Successful Request", 
    "response_data": { 
        "payment_code": "3632033", 
        "expiry_datetime": "12/10/2024 16:28:52" 
    } 
}