Skip to content
/
Brink Commerce
Last updated

Get started with Kustom Checkout for Brink Commerce

Introduction

For Brink Commerce merchants, Kustom Checkout is integrated via the Brink API. The checkout flow is API-driven and requires backend implementation to create and manage Kustom orders.

Before you begin

Make sure you have:

  • An active Brink Commerce environment
  • API access to the Brink Retail API / Shopper API
  • A Kustom Merchant Account: Apply for an agreement with Kustom by filling out the onboarding form at kustom.co via the Get started option (top right corner)
  • Company registration and bank details (for KYC verification)

1. Obtain Kustom API credentials

Before implementing the checkout flow, retrieve your credentials from the Kustom Merchant Portal:

  • Merchant ID
  • API username
  • API password

These credentials are required to authenticate API calls.

2. Create a Kustom Checkout order

In Brink Commerce, checkout is initiated via the Shopper API.

During checkout, your backend must:

  • Collect cart data
  • Calculate totals (including tax, shipping, discounts)
  • Create a Kustom order via the relevant API endpoint
  • Receive the checkout URL or client token

The Kustom order request must include:

  • Order amount (in minor units)
  • Currency
  • Order lines (products, shipping, discounts)
  • Customer information
  • Billing and shipping details
  • Merchant URLs (confirmation, notification, cancellation)

Once the order is successfully created, Kustom returns a checkout session that should be rendered to the shopper.

3. Redirect or embed the checkout

After creating the order:

  • Redirect the customer to the Kustom-hosted checkout page
    or
  • Render the checkout snippet in your frontend (depending on integration type)

The shopper completes the payment within the Kustom Checkout interface.

4. Handle order confirmation

When the payment is completed:

  • The customer is redirected back to your confirmation URL
  • A server-to-server notification is sent to your backend
  • The order should be finalized in Brink

Important:
Always validate the payment status with Kustom before marking the order as paid.

5. Complete KYC verification

Before going live, ensure that KYC verification has been completed in the Kustom Merchant Portal.

This typically includes:

  • Company registration documents
  • Beneficial owner information
  • Bank account details

Kustom must approve the account before production payments can be processed.

Verify that the integration is working

Before launching in production:

  • Create a test order
  • Complete a test payment

Verify:

  • The checkout loads correctly
  • Payment status is returned correctly
  • Order confirmation works
  • Notifications are received

Test both success and failure scenarios.

Automated payment processing

After activation:

  • Payments are authorized and captured via Kustom
  • Refunds are managed in the Kustom Merchant Portal
  • Payouts are transferred to your registered bank account
  • Order status updates should be synced between Kustom and Brink via API

Support

Previous page
Next page