Pular para o conteúdo
Referência

Endpoints /v1

117 endpoints de integração, agrupados por domínio. Todos aceitam API key; o escopo exigido aparece em cada um.

Transações

Todas as entradas numa lista só — PIX, boleto, cartão, cripto, checkout, link, assinatura e depósitos. Método e origem são filtros.

6 endpoints

PIX

Cobranças PIX com QR Code (copia e cola), recebimentos e depósitos na conta.

10 endpointsProduto PIX

Boleto

Boletos registrados com juros, multa, desconto e PDF.

5 endpointsProduto BOLETO

Cartão

Pagamentos com cartão tokenizado. O número do cartão e o CVV nunca chegam à BOSS Pay — só o token do adquirente.

8 endpointsProduto CARD

Cripto e câmbio

Recebimento em stablecoins (USDT/USDC) e cotações BRL ↔ stablecoin. A execução da conversão é feita pelo painel (exige 2FA).

9 endpointsProduto CRYPTO / FX

Clientes

Cadastro de pagadores reaproveitado em cobranças e assinaturas.

3 endpoints

Checkout

Checkout hospedado com itens, métodos, cupons e campos personalizados.

6 endpointsProduto CHECKOUT

Links de pagamento

Links com valor fixo ou aberto, limite de usos e validade.

6 endpointsProduto LINK

Assinaturas

Planos, assinaturas, faturas, cupons e política de retentativa (dunning).

25 endpointsProduto RECURRING

Split

Recebedores, regras de divisão e repasses.

12 endpointsProduto SPLIT

Financeiro e conta

Saldos, extrato, recebíveis e liquidações. Transferências de saída são criadas só pelo painel (com 2FA); via API, apenas consulta.

13 endpoints

Relatórios

Exportações assíncronas (CSV/XLSX/PDF) geradas pelo worker.

4 endpoints

Máquinas (POS)

Terminais, lojas e solicitações de máquina.

8 endpoints

Catálogo

Produtos BOSS Pay e o status de cada um para a sua empresa.

2 endpoints

Fora da API

Equipe, dados da empresa, chaves de API, webhooks, suporte, transferências de saída, beneficiários e execução de conversão são feitos apenas pelo painel, com usuário autenticado.