Overview
This node provides integration with the Efí Bank Pix API, enabling users to perform a wide range of Pix-related financial operations. Pix is an instant payment system widely used in Brazil, and this node facilitates managing Pix transactions such as creating charges, sending payments, managing webhooks, handling automatic Pix recurrence, split payments, and more.
Typical use cases include:
- Creating immediate or due-date Pix charges for customers.
- Managing recurring Pix payments automatically.
- Sending Pix payments programmatically.
- Handling Pix webhooks for real-time notifications.
- Configuring and querying split payments among multiple recipients.
- Generating and managing QR codes for Pix transactions.
- Retrieving account balances and transaction receipts.
This node is beneficial for businesses automating their payment workflows, financial reconciliation, or integrating Pix payment capabilities into their applications without manual intervention.
Properties
| Name | Meaning |
|---|---|
| Tipo de transação | Select the type of Pix transaction to perform. Options include: Cobranças imediatas (Immediate charges), Cobranças com vencimento (Due charges), Pix Automático (Automatic Pix), Envio e Pagamento Pix (Pix send/pay), Gestão de Pix (Pix management), Payload Locations, Split de pagamento Pix (Split payments), Webhooks, Endpoints exclusivos EfÍ (Exclusive endpoints). |
| 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., create charge, update charge, list charges, configure webhook, etc. |
| txid | Transaction identifier used for various charge-related endpoints. |
| revisao | Optional revision number to retrieve previous versions of a charge or configuration. |
| inicio / begin | Start date/time for filtering queries (e.g., listing charges or webhooks). |
| fim / end | End date/time for filtering queries. |
| cpf | CPF (Brazilian individual taxpayer registry) of the payer, used as a filter in some queries. |
| cnpj | CNPJ (Brazilian company registry) of the payer, used as a filter in some queries. |
| status | Status filter for charges, recurrences, or payments. |
| paginacao.paginaAtual | Page number to return in paginated queries. |
| paginacao.itensPorPagina | Number of items per page in paginated queries. |
| Body da Requisição | JSON body for requests that require detailed data input, such as creating or updating charges, configuring splits, or setting up webhooks. The exact structure depends on the chosen endpoint. |
| idEnvio | Identifier for sent Pix payments, used in detail or payment endpoints. |
| e2eid / e2eId | End-to-end identifier for Pix transactions, used in detail or receipt endpoints. |
| locationPresente | Indicates if a charge or recurrence has associated payload locations; options are "none" (do not send), "true", or "false". |
| devolucaoPresente | Indicates if sent Pix payments have associated returns; options are "none", "true", or "false". |
| id | Generic identifier used for various resources like locations, batches, splits, or devolutions depending on the endpoint. |
| splitConfigId | Identifier for a split payment configuration. |
| chave / pixKey / chavePix | Your Pix key linked to the account, required for webhook configuration and other operations. |
| urlNotification | URL where webhook notifications will be sent. |
Note: Many properties appear conditionally based on the selected transaction type and endpoint.
Output
The node outputs an array of JSON objects representing the response from the Efí Bank Pix API for the requested operation. The exact structure varies depending on the endpoint called but generally includes details about Pix charges, payments, configurations, or webhook statuses.
If the operation involves binary data (e.g., QR code images), the output will contain relevant binary fields representing that data.
Dependencies
- Requires an API key credential for authenticating with the Efí Bank Pix API.
- Network access to the Efí Bank Pix API endpoints.
- Proper configuration of webhook URLs if using webhook-related endpoints.
- JSON-formatted request bodies for endpoints requiring complex data input.
Troubleshooting
- Authentication errors: Ensure the API key credential is correctly configured and valid.
- Invalid or missing parameters: Many endpoints require specific parameters (e.g., txid, id, or JSON body). Verify all required inputs are provided and correctly formatted.
- Date filters: Use ISO 8601 date strings for date filters (
inicio,fim,begin,end). - Pagination issues: When retrieving lists, ensure pagination parameters are set correctly to avoid empty results.
- Webhook failures: Confirm the webhook URL is reachable and properly handles incoming POST requests.
- JSON body syntax errors: For endpoints requiring JSON bodies, validate the JSON format before execution.
- API rate limits or service availability: Handle possible API throttling or downtime gracefully.
Links and References
- Efí Bank Pix API Documentation (official API docs, in Portuguese)
- Pix Payment System - Central Bank of Brazil (general info about Pix)
- n8n Documentation (for general node usage and credential setup)