Overview
This node provides integration with the Efí Bank's "API Cobranças" (Billing API), enabling users to manage various types of financial transactions such as boletos (bank slips), credit card payments, carnês (installment booklets), subscriptions, payment links, split payments, and notifications. It supports a wide range of endpoints for creating, updating, querying, and managing these transactions.
Typical use cases include:
- Creating and managing boleto or credit card charges.
- Handling installment plans via carnês.
- Managing subscription plans and their payments.
- Generating and managing payment links.
- Processing split payments among multiple payees.
- Receiving and consulting notifications related to transactions.
For example, a business can automate issuing boletos for customer payments, retry failed credit card payments, or create subscription plans with automatic billing.
Properties
| Name | Meaning |
|---|---|
| Tipo de transação | Select the type of transaction. Options: Boleto, Cartão, Carnê, Assinatura, Link de Pagamento, Split de Pagamento, Notificações. |
| Endpoints | Depending on the selected transaction type, choose the specific API endpoint to call. Each transaction type has its own set of endpoints, e.g., "Criar Boleto One Step" for boletos, "Criar Cobrança via cartão One Step" for cards, etc. |
| charge_id | The ID of the charge/transaction. Required for many endpoints that operate on existing charges. |
| requestBody* | JSON bodies for various create/update operations, e.g., requestBodyBoletoOneStep for creating a boleto in one step, requestBodyCriarBoleto for creating a boleto transaction, etc. These contain detailed data like items, customer info, payment details, expiration dates, configurations, messages, etc. |
| begin_date, end_date | Date range filters for listing queries. Required for list endpoints to filter results by date. |
| date_of | Defines which date field to apply the date filter on when listing transactions. |
| status | Filter transactions by their status. |
| customer_document | Filter by payer's document number. |
| custom_id | Custom identifier from your system or application to filter or tag transactions. |
| value | Filter by the amount/value of the charge. |
| limit, page, offset | Pagination controls for list endpoints: number of records, page number, and offset. |
| Email address used for resending boletos, carnês, or payment links. | |
| amount | Amount value used for refunding a card payment. |
| brand | Card brand for installment queries. Options: Visa, Mastercard, Amex, Elo, Hipercard. |
| carnet_id | ID of the carnê (installment booklet). Required for carnê-related operations. |
| parcel, parcel_data | Parcel number and new due date for updating carnê parcels. |
| plan_id | ID of the subscription plan. |
| subscription_id | ID of the subscription. |
| token | Notification token for querying notifications. |
| nome_plano | New name for updating a subscription plan. |
| requestBodyHistorico | Description text to add to the history of a transaction, carnê, or subscription. |
Note: Many properties are conditionally shown depending on the selected transaction type and endpoint.
Output
The node outputs an array of JSON objects representing the response from the Efí Bank API for the called endpoint. The structure varies depending on the endpoint but generally includes details about created or queried transactions, such as IDs, statuses, amounts, customer information, payment details, and metadata.
Binary data output is not indicated; the node primarily deals with JSON data representing financial transactions and related metadata.
Dependencies
- Requires an API key credential for authentication with the Efí Bank Cobranças API.
- The node depends on an internal service module (
./Services) to execute API calls based on the selected endpoint. - Proper configuration of the API credentials in n8n is necessary.
- Network access to Efí Bank's API endpoints is required.
Troubleshooting
- Invalid or missing API credentials: Ensure the API key credential is correctly configured and valid.
- Incorrect or missing required parameters: Many endpoints require mandatory fields like
charge_id,plan_id, or properly formatted JSON bodies. Validate inputs carefully. - Date filters: For list endpoints,
begin_dateandend_dateare mandatory; omitting them may cause errors. - JSON body formatting: The request body fields expect valid JSON. Malformed JSON will cause request failures.
- Endpoint mismatch: Selecting an endpoint incompatible with the chosen transaction type will result in no operation or errors.
- Network issues: Connectivity problems to the Efí Bank API will cause execution failures.
- Error messages from API: Usually indicate invalid parameters, expired tokens, or unauthorized access. Review API documentation and ensure all required fields are correct.
Links and References
- Efí Bank API Documentation (Assumed official site; replace with actual API docs if available)
- n8n Documentation on Creating Custom Nodes
- General information on Brazilian payment methods like boletos and carnês for context.
This summary is based solely on static analysis of the provided source code and property definitions without runtime execution.