Bolt has moved to boltapp.com. Stores still using bolt.com hosts must update now: see the migration guide.

v1 Payments API
Step-by-step guide to the v1 payments API, which is still supported but will be deprecated.

Overview

This page outlines the steps to implement the v1 payments API. This integration is relevant for merchants for whom our modern Payments API is not suitable because they:

  • do not have an existing integration with a payment gateway
  • prefer to use Bolt’s transaction model
  • require certain payment features only supported by the v1 payments API

WARNING

Embeddable Checkout API v1 and v3 are interchangeable. New integrations should use v3; v1 is still supported but will be deprecated. See API V3 Implementation.

v1 Payments API

You should implement logic for each of the following use cases:

Use Case 1: Shopper with an Existing Bolt Account

If the shopper has an existing Bolt Account and your store has successfully accessed this Bolt Account details, use the MerchantCreditCardAuthorizationRecharge payload when interacting with the Authorize Payment API. This enables the store to leverage saved Bolt Account information via the address_id and credit_card_id.

This request must include the Bolt access token in order to attribute the payment to the existing Bolt shopper account.

Use Case 2: Shopper with an Existing Bolt Account Using a New Card

If the shopper has an existing Bolt Account and needs to use a new credit card for payment, use the MerchantCreditCardAuthorization payload when interacting with the Authorize Payment API.

This request must include the Bolt access token in order to add the new credit card to the existing Bolt shopper account.

Use Case 3: Shopper without an Existing Bolt Account

If the shopper wants to create a new Bolt Account, use the MerchantCreditCardAuthorization payload when interacting with the Authorize Payment API. This enables your store to input a new billing/shipping address, a credit card token to charge, and a create_bolt_account boolean that signals to Bolt that the shopper has elected to create a Bolt Account.

NOTE

In order to populate the create_bolt_account flag, make sure to have collected shopper consent via the Account Checkbox.