List ThreeDSAuthentications

The 3D Secure API provides endpoints for managing 3D Secure authentication processes, including initiating authentication requests and retrieving authentication results.

Query Params
integer
1 to 10000
Defaults to 2000

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

integer
≥ 0
Defaults to 0

_skip query params

_sort
array of strings

_sort query params

_sort
string

ThreeDSAuthentication id

number
≤ 9007199254740991

The amount of the transaction.

string

The ID of the card that is checked for enrollment.

date

The time at which the authentication was created.

string
length between 3 and 3

Alphabetical ISO 4217 currency code for the sale amount.

string

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

string

The ID of the threeDSContractId used.

string

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

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.

string

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

string

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

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)

string

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

string

Card Brand

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.

string

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

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.

string
enum

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.

string

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

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

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

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.

string

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

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.

string
length ≤ 2

The global score calculated by the CB Scoring platform.

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.

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

string

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

string

The error code indicating a problem with this transaction.

string

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

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.

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.

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

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.

string

Client encrypted cardholder data. The cardholder data encrypted using the OnlinePay 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.

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.

string

ThreeDSAuthentication id

number
≤ 9007199254740991

The amount of the transaction.

string

The ID of the card that is checked for enrollment.

date

The time at which the authentication was created.

string
length between 3 and 3

Alphabetical ISO 4217 currency code for the sale amount.

string

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

string

The ID of the threeDSContractId used.

string

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

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.

string

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

string

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

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)

string

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

string

Card Brand

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.

string

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

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.

string
enum

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.

string

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

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

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

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.

string

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

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.

string
length ≤ 2

The global score calculated by the CB Scoring platform.

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.

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

string

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

string

The error code indicating a problem with this transaction.

string

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

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.

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.

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

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.

string

Client encrypted cardholder data. The cardholder data encrypted using the OnlinePay 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.

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.

string

ThreeDSAuthentication id

string

The ID of the card that is checked for enrollment.

string
length between 3 and 3

Alphabetical ISO 4217 currency code for the sale amount.

string

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

string

The ID of the threeDSContractId used.

string

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

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.

string

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

string

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

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)

string

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

string

Card Brand

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.

string

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

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.

string
enum

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.

string

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

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

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

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.

string

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

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.

string
length ≤ 2

The global score calculated by the CB Scoring platform..

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.

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

string

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

string

The error code indicating a problem with this transaction.

string

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

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.

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.

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

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.

string

Client encrypted cardholder data. The cardholder data encrypted using the OnlinePay 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.

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.

number
≤ 9007199254740991

The amount of the transaction.

date

The time at which the authentication was created.

number
≤ 9007199254740991

The amount of the transaction.

date

The time at which the authentication was created.

Responses

Language
Credentials
Basic
base64
:
URL
LoadingLoading…
Response
Click Try It! to start a request and see the response here! Or choose an example:
application/json

Terms and conditions Website requirements Other fees and charges

This information is a general statement for information purposes only and should only be used as a guide. While all care has been taken in preparation of this document, no member of the Westpac Group, nor any of their employees or directors gives any warranty of accuracy or reliability nor accepts any liability in any other way, including by reason of negligence for any errors or omissions contained herein, to the extent permitted by law. Unless otherwise specified, the products and services described are available only in Australia.

© Westpac Banking Corporation ABN 33 007 457 141 AFSL and Australian credit licence 233714.