Enviar PIX

POST

api

message

pix

:instance

Enviar PIX

curl --request POST \
  --url https://api.example.com/api/message/pix/:instance \
  --header 'Content-Type: <content-type>' \
  --header 'token: <token>' \
  --data '
{
  "number": "<string>",
  "merchantName": "<string>",
  "pixKey": "<string>",
  "pixKeyType": "<string>",
  "delay": 123,
  "replyTo": "<string>",
  "replyPrivate": true,
  "source": "<string>"
}
'

const options = {
  method: 'POST',
  headers: {token: '<token>', 'Content-Type': '<content-type>'},
  body: JSON.stringify({
    number: '<string>',
    merchantName: '<string>',
    pixKey: '<string>',
    pixKeyType: '<string>',
    delay: 123,
    replyTo: '<string>',
    replyPrivate: true,
    source: '<string>'
  })
};

fetch('https://api.example.com/api/message/pix/:instance', options)
  .then(res => res.json())
  .then(res => console.log(res))
  .catch(err => console.error(err));

import requests

url = "https://api.example.com/api/message/pix/:instance"

payload = {
    "number": "<string>",
    "merchantName": "<string>",
    "pixKey": "<string>",
    "pixKeyType": "<string>",
    "delay": 123,
    "replyTo": "<string>",
    "replyPrivate": True,
    "source": "<string>"
}
headers = {
    "token": "<token>",
    "Content-Type": "<content-type>"
}

response = requests.post(url, json=payload, headers=headers)

print(response.text)

Auth: TokenAccount o TokenInstance • Rate-limit: Global (100/min) • Idempotente: no

Descripción

Envía un mensaje con una tarjeta visual de PIX en el chat de WhatsApp, mostrando el nombre del beneficiario, el tipo de clave y la clave en sí. El botón funciona como un “copiar clave” con estilo PIX, al tocarlo, el destinatario copia la clave al portapapeles y la pega en su app bancaria para pagar. No abre una pantalla de pago, no crea un cobro, y no hay callback de confirmación, es solo la presentación visual de la clave en un formato amigable y clicable.

Ejemplos

PIX con clave CPF

Envía el botón PIX usando una clave CPF. Envía solo dígitos (sin puntos ni guiones).

curl -X POST "https://ryzeapi.cloud/api/message/pix/$Instance_Name" \
  -H "token: $Token_Instance" \
  -H "Content-Type: application/json" \
  -d '{
    "number":       "5511999999999",
    "merchantName": "RyzeAPI Tecnologia",
    "pixKey":       "12345678901",
    "pixKeyType":   "CPF"
  }'

await fetch(`https://ryzeapi.cloud/api/message/pix/${process.env.Instance_Name}`, {
  method: "POST",
  headers: {
    "token":        process.env.Token_Instance,
    "Content-Type": "application/json"
  },
  body: JSON.stringify({
    number:       "5511999999999",
    merchantName: "RyzeAPI Tecnologia",
    pixKey:       "12345678901",
    pixKeyType:   "CPF"
  })
});

import os, requests

requests.post(
    f"https://ryzeapi.cloud/api/message/pix/{os.environ['Instance_Name']}",
    headers={
        "token":        os.environ["Token_Instance"],
        "Content-Type": "application/json"
    },
    json={
        "number":       "5511999999999",
        "merchantName": "RyzeAPI Tecnologia",
        "pixKey":       "12345678901",
        "pixKeyType":   "CPF"
    }
)

package main

import (
    "net/http"
    "os"
    "strings"
)

func main() {
    body := strings.NewReader(`{
        "number":       "5511999999999",
        "merchantName": "RyzeAPI Tecnologia",
        "pixKey":       "12345678901",
        "pixKeyType":   "CPF"
    }`)
    req, _ := http.NewRequest("POST", "https://ryzeapi.cloud/api/message/pix/"+os.Getenv("Instance_Name"), body)
    req.Header.Set("token", os.Getenv("Token_Instance"))
    req.Header.Set("Content-Type", "application/json")
    http.DefaultClient.Do(req)
}

PIX con clave CNPJ

Envía el botón PIX usando una clave CNPJ. Envía solo dígitos (sin puntos, guiones ni barras).

curl -X POST "https://ryzeapi.cloud/api/message/pix/$Instance_Name" \
  -H "token: $Token_Instance" \
  -H "Content-Type: application/json" \
  -d '{
    "number":       "5511999999999",
    "merchantName": "RyzeAPI Tecnologia",
    "pixKey":       "12345678000199",
    "pixKeyType":   "CNPJ"
  }'

await fetch(`https://ryzeapi.cloud/api/message/pix/${process.env.Instance_Name}`, {
  method: "POST",
  headers: {
    "token":        process.env.Token_Instance,
    "Content-Type": "application/json"
  },
  body: JSON.stringify({
    number:       "5511999999999",
    merchantName: "RyzeAPI Tecnologia",
    pixKey:       "12345678000199",
    pixKeyType:   "CNPJ"
  })
});

import os, requests

requests.post(
    f"https://ryzeapi.cloud/api/message/pix/{os.environ['Instance_Name']}",
    headers={
        "token":        os.environ["Token_Instance"],
        "Content-Type": "application/json"
    },
    json={
        "number":       "5511999999999",
        "merchantName": "RyzeAPI Tecnologia",
        "pixKey":       "12345678000199",
        "pixKeyType":   "CNPJ"
    }
)

package main

import (
    "net/http"
    "os"
    "strings"
)

func main() {
    body := strings.NewReader(`{
        "number":       "5511999999999",
        "merchantName": "RyzeAPI Tecnologia",
        "pixKey":       "12345678000199",
        "pixKeyType":   "CNPJ"
    }`)
    req, _ := http.NewRequest("POST", "https://ryzeapi.cloud/api/message/pix/"+os.Getenv("Instance_Name"), body)
    req.Header.Set("token", os.Getenv("Token_Instance"))
    req.Header.Set("Content-Type", "application/json")
    http.DefaultClient.Do(req)
}

PIX con clave Email

Envía el botón PIX usando una clave EMAIL.

curl -X POST "https://ryzeapi.cloud/api/message/pix/$Instance_Name" \
  -H "token: $Token_Instance" \
  -H "Content-Type: application/json" \
  -d '{
    "number":       "5511999999999",
    "merchantName": "RyzeAPI Tecnologia",
    "pixKey":       "contato@ryzeapi.cloud",
    "pixKeyType":   "EMAIL"
  }'

await fetch(`https://ryzeapi.cloud/api/message/pix/${process.env.Instance_Name}`, {
  method: "POST",
  headers: {
    "token":        process.env.Token_Instance,
    "Content-Type": "application/json"
  },
  body: JSON.stringify({
    number:       "5511999999999",
    merchantName: "RyzeAPI Tecnologia",
    pixKey:       "contato@ryzeapi.cloud",
    pixKeyType:   "EMAIL"
  })
});

import os, requests

requests.post(
    f"https://ryzeapi.cloud/api/message/pix/{os.environ['Instance_Name']}",
    headers={
        "token":        os.environ["Token_Instance"],
        "Content-Type": "application/json"
    },
    json={
        "number":       "5511999999999",
        "merchantName": "RyzeAPI Tecnologia",
        "pixKey":       "contato@ryzeapi.cloud",
        "pixKeyType":   "EMAIL"
    }
)

package main

import (
    "net/http"
    "os"
    "strings"
)

func main() {
    body := strings.NewReader(`{
        "number":       "5511999999999",
        "merchantName": "RyzeAPI Tecnologia",
        "pixKey":       "contato@ryzeapi.cloud",
        "pixKeyType":   "EMAIL"
    }`)
    req, _ := http.NewRequest("POST", "https://ryzeapi.cloud/api/message/pix/"+os.Getenv("Instance_Name"), body)
    req.Header.Set("token", os.Getenv("Token_Instance"))
    req.Header.Set("Content-Type", "application/json")
    http.DefaultClient.Do(req)
}

Respuesta exitosa

200 OK

{
  "success": true,
  "message": "Message sent successfully",
  "status":  "sent",
  "data": {
    "messageId":   "3EB08FCF27E532F1B0F5",
    "direction":   "outgoing",
    "messageType": "pix",
    "content":     "",
    "source":      "api",
    "timestamp":   "2026-04-30T14:30:00Z",
    "chat": {
      "jid":     "5511999999999@s.whatsapp.net",
      "isGroup": false
    },
    "sender": {
      "jid":      "5511777777777@s.whatsapp.net",
      "instance": "minha-instancia"
    }
  }
}

El botón solo copia la clave PIX al portapapeles del destinatario, no abre la pantalla de pago del banco ni inicia un cobro. El pago lo hace manualmente el destinatario en su propia app bancaria, y no hay callback de “pagado” vía WhatsApp.

Parámetros de ruta

string

requerido

Nombre de la instancia (p. ej., $Instance_Name).

Cabeceras

string

requerido

TokenAccount o TokenInstance.

string

requerido

application/json

Cuerpo de la solicitud

string

requerido

Destino: teléfono (5511999999999) o JID (@s.whatsapp.net, @lid, @g.us).

string

requerido

Nombre del beneficiario mostrado en la tarjeta visual de PIX (sobre la clave).

string

requerido

Clave PIX (CPF, CNPJ, email, teléfono o clave aleatoria).

string

requerido

Tipo de clave. Valores aceptados: CPF, CNPJ, EMAIL, PHONE, RANDOM.

int

predeterminado:"0"

Tiempo en segundos a esperar antes de enviar. Durante el intervalo, el servidor envía el indicador “escribiendo…” al destinatario.

string

ID del mensaje a citar (respuesta). El mensaje original debe pertenecer a la misma instancia y haber sido guardado en la base de datos.

boolean

predeterminado:"false"

Cuando es true y replyTo apunta a un mensaje originado en un grupo, la respuesta se redirige al chat privado del autor original.

string

predeterminado:"api"

Identificador de origen para trazabilidad (p. ej., crm, checkout, n8n).

Notas

El pixKeyType se valida con oneof, si envías un valor fuera de CPF | CNPJ | EMAIL | PHONE | RANDOM, la solicitud se rechaza con 400.
Para claves CPF/CNPJ, envía solo dígitos (sin puntos, guiones ni barras): 12345678901 o 12345678000199.
Para PHONE, usa el formato internacional sin + (p. ej., 5511999999999).
Para RANDOM, usa el UUID generado por el banco (p. ej., aabbccdd-1234-5678-90ab-cdef01234567).
Este endpoint no crea un código QR Brcode ni registra un cobro, es solo la representación visual del pedido con una clave PIX clicable.

Errores

HTTP	Status interno	Mensaje
400	,	`Instance name is required`
400	,	`Invalid request: <detail>`
400	,	`Number is required`
400	,	`MerchantName is required`
400	,	`PixKey is required`
400	,	`PixKeyType is required`
400	`invalid_number`	`Invalid phone number format: <detail>`
400	`invalid_request`	(validación `oneof` u otro motivo)
404	,	`Instance not found`
500	`send_failed`	`Failed to send message: <reason>`
503	`disconnected`	`Instance is not connected to WhatsApp`

Envoltorio de error:

{
  "success": false,
  "error": { "message": "PixKeyType is required" }
}

Introducción

Instancia

Eventos

Mensajes

Llamadas

Grupos

Comunidades

Newsletter

Perfil

Chat

Chatwoot

Typebot

Observabilidad

Descripción

Ejemplos

PIX con clave CPF

PIX con clave CNPJ

PIX con clave Email

Respuesta exitosa

Parámetros de ruta

Cabeceras

Cuerpo de la solicitud

Notas

Errores

​Descripción

​Ejemplos

​PIX con clave CPF

​PIX con clave CNPJ

​PIX con clave Email

​Respuesta exitosa

​Parámetros de ruta

​Cabeceras

​Cuerpo de la solicitud

​Notas

​Errores

Descripción

Ejemplos

PIX con clave CPF

PIX con clave CNPJ

PIX con clave Email

Respuesta exitosa

Parámetros de ruta

Cabeceras

Cuerpo de la solicitud

Notas

Errores