PIX

（payProduct=24）

请求地址

环境名称	URL
SandBox	POST https://api.supefina.tech/api/supefina/transactions/payout
正式环境	POST https://api.supefina.net/api/supefina/transactions/payout

请求方式

请求头

Key	Value
Content-Type	application/json

请求体

变量名	类型	必填	描述
account	String	是	收款方账户号 509.281.038-62（CPF） [email protected](EMAIL） 12345678911（PHONE） 01eb9090-73e5-4187-b43d-0d80a149e1dc（EVP：类似UUID的字符串
accountType	String	是	收款方账户类型 03：CPF 04：EMAIL 05：PHONE 06：EVP
callbackUrl	String	否	回调地址 详见通知回调说明
countryId	String	是	国家编号 参照：字典表-国家编号 巴西，BRA
currency	String	是	币种 参照：字典表-货币 雷亚尔：BRL
customerName	String	是	收款人姓名 首尾不得包含空格，但姓名之间可以有空格
customerIdentification	String	否	用户证件号（CPF）
merId	String	是	商户ID 商户ID获取路径：Supefina商户后台-商户管理-基本信息-商户ID
merOrderNo	String	是	商户订单号
nonceStr	String	是	随机字符串 长度不能超过32位
orderAmount	String	是	订单金额
payProduct	String	是	支付类型 PIX：24
sign	String	是	签名 具体参照：签名算法

请求示例

{
    "account": "92901821704",
    "accountType": "03",
    "callbackUrl": "http://test.com",
    "countryId": "BRA",
    "currency": "BRL",
    "customerName": "test name",
    "customerIdentification": "123456789-09",
    "merId": "8202419830650996",
    "merOrderNo": "T1AY73bzIe01bBB88DeYD",
    "nonceStr": "T1AY73bzIe01bBB88DeYD",
    "orderAmount": "200.00",
    "payProduct": "24",
    "sign": "EFD3D871D496CB05B6453FEA5B3273CC"
}

响应参数

变量名	类型	描述
code	String	响应编码 具体参照：响应状态码
data	Object	响应数据
amount	BigDecimal	订单金额
fee	BigDecimal	预收手续费
merCode	String	商户ID
merOrderNo	String	商户订单号
supefinaOrderNo	String	supefina订单号
transactionStatus	String	下单状态 该笔订单的的发起状态是否成功，与订单真正的交易状态无关。 00：下单成功 04：下单失败
msg	String	响应信息

响应示例

{
    "code": "200",
    "data": {
        "amount": 200.00,
        "fee": 0.00,
        "merCode": "8202419830650996",
        "merOrderNo": "T1AY73bzIe01bBB88DeYD",
        "supefinaOrderNo": "20240517050201466cf179077884e",
        "transactionStatus": "00"
    },
    "msg": "success "
}

回调通知

提交方式：POST

变量名	类型	描述
amount	String	订单金额
countryId	String	国家编号 参照：字典表-国家编号 秘鲁，PER
customerName	String	收款人姓名
fee	String	预收手续费
identifier	String	付款参考 Clabe
merId	String	商户ID
merOrderId	String	商户订单号
msg	String	消息
nonceStr	String	随机字符串 长度不能超过32位
realityAmount	String	实收金额
realityFee	String	实收手续费
sign	String	签名
status	String	交易状态 具体参照：字典表——交易订单状态
successTime	String	交易成功时间
supefinaOrderId	String	supefina订单号
transactionType	String	交易类型 01：代收 02：代付

回调通知示例

{
    "amount": "200.00",
    "countryId": "BRA",
    "customerName": "test name",
    "fee": "0.00",
    "identifier": "706180968985601627",
    "merId": "8202419830650996",
    "merOrderId": "T1AY73bzIe01bBB88DeYD",
    "nonceStr": "f0639536-51c7-4252-9f81-c33d4e",
    "realityAmount": "200.00",
    "realityFee": "0.00",
    "sign": "A4407F599DFA337C84A0FF834984B206",
    "status": "01",
    "supefinaOrderId": "20240517050201466cf179077884e",
    "transactionType": "02"
}

回调通知响应

商户成功收到回调后需同步返回指定字符串：SUCCESS 不返回或返回其他内容默认通知失败 如：

public String test(){
	return "SUCCESS";
}