1. Buscando um cliente
Neofin V1
latest
  • latest
  • english
  • Inicie sua jornada na Neofin
  • Preparando seus ambientes
  • Dúvidas frequentes
  • Premissas comportamentais da API (default x personalização)
  • Premissas de infraestrutura da API (default x personalização)
  • 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
        • V2
          • Marcar como pago - V2
        • Marcando como paga
          PUT
      • Cancelando uma cobrança
        • Como cancelar uma cobrança
        • Cancelando uma cobrança
          PUT
      • Reabrindo uma cobrança
        • Como reabrir uma cobrança
        • Reabrir cobrança cancelada
      • 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 outros arquivos
          POST
        • 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
        • Listando réguas disponíveis
          GET
    • Webhooks
      • Como preparar seus webhooks
  • Schemas
    • API Return
      • BillingsOutput
      • BillingsEventsOutput
      • ResumedBillingsEventsOutput
      • BillingsByPaymentDateOutput
      • ForbidennModel
    • Enums
      • BillingStatusEnum
      • InstallmentTypeEnum
      • BillingType
    • Sub Entities
      • GenericBoleto
      • BillingInInstallment
      • Payments
    • Billing
    • BillingEvent
    • ResumedBillingEvent
    • CommonReturnModel
    • BillingWithPayments
    • UpsertBilling
    • InstallmentWithBilling
    • Attachment
    • UpsertCustomer
  1. Buscando um cliente

Listando réguas disponíveis

Sandbox
https://api.sandbox.neofin.services
Sandbox
https://api.sandbox.neofin.services
GET
https://api.sandbox.neofin.services
/customer/clusters

Endpoint para Listagem de Réguas Disponíveis#

Este endpoint permite visualizar todas as réguas disponíveis para uso no sistema.
As réguas podem ser utilizadas tanto no cadastro de clientes quanto no cadastro de cobranças. Ao criar uma cobrança, é possível associar o cliente a uma régua específica.
ℹ️ Observação: Este endpoint está disponível apenas no ambiente Sandbox.

Request

Header Params

Responses

🟢200Success
application/json
Body

🟠403
🔴500
Request Request Example
Shell
JavaScript
Java
Swift
curl --location --request GET 'https://api.sandbox.neofin.services/customer/clusters' \
--header 'api-key: ' \
--header 'secret-key: '
Response Response Example
200 - Example 1
[
    {
        "id": "5e991178-a12e-4e4f-b75b-a1da8c6e5990",
        "name": "decumbo",
        "paused": true,
        "type": "tener"
    }
]
Previous
Buscando um cliente pelo documento
Next
Como preparar seus webhooks
Built with