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, payment splits, and notifications. It supports multiple endpoints for each transaction type, allowing creation, retrieval, updating, cancellation, and other operations related to billing and payment processing.
Common scenarios where this node is beneficial include:
- Automating the creation and management of payment requests via boletos or credit cards.
- Handling subscription plans and their associated payments.
- Managing installment booklets (carnês) for customers.
- Creating and managing payment links for easy customer payments.
- Implementing split payments to distribute funds among multiple payees.
- Receiving and consulting payment notifications.
Practical examples:
- Automatically generate a boleto for a product purchase and send it to the customer.
- Create a subscription plan and enroll customers with recurring payments.
- Retrieve a list of all credit card transactions within a date range.
- Cancel a payment link that is no longer valid.
- Retry a failed credit card payment using updated payment information.
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 para Boleto | Select the specific endpoint for boleto transactions, e.g., create boleto one step, create transaction, associate payment method, return existing charge info, cancel transaction, resend boleto email, mark as paid, etc. |
| Endpoints para Cartão | Select the specific endpoint for credit card transactions, e.g., create charge one step, create transaction, retry payment, refund payment, return charge info, cancel transaction, list installments, etc. |
| Endpoints para Carnê | Select the specific endpoint for carnet transactions, e.g., create carnet, return carnet, cancel carnet, resend carnet email, mark as paid, alter due dates, etc. |
| Endpoints para Assinatura | Select the specific endpoint for subscription plans, e.g., create plan, edit plan name, cancel plan, create subscriptions (one step or two steps), set payment method, retry payment, cancel subscription, resend email, etc. |
| Endpoints para Link | Select the specific endpoint for payment links, e.g., create link one step, create transaction, associate payment method, return link info, cancel link, resend link email, etc. |
| Endpoints para Split | Select the specific endpoint for split payments, e.g., create split transaction one step boleto/cartão, associate payment method boleto/cartão, create split transaction. |
| Endpoint para Notificação | Select the notification endpoint, currently only "consultar notificação" (consult notification). |
| charge_id / chargeId | The ID of the charge/transaction, required for many endpoints to identify the specific transaction. |
| Various JSON Body fields | Many endpoints require a JSON body input to specify details like items, customer info, payment details, metadata, configurations, etc. These are provided as JSON inputs named accordingly (e.g., requestBodyBoletoOneStep, requestBodyCriarBoleto). |
| begin_date / end_date | Date range filters for listing or retrieving transactions or charges. |
| Email address used for resending boletos, carnets, or payment links. | |
| amount | Amount value used in refund operations. |
| Identificador de conta | Account identifier used for listing installments. |
| parcel / parcelas | Parcel number(s) and new due dates for altering installment due dates. |
| plan_id / subscriptionId | IDs for plans or subscriptions used in subscription-related endpoints. |
| nome_plano | New name for editing a subscription plan. |
Note: Each transaction type has its own set of endpoints and corresponding required parameters, which become visible based on the selected transaction type and endpoint.
Output
The node outputs data returned from the Efí Bank API calls corresponding to the selected transaction type and endpoint. The output is structured as JSON objects containing the response data from the API, which may include:
- Details of created transactions, boletos, carnês, subscriptions, or payment links.
- Lists of transactions or charges filtered by date or other criteria.
- Status updates or confirmation messages for cancellations, retries, or metadata inclusions.
- Notification details when querying notifications.
If binary data is involved (not explicitly indicated in the properties), it would typically represent documents like PDFs of boletos or carnês, but this node primarily handles JSON responses.
Dependencies
- Requires an API key credential for authentication with the Efí Bank Cobranças API.
- The node depends on internal service modules (
./Services) to execute API calls. - Proper configuration of the API credentials in n8n is necessary.
- Network access to the Efí Bank API endpoints must be available.
Troubleshooting
- Invalid or missing API credentials: Ensure the API key or authentication token is correctly configured in the node credentials.
- Incorrect JSON body format: When providing JSON bodies for requests, ensure the JSON is well-formed and matches the expected schema for the selected endpoint.
- Missing required parameters: Some endpoints require mandatory fields like
charge_id,begin_date,end_date, oremail. Omitting these will cause errors. - Date format issues: Dates should be provided in the correct string format (e.g., "YYYY-MM-DD") as expected by the API.
- Endpoint mismatch: Selecting an endpoint that does not correspond to the chosen transaction type will result in no operation or errors.
- Network or API errors: Check network connectivity and API availability; handle HTTP errors gracefully.
- Payment token issues: For credit card operations requiring a payment token, ensure the token is valid and current.
Links and References
- Efí Bank API Documentation (example placeholder, replace with actual URL 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.