Z-API WhatsAppInstall

Summary

Sends a PIX button to a contact via WhatsApp.

Inputs

• phone (required) — Contact number (or group ID) in international format, digits only. Example: 5511999999999.
• pixKey (required) — PIX key that will be sent in the button (CPF, CNPJ, phone, email, or random key).
• pixType (required) — PIX key type (CPF, CNPJ, PHONE, EMAIL, or EVP), exactly as required by the API.
• merchantName — Title that will be shown on the button. If empty, the default shown is 'Pix'.

Output shape

raw JSON response from the /send-button-pix endpoint

May contain success details; errors are thrown as NodeOperationError.

Examples

Example 1: Send a payment PIX button to a client

Phone = 5511999999999, pixKey = '1234567890', pixType = 'CPF', merchantName = 'Acme Corp'

Example 2: Send a PIX button with default merchant name

Phone = 5511999999999, pixKey = 'randomKey123', pixType = 'EVP', merchantName omitted

Example 3: Send a PIX button to a group

Phone = '1234567890-group', pixKey = '987654321', pixType = 'CNPJ', merchantName = 'MyShop'

Links

• n8n community nodes installation guide