Este endpoint permite criar cobranças, processar pagamentos, consultar detalhes e receber notificações via Webhook sobre eventos do ciclo de vida de uma cobrança.

---

Autenticação

Authorization: Bearer {API_TOKEN}
Content-Type: application/json

---

Criar Cobrança

Cria uma nova cobrança com regras de desconto, juros, multa, split e dados completos do pagador.

POST /charges

---

Request Body — Parâmetros

Dados principais da cobrança

---

Objeto charge_debtor — Dados do Pagador

---

Objeto charge_split — Split de Pagamento

---

Response — Sucesso

{
  "id": "chg_123456"
}

---

Processamento da Cobrança

Após a criação, a cobrança é processada de forma assíncrona.

O resultado é enviado via Webhook conforme o status do processamento.

---

Webhook — Cobrança Criada com Sucesso

Evento disparado quando a cobrança é registrada com sucesso.

Event

charge.created

Payload — Parâmetros

---

Webhook — Erro na Criação da Cobrança

Evento disparado quando ocorre falha no processamento.

Event

charge.error

Payload — Parâmetros

---

Consultar Detalhes da Cobrança

Retorna todas as informações da cobrança, incluindo pagamento, boleto, PIX e splits.

GET /charges/{charge_id}

---

Response — Parâmetros

Dados gerais

---

Dados de pagamento

---

Objeto charge_receiver

---

Objeto split (array)

---

Status da Cobrança

{
  "dueDate": "2024-08-30",
  "amount": "<number>",
  "fine": "<number>",
  "discountLimitDate": "2024-08-30",
  "discountValue": "<number>",
  "interest": "<number>",
  "chargeDebtor": {
    "number": "<string>",
    "neighborhood": "<string>",
    "name": "<string>",
    "document": "<string>",
    "city": "<string>",
    "publicArea": "<string>",
    "state": "<string>",
    "postalCode": "<string>",
    "phone": {
      "countryCode": "+200",
      "areaCode": "<string>",
      "number": "<string>"
    },
    "email": "<string>"
  },
  "daysToExpireAfterPayment": "<number>",
  "discountModality": "PERCENT"
}