Neofin V1
  1. Listando suas cobranças
Neofin V1
  • Inicie sua jornada na Neofin
  • Preparando seus ambientes
  • Versão 1
    • API de Cobranças
      • Upsert de Cobranças
        • Como realizar o upsert de uma cobrança
        • Upsert de Cobranças
          POST
      • Buscando uma cobrança
        • Como buscar uma única cobrança
        • Buscando pelo Integration Identifier
          GET
        • Buscando pelo Billing Number
          GET
      • Marcando uma cobrança como paga
        • Como marcar uma cobrança como paga
        • Marcando como paga
          PUT
      • Cancelando uma cobrança
        • Como cancelar uma cobrança
        • Cancelando uma cobrança
          PUT
      • Listando suas cobranças
        • Como listar suas cobranças
        • Todas as cobranças
          GET
        • Cobranças por status
          GET
        • Cobranças por cliente
          GET
        • Cobranças por data de atualização
          GET
        • Eventos de cobranças
          GET
        • Eventos de uma uma cobrança por Integration Identifier
          GET
        • Cobranças por data de pagamento
          GET
      • Enviando anexos
        • Como enviar anexos
        • Anexando uma NF a uma cobrança pelo Integration Identifier
          PUT
        • Anexando um Boleto a uma cobrança pelo Integration Identifier
          PUT
    • API de Clientes
      • Upsert de um cliente
        • Como realizar o upsert de um cliente
        • Upsert de clientes
          POST
      • Buscando um cliente
        • Buscando um cliente por Integration Identifier
          GET
        • Buscando um cliente pelo documento
          GET
    • Webhooks
      • Como preparar seus webhooks
    • FAQ
      • Dúvidas frequentes
  1. Listando suas cobranças

Todas as cobranças

GET
https://api.sandbox.neofin.services/billing
Last modified:2025-05-12 12:39:48
Request Request Example
Shell
JavaScript
Java
Swift
curl --location --request GET 'https://api.sandbox.neofin.services/billing?next_page_token=' \
--header 'api-key: ' \
--header 'secret-key: '
Response Response Example
200 - Example 1
{
  "billings": [
    {
      "customer_mail": "string",
      "fine": 0,
      "digest": "string",
      "status": "processing",
      "installments": 0,
      "nfe_number": "string",
      "customer_phone": "string",
      "fees": 0,
      "installment_type": "weekly",
      "billing_number": "string",
      "created_by_name": "string",
      "customer_document": "string",
      "origin": "string",
      "discount_before_payment": 0,
      "integration_identifier": "string",
      "customer_id": "string",
      "due_date": 0,
      "updated_at": 0,
      "issued_at": 0,
      "amount": 0,
      "description": "string",
      "billing_url": "string",
      "discount_before_payment_due_date": 0,
      "customer_name": "string",
      "type": "generic"
    }
  ],
  "next_page_token": "string",
  "count": 0
}

Request

Query Params
next_page_token
string 
optional
Token de paginação que é retornada nessa mesma requisição
Header Params
api-key
string 
required
Neofin API Key
Example:
{{API_KEY}}
secret-key
string 
required
Neofin Secret Key
Example:
{{SECRET_KEY}}

Responses

🟢200Success
application/json
Body
billings
array[object (Billing) {25}] 
required
customer_mail
string 
optional
E-mail do seu cliente
fine
number 
required
Multa do boleto
digest
string 
optional
Hash verificadora da cobrança
status
enum<string> 
required
Status da cobrança
Allowed values:
processingpendingoverduecancelledcancellingpayment_approvedpaiddeleteddeletingrenegotiated
installments
integer 
required
Quantidade de parcelas da sua cobrança
nfe_number
string 
required
ID da sua NFe
customer_phone
string 
optional
Telefone do seu cliente
fees
number 
required
Taxas da cobrança
installment_type
enum<string> 
optional
Tipo da parcela
Allowed values:
weeklybiweeklymonthlycustom
billing_number
string 
required
ID da sua cobrança na Neofin
created_by_name
string 
required
Por quem foi criada essa cobrança
customer_document
string 
required
CPF ou CNPJ válido (Ex: "24166636000176")
origin
string 
required
Indica por onde a cobrança foi criada
discount_before_payment
number 
required
Desconto aplicado antes da data de pagamento
integration_identifier
string 
required
Identificador único: o ID dessa cobrança e parcela no seu sistema
customer_id
string 
required
Identificador do seu cliente no nosso sistema
due_date
integer 
required
Data de vencimento da primeira parcela.
updated_at
integer 
required
Data de atualização
issued_at
integer 
required
Data de emissão
amount
integer 
required
Valor total da sua cobrança
description
string 
required
Descrição da cobrança que aparecerá no link de pagamento
billing_url
string 
optional
URL que seu cliente recebe da Neofin
discount_before_payment_due_date
integer 
optional
Data em que o "discount_before_payment" deve ser aplicado
customer_name
string 
required
Nome do seu cliente
type
enum<string> 
required
Tipo da cobrança
Allowed values:
genericbolepixboletopix
next_page_token
string  | null 
optional
count
integer 
required
🟠403Invalid API Keys
🔴500Internal Server Error
Previous
Como listar suas cobranças
Next
Cobranças por status
Built with