API Access Overview

Acquiring Credentials

Access to Norce Checkout is provisioned as part of your onboarding process.

To receive your initial Merchant Identifier, Slug, and Bearer Tokens, please contact your Norce representative or our support team. We will set up your environment and provide the necessary credentials to get you started in the Playground and Stage environments.

Merchant

Each merchant is assigned a unique identifier, referred to as the "merchant identifier" or simply "merchant." This identifier is used across all API interactions.

In the following examples, the fictional store "Things & Stuff" is assigned the merchant identifier thingsandstuff.

Channel

A channel is a logical group of adapter configurations and credentials that defines a specific purchase flow for a merchant. This allows you to manage multiple checkout behaviors, such as different market setups or A/B tests, simply by switching the channel identifier.

This identifier is used across all API interactions.

In the following examples, the fictional store "Things & Stuff" use the channel identifier thingsandstuff-se-nonpsp.

Environments and URLs

Norce Checkout is available in three environments.

To interact with our APIs, you need to pay attention to the following information:

Base URL: Includes your identifier (slug), location, and environment.
Headers: Include your merchant identifier, channel, and authorization bearer token.

The API Base URL follows this general structure:

https://{slug}.api-se.{environment}.norce.tech/checkout/{adapter-or-service}

Environment URL Patterns

Environment	URL Pattern	Purpose
Playground	`https://{slug}.api-se.playground.norce.tech/checkout/`	Early experiments and initial testing.
Stage	`https://{slug}.api-se.stage.norce.tech/checkout/`	Development, integration testing, and UAT.
Production	`https://{slug}.api-se.norce.tech/checkout/`	Live transactions (note that the environment segment is excluded).

URL Components

{slug}: Your unique merchant identifier (e.g., thingsandstuff).
{environment}: Identifies the specific non-production API environment (playground or stage).
/checkout/{adapter-or-service}: The specific path for the service or adapter you are calling. For example, the Norce Checkout order API uses /checkout/order, while adapters use paths like /checkout/norce-adapter.

Example URL (Playground): https://thingsandstuff.api-se.playground.norce.tech/checkout/order

Environment Configuration

Ensure your adapter configurations match the environment you are targeting. Stage environment configurations must use the stage-specific API credentials provided by your payment and shipping providers.

Request Headers

To interact with the Norce Checkout services, include the following headers:

X-Merchant: Contains your merchant identifier, eg., thingsandstuff.
X-Channel: Contains your channel identifier, eg., thingsandstuff-se-nonpsp.

Authorization (Bearer Token)

You can request multiple bearer tokens. A primary and secondary token will be issued. While there is no official time-to-live (TTL) for tokens, the primary token can be revoked at any time, at which point you'll need to use the secondary token. We will provide a new token or pair of tokens as needed.

To include the merchant and token in the request:

GET https://thingsandstuff.api-se.norce.tech/checkout/order/api/v1/checkout/orders/
X-Merchant: thingsandstuff
X-Channel: thingsandstuff-se-nonpsp
Authorization: Bearer {{token}}

Note: Each merchant has unique tokens. Tokens cannot be shared between merchants.