Pular para o conteúdo principal
POST
/
send-button-pix
Enviar botão Pix
curl --request POST \
  --url https://zapi.hubmessage.io/channels/{channel_id}/token/{channel_token}/send-button-pix \
  --header 'Authorization: Bearer <token>' \
  --header 'Content-Type: application/json' \
  --data '
{
  "phone": "5511999999999",
  "pixKey": "12345678900",
  "type": "CPF",
  "merchantName": "Hub Message"
}
'
{
  "zaapId": "3999984263738042930CD6ECDE9VDWSA",
  "messageId": "D241XXXX732339502B68",
  "id": "D241XXXX732339502B68"
}

​
Conceituação

Método para envio de mensagens com botão de pagamento via Pix. O destinatário recebe um botão que ao ser clicado copia a chave Pix. Os tipos de chave suportados são: CPF, CNPJ, PHONE, EMAIL e EVP (chave aleatória).
A estrutura de resposta é idêntica à da Z-API. Seu código existente que processa esses retornos continuará funcionando sem alterações.

Autorizações

​
Authorization
string
header
obrigatório

Secret Key gerada no painel de Segurança do Hub Message

Corpo

application/json
​
phone
string
obrigatório

Telefone do destinatário (DDI + DDD + número)

Exemplo:

"5511999999999"

​
pixKey
string
obrigatório

Chave Pix

​
type
enum<string>
obrigatório

Tipo da chave Pix

Opções disponíveis:
CPF,
CNPJ,
PHONE,
EMAIL,
EVP
​
merchantName
string

Título do botão. Padrão: "Pix"

Resposta

Mensagem enviada com sucesso

​
zaapId
string

Identificador interno

​
messageId
string

ID da mensagem no WhatsApp

​
id
string

Mesmo valor do messageId (compatibilidade)