curl --request POST \
  --url https://api.wppfy.com/send/request-payment \
  --header 'Content-Type: application/json' \
  --header 'token: <api-key>' \
  --data '
{
  "number": "5511999999999",
  "orderMessageId": "3EB0ID_DO_PEDIDO",
  "pixKey": "123e4567-e89b-12d3-a456-426614174000",
  "text": "Confira os dados para pagamento"
}
'

{
  "id": "3c90c3cc-0d44-4b50-8888-8dd25736052a",
  "messageid": "<string>",
  "chatid": "<string>",
  "sender": "<string>",
  "senderName": "<string>",
  "isGroup": false,
  "fromMe": false,
  "messageType": "<string>",
  "source": "<string>",
  "messageTimestamp": 0,
  "status": "<string>",
  "text": "",
  "quoted": "",
  "edited": "",
  "reaction": "",
  "vote": "",
  "convertOptions": "",
  "buttonOrListid": "",
  "owner": "",
  "error": "",
  "content": {},
  "wasSentByApi": true,
  "pinned": true,
  "sendFunction": "<string>",
  "sendPayload": {},
  "fileURL": "<string>",
  "callPeer": {
    "jid": "<string>",
    "name": "<string>",
    "imagePreviewUrl": "<string>"
  },
  "send_folder_id": "<string>",
  "track_source": "<string>",
  "track_id": "<string>",
  "ai_metadata": {
    "agent_id": "<string>",
    "turn": "<string>",
    "flow_id": "<string>",
    "request": {
      "messages": "<array>",
      "tools": "<array>",
      "options": {
        "model": "<string>",
        "temperature": 123,
        "maxTokens": 123,
        "topP": 123,
        "frequencyPenalty": 123,
        "presencePenalty": 123
      }
    },
    "response": {
      "choices": "<array>",
      "toolResults": "<array>",
      "error": "<string>"
    },
    "outcome": {
      "status": "sent",
      "texts": 123,
      "audio": true,
      "menus": 123,
      "files": 123,
      "handoff": "<string>",
      "lead": [
        "<string>"
      ],
      "detail": "<string>"
    }
  },
  "sender_pn": "<string>",
  "sender_lid": "<string>",
  "sender_image_preview_url": "<string>",
  "response": {
    "status": "success",
    "message": "Payment request sent successfully"
  }
}

{
  "error": "Missing pixKey or pixCode"
}

{
  "error": "Invalid token"
}

{
  "error": "Failed to send payment request"
}

Send Message

Request payment

Sends a payment request with WhatsApp’s native “Review and pay” button. The flow supports PIX (static, dynamic, or disabled), boleto, payment link, and card, combining everything into a single interactive message.

How it works

Sets the value in amount (BRL by default) and optionally customizes the title, text, and additional note.
By default, pixKey is required.
The file pointed to by fileUrl is attached as a document (a boleto or PDF invoice, for example).
paymentLink enables the external button.
To charge for an order received via WhatsApp, provide orderMessageId with the ID of the OrderMessage message from that same contact. The API retrieves the order’s items, currency, and total; amount is not required in this case. A payment method must still be provided.

Common fields

This endpoint also supports the standard fields: delay, readchat, readmessages, replyid, mentions, track_source, track_id, and async.

POST

send

request-payment

curl --request POST \
  --url https://api.wppfy.com/send/request-payment \
  --header 'Content-Type: application/json' \
  --header 'token: <api-key>' \
  --data '
{
  "number": "5511999999999",
  "orderMessageId": "3EB0ID_DO_PEDIDO",
  "pixKey": "123e4567-e89b-12d3-a456-426614174000",
  "text": "Confira os dados para pagamento"
}
'

{
  "id": "3c90c3cc-0d44-4b50-8888-8dd25736052a",
  "messageid": "<string>",
  "chatid": "<string>",
  "sender": "<string>",
  "senderName": "<string>",
  "isGroup": false,
  "fromMe": false,
  "messageType": "<string>",
  "source": "<string>",
  "messageTimestamp": 0,
  "status": "<string>",
  "text": "",
  "quoted": "",
  "edited": "",
  "reaction": "",
  "vote": "",
  "convertOptions": "",
  "buttonOrListid": "",
  "owner": "",
  "error": "",
  "content": {},
  "wasSentByApi": true,
  "pinned": true,
  "sendFunction": "<string>",
  "sendPayload": {},
  "fileURL": "<string>",
  "callPeer": {
    "jid": "<string>",
    "name": "<string>",
    "imagePreviewUrl": "<string>"
  },
  "send_folder_id": "<string>",
  "track_source": "<string>",
  "track_id": "<string>",
  "ai_metadata": {
    "agent_id": "<string>",
    "turn": "<string>",
    "flow_id": "<string>",
    "request": {
      "messages": "<array>",
      "tools": "<array>",
      "options": {
        "model": "<string>",
        "temperature": 123,
        "maxTokens": 123,
        "topP": 123,
        "frequencyPenalty": 123,
        "presencePenalty": 123
      }
    },
    "response": {
      "choices": "<array>",
      "toolResults": "<array>",
      "error": "<string>"
    },
    "outcome": {
      "status": "sent",
      "texts": 123,
      "audio": true,
      "menus": 123,
      "files": 123,
      "handoff": "<string>",
      "lead": [
        "<string>"
      ],
      "detail": "<string>"
    }
  },
  "sender_pn": "<string>",
  "sender_lid": "<string>",
  "sender_image_preview_url": "<string>",
  "response": {
    "status": "success",
    "message": "Payment request sent successfully"
  }
}

{
  "error": "Missing pixKey or pixCode"
}

{
  "error": "Invalid token"
}

{
  "error": "Failed to send payment request"
}

Authorizations

token

string

header

required

Body

application/json

Option 1
Option 2

number

string

required

ID of the chat the message will be sent to. Can be a phone number in international format, a group ID (@g.us), a user ID (with @s.whatsapp.net or @lid).

Example:

"5511999999999"

amount

number<float>

required

Charge amount (in BRL by default)

Example:

199.9

orderMessageId

string

ID of an OrderMessage received from the same contact. Links the charge to the actual order.

title

string

Title appearing in the flow header

Example:

"Order Details"

text

string

Message displayed in the flow body

Example:

"Order #123 ready for payment"

footer

string

Message footer text

Example:

"Example Store"

itemName

string

Name of the main item listed in the flow

Example:

"Gold Plan Subscription"

invoiceNumber

string

Identifier or invoice number

Example:

"PED-123"

pixKey

string

Static PIX key (CPF/CNPJ/phone/email/EVP)

Example:

"123e4567-e89b-12d3-a456-426614174000"

pixType

string

PIX key type (CPF, CNPJ, PHONE, EMAIL, EVP). Default EVP

Example:

"EVP"

pixName

string

Receiver name displayed in the flow (defaults to the instance profile name)

Example:

"Example Store"

paymentLink

string

External URL for checkout (only approved domains; see list above)

Example:

"https://pagamentos.exemplo.com/checkout/abc"

fileUrl

string

URL or path (base64) of the document to be attached (e.g., PDF boleto)

Example:

"https://cdn.exemplo.com/boleto-123.pdf"

fileName

string

Filename displayed in WhatsApp when attaching fileUrl

Example:

"boleto-123.pdf"

boletoCode

string

Boleto digitable line (automatically enables the boleto method)

Example:

"34191.79001 01043.510047 91020.150008 5 91070026000"

replyid

string

ID of the message to be replied to

mentions

string

Mentioned numbers separated by comma

delay

integer

Delay in milliseconds before sending (displays "typing..." in WhatsApp)

readchat

boolean

Marks the chat as read after sending the message

readmessages

boolean

Marks recent messages as read after sending

async

boolean

Queues the sending for asynchronous processing

track_source

string

Tracking source (e.g., chatwoot, internal-crm)

track_id

string

Tracking identifier (accepts duplicate values)

Response

Payment request sent successfully

Represents a message exchanged in the system

string<uuid>

Internal unique message ID (format r + 7 random hex characters)

messageid

string

Original message ID at the provider

chatid

string

Related conversation ID

sender

string

Message sender ID

senderName

string

Sender's display name

isGroup

boolean

default:false

Indicates whether it is a group message

fromMe

boolean

default:false

Indicates whether the message was sent by the user

messageType

string

Message content type

source

string

Message source platform

messageTimestamp

integer

default:0

Original message timestamp in milliseconds

status

string

Message lifecycle status. Common examples: Queued, Canceled, Failed, Sent, Delivered, Read. In group messages, it follows the most advanced participant: Delivered when at least one received it, Read when at least one read it, and Played when at least one listened to it.

text

string

default:""

Original message text

quoted

string

default:""

ID of the quoted/replied message

edited

string

default:""

Message edit history

reaction

string

default:""

ID of the reacted message

vote

string

default:""

Poll and list voting data

convertOptions

string

default:""

Conversion of message options, list, poll and buttons

buttonOrListid

string

default:""

ID of the selected button or list item

owner

string

default:""

Message owner

error

string

default:""

Error message if sending failed

content

Raw message content (serialized JSON or text)

wasSentByApi

boolean

Indicates whether the message was sent via API

pinned

boolean

Message pinned in the conversation (pin and unpin also arrive in messages_update, types Pinned and Unpinned)

sendFunction

string

Function used to send the message (when sent via API)

sendPayload

Payload used in the send when available. Base64 media data is omitted.

fileURL

string

Message file URL or reference

callPeer

object

Known contact associated with a call, when available in messageType: call.

Show child attributes

send_folder_id

string

Folder associated with the send (when applicable)

track_source

string

Tracking source

track_id

string

Tracking ID (may repeat)

ai_metadata

object

Record of an AI round. The full one (request to the model, response, and outcome) is stored once, on the contact's last message that the round replied to, even when nothing went out (error, discarded response). Each message sent by the AI carries only agent_id and turn (the id of that contact message).

Show child attributes

sender_pn

string | null

Sender's resolved PN JID (when available)

sender_lid

string | null

Sender's original LID (when available)

sender_image_preview_url

string<uri>

Temporary preview URL of the sender, when known. Hydration in this version fills in messages received in groups; the field may be omitted. It does not trigger a photo query to WhatsApp during listing.

response

object

Show child attributes

Instance

CRM

Proxy

Profile

Send Message

Async Message

Message Actions and Search

Groups and Communities

Newsletters and Channels

Server-Sent Events (SSE)

Blocklist

Labels

Chats

Contacts

Calls

Chatwoot Integration

Business

Quick Replies

Request payment

How it works

Common fields

Authorizations

Body

Response