Onboarding API

Number of APIs: 8

The Cardinal Commerce REST Onboarding API demonstrates core-functionality using Qodex's [Dynamic Variables] to generate random values with each submission (enabling support for rapid-fire consecutive request submissions).

You will find these variables in the Pre-requests tab of the API request.

Eg.

var trxPwd = pm.variables.replaceIn("{{$randomPassword}}");

In the example above, a variable (or, var) named trxPwd is created by placing the Dynamic Variable name $randomPassword inside the double curly braces {{ }}

Each randomized value is saved to the Environment but will be over-written with the next request

Getting Started

Please ensure that you've either created or edited an [environment] with the necessary Onboarding API credentials:

ENVIRONMENT
API_KEY
API_ID
ORG_UNIT_ID

⚠ When in doubt, create your own unique environment fork

Forking environments

From the upper right-hand corner, select Centinel Direct 202 STAG from the menu
Click the Environment quick look button just to the right (eyeball icon)
Click Edit
Click the More actions button (three circles)
Select Create a fork
Choose a preferred name then save
From the upper right-hand corner, select your new Environment fork

API Key Usage

In order to provide more flexibility with submitting requests and rotating keys, the Onboarding API authenticates using the identifier, OrgUnit, Algorithm, Timestamp, and Signature fields.

Field Name	Description
Algorithm	The hash algorithm that was used to generate the Signature for the request. Possible Values: - SHA-256 - SHA-512
Identifier	The unique identifier representing the API Key being used to generate the Signature that is specified on the request. This value will be provided by Cardinal at the time the API Key is generated.
OrgUnit	The unique organizational unit for which the request is being processed for. Each merchant within the system will be assigned a unique OrgUnit value by Cardinal.
Signature	The signature for the request being submitted. This value is generated by hashing the combination of the Timestamp and the API Key. For additional information, please see the specific section on generating signature values.
Timestamp	The ISO standard time in milliseconds for the point in time that the request is generated. Example: {{CURRENT_TIMESTAMP}}

Troubleshooting

The following error likely means that Merchant API credentials were added to the environment rather than Onboarding API:

{
    "ErrorNumber": 1001,
    "Message": "Not authorized to access this request."
}