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": "Solicitud de pago enviada con éxito"
  }
}

{
  "error": "Falta pixKey o pixCode"
}

{
  "error": "Token inválido"
}

{
  "error": "Error al enviar la solicitud de pago"
}

Enviar Mensaje

Solicitar pago

Envía una solicitud de pago con el botón nativo “Revisar y pagar” de WhatsApp. El flujo admite PIX (estático, dinámico o deshabilitado), boleto, enlace de pago y tarjeta, combinando todo en un único mensaje interactivo.

Cómo funciona

Define el valor en amount (BRL por defecto) y, opcionalmente, personaliza el título, el texto y la nota adicional.
Por defecto, exige pixKey.
El archivo indicado en fileUrl se adjunta como documento (boleto o factura en PDF, por ejemplo).
paymentLink habilita el botón externo.
Para cobrar un pedido recibido por WhatsApp, indique orderMessageId con el ID del mensaje OrderMessage de ese mismo contacto. La API obtiene los artículos, la moneda y el total del pedido; amount no es necesario en ese caso. Aun así, es necesario indicar un método de pago.

Campos comunes

Este endpoint también admite los campos estándar: delay, readchat, readmessages, replyid, mentions, track_source, track_id y 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": "Solicitud de pago enviada con éxito"
  }
}

{
  "error": "Falta pixKey o pixCode"
}

{
  "error": "Token inválido"
}

{
  "error": "Error al enviar la solicitud de pago"
}

Autorizaciones

token

string

header

requerido

Cuerpo

application/json

Option 1
Option 2

number

string

requerido

ID del chat al que se enviará el mensaje. Puede ser un número de teléfono en formato internacional, un ID de grupo (@g.us), un ID de usuario (con @s.whatsapp.net o @lid).

Ejemplo:

"5511999999999"

amount

number<float>

requerido

Monto del cobro (en BRL por defecto)

Ejemplo:

199.9

orderMessageId

string

ID de un OrderMessage recibido del mismo contacto. Vincula el cobro al pedido real.

title

string

Título que aparece en el encabezado del flujo

Ejemplo:

"Detalles del pedido"

text

string

Mensaje mostrado en el cuerpo del flujo

Ejemplo:

"Pedido #123 listo para pago"

footer

string

Texto del pie de página del mensaje

Ejemplo:

"Tienda Ejemplo"

itemName

string

Nombre del elemento principal listado en el flujo

Ejemplo:

"Suscripción Plan Oro"

invoiceNumber

string

Identificador o número de la factura

Ejemplo:

"PED-123"

pixKey

string

Clave PIX estática (CPF/CNPJ/teléfono/email/EVP)

Ejemplo:

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

pixType

string

Tipo de la clave PIX (CPF, CNPJ, PHONE, EMAIL, EVP). Predeterminado EVP

Ejemplo:

"EVP"

pixName

string

Nombre del receptor mostrado en el flujo (por defecto usa el nombre del perfil de la instancia)

Ejemplo:

"Tienda Ejemplo"

paymentLink

string

URL externa para checkout (solo dominios homologados; vea la lista anterior)

Ejemplo:

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

fileUrl

string

URL o ruta (base64) del documento que se adjuntará (ej.: boleto PDF)

Ejemplo:

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

fileName

string

Nombre del archivo que se muestra en WhatsApp al adjuntar fileUrl

Ejemplo:

"boleto-123.pdf"

boletoCode

string

Línea digitable del boleto (habilita automáticamente el método boleto)

Ejemplo:

"34191.79001 01043.510047 91020.150008 5 91070026000"

replyid

string

ID del mensaje que será respondido

mentions

string

Números mencionados separados por coma

delay

integer

Retraso en milisegundos antes del envío (muestra "escribiendo..." en WhatsApp)

readchat

boolean

Marca el chat como leído después de enviar el mensaje

readmessages

boolean

Marca los mensajes recientes como leídos después del envío

async

boolean

Encola el envío para procesamiento asíncrono

track_source

string

Origen de rastreo (ej.: chatwoot, crm-interno)

track_id

string

Identificador de seguimiento (acepta valores duplicados)

Respuesta

Solicitud de pago enviada con éxito

Representa un mensaje intercambiado en el sistema

string<uuid>

ID único interno del mensaje (formato r + 7 caracteres hex aleatorios)

messageid

string

ID original del mensaje en el proveedor

chatid

string

ID de la conversación relacionada

sender

string

ID del remitente del mensaje

senderName

string

Nombre visible del remitente

isGroup

boolean

predeterminado:false

Indica si es un mensaje de grupo

fromMe

boolean

predeterminado:false

Indica si el mensaje fue enviado por el usuario

messageType

string

Tipo de contenido del mensaje

source

string

Plataforma de origen del mensaje

messageTimestamp

integer

predeterminado:0

Timestamp original del mensaje en milisegundos

status

string

Estado del ciclo de vida del mensaje. Ejemplos comunes: Queued, Canceled, Failed, Sent, Delivered, Read. En mensajes de grupo, sigue al participante más avanzado: Delivered cuando al menos uno lo recibió, Read cuando al menos uno lo leyó y Played cuando al menos uno lo escuchó.

text

string

predeterminado:""

Texto original del mensaje

quoted

string

predeterminado:""

ID del mensaje citado/respondido

edited

string

predeterminado:""

Historial de ediciones del mensaje

reaction

string

predeterminado:""

ID del mensaje al que se reaccionó

vote

string

predeterminado:""

Datos de votación de encuestas y listas

convertOptions

string

predeterminado:""

Conversión de opciones del mensaje, lista, encuesta y botones

buttonOrListid

string

predeterminado:""

ID del botón o elemento de lista seleccionado

owner

string

predeterminado:""

Propietario del mensaje

error

string

predeterminado:""

Mensaje de error en caso de que el envío haya fallado

content

Contenido bruto del mensaje (JSON serializado o texto)

wasSentByApi

boolean

Indica si el mensaje fue enviado vía API

pinned

boolean

Mensaje fijado en la conversación (fijar y desfijar también llegan en messages_update, tipos Pinned y Unpinned)

sendFunction

string

Función usada para enviar el mensaje (cuando se envía vía API)

sendPayload

Payload utilizado en el envío cuando está disponible. Los datos de medios en base64 se omiten.

fileURL

string

URL o referencia de archivo del mensaje

callPeer

object

Contacto conocido asociado a una llamada, cuando está disponible en messageType: call.

Show child attributes

send_folder_id

string

Carpeta asociada al envío (cuando corresponda)

track_source

string

Origen de rastreo

track_id

string

ID de seguimiento (puede repetirse)

ai_metadata

object

Registro de una ronda de la IA. El completo (solicitud al modelo, respuesta y outcome) queda una sola vez, en el último mensaje del contacto al que respondió la ronda, incluso cuando no salió nada (error, respuesta descartada). Cada mensaje enviado por la IA lleva solo agent_id y turn (el id de ese mensaje del contacto).

Show child attributes

sender_pn

string | null

JID PN resuelto del remitente (cuando esté disponible)

sender_lid

string | null

LID original del remitente (cuando esté disponible)

sender_image_preview_url

string<uri>

URL temporal de vista previa del remitente, cuando se conoce. La hidratación de esta versión completa los mensajes recibidos en grupos; el campo puede omitirse. No provoca consulta de foto a WhatsApp en el listado.

response

object

Show child attributes

Instancia

CRM

Proxy

Perfil

Enviar Mensaje

Mensaje Async

Acciones en el mensaje y Búsqueda

Grupos y Comunidades

Newsletters y Canales

Server-Sent Events (SSE)

Bloqueos

Etiquetas

Chats

Contactos

Llamadas

Integración con Chatwoot

Business

Respuestas Rápidas

Solicitar pago

Cómo funciona

Campos comunes

Autorizaciones

Cuerpo

Respuesta