💬 Shared Inbox do WhatsApp na nova PlataformaMais
1msg official logo

WhatsApp Business API para notificação de pagamento offline

O cenário envia um modelo personalizado de WhatsApp para o cliente quando um pagamento offline é registrado.

Visão geral do caso de uso

O cenário envia ao cliente um modelo de WhatsApp personalizado quando um pagamento offline é registrado. A mensagem inclui o nome do cliente, o valor do pagamento e a data do pagamento. Um botão de URL estático abre a página de recibo ou histórico de pagamentos.

Exemplo de modelo

Olá, {{1}}! Registramos seu pagamento offline de {{2}} em {{3}}. Obrigado.

Ver recibo
  • {{1}}
    nome do cliente
  • {{2}}
    valor do pagamento
  • {{3}}
    data de pagamento
  • “Ver recibo”
    botão — fixo no modelo Meta
WhatsApp Business API for offline payment notification

Quando usá-lo

Acesse este cenário quando a equipe ou o faturamento registrar um pagamento em dinheiro, transferência ou em pessoa e o cliente precisar de prova imediatamente, mas não tiver um chat aberto no WhatsApp — apenas um modelo aprovado pode ser enviado primeiro. Isso se aplica a equipes de varejo e de campo registrando pagamentos no balcão, equipes de finanças correspondendo transferências bancárias a contas, e integradores conectando eventos de postagem de pagamento de ERP ou POS a confirmações de cliente.

Menos ligações de "você recebeu meu pagamento?"
O nome do cliente, o valor e a data do pagamento chegam como três variáveis do corpo no momento em que a cobrança registra o pagamento offline, assim o cliente vê a prova de postagem sem precisar chamar o suporte ou verificar o e-mail.
Prova em um canal que eles já usam
A confirmação chega pelo WhatsApp, onde o cliente já está conversando, então os detalhes do pagamento ficam pesquisáveis na conversa em vez de enterrados em um e-mail de recibo.
Recibo sem um ticket de suporte
Um botão de URL estático fixo no modelo Meta abre a página de recibo ou histórico de pagamentos, permitindo que o cliente acesse a documentação sem precisar pedir aos funcionários para reenviarem.
Sem trabalho de confirmação manual
A cobrança ou o back-office ativa o template ao registrar o pagamento, e o status de entrega é registrado para acompanhamento.

Fluxo de Trabalho

  1. Gatilho

    A equipe ou os registros de faturamento registram um pagamento offline e disparam um evento de confirmação.

    event · triggered

  2. Evento de captura

    O sistema resolve o número de telefone do cliente e os campos de pagamento.

    phone: "+…"

  3. Construa e envie

    Uma mensagem de modelo personalizada é construída com três variáveis de corpo e um botão de URL estático.

    POST /sendTemplate

  4. Entregue

    O cliente recebe a notificação do WhatsApp e pode abrir o recibo através do botão.

    delivered

  5. Status monitorado

    O resultado da entrega é registrado para cobrança ou acompanhamento de CRM.

    status: "read"

WhatsApp Business API for offline payment notification

Implementação técnica

Requisitos

  1. Chave da API 1MSG · Como obter a Chave da API
  2. Conta do WhatsApp Business · Como Conectar WABA
  3. Modelo do WhatsApp · Como Aprovar o Modelo WABA
  4. Opcão do Cliente · Como Gerenciar o Consentimento

Exemplos de código

#!/usr/bin/env bash
set -euo pipefail

# === Configuration (replace "___" placeholders) ===

API_BASE_URL="https://api.1msg.io"        # production 1MSG API base URL
CHANNEL_ID="___"                           # channel ID from 1MSG dashboard
API_TOKEN="___"                            # channel JWT token (Bearer)

TEMPLATE_NAME="___"                        # approved template name
TEMPLATE_NAMESPACE="___"                   # template namespace (required — send fails without it)
TEMPLATE_LANGUAGE="___"                    # template language code, e.g. "en"



# === Test data ===
TEST_PHONE="___"                 # client phone in international format
TEST_CUSTOMERNAME="___"         # {{1}} customer name
TEST_PAYMENTAMOUNT="___"         # {{2}} payment amount
TEST_DATE="___"         # {{3}} date or time

PHONE_NORM="$(printf '%s' "$TEST_PHONE" | tr -cd '0-9')"

for pair in "CHANNEL_ID=$CHANNEL_ID" "API_TOKEN=$API_TOKEN" \
            "TEMPLATE_NAME=$TEMPLATE_NAME" "TEMPLATE_NAMESPACE=$TEMPLATE_NAMESPACE" \
            "TEMPLATE_LANGUAGE=$TEMPLATE_LANGUAGE" "TEST_PHONE=$TEST_PHONE" \
            "TEST_CUSTOMERNAME=$TEST_CUSTOMERNAME" \
            "TEST_PAYMENTAMOUNT=$TEST_PAYMENTAMOUNT" \
            "TEST_DATE=$TEST_DATE"; do
    val="${pair#*=}"
    if [ -z "$val" ] || [ "$val" = "___" ]; then
        echo "Missing configuration value: ${pair%%=*}" >&2
        exit 1
    fi
done

if [ -z "$PHONE_NORM" ]; then
    echo "Error: phone number has no digits after normalization" >&2
    exit 1
fi

URL="${API_BASE_URL%/}/${CHANNEL_ID}/sendTemplate"

# params carries body ONLY. Button text is fixed in the Meta template — no button param.

# {{1}} customer name → ${TEST_CUSTOMERNAME}
# {{2}} payment amount → ${TEST_PAYMENTAMOUNT}
# {{3}} date or time → ${TEST_DATE}
read -r -d '' PAYLOAD <<JSON || true
{
  "phone": "${PHONE_NORM}",
  "template": "${TEMPLATE_NAME}",
  "namespace": "${TEMPLATE_NAMESPACE}",
  "language": { "policy": "deterministic", "code": "${TEMPLATE_LANGUAGE}" },
  "params": [
    {
      "type": "body",
      "parameters": [
        { "type": "text", "text": "${TEST_CUSTOMERNAME}" },
        { "type": "text", "text": "${TEST_PAYMENTAMOUNT}" },
        { "type": "text", "text": "${TEST_DATE}" }
      ]
    }

  ]
}
JSON

RESPONSE="$(curl -s -w '\n%{http_code}' -X POST "$URL" \
    -H "Content-Type: application/json" \
    -H "Authorization: Bearer ${API_TOKEN}" \
    -d "$PAYLOAD")"

HTTP_CODE="$(printf '%s' "$RESPONSE" | tail -n1)"
BODY="$(printf '%s' "$RESPONSE" | sed '$d')"

case "$BODY" in
    *'"sent":true'*) ok=1 ;;
    *) ok=0 ;;
esac

if [ "$HTTP_CODE" -ge 200 ] && [ "$HTTP_CODE" -lt 300 ] && [ "$ok" -eq 1 ]; then
    echo "Message sent to client."
    echo "API response: $BODY"
else
    echo "Send failed. HTTP status: $HTTP_CODE" >&2
    echo "$BODY" >&2
    exit 1
fi

Status de resposta e entrega

HTTP 2xx e JSON "sent": true significam que 1MSG aceitou a mensagem para envio — não que ela já tenha chegado ao telefone do cliente. Salve o campo id (parecido com wamid.…) para correlacionar os callbacks de entrega.

200 Claro!Resposta
{
  "sent": true,
  "id": "wamid.HBgLMzgwNjM5...",
  "message": "Message accepted for delivery"
}
  • sent

    Aceito para envio — não ainda no telefone do cliente

  • id

    Armazene isso; os retornos de chamada de entrega e hookInfo estão baseados nisso

A entrega em si chega mais tarde, como um callback separado. Registre um webhook (POST …/webhook) e 1MSG envia atualizações de status para seu endpoint HTTPS em um payload de nível superior hooks[].

200 OKWebhook de status de entrega — payload recebido
{
  "hooks": [
    {
      "id": "gBGGeSaGViBfAgnlzOSHEwK9O6F",
      "type": "message",
      "status": "sent",
      "timestamp": "1654864094",
      "recipient_id": "556123122026"
    }
  ]
}
  • status

    enviado, entregue, lido — ou um status de falha quando aplicável

  • id

    Correlaciona o callback com o id retornado pela chamada de envio

  • timestamp

    Segundos Unix, como uma string

Se você preferir não receber chamadas, consulte GET {base}/{channel}/hookInfo?messageId=<id> em vez disso. Na prática, a entrega muitas vezes é concluída em segundos — mas o contrato da API não garante isso, portanto nunca bloqueie um fluxo esperando por isso.

Erros comuns

StatusRespostaCausa
200Message was not sent: template is not definednamespace, template or language missing from the request body.
200template name (…) does not exist in <language>The template is approved in a different language than the one requested.
200Message was not sent: provide chatId, phone, bsuid, or usernameNo recipient the channel could resolve.
403access deniedThe token is wrong, or belongs to a different channel than the URL.
429too many requests. please try laterThe channel is over its send rate.

Perguntas Frequentes

Sim — mensagens de WhatsApp de início a frio requerem um modelo aprovado pela Meta.

Relacionado

Crie para o WhatsApp em horas
sem complicações de infraestrutura