Brick API Documentation
Checkout Page

Checkout Page

Brick Checkout Page is a hosted payment page for Brick Receive Money. Your system creates a checkout session through API, Brick returns a checkoutUrl, and the customer uses that URL as a payment link to complete payment through the enabled payment flow.

Use Checkout Page when you need a hosted payment experience or payment link without building your own payment selection UI. The API creates the checkout session, while the Brick Dashboard manages branding, redirect URLs, published key settings, and embed domain rules.

What You Can Do With Checkout Page

  • Create a hosted checkout session through API.
  • Retrieve a shareable checkoutUrl payment link.
  • Configure page title, colors, logo, redirect URLs, published key, and embed domain rules from the Brick Dashboard.
  • Use checkout links in web, mobile, chat, invoice, customer support, or payment-request workflows.
  • Check the latest checkout session status.

How Checkout Page Works

Checkout Page separates API and dashboard responsibilities:

  • 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

FAQ

Is Checkout Page the same as a payment link?

Checkout Page is the hosted payment page product. The payment link is the checkoutUrl returned when your system creates a Checkout Page session.

Do I configure Checkout Page through API or Dashboard?

Use the API to create checkout sessions and retrieve checkoutUrl values. Use the Brick Dashboard to configure branding, redirect URLs, published key settings, and embed domain rules.


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

Last modified on
Same Day SettlementConfiguration and Implementation