CASHPAY巴西PIX支付API
  1. 支付接口
CASHPAY巴西PIX支付API
  • 身份验证说明
  • CPF验证规则
  • CASHPAY支持巴西游戏用户实名方案
  • 其他提示
  • 支付接口
    • 代收代付查询订单
      GET
    • 创建代收订单
      POST
    • 创建代付订单(新版)
      POST
    • 商户查询余额
      GET
    • 代收代付回调请求示例
      POST
    • 代收代付批量查询接口
      GET
  • 废弃
    • 创建代付订单(废弃)
      POST
  1. 支付接口

创建代付订单(新版)

POST
/open-api/pay/transfer_fast
-------------------- 重点 --------------------
⚠️请求 该代付接口 只有 获取到 code=500 可以认为提交失败
如果发生超时/其他异常,不要直接处理为失败,因为我们可能已经接收到订单,等待我们回调或者调用查询订单api,
⚠️请求我们得到响应后,需要等待至少3分钟,再进行查询订单,如果返回了 code=404 说明我们没有接收到订单可以认为失败。
该新版api与旧版的不同点:1.返回的状态不一样,2.不再返回sign参数,3.增加返回了一些字段
关于巴西通过pix付款给收款人(代付)的解释
1.
收款人需要有pix账号(类似国内支付宝账号)巴西官方名字 pix chave(中文: pix 键,英文 pix key)
2.
个人主体付款人有账户肯定有自己的CPF (税号/证件号,类似国内身份证号),公司主体是 CNPJ
3.
pix chave 类型有5种,分别是EMAIL/PHONE/CPF/CNPJ/EVP,
同样pix 键就是上面5种格式,CPF:11位数;PHONE:11位数(可加前缀'+55');EMAIL:邮箱格式;CNPJ:14位数;EVP: uuid格式
对接我们:
accountNum 传pix chave
accountType 传对应类型
customerCert 传税号,个人传他的CPF,公司传他的CNPJ
customerName 传用户名字
建议在提交支付平台之前或者前端校验用户输入的CPF,检验规则见:《CPF验证规则》

请求参数

Authorization
在 Header 添加参数
Authorization
,其值为在 Basic 之后拼接空格,以及经过 Base64 编码的 username:password
示例:
Authorization: Basic *****************
Header 参数

Body 参数application/json

示例
{
    "accountType": "CPF",
    "accountNum": "32562523890",
    "amount": "100",
    "merchantOrderId": "daifu20230703cspix107",
    "transferReceipt": "no",
    "customerCert": "32562523890",
    "customerName": "HE YONG",
    "notifyUrl": "https://pix.aaa.com/pay/callback",
    "merchantUserId":"634123234"
}

示例代码

Shell
JavaScript
Java
Swift
Go
PHP
Python
HTTP
C
C#
Objective-C
Ruby
OCaml
Dart
R
请求示例请求示例
Shell
JavaScript
Java
Swift
curl --location --request POST '/open-api/pay/transfer_fast' \
--header 'x-app-id: appId' \
--header 'Content-Type: application/json' \
--header 'Authorization: Basic Og==' \
--data-raw '{
    "accountType": "CPF",
    "accountNum": "32562523890",
    "amount": "100",
    "merchantOrderId": "daifu20230703cspix107",
    "transferReceipt": "no",
    "customerCert": "32562523890",
    "customerName": "HE YONG",
    "notifyUrl": "https://pix.aaa.com/pay/callback",
    "merchantUserId":"634123234"
}'

返回响应

🟢200OK
application/json
Body

示例
{
    "code": 200,
    "msg": "WAIT_DEDUCT",
    "status": "90",
    "transferReceipt": "no",
    "amount": "100",
    "fee": "0",
    "createTimeL": 1688387795591,
    "orderId": "S120202307031675845995054960640",
    "merchantOrderId": "daifu20230703cspix107",
    "payType": "120",
    "traceId": "i170,i1707032a0b862e2f594444bd50da59536ba8fb",
    "customerName": "HE YONG",
    "customerCert": "32562523890"
}
🔴500Internal Server Error
修改于 2024-11-01 14:49:02
上一页
创建代收订单
下一页
商户查询余额
Built with