API Reference

Checkout Page

Hosted payment page to create branded checkout sessions via API, with dashboard-managed styling, redirects, and shareable checkoutUrl for customer payments.

Checkout Page Integration Guide

Overview

Checkout Page allows you to create a hosted Brick payment page via API while managing branding and page behavior from the Brick Dashboard. This model separates operational concerns cleanly:

  • Use the API to create a checkout session and retrieve the checkoutUrl.
  • Use the Dashboard to configure the page title, colors, logo, redirect URLs, published key, and embed domain rules.

This guide is intended for merchants integrating Checkout Page into a web or mobile commerce flow.


Available Endpoints

  • Create Checkout Page Session — create a new checkout session
  • Get Checkout Status — retrieve the latest checkout status

When to Use Checkout Page

Checkout Page is appropriate when you want to:

  • launch a branded hosted payment page quickly
  • avoid building your own payment selection UI
  • support API-driven checkout creation with dashboard-managed branding
  • share a checkout link through web, chat, invoice, or customer support flows

Prerequisites

Before integrating, ensure that you have:

  1. A verified Brick account and an active dashboard.
  2. Sandbox or production API credentials from Configuration > API Credentials.
  3. The relevant callback URLs configured in the Dashboard.
  4. Checkout Page branding configured in Settings > Checkout.


📘

References