Sign in

v1

latestOpenAPI 3.0.12026-07-2353480642.4 KB
3DS Authentication

List ThreeDSAuthentications

The API enumerates the ThreeDS Authentication objects, offering filtration criteria to obtain filtered data based on specified parameters.

Filtering and Searching

Filters can be used to interact with any object. Objects can be queried by appending parameters to the query string of the URL.

So to get a list of all pares_status = Y in threeds authentication with EUR currency, having an amount equal to or greater than 20, we would use the following URL:

/v2/3d?_limit=10&amount>=212&currency_code=EUR&authentication.pares_status=Y

Parameters with multiple values are also supported. So for example, to query pares_status = Y and pares_status = U, you would use the following URL:

/v2/3d?authentication.pares_status=Y&authentication.pares_status=U

Use the following syntax to query objects based on parameters and values - in this example querying threeds authentication by the amount.

Query on one value:

/v2/3d?amount=7500

Query on everything but one value:

/v2/3d?amount!=7500

Less than and equal to:

/v2/3d?amount<=7500

Greater than and equal to:

/v2/3d?amount>=7500

Range of values within/outside specified bounds:

/v2/3d?amount<=7600&amount>=7500

Multiple parameters:

/v2/3d?amount=7600&currency_code=EUR

Limit the number of results:

/v2/3d?_limit=50

Sort results in descending order:

/v2/3d?_sort=-amount

Sort results in ascending order:

/v2/3d?_sort=amount

Query operators:

OperatorDescription
=equal
!not equal
<less than or equal to
>greater than or equal to
~pattern matching
>&<multiple-argument (range) search
get/v2/3d

Query parameters

_limitinteger

The maximum number of values that can be sent in the response ( maximum: 10000 )

_skipinteger

_skip query params

_sortstring[]

_sort query params

_idstring

ThreeDSAuthentication id

amountnumber

The amount of the transaction.

cardstring

The ID of the card that is checked for enrollment.

created_atstring date

The time at which the authentication was created.

currency_codestring

Alphabetical ISO 4217 currency code for the sale amount.

entity_idstring

The ID of the entity, which this authentication belongs to.

threeds_contract_idstring

The ID of the threeDSContractId used.

transaction_idstring

To complete the transaction, the value is required to be passed on the Cardinal.Continue().

authentication.acs_rendering_typestring

Identifies the UI Type the ACS will use to complete the challenge. NOTE: Only available for App transactions using the Cardinal Mobile SDK and is optional for an Issuer to return.

authentication.acs_transaction_idstring

Unique transaction identifier assigned by the ACS to identify a single transaction.

authentication.acs_urlstring

The fully qualified URL to redirect the Consumer to complete the Consumer Authentication transaction. NOTE: Available if Enrolled = Y

authentication.authentication_typestring

Indicates the type of authentication that will be used to challenge the card holder. Possible Values: 01 - Static 02 - Dynamic 03 - OOB (Out of Band)

authentication.authorization_payloadstring

The Base64 encoded JSON Payload of CB specific Authorization Values returned in the Frictionless Flow.

authentication.card_brandstring

Card Brand

authentication.cardholder_infostring

Additional text provided by the Issuing Bank to the Cardholder during a Frictionless transaction and was not authenticated by the ACS. The Issuing Bank can optionally support this value.

authentication.cavv_algorithmstring

Indicates the algorithm used to generate the CAVV value. Possible Values: 2 - CVV with ATN 3 - Mastercard SPA algorithm

authentication.cavvstring

Cardholder Authentication Verification Value (CAVV). This value should be appended to the authorization message signifying that the transaction has been successfully authenticated. It will be encoded according to the Merchant's configuration in either Base64 encoding or Hex encoding. A Base64 encoding Merchant configuration will produce values of 28 or 32 characters. A Hex encoding Merchant configuration will produce values of 40 or 48 characters. The value when decoded will either be 20 bytes for CAVV.

authentication.challenge_cancel'01' | '02' | '03' | '04' | '05' | '06' | '07' | '8.0'

An indicator as to why the transaction was canceled. Possible Values: 01 - Cardholder selected Cancel 02 - Reserved for future EMVCo use (values invalid until defined by EMVCo). 03 - Transaction Timed Out—Decoupled Authentication 04 - Transaction timed out at ACS—other timeouts 05 - Transaction Timed out at ACS - First CReq not received by ACS 06 - Transaction Error 07 - Unknown 08 = Transaction Timed Out at SDK NOTE: Only present when the Consumer cancels the challenge. Decoupled authentication is not supported at this time.

authentication.challenge_requiredstring

Indicates whether a challenge is required to complete authentication. For example, regional mandates. Possible Values: Y - Challenge Required N - Challenge Not Required

authentication.ds_transaction_idstring

Unique transaction identifier assigned by the Directory Server (DS) to identify a single transaction. NOTE: Required for Mastercard Identity Check transaction in Authorization - Only available in EMV 3DS (3DS 2.0) transactions

authentication.eci_flagstring

Electronic Commerce Indicator (ECI). The ECI value is part of the 2 data elements that indicate the transaction was processed electronically. This should be passed on the authorization transaction to the Gateway/Processor. Possible Values: 02 or 05 - Fully Authenticated Transaction 01 or 06 - Attempted Authentication Transaction 00 or 07 - Non 3D Secure Transaction Mastercard - 02, 01, 00 VISA - 05, 06, 07 AMEX - 05, 06, 07 JCB - 05, 06, 07 DINERS CLUB - 05, 06, 07 NOTE: 3DS 2.0 field

authentication.enrolledstring

Status of Authentication eligibility. Possible Values: Y - Yes, Bank is participating in 3D Secure protocol and will return the ACSUrl N - No, Bank is not participating in 3D Secure protocol U - Unavailable, The DS or ACS is not available for authentication at the time of the request B - Bypass, Merchant authentication rule is triggered to bypass authentication in this use case NOTE: If the Enrolled value is NOT Y, then the Consumer is NOT eligible for Authentication.

authentication.error_descstring

Application error description for the associated error number(s). NOTE: Multiple error descriptions are separated by a comma.

authentication.error_nostring

Application error number(s). A non-zero value represents the error encountered while attempting to process the message request. NOTE: Multiple error numbers are separated by a comma.

authentication.network_scorestring

The global score calculated by the CB Scoring platform.

authentication.order_idstring

3DS server generated order identifier. Used to link multiple actions on a single order to a single identifier. Mod-10 compliant and unique BIN range to 3DS services.

authentication.pares_statusstring

Transactions status result identifier. Possible Values: Y - Successful Authentication N - Failed Authentication U - Unable to Complete Authentication A - Successful Attempts Transaction C - Challenge Required for Authentication R - Authentication Rejected (Merchant must not submit for authorization) NOTE: Statuses of C and R only apply to Consumer Authentication 2.0.,

authentication.payloadstring

The encoded payment request generated by Centinel. NOTE: Available if Enrolled = Y

authentication.reason_codestring

The error code indicating a problem with this transaction.

authentication.reason_descstring

Text and additional detail about the error for this transaction. NOTE: This field concatenates the errorDescription and errorDetail from the authentication response message

authentication.signature_verificationstring

Transaction Signature status identifier. Possible Values: Y - Indicates that the signature of the PARes has been validated successfully and the message contents can be trusted. N - Indicates that the PARes could not be validated. This result could be for a variety of reasons; tampering, certificate expiration, etc., and the result should not be trusted.

authentication.status_reasonstring

Provides additional information as to why the PAResStatus has the specific value. NOTE: Required for Payment (e.g. Authentication Indicator equals 01 on Lookup Request) transactions when PAResStatus is equal to N, U, or R in the Lookup Response.

authentication.threeds_versionstring

This field contains the 3DS version that was used to process the transaction. Possible Values: 1.0.2 2.1.0 NOTE: Required for Mastercard Identity Check transactions in Authorization

authentication.xidstring

Third Party Token that is returned from the token provider after a card number is specified on the request. NOTE: This field is returned if Tokenization is enabled in the Merchant profile setting AND the Merchant is using a third party token provider.

encrypted_cardstring

Client encrypted cardholder data. The cardholder data encrypted using the Verifone provided public key. This needs to be provided in base64 encoded format. The data to encrypt is a JSON with possible tags being cardNumber, sequenceNumber, cardholderName, startMonth, startYear, expiryMonth, expiryYear, cvv. Additionally a tag called captureTime must be presenting indicating the time the card was captured in UTC in format RFC 3339, section 5.6. eg. 2019-08-24T14:15:22Z. Sample JSON to encrypt:

    {
        "captureTime": '2019-08-24T14:15:22Z',
        "cardNumber": '5555555555554444',
        "expiryMonth": 1,
        "expiryYear": 2025,
        "cvv": '123',
    }

Note: encrypted_card is required if card or reuse_token is not provided.

public_key_aliasstring

The alias for the public key used to encrypt this card. Note: public_key_alias is required if card or reuse_token is not provided.

_id!string

ThreeDSAuthentication id

amount!number

The amount of the transaction.

card!string

The ID of the card that is checked for enrollment.

created_at!string date

The time at which the authentication was created.

currency_code!string

Alphabetical ISO 4217 currency code for the sale amount.

entity_id!string

The ID of the entity, which this authentication belongs to.

threeds_contract_id!string

The ID of the threeDSContractId used.

transaction_id!string

To complete the transaction, the value is required to be passed on the Cardinal.Continue().

authentication.acs_rendering_type!string

Identifies the UI Type the ACS will use to complete the challenge. NOTE: Only available for App transactions using the Cardinal Mobile SDK and is optional for an Issuer to return.

authentication.acs_transaction_id!string

Unique transaction identifier assigned by the ACS to identify a single transaction.

authentication.acs_url!string

The fully qualified URL to redirect the Consumer to complete the Consumer Authentication transaction. NOTE: Available if Enrolled = Y

authentication.authentication_type!string

Indicates the type of authentication that will be used to challenge the card holder. Possible Values: 01 - Static 02 - Dynamic 03 - OOB (Out of Band)

authentication.authorization_payload!string

The Base64 encoded JSON Payload of CB specific Authorization Values returned in the Frictionless Flow.

authentication.card_brand!string

Card Brand

authentication.cardholder_info!string

Additional text provided by the Issuing Bank to the Cardholder during a Frictionless transaction and was not authenticated by the ACS. The Issuing Bank can optionally support this value.

authentication.cavv_algorithm!string

Indicates the algorithm used to generate the CAVV value. Possible Values: 2 - CVV with ATN 3 - Mastercard SPA algorithm

authentication.cavv!string

Cardholder Authentication Verification Value (CAVV). This value should be appended to the authorization message signifying that the transaction has been successfully authenticated. It will be encoded according to the Merchant's configuration in either Base64 encoding or Hex encoding. A Base64 encoding Merchant configuration will produce values of 28 or 32 characters. A Hex encoding Merchant configuration will produce values of 40 or 48 characters. The value when decoded will either be 20 bytes for CAVV.

authentication.challenge_cancel!'01' | '02' | '03' | '04' | '05' | '06' | '07' | '8.0'

An indicator as to why the transaction was canceled. Possible Values: 01 - Cardholder selected Cancel 02 - Reserved for future EMVCo use (values invalid until defined by EMVCo). 03 - Transaction Timed Out—Decoupled Authentication 04 - Transaction timed out at ACS—other timeouts 05 - Transaction Timed out at ACS - First CReq not received by ACS 06 - Transaction Error 07 - Unknown 08 = Transaction Timed Out at SDK NOTE: Only present when the Consumer cancels the challenge. Decoupled authentication is not supported at this time.

authentication.challenge_required!string

Indicates whether a challenge is required to complete authentication. For example, regional mandates. Possible Values: Y - Challenge Required N - Challenge Not Required

authentication.ds_transaction_id!string

Unique transaction identifier assigned by the Directory Server (DS) to identify a single transaction. NOTE: Required for Mastercard Identity Check transaction in Authorization - Only available in EMV 3DS (3DS 2.0) transactions

authentication.eci_flag!string

Electronic Commerce Indicator (ECI). The ECI value is part of the 2 data elements that indicate the transaction was processed electronically. This should be passed on the authorization transaction to the Gateway/Processor. Possible Values: 02 or 05 - Fully Authenticated Transaction 01 or 06 - Attempted Authentication Transaction 00 or 07 - Non 3D Secure Transaction Mastercard - 02, 01, 00 VISA - 05, 06, 07 AMEX - 05, 06, 07 JCB - 05, 06, 07 DINERS CLUB - 05, 06, 07 NOTE: 3DS 2.0 field

authentication.enrolled!string

Status of Authentication eligibility. Possible Values: Y - Yes, Bank is participating in 3D Secure protocol and will return the ACSUrl N - No, Bank is not participating in 3D Secure protocol U - Unavailable, The DS or ACS is not available for authentication at the time of the request B - Bypass, Merchant authentication rule is triggered to bypass authentication in this use case NOTE: If the Enrolled value is NOT Y, then the Consumer is NOT eligible for Authentication.

authentication.error_desc!string

Application error description for the associated error number(s). NOTE: Multiple error descriptions are separated by a comma.

authentication.error_no!string

Application error number(s). A non-zero value represents the error encountered while attempting to process the message request. NOTE: Multiple error numbers are separated by a comma.

authentication.network_score!string

The global score calculated by the CB Scoring platform.

authentication.order_id!string

3DS server generated order identifier. Used to link multiple actions on a single order to a single identifier. Mod-10 compliant and unique BIN range to 3DS services.

authentication.pares_status!string

Transactions status result identifier. Possible Values: Y - Successful Authentication N - Failed Authentication U - Unable to Complete Authentication A - Successful Attempts Transaction C - Challenge Required for Authentication R - Authentication Rejected (Merchant must not submit for authorization) NOTE: Statuses of C and R only apply to Consumer Authentication 2.0.,

authentication.payload!string

The encoded payment request generated by Centinel. NOTE: Available if Enrolled = Y

authentication.reason_code!string

The error code indicating a problem with this transaction.

authentication.reason_desc!string

Text and additional detail about the error for this transaction. NOTE: This field concatenates the errorDescription and errorDetail from the authentication response message

authentication.signature_verification!string

Transaction Signature status identifier. Possible Values: Y - Indicates that the signature of the PARes has been validated successfully and the message contents can be trusted. N - Indicates that the PARes could not be validated. This result could be for a variety of reasons; tampering, certificate expiration, etc., and the result should not be trusted.

authentication.status_reason!string

Provides additional information as to why the PAResStatus has the specific value. NOTE: Required for Payment (e.g. Authentication Indicator equals 01 on Lookup Request) transactions when PAResStatus is equal to N, U, or R in the Lookup Response.

authentication.threeds_version!string

This field contains the 3DS version that was used to process the transaction. Possible Values: 1.0.2 2.1.0 NOTE: Required for Mastercard Identity Check transactions in Authorization

authentication.xid!string

Third Party Token that is returned from the token provider after a card number is specified on the request. NOTE: This field is returned if Tokenization is enabled in the Merchant profile setting AND the Merchant is using a third party token provider.

encrypted_card!string

Client encrypted cardholder data. The cardholder data encrypted using the Verifone provided public key. This needs to be provided in base64 encoded format. The data to encrypt is a JSON with possible tags being cardNumber, sequenceNumber, cardholderName, startMonth, startYear, expiryMonth, expiryYear, cvv. Additionally a tag called captureTime must be presenting indicating the time the card was captured in UTC in format RFC 3339, section 5.6. eg. 2019-08-24T14:15:22Z. Sample JSON to encrypt:

    {
        "captureTime": '2019-08-24T14:15:22Z',
        "cardNumber": '5555555555554444',
        "expiryMonth": 1,
        "expiryYear": 2025,
        "cvv": '123',
    }

Note: encrypted_card is required if card or reuse_token is not provided.

public_key_alias!string

The alias for the public key used to encrypt this card. Note: public_key_alias is required if card or reuse_token is not provided.

_id~string

ThreeDSAuthentication id

card~string

The ID of the card that is checked for enrollment.

currency_code~string

Alphabetical ISO 4217 currency code for the sale amount.

entity_id~string

The ID of the entity, which this authentication belongs to.

threeds_contract_id~string

The ID of the threeDSContractId used.

transaction_id~string

To complete the transaction, the value is required to be passed on the Cardinal.Continue().

authentication.acs_rendering_type~string

Identifies the UI Type the ACS will use to complete the challenge. NOTE: Only available for App transactions using the Cardinal Mobile SDK and is optional for an Issuer to return.

authentication.acs_transaction_id~string

Unique transaction identifier assigned by the ACS to identify a single transaction.

authentication.acs_url~string

The fully qualified URL to redirect the Consumer to complete the Consumer Authentication transaction. NOTE: Available if Enrolled = Y

authentication.authentication_type~string

Indicates the type of authentication that will be used to challenge the card holder. Possible Values: 01 - Static 02 - Dynamic 03 - OOB (Out of Band)

authentication.authorization_payload~string

The Base64 encoded JSON Payload of CB specific Authorization Values returned in the Frictionless Flow.

authentication.card_brand~string

Card Brand

authentication.cardholder_info~string

Additional text provided by the Issuing Bank to the Cardholder during a Frictionless transaction and was not authenticated by the ACS. The Issuing Bank can optionally support this value.

authentication.cavv_algorithm~string

Indicates the algorithm used to generate the CAVV value. Possible Values: 2 - CVV with ATN 3 - Mastercard SPA algorithm

authentication.cavv~string

Cardholder Authentication Verification Value (CAVV). This value should be appended to the authorization message signifying that the transaction has been successfully authenticated. It will be encoded according to the Merchant's configuration in either Base64 encoding or Hex encoding. A Base64 encoding Merchant configuration will produce values of 28 or 32 characters. A Hex encoding Merchant configuration will produce values of 40 or 48 characters. The value when decoded will either be 20 bytes for CAVV.

authentication.challenge_cancel~'01' | '02' | '03' | '04' | '05' | '06' | '07' | '8.0'

An indicator as to why the transaction was canceled. Possible Values: 01 - Cardholder selected Cancel 02 - Reserved for future EMVCo use (values invalid until defined by EMVCo). 03 - Transaction Timed Out—Decoupled Authentication 04 - Transaction timed out at ACS—other timeouts 05 - Transaction Timed out at ACS - First CReq not received by ACS 06 - Transaction Error 07 - Unknown 08 = Transaction Timed Out at SDK NOTE: Only present when the Consumer cancels the challenge. Decoupled authentication is not supported at this time.

authentication.challenge_required~string

Indicates whether a challenge is required to complete authentication. For example, regional mandates. Possible Values: Y - Challenge Required N - Challenge Not Required

authentication.ds_transaction_id~string

Unique transaction identifier assigned by the Directory Server (DS) to identify a single transaction. NOTE: Required for Mastercard Identity Check transaction in Authorization - Only available in EMV 3DS (3DS 2.0) transactions

authentication.eci_flag~string

Electronic Commerce Indicator (ECI). The ECI value is part of the 2 data elements that indicate the transaction was processed electronically. This should be passed on the authorization transaction to the Gateway/Processor. Possible Values: 02 or 05 - Fully Authenticated Transaction 01 or 06 - Attempted Authentication Transaction 00 or 07 - Non 3D Secure Transaction Mastercard - 02, 01, 00 VISA - 05, 06, 07 AMEX - 05, 06, 07 JCB - 05, 06, 07 DINERS CLUB - 05, 06, 07 NOTE: 3DS 2.0 field

authentication.enrolled~string

Status of Authentication eligibility. Possible Values: Y - Yes, Bank is participating in 3D Secure protocol and will return the ACSUrl N - No, Bank is not participating in 3D Secure protocol U - Unavailable, The DS or ACS is not available for authentication at the time of the request B - Bypass, Merchant authentication rule is triggered to bypass authentication in this use case NOTE: If the Enrolled value is NOT Y, then the Consumer is NOT eligible for Authentication.

authentication.error_desc~string

Application error description for the associated error number(s). NOTE: Multiple error descriptions are separated by a comma.

authentication.error_no~string

Application error number(s). A non-zero value represents the error encountered while attempting to process the message request. NOTE: Multiple error numbers are separated by a comma.

authentication.network_score~string

The global score calculated by the CB Scoring platform..

authentication.order_id~string

3DS server generated order identifier. Used to link multiple actions on a single order to a single identifier. Mod-10 compliant and unique BIN range to 3DS services.

authentication.pares_status~string

Transactions status result identifier. Possible Values: Y - Successful Authentication N - Failed Authentication U - Unable to Complete Authentication A - Successful Attempts Transaction C - Challenge Required for Authentication R - Authentication Rejected (Merchant must not submit for authorization) NOTE: Statuses of C and R only apply to Consumer Authentication 2.0.,

authentication.payload~string

The encoded payment request generated by Centinel. NOTE: Available if Enrolled = Y

authentication.reason_code~string

The error code indicating a problem with this transaction.

authentication.reason_desc~string

Text and additional detail about the error for this transaction. NOTE: This field concatenates the errorDescription and errorDetail from the authentication response message

authentication.signature_verification~string

Transaction Signature status identifier. Possible Values: Y - Indicates that the signature of the PARes has been validated successfully and the message contents can be trusted. N - Indicates that the PARes could not be validated. This result could be for a variety of reasons; tampering, certificate expiration, etc., and the result should not be trusted.

authentication.status_reason~string

Provides additional information as to why the PAResStatus has the specific value. NOTE: Required for Payment (e.g. Authentication Indicator equals 01 on Lookup Request) transactions when PAResStatus is equal to N, U, or R in the Lookup Response.

authentication.threeds_version~string

This field contains the 3DS version that was used to process the transaction. Possible Values: 1.0.2 2.1.0 NOTE: Required for Mastercard Identity Check transactions in Authorization

authentication.xid~string

Third Party Token that is returned from the token provider after a card number is specified on the request. NOTE: This field is returned if Tokenization is enabled in the Merchant profile setting AND the Merchant is using a third party token provider.

encrypted_card~string

Client encrypted cardholder data. The cardholder data encrypted using the Verifone provided public key. This needs to be provided in base64 encoded format. The data to encrypt is a JSON with possible tags being cardNumber, sequenceNumber, cardholderName, startMonth, startYear, expiryMonth, expiryYear, cvv. Additionally a tag called captureTime must be presenting indicating the time the card was captured in UTC in format RFC 3339, section 5.6. eg. 2019-08-24T14:15:22Z. Sample JSON to encrypt:

    {
        "captureTime": '2019-08-24T14:15:22Z',
        "cardNumber": '5555555555554444',
        "expiryMonth": 1,
        "expiryYear": 2025,
        "cvv": '123',
    }

Note: encrypted_card is required if card or reuse_token is not provided.

public_key_alias~string

The alias for the public key used to encrypt this card. Note: public_key_alias is required if card or reuse_token is not provided.

amount>number

The amount of the transaction.

created_at>string date

The time at which the authentication was created.

amount<number

The amount of the transaction.

created_at<string date

The time at which the authentication was created.

Response

Successful

_idstring

ThreeDSAuthentication id

amountnumber

The amount of the transaction.

threeds_contract_idstring

The ID of the threeDSContractId used.

cardstring

The ID of the card that is checked for enrollment.

currency_codestring

Alphabetical ISO 4217 currency code for the sale amount.

created_atstring date

The time at which the authentication was created.

entity_idstring

The ID of the entity, which this authentication belongs to.

transaction_idstring

To complete the transaction, the value is required to be passed on the Cardinal.Continue().