Skip to main content

Getting Started

This guide includes instructions for installing and configuring Bold Checkout on a development store.

Install Bold Checkout​

To call the Checkout APIs, you must have the Bold Checkout app installed on your store. The installation process varies slightly based on your store's platform. Refer to the following guides for more information and instructions:

note

Bold Checkout is called Bold Cashier on Shopify. Bold Cashier is only available to merchants who installed the app prior to January 20, 2020. New enterprise customers can submit a request to Shopify to use Bold Cashier. Please reach out to our Customer Success team for more information.

Enable development mode​

Complete the following steps to turn on development mode, which enables you to process test transactions.

  1. In the Bold Checkout admin, navigate to Payment Options > Payment Gateways.
  2. Switch the Development mode toggle to On. Developer mode screenshot
  3. Configure a development payment gateway. Payments are not captured for orders submitted while the store is in development mode.
  4. If you are using any of the following scenarios, submit a support request:
    1. If you are not using Spreedly as a payment gateway, you must submit a support request. Bold Checkout uses Spreedly to provide a test payment gateway. For most other gateways, including those in development mode, Bold Checkout requires that you provide a credit card. This card will not be charged when the store is in development mode. However, if your store will be used exclusively for development, submit a support request to request that the credit card requirement is waived for your store.
    2. If you create a password-protected development store on Shopify, you must also include the storefront password in your support request. Production stores do not require this step.

Add all domains to CORS allowlist​

The Bold Checkout APIs are protected by a restrictive Cross-Origin Resource Sharing (CORS) policy, which blocks frontend JavaScript code from calling the APIs.

You must manually add your domain to CORS allowlist if you are self-hosting your checkout or using a custom domain for your checkout page. Failing to do so causes in errors from your browser or a failure of your browser to load the checkout frontend.

note

If your store has Bold Checkout installed and is in development mode, it is automatically added to the CORS allowlist and you do not need to manually add it to the allowlist.

Next steps​

Complete the steps outlined in the Making API Calls guide to make your first API call.