Skip to main content
Version: v1

Transaction Lifecycle

Getting Started​

If you're here, you've already implemented our Storefront Components, or your team is working to implement them on the front end.

Each transaction registers on the front end via the Storefront Components in order to enable immediate impact tracking.

Our OMS APIs enable purchase verification, update and cancellation. Batch endpoints are available upon request.

Beam Transaction Lifecycle​

  1. Transactions are registered with Beam via the Beam Post Purchase widget to show impact updates to the user
  2. Partner's OMS registers the transaction
  3. Partner's OMS verifies the cart total and order ID of all online store transactions with Beam's system using the OMS API Key
  4. Partner's OMS sends updates to Beam when there're cancellations or cart total updates

For Subscriptions, recurring transactions are registered with Beam using the OMS API Key. Any transaction registered using the OMS API Key is already verified, and does not require a second call to verify the transaction.

Implementation Steps​

  1. For all transactions, asynchronously verify them with Beam using POST Update Transaction
  2. After an order is cancelled, call PUT Cancel Transaction
  3. After an order is updated (cart total changes), call POST Update Transaction

Subscription Implementation Steps​

  1. Register any recurring transaction (a transaction not registered via the web widgets) using POST Register Transaction
  2. Implement the above 3 implementation steps
  3. Cancelled subscriptions should call POST cancel subscription
  4. User email updates should call POST Update User Email