创建代付订单(废弃) - CASHPAY巴西PIX支付API

请求参数

Authorization

在 Header 添加参数

Authorization

，其值为在 Basic 之后拼接空格，以及经过 Base64 编码的 username:password

示例：

Authorization: Basic *****************

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/RANDOM

枚举值:

EMAILPHONECPFCNPJRANDOM

accountNum

string

用户pix账号

必需

>= 8 字符<= 64 字符

示例值:

examplepixaccount@gmail.com

merchantUserId

string

必需

真实用户id/玩家id

示例

{
    "amount": "150",
    "merchantOrderId": "d869e074-57d1-4e1b-8cd7-d46d763b6ac8",
    "notifyUrl": "https://pre.hzxb.pro/health_check/print",
    "accountType": "CPF",
    "accountNum": "23613276860",
    "customerName": "zhangsan",
    "customerCert": "23613276860"
}

示例代码

Shell

JavaScript

Java

Swift

Go

PHP

Python

HTTP

C

C#

Objective-C

Ruby

OCaml

Dart

R

curl --location --request POST '/open-api/pay/transfer' \
--header 'Content-Type: application/json' \
--header 'Authorization: Basic Og==' \
--data-raw '{
    "amount": "150",
    "merchantOrderId": "d869e074-57d1-4e1b-8cd7-d46d763b6ac8",
    "notifyUrl": "https://pre.hzxb.pro/health_check/print",
    "accountType": "CPF",
    "accountNum": "23613276860",
    "customerName": "zhangsan",
    "customerCert": "23613276860"
}'

返回响应

🟢200OK

application/json

Body

code

enum<integer> <int32>

必需

响应码.正常:200,查询不到:404,失败:500,重复亲求:425

枚举值:

200404500

msg

string

必需

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

示例值:

success

status

enum<string>

可选

订单状态.待提交:99,支付中:00,成功:01,失败:02,超时:03,退款:04

枚举值:

0001020304

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": "WAIT",
    "status": "99",
    "orderId": "S120202208051555527511771885568",
    "merchantOrderId": "c234235234234235234234",
    "payType": "120",
    "sign": "154cf9ea31deecef04f0394aee3e8594",
    "traceId": "1271bf2b484d62e4340358a72d00653ef5c3d"
}

🔴500Internal Server Error