Pix

ℹ️
Please refer to the API Reference for the full request and response examples.

In Pix, the transmission of the payment order and the availability of funds to the receiving user takes place in real time, 24 hours a day and without the need for intermediates. Thus, it is a type of payment method that enables fast payments with lower transaction costs.

⚠️
Pix is currently available for providers Cielo 3.0 and Bradesco. First, you need to contact the provider in order to authorize this type of payment method.

The life cycle of a Pix transaction is as follows:

SEQUENCE	RESPONSIBLE	DESCRIPTION	TRANSACTION STATUS
1	Merchant	Generates the QR Code.	12 - Pending
2	Shopper	Pays QR Code.	2 - Paid
3	Merchant	Receives payment confirmation notification.	2 - Paid
4	Merchant	Queries the transaction status.	2 - Paid
5	Merchant	Releases order.	2 - Paid
6	Merchant	If necessary, requests refund of the Pix transaction (similar to card refund).	2 - Paid
7	Merchant	Receives refund confirmation notification.	11 - Refunded
-	Merchant	Queries the transaction status.	11 - Refunded

Creating a transaction with QR code Pix

You can generate a Pix QR code through Gateway API by simply performing the integration as specified below.

Among the required request fields, two stand out:

Type, which must be sent as "Pix";
Provider, which must be "Cielo30" or "Bradesco2".

The response for the request will return the base64 encoded QR Code Pix image, which must be made available to the shopper.

See below the representation of the transactional flow in QR code Pix generation:

The shopper then performs the QR code reading through one of the Pix payment enabled applications and makes the payment. In this step, there is no participation of the store or Braspag, as shown below:

Below we show a request example for generating the QR code Pix:

Request for creating the QR Code Pix

{ 
   "MerchantOrderId":"2020102601",
   "Customer":{
      "Name":"Nome do Pagador",
      "Identity":"12345678909",
      "IdentityType":"CPF"
   },
   "Payment":{ 
      "Type":"Pix",
      "Provider":"Bradesco2",
      "Amount":100,
      "QrCodeExpiration":86400
   }    
}

Requesting a Pix Refund

If the merchant needs to "cancel" a Pix transfer, it is possible to perform an operation called a "refund". It is important to note that the refund is not an instant operation, and can be complied with or not by the Pix provider. When a refund is accepted, the store receives a notification.