How to Use the Service

The Pix Payments API includes a set of RESTful endpoints that expose the Pix instant payments platform and enable you to transfer funds using QR codes and Pix keys. The functionality includes:

Pay-Ins

Generate a dynamic QR code: Within your website, consumers can request a QR-based payment and receive a dynamic QR code that guarantees a contactless, instant, and successful payment.
Create a static QR code: Easily share your payment data with your consumers via a static QR code.
Retrieve a QR-code pay-In: Get comprehensive information about a payment sent via a QR code.
List Pay-Ins: Retrieve detailed information about direct deposits and inbound reversals.
Retrieve a dynamic QR code: Get a previously issued code.
Note: This endpoint is a future development and is not currently available.

Payouts

Create a Pix withdrawal: Within your website, consumers can request a withdrawal of funds anytime and seamlessly receive their money in the indicated account in a few seconds. Withdrawing funds is a two-step process: Preview and Confirm. Creating outbound reversals is also supported. Reversals enable you to refund previously completed pay-ins (deposits), and they follow the withdrawal flow, using the same endpoints and procedures.
Retrieve a Pix withdrawal: Get a previously enabled payout or outbound reversal.

Notifications

Receive webhook notifications: Set up a callback URL where the webhook delivers automatic updates on your account's pay-in and payout events.

Taxpayer Identification Number

The Brazilian equivalents of tax registration numbers are as follows:

CPF (Cadastro de Pessoas Físicas): Taxpayer ID of individuals. It has 11 numbers, nine base digits followed by two check digits, resulting from an arithmetic operation on the first nine numbers.
CNPJ (Cadastro Nacional de Pessoas Jurídicas): Taxpayer ID of legal entities. It is a 14-digit number, with 12 base digits and two check digits at the end that result from an arithmetic formula of the base numbers.

To avoid rejected transactions, ensure your client application provides the API with a valid CPF or CNPJ. For a description of the validation algorithms, check out the following writings:

And these example projects: