3DS Authentication

The 3DS Authentication endpoints let you query historical authentication records associated with your entity. Use them to audit authentication outcomes, reconcile transactions, and investigate specific authentication events by ID.

How It Works

1

Build your query

Choose your filter criteria — amount, currency, card, pares_status, date range, or any authentication.* sub-field. Combine multiple parameters in the query string using the operators below.

2

Send the request

Call GET /v2/3d with your filters. Use _limit and _skip for pagination and _sort to control ordering. For a total count without fetching records, call GET /v2/3d/count with the same filters.

3

Read the response

The response returns an array of ThreeDSAuthentication objects. Each record includes the full authentication sub-object with enrollment status, ECI flag, CAVV, pares_status, and more. To fetch a single known record, use GET /v2/3d/{id}.

Query Operators

Append filter parameters directly to the query string. All authentication.* nested fields are supported as filter and sort keys.

/v2/3d?amount=7500
/v2/3d?currency_code=EUR
/v2/3d?authentication.pares_status=Y
Operator
Description

=

Equal

!

Not equal

<

Less than or equal to

>

Greater than or equal to

~

Pattern matching

>&<

Range (multiple-argument) search

pares_status Values

Authentication was fully successful. Proceed with the authorization.

enrolled Values

Bank is participating in 3D Secure and will return an acs_url. The consumer is eligible for authentication.

API Reference

List ThreeDSAuthentications

get
/v2/3d

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:

Limit the number of results:

Sort results in descending order:

Sort results in ascending order:

Query operators:

Operator
Description

=

equal

!

not equal

<

less than or equal to

>

greater than or equal to

~

pattern matching

>&<

multiple-argument (range) search

Authorizations
AuthorizationstringRequired

JWT Bearer token. Pass as: Authorization: Bearer <token>. The JWT must be signed with your Verifone-provisioned private key and must include entity_id, sub (user_id), and roles claims.

Query parameters
_limitinteger · min: 1 · max: 10000Optional

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

Default: 2000
_skipintegerOptional

_skip query params

Default: 0
_idstringOptional

ThreeDSAuthentication id

amountnumber · max: 9007199254740991Optional

The amount of the transaction.

cardstringOptional

The ID of the card that is checked for enrollment.

created_atstring · dateOptional

The time at which the authentication was created.

currency_codestring · min: 3 · max: 3Optional

Alphabetical ISO 4217 currency code for the sale amount.

entity_idstringOptional

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

threeds_contract_idstringOptional

The ID of the threeDSContractId used.

transaction_idstringOptional

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

authentication.acs_rendering_typestringOptional

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_idstringOptional

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

authentication.acs_urlstringOptional

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

authentication.authentication_typestringOptional

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_payloadstringOptional

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

Pattern: ^(?:[A-Za-z0-9+\/]{2}[A-Za-z0-9+\/]{2})*(?:[A-Za-z0-9+\/]{2}==|[A-Za-z0-9+\/]{3}=)?$
authentication.card_brandstringOptional

Card Brand

authentication.cardholder_infostringOptional

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_algorithmstringOptional

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

authentication.cavvstringOptional

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_cancelstring · enumOptional

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.

Possible values:
authentication.challenge_requiredstringOptional

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_idstringOptional

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_flagstringOptional

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.enrolledstringOptional

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_descstringOptional

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

authentication.error_nostringOptional

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 · max: 2Optional

The global score calculated by the CB Scoring platform.

authentication.order_idstringOptional

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_statusstringOptional

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.payloadstringOptional

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

authentication.reason_codestringOptional

The error code indicating a problem with this transaction.

authentication.reason_descstringOptional

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_verificationstringOptional

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_reasonstringOptional

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_versionstringOptional

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.xidstringOptional

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_cardstringOptional

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_aliasstringOptional

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!stringOptional

ThreeDSAuthentication id

amount!number · max: 9007199254740991Optional

The amount of the transaction.

card!stringOptional

The ID of the card that is checked for enrollment.

created_at!string · dateOptional

The time at which the authentication was created.

currency_code!string · min: 3 · max: 3Optional

Alphabetical ISO 4217 currency code for the sale amount.

entity_id!stringOptional

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

threeds_contract_id!stringOptional

The ID of the threeDSContractId used.

transaction_id!stringOptional

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

authentication.acs_rendering_type!stringOptional

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!stringOptional

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

authentication.acs_url!stringOptional

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

authentication.authentication_type!stringOptional

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!stringOptional

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

Pattern: ^(?:[A-Za-z0-9+\/]{2}[A-Za-z0-9+\/]{2})*(?:[A-Za-z0-9+\/]{2}==|[A-Za-z0-9+\/]{3}=)?$
authentication.card_brand!stringOptional

Card Brand

authentication.cardholder_info!stringOptional

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!stringOptional

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

authentication.cavv!stringOptional

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!string · enumOptional

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.

Possible values:
authentication.challenge_required!stringOptional

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!stringOptional

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!stringOptional

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!stringOptional

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!stringOptional

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

authentication.error_no!stringOptional

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 · max: 2Optional

The global score calculated by the CB Scoring platform.

authentication.order_id!stringOptional

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!stringOptional

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!stringOptional

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

authentication.reason_code!stringOptional

The error code indicating a problem with this transaction.

authentication.reason_desc!stringOptional

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!stringOptional

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!stringOptional

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!stringOptional

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!stringOptional

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!stringOptional

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!stringOptional

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~stringOptional

ThreeDSAuthentication id

card~stringOptional

The ID of the card that is checked for enrollment.

currency_code~string · min: 3 · max: 3Optional

Alphabetical ISO 4217 currency code for the sale amount.

entity_id~stringOptional

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

threeds_contract_id~stringOptional

The ID of the threeDSContractId used.

transaction_id~stringOptional

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

authentication.acs_rendering_type~stringOptional

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~stringOptional

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

authentication.acs_url~stringOptional

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

authentication.authentication_type~stringOptional

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~stringOptional

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

Pattern: ^(?:[A-Za-z0-9+\/]{2}[A-Za-z0-9+\/]{2})*(?:[A-Za-z0-9+\/]{2}==|[A-Za-z0-9+\/]{3}=)?$
authentication.card_brand~stringOptional

Card Brand

authentication.cardholder_info~stringOptional

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~stringOptional

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

authentication.cavv~stringOptional

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~string · enumOptional

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.

Possible values:
authentication.challenge_required~stringOptional

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~stringOptional

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~stringOptional

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~stringOptional

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~stringOptional

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

authentication.error_no~stringOptional

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 · max: 2Optional

The global score calculated by the CB Scoring platform..

authentication.order_id~stringOptional

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~stringOptional

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~stringOptional

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

authentication.reason_code~stringOptional

The error code indicating a problem with this transaction.

authentication.reason_desc~stringOptional

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~stringOptional

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~stringOptional

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~stringOptional

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~stringOptional

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~stringOptional

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~stringOptional

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 · max: 9007199254740991Optional

The amount of the transaction.

created_at>string · dateOptional

The time at which the authentication was created.

amount<number · max: 9007199254740991Optional

The amount of the transaction.

created_at<string · dateOptional

The time at which the authentication was created.

Responses
200

Successful

application/json
_idstringOptional

ThreeDSAuthentication id

Example: f1aeb720-9bd9-4667-a24f-979fb8175c65
amountnumber · max: 9007199254740991Optional

The amount of the transaction.

Example: 20cde61c-cdd0-4a5a-90f6-47ba4f1e5704
threeds_contract_idstringOptional

The ID of the threeDSContractId used.

Example: 7076974d-04b9-4375-9814-e9313f6bd036
cardstringOptional

The ID of the card that is checked for enrollment.

currency_codestring · min: 3 · max: 3Optional

Alphabetical ISO 4217 currency code for the sale amount.

Example: USD
created_atstring · dateOptional

The time at which the authentication was created.

entity_idstringOptional

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

Example: 516af950-02b8-43fb-9955-1c01d0d67e90
transaction_idstringOptional

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

Example: ppWyiLx7GnvTLlqFZtM1
get
/v2/3d

Count ThreeDSAuthentication

get
/v2/3d/count

The API provides the total number of threeDS authentications and can be queried by appending parameters to the query string of the URL.

Authorizations
AuthorizationstringRequired

JWT Bearer token. Pass as: Authorization: Bearer <token>. The JWT must be signed with your Verifone-provisioned private key and must include entity_id, sub (user_id), and roles claims.

Query parameters
_idstringOptional

ThreeDSAuthentication id

amountnumber · max: 9007199254740991Optional

The amount of the transaction.

cardstringOptional

The ID of the card that is checked for enrollment.

created_atstring · dateOptional

The time at which the authentication was created.

currency_codestring · min: 3 · max: 3Optional

Alphabetical ISO 4217 currency code for the sale amount.

entity_idstringOptional

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

threeds_contract_idstringOptional

The ID of the threeDSContractId used.

transaction_idstringOptional

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

authentication.acs_rendering_typestringOptional

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_idstringOptional

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

authentication.acs_urlstringOptional

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

authentication.authentication_typestringOptional

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_payloadstringOptional

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

Pattern: ^(?:[A-Za-z0-9+\/]{2}[A-Za-z0-9+\/]{2})*(?:[A-Za-z0-9+\/]{2}==|[A-Za-z0-9+\/]{3}=)?$
authentication.card_brandstringOptional

Card Brand

authentication.cardholder_infostringOptional

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_algorithmstringOptional

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

authentication.cavvstringOptional

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_cancelstring · enumOptional

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.

Possible values:
authentication.challenge_requiredstringOptional

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_idstringOptional

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_flagstringOptional

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.enrolledstringOptional

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_descstringOptional

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

authentication.error_nostringOptional

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 · max: 2Optional

The global score calculated by the CB Scoring platform.

authentication.order_idstringOptional

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_statusstringOptional

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.payloadstringOptional

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

authentication.reason_codestringOptional

The error code indicating a problem with this transaction.

authentication.reason_descstringOptional

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_verificationstringOptional

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_reasonstringOptional

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_versionstringOptional

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.xidstringOptional

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_cardstringOptional

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_aliasstringOptional

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!stringOptional

ThreeDSAuthentication id

amount!number · max: 9007199254740991Optional

The amount of the transaction.

card!stringOptional

The ID of the card that is checked for enrollment.

created_at!string · dateOptional

The time at which the authentication was created.

currency_code!string · min: 3 · max: 3Optional

Alphabetical ISO 4217 currency code for the sale amount.

entity_id!stringOptional

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

threeds_contract_id!stringOptional

The ID of the threeDSContractId used.

transaction_id!stringOptional

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

authentication.acs_rendering_type!stringOptional

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!stringOptional

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

authentication.acs_url!stringOptional

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

authentication.authentication_type!stringOptional

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!stringOptional

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

Pattern: ^(?:[A-Za-z0-9+\/]{2}[A-Za-z0-9+\/]{2})*(?:[A-Za-z0-9+\/]{2}==|[A-Za-z0-9+\/]{3}=)?$
authentication.card_brand!stringOptional

Card Brand

authentication.cardholder_info!stringOptional

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!stringOptional

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

authentication.cavv!stringOptional

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!string · enumOptional

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.

Possible values:
authentication.challenge_required!stringOptional

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!stringOptional

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!stringOptional

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!stringOptional

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!stringOptional

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

authentication.error_no!stringOptional

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 · max: 2Optional

The global score calculated by the CB Scoring platform.

authentication.order_id!stringOptional

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!stringOptional

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!stringOptional

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

authentication.reason_code!stringOptional

The error code indicating a problem with this transaction.

authentication.reason_desc!stringOptional

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!stringOptional

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!stringOptional

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!stringOptional

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!stringOptional

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!stringOptional

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!stringOptional

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~stringOptional

ThreeDSAuthentication id

card~stringOptional

The ID of the card that is checked for enrollment.

currency_code~string · min: 3 · max: 3Optional

Alphabetical ISO 4217 currency code for the sale amount.

entity_id~stringOptional

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

threeds_contract_id~stringOptional

The ID of the threeDSContractId used.

transaction_id~stringOptional

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

authentication.acs_rendering_type~stringOptional

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~stringOptional

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

authentication.acs_url~stringOptional

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

authentication.authentication_type~stringOptional

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~stringOptional

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

Pattern: ^(?:[A-Za-z0-9+\/]{2}[A-Za-z0-9+\/]{2})*(?:[A-Za-z0-9+\/]{2}==|[A-Za-z0-9+\/]{3}=)?$
authentication.card_brand~stringOptional

Card Brand

authentication.cardholder_info~stringOptional

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~stringOptional

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

authentication.cavv~stringOptional

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~string · enumOptional

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.

Possible values:
authentication.challenge_required~stringOptional

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~stringOptional

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~stringOptional

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~stringOptional

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~stringOptional

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

authentication.error_no~stringOptional

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 · max: 2Optional

The global score calculated by the CB Scoring platform.

authentication.order_id~stringOptional

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~stringOptional

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~stringOptional

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

authentication.reason_code~stringOptional

The error code indicating a problem with this transaction.

authentication.reason_desc~stringOptional

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~stringOptional

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~stringOptional

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~stringOptional

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~stringOptional

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~stringOptional

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~stringOptional

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 · max: 9007199254740991Optional

The amount of the transaction.

created_at>string · dateOptional

The time at which the authentication was created.

amount<number · max: 9007199254740991Optional

The amount of the transaction.

created_at<string · dateOptional

The time at which the authentication was created.

Responses
200

Successful

application/json
countnumberRequired

count.

get
/v2/3d/count

Get ThreeDSAuthentication by ID

get
/v2/3d/{id}

The API returns details about a particular threeDSAuthentication associated with the provided ID.

Authorizations
AuthorizationstringRequired

JWT Bearer token. Pass as: Authorization: Bearer <token>. The JWT must be signed with your Verifone-provisioned private key and must include entity_id, sub (user_id), and roles claims.

Path parameters
idstringRequired

ThreeDSAuthentication id

Responses
200

Successful

application/json
_idstringOptional

ThreeDSAuthentication id

Example: f1aeb720-9bd9-4667-a24f-979fb8175c65
amountnumber · max: 9007199254740991Optional

The amount of the transaction.

Example: 20cde61c-cdd0-4a5a-90f6-47ba4f1e5704
threeds_contract_idstringOptional

The ID of the threeDSContractId used.

Example: 7076974d-04b9-4375-9814-e9313f6bd036
cardstringOptional

The ID of the card that is checked for enrollment.

currency_codestring · min: 3 · max: 3Optional

Alphabetical ISO 4217 currency code for the sale amount.

Example: USD
created_atstring · dateOptional

The time at which the authentication was created.

entity_idstringOptional

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

Example: 516af950-02b8-43fb-9955-1c01d0d67e90
transaction_idstringOptional

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

Example: ppWyiLx7GnvTLlqFZtM1
get
/v2/3d/{id}

Last updated

Was this helpful?