Skip to main content
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",
  "amount": 199.9,
  "text": "Order #123 ready for payment",
  "pixKey": "123e4567-e89b-12d3-a456-426614174000",
  "pixType": "EVP"
}
'
{
  "id": "3c90c3cc-0d44-4b50-8888-8dd25736052a",
  "messageid": "<string>",
  "chatid": "<string>",
  "fromMe": false,
  "isGroup": false,
  "messageType": "text",
  "messageTimestamp": 0,
  "edited": "",
  "quoted": "",
  "reaction": "",
  "sender": "",
  "senderName": "",
  "source": "",
  "status": "",
  "text": "",
  "vote": "",
  "buttonOrListid": "",
  "convertOptions": "",
  "fileURL": "",
  "content": "<string>",
  "owner": "",
  "track_source": "",
  "track_id": "",
  "created": "(strftime('%Y-%m-%d %H:%M:%f', 'now'))",
  "updated": "(strftime('%Y-%m-%d %H:%M:%f', 'now'))",
  "ai_metadata": {
    "agent_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>"
    }
  },
  "response": {
    "status": "success",
    "message": "Payment request sent successfully"
  }
}

Authorizations

​
token
string
header
required

Body

application/json
​
number
string
required

Recipient number (Area code + number, international format)

Example:

"5511999999999"

​
amount
number<float>
required

Charge amount (in BRL by default)

Example:

199.9

​
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:

"ORD-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.example.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

Representa uma mensagem trocada no sistema

​
id
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

​
fromMe
boolean
default:false

Indica se a mensagem foi enviada pelo usuário

​
isGroup
boolean
default:false

Indica se é uma mensagem de grupo

​
messageType
enum<string>

Tipo de conteúdo da mensagem

Available options:
text,
image,
video,
document,
audio,
location,
button,
list,
reaction
​
messageTimestamp
integer
default:0

Timestamp original da mensagem em milissegundos

​
edited
string
default:""

Histórico de edições da mensagem

​
quoted
string
default:""

ID da mensagem citada/respondida

​
reaction
string
default:""

ID da mensagem reagida

​
sender
string
default:""

ID do remetente da mensagem

​
senderName
string
default:""

Nome exibido do remetente

​
source
enum<string>
default:""

Plataforma de origem da mensagem

Available options:
ios,
web,
android
​
status
enum<string>
default:""

Status do ciclo de vida da mensagem

Available options:
pending,
sent,
delivered,
read,
failed,
deleted
​
text
string
default:""

Texto original da mensagem

​
vote
string
default:""

Dados de votação de enquete e listas

​
buttonOrListid
string
default:""

ID do botão ou item de lista selecionado

​
convertOptions
string
default:""

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

​
fileURL
string<uri>
default:""

URL para download de arquivos de mídia

​
content
string

Conteúdo completo da mensagem em formato JSON

​
owner
string
default:""

Dono da mensagem

​
track_source
string
default:""

Origem do rastreamento da mensagem

​
track_id
string
default:""

ID para rastreamento da mensagem (aceita valores duplicados)

​
created
string<date-time>
default:(strftime('%Y-%m-%d %H:%M:%f', 'now'))

Data de criação no sistema (formato SQLite YYYY-MM-DD HH:MM:SS.FFF)

​
updated
string<date-time>
default:(strftime('%Y-%m-%d %H:%M:%f', 'now'))

Data da última atualização (formato SQLite YYYY-MM-DD HH:MM:SS.FFF)

​
ai_metadata
object

Metadados do processamento por IA

​
response
object