Events API

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.

The /events endpoint sends and receives data about significant actions that occur with an entity or instrument on your system.

Event Subtypes for Transactions

Transaction subtypes provide a way to differentiate between, filter, and select transactions of different types.

Here are recommended (and optional) transaction subtypes:

SubtypeDescription
achACH transfers to/from a bank account
depositFunding events from your users' external accounts to your system accounts
withdrawalUsers withdrawing monetary value from your system accounts to their external accounts
p2pTransfer of value between users on your platform
purchaseGoods purchases, rentals, card network payments made by the user
refundReversal of any transaction into the user's account
reversalAlterations to a previous transaction
debitMonetary transfer into the target user's account
loan_issuedLoan given by the platform to the user
loan_paymentLoan repayment given or received by the user

Event Subtypes for Actions

Action subtypes provide a way to differentiate between, filter, and select transactions of different types.

Here are recommended (and optional) action subtypes:

SubtypeDescription
user_loginEvent log of a registered user logging in to your platform
user_logoutEvent log of a registered user logging out of your platform
user_accessEvent log of a registered user accessing
user_profile_updateUpdate event of a user's profile e.g. a user updating their shipping address
user_deletionPermanent user deletion from the platform
user_blockedUser blocked on the platform
user_suspendedTemporary suspension of the user on the platform
communicationEvent log detailing a communication/messaging event involving users on your platform and/or your customer contact teams
disputeEvent log detailing disputes and complaints filed user on your platform
user_referralEvent log detailing any referral activity initiated by existing users on your platform
promotion_appliedEvent log detailing any application of promotions to a user on your platform

Action Types for Actions

Possible values of action_type are:

Action Type
SIGNUP
LOGIN
LOGOUT
BLOCK
CLOSE
ACTIVATE
FORGOT_PASSWORD
PASSWORD_RESET
PROMO_CODE_USE
PROFILE_CHANGE