This section provides the Pix glossary
CPF
The CPF (Cadastro de Pessoas Físicas) is a tax identification number used in Brazil for individuals, akin to a social security number. It is required for financial transactions, opening bank accounts, and paying taxes.
JSON format: 26821152098
Format validation: ^[0-9]{11}$
CNPJ
The CNPJ (Cadastro Nacional da Pessoa Jurídica) is a tax identification number for companies in Brazil. It’s used for commercial purposes like opening bank accounts, issuing invoices, and paying taxes.
JSON format: 58255572000100
Format validation: ^[0-9]{14}$
Pix Key
A Pix key acts as a unique identifier to receive instant payments in Brazil. It can be linked to a CPF, CNPJ, phone number, email, or a randomly generated key, simplifying payment processes without sharing sensitive banking information.
Pix Key Types
| Key Type | Description | Format Validation | |
|---|---|---|---|
| CPF | CPF of the user | ^[0-9]11$ | |
| CNPJ | CNPJ of the company | ^[0-9]14$ | |
| Celphone Number | Celphone Number | ^+[1-9][0-9]\d14$ | |
| E-mail address | ^[a-z0-9.!#$&'*+/=?^_`{ | }~-]+@a-z0-9?(?:.a-z0-9?)*$ | |
| EVP (Random Key) | Random Key Generated by Central Bank | [0-9a-f]8-[0-9a-f]4-[0-9a-f]4-[0-9a-f]4-[0-9a-f]12$ |
MTLS
Mutual Transport Layer Security (MTLS) adds an extra layer of authentication between client and server, ensuring both are authenticated before establishing a secure connection. This is crucial in banking scenarios. Both test and production certificates are self-signed, requiring integration teams to account for this.
TransactionId
This unique identifier is used to track specific Pix transactions, crucial for payment reconciliation. It can be generated automatically or provided by the partner but must be unique per recipient.
Length: 26 to 35 characters
Valid characters: A-Z, a-z, 0-9
Format validation: ^[A-Za-z0-9]{26,35}$
Payment Status (CashIn)
| Message | Description | Descrição |
|---|---|---|
| ATIVA | REMOVIDO_PELO_PSP | QrCode ativo (Nao pago, Nao expirado) |
| LIQUIDATED | QrCode Paid | QrCode Pago |
| CONCLUIDA (Status from Get Dynamic) | QrCode Paid | QrCode Pago |
| REMOVIDO_PELO_USUARIO_RECEBEDOR | QrCode deactivated by the processor | QrCode Desativado pelo Processador |
| REMOVIDO_PELO_PSP | QrCode expired and deactivated by the bank | QrCode expirado e desativado pelo banco |
Transfer Status (CashOut)
| Message | Description | Descrição |
|---|---|---|
| CANCELED | Transfer Canceled | Transferencia Cancelada |
| PROCESSING | Transfer is being Processed. | Em Processamento |
| LIQUIDATED | Transfer Concluded/Paid | Transferencia Realizada |
| WAITING_CONFIRMATION | Waiting Confirmation (From Receiver) | Aguardando Confirmação (Do Recebedor) |
| ON_QUEUE | On Queue (Internal) | Em Fila (Interna) |
| REFUNDED | Refunded (By The Receiver's Bank) | Extornado (Pelo Banco Recebedor) |
| PARTIALLY REFUNDED | Refunded Partially | Extornado Parcialmente |
| WAITING_SETTLEMENTCORE | Waiting | Aguardando |