VirtualPay CallBack

This API will be triggered to notify merchants in real-time whenever a transaction occurs on a virtual account

---

Callback API Specification

API ARCHITECTURE: REST

API Method: POST

Endpoint: To be provided by client

Request Parameter

Parameter Name	Type	Description
customer_id	string	The unique identifier of the customer initiating the transaction.
virtual_account_no	string	The virtual account number involved in the transaction.
virtual_account_name	string	The name associated with the virtual account.
transaction_amount	string	The total amount involved in the transaction.
transaction_fee	string	Fee charged for the transaction
transaction_reference	string	A unique identifier for the transaction.
bo_referenceno	string	A reference number provided by the back office.
source_account	string	The originating account number for the transaction.
source_account_name	string	The name associated with the source account.
source_bank	string	The bank name of the source account.
source_bank_code	string	The bank code of the source account's bank.
narration	string	A description or purpose of the transaction.
session_id	string	Switch session ID for the transaction.
transaction_date	string	The date of the transaction.
tran_response_code	string	Code indicating the transaction response (e.g., "00" for success).
tran_response_message	string	A message providing information about the transaction's status.
channel_code	string	An identifier for the transaction channel, such as "VIRTUALPAY".
payment_status	string	The status of the payment, indicating if the complete amount was paid ("Complete") or if there was an "Amount Mismatch" (for retail transactions).

SAMPLE REQUEST

{
    "customer_id": "08123456789",
    "virtual_account_no": "1578000000",
    "virtual_account_name": "JOHN DOE",
    "transaction_amount": "1500",
    "transaction_fee": "0.84",
    "transaction_reference": "VPAYTO1287139954",
    "bo_referenceno": "099MJKL212640002",
    "source_account": "0760261888",
    "source_account_name": "RICE DUMO",
    "source_bank": "Access Bank",
    "source_bank_code": "044",
    "narration": "TESTING",
    "transaction_date": "06-07-2022",
    "session_id": "100004241002184852120107569806",
    "tran_response_code": "00",
    "tran_response_message": "Successful Request",
    "channel_code": "VIRTUALPAY",
    "transaction_type": "static",
    "payment_status": "Complete" // Values can be "Complete" or "Amount Mismatch"
}

SAMPLE RESPONSES

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

{
  "response_code": "99",
  "response_message": "Failed Request"
}

{
  "response_code": "98",
  "response_message": "Duplicate Transaction"
}