创建代付订单(新版) - CASHPAY巴西PIX支付API

-------------------- 重点 --------------------
⚠️请求该代付接口只有获取到 code=500 可以认为提交失败

如果发生超时/其他异常，不要直接处理为失败，因为我们可能已经接收到订单，等待我们回调或者调用查询订单api，

⚠️请求我们得到响应后，需要等待至少3分钟，再进行查询订单，如果返回了 code=404 说明我们没有接收到订单可以认为失败。

该新版api与旧版的不同点：1.返回的状态不一样，2.不再返回sign参数，3.增加返回了一些字段

关于巴西通过pix付款给收款人（代付）的解释

收款人需要有pix账号(类似国内支付宝账号)巴西官方名字 pix chave(中文: pix 键，英文 pix key)

个人主体付款人有账户肯定有自己的CPF (税号/证件号，类似国内身份证号)，公司主体是 CNPJ

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 参数

x-app-id

string

必需

示例值:

appId

Body 参数application/json

amount

string

必需

金额(单位分),字符串

示例值:

1000

merchantOrderId

string

必需

商户订单id，商户收+付保持唯一

>= 10 字符<= 64 字符

示例值:

pay2342342343565234123

notifyUrl

string

必需

回调url，以http/https开头

>= 10 字符<= 256 字符

示例值:

https://test.example.com/pay/callback

customerName

string

用户姓名

必需

>= 5 字符<= 32 字符

示例值:

zhangSan

customerCert

string

用户CPF

必需

>= 9 字符<= 11 字符

示例值:

33216065855

accountType

enum<string>

必需

用户pix类型:EMAIL/PHONE/CPF/CNPJ/EVP

枚举值:

EMAILPHONECPFCNPJRANDOM

accountNum

string

用户pix账号

必需

>= 8 字符<= 64 字符

示例值:

examplepixaccount@gmail.com

merchantUserId

string

必需

强制：真实用户id/玩家id

示例

{
  "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

PHP

Python

HTTP

Objective-C

Ruby

OCaml

Dart

返回响应

🟢200OK

application/json

Body

code

enum<integer> <int32>

必需

响应码.正常:200,查询不到:404,失败:500,创建订单重复请求:425

枚举值:

200404500

msg

string

必需

描述信息(不能做判断,以status为准)

示例值:

success

status

enum<string>

可选

订单状态，具体查看【代收代付查询订单】

枚举值:

0001020304

transferReceipt

string

可选

是否检验证件号：yes校验no不校验

amount

string

订单金额单位分

可选

fee

string

订单手续费单位分

可选

createTimeL

number

可选

订单创建时间毫秒戳巴西时区

orderId

string

平台订单id

可选

示例值:

S202207181549087817064251392

merchantOrderId

string

商户订单id

可选

示例值:

pay2342342343565234123

payType

enum<string>

可选

代收110,代付120

枚举值:

110120

traceId

string

追踪id

可选

示例值:

qfrdby455v34q23crv34t54ar23rmi85t7v1123e4

customerName

string

提交的客户名称

可选

customerCert

string

提交的客户证件号

可选

示例

成功示例异常示例重复请求

{
  "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