Handle payment_link.expired Events

Use the payment_link.expired webhook to identify payment links that have reached their expiration time.

Amwal sends this event when a payment link reaches its configured expiry_date. Use it to update the related order or payment-link record in your system.

Process the event

1. Read the payment link id and order_id from the payload.
2. Find the related order or payment-link record in your system.
3. Update the record to show that the payment link has expired.
4. Return HTTP 200 after your system accepts the event.

Example payload

The following example uses dummy data. Do not include real customer details, merchant IDs, or callback URLs in documentation.

{
  "id": "11111111-2222-4333-8444-555555555555",
  "event": "payment_link.expired",
  "title": null,
  "amount": "389.00000",
  "status": "Expired",
  "order_id": "ORDER-1001",
  "single_use": true,
  "description": null,
  "expiry_date": "2026-03-30T13:21:36.274000+00:00",
  "merchant_id": "aaaaaaaa-bbbb-4ccc-8ddd-eeeeeeeeeeee",
  "callback_url": "https://store.example.com/payment/callback",
  "client_email": "[email protected]",
  "client_last_name": "Customer",
  "environment_type": "SANDBOX",
  "client_first_name": "Example",
  "client_phone_number": "+966500000000"
}