Skip to main content
POST
/
instances
/
{instanceId}
/
token
/
{instanceToken}
/
send-button-pix
curl --request POST \
  --url https://api.ezapi.com.br/instances/{instanceId}/token/{instanceToken}/send-button-pix \
  --header 'Client-Token: <api-key>' \
  --header 'Content-Type: application/json' \
  --data '
{
  "phone": "{{PHONE}}",
  "pixKey": "Chave PIX",
  "type": "CPF"
}
'
{
  "messageId": "3EB047ED70306656281B34",
  "id": "3EB047ED70306656281B34"
}
{
  "error": "Unauthorized",
  "message": "Invalid instanceToken"
}
{
  "error": "Instance not found"
}
{
  "error": "Worker command timeout"
}
{
  "error": "Unable to process request"
}
Envia um botão interativo de pagamento PIX.

Authorizations

​
Client-Token
string
header
required

Path Parameters

​
instanceId
string
required

Identificador único da instância.

Example:

"abc1234567890"

​
instanceToken
string
required

Token privado da instância retornado na criação.

Example:

"tok_a1b2c3d4e5f6"

Body

application/json
​
phone
string
required

Número com código do país (ex: 554499999999) ou JID de grupo (ex: 120363123456789@g.us)

Example:

"{{PHONE}}"

​
pixKey
string
required
Example:

"Chave PIX"

​
type
string
required
Example:

"CPF"

​
mentioned
string[]

Lista de números para mencionar em grupos

Example:
["554499999999"]
​
mentionsEveryOne
boolean
default:false

Mencionar todos os participantes do grupo

Response

Resposta de sucesso.

​
messageId
string
required
Example:

"3EB047ED70306656281B34"

​
id
string
required
Example:

"3EB047ED70306656281B34"