Bolt API Reference

Postman Collection:

About

A comprehensive Bolt API reference for interacting with Transactions, Orders, Product Catalog, Configuration, Testing, and much more.

Note: You must also reference the Merchant Callback API when building a managed checkout custom cart integration

Version: 1.0.1

/v1/account

GET
Get Account Details

Fetch a shopper’s account details to pre-fill checkout fields. This request must come from your backend for security purposes, as it requires the use of your private key to authenticate. For PCI compliance, only limited information is returned for each credit card available in the shopper’s wallet.

Security

  • OAuth [bolt.account.manage bolt.account.view]
  • X-API-Key []

Parameters

  • X-Publishable-Key (string - header)

    The publicly viewable identifier used to identify a merchant division. This key is found in the Developer > API section of the Bolt Merchant Dashboard [RECOMMENDED].

Responses

200 Account Details Fetched

object

  • addresses array

    A list of all addresses associated to the shopper’s account.

  • has_bolt_account boolean

    Used to determine whether a Bolt Account exists with this shopper’s account details.

  • payment_methods array

    A list of all payment methods associated to the shopper’s account.

  • profile
POST
Create Bolt Account

Create a Bolt shopping account.

Security

  • X-API-Key []

Parameters

  • X-Publishable-Key (string - header)

    The publicly viewable identifier used to identify a merchant division. This key is found in the Developer > API section of the Bolt Merchant Dashboard [RECOMMENDED].

  • Idempotency-Key (string - header)

    A key created by merchants that ensures POST and PATCH requests are only performed once. Read more about Idempotent Requests here.

Responses

200 Account Created

object

  • addresses array

    A list of all addresses associated to the shopper’s account.

  • has_bolt_account boolean

    Used to determine whether a Bolt Account exists with this shopper’s account details.

  • payment_methods array

    A list of all payment methods associated to the shopper’s account.

  • profile

/v1/account/addresses

POST
Add Address

Add an address to a shopper’s account address book.

Security

  • OAuth [bolt.account.manage]
  • X-API-Key []

Parameters

  • X-Publishable-Key (string - header)

    The publicly viewable identifier used to identify a merchant division. This key is found in the Developer > API section of the Bolt Merchant Dashboard [RECOMMENDED].

  • Idempotency-Key (string - header)

    A key created by merchants that ensures POST and PATCH requests are only performed once. Read more about Idempotent Requests here.

Responses

200 Address Added Successfully
This is a slice: [map[allOf:[map[$ref:#/components/schemas/address_view] map[properties:map[metadata:map[$ref:#/components/schemas/profile/properties/metadata]]]] description:The address object returned in the response. type:object] map[properties:map[default:map[type:boolean]] type:object]]

/v1/account/addresses/{id}

DELETE
Delete Address

Deletes an existing address in a shopper’s address book.

Security

  • OAuth [bolt.account.manage]
  • X-API-Key []

Parameters

  • id (string - path) required

    The ID for an address in the shopper’s Address Book.

  • X-Publishable-Key (string - header)

    The publicly viewable identifier used to identify a merchant division. This key is found in the Developer > API section of the Bolt Merchant Dashboard [RECOMMENDED].

Responses

200 Address Successfully Deleted
POST
Replace Address

Replace an existing address in a shopper’s address book. These changes delete the existing address and create a new one.

Security

  • OAuth [bolt.account.manage]
  • X-API-Key []

Parameters

  • id (string - path) required

    The ID for an address in the shopper’s Address Book.

  • X-Publishable-Key (string - header)

    The publicly viewable identifier used to identify a merchant division. This key is found in the Developer > API section of the Bolt Merchant Dashboard [RECOMMENDED].

  • Idempotency-Key (string - header)

    A key created by merchants that ensures POST and PATCH requests are only performed once. Read more about Idempotent Requests here.

Responses

200 Address Updated Successfully
This is a slice: [map[$ref:#/paths/~1v1~1account~1addresses/post/responses/200/content/application~1json/schema/allOf/0] map[properties:map[default:map[type:boolean]] type:object]]
PUT
Edit Address

Edit an existing address in a shopper’s address book. This endpoint fully replaces the information for an existing address while retaining the same address ID.

Security

  • OAuth [bolt.account.manage]
  • X-API-Key []

Parameters

  • id (string - path) required

    The ID for an address in the shopper’s Address Book.

  • X-Publishable-Key (string - header)

    The publicly viewable identifier used to identify a merchant division. This key is found in the Developer > API section of the Bolt Merchant Dashboard [RECOMMENDED].

Responses

200 Address Updated Successfully
This is a slice: [map[$ref:#/paths/~1v1~1account~1addresses/post/responses/200/content/application~1json/schema/allOf/0] map[properties:map[default:map[type:boolean]] type:object]]

/v1/account/exists

GET
Detect Account

Check whether an account exists using one of email, phone, or sha256_email as the unique identifier.

Parameters

  • email (string - query)

    The shopper’s email address is the primary mechanism for detecting an account. You must provide either a value for this parameter or for sha256_email.

  • sha256_email (string - query)

    The sha256 hash of the shopper’s normalized email address can be used to detect an account instead of email.

  • phone (string - query)

    The shopper’s phone number. Includes country code (e.g. +1); does not include dashes or spaces. Can be used to detect an account instead of sha256_email or email.

  • X-Publishable-Key (string - header) required

    The publicly viewable identifier used to identify a merchant division. This key is found in the Developer > API section of the Bolt Merchant Dashboard.

Responses

200 Has Bolt Account

object

  • has_bolt_account boolean
422 Missing Query Parameter

object

  • errors
  • result

/v1/account/payment_methods

POST
Add Payment Method

Add a payment method to a shopper’s Bolt account Wallet. For security purposes, this request must come from your backend because authentication requires the use of your private key.

Note: Before using this API, the credit card details must be tokenized using Bolt’s JavaScript library function, which is documented in Install the Bolt Tokenizer.

Security

  • OAuth [bolt.account.manage]
  • X-API-Key []

Parameters

  • X-Publishable-Key (string - header)

    The publicly viewable identifier used to identify a merchant division. This key is found in the Developer > API section of the Bolt Merchant Dashboard [RECOMMENDED].

  • Idempotency-Key (string - header)

    A key created by merchants that ensures POST and PATCH requests are only performed once. Read more about Idempotent Requests here.

Responses

200 Payment Method Added

object

  • billing_address
  • default boolean

    The default card payment method chosen by the shopper.

  • description string

    The APM account identifier; usually the email address.

  • exp_month integer

    The expiration month of the credit card.

    Examples: 11

  • exp_year integer

    The expiration year of the credit card.

    Examples: 2024

  • id string

    The ID of the payment method associated with the Shopper’s account.

  • last4
  • metadata
  • network
  • type string

    The payment method type. If empty, the property defaults to card.

    Enums: [card paypal]

/v1/account/payment_methods/{payment_method_id}

DELETE
Delete Payment Method

Delete a saved payment method from a shopper’s Bolt account Wallet.

Security

  • OAuth [bolt.account.manage]
  • X-API-Key []

Parameters

  • payment_method_id (path):

    The ID for a payment method in the shopper’s Bolt account Wallet. This ID can be obtained using Get Account Details.

  • X-Publishable-Key (string - header)

    The publicly viewable identifier used to identify a merchant division. This key is found in the Developer > API section of the Bolt Merchant Dashboard [RECOMMENDED].

Responses

200 Success
403 Forbidden

object

  • errors
  • result
404 Not Found

object

  • errors
  • result

/v1/account/profile

PATCH
Update Profile

Update the identifiers for a shopper’s profile (first name or last name).

Security

  • OAuth [bolt.account.manage]
  • X-API-Key []

Parameters

  • X-Publishable-Key (string - header)

    The publicly viewable identifier used to identify a merchant division. This key is found in the Developer > API section of the Bolt Merchant Dashboard [RECOMMENDED].

Responses

200 Profile Updated

object

  • email
  • first_name string

    The given name of the person associated with this record.

    Examples: Alan

  • last_name string

    The surname of the person associated with this record.

    Examples: Watts

  • metadata
  • name string

    The given and surname of the person associated with this address.

    Examples: Alan Watts

  • phone

/v1/catalog/custom/product

POST

Put Custom Product

Security

  • X-API-Key [X-API-Key]

Responses

200 Products Ingestion Successful
403
default

/v1/catalog/custom/store

POST

Put Custom Store

Security

  • X-API-Key [X-API-Key]

Responses

200 Store Ingestion Successful
403
default

/v1/merchant/callbacks

GET
Get Callback URLs

Retrieves callbacks URLs for a Bolt merchant division.

Security

  • X-API-Key []

Parameters

  • division_id (string - query) required

    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, phone order processing). You can view and switch between these divisions from the Bolt Merchant Dashboard.

Responses

200 Merchant Callbacks Retrieved

object

  • callback_urls array

    List of callback URLs retrieved

    Examples: [map[type:oauth_redirect url:https://example.com/1] map[type:oauth_logout url:https://example.com/2] map[type:get_account url:https://example.com/3]]

400
403
POST
Set Callback URLs

Configure callbacks URLs for a Bolt merchant division. This will store or override only the callback URLs that are specified in the request. Operations are fully transactional.

Security

  • X-API-Key []

Responses

200 Successfully sets callback URLs. No JSON schema is expected.
400
403
422 Request did not pass input validation. Check required fields are populated & meet input requirements.

object

  • errors
  • result

/v1/merchant/identifiers

GET
Get Merchant Identifiers

This endpoint returns the merchant’s public ID and the publishable key related to the merchant division.

Security

  • X-API-Key []

Responses

200 Merchant Identifiers Retrieved

object

  • merchant_divisions
  • merchant_id string

    The public ID of this merchant.

    Examples: 8fd9diIy59sj

  • signing_secret string

    Bolt generates one secret key per merchant and uses it to securely sign requests.

    Examples: xf833434fg2cffos92632aa6e1e4fc627a9385045gdj937fg2a127gi93cgos873

403

/v1/merchant/orders

POST
Create Order Token

Make a request to this endpoint to create a Bolt order, generate a Bolt order token, and initiate the checkout process. A Bolt order token is required for Bolt orders; see Non-Bolt orders for alternative use cases.

Security

  • X-API-Key []

Responses

200 Token Generation Successful

object

  • cart
  • dynamic_content
  • external_data
  • token string
  • user_note string

    Used by shoppers to make extra requests or provide details for gift messages.

400
403
422

/v1/merchant/statement

POST
Fetch a Statement

Get a pre-signed URL for the requested statement file.

Security

  • X-API-Key [X-API-Key]

Responses

200
403
404
422

/v1/merchant/track_shipment

POST
Send order tracking details

Send the carrier and order tracking number to Bolt (after a label has been printed). Bolt then uses EasyPost to forward ongoing tracking event updates to the shopper. This request must include all items included in the shipment; their references must also match those found in the original cart generation.

Security

  • X-API-Key [X-API-Key]

Responses

200
400
422 Generic Error Schema

object

  • errors
  • result

/v1/merchant/transactions/authorize

POST
Authorize a Card

This endpoint authorizes card payments and has three main use cases:

  • • Authorize a payment using an unsaved payment method for a guest or logged-in shopper.
  • • Authorize a payment using a saved payment method for a logged-in shopper.
  • • Re-charge a previous transaction using the credit_card_id of the transaction.

Security

  • OAuth []
  • X-API-Key []

Parameters

  • X-Publishable-Key (string - header)

    The publicly viewable identifier used to identify a merchant division. This key is found in the Developer > API section of the Bolt Merchant Dashboard [RECOMMENDED].

  • Idempotency-Key (string - header)

    A key created by merchants that ensures POST and PATCH requests are only performed once. Read more about Idempotent Requests here.

Responses

200 Authorization Successful

object

  • did_create_bolt_account boolean
  • order_number string
  • transaction

/v1/merchant/transactions/capture

POST
Capture a Transaction

This captures funds for the designated transaction. A capture can be done for any partial amount or for the total authorized amount.

Although the response returns the standard transaction_view object, only captures and either id or reference are needed.

Security

  • X-API-Key []

Parameters

Responses

200 Capture Successful

object

  • amount
  • authorization
  • capture object

    Deprecated. Use captures.

  • captures array
  • credit
  • date
  • from_consumer
  • from_credit_card
  • id
  • indemnification_decision
  • indemnification_reason
  • last4
  • last_viewed_utc number (int64)
  • merchant_division
  • merchant_order_number string
  • order_decision
  • processor
  • reference
  • review_ticket
  • risk_insights
  • risk_review_status string

    Describes the current Risk Review status. A transaction could be unreviewed, reviewed, or pending manual review by the Bolt team.

    Examples: reviewed

    Enums: [unknown needs_review reviewed]

  • risk_score integer (int64)
  • splits array
  • status
  • to_consumer
  • to_credit_card
  • transaction_properties object
  • type
  • view_status string

    Enums: [not_viewed viewed viewing]

  • void object
403
404
422 Unprocessable Entity
This is a map: map[errors:map[items:map[properties:map[code:map[example:1000001 type:number] field:map[example:transaction_id type:string] message:map[example:`TA8hLkJh4db4JJ` must be a valid public id of type transaction type:string]] type:object] type:array] result:map[type:object]]

/v1/merchant/transactions/credit

POST
Refund a Transaction

This refunds a captured transaction. Refunds can be done for any partial amount or for the total authorized amount. These refunds are processed synchronously and return information about the refunded transaction in the standard transaction_view object.

Security

  • X-API-Key []

Parameters

Responses

200 Refund Successful

object

  • amount
  • authorization
  • capture object

    Deprecated. Use captures.

  • captures array
  • credit
  • date
  • from_consumer
  • from_credit_card
  • id
  • indemnification_decision
  • indemnification_reason
  • last4
  • last_viewed_utc number (int64)
  • merchant_division
  • merchant_order_number string
  • order_decision
  • processor
  • reference
  • review_ticket
  • risk_insights
  • risk_review_status string

    Describes the current Risk Review status. A transaction could be unreviewed, reviewed, or pending manual review by the Bolt team.

    Examples: reviewed

    Enums: [unknown needs_review reviewed]

  • risk_score integer (int64)
  • splits array
  • status
  • to_consumer
  • to_credit_card
  • transaction_properties object
  • type
  • view_status string

    Enums: [not_viewed viewed viewing]

  • void object
422 Generic Error Schema

object

  • errors
  • result

/v1/merchant/transactions/review

POST
Review Transaction

This endpoint is used to manually approve or reject orders for a specified transaction.

Security

  • X-API-Key []

Parameters

Responses

200 Transaction Details Received

403
404
422

/v1/merchant/transactions/void

POST
Void a Transaction

This voids the authorization for a given transaction. Voids must be completed before the authorization is captured. In the request, either transaction_id or transaction_reference is required. Although the response returns the standard transaction_view object, only status and either id or reference are needed.

Security

  • X-API-Key []

Parameters

Responses

200 Void Successful

object

  • amount
  • authorization
  • capture object

    Deprecated. Use captures.

  • captures array
  • credit
  • date
  • from_consumer
  • from_credit_card
  • id
  • indemnification_decision
  • indemnification_reason
  • last4
  • last_viewed_utc number (int64)
  • merchant_division
  • merchant_order_number string
  • order_decision
  • processor
  • reference
  • review_ticket
  • risk_insights
  • risk_review_status string

    Describes the current Risk Review status. A transaction could be unreviewed, reviewed, or pending manual review by the Bolt team.

    Examples: reviewed

    Enums: [unknown needs_review reviewed]

  • risk_score integer (int64)
  • splits array
  • status
  • to_consumer
  • to_credit_card
  • transaction_properties object
  • type
  • view_status string

    Enums: [not_viewed viewed viewing]

  • void object
403
404

/v1/merchant/transactions/{REFERENCE}

GET
Transaction Details

This allows you to pull the full transaction details for a given transaction.

Note: All objects and fields marked required in the Transaction Details response are also nullable. This includes any sub-components (objects or fields) also marked required.

Security

  • X-API-Key []

Parameters

  • REFERENCE (string - path) required

    This is the Bolt transaction reference. (ex. N7Y3-NFKC-VFRF)

Responses

200
403
422
PATCH
Update a Transaction

This allows you to update certain transaction properties post-authorization.

Security

  • X-API-Key []

Parameters

  • REFERENCE (string - path) required

    This is the Bolt transaction reference. (ex. N7Y3-NFKC-VFRF)

  • Idempotency-Key (string - header)

    A key created by merchants that ensures POST and PATCH requests are only performed once. Read more about Idempotent Requests here.

Responses

200
403
404 Generic Error Schema

object

  • errors
  • result

/v1/oauth/token

POST
OAuth Token Endpoint

Endpoint for receiving access, ID, and refresh tokens from Bolt’s OAuth server.

To use this endpoint, first use the Authorization Code Request flow by using the authorization_code Grant Type (grant_type). Then, in the event that you would need a second or subsequent code, use the refresh_token value returned from a successful request as the refresh_token input value in your subsequent refresh_token Grant Type (grant_type) request.

Reminder - the Content-Type of this request must be application/x-www-form-urlencoded

Parameters

  • X-Publishable-Key (string - header)

    The publicly viewable identifier used to identify a merchant division. This key is found in the Developer > API section of the Bolt Merchant Dashboard [RECOMMENDED].

Responses

200 OAuth token response.

object

  • access_token string

    An access token you can use to make requests on behalf of a Bolt Account.

  • expires_in integer

    Access token’s expiration in seconds.

  • id_token string

    A JWT token issued when the request includes the scope open_id.

  • refresh_token string

    A refresh token you can use to issue a brand new access token without obtaining a new authorization code.

  • refresh_token_scope string

    The scope granted to the refresh token. Currently this will always be bolt.account.view.

  • scope string

    The scope granted to access token, depending on the scope granted to the authorization code as well as the scope parameter. Options include bolt.account.manage, bolt.account.view, openid.

  • token_type string

    The token_type will always be bearer.

400
403
422

/v1/payments

POST
Initialize Payment

Initialize a Bolt payment token that will be used to reference this payment to Bolt when it is updated or finalized. NOTE: The authorization header is NOT required for payments associated with users who do not have a Bolt account.

Security

  • OAuth [bolt.account.manage]
  • X-API-Key []

Parameters

  • X-Publishable-Key (string - header)

    The publicly viewable identifier used to identify a merchant division. This key is found in the Developer > API section of the Bolt Merchant Dashboard [RECOMMENDED].

  • Idempotency-Key (string - header)

    A key created by merchants that ensures POST and PATCH requests are only performed once. Read more about Idempotent Requests here.

Responses

200 Payment token retrieved.
This is a slice: [map[properties:map[id:map[description:The ID for a Payment Attempt type:string] status:map[description:The current payment status. enum:[awaiting_user_confirmation payment_ready success] type:string]] type:object]] This is a slice: [map[$ref:#/components/schemas/paypal_payment_view] map[$ref:#/components/schemas/saved_payment_view]]
403

/v1/payments/{id}

POST
Update Payment

Update a Bolt payment using the token given after initializing a payment. Updates will completely replace the original top-level resource (for example, if a cart is sent in with the request it will replace the existing cart). Any included object should be sent as complete object. NOTE: The authorization header is NOT required for payments associated with users who do not have a Bolt account.

Security

  • OAuth [bolt.account.manage]
  • X-API-Key []

Parameters

  • X-Publishable-Key (string - header)

    The publicly viewable identifier used to identify a merchant division. This key is found in the Developer > API section of the Bolt Merchant Dashboard [RECOMMENDED].

  • Idempotency-Key (string - header)

    A key created by merchants that ensures POST and PATCH requests are only performed once. Read more about Idempotent Requests here.

  • id (path):

    The ID received in the initial v1/payments request.

Responses

200 Payment updated.
This is a slice: [map[$ref:#/paths/~1v1~1payments/post/responses/200/content/application~1json/schema/allOf/0]] This is a slice: [map[$ref:#/components/schemas/paypal_payment_view] map[$ref:#/components/schemas/saved_payment_view]]
403

/v1/products/catalog

GET
Get Products Catalog

This endpoint returns a list of products when given a valid merchant_division_id.

Security

  • X-API-Key []

Parameters

  • X-Nonce (string - header) required

    Unique 12-16 digit for a publisher or product catalog request.

  • X-Publisher-Key (string - header) required

    Unique identifier for the publisher.

  • X-Authorization-Signature (string - header) required

    Generated signature after using the signing secret and nonce by the publisher.

  • MerchantDivisionPublicID (string - query) required

    The public ID for a given merchant division of your Bolt account.

  • limit (string - query)

    The maximum number of product results returned.

Responses

200 Product Catalogue Retrieved

object

  • Catalog array
  • Cursor string

/v1/remote_checkout/order

POST
Create order token (remote)

This is used for publisher implementation use cases. After calling Bolt to check product inventory for availability, call the /remote_checkout/order endpoint to create a Bolt order, generate a Bolt order token, and initiate the checkout process.

Security

  • X-API-Key []

Parameters

  • X-Nonce (string - header) required

    Unique 12-16 digit for a publisher or product catalog request.

  • X-Publisher-Key (string - header) required

    Unique identifier for the publisher.

  • X-Authorization-Signature (string - header) required

    Generated signature after using the signing secret and nonce by the publisher.

Responses

200 Order Created Successfully

object

  • token string
422 Order Creation Failed

object

  • errors
  • result

/v1/shipments/mock_bolt_shipping

POST
Test Shipping

This endpoint simulates tracking an order’s shipment and is for testing purposes only.

Security

  • X-API-Key []

Responses

200 Success - No Details
400 OrderTrackingTesting Generic Failure

object

  • errors
  • result
422 Unprocessable Entity

object

  • errors
  • result

/v1/testing/card_token

GET
Fetch a Test Credit Card Token

This endpoint fetches a new credit card token for Bolt’s universal test credit card number 4111 1111 1111 1004. This is for testing and is available only in sandbox.

Security

  • X-API-Key []

Responses

200 Successfully Fetched Credit Card Token
This is a map: map[bin:map[description:The credit card bin. example:411111 type:string] expiry:map[description:The date at which the token expires. A token must be used within 15 minutes of creation. example:1671140825305 type:integer] last4:map[description:The last 4 digits of the card number. example:1004 type:string] network:map[description:The credit card network. example:visa type:string] token:map[description:The newly generated credit card token. example:7i8322df93jsor663bsf02be798e672afd9360a81d203rc97778ff4bddedertg type:string]]

/v1/testing/shopper/create

POST
Create Testing Shopper Account

Create a Bolt shopper account for testing purposes. Available for sandbox use only and the created account will be recycled after a certain time.

Security

  • X-API-Key []

Parameters

  • X-Publishable-Key (string - header)

    The publicly viewable identifier used to identify a merchant division. This key is found in the Developer > API section of the Bolt Merchant Dashboard [RECOMMENDED].

Responses

200 Testing Account Created
This is a map: map[email:map[$ref:#/components/schemas/email description:The email of the testing account] email_state:map[$ref:#/paths/~1v1~1testing~1shopper~1create/post/requestBody/content/application~1json/schema/properties/email_state example:verified] migrated_merchant_owner_id:map[description:The merchant's public id if the account is migrated example:addvfRR_bp_7 type:string] oauth_code:map[description:OAuth code that is associated with this account and can be used to exchange for an access token example:7GSjMRSHs6Ak7C_zvVW6P2IhZOHxMK7HZKW1fMX85ms.-DUXvwr1Yg-bfvqXUlMaz49fPn7OdiPa3TwVBlUI-wc type:string] otp_code:map[description:Fixed OTP code that can be used to login to the created account example:123456 type:string] phone:map[$ref:#/components/schemas/phone description:The phone number of the testing account] phone_state:map[$ref:#/paths/~1v1~1testing~1shopper~1create/post/requestBody/content/application~1json/schema/properties/email_state example:unverified] will_deactivate_at:map[description:The created testing account will be deactivated after this date example:2023-06-01T23:16:07.000Z type:string]]

/v1/webhooks

GET
Query Webhooks

Find webhook configurations belonging to a merchant division. Results are limited to only show webhooks authorized by the X-API-Key.

Security

  • X-API-Key []

Parameters

  • division_id (string - query) required

    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, phone order processing). You can view and switch between these divisions from the Bolt Merchant Dashboard.

Responses

200 Success
This is a map: map[webhooks:map[items:map[$ref:#/components/schemas/webhook] type:array]]
400 BAD REQUEST. Request is malformed or invalid values are detected.

object

  • errors
  • result
403 FORBIDDEN. Not authorized to query webhook for this entity.

object

  • errors
  • result
404 NOT FOUND. Unable to find webhook.

object

  • errors
  • result
POST
Create Bolt Webhook

Create a new webhook to receive notifications from Bolt about various events, such as transaction status. Webhooks must have unique configuration.

Security

  • X-API-Key []

Responses

200 Success
This is a map: map[webhook_id:map[$ref:#/components/schemas/webhook_id]] This is a slice: [webhook_id]
400 BAD REQUEST. Request is malformed or invalid values are detected.

object

  • errors
  • result
403 FORBIDDEN. Not authorized to create a webhook for this entity.

object

  • errors
  • result
422 UNPROCESSABLE ENTITY. Not allowed to receive duplicate notifications. This is to safeguard a webhook listener from receiving duplicate events. Use GET /v1/webhooks and DELETE /v1/webhooks to check for and delete duplicate webhooks.

object

  • errors
  • result

/v1/webhooks/{webhook_id}

DELETE
Delete a Bolt Webhook

Delete a Bolt webhook. Provide an authorized X-API-Key to perform this action.

Security

  • X-API-Key []

Parameters

  • webhook_id (path):

    Webhook ID

Responses

200 Success
400 BAD REQUEST. Request is malformed or invalid values are detected.

object

  • errors
  • result
403 FORBIDDEN. Not authorized to perform the operation on this resource.

object

  • errors
  • result
404 NOT FOUND. Unable to find webhook.

object

  • errors
  • result
GET
Get Webhook

Get Webhook information by its Webhook ID. Results only include webhooks authorized by the X-API-Key.

Security

  • X-API-Key []

Parameters

  • webhook_id (path):

    Webhook ID

Responses

200 Success

object

  • created_at integer

    Webhook creation time in epoch timestamp milliseconds.

    Examples: 1485997169003

  • event_group
  • events array

    All events the webhook is subscribed to. Null when event_group = all.

  • url
  • webhook_id
400 BAD REQUEST. Request is malformed or invalid values are detected.

object

  • errors
  • result
403 FORBIDDEN. Not authorized to perform the operation on this resource.

object

  • errors
  • result
404 NOT FOUND. Unable to find webhook.

object

  • errors
  • result

v1/payments/{id}/finalize

POST
Finalize Payment

Finalize a Bolt Payment. NOTE: The authorization header is NOT required for payments associated with users who do not have a Bolt account.

Security

  • OAuth [bolt.account.manage]
  • X-API-Key []

Parameters

  • id (path):

    The ID received in the initial v1/payments request.

  • Idempotency-Key (string - header)

    A key created by merchants that ensures POST and PATCH requests are only performed once. Read more about Idempotent Requests here.

Responses

200 Payment Token Retrieved
This is a slice: [map[properties:map[id:map[description:The ID for the given Payment Attempt type:string] payment_method_id:map[description:ID of the payment method in Bolt's system, only if the payment method is saved. type:string] paypal:map[properties:map[email:map[$ref:#/components/schemas/email description:The email associated with the PayPal account used for this Payment.]] type:object] status:map[description:The current payment status. enum:[awaiting_user_confirmation payment_ready success] example:success type:string] transaction:map[properties:map[reference:map[description:The Bolt transaction reference (can be used to fetch transaction details, capture, void or refund transaction) example:GG8G-XPP6-BFQJ type:string]] type:object]] type:object]]
403

Components

1005_code
1005_invalid_merchant_key
code

message

1005_message
account_details
addresses array

A list of all addresses associated to the shopper's account.

has_bolt_account boolean

Used to determine whether a Bolt Account exists with this shopper's account details.

payment_methods array

A list of all payment methods associated to the shopper's account.

profile

account_login_status
address
company string

The company name associated with this address.

country string

The name of the country associated with this address.

country_code string

The ISO 3166-1 alpha-2 country code associated with this address.

default boolean

Whether the added address is now the default address.

door_code string

The building door code or community gate code.

email

The email address associated with this address.

first_name string

The given name of the person associated with this address.

last_name string

The surname of the person associated with this address.

locality string

The city name details associated with this address.

name string

The given and surname of the person associated with this address.

phone

The phone number associated with this address.

postal_code string

The the postal or zip code associated with this address.

region string

**Not Required for NON US addresses**. The region details such as state or province associated with this address.

region_code string

The ISO 3166-2 region code associated with this address. - * If specified, value must be valid for the `country`. - * If null, value is inferred from the `region`.

street_address1 string

The street number and street name of the address.

street_address2 string

Any apartment, floor, or unit details.

street_address3 string

Any additional street address details.

street_address4 string

Any additional street address details.

address_account
address_change
from_address

status

ticket_id

timestamp

to_address

address_change_id
address_change_request_metadata_view
can_change_shipping_address boolean

id string

status string

ticket_id string

ticket_status string

address_change_status
address_change_ticket_id
address_change_ticket_status
address_change_timestamp
address_change_view
from_address

status string

ticket_id string

timestamp number (int64)

to_address

address_view
company string

The company name associated with this address.

country string

The name of the country associated with this address.

country_code string

The ISO 3166-1 alpha-2 country code associated with this address.

door_code

email_address

The email address associated with this address.

first_name string

The given name of the person associated with this address.

id string

The unique Bolt ID associated with this address.

last_name string

The surname of the person associated with this address.

locality string

The city name details associated with this address.

name string

The given and surname of the person associated with this address.

phone_number

The phone number associated with this address.

postal_code string

The postal or zip code associated with this address.

region string

The region details such as state or province associated with this address.

region_code string

The the ISO 3166-2 region code associated with this address.

street_address1 string

The street number and street name of the address.

street_address2 string

Any apartment, floor, or unit details.

street_address3 string

Any additional street address details.

street_address4 string

Any additional street address details.

adjust_transaction
adjust_transaction_merchant
created_at

description

operational_processors

processor

public_id

time_zone

adjust_transactions
alliance_data_info
call_id string

amount
amount_view
amount number (int64)

currency string

currency_symbol string

amounts
amount

currency

currency_symbol

auth_rejection_details_view
reason_code string

reason_description string

authorization_id
authorization_reason_codes
authorization_reason_description
authorization_verification_status
authorize_external_outputs
commerce_cloud_order_uuid string

sfcc_response object

shopify_response

auto_approved
availability
availability_count
base_cart
add_ons array

billing_address

discounts array

fees array

fulfillments array

in_store_cart_shipments array

items array

The list of items associated with the cart.

loyalty_rewards array

shipments array

tax_amount number (int64)

The total tax amount for all of the items associated with the cart.

total_amount number (int64)

The total amount, in cents, of the cart including its items and taxes (if applicable), e.g. $9.00 is 900. This total must match the sum of all other amounts.

base_create_webhook
division_id string

The unique ID associated with the specific merchant division.

url

base_model
CreatedAt integer (timestamp)

DeactivatedAt integer (timestamp)

DeactivatedBy integer (int64)

ID integer (int64)

UpdatedAt integer (timestamp)

billing_address_id
block_listed
bolt_product_id
brand
can_change_shipping_address
capture
amount

id

splits array

A list of splits. **Nullable** for Transactions Details.

status

capture_id
capture_status
capture_transaction_with_reference
amount

currency

merchant_event_id

skip_hook_notification

transaction_reference

captures
card_address
company

country

country_code

email

first_name

id

last_name

locality

name

phone

postal_code

region

street_address1

card_bin
card_display_network
card_expiration
card_expiration_string
card_gift
card_number

pin

card_id
card_last4
card_network
card_number
card_priority
card_status
card_token
card_token_type
cards_gift
carrier
cart
billing_address

billing_address_id

items

tax_amount

total_amount

cart_add_on
description string

The description of the product being displayed as an add on.

imageUrl string

The URL of the image displayed for the add on product.

name string

The name of the product being displayed as an add on.

price number (int64)

The price of the product add on in cents (1/100).

productId string

The the ID of the product being displayed as an add on.

productPageUrl string

The URL to the product page of the product being displayed as an add on.

cart_create
cart_discount
amount number

code string

description string

Used to define the discount offering.

details_url string

Used to provide a link to additional details, such as a landing page, associated with the discount offering.

discount_category string

reference string

Used to define the reference ID associated with the discount available.

type string

The type of discount.

cart_discounts
billing_address

currency

discount_amount

discounts

display_id

items

order_reference

shipments

shipping_amount

subtotal_amount

tax_amount

total_amount

cart_item
brand string

category string

Used to define a product category associated with the item.

collections

color string

Used to define the color of the item.

customizations array

description string

details_url string

Used to provide a link to the item's product page.

external_inputs

gift_option object

Contains the gift option settings for wrapping and custom messages.

image_url string

Used to provide a link to the image associated with the item.

isbn string

Used to define the International Standard Book Number associated with the book.

item_group string

manufacturer string

Used to define the organization that manufactured the item.

merchant_product_id

merchant_variant_id string

A merchant's unique ID for a given product's specific variant.

msrp number (int64)

name string

options string

properties array

quantity number (int64)

reference string

shipment

shipment_type string

size string

Used to define the size of the item.

sku string

Used to define the alpha-numberic Stock Keeping Unit associated with the item as it is mapped to your internal product catalogue.

source string

tags string

Used to define a comma-separated list of tags associated with the item.

tax_amount number (int64)

The tax amount for the item; this value should scale with the quantity of units selected.

tax_code string

taxable boolean

total_amount number (int64)

The total amount, in cents, of the item including its taxes if applicable.

type string

unit_price number (int64)

The price of one unit of the item; for example, the price of one pack of socks.

uom string

Used to define the unit of measure used to describe the item.

upc string

Used to define the 12-digit Universal Product Code (a barcode) associated with the item worldwide.

weight number (int64)

weight_unit string

cart_item_customization
attributes object

name string

price

cart_item_property
color string

display boolean

name string

name_id number (int64)

value string

value_id number (int64)

cart_limited
billing_address

display_id

order_reference

shipments

cart_loyalty_rewards
amount number (int64)

The reward amount in cents (1/100).

coupon_code string

The loyalty reward's coupon code.

description string

A description of the loyalty reward that will be shown to the shopper.

details string

Internal-facing metadata for the Loyalty Rewards. Ideal for adding any other identifying information about the reward, including a duplication of the original loyalty reward json response from the loyalty provider as shown in the example provided. If you choose to use this field to hold json, enclose the content in single quotes to force a string value.

points number (int64)

The number of points needed for this reward.

source string

The loyalty rewards provider.

type string

The type of loyalty reward.

cart_order
billing_address

cart_url

currency object

discount_amount

discounts

display_id

in_store_shipments

items

merchant_order_url

metadata

order_description string

order_reference

shipments

shipping_amount

subtotal_amount

tax_amount

total_amount

transaction_reference

cart_order_generated
discounts

display_id

items

order_reference

total_amount

cart_publisher
Items

cart_shipment
carrier

cost

discounted_by_membership

estimated_delivery_date

expedited

package_depth

package_dimension_unit

package_height

package_type

package_weight_unit

package_width

service

shipping_address

shipping_address_id

shipping_method

signature

tax_amount

tax_code

total_weight integer

The total weight.

total_weight_unit

type

cart_shipment_combined
currency

display_id

items

metadata

order_reference

total_amount

cart_shipment_type
cart_shipments
cart_transaction_authorize
billing_address

currency

discounts

items

order_reference

shipments

tax_amount

total_amount

cart_transaction_recharge
currency

order_reference

total_amount

cart_url
cart_view
billing_address

cart_url string

Used to provide a link to the cart ID.

currency

discount_amount

discounts array

display_id string

fee_amount

fees array

fulfillments array

in_store_shipments

items array

loyalty_rewards array

loyalty_rewards_amount

merchant_order_url string

metadata object

msrp

order_description string

Used optionally to pass additional information like order numbers or other IDs as needed.

order_reference string

This value is used by Bolt as an external reference to a given order. This reference must be unique per successful transaction.

shipments array

shipping_amount

subtotal_amount

tax_amount

total_amount

transaction_reference string

The 12 digit reference ID associated to a given transaction webhook for an order.

catalog_view
Catalog array

Cursor string

category
chargeback_details
amt_won

chargeback_amt

chargeback_fee

chargeback_id

event_views array

net_amt

reason

reason_code

representment_reply_by_date

representment_result

chargeback_details_view
amt_won

chargeback_amt

chargeback_fee

chargeback_id string

event_views array

net_amt

reason string

reason_code string

representment_reply_by_date number (int64)

The reply-by date of the dispute in UnixMillis format.

representment_result string

chargeback_event_content
chargeback_event_time
chargeback_event_view
content string

time number

chargeback_id
chargeback_reason
chargeback_reason_code
chargeback_representment_reply_by_date
chargeback_representment_result
code
collection
collections
color
company
consumer_billing_address
company

country

country_code

email_address

first_name

id

last_name

locality

name

phone_number

postal_code

region

street_address1

street_address2

street_address3

street_address4

consumer_email_verified
consumer_id
consumer_membership_status
consumer_platform_account_status
consumer_self_view
consumer_summary_view
first_name string

The given name of the person associated with this record.

id string

last_name string

The surname of the person associated with this record.

consumer_user_membership
status

cost
country
country_code
create_account_input
addresses array

A list of physical shipping addresses associated with this account.

payment_methods array

A list of payment methods associated with this account.

profile

credit
status string

credit_card
billing_address

bin string

The Bank Identification Number for the credit card; this is typically the first 4-6 digits of the credit card number.

expiration string

The expiration date of the credit card.

last4 string

The last 4 digits of the credit card number.

postal_code string

Used for the postal or zip code associated with the credit card.

priority integer

Used to indicate the card's priority. '1' indicates primary, while '2' indicates a secondary card.

save boolean

Determines whether or not the credit card will be saved to the shopper's account. Defaults to `true`.

token string

The Bolt token associated to the credit card.

token_type string

Used to define which payment processor generated the token for this credit card; for those using Bolt's tokenizer, the value must be `bolt`.

credit_card_authorization_reason
credit_card_authorization_status
credit_card_authorization_view
auth string

avs_response string

cvv_response string

merchant_event_id

metadata object

processor string

reason

status

credit_card_capture_view
amount

id

merchant_event_id

metadata object

splits

status

credit_card_credit
Async boolean

CaptureID number (int64)

Credit string

CreditCardSettlementID number (int64)

CreditCardTransactionID number (int64)

MultirefundCreditID number (int64)

Status

credit_card_credit_status
status string

The status of the refund to a card.

credit_card_credit_view
credit_card_transaction
BaseModel

funding_instrument_id

ledger_id integer (int64)

The ID of the ledger.

ledger_time integer (date-time)

the time of the ledger.

stage

transaction_id

credit_card_transaction_stage
credit_card_user
emails

first_name

id

last_name

phones

credit_card_view
billing_address

bin

display_network

expiration

icon_asset_path

id

last4

network

priority

status

token

token_type

credit_card_void
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 enforce any uniqueness constraints on this ID. It is up to the merchant to generate identifiers that properly fulfill its needs.

skip_hook_notification

transaction_reference

credit_status
status string

This is the status of the refund.

currency
currency

currency_symbol

currency_iso
currency_symbol
custom_field_full_response_view
field

response

custom_field_response_view
response

custom_field_view
checkout_step string

context string

dynamic boolean

external_id string

field_setup string

label string

position number (int64)

public_id string

required boolean

subscribeToNewsletter boolean

custom_fields
checkout_setup string

context string

The app context of where the custom field is used.

dynamic boolean

Defines whether the field is dynamic.

external_id string

The external ID for the custom field.

field_setup string

label string

The displayed label for the custom field, seen by the shopper.

position integer

public_id string

The internal ID for the custom field.

required boolean

Defines if the field must be completed to check out.

subscribe_to_newsletter boolean

Defines whether the shopper is opted into a newsletter or not.

custom_fields2
customer_list_status
auto_approved boolean

block_listed boolean

customizations_name
data
data_error
reason

date
default
depth
description
dimension_unit
discount_category
discount_code
discount_codes
discount_currency
discount_description
discount_free_shipping
is_free_shipping

maximum_cost_allowed

discount_membership
discount_reference
discount_type
discount_uri
discounts
discounts_order_generate
discounts_transaction_authorize
display_id
distance
distance_unit
email
email_id
email_priority
email_status
email_view
address string

id string

priority

status string

emails
error
code

message

error_base_response
error

event

status string

error_bolt_api
code

message

errors
errors_base_response
errors array

event

status string

errors_bolt_api
errors_bolt_api_response
errors

result

errors_oauth_server_response
error string

error_description string

estimated_delivery_date
event
event_group_create_webhook
event_group

events_array_create_webhook
events array

If `webhook_event_group` is null, pick a list of notification events to subscribe to.

expedited
external_data
shopify

first_name
from_consumer
email_verified

emails

first_name

id string

The card-holder's ID. **Nullable** for Transactions Details.

last_name

phones

platform_account_status

user_membership

from_credit_card
billing_address

bin

display_network

expiration

icon_asset_path

id

last4

network

priority

status

token_type

funding_instrument_id
gift_option_view
hide_gift_message boolean

hide_gift_wrap boolean

gift_options
message

wrap

gift_options_message
gift_options_wrap
gtin
has_bolt_account
has_dynamic_price
height
hide_apm
hide_apms
hosted_payments_response
x_account_id string

x_amount string

x_currency string

x_gateway_reference string

x_message string

x_reference string

x_result string

x_signature string

x_test string

x_timestamp string

i_authorize_result_view
did_create_bolt_account boolean

order_number string

transaction

i_cart_discount_view
amount

code string

Discount code used.

description string

Used to define the discount offering.

details_url string

Used to provide a link to additional details, such as a landing page, associated with the discount offering.

discount_category string

free_shipping

reference string

Used to define the reference ID associated with the discount available.

i_cart_item_external_inputs
shopify_line_item_reference number (int64)

shopify_product_reference number (int64)

shopify_product_variant_reference number (int64)

i_cart_item_view
bolt_product_id string

brand string

category string

Used to define a product category associated with the item.

collections

color string

Used to define the color of the item.

customizations array

description string

details_url string

Used to provide a link to the item's product page.

gift_option

hide boolean

image_url string

Used to provide a link to the image associated with the item.

isbn string

Used to define the International Standard Book Number associated with the book.

item_group string

manufacturer string

Used to define the organization that manufactured the item.

merchant_product_id string

merchant_variant_id string

msrp

name string

options string

properties array

quantity number (int64)

reference string

shipment_id string

shipment_type string

shopify_line_item_reference number (int64)

shopify_product_reference number (int64)

shopify_product_variant_reference number (int64)

size string

Used to define the size of the item.

sku string

Used to define an alpha-numeric Stock Keeping Unit associated with the item as it is mapped to your internal product catalogue.

subscription

tags string

Used to define a comma-separated list of tags associated with the item.

tax_amount

taxable boolean

total_amount

type string

unit_price

uom string

Used to define the unit of measure used to describe the product.

upc string

Used to define the 12-digit Universal Product Code (a barcode) associated with the item worldwide.

weight

i_cart_shipment_view
carrier string

The carrier used to deliver the shipment.

cost

default boolean

description array

description_tooltips array

estimated_delivery_date string (date-time)

expedited boolean

Used to determine whether a shipment has been expedited or not.

gift_options

id string

package_dimension object

package_type string

package_weight

reference string

service string

shipping_address

shipping_method string

signature string

tax_amount

total_weight

type string

i_cart_view
billing_address

cart_url string

Used to provide a link to the cart ID.

currency

discount_amount

discounts array

display_id string

fee_amount

fees array

items array

merchant_order_url string

order_description string

Used optionally to pass additional information like order numbers or other IDs as needed.

order_reference string

This value is used by Bolt as an external reference to a given order. This reference must be unique per successful transaction.

shipments array

shipping_amount

subtotal_amount

tax_amount

total_amount

transaction_reference string

The 12 digit reference ID associated to a given transaction webhook for an order.

i_currency
currency string

currency_symbol string

i_custom_field_view
checkout_step string

context string

dynamic boolean

external_id string

field_setup string

helper_text string

label string

position number (int64)

public_id string

required boolean

subscribeToNewsletter boolean

i_delivery_options
dynamicContent

inStorePickupOptions array

shipToStoreOptions array

shippingOptions array

i_description_part
content string

is_html boolean

i_description_tooltip
html_content string

target number (int64)

i_free_shipping_discount_view
is_free_shipping boolean

maximum_cost_allowed number (int64)

i_gift_option_view
hide_gift_message boolean

hide_gift_wrap boolean

i_order_dynamic_content
custom_fields array

eligible_payment_methods array

gift_option_view

hide_apm array

order_notice string

payment_notice string

shipping_info_notice string

shipping_notice string

i_order_external_data
steam_id string

i_order_metadata
encrypted_user_id string

i_order_view
cart

dynamic_content

external_data

token string

user_note string

Used by shoppers to make extra requests or provide details for gift messages.

i_remote_order_create
cart object

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, phone order processing). You can view and switch between these divisions from the Bolt Merchant Dashboard.

platform_user_id string

(Currently for creating remote orders in SFCC). A registered customer's ID / number to be on the order.

i_remote_order_result
token string

i_store_shipment_view
i_subscription_frequency_view
type string

value number (int64)

i_weight
unit string

weight number (int64)

icon_asset_path
image_url
in_store_cart_shipment
cart_shipment

description string

Shipment option description.

distance number (float64)

distance_unit string

in_store_pickup_address

pickup_window_close integer (date)

pickup_window_open integer (date)

store_name string

The local store's name where the item can be picked up.

in_store_shipment
carrier

cost

default

estimated_delivery_date

expedited

gift_options

id

package_dimension

package_type

package_weights

reference

service

shipping_address

shipping_method

signature

tax_amount

total_weight

in_store_shipment2
address

distance number

distance_unit string

shipment

store_name string

in_store_shipments
indemnification_decision
indemnification_reason
is_free_shipping
isbn
item
bolt_product_id

brand

category

collections

color

customizations array

description

details_url string

The URL for the item's details.

image_url

isbn

item_group

manufacturer

name

options

properties

quantity

reference

shipment_type

size

sku

tags

tax_amount

taxable

total_amount

type

unit_price

uom string

upc string

weight

item_add
currency

price

product_id

quantity

item_description
item_group
item_properties
item_property
name string

value string

item_remove
product_id

quantity

item_shipment_type
items
items_add
items_remove
last_name
last_viewed_utc
locality
login_view
actions array

methods array

sso_authorization_url string

magento_payment_request
card

consumer_id string

The unique ID associated with the shopper. Leave `null` for guest checkout payment authorizations.

credit_card_id string

The unique ID associated to a saved credit card in the account's wallet. Leave `null` if inputting a new, unsaved card.

order_token string

manual_dispute_view
amount number (int64)

currency string

delivery_evidence string

dispute_evidence string

other_evidence array

reason string

status string

manual_disputes
amount

currency

delivery_evidence string

dispute_evidence string

other_evidence string

reason string

status string

manual_disputes_array
manufacturer
maximum_cost_allowed
media_audios
media_urls
media_videos
merchant
created_at

description

onboarding_status

operational_processors

processor

public_id

status

time_zone

merchant_account_page_url
merchant_callback_url_type
merchant_callbacks_input
callback_urls array

List of callback URLs to configure

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, phone order processing). Use the Bolt Merchant Dashboard to switch between divisions and find the division ID under `Merchant Division Public ID`.

merchant_callbacks_view
callback_urls array

List of callback URLs retrieved

merchant_create_order_url
merchant_created_date
merchant_credit_card_authorization
auto_capture boolean

cart

create_bolt_account boolean

If `true`, the guest shopper is provided a Bolt Account using their email address as its unique ID; if `false`, no information is saved at checkout.

credit_card

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, phone order processing). Use the Bolt Merchant Dashboard to switch between divisions and find the division ID under `Merchant Division Public ID`.

merchant_event_id

previous_transaction_id

processing_initiator string

Determines who initiated the transaction (e.g. shopper, merchant) and how they did it (e.g. recurring subscription, on-file card). * `initial_card_on_file` - The first transaction made for a card. The system then saves this card for future transactions. * `initial_recurring` - The first time any card is used to pay for a recurring charge. For example, a subscription. * `stored_cardholder_initiated` - The subsequent (second, third, etc.) transactions a shopper initiates with a stored card. This includes every situation during which a cardholder requests a charge, for example if the cardholder requests a merchant charge their card. * `stored_merchant_initiated` - The subsequent (second, third, etc.) transactions a merchant initiates with a stored card only when the cardholder does not request the charge. For example, when a customer service representative buys on behalf of a shopper or when a business adds funds to a public transit card. * `following_recurring` - The subsequent (second, third, etc.) transactions a card is used to pay for a recurring charge. For example, a subscription. * `cardholder_initiated` - When a cardholder begins a transaction that isn’t stored in Bolt and won’t be stored in Bolt for future transactions. * `recurring` - Any time a card is used to pay for a recurring charge (for example, a subscription). Only use this value when you don’t know if it’s the first recurring charge.

shipping_address

source string

user_identifier

user_identity

merchant_credit_card_authorization_recharge
auto_capture boolean

cart

credit_card_id string

The unique ID associated to the saved credit card in the account's wallet.

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, phone order processing). Use the Bolt Merchant Dashboard to switch between divisions and find the division ID under `Merchant Division Public ID`.

merchant_event_id

previous_transaction_id

processing_initiator

shipping_address

source string

user_identifier

user_identity

merchant_credit_card_review
decision string

transaction_reference

merchant_debug_url
merchant_description
merchant_division
account_page_url

api_base_domain_url string

create_order_url string

The endpoint URL provided by the merchant to Bolt for creating orders. **Nullable** for Transactions Details.

debug_url

description

get_account_url

hook_type

hook_url

id

is_universal_merchant_api boolean

Defines whether or not the Universal API method is in use. **Nullable** for Transactions Details.

is_webhooks_v2 boolean

Defines whether or not the second version of Bolt's webhooks is in use. **Nullable** for Transactions Details.

logo

merchant_id

oauth_logout_url

oauth_redirect_url

platform

plugin_config_url

privacy_policy_url

product_info_url

public_id

shipping_and_tax_url string

The endpoint URL provided by the merchant to Bolt for shipping and tax calculations.

shipping_url string

The endpoint URL provided by the merchant to Bolt for shipping calculations. **Nullable** for Transactions Details.

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.

tax_url string

The endpoint URL provided by the merchant to Bolt for tax calculations. **Nullable** for Transactions Details.

terms_of_service_url

universal_merchant_api_url

update_cart_url string

The endpoint URL provided by the merchant to Bolt to pass cart updates.

validate_additional_account_data_url

merchant_division_description
merchant_division_domain
merchant_division_id
merchant_division_logo
merchant_division_logo_view
domain string

resource string

merchant_division_public_id
merchant_division_summary_view
account_page_url string

api_base_domain_url string

base_domain_url string

confirmation_redirect_url string

create_order_url string

debug_url string

description string

display_name string

get_account_url string

hook_type string

hook_url string

id string

is_universal_merchant_api boolean

is_webhooks_v2 boolean

logo

logo_dashboard

merchant_id string

merchant_password_login_url string

(Optional) Link shoppers can use to log into a merchant store via the Bolt SSO modal.

mobile_app_domain_url string

oauth_logout_url string

oauth_redirect_url string

platform string

plugin_config_url string

privacy_policy_url string

product_info_url string

public_id string

remote_apiurl string

shipping_and_tax_url string

shipping_url string

shopper_custom_fields_updated_url string

status string

tax_url string

terms_of_service_url string

universal_merchant_api_url string

update_cart_url string

use_async_refunds_amazon_pay boolean

use_async_refunds_paypal boolean

validate_additional_account_data_url string

merchant_divisions_identifiers_view
merchant_get_account_url
merchant_hook_url
merchant_id
merchant_identifiers_view
merchant_divisions

merchant_id string

The public ID of this merchant.

signing_secret string

Bolt generates one secret key per merchant and uses it to securely sign requests.

merchant_logo
domain

resource

merchant_oauth_logout_url
merchant_oauth_redirect_url
merchant_onboarding_status_code
merchant_order_number
merchant_platform
merchant_plugin_config_url
merchant_privacy_policy_url
merchant_processor_linked
merchant_product_id
merchant_product_info_url
merchant_public_id
merchant_status
merchant_terms_of_service_url
merchant_time_zone
merchant_universal_merchant_api_url
merchant_validate_additional_account_data_url
merchant_view
created_at string

description string

processor string

message
metadata
metadata_component
key1 string

key2 string

mock_tracking_input
delivery_estimate string

status string

The shipment status of a simulated order.

tracking_detail array

A list of tracking updates that contain the shipment's status, location, and any unique messages.

tracking_number string

The carrier's tracking number for the shipment (Order Tracking Testing). Must begin with `MockBolt`.

multimedia
name_item
name_person
name_store
o_auth_token_input
client_id string

Merchant publishable key which can be found in the merchant dashboard

client_secret string

Your Bolt API Key.

code string

Fetched value using OTP value from the Authorization Modal.

grant_type string

The type of OAuth 2.0 grant being utilized. The value will always be `authorization_code` when exchanging an authorization code for an access token.

scope string

The scope issued to the merchant when receiving an authorization code. Options include `bolt.account.manage`, `bolt.account.view`, `openid`. You can find more information on these options in our [OAuth scope documentation](https://help.bolt.com/developers/references/bolt-oauth/#scopes).

state string

A randomly generated string issued to the merchant when receiving an authorization code used to prevent CSRF attacks

o_auth_token_input_refresh
client_id string

Merchant publishable key which can be found in the merchant dashboard

client_secret string

Your Bolt API Key.

grant_type string

The type of OAuth 2.0 grant being utilized. The value will always be `refresh_token` when exchanging a refresh token for an access token.

refresh_token string

The value of the refresh token issued to you in the originating OAuth token request.

scope string

The scope issued to the merchant when receiving an authorization code. Options include `bolt.account.manage`, `bolt.account.view`, `openid`.

state string

A randomly generated string issued to the merchant when receiving an authorization code used to prevent CSRF attacks

o_auth_token_response
access_token string

An access token you can use to make requests on behalf of a Bolt Account.

expires_in integer

Access token’s expiration in seconds.

id_token string

A JWT token issued when the request includes the scope open_id.

refresh_token string

A refresh token you can use to issue a brand new access token without obtaining a new authorization code.

refresh_token_scope string

The scope granted to the refresh token. Currently this will always be bolt.account.view.

scope string

The scope granted to access token, depending on the scope granted to the authorization code as well as the scope parameter. Options include `bolt.account.manage`, `bolt.account.view`, `openid`.

token_type string

The token_type will always be bearer.

options
order
cart

dynamic_content object

Contains all dynamic content fields.

external_data

token

user_note

order_create
cart

channel string

Used to determine the channel from which the order was created.

create_cart_on_merchant_backend boolean

Used to determine whether the order is created on your backend platform. This should almost always be `false`.

metadata

user_note string

Optionally used by shoppers to make extra requests or provide details for gift messages.

order_create_cart
cart_url

currency

discounts

display_id

items

metadata array

order_reference

total_amount

order_decision
decision_factors

score

order_decision_details_view
decision_factors array

score number (int64)

order_decision_score
order_display_id
order_external_data_view
shopify string

order_generate_cart
cart_url

currency

discounts

items

metadata

order_reference

total_amount

order_non_bolt
order_publisher_cart_order_shipping_address
order_publisher_cart_shipment
cost

reference

service

shipping_address object

shipping_method

tax_amount

order_publisher_cart_shipments
order_publisher_item
bolt_product_id

description

image_url

name

properties

quantity

reference

sku

tax_amount

taxable

total_amount

type

unit_price

order_publisher_items
order_received_url
order_reference
order_status_details
order_status_type
order_token
order_tracking_number
order_url
order_view
cart

dynamic_content

external_data

platform_user_id string

requires_action string

token string

user_note string

Used by shoppers to make extra requests or provide details for gift messages.

order_webhook
cart object

metadata

status

order_webhook_metadata
immutable_quote_id integer

The immutable quote ID.

package_dimension
depth

height

unit

width

package_type
package_weights
unit

weight

payment_method
payment_method_data

payment_method_provider string

payment_method_account
paypal_payment_input_initialize
payment_method object

paypal_payment_input_update
payment_method object

paypal_payment_view
action object

Action after initializing payment

phone
phone_country_code
phone_id
phone_priority
phone_status
phone_view
country_code string

Used for the 2-digit ISO 3166-1 alpha 2 country code associated with this address.

id string

number string

priority string

status string

phones
phones_with_country_code
pickup_address
country

country_code

locality

postal_code

region

street_address1

street_address2

street_address3

street_address4

pickup_option
address

cost

distance

distance_unit

pickup_window_close

pickup_window_open

reference

signature

store_name

tax_amount

pickup_options
pickup_window_close
pickup_window_open
pin
postal_code
previous_subscription_id
previous_transaction_id
price
priority
processing_initiator
processor_card_token
processor_shopper_reference
processor_token_alias
product
Availability

AvailabilityCount

BoltID

Brand

Description

Identifiers

IsVariantOf

ItemType

Multimedia object

The media files associated to the product.

Name

Prices

Properties

Taxable

product_id
product_identifiers
GTIN

MerchantDivisionID

MerchantProductID

SKU

product_identifiers_view
GTIN string

The Global Trade Item Number for this product; GTINs are used as barcodes.

MerchantDivisionID 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, phone order processing). You can view and switch between these divisions from the Bolt Merchant Dashboard.

MerchantProductID string

MerchantVariantID string

SKU string

Used to define the alpha-numberic Stock Keeping Unit associated with the item as it is mapped to your internal product catalogue.

product_inventory
Current

NextCursor

Parent

Variants

product_inventory_view
Current

NextCursor string

Parent

Properties array

Variants array

product_media_audio
product_media_url
product_media_video
product_metadata
ImageURL

Position

TextLabel

product_name
product_name_id
product_next_cursor
product_price
Currency

UnitPriceInCents

product_prices
product_properties
product_properties_array
product_properties_map_view
name string

nameID string

values

product_property_name
product_property_name_id
product_property_position
product_property_text_label
product_property_value
product_property_value_id
product_value
product_value_id
product_variant
product_view
Availability string

AvailabilityCount number (int64)

BoltID string

Brand string

Description string

Identifiers

Multimedia object

Name string

Prices array

products
profile
email

The email of the person associated with this profile.

first_name string

The given name of the person associated with this record.

last_name string

The surname of the person associated with this record.

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. Keys can be up to 40 characters long and values can be up to 500 characters long. Metadata should not contain any sensitive customer information, like PII (Personally Identifiable Information). For more information about metadata, see our [documentation](https://help.bolt.com/developers/references/embedded-metadata/).

phone

The phone number of the person associated with this profile.

profile_view
email

first_name string

The given name of the person associated with this record.

last_name string

The surname of the person associated with this record.

metadata

name string

The given and surname of the person associated with this address.

phone

properties
property1 string

property2 string

property_metadata_view
ImageURL string

Position number (int)

TextLabel string

property_value_view
Metadata

Value string

ValueID string

publisher_item
BoltProductID

Properties

Quantity

SKU

publisher_items
publisher_order_metadata
key object

Map Item.

publisher_properties
NameID

ValueID

quantity
rate_shipping
rate_subtotal
reason
reference
refund_results
capture_to_refund

cc_transaction

credit_status_to_update

credit_to_refund

error

refund_id

refund_transaction

retriable boolean

Specifies if the system can retry the refund upon encountering an error.

refund_transaction
amount

authorization

capture

captures

credit

date

from_consumer

from_credit_card

id

indemnification_decision

indemnification_reason

last4

last_viewed_utc

merchant

merchant_division

merchant_order_number

order_decision

processor

reference

review_ticket

risk_insights

splits

status

to_consumer

to_credit_card

transaction_properties

type

refund_transaction_ids
refund_transactions
refundable_capture
amount

capture_id

currency

external_capture_id string

An external ID that can be sent to a third-party system.

region
request_deadline
request_failed
request_id
request_result
success

request_source
request_status
requested_refund_amount
review
date integer

decision string

risk_model_result

source string

review_ticket
id

request_deadline

status

review_ticket_view
id string

request_deadline number (int64)

status string

risk_decision_factor.yml
risk_decision_factors.yml
risk_fraud_probability.yml
risk_insight_availability.yml
risk_insights.yml
available

decision_factors

fraud_probability

payment_instrument_factors object

risk_model_contribution
category string

Internal categories for risk analysis.

weight string

risk_model_contributions
risk_model_external_result_view
available boolean

decision_factors array

Used to list a total of up to 5 decision factors used by the risk model to determine the risk analysis result.

fraud_probability number (int)

payment_instrument_factors object

risk_model_resul_contribution_view
category string

weight string

risk_model_result
contributions

risk_model_result_view
contribution array

risk_payment_instrument_factors.yml
avs string

cvv string

saved_credit_card_view
billing_address

default boolean

The default card payment method chosen by the shopper.

description string

The APM account identifier; usually the email address.

exp_month integer

The expiration month of the credit card.

exp_year integer

The expiration year of the credit card.

id string

The ID of the payment method associated with the Shopper's account.

last4

metadata

network

type string

The payment method type. If empty, the property defaults to `card`.

saved_payment_input_initialize
payment_method object

saved_payment_input_update
payment_method object

saved_payment_view
action object

Action after initializing payment

saved_paypal_account_view
description string

The email associated with a shopper's saved PayPal account.

id string

The ID of the payment method associated with the Shopper's account.

metadata

type string

Type field indicates this is a saved PayPal to differentiate it from a saved card.

service
shipment
carrier

cost

default

estimated_delivery_date

expedited

gift_options

id

package_dimension

package_type

package_weights

reference

service

shipping_address

shipping_method

signature

tax_amount

total_weight

shipments
shipments2
shipping_address
company

country

country_code

email

first_name

id

last_name

locality

name

phone

postal_code

region

street_address1

street_address2

street_address3

street_address4

shipping_address_id
shipping_carrier
shipping_default
shipping_method
shipping_option
cost

default

description

description_tooltips

discount_by_membership

estimated_delivery_date

reference

service

signature

tax_amount

tax_code

shipping_option_combined
cost

estimated_delivery_date

reference

service

signature

tax_amount

tax_code

shipping_option_description
shipping_option_description_tooltip
html_content

target

shipping_option_description_tooltip_content
shipping_option_description_tooltip_target
shipping_option_description_tooltips
shipping_options
shipping_options_combined
shipping_to_store_option
address

cost

distance

distance_unit

reference

service

signature

store_name

tax_amount

shipping_to_store_options
shopify
signature
size
sku
source
source_transaction
amount

authorization

capture

captures

credit

date

from_consumer

from_credit_card

indemnification_decision

indemnification_reason

merchant

merchant_division

merchant_order_number

order_decision

processor

reference

review_ticket

splits

status

to_consumer

to_credit_card

transaction_properties

type

splits
statements_date
statements_file_type
statements_type
statements_url
status
street_address
subscription
frequency object

Describes how often the subscription recurs.

tag
tags
tax_amount
tax_code
tax_result
items

rate_shipping

rate_subtotal

subtotal_amount

taxable
timeline
timeline_consumer
first_name

id

last_name

timeline_date
timeline_event
address_change

amount

consumer

date

note

review

transaction

type

visibility

timeline_note
timeline_transaction
amount

authorization

capture

captures

credit

date

from_consumer

from_credit_card

id

indemnification_decision

indemnification_reason

last4

last_viewed_utc

merchant

merchant_division

merchant_order_number

order_decision

processor

reference

review_ticket

risk_insights

splits

status

to_consumer

to_credit_card

transaction_properties

type

timeline_type
timeline_visibility
total_amount
total_refund_amount
total_weight
unit

weight

tracking_detail
city string

country string

datetime string (date-time)

message string

state string

status string

The transit status of the order being tracked.

zip string

transaction
transaction_auth_address
company string

The company name associated with this address.

country string

The name of the country associated with this address.

country_code string

The ISO 3166-1 alpha-2 country code associated with this address.

default boolean

Whether the added address is now the default address.

email

The email of the person associated with this address.

first_name string

The given name of the person associated with this address.

last_name string

The surname of the person associated with this address.

locality string

The city name details associated with this address.

name string

The given and surname of the person associated with this address.

phone

The phone number associated with this address.

postal_code string

The postal or zip code associated with this address.

region string

**Not Required for NON US addresses**. The region details such as state or province associated with this address.

region_code string

The ISO 3166-2 region code associated with this address. - * If specified, value must be valid for the `country`. - * If null, value is inferred from the `region`.

street_address1 string

The street number and street name of the address.

street_address2 string

Any apartment, floor, or unit details.

street_address3 string

Any additional street address details.

street_address4 string

Any additional street address details.

transaction_authorization
auth string

avs_response string

cvv_response string

metadata object

The metadata associated with the authorization.

processor

reason

status

transaction_custom_fields
field

response string

transaction_custom_fields_array
transaction_date
transaction_decision
transaction_details_view
transaction_from_credit_card
display_network

id

last4

network

transaction_from_user
emails

first_name

id

last_name

phones

transaction_id
transaction_indemnification_decision
transaction_indemnification_reason
transaction_indemnification_status
transaction_operational_processor
processor

status

transaction_operational_processors
transaction_processor
transaction_processor_status
transaction_properties
avs_result string

cvv_result string

transaction_publisher_from_credit_card.yml
display_network

id

last4

network

transaction_publisher_item
description

image_url

name

properties

quantity

reference

sku

taxable

total_amount

type

unit_price

transaction_publisher_items
transaction_publisher_refund_transactions
transaction_recharged
amount

authorization

date

from_consumer

from_credit_card

id

indemnification_decision

indemnification_reason

merchant

merchant_division

processor

reference

splits

status

to_consumer

type

transaction_reference
transaction_review_view
date number (int64)

decision string

risk_model_result

source string

transaction_reviewed
amount

authorization

captures array

A list of captures.

date

from_consumer

from_credit_card

id

indemnification_decision

indemnification_reason

merchant

merchant_division

processor

reference

risk_insights

status

to_consumer

type

transaction_skip_hook_notification
transaction_splits_view
amount

type string

transaction_status
transaction_timeline_view
address_change

amount

consumer

date number

note string

review

transaction

type string

visibility string

transaction_type
transaction_view
amount

authorization

capture object

Deprecated. Use `captures`.

captures array

credit

date

from_consumer

from_credit_card

id

indemnification_decision

indemnification_reason

last4

last_viewed_utc number (int64)

merchant_division

merchant_order_number string

order_decision

processor

reference

review_ticket

risk_insights

risk_review_status string

Describes the current Risk Review status. A transaction could be unreviewed, reviewed, or pending manual review by the Bolt team.

risk_score integer (int64)

splits array

status

to_consumer

to_credit_card

transaction_properties object

type

view_status string

void object

type
unit_price
url
user_identifier
artifact string

email

The Shopper's email address that is used as a unique ID for the account. This email can be used to detect an account using the `/v1/account/exists` endpoint.

email_id string

The ID associated with the identifying email address for this account.

phone

The Shopper's phone number that is used to help identify the account owner. This can be passed with the `user_identifier.email` to find and match accounts.

phone_id string

The ID associated with the identifying phone number for this account.

user_identity
first_name

last_name

user_note
v1_accounts_view
has_bolt_account boolean

variants
webhook
created_at integer

Webhook creation time in epoch timestamp milliseconds.

event_group

events array

All events the webhook is subscribed to. Null when `event_group` = `all`.

url

webhook_id

webhook_event_group
webhook_id
webhooks_object
webhooks_type
weight
weight_unit
width