Cobranças e Faturas

Crie cobranças com múltiplos itens, emita PIX ou Boleto e compartilhe um link de pagamento com seu cliente.
Resumo Rápido

Crie produtos no catálogo, cadastre pagadores e emita cobranças via POST /api/v1/invoices. Cada cobrança pode ter múltiplos itens, vencimento, multa e juros. Após emitir, um link público é gerado para o pagador pagar via PIX ou Boleto sem precisar de cadastro.

0. Pagadores com Endereço

Para emissão de boletos, alguns provedores exigem endereço completo do pagador (logradouro, cidade e UF). Caso o provedor selecionado requisite esses dados, a API retornará um erro 422 com a orientação dos campos necessários.

Criar Pagador com Endereço 
{
  "name": "João Silva",
  "document": "123.456.789-00",
  "email": "joao@email.com",
  "address_street": "Rua Exemplo",
  "address_number": "123",
  "address_complement": "Apto 45",
  "address_district": "Centro",
  "address_city": "São Paulo",
  "address_state": "SP",
  "address_postal_code": "01001-000"
}

1. Produtos (Catálogo)

Antes de criar uma cobrança, cadastre seus produtos/serviços no catálogo:

Criar Produto 
POST /api/v1/products
Authorization: Bearer SEU_TOKEN
{
  "name": "Curso de Marketing Digital",
  "type": "digital",
  "price": 497.00,
  "currency": "BRL",
  "status": "active"
}

2. Pagadores

Cadastre a pessoa que vai pagar a cobrança (opcional, mas necessário para Boleto):

Criar Pagador 
POST /api/v1/payers
Authorization: Bearer SEU_TOKEN
{
  "name": "João Silva",
  "document": "123.456.789-00",
  "email": "joao@email.com"
}

3. Criando uma Cobrança

Crie uma cobrança com itens avulsos ou vinculados a produtos do catálogo:

POST /api/v1/invoices 
{
  "payer_name": "João Silva",
  "description": "Curso de Marketing Digital",
  "due_date": "2026-08-15",
  "fine_rate": 2.0,
  "interest_rate": 0.033,
  "items": [
    {
      "description": "Curso Completo",
      "quantity": 1,
      "unit_price": 497.00
    }
  ]
}

A cobrança é criada em status draft (rascunho).
O response inclui o id da invoice e o invoice_number gerado automaticamente.

4. Emitindo PIX ou Boleto

Após criar a cobrança, emita um PIX ou Boleto para o pagador:

POST /api/v1/invoices/{id}/issue 
{
  "payment_method": "pix"
}

Métodos: pix (gera QR Code) ou boleto (boleto registrado)

Ao emitir, a cobrança vai para status pending e um Deposit é criado. O sistema roteia automaticamente entre os provedores disponíveis conforme prioridade.

Boleto Registrado
  • Valor: Convertido automaticamente para centavos (R$ 49,90 → 4990)
  • Multa: Percentual (2,0%) ou valor fixo
  • Juros: Percentual ao mês ou valor fixo ao dia
  • Split: Distribuição automática entre contas
  • Boleto PDF: Disponível após confirmação via webhook

https://app.ajnapay.com.br/pagamento/{token}

Compartilhe este link com seu cliente — ele paga sem precisar de cadastro!

5. Link de Pagamento (Portal do Pagador)

O link de pagamento é público (não requer autenticação).
O pagador vê os detalhes da cobrança e pode pagar via PIX ou Boleto.

O que o pagador vê

  • Número da fatura e valor
  • Data de vencimento, multa e juros
  • Itens da cobrança
  • Botão para pagar com PIX (QR Code)
  • Botão para gerar Boleto
  • Confirmação com animação após pagamento

6. Status da Cobrança

Status Descrição
draftRascunho — criada mas não emitida
pendingPendente — aguardando pagamento
paidPaga — pagamento confirmado
overdueVencida — data de vencimento passou
cancelledCancelada
refundedEstornada

7. Comprovante e Recibo

Após o pagamento, o sistema redireciona automaticamente o pagador para uma tela de comprovante com todos os dados da transação (valor, data, ID, recebedor, itens da cobrança). O comprovante também fica acessível via link permanente:

Link permanente do comprovante 
https://ajnapay.com.br/comprovante/{depositId}
Para o pagador
  • Ao pagar, é redirecionado ao comprovante automaticamente
  • Botão Compartilhar no WhatsApp com preview bonito
  • Botão Copiar link do comprovante
  • O link da cobrança original também ganha botão Ver comprovante
Para o recebedor (dashboard)
  • Botão 📄 Comprovante na listagem de depósitos
  • Mesmo botão no extrato de transações (deposits pagos)
  • Na tela de detalhes da cobrança, aba Pagamentos
  • Link permanente — pode enviar ao pagador por WhatsApp/email

8. Webhooks

Quando a cobrança é paga, o sistema atualiza automaticamente o status. Se você configurou um postback_url na criação da invoice, receberá uma notificação.

Próximos passos

Consulte a documentação de splits para distribuir valores entre contas, ou veja a API Reference completa para detalhes de todos os endpoints.