Create a Custom Payment Capture Session

This endpoint is only relevant to Custom integrations.

For more details about Custom, check out the Overview or Quickstart.

The response payload represents the Custom Payment Capture Session. The ref and redirect_url fields are the most important:

  • ref represents the Order
  • redirect_url is the URL that launches the front-end, customer-facing Forage UI
    • Point customers to this URL to enter their PIN to complete checkout

If PIN entry is successful, then Forage points the customer to the success_redirect_url specified in the request body. Forage directs the customer to the cancel_redirect_url if they cancel the balance inquiry from the Forage UI.

To check the status of an Order after the customer completes the Forage UI, send a GET to /orders/{order_ref}/.

How to use the snap_total and ebt_cash_total params

Keep snap_total to SNAP eligible items only, and ebt_cash_total to EBT Cash eligible items only.