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 payment requests via boletos or credit cards.
- Handling installment plans and subscription billing.
- Generating and managing payment links.
- Managing split payments among multiple payees.
- Receiving and processing notifications related to transactions.
For example, a business can automate issuing boletos for customer payments, retry failed credit card charges, or create subscription plans with automated billing cycles.
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., for Boleto: createOneStepCharge, createCharge, cancelBillet, etc. |
| charge_id | The ID of the charge/transaction. Required for many endpoints that operate on existing charges (e.g., define payment method, detail, update metadata). |
| requestBody* | JSON bodies for various operations, such as creating charges, associating payment methods, updating metadata, etc. These inputs expect JSON formatted data matching the API requirements for each endpoint. |
| begin_date / end_date | Date range filters for listing queries (e.g., listBillets, listCards, listCarnets, listSubscriptions). Format: YYYY-MM-DD. |
| Email address used for sending or resending documents like boletos, carnês, or payment links. | |
| amount | Numeric value representing amounts, e.g., refund amount in credit card refunds. |
| total | Total amount of the charge, used for installment queries. |
| brand | Credit card brand for installment queries. Options: Visa, Mastercard, Amex, Elo, Hipercard. |
| carnet_id | ID of the carnê (installment booklet) for operations on carnês. |
| parcel / parcel_data | Parcel number and new due date for updating installments in carnês. |
| plan_id | ID of the subscription plan for operations like update or delete. |
| subscription_id | ID of the subscription for operations like defining payment method, updating metadata, or cancellation. |
| token | Notification token for querying notifications. |
Note: Many properties are conditionally shown depending on the selected transaction type and endpoint.
Output
The node outputs an array of JSON objects corresponding to the responses from the called API endpoints. Each output item contains the JSON response from the Efí Bank API for the requested operation.
If the operation involves binary data (not explicitly indicated in the provided properties), it would be included accordingly, but this node primarily deals with JSON data representing transaction details, statuses, lists, and metadata.
Dependencies
- Requires an API key credential for authenticating with the Efí Bank Cobranças API.
- The node depends on an internal service module (
./Services) which handles the actual API calls based on the selected endpoint. - Proper configuration of the API credentials within n8n is necessary.
- Input JSON bodies must conform to the API schema expected by Efí Bank.
Troubleshooting
- Invalid or missing API credentials: Ensure the API key credential is correctly configured and active.
- Malformed JSON input: When providing JSON bodies, ensure valid JSON syntax; otherwise, the API call will fail.
- Missing required parameters: Some endpoints require mandatory fields like
charge_id,plan_id, orsubscription_id. Omitting these will cause errors. - Date format issues: Dates should be in
YYYY-MM-DDformat; incorrect formats may lead to API rejections. - Endpoint mismatch: Selecting an endpoint incompatible with the chosen transaction type will result in errors.
- Network or API downtime: Temporary connectivity issues or API unavailability can cause failures; retry later or check API status.
Error messages returned by the API typically indicate the missing or invalid parameter, authentication failure, or resource not found. Review the error details and adjust inputs accordingly.
Links and References
- Efí Bank API Documentation (Assumed official docs URL, replace with actual if known)
- n8n documentation on Creating Custom Nodes
- General info on Boletos and Payment Methods in Brazil
This summary is based solely on static analysis of the provided source code and property definitions without runtime execution.