Sign in

v1

latestOpenAPI 3.0.12026-07-26106359429.8 KB
OAuth

Get an Access Token

Exchange your client credentials for an access code.

post/v1/oauth/token

Request body

grant_type'client_credentials' required

The type of access token you want to request.

client_idstring required

Your client ID.

client_secretstring required

Your client secret.

scope'account_number/read' | 'account_number/read_write' | 'ach/read' | 'ach/read_write' | 'wire/read' | 'wire/read_write' | 'instant_payment/read' | 'instant_payment/read_write' | 'event/read' | 'internal_transfer/read' | 'internal_transfer/read_write' | 'lending/read' | 'lending/read_write' | 'entity/read' | 'entity/read_write' | 'funding/read' | 'funding/read_write' | 'subledger_balance/read' | 'subledger_balance/read_write' | 'account/read' | 'account/read_write' | 'application/read' | 'application/read_write' | 'blockchain_payment/read' | 'blockchain_payment/read_write' | 'card/read' | 'card/read_write'

A space delimited list of scopes your access token should be provisioned to allow.

Example request

{
  "client_id": "<client_id>",
  "client_secret": "<client_secret>",
  "scope": "ach/read"
}

Response

Successful token exchange

access_tokenstring

A Base64 access token.

token_typestring

The token type.

scopestring

A space delimited list of scopes your access token is provisioned for.

expires_ininteger

The number of seconds the access token will expire in.

Example response

{
  "access_token": "AN_ACCESS_TOKEN",
  "token_type": "Bearer",
  "scope": "ach/read account_number/read",
  "expires_in": 86400
}