API REFERENCE

巴西 · 创建代付

巴西创建代付的接口地址、参数与示例。

接口地址#

POSThttps://YOUR_GATEWAY_HOST/Payment_Dfpay_add.html

application/x-www-form-urlencoded

参数定义#

字段	要求	参与签名	说明
`mchid`	必填	是	面板显示的商户号，不是内部用户 ID。
`out_trade_no`	必填	是	商户原始代付订单号，每次新申请使用唯一订单号。
`money`	必填	是	BRL 金额字符串，保留两位小数；限额和费率以商户及产品配置为准。
`bankname`	必填	是	PIX 密钥类型：PIX_CPF、PIX_PHONE、PIX_EMAIL 或 PIX_EVP；支持类型与格式由分配产品决定。
`cardnumber`	必填	是	与 bankname 对应的收款人 PIX 密钥，以字符串传递；保留 CPF/CNPJ 前导零，手机号遵循产品指定格式。
`accountname`	建议填写	非空时参与	收款人真实姓名，建议填写；产品要求时必填。
`notifyurl`	适用时填写	非空时参与	商户异步通知地址，需要接收结果时填写。
`subbranch`	按分配产品要求	非空时参与	支行信息，分配产品要求时填写。
`province`	选填	非空时参与	省市信息按产品要求填写；通用 PIX 示例不要求。
`city`	选填	非空时参与	省市信息按产品要求填写；通用 PIX 示例不要求。
`extends`	按分配产品要求	非空时参与	Base64(JSON) 扩展参数，仅在分配产品要求且已定义时发送。
`pay_md5sign`	必填	否	32 位大写 MD5 签名；此字段本身不参与计算。

请求与响应示例#

cURL · 使用前替换占位参数

curl --request POST 'https://YOUR_GATEWAY_HOST/Payment_Dfpay_add.html' \
  --header 'Content-Type: application/x-www-form-urlencoded' \
  --data-urlencode 'mchid=10000' \
  --data-urlencode 'out_trade_no=DEMO_PAYOUT_001' \
  --data-urlencode 'money=100.00' \
  --data-urlencode 'bankname=PIX_CPF' \
  --data-urlencode 'cardnumber=YOUR_PIX_KEY' \
  --data-urlencode 'accountname=RECIPIENT_NAME' \
  --data-urlencode 'notifyurl=https://example.com/payout/notify' \
  --data-urlencode 'pay_md5sign=CALCULATE_WITH_YOUR_APIKEY'

请求参数 · 以表单提交

{
  "mchid": "10000",
  "out_trade_no": "DEMO_PAYOUT_001",
  "money": "100.00",
  "bankname": "PIX_CPF",
  "cardnumber": "YOUR_PIX_KEY",
  "accountname": "RECIPIENT_NAME",
  "notifyurl": "https://example.com/payout/notify",
  "pay_md5sign": "CALCULATE_WITH_YOUR_APIKEY"
}

响应示例

{
  "status": "success",
  "msg": "代付申请成功",
  "transaction_id": "DEMO_PLATFORM_PAYOUT"
}

响应示例

{
  "status": "error",
  "msg": "签名验证失败",
  "data": []
}

签名与结果处理#

按该接口的签名范围计算，不要把所有示例字段都加入签名。

查看签名指南