NODAPI

Enviar Mensagem

Enviar botão PIX

POST/send/pix-button
  • Conta no limite de envio da conexão. Ao passar do limite, a resposta é 429.

Autenticação: envie a chave da conexão no header token ou em Authorization: Bearer.

Envia um botão nativo do WhatsApp que abre para pagamento PIX com a chave informada. O usuário visualiza o detalhe do recebedor, nome e chave.

Regras principais

  • pixType aceita: CPF, CNPJ, PHONE, EMAIL, EVP (case insensitive)
  • pixName padrão: "Pix" quando não informado - nome de quem recebe o pagamento

Campos comuns

Este endpoint herda os campos opcionais padronizados da tag "Enviar Mensagem": delay, readchat, readmessages, replyid, mentions, track_source, track_id e async.

Exemplo de payload

{
  "number": "5511999999999",
  "pixType": "EVP",
  "pixKey": "123e4567-e89b-12d3-a456-426614174000",
  "pixName": "Loja Exemplo"
}

Corpo da requisição (JSON)

CampoTipoDescrição
number*string

ID do chat para o qual a mensagem será enviada. Pode ser um número de telefone em formato internacional, um ID de grupo (@g.us), um ID de usuário (com @s.whatsapp.net ou @lid).

Exemplo: 5511999999999

pixType*string

Tipo da chave PIX. Valores aceitos: CPF, CNPJ, PHONE, EMAIL ou EVP

Exemplo: EVP

pixKey*string

Valor da chave PIX (CPF/CNPJ/telefone/email/EVP)

Exemplo: 123e4567-e89b-12d3-a456-426614174000

pixNamestring

Nome exibido como recebedor do PIX (padrão "Pix" se vazio)

Exemplo: Loja Exemplo

asyncboolean

Enfileira o envio para processamento assíncrono

delayinteger

Atraso em milissegundos antes do envio (exibe "digitando..." no WhatsApp)

readchatboolean

Marca o chat como lido após enviar a mensagem

readmessagesboolean

Marca mensagens recentes como lidas após o envio

replyidstring

ID da mensagem que será respondida

mentionsstring

Lista de números mencionados separados por vírgula

track_sourcestring

Origem de rastreamento (ex.: chatwoot, crm-interno)

track_idstring

Identificador de rastreamento (aceita valores duplicados)

* obrigatório

Respostas

  • 200Botão PIX enviado com sucesso
  • 400Requisição inválida
  • 401Não autorizado
  • 500Erro interno do servidor

Experimente

Atenção: a chamada é real. Ela roda na sua conexão e pode enviar mensagem de verdade. A chave fica só nesta tela e some ao sair dela; nunca é guardada.

Cole a chave gerada no painel.