--- title: "List ThreeDSAuthentications" method: GET path: "/v2/3d" tags: ["3DS Authentication"] --- # 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¤cy_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¤cy_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:** | Operator | Description | |---|---| | `=` | equal | | `!` | not equal | | `<` | less than or equal to | | `>` | greater than or equal to | | `~` | pattern matching | | `>&<` | multiple-argument (range) search | ## Query parameters - `_limit` integer - `_skip` integer - `_sort` string[] - `_id` string - `amount` number - `card` string - `created_at` string, date - `currency_code` string - `entity_id` string - `threeds_contract_id` string - `transaction_id` string - `authentication.acs_rendering_type` string - `authentication.acs_transaction_id` string - `authentication.acs_url` string - `authentication.authentication_type` string - `authentication.authorization_payload` string - `authentication.card_brand` string - `authentication.cardholder_info` string - `authentication.cavv_algorithm` string - `authentication.cavv` string - `authentication.challenge_cancel` '01' | '02' | '03' | '04' | '05' | '06' | '07' | '8.0' - `authentication.challenge_required` string - `authentication.ds_transaction_id` string - `authentication.eci_flag` string - `authentication.enrolled` string - `authentication.error_desc` string - `authentication.error_no` string - `authentication.network_score` string - `authentication.order_id` string - `authentication.pares_status` string - `authentication.payload` string - `authentication.reason_code` string - `authentication.reason_desc` string - `authentication.signature_verification` string - `authentication.status_reason` string - `authentication.threeds_version` string - `authentication.xid` string - `encrypted_card` string - `public_key_alias` string - `_id!` string - `amount!` number - `card!` string - `created_at!` string, date - `currency_code!` string - `entity_id!` string - `threeds_contract_id!` string - `transaction_id!` string - `authentication.acs_rendering_type!` string - `authentication.acs_transaction_id!` string - `authentication.acs_url!` string - `authentication.authentication_type!` string - `authentication.authorization_payload!` string - `authentication.card_brand!` string - `authentication.cardholder_info!` string - `authentication.cavv_algorithm!` string - `authentication.cavv!` string - `authentication.challenge_cancel!` '01' | '02' | '03' | '04' | '05' | '06' | '07' | '8.0' - `authentication.challenge_required!` string - `authentication.ds_transaction_id!` string - `authentication.eci_flag!` string - `authentication.enrolled!` string - `authentication.error_desc!` string - `authentication.error_no!` string - `authentication.network_score!` string - `authentication.order_id!` string - `authentication.pares_status!` string - `authentication.payload!` string - `authentication.reason_code!` string - `authentication.reason_desc!` string - `authentication.signature_verification!` string - `authentication.status_reason!` string - `authentication.threeds_version!` string - `authentication.xid!` string - `encrypted_card!` string - `public_key_alias!` string - `_id~` string - `card~` string - `currency_code~` string - `entity_id~` string - `threeds_contract_id~` string - `transaction_id~` string - `authentication.acs_rendering_type~` string - `authentication.acs_transaction_id~` string - `authentication.acs_url~` string - `authentication.authentication_type~` string - `authentication.authorization_payload~` string - `authentication.card_brand~` string - `authentication.cardholder_info~` string - `authentication.cavv_algorithm~` string - `authentication.cavv~` string - `authentication.challenge_cancel~` '01' | '02' | '03' | '04' | '05' | '06' | '07' | '8.0' - `authentication.challenge_required~` string - `authentication.ds_transaction_id~` string - `authentication.eci_flag~` string - `authentication.enrolled~` string - `authentication.error_desc~` string - `authentication.error_no~` string - `authentication.network_score~` string - `authentication.order_id~` string - `authentication.pares_status~` string - `authentication.payload~` string - `authentication.reason_code~` string - `authentication.reason_desc~` string - `authentication.signature_verification~` string - `authentication.status_reason~` string - `authentication.threeds_version~` string - `authentication.xid~` string - `encrypted_card~` string - `public_key_alias~` string - `amount>` number - `created_at>` string, date - `amount<` number - `created_at<` string, date ## Response `200` Successful - ThreeDSAuthentication[] - `_id` string — ThreeDSAuthentication id - `amount` number — The amount of the transaction. - `threeds_contract_id` string — The ID of the threeDSContractId used. - `authentication` AuthenticationResult - `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 - `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. - `error_desc` string — Application error description for the associated error number(s). NOTE: Multiple error descriptions are separated by a comma. - `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. - `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. - `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 - `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. - `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 - `acs_url` string — The fully qualified URL to redirect the Consumer to complete the Consumer Authentication transaction. NOTE: Available if Enrolled = Y - `card_brand` string — Card Brand - `network_score` string — The global score calculated by the CB Scoring platform. - `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. - `authorization_payload` string — The Base64 encoded JSON Payload of CB specific Authorization Values returned in the Frictionless Flow. - `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. - `cavv_algorithm` string — Indicates the algorithm used to generate the CAVV value. Possible Values: 2 - CVV with ATN 3 - Mastercard SPA algorithm - `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., - `payload` string — The encoded payment request generated by Centinel. NOTE: Available if Enrolled = Y. - `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. - `reason_code` string — The error code indicating a problem with this transaction. - `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. - `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. - `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. - `acs_transaction_id` string — Unique transaction identifier assigned by the ACS to identify a single transaction. - `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) - `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 - `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 - `card` string — The ID of the card that is checked for enrollment. - `currency_code` string — Alphabetical ISO 4217 currency code for the sale amount. - `created_at` string, date — The time at which the authentication was created. - `entity_id` string — The ID of the entity, which this authentication belongs to. - `transaction_id` string — To complete the transaction, the value is required to be passed on the Cardinal.Continue(). ## Other responses - `400` — Bad Request - `401` — Unauthorized - `403` — Forbidden - `404` — Not Found - `500` — Internal Server Error - `504` — Gateway Time-out --- [API](https://skmtc.net/verifone/apis/checkout-api.md) · [All operations](https://skmtc.net/verifone/apis/checkout-api/llms.txt) · [OpenAPI document](https://skmtc-service-staging.skmtc.workers.dev/v1/apis/verifone/checkout-api/revisions/ed8dc1f12a5a/schema)