Evolution API icon

Evolution API

Interact with Evolution API

Actions114

Message → Send PIX

AI-generated

Overview

This node operation sends a PIX payment message using the Evolution API. It is useful for automating the process of sending PIX payments to beneficiaries by specifying details such as the instance name, recipient number, beneficiary name, PIX key type, and PIX key. Practical examples include sending payment notifications or initiating PIX transfers programmatically within workflows.

Use Case Examples

  1. Automate sending PIX payments to customers or suppliers.
  2. Notify recipients of PIX payment details via messaging.

Properties

Name Meaning
Instance Name The name of the instance that will send the PIX payment message.
Recipient Number The phone number or identifier of the message recipient.
Beneficiary Name The name of the PIX payment beneficiary.
Key Type The type of PIX key used for the payment (e.g., phone, email, CPF, CNPJ, random).
PIX Key The PIX key of the beneficiary to which the payment is sent.

Output

JSON

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

Dependencies

  • Evolution API with required API key credentials

Troubleshooting

  • Ensure all required fields (Instance Name, Recipient Number, Beneficiary Name, Key Type, PIX Key) are provided and correctly formatted.
  • Check API credentials and network connectivity to Evolution API endpoint.
  • Common error: 'Unsupported operation' indicates the operation or resource is not implemented or incorrectly specified.

Discussion