Evolution API icon

Evolution API

Interact with Evolution API

Overview

The node "Evolution API" allows interaction with the Evolution API service. Specifically, for the resource Mensaje and operation Enviar PIX, it enables sending a PIX payment message to a recipient. This is useful in scenarios where automated financial transactions or payment notifications need to be sent programmatically via PIX, a popular instant payment system in Brazil.

Practical examples include:

  • Sending a PIX payment request or confirmation to a customer.
  • Automating payment notifications within a business workflow.
  • Integrating PIX payments into CRM or ERP systems for seamless transaction handling.

Properties

Name Meaning
Nombre De La Instancia The name of the instance that will send the PIX payment message.
Número Del Destinatario The recipient's number (likely a chat or contact identifier) to whom the PIX is sent.
Nombre Del Beneficiario The name of the beneficiary who will receive the PIX payment.
Tipo De Clave The type of PIX key used for the beneficiary. Options: Teléfono, Correo Electrónico, CPF, CNPJ, Aleatoria.
Clave 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 message. The exact structure depends on the API response but typically includes status information about the sent message.

If binary data were involved (e.g., attachments), it would be summarized here, but this node focuses on JSON output related to the PIX message transaction.

Dependencies

  • Requires an API key credential for authenticating with the Evolution API.
  • The node expects the Evolution API base URL and headers to be configured as defaults.
  • No additional external dependencies are indicated beyond the Evolution API service.

Troubleshooting

  • Operation not supported error: If you select an unsupported operation or resource, the node throws an error indicating the function is not supported. Ensure the resource is "messages-api" and operation is "send-pix".
  • Missing required properties: All input properties marked as required must be provided; otherwise, the node will fail.
  • API authentication errors: Make sure the API key credential is correctly set up and valid.
  • Invalid PIX key or key type: Providing incorrect PIX key details may cause the API to reject the request.

Links and References

Discussion