PIX

（payProduct=24）

No request address

The name of the environment	URL
SandBox	POST https://api.supefina.tech/api/supefina/transactions/payout
Formal environment	POST https://api.supefina.net/api/supefina/transactions/payout

How the request is made

Request header

Key	Value
Content-Type	application/json

Request body

Variable name	type	Required	description
account	String	Yes	Beneficiary account number 509.281.038-62（CPF） [email protected](EMAIL） 12345678911（PHONE） 01eb9090-73e5-4187-b43d-0d80a149e1dc(EVP: UUID-like string.)
accountType	String	Yes	Beneficiary account type 03：CPF 04：EMAIL 05：PHONE 06：EVP
callbackUrl	String	No	Callback address For details, see Notification Callbacks
countryId	String	Yes	Country number Reference: Dictionary table - country number Brazil, BRA
currency	String	Yes	Currency Reference: Dictionary Table - Currency BRL
customerName	String	Yes	Beneficiary's name
customerIdentification	String	No	User Document Number (CPF)
merId	String	Yes	Merchant ID Merchant ID acquisition path: Supefina Merchant Background - Merchant Management - Basic Information - Merchant ID
merOrderNo	String	Yes	Merchant order number
nonceStr	String	Yes	Random strings The length cannot exceed 32 bits
orderAmount	String	Yes	The amount of the order
payProduct	String	Yes	Payment type PIX：24
sign	String	Yes	signature For details, please refer to: Signature algorithm

Sample request

{
    "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"
}

Response parameters

Variable name	type	description
code	String	Response coding For details, see Response Status Code
data	Object	Response data
amount	BigDecimal	The amount of the order
fee	BigDecimal	Advance handling fee will be charged
merCode	String	Merchant ID
merOrderNo	String	Merchant order number
supefinaOrderNo	String	Supefina order number
transactionStatus	String	Order status Whether the initiation status of the order is successful or not has nothing to do with the real transaction status of the order. 00: The order is successful 04: Failed to place an order
msg	String	Response Information

Sample response

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

Callback notifications

Submission method:POST

Variable name	type	description
amount	String	The amount of the order
countryId	String	Country number Reference: Dictionary table - country number Peru, PER
customerName	String	Beneficiary's name
fee	String	Advance handling fee will be charged
merId	String	Merchant ID
merOrderId	String	Merchant order number
msg	String	message
nonceStr	String	Random strings The length cannot exceed 32 bits
realityAmount	String	Paid-in amount
realityFee	String	Actual handling fee
sign	String	signature
status	String	Transaction status For details, please refer to: Dictionary Table - Trading Order Status
successTime	String	The time at which the transaction was successful
supefinaOrderId	String	Supefina order number
transactionType	String	The type of transaction 01：Payin 02：Payout

An example of a callback notification

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

Callback notification response

After the merchant successfully receives the callback, it needs to return the specified string synchronously: SUCCESS does not return or returns other content by default, and the notification fails As:

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