Pular para o conteúdo
Developers

API BOSS Pay

Receba por PIX, boleto, cartão e stablecoins, crie checkouts, links e assinaturas, divida pagamentos e acompanhe o financeiro — tudo por uma API REST com JSON.

Primeira requisição

Crie uma chave bp_test_… em Painel › Desenvolvedores › API Keys e gere uma cobrança PIX no Sandbox. Nada no Sandbox movimenta dinheiro real.

curl
curl -X POST https://api2.bosspay.io/v1/pix/charges \
  -H "Authorization: Bearer bp_test_SUA_CHAVE" \
  -H "Content-Type: application/json" \
  -H "Idempotency-Key: pedido-1042" \
  -d '{
    "amount": "15990",
    "description": "Pedido #1042",
    "customer": { "name": "Maria Souza", "document": "12345678909" },
    "externalId": "1042"
  }'

A resposta traz a transação com status: "PENDING" e, em pix.qrCodeText, o copia e cola para o pagador. Quando o pagamento for confirmado você recebe o webhook payment.approved.

Convenções

  • URL base: https://api2.bosspay.io. Todas as rotas de integração começam em /v1.
  • Valores monetários em unidade mínima (centavos; 6 casas para USDT/USDC), sempre devolvidos como string para não perder precisão. Envie como string ("15990") ou inteiro.
  • Datas em ISO 8601 (UTC). Filtros de período usam AAAA-MM-DD no fuso da empresa.
  • Toda resposta tem o cabeçalho x-request-id; informe-o ao suporte. Você pode enviar o seu próprio (8 a 64 caracteres).
  • O ambiente (Sandbox ou Produção) é definido pela chave usada — não existe parâmetro de ambiente.
  • Limite padrão: 600 requisições por minuto por chave. Acima disso, HTTP 429.