Scheduled Payment Status Updated

scheduled_payment.status.updated

This webhook triggers when a Scheduled Payment has changed state. This includes successful and failed scheduled payment events.

Event Message

The table below describes the structure of the event.

FieldDescriptionValues
eventThe state change recordedpayment.success, payment_failed
payment_idThe payment identifier for this event
serviceThe service for the payment type this is related todomestic-scheduled-payment
user_idThe user identifier this event relates to

Examples

{
  "data": {
    "event": "payment.success",
    "payment_id": "89f80199-1199-400e-9092-17208f6f39f5",
    "service": "domestic-scheduled-payment",
    "user_id": "22f80199-1199-400e-9092-17208f6f39f0",
  }
}
{
  "data": {
    "event": "payment.failed",
    "payment_id": "89f80199-1199-400e-9092-17208f6f39f5",
    "service": "domestic-scheduled-payment",
    "user_id": "22f80199-1199-400e-9092-17208f6f39f0",
  }
}