Skip to main content
WEBHOOK
paymentRefund
{
  "version": "V1.6.0",
  "event_name": "ACQUIRING",
  "event_type": "acquiring.refund.created",
  "event_id": "ff65da37-6fcc-4e3a-a418-547b349aee8b",
  "source_id": "RF2043629695899013120",
  "data": {
    "amount": "8.88",
    "complete_time": null,
    "create_time": "2026-04-13T17:57:42+08:00",
    "currency": "SGD",
    "metadata": {
      "order_id": "order_6789"
    },
    "payment_attempt_id": "PA2043628825429938176",
    "payment_intent_id": "PI2043628825316691968",
    "payment_refund_id": "RF2043629695899013120",
    "reason": "full refund",
    "refund_status": "INITIATED"
  }
}

Documentation Index

Fetch the complete documentation index at: https://developers.uqpay.com/llms.txt

Use this file to discover all available pages before exploring further.

​
Event Types

Event TypeDescription
acquiring.refund.createdA refund request was created.
acquiring.refund.succeededThe refund was completed successfully.
acquiring.refund.failedThe refund failed.

Body

application/json
​
event_id
string<uuid>
required

A unique identifier for this event.

​
event_name
enum<string>
required

Top-level event category.

Available options:
ACQUIRING
​
event_type
enum<string>
required

The specific event type that occurred.

Available options:
acquiring.refund.created,
acquiring.refund.succeeded,
acquiring.refund.failed
​
source_id
string
required

Payment refund ID.

​
version
string
required

API version number.

Example:

"V1.6.0"

​
data
object

Payment refund details associated with the event.

Response

200

Return 200 to acknowledge receipt.