Skip to content

Checkout Domains

Checkout Domains directory showing one domain entry with Checkout Page, API Hostname, Description, Primary, Sandbox, and Sandbox IP Whitelist columns

Checkout Domains defines the hostnames from which a brand's checkout can be accessed. Each domain entry maps a fully qualified domain name to its role — production primary, sandbox, or additional — and controls which IP addresses are permitted to access sandbox domains.

Permissions

ActionPermission required
Manage checkout domainstenant:update:domains

Directory columns

ColumnDescription
IDInternal domain identifier
Checkout PageThe hostname served by the client-facing checkout UI
API HostnameThe fully qualified domain name (FQDN) configured for this entry
DescriptionOptional notes about the domain's purpose
PrimaryWhether this is the brand's main public API domain
SandboxWhether this domain is for sandbox/testing use only
Sandbox IP WhitelistIP addresses or CIDR ranges permitted to access this sandbox domain

Created At and Updated At columns are available but hidden by default — use the column picker to show them.

Row actions

ActionDescription
EditUpdate the domain's configuration
DeleteRemove the domain entry

Adding a domain

Add New Domain dialog showing the FQDN field, Description textarea, Primary toggle off, and Sandbox toggle off

Click Add Domain to open the creation form.

FieldRequiredDescription
FQDNYesThe fully qualified domain name (e.g. checkout.example.com)
DescriptionNoA note describing the domain's purpose
PrimaryNoToggle on if this is the main public API domain for this brand
SandboxNoToggle on if this domain is for sandbox/testing purposes
Sandbox IP WhitelistConditionalAppears when Sandbox is enabled — see below

WARNING

A domain cannot be both Primary and Sandbox. Enabling one automatically prevents the other from being set.

Sandbox IP Whitelist

Add New Domain dialog with Sandbox toggled on, revealing the Sandbox IP Whitelist field with helper text explaining space, comma, or linebreak separation

When Sandbox is enabled the Sandbox IP Whitelist field appears. Enter one or more IPv4 or IPv6 addresses or CIDR ranges, separated by spaces, commas, or line breaks.

  • Empty whitelist — no IP restriction. Any source IP can access the sandbox domain.
  • Populated whitelist — only requests from the listed IPs or CIDR ranges are allowed through. Requests from any other IP will be blocked.

What sandbox mode does

A sandbox domain exposes PSP integrations that are in Development / QA release state in addition to all other active integrations. On a non-sandbox domain those integrations are hidden from checkout entirely, so sandbox domains are the correct place to test new PSP integrations before they reach UAT.

Editing a domain

Edit Domain dialog showing the FQDN pre-filled as api-checkout.feriority.com, a Description textarea, Primary toggle on, and Sandbox toggle off

Click the Edit button on any row to open the edit form. The fields are identical to the add form. Save the floppy-disk icon to apply changes.

The directory supports the standard search, filter, sort, and export controls common to all Payment Nexus directories.