Formance · OAuth Scopes

Formance OAuth Scopes

OAuth 2.0 derived

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

Tokens are issued from https://{organization}.{environment}.formance.cloud/api/auth/oauth/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.

Financial InfrastructureLedgerDouble-Entry AccountingPaymentsOrchestrationMoney MovementOpen SourceFintech

Scopes: 6 Flows: clientCredentials Method: derived

OAuth endpoints

Token URL
https://{organization}.{environment}.formance.cloud/api/auth/oauth/token

Flows
clientCredentials

Scopes (6)

Scope	Description	Flows
ledger:read	Read ledger resources	clientCredentials
ledger:write	Write ledger resources	clientCredentials
payments:read	Read payments resources	clientCredentials
payments:write	Write payments resources	clientCredentials
wallets:read	Read wallets resources	clientCredentials
wallets:write	Write wallets resources	clientCredentials

📄 Provider scope reference:

Source

OAuth Scopes

generated: '2026-07-11'
method: derived
source: openapi/formance-openapi.yml
schemes:
- name: oauth2
  source: openapi/formance-openapi.yml
  flows:
  - flow: clientCredentials
    tokenUrl: https://{organization}.{environment}.formance.cloud/api/auth/oauth/token
  description: 'OAuth2 client-credentials flow. Exchange a client id and secret at `/api/auth/oauth/token`
    for a Bearer access token, then send it as `Authorization: Bearer <token>`.'
scopes:
- scope: ledger:read
  description: Read ledger resources
  flows:
  - clientCredentials
  sources:
  - openapi/formance-openapi.yml
- scope: ledger:write
  description: Write ledger resources
  flows:
  - clientCredentials
  sources:
  - openapi/formance-openapi.yml
- scope: payments:read
  description: Read payments resources
  flows:
  - clientCredentials
  sources:
  - openapi/formance-openapi.yml
- scope: payments:write
  description: Write payments resources
  flows:
  - clientCredentials
  sources:
  - openapi/formance-openapi.yml
- scope: wallets:read
  description: Read wallets resources
  flows:
  - clientCredentials
  sources:
  - openapi/formance-openapi.yml
- scope: wallets:write
  description: Write wallets resources
  flows:
  - clientCredentials
  sources:
  - openapi/formance-openapi.yml