巴西支付接口

1350字约5分钟

注意

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

限额

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

代付API

代付申请

简要描述：

创建代付订单

URL：/brl/pay/apply

参数：

参数名	必选	类型	说明
appId	是	Long	业务ID（后台获取）
orderId	是	String	商户订单号(必须保证唯一性)
amount	是	String	交易金额(单位：巴西雷纳尔，精确到小数点后两位；禁止添加标点符号，例如：”,”）范围:1-99999
accountType	是	String	账户类型：EWALLET（电子钱包)
bankCode	是	String	钱包编码
identifyType	是	String	账号类型(CPF/PHONE/EMAIL /CNPJ/EPV)
accountNo	是	String	用户收款账号
name	是	String	收款人姓名(收款人姓名格式：英文大小写且允许有空格，1-30位,"firstName middleName lastName" (middleName 非必填, 特殊字符支持 '.-))
phone	是	String	手机号（格式参考电话号码格式）
email	是	String	电子邮件
subject	否	String	支付备注（交易标题，商品名称，支付原因）
body	否	String	备注详情
sign	是	String	签名

request

{
    "appId": 1054,
    "orderId": "M100000450012",
    "amount": "500",
    "accountType": "EWALLET",
    "bankCode": "PIX",
    "identifyType": "CPF",
    "accountNo": "09876543210",
    "name": "john doe",
    "phone": "09876543210",
    "email": "johndoe@cashfree.com",
    "subject": "iphone13",
    "body": "ProMotion technology with adaptive refresh rates up to 120Hz",
    "sign": "I1PeK3eJOVsFFNowxVRqMXpeWm1lr/BcRpBi8WsW4wVo1+5CC3JsrFq/m/L2O69NzKHvtDWi4zia3DL3dPut0yMyUyqL91LNCSaeISbGsQPlhEsQpyTOryS/RKOfsrn2Xo37SCF/phAvndOk2jwwGwqM5xLz1ms9Ukl85wv27QFNrXIMxK2p18oe7MpMYrgf+xvEBE/VqCtKMtN9pO449wWwXzHWNPbZ76s4pAvKwRE9yXQDr7Iw14Dktcnl1FoLM4gWM/obkO+mz6SyAGDuXhVh/+OD/IGNiCyTCNq6ciQY28UnCFV6ZIP40gxsFhfBJKbK+Raw7y1Bh912ifYfug=="
}

response

{
    "status": "1",
    "error": "00000000",
    "msg": "",
    "data": {
        "orderId": "M100000450013",
        "orderNo": "3023062014149637",
        "sign": "LmhUnkw5j0pMiimsG8rKwdNNZGvXH5MpSmD6mdHZwq1SQwuK5BohmdEoqKB/jkMk28o3da4Cxh6Q+tW97+yTCemRrF+dMaHA73rpOeUuujKQl/UcFvJuMhfLBa2tp09L71NzoBqpPD6aXf37mYAz8E1HmERwFPpac5FVxIYanHG8cqmMLJYsVmHTSxWavgWU03ys9UczBePkBiR8sl2FSOhFABB0wAP28lswrV/ABS68IsLKtyd1fyI3GBfSbIK5nDEEnlE+EdElFdLs9taAxJImeVF1x4eT47+bkPJ2qS8z3K8QGzKLF3W+8SiRZGfSwDTsLKH+2Vycvy5auRl+ag=="
    }
}

返回data参数说明

参数名	必选	类型
orderId	String	商户订单号(必须保证唯一性)
orderNo	String	平台订单号
sign	String	签名

代付查询

简要描述：

代付订单查询

URL：/brl/pay/query

参数：

参数名	必选	类型	说明
appId	是	Long	业务ID（后台获取）
orderId	是	String	商户订单号
orderNo	否	String	平台订单号（响应快）
sign	是	String	签名

request

{
    "appId": 1000,
    "orderId": "M1234567111",
    "orderNo": "3022111516571436",
    "sign": "ZxkVZL+GAyv0VhvWn4IvuYahTzxgQuthkuV2ONWiqIfIDb2avvHlFOUJVzqZi1q8CPHXZm1ltanRTRVTxfsuftLvGeDioUHglWt46/RU6c1OPznpLGsZ35Q3n5tW2y1EnOsxPynXBFLuDQy+aZ3l9u6AQ30T0zQexMGT+IxuFkmUp02g/6juaHa5ZgNMv7lN67ixIp162wrM7OJuaOif872QijSceRdZhzaMGImAwB0D4MosRV4WMBOKkwgPdmS7GuZN66YUidXk3wTGqX3MYRw6M0kj4eNegSUwPXvp4q4p0KO8Y3xUMld54GY2ApX3WN3CBtC/vpJqEszjGBbbGg=="
}

response — 订单失败

{
    "status": "1",
    "error": "00000000",
    "msg": "",
    "data": {
        "orderId": "M1234567111",
        "orderNo": "3022111516571436",
        "amount": "100000.00",
        "fee": "0.00",
        "status": 3,
        "errorMsg": "Đơn hàng không tồn tại",
        "sign": "KKuvCl0SuNANJs+l2ogDaJm8pmV+Hi+Xa7q27vJ6D1Ehs4aOp13kRbITfJAhczh3T81BE9qwHeJaYwf+r0EypKM9TL6pMwfG8Az4gRy1D57wiUaVjl2PWcvbEqrn1hL0b+btkjvAM9I+CcSv+wuOW3/uku17Ws3FhgJLj9sFsQUBAPjDO+758VnwBytCOLBmljLBXyKgNgpmFQ1/DNkqWl0UNzyLK45Zw3yf5NiwhEFbvW0jlOWlfu/ql4hluISUQG573jEoFCBEnQLb2tQoRZj1QYNRCXPf5lbej0vzqbEwvR9h+ZOf255t1MocJkdIe463DTV5U3KZdVT87HMagw=="
    }
}

response — 订单成功

{
    "status": "1",
    "error": "00000000",
    "msg": "",
    "data": {
        "orderId": "M1234567112",
        "orderNo": "3022111517401574",
        "amount": "100000.00",
        "fee": "1003.00",
        "status": 2,
        "payTime": "2024-03-01 23:59:59",
        "sign": "khPtOmGq+cpKX0HFAI/lbP0dx4oVyNAnL5oLsdmhDJdASlQm0yg5I3o+MhImYggEsL6c2bo5fP29t54OZFqSdQDfIuNDvGbAMAr4mRBxc0hoHLkBLyyagfVPBLyQA1JY8XV3ZL4ySzQ3ZQnMCfrh2K39ueUuz6HpZ03Hj0KYijVRCXAZaio/L5jfLBT12QXmvIfAHa8s/k9flhK05ENHPep3zjj/MZGOEaX7jkEJLfjK0duypDCa61BRQjM+oePOdVsgleIl1Yf98UAxMDZ/A3912KFHEb+/jvmdnulNbiJFyuT1fEe+j2teUgw3vFsZAtwNWAgxhC7UO+N0Q5z4EA=="
    }
}

返回data参数说明

参数名	类型	说明
orderId	String	商户订单号(必须保证唯一性)
orderNo	String	平台订单号
amount	String	交易金额
fee	String	手续费
status	Integer	状态(0未开始，1支付中，2成功（终态），3失败（终态）, -1异常待确认)
payTime	String	支付成功时间（当status=2时有值）(巴西时间), 格式: yyyy-MM-dd HH:mm:ss
errorMsg	String	支付失败原因（当status=3时有值）
sign	String	签名

钱包编码

钱包编码EWALLET（电子钱包）

bankCode	bankName
PIX	PIX电子钱包渠道

代收API

代收申请

简要描述：

创建代收订单

URL：/brl/collect/apply

参数：

参数名	必选	类型	说明
appId	是	Long	业务ID（后台获取）
orderId	是	String	商户订单号(必须保证唯一性)
name	是	String	收款人姓名（收款人姓名格式:英文大小写且允许有空格,1-30位,"firstName middleName lastName" (middleName非必填,特殊字符支持!-)
phone	是	String	手机号，（格式参考电话号码格式）
email	是	String	电子邮件
amount	是	String	交易金额(单位：巴西雷纳尔，精确到小数点后两位；禁止添加标点符号，例如：”,”）范围:1-99999
payType	是	String	用户支付方式：QR
inBankCode	是	String	收款编码
callBackUrl	是	String	重定向链接
subject	否	String	支付备注
body	否	String	备注详情
sign	是	String	签名

request

{
    "appId": 1054,
    "orderId": "M233323000059",
    "amount": "300",
    "phone": "09230219312",
    "email": "23423@qq.com",
    "name": "test",
    "inBankCode": "PIX",
    "payType": "QR",
    "sign": "af0gAHkUOyYHu9owQp8NJ4mPEeUW4vuJcjdxqLIzrVw8AvpLSjD1DXupReSG/CyuSkFRyiIvCp5u703AuGGmfgD2gKDH3Ywau41bAbG2jnHJ8mtjiSJ5iWUzanyd4Kr7d1+rETbzUl7/BkW3t0X8UUFdqpxwG8DPUjAwUKfplWDHV7koG51Ozexd80DCsmW6eWdouAZ1uNXGLYmV3ftE3BmfNRtuv1C5bfTJWrTEIOxbF6g2uYOFZTlIgrQgd7/2PsAYwQQXNz8Q8CYl4OxqCv4pXJxaLWPbR5tqZu9og5kn32C9aHW/NlU1y39vzz+4ef81yPAqUV9oHlSMSPrMmw=="
}

response

{
    "status": "1",
    "error": "00000000",
    "msg": "",
    "data": {
        "orderId": "M233323000059",
        "orderNo": "6023071013539074",
        "payUrl": "https://a.api-uat.php.com/1L9zQS2",
        "bankCode": "PIX",
        "bankNo": "PC0007I10000035",
        "qrCode": "00020101021228760011ph.ppmi.p2m0111OPDVPHM1XXX0315777148000000017041652948137245442930503001520460165303608540810000.php Of Mandalu62310010ph.allbank05062110000803***88310012ph.ppmi.qrph0111OPDVPHM1XXX63042763",
        "sign": "YEoA8Y2JzQFGVzwJSqmemm1Kfv/bfyIfCqv2dp7RNzT5B72AQvdD+nt2nR4sL1HWscvmNHyVt5ovAi7MMhy3ziih/sMph+wPx4YjH3W1h5DyBvSlWvaKfKrK5ViomZ0pPYWydwRHnnRnicxToHK9S6qtSy7Q73O0hdz4hJ9p41Th3ycBl2Q9SeqSZYSY1ohcPDhdyRf2y0prb8rHgpBKzxZ5BKX/1bsE9OmsSEHAEYT8OGgko6aNe8XPAhr4G48cpWTftvnGQuzh0O65nuZRI/PF+Axt2zJCVbFHDDSREI9NlAT82ebDqhlVdxQzKE67D1nxgjb3dPmDUYHOBpmwxQ=="
    }
}

返回data参数说明

参数名	类型	说明
orderId	String	商户订单号(必须保证唯一性)
orderNo	String	平台订单号
payUrl	String	返回的是还款地址其他时候返回的是指引或者详情
bankNo	String	还款卡号（VA）
bankCode	String	通道Code(VA)
qrCode	String	二维码内容-可自行生成二维码(QR)
sign	String	签名

代收查询

简要描述：

创建代付订单
异步通知后，通过orderNo查询二次确认状态

URL：/brl/collect/query

参数：

参数名	必选	类型	说明
appId	是	Long	业务ID（后台获取）
orderId	是	String	商户订单号
orderNo	否	String	平台订单号（响应快）
sign	是	String	签名

request

{
    "appId": 1054,
    "orderId": "M22222000028",
    "sign": "EmyJGm3ELzG4FsOd0Krs9ncbSjo4oTGuXWML+7djYla3+VAwd9wS17z38p/7U2ZAjroO04XrE7YXcB1o76Dtyipj3h3bJzs7FYma1QNkMUdt9hh7m8U6hMsMQX7vIWHtXNwz4pbTSC75+kQWXaCew7KoE6LXECdJU8AISgNgeki2TK9R0pCfshr0Z2SZBPeuT6OvIH5LdmqgdZhuqnffGU2qnXk4KMkO848e6/WALLBR+LE1wyKHfPnYVcuKSMVYxkvKyyIL5JIPEgW0o5bh4RCbaUn3NZtyYwrU1uQ3ZDFRThm9j6XAQP+LBlmq3nOePqBtp/VDVarRaV+7FbQg3A=="
}

response

{
    "status": "1",
    "error": "00000000",
    "msg": "",
    "data": {
        "orderId": "M22222000028",
        "orderNo": "6023042811314347",
        "amount": "50000.00",
        "actualAmount": "0.00",
        "fee": "0.00",
        "status": 1,
        "sign": "fP433ygWVDLVGxYkVnIJj7riGq0U3vyVX+MbBAImxfGLZkZcEAHVEoVYuULZSmXAAXKRSyd67WlDNm+24pougM54ofAoH4HMtCL2tfCoBReFyz3z02AGKkrKE2xWhSpWoqfQoBvzwuN5iGMMu0s9Q1YvqiwJ8WDVIENnmiIyD8qDJN7caHTW2US14/faG+69AvnuIgJ/nu7/jogOlgEYdZdVYU7gcRDE+d47KjlFGswQkJ/h/uzV7cWtUqrtOO7ZnZ3/z33Xx8awokX36QoYcPSWAU0h+Ij9O9402HNhm1eTbYcLU0uI/z8xCAtyAI/tTyiFijpiNlxUKQj+zKsILw=="
    }
}

返回data参数说明

参数名	类型	说明
orderId	String	商户订单号(必须保证唯一性)
orderNo	String	平台订单号
amount	String	交易金额
actualAmount	String	收到金额
fee	String	手续费
status	Integer	状态(0未开始，1支付中，2成功（终态），3失败（终态）, -1异常待确认)
payTime	String	支付成功时间（当status=2,4,5时有值）(巴西时间), 格式: yyyy-MM-dd HH:mm:ss
errorMsg	String	失败原因（当status=3时有值）
sign	String	签名

收款编码(inBankCode)

payType=QR （二维码)-支持菲律宾的所有钱包以及银行APP扫码支付

inBankCode	限额	说明	是否可用
PIX	1 - 99999	QR二维码	可用