API Headers

This document provides details about the headers required or supported by the Convenient Checkout API endpoints.

Required Headers

These headers must be included with every API request.

Header Name	Type	Required	Description
Authorization	string	Yes	Bearer token used for authentication. Format: Bearer {token}
Content-Type	string	Yes	Specifies the format of the request body. Must be application/json for most endpoints
X-Merchant-Id	string	Yes	Identifies the merchant making the request

🔒 InternalInternal information — not visible in the public (merchant) site.

User Scope Required Headers

These additional headers are required specifically for requests with user scopes.

Header Name	Type	Required	Description
x-checkout-id	string	Yes (for user scopes)	Identifies the specific checkout session
x-customer-id	string	Yes (for user scopes)	Identifies the customer making the request

Optional Headers

These headers provide additional context but are not required for all requests.

Header Name	Type	Required	Description
X-source	string	No	Identifies the source/origin system of the request

Environment-Specific Headers

Headers that might be required in specific environments.

Header Name	Type	Required	Description
X-Upstream-Env	string	Conditional	Enum: dev, stage, test, reg, perf. Specify the environment value. Only required for Non-Prod environments