Skip to main content
GET
获取 payout

授权

Authorization
string
header
必填

会话 JWT(来自注册/登录)或 API key(pk_...)。 也接受 X-API-Key: <token> 作为替代请求头。

路径参数

payoutID
string<uuid>
必填

响应

payout。

payout_id
string<uuid>
account_id
string<uuid>
idempotency_key
string
country
string
currency
string
method
string
local_amount
string
fx_rate
string

执行时你账户的汇率(每 1 USDT 的本地单位数)。

rate_source
enum<string>

执行汇率来源。lot、blend 或 spot;没有归因的历史记录会省略。

可用选项:
lot,
blend,
spot
usdt_amount
string
fee
string
total_debit
string
settlement_asset
enum<string>

该操作实际扣款的虚拟余额。

可用选项:
USD,
USDT,
USDC,
BTC,
GOLD,
SILVER,
PLATINUM
settlement_amount
string

从结算资产余额实际扣除的准确金额(以该资产单位表示)。当资产为 USDT 时等于 total_debit。若 payout 失败,退款即为该准确金额——绝不重新计价。

settlement_rate
string

用于转换 USDT 总额的结算资产有效 USD 单价(USDT/USDC 为 "1")。

beneficiary
object
description
string
status
enum<string>

pending 且 compliance_pending: true 表示收款人技术筛查在任何扣款或调用 core 之前等待。筛查通过后,pending 也可使用 compliance_dispatch_pending、compliance_dispatching 或 core_unreachable,此时扣款仍被持有。

可用选项:
pending,
processing,
completed,
failed
status_code
string

规范化状态详情。compliance_pending 表示扣款前状态;compliance_dispatch_pending、compliance_dispatching 和 core_unreachable 表示筛查后的持久化转换。

status_message
string
funds_debited
boolean

技术筛查 pending 且尚未扣款时为 false。筛查通过并存在扣款/hold 后为 true,包括派发转换期间。

predebit_failure
boolean

筛查或硬性合规控制在任何扣款前终止 payout 时为 true;不同于扣款后再退款的失败 payout。

compliance_pending
boolean

仅当技术筛查在任何扣款或调用 core 之前等待时为 true;接受 process 结果后为 false。

bank_reference
string

银行/支付渠道的交易参考号(受益人可用它与银行核对付款)。US ACH/wire/SWIFT 在创建时立即返回 CBF 参考号;其他通道在渠道报告之前为空。

uetr
string

银行在执行后报告的 UETR/SWIFT gpi tracking 标识;可用前为空。

imad
string

银行在执行后报告的国内 wire/ACH tracking 标识;可用前为空。

created_at
string<date-time>
updated_at
string<date-time>
idempotency_hit
boolean

当响应为幂等重放时为 true。

receipt_url
string<uri>

仅在存在凭证时返回,通常在扣款并进入最终状态后出现。payout 在扣款前等待技术筛查时省略。