Cobranças — API | Gateway Crédito Direto

GET/chargesAutenticado

Listar cobranças

Retorna as cobranças da conta autenticada, com receivables (Pix e/ou boleto), pagamentos e status.

https://gateway.credito-direto.com/api/charges

cURL

curl --request GET \
  --url 'https://gateway.credito-direto.com/api/charges' \
  --header 'accept: application/json' \
  --header 'authorization: Bearer TOKEN'

Query string

Campo	Tipo	Obrigatório	Descrição
receivable_status	string \| string[]	Não	Filtra pelo status do receivable: created, processing, paid, refunded, canceling, canceled.
page_size	number	Não	Quantidade de itens por página.

Exemplo de resposta

Response JSON

{
  "items": [
    {
      "id": "chg_01",
      "payment_methods": ["pix", "boleto"],
      "payer": {
        "name": "Maria Silva",
        "tax_id": "12345678909",
        "address": {
          "street": "Rua das Flores",
          "number": "100",
          "district": "Centro",
          "city": "São Paulo",
          "state": "SP",
          "postal_code": "01001000"
        }
      },
      "receivables": [
        {
          "id": "rcv_01",
          "status": "paid",
          "amount": 15035,
          "due_date": "2026-08-15",
          "description": "Parcela consignado — ref. 08/2026",
          "qrcode": { "id": "qr_01", "emv_payload": "00020126..." },
          "boleto": {
            "id": "bol_01",
            "barcode": "23791.12345 67890.123456 78901.234567 8 12340000015035",
            "linha_digitavel": "23791123456789012345678901234567812340000015035",
            "identification_number": "1234567890",
            "type": "other"
          },
          "payments": [
            {
              "id": "pay_01",
              "amount": 15035,
              "paid_with": "pix",
              "receipt_url": "https://gateway.credito-direto.com/comprovantes/pay_01",
              "created_at": "2026-08-10T14:22:00.000Z"
            }
          ],
          "created_at": "2026-08-09T12:00:00.000Z",
          "updated_at": "2026-08-10T14:22:00.000Z"
        }
      ],
      "created_at": "2026-08-09T12:00:00.000Z",
      "updated_at": "2026-08-10T14:22:00.000Z"
    }
  ]
}

GET/charges/:idAutenticado

Obter cobrança

Retorna o detalhe completo de uma cobrança, incluindo QR Code Pix e dados de boleto.

https://gateway.credito-direto.com/api/charges/:id

cURL

curl --request GET \
  --url 'https://gateway.credito-direto.com/api/charges/:id' \
  --header 'accept: application/json' \
  --header 'authorization: Bearer TOKEN'

Parâmetros de caminho

Campo	Tipo	Obrigatório	Descrição
id	string	Sim	Identificador da cobrança.

Responde `404` se a cobrança não existir na conta autenticada.

POST/chargesAutenticado

Criar cobrança

Emite uma cobrança com Pix, boleto ou ambos. Valores em centavos. Resposta `201` com a cobrança criada.

https://gateway.credito-direto.com/api/charges

cURL

curl --request POST \
  --url 'https://gateway.credito-direto.com/api/charges' \
  --header 'accept: application/json' \
  --header 'authorization: Bearer TOKEN' \
  --header 'content-type: application/json' \
  --data '{ "payment_methods": ["pix", "boleto"], "payment_method_details": { "boleto": { "type": "other" } }, "payer": { "name": "Maria Silva", "tax_id": "12345678909", "address": { "street": "Rua das Flores", "number": "100", "district": "Centro", "city": "São Paulo", "state": "SP", "postal_code": "01001000" } }, "amount": 15035, "due_date": "2026-09-15", "description": "Parcela consignado — ref. 09/2026", "external_id": "contrato-8841", "fine_type": "percentage", "fine_percent": 2, "interest_type": "percentage_per_month", "interest_percent": 1 }'

Corpo da requisição

Campo	Tipo	Obrigatório	Descrição
payment_methods	("pix" \| "boleto")[]	Sim	Pelo menos um meio. Use `pix`, `boleto` ou os dois.
amount	integer	Sim	Valor em centavos. Ex.: `15035` = R$ 150,35.
due_date	string (YYYY-MM-DD)	Sim	Data de vencimento.
expiration_date	string (YYYY-MM-DD)	Não	Data limite para pagamento após o vencimento.
description	string	Não	Texto exibido ao pagador e na conciliação.
external_id	string	Não	Seu identificador interno para conciliar com o seu sistema.
payer.name	string	Sim	Nome completo ou razão social do pagador.
payer.trade_name	string	Não	Nome fantasia (PJ).
payer.tax_id	string	Sim	CPF (11 dígitos) ou CNPJ (14 dígitos), somente números.
payer.address	object	Sim	street, number, district, city, state (UF com 2 letras), postal_code (mín. 8). complement é opcional.
payment_method_details.pix.pix_key	string	Não	Chave Pix de recebimento. Se omitida, usa a chave padrão da conta.
payment_method_details.boleto.type	"other" \| "proposal"	Não	Tipo do boleto. Padrão operacional: `other`.
payment_method_details.automatic_pix	object	Não	Pix Automático: frequency (weekly, monthly, quarterly, semi_annual, annual), retry_policy (not_allowed \| allow_three_in_seven_days), start_date, end_date?, fixed_amount?, max_amount_floor?, identifier (obrigatório).
fine_type / fine_percent / fine_amount	enum \| number \| integer	Não	Multa. `fine_type`: fixed \| percentage. Percentual ou valor em centavos.
interest_type / interest_percent / interest_amount	enum \| number \| integer	Não	Juros. Tipos: fixed_per_day, fixed_per_working_day, percentage_per_month, percentage_per_month_working_days.
discount_type / discount_percent / discount_amount / discount_dates	string \| number \| integer \| array	Não	Desconto. `discount_dates`: [{ amount?, percent?, date }] para descontos por data.

Exemplo de requisição

Body JSON

{
  "payment_methods": ["pix", "boleto"],
  "payment_method_details": {
    "boleto": { "type": "other" }
  },
  "payer": {
    "name": "Maria Silva",
    "tax_id": "12345678909",
    "address": {
      "street": "Rua das Flores",
      "number": "100",
      "district": "Centro",
      "city": "São Paulo",
      "state": "SP",
      "postal_code": "01001000"
    }
  },
  "amount": 15035,
  "due_date": "2026-09-15",
  "description": "Parcela consignado — ref. 09/2026",
  "external_id": "contrato-8841",
  "fine_type": "percentage",
  "fine_percent": 2,
  "interest_type": "percentage_per_month",
  "interest_percent": 1
}

O valor (`amount`, multa/juros/desconto em valor) é sempre em centavos.
Pix Automático exige `identifier` e `start_date`. `fixed_amount` também em centavos.

POST/charges/:id/cancelAutenticado

Cancelar cobrança

Cancela uma cobrança em aberto. Não é possível cancelar cobrança já paga.

https://gateway.credito-direto.com/api/charges/:id/cancel

cURL

curl --request POST \
  --url 'https://gateway.credito-direto.com/api/charges/:id/cancel' \
  --header 'accept: application/json' \
  --header 'authorization: Bearer TOKEN'

Parâmetros de caminho

Campo	Tipo	Obrigatório	Descrição
id	string	Sim	Identificador da cobrança.

Responde `404` se a cobrança não for encontrada.