Pular para o conteúdo principal
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": "Pedido #123 pronto para pagamento",
  "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

Número do destinatário (DDD + número, formato internacional)

Example:

"5511999999999"

​
amount
number<float>
required

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

Example:

199.9

​
title
string

Título que aparece no cabeçalho do fluxo

Example:

"Detalhes do pedido"

​
text
string

Mensagem exibida no corpo do fluxo

Example:

"Pedido #123 pronto para pagamento"

​
footer
string

Texto do rodapé da mensagem

Example:

"Loja Exemplo"

​
itemName
string

Nome do item principal listado no fluxo

Example:

"Assinatura Plano Ouro"

​
invoiceNumber
string

Identificador ou número da fatura

Example:

"PED-123"

​
pixKey
string

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

Example:

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

​
pixType
string

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

Example:

"EVP"

​
pixName
string

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

Example:

"Loja Exemplo"

​
paymentLink
string

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

Example:

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

​
fileUrl
string

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

Example:

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

​
fileName
string

Nome do arquivo exibido no WhatsApp ao anexar fileUrl

Example:

"boleto-123.pdf"

​
boletoCode
string

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

Example:

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

Response

Solicitação de pagamento enviada com sucesso

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

Opções disponíveis:
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

Opções disponíveis:
ios,
web,
android
​
status
enum<string>
default:""

Status do ciclo de vida da mensagem

Opções disponíveis:
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