Neofin V1
  1. Buscando uma cobrança
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. Buscando uma cobrança

Buscando pelo Integration Identifier

GET
https://api.sandbox.neofin.services/billing/integration/{integration_identifier}
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/integration/seu-id-interno-123456' \
--header 'api-key: ' \
--header 'secret-key: '
Response Response Example
200 - Example 1
{
  "customer_mail": "string",
  "fine": "string",
  "digest": "string",
  "status": "processing",
  "installments": 0,
  "nfe_number": "string",
  "customer_phone": "string",
  "fees": "string",
  "installment_type": "string",
  "billing_number": "string",
  "created_by_name": "string",
  "customer_document": "string",
  "discount_before_payment": "string",
  "integration_identifier": "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": "string",
  "payments": [
    {
      "installment": "string",
      "payment_number": "string",
      "payment_status": "string"
    }
  ]
}

Request

Path Params
integration_identifier
string 
required
Seu próprio Integration identifier da sua cobrança
Example:
seu-id-interno-123456
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
customer_mail
string 
required
fine
string 
required
digest
string 
required
status
enum<string> 
required
Status da cobrança
Allowed values:
processingpendingoverduecancelledcancellingpayment_approvedpaiddeleteddeletingrenegotiated
installments
integer 
required
nfe_number
string 
required
customer_phone
string 
required
fees
string 
required
installment_type
string 
required
billing_number
string 
required
created_by_name
string 
required
customer_document
string 
required
discount_before_payment
string 
required
integration_identifier
string 
required
due_date
integer 
required
updated_at
integer 
required
issued_at
integer 
required
amount
integer 
required
description
string 
required
billing_url
string 
required
discount_before_payment_due_date
integer 
required
customer_name
string 
required
type
string 
required
payments
array [object {3}] 
required
installment
string 
optional
payment_number
string 
optional
payment_status
string 
optional
🟠403Invalid API Keys
🟠404Billing not found
🔴500Internal Server Error
Previous
Como buscar uma única cobrança
Next
Buscando pelo Billing Number
Built with