Bolt API Reference
type: WebAPI
description: A comprehensive Bolt API reference for interacting with Accounts, Payments, Orders and more.
version: 3.3.22
terms of service: https://www.bolt.com/end-user-terms
documentation: https://help.bolt.com/api-bolt/
provider: Bolt
endpoint url: https://{environment}.bolt.com/v3
available channel: Retrieve account details
  type: WebAPI
  description: Retrieve a shopper's account details, such as addresses and payment information. The account's details are filtered to be relevant to your merchant account, and some fields may be missing for some accounts. See the schema for details.
  http method: GET
available channel: Add an address
  type: WebAPI
  description: Add an address to the shopper's account
  http method: POST
available channel: Edit an existing address
  type: WebAPI
  description: Edit an existing address on the shopper's account. This does not edit addresses that are already associated with other resources, such as transactions or shipments.
  http method: PUT
available channel: Delete an existing address
  type: WebAPI
  description: Delete an existing address. Deleting an address does not invalidate or remove the address from transactions or shipments that are associated with it.
  http method: DELETE
available channel: Add a payment method
  type: WebAPI
  description: Add a payment method to a shopper's Bolt Account Wallet. For security purposes, this request must come from your backend. **Note**: Before using this API, the credit card details must be tokenized by Bolt's credit card tokenization service. Please review our [Bolt Payment Field Component](https://help.bolt.com/products/ignite/api-implementation/#enhance-payments) or [Install the Bolt Tokenizer](https://help.bolt.com/developers/references/bolt-tokenizer) documentation.
  http method: POST
available channel: Delete an existing payment method
  type: WebAPI
  description: Delete an existing payment method. Deleting a payment method does not invalidate or remove it from transactions or orders that are associated with it.
  http method: DELETE
available channel: Initialize a Bolt payment for logged in shoppers
  type: WebAPI
  description: Initialize a Bolt logged-in shopper's intent to pay for a cart, using the specified payment method. Payments must be finalized before indicating the payment result to the shopper. Some payment methods will finalize automatically after initialization. For these payments, they will transition directly to "finalized" and the response from Initialize Payment will contain a finalized payment.
  http method: POST
available channel: Finalize a pending payment
  type: WebAPI
  description: Finalize a pending payment being made by a Bolt logged-in shopper. Upon receipt of a finalized payment result, payment success should be communicated to the shopper.
  http method: POST
available channel: Initialize a Bolt payment for guest shoppers
  type: WebAPI
  description: Initialize a Bolt guest shopper's intent to pay for a cart, using the specified payment method. Payments must be finalized before indicating the payment result to the shopper. Some payment methods will finalize automatically after initialization. For these payments, they will transition directly to "finalized" and the response from Initialize Payment will contain a finalized payment.
  http method: POST
available channel: Finalize a pending guest payment
  type: WebAPI
  description: Finalize a pending payment being made by a Bolt guest shopper. Upon receipt of a finalized payment result, payment success should be communicated to the shopper.
  http method: POST
available channel: Create an order that was prepared outside the Bolt ecosystem.
  type: WebAPI
  description: Create an order that was prepared outside the Bolt ecosystem. Some Bolt-powered flows automatically manage order creation - in those flows the order ID will be provided separately and not through this API.
  http method: POST
available channel: Get OAuth token
  type: WebAPI
  description: Retrieve a new or refresh an existing OAuth token.
  http method: POST
available channel: Callback to update or create a full shopper account
  type: WebAPI
  description: Create or update a shopper account with profile information, payment and addresses. This is also known as the "upsert account" API, a combination of update and insert.
  http method: POST
available channel: Create a test account
  type: WebAPI
  description: Create a Bolt shopper account for testing purposes.
  http method: POST
available channel: Get a random phone number
  type: WebAPI
  description: Get a random, fictitious phone number that is not assigned to any existing Bolt account.
  http method: GET
available channel: Retrieve a tokenized test credit card
  type: WebAPI
  description: Retrieve a test credit card that can be used to process payments in your Bolt testing environment. The response includes the card's Bolt credit card token.
  http method: POST