Overview
This node provides integration with the Pix API of Efí Bank, enabling various Pix transaction types and operations. It supports creating, updating, querying, and managing Pix charges, payments, webhooks, splits, batch operations, automatic Pix transactions, and account configurations.
Common scenarios where this node is beneficial include:
- Automating Pix charge creation and management for immediate or due payments.
- Sending Pix payments and querying their status.
- Managing Pix keys, webhooks, and split payment configurations.
- Handling batch Pix charges and automatic recurring Pix payments.
- Retrieving account balances, reports, and transaction details.
Practical examples:
- Creating an immediate Pix charge to request payment from a customer.
- Sending a Pix payment programmatically to a beneficiary.
- Configuring a webhook URL to receive notifications about Pix events.
- Setting up split payments to distribute received Pix funds among multiple recipients.
- Scheduling automatic recurring Pix charges for subscription services.
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), Envio e Pagamento Pix (Pix sending and payment), Gestão de Pix (Pix management), Payload Locations, Cobranças em Lote (Batch charges), Split de pagamento Pix (Pix split payments), Webhooks, Endpoints exclusivos EfÍ (Exclusive Efí endpoints), PIX Automático (Automatic Pix). |
| Endpoints | Depending on the selected transaction type, choose the specific API endpoint to call. Each transaction type has its own set of endpoints, such as creating charges, updating charges, listing charges, sending Pix, managing webhooks, etc. |
| txid | Transaction identifier used in various charge-related endpoints. |
| inicio / begin | Start date/time for filtering queries (e.g., list charges, list webhooks). Format: ISO 8601 string. |
| fim / end | End date/time for filtering queries. Format: ISO 8601 string. |
| Body da Requisição | JSON body for requests that require detailed data input, such as creating or updating charges, sending Pix payments, configuring splits, or setting up webhooks. The exact structure depends on the chosen endpoint. |
| idEnvio | Identifier for sent Pix payments, used in some query endpoints. |
| e2eid | End-to-end ID for Pix transactions, used for querying specific Pix payments. |
| pixCopiaECola | Copy-and-paste code of a Pix QR Code to be detailed or paid. |
| id | Various meanings depending on context: location ID, batch ID, devolution ID, etc. |
| tipoCob | Type of charge, either COB (immediate) or COBV (due), used when creating payload locations. |
| splitConfigId | Identifier for a Pix split payment configuration. |
| chave / pixKey / chavePix | Pix key linked to the account, used in webhook and exclusive endpoint operations. |
| urlNotification | URL to which webhook notifications will be sent. |
| valor | Value amount, e.g., for devolutions or payments. |
| cpf / cnpj | CPF or CNPJ number used for filtering or specifying parties in requests. |
| status | Status filter for automatic Pix recurrence listings. Options: Ativa (Active), Inativa (Inactive), Removida pelo usuário recebedor (Removed by receiver user), Removida pelo PSP (Removed by PSP). |
Note: Many endpoints require a JSON request body property named "Body da Requisição" or similar, where users must provide structured JSON data according to the API specification.
Output
The node outputs an array of JSON objects corresponding to the responses from the called Pix API endpoints. Each output item contains the JSON response data returned by the API for the requested operation.
If the operation involves binary data (not explicitly indicated here), it would typically represent files or reports; however, this node primarily deals with JSON data related to Pix transactions.
Dependencies
- Requires an API key credential for authenticating with the Efí Bank Pix API.
- Network access to Efí Bank's Pix API endpoints.
- Proper configuration of webhook URLs if using webhook-related endpoints.
- JSON-formatted request bodies must conform to the API's expected schema for each endpoint.
Troubleshooting
- Invalid or missing API credentials: Ensure the API key credential is correctly configured in n8n.
- Incorrect JSON request body: Validate JSON syntax and required fields for the selected endpoint.
- Date filters out of range or invalid format: Use ISO 8601 date strings and ensure logical date ranges.
- Missing required parameters: Some endpoints require mandatory fields like txid, id, or keys; verify all required inputs are provided.
- Webhook URL unreachable or misconfigured: Confirm the webhook URL is publicly accessible and correctly set.
- API rate limits or network errors: Monitor API usage and handle transient network issues with retries.
Common error messages usually relate to authentication failures, validation errors on request bodies, or resource not found errors when querying by IDs.
Links and References
- Efí Bank Pix API Documentation (example placeholder, replace with actual official docs)
- Pix - Central Bank of Brazil
- n8n Documentation for general node usage and credential setup guidance