Overview
- GET /v1/account/exists
- GET /v1/account
- POST /v1/account
- POST /v1/account/addresses
- POST /v1/account/addresses/{id}
- PARAMETERS /v1/account/addresses/{id}
- DELETE /v1/account/addresses/{ID}
- PARAMETERS /v1/account/addresses/{ID}
- POST /v1/account/payment_methods
- POST /v1/oauth/token
- GET /.well-known/openid-configuration
- POST /v1/merchant/transactions/authorize
- POST /v1/merchant/transactions/capture
- POST /v1/merchant/transactions/credit
- POST /v1/merchant/transactions/void
- [[#get-v1merchanttransactionsbolt-transaction-reference|GET /v1/merchant/transactions/
]] - POST /v1/testing/shopper/create
- GET /v1/testing/card_token
- GET /v1/webhooks
- POST /v1/webhooks
- GET /v1/webhooks/{webhook_id}
- DELETE /v1/webhooks/{webhook_id}
- PARAMETERS /v1/webhooks/{webhook_id}
- GET /v1/merchant/callbacks
- POST /v1/merchant/callbacks
- GET /v1/merchant/identifiers
- POST /v1/merchant/orders
GET /v1/account/exists
Summary: Detect Account
Check whether an account exists using email or sha256_email as the unique identifier. This can be called directly from the browser.
OpenAPI snippet URL
GET /v1/account
Summary: 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.
Required Variables
oauth_access_token:
An active OAuth access token. Obtain an access token from the Authorization Code Request under the OAuth folder. You will need a shopper’s Authorization Code to receive this token.
Testing: For testing purposes, the Create Test Shopper Account request will provide a mechanism to get this value. (Only in Sandbox)
OpenAPI snippet URL
POST /v1/account
Summary: Create Bolt Account
Creates a Bolt shopper account. A payment method must be included.
Required Variables
shopper_email & shopper_phone:
The email and phone of the Shopper whose Bolt Account is being created. To create a new account these identifiers must be unclaimed by an existing account.
Testing: For testing purposes, the Get Unused Shopper Account Identifiers request will provide a mechanism to get these values. (Only in Sandbox)
credit_card_token:
An active credit card token for the payment method being attached to the new shopper account.
Testing: For testing purposes, the Create a Test Credit Card Token request will provide a mechanism to get these values. (Only in Sandbox)
The required variables are the minimum initial values necessary to get a request working. It is expected that you will add/modify more parameters throughout the integration process.
OpenAPI snippet URL
POST /v1/account/addresses
Summary: Add Address
Add an address to a shopper’s account address book.
Required Variables
oauth_access_token:
An active OAuth access token. Obtain an access token from the Authorization Code Request under the OAuth folder. You will need a shopper’s Authorization Code to receive this token.
Testing: For testing purposes, the Create Test Shopper Account request will provide a mechanism to get this value. (Only in Sandbox)
shopper_email & shopper_phone:
The email and phone attached to the new shipping address in the shopper’s address book.
The required variables are the minimum initial values necessary to get a request working. It is expected that you will add/modify more parameters throughout the integration process.
OpenAPI snippet URL
POST /v1/account/addresses/{id}
Summary: Edit Address
Edit an existing address in a shopper’s address book. These changes replace the existing address.
Required Variables
oauth_access_token:
An active OAuth access token. Obtain an access token from the Authorization Code Request under the OAuth folder. You will need a shopper’s Authorization Code to receive this token.
Testing: For testing purposes, the Create Test Shopper Account request will provide a mechanism to get this value. (Only in Sandbox)
shopper_email & shopper_phone:
The email and phone attached to the new shipping address in the shopper’s address book.
ID:
The address ID of the shopper address you are deleting. You receive this value in the GET Account Details request.
The required variables are the minimum initial values necessary to get a request working. It is expected that you will add/modify more parameters throughout the integration process.
OpenAPI snippet URL
PARAMETERS /v1/account/addresses/{id}
OpenAPI snippet URL
DELETE /v1/account/addresses/{ID}
Summary: Delete Address
Deletes an existing address in a shopper’s address book.
Required Variables
oauth_access_token:
An active OAuth access token. Obtain an access token from the Authorization Code Request under the OAuth folder. You will need a shopper’s Authorization Code to receive this token.
Testing: For testing purposes, the Create Test Shopper Account request will provide a mechanism to get this value. (Only in Sandbox)
ID:
The address ID of the shopper address you are deleting. You receive this value in the GET Account Details request.
OpenAPI snippet URL
PARAMETERS /v1/account/addresses/{ID}
OpenAPI snippet URL
POST /v1/account/payment_methods
Summary: 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 API key.
Required Variables
oauth_access_token:
An active OAuth access token. Obtain an access token from the Authorization Code Request under the OAuth folder. You will need a shopper’s Authorization Code to receive this token.
Testing: For testing purposes, the Create Test Shopper Account request will provide a mechanism to get this value. (Only in Sandbox)
shopper_email & shopper_phone:
The email and phone attached to the billing address in the shopper’s address book.
credit_card_token:
An active credit card token for the payment method being attached to the shopper’s account.
Testing: For testing purposes, the Create a Test Credit Card Token request will provide a mechanism to get these values. (Only in Sandbox)
The required variables are the minimum initial values necessary to get a request working. It is expected that you will add/modify more parameters throughout the integration process.
OpenAPI snippet URL
POST /v1/oauth/token
Summary: Get Access Token with OAuth Code
Get an access token, id token, and refresh token from an Authorization Code.
Required Variables
authorization_code:
Provide a shopper Authorization Code to exchange for an access_token.
Testing: For testing purposes, the Create Test Shopper Account request will provide a mechanism to get this value. (Only in Sandbox)
OpenAPI snippet URL
GET /.well-known/openid-configuration
Summary: OpenID Configuration
OpenID Configuration
OpenAPI snippet URL
POST /v1/merchant/transactions/authorize
Summary: Authorize New Card
Authorize a payment using an unsaved payment method.
Required Variables
credit_card_token:
An active credit card token for the payment method being attached to the new shopper account.
Testing: For testing purposes, the Create a Test Credit Card Token request will provide a mechanism to get these values. (Only in Sandbox)
shopper_email & shopper_phone:
The email and phone of the shopper placing the transaction. If create_bolt_account is set to true, these must not be attached to a current account for account creation to succeed.
Testing: For testing purposes, the Get Unused Shopper Account Identifiers request will provide a mechanism to get unique values for these. (Only in Sandbox)
The required variables are the minimum initial values necessary to get a request working. It is expected that you will add/modify more parameters throughout the integration process.
OpenAPI snippet URL
POST /v1/merchant/transactions/capture
Summary: 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.
Required Variables
transaction_reference:
The reference identifier of the transaction your want to capture.
Note: A transaction must be in the authorized state for it to be eligible for capture. To view, a transaction’s status use the Fetch Transaction Details endpoint.
OpenAPI snippet URL
POST /v1/merchant/transactions/credit
Summary: 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 response object.
Note: At Bolt a refund denotes a new transaction. The original payment transaction is considered the source_transaction of the refund.
Required Variables
transaction_reference:
The reference identifier of the transaction your want to refund.
Note: A transaction must be in the completed state for it to be eligible for a refund. To view, a transaction’s status use the Fetch Transaction Details endpoint.
OpenAPI snippet URL
POST /v1/merchant/transactions/void
Summary: Void a Transaction
This voids the authorization for a given transaction. Voids must be completed before the authorization is captured.
Required Variables
transaction_reference:
The reference identifier of the transaction your want to void.
Note: A transaction cannot be in the completed state for it to be eligible for a void. To view, a transaction’s status use the Fetch Transaction Details endpoint.
OpenAPI snippet URL
GET /v1/merchant/transactions/
Summary: Fetch Transactions Details
This allows you to pull detailed transaction information for a given transaction reference.
Required Variables
transaction_reference:
The reference identifier for a given transaction.
OpenAPI snippet URL
POST /v1/testing/shopper/create
Summary: Create a Test Shopper Account (Random Email/Phone, Fixed OTP, and OAuth Code)
Create a Bolt shopper account for testing purposes - available for sandbox use only. The API will provide:
- A unique phone number and email pairing that does not collide with other existing accounts.
- A fixed OTP code that can be used to log in to the Bolt authentication modal.
- An authorization code that can be used to exchange for an OAuth access token. Certain account-related APIs will require an access token.
OpenAPI snippet URL
GET /v1/testing/card_token
Summary: Create a Test Credit Card Token
Creates a credit card token from Bolt’s universal test credit card number (4111 1111 1111 1004) - available for sandbox use only. This mimics the behavior of Bolt’s tokenization SDK or hosted payment fields.
-
Short-term credit card tokens are active for 15 minutes and are single-use.
-
The credit card token will be returned in the response under the token field.
OpenAPI snippet URL
GET /v1/webhooks
Summary: Query Webhook Endpoints
Find webhook configurations belonging to a merchant division. Results are limited to only show webhooks authorized by the X-API-Key.
OpenAPI snippet URL
POST /v1/webhooks
Summary: Create a Webhook Endpoint
Create a new webhook to receive notifications from Bolt about various events, such as transaction status. Webhooks must have a unique configuration.
Required Variables
webhook_url:
The endpoint path subscribed to receive Bolt webhook events.
OpenAPI snippet URL
GET /v1/webhooks/{webhook_id}
Summary: Get Webhook Endpoint By ID
Get a webhook endpoint by ID.
Required Variables
webhook_id:
The webhook URL UUID returned by the Create a Webhook Endpoint request.
OpenAPI snippet URL
DELETE /v1/webhooks/{webhook_id}
Summary: Delete Webhook Endpoint
Delete a webhook endpoint by ID.
Required Variables
webhook_id:
The webhook URL UUID returned by the Create a Webhook Endpoint request.
OpenAPI snippet URL
PARAMETERS /v1/webhooks/{webhook_id}
OpenAPI snippet URL
GET /v1/merchant/callbacks
Summary: Get Callback URLs
Retrieves callbacks URLs for a Bolt merchant division.
OpenAPI snippet URL
POST /v1/merchant/callbacks
Summary: 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.
Required Variables
url:
The endpoint path Bolt will send callback requests to.
The required variables are the minimum initial values necessary to get a request working. It is expected that you will add/modify more parameters throughout the integration process. For example, you don’t need to set every callback URL or you may have different URLs per callback type.
OpenAPI snippet URL
GET /v1/merchant/identifiers
Summary: Get Merchant Identifiers
This endpoint returns public identifiers for a Bolt merchant account and corresponding merchant divisions.
OpenAPI snippet URL
POST /v1/merchant/orders
Summary: Create Order Token
API for creating a Bolt order token with supplied cart information.
Required Variables
shopper_email & shopper_phone:
The shopper email and phone attached to this new Bolt order token.
The required variables are the minimum initial values necessary to get a request working. It is expected that you will add/modify more parameters throughout the integration process.
OpenAPI snippet URL