创建代收订单 - CASHPAY巴西PIX支付API

请求该接口需要判断返回值当 code=200并且status=00为正常。然后获取返回的payUrl供用户充值
如果http响应码为502，可间隔2秒重试请求3次

pix qrcode 格式验证工具：https://pix.nascent.com.br/tools/pix-qr-decoder

2024-11-01 代收要求传cpf/name，代收代付需要传用户id

请求参数

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

returnUrl

string

可选

页面跳转url，以http/https开头，支付页面打开3分钟后或者支付成功会跳转这个链接

>= 10 字符<= 256 字符

示例值:

https://h5.example.com/pay/result.html

merchantUserId

string

必需

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

customerName

string

必需

2024-11-01新增：用户真实姓名

customerCert

string

必需

2024-11-01新增：CPF / CNPJ

示例

{
    "amount": "200",
    "notifyUrl": "https://pix.aaa.com/pay/callback",
    "merchantOrderId": "6c16fff6-9c53-4d59-bd55-f567d9207411",
    "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

payUrl

string

代收支付链接

可选

示例值:

https://checkout.eplspay.com/?cid=expireAt%202022-07-19T14:28:11.652&sid=S202207181549087817064251392&amount=20.00&qrcode=000201010212268D1A7

qrcodeRaw

string

代收支付二维码

可选

amount

string

订单金额(分)

可选

fee

string

手续费(分)

可选

realPayAmount

string

实际付款金额(分)

可选

createTimeL

string

可选

订单创建Unix毫秒巴西时区

orderId

string

平台订单id

可选

示例值:

S202207181549087817064251392

merchantOrderId

string

商户订单id

可选

示例值:

pay2342342343565234123

payType

enum<string>

可选

代收110,代付120

枚举值:

110120

sign

string

签名值

可选

示例值:

c60bac24be9381a43db34bfbf2df230d

traceId

string

追踪id

可选

示例值:

qfrdby455v34q23crv34t54ar23rmi85t7v1123e4

示例

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

{
    "code": 200,
    "msg": "success",
    "status": "00",
    "payUrl": "https://pay2.mtbtop1.com/s3/checkout-page/v3.html?cid=expireAt%202023-05-29T12:07:34.852740&sid=S110202305291663185317441789952&amount=2&qrcode=00020101021226790014br.gov.bcb.pix2557brcode.starkinfra.com/v2/5214d403821a491e97374b79733eb2f65204000053039865802BR5925Wudi%20pay%20Correspondente%20d6009Sao%20Paulo62070503***63045210",
    "qrcodeRaw": "00020101021226790014br.gov.bcb.pix2557brcode.starkinfra.com/v2/5214d403821a491e97374b79733eb2f65204000053039865802BR5925Wudi pay Correspondente d6009Sao Paulo62070503***63045210",
    "amount": "200",
    "fee": "0.8",
    "createTimeL": 1685369254824,
    "orderId": "S110202305291663185317441789952",
    "merchantOrderId": "305291663185317299159040",
    "payType": "110",
    "sign": "a2fdc7724e85038191ad5d212e412bc6",
    "traceId": "i220,i22052976b20c42de1945d7bec29a8a468a1c8f"
}

🔴500Internal Server Error