Neofin V1
    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

    Preparando seus ambientes

    Esta documentação tem como objetivo explicar as funcionalidades da API da Neofin para criação, edição, cancelamento e recuperação de faturas.

    API Endpoints#

    📌
    URL para o ambiente de sandbox: https://api.sandbox.neofin.services/
    📌
    URL para o ambiente de produção: https://api.neofin.services/

    Autenticação#

    Para autenticar em ambos os ambientes, você deve incluir os seguintes headers na sua requisição:
    --header 'api-key: {api-key}'
    --header 'secret-key: {secret-key}'
    Os headers {api-key} e {secret-key} no exemplo acima devem ser substituídos pelos valores apropriados.
    Você pode obter sua chave de API e segredo diretamente pela plataforma Neofin. Dentro da Plataforma Neofin, navegue até Configurações > Integrações e clique em Criar chaves no final da página.
    Importante
    Não compartilhe sua chave de API e segredo com ninguém. Essas credenciais fornecem acesso à API da Neofin, e qualquer ação executada com elas será vinculada à sua conta.
    Previous
    Inicie sua jornada na Neofin
    Next
    Como realizar o upsert de uma cobrança
    Built with