Evolution API icon

Evolution API

Interact with Evolution API
Join our community

Actions64

Overview

This node interacts with the Evolution API to send PIX payment messages. It is designed to facilitate sending PIX transactions by specifying details such as the instance name, recipient number, beneficiary name, PIX key type, and the PIX key itself. This node is useful in scenarios where automated PIX payments need to be sent programmatically, such as in financial applications, payment processing systems, or automated billing workflows.

Use Case Examples

  1. Sending a PIX payment to a customer by specifying their phone number as the PIX key.
  2. Automating PIX transactions to multiple beneficiaries by iterating over a list of recipients and sending payments using their respective PIX keys.

Properties

Name Meaning
Instance Name The name of the instance that will send the PIX payment.
Recipient Number The recipient's contact number to whom the PIX payment will be sent.
Beneficiary Name The name of the PIX payment beneficiary.
Key Type The type of PIX key used for the transaction (e.g., phone, email, CPF, CNPJ, random).
Key PIX The PIX key of the beneficiary to which the payment will be sent.

Output

JSON

  • status - The status of the PIX payment request.
  • messageId - The unique identifier of the sent PIX message.
  • timestamp - The timestamp when the PIX payment was sent.

Dependencies

  • Requires an API key credential for authenticating with the Evolution API.

Troubleshooting

  • Ensure that the instance name and recipient number are correctly specified to avoid sending failures.
  • Verify that the PIX key type matches the format of the provided PIX key to prevent validation errors.
  • Check API credentials and network connectivity if the node fails to communicate with the Evolution API.
  • Common error messages may include unsupported operation errors if the resource or operation parameters are incorrect, or authentication errors if API credentials are invalid.

Discussion