Início

API de pagamentos Pix.

Endereços #

Credenciais #

Peça ao seu contato comercial. Você recebe:

1. o client_id (o nome curto da sua conta, como loja01);
2. o client_secret, entregue uma vez por canal seguro. Guarde-o em cofre: ele não é mostrado de novo;
3. a lista de escopos concedidos.

Com os três, siga para Autenticação.

Regras que valem em toda a API #

• Dinheiro é string decimal com duas casas: "150.00". Nunca número.
• Instantes são RFC 3339 em UTC: 2026-09-18T12:00:00Z. Datas de extrato são o dia contábil em America/Sao_Paulo.
• Identificadores de cobrança, saque e sub-conta são seus: 26 a 35 caracteres alfanuméricos. O id da devolução também é seu, com 1 a 35. Recomendamos ULID.
• CPF tem 11 dígitos, sem pontuação. CNPJ tem 14 posições, sem pontuação: as 12 primeiras podem ser dígitos ou letras maiúsculas, e as 2 últimas são dígitos, como 12ABC34501DE35. Guarde o CNPJ como texto, nunca como número.
• Toda resposta traz x-correlation-id, inclusive a do pedido de token. Guarde-o para falar com o suporte.
• Seu parser deve tolerar campos e valores novos.

Para a máquina #

• llms.txt: a lista destas páginas, uma frase cada.
• A especificação OpenAPI das rotas /v2/ex/ é servida em GET /v2/openapi.yaml. As rotas de cobrança, Pix recebido e devolução seguem o padrão do Banco Central e não estão nessa especificação.