Types of events
This is a list of all the types of events we currently send. We may add more at any time, so in developing and maintaining your code, you should not assume that only these types exist.
You'll notice that these events follow a pattern: resource.event. Our goal is to design a consistent system that makes things easier to anticipate and code against.
EVENT
Scroll inside to view more
|
Type
|
Description
|
|---|---|
ach_debit.cancelled describes an ACH debit
| Occurs whenever an ACH Debit is cancelled.
|
ach_debit.confirmed describes an ACH debit
| Occurs whenever an ACH Debit is confirmed.
|
ach_debit.extended describes an ACH debit
| Occurs whenever an ACH Debit is extended.
|
ach_debit.pending describes an ACH debit
| Occurs whenever an ACH Debit is created.
|
ach_debit.rejected describes an ACH debit
| Occurs whenever an ACH Debit is rejected.
|
ach_debit.returned describes an ACH debit
| Occurs whenever an ACH Debit is returned.
|
ach_debit.submitted describes an ACH debit
| Occurs whenever an ACH Debit is submitted.
|
customer.inactive describes a customer
| Occurs whenever a customer has no active mandates.
|
customer.active describes a customer
| Occurs whenever a customer has at least one active mandate.
|
mandate.acknowledged describes a mandate
| Occurs whenever a mandate is acknowledged.
|
mandate.active describes a mandate
| Occurs whenever a mandate is activated.
|
mandate.cancelled describes a mandate
| Occurs whenever a mandate is cancelled.
|
mandate.failed describes a mandate
| Occurs whenever a mandate fails.
|
mandate.expired describes a mandate
| Occurs whenever a mandate is expired.
|
settlement.pending describes a settlement
| Occurs whenever a settlement is created.
|
settlement.processing describes a settlement
| Occurs whenever a settlement is processing.
|
settlement.settled describes a settlement
| Occurs whenever a settlement is paid out.
|
source.pending describes a source
| Occurs whenever a source is created.
|
source.pending_submission describes a source
| Occurs whenever a physical source is processed.
|
source.submitted describes a source
| Occurs whenever a source is submitted.
|
source.withdrawn describes a source
| Occurs whenever a source is withdrawn/expires.
|
subscription.active describes a subscription
| Occurs whenever a subscription is created.
|
subscription.cancelled describes a subscription
| Occurs whenever a subscription is cancelled.
|
subscription.finished describes a subscription
| Occurs whenever a subscription finishes.
|
- Have questions?
- Need help? Contact support
- LLM? Read llms.txt
