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

Como buscar uma única cobrança

Buscar a cobrança pelo BillingNumber#

Este endpoint deve ser utilizado para recuperar as informações da cobrança desejada.
cURL example:
ccurl --location 'https://api.sandbox.neofin.services/billing/122087378560242' \
  --header 'api-key: key' \
  --header 'secret-key: secret'
As variáveis retornadas dentro do objeto da cobrança podem variar de acordo com o "type" (tipo) da cobrança. Exemplo:
{
   "customer_mail":"teste@neofin.com.br",
   "fine":"",
   "status":"pending",
   "installments":1.0,
   "nfe_number":"000000021",
   "customer_phone":"+5533999751491",
   "fees":"",
   "by_mail":true,
   "installment_type":"custom",
   "billing_number":"122087378560242",
   "created_by_name":"Integração API",
   "customer_document":"24540707078",
   "discount_before_payment":"0",
   "integration_identifier":"Neofin-00000002241",
   "due_date":1703114722.0,
   "updated_at":1703084752.0,
   "by_whatsapp":false,
   "issued_at":1703084752.0,
   "amount":20000.0,
   "description":"Cobrança 000000021 Parcela 1 TESTE",
   "billing_url":"https://sandbox.neofin.com.br/pay?billing=122087378560242",
   "discount_before_payment_due_date":0.0,
   "customer_name":"Empresa teste LTDA",
   "type":"generic"
}

Buscar cobrança pelo IntegrationIdentifier#

Este endpoint deve ser utilizado para recuperar as informações da cobrança desejada.
cURL example:
ccurl --location 'https://api.sandbox.neofin.services/billing/integration/your-integration-identifier-123' \
  --header 'api-key: key' \
  --header 'secret-key: secret'
As variáveis retornadas dentro do objeto da cobrança podem variar de acordo com o "type" (tipo) da cobrança. Exemplo:
{
   "customer_mail":"teste@neofin.com.br",
   "fine":"",
   "status":"pending",
   "installments":1.0,
   "nfe_number":"000000021",
   "customer_phone":"+5533999751491",
   "fees":"",
   "by_mail":true,
   "installment_type":"custom",
   "billing_number":"122087378560242",
   "created_by_name":"Integração API",
   "customer_document":"24540707078",
   "discount_before_payment":"0",
   "integration_identifier":"Neofin-00000002241",
   "due_date":1703114722.0,
   "updated_at":1703084752.0,
   "by_whatsapp":false,
   "issued_at":1703084752.0,
   "amount":20000.0,
   "description":"Cobrança 000000021 Parcela 1 TESTE",
   "billing_url":"https://sandbox.neofin.com.br/pay?billing=122087378560242",
   "discount_before_payment_due_date":0.0,
   "customer_name":"Empresa teste LTDA",
   "type":"generic"
}
Previous
Upsert de Cobranças
Next
Buscando pelo Integration Identifier
Built with