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

代收代付查询订单

GET
/open-api/pay/query
支付接口
代收代付查询,查询到的是实时状态
订单状态说明:
90待扣款:这个状态正常很快过渡过去,商户无需处理。如果备注是“RiskWarning”开头的,是被风控挂起,这时候商户需要在群里执行放行或者驳回;
99待提交:代付这笔订单还没有提交到银行,商户无需处理;
00支付中:商户等待付款结果,商户无需处理;
06待确认:代收订单,用户已支付等待平台确认,商户无需处理;
01成功:代收/代付成功;
02失败:代收失败无需处理;代付失败会给商户回增余额,商户需要执行自己业务回滚逻辑;
04退款:交易状态反向执行,代收会给商户扣减余额,代付会给商户回增余额,商户需要执行自己业务回滚逻辑;
05拒收:代付拒收,商户余额没有变动,商户需要执行自己业务回滚逻辑。
所有状态都可以转到成功/退款,但每个状态只会转变过去1次,比如成功可以转退款,失败可以转成功,退款也可以转成功等等。
!!!该api返回数据不要验签,可能会增加/减少字段

请求参数

Authorization
在 Header 添加参数
Authorization
,其值为在 Basic 之后拼接空格,以及经过 Base64 编码的 username:password
示例:
Authorization: Basic *****************
Query 参数
merchantOrderId
string 
可选
参数二选一即可,两个都传要一致
orderId
string 
可选
不推荐,发生超时会导致获取不到
Header 参数
x-app-id
string 
必需
示例值:
appId

示例代码

Shell
JavaScript
Java
Swift
Go
PHP
Python
HTTP
C
C#
Objective-C
Ruby
OCaml
Dart
R
请求示例请求示例
Shell
JavaScript
Java
Swift
curl --location --request GET '/open-api/pay/query?merchantOrderId=&orderId=' \
--header 'x-app-id: appId' \
--header 'Authorization: Basic Og=='

返回响应

🟢200OK
application/json
Body
code
enum<integer> <int32>
必需
响应码.正常:200,查询不到:404,失败:500不要进行业务处理
枚举值:
200404500
msg
string 
必需
描述信息(不能做判断,以status为准)
示例值:
success
status
enum<string> 
可选
订单状态.待提交:99,支付中:00,成功:01,失败:02,超时:03,退款:04
枚举值:
0001020304
payUrl
string 
可选
代收支付链接/代付付款凭证(0516)
示例值:
https://checkout.eplspay.com/?cid=expireAt%202022-07-19T14:28:11.652&sid=S202207181549087817064251392&amount=20.00&qrcode=000201010212268D1A7
endToEndId
string 
必需
endToEndId
amount
string 
订单金额(分)
可选
fee
string 
手续费
可选
realPayAmount
string 
实际付款金额(分)
可选
createTimeL
number 
可选
订单创建Unix毫秒
orderId
string 
平台订单id
可选
示例值:
S202207181549087817064251392
merchantOrderId
string 
商户订单id
可选
示例值:
pay2342342343565234123
payType
enum<string> 
可选
代收110,代付120
枚举值:
110120
sign
string 
签名值
可选
示例值:
c60bac24be9381a43db34bfbf2df230d
traceId
string 
追踪id
可选
示例值:
qfrdby455v34q23crv34t54ar23rmi85t7v1123e4
customerName
string 
可选
代收用户姓名/代付为商户的信息(0516)
customerCert
string 
可选
代收用户CPF/代付为商户的信息(0516)
示例
{
    "code": 200,
    "msg": "PAID",
    "status": "01",
    "payUrl": "https://pay2.mtbtop1.com/s3/checkout-page/v3.html?cid=expireAt%202023-03-11T23:02:28.707566&sid=S110202303111634721486436782080&amount=20&qrcode=00020101021226790014br.gov.bcb.pix2557brcode.starkinfra.com/v2/79f05d1cfba545e6be1352339026613f5204000053039865802BR5925Conect%20World%20Comercio,%20Im6009Sao%20Paulo62070503***630455FC",
    "endToEndId": "e08561701202303120103i5gsv8nm4xz",
    "amount": "2000",
    "fee": "40",
    "realPayAmount": "2000",
    "createTimeL": 1678582948680,
    "orderId": "S110202303111634721486436782080",
    "merchantOrderId": "S110202303111634721486239629312",
    "payType": "110",
    "sign": "931f31f3c6013d8ae01a8016ae595d1d",
    "traceId": "i210,i21031128d291b539b84025acedf30448d1dd72"
}
🔴500Internal Server Error
修改于 2024-09-17 02:14:43
上一页
其他提示
下一页
创建代收订单
Built with