Messages

Send a PIX payment card (copy/pay button) message

Sends a WhatsApp message carrying a native PIX payment card. The recipient sees the merchant name and PIX key and can copy or pay it directly via the native pay button. The `keyType` is the PIX key type (`CPF`, `CNPJ`, `PHONE`, `EMAIL`, or `EVP`). An optional `amount` (BRL) sets the charge value; absent or `0` renders a static "any amount" code. WUTS attaches the payment business nodes required for the card to render and be delivered on the recipient's device.

POST
/send/button-pix

Sends a WhatsApp message carrying a native PIX payment card. The recipient sees the merchant name and PIX key and can copy or pay it directly via the native pay button. The keyType is the PIX key type (CPF, CNPJ, PHONE, EMAIL, or EVP). An optional amount (BRL) sets the charge value; absent or 0 renders a static "any amount" code. WUTS attaches the payment business nodes required for the card to render and be delivered on the recipient's device.

Authorization

bearerAuth
AuthorizationBearer <token>

Per-user API token (UUID v4) sent as Authorization: Bearer <token>. Identifies the tenant and user.

In: header

Request Body

application/json

TypeScript Definitions

Use the request body type in TypeScript.

Response Body

application/json

application/json

application/json

application/json

application/json

curl -X POST "https://example.com/send/button-pix" \  -H "Content-Type: application/json" \  -d '{    "to": "5511999999999",    "pixKey": "chave@exemplo.com",    "keyType": "EMAIL",    "merchantName": "Revotalk",    "amount": 49.9  }'
{  "success": true,  "message_id": "3EB0XXXXPIX1234567890ABCD",  "timestamp": "2026-06-19T14:32:10Z",  "status": "sent",  "chat_jid": "5511999999999@s.whatsapp.net",  "message": "PIX button message sent successfully"}
{  "error": "keyType must be one of CPF, CNPJ, PHONE, EMAIL, EVP"}
{  "error": "unauthorized"}
{  "error": "failed to dispatch message"}
{  "error": "WhatsApp device is not connected"}