Skip to main content

N8N

Custom Efí Node for N8N


n8n is a workflow automation platform that allows you to connect various APIs and services in a visual and flexible way. It enables the creation of custom integrations without the need for advanced programming, using a node-based system to link different systems.

n8n-nodes-efibank is a custom node for n8n that simplifies integration with Efibank's Billing API and Pix API, allowing the automation of financial flows such as payments, receipts, and transactions.

1. Requirements​

1.1. Node.js Version​

This custom node requires a Node.js version compatible with n8n. The minimum required version is 18.17, and the maximum supported version is 22.


2. Installation​

To install the node in an existing n8n setup, use one of the options below:

2.1. Installation via Community Nodes (n8n GUI)​

To install the n8n-nodes-efibank node directly via the n8n GUI, using the Community Nodes functionality, follow these steps:

  • Access the n8n panel in your browser (usually at http://localhost:5678).
  • In the bottom left corner, click on the three dots next to your profile picture.
  • Select the Settings option.
  • Select the Community Nodes tab.
  • Click on the Install a community node button.
  • In the installation field, type n8n-nodes-efibank.
  • Click on Install and wait for completion.

After installation, you will need to restart n8n for the new node to be available:

  • If you are using Docker: run docker restart n8n.
  • If you are running locally: restart the process with n8n stop and n8n start.

After that, the Efí Bank Cobranças and Efí Bank Pix nodes will be available in your list of nodes for use in workflows.

2.2. Installation via NPM​

$ npm install n8n-nodes-efibank

2.3. Installation via GIT​

$ git clone https://github.com/efipay/n8n-nodes-efibank.git

3. Node Installation (only for installation via NPM or Git)​

To properly inatllation the custom node, follow these steps:

  • Install dependencies:
    • npm install
  • Compile the code:
    • npm run build
  • Configure the link for local (development) use:
    • npm link
  • Start n8n:
    • n8n

4. Node Configuration​

Before starting the configuration, you need to obtain your Production and Sandbox credentials from your Efí account. Follow these steps:

  • Access the Efí panel in the menu API.
  • In the sidebar menu, click Aplicações and select Criar aplicação.
  • Enter a name for the application (e.g., n8n).
  • Select the "API Cobranças" option and enable the "Emissão de cobranças" scope.
  • If using the "API Pix", enable all Production and Sandbox scopes.
  • Click Continuar.
  • Enter your Electronic Signature to confirm the changes and update the application.

After completing this process, your client_id and client_secret credentials will be displayed in a screen similar to this:


Billing API Node Configuration​

In the n8n environment, go to your workflow and look for the node Efí Bank Cobranças. To configure the credentials, follow these steps:

  • Click Create New Credential, as shown in the image below, to add a new credential.
  • Select the environment (Homologação/Produção).
  • Enter the Client ID e Client Secret credentials for both environments.
  • Click Save.

Pix API Node Configuration​

In the n8n environment, go to your workflow and look for the node Efí Bank Pix. To configure the credentials, follow these steps:

  • Click Create New Credential, as shown in the image below, to add a new credential.
  • Select the environment (Homologação/Produção).
  • Enter the Client ID e Client Secret credentials for both environments.
  • Configure the certificate:
    • Generate a certificate in your Efí account following this guide.
    • Convert the .p12 certificate using the conversion page and click "Encode and Display" to obtain the necessary data.
    • Copy the Certificate content and paste it into the Certificado field.
    • Copy the Key content and paste it into the Key field.
  • Click Save.

5. Testing​

To test the integration, follow these steps:

  • Select the desired transaction type.
  • Choose the corresponding endpoint.
  • Fill in the necessary request data. Use the pre-filled examples or provide specific details for your integration.
  • Click Test step to execute the test.

6. Frequently Asked Question​

Where can I track transactions generated by n8n?​

Transactions generated through the plugin can be tracked in your Efí account in the menu API > Minhas Aplicações > Sua Aplicação. In this environment, you can track all transactions and their respective statuses.


7. Support and Suggestions​

Your suggestions for new ideas and implementations for Efí's custom node are very important. Therefore, if you have any ideas, please contact our team. We will analyze your suggestion and evaluate the possibility of implementation.

If you have any questions, please contact us through the website Efí.

Last updated on