​
O que é uma Cobrança?

Uma cobrança (charge) representa uma solicitação de pagamento. Quando você cria uma cobrança, geramos o meio de pagamento (QR Code PIX, link de cartão, boleto) para o cliente pagar.

​
Tipos de Cobrança

​
PIX

Pagamento instantâneo via PIX. Confirmação em segundos. 
{
  "billing_type": "PIX",
  "value": 99.90,
  ...
}
Retorno: QR Code + código copia-e-cola

​
Cartão de Crédito

Pagamento com cartão de crédito. Suporta parcelamento. 
{
  "billing_type": "CREDIT_CARD",
  "value": 99.90,
  ...
}
Retorno: Link de pagamento ou processo via token Cria um link onde o cliente escolhe como pagar. 
{
  "billing_type": "UNDEFINED",
  "value": 99.90,
  ...
}
Retorno: URL do checkout

​
Status das Cobranças

StatusDescrição
PENDINGAguardando pagamento
RECEIVEDPagamento confirmado
OVERDUEPagamento vencido
REFUNDEDPagamento estornado
CANCELLEDCobrança cancelada

​
Ciclo de Vida

  1. Criar cobrança → Status PENDING
  2. Cliente paga → Status RECEIVED
  3. Prazo expira → Status OVERDUE
  4. Estorno → Status REFUNDED

​
Expiração

  • PIX: 1 hora (configurável até 24h)
  • Boleto: Data de vencimento definida
  • Link: 24 horas (padrão)

​
Valores

Cada cobrança tem:
CampoDescrição
valueValor bruto cobrado do cliente
net_valueValor líquido que você recebe
platform_feeTaxa da plataforma
reserve_amountValor em reserva (5%)

​
Exemplo

{
  "value": 100.00,
  "net_value": 86.93,
  "platform_fee": 8.49,
  "reserve_amount": 4.58
}

​
Metadados

Use o campo external_reference para vincular a cobrança ao seu sistema: 
{
  "billing_type": "PIX",
  "value": 99.90,
  "external_reference": "PEDIDO-12345",
  ...
}
Isso facilita reconciliação e rastreamento.

​
Webhook de Pagamento

Quando uma cobrança é paga, você recebe um webhook: 
{
  "event": "payment.received",
  "data": {
    "payment_id": "abc123",
    "value": 99.90,
    "status": "RECEIVED"
  }
}
Veja mais em Webhooks.