Bolt Financial Transactions API
Use the Transactions endpoint to authorize payments when the shopper checks out and handle post authorization actions such as captures and refunds. You can use a shopper's existing saved payment information or tokenize new payment information with the [Bolt Tokenizer](https://help.boltapp.com/api-tokenizer/). Bolt Authorize Transaction types fall into one of three categories: a logged-in shopper checking out with a saved payment method, any type of shopper checking out with a new payment method, and a logged-in shopper checking out with a new payment method. The new payment method will be saved to the shopper's account.
Bolt Financial Transactions 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 Transaction. The published artifact set on APIs.io includes an OpenAPI specification and API documentation.
This API exposes 8 operations across 7 paths, and defines 250 schemas. It is described by OpenAPI 3.2.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.
8 operations
7 paths
250 schemas
1 GET1 PATCH6 POST
Metadata
The identity and technical contract details declared by the specification.
Authentication & Security 2
Bolt Financial Transactions 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 8
Across 7 paths, the API surfaces 8 operations — 1 GET, 1 PATCH, 6 POST. Each is listed below with its method, path, parameters, and response codes.
Transactions 8
Use the Transactions endpoint to authorize payments when the shopper checks out and handle post authorization actions such as captures and refunds. You can use a shopper's existin…
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/review
Review 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
Schemas 250
The contract defines 250 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.
cost
integer
The cost in cents.
processing_initiator
string
Defines which payment method was used to initiate the transaction.
merchant_status
integer
The merchant's status: 1 - Active 2 - Inactive 3 - Offboarding
merchant_product_id
string
The merchant's unique ID for the product.
merchant_order_number
string
The merchant's internal order number for this transaction.
chargeback_representment_result
string
The result of the chargeback representment.
depth
integer
The depth.
authorization_id
string
The authorization's id.
cart_shipment
object
A cart that is being prepared for shipment
21 properties
transaction_timeline_view
object
9 properties
transaction_details_view
merchant_oauth_logout_url
string
The endpoint URL provided by the merchant for logging out of OAuth accounts.
postal_code
string
The postal code.
cart_discount
object
7 properties
credit_card_capture_view
object
6 properties
gift_option_view
object
Defines which gift options are hidden.
2 properties
customer_list_status
object
2 properties
first_name
string
The person's first name.
carrier
string
The name of the carrier selected.
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
cart_loyalty_rewards
object
7 properties
phone_country_code
string
A phone number's country code.
cart_loyalty_rewards_view
object
7 properties
chargeback_reason_code
string
Bolt's [standardized reason codes](https://help.boltapp.com/merchants/references/policies/disputes/dispute-codes/).
card_token
string
The Bolt token associated to the credit card. Required for new, unsaved cards.
consumer_self_view
estimated_delivery_date
string
The estimated delivery date.
digital_delivery
object
2 properties
billing_address_id
stringnull
The unique Bolt ID associated with a previously saved billing address. Not applicable to new, unsaved addresses.
request_status
string
request_id
string
The unique ID for the request ticket.
transaction_update_input
object
2 properties
chargeback_event_view
object
2 properties
region
string
A state, province, or similar region type.
i_weight
object
2 properties
merchant_debug_url
string
The endpoint URL provided by the merchant for debugging.
credit_card_authorization_view
object
8 properties
card_status
string
The card's status. Nullable for Transactions Details.
default
boolean
email_id
string
This is the ID for the email address associated with the shopper.
merchant_division_domain
string
The URL of the merchant division.
phone_view
object
5 properties
consumer_membership_status
string
True if user has an AllPass membership associated to their Bolt Account. Nullable for Transactions Details.
adjust_transactions
array
Nullable for Transactions Details.
authorization_verification_status
string
Used to track the status of micro-authorizations. Nullable for Transactions Details.
transaction_status
string
The transaction's status.
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
request_result
object
Custom-defined Bolt result object.
1 property
capture_id
string
The unique ID for the capture. Nullable for Transactions Details.
chargeback_details
object
10 properties
credit_card_credit_view
chargeback_id
string
The unique ID of the chargeback.
credit_card_void_cause
string
Specifies why this particular transaction is voided.
cart_item_property
object
6 properties
consumer_id
string
The shopper's unique ID.
door_code
stringnull
The building door code or community gate code.
login_view
object
3 properties
icon_asset_path
string
The asset link for displayed icons. This link varies depending on payment method used. Nullable for Transactions Details.
country
string
The country's name.
expedited
boolean
True if shipment is expedited.
transaction_splits_view
object
2 properties
capture_transaction_with_reference
object
5 properties
3 required
cart_item_property_view
object
4 properties
custom_field_view
object
10 properties
review_ticket_view
object
3 properties
phone_priority
string
This is the priority of the contact method. This field's contents are not displayed in the transaction details view.
cart_item
object
38 properties
5 required
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
credit_card_void
object
3 properties
1 required
currency_iso
string
The 3-digit ISO code for the currency. Nullable for Transactions Details.
cart_view
object
This is the cart object returned in a successful response.
24 properties
i_order_dynamic_content
object
8 properties
order_decision
object
Decision and score for an order.
2 properties
refund_transactions_view
array
Nullable for Transactions Details.
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.
message
string
Human-readable description of the error for developers. Should not be shown to users and is not localized.
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
merchant_credit_card_review
object
2 properties
2 required
credit_card_view
object
Contains details about the credit card transaction.
12 properties
phone_status
string
This is the status of the contact method.
transaction_reference
string
The transaction's 12-digit Bolt reference ID. Nullable for Transactions Details.
i_free_shipping_discount_view
object
2 properties
review_ticket
object
Internal use only.
3 properties
phone_id
string
This is the ID for the phone number associated with the shopper.
merchant_terms_of_service_url
string
The endpoint URL provided by the merchant for providing unique terms of service.
merchant_platform
string
The type of platform being used for this merchant division.
company
string
The company's name
code
integer
Custom-defined Bolt error code. This can be used to programmatically react to specific errors.
merchant_account_page_url
string
The URL provided by the merchant for the account page.
country_code
string
The 2-digit country code.
splits_view
array
A list of splits. Nullable for Transactions Details.
order_view
object
7 properties
transaction_processor
string
The processor used. Nullable for Transactions Details.
street_address
string
You can use up to 4 street address fields.
i_currency
object
2 properties
gift_options_wrap
boolean
Defines whether gift wrapping was requested.
card_expiration
integer
The card's expiration. Nullable for Transactions Details.
merchant_division
object
28 properties
6 required
address
object
The Address object is used for billing, shipping, and physical store address use cases.
18 properties
8 required
credit_card_user
object
The credit card user.
5 properties
merchant_id
string
The unique ID for the merchant's Bolt account. A merchant account contains many merchant divisions. Nullable for Transactions Details.
locality
string
A locale such as county, district, etc.
custom_field_response_view
object
1 property
shipping_method
string
The name of the shipping method.
height
integer
The height.
in_store_cart_shipment
object
8 properties
consumer_summary_view
object
3 properties
manual_disputes
object
10 properties
amount_view
object
3 properties
auth_rejection_details_view
object
2 properties
1 required
capture_view
object
Deprecated. Use captures.
6 properties
error_bolt_api
object
Error object containing custom error information
2 properties
merchant_created_date
integer
The date the merchant account was created. Nullable for Transactions Details.
i_authorize_result_view
object
3 properties
i_cart_shipment_view
object
20 properties
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.
risk_review_status
string
Describes the current Risk Review status. A transaction could be unreviewed, reviewed, or pending manual review by the Bolt team.
i_cart_item_external_inputs
object
3 properties
order_decision_details_view
object
2 properties
fulfillment
object
Defines the shipments associated with the cart items.
5 properties
consumer_user_membership
object
Nullable for Transactions Details.
1 property
1 required
name_person
string
The first and last name together as a string.
risk_insight_availability.yml
boolean
Must be set to true to receive fraud insights.
reference
string
Reference for the object.
transaction_view
object
30 properties
merchant_division_summary_view
object
38 properties
transaction_review_view
object
4 properties
order_external_data_view
object
1 property
risk_model_result_view
object
1 property
transaction_rejection_details_view
object
1 property
phone
string
A phone number following E164 standards, in its globalized format, i.e. prepended with a plus sign.
card_token_type
string
Used to define which payment processor generated the token for this credit card.
cart_create
fulfillment_view
object
5 properties
address_change_view
object
5 properties
last_viewed_utc
integer
The last view time as UTC.
payment_service
string
merchant_hook_url
string
The endpoint URL provided by the merchant to send webhooks.
cart_item_customization
object
3 properties
transaction_operational_processor
object
2 properties
2 required
i_gift_option_view
object
2 properties
webhooks_type
string
[Webhook events](https://help.boltapp.com/developers/guides/webhooks/transaction-hook-types) that trigger a notification to the URL. Note:newslettersubscriptio…
eligible_payment_method
object
2 properties
risk_decision_factor.yml
string
One of the main contributing factors to the fraud decision and score.
custom_fields
object
10 properties
signature
string
The signature.
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…
card_id
string
The card's ID. Nullable for Transactions Details.
merchant_division_public_id
string
The unique public ID for one of the merchant's store division.
order_decision_score
integer
The total fraud risk score of the order.
phones_with_country_code
array
A list of phone numbers.
merchant_onboarding_status_code
string
merchant_product_info_url
string
The endpoint URL provided by the merchant for checking product details.
subscription
object
Describes a product added as a recurring subscription.
1 property
previous_subscription_id
stringnull
The unique ID associated with to the shopper's previous subscription-based transaction. Leave null for standard, non-subscription transactions.
service
string
The service name.
cart_fee
object
6 properties
5 required
package_dimension
object
Contains the package's width, eight, depth, and unit details.
4 properties
shipping_address_id
string
ID for billing address
transaction_id
string
The unique ID associated with the transaction. Nullable for Transactions Details.
merchant_division_description
string
The description of the merchant division. Nullable for Transactions Details.
gift_options
object
Contains the gift option settings for wrapping and custom messages.
2 properties
last_name
string
The person's last name.
auth_rejection_details
object
2 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…
errors_bolt_api
array
merchant_credit_card_authorization_recharge
object
This request is used for authorizing an existing, saved card associated with the account.
11 properties
6 required
credit_card_void_status
string
The status of the void request.
risk_fraud_probability.yml
integer
The total [fraud score](/merchants/references/policies/fraud-review/fraud-scoring).
user_identity
object
2 properties
merchant_division_logo_view
object
2 properties
card_last4
string
The card's last 4 digits. Nullable for Transactions Details.
transaction_credit
object
5 properties
3 required
weight_unit
string
The unit of measurement for an item's weight.
gift_options_message
string
Includes the gift message written by the shopper.
merchant_time_zone
string
The timezone of the merchant. Nullable for Transactions Details.
transaction_date
integer
Transaction date. Nullable for Transactions Details.
i_description_tooltip
object
2 properties
card_display_network
string
The card's network. Nullable for Transactions Details.
risk_model_external_result_view
object
4 properties
custom_field_full_response_view
object
2 properties
in_store_shipment
object
A cart that is being prepared for shipment
17 properties
amount
integer
The amount in cents. Nullable for Transactions Details.
tax_code
string
The relevant tax code.
priority
string
Describes the card's priority.
refund_transaction_ids
array
Nullable for Transactions Details.
merchant
object
8 properties
5 required
email_view
object
4 properties
in_store_shipment2
object
A cart that is being prepared for shipment
5 properties
merchant_oauth_redirect_url
string
The endpoint URL provided by the merchant for OAuth redirects.
merchant_division_logo
string
The logo image file for the merchant division.
risk_decision_factors.yml
array
The top 5 factors of the fraud decision.
merchant_universal_merchant_api_url
string
The endpoint URL provided by the merchant to access their universal API.
dimension_unit
string
The unit of measurement for an item's dimensions.
width
integer
The width.
package_weights
object
2 properties
amounts
object
The amount. Nullable for Transactions Details.
3 properties
3 required
collections
array
request_deadline
integer
merchant_get_account_url
string
The endpoint URL provided by the merchant to fetch accounts.
credit_card_authorization_status
string
The status of the authorization request. 1 - succeeded 2 - declined 3 - error
merchant_public_id
string
The unique public ID for the merchant's Bolt account. A merchant account contains many merchant divisions.
weight
integer
The weight of an item.
consumer_billing_address
object
16 properties
4 required
merchant_plugin_config_url
string
The endpoint URL provided by the merchant for checking plugin configuration details.
card_network
string
The card's network code. Nullable for Transactions Details. Note: LEGACY dinersclubusca now tagged as mastercard
i_cart_item_view
object
39 properties
risk_model_resul_contribution_view
object
2 properties
credit
object
1 property
manual_dispute_view
object
10 properties
request_failed
boolean
Indicates that the request failed. This value is always false.
package_type
string
The type of package.
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,…
collection
string
merchant_credit_card_authorization
object
This request is used for authorizing a new, unsaved card.
12 properties
7 required
chargeback_reason
string
The reason for the chargeback.
i_custom_field_view
object
11 properties
chargeback_details_view
object
10 properties
i_cart_discount_view
object
7 properties
capture_status
string
The status of the capture. Nullable for Transactions Details.
captures_view
array
All captures associated with the transaction. Nullable for Transactions Details.
chargeback_representment_reply_by_date
integer
The date of the chargeback.
total_weight
object
2 properties
merchant_privacy_policy_url
string
The endpoint URL provided by the merchant for providing a unique privacy policy.
email_status
string
This is the status of the contact method.
cart_add_on
object
A list of up to 3 add-ons that are displayed to the shopper.
6 properties
3 required
cart_shipment_type
string
The type corresponding to this shipment, if applicable.
merchant_variant_id
string
A merchant's unique ID for a given product's specific variant.
transaction_type
string
The type of transaction.
address_view
object
The address object returned in the response.
19 properties
merchant_validate_additional_account_data_url
string
The endpoint URL provided by the merchant for validating additional account data.
transaction_indemnification_reason
string
Describes the reason that the transaction is or is not indemnified by Bolt for fraud.
cart_item_gift_option
object
Contains the gift option settings for wrapping and custom messages.
4 properties
address_change_request_metadata_view
object
5 properties
errors_bolt_api_response
object
2 properties
credit_card_void_view
object
4 properties
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.
i_description_part
object
2 properties
credit_card_credit_status
object
1 property
currency_symbol
string
The currency symbol used for the amount. Nullable for Transactions Details.
transaction_processor_status
string
The processor's status. Only primary and active processor are displayed.
tax_amount
integer
Tax amount in cents.
transaction_operational_processors
array
Nullable for Transactions Details.
merchant_description
string
The description of the merchant account. Nullable for Transactions Details.
transaction_indemnification_decision
string
Describes whether the transaction is indemnified by Bolt for fraud.
emails
array
A list of email addresses. Nullable for Transactions Details.
email_priority
string
This is the priority of the contact method. This field's contents are not displayed in the transaction details view.
merchant_logo
object
2 properties
discount_membership
boolean
Defines if shopper has a membership discount.
email
string
An email address.
Specification
The full machine-readable OpenAPI contract behind this narrative.
Source
More from Bolt Financial 12
Other APIs Bolt Financial publishes across the network.
Bolt MCP Servers
Bolt Financial Account API
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 Webhooks API
#Transaction
Where this information came from
This is an independent, third-party profile of Bolt Financial Transactions 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.