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.

Field	Description	Values
`event`	The state change recorded	`payment.success`, `payment_failed`
`payment_id`	The payment identifier for this event
`service`	The service for the payment type this is related to	`domestic-scheduled-payment`
`user_id`	The 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",
  }
}