Skip to main content
POST
/
api
/
messages
/
pix
curl -X POST "https://api.oxenty.api.br/api/messages/pix" \
  -H "X-API-Key: YOUR_API_KEY" \
  -H "Content-Type: application/json" \
  -d '{
    "sessionId": "550e8400-e29b-41d4-a716-446655440000",
    "to": "5511999999999",
    "pixKey": "12345678901",
    "pixKeyType": "cpf",
    "merchantName": "Loja Exemplo",
    "amount": 99.90,
    "itemName": "Pedido #12345",
    "buttonText": "Pagar R$ 99,90"
  }'

{
  "messageId": "3EB0A1B2C3D4E5F6",
  "status": "sent"
}

Documentation Index

Fetch the complete documentation index at: https://docs.oxenty.api.br/llms.txt

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

Envia uma mensagem interativa de pagamento PIX com QR code. O destinatário pode escanear ou copiar o código PIX para realizar o pagamento.

​
Request Body

​
sessionId
string
required
ID da sessão WhatsApp.
​
to
string
required
Número do destinatário ou JID de grupo.
​
pixKey
string
required
Chave PIX (CPF, CNPJ, email, telefone ou chave aleatória).
​
pixKeyType
string
required
Tipo da chave PIX.Valores: cpf, cnpj, email, phone, random
​
merchantName
string
required
Nome do recebedor (comerciante).
​
amount
number
Valor do pagamento em reais (opcional).
​
referenceId
string
ID de referência da transação (opcional).
​
itemName
string
Nome do item/serviço sendo pago (opcional).
​
buttonText
string
default:"Pagar"
Texto do botão de pagamento.

​
Resposta

​
messageId
string
ID único da mensagem enviada.
curl -X POST "https://api.oxenty.api.br/api/messages/pix" \
  -H "X-API-Key: YOUR_API_KEY" \
  -H "Content-Type: application/json" \
  -d '{
    "sessionId": "550e8400-e29b-41d4-a716-446655440000",
    "to": "5511999999999",
    "pixKey": "12345678901",
    "pixKeyType": "cpf",
    "merchantName": "Loja Exemplo",
    "amount": 99.90,
    "itemName": "Pedido #12345",
    "buttonText": "Pagar R$ 99,90"
  }'

{
  "messageId": "3EB0A1B2C3D4E5F6",
  "status": "sent"
}
O PIX é um método de pagamento instantâneo brasileiro. A mensagem gerada inclui um QR code que o destinatário pode escanear com seu app de banco.