Actions64
- Instancia Actions
- Mensagem Actions
- Grupo Actions
- Chat Actions
- Perfil Actions
- Evento Actions
- Integração Actions
Overview
The node "Evolution API Direct" allows users to interact with the Evolution API by sending requests directly using a specified server URL and an API key. Specifically, for the resource Mensagem and operation Enviar PIX, it enables sending PIX payment messages to a beneficiary. This is useful in automating financial transactions via PIX, Brazil's instant payment system.
Typical use cases include:
- Automating PIX payments from a business system.
- Integrating PIX transfers into workflows that require sending money to customers or suppliers.
- Triggering PIX payments based on events such as order completion or invoice approval.
Example: Automatically send a PIX payment to a supplier after an invoice is approved, specifying the beneficiary’s PIX key type and key.
Properties
| Name | Meaning |
|---|---|
| Server URL | The full URL of your Evolution API server endpoint (e.g., https://api.exemplo.com). |
| API Key | The API key credential used to authenticate requests to the Evolution API. |
| Nome Da Instância | The name of the instance that will send the PIX payment. |
| Número Do Destinatário | The recipient's number or identifier (remote JID) to whom the PIX message will be sent. |
| Nome Do Beneficiário | The name of the PIX payment beneficiary. |
| Tipo Da Chave | The type of PIX key used for the beneficiary. Options: 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 message. The structure typically includes confirmation details about the sent PIX, status, and any relevant metadata returned by the API.
If the API supports binary data output (not indicated here), it would be summarized accordingly, but this node primarily deals with JSON responses.
Dependencies
- Requires access to the Evolution API endpoint specified by the user.
- Requires a valid API key credential for authentication.
- The node expects the user to provide correct instance names and recipient identifiers compatible with the Evolution API.
- No additional external libraries beyond those bundled with n8n are required.
Troubleshooting
Common issues:
- Incorrect or missing API key leading to authentication failures.
- Invalid or malformed Server URL causing connection errors.
- Wrong instance name or recipient number resulting in failed message delivery.
- Mismatch between the PIX key type and the provided key value.
Error messages:
"Operação não suportada."indicates the requested operation is not supported for the selected resource; verify resource and operation parameters.- Network or authentication errors usually stem from incorrect Server URL or API key; double-check these inputs.
- Validation errors from the API may indicate missing or invalid fields like beneficiary name or PIX key.
Links and References
- Evolution API Documentation (as referenced in the code)
- PIX Payment System Overview (for understanding PIX keys and types)