> ## Documentation Index
> Fetch the complete documentation index at: https://docs.ryzeapi.cloud/llms.txt
> Use this file to discover all available pages before exploring further.

# Enviar Pix

> Envia botão de pagamento PIX com chave e comerciante

**Auth:** `TokenAccount` ou `TokenInstance` • **Rate-limit:** `Global` (100/min) • **Idempotente:** não

## Descrição

Envia uma mensagem com **cartão visual de PIX** no chat do WhatsApp, exibindo o nome do beneficiário, o tipo da chave e a própria chave. O botão funciona como um **"copiar chave"** com design de PIX, ao tocar, o destinatário copia a chave para a área de transferência e cola no app do banco para pagar. Não abre tela de pagamento, não cria cobrança e não há callback de confirmação, é apenas a apresentação visual da chave em formato amigável e clicável.

## Exemplos

### PIX com Chave de CPF

Envia o botão PIX usando uma chave do tipo `CPF`. Envie **apenas dígitos** (sem pontos ou traços).

<CodeGroup>
  ```bash cURL theme={null}
  curl -X POST "https://ryzeapi.cloud/api/message/pix/$Instance_Name" \
    -H "token: $Token_Instance" \
    -H "Content-Type: application/json" \
    -d '{
      "number":       "5511999999999",
      "merchantName": "RyzeAPI Tecnologia",
      "pixKey":       "12345678901",
      "pixKeyType":   "CPF"
    }'
  ```

  ```javascript JavaScript theme={null}
  await fetch(`https://ryzeapi.cloud/api/message/pix/${process.env.Instance_Name}`, {
    method: "POST",
    headers: {
      "token":        process.env.Token_Instance,
      "Content-Type": "application/json"
    },
    body: JSON.stringify({
      number:       "5511999999999",
      merchantName: "RyzeAPI Tecnologia",
      pixKey:       "12345678901",
      pixKeyType:   "CPF"
    })
  });
  ```

  ```python Python theme={null}
  import os, requests

  requests.post(
      f"https://ryzeapi.cloud/api/message/pix/{os.environ['Instance_Name']}",
      headers={
          "token":        os.environ["Token_Instance"],
          "Content-Type": "application/json"
      },
      json={
          "number":       "5511999999999",
          "merchantName": "RyzeAPI Tecnologia",
          "pixKey":       "12345678901",
          "pixKeyType":   "CPF"
      }
  )
  ```

  ```go Go theme={null}
  package main

  import (
      "net/http"
      "os"
      "strings"
  )

  func main() {
      body := strings.NewReader(`{
          "number":       "5511999999999",
          "merchantName": "RyzeAPI Tecnologia",
          "pixKey":       "12345678901",
          "pixKeyType":   "CPF"
      }`)
      req, _ := http.NewRequest("POST", "https://ryzeapi.cloud/api/message/pix/"+os.Getenv("Instance_Name"), body)
      req.Header.Set("token", os.Getenv("Token_Instance"))
      req.Header.Set("Content-Type", "application/json")
      http.DefaultClient.Do(req)
  }
  ```
</CodeGroup>

### PIX com Chave de CNPJ

Envia o botão PIX usando uma chave do tipo `CNPJ`. Envie **apenas dígitos** (sem pontos, traços ou barras).

<CodeGroup>
  ```bash cURL theme={null}
  curl -X POST "https://ryzeapi.cloud/api/message/pix/$Instance_Name" \
    -H "token: $Token_Instance" \
    -H "Content-Type: application/json" \
    -d '{
      "number":       "5511999999999",
      "merchantName": "RyzeAPI Tecnologia",
      "pixKey":       "12345678000199",
      "pixKeyType":   "CNPJ"
    }'
  ```

  ```javascript JavaScript theme={null}
  await fetch(`https://ryzeapi.cloud/api/message/pix/${process.env.Instance_Name}`, {
    method: "POST",
    headers: {
      "token":        process.env.Token_Instance,
      "Content-Type": "application/json"
    },
    body: JSON.stringify({
      number:       "5511999999999",
      merchantName: "RyzeAPI Tecnologia",
      pixKey:       "12345678000199",
      pixKeyType:   "CNPJ"
    })
  });
  ```

  ```python Python theme={null}
  import os, requests

  requests.post(
      f"https://ryzeapi.cloud/api/message/pix/{os.environ['Instance_Name']}",
      headers={
          "token":        os.environ["Token_Instance"],
          "Content-Type": "application/json"
      },
      json={
          "number":       "5511999999999",
          "merchantName": "RyzeAPI Tecnologia",
          "pixKey":       "12345678000199",
          "pixKeyType":   "CNPJ"
      }
  )
  ```

  ```go Go theme={null}
  package main

  import (
      "net/http"
      "os"
      "strings"
  )

  func main() {
      body := strings.NewReader(`{
          "number":       "5511999999999",
          "merchantName": "RyzeAPI Tecnologia",
          "pixKey":       "12345678000199",
          "pixKeyType":   "CNPJ"
      }`)
      req, _ := http.NewRequest("POST", "https://ryzeapi.cloud/api/message/pix/"+os.Getenv("Instance_Name"), body)
      req.Header.Set("token", os.Getenv("Token_Instance"))
      req.Header.Set("Content-Type", "application/json")
      http.DefaultClient.Do(req)
  }
  ```
</CodeGroup>

### PIX com Chave de Email

Envia o botão PIX usando uma chave do tipo `EMAIL`.

<CodeGroup>
  ```bash cURL theme={null}
  curl -X POST "https://ryzeapi.cloud/api/message/pix/$Instance_Name" \
    -H "token: $Token_Instance" \
    -H "Content-Type: application/json" \
    -d '{
      "number":       "5511999999999",
      "merchantName": "RyzeAPI Tecnologia",
      "pixKey":       "contato@ryzeapi.cloud",
      "pixKeyType":   "EMAIL"
    }'
  ```

  ```javascript JavaScript theme={null}
  await fetch(`https://ryzeapi.cloud/api/message/pix/${process.env.Instance_Name}`, {
    method: "POST",
    headers: {
      "token":        process.env.Token_Instance,
      "Content-Type": "application/json"
    },
    body: JSON.stringify({
      number:       "5511999999999",
      merchantName: "RyzeAPI Tecnologia",
      pixKey:       "contato@ryzeapi.cloud",
      pixKeyType:   "EMAIL"
    })
  });
  ```

  ```python Python theme={null}
  import os, requests

  requests.post(
      f"https://ryzeapi.cloud/api/message/pix/{os.environ['Instance_Name']}",
      headers={
          "token":        os.environ["Token_Instance"],
          "Content-Type": "application/json"
      },
      json={
          "number":       "5511999999999",
          "merchantName": "RyzeAPI Tecnologia",
          "pixKey":       "contato@ryzeapi.cloud",
          "pixKeyType":   "EMAIL"
      }
  )
  ```

  ```go Go theme={null}
  package main

  import (
      "net/http"
      "os"
      "strings"
  )

  func main() {
      body := strings.NewReader(`{
          "number":       "5511999999999",
          "merchantName": "RyzeAPI Tecnologia",
          "pixKey":       "contato@ryzeapi.cloud",
          "pixKeyType":   "EMAIL"
      }`)
      req, _ := http.NewRequest("POST", "https://ryzeapi.cloud/api/message/pix/"+os.Getenv("Instance_Name"), body)
      req.Header.Set("token", os.Getenv("Token_Instance"))
      req.Header.Set("Content-Type", "application/json")
      http.DefaultClient.Do(req)
  }
  ```
</CodeGroup>

## Resposta de sucesso

```json 200 OK theme={null}
{
  "success": true,
  "message": "Message sent successfully",
  "status":  "sent",
  "data": {
    "messageId":   "3EB08FCF27E532F1B0F5",
    "direction":   "outgoing",
    "messageType": "pix",
    "content":     "",
    "source":      "api",
    "timestamp":   "2026-04-30T14:30:00Z",
    "chat": {
      "jid":     "5511999999999@s.whatsapp.net",
      "isGroup": false
    },
    "sender": {
      "jid":      "5511777777777@s.whatsapp.net",
      "instance": "minha-instancia"
    }
  }
}
```

<Note>
  O botão **apenas copia a chave PIX** para a área de transferência do destinatário, não abre a tela de pagamento do banco nem inicia uma cobrança. O pagamento é feito manualmente pelo destinatário no app do próprio banco, e **não há callback de "pago" via WhatsApp**.
</Note>

## Parâmetros de rota

<ParamField path="instance" type="string" required>
  Nome da instância (ex.: `$Instance_Name`).
</ParamField>

## Headers

<ParamField header="token" type="string" required>
  `TokenAccount` ou `TokenInstance`.
</ParamField>

<ParamField header="Content-Type" type="string" required>
  `application/json`
</ParamField>

## Request body

<ParamField body="number" type="string" required>
  Destino: telefone (`5511999999999`) ou JID (`@s.whatsapp.net`, `@lid`, `@g.us`).
</ParamField>

<ParamField body="merchantName" type="string" required>
  Nome do beneficiário exibido no cartão visual do PIX (acima da chave).
</ParamField>

<ParamField body="pixKey" type="string" required>
  Chave PIX (CPF, CNPJ, e-mail, telefone ou chave aleatória).
</ParamField>

<ParamField body="pixKeyType" type="string" required>
  Tipo da chave. Valores aceitos: `CPF`, `CNPJ`, `EMAIL`, `PHONE`, `RANDOM`.
</ParamField>

<ParamField body="delay" type="int" default="0">
  Tempo em **segundos** para aguardar antes de enviar. Durante o intervalo, o servidor envia o indicador de "digitando..." ao destinatário.
</ParamField>

<ParamField body="replyTo" type="string">
  ID da mensagem a ser citada (reply). A mensagem original precisa pertencer à mesma instância e ter sido salva no banco.
</ParamField>

<ParamField body="replyPrivate" type="boolean" default="false">
  Quando `true` **e** `replyTo` aponta para uma mensagem originária de um grupo, a resposta é redirecionada para o **privado** do autor original.
</ParamField>

<ParamField body="source" type="string" default="api">
  Identificador de origem para rastreabilidade (ex.: `crm`, `checkout`, `n8n`).
</ParamField>

## Notas

<Note>
  * O **`pixKeyType`** é validado por `oneof`, se enviar um valor fora de `CPF | CNPJ | EMAIL | PHONE | RANDOM`, a request é rejeitada com `400`.
  * Para chaves CPF/CNPJ envie **apenas dígitos** (sem pontos, traços ou barras): `12345678901` ou `12345678000199`.
  * Para `PHONE`, use o formato internacional sem `+` (ex.: `5511999999999`).
  * Para `RANDOM`, use a UUID que o banco gerou (ex.: `aabbccdd-1234-5678-90ab-cdef01234567`).
  * Esse endpoint não cria QR Code Brcode nem registra cobrança, é apenas a **representação visual** do pedido com chave PIX clicável.
</Note>

## Erros

| HTTP | Status interno    | Mensagem                                 |
| ---- | ----------------- | ---------------------------------------- |
| 400  | ,                 | `Instance name is required`              |
| 400  | ,                 | `Invalid request: <detalhe>`             |
| 400  | ,                 | `Number is required`                     |
| 400  | ,                 | `MerchantName is required`               |
| 400  | ,                 | `PixKey is required`                     |
| 400  | ,                 | `PixKeyType is required`                 |
| 400  | `invalid_number`  | `Invalid phone number format: <detalhe>` |
| 400  | `invalid_request` | (validação `oneof` ou outro motivo)      |
| 404  | ,                 | `Instance not found`                     |
| 500  | `send_failed`     | `Failed to send message: <reason>`       |
| 503  | `disconnected`    | `Instance is not connected to WhatsApp`  |

Envelope de erro:

```json theme={null}
{
  "success": false,
  "error": { "message": "PixKeyType is required" }
}
```