BRICK CHECKOUT PAGE
Accept more payment methods. Let Brick host checkout.
Create each session through your backend API while Brick hosts the payment interface for QRIS, virtual account, and supported e-wallet payments.
Companies using Brick
OUR SOLUTION
One API-created session,
one hosted payment experience.
Your backend drives session creation through the API. Brick hosts the payment interface, while branding, redirects, callbacks, and page settings remain manageable from the Brick Dashboard.
Your Backend Controls
Transaction-specific session logic — handled entirely from your backend code.
- Generate a public access token per session
- Create a checkout session via API — receive a checkoutUrl
- Redirect or share the checkoutUrl with your customer
- Store the transaction referenceId for reconciliation
- Receive payment callbacks to your configured webhook
- Check status anytime via the Checkout Status endpoint
Brick Dashboard Controls
Merchant-level configuration managed from Settings › Checkout — no code changes needed.
- Page title, primary color, font color & family
- Logo URL and favicon
- Success URL and Failed URL (redirect after payment)
- Receipt delivery (email and WhatsApp)
- Published Key for frontend initialization
- Allowed domains for embedded checkout flows
HOW BRICK CHECKOUT PAGE WORKS
Configure once. Create sessions per transaction.
-
01
Configure in Dashboard
Set branding, redirect URLs, and receipt settings once in Settings › Checkout. These apply to every checkout session going forward.
-
02
Create a Session via API
Your backend generates a public access token, then calls the Create Checkout Page Session endpoint. Receive a checkoutUrl in response.
-
03
Share & Receive Callback
Redirect your customer to the checkoutUrl or share it via chat, invoice, or support. Brick sends a real-time callback when payment completes.
USE CASES
Examples of Using Brick Checkout Page
Create a checkout session for each payment, then direct customers to Brick's hosted page from your website, chat, invoice, or support flow.
Web Commerce
Redirect buyers to Brick Checkout after order confirmation. No custom payment UI — Brick handles the full selection and confirmation experience.
Chat & Messaging
Share a checkoutUrl directly in WhatsApp, Telegram, or in-app chat. Customers pay without leaving their conversation context.
Invoice Payments
Embed or link a checkout session in digital invoices. Customers pay on their own time — Brick handles status tracking and callbacks automatically.
Customer Support
Support agents can generate and share a checkout link on the spot — no engineering involvement needed per transaction.
OUR SOLUTION
Two endpoints.
Complete checkout flow.
Checkout Page is powered by two endpoints. Use Create Checkout Page Session to generate each transaction's checkout URL, and Checkout Status to retrieve payment state at any time — in addition to the real-time callback.
Create Checkout Page Session
Generate a new checkout session for a transaction. Returns a checkoutUrl to redirect or share with the customer.
Get Checkout Status
Retrieve the latest payment status for a checkout session. Use alongside callbacks for complete status coverage.
# Checkout Page uses different credentials
# for different layers of the integration
Published Key
Loads merchant checkout config (safe for frontend)
Client ID + Client Secret
Used to generate a publicAccessToken
publicAccessToken
Authorizes Create Session & Checkout Status
⚠ Never expose Client Secret in frontend code
Use redirect URLs for UX only — always rely
on callbacks for payment confirmation
See full details in Configuration & Implementation
PREREQUISITES
What you need before integrating.
Ensure these are in place before calling the Checkout Page API in production.
Verified Brick Account + Active Dashboard
A completed KYB (Know Your Business) verification and an active Brick Dashboard account. Production API access is only enabled after KYB approval.
→ Configuration › Verify Your Account (KYB)API Credentials (Sandbox or Production)
Your Client ID and Client Secret from Configuration › API Credentials. Credentials are environment-specific and cannot be mixed between sandbox and production.
→ Configuration › API CredentialsCallback URLs Configured in Dashboard
The relevant callback URLs must be set in your Brick Dashboard before going live. Payment confirmation should always rely on callbacks — not redirect URLs alone.
→ Configuration › Callback URLCheckout Page Branding Configured
Set your page title, brand colors, logo, and redirect URLs in Settings › Checkout before creating your first session. These apply to all sessions until changed.
→ Settings › CheckoutPayment confirmation matters
Payments reach your Brick account balance after the settlement time is fulfilled. Redirect URLs are for the customer experience only. Confirm payment status through callbacks or the Checkout Status endpoint.
BENEFIT
Benefits of Using Brick Checkout Page
Create a hosted checkout experience, share each payment link, and confirm the outcome through Brick.
Launch without building a payment UI
Brick hosts the checkout experience while your backend creates each payment session through the API.
Manage branding in Dashboard
Set your page title, colors, logo, and redirect URLs in Settings › Checkout.
Share checkout links anywhere
Use the checkoutUrl on your website, in chat, on invoices, or in support flows.
Confirm payments with callbacks
Use Brick callbacks as the source of truth, and check session status when needed.
Keep credentials on your backend
Create sessions server-side and keep your Client ID and Client Secret out of frontend code.
Track every checkout session
Store your externalId and Brick transaction ID to match callbacks and verify payment status.
Integration resources
Plan your Checkout Page integration
Review the API reference and integration documentation, then use the registration guide to prepare for account onboarding.
READY TO START
Build your first checkout session
Checkout Page becomes available after your Brick account is verified and active. Talk to sales or create an account to get started.