Introdução

Nossa API permite controle completo das funcionalidades do Pix, como geração de chave, recebimento através de QR Code dinâmico e estático, além de envio de dinheiro (pagamentos) através de chave pix, dados dados bancários e QR Codes.

Esta sessão de nossa documentação foca em orientá-lo no recebimento através de Pix. Para entende como fazer o envio de dinheiro (pagamentos), verifique a sessão de transferências.

Existem três maneiras de receber via Pix:

• Gerar uma cobrança com a forma de recebimento "PIX" que realiza as notificações de cobrança automaticamente para o seu cliente e que também permite recuperar o QrCode Dinâmico após a sua criação;
• Cadastrando uma chave e informando-a ao seu cliente;
• Criando um QrCode estático.

📘

Ao receber um pagamento através da chave Pix ou um QrCode estático, um cliente e uma cobrança serão criados automaticamente para registro desse pagamento em sua conta.

Recebendo cobranças e transferências via Pix

O primeiro passo para receber cobranças ou transferências via Pix é criar uma chave Pix em sua conta.

🚧

Esta é uma funcionalidade que só estará habilitada após a sua conta estar 100% aprovada e a prova de vida ter sido realizada.

Criando uma chave Pix

No momento, através da API é possível criar somente chaves aleatórias (EVP). Lembramos que há uma restrição no número de chaves que cada conta pode criar: 5 para pessoa física e 20 para pessoa jurídica.

POST /v3/pix/addressKeys
Confira a referência completa deste endpoint

{
  "type": "EVP",
}

📘

Por limitações aplicadas pelo Banco Central, deve-se aguardar 1 minuto entre cada chave criada para uma conta.

O Banco Central também aplica os limites de chaves por conta informados acima.