Ze da APIInstall

Summary

Sends a PIX button interactive message to a recipient, optionally with scheduling, delays, and pagination options.

Inputs

• phone (required) — Recipient phone number with country code
• delayMessage — Delay in seconds before sending the message (0 = API default 1-3s random)
• delayTyping — Show typing indicator for this many seconds before sending (1-15, 0 = off)
• scheduledFor — ISO 8601 timestamp for scheduled delivery (overrides Delay Message). Must be in the future.
• messageId — Message ID to reply to
• message — Message text
• pixKey (required) — PIX Key
• type (required) — PIX type (CNPJ/CPF/Email/EVP/Phone) – default CPF
• name — Recipient name for PIX
• transactionId — Transaction ID
• amount — Amount (numeric, precision 2)
• requestOptions — Collection of batching and proxy settings etc.
• allowUnauthorizedCerts — Whether to accept the response even if SSL certificate validation is not possible
• proxy — HTTP proxy to use. If authentication is required it can be defined as follow: http://username:password@myproxy:3128
• timeout — Time in ms to wait for the server to send response headers (and start the response body) before aborting the request

Output shape

A JSON response indicating success, typically containing the sent message ID or status; may be empty on success

Errors are propagated as exceptions; no body is returned on successful delivery

Examples

Example 1: Send a PIX button to a customer

phone=5511999999999, pixKey=123456789012, amount=150.00, type=CPF, name=John Doe

Example 2: Schedule a PIX reminder

phone=5511999999999, pixKey=987654321098, scheduledFor=2025-01-01T12:00:00Z, message=Reminder: Your payment is due

Links

• n8n community nodes installation guide