Efí Bank | API Cobranças icon

Efí Bank | API Cobranças

Integração com a API Cobranças do Efí Bank

Efí Bank | API Cobranças

AI-generated

Overview

This node integrates with the Efí Bank API for managing various types of financial transactions such as boletos, credit cards, carnês, subscriptions, payment links, splits, and notifications. It allows users to select the transaction type and specific API endpoint to perform operations like creating charges, associating payment methods, retrieving details, updating metadata, canceling transactions, sending emails, and more. This node is useful for automating and managing payment processes within workflows, such as generating payment slips, handling credit card payments, managing subscription plans, and processing split payments.

Use Case Examples

  1. Create a boleto charge with customer details and expiration date.
  2. Retrieve a list of card charges filtered by date and status.
  3. Create and manage subscription plans and their associated payments.
  4. Generate and send payment links with custom metadata and discounts.

Properties

Name Meaning
Tipo de transação Select the type of transaction to operate on (e.g., boleto, cartao, carne, assinatura, link, split, notificacao).
Endpoints para Boleto Select the specific API endpoint for boleto transactions (e.g., createOneStepCharge, createCharge, defineBilletPayMethod, etc.).
Endpoints para Cartão Select the specific API endpoint for credit card transactions (e.g., createOneStepCard, createCardCharge, defineCardPayMethod, etc.).
Endpoints para Carnê Select the specific API endpoint for carnê transactions (e.g., createCarnet, detailCarnet, listCarnets, etc.).
Endpoints para Assinatura Select the specific API endpoint for subscription plans and subscriptions (e.g., createPlan, listPlans, updatePlan, etc.).
Endpoints para Link de pagamento Select the specific API endpoint for payment links (e.g., createOneStepLink, createLinkCharge, defineLinkPayMethod, etc.).
Endpoints para Split de pagamento Select the specific API endpoint for split payment transactions (e.g., createOneStepSplitBillet, createOneStepSplitCard, etc.).
Endpoint para Notificação Select the endpoint for notification operations (e.g., getNotification).

Output

JSON

  • response - The JSON response from the Efí Bank API for the selected transaction type and endpoint.

Dependencies

  • Efí Bank API credentials required for authentication.

Troubleshooting

  • Ensure that the API credentials are correctly configured and valid to avoid authentication errors.
  • Verify that required parameters for each endpoint are provided to prevent request validation errors.
  • Check the API endpoint selection matches the transaction type to avoid unsupported operation errors.
  • Handle network or API downtime gracefully by implementing retries or error handling in workflows.

Links

Discussion