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

Bolt Financial Account API

Use the Account endpoint to view and manage customer accounts. Perform actions such as creating an account, updating an address, or adding a payment method. This endpoint is for merchants using the Accounts Package. See our related guide on [Bolt OAuth](https://help.boltapp.com/developers/bolt-oauth/).

Bolt Financial Account API is one of 13 APIs that Bolt Financial publishes on the APIs.io network, described by a machine-readable OpenAPI specification.

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

This API exposes 16 operations across 12 paths, and defines 51 schemas. It is described by OpenAPI 3.2.0, at version 1.0.

Requests are made against 4 base URLs: https://api.boltapp.com, https://api-sandbox.boltapp.com, https://api-staging.boltapp.com, https://{environment}.boltapp.com/v3.

16 operations 12 paths 51 schemas 4 DELETE3 GET1 PATCH6 POST2 PUT

Metadata

The identity and technical contract details declared by the specification.

Specification
OpenAPI 3.2.0
API Version
1.0
Base URL
https://api.boltapp.com
Authentication
OAuth 2.0, API Key, API Key, OAuth 2.0
Resource Areas
1

Authentication & Security 4

Bolt Financial Account API declares 4 security schemes for authenticating requests. It supports OAuth 2.0 (OAuth) using the authorizationCode flow, exposing 3 scopes. An API key is passed in the header as X-API-Key (X-API-Key). 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.

  • OAuth — Bolt utilizes the OAuth flow that developers can use to attain access to Bolt Account data via APIs. For all APIs that require authorization, please provide yo…
  • X-API-Key — Admins and Developers can obtain their Bolt API key from the Bolt Merchant Dashboard.

Paths & Operations 16

Across 12 paths, the API surfaces 16 operations — 4 DELETE, 3 GET, 1 PATCH, 6 POST, 2 PUT. Each is listed below with its method, path, parameters, and response codes.

Account 16

Use the Account endpoint to view and manage customer accounts. Perform actions such as creating an account, updating an address, or adding a payment method. This endpoint is for m…

GET
/v1/account
Get Account Details
getAccount 1 param → 200
POST
/v1/account
Create Bolt Account
createAccount 2 params body → 200
PATCH
/v1/account/profile
Update Profile
updateAccountProfile 1 param body → 200
POST
/v1/account/addresses
Add Address
addAddress 2 params body → 200
DELETE
/v1/account/addresses/{id}
Delete Address
deleteAddress 2 params → 200
POST
/v1/account/addresses/{id}
Replace Address
replaceAddress 3 params body → 200
PUT
/v1/account/addresses/{id}
Edit Address
editAddress 2 params body → 200
GET
/v1/account/exists
Detect Account
detectAccount 4 params → 200422
POST
/v1/account/payment_methods
Add Payment Method
addPaymentMethod 2 params body → 200
DELETE
/v1/account/payment_methods/{payment_method_id}
Delete Payment Method
deletePaymentMethod 2 params → 200403404
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

Schemas 51

The contract defines 51 schemas that model the data the API accepts and returns. The most detailed are address_view (19 properties), address (18 properties), credit_card_account (15 properties), address-listing (13 properties). Each schema is shown below with its type and property counts.

phone
string
A phone number following E164 standards, in its globalized format, i.e. prepended with a plus sign.
card_network
string
The card's network code. Nullable for Transactions Details. Note: LEGACY dinersclubusca now tagged as mastercard
address_view_account
object
The address object returned in the response.
payment_method_account
object
request_failed
boolean
Indicates that the request failed. This value is always false.
saved_credit_card_view
object
Saved Credit Card Detail
10 properties
shopper_metadata
objectnull
A key-value pair object that allows users to store arbitrary information associated with an object. For any individual account object, we allow up to 50 keys.…
1 property
door_code
stringnull
The building door code or community gate code.
profile_view
object
The shopper's account profile.
6 properties
message
string
Human-readable description of the error for developers. Should not be shown to users and is not localized.
saved_paypal_account_view
object
Saved PayPal account details.
4 properties
v1_accounts_view
object
1 property
profile
object
The first name, last name, email address, and phone number of a shopper.
5 properties 3 required
code
integer
Custom-defined Bolt error code. This can be used to programmatically react to specific errors.
address_view
object
The address object returned in the response.
19 properties
address
object
The Address object is used for billing, shipping, and physical store address use cases.
18 properties 8 required
address_account
object
errors_bolt_api
array
errors_bolt_api_response
object
2 properties
update_profile
object
The profile fields that can be updated for a shopper.
3 properties
create_account_input
object
The details needed to create a Bolt account.
3 properties 1 required
card_last4
string
The card's last 4 digits. Nullable for Transactions Details.
error_bolt_api
object
Error object containing custom error information
2 properties
email
string
An email address.
request_result
object
Custom-defined Bolt result object.
1 property
account_details_address_view
The address object returned in the response.
credit_card_account
object
The creditcard object is used to to pay for guest checkout transactions or save payment method details to an account. Once saved, you can reference the credit…
15 properties 3 required
account_details
object
4 properties
payment-method-klarna
object
2 properties 2 required
payment-method-afterpay
object
2 properties 2 required
payment-method-affirm
object
2 properties 2 required
payment-method-applepay
payment-method
payment-method-googlepay
payment-method-klarna-paynow
object
2 properties 2 required
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-explicit
object
13 properties 7 required
country-code
string
The country (in its ISO 3166 alpha-2 format) associated with this address.
payment-method-credit-card
profile_2
object
An account's identifying information.
4 properties 3 required
address-reference-partial
object
2 properties 2 required
credit-card-network
string
The credit card's network.
field-error
object
An error that pertains to validation of a specific field in the request.
3 properties 3 required
account
object
3 properties 2 required
credit-card
object
7 properties 5 required
address-reference-id
object
2 properties 2 required
payment-method-paypal
object
3 properties 3 required
payment-method-klarna-account
object
2 properties 2 required
error
object
2 properties 2 required
credit-card-error
object
2 properties 2 required
address-reference

Specification

The full machine-readable OpenAPI contract behind this narrative.

Source

bolt-financial-account-api-openapi.yml Raw ↑

Other APIs Bolt Financial publishes across the network.

Bolt MCP Servers
Bolt Financial Callbacks API
Bolt Financial Configuration API
Bolt Financial O Auth API
Bolt Financial Orders API
Bolt Financial Payments API
Bolt Financial Statements API
Bolt Financial Subscriptions API
Bolt Financial Testing API
Bolt Financial Tokenizer API
Bolt Financial Transactions API
Bolt Financial Webhooks API
Where this information came from

This is an independent, third-party profile of Bolt Financial Account 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.