logo Sogenactif

Release 24.5

go directly to content

Search by keywords

cardValidateAuthentication

To search in the page use Ctrl+F on your keyboard

Requests for 3-D Secure validation of authentication:

In this document, unless otherwise stated, any reference to 3-D Secure includes Visa (Verified by Visa), MasterCard (SecureCode) and American Express (SafeKey).

This request is mandatory to check the complete 3-D Secure authentication (with PARes message). It must be called after you received the POST form from the ACS (Access Control Server) (See “Post form to the ACS”).

This method is mainly used for control purposes of the card holder before saving the card in a wallet.

Recommended interfaceVersion: IR_WS_2.55

  • PROD
    https://office-server.sogenactif.com/rs-services/v2/checkout/cardValidateAuthentication
    method
    POST
  • TEST
    https://office-server-sogenactif.test.sips-services.com/rs-services/v2/checkout/cardValidateAuthentication
    method
    POST
  • PROD
    https://office-server.sogenactif.com/services/v2/checkout?wsdl
    method
    POST
  • TEST
    https://office-server-sogenactif.test.sips-services.com/services/v2/checkout?wsdl
    method
    POST

Required

  • interfaceVersion
    presence
    Required
    Interface version
    2.0

    Version of the interface used. It is composed of a prefix that varies according to the function used and a version number (e.g. IR_WS_2.47).

    Please refer to the function page for the value to use. Use the latest interface version number.

    List of values
    IR_WS_
    Sogenactif Paypage and Sogenactif Office Serveur (SOAP/JSON) interface.
  • keyVersion
    presence
    Required
    Interface version
    2.0

    Version of the merchant’s secret key used to calculate the imprint of the message (key stored by the merchant to verify the imprint of the automatic and manual notifications).

  • merchantId
    presence
    Required
    Interface version
    2.0

    Identifier of the shop, this value is provided to the merchant by Sogenactif during the shop registration.

  • messageVersion
    presence
    Required
    Interface version
    2.0

    Parameters version of redirection (used for Sogenactif Office Serveur with redirection).

  • paResMessage
    presence
    Required
    Interface version
    2.0

    Payer Authentication Response (PARes) generated by the ACS for the cardholder authentication response and transmitted to the ThreedSecureService service.

  • redirectionData
    presence
    Required
    Interface version
    2.0

    In case of 3-D Secure payment, contains the context of the transaction retrieved from the cardCheckEnrollment method. In case of 3-D Secure server Standalone, it contains the Payer Authentication Request (PAReq) that the merchant must transmit to ACS for 3-D Secure authentication (format: base 64 encoded).In case of external payment provider, contains the context of the transaction sent by the merchant during the transaction initialisation.

  • seal
    presence
    Required
    Interface version
    2.0

    Message seal used to ensure the integrity of the request and the authentication of sender / receiver of the message.

Optional

Request sample

            {
  "interfaceVersion": "IR_WS_2.9",
  "keyVersion": "1",
  "merchantId": "011223344550000",
  "messageVersion": "0.1",
  "paResMessage": "eJydVVuTqjgQ....7h%2FwH0CKem",
  "redirectionData": "uqjeV+KegCSM0POI...CjVUfxqyFq7zSYus7E\u003d",
  "transactionReference": "TREFEXA2015",
  "seal": "9565b71cb583f025278de91940c69900dee72d91e8184ddb6547f00927597fd1"
}

        
                  <urn:cardValidateAuthentication>
         <urn:input>
            <urn:merchantId>011223344550000</urn:merchantId>
            <urn:transactionReference>TREFEXA2015</urn:transactionReference>
            <urn:interfaceVersion>IR_WS_2.9</urn:interfaceVersion>
            <urn:redirectionData>RSs7cZyL1DqsV... 9P15xVe</urn:redirectionData>
            <urn:messageVersion>0.1</urn:messageVersion>
            <urn:paResMessage>eJydVVuTqjgQ....7h%2FwH0CKem</urn:paResMessage>
         </urn:input>
      </urn:cardValidateAuthentication>

Required

  • seal
    presence
    Required
    Interface version
    2.0

    Message seal used to ensure the integrity of the request and the authentication of sender / receiver of the message.

Optional

  • errorFieldName
    presence
    Optional
    Interface version
    2.21

    Error field name of the incoming request. Present when responseCode = 12 or 30.

  • holderAuthentMethod
    presence
    Optional
    Interface version
    2.27

    Name of the method applied to authenticate a payment mean holder

    List of values
    DYNAMIC
    Dynamic authentication method
    NOT_SPECIFIED
    Not specified (compatible holderAuthentProgram: 3DS)
    NO_AUTHENT
    Equivalent to NO_AUTHENT_METHOD, it is an alternative value used in the transaction report Compatible holderAuthentProgram: NO_AUTHENT
    NO_AUTHENT_METHOD
    No Holder Verification Method performed Compatible holderAuthentProgram: PAYLIB
    OOB
    Out Of Band authentication method that is not defined by 3D Secure application
    OTP_HARDWARE
    OTP on Hardware secure element (CAP, SIM, …) Compatible holderAuthentProgram: PAYLIB
    OTP_SOFTWARE
    OTP on Software secure element (SEA, …) Compatible holderAuthentProgram: PAYLIB
    OTP_TELE
    One Time Password (SMS, SVI, Token…) Compatible holderAuthentProgram: PAYLIB
    PASSWORD
    Password is reusable (birth date, password, zip code, …) Compatible holderAuthentMethod: BCMCMOBILE
    STATIC
    Static authentication method
  • holderAuthentProgram
    presence
    Optional
    Interface version
    2.27

    Authentication programme

    List of values
    1EUROCOM
    Cofidis Pay 5x10x20x authentication
    3DS
    3-D Secure authentication
    3DS_V2
    3-D Secure v2 authentication program. This value is accepted for the following versions Since the version 2.24 for Sogenactif Paypage Since the version 2.24 for Sogenactif Office Serveur Since the version 2.5 for Sogenactif In-App
    APPLEPAY
    Apple Pay authentication
    BCMCMOBILE
    BCMC authentication
    GOOGLEPAY
    Google Pay authentication
    MASTERPASS
    MasterPass authentication
    NOT_SPECIFIED
    No specified authentication program
    NO_AUTHENT
    Equivalent to NO_AUTHENT_METHOD it is an alternative value used in the transaction report
    NO_AUTHENT_METHOD
    no authentication program
    PAYLIB
    Paylib authentication
    SAMSUNGPAY
    Samsung Pay authentication
    THREE_DS
    Equivalent to 3DS it is an alternative value used in the transaction report
  • holderAuthentResponseCode
    presence
    Optional
    Interface version
    2.0

    Response code of the authentication process.

    List of values
    00
    Holder authenticated
    01
    Holder not authenticated
    02
    Holder authentication could not be performed because of a technical problem on the ACS (TX.status = U in the PARes message)
    03
    Proof of authentication available
    88
    An Error message was sent by ACS instead of a CRes message
    89
    The session has expired
    95
    Invalid PARes message signature
    96
    Invalid PARes message
  • holderAuthentStatus
    presence
    Optional
    Interface version
    2.27

    Result of the authentication process.

    List of values
    3D_ABORT
    The buyer has abandoned the transaction during the process of authentication. Currently, this status is only possible in the case of a PAYLIB payment.
    3D_ATTEMPT
    The merchant and the cardholder are both enrolled in the authentication programme, but the buyer did not have to be authenticated (the server access control of the bank that issued the card, only implements the generation of an authentication attempt proof). This case can also occur when the DS replies instead of the ACS when the ACS is unavailable.
    3D_BYPASS
    According to certain criteria set by the merchant, the authentication programme checks were bypassed.
    3D_ERROR
    The merchant participates in the authentication programme but the Sogenactif server encountered a technical problem during the authentication process (when checking the registration card to the authentication programme or during authentication of the holder).
    3D_FAILURE
    The merchant and the cardholder are both enrolled in the authentication programme, but the buyer failed to authenticate (wrong password).
    3D_NOTENROLLED
    The merchant participates in the authentication programme, but the cardholder’s card is not enrolled.
    3D_SUCCESS
    The merchant and the cardholder are both enrolled in the authentication programme and the cardholder has successfully authenticated.
    ATTEMPT
    The merchant and the cardholder are both enrolled in the authentication programme, but the buyer did not have to be authenticated (the server access control of the bank that issued the card, only implements the generation of an authentication attempt proof). This case can also occur when the DS replies instead of the ACS when the ACS is unavailable.
    BYPASS
    According to certain criteria set by the merchant, the authentication programme checks were bypassed.
    CANCEL
    The buyer has abandoned the transaction during the process of authentication. Currently, this status is only possible in the case of a PAYLIB payment.
    ERROR
    The merchant participates in the authentication programme but the Sogenactif server encountered a technical problem during the authentication process (when checking the registration card to the authentication programme or during authentication of the holder).
    FAILURE
    The merchant and the cardholder are both enrolled in the authentication programme, but the buyer failed to authenticate (wrong password).
    NOT_ENROLLED
    The merchant participates in the authentication programme, but the cardholder’s card is not enrolled.
    NOT_PARTICIPATING
    The buyer has not authenticated to one of the following reasons: - the type of card is not supported by the authentication programm - the merchant is not enrolled in the authentication programm
    NOT_SPECIFIED
    The status of the holder authentication is not available.
    NO_AUTHENT
    According to certain criteria set by the merchant, the authentication programme checks were bypassed
    NO_AUTHENT_DTA
    According to certain criteria set by the merchant, the authentication programme checks were bypassed using Direct to Authorize
    SSL
    According to certain criteria set by the merchant, the authentication programme checks were bypassed
    SUCCESS
    The merchant and the cardholder are both enrolled in the authentication programme and the cardholder has successfully authenticated.
  • responseCode
    presence
    Optional
    Interface version
    2.0

    Sogenactif server response code.

    List of values
    00
    Operation accepted
    03
    Invalid merchant contract
    12
    Invalid transaction. Please check the request parameters
    40
    Function not supported: the operation that you wish to perform is not part of the operation type for which you are authorized
    99
    Temporarily problem with the payment server
  • threeD
    presence
    Optional
    Interface version
    2.27

    Contains cardholder’s 3-D Secure authentication information.

    Contains
    • securityIndicator
      presence
      Optional
      Interface version
      2.27

      Transaction’s security level. This indicator is calculated based on the prior result of the 3-D Secure authentication.

      List of values
      10
      3DS disengaged holderAuthentProgram: N/A holderAuthentStatus : BYPASS
      20
      Deprecated value holderAuthentProgram: N/A holderAuthentStatus : N/A
      21
      Cardholder not enrolled in the 3DS 1.0 program holderAuthentProgram: 3DS holderAuthentStatus : NOT_ENROLLED
      22
      Deprecated value holderAuthentProgram: 3DS holderAuthentStatus : NOT_ENROLLED
      23
      Successful authentication in 3DS 2.0 in frictionless mode holderAuthentProgram: 3DS_V2 holderAuthentStatus : SUCCESS
      24
      Successful authentication in 3DS 2.0 in challenge mode (strong authentication) holderAuthentProgram: 3DS_V2 holderAuthentStatus : SUCCESS
      25
      Successful authentication in 3DS 1.0 holderAuthentProgram: 3DS holderAuthentStatus : SUCCESS
      26
      Cardholder partially authenticated on ACS 3DS 1.0 holderAuthentProgram: 3DS holderAuthentStatus : ATTEMPT
      27
      Carrier partially authenticated on ACS 3DS 2.0 in frictionless mode holderAuthentProgram: 3DS_V2 holderAuthentStatus : ATTEMPT
      28
      Cardholder partially authenticated on ACS 3DS 2.0 in challenge mode (strong authentication) holderAuthentProgram: 3DS_V2 holderAuthentStatus : ATTEMPT
      29
      Card range not enrolled in the 3DS 2.0 program holderAuthentProgram: 3DS_V2 holderAuthentStatus : NOT_ENROLLED
      30
      Cardholder not enrolled in the 3DS 2.0 program holderAuthentProgram: 3DS_V2 holderAuthentStatus : NOT_ENROLLED
      31
      Cardholder authentication failure in 3DS 1.0 holderAuthentProgram: 3DS holderAuthentStatus : FAILURE
      32
      Invalid signature in ACS response in 3DS 1.0 holderAuthentProgram: 3DS holderAuthentStatus : FAILURE
      33
      Invalid ACS response in 3DS 1.0 holderAuthentProgram: 3DS holderAuthentStatus : FAILURE
      34
      Cardholder authentication failure in 3DS 2.0 in frictionless mode holderAuthentProgram: 3DS_V2 holderAuthentStatus : FAILURE
      35
      Cardholder authentication failure in 3DS 2.0 in challenge mode holderAuthentProgram: 3DS_V2 holderAuthentStatus : FAILURE
      36
      3DS 2.0 authentication failed because no Rreq message received from ACS holderAuthentProgram: 3DS_V2 holderAuthentStatus : FAILURE
      37
      3DS 2.0 authentication failed because Cres message is invalid holderAuthentProgram: 3DS_V2 holderAuthentStatus : FAILURE
      38
      3DS 2.0 authentication failed because the Cres message contains an error message holderAuthentProgram: 3DS_V2 holderAuthentStatus : FAILURE
      39
      No authentication as requested by the merchant holderAuthentProgram: 3DS_V2 holderAuthentStatus : NO_AUTHENT
      41
      Error in 3DS 1.0: Session expired holderAuthentProgram: 3DS holderAuthentStatus : ERROR
      42
      Error in 3DS 2.0: Session expired holderAuthentProgram: 3DS_V2 holderAuthentStatus : ERROR
      71
      Error in 3DS 2.0: ARes message not received holderAuthentProgram: 3DS_V2 holderAuthentStatus : ERROR
      72
      Error in 3DS 2.0: ARes message received from DS is invalid holderAuthentProgram: 3DS_V2 holderAuthentStatus : ERROR
      73
      Error in 3DS 2.0: RReq message received from ACS is invalid holderAuthentProgram: 3DS_V2 holderAuthentStatus : ERROR
      74
      Error in 3DS 2.0: unable to reach the DS holderAuthentProgram: 3DS_V2 holderAuthentStatus : ERROR
      75
      Error in 3DS 2.0: technical problem on the Sips platform holderAuthentProgram: 3DS_V2 holderAuthentStatus : ERROR
      76
      Error in 3DS 2.0: technical problem on the 3DS Server holderAuthentProgram: 3DS_V2 holderAuthentStatus : ERROR
      81
      Error in 3DS 1.0: Internal MPI error during the first call holderAuthentProgram: 3DS holderAuthentStatus : ERROR
      82
      Error in 3DS 1.0: Internal MPI error during the second call holderAuthentProgram: 3DS holderAuthentStatus : ERROR
      84
      Error in 3DS 1.0: Invalid DS response holderAuthentProgram: 3DS holderAuthentStatus : ERROR
      85
      Error in 3DS 1.0: technical problem during the first call to MPI holderAuthentProgram: 3DS holderAuthentStatus : ERROR
      86
      Error in 3DS 1.0: technical problem during the second call to MPI holderAuthentProgram: 3DS holderAuthentStatus : ERROR
      87
      Error in 3DS 1.0: the parameters transmitted to the MPI are invalid holderAuthentProgram: 3DS holderAuthentStatus : ERROR
      88
      Error in 3DS 1.0: Network problem holderAuthentProgram: 3DS holderAuthentStatus : ERROR
      90
      Deprecated value holderAuthentProgram: 3DS holderAuthentStatus : ERROR
      92
      Problem when verifying carrier enrollment holderAuthentProgram: 3DS holderAuthentStatus : ERROR
      93
      Problem when authenticating the cardholder on the ACS holderAuthentProgram: 3DS holderAuthentStatus : ERROR
      94
      Error in 3DS 2.0: technical problem when calling the DS holderAuthentProgram: 3DS holderAuthentStatus : ERROR
      95
      Error in 3DS 2.0: technical problem during kinematics with ACS holderAuthentProgram: 3DS_V2 holderAuthentStatus : ERROR
    • cavv
      presence
      Optional
      Interface version
      2.27

      Cardholder’s authentication verification value communicated in the MPI during 3-D Secure payments.

    • eci
      presence
      Optional
      Interface version
      2.27

      Electric commerce indicator communicated in the MPI during 3-D Secure payments.

    • cavvAlgorithm
      presence
      Optional
      Interface version
      2.27

      Algorithm indicator used to generate a CAVV communicated in the MPI during 3-D Secure payments.

      List of values
      0
      HMAC
      1
      CVV
      2
      CVV ATN
      3
      Mastercard SPA
    • txStatus
      presence
      Optional
      Interface version
      2.27

      Result of the authentication communicated in the MPI during 3-D Secure payments.

      List of values
      9
      CARD_NOT_ENROLLED
      A
      ATTEMPT
      C
      CHALLENGE
      D
      DECOUPLED_AUTHENTICATION
      E
      AUTHENTICATED_WITHOUT_CRYPTO
      I
      INFO_ONLY
      N
      NOT_AUTHENTICATED
      R
      AUTHENTICATION_REJECTED
      U
      ERROR
      Y
      AUTHENTICATED_WITH_CRYPTO
    • xid
      presence
      Optional
      Interface version
      2.27

      Unique transaction ID (generated by the MPI) presented in all 3-D Secure messages and communicated in the MPI during 3-D Secure payments.

  • threeDV2
    presence
    Optional
    Interface version
    2.27

    Contains cardholder’s 3-D Secure v2 authentication information.

    Contains
    • securityIndicator
      presence
      Optional
      Interface version
      2.27

      Transaction’s security level. This indicator is calculated based on the prior result of the 3-D Secure authentication.

      List of values
      10
      3DS disengaged holderAuthentProgram: N/A holderAuthentStatus : BYPASS
      20
      Deprecated value holderAuthentProgram: N/A holderAuthentStatus : N/A
      21
      Cardholder not enrolled in the 3DS 1.0 program holderAuthentProgram: 3DS holderAuthentStatus : NOT_ENROLLED
      22
      Deprecated value holderAuthentProgram: 3DS holderAuthentStatus : NOT_ENROLLED
      23
      Successful authentication in 3DS 2.0 in frictionless mode holderAuthentProgram: 3DS_V2 holderAuthentStatus : SUCCESS
      24
      Successful authentication in 3DS 2.0 in challenge mode (strong authentication) holderAuthentProgram: 3DS_V2 holderAuthentStatus : SUCCESS
      25
      Successful authentication in 3DS 1.0 holderAuthentProgram: 3DS holderAuthentStatus : SUCCESS
      26
      Cardholder partially authenticated on ACS 3DS 1.0 holderAuthentProgram: 3DS holderAuthentStatus : ATTEMPT
      27
      Carrier partially authenticated on ACS 3DS 2.0 in frictionless mode holderAuthentProgram: 3DS_V2 holderAuthentStatus : ATTEMPT
      28
      Cardholder partially authenticated on ACS 3DS 2.0 in challenge mode (strong authentication) holderAuthentProgram: 3DS_V2 holderAuthentStatus : ATTEMPT
      29
      Card range not enrolled in the 3DS 2.0 program holderAuthentProgram: 3DS_V2 holderAuthentStatus : NOT_ENROLLED
      30
      Cardholder not enrolled in the 3DS 2.0 program holderAuthentProgram: 3DS_V2 holderAuthentStatus : NOT_ENROLLED
      31
      Cardholder authentication failure in 3DS 1.0 holderAuthentProgram: 3DS holderAuthentStatus : FAILURE
      32
      Invalid signature in ACS response in 3DS 1.0 holderAuthentProgram: 3DS holderAuthentStatus : FAILURE
      33
      Invalid ACS response in 3DS 1.0 holderAuthentProgram: 3DS holderAuthentStatus : FAILURE
      34
      Cardholder authentication failure in 3DS 2.0 in frictionless mode holderAuthentProgram: 3DS_V2 holderAuthentStatus : FAILURE
      35
      Cardholder authentication failure in 3DS 2.0 in challenge mode holderAuthentProgram: 3DS_V2 holderAuthentStatus : FAILURE
      36
      3DS 2.0 authentication failed because no Rreq message received from ACS holderAuthentProgram: 3DS_V2 holderAuthentStatus : FAILURE
      37
      3DS 2.0 authentication failed because Cres message is invalid holderAuthentProgram: 3DS_V2 holderAuthentStatus : FAILURE
      38
      3DS 2.0 authentication failed because the Cres message contains an error message holderAuthentProgram: 3DS_V2 holderAuthentStatus : FAILURE
      39
      No authentication as requested by the merchant holderAuthentProgram: 3DS_V2 holderAuthentStatus : NO_AUTHENT
      41
      Error in 3DS 1.0: Session expired holderAuthentProgram: 3DS holderAuthentStatus : ERROR
      42
      Error in 3DS 2.0: Session expired holderAuthentProgram: 3DS_V2 holderAuthentStatus : ERROR
      71
      Error in 3DS 2.0: ARes message not received holderAuthentProgram: 3DS_V2 holderAuthentStatus : ERROR
      72
      Error in 3DS 2.0: ARes message received from DS is invalid holderAuthentProgram: 3DS_V2 holderAuthentStatus : ERROR
      73
      Error in 3DS 2.0: RReq message received from ACS is invalid holderAuthentProgram: 3DS_V2 holderAuthentStatus : ERROR
      74
      Error in 3DS 2.0: unable to reach the DS holderAuthentProgram: 3DS_V2 holderAuthentStatus : ERROR
      75
      Error in 3DS 2.0: technical problem on the Sips platform holderAuthentProgram: 3DS_V2 holderAuthentStatus : ERROR
      76
      Error in 3DS 2.0: technical problem on the 3DS Server holderAuthentProgram: 3DS_V2 holderAuthentStatus : ERROR
      81
      Error in 3DS 1.0: Internal MPI error during the first call holderAuthentProgram: 3DS holderAuthentStatus : ERROR
      82
      Error in 3DS 1.0: Internal MPI error during the second call holderAuthentProgram: 3DS holderAuthentStatus : ERROR
      84
      Error in 3DS 1.0: Invalid DS response holderAuthentProgram: 3DS holderAuthentStatus : ERROR
      85
      Error in 3DS 1.0: technical problem during the first call to MPI holderAuthentProgram: 3DS holderAuthentStatus : ERROR
      86
      Error in 3DS 1.0: technical problem during the second call to MPI holderAuthentProgram: 3DS holderAuthentStatus : ERROR
      87
      Error in 3DS 1.0: the parameters transmitted to the MPI are invalid holderAuthentProgram: 3DS holderAuthentStatus : ERROR
      88
      Error in 3DS 1.0: Network problem holderAuthentProgram: 3DS holderAuthentStatus : ERROR
      90
      Deprecated value holderAuthentProgram: 3DS holderAuthentStatus : ERROR
      92
      Problem when verifying carrier enrollment holderAuthentProgram: 3DS holderAuthentStatus : ERROR
      93
      Problem when authenticating the cardholder on the ACS holderAuthentProgram: 3DS holderAuthentStatus : ERROR
      94
      Error in 3DS 2.0: technical problem when calling the DS holderAuthentProgram: 3DS holderAuthentStatus : ERROR
      95
      Error in 3DS 2.0: technical problem during kinematics with ACS holderAuthentProgram: 3DS_V2 holderAuthentStatus : ERROR
    • authentDateTime
      presence
      Optional
      Interface version
      2.27

      UTC date and time of the authentication.

    • authentCancelReason
      presence
      Optional
      Interface version
      2.27

      Reason for authentication cancellation.

      List of values
      01
      Cancellation was requested by the cardholder
      02
      The requestor 3DS cancelled the authentication
      03
      Abandoned transaction
      04
      Time out exceeded at ACS: other deadlines
      05
      Time out exceeded at ACS: first CReq not received by ACS
      06
      Transaction in error
      07
      Unknown cancellation reason
    • holderAuthentType
      presence
      Optional
      Interface version
      2.27

      Cardholder authentication type applied by the issuer of the card. Field valued in 3-D Secure v2.

      List of values
      CHALLENGE
      Authentication on challenge flow (redirection of authentication pages to cardholder)
      FRICTIONLESS
      Authentication on frictionless flow
      FRICTIONLESS_DELEGATE
      Deprecated - Authentication on delegated frictionless flow (DS manage the authentication instead of issuer in case of technical issues
      NONE
      No authentication could be implemented
    • cavvAlgorithm
      presence
      Optional
      Interface version
      2.27

      Algorithm indicator used to generate a CAVV communicated in the MPI during 3-D Secure payments.

      List of values
      0
      HMAC
      1
      CVV
      2
      CVV ATN
      3
      Mastercard SPA
    • authentTransStatusReason
      presence
      Optional
      Interface version
      2.27

      Reason accompanying the authentication result communicated in the MPI of a 3D-Secure payment.

    • authentMessageVersion
      presence
      Optional
      Interface version
      2.31

      Version of the 3-D Secure protocol used (e.g. 2.1.0).

    • cavv
      presence
      Optional
      Interface version
      2.27

      Cardholder’s authentication verification value communicated in the MPI during 3-D Secure payments.

    • authentDsTransId
      presence
      Optional
      Interface version
      2.27

      Universal transaction identifier assigned by the DS to uniquely identify a transaction.

    • challengeMode3DS
      presence
      Optional
      Interface version
      2.27

      Holder authentication level requested.

      List of values
      CHALLENGE
      The merchant desired authentication challenge mode is to have a client authentication. In other words, it is a “challenge” request
      CHALLENGE_MANDATE
      The merchant need is to apply the regulatory mode to have a strong customer authentication (for example for the first payment of payment schedule)
      NO_CHALLENGE
      The merchant desired authentication challenge mode is to have no customer authentication. In other words, it is a “challenge” request
      NO_CHALLENGE_DTA
      The merchant does not want customer authentication in a Direct to Authorize kinematics
      NO_CHALLENGE_TRA_ACQ
      The merchant desired no authentication of the cardholder by invoking the TRA acquirer exemption. It’s a request for “Frictionless”.
      NO_CHALLENGE_TRA_ACQ_DTA
      The merchant wishes to bypass cardholder authentication by invoking the Acquirer TRA exemption. This is a Direct to Authorize request.
      NO_PREFERENCE
      The merchant has no desired authentication challenge mode
    • authentExemptionReasonList
      presence
      Optional
      Interface version
      2.31

      List of exemptions fixed by the issuer.

      List of values
      AUTOMATE_PAYMENT
      Automatic payment machines for transport and car park
      CORPORATE
      Exemption safe procedure and payment protocol for companies
      DELEGATED_SCA
      Strong authentication implemented by the acceptor (wallet)
      LOW_RISK_MERCHANT_CB
      Risk analysis in the Low Risk Merchant CB program
      LOW_VALUE
      Exemption low values
      OTHER_EXEMPTION
      Other use case exempt from authentication
      OUT_OF_SCOPE_RTS
      RECURRING_FIX
      Exemption for recurring transactions of identical amounts and fixed term
      TECHNICAL_ERROR
      Technical impossibility of implementing authentication
      TRA_ACQUIRER
      Exemption risk analysis by the acceptor/acquirer
      TRA_ISSUER
      Exemption risk analysis by the issuer
      WHITE_LIST
      Exemption trusted beneficiary
    • authentAcsTransId
      presence
      Optional
      Interface version
      2.27

      Universal transaction identifier assigned by the ACS to uniquely identify a transaction.

    • authentDsMerchantName
      presence
      Optional
      Interface version
      2.31

      Identifier assigned by the Directory Server to uniquely identify the merchant.

    • eci
      presence
      Optional
      Interface version
      2.27

      Electric commerce indicator communicated in the MPI during 3-D Secure payments.

    • authentScoreValue
      presence
      Optional
      Interface version
      2.27

      Score value provided by the DS (Directory Server) to the ACS (Access Control Server).

    • authentAmount
      presence
      Optional
      Interface version
      2.27

      Authentication amount.

    • authentThreedsServerTransId
      presence
      Optional
      Interface version
      2.35

      Universal transaction identifier assigned by the 3DS server to uniquely identify a transaction.

    • authentAcsMethod
      presence
      Optional
      Interface version
      2.31

      Authentication method that the ACS applied to authenticate the cardholder.

      List of values
      01
      STATIC_PASSCODE
      02
      SMS_OTP
      03
      KEY_FOB_OR_EMV_CARD_READER_OTP
      04
      APP_OTP
      05
      OTP_OTHER
      06
      KBA
      07
      OOB_BIOMETRICS
      08
      OOB_LOGIN
      09
      OOB_OTHER
      10
      OTHER
    • txStatus
      presence
      Optional
      Interface version
      2.27

      Result of the authentication communicated in the MPI during 3-D Secure payments.

      List of values
      9
      CARD_NOT_ENROLLED
      A
      ATTEMPT
      C
      CHALLENGE
      D
      DECOUPLED_AUTHENTICATION
      E
      AUTHENTICATED_WITHOUT_CRYPTO
      I
      INFO_ONLY
      N
      NOT_AUTHENTICATED
      R
      AUTHENTICATION_REJECTED
      U
      ERROR
      Y
      AUTHENTICATED_WITH_CRYPTO

Response sample

            {
  "responseCode": "00",
  "holderAuthentResponseCode": "00",
  "seal": "ef3f3cc68a39a5d1144663162a35fa6070bfe39d5abbe672b15417ff87afc431"
}

        
                  <cardValidateAuthenticationResponse xmlns="urn:sips:cn:contract:office:checkout:v2">
         <output> 
            <responseCode>00</responseCode>
            <holderAuthentResponseCode>00</holderAuthentResponseCode>
         </output>
      </cardValidateAuthenticationResponse>

Changelog


Interface version Data Attendance Container
2.12 intermediateServiceProviderId Request
2.0 s10TransactionReference Request
2.0 s10TransactionId Container
  • s10TransactionReference
    • 2.0 s10TransactionIdDate Container
  • s10TransactionReference
    • 2.12 sealAlgorithm Request
    2.0 transactionReference Request
    2.0 interfaceVersion Request
    2.0 keyVersion Request
    2.0 merchantId Request
    2.0 messageVersion Request
    2.0 paResMessage Request
    2.0 redirectionData Request
    2.0 seal Request/Response
    2.21 errorFieldName Response
    2.27 holderAuthentMethod Response
    2.27 holderAuthentProgram Response
    2.0 holderAuthentResponseCode Response
    2.27 holderAuthentStatus Response
    2.0 responseCode Response
    2.27 threeD Response
    2.27 securityIndicator Container
  • threeD
  • threeDV2
    • 2.27 cavv Container
  • threeD
  • threeDV2
    • 2.27 eci Container
  • threeD
  • threeDV2
    • 2.27 cavvAlgorithm Container
  • threeD
  • threeDV2
    • 2.27 txStatus Container
  • threeD
  • threeDV2
    • 2.27 xid Container
  • threeD
    • 2.27 threeDV2 Response
    2.27 authentDateTime Container
  • threeDV2
    • 2.27 authentCancelReason Container
  • threeDV2
    • 2.27 holderAuthentType Container
  • threeDV2
    • 2.27 authentTransStatusReason Container
  • threeDV2
    • 2.31 authentMessageVersion Container
  • threeDV2
    • 2.27 authentDsTransId Container
  • threeDV2
    • 2.27 challengeMode3DS Container
  • threeDV2
    • 2.31 authentExemptionReasonList Container
  • threeDV2
    • 2.27 authentAcsTransId Container
  • threeDV2
    • 2.31 authentDsMerchantName Container
  • threeDV2
    • 2.27 authentScoreValue Container
  • threeDV2
    • 2.27 authentAmount Container
  • threeDV2
    • 2.35 authentThreedsServerTransId Container
  • threeDV2
    • 2.31 authentAcsMethod Container
  • threeDV2
    • Back to top Need help?

    This site uses trackers to improve your experience, perform analysis and researches on your use of Sogenactif documentation website.
    You have several options:
    Closing this banner you refuse the use of trackers on your device.

    Configuration