Pular para o conteúdo principal
POST
/
instances
/
{instanceId}
/
token
/
{token}
/
send-button-pix
Enviar botão PIX
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>"
}
'

Documentation Index

Fetch the complete documentation index at: https://developer.z-api.io/llms.txt

Use this file to discover all available pages before exploring further.

​
Conceituação

Neste método você poderá enviar mensagens de chave pix com botão para copiar.
Envios de botões atualmente se encontram disponíveis, porém possui alguns fatores decisivos para o funcionamento. Para mais detalhes acesse o tópico Funcionamento dos Botões.
Mensagens PIX recebidas no WhatsApp Web não alteram o estado do chat — não marcam como não lido nem movem para o topo da lista. As mensagens são renderizadas normalmente. Isso é um bug do WhatsApp Web.

​
Exemplo no WhatsApp

​
Atributos

​
instanceId
string
obrigatório
ID da sua instância. Disponível no painel Z-API em Instâncias.
​
token
string
obrigatório
Token da sua instância Z-API.

​
Obrigatórios

​
phone
string
obrigatório
Telefone (ou ID do grupo para casos de envio para grupos) do destinatário no formato DDI DDD NÚMERO. Ex: 551199999999
​
pixKey
string
obrigatório
Chave PIX
​
type
string
obrigatório
Tipo da chave: CPF, CNPJ, PHONE, EMAIL ou EVP

​
Opcionais

​
merchantName
string
Título do botão (padrão: “Pix”)

​
Request Body

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

​
Response

​
200

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

​
405

Neste caso certifique que esteja enviando corretamente a especificação do método, ou seja verifique se você enviou o POST ou GET conforme especificado no início deste tópico.

​
415

Caso você receba um erro 415, certifique de adicionar na headers da requisição o “Content-Type” do objeto que você está enviando, em sua grande maioria “application/json”.