Evolution API icon

Evolution API

Interact with Evolution API

Actions64

Overview

The "Enviar PIX" operation under the "Mensagem" (messages-api) resource in this custom n8n node allows you to send a PIX payment via the Evolution API. PIX is an instant payment system widely used in Brazil, enabling fast and secure money transfers. This node is useful for automating financial transactions, such as sending payments to suppliers, customers, or partners directly from your workflows.

Practical examples:

  • Automate payroll or vendor payments.
  • Send refunds or incentives to customers.
  • Integrate with e-commerce platforms to automate order-related payments.

Properties

Below are the input properties required for the "Enviar PIX" operation:

Display Name Type Description
Nome Da Instância String Digite o nome da instância que vai enviar o PIX (Enter the name of the instance that will send the PIX). Required
Número Do Destinatário String WhatsApp number of the recipient. Required
Nome Do Beneficiário String Nome do beneficiário do PIX (Name of the PIX beneficiary). Required
Tipo Da Chave Options Tipo da chave PIX (Type of PIX key). Options: Telefone (phone), E-Mail, CPF, CNPJ, Aleatória (random). Required
Chave PIX String Chave PIX do beneficiário (PIX key of the beneficiary). Required

Output

The output of this node is a JSON object (or array of objects) containing the response from the Evolution API after attempting to send the PIX payment. The exact structure depends on the API's response, but typically includes fields such as status, transaction ID, and any error messages if applicable.

Example output (structure may vary):

[
  {
    "status": "success",
    "transactionId": "1234567890",
    "message": "PIX sent successfully"
  }
]

If the operation fails, the output may include error details:

[
  {
    "status": "error",
    "message": "Invalid PIX key"
  }
]

Dependencies

  • External Service: Requires access to the Evolution API.
  • API Key/Credentials: You must configure valid Evolution API credentials in n8n under the name evolutionApi.
  • n8n Configuration: Ensure the node is properly authenticated and has network access to https://doc.evolution-api.com/api-reference.

Troubleshooting

Common Issues:

  • Missing or Invalid Credentials: If the Evolution API credentials are not set up correctly, the node will fail to authenticate.
  • Unsupported Operation: If the operation or resource is not implemented, you may see an error like:
    • "Operação não suportada."
      Translation: "Operation not supported."
  • Validation Errors: If required fields are missing or incorrectly formatted (e.g., invalid PIX key), the API may return an error message in the output.
  • Network Issues: Connectivity problems between n8n and the Evolution API endpoint can cause failures.

How to resolve:

  • Double-check all required input fields.
  • Verify your Evolution API credentials in n8n.
  • Ensure the selected operation/resource combination is supported.
  • Review the error message in the output for specific guidance.

Links and References

Discussion