跳转到主要内容
POST
/
v2
/
payment
/
payout
/
create
Create Payout
curl --request POST \
  --url https://api-sandbox.uqpaytech.com/api/v2/payment/payout/create \
  --header 'Content-Type: application/json' \
  --header 'x-auth-token: <api-key>' \
  --header 'x-idempotency-key: <x-idempotency-key>' \
  --data '
{
  "payout_currency": "SGD",
  "payout_amount": "100.00",
  "statement_descriptor": "UQPAY PAYOUT",
  "internal_note": "Payment to supplier",
  "payout_account_id": "18523f72-f4de-4f9c-bb8e-ec7d1c4f32be"
}
'
{
  "payout_id": "PO1968582687224500224",
  "payout_currency": "SGD",
  "payout_amount": "100.00",
  "statement_descriptor": "UQPAY PAYOUT",
  "payout_status": "INITIATED",
  "create_time": "2025-09-18T15:47:41+08:00",
  "internal_note": "Payment to supplier",
  "completed_time": ""
}

Documentation Index

Fetch the complete documentation index at: https://developers-sandbox.uqpaytech.com/llms.txt

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

授权

​
x-auth-token
string
header
必填

The API token for login provided by UQPay.

请求头

​
x-on-behalf-of
string

Specifies the sub-account on whose behalf the request is made. This should be set to the account_id, which can be retrieved via the List Connected Accounts. If omitted or empty, the request is executed using the master account. More information at Connected Accounts.

​
x-idempotency-key
string<uuid>
必填

A unique identifier (UUID) used to maintain operation idempotency, ensuring that repeated executions of the same operation do not result in unintended effects or duplication. It helps preserve data consistency in the face of network errors, retries, or failures.

请求体

application/json
​
payout_currency
string
必填

Three-letter currency code

示例:

"SGD"

​
payout_amount
string
必填

The amount to be withdrawn through this payout.

示例:

"100.00"

​
statement_descriptor
string
必填

Payout reference information displayed to the recipient's bank

Maximum string length: 15
示例:

"UQPAY PAYOUT"

​
internal_note
string

Payout remark information

示例:

"Payment to supplier"

​
payout_account_id
string

The UQPAY account ID to receive the payout funds via internal transfer. Both long and short account IDs are accepted.

  • If omitted, the payout is sent to the pre-configured external bank account (default behavior).
  • If provided, the payout is processed as a UQPAY internal transfer to the specified account. Pass the account ID of the caller.
示例:

"18523f72-f4de-4f9c-bb8e-ec7d1c4f32be"

响应

200 - application/json

Payout created successfully

​
payout_id
string
必填

Payout UUID

示例:

"PO1968582687224500224"

​
payout_currency
string
必填

Three-letter currency code

示例:

"SGD"

​
payout_amount
string
必填

The amount to be withdrawn through this payout.

示例:

"100.00"

​
statement_descriptor
string
必填

Payout reference information displayed to the recipient's bank

Maximum string length: 15
示例:

"UQPAY PAYOUT"

​
payout_status
enum<string>
必填

Payout status enumeration

可用选项:
INITIATED,
PROCESSING,
COMPLETED,
FAILED,
FAILED_REFUNDED
示例:

"INITIATED"

​
create_time
string<date/time>
必填

Payout creation time

示例:

"2025-09-18T15:47:41+08:00"

​
internal_note
string

Payout remark information

示例:

"Payment to supplier"

​
completed_time
string<date/time>

Payout completion time

示例:

""