Neofin V1
english
  • latest
  • english
    Neofin V1
    english
    • latest
    • english
    • Start your Neofin journey
    • Setup your environment
    • NeofinV1
      • Billing API
        • Upsert a billing
          • How to upsert a billing
          • Upsert a billing
            POST
        • Retrieve a billing
          • How to retrieve a single billing
          • Get billing by Integration Identifier
            GET
          • Get billing by Billing Number
            GET
        • Mark a billing as paid
          • How to mark a billing as paid
          • Mark a billing as paid
            PUT
        • Cancel a billing
          • How to cancel a billing
          • Cancel a billing
            PUT
        • Listing billings
          • How to list your billings
          • Billing by status
            GET
          • Billing by customer
            GET
          • Billing updated date
            GET
          • Billing Events
            GET
          • Billing Events by Integration Identifier
            GET
        • Upload attachments
          • How to upload attachments
          • Upload a Billing NF by Integration Identifier
            PUT
          • Upload a Billing Boleto by Integration Identifier
            PUT
      • Customer API
        • Upserting a customer
          • How to upsert a customer
          • Upsert a customer
            POST
        • Retrieve a customer
          • Get a customer by Integration Identifier
            GET
          • Get a customer by their document
            GET
      • Webhooks
        • How to setup your webhooks

    Setup your environment

    Neofin Payments API#

    This documentation aims to explain the functionalities of the Neofin API for creating, editing, canceling, and retrieving invoices.

    API Endpoints#

    📌
    URL for sandbox environment: https://api.sandbox.neofin.services/
    📌
    URL for sandbox environment: https://api.neofin.services/

    Authentication#

    To authenticate in both environments, you must include the following headers in your request:
    --header 'api-key: {api-key}'
    --header 'secret-key: {secret-key}'
    {api-key} and {secret-key} in the above example should be replaced with their appropriate values.
    You can obtain your API key and secret from the Neofin platform. Inside the Neofin Platform, navigate to Settings > Integrations, then click Create keys at the bottom of the page.
    Important
    Do not share your API key and secret with anyone. These credentials grant access to the Neofin API, and any actions performed using them will be linked to your account.
    Previous
    Start your Neofin journey
    Next
    How to upsert a billing
    Built with