Flex Token Use Cases

These examples list the API fields required for the Setup, Check Enrollment, and Validate Authentication services when using a Flex Microform token. An example of a request payload and a successful response for each service is provided.

A Flex Microform token is valid for 15 minutes. After 15 minutes, a new Flex Microform token is needed.

Setting Up Device Data Collection When Using a Flex Microform Token

Running the Setup service identifies the customer's bank and prepares for collecting data about the device that the customer is using to place the order. In this use case, a Flex Microform token is used instead of the payment card data.

Endpoint

POST /risk/v1/authentication-setups

Example: Setup with a Flex Microform Token

{  "tokenInformation": {    "transientToken": "1C0RNHMQBTATXFCFNGR5EXH3XNOP6359LGLL9J283ATABJ8Z11NL66D834239B51"  }}

{  "consumerAuthenticationInformation": {    "accessToken": "eyJhbGciOiJIUzI1NiIsInR5cCI6IkpXVCJ9.eyJqdGkiOiIzOTRmNDJmYS0xNGUxLTQ1ODAtOGUyZi05ZTVkNzM0Y2ZjYmYiLCJpYXQiOjE3MjU0NDQyNzQsImlzcyI6IjVkZDgzYmYwMGU0MjNkMTQ5OGRjYmFjYSIsImV4cCI6MTcyNTQ0Nzg3NCwiT3JnVW5pdElkIjoiNWI5YzRiYjNmZjYyNmIxMzQ0ODEwYTAxIiwiUmVmZXJlbmNlSWQiOiIwMDRhYzBhZC1mMGE2LTQ4MDAtOWQ3YS05NjJkZTZlYjQ0NmMifQ.oZ9gUZ98gbLyWfFDoY4jRknUQppIR-F_8JFXI6LTQWo",    "deviceDataCollectionUrl": "https://centinelapistag.cardinalcommerce.com/V1/Cruise/Collect",    "referenceId": "004ac0ad-f0a6-4800-9d7a-962de6eb446c",    "token": "AxizbwSTiUOd9P85Jq6mABEBTyDYFkxkAhMQyaSZejFczCmBWAAAnxnb"  },  "id": "7254442740716751204006",  "status": "COMPLETED",  "submitTimeUtc": "2024-09-04T10:04:34Z"}

This field is required to use a Flex Microform token when you request the payer authentication Setup service.

Required Field for Setup with a Flex Microform Token

tokenInformation.transientToken string

Some payment cards require specific information to be collected during a transaction.

Card-Specific Fields for Setup with a Flex Microform Token

Cartes Bancaires 1 field

Field	Description
`paymentInformation.card.type`	Required when the card type is JCB, Cartes Bancaires, China UnionPay, or Meeza.

China UnionPay 1 field

Field	Description
`paymentInformation.card.type`	Required when the card type is JCB, Cartes Bancaires, China UnionPay, or Meeza.

JCB 1 field

Field	Description
`paymentInformation.card.type`	Required when the card type is JCB, Cartes Bancaires, China UnionPay, or Meeza.

Meeza 1 field

Field	Description
`paymentInformation.card.type`	Required when the card type is JCB, Cartes Bancaires, China UnionPay, or Meeza.

Country-Specific Fields for Setup with a Flex Microform Token

Canada 2 fields

Field	Description
`orderInformation.billTo.administrativeArea`	Required for transactions in the US and Canada.
`orderInformation.billTo.postalCode`	Required when the `orderInformation.billTo.country` field value is `US` or `CA`.

Egypt (Meeza transactions) 2 fields

Field	Description
`consumerAuthenticationInformation.overrideCountryCode`	For Meeza transactions, this value must be set to `EG` if Egypt was not set as the country in merchant configuration during merchant boarding.
`merchantInformation.merchantDescriptor.country`	For Meeza transactions, this value must be set to `EG` if Egypt was not set as the country in merchant configuration during merchant boarding.

United States 2 fields

Field	Description
`orderInformation.billTo.administrativeArea`	Required for transactions in the US and Canada.
`orderInformation.billTo.postalCode`	Required when the `orderInformation.billTo.country` field value is `US` or `CA`.

Checking Enrollment When Using a Flex Microform Token

The Check Enrollment service verifies whether the customer's card is enrolled in a card authentication program. In this use case, a Flex Microform token is used instead of the payment card data. Flex Microform tokens are only valid for 15 minutes.

Endpoint

POST /risk/v1/authentications

Example: Check Enrollment with a Flex Microform Token (Challenge)

{  "orderInformation": {    "amountDetails": {      "currency": "USD",      "totalAmount": "10.99"    },    "billTo": {      "address1": "1 Market St",      "address2": "Address 2",      "administrativeArea": "CA",      "country": "US",      "locality": "san francisco",      "firstName": "John",      "lastName": "Doe",      "phoneNumber": "4158880000",      "email": "[email protected]",      "postalCode": "94105"    }  },  "deviceInformation": {    "ipAddress": "139.130.4.5",    "httpAcceptContent": "test",    "httpBrowserLanguage": "en_us",    "httpBrowserJavaEnabled": "N",    "httpBrowserJavaScriptEnabled": "Y",    "httpBrowserColorDepth": "24",    "httpBrowserScreenHeight": "100000",    "httpBrowserScreenWidth": "100000",    "httpBrowserTimeDifference": "300",    "userAgentBrowserValue": "GxKnLy8TFDUFxJP1t"  },  "consumerAuthenticationInformation": {    "deviceChannel": "BROWSER",    "transactionMode": "eCommerce",    "referenceId": "CybsCruiseTester-b767b4ea"  },  "tokenInformation": {    "transientToken": "1C0RNHMQBTATXFCFNGR5EXH3XNOP6359LGLL9J283ATABJ8Z11NL66D834239B51"  }}

{  "clientReferenceInformation": {    "code": "1725444594611"  },  "consumerAuthenticationInformation": {    "challengeRequired": "N",    "authenticationTransactionId": "jzULqrneaqG5H3Jev780",    "strongAuthentication": {      "OutageExemptionIndicator": "0"    },    "token": "AxjzbwSTiUOpWHIlxG5lABEBTyDYFlzPSBcS0JhdrSTL0YrmYUwKwAAAwwQS",    "acsUrl": "https://0merchantacsstag.cardinalcommerce.com/MerchantACSWeb/creq.jsp",    "acsReferenceNumber": "Cardinal ACS",    "stepUpUrl": "https://centinelapistag.cardinalcommerce.com/V2/Cruise/StepUp",    "pareq": "eyJtZXNzYWdlVHlwZSI6IkNSZXEi...",    "directoryServerTransactionId": "231b97bd-2a3d-4500-b666-fda90334e5db",    "veresEnrolled": "Y",    "threeDSServerTransactionId": "1d0c7257-9bd3-4fe9-b399-8c513c88d699",    "acsOperatorID": "MerchantACS",    "specificationVersion": "2.2.0",    "acsTransactionId": "83c7e636-3af2-4a96-9e59-7c6754127d24"  },  "errorInformation": {    "reason": "CONSUMER_AUTHENTICATION_REQUIRED",    "message": "The cardholder is enrolled in Payer Authentication. Please authenticate the cardholder before continuing with the transaction."  },  "id": "7254445946286742204005",  "paymentInformation": {    "card": {      "bin": "445653",      "type": "VISA"    }  },  "status": "PENDING_AUTHENTICATION",  "submitTimeUtc": "2024-09-04T10:09:55Z"}

Required Fields for Checking Enrollment with a Flex Microform Token

consumerAuthenticationInformation.deviceChannel string

consumerAuthenticationInformation.referenceId string

deviceInformation.httpAcceptBrowserValue string

deviceInformation.httpAcceptContent string

deviceInformation.httpBrowserColorDepth string

deviceInformation.httpBrowserJavaEnabled boolean

deviceInformation.httpBrowserJavaScriptEnabled boolean

deviceInformation.httpBrowserLanguage string

deviceInformation.httpBrowserScreenHeight string

deviceInformation.httpBrowserScreenWidth string

deviceInformation.httpBrowserTimeDifference string

deviceInformation.ipAddress string

deviceInformation.userAgentBrowserValue string

When the customer's browser provides this value, you must include it in your request.

orderInformation.amountDetails.currency string

orderInformation.amountDetails.totalAmount string

Required when the orderInformation.lineItems.unitPrice field is not used.

orderInformation.billTo.address1 string

orderInformation.billTo.address2 string

orderInformation.billTo.administrativeArea string

Required for the US and Canada.

orderInformation.billTo.country string

Required for the US and Canada.

orderInformation.billTo.email string

orderInformation.billTo.firstName string

orderInformation.billTo.lastName string

orderInformation.billTo.locality string

orderInformation.billTo.phoneNumber string

orderInformation.billTo.postalCode string

paymentInformation.card.expirationYear string

paymentInformation.card.expirationMonth string

paymentInformation.card.type string

Card-Specific Fields for Checking Enrollment with a Flex Microform Token

Cartes Bancaires 1 field

Field	Description
`paymentInformation.card.type`	Required when the card type is JCB, Cartes Bancaires, China UnionPay, or Meeza.

China UnionPay 1 field

Field	Description
`paymentInformation.card.type`	Required when the card type is JCB, Cartes Bancaires, China UnionPay, or Meeza.

JCB 1 field

Field	Description
`paymentInformation.card.type`	Required when the card type is JCB, Cartes Bancaires, China UnionPay, or Meeza.

Meeza 1 field

Field	Description
`paymentInformation.card.type`	Required when the card type is JCB, Cartes Bancaires, China UnionPay, or Meeza.

Country-Specific Fields for Checking Enrollment with a Flex Microform Token

Canada 2 fields

Field	Description
`orderInformation.billTo.administrativeArea`	Required for transactions in the US and Canada.
`orderInformation.billTo.postalCode`	Required when the `orderInformation.billTo.country` field value is `US` or `CA`.

Egypt (Meeza transactions) 2 fields

Field	Description
`consumerAuthenticationInformation.overrideCountryCode`	For Meeza transactions, this value must be set to `EG` if Egypt was not set as the country in merchant configuration during merchant boarding.
`merchantInformation.merchantDescriptor.country`	For Meeza transactions, this value must be set to `EG` if Egypt was not set as the country in merchant configuration during merchant boarding.

United States 2 fields

Field	Description
`orderInformation.billTo.administrativeArea`	Required for transactions in the US and Canada.
`orderInformation.billTo.postalCode`	Required when the `orderInformation.billTo.country` field value is `US` or `CA`.

Validating a Challenge When Using a Flex Microform Token

The Validation service verifies the authentication results after the cardholder completes the step-up challenge. In this use case, a Flex Microform token is used instead of the payment card data.

Endpoint

POST /risk/v1/authentication-results

Example: Validate Challenge with a Flex Microform Token

{  "paymentInformation": {    "card": {      "type": "001"    }  },  "consumerAuthenticationInformation": {    "authenticationTransactionId": "jzULqrneaqG5H3Jev780"  }}

{  "clientReferenceInformation": {    "code": "pavalidatecheck",    "partner": {      "developerId": "7891234",      "solutionId": "89012345"    }  },  "consumerAuthenticationInformation": {    "indicator": "vbv",    "eciRaw": "05",    "authenticationResult": "0",    "strongAuthentication": {      "OutageExemptionIndicator": "0"    },    "authenticationStatusMsg": "Success",    "eci": "05",    "token": "AxizLwSTiUOsVuUwvt1DABEBTyDYFmPAAhMQyaSZejFczCmATUmo",    "cavv": "AAIBBYNoEwAAACcKhAJkdQAAAAA=",    "paresStatus": "Y",    "xid": "AAIBBYNoEwAAACcKhAJkdQAAAAA=",    "directoryServerTransactionId": "231b97bd-2a3d-4500-b666-fda90334e5db",    "threeDSServerTransactionId": "1d0c7257-9bd3-4fe9-b399-8c513c88d699",    "specificationVersion": "2.2.0",    "acsTransactionId": "83c7e636-3af2-4a96-9e59-7c6754127d24"  },  "id": "7254446789006754504003",  "paymentInformation": {    "card": {      "bin": "445653",      "type": "VISA"    }  },  "status": "AUTHENTICATION_SUCCESSFUL",  "submitTimeUtc": "2024-09-04T10:11:19Z"}

Required Fields for Validating a Challenge with a Flex Microform Token

consumerAuthenticationInformation.authenticationTransactionId string

paymentInformation.card.type string

Card-Specific Fields for Validating a Challenge with a Flex Microform Token

Cartes Bancaires 1 field

Field	Description
`paymentInformation.card.type`	Required when the card type is JCB, Cartes Bancaires, China UnionPay, or Meeza.

China UnionPay 1 field

Field	Description
`paymentInformation.card.type`	Required when the card type is JCB, Cartes Bancaires, China UnionPay, or Meeza.

JCB 1 field

Field	Description
`paymentInformation.card.type`	Required when the card type is JCB, Cartes Bancaires, China UnionPay, or Meeza.

Meeza 1 field

Field	Description
`paymentInformation.card.type`	Required when the card type is JCB, Cartes Bancaires, China UnionPay, or Meeza.

Country-Specific Fields for Validating a Challenge with a Flex Microform Token

Canada 2 fields

Field	Description
`orderInformation.billTo.administrativeArea`	Required for transactions in the US and Canada.
`orderInformation.billTo.postalCode`	Required when the `orderInformation.billTo.country` field value is `US` or `CA`.

Egypt (Meeza transactions) 2 fields

Field	Description
`consumerAuthenticationInformation.overrideCountryCode`	For Meeza transactions, this value must be set to `EG` if Egypt was not set as the country in merchant configuration during merchant boarding.
`merchantInformation.merchantDescriptor.country`	For Meeza transactions, this value must be set to `EG` if Egypt was not set as the country in merchant configuration during merchant boarding.

United States 2 fields

Field	Description
`orderInformation.billTo.administrativeArea`	Required for transactions in the US and Canada.
`orderInformation.billTo.postalCode`	Required when the `orderInformation.billTo.country` field value is `US` or `CA`.

Was this page helpful?

Last published: October 28, 2026

Setting Up Device Data Collection When Using a Flex Microform Token

Checking Enrollment When Using a Flex Microform Token

Validating a Challenge When Using a Flex Microform Token

Not available for your audience