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"
}

Enviar Mensagem

Solicitar pagamento

Envia uma solicitação de pagamento com o botão nativo “Revisar e pagar” do WhatsApp. O fluxo suporta PIX (estático, dinâmico ou desabilitado), boleto, link de pagamento e cartão, combinando tudo em uma única mensagem interativa.

Como funciona

Define o valor em amount (BRL por padrão) e opcionalmente personaliza título, texto e nota adicional.
Por padrão exige pixKey.
O arquivo apontado por fileUrl é anexado como documento (boleto ou fatura em PDF, por exemplo).
paymentLink habilita o botão externo.
Para cobrar um pedido recebido pelo WhatsApp, informe orderMessageId com o ID da mensagem OrderMessage desse mesmo contato. A API obtém itens, moeda e total do pedido; amount não é necessário nesse caso. Ainda é preciso informar um método de pagamento.

Campos comuns

Este endpoint também suporta os campos padrão: delay, readchat, readmessages, replyid, mentions, track_source, track_id e 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"
}

Autorizações

token

string

header

obrigatório

Corpo

application/json

Option 1
Option 2

number

string

obrigatório

ID do chat para o qual a mensagem será enviada. Pode ser um número de telefone em formato internacional, um ID de grupo (@g.us), um ID de usuário (com @s.whatsapp.net ou @lid).

Exemplo:

"5511999999999"

amount

number<float>

obrigatório

Valor da cobrança (em BRL por padrão)

Exemplo:

199.9

orderMessageId

string

ID de uma OrderMessage recebida do mesmo contato. Vincula a cobrança ao pedido real.

title

string

Título que aparece no cabeçalho do fluxo

Exemplo:

"Detalhes do pedido"

text

string

Mensagem exibida no corpo do fluxo

Exemplo:

"Pedido #123 pronto para pagamento"

footer

string

Texto do rodapé da mensagem

Exemplo:

"Loja Exemplo"

itemName

string

Nome do item principal listado no fluxo

Exemplo:

"Assinatura Plano Ouro"

invoiceNumber

string

Identificador ou número da fatura

Exemplo:

"PED-123"

pixKey

string

Chave PIX estático (CPF/CNPJ/telefone/email/EVP)

Exemplo:

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

pixType

string

Tipo da chave PIX (CPF, CNPJ, PHONE, EMAIL, EVP). Padrão EVP

Exemplo:

"EVP"

pixName

string

Nome do recebedor exibido no fluxo (padrão usa o nome do perfil da instância)

Exemplo:

"Loja Exemplo"

paymentLink

string

URL externa para checkout (somente dominios homologados; veja lista acima)

Exemplo:

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

fileUrl

string

URL ou caminho (base64) do documento a ser anexado (ex.: boleto PDF)

Exemplo:

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

fileName

string

Nome do arquivo exibido no WhatsApp ao anexar fileUrl

Exemplo:

"boleto-123.pdf"

boletoCode

string

Linha digitável do boleto (habilita o método boleto automaticamente)

Exemplo:

"34191.79001 01043.510047 91020.150008 5 91070026000"

replyid

string

ID da mensagem que será respondida

mentions

string

Números mencionados separados por vírgula

delay

integer

Atraso em milissegundos antes do envio (exibe "digitando..." no WhatsApp)

readchat

boolean

Marca o chat como lido após enviar a mensagem

readmessages

boolean

Marca mensagens recentes como lidas após o envio

async

boolean

Enfileira o envio para processamento assíncrono

track_source

string

Origem de rastreamento (ex.: chatwoot, crm-interno)

track_id

string

Identificador de rastreamento (aceita valores duplicados)

Resposta

Solicitação de pagamento enviada com sucesso

Representa uma mensagem trocada no sistema

string<uuid>

ID único interno da mensagem (formato r + 7 caracteres hex aleatórios)

messageid

string

ID original da mensagem no provedor

chatid

string

ID da conversa relacionada

sender

string

ID do remetente da mensagem

senderName

string

Nome exibido do remetente

isGroup

boolean

padrão:false

Indica se é uma mensagem de grupo

fromMe

boolean

padrão:false

Indica se a mensagem foi enviada pelo usuário

messageType

string

Tipo de conteúdo da mensagem

source

string

Plataforma de origem da mensagem

messageTimestamp

integer

padrão:0

Timestamp original da mensagem em milissegundos

status

string

Status do ciclo de vida da mensagem. Exemplos comuns: Queued, Canceled, Failed, Sent, Delivered, Read. Em mensagem de grupo, segue o participante mais adiantado: Delivered quando pelo menos um recebeu, Read quando pelo menos um leu e Played quando pelo menos um ouviu.

text

string

padrão:""

Texto original da mensagem

quoted

string

padrão:""

ID da mensagem citada/respondida

edited

string

padrão:""

Histórico de edições da mensagem

reaction

string

padrão:""

ID da mensagem reagida

vote

string

padrão:""

Dados de votação de enquete e listas

convertOptions

string

padrão:""

Conversão de opções da mensagem, lista, enquete e botões

buttonOrListid

string

padrão:""

ID do botão ou item de lista selecionado

owner

string

padrão:""

Dono da mensagem

error

string

padrão:""

Mensagem de erro caso o envio tenha falhado

content

Conteúdo bruto da mensagem (JSON serializado ou texto)

wasSentByApi

boolean

Indica se a mensagem foi enviada via API

pinned

boolean

Mensagem fixada na conversa (fixar e desafixar chegam também em messages_update, tipos Pinned e Unpinned)

sendFunction

string

Função usada para enviar a mensagem (quando enviada via API)

sendPayload

Payload usado no envio quando disponível. Dados de mídia em base64 são omitidos.

fileURL

string

URL ou referência de arquivo da mensagem

callPeer

object

Contato conhecido associado a uma ligação, quando disponível em messageType: call.

Show child attributes

send_folder_id

string

Pasta associada ao envio (quando aplicável)

track_source

string

Origem de rastreamento

track_id

string

ID de rastreamento (pode repetir)

ai_metadata

object

Registro de uma rodada da IA. O completo (pedido ao modelo, resposta e outcome) fica uma vez, na última mensagem do contato que a rodada respondeu, também quando nada saiu (erro, resposta descartada). Cada mensagem enviada pela IA leva só agent_id e turn (o id dessa mensagem do contato).

Show child attributes

sender_pn

string | null

JID PN resolvido do remetente (quando disponível)

sender_lid

string | null

LID original do remetente (quando disponível)

sender_image_preview_url

string<uri>

URL temporária de preview do remetente, quando conhecida. A hidratação desta versão preenche mensagens recebidas em grupos; o campo pode ser omitido. Não provoca consulta de foto ao WhatsApp na listagem.

response

object

Show child attributes

Instancia

CRM

Proxy

Perfil

Enviar Mensagem

Mensagem Async

Ações na mensagem e Buscar

Grupos e Comunidades

Newsletters e Canais

Server-Sent Events (SSE)

Bloqueios

Etiquetas

Chats

Contatos

Chamadas

Integração Chatwoot

Business

Respostas Rápidas

Solicitar pagamento

Como funciona

Campos comuns

Autorizações

Corpo

Resposta