Efí Bank | API Pix icon

Efí Bank | API Pix

Integração com a API Pix da Efí Bank

Efí Bank | API Pix

AI-generated

Overview

This node integrates with the Efí Bank API Pix, enabling various Pix transaction operations such as creating immediate charges, due charges, automatic Pix transactions, payment sending, Pix management, payload location handling, payment splits, webhook management, and exclusive Efí endpoints. It is useful for automating and managing Pix payment workflows within n8n, including creating, updating, querying, and managing Pix transactions and related configurations.

Use Case Examples

  1. Creating an immediate Pix charge for a customer.
  2. Querying a list of Pix charges within a date range.
  3. Configuring a webhook to receive Pix notifications.
  4. Managing Pix payment splits for revenue sharing.

Properties

Name Meaning
Tipo de transação Select the type of Pix transaction to perform, such as immediate charges, due charges, automatic Pix, payment sending, management, payload locations, splits, webhooks, or exclusive Efí endpoints.
endpoints Select the specific API endpoint to use within the chosen transaction type, such as creating charges, updating, querying details, listing, configuring webhooks, etc.
txid Transaction identifier used for operations that require specifying a Pix transaction.
revisao Revision number to retrieve previous versions of a charge or configuration.
inicio Start date for filtering queries, typically used in list or report endpoints.
fim End date for filtering queries, typically used in list or report endpoints.
cpf CPF (Brazilian individual taxpayer registry) of the payer, used for filtering or specifying payer information.
cnpj CNPJ (Brazilian company registry) of the payer, used for filtering or specifying payer information.
status Status filter for charges, payments, or other entities.
paginaAtual Current page number for paginated list queries.
itensPorPagina Number of items per page for paginated list queries.
requestBodyPixCreateImmediateCharge JSON body for creating an immediate Pix charge.
requestBodyPixCreateCharge JSON body for creating a Pix charge with txid.
requestBodyPixUpdateCharge JSON body for updating (revising) a Pix charge.
requestBodyPixCreateDueCharge JSON body for creating a due Pix charge.
requestBodyPixUpdateDueCharge JSON body for updating a due Pix charge.
requestBodyPixSend JSON body for sending a Pix payment.
requestBodypixQrCodePay JSON body for paying a Pix QR code.
bodyRequestSplitConfig JSON body for creating a Pix payment split configuration without an ID.
bodyRequestSplitConfigId JSON body for creating or updating a Pix payment split configuration with an ID.
pixKey Pix key linked to the account, used for webhook configuration and other operations.
urlNotification URL to which webhook notifications will be sent.
bodyWebhookResend JSON body for resending webhook notifications.
bodyRequestUpdateAccountConfig JSON body for creating or modifying account configurations.

Output

JSON

  • response - The JSON response returned from the Efí Bank API Pix for the executed endpoint.

Dependencies

  • Efí Bank API Pix credentials required for authentication

Troubleshooting

  • Ensure the API credentials are correctly configured and valid to avoid authentication errors.
  • Verify that required parameters such as txid, id, or JSON request bodies are provided when needed to prevent request validation errors.
  • Check date formats and pagination parameters to ensure they conform to API expectations to avoid query errors.
  • If webhooks are not triggering, verify the webhook URL and configuration parameters are correct.

Links

Discussion