Skip to main content
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"
}

​
Overview

Method for sending messages with a Pix payment button. The recipient receives a button that copies the Pix key when clicked. Supported key types: CPF, CNPJ, PHONE, EMAIL, and EVP (random key).
The response structure is identical to Z-API. Your existing code that processes these returns will continue working without changes.

Authorizations

​
Authorization
string
header
required

Secret Key generated in the Hub Message Security panel

Body

application/json
​
phone
string
required

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

Example:

"5511999999999"

​
pixKey
string
required

Pix key

​
type
enum<string>
required

Pix key type

Available options:
CPF,
CNPJ,
PHONE,
EMAIL,
EVP
​
merchantName
string

Button title. Default: "Pix"

Response

Message sent successfully

​
zaapId
string

Internal identifier

​
messageId
string

WhatsApp message ID

​
id
string

Same value as messageId (compatibility)