Evolution API icon

Evolution API

Interact with Evolution API
Join our community

Actions64

Overview

This node, named "Evolution API," is designed to interact with the Evolution API service. Specifically, for the resource "Mensagem" and operation "Enviar PIX," it facilitates sending PIX payments—a popular instant payment method in Brazil—by providing necessary details such as recipient information and PIX key data.

Common scenarios where this node is beneficial include automating financial transactions, integrating PIX payments into workflows, or triggering PIX transfers based on events in other systems (e.g., invoicing, order processing).

For example, a business could use this node to automatically send PIX payments to suppliers once an invoice is approved, streamlining payment processes without manual intervention.

Properties

Name Meaning
Nome Da Instância The name of the instance that will send the PIX payment.
Número Do Destinatário The recipient's number identifier (likely a chat or contact ID).
Nome Do Beneficiário The name of the PIX payment beneficiary (recipient).
Tipo Da Chave The type of PIX key used; options are: Telefone (phone), E-Mail, CPF, CNPJ, Aleatória (random).
Chave PIX The actual PIX key value of the beneficiary.

Output

The node outputs a JSON array containing the response from the Evolution API after attempting to send the PIX payment. This output typically includes confirmation details about the transaction status, any identifiers returned by the API, or error messages if the operation failed.

No binary data output is indicated.

Dependencies

  • Requires an API key credential for authenticating with the Evolution API.
  • The node expects the Evolution API service to be accessible and properly configured.
  • No additional environment variables or external dependencies are explicitly required beyond the API credential.

Troubleshooting

  • Unsupported Operation Error: If the node throws an error stating the operation is not supported, verify that the resource and operation names are correctly set to "messages-api" and "send-pix" respectively.
  • Missing Required Parameters: Ensure all required properties (instance name, recipient number, beneficiary name, key type, and PIX key) are provided; missing these will cause errors.
  • API Authentication Failures: Confirm that the API key credential is valid and has the necessary permissions.
  • Network Issues: Connectivity problems with the Evolution API endpoint can cause timeouts or failures; check network access and API availability.

Links and References

Discussion