Payment flows

Rye supports a variety of different use cases, including selling Shopify products from the Sell Anything API and the Sync API, as well as selling Amazon products via Rye. Each use case requires a slightly different payment flow, which is described in detail below.

​

Key terms / concepts

This guide assumes you’re familiar with the following terms and concepts:

​

Sell Anything API - Shopify products

These are products that are specifically requested as part of the Sell Anything API.

​

Sync API - Shopify products

These are products that are part of the Rye network via the Sync API.

​

Amazon checkout

This refers to using Rye to place Amazon orders on behalf of end customers. For this use case, Rye handles returns and cancellations for

​

Rye Pay

The Rye Pay library is an npm package Rye provides to collect payment information from customers directly inside their web browser.

Rye Pay does not affect how data flows from Rye to merchants, but it does affect how payment information is collected from customers and passed to Rye.

​

Payment flows

​

Sync API

1. Shopper enters payment information on developer’s site via the rye-pay library OR developer collects payment from shopper via their own payment flow.
2. Cart is submitted to Rye with tokenized credit card information.
3. Order is submitted to merchant’s Shopify store, charging passed-in card directly (shopper’s card if using rye-pay, developer’s card if using their own payment flow).

​

Back-end payment flow

​

Rye Pay payment flow

​

Sell Anything API

1. Shopper enters payment information on developer’s site via the rye-pay library OR developer collects payment from shopper via their own payment flow.
2. Cart is submitted to Rye with tokenized credit card information.
3. Passed-in card is charged by Rye (shopper’s card if using rye-pay, developer’s card if using their own payment flow).
4. Order is submitted to merchant’s Shopify or Amazon store, paid for by Rye.

​

Back-end payment flow

​

Rye Pay payment flow

​

Handling returns

To better understand how payments work with returns, please see the Returns guide.

​

Additional notes

Rye will handle any processing fees that are part of the flows explained above. As order volume grows, this is subject to change by incorporating a regular invoicing process paid via ACH.