创建 payout
向本地银行账户派发法币。本地金额按你账户的汇率(与 GET /v1/rates 返回的相同)转换为 USDT;扣除 usdt_amount 加固定费用(如有配置)并冻结,直到派发完成。若失败,全额退款。
从任意余额支付:默认从你账户的默认结算资产扣款(default_settlement_asset——USD 为主资产;用 PUT /v1/settlement 更改)。传 settlement_asset(USD、USDT、USDC、BTC、GOLD、SILVER 或 PLATINUM) 可让这笔操作从其他余额支付:总额按当时的有效结算价格转换为该资产(见 GET /v1/rates 的 settlement 块),扣款、冻结以及失败时的退款都在该资产中且金额完全一致。若 BTC/GOLD/SILVER/PLATINUM 的执行价格不可用,请求返回 503 pricing_unavailable;波动性资产还有单笔限额(422 settlement_limit_exceeded)。
必须提供幂等键(请求体字段或 Idempotency-Key 请求头)。使用相同键重试会返回原始 payout(200 且 idempotency_hit: true)。
如果收款人技术筛查暂时不可用且技术筛查队列可用，响应为 202，资源为 status: pending、status_code: compliance_pending、compliance_pending: true、 funds_debited: false，不会先扣款或调用 core。筛查返回 process 后，同一个资源仍可 在 pending 中使用 compliance_dispatch_pending、compliance_dispatching 或 core_unreachable，此时 funds_debited 为 true；保留相同幂等键并等待协调。
授权
会话 JWT(来自注册/登录)或 API key(pk_...)。
也接受 X-API-Key: <token> 作为替代请求头。
请求头
idempotency_key 请求体字段的替代方式。
请求体
ISO 3166-1 alpha-2 目标国家(例如 CL、PE、MX)。
本地货币(例如 CLP、PEN、MXN)。
本地货币金额,正数十进制字符串。
"50000.00"
来自 GET /v1/payouts/methods 的 payout 方式(例如 bank_transfer)。
目标账户详情。所需键取决于国家与方式;参见 GET /v1/payouts/methods 和
GET /v1/payouts/banks。示例:智利为 RUT + 银行,墨西哥为 CLABE,秘鲁为 CCI。巴西 PIX:pix_key + pix_key_type(cpf、
cnpj、phone、email、evp),或不用键的银行账户,使用
bank_code(ISPB)+ branch_code + account_number + tax_id。
厄瓜多尔(汇款走廊):document_value(身份证号)加上在同一对象中平铺的汇款人数据(sender_name、
sender_document_value 等);可选的结构化姓名字段
(given_name、first_surname 等及其对应的 sender_* 字段)
优先于对 name 的自动拆分。
阿根廷:tax_id(11 位 CUIT/CUIL)+ account_number
（22 位 CBU 或 CVU，或 6–20 个字符且至少包含一个字母的银行 alias；USD 仅支持 CBU）—— 无需 bank_code。
美国(USD):每笔转账都需收款人完整的身份与邮政地址 —— name、
email、account_number、country_code、address、city、
postal_code、bank_name、bank_country 和 bank_code(ach/wire
用 ABA routing number,swift 用 SWIFT BIC);ach 还必须提供
account_type(CHECKING/SAVING)。收款人可居住在任何国家
(country_code 不限 —— 例如向居住德国的收款人的美国银行账户发起
ACH);仅当 country_code 为 US 时 state 为必填。ach/wire
的收款银行必须位于美国(bank_country: "US" —— 本地通道无法向
美国以外的银行付款),并需完整银行地址块(bank_address、
bank_city、bank_postal_code,美国银行还需 bank_state);
swift 的银行地址块为选填(通道可从 BIC 推导),bank_country
可为任意国家。附件 B 所列辖区(CU/IR/KP/SY)对收款人国家和银行
国家仍然封锁(422 prohibited_country)。所有 USD 银行通道转账
还须先通过 POST /v1/payouts/documents 上传支持文件(发票/收据)
—— 详见 payouts 指南。
Show child attributes
Show child attributes
使用联系人在该国家(及方式,若传入)最近保存的受益人,而无需再次输入 beneficiary。显式 beneficiary 始终优先;若联系人没有则返回 422 no_saved_destination。
受益人会自动保存为联系人;传 false 可跳过。
可选支付备注。对于 SEPA，adapter 会将其折叠到 provider corporate charset；不支持的字符返回 400 invalid_payload，wire 值最多 140 个 runes。
此操作要扣款的虚拟余额。可接受的值:USDT、USDC、BTC、GOLD、SILVER、PLATINUM、BOB、MXN 与 ARS。法币执行目前返回 503 pricing_unavailable。省略则使用账户的默认结算资产(default_settlement_asset——USD 为主资产)。
USD, USDT, USDC, BTC, GOLD, SILVER, PLATINUM, BOB, MXN, ARS 用于客户 SEPA payout 的 active funding_usdt 虚拟 IBAN，可选。只有一个 active EUR 来源时可省略；存在多个来源时必须发送。付款人身份来自 vIBAN registrant。
可选的活跃 BO/BOB banking 工具；其他通道拒绝此字段，多个来源时必须发送 UUID。
Optional rail-specific options. For a deliberate retry after a recent bank rejection, set destination_retry_ack to the most recent prior case ID.
Show child attributes
Show child attributes
响应
既有 payout 的幂等重放。
执行时你账户的汇率(每 1 USDT 的本地单位数)。
执行汇率来源。lot、blend 或 spot；没有归因的历史记录会省略。
lot, blend, spot 该操作实际扣款的虚拟余额。
USD, USDT, USDC, BTC, GOLD, SILVER, PLATINUM 从结算资产余额实际扣除的准确金额(以该资产单位表示)。当资产为 USDT 时等于 total_debit。若 payout 失败,退款即为该准确金额——绝不重新计价。
用于转换 USDT 总额的结算资产有效 USD 单价(USDT/USDC 为 "1")。
pending 且 compliance_pending: true 表示收款人技术筛查在任何扣款或调用 core 之前等待。筛查通过后，pending 也可使用 compliance_dispatch_pending、compliance_dispatching 或 core_unreachable，此时扣款仍被持有。
pending, processing, completed, failed 规范化状态详情。compliance_pending 表示扣款前状态；compliance_dispatch_pending、compliance_dispatching 和 core_unreachable 表示筛查后的持久化转换。
技术筛查 pending 且尚未扣款时为 false。筛查通过并存在扣款/hold 后为 true，包括派发转换期间。
筛查或硬性合规控制在任何扣款前终止 payout 时为 true；不同于扣款后再退款的失败 payout。
仅当技术筛查在任何扣款或调用 core 之前等待时为 true；接受 process 结果后为 false。
银行/支付渠道的交易参考号(受益人可用它与银行核对付款)。US ACH/wire/SWIFT 在创建时立即返回 CBF 参考号；其他通道在渠道报告之前为空。
银行在执行后报告的 UETR/SWIFT gpi tracking 标识；可用前为空。
银行在执行后报告的国内 wire/ACH tracking 标识；可用前为空。
当响应为幂等重放时为 true。
仅在存在凭证时返回，通常在扣款并进入最终状态后出现。payout 在扣款前等待技术筛查时省略。