How AI is applied across API Evangelist and APIs.io. Read my AI disclosure →
API Evangelist API Evangelist
Discovery
Learnings
Guidance
Toolbox
Alignment
API Evangelist LLC
Discovery
Learnings
Guidance
Toolbox
Alignment
API Evangelist LLC

Need help?

Contact us
Bolt Financial

Bolt Embeddable Checkout v3 API

The v3 generation of the Bolt Embeddable Checkout API, served under a /v3 path with a templated environment server variable. Reorganises the surface around Accounts, Payments (including guest payments), Orders, OAuth, merchant Callbacks, Testing and Events. Bolt gates v3 behind explicit enablement and directs most integrations to v1.

Documentation Provider Profile APIs.io OpenAPI GitHub

Bolt Embeddable Checkout v3 API is one of 5 APIs that Bolt Financial publishes on the APIs.io network, described by a machine-readable OpenAPI specification.

Tagged areas include Checkout, Payments, Order, and Account. The published artifact set on APIs.io includes an OpenAPI specification and API documentation.

This API exposes 16 operations across 15 paths, organized into 6 resource areas, and defines 77 schemas. It is described by OpenAPI 3.0.0, at version 3.3.22.

Requests are made against a single base URL, https://{environment}.boltapp.com/v3.

16 operations 15 paths 77 schemas 2 DELETE2 GET11 POST1 PUT

Metadata

The identity and technical contract details declared by the specification.

Specification
OpenAPI 3.0.0
API Version
3.3.22
Base URL
https://api.boltapp.com/v3
Authentication
API Key, OAuth 2.0
Contact
Bolt
Terms of Service
View terms
Resource Areas
6

Authentication & Security 2

Bolt Embeddable Checkout v3 API declares 2 security schemes for authenticating requests. An API key is passed in the header as X-API-Key (api-key). It supports OAuth 2.0 (oauth) using the authorizationCode flow, exposing 3 scopes.

Paths & Operations 16

Across 15 paths, the API surfaces 16 operations — 2 DELETE, 2 GET, 11 POST, 1 PUT. They span 6 resource areas: Account, Payments, Orders, OAuth, Callbacks, Testing. Each is listed below with its method, path, parameters, and response codes.

Account 6

Use the Accounts API to access shoppers' accounts to empower your checkout and facilitate shoppers' choices.

GET
/account
Retrieve account details
accountGet 2 params → 2004XXdefault
POST
/account/addresses
Add an address
accountAddressCreate 2 params body → 2004XXdefault
PUT
/account/addresses/{id}
Edit an existing address
accountAddressEdit 3 params body → 2004XXdefault
DELETE
/account/addresses/{id}
Delete an existing address
accountAddressDelete 3 params → 2004XXdefault
POST
/account/payment-methods
Add a payment method
accountAddPaymentMethod 2 params body → 2004XXdefault
DELETE
/account/payment-methods/{id}
Delete an existing payment method
accountPaymentMethodDelete 3 params → 2004XXdefault
Payments 4

Use the Payments API to process credit card and alternative payment methods with Bolt.

POST
/payments
Initialize a Bolt payment for logged in shoppers
paymentsInitialize 2 params body → 2004XXdefault
POST
/payments/{id}
Finalize a pending payment
paymentsAction 3 params body → 2004XXdefault
POST
/guest/payments
Initialize a Bolt payment for guest shoppers
guestPaymentsInitialize 2 params body → 2004XXdefault
POST
/guest/payments/{id}
Finalize a pending guest payment
guestPaymentsAction 3 params body → 2004XXdefault
Orders 1

Use the Orders API to create and manage orders, including orders that have been placed outside the Bolt ecosystem.

POST
/orders
Create an order that was prepared outside the Bolt ecosystem.
ordersCreate 2 params body → 2004XXdefault
OAuth 1

Use the OAuth API to enable your ecommerce server to make API calls on behalf of a Bolt logged-in shopper.

POST
/oauth/token
Get OAuth token
oauthGetToken body → 2004XXdefault
Callbacks 1

Implement Callback endpoints on your servers to power Bolt experiences. Different Bolt packages require different callbacks to be implemented. Consult your relevant product docume…

POST
/callbacks/accounts
Callback to update or create a full shopper account
callbackAccountUpsert 1 param body → 2004XXdefault
Testing 3

Use the Testing API to generate and retrieve test data to verify a subset of flows in non-production environments.

POST
/testing/accounts
Create a test account
testingAccountCreate 1 param body → 2004XXdefault
GET
/testing/accounts/phones
Get a random phone number
testingAccountPhoneGet 1 param → 2004XXdefault
POST
/testing/credit-cards
Retrieve a tokenized test credit card
testingCreditCardGet body → 2004XXdefault

Schemas 77

The contract defines 77 schemas that model the data the API accepts and returns. The most detailed are address-reference-explicit (13 properties), address-listing (13 properties), account-test-creation-data (9 properties), cart-item (9 properties). Each schema is shown below with its type and property counts.

country-code
string
The country (in its ISO 3166 alpha-2 format) associated with this address.
address-listing
object
An address saved on an account, i.e. a physical address plus any additional account-specific metadata.
13 properties 6 required
address-reference-id
object
2 properties 2 required
address-reference-explicit
object
13 properties 7 required
address-reference-partial
object
2 properties 2 required
address-reference
credit-card-network
string
The credit card's network.
credit-card
object
7 properties 5 required
payment-method-credit-card
payment-method-googlepay
payment-method-applepay
payment-method-paypal
object
3 properties 3 required
payment-method-affirm
object
2 properties 2 required
payment-method-afterpay
object
2 properties 2 required
payment-method-klarna
object
2 properties 2 required
payment-method-klarna-account
object
2 properties 2 required
payment-method-klarna-paynow
object
2 properties 2 required
payment-method
profile
object
An account's identifying information.
4 properties 3 required
account
object
3 properties 2 required
error
object
2 properties 2 required
field-error
object
An error that pertains to validation of a specific field in the request.
3 properties 3 required
credit-card-error
object
2 properties 2 required
amount
object
A monetary amount, i.e. a base unit amount and a supported currency.
2 properties 2 required
cart-shipment
object
3 properties
cart-discount
object
3 properties 1 required
cart-item
object
9 properties 5 required
cart
object
8 properties 3 required
payment-method-reference
object
2 properties 2 required
payment-method-bolt-token
object
Pay with a saved card referenced by a Bolt token. The token is the value returned in the X-Bolt-Token response header when the card was added (requires the ret…
2 properties 2 required
payment-method-extended
seller-split-amounts
object
5 properties
marketplace-commission-fee
object
3 properties
seller-split
object
3 properties
payment-initialize-request
object
6 properties 2 required
processor-response
object
Raw authorization response from the payment processor
3 properties
transaction-authorization
object
2 properties
transaction-capture
object
2 properties
transaction-refund
object
1 property
transaction-void
object
1 property
transaction
object
2 properties
payment-response-finalized
object
4 properties 3 required
payment-response-pending
object
5 properties 4 required
payment-response-three-ds-required
object
4 properties 3 required
payment-response
three-ds-error
object
An error that occurs during 3D Secure authentication or verification.
2 properties 2 required
cart-error
object
2 properties 2 required
payment-action-request
object
2 properties 1 required
seller-info
object
1 property 1 required
payment-incremental-authorization-request
object
5 properties 2 required
payment-update-request
object
2 properties
profile-creation-data
guest-payment-initialize-request
object
7 properties 3 required
order
object
2 properties 2 required
order-response
object
2 properties 2 required
authorization-code-request
object
Perform the initial token exchange, using the authorization code provided by Bolt's Login Modal.
6 properties 5 required
refresh-token-request
object
Refresh an existing access token, using the refresh token provided in the initial authorization.
6 properties 5 required
base-oauth-token-response
object
6 properties
get-access-token-response
create-full-account
object
2 properties
item
object
7 properties 5 required
cart-2
object
6 properties 3 required
update-cart-event-data
object
1 property 1 required
cart-updated-event-data
object
1 property 1 required
payment-event-data
object
2 properties 1 required
payment-completed-event-data
object
2 properties 1 required
recognition-event-data
object
3 properties 3 required
shopper-recognized-event-data
object
3 properties 3 required
page-view-event-data
object
2 properties 1 required
page-viewed-event-data
object
2 properties 1 required
event
object
6 properties 5 required
events-request
array
failed-event
object
3 properties
events-response
object
1 property
account-test-creation-data
object
9 properties 6 required
account-test-phone-data
object
1 property 1 required
test-credit-card
object
5 properties 5 required

Specification

The full machine-readable OpenAPI contract behind this narrative.

Source

bolt-financial-embeddable-checkout-v3-openapi.yml Raw ↑

Other APIs Bolt Financial publishes across the network.

Bolt API
AE Profile APIs.io
Bolt Embeddable Checkout v1 API
AE Profile APIs.io
Bolt Tokenizer API
AE Profile APIs.io
Bolt MCP Servers
AE Profile APIs.io
#Checkout#Payments#Order#Account
← Back to B APIs
API Details
ID
bolt-financial:embeddable-checkout-v3
Base URL
https://api.boltapp.com/v3
Docs
https://help.boltapp.com/api-embedded-v3/
Provider
Bolt Financial
APIs.io →  GitHub →
Explore more
All APIs Providers APIs.io Network
Work with this as data

Every API here is available over the API and to AI agents over MCP. APIs is not yet its own endpoint on the v1 API. Reach this content through network search and the tag graph, or the MCP server below.

Installs https://mcp.apievangelist.com/mcp in Claude, Cursor, VS Code and the rest — one button, every client.

MCP tools for apis
4 tools reach this content
  • search_api_evangelistSearch every content type across the network at once.
  • find_relatedThe shared-tag relevance graph — what else covers this.
  • get_tagEverything one tag labels, across all content types.
  • guide_topicPRO — a curated bundle for a topic: area, guidance, rules, papers, stories, services.
All tools & prompts
Call it yourself
curl for this page
Search the network for this 
curl "https://api.apievangelist.com/v1/search?q=embeddable-checkout-v3&limit=10"
Everything under a tag 
curl "https://api.apievangelist.com/v1/tags/embeddable-checkout-v3"

Discovery needs no key. Full bodies and the synthesis endpoints are Pro.

Get an API key

Free tier, no email required. Sign in with whichever identity you already have.

GitHub Google LinkedIn

A second provider on the same verified email joins the account you already have. Your account

Where this information came from

This is an independent, third-party profile of Bolt Embeddable Checkout v3 API, published by API Evangelist. We do not operate, host, resell, or support these APIs, and we are not affiliated with or endorsed by the company unless stated above. Everything here is built from publicly available information — the company's own site, developer portal, documentation, public repositories, and the specifications it publishes for public use. Nothing is obtained by breaching a system, defeating an access control, or using credentials.

The Kin Score and Agent Readiness rating are independently calculated assessments of a company's public API artifacts, scored against a published rubric. They are not certifications, endorsements, security assessments, or audits.

Corrections, re-scores, and removal are free — no partnership or purchase required, and you do not need to justify the request. A removed company is recorded as unrated, never scored zero for having asked. Acknowledgement within one business day; removal within two.

info@apievangelist.com · Read the full data-sourcing policy →
On a security or compliance team? Put security in the subject line and you will get a person, not a form — we will tell you exactly which public URLs this profile was built from.