NODAPI

Enviar Mensagem

Solicitar pagamento

POST/send/request-payment
  • Conta no limite de envio da conexão. Ao passar do limite, a resposta é 429.

Autenticação: envie a chave da conexão no header token ou em Authorization: Bearer.

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.

Campos comuns

Este endpoint também suporta os campos padrão: delay, readchat, readmessages, replyid, mentions, track_source, track_id e async.

Corpo da requisição (JSON)

CampoTipoDescrição
number*string

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

titlestring

Título que aparece no cabeçalho do fluxo

Exemplo: Detalhes do pedido

textstring

Mensagem exibida no corpo do fluxo

Exemplo: Pedido #123 pronto para pagamento

footerstring

Texto do rodapé da mensagem

Exemplo: Loja Exemplo

itemNamestring

Nome do item principal listado no fluxo

Exemplo: Assinatura Plano Ouro

invoiceNumberstring

Identificador ou número da fatura

Exemplo: PED-123

amount*number

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

Exemplo: 199.9

pixKeystring

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

Exemplo: 123e4567-e89b-12d3-a456-426614174000

pixTypestring

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

Exemplo: EVP

pixNamestring

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

Exemplo: Loja Exemplo

paymentLinkstring

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

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

fileUrlstring

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

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

fileNamestring

Nome do arquivo exibido no WhatsApp ao anexar fileUrl

Exemplo: boleto-123.pdf

boletoCodestring

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

Exemplo: 34191.79001 01043.510047 91020.150008 5 91070026000

replyidstring

ID da mensagem que será respondida

mentionsstring

Números mencionados separados por vírgula

delayinteger

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

readchatboolean

Marca o chat como lido após enviar a mensagem

readmessagesboolean

Marca mensagens recentes como lidas após o envio

asyncboolean

Enfileira o envio para processamento assíncrono

track_sourcestring

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

track_idstring

Identificador de rastreamento (aceita valores duplicados)

* obrigatório

Exemplos de corpo

PIX simples

{
  "number": "5511999999999",
  "amount": 199.9,
  "text": "Pedido #123 pronto para pagamento",
  "pixKey": "123e4567-e89b-12d3-a456-426614174000",
  "pixType": "EVP"
}

PIX + boleto

{
  "number": "5511999999999",
  "amount": 349.5,
  "text": "Pedido #457 com boleto",
  "pixKey": "12345678000190",
  "pixType": "CNPJ",
  "pixName": "Loja Exemplo LTDA",
  "boletoCode": "34191.79001 01043.510047 91020.150008 5 91070026000",
  "additionalNote": "Pague via PIX ou utilize o boleto em anexo"
}

PIX + boleto + link

{
  "number": "5511888888888",
  "title": "Assinatura Premium",
  "text": "Plano anual disponível para pagamento",
  "footer": "footer",
  "invoiceNumber": "INV-789",
  "itemName": "Bolo XYZ",
  "amount": 599,
  "pixKey": "123e4567-e89b-12d3-a456-426614174000",
  "pixType": "EVP",
  "pixName": "Empresa Exemplo",
  "boletoCode": "23793.38128 60000.000123 45670.000012 3 45670000012345",
  "fileUrl": "https://cdn.exemplo.com/boleto-inv-789.pdf",
  "fileName": "Clique para abrir o PDF.pdf",
  "paymentLink": "https://payment-link.pagar.me/checkout/inv-789"
}

Respostas

  • 200Solicitação de pagamento enviada com sucesso
  • 400Requisição inválida
  • 401Não autorizado
  • 500Erro interno do servidor

Experimente

Atenção: a chamada é real. Ela roda na sua conexão e pode enviar mensagem de verdade. A chave fica só nesta tela e some ao sair dela; nunca é guardada.

Cole a chave gerada no painel.