Payments Pix

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.

Creates a Payment to be effectuated by PIX

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.

Headers

Name	Type	Description
Authorization*	String	Bearer Token
Content-Type*	String	application/json
User-Agent*	String	Empresa X ([e-mail])

Request Body

Name	Type	Description
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.

200 Payment Generated

{
    "message": "Pagamento PIX gerado com sucesso.",
    "data": {
        "qr_code_url": "https://chart.googleapis.com/chart?chs=150x150&cht=qr&chl=8CrYvbyo.PAGSTARMOCK2022.l5vHCG7JFsuy.0iAHBEkl1eriivlj2D2Q3lT5",
        "favoured": "Pagstar Serviços de Pagamentos",
        "external_reference": "b29c4984-e662-4755-b20e-4138bc265007",
        "checkout": "https://dev-checkout.pagstar.com/payment/pix/b29c4984-e662-4755-b20e-4138bc265007",
        "pix_key": "8CrYvbyo.PAGSTARMOCK2022.l5vHCG7JFsuy.0iAHBEkl1eriivlj2D2Q3lT5"
    }
}

404: Not Found Tenant not found

{
    "message": "Tenant não encontrado",
    "data": []
}Good to know: This API method was created using the API Method block, it's how you can build out an API method documentation from scratch. Have a play with the block and you'll see you can do some nifty things like add and reorder parameters, document responses, and give your methods detailed descriptions.

401: Unauthorized Unauthorized

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

Test's Documents

To perform the payment tests, we recommend using the documents below:

Checkout

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.

Webhook

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.

Webhook

Pooling

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.

Payment Pooling