Standard flow

Learn how a standard flow works in the Direct Integrations option

The following sequence diagrams outline a standard Direct Integrations flow. They depict interactions between the customer, your commerce platform, the Digital River APIs, and Digital River. These diagrams are meant to outline Digital River's core capabilities, focusing specifically on:

To learn about other flows, refer to the Sequence diagrams section on the Integration checklists page.

Product management

When identifying and describing your products in the Digital River APIs, you can use several approaches.

For details on your product management options, refer to the Product basics page.


Digital River is typically not involved in initial pre-checkout interactions between customers and your commerce platform. During this stage, customers land on your storefront, build a cart, confirm the cart's details, and initiate checkout. Your commerce platform typically presents them with the option of checking out as either a guest or registered customer.

Building a checkout

When a new customer checks out on your storefront, you can use the Digital River APIs to create a customer and a checkout. The checkout contains the transaction's tax details and assigned selling entity. Your commerce platform should update the user interface with this tax information and use the selling entity to display compliance disclosures.

Creating an order

When customers proceed to the payment entry stage, your commerce platform needs to render Drop-in payments. Customers then submit their payment details and Drop-in payments uses that information to create a payment source.

Explore the Drop-in payments builder to gain a better understanding of how sources are created.

If customers opted to save the payment source for future purchases, and that source is ready for storage, you should attach the source to the customer and then apply the source to the checkout. Otherwise, simply apply the source to the checkout for use in this single transaction.

Once payment is applied, use the checkout to update the commerce platform with the transaction's final tax information and selling entity. The commerce platform should then render an order review page with the appropriate compliance information.

At this point, customers typically confirm the transaction's details and submit the order. This event should trigger a create order request. This request primarily acts as a fraud review and payment authorization call.

The immediate response contains either a 409 Conflict or 201 Created status code. In the event of an error, update the status of the commerce platform and render the appropriate message to storefront customers. If an order is created, use the response's data to update the status of the commerce platform's order.

For immediately accepted orders, move the commerce platform's order into a ready to fulfill state and direct customers to some sort of "Thank You" page.

If an order's state is immediately returned as pending payment authorization or in fraud review, you'll need to handle asynchronous, order-related events sent by Digital River.

Once an order is successfully screened for fraud or customers complete the steps necessary to push payment, Digital River creates the order accepted and ready to fulfill event. If an order asynchronously fails due to suspected fraud or because the payment window closes without funds, we create an order blocked or charged failed event, respectively.

When you're notified of one of these events, retrieve the order's state from the event's payload, and, depending on that value, move the commerce platform's order into an accepted, blocked, or payment failed state.

Fulfilling an order

Once an order's state is accepted, the client can initiate fulfillment. As products are fulfilled or cancelled, the commerce platform updates the status of those line items and emits status change events. These events should trigger a POST/fulfillments request that specifies the fulfilled quantity, the cancelled quantity, or both. Depending on the configuration of that request, Digital River initiates a funds capture and/or authorization reversal.

Last updated