发起Payout请求

创建一个代付请求以向受益人 (Beneficiary) 付款。部分请求结构将取决于您希望使用的payout方式。

请注意，您可以以本地货币或美元发送payout请求。请与您的Coda商务伙伴确认。

最终受益人将仅以 本地货币 接收代付款项

接口

环境	方法	URL
沙盒 (Sandbox)	POST	https://payout.codapayments-staging.com/payouts
生产 (Production)	POST	https://payout.codapayments.com/payouts

Headers

您可以参考身份验证章节。

请求参数

参数	类型	必填项	描述	验证
payout_method	Object	是	使用的Payout方式的详细信息	请参阅下面的 payout_method 详细信息
amount	Object	是	金额详情	请参阅下面的金额 (amount) 详细信息
country_code	String	是	2 个字母的ISO 3166 国家/地区	2 个字母，例如埃及：“EG” 请参阅下面的“国家/地区代码和货币代码列表”。
purpose	String	是	Payout目的	枚举： “revenue_share”, “salaries”, “payment_for_suppliers” 巴基斯坦：影响者付款应申报为“revenue_share”。 这些将被征收预扣税。
reference	String	否	这是您希望附加到payout的参考信息。如果所使用的付款方式允许，它将显示给收款人。	这是一个自选文本字段。 最多 255 个字符
request_id	String	是	由商户创建并附加到payout请求中的唯一请求ID。请注意，这必须是幂等的。	仅允许字母数字字符、连字符“-”和下划线“_”

amount (金额)

参数	类型	必填项	描述	验证
value	Number	是	请求金额 – 请求的payout总额。	最大小数位：2/ 对于印度尼西亚 IDR：仅接受xxxxxx.00格式； 不允许使用.x0或其他小数
currency_code	String	是	请求货币 – 请求金额的货币。 3 个字母的货币代码 ISO 4217。	3 个字母，例如埃及：“EGP” 请参阅下面的“国家/地区代码和货币代码列表”。

payout_method (payout模式)

参数	类型	必填项	描述	验证
type	String	是	使用的Payout方式	枚举： ” 银行转账 (bank_transfer)” “电子钱包 (wallet)"
payment_method	String	是	使用的Payout方式	支持的支付方式之一。 请参阅各国家的支付详情列表。
beneficiary	Object	是	收款人详情	请参阅下面 "beneficiary (收款人)" 详细信息

beneficiary (收款人)

参数	类型	必填项	描述	验证
name	String	是	收件人的全名	最多 255 个字符
payout_method_details	Object	是	指定付款渠道的收款人帐户的详细信息。	请参阅各国家的支付详情列表。

根据您希望使用的支付渠道将payout款项发送给收款人，“payout_method_details”对象的名称和必填字段会有所不同。您可以在下面找到支持的支付渠道列表以及每个渠道的必填字段。

响应参数

参数	描述
payout_method.type	国家/地区代码 + 在请求中传递的使用的payout方式
amount.value	请求金额 – payout请求的总金额。通过 API 请求传递。
amount.currency_code	请求货币 – 请求金额的货币。 3 字母货币代码（ISO 4217 标准），通过 API 请求传递。
country_code	Payout国家/地区。 2 字母国家代码（ISO 3166 标准），通过 API 请求传递。
purpose	Payout用途，通过 API 请求传递。
reference	自由文本，通过 API 请求传递。
request_id	由商户创建的、附加到Payout请求的唯一请求 ID。通过 API 请求传递。
due_date	通过 API 请求传递的截止日期。
id	Coda payout 交易 ID：字符串 (String) 类型。