PIX

（payProduct=24）

payment process

1. The user places an order on the merchant's website and selects PIX payment;

2. The merchant initiates a PIX payment request to Supefina;

3. Supefina returns the PIX payment URL information;

4. The merchant displays the payment URL to the user;

5. The user opens the URL to display the QR code and pays according to the page prompts;

6. The payment is successful;

7. Supefina notifies the merchant that the order is successful.

Pay for videos

7MB

PIX支付视频.mp4

Cashier link request address

The name of the environment	URL
SandBox	POST http://8.130.9.219:8899/api/supefina/transactions/payin
Formal environment	POST https://api.supefina.net/api/supefina/transactions/payin

Request parameters

Request header

Key	Value
Content-Type	application/json

Request body

Variable name	type	Required	description
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 Real：BRL
customerPhone	String	No	Mobile phone number
customerEmail	String	Yes	The user's email address
customerIdentification	String	No	User Document Number（CPF）
customerName	String	Yes	User's name
description	String	Yes	Description of the order No special symbols
expireTimeL	Long	No	Expiration time Unit: seconds This expiration time does not take effect, and defaults to 12 hours
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 Two decimal places are supported; 3 >= orderAmount <= 50000
payProduct	String	Yes	Payment type PIX：24
sign	String	Yes	signature For details, please refer to: Signature algorithm

Sample request

{
    "callbackUrl": "https://test.com",
    "countryId": "BRA",
    "currency": "BRL",
    "customerEmail": "[email protected]",
    "customerIdentification": "123456789-09",
    "customerName": "test name",
    "description": "test description",
    "merId": "8202759583060992",
    "merOrderNo": "1234777f35edb1965949059290",
    "nonceStr": "mFI99d699u",
    "orderAmount": "10.00",
    "payProduct": "24",
    "sign": "226736F20763B930BEBFDABE342F7538"
}

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
channelName	String	The name of the channel
fee	BigDecimal	Advance handling fee will be charged
merCode	String	Merchant ID
merOrderNo	String	Merchant order number
referenceCode	String	QR code for receiving money (expires in 12 hours)
supefinaOrderNo	String	The amount of the order
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
url	String	Transaction link (10-minute countdown expires at the cashier)
msg	String	message

Sample response

{
    "code": "200",
    "data": {
        "amount": 10.00,
        "channelName": "brpix",
        "fee": 0.04,
        "merCode": "8202759583060992",
        "merOrderNo": "1234777f35edb1965949059290",
        "referenceCode": "00020126920014br.gov.bcb.pix2570qrcodes.sulcredi.coop.br/v2/v3/at/97036e99-cb37-4432-a63a-aee049738d115204000053039865802BR5908ARK PAGO6009SAO PAULO62070503***63046E32",
        "supefinaOrderNo": "20240513050101498940f64291983",
        "transactionStatus": "00",
        "url": "https://h5.supefina.net/supefina?token="
    },
    "msg": "success "
}

Callback notifications

Submission method:POST

Variable name	type	description
amount	String	The amount of the order
countryId	String	Country number
customerName	String	Payer's name
fee	String	Advance handling fee will be charged
merId	String	Merchant code
merOrderId	String	Merchant order number
msg	String	Information
nonceStr	String	Random strings
payerIdNumber	String	Payer CPF
payerName	String	Payer's name
realityAmount	String	Paid-in amount
realityFee	String	Actual handling fee
reference	String	identifier
sign	String	signature
status	String	Transaction status For details, please refer to: Dictionary Table - Trading Order Status
successTime	Date	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": "10.00",
    "countryId": "BRA",
    "customerName": "test name",
    "fee": "0.04",
    "merId": "8202759583060992",
    "merOrderId": "1234777f35edb1965949059290",
    "nonceStr": "7f00fe52-15c7-40e0-a881-6d98a5",
    "payerIdNumber": "15169686463",
    "payerName": "pay person name",
    "realityAmount": "10.00",
    "realityFee": "0.04",
    "reference": "E228964319624061706672exq6TZQQ99",
    "sign": "37AB65F3A0C4743651005CBB1C4639F4",
    "status": "01",
    "successTime": 1718604452000,
    "supefinaOrderId": "20240513050101498940f64291983",
    "transactionType": "01"
}

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