Sign in

v2

latestOpenAPI 3.0.02026-07-3139594346.4 KB
OAuth

OAuth Token Endpoint

Endpoint for receiving access, ID, and refresh tokens from Bolt's OAuth server.

To use this endpoint, first use the Authorization Code Request flow by using the authorization_code Grant Type (grant_type). Then, in the event that you would need a second or subsequent code, use the refresh_token value returned from a successful request as the refresh_token input value in your subsequent refresh_token Grant Type (grant_type) request.

Reminder - the Content-Type of this request must be application/x-www-form-urlencoded

post/v1/oauth/token

Headers

X-Publishable-Keystring

The publicly viewable identifier used to identify a merchant division. This key is found in the Developer > API section of the Bolt Merchant Dashboard [RECOMMENDED].

Response

OAuth token response.

access_tokenstring

An access token you can use to make requests on behalf of a Bolt Account.

expires_ininteger

Access token’s expiration in seconds.

id_tokenstring

A JWT token issued when the request includes the scope open_id.

refresh_tokenstring

A refresh token you can use to issue a brand new access token without obtaining a new authorization code.

refresh_token_scopestring

The scope granted to the refresh token. Currently this will always be bolt.account.view.

scopestring

The scope granted to access token, depending on the scope granted to the authorization code as well as the scope parameter. Options include bolt.account.manage, bolt.account.view, openid.

token_typestring

The token_type will always be bearer.