The Forage API is versioned. A new version is released when there is a backwards-incompatible change to the API.

The API version for all of your requests is set in your account API settings in the Forage dashboard. To prevent breaking changes, the default is the oldest supported API version.

Forage strongly recommends updating the version in your API settings to the most recent release.

API version history

The sections below detail every supported version of the Forage API. Each version is named after its release date, following the YYYY-MM-DD convention.


Original unversioned release

  • Introduced split tender over SNAP, EBT Cash, and credit/debit cards.

How to override API version account settings

To override the API version in your account settings for specific requests, set the version in the API-Version request header, as in the following example:

curl --request POST \
     --url \
     --header 'API-Version: 2021-12-19' \
     --header 'Merchant-Account: 1234567' \
     --header 'Authorization: Bearer sandbox_lsIZjMZ2eaS6H5SpBcsRI8mViRwKfA' \
     --header 'Accept: application/json' \
     --header 'Content-Type: application/json' \
     --data '{
  "snap_total": 100,
  "ebt_cash_total": 20,
  "remaining_total": 0,
  "product_list": [],
  "success_redirect_url": "",
  "cancel_redirect_url": "",
  "delivery_address": {
    "city": "San Francisco",
    "country": "US",
    "line1": "185y Market St",
    "line2": "",
    "state": "CA",
    "zipcode": "94103"
  "is_delivery": false,
  "supported_benefits": [