Skip to main content
POST
Enviar botón Pix

Conceptos

Método para enviar mensajes con botón de pago mediante Pix. El destinatario recibe un botón que, al pulsarlo, copia la clave Pix. Los tipos de clave admitidos son: CPF, CNPJ, PHONE, EMAIL y EVP (clave aleatoria).

Autorizaciones

Authorization
string
header
requerido

Secret Key generada en el panel de Seguridad de Omni Z-API

Cuerpo

application/json
phone
string
requerido

Teléfono del destinatario (código de país + prefijo + número)

Ejemplo:

"5511999999999"

pixKey
string
requerido

Clave Pix

type
enum<string>
requerido

Tipo de clave Pix

Opciones disponibles:
CPF,
CNPJ,
PHONE,
EMAIL,
EVP
merchantName
string

Título del botón. Por defecto: «Pix»

Respuesta

Mensaje enviado correctamente

zaapId
string

Identificador interno

messageId
string

ID del mensaje en WhatsApp

id
string

El mismo valor que messageId (compatibilidad)