Events have two types, transaction events and action events:
- Transaction events are any monetary flow that is sent or received by an entity on your system.
- Action events are non-monetary changes of state that occur on your system, e.g. user logins.
/events endpoint sends and receives data about significant actions that occur with an entity or instrument on your system.
Transaction subtypes provide a way to differentiate between, filter, and select transactions of different types.
Here are recommended (and optional) transaction subtypes:
ACH transfers to/from a bank account
Funding events from your users' external accounts to your system accounts
Users withdrawing monetary value from your system accounts to their external accounts
Transfer of value between users on your platform
Goods purchases, rentals, card network payments made by the user
Reversal of any transaction into the user's account
Alterations to a previous transaction
Monetary transfer into the target user's account
Loan given by the platform to the user
Loan repayment given or received by the user
Action subtypes provide a way to differentiate between, filter, and select transactions of different types.
Here are recommended (and optional) action subtypes:
Event log of a registered user logging in to your platform
Event log of a registered user logging out of your platform
Event log of a registered user accessing
Update event of a user's profile e.g. a user updating their shipping address
Permanent user deletion from the platform
User blocked on the platform
Temporary suspension of the user on the platform
Event log detailing a communication/messaging event involving users on your platform and/or your customer contact teams
Event log detailing disputes and complaints filed user on your platform
Event log detailing any referral activity initiated by existing users on your platform
Event log detailing any application of promotions to a user on your platform
Possible values of action_type are: