巴西支付接口

1051字约4分钟

注意

阅读该接口文档前，务必先查看 接口说明

限额

交易类型	限额(单位:BRL)
代收	PIX : 1-10000
代付	PIX : 1-10000

账户余额查询

URL：/common/openapi/account/balance

param 参数：

参数名	必选	固定值	说明
country	是	BRA	国家编码
currency	是	BRL	币种

request

{
    "param": {
        "country": "BRA",
        "currency": "BRL",
    },
    "sign": "Gw6D0kuWlnngLMiSxQQ2Dz2ciZz4LUZ7gWA8dRkEbcsE+UoiTOy6T3g6vNvGUlz+vPV2aRHKZ6aPBh0PaJkWW36T/lf8qId4D9uh8lFeTe7zW0+hTgTnN9YmruA6rlRNCo9QytbMRk6qkEZh1PZ2NrFnC77FhYVEVdOk6bIOv/vnGo1RVpbmsO+Gw+tPnvkQ1jvVDEHUlKgnAFGYa7+oWw8eClh9T4Ob7ZUPI0Z+dhefAmEX+z8DCyUxZrtbgA0li21KW2TmErIiRJQxep/f4quWRoTKkPziiMefKo1jFgbyL/gVzgkp91YaMMyk1QJKW1UoZ8iqHKNMI6pmvBCk8g=="

}

response

{
    "code": 200,
    "message": "",
    "data": {
        "merId": "",
        "merName": "",
        "currency": "",
        "amountTotal": "0.00",
        "freeAmount": "1085178690.00",
        "unrecordedAmount": "0.00",
        "freezeAmount": "1085178690.00",
        "frzBal": "0.00"
    }
}

返回data参数说明

参数名	类型	说明
merId	string	商户号
merName	string	商户名称
currency	string	币种
amountTotal	BigDecimal	总金额
freeAmount	BigDecimal	可用金额
unrecordedAmount	BigDecimal	在途金额
freezeAmount	BigDecimal	冻结金额

代收接口

代收下单

URL：/bra/openapi/payIn

param参数：

参数名	必选	类型	说明
amount	是	number	交易金额(小数点后尾数不带0, 例如: 禁止传输 123.40, 应传: 123.4)
app	否	string	应用名称
channelCode	是	string	支付渠道(PIX)
currency	否	string	币种(BRL)
merchantOrderNo	是	string	商户订单号
redirectUrl	是	string	商户重定向地址
notifyUrl	是	string	交易完成通知地址
timestamp	是	integer	交易时间戳(毫秒)

request

{
  "param": {
    "amount": 1,
    "channelCode": "PIX",
    "merchantOrderNo": "3443093920230506526",
    "redirectUrl": "http://www.",
    "app": "demo",
    "currency": "BRL",
    "notifyUrl": "http://xxx",
    "timestamp": 1684591961
  },
  "sign": "111"
}

response

{
  "code": 200,
  "message": "操作成功",
  "data": {
    "merchantNo": "34430939",
    "merchantOrderNo": "3443093920230506547",
    "plaOrderNo": "1123050691235966790",
    "channelCode": "PIX",
    "amount": "1",
    "status": "PENDING",
    "payUrl": "https://qr.XwinPay.asia/bra?orderNo=1123050691235966790"
  }
}

返回data参数说明

参数名	类型	说明
amount	string	交易金额
channelCode	string	支付渠道
merchantNo	string	平台商户号
merchantOrderNo	string	商户订单号
payUrl	string	支付链接
plaOrderNo	long	平台订单号
status	string	交易状态('PENDING','COMPLETED','FAILED')
qrCode	string	二维码内容

代付下单

URL：/bra/openapi/payOut

param参数：

参数名	必选	类型	说明
amount	是	number	交易金额(小数点后尾数不带0, 例如: 禁止传输 123.40, 应传: 123.4)
app	否	string	应用名称
channelCode	是	string	支付渠道(PIX)
currency	否	string	币种(BRL)
bankCode	否	string	银行编码
merchantOrderNo	是	string	商户订单号
accountType	是	string	账号类型(CPF/PHONE/EMAIL /CNPJ/EPV)
accountNumber	是	string	账号
accountName	是	string	姓名
notifyUrl	是	string	交易完成通知地址
timestamp	是	integer	交易时间戳(毫秒)

request

{
  "param": {
    "amount": 1,
    "channelCode": "PIX",
    "merchantOrderNo": "3443093920230506526",
    "accountType": "CPF",
    "accountNumber": "978569859",
    "accountName": "Test name",
    "app": "demo",
    "currency": "BRL",
    "notifyUrl": "http://xxx",
    "timestamp": 1684591961
  },
  "sign": "111"
}

response

{
  "code": 200,
  "message": "操作成功",
  "data": {
    "merchantNo": "34430939",
    "merchantOrderNo": "3443093920230506547",
    "plaOrderNo": "1123050691235966790",
    "channelCode": "PIX",
    "amount": "1",
    "status": "PENDING",
    "bankCode": "001",
    "bankName": "PGB",
    "accountNumber": "97856875",
    "accountName": "Test Name"
  }
}

返回data参数说明

参数名	类型	说明
amount	string	交易金额
channelCode	string	支付渠道
merchantNo	string	平台商户号
merchantOrderNo	string	商户订单号
plaOrderNo	long	平台订单号
status	string	交易状态('PENDING','COMPLETED','FAILED')
bankCode	string	银行编码
bankName	string	银行名称
accountNumber	string	账号
accountName	string	姓名

交易状态查询

URL：/bra/openapi/orderStatus

param参数：

参数名	必选	类型	说明
plaOrderNo	是	String	平台订单号

request

{
	"param": {
		"plaOrderNo": "1223050839733260230"
	},
	"sign": "111"
}

response — 订单成功

{
	"code": 200,
	"message": "操作成功",
	"data": {
		"merchantNo": "58256833",
		"merchantOrderNo": "5825683320230508569",
		"plaOrderNo": "1223050839733260230",
		"channelCode": "alipay",
		"status": "COMPLETED",
		"amount": "50000",
		"fee": "600",
		"merchantPayTime": "2023-05-08 11:13:21",
		"plaStatusTime": "2023-05-08 11:13:41"
	}
}

返回data参数说明

参数名	类型	说明
amount	string	订单金额
channelCode	string	支付渠道
fee	string	手续费
merchantNo	string	平台商户号
merchantOrderNo	string	商户订单号
merchantPayTime	string	商户交易时间
plaOrderNo	long	平台订单号
plaStatusTime	string	平台订单状态流转时间
status	string	支付状态('PENDING','COMPLETED','FAILED')

订单回调通知

URL：系统交易完成或余额不足时会发送回调到notify_url回调通知地址

响应: 接受请求后请返回“success”字符串给我们

请求方式：

method: POST
Content Type: application/json

body参数：

参数名	类型	说明
amount	string	订单金额
fee	string	手续费
merchantNo	string	平台商户号
merchantOrderNo	string	商户订单号
merchantPayTime	string	商户交易时间
plaOrderNo	long	平台订单号
plaStatusTime	string	平台订单状态流转时间
status	string	支付状态('PENDING','COMPLETED','FAILED')
errorCode	string	错误编码(status为FAILED时有值)
errorMessage	string	错误信息(status为FAILED时有值)
sign	string	签名使用平台公钥验签(取reqeust body里的数据，)

request

{
	"merchantNo": "24438069",
	"merchantOrderNo": "2443806920230508574",
	"plaOrderNo": "1223050832685691405",
	"status": "COMPLETED",
	"amount": "20000",
	"merchantPayTime": "2023-05-08 15:08:41",
	"plaStatusTime": "2023-05-08 15:08:42",
	"fee": "700",
	"sign": "bXE1dI7TrjmRvIGrcfgBqMKhSCsTAtvtoZBd4GIl6NQOqd/8qGudTmX3WJn37NX+v8ehaSGUNSa+4ocAzWQlNQMqJ/OH2Hd+mViXjR2+6n3q4WsvHTzoDGR0VT85jT2cjR421RnnzaC/eLy/02Zx/j7y2snodVnzi6L3RfiY2gM="
}