Skip to main content
WEBHOOK
payoutStatus
{
  "version": "V1.6.0",
  "event_name": "PAYOUT",
  "event_type": "payout.ready.send",
  "event_id": "f4ff59f6-72d4-4f47-b16d-0a8a99f21dad",
  "source_id": "d7797dbe-0d04-4bb7-a881-9cdc253db355",
  "data": {
    "account_id": "b1b89684-c2c4-4d54-b8a8-3572727fd120",
    "amount": "30",
    "authorisation_steps_required": "0",
    "beneficiary_id": "57cabf52-109b-42f7-80e0-a5ec96f03df7",
    "currency": "USD",
    "direct_id": "0",
    "failure_reason": "",
    "failure_returned_amount": "",
    "fee_amount": "2.03",
    "fee_currency": "USD",
    "fee_paid_by": "SHARED",
    "payment_date": "2026-04-13",
    "payment_type": "SWIFT",
    "payout_amount": "30",
    "payout_currency": "USD",
    "payout_id": "d7797dbe-0d04-4bb7-a881-9cdc253db355",
    "payout_way": "API",
    "quote_id": "",
    "reason": "audiovisual services",
    "reference": "webhook-test-same-ccy-001",
    "short_reference": "P260413-XTQRDXK8",
    "short_reference_id": "P260413-XTQRDXK8",
    "status": "READY_TO_SEND",
    "unique_request_id": "9400079e-9398-4f5e-a2f1-beb8235e3f8f"
  }
}

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
payout.ready.sendSuccessfully created a payout.
payout.compliance.rejectedThe payout was rejected by compliance.
payout.completedThe payout was successfully completed.
payout.failedTriggered after the system successfully refunds a failed payout.

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:
PAYOUT
​
event_type
enum<string>
required

The specific event type that occurred.

Available options:
payout.ready.send,
payout.compliance.rejected,
payout.completed,
payout.failed
​
source_id
string
required

Payout ID.

​
version
string
required

API version number.

Example:

"V1.6.0"

​
data
object

Payout details associated with the event.

Response

200

Return 200 to acknowledge receipt.