Instant Pix

Lina's Instant Pix APIs simplify payment initiation, dramatically reducing the time and resources required to offer a modern, efficient payment experience powered by Open Finance — one of the biggest innovations in the Brazilian financial market.

With this API suite, you can list the financial institutions enabled for payment under your ITP, open a payment consent, and confirm the payment status end-to-end — all without the payer leaving your product until the authentication step at their bank.

How the flow works

Call GET /api/v1/open-integration/participants/registered to retrieve the list of institutions registered and enabled to operate payments under your ITP. Let the end user pick the payer's bank.
Call POST /api/v1/open-integration/consents to open a payment request. The response includes a redirectUrl that the end user must visit to authenticate at the bank and approve the consent.
After the payment flow finishes at the bank, the user is redirected back to the redirectUri you provided in the body of POST /consents. Keeping that URL live is your responsibility.
The callback query string carries the paymentLinkId. Use it to call GET /api/v1/payments/requests/{paymentRequestId} and confirm the status: look for status: CONSUMIDO on the payment request, and status: PAGO (or status: PENDENTE for payments scheduled in the future) on each payment inside the payments array.

Flow diagram

Carregando diagrama…

Instant Pix end-to-end flow — End user, Initiator site, Initiation API (Lina) and Account holder

Payment status values

The status enums below come back on the GET /payments/requests/{id} response. The request-level status describes the overall consent state, while the payment-level status describes each payment inside the request.

Payment request status

Status	Meaning
`PENDENTE`	The consent has been created but the user has not authorized it yet.
`EM_PROCESSAMENTO`	The consent is being processed by the account holder.
`CONSUMIDO`	The consent was authorized and the payment(s) were submitted. This is the terminal happy-path status.
`EXPIRADO`	The consent expired before the user authorized it.
`CANCELADO`	The consent was cancelled before completion.
`ERRO_NA_DETENTORA`	The account holder returned an error while processing the consent.
`ERRO`	Generic error state during consent processing.

Payment status

Status	Meaning
`PENDENTE`	The payment is scheduled but not settled yet (common for future-dated payments).
`EM_PROCESSAMENTO`	The payment is being settled by the account holder.
`PAGO`	The payment was settled successfully. This is the terminal happy-path status.
`REJEITADO`	The account holder rejected the payment.
`EXPIRADO`	The payment expired before settlement.
`CANCELADO`	The payment was cancelled.
`ERRO_NA_DETENTORA`	The account holder returned an error during settlement.
`ERRO`	Generic error state during payment processing.

Next steps

Get registered participants — list institutions enabled for your ITP.
Create a consent — open a payment request and obtain the redirectUrl.
Get payment request — confirm the final payment status.