跳转到主要内容
GET
Retrieve Payout

授权

x-auth-token
string
header
必填

UQPay 提供的登录 API Token。

请求头

x-on-behalf-of
string

指定代表哪个子账户发起该请求。应设置为 account_id,可通过 List Connected Accounts 获取。若省略或为空,则使用主账户执行请求。 更多信息见 Connected Accounts

x-idempotency-key
string<uuid>
必填

用于保持操作幂等性的唯一标识符(UUID),确保同一操作重复执行不会产生意外影响或重复结果。它有助于在网络错误、重试或故障时保持数据一致性。

路径参数

payout_id
string
必填

出款单 ID

示例:

"PO1234567890123456789"

响应

200 - application/json

成功获取出款

payout_id
string
必填

出款 UUID

示例:

"PO1968582687224500224"

payout_currency
string
必填

三位币种代码

示例:

"SGD"

payout_amount
string
必填

通过此次出款提取的金额。

示例:

"100.00"

statement_descriptor
string
必填

向收款方银行展示的出款参考信息

Maximum string length: 15
示例:

"UQPAY PAYOUT"

payout_status
enum<string>
必填

出款状态枚举。

  • INITIATED:出款已发起。
  • PROCESSING:出款正在处理中(银行处理中)。
  • COMPLETED:出款已成功完成。
  • FAILED:出款失败。
  • FAILED_REFUNDED:出款失败,资金已退回。
可用选项:
INITIATED,
PROCESSING,
COMPLETED,
FAILED,
FAILED_REFUNDED
示例:

"INITIATED"

create_time
string<date/time>
必填

出款创建时间

示例:

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

internal_note
string

出款备注信息

示例:

"Payment to supplier"

completed_time
string<date/time>

出款完成时间

示例:

""