Forage · OAuth Scopes

Forage OAuth Scopes

OAuth 2.0 derived

Forage publishes 6 OAuth 2.0 scopes via the password and clientCredentials flows. Scopes are the fine-grained permissions an application requests at authorization time to act against the Forage API on a user’s behalf.

Tokens are issued from /o/token/.

This index is generated from the provider’s OpenAPI security definitions (and, where available, its documented scope reference) and refreshes on every APIs.io network build. Browse every provider’s scopes at scopes.apis.io.

CompanyPaymentsEBTSNAPEBT CashHSA/FSAFintechGovernment BenefitsGroceryCheckoutFinancial Services
Scopes: 6 Flows: password, clientCredentials Method: derived

OAuth endpoints

Token URL
/o/token/
Flows
passwordclientCredentials

Scopes (6)

ScopeDescriptionFlows
disbursement Scope for tokens which can disburse money to merchants. clientCredentials
hosted_checkout Scope for tokens used by merchant applications which allow Forage to manage split tender processing (i.e. EBT + Credit/Debit). password
internal Scope for tokens used by Forage internal applications. clientCredentials
pin-protected Scope for tokens which can access secure storage. clientCredentials
pinpad_only Scope for tokens used by merchant applications which manage their own split tender (i.e. Forage Checkout is used only for EBT processing). password
reporting

Source

OAuth Scopes

Raw ↑
generated: '2026-10-14'
method: derived
source: openapi/forage-payments-api-openapi.yml
schemes:
- name: OAuth2
  source: openapi/forage-payments-api-openapi.yml
  flows:
  - flow: password
    tokenUrl: /o/token/
  - flow: clientCredentials
    tokenUrl: /o/token/
  description: Pass the access token in the 'Authorization' header with the format "Bearer ${token}",
    i.e. the word "Bearer" and your access token from the /o/token/ API, separated by whitespace.
scopes:
- scope: disbursement
  description: Scope for tokens which can disburse money to merchants.
  flows:
  - clientCredentials
  sources:
  - openapi/forage-payments-api-openapi.yml
- scope: hosted_checkout
  description: Scope for tokens used by merchant applications which allow Forage to manage split
    tender processing (i.e. EBT + Credit/Debit).
  flows:
  - password
  sources:
  - openapi/forage-payments-api-openapi.yml
- scope: internal
  description: Scope for tokens used by Forage internal applications.
  flows:
  - clientCredentials
  sources:
  - openapi/forage-payments-api-openapi.yml
- scope: pin-protected
  description: Scope for tokens which can access secure storage.
  flows:
  - clientCredentials
  sources:
  - openapi/forage-payments-api-openapi.yml
- scope: pinpad_only
  description: Scope for tokens used by merchant applications which manage their own split tender
    (i.e. Forage Checkout is used only for EBT processing).
  flows:
  - password
  sources:
  - openapi/forage-payments-api-openapi.yml
- scope: reporting
  sources:
  - openapi/forage-payments-api-openapi.yml

Work with this as data

Every scope set here is available over the APIs.io API and to AI agents over MCP.

MCP server

One button, every client — Claude, Cursor, VS Code and the rest.

https://apis.io/mcp

Tools for oauth scopes

4 MCP tools reach this
  • find_scopesBrowse and filter every scope set in the catalog.
  • apis_io_searchSTART HERE — APIs, providers and tags for one query, each with its total.
  • resolveTurn a domain, URL or GitHub org into the provider it belongs to.
  • find_cohortsEvery scored population of providers in the catalog.
All 92 tools →

Call it yourself

curl for this page
This scope set
curl "https://apis.io/api/v1/scopes/forage-scopes"
All oauth scopes
curl "https://apis.io/api/v1/scopes?limit=25"

Discovery needs no key. Ratings and market analysis are Pro.

Get an API key

Free tier, no form to fill in. Signing in shares your email address with us — we store it to create your key and to recognise you if you sign in with another provider. See our Privacy Policy and Terms.

A second provider on the same verified email joins the account you already have.