This endpoint is only relevant to Fully Hosted integrations.
A POST
request to /sessions/
initiates a Session
of the Fully Hosted Forage Checkout UI. On success, the API creates a Forage Order
.
The response payload represents the Fully Hosted Session
. The ref
and redirect_url
fields are the most important:
ref
represents theOrder
- Store this
ref
so that you can pass it in a future request to Retrieve the Order outcome
- Store this
redirect_url
is the URL that launches the customer-facing Forage Checkout UI- Point customers to this URL when they’re ready to complete checkout
How to use the
snap_total
andebt_cash_total
paramsKeep
snap_total
to SNAP eligible items only, andebt_cash_total
to EBT Cash eligible items only.A customer might apply less than the total eligible amount of benefits to the
Order
. Retrieve the Order outcome and inspect thereceipt
field to confirm the final spending breakdown across payment types.
Pass the
tax_rate
of every item in theproduct_list
body param so that Forage can handle taxes.Forage calculates the taxes for the
Order
depending on how the customer decides to pay. SNAP eligible items are only subject to taxes when purchased with a credit/debit card, per FNS regulations. Retrieve the Order outcome and inspect thesales_tax_applied
response value to find the final tax amount charged to the customer, or review thetaxes_charged
on a per item level in theproduct_list
field.
Guides