Skip to main content
POST
/
instances
/
{instanceId}
/
token
/
{token}
/
send-button-pix
Send PIX button
curl --request POST \
  --url https://api.z-api.io/instances/{instanceId}/token/{token}/send-button-pix \
  --header 'Client-Token: <api-key>' \
  --header 'Content-Type: application/json' \
  --data '
{
  "phone": "<string>",
  "pixKey": "<string>",
  "type": "<string>"
}
'

​
Overview

With this method you can send PIX key messages with a copy button.
Button sending is currently available, but there are some decisive factors for it to work. For more details check the Button Status topic.
PIX messages received on WhatsApp Web don’t change the chat state — they don’t mark as unread or move to the top of the list. Messages render normally. This is a WhatsApp Web bug.

​
Attributes

​
instanceId
string
required
Your instance ID. Available in the Z-API panel under Instances.
​
token
string
required
Your Z-API instance token.

​
Required

​
phone
string
required
Recipient’s phone number (or group ID for group messages) in DDI DDD NUMBER format. E.g.: 551199999999
​
pixKey
string
required
PIX key
​
type
string
required
Key type: CPF, CNPJ, PHONE, EMAIL or EVP

​
Optional

​
merchantName
string
Button title (default: “Pix”)

​
Request Body

{
  "phone": "551199999999",
  "pixKey": "pix key",
  "type": "EVP"
}

​
Response

​
200

{
  "zaapId": "3999984263738042930CD6ECDE9VDWSA",
  "messageId": "D241XXXX732339502B68",
  "id": "D241XXXX732339502B68"
}

​
405

Make sure you are correctly sending the method specification, that is, verify that you sent POST or GET as specified at the beginning of this topic.

​
415

If you receive a 415 error, make sure to add the “Content-Type” header to your request, which in most cases is “application/json”.