payment.fail: Payment Failed or Cancelled Event

The payment.fail event is sent when a payment fails or is cancelled. Use this event to update the order status in your system and release any held resources.

Event Data

string

required

Always payment.fail.

string

required

The payment reference from your system.

string

required

The unique VTPE payment identifier.

Payload Example

{
  "event": "payment.fail",
  "data": {
    "reference": "ORD-2024-001",
    "paymentId": "pay_abc123xyz"
  }
}

Handling This Event

if (event === "payment.fail") {
  await db.cancelOrder({
    reference: data.reference,
    paymentId: data.paymentId
  });
  // Optionally notify the customer
}

if event == "payment.fail":
    db.cancel_order(
        reference=data["reference"],
        payment_id=data["paymentId"]
    )
    # Optionally notify the customer

Use the reference field to look up the associated order in your database and release any reservations or inventory holds tied to that order.

⌘I

Overview

Payments

Webhooks

Static QR Codes

payment.fail: Payment Failed or Cancelled Event

Event Data

Payload Example

Handling This Event

​Event Data

​Payload Example

​Handling This Event

Event Data

Payload Example

Handling This Event