Norce Checkout Configuration
Version: 1.0.0
Build 2025-06-18 11:11:10
Configuration API
Related Documentation
For conceptual documentation and usage guides, see:
- NCO Configuration - Understanding NCO configuration concepts
- NCO Introduction - Getting started with Norce Checkout
Base URLs
https://checkout-configuration.test.norce.tech- Test server
Authentication
Bearer
- Type: apiKey
- Description: Authorization header using the bearer scheme. Example: 'Bearer a3bcdABCaB12abc3AbCDAB5AbcABCaBcABC5ab3c5A0='
Endpoints
PUT /api/v1/configuration/merchants/{merchant}/channels/{channel}/configurations/{configuration_name}
Set configuration. If the channel does not exist, it will be created.
Parameters
- merchant (path) required
- Merchant
- Type:
string
- channel (path) required
- Channel
- Type:
string
- configuration_name (path) required
- Name of service or adapter
- Type:
string
Request Body
Configuration
Content-Type: application/json
Responses
200
OK
Content-Type: application/json
Schema: Configuration
400
Bad Request
Content-Type: application/json
Schema: Error
401
Unauthorized
Content-Type: application/json
Schema: Error
404
Not Found
Content-Type: application/json
Schema: Error
GET /api/v1/configuration/merchants/{merchant}/channels/{channel}/configurations/{configuration_name}
Get configuration
Parameters
- merchant (path) required
- Merchant
- Type:
string
- channel (path) required
- Channel
- Type:
string
- configuration_name (path) required
- Name of service or adapter
- Type:
string
Responses
200
OK
Content-Type: application/json
Schema: Configuration
401
Unauthorized
Content-Type: application/json
Schema: Error
404
Not Found
Content-Type: application/json
Schema: Error
DELETE /api/v1/configuration/merchants/{merchant}/channels/{channel}/configurations/{configuration_name}
Delete configuration. If this is the last configuration for a channel, the channel will be deleted.
Parameters
- merchant (path) required
- Merchant
- Type:
string
- channel (path) required
- Channel
- Type:
string
- configuration_name (path) required
- Name of service or adapter
- Type:
string
Responses
204
No Content
401
Unauthorized
Content-Type: application/json
Schema: Error
404
Not Found
Content-Type: application/json
Schema: Error
GET /api/v1/configuration/merchants/{merchant}/channels/{channel}/configurations
Get configurations
Parameters
- merchant (path) required
- Merchant
- Type:
string
- channel (path) required
- Channel
- Type:
string
Responses
200
OK
Content-Type: application/json
Schema: Array of Configuration
401
Unauthorized
Content-Type: application/json
Schema: Error
404
Not Found
Content-Type: application/json
Schema: Error
PUT /api/v1/configuration/merchants/{merchant}/channels/{channel}/configurations
**Set configurations. If the channel does not exist, it will be created.
Unlike a proper restful PUT of a list, this will only set/replace the configurations provided in the list and leave any other configurations for this merchant and channel unmodified.**
Parameters
- merchant (path) required
- Merchant
- Type:
string
- channel (path) required
- Channel
- Type:
string
Request Body
Content-Type: application/json
Schema: Array of Configuration
Responses
200
OK
Content-Type: application/json
Schema: Array of Configuration
401
Unauthorized
Content-Type: application/json
Schema: Error
404
Not Found
Content-Type: application/json
Schema: Error
DELETE /api/v1/configuration/merchants/{merchant}/channels/{channel}/configurations
This endpoint deletes all the configurations for a given channel. This will also delete the channel.
Parameters
- merchant (path) required
- Merchant
- Type:
string
- channel (path) required
- Channel
- Type:
string
Responses
204
No Content
401
Unauthorized
Content-Type: application/json
Schema: Error
404
Not Found
Content-Type: application/json
Schema: Error
GET /api/v1/configuration/merchants/{merchant}/channels
Get channels
Parameters
- merchant (path) required
- Merchant
- Type:
string
Responses
200
OK
Content-Type: application/json
401
Unauthorized
Content-Type: application/json
Schema: Error
404
Not Found
Content-Type: application/json
Schema: Error
Schemas
Configuration
Properties
- $schema (
string) required- The URL of the validating schema
- Example:
"https://checkout-name-adapter.norce.tech/schemas/v1/configuration.json"
- id (
string) required- The Id of the adapter the configuration is for
- Example:
"checkout-name-adapter"
Error
Properties
- code (
string) - message (
string) - details (
object)