Page Comparison

Merchant

Get

Endpoint - /V2/Merchant/Get

Info
The Merchant you are intending to retrieve will be represented as the OrgUnitId on the core request. Note: no Payload is required for the request on this endpoint.

Get Merchant Request

Code Block

{
    "TransactionId": "44104676",
    "Signature": "GCjvrRxb8FdfWl+/5tZ7mw7nEOzzIK48TFKoVBwgyWc=",
    "Timestamp": "2020-02-01T20:14:57.484Z",
    "Identifier": "CardinalOnboardingAPI-Test",
    "Algorithm": "SHA-256",
    "OrgUnitId": "5b6214bc2f3e7330d08ed35e"
}

Get Merchant Response

Code Block

language	json

{
    "TransactionId": "44104676",
    "ErrorNumber": 0,
    "Message": "",
    "Payload": {
        "Merchant": {
            "Active": true,
            "CavvDataFormat": "BASE64",
            "City": "Mentor",
            "CountryCode": "840",
            "MerchantId": "TM123456",
            "MerchantURL": "https://www.merchanturl.com",
            "Mode": "READONLY",
            "State": "OH",
            "TimeZone": "11",
            "MerchantName": "TestMerchant"
        }
    }
}

Update

Endpoint - /V2/Merchant/Update

Field Name	Format Length	Required	Definition and Values	Example Values
Active	AN(5)	No	(True of False is expected) Whether or not the merchant is able to transact.	True
CavvDataFormat	AN(6)	No	Optional - Defaults to Configuration value. Allowed values: BASE64, HEX	BASE64
City	AN(50)	No	Merchant city.	Mentor
CountryCode	N(10)	Yes	ISO 3166 Country Code	840
ErrorDescription	AN(500)		(Only present in the response) Error description of the request.
ErrorNumber	AN(20)		(Only present in the response) Error number for the request. '0' indicates that request was successful.
MerchantId	AN(50)	Yes	Identity defined for the Merchant.	100_abc
MerchantName	AN(40)	Yes	Merchant Name No Special characters allowed in this field	TestMerchant
MerchantEmail	AN(250)	Yes	Email associated with the merchant account	email@domain.com
MerchantURL/WebsiteURL	AN(255)	Yes	Merchant URL - Must be valid https URL.	https://example.com
Mode	AN(8)	No	Optional - Defaults to Configuration value. Allowed values: OPEN, READONLY, LOCKED	READONLY
State	A(2)	No	State/Province the Merchant is incorporated Format: ISO 3166	OH
TestCaseGroup	AN(10)	Yes	Optional - Defaults to Configuration value. Recommended to pass CUSTOM. Allowed values: CARDINAL CUSTOM MERCHANTACS	CUSTOM
Timezone	AN(50)	No	Merchant time zone. See /wiki/spaces/STAG/pages/1095925795 .	11
TransactionPassword	AN(50)	Yes	Optional - Defaults to Configuration value.	ABC123!@#

Update Merchant Request

Code Block

{
    "TransactionId": "91171867",
    "Signature": "snURHeZqgsVYSMnExmvyMW4RRmYqiFPDV+J5d8AJ6xs=",
    "Timestamp": "2020-02-01T20:14:58.267Z",
    "Identifier": "CardinalOnboardingAPI-Test",
    "Algorithm": "SHA-256",
    "OrgUnitId": "5b6214bc2f3e7330d08ed35e",
    "Payload": {
        "CentinelMerchant": {
            "Active": true,
            "CavvDataFormat": "BASE64",
            "City": "Mentor",
            "CountryCode": "840",
            "MerchantId": "TM123456",
            "MerchantURL": "https://www.merchanturl.com",
            "State": "OH",
            "TimeZone": "11",
            "TransactionPassword": "ABC123!@#",
            "MerchantName": "TestMerchant",
            "Mode": "READONLY"
        }
    }
}

Note
When sending in updated Merchant Details, the API requires that all configurations (current and updated) be sent in for the call to be updated successfully.

Update Merchant Response

Code Block
{ "TransactionId": "91171867", "ErrorNumber": 0, "Message": "" }

Merchant Acquirer Config

Create

Endpoint - /V2/MerchantAcquirerConfig/Create

Field Name	Format Length	Required	Definition and Values	Example Values
AcquirerId	AN(20)	Yes	The ID that the merchant is configured under in the acquirer's system, typically 6 digits	For Visa, this value will begin with a 4 (example: 4xxxxx) and be 6 digits For Mastercard, this value will begin with a 5 or a 2 (example 5xxxxx or 2xxxxx) and be 6 digits NOTE: For AMEX, this value will be longer than 6 digits
AcquirerMerchantId	AN(35)	Yes	Merchant assigned Acquirer Id.	Test Merchant
CurrencyCode	AN(8)	Yes	3 digit numeric (ISO 4217) or 'Default.'	See /wiki/spaces/STAG/pages/1095925779
PaymentInitiativeType	AN(30)	Yes	Values: VerifiedByVisa AmexSafeKey ELO DinersClubInternationalProtectBuy MasterCardSecureCode JCBJSecure Maestro CB	VerifiedByVisa
AcquirerPassword	AN(100)	No NOTE: The AcquirerPassword is required for JCBJSecure requests.		12345678
MCCCode	N(4)	Yes	Merchant category code (MCC)	Refer to EMV 3DS specification
RequestorName	AN(40)	No NOTE: this value is required if you plan to run EMV 3DS transactions	This value is a Directory Server assigned 3DS Requestor Name value, each DS may provide a unique ID.
RequestorID	AN(35)	No NOTE: this value is required if you plan to run EMV 3DS transactions	This value is a Directory Server assigned 3DS Requestor ID value, each DS may provide a unique ID.

Merchant Acquirer Create Request

Code Block

{
    "TransactionId": "78020875",
    "Signature": "bRKinvmKaHZ9Irvf/cZ+fIs9jQ/QjKeeeqm/Q8xniko=",
    "Timestamp": "2020-02-01T20:14:59.600Z",
    "Identifier": "CardinalOnboardingAPI-Test",
    "Algorithm": "SHA-256",
    "OrgUnitId": "5b6214c32f3e7330d08ed384",
    "Payload": {
        "AcquirerId": "444555",
        "AcquirerMerchantId": "7OGe6hDupT",
        "CurrencyCode": "Default",
        "PaymentInitiativeType": "VerifiedByVisa",
        "RequestorId": "TestVISA",
        "RequestorName": "TestVISA",
        "MCCCode": "1234"
    }
}

Merchant Acquirer Create Response

Code Block

language	json

{
    "TransactionId": "78020875",
    "ErrorNumber": 0,
    "Message": "Merchant Acquirer configs are created"
}

Update

Endpoint - /V2/MerchantAcquirerConfig/Update

Field Name	Format Length	Required	Definition and Values	Example Values
AcquirerId	AN(20)	Yes	The ID that the merchant is configured under in the acquirer's system, typically 6 digits	For Visa, this value will begin with a 4 (example: 4xxxxx) and be 6 digits For Mastercard, this value will begin with a 5 or a 2 (example 5xxxxx or 2xxxxx) and be 6 digits NOTE: For AMEX, this value will be longer than 6 digits
AcquirerMerchantId	AN(35)	Yes	Merchant assigned Acquirer Id.	UpdatedAcquirerMerchantId
CurrencyCode	AN(8)	Yes	3 digit numeric (ISO 4217) or 'Default.'	See /wiki/spaces/STAG/pages/1095925779
PaymentInitiativeType	AN(30)	Yes	Values: VerifiedByVisa AmexSafeKey ELO DinersClubInternationalProtectBuy MasterCardSecureCode JCBJSecure Maestro CB	VerifiedByVisa
AcquirerPassword	AN(100)	No NOTE: The AcquirerPassword is required for JCBJSecure requests.		12345678
MCCCode	N(4)	Yes	Merchant category code (MCC)	Refer to EMV 3DS specification
RequestorName	AN(40)	No NOTE: this value is required if you plan to run EMV 3DS transactions	This value is a Directory Server assigned 3DS Requestor Name value, each DS may provide a unique ID.
RequestorID	AN(35)	No NOTE: this value is required if you plan to run EMV 3DS transactions	This value is a Directory Server assigned 3DS Requestor ID value, each DS may provide a unique ID.

Merchant Acquirer Config Update Request

Code Block

language	json

{
    "TransactionId": "79118695",
    "Signature": "ynRcqtPJITCbu9lPb+SosETgh5vEOM0uSeSbcG1+0lY=",
    "Timestamp": "2020-02-01T20:15:01.251Z",
    "Identifier": "CardinalOnboardingAPI-Test",
    "Algorithm": "SHA-256",
    "OrgUnitId": "5b6214c32f3e7330d08ed384",
    "Payload": {
        "AcquirerId": "444555",
        "AcquirerMerchantId": "UpdatedAcquirerMerchantId",
        "CurrencyCode": "Default",
        "PaymentInitiativeType": "VerifiedByVisa",
        "AcquirerPassword": "12345678",
        "RequestorId": "TestVISA",
        "RequestorName": "TestVISA",
        "MCCCode": "1234"
    }
}

Merchant Acquirer Config Update Response

Code Block

language	json

{
    "TransactionId": "79118695",
    "ErrorNumber": 0,
    "Message": "Merchant Acquirer configs are updated"
}

Delete

Endpoint - /V2/MerchantAcquirerConfig/Delete

Field Name	Format Length	Required	Definition and Values	Example Values
AcquirerId	AN(20)	Yes	The ID that the merchant is configured under in the acquirer's system, typically 6 digits	For Visa, this value will begin with a 4 (example: 4xxxxx) and be 6 digits For Mastercard, this value will begin with a 5 or a 2 (example 5xxxxx or 2xxxxx) and be 6 digits NOTE: For AMEX, this value will be longer than 6 digits
AcquirerMerchantId	AN(35)	Yes	Merchant assigned Acquirer Id.	UpdatedAcquirerMerchantId
CurrencyCode	AN(8)	Yes	3 digit numeric (ISO 4217) or 'Default.'	See /wiki/spaces/STAG/pages/1095925779
PaymentInitiativeType	AN(30)	Yes	Values: VerifiedByVisa AmexSafeKey ELO DinersClubInternationalProtectBuy MasterCardSecureCode JCBJSecure Maestro CB	VerifiedByVisa
MCCCode	N(4)	Yes	Merchant category code (MCC)	Refer to EMV 3DS specification

Delete Merchant Acquirer Config Request

Code Block

language	json

{
    "TransactionId": "79118695",
    "Signature": "ynRcqtPJITCbu9lPb+SosETgh5vEOM0uSeSbcG1+0lY=",
    "Timestamp": "2020-02-01T20:15:01.251Z",
    "Identifier": "CardinalDocs",
    "Algorithm": "SHA-256",
    "OrgUnitId": "5b6214c32f3e7330d08ed384",
    "Payload": {
        "AcquirerId": "444555",
        "AcquirerMerchantId": "UpdatedAcquirerMerchantId",
        "CurrencyCode": "Default",
        "PaymentInitiativeType": "VerifiedByVisa",
        "mCCCode": "1234"
    }
}

Delete Merchant Acquirer Config Response

Code Block

language	json

{
    "TransactionId": "79118695",
    "ErrorNumber": 0,
    "Message": "Merchant Acquirer configs are deleted"
}

Get All

The Get All call allows you to retrieve details of the acquirer config loaded in our system. The following are the DSStatuses and their use cases:

SUBMITTED - DS Load is submitted to the queue
NOTSUBMITTED - DS Load not generated
ACTIVE - DS Load complete
ERROR - Error during the DS Load process
ACQUIRERNOTPARTICIPATING - DS confirmation that Acquirer was not Participating

Endpoint - /V2/MerchantAcquirerConfig/GetAll

Info
The Merchant you are intending to retrieve Acquirer Configurations for will be represented as the OrgUnitId on the core request. Note: no Payload is required for the request on this endpoint.

Get All Merchant Acquirer Config Request

Code Block

{
    "TransactionId": "73938297",
    "Signature": "hAc8Zq10DvqNUwnJYHxboJOtuihhGmwkCCRuVjZ1X48=",
    "Timestamp": "2020-02-01T20:15:00.126Z",
    "Identifier": "CardinalOnboardingAPI-Test",
    "Algorithm": "SHA-256",
    "OrgUnitId": "5b6214c32f3e7330d08ed384"
}

Get All Merchant Acquirer Config Response

Code Block

language	json

{
    "TransactionId": "73938297",
    "ErrorNumber": 0,
    "Payload": {
        "MerchantAcquirerConfigs": [
            {
                "AcquirerId": "444555-1000",
                "AcquirerMerchantId": "ABC123XYZ456",
                "AcquirerPassword": "",
                "CurrencyCode": "Default",
                "PaymentInitiativeType": "1",
                "DSStatus": "NOTSUBMITTED",
                "MCCCode": "1234",
                "RequestorName": "Name",
                "RequestorId": "Id"
            }
        ]
    }
}

Payer Authentication Config

The Merchant Onboarding API supports 143 different configurations for Payer Authentication. For a full listing of available fields, please reach out to your Solution Engineer.

Payer Auth Config Examples

2.0 Field Name

Centinel Field Name

Required

Definition and Values

Set As

Three DS 2.0 Enabled

ThreeDSV2

Yes

Enable 3DS2: The transaction will be routed down to the 3DS2 path when DF information is available or when applicable fields are passed on the cmpi_lookup. If we miss any data of the data fields required for the 3DS2 data field we fall back to 1.0.

Values: Default/On/Off

On

Merchant Category Code

CategoryCode

No

It is a default value passed if the Merchant doesn't specify one on the lookup. This field is passed in AReq and is an indicator of what type of goods the Merchant sells.

1234

Update

This call updates an existing merchant with the specified fields and their respective CentinelPayerAuthenticationConfigs. It can be used to update existing CentinelPayerAuthenticationConfigs for an existing merchant.

Note
When sending in updated PayerAuthConfig, this call requires the sender to send in current and new requested configurations for successful execution of the update.

Endpoint - /V1/PayerAuthConfig/Update

Update Payer Auth Config Request

Code Block

{
    "TransactionId": "80502245",
    "Signature": "BcB0EgXRR/lU1l2wFZepGdoTJZJUI4KyBEiHCkWMEQs=",
    "Timestamp": "2020-02-01T20:15:05.558Z",
    "Identifier": "CardinalOnboardingAPI-Test",
    "Algorithm": "SHA-256",
    "OrgUnitId": "5b6214c32f3e7330d08ed384",
    "Payload": {
        "ThreeDSV2": "On"
    }
}

Update Payer Auth Config Response

Code Block

language	json

{
    "TransactionId": "80502245",
    "ErrorNumber": 0,
    "Message": "PayerAuth configs are updated"
}

Get

Endpoint - /V1/PayerAuthConfig/Get

Info
The Merchant you are intending to retrieve Payer Auth Configurations for will be represented as the OrgUnitId on the core request. Note: no Payload is required for the request on this endpoint.

Get Payer Auth Config Request

Code Block

language	json

{
    "TransactionId": "40572129",
    "Signature": "Ikl2RX7TmKdh1rgxvsR4qIfoa5/88vDr7PGVw+NZ3Mc=",
    "Timestamp": "2020-02-01T20:15:04.990Z",
    "Identifier": "CardinalOnboardingAPI-Test",
    "Algorithm": "SHA-256",
    "OrgUnitId": "5b6214c32f3e7330d08ed384"
}

Get Payer Auth Config Response

Code Block

language	json

{
    "TransactionId": "40572129",
    "ErrorNumber": 0,
    "Message": "",
    "Payload": {
        "PayerAuthConfig": {
            ...
        }
    }
}

Acquirers

Get All

Endpoint - /V2/Acquirers/GetAll

Info
The OrgUnitId on the core request should be populated with your given OrgUnitId value, representing the Processor.

Possible Payload Values:

All
VerifiedByVisa
AmexSafeKey
ELO
DinersClubInternationalProtectBuy
MasterCardSecureCode
JCBJSecure
Maestro
CB

Pass "All" as the Payload field to return all valid Acquirer Ids. It is recommended to pass "All" for the first call in order to get the list of valid PaymentInitiativeTypes as well, which can then be used in any subsequent calls.

Get All Request

Code Block

{
    "TransactionId": "58970030",
    "Signature": "X6OXD2ejRddfX3FCcfkjuX0GVp7pcAsigdOofHmsvDo=",
    "Timestamp": "2020-03-12T16:45:11.962Z",
    "Identifier": "CardinalOnboardingAPI-Test",
    "Algorithm": "SHA-256",
    "OrgUnitId": "55d256ccdb2b0f17304e9dad",
    "Payload": "All"
}

Get All Response

Code Block

language	json

{
    "TransactionId": "24253685",
    "ErrorNumber": 0,
    "Message": "",
    "Payload": {
        "Acquirers": [
            {
                "AcquirerBIN": "04xxxxxx",
                "AcquirerId": "4xxxxxx",
                "AcquirerName": "Demo - Visa",
                "PaymentInitiativeKey": "Visa"
            },
            {
                "AcquirerBIN": "01xxxxxxxxxx",
                "AcquirerId": "1xxxxxxxxxx",
                "AcquirerName": "Demo - AMEX",
                "PaymentInitiativeKey": "AmexSafeKey"
            },
            {
                "AcquirerBIN": "05xxxxx",
                "AcquirerId": "5xxxxx",
                "AcquirerName": "Demo - MC",
                "PaymentInitiativeKey": "MC"
            }
        ]
    }
}

API Key

API Keys are the merchant's credentials to connect to Cardinal Consumer Authentication, consisting of the following two values:

API Key
API ID

Create

Endpoint - V1/APIKey/Create

Field Name	Format Length	Required	Definition and Values	Example Values
ListOfGroups	AN(255)	Yes	List of Groups requested to add in the Merchant API Key.	Cardinal Consumer Authentication

Create API Key Request

Code Block

language	json

{
    "TransactionId": "31583689",
    "Signature": "6UX3Tf6VD/ryjAkpFddzNi0T4Xk5VCU1e3sUYBwna/g=",
    "Timestamp": "2020-06-01T18:20:14.443Z",
    "Identifier": "CardinalDocs",
    "Algorithm": "SHA-256",
    "OrgUnitId": "55d256ccdb2b0f17304e9dad",
    "Payload": {
        "ListOfGroups": [
            "Cardinal Consumer Authentication"
        ]
    }
}

Create APIKey Response

Code Block
{ "TransactionId": "00902333", "ErrorNumber": 0, "Payload": { "ApiKey": "8d11be9f-340f-4f22-8823-1297eba3ee55", "ApiId": "5b6899942f3e7330d093a8eb" } }

Table of Contents

Versions Compared

Old Version 4

New Version 5

Key

Merchant

Get

Update

Merchant Acquirer Config

Create

Update

Delete

Get All

Payer Authentication Config

Update

Get

Acquirers

Get All

API Key

Create