Skip to main content
POST
Send Pix button

Overview

Method for sending messages with a Pix payment button. The recipient receives a button that copies the Pix key when clicked. Supported key types: CPF, CNPJ, PHONE, EMAIL, and EVP (random key).

Authorizations

Authorization
string
header
required

Secret Key generated in the Omni Z-API Security panel

Body

application/json
phone
string
required

Recipient phone number (country code + area code + number)

Example:

"5511999999999"

pixKey
string
required

Pix key

type
enum<string>
required

Pix key type

Available options:
CPF,
CNPJ,
PHONE,
EMAIL,
EVP
merchantName
string

Button title. Default: "Pix"

Response

Message sent successfully

zaapId
string

Internal identifier

messageId
string

WhatsApp message ID

id
string

Same value as messageId (compatibility)