Africa Fintech FoundryDeveloper Portal
Get API keys
VirtualPay · Retail

Retail virtual accounts

VirtualPay Retail uses temporary virtual accounts for individual retail payments. The account expires after its configured interval and carries the expected transaction amount.

POST

Generate virtual account number

https://developer-sandbox.accessbankplc.com/virtualpay/GenerateVirtualAccountNumber
This endpoint generates a Breezepay virtual account number/wallet ID to be used for payment by customer if customer does not already have one tied to ID.
Parameters
customer_namestringName of the customer (for account enquiry).
customer_emailstringCustomer’s email address.
channel_codestringrequiredClient application code.
merchant_idstringrequiredID of the merchant.
transaction_amountstringrequiredTransaction amounts.
customer_idstringrequiredUnique ID for the customer on client system.
customer_phonestringCustomer’s phone number.
request_authorizerstringRequest authorizer on client system.
// request
{
  "customer_id": "jondoe@yahoo.com",
  "merchant_id": "MERCHANT ID",
  "customer_name": "Jon Doe",
  "transaction_amount": "100",
  "customer_email": "jondoe@yahoo.com",
  "customer_phone": "07051234567",
  "request_authorizer": "System",
  "currency": "NGN",
  "channel_code": "MERCHANT ID"
}
POST

Get merchant transactions

https://developer-sandbox.accessbankplc.com/virtualpay/GetMerchantTransactions
This endpoint gets all credits to virtual accounts created under merchant for the date range supplied.
Parameters
start_datestringStart date of transactions range (if null, same day transactions would be fetched).
end_datestringEnd date of the transaction range.
channel_codestringrequiredClient application code.
merchant_idstringrequiredID of the merchant.
page_numberintrequiredThe page number of results to retrieve.
page_sizeintThe number of results per page.
// request
{
  "merchant_id": "YOUR MERCHANT ID",
  "page_number": 1,
  "page_size": 5,
  "channel_code": "YOUR CHANNEL CODE",
  "start_date": "28/09/2023",
  "end_date": "29/09/2023"
}
POST

Get transactions

https://developer-sandbox.accessbankplc.com/virtualpay/GetTransactions
This endpoint gets all transactions carried out by merchant.
Parameters
start_datestringStart date of transactions range (if null, same day transactions would be fetched).
end_datestringEnd date of the transaction range.
channel_codestringrequiredClient application code.
merchant_idstringrequiredID of the merchant.
// request
{
  "merchant_id": " YOUR MERCHANT ID",
  "channel_code": "YOUR CHANNEL CODE",
  "start_date": "23/11/2021",
  "end_date": "23/11/2021"
}
POST

Check transaction status

https://developer-sandbox.accessbankplc.com/virtualpay/CheckTransactionStatus
This endpoint retrieves the status of a transaction using the session ID or VPAY request ID.
Parameters
channel_codestringrequiredClient application code.
request_idstringrequiredVirtualpay unique transaction reference.
session_idstringSwitch session ID for transaction.
merchant_idstringrequiredID of the merchant.
// request
{
  "merchant_id": "YOUR MERCHANT ID",
  "request_id": "VPAY099MJNL221659TU6",
  "session_id": "",
  "channel_code": "YOUR CHANNEL CODE"
}
POST

Get merchant details

https://developer-sandbox.accessbankplc.com/virtualpay/GetMerchantDetails
Get merchant details using the merchant ID and account number.
Parameters
channel_codestringrequiredClient application code.
merchant_idstringrequiredID of merchant.
account_nostringrequiredMerchant account number.
// request
{
  "merchant_id": "YOUR MERCHANT ID",
  "account_no": "0123456789",
  "channel_code": "YOUR CHANNEL CODE"
}