Create Checkout Session

Create a checkout session for your customer. A successful response will yield an Order object in the body. After creating the session, be sure to do the following,

  • Redirect your customer to the redirect_url so they can pay for their order.
  • Store the order's reference number, ref field in the response, for your records.

The total amount to be paid must be broken down into 3 amounts when you create the session,

  1. snap_total - The amount which is SNAP-eligible (e.g. cost of produce in the basket).
  2. ebt_cash_total - The amount which is eligible for EBT cash, but not SNAP-eligible (e.g. cost of paper products).
  3. remaining_total - The amount which is not eligible for either benefit and must be paid with a form of payment other than an EBT card.

Note that these amounts are the maximum amount which can be paid using the corresponding payment method type. The actual payment choices made by your customer may vary from these maximums, so you should inspect the receipt field of the Order or the individual Payment objects associated with this order to see the actual breakdown of spending across payment types.

The total value of the basket + taxes = snap_total + ebt_cash_total + remaining_total.

If taxes are applied to any items in the cart, all of the products must be passed into the product_list field.

Regarding taxes, be aware that a product's tax_rate will only be applied to a SNAP-eligible item if the customer chooses to pay for SNAP-eligible items with an alternate payment method. Per FNS regulations, SNAP payments cannot be taxed, but SNAP-eligible items are subject to tax if paid for with a credit card or EBT Cash.

Since the amount of taxes charged will be dependant on the amount of SNAP a customer applies to their order, the final amount of taxes applied will only be available once an order has been successfully processed. That sales_tax_applied field will denote the amount charged to the customer and the taxes_charged fields found in the product_list will give a further breakdown on a per item and a per individual tax basis.

Recipes
🛒
Create a Checkout session
Open Recipe

📘

Token

You generated a token in the previous section. Make sure to include it in the header.

Language
Authentication
OAuth2
URL
Click Try It! to start a request and see the response here!