Skip to Content
CheckoutAPI ReferenceSettingsOverview

Settings

Your merchant settings hold business configuration: business mode (test or live), per-chain signer status, checkout branding, and the addresses you need to integrate — including your PaymentFactory address (required to sign direct payments) and your settlement address.

These values are stable. Fetch them once and store them with your config. You can also view and manage them in your dashboard.

🔐

Settings endpoints require your secret API key. See Authorization for details.

Branding colors

Customize the hosted checkout and subscribe pages with your own colors via PATCH /settings:

FieldControls
background_colorPage background, card surface, and the header bar tint — all derived from this one hex color.
primary_colorButtons and other accent elements.

Each color applies independently — set one, both, or neither. Whichever is unset falls back to the platform default, and the header bar only takes on your background tint once background_color itself is set; otherwise it stays on the default. Foreground/text colors are chosen automatically for contrast against whatever background or primary color you pick — they aren’t separately configurable.

Colors are 6-digit hex strings including the leading # (e.g. #0f172a). Shorthand like #0f1 is rejected. Send null to reset a color back to the platform default. You can also set them from the dashboard’s Settings page, with a live preview.

Branding colors are set once on /settings and apply to both the one-shot checkout page and the subscribe page. They’re echoed back on the subscription checkout response so you can mirror your branding in your own UI. The one-shot checkout response doesn’t carry them, so read them from GET /settings instead.

Endpoints

Start building

XO

Request Demo

Schedule a call with our team

Select a product
Arrow right

Start building
Grateful

Contact Us

We're here to help