Instalment Schedule Events
Event types and causes for instalment schedule resources.
Created#
The instalment schedule has been created.
apiinstalment_schedule_createdInstalment schedule has been created via the API
Creation Failed#
The instalment schedule failed to create due to validation errors when creating the payments. The errors will be included in the event payload.
apiinstalment_schedule_creation_failedInstalment schedule failed to be created
Cancelled#
The instalment schedule has been cancelled. Any pending payments have also been cancelled.
apiinstalment_schedule_cancelledInstalment schedule has been cancelled
gocardlessmandate_cancelledInstalment schedule has been cancelled
gocardlessmandate_failedInstalment schedule has been cancelled
gocardlessmandate_suspended_by_payerInstalment schedule has been cancelled
gocardlessmandate_expiredInstalment schedule has been cancelled
Errored#
One or more instalments in this instalment schedule failed to collect successfully.
gocardlessinstalment_schedule_erroredInstalment schedule has errored
gocardlessinstalment_schedule_errored_lateOne or more payments in the instalment schedule has had a late failure
Resumed#
The instalment schedule has been rectified by remedying any failed payments.
gocardlessinstalment_schedule_resumedInstalment schedule has resumed
Completed#
This instalment schedule has concluded. No further instalments will be collected.
gocardlessinstalment_schedule_completedInstalment schedule has completed