This documentation describes how to perform a payment with Pix QR Code
If the customer pays the pix through his banking application, Pagstar will send a notification using webhook.
Fields with * are required. The others are considered optional.
The fields name and document are optionals, but we recommend tha you use both to reduce fraude. If you pass the name, the document field will be required. If you submit a document, the name field will be required. Either you send both data, or you send none.
POST
https://api.pagstar.com/api/v2/wallet/partner/transactions/generate-anonymous-pix
PIX is a free instant method of paying in Brazil. It is offered and processed by BACEN (Brazil's Central Bank). Customer may pay the PIX generated by this endpoint on his/her personal bank app.
Name | Type | Description |
---|---|---|
Name | Type | Description |
---|---|---|
The default expiration time for a qrcode is 3600 seconds.
Minimum value to payment is 0,20 BRL
Maximum value to payment is 10.000,00 BRL
To create your payment screen, you can convert the data.pix_key property to an image, or use data.qr_code_url which is in image format. For the copy and paste, use the data.pix_key property
To perform the payment tests, we recommend using the documents below:
We also provide a transparent checkout to reduce your development time. To use it, simply use the data.checkout property of the response json.
We recommend that you create your checkout screen on your site, many users do not like to switch sites to make payments.
Basically it's a "let me know back at a certain URL when you have updates on this transaction". When Pagstar finalizes the processing of a transaction, you will receive on your configured URL the status of it.
Once you have created a transaction, your application makes several requests to Pagstar to check the status of the transaction, until Pagstar returns that it has been paid.
Authorization*
String
Bearer Token
Content-Type*
String
application/json
User-Agent*
String
Empresa X (contato@empresa.com)
value*
numeric
Amount to be paid in real unit, and consider cents as decimal
callback
String
The callback which the user may be redirected after payment on checkout
tenant_id*
String
ID of the used tenant
name
String
Customer's name
document
String
Customer's document (CPF or CNPJ with or without points)
expiration
numeric
Time in seconds to expire qrcode
transaction_id
String
Your system reference
description
String
Description that appears on the proof of payment. Usually you put the name of the company or website. Maximum 50 characters.