Pular para o conteúdo principal
POST
/
send-button-pix
Send Pix button
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 generated in the Hub Message Security panel

Corpo

application/json
​
phone
string
obrigatório

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

Exemplo:

"5511999999999"

​
pixKey
string
obrigatório

Pix key

​
type
enum<string>
obrigatório

Pix key type

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

Button title. Default: "Pix"

Resposta

Message sent successfully

​
zaapId
string

Internal identifier

​
messageId
string

WhatsApp message ID

​
id
string

Same value as messageId (compatibility)