Skip to main content

AuthResponse

acsChallengeMandatedstringnullable

Indication of whether a challenge is required for the transaction to be authorised due to local/regional mandates or other variable. Required if transStatus is one of [C, D]. Applies to categories PA, NPA and channels APP, BRW, 3RI.

Possible values: [Y, N]

acsDecConIndstringnullable

Indicates whether the ACS confirms utilisation of Decoupled Authentication and agrees to utilise Decoupled Authentication to authenticate the Cardholder. Required if transStatus is "D". Applies to categories PA, NPA and channels APP, BRW, 3RI.

Possible values: [Y, N]

acsOperatorIDstringnullable

DS assigned ACS identifier. Each DS can provide a unique ID to each ACS on an individual basis. Applies to categories PA, NPA and channels APP, BRW, 3RI.

Possible values: <= 32 characters

acsReferenceNumberstringrequired

Unique identifier assigned by the EMVCo Secretariat upon Testing and Approval. Applies to categories PA, NPA and channels APP, BRW, 3RI.

Possible values: <= 32 characters

acsRenderingType objectnullable

Identifies the ACS UI Template that the ACS will first present to the consumer. Required if deviceChannel is "01" and transStatus is "C". Applies to categories PA, NPA and channel APP.

acsInterfacestringrequired

This the ACS interface that the challenge will present to the cardholder.

  • 01: Native UI
  • 02: HTML UI

Possible values: [01, 02]

acsUiTemplatestringrequired

Identifies the UI Template format that the ACS first presents to the consumer.

  • 01: Text
  • 02: Single Select
  • 03: Multi Select
  • 04: OOB
  • 05: HTML Other

Possible values: [01, 02, 03, 04, 05]

acsSignedContentstringnullable

Contains the JWS object (represented as a string) created by the ACS for the ARes message. Required if transStatus is "C". Required if deviceChannel is "01". Applies to categories PA, NPA and channel APP.

Possible values: Value must match regular expression ^[A-Za-z0-9-_]+\.[A-Za-z0-9-_]+\.[A-Za-z0-9-_]+$

acsTransIDstring<uuid>required

Universally unique transaction identifier assigned by the ACS to identify a single transaction. Applies to categories PA, NPA and channels APP, BRW, 3RI.

acsURLstring<uri>nullable

Fully qualified URL of the ACS to be used for the challenge. 02-BRW—3DS Requestor will post the CReq to this URL via the challenge window Required if deviceChannel is "02". Required if transStatus is "C". Applies to categories PA, NPA and channel BRW.

Possible values: <= 2048 characters

authenticationTypestringnullable

Indicates the type of authentication method the Issuer will use to challenge the Cardholder, whether in the ARes message or what was used by the ACS when in the RReq message. Required if transStatus is one of [C, D]. Applies to categories PA, NPA and channels APP, BRW, 3RI.

  • 01: Static
  • 02: Dynamic
  • 03: OOB
  • 04: Decoupled
  • 80-99: Reserved for DS use

Possible values: Value must match regular expression ^(0[1-4]|[89][0-9])$

authenticationValuestringnullable

Payment System-specific value provided by the ACS or the DS using an algorithm defined by Payment System. Authentication Value may be used to provide proof of authentication. Required if messageCategory is "01". Required if transStatus is one of [Y, A]. Applies to categories PA, NPA and channels APP, BRW, 3RI.

Possible values: >= 28 characters and <= 28 characters, Value must match regular expression ^[a-zA-Z0-9+/]{26,28}={0,2}$

cardholderInfostringnullable

Text provided by the ACS/Issuer to Cardholder during a Frictionless or Decoupled transaction. The Issuer can provide information to Cardholder. For example, “Additional authentication is needed for this transaction, please contact (Issuer Name) at xxx-xxx-xxxx.” Required if acsDecConInd is "Y". Applies to categories PA, NPA and channels APP, BRW, 3RI.

Possible values: <= 128 characters

dsReferenceNumberstringrequired

EMVCo-assigned unique identifier to track approved DS. Applies to categories PA, NPA and channels APP, BRW, 3RI.

Possible values: <= 32 characters

dsTransIDstring<uuid>required

Universally unique transaction identifier assigned by the DS to identify a single transaction. Applies to categories PA, NPA and channels APP, BRW, 3RI.

Possible values: <= 36 characters

ecistringnullable

Payment System-specific value provided by the ACS or DS to indicate the results of the attempt to authenticate the Cardholder. Applies to categories PA, NPA and channels APP, BRW, 3RI.

Possible values: <= 2 characters

messageExtension object[]nullable

Data necessary to support requirements not otherwise defined in the 3-D Secure message are carried in a Message Extension. Applies to categories PA, NPA and channels APP, BRW, 3RI.

Possible values: <= 10

  • Array [
    • criticalityIndicatorbooleanrequired

    A Boolean value indicating whether the recipient must understand the contents of the extension to interpret the entire message.

    data objectrequired

    The data carried in the extension. Max length: 8059.

    property name*any

    The data carried in the extension. Max length: 8059.

    idstringrequired

    A unique identifier for the extension. Note: Payment System Registered Application Provider Identifier (RID) is required as prefix of the ID.

    Possible values: <= 64 characters

    namestringrequired

    The name of the extension data set as defined by the extension owner.

    Possible values: <= 64 characters

  • ]
    • messageTypestringrequired

    Identifies the type of message that is passed. Applies to categories PA, NPA and channels APP, BRW, 3RI.

    Possible values: [ARes]

    messageVersionstringrequired

    Protocol version identifier. This shall be the Protocol Version Number of the specification utilised by the system creating this message. Applies to categories PA, NPA and channels APP, BRW, 3RI.

    Possible values: [2.2.0]

    sdkTransIDstring<uuid>nullable

    Universally unique transaction identifier assigned by the 3DS SDK to identify a single transaction. Required if deviceChannel is "01". Applies to categories PA, NPA and channel APP.

    threeDSServerTransIDstring<uuid>required

    Universally unique transaction identifier assigned by the 3DS Server to identify a single transaction. Applies to categories PA, NPA and channels APP, BRW, 3RI.

    transStatusstringnullable

    Indicates whether a transaction qualifies as an authenticated transaction or account verification. Required if messageCategory is "01". Applies to categories PA, NPA and channels APP, BRW, 3RI.

    • Y: Authentication/ Account Verification Successful
    • N: Not Authenticated /Account Not Verified; Transaction denied
    • U: Authentication/ Account Verification Could Not Be Performed; Technical or other problem, as indicated in ARes or RReq
    • A: Attempts Processing Performed; Not Authenticated/Verified, but a proof of attempted authentication/verification is provided
    • C: Challenge Required; Additional authentication is required using the CReq/CRes
    • D: Challenge Required; Decoupled Authentication confirmed.
    • R: Authentication/ Account Verification Rejected; Issuer is rejecting authentication/verification and request that authorisation not be attempted.
    • I: Informational Only; 3DS Requestor challenge preference acknowledged.

    Possible values: [Y, N, U, A, C, D, R, I]

    transStatusReasonstringnullable

    Provides information on why the Transaction Status field has the specified value. Required if messageCategory is "01". Required if transStatus is one of [N, U, R]. Applies to categories PA, NPA and channels APP, BRW, 3RI.

    • 01: Card authentication failed
    • 02: Unknown Device
    • 03: Unsupported Device
    • 04: Exceeds authentication frequency limit
    • 05: Expired card
    • 06: Invalid card number
    • 07: Invalid transaction
    • 08: No Card record
    • 09: Security failure
    • 10: Stolen card
    • 11: Suspected fraud
    • 12: Transaction not permitted to cardholder
    • 13: Cardholder not enrolled in service
    • 14: Transaction timed out at the ACS
    • 15: Low confidence
    • 16: Medium confidence
    • 17: High confidence
    • 18: Very High confidence
    • 19: Exceeds ACS maximum challenges
    • 20: Non-Payment transaction not supported
    • 21: 3RI transaction not supported
    • 22: ACS technical issue
    • 23: Decoupled Authentication required by ACS but not requested by 3DS Requestor
    • 24: 3DS Requestor Decoupled Max Expiry Time exceeded
    • 25: Decoupled Authentication was provided insufficient time to authenticate cardholder. ACS will not make attempt
    • 26: Authentication attempted but not performed by the cardholder
    • 80-99: Reserved for DS use

    Possible values: Value must match regular expression ^(0[1-9]|1[0-9]|2[0-6]|[89][0-9])$

    whiteListStatusstringnullable

    Enables the communication of trusted beneficiary/whitelist status between the ACS, the DS and the 3DS Requestor. Note: Valid values in the AReq message are Y or N. Applies to categories PA, NPA and channels APP, BRW, 3RI.

    • Y: 3DS Requestor is whitelisted by cardholder
    • N: 3DS Requestor is not whitelisted by cardholder
    • E: Not eligible as determined by issuer
    • P: Pending confirmation by cardholder
    • R: Cardholder rejected
    • U: Whitelist status unknown, unavailable, or does not apply

    Possible values: [Y, N, E, P, R, U]

    whiteListStatusSourcestringnullable

    This data element will be populated by the system setting Whitelist Status. Required if whiteListStatus is not empty. Applies to categories PA, NPA and channels APP, BRW, 3RI.

    • 01: 3DS Server
    • 02: DS
    • 03: ACS
    • 80-99: Reserved for DS use

    Possible values: Value must match regular expression ^(0[123]|[89][0-9])$

    AuthResponse
    {
      "acsChallengeMandated": "Y",
      "acsDecConInd": "Y",
      "acsOperatorID": "string",
      "acsReferenceNumber": "string",
      "acsRenderingType": {
        "acsInterface": "01",
        "acsUiTemplate": "01"
      },
      "acsSignedContent": "string",
      "acsTransID": "3fa85f64-5717-4562-b3fc-2c963f66afa6",
      "acsURL": "string",
      "authenticationType": "string",
      "authenticationValue": "string",
      "cardholderInfo": "string",
      "dsReferenceNumber": "string",
      "dsTransID": "3fa85f64-5717-4562-b3fc-2c963f66afa6",
      "eci": "string",
      "messageExtension": [
        {
          "criticalityIndicator": true,
          "data": {},
          "id": "string",
          "name": "string"
        }
      ],
      "messageType": "ARes",
      "messageVersion": "2.2.0",
      "sdkTransID": "3fa85f64-5717-4562-b3fc-2c963f66afa6",
      "threeDSServerTransID": "3fa85f64-5717-4562-b3fc-2c963f66afa6",
      "transStatus": "Y",
      "transStatusReason": "string",
      "whiteListStatus": "Y",
      "whiteListStatusSource": "string"
    }