1. Webhooks
PIK
  • Start
    • Getting Started
  • Authentication
    • Authentication Token
      POST
  • Global Account
    • Contacts
      • Create Contact
      • List Contacts
      • Get Contact
      • Count Contacts
    • Virtual Accounts
      • Create Virtual Account
      • List Virtual Accounts
      • Get Virtual Account
    • Transactions
      • List Transactions
      • Get Transaction
    • Account Balance
      • List Account Balances
      • Get Balance by Currency
    • Payout
      • Create Payout
    • Webhooks
      • Unified Webhook Entry
        POST
      • Virtual Account Webhook
        POST
      • Deposit Webhook
        POST
      • Payout Status Webhook
        POST
  • Payment Links
    • Payment Links
      • Create Payment Link
      • Update Payment Link
      • Get Payment Link Detail
      • Get Payment Link List
    • Transactions
      • Get Transaction List
  • Webhook
    • Global Account
      • Deposit Webhook
      • Payout Webhook
      • Virtual Account Webhook
    • Payment Links
      • Overview
      • Order Collect Out Webhook
      • Customer Payment Webhook
      • Customer Refund Webhook
      • Master Recharge Webhook
      • Web3 Direct Payment Webhook
      • Withdraw Out Webhook
  1. Webhooks

Unified Webhook Entry

POST
/receive/webhook/uqpay
Unified UQPay webhook entry. Routes to the corresponding handler based on the event_name field in the request body.
Supported event_name values:
VIRTUAL -> Virtual account events (same as /va)
DEPOSIT -> Deposit events (same as /deposit)
PAYOUT -> Payout status events (same as /payout)
BENEFICIARY -> Beneficiary events
ONBOARDING -> Sub-account onboarding events
Note: This endpoint is called by UQPay servers and does not require JWT auth. For Open API integrations, the dedicated paths (/va, /deposit, /payout) are recommended.

Request

Authorization
JWT Bearer
Add the parameter
Authorization
to Headers
Example:
Authorization: ********************
or
Body Params application/jsonRequired

Examples

Responses

🟢200
Webhook received successfully
This response does not have a body.
Request Request Example
Shell
JavaScript
Java
Swift
curl --location '/receive/webhook/uqpay' \
--header 'Authorization: Bearer <token>' \
--header 'Content-Type: application/json' \
--data '{
    "version": "1.0",
    "event_name": "VIRTUAL",
    "event_type": "string",
    "event_id": "string",
    "source_id": "string",
    "data": {
        "property1": "string",
        "property2": "string"
    }
}'
Modified at 2026-05-27 09:47:15
Previous
Create Payout
Next
Virtual Account Webhook
Built with