payment.success: Payment Confirmed Event Schema

Event Data

string

required

Always payment.success.

string

required

The payment reference from your system.

string

required

The unique VTPE payment identifier.

number

required

The confirmed payment amount.

string

required

The currency code.

string

required

The payment confirmation timestamp in ISO 8601 format.

string

required

The payment channel. One of: AGENCY, DELIVERY, MARKETPLACE.

Value	Description
AGENCY	Payment completed through an agency partner channel.
DELIVERY	Payment completed through a delivery partner channel.
MARKETPLACE	Payment completed through the marketplace channel.

Value

Description

AGENCY

Payment completed through an agency partner channel.

DELIVERY

Payment completed through a delivery partner channel.

MARKETPLACE

Payment completed through the marketplace channel.

{ "event": "payment.success", "data": { "reference": "ORD-2024-001", "paymentId": "pay_abc123xyz", "amount": 5000.00, "currency": "DZD", "paidAt": "2024-01-15T10:30:00Z", "channel": "AGENCY" } }

Handling This Event

if (event === "payment.success") {
  // Check idempotency
  const alreadyProcessed = await db.getPaymentByPaymentId(data.paymentId);
  if (alreadyProcessed) {
    return res.status(200).json({ success: true }); // already handled
  }

  await db.fulfillOrder({
    reference: data.reference,
    paymentId: data.paymentId,
    paidAt: data.paidAt,
    channel: data.channel
  });
}

if event == "payment.success":
    # Check idempotency
    if db.get_payment_by_payment_id(data["paymentId"]):
        return jsonify({"success": True}), 200  # already handled

    db.fulfill_order(
        reference=data["reference"],
        payment_id=data["paymentId"],
        paid_at=data["paidAt"],
        channel=data["channel"]
    )

Always check idempotency using paymentId before fulfilling an order. VTPE may retry delivery, and duplicate fulfillment can lead to inconsistent state.

Overview

Payments

Webhooks

Static QR Codes

payment.success: Payment Confirmed Event Schema

Event Data

Channel Values

Payload Example

Handling This Event

​Event Data

​Channel Values

​Payload Example

​Handling This Event

Event Data

Channel Values

Payload Example

Handling This Event