Webhooks

Webhooks are server callbacks to your server from OQPay. Webhooks are event-based and are sent when specific events related to the transaction happen.

Configure Webhook
  1. Add your webhook through the merchant dashboard for the first time. Write to support@oqpay.in to edit your Webhook endpoint.
  2. Ensure you do not process duplicate events.
  3. Below is the list of events for which we will be notifying on your webhook and a list of parameters being sent.

We support webhooks in both encoded and JSON formats.

Webhook parameters and descriptions are available below:
Parameter Description
registrationID Unique registration ID.
txnRefranceID Transaction reference ID.
amount Payment amount.
currency Transaction currency.
paymentStatus Current payment status.
method Payment method used.
vpa UPI virtual payment address.
rrn Bank reference number.
createdAt Transaction created time.
message API response message.
status Request status.

Transfer Rejected

It notifies that the transfer request was received, but has been rejected due to some reason.

Webhook Response

{
  "registrationID": "OQP-XXXX",
  "txnRefranceID": "OQP1XXXXXXXXXXXX",
  "amount": "500",
  "currency": "INR",
  "paymentStatus": "captured",
  "method": "upi",
  "vpa": "99XXXXXXXX@ptyes",
  "rrn": "306XXXXXXXXX",
  "createdAt": "2026-05-18T14:07:47+05:30",
  "message": "Data Retrieve Successfully",
  "status": "True"
}

Callback Response

Upon successful delivery of data to the configured callback URL, an appropriate success response is expected to be returned. Response handling and acknowledgment processing are required to be implemented by the receiving system.

{
  "status": "True",
  "message": "Transaction completed successfully"
}

Did this page help you?     Yes    No