List your own domains for the customer pages
Your hosts (pay.example.com) for checkout, offers and the customer portal, newest first, each with the two DNS records it needs and where it stands.
Required scope: brand.read (Read brand profile).
query Parameters
limitPage size (default 50, max 200)
cursorOpaque continuation token from the previous response's pagination.cursor. Omit for the first page. Cursors are stateless and do not expire, but are only valid for the list and filters that produced them.
Headers
X-Workspace-IdSelects the workspace this request operates in, by workspace UUID or slug (e.g. a sandbox workspace for test integrations). Omitted: the organization's default live workspace. Unknown workspace: 404; workspace outside your organization: 403. Discover workspaces via GET /workspaces.
Workspace UUID or slug.
List your own domains for the customer pages › Responses
OK
Add your own domain for the customer pages
Claims the host and answers the two DNS records to create: a CNAME to the platform and a TXT proving you hold the domain. The host is served once both are seen (POST /v1/custom-domains/{id}/check, or the hourly check). At most 5.
Required scope: brand.write (Manage brand profile).
Headers
Idempotency-KeyUnique key that makes this POST safe to retry: repeats with the same key replay the first response instead of re-executing. Replays are scoped to the retrying principal (same API key / user) and kept for 24 hours. Required on every POST.
Client-generated idempotency key (e.g. a UUID).
X-Workspace-IdSelects the workspace this request operates in, by workspace UUID or slug (e.g. a sandbox workspace for test integrations). Omitted: the organization's default live workspace. Unknown workspace: 404; workspace outside your organization: 403. Discover workspaces via GET /workspaces.
Workspace UUID or slug.
Add your own domain for the customer pages › Request Body
hostnameThe host your customers will see, e.g. pay.example.com. Not the bare domain your website runs on.
Add your own domain for the customer pages › Responses
Created
Remove a domain
The host stops being served at once; links go back to the platform's own host.
Required scope: brand.write (Manage brand profile).
path Parameters
idHeaders
X-Workspace-IdSelects the workspace this request operates in, by workspace UUID or slug (e.g. a sandbox workspace for test integrations). Omitted: the organization's default live workspace. Unknown workspace: 404; workspace outside your organization: 403. Discover workspaces via GET /workspaces.
Workspace UUID or slug.
Remove a domain › Responses
No Content
Check a domain's DNS records now
Required scope: brand.write (Manage brand profile).
path Parameters
idHeaders
Idempotency-KeyUnique key that makes this POST safe to retry: repeats with the same key replay the first response instead of re-executing. Replays are scoped to the retrying principal (same API key / user) and kept for 24 hours. Required on every POST.
Client-generated idempotency key (e.g. a UUID).
X-Workspace-IdSelects the workspace this request operates in, by workspace UUID or slug (e.g. a sandbox workspace for test integrations). Omitted: the organization's default live workspace. Unknown workspace: 404; workspace outside your organization: 403. Discover workspaces via GET /workspaces.
Workspace UUID or slug.
Check a domain's DNS records now › Responses
OK
List the origins that may embed the payment pages
The websites (scheme://host[:port]) whose pages may frame Kontier's embeddable payment pages (/embed/*), in origin order. Empty: embedded nowhere.
Required scope: brand.read (Read brand profile).
query Parameters
limitPage size (default 50, max 200)
cursorOpaque continuation token from the previous response's pagination.cursor. Omit for the first page. Cursors are stateless and do not expire, but are only valid for the list and filters that produced them.
Headers
X-Workspace-IdSelects the workspace this request operates in, by workspace UUID or slug (e.g. a sandbox workspace for test integrations). Omitted: the organization's default live workspace. Unknown workspace: 404; workspace outside your organization: 403. Discover workspaces via GET /workspaces.
Workspace UUID or slug.
List the origins that may embed the payment pages › Responses
OK
Replace the origins that may embed the payment pages
Replaces the list. Each origin is scheme://host[:port]: https, or http for localhost and 127.0.0.1 while you develop; no path, wildcard or query. The list becomes the embed pages' Content-Security-Policy frame-ancestors, so a browser refuses the pages inside any other site. At most 20. Answers the stored list, as GET does.
Required scope: brand.write (Manage brand profile).
Headers
X-Workspace-IdSelects the workspace this request operates in, by workspace UUID or slug (e.g. a sandbox workspace for test integrations). Omitted: the organization's default live workspace. Unknown workspace: 404; workspace outside your organization: 403. Discover workspaces via GET /workspaces.
Workspace UUID or slug.
Replace the origins that may embed the payment pages › Request Body
originsOrigins (scheme://host[:port]) whose pages may frame the /embed/* payment pages. Empty: embedded nowhere.
Replace the origins that may embed the payment pages › Responses
OK