// Endpoints

Payments

Read payments taken in WhatsApp, with their invoices and refunds.

Each Pay link sent from the inbox or a flow is one payment. Read them to keep your books, your shop or your CRM up to date. Each comes with its invoice or receipt and every refund. For a push the moment something is paid or refunded, subscribe to the payment.paid and payment.refunded webhook events.

GET/api/v1/payments

List payments

Scope: payments:read

Newest first, 50 per page (up to 100 with limit). Follow next_cursor for the next page. Add status to see only one kind.

StatusMeaning
pendingThe link was sent and has not been paid yet
paidPaid and confirmed with the gateway. The invoice or receipt is issued
expiredThe link ran out before anyone paid
cancelledThe link was withdrawn
amount_mismatchThe gateway took a different amount from the one asked for. No invoice was issued; check it in your gateway
curl "https://connect.vyon.uk/api/v1/payments?status=paid" \
  -H "Authorization: Bearer wacrm_live_YOUR_KEY"
GET/api/v1/payments/{id}

Read a payment

Scope: payments:read

{
  "data": {
    "id": "…",
    "status": "paid",
    "product": { "name": "Annual plan", "kind": "sale" },
    "quantity": 1,
    "currency": "INR",
    "subtotal_minor": 423644,
    "tax_minor": 76256,
    "total_minor": 499900,
    "refunded_minor": 100000,
    "buyer": { "name": "Asha Patel", "email": "asha@example.com", "phone": "+919876543210" },
    "contact_id": "…",
    "conversation_id": "…",
    "gateway": "razorpay",
    "gateway_payment_id": "pay_…",
    "invoice": { "number": "INV-2026-27/0042", "kind": "invoice", "issued_at": "…", "pdf_url": "https://…" },
    "refunds": [
      {
        "id": "…",
        "status": "processed",
        "amount_minor": 100000,
        "reason": "Part of the order cancelled",
        "processed_at": "…",
        "credit_note": { "number": "CN-2026-27/0007", "pdf_url": "https://…" }
      }
    ],
    "expires_at": "…",
    "paid_at": "…",
    "created_at": "…"
  }
}
  • Amounts are whole numbers in the currency's smallest unit: 499900 is ₹4,999.00. Payments in different currencies are never added together.
  • product.kind is sale, donation or membership. A donation has a receipt instead of an invoice (invoice.kind is donation_receipt).
  • A refund's status is requested or pending while the gateway is making it, then processed or failed. A credit note exists only once it is processed.

Links to documents

pdf_url is a signed link that does not expire. Anyone holding it can open the document, so keep it out of public pages and logs.

Scope#

Both endpoints need a key with payments:read. Refunds are made from the inbox by an admin, not through the API.