WhatsApp Business API for new payment notification

Use case overview

The scenario sends the finance manager a personalised WhatsApp template when a new payment is received. The message includes the customer name, payment amount, and payment date. A static URL button opens the billing dashboard.

Template example

💳 New payment received

Customer: {{1}}

Amount: {{2}}

Date: {{3}}

Review the payment in the billing dashboard.

[Open billing]

The billing dashboard URL button is fixed in the Meta template — only body variables are sent via the API.

Variables and purpose

• {{1}} — customer name
• {{2}} — payment amount
• {{3}} — payment date

Filled-in example

💳 New payment received

Customer: Alex Smith

Amount: 1,250.00 USD

Date: June 29, 2026

Review the payment in the billing dashboard.

[Open billing]

When to use it

• finance teams
• billing ops
• integrators

Business value

• Billing or payment gateway posts a new payment event
• System resolves the finance manager phone and payment summary fields
• Internal notification template is built with customer name, amount, and date
• WhatsApp message is delivered to the finance manager
• Manager opens the billing dashboard via the static URL button to review the payment

Workflow

1. Billing or the payment gateway emits a new-payment event.
2. The system resolves the finance manager phone number and payment summary fields.
3. An internal notification template is built with three body variables and a static URL button.
4. The manager receives the WhatsApp alert on their phone.
5. Delivery result is logged; the manager opens the billing dashboard via the button.
6. Delivery progress is reported asynchronously — typically sent, then delivered (or failed/undelivered).
7. Your system receives status via webhook (hooks[]) or polls GET …/hookInfo?messageId=<id> and handles failures if needed.

Technical implementation

Prerequisites

• A 1MSG account with WhatsApp Business API connected and an approved message template.
• Manager phone number in international format (without + and spaces) — MANAGER_PHONE in generated code.
• Payment payload: customer name, amount, date; billing dashboard URL fixed in the Meta template button.

Code examples

#!/usr/bin/env node

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

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

const TEMPLATE_NAME = "___";                // approved template name
const TEMPLATE_NAMESPACE = "___";           // template namespace (422 without it)
const TEMPLATE_LANGUAGE = "___";            // template language code, e.g. "en"



// === Test data ===
const MANAGER_PHONE = "___";            // manager phone in international format
const TEST_CUSTOMERNAME = "___";    // {{1}} customer name
const TEST_PAYMENTAMOUNT = "___";    // {{2}} payment amount
const TEST_DATE = "___";    // {{3}} date or time

function normalizePhone(phone) {
  return String(phone).replace(/\D/g, "");
}

function assertConfigured(values) {
  for (const [key, value] of Object.entries(values)) {
    if (value === "___" || value === "" || value === undefined || value === null) {
      throw new Error(`Missing configuration value: ${key}`);
    }
  }
}

async function sendTemplateMessage({ phone, customerName, paymentAmount, date }) {
  assertConfigured({
    CHANNEL_ID,
    API_TOKEN,
    TEMPLATE_NAME,
    TEMPLATE_NAMESPACE,
    TEMPLATE_LANGUAGE,
    phone,
    customerName,
    paymentAmount,
    date,
  });

  const url = `${API_BASE_URL}/${CHANNEL_ID}/sendTemplate`;

  // params carries body ONLY. Button text is fixed in the Meta template — no button param.
  const requestBody = {
    phone: normalizePhone(phone),
    template: TEMPLATE_NAME,
    namespace: TEMPLATE_NAMESPACE,
    language: {
      policy: "deterministic",
      code: TEMPLATE_LANGUAGE,
    },
    params: [
      {
        type: "body",
        parameters: [
          { type: "text", text: String(customerName) }, // {{1}} customer name
          { type: "text", text: String(paymentAmount) }, // {{2}} payment amount
          { type: "text", text: String(date) }, // {{3}} date or time
        ],
      },
    ],
  };

  const res = await fetch(url, {
    method: "POST",
    headers: {
      "Content-Type": "application/json",
      Authorization: `Bearer ${API_TOKEN}`,
    },
    body: JSON.stringify(requestBody),
  });

  const raw = await res.text();
  let data;
  try {
    data = JSON.parse(raw);
  } catch {
    data = null;
  }

  if (!res.ok || !data || data.sent !== true) {
    console.error("Send failed. API response:");
    console.error(raw);
    process.exit(1);
  }

  console.log("Message sent to manager.");
  console.log("API response:", raw);
  return data;
}

if (require.main === module) {
  sendTemplateMessage({
    phone: MANAGER_PHONE,
    customerName: TEST_CUSTOMERNAME,
    paymentAmount: TEST_PAYMENTAMOUNT,
    date: TEST_DATE,
  }).catch((err) => {
    console.error("Execution failed:", err.message);
    process.exit(1);
  });
}

module.exports = { sendTemplateMessage };

Immediate API response (synchronous)

• HTTP 2xx and JSON "sent": true mean 1MSG accepted the message for sending — not that it already reached the customer's phone.
• Save the `id` field from the response (value looks like wamid.…). Use it to correlate delivery callbacks or polling.
• The response may also include message and description — informational only.

Delivery status (asynchronous)

• Register a webhook (POST …/webhook) so 1MSG POSTs delivery updates to your HTTPS endpoint in a separate `hooks[]` payload (sent, delivered, read, or failed/undelivered when applicable).
• Optionally poll: GET {base}/{channel}/hookInfo?messageId=<id from sendTemplate>.
• In practice, delivery often completes within a few seconds — but that is not guaranteed by the API contract.

Common errors

• Invalid or non-normalized phone number
• Unapproved or missing template name / namespace
• No customer opt-in for WhatsApp business messages
• Template variable count mismatch (422 from API)
• Delivery failure — check status webhook and retry policy

FAQ

• Do I need an approved template? Yes — cold-start WhatsApp messages require a Meta-approved template.
• Can I customize the message text? Body variables are dynamic; fixed text and button labels are set in the Meta template.
• How do I check delivery? sent: true only confirms acceptance. Track delivery via webhook hooks[] or GET …/hookInfo?messageId=<id>.
• What if the message is not delivered? Log the failed/undelivered hook, verify opt-in and template status, then retry or fall back to another channel.
• Can I connect this to my CRM or backend? Yes — trigger the API call from your platform webhook or event handler.

Related

• Knowledge base
• Creating a template
• Sending a template
• SDK