Skip to main content
Entenda os termos que aparecem em toda a documentação antes de integrar.

​
Conta merchant

Cada integrador possui uma conta com status (PENDING, ACTIVE, SUSPENDED, CLOSED), saldo em BRL e usuários vinculados. Operações financeiras geram transações no extrato com tipo, direção (CREDIT / DEBIT), status e metadados públicos enxutos.

​
Trilho PIX: PADRAO

O trilho PADRAO é o único trilho operacional da API pública. Cobre conta verificada (CPF ou CNPJ), PIX regulado, reembolso, MED no SPI, cobranças, assinaturas e loja completa (PIX e cripto). O trilho ativo na API pública é definido na chave de API ao criá-la. Não envie pixRail no body das rotas /v1/*.

​
Saldo: disponível, pendente e bloqueado

Regra de saque: novas transferências PIX só são aceitas se o disponível cobrir o valor mais operações pendentes.

​
Verificação (KYC)

Contas passam por verificação (PENDING, SUBMITTED, APPROVED, REJECTED). Recursos do trilho PADRAO exigem verificação aprovada.

​
Nomes que confundem

Mapa completo: Rotas da API.
Cobranças e assinaturas: boleto, cartão e PIX comercial na Conta Padrão — veja Cobranças e assinaturas.

​
Subcontas merchant

Subcontas são carteiras lógicas sob a conta principal. Habilitação exige solicitação em Contas → Subcontas no app. PIX e saques usam subaccountId nas rotas normais de pagamento. Guia de subcontas

​
Envelope e referências

Toda resposta v1 segue:

​
Webhooks

Eventos de negócio chegam por POST HTTPS com assinatura HMAC (whsec_...). Tutorial: Webhooks na prática.

​
Glossário

Termos adicionais: Glossário.