Bolt · Schema

authorization-code-request

Perform the initial token exchange, using the authorization code provided by Bolt's Login Modal.

CheckoutPaymentseCommerceOne-Click CheckoutShopper NetworkFraud Protection

Properties

Name Type Description
client_id string The OAuth client ID, which corresponds to the merchant publishable key, which can be retrieved in your Merchant Dashboard.
client_secret string The OAuth client secret, which corresponds the merchant API key, which can be retrieved in your Merchant Dashboard.
scope array The requested scopes. If the request is successful, the OAuth client will be able to perform operations requiring these scopes.
state string A randomly generated string sent along with an authorization code. This must be included if provided. It is used to prevent cross-site request forgery (CSRF) attacks.
grant_type string The type of OAuth 2.0 grant being utilized.
code string Fetched value using OTP value from the Authorization Modal.
View JSON Schema on GitHub

JSON Schema

authorization-code-request.json Raw ↑ 
{
  "$schema": "http://json-schema.org/draft-07/schema#",
  "$id": "https://api.bolt.com/schemas/authorization-code-request",
  "title": "authorization-code-request",
  "type": "object",
  "description": "Perform the initial token exchange, using the authorization code provided by Bolt's Login Modal.",
  "required": [
    "client_id",
    "client_secret",
    "grant_type",
    "scope",
    "code"
  ],
  "properties": {
    "client_id": {
      "type": "string",
      "description": "The OAuth client ID, which corresponds to the merchant publishable key, which can be retrieved in your Merchant Dashboard.",
      "example": "8fd9diIy59sj.IraJdeIgmdsO.fd233434fg2c616cgo932aa6e1e4fc627a9385045gr395222a127gi93c595rg4"
    },
    "client_secret": {
      "type": "string",
      "description": "The OAuth client secret, which corresponds the merchant API key, which can be retrieved in your Merchant Dashboard.",
      "example": "23ee7ec7301779eaff451d7c6f6cba322499e3c0ec752f800c72a8f99217e3a8"
    },
    "scope": {
      "description": "The requested scopes. If the request is successful, the OAuth client will be able to perform operations requiring these scopes.",
      "externalDocs": {
        "description": "OAuth Developer Reference",
        "url": "https://help.bolt.com/developers/references/bolt-oauth/#scopes"
      },
      "type": "array",
      "items": {
        "type": "string",
        "enum": [
          "bolt.account.manage",
          "bolt.account.view",
          "openid"
        ]
      }
    },
    "state": {
      "description": "A randomly generated string sent along with an authorization code. This must be included if provided. It is used to prevent cross-site request forgery (CSRF) attacks.",
      "type": "string",
      "example": "xyzABC123"
    },
    "grant_type": {
      "description": "The type of OAuth 2.0 grant being utilized.",
      "enum": [
        "authorization_code"
      ],
      "type": "string",
      "example": "authorization_code"
    },
    "code": {
      "description": "Fetched value using OTP value from the Authorization Modal.",
      "type": "string",
      "example": "7GSjMRSHs6Ak7C_zvVW6P2IhZOHxMK7HZKW1fMX85ms"
    }
  }
}