Bolt Embeddable Checkout v1 API
The Embeddable Checkout v1 API used by merchants building their own checkout UI on top of Bolt. Exposes shopper account lookup and management, address and payment-method operations, OAuth token exchange, transaction authorize/capture/refund/void, tokenizer proxying and sandbox testing helpers. Bolt documents v1 as the default for custom checkout UI.
Bolt Embeddable Checkout v1 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, Account, Transaction, and Authentication. The published artifact set on APIs.io includes an OpenAPI specification and API documentation.
This API exposes 20 operations across 16 paths, organized into 4 resource areas, and defines 588 schemas. It is described by OpenAPI 3.0.0, at version 1.0.1.
Requests are made against 3 base URLs: https://api.boltapp.com, https://api-sandbox.boltapp.com, https://api-staging.boltapp.com.
20 operations
16 paths
588 schemas
2 DELETE4 GET2 PATCH11 POST1 PUT
Metadata
The identity and technical contract details declared by the specification.
Authentication & Security 2
Bolt Embeddable Checkout v1 API declares
2 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).
By default, every request must be authenticated.
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 20
Across 16 paths, the API surfaces 20 operations — 2 DELETE, 4 GET, 2 PATCH, 11 POST, 1 PUT. They span 4 resource areas: Account, OAuth, Transactions, Testing. Each is listed below with its method, path, parameters, and response codes.
Account 10
Create Embedded Accounts user flows for logged-in and guest experiences by interacting with and updating shopper data.
GET
/v1/account
Get Account Details
POST
/v1/account
Create Bolt Account
PATCH
/v1/account/profile
Update Profile
POST
/v1/account/addresses
Add Address
DELETE
/v1/account/addresses/{id}
Delete Address
POST
/v1/account/addresses/{id}
Replace Address
PUT
/v1/account/addresses/{id}
Edit Address
GET
/v1/account/exists
Detect Account
POST
/v1/account/payment_methods
Add Payment Method
DELETE
/v1/account/payment_methods/{payment_method_id}
Delete Payment Method
OAuth 1
Interact with Shopper data by completing the Bolt OAuth process.
POST
/v1/oauth/token
OAuth Token Endpoint
Transactions 7
Authorize credit card transactions and perform operations on those transactions with Bolt's transaction API.
POST
/v1/merchant/transactions/authorize
Authorize a Card
POST
/v1/merchant/transactions/capture
Capture a Transaction
POST
/v1/merchant/transactions/credit
Refund a Transaction
POST
/v1/merchant/transactions/void
Void a Transaction
GET
/v1/merchant/transactions/{REFERENCE}
Transaction Details
PATCH
/v1/merchant/transactions/{REFERENCE}
Update a Transaction
POST
/v1/tokenizer/proxy
Authorize a Card using TaaS
Testing 2
A collection of endpoints that provide useful functionality to assist in testing your Bolt integration.
POST
/v1/testing/shopper/create
Create Testing Shopper Account
GET
/v1/testing/card_token
Fetch a Test Credit Card Token
Schemas 588
The contract defines 588 schemas that model the data the API accepts and returns. The most detailed are i_cart_item_view (39 properties), cart_item (38 properties), merchant_division_summary_view (38 properties), transaction_view (30 properties). Each schema is shown below with its type and property counts.
door_code
string
The building door code or community gate code.
email
string
An email address.
phone
string
A phone number following E164 standards, in its globalized format, i.e. prepended with a plus sign.
address_view
object
The address object returned in the response.
19 properties
shopper_metadata
object
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
account_details_address_view
The address object returned in the response.
card_last4
string
The card's last 4 digits. Nullable for Transactions Details.
card_network
string
The card's network code. Nullable for Transactions Details. Note: LEGACY dinersclubusca now tagged as mastercard
saved_credit_card_view
object
Saved Credit Card Detail
10 properties
saved_paypal_account_view
object
Saved PayPal account details.
4 properties
profile_view
object
The shopper's account profile.
6 properties
account_details
object
4 properties
address
object
The Address object is used for billing, shipping, and physical store address use cases.
18 properties
8 required
address_account
object
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
payment_method_account
object
profile
object
The first name, last name, email address, and phone number of a shopper.
5 properties
3 required
create_account_input
object
The details needed to create a Bolt account.
3 properties
1 required
update_profile
object
The profile fields that can be updated for a shopper.
3 properties
address_view_account
object
The address object returned in the response.
v1_accounts_view
object
1 property
code
integer
Custom-defined Bolt error code. This can be used to programmatically react to specific errors.
message
string
Human-readable description of the error for developers. Should not be shown to users and is not localized.
error_bolt_api
object
Error object containing custom error information
2 properties
errors_bolt_api
array
request_failed
boolean
Indicates that the request failed. This value is always false.
request_result
object
Custom-defined Bolt result object.
1 property
errors_bolt_api_response
object
2 properties
o_auth_token_input
object
6 properties
5 required
o_auth_token_input_refresh
object
6 properties
5 required
o_auth_token_response
object
7 properties
errors_oauth_server_response
object
2 properties
cart_add_on
object
A list of up to 3 add-ons that are displayed to the shopper.
6 properties
3 required
cart_discount
object
7 properties
cart_fee
object
6 properties
5 required
collection
string
collections
array
cart_item_customization
object
3 properties
i_cart_item_external_inputs
object
3 properties
cost
integer
The cost in cents.
merchant_product_id
string
The merchant's unique ID for the product.
gift_options_message
string
Includes the gift message written by the shopper.
gift_options_wrap
boolean
Defines whether gift wrapping was requested.
cart_item_gift_option
object
Contains the gift option settings for wrapping and custom messages.
4 properties
merchant_variant_id
string
A merchant's unique ID for a given product's specific variant.
cart_item_property
object
6 properties
carrier
string
The name of the carrier selected.
discount_membership
boolean
Defines if shopper has a membership discount.
estimated_delivery_date
string
The estimated delivery date.
expedited
boolean
True if shipment is expedited.
depth
integer
The depth.
dimension_unit
string
The unit of measurement for an item's dimensions.
height
integer
The height.
package_type
string
The type of package.
weight_unit
string
The unit of measurement for an item's weight.
width
integer
The width.
service
string
The service name.
shipping_address_id
string
ID for billing address
shipping_method
string
The name of the shipping method.
signature
string
The signature.
tax_amount
integer
Tax amount in cents.
tax_code
string
The relevant tax code.
cart_shipment_type
string
The type corresponding to this shipment, if applicable.
cart_shipment
object
A cart that is being prepared for shipment
21 properties
cart_item
object
38 properties
5 required
digital_delivery
object
2 properties
in_store_cart_shipment
object
8 properties
fulfillment
object
Defines the shipments associated with the cart items.
5 properties
cart_loyalty_rewards
object
7 properties
base_cart
object
The basecart object contains the core details typically found in most cart objects, including items, discounts, amount totals, shipments, and in-store pickups.
11 properties
1 required
cart_create
credit_card
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…
10 properties
6 required
transaction_merchant_event_id
string
The reference ID associated with a transaction event (auth, capture, refund, void). This is an arbitrary identifier created by the merchant. Bolt does not enfo…
previous_subscription_id
string
The unique ID associated with to the shopper's previous subscription-based transaction. Leave null for standard, non-subscription transactions.
user_identifier
object
The object containing key lookup IDs associated with the shopper's account, such as the unique email address and phone number.
5 properties
1 required
first_name
string
The person's first name.
last_name
string
The person's last name.
user_identity
object
2 properties
merchant_credit_card_authorization
object
This request is used for authorizing a new, unsaved card.
12 properties
7 required
processing_initiator
string
Defines which payment method was used to initiate the transaction.
merchant_credit_card_authorization_recharge
object
This request is used for authorizing an existing, saved card associated with the account.
11 properties
6 required
amount_view
object
3 properties
credit_card_authorization_reason
string
The reason code explaining the authorization status. 1 - none 2 - invalidamount 3 - invalidcvv 4 - invalidccnumber 5 - expired 6 - risk 7 - loststolen 8 - call…
credit_card_authorization_status
string
The status of the authorization request. 1 - succeeded 2 - declined 3 - error
credit_card_authorization_view
object
8 properties
capture_id
string
The unique ID for the capture. Nullable for Transactions Details.
capture_status
string
The status of the capture. Nullable for Transactions Details.
capture_view
object
Deprecated. Use captures.
6 properties
transaction_splits_view
object
2 properties
credit_card_capture_view
object
6 properties
credit_card_credit_status
object
1 property
credit_card_credit_view
transaction_date
integer
Transaction date. Nullable for Transactions Details.
consumer_summary_view
object
3 properties
login_view
object
3 properties
priority
string
Describes the card's priority.
email_view
object
4 properties
phone_view
object
5 properties
consumer_self_view
card_bin
string
The Bank Identification Number for the credit card; this is typically the first 4-6 digits of the credit card number. Nullable for Transactions Details.
card_display_network
string
The card's network. Nullable for Transactions Details.
card_expiration
integer
The card's expiration. Nullable for Transactions Details.
icon_asset_path
string
The asset link for displayed icons. This link varies depending on payment method used. Nullable for Transactions Details.
card_id
string
The card's ID. Nullable for Transactions Details.
card_status
string
The card's status. Nullable for Transactions Details.
card_token
string
The Bolt token associated to the credit card. Required for new, unsaved cards.
card_token_type
string
Used to define which payment processor generated the token for this credit card.
credit_card_view
object
Contains details about the credit card transaction.
12 properties
transaction_id
string
The unique ID associated with the transaction. Nullable for Transactions Details.
transaction_indemnification_decision
string
Describes whether the transaction is indemnified by Bolt for fraud.
transaction_indemnification_reason
string
Describes the reason that the transaction is or is not indemnified by Bolt for fraud.
merchant_division_logo_view
object
2 properties
merchant_division_summary_view
object
38 properties
order_decision_details_view
object
2 properties
transaction_processor
string
The processor used. Nullable for Transactions Details.
transaction_reference
string
The transaction's 12-digit Bolt reference ID. Nullable for Transactions Details.
review_ticket_view
object
3 properties
risk_model_external_result_view
object
4 properties
risk_review_status
string
Describes the current Risk Review status. A transaction could be unreviewed, reviewed, or pending manual review by the Bolt team.
transaction_status
string
The transaction's status.
transaction_type
string
The type of transaction.
credit_card_void_cause
string
Specifies why this particular transaction is voided.
credit_card_void_status
string
The status of the void request.
credit_card_void_view
object
4 properties
transaction_view
object
30 properties
i_authorize_result_view
object
3 properties
amount
integer
The amount in cents. Nullable for Transactions Details.
currency_iso
string
The 3-digit ISO code for the currency. Nullable for Transactions Details.
transaction_skip_hook_notification
boolean
Set to true to skip receiving a webhook notification from Bolt that is triggered by this update to the transaction.
capture_transaction_with_reference
object
5 properties
3 required
transaction_credit
object
5 properties
3 required
credit_card_void
object
3 properties
1 required
address_change_request_metadata_view
object
5 properties
adjust_transactions
array
Nullable for Transactions Details.
authorization_verification_status
string
Used to track the status of micro-authorizations. Nullable for Transactions Details.
authorization_id
string
The authorization's id.
captures_view
array
All captures associated with the transaction. Nullable for Transactions Details.
chargeback_id
string
The unique ID of the chargeback.
chargeback_event_view
object
2 properties
chargeback_reason
string
The reason for the chargeback.
chargeback_reason_code
string
Bolt's [standardized reason codes](https://help.boltapp.com/merchants/references/policies/disputes/dispute-codes/).
chargeback_representment_reply_by_date
integer
The date of the chargeback.
chargeback_representment_result
string
The result of the chargeback representment.
chargeback_details
object
10 properties
credit
object
1 property
custom_fields
object
10 properties
customer_list_status
object
2 properties
email_id
string
This is the ID for the email address associated with the shopper.
email_priority
string
This is the priority of the contact method. This field's contents are not displayed in the transaction details view.
email_status
string
This is the status of the contact method.
emails
array
A list of email addresses. Nullable for Transactions Details.
consumer_id
string
The shopper's unique ID.
phone_country_code
string
A phone number's country code.
phone_id
string
This is the ID for the phone number associated with the shopper.
phone_priority
string
This is the priority of the contact method. This field's contents are not displayed in the transaction details view.
phone_status
string
This is the status of the contact method.
phones_with_country_code
array
A list of phone numbers.
credit_card_user
object
The credit card user.
5 properties
consumer_membership_status
string
True if user has an AllPass membership associated to their Bolt Account. Nullable for Transactions Details.
consumer_user_membership
object
Nullable for Transactions Details.
1 property
1 required
last_viewed_utc
integer
The last view time as UTC.
manual_disputes
object
10 properties
merchant_created_date
integer
The date the merchant account was created. Nullable for Transactions Details.
merchant_description
string
The description of the merchant account. Nullable for Transactions Details.
merchant_onboarding_status_code
string
transaction_processor_status
string
The processor's status. Only primary and active processor are displayed.
transaction_operational_processor
object
2 properties
2 required
transaction_operational_processors
array
Nullable for Transactions Details.
merchant_public_id
string
The unique public ID for the merchant's Bolt account. A merchant account contains many merchant divisions.
merchant_status
integer
The merchant's status: 1 - Active 2 - Inactive 3 - Offboarding
merchant_time_zone
string
The timezone of the merchant. Nullable for Transactions Details.
merchant
object
8 properties
5 required
merchant_account_page_url
string
The URL provided by the merchant for the account page.
merchant_debug_url
string
The endpoint URL provided by the merchant for debugging.
merchant_division_description
string
The description of the merchant division. Nullable for Transactions Details.
merchant_get_account_url
string
The endpoint URL provided by the merchant to fetch accounts.
merchant_shopper_custom_fields_updated_url
string
The endpoint URL provided by the merchant to be notified whenever shopper respond to the custom fields for creating merchant platform account.
webhooks_type
string
[Webhook events](https://help.boltapp.com/developers/guides/webhooks/transaction-hook-types) that trigger a notification to the URL. Note:newslettersubscriptio…
merchant_hook_url
string
The endpoint URL provided by the merchant to send webhooks.
merchant_division_id
string
The unique ID associated to the merchant's Bolt Account division; Merchants can have different divisions to suit multiple use cases (storefronts, pay-by-link,…
merchant_division_domain
string
The URL of the merchant division.
merchant_division_logo
string
The logo image file for the merchant division.
merchant_logo
object
2 properties
merchant_id
string
The unique ID for the merchant's Bolt account. A merchant account contains many merchant divisions. Nullable for Transactions Details.
merchant_oauth_logout_url
string
The endpoint URL provided by the merchant for logging out of OAuth accounts.
merchant_oauth_redirect_url
string
The endpoint URL provided by the merchant for OAuth redirects.
merchant_platform
string
The type of platform being used for this merchant division.
merchant_plugin_config_url
string
The endpoint URL provided by the merchant for checking plugin configuration details.
merchant_privacy_policy_url
string
The endpoint URL provided by the merchant for providing a unique privacy policy.
merchant_product_info_url
string
The endpoint URL provided by the merchant for checking product details.
merchant_division_public_id
string
The unique public ID for one of the merchant's store division.
merchant_terms_of_service_url
string
The endpoint URL provided by the merchant for providing unique terms of service.
merchant_universal_merchant_api_url
string
The endpoint URL provided by the merchant to access their universal API.
merchant_validate_additional_account_data_url
string
The endpoint URL provided by the merchant for validating additional account data.
merchant_division
object
28 properties
6 required
merchant_order_number
string
The merchant's internal order number for this transaction.
i_currency
object
2 properties
i_free_shipping_discount_view
object
2 properties
i_cart_discount_view
object
7 properties
gift_option_view
object
Defines which gift options are hidden.
2 properties
cart_item_property_view
object
4 properties
subscription
object
Describes a product added as a recurring subscription.
1 property
i_weight
object
2 properties
i_cart_item_view
object
39 properties
i_description_part
object
2 properties
i_description_tooltip
object
2 properties
i_cart_shipment_view
object
20 properties
currency_symbol
string
The currency symbol used for the amount. Nullable for Transactions Details.
amounts
object
The amount. Nullable for Transactions Details.
3 properties
3 required
default
boolean
gift_options
object
Contains the gift option settings for wrapping and custom messages.
2 properties
package_dimension
object
Contains the package's width, eight, depth, and unit details.
4 properties
weight
integer
The weight of an item.
package_weights
object
2 properties
reference
string
Reference for the object.
company
string
The company's name
country
string
The country's name.
country_code
string
The 2-digit country code.
billing_address_id
string
The unique Bolt ID associated with a previously saved billing address. Not applicable to new, unsaved addresses.
locality
string
A locale such as county, district, etc.
name_person
string
The first and last name together as a string.
postal_code
string
The postal code.
region
string
A state, province, or similar region type.
street_address
string
You can use up to 4 street address fields.
consumer_billing_address
object
16 properties
4 required
total_weight
object
2 properties
in_store_shipment
object
A cart that is being prepared for shipment
17 properties
in_store_shipment2
object
A cart that is being prepared for shipment
5 properties
fulfillment_view
object
5 properties
cart_loyalty_rewards_view
object
7 properties
cart_view
object
This is the cart object returned in a successful response.
24 properties
i_custom_field_view
object
11 properties
payment_service
string
eligible_payment_method
object
2 properties
i_gift_option_view
object
2 properties
i_order_dynamic_content
object
8 properties
order_external_data_view
object
1 property
order_view
object
7 properties
risk_decision_factor.yml
string
One of the main contributing factors to the fraud decision and score.
risk_decision_factors.yml
array
The top 5 factors of the fraud decision.
order_decision_score
integer
The total fraud risk score of the order.
order_decision
object
Decision and score for an order.
2 properties
refund_transaction_ids
array
Nullable for Transactions Details.
refund_transactions_view
array
Nullable for Transactions Details.
request_id
string
The unique ID for the request ticket.
request_deadline
integer
request_status
string
review_ticket
object
Internal use only.
3 properties
risk_insight_availability.yml
boolean
Must be set to true to receive fraud insights.
risk_fraud_probability.yml
integer
The total [fraud score](/merchants/references/policies/fraud-review/fraud-scoring).
risk_insights.yml
object
Displays fraud decisioning insights based on key factors. This information can either be forwarded via a riskinsights transaction webhook type or be polled by…
4 properties
splits_view
array
A list of splits. Nullable for Transactions Details.
address_change_view
object
5 properties
risk_model_resul_contribution_view
object
2 properties
risk_model_result_view
object
1 property
transaction_review_view
object
4 properties
transaction_timeline_view
object
9 properties
auth_rejection_details
object
2 properties
transaction_rejection_details_view
object
1 property
transaction_update_input
object
2 properties
account_identifier_status
string
The status of the shopper account identifier (email or phone). If the account does not have this identifier, the status is "missing"; If the identifier has bee…
testing_account_request
object
7 properties
testing_account_details
object
8 properties
1005_code
integer
Invalid merchant key.
1005_message
string
Authentication error. Invalid merchant key.
1005_invalid_merchant_key
object
2 properties
account_login_status
string
address_change_status
string
The status of the request.
address_change_ticket_id
string
The ID of the ticket.
address_change_timestamp
integer
The timestamp of the address change request.
address_change
object
5 properties
address_change_id
string
The Unique ID for the change request.
address_change_ticket_status
string
The status of the request.
adjust_transaction_merchant
object
6 properties
5 required
alliance_data_info
object
1 property
1 required
auth_rejection_details_view
object
2 properties
1 required
authorization_reason_codes
string
The code matching the rejection reason.
authorization_reason_description
string
The explanation of the reason code.
hosted_payments_response
object
10 properties
9 required
sfcc_order_output
object
1 property
authorize_external_outputs
object
3 properties
auto_approved
boolean
If merchant has whitelisted, is true.
availability
string
Determines if the product is available.
availability_count
integer
How many are in stock.
url
string
The full URL to receive webhook notifications.
base_create_webhook
object
2 properties
2 required
base_model
object
Base model.
5 properties
block_listed
boolean
If merchant has block listed, is true.
bolt_product_id
string
Unique ID generated for a product via the products endpoint.
brand
string
The name of a brand.
can_change_shipping_address
boolean
Defines whether the merchant can update the shipping address after authorization.
capture
object
Deprecated. Use captures.
4 properties
3 required
captures
array
All captures associated with the transaction. Nullable for Transactions Details.
card_address
object
13 properties
card_expiration_string
string
The expiration date of the credit card, expressed as a string.
card_number
integer
The card number. Nullable for Transactions Details.
pin
integer
The PIN for the credit card.
card_gift
object
A gift card.
2 properties
card_priority
string
The priority for the card.
cards_gift
array
A list of gift cards.
category
string
A category.
color
string
The color.
metadata_component
object
2 properties
customizations_name
string
The name of the customization.
item_description
string
A description for the item added to the cart/order.
image_url
string
The URL for the item's image.
isbn
string
A 13-digit identifier for a book item.
item_group
string
Enables grouping in the checkout UI.
manufacturer
string
The name of a manufacturer.
name_item
string
The name of an item.
options
string
item_property
object
2 properties
item_properties
array
quantity
integer
The quantity of this item.
item_shipment_type
string
The shipment type selected by the shopper.
size
string
The size.
sku
string
The SKU identifier for this item or service.
tag
string
A tag
taxable
boolean
Determines if item is taxable.
type
string
Determines if item is a physical, digital, or bundled good, or if the good type is unknown.
item
object
An item with properties.
29 properties
5 required
items
array
A list of items.
total_amount
integer
The total amount.
display_id
string
The displayed ID.
order_reference
string
The order reference.
metadata
object
You can add your own metadata.
cart
object
8 properties
shipping_address
object
16 properties
currency
object
2 properties
discount_code
string
The discount code input by a shopper.
discount_codes
array
A list of discount codes.
cart_shipments
array
A list of shipments.
cart_discounts
object
12 properties
subscription_cart
object
Cart information about this subscription.
1 property
1 required
offer_cycles
integer
Describes how long the trial applies to this subscription. Apply this value to the unit in frequency to find the trial length; e.g., 1 month.
subscription_frequency_unit
string
The unit for a subscription's frequency.
subscription_frequency_value
integer
The value applied to the unit frequency.
subscription_frequency
object
Describes how often the subscription recurs.
2 properties
2 required
offer_recurring
object
The price and frequency for rebill periods.
3 properties
2 required
offer_trial
object
The price and frequency for the initial period.
3 properties
1 required
cart_item_subscription
object
3 properties
cart_limited
object
Limited cart view.
4 properties
cart_url
string
The URL for the cart.
discount_description
string
The discount code's description.
discount_uri
string
The discount's URI.
discount_category
string
The discount's category.
is_free_shipping
boolean
maximum_cost_allowed
integer
discount_free_shipping
object
Contains free shipping settings and limitations.
2 properties
discounts
array
A list of discounts.
in_store_shipments
array
order_url
string
shipment
object
A cart that is being prepared for shipment
17 properties
shipments2
array
cart_order
object
18 properties
3 required
order_display_id
string
The order reference.
cart_order_generated
object
5 properties
product_name_id
string
The product's unique ID associated to the product.properties.nameid from the Get Inventory call.
product_value_id
integer
The product's unique value ID associated to the product.properties.valueid from the Get Inventory call.
publisher_properties
object
Properties associated to the item.
2 properties
publisher_item
object
An item with properties.
4 properties
publisher_items
array
A list of items.
cart_publisher
object
1 property
cart_shipment_combined
object
A cart that is being prepared for shipment
6 properties
discounts_transaction_authorize
array
A list of discounts.
cart_transaction_authorize
object
8 properties
cart_transaction_recharge
object
3 properties
product_identifiers_view
object
5 properties
product_view
object
9 properties
property_metadata_view
object
3 properties
property_value_view
object
3 properties
product_properties_map_view
object
The map of this product's properties.
3 properties
product_inventory_view
object
5 properties
catalog_view
object
2 properties
chargeback_details_view
object
10 properties
chargeback_event_content
string
The context for the chargeback.
chargeback_event_time
integer
The time this single chargeback event ocurred.
consumer_email_verified
boolean
True if Bolt has verified this email in the past. Nullable for Transactions Details.
consumer_platform_account_status
integer
Used internally for Bolt. Does not display information externally.
credit_card_credit
object
7 properties
funding_instrument_id
integer
ID of the funding instrument used.
credit_card_transaction_stage
integer
Stage of the credit card transaction: 1 - Auth 2 - Capture 3 - Void 4 - Credit 5 - Legacy value: authcapture 6 - Submission 7 - Settlement
credit_card_transaction
object
Details about the credit card transaction.
6 properties
credit_status
object
1 property
custom_field_view
object
10 properties
custom_field_response_view
object
1 property
custom_field_full_response_view
object
2 properties
custom_fields2
array
data
object
Generic wrapper used by Bolt.
reason
string
The reason for the error.
data_error
object
The JSON object with string key, and value any JSON object.
1 property
date
integer
The date.
description
string
The product's description.
discount_reference
string
The discount's reference.
discount_type
string
The type of discount.
discounts_order_generate
array
A list of discounts.
distance
integer
The distance as a number.
distance_unit
string
The distance unit.
error
object
2 properties
event
string
The kind of event.
error_base_response
object
3 properties
errors
array
errors_base_response
object
3 properties
webhook_event_group
string
Subscribe to a group of events. all: subscribe to all existing and future event types
event_group_create_webhook
object
1 property
events_array_create_webhook
object
1 property
shopify
string
Data externalized from shopify.
external_data
object
For Shopify users only; otherwise, is empty.
1 property
from_consumer
object
The credit card user. Nullable for Transactions Details.
8 properties
4 required
from_credit_card
object
A credit card.
11 properties
10 required
gtin
string
The product's GTIN.
has_bolt_account
boolean
Determines if user has a Bolt account using their e-mail address or phone number.
has_dynamic_price
boolean
Determines if item has dynamic price.
hide_apm
string
Hides alternative payment methods from checkout.
hide_apms
array
i_cart_fee_view
object
6 properties
i_cart_view
object
This is the cart object returned in a successful response.
18 properties
i_store_shipment_view
i_delivery_options
object
4 properties
i_order_external_data
object
1 property
i_order_metadata
object
1 property
i_order_view
object
5 properties
i_remote_order_create
object
3 properties
2 required
i_remote_order_result
object
1 property
i_subscription_frequency_view
object
2 properties
indemnification_decision
string
Determines indemnification coverage.
indemnification_reason
string
Determines indemnification coverage reason.
price
integer
The price of an item.
product_id
string
The product's unique id.
item_add
object
4 properties
item_remove
object
2 properties
items_add
array
A list of items to add to the cart.
items_remove
array
A list of items to remove from the cart.
magento_payment_request
object
4 properties
manual_dispute_view
object
10 properties
manual_disputes_array
array
product_media_audio
string
The URL for an image, video, or audio clip. For Property URLs, this can be used for color and pattern swatches to represent your product variants.
media_audios
array
List of URLs
product_media_url
string
The URL for an image, video, or audio clip. For Property URLs, this can be used for color and pattern swatches to represent your product variants.
media_urls
array
List of URLs
product_media_video
string
The URL for an image, video, or audio clip. For Property URLs, this can be used for color and pattern swatches to represent your product variants.
media_videos
array
List of URLs
merchant_callback_url_type
string
Bolt merchant division callback URL type
merchant_callbacks_input
object
2 properties
2 required
merchant_callbacks_view
object
1 property
merchant_create_order_url
string
The endpoint URL provided by the merchant to Bolt for order creation.
merchant_credit_card_review
object
2 properties
2 required
merchant_divisions_identifiers_view
array
merchant_identifiers_view
object
3 properties
merchant_processor_linked
boolean
Indicates if the merchant account has set up their processor with Bolt.
merchant_view
object
3 properties
tracking_detail
object
7 properties
7 required
mock_tracking_input
object
4 properties
4 required
multimedia
string
Type of media.
name_store
string
The name of the store.
order_token
string
The token for the order.
user_note
string
Notes from the shopper.
order
object
5 properties
seller_split_amounts
object
Defines the financial breakdown for a seller split, including subtotals, discounts, shipping, taxes, and the final gross amount.
5 properties
5 required
marketplace_commission_fee
object
Configures the marketplace commission fee structure for a seller split, supporting both percentage-based and flat fee models.
3 properties
2 required
seller_split
object
Defines a seller split configuration for marketplace orders, specifying which items and shipments belong to a seller and how amounts should be calculated and d…
3 properties
3 required
order_create
object
6 properties
2 required
order_create_cart
object
8 properties
order_generate_cart
object
The cart associated to the order token.
7 properties
order_non_bolt
boolean
Designates if the order was placed outside of Bolt checkout.
order_publisher_cart_shipment
object
A cart that is being prepared for shipment
6 properties
order_publisher_cart_shipments
array
A list of shipments.
properties
object
2 properties
order_publisher_item
object
An item with properties.
13 properties
order_publisher_items
array
A list of items.
order_received_url
string
This is a URL used to redirect the shopper when the order is created (optional).
order_status_details
string
The details that contextualize the order's status.
order_status_type
string
The type of order webhook.
order_tracking_number
string
The carrier's tracking number for the shipment.
publisher_order_metadata
object
This is a map that can contain several objects indexed by different keys. You can use this to track conversions.
1 property
order_webhook
object
3 properties
order_webhook_metadata
object
1 property
payment_method
object
2 properties
initialize_paypal_payment_input
object
1 property
1 required
update_paypal_payment_input
object
1 property
paypal_payment_view
object
1 property
phones
array
A list of phone numbers.
pickup_address
object
9 properties
pickup_window_close
integer
When a store not available for picking up orders.
pickup_window_open
integer
When a store is available for picking up orders.
pickup_option
object
A pickup option.
10 properties
pickup_options
array
A list of pickup options.
previous_transaction_id
string
The ID of the shopper's last transaction.
processor_card_token
string
The token associated with the shopper's credit card. This field is only populated for merchants using Adyen or Radial as their credit card processor.
processor_shopper_reference
string
The token associated with the shopper.
processor_token_alias
string
The alias token for the processor used.
product_identifiers
object
Identifiers for the product.
4 properties
product_variant
string
The boltproductID of the parent product. If the product is the parent, this ID is the same.
product_name
integer
The product's readable name.
product_price
object
The product's price in cents and currency.
2 properties
product_prices
array
List of product prices.
product_property_position
integer
Used to dictate the order of properties displayed (e.g., least greatest).
product_property_text_label
string
The text label for the property.
product_metadata
object
Metadata for the product.
3 properties
product_property_name
string
The property's readable name.
product_property_name_id
integer
The property type's unique ID.
product_property_value
string
The property's unique value. (e.g., S M L for size properties; Red Green Blue for color properties.)
product_property_value_id
integer
The unique ID of the property's value.
product_properties
array
Properties associated to the product.
product
object
A product.
13 properties
product_next_cursor
string
The ID of the next variant to link to when pagination is used.
products
array
The inventory available for a given product.
product_inventory
object
The inventory available for a given product.
4 properties
product_value
string
The product's unique value ID associated to the product.properties.valueid from the Get Inventory call.
rate_shipping
integer
The shipping rate amount in cents.
rate_subtotal
integer
The rate subtotal in cents.
refundable_capture
object
Records details about a capture that is eligible to be refunded.
4 properties
transaction
refund_results
object
Details about the refund.
8 properties
transaction_authorization
object
7 properties
2 required
splits
array
A list of splits. Nullable for Transactions Details.
transaction_properties
object
2 properties
refund_transaction
object
27 properties
refund_transactions
array
Nullable for Transactions Details.
request_source
string
The source of the request.
risk_model_contribution
object
2 properties
risk_model_contributions
array
risk_model_result
object
Contains the contributing factors Bolt's risk model used to make a decision.
1 property
review
object
4 properties
risk_payment_instrument_factors.yml
object
Displays the result of the CVV and AVS checks returned at authorization.
2 properties
initialize_saved_payment_input
object
1 property
1 required
update_saved_payment_input
object
1 property
saved_payment_view
object
1 property
shipments
array
A list of shipments.
shipping_carrier
string
the name of the carrier used for shipment.
shipping_default
boolean
Defines if option is default or not.
shipping_option_description
string
Additional information about the service. Supports a maximum of 60 characters and the use of , with IDs to be used as tooltips.
shipping_option_description_tooltip_content
string
The HTML content that the tooltip displays. Supports up to 120 characters and the following HTML elements: , , , , , and
shipping_option_description_tooltip_target
integer
The ID of the span used to wrap the description's text. This ID is used to display the tooltip.
shipping_option_description_tooltip
object
An optional tooltip for a shipping option that supports a maximum of 60 characters (does not include HTML). This tooltip is displayed beneath the shipping opti…
2 properties
shipping_option_description_tooltips
array
A list shipping tooltips.
shipping_option
object
A shipping option.
11 properties
shipping_option_combined
object
A shipping option.
7 properties
shipping_options
array
A list of shipping options.
shipping_options_combined
array
A list of shipping options.
shipping_to_store_option
object
A shipping option.
9 properties
shipping_to_store_options
array
A list of ship-to-store options.
source
string
This is the originating source of the request
source_transaction
object
Nullable for Transactions Details.
23 properties
statements_date
integer
This is the date of the statement, in milliseconds since the Unix epoch time.
statements_file_type
string
This is the type of the file. Currently, Bolt only supports CSV statements.
statements_type
string
The time period and statement type: [Funding details statement](https://help.boltapp.com/operations/financials/export-funding-detail-statements/) with transact…
statements_url
string
This is the pre-signed URL of the requested statement. The URL has an expiration period of 5 minutes. Sharing the URL implies sharing the statement and its con…
status
string
The status.
tags
array
A list of tags.
tax_result
object
4 properties
timeline_consumer
object
The consumer associated to the note.
3 properties
timeline_date
integer
timeline event view
timeline_note
string
transaction timeline event note
timeline_transaction
object
27 properties
timeline_type
string
transaction timeline event type.
timeline_visibility
string
Defines who has permission to view the note added to the timeline.
timeline_event
object
One event on the timeline.
9 properties
timeline
array
timeline of actions on a transaction
transaction_auth_address
object
The Address object is used for billing, shipping, and physical store address use cases.
17 properties
8 required
transaction_custom_fields
object
2 properties
transaction_custom_fields_array
array
transaction_decision
string
The decision to approve or reject the transaction.
transaction_details_view
transaction_from_credit_card
object
4 properties
transaction_from_user
object
5 properties
transaction_indemnification_status
integer
Describes whether the indemnification decision and reason are up-to-date. 1 - current 2 - prior
transaction_publisher_from_credit_card.yml
object
4 properties
transaction_publisher_item
object
An item with properties.
11 properties
transaction_publisher_items
array
A list of items.
transaction_publisher_refund_transactions
array
List of transaction IDs.
transaction_recharged
object
16 properties
transaction_reviewed
object
17 properties
unit_price
integer
Price per unit in cents.
variants
array
A collection of product variations linked to the current product that can vary in size and color or other properties.
webhook_id
string
A unique webhook ID. Reference this value to modify or delete the webhook subscription. operations as well.
webhook
object
5 properties
3 required
webhooks_object
string
The type of webhook object.
adjust_transaction
discount_currency
order_publisher_cart_order_shipping_address
paypal_payment_input_initialize
paypal_payment_input_update
product_properties_array
requested_refund_amount
saved_payment_input_initialize
saved_payment_input_update
total_refund_amount
Specification
The full machine-readable OpenAPI contract behind this narrative.
Source
More from Bolt Financial 4
Other APIs Bolt Financial publishes across the network.
Bolt API
Bolt Embeddable Checkout v3 API
Bolt Tokenizer API
Bolt MCP Servers
#Checkout#Account#Transaction#Authentication
Where this information came from
This is an independent, third-party profile of Bolt Embeddable Checkout v1 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.