汇款

post
汇款请求

https://api.dlocal.com/api_curl/cashout_api/request_cashout
下面是用于请求汇款的基本方法,请注意每个国家可能有独特的附加要求,并且有自己的付款时间表,见下文更详细的例子。
Request
Response
Request
Body Parameters
login
required
string
您在 dLocal 平台侧的商户id -长度: 32 个字符-
pass
required
string
您在 dLocal 平台侧的商户密码 -长度: 32 个字符-
external_id
required
string
Payout 标示 (在商户网站) -最长 100 个字符-
document_id
optional
string
受益人个人身份证明号码 -最长100 个字符-
document_type
optional
string
受益人身份证明类型 -最长 10 个字符-
beneficiary_name
required
string
受益人名字或公司 -最长 100 个字符-
beneficiary_lastname
optional
string
受益人姓氏 -最长 100 个字符-
country
required
string
受益人国家. ISO 3166-1 alpha-2 代码 -最长: 2 个字符-
bank_code
optional
integer
受益人银行代码,参考银行代码部分
bank_name
optional
string
受益人银行名称,参考银行名称部分 -最长 40 chars-
bank_province
optional
string
受益人银行所属省名称 -最长 40 个字符-
bank_city
optional
string
受益人银行所属城市名称 -最长 40 个字符-
bank_branch_name
optional
string
受益人银行支行明称 -最长 40 个字符-
bank_branch
optional
string
受益人银行支行代码 -最大 45 个字符-
bank_account
required
string
受益人银行账户号码 -最大 45 个字符-
account_type
optional
string
账户类型. C 代表活期账户, S 代表储蓄账户, M 代表主账户 (仅秘鲁使用) -长度: 1 个字符-
amount
required
number
汇款数额 (在“货币”字段中输入的货币) -最多 2 个十进制数-
control
optional
string
Control 字符串
address
optional
string
受益人地址 -最长 200 个字符-
birthday
optional
string
受益人生日 -格式: 'YYYYMMDD'-
city
optional
string
受益人所在城市 -最长 100 个字符-
comments
optional
string
汇款备注信息 -最长 200 个字符-
currency
required
string
每个国家都接受美元和当地货币 默认: USD -长度: 3 个字符-
email
optional
string
受益人邮箱 -最长 100 个字符-
phone
optional
string
受益人电话号码 -最长 20 个字符-
extra_info
optional
string
受益人其他信息 json格式 -最长 500 个字符-
notification_url
optional
string
如果通知URL与默认定义的通知URL不同,则提供。请参阅下面的通知消息部分。 -最长 100 个字符-
on_hold
optional
boolean
商家是否希望保留付款并设置为稍后通过商家面板处理 默认: 0 -布尔型 1 或 0-
postal_code
optional
string
受益人邮编 -最长 20 个字符-
type
optional
string
应答类型 xml 或 json. 默认: json
remitter_address
optional
string
汇款人地址 -最大 200 个字符-
remitter_bank_account
optional
string
汇款人银行账户 -最大 45 个字符-
remitter_full_name
optional
string
汇款人全名 -最长 200 个字符-
remitter_document
optional
string
汇款人证件 -最长 45 个字符-
remitter_city
optional
string
汇款人银行城市名称 -最长 40 个字符-
remitter_country
optional
string
汇款人城市. ISO 3166-1 alpha-2 码 -最长 2 个字符-
remitter_postal_code
optional
string
汇款人邮编 -最长 20 个字符-
remitter_birth_date
optional
string
汇款人生日 -格式: 'YYYYMMDD'-
purpose
required
string
汇款目的代码,详见下面目的代码章节 -最长: 6 个字符-
Response
200: OK
应答 OK
{
“status”:0,
“cashout_id”:123456,
“desc”:“OK”
}
400: Bad Request
external ID 超出有效长度
{
“status”: 1,
“desc”: “Invalid param external_id”,
“error_code”: “300”
}

根据每个国家的银行合规性要求,在发送汇款请求时可能需要一些附加字段。

国家要求

请查看一下每个国家的要求以及请求示例:

关于 'login' 和 'pass' 字段:

x_loginx_trans_key 是你的证书,记住可以在 Merchant Pane 里面的 Integration > Credentials & Settings 部分找到。

通知消息

一旦银行确认转账,dLocal将向您的商户通知URL地址发送通知,通知您交易的结果代码。这个通知URL地址可通过每一个汇款请求中的 notification 参数进行更新, 但是请注意这个新的URL地址将只对特定的汇款支付活动有效。

更多关于通知消息的内容,请参考通知消息章节。

目标代码

一些国家的法规要求您指定每笔付款的用途,有关目标代码的详细信息,请查看 API 代码章节。