logo Sogenactif

Release 23.1

go directly to content

Search by keywords

paymentDataProviderCheck

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

This function allows to decrypt data providing by an OEM (e.g. GooglePay)

  • PROD
    https://office-server.sogenactif.com/rs-services/v2/checkout/paymentDataProviderCheck
    method
    POST
  • TEST
    https://office-server-sogenactif.test.sips-services.com/rs-services/v2/checkout/paymentDataProviderCheck
    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 value and number of the interface used.

    List of values
    AR_WS_2.
    Obsolete
    AUT_WS_2.
    AUT_WS: Sogenactif Office Serveur (SOAP/JSON) interface for the Sogenactif authentication services.2.x: version referenced in the documentation of the function used by the merchant
    CPR_WS_2.
    Obsolete
    CR_WS_2.
    CR_WS: Sogenactif Office Serveur (SOAP/JSON) interface for Cash Management functions. 2.x: connector version used by the merchant
    DR_WS_2.
    DR_WS: Sogenactif Office Serveur (SOAP/JSON) interface for Diagnostic functions. 2.x: connector version used by the merchant
    FR_WS_2.
    FR_WS: Sogenactif Office Serveur (SOAP) interface for Fraud functions. 2.x: connector version used by the merchant
    HP_x.x
    HP: Sogenactif Paypage (POST) interface. x.x: connector version used by the merchant
    IR_MB_
    IR_MB: Sogenactif In-App (JSON) interface for Sogenactif In-App functions. 1.x: connector version used by the merchant
    IR_WS_
    IR_WS: Sogenactif Paypage (SOAP/JSON) interface. x.x: connector version used by the merchant
    IR_WS_2.
    IR_WS: Sogenactif Office Serveur (SOAP/JSON) interface for payment request functions. 2.x: connector version used by the merchant
    MR_WS_2.
    MR_WS: Sogenactif Office Serveur (SOAP/JSON) interface for mandate management. 2.x: connector version used by the merchant
    OR_WS_1.0
    OR_WS: Sogenactif Office Serveur (SOAP) interface for Sogenactif Office Serveur functions. 1.0: connector version used by the merchant
    PMR_WS_2.
    PMR_WS: Sogenactif Office Serveur (SOAP/JSON) interface for payment method repository information request functions. 2.x: connector version used by the merchant
    POR_WS_2.
    Obsolete
    TR_WS_2.
    TR_WS: Sogenactif Office Serveur (SOAP) interface for Token functions. 2.x: connector version used by the merchant
    WMR_WS_2.
    WMR_WS: Sogenactif Walletpage interface 2.x: connector version used by the merchant
    WR_WS_2.
    WR_WS: Sogenactif Office Serveur (SOAP/JSON) interface for Wallet functions. 2.x: connector version used by the merchant
  • 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.

  • paymentData
    presence
    Required
    Interface version
    2.0

    Encrypted payment data provided in a JSON field (ex “token” for Google Pay).

  • paymentMeanDataProvider
    presence
    Required
    Interface version
    2.0

    Name of data provider of the payment mean.

    List of values
    APPLEPAY
    Apple Pay
    SAMSUNGPAY
    Samsung Pay
  • 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.

  • sealAlgorithm
    presence
    Required
    Interface version
    2.0

    Algorithm applied to calculate the seal encryption.

    List of values
    HMAC-SHA-256
    The encryption algorithm applied is HMAC-SHA-256
    HMAC-SHA-512
    The encryption algorithm applied is HMAC-SHA-512
    SHA-256
    The encryption algorithm applied is SHA-256

Optional

Request sample

            {
"interfaceVersion": "IR_WS_2.46",
"keyVersion": "1",
"merchantId": "011223344550000",
"paymentMeanDataProvider": "GOOGLEPAY",
"paymentData": "Cyphered data...",
"seal": "30218c85ca303d33d5e7b60bb48222b9826fbc30b6c2ec98fff285702e445ae1"
}

        
                  <urn:paymentDataProviderCheck>
         <urn:input>
            <urn:merchantId>011223344550000</urn:merchantId>
            <urn:interfaceVersion>IR_WS_2.46</urn:interfaceVersion>
            <urn:paymentMeanDataProvider>GOOGLEPAY</urn:paymentMeanDataProvider>
            <urn:paymentData>Cyphered data...</urn:paymentData>
            <urn:seal>30218c85ca303d33d5e7b60bb48222b9826fbc30b6c2ec98fff285702e445ae1</urn:seal>
            <urn:keyVersion>1</urn:keyVersion>
         </urn:input>
      </urn:paymentDataProviderCheck>

        

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

  • authenticationResult
    presence
    Optional
    Interface version
    2.0

    Contains the result information from the cardholder’s authentification.

    Contains
    • applePay
      presence
      Optional
      Interface version
      2.0

      Contains specific authentication information for ApplePay.

      Contains
    • googlePay
      presence
      Optional
      Interface version
      2.46

      Contains specific authentication information for GooglePay.

      Contains
    • holderAuthentProgram
      presence
      Optional
      Interface version
      2.0

      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
      ARP
      ARP authentication
      BCMCMOBILE
      BCMC 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
    • holderAuthentProvider
      presence
      Optional
      Interface version
      2.0

      Specifies the PSP that performed the authentication.

      List of values
      1
      The PSP is Sogenactif
      2
      Other PSP
    • samsungPay
      presence
      Optional
      Interface version
      2.0

      Contains the information related to SamsungPay.

      Contains
    • threeD
      presence
      Optional
      Interface version
      2.0

      Contains cardholder’s 3-D Secure authentication information.

      Contains
      • securityIndicator
        presence
        Optional
        Interface version
        2.0

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

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

      • eci
        presence
        Optional
        Interface version
        2.0

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

      • cavvAlgorithm
        presence
        Optional
        Interface version
        2.0

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

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

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

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

      Contains
      • securityIndicator
        presence
        Optional
        Interface version
        2.0

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

        UTC date and time of the authentication.

      • authentCancelReason
        presence
        Optional
        Interface version
        2.0

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

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

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

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

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

      • authentDSTransId
        presence
        Optional
        Interface version
        2.0

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

      • challengeMode3DS
        presence
        Optional
        Interface version
        2.0

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

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

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

      • authentScoreValue
        presence
        Optional
        Interface version
        2.0

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

      • authentAmount
        presence
        Optional
        Interface version
        2.0

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

        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
  • cardExpiryDate
    presence
    Optional
    Interface version
    2.0

    Card expiry date. If the card does not have any expiry date, this field is empty.

  • errorFieldName
    presence
    Optional
    Interface version
    2.0

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

  • paymentMeanBrand
    presence
    Optional
    Interface version
    2.0

    Name of the payment method that is used. It is related to one paymentMeanType.

    List of values
    1EUROCOM
    Cofidis Pay 5x10x20x Acquisition contract: ONLINE_CREDIT
    3XCBCOFINOGA
    Depreciated. Cofinoga 3xCB paymentMeanBrandType: CARD
    ACCEPTGIRO
    AcceptGiro paymentMeanBrandType: CREDIT_TRANSFER
    ACCORD
    Oney card paymentMeanBrandType: CARD
    ACCORD_3X
    Payment in 3 times with Facily Pay paymentMeanBrandType: ONLINE_CREDIT
    ACCORD_4X
    Payment in 4 times with Facily Pay paymentMeanBrandType: ONLINE_CREDIT
    ACCORD_KDO
    Carte Cadeau Oney paymentMeanBrandType: CARD
    AIRPLUS
    Airplus card paymentMeanBrandType: CARD
    AIRPLUS_LOGEE
    Airplus card paymentMeanBrandType: CARD
    AMEX
    American Express card paymentMeanBrandType: CARD
    AMEX_LOGEE
    American Express card paymentMeanBrandType: CARD
    AURORE
    CPAY card paymentMeanBrandType: CARD
    BCACB_3X
    Payment in 3 times with Floa Bank CB paymentMeanBrandType: ONLINE_CREDIT
    BCACB_4X
    Payment in 4 times with Floa Bank CB paymentMeanBrandType: ONLINE_CREDIT
    BCACUP
    CUP card of Floa Bank paymentMeanBrandType: CARD
    BCMC
    Bancontact card paymentMeanBrandType: CARD
    CACF_3X
    Payment in 3 times with CACF paymentMeanBrandType: ONLINE_CREDIT
    CACF_4X
    Payment in 4 times with CACF paymentMeanBrandType: ONLINE_CREDIT
    CADHOC
    Cadhoc paymentMeanBrandType: CARD
    CADOCARTE
    Cado Carte paymentMeanBrandType: CARD
    CB
    Carte Bancaire paymentMeanBrandType: CARD
    CBCONLINE
    PayButton CBC Online paymentMeanBrandType: CREDIT_TRANSFER
    CETELEM_3X
    Cetelem 3xCB paymentMeanBrandType: ONLINE_CREDIT
    CETELEM_4X
    Cetelem 4xCB paymentMeanBrandType: ONLINE_CREDIT
    COFIDIS_3X
    Cofidis 3xCB paymentMeanBrandType: ONLINE_CREDIT
    COFIDIS_4X
    Cofidis 4xCB paymentMeanBrandType: ONLINE_CREDIT
    CONECS
    Titres Restaurants Dématérialisés Conecs paymentMeanBrandType: VOUCHER
    CUP
    China UnionPay card paymentMeanBrandType: CARD
    CVA
    Visa Aurore card paymentMeanBrandType: CARD
    CVCO
    Chèque-Vacances Connect paymentMeanBrandType: VOUCHER
    DINERS
    Carte Diners club international paymentMeanBrandType: CARD
    ELV
    Elektronisches LastschriftVerfahren paymentMeanBrandType: DIRECT_DEBIT
    FIVORY
    Lyf Pay paymentMeanBrandType: WALLET
    FRANFINANCE_3X
    Franfinance 3xCB paymentMeanBrandType: ONLINE_CREDIT
    FRANFINANCE_4X
    Franfinance 4xCB paymentMeanBrandType: ONLINE_CREDIT
    GIROPAY
    Giropay paymentMeanBrandType: CREDIT_TRANSFER
    IDEAL
    iDeal paymentMeanBrandType: CREDIT_TRANSFER
    ILLICADO
    Illicado paymentMeanBrandType: CARD
    INCASSO
    Incasso paymentMeanBrandType: DIRECT_DEBIT
    INGHOMEPAY
    PayButton ING Home’Pay paymentMeanBrandType: CREDIT_TRANSFER
    JCB
    Carte Japan Credit Bureau paymentMeanBrandType: CARD
    KBCONLINE
    PayButton KBC Online paymentMeanBrandType: CREDIT_TRANSFER
    LEPOTCOMMUN
    Le Pot Commun paymentMeanBrandType: CARD
    LYDIA
    Lydia paymentMeanBrandType: PROVIDER
    MAESTRO
    Maestro card (Mastercard) paymentMeanBrandType: CARD
    MASTERCARD
    Mastercard card paymentMeanBrandType: CARD
    MASTERPASS
    Deprecated - MasterPass paymentMeanBrandType:
    ONEY34X
    Payment in 3 or 4 times with Oney paymentMeanBrandType: ONLINE_CREDIT
    PAYLIB
    Paylib paymentMeanBrandType:
    PAYPAL
    Paypal paymentMeanBrandType: WALLET
    PAYTRAIL
    Paytrail paymentMeanBrandType: CREDIT_TRANSFER
    PAY_BY_BANK
    SEPA credit transfer paymentMeanBrandType: CREDIT_TRANSFER
    PRESTO
    Presto Plus paymentMeanBrandType: ONLINE_CREDIT
    SEPA_DIRECT_DEBIT
    SDD (SEPA Direct Debit) paymentMeanBrandType: DIRECT_DEBIT
    SOFINCO
    Sofinco card paymentMeanBrandType: CARD
    SOFORTUBERWEISUNG
    Sofortüberweisung (Sofort Banking) paymentMeanBrandType: CREDIT_TRANSFER
    UNKNOWN
    Unknown payment mean (this value can be returned by Sogenactif but must not be used in a request)
    VISA
    Visa card paymentMeanBrandType: CARD
    VISACHECKOUT
    Deprecated - Visa Checkout wallet paymentMeanBrandType: WALLET
    VISA_ELECTRON
    Carte Visa Electron paymentMeanBrandType: CARD
    VPAY
    VPAY card (Visa) paymentMeanBrandType: CARD
  • paymentMeanDataProvider
    presence
    Optional
    Interface version
    2.0

    Name of data provider of the payment mean.

    List of values
    APPLEPAY
    Apple Pay
    SAMSUNGPAY
    Samsung Pay
  • paymentToken
    presence
    Optional
    Interface version
    2.0

    Hosted Fields payment token to be sent when making calls to Sogenactif Office Serveur and allowing you to find card payment information for classic or 3-D Secure payment, by wallet or not.

  • responseCode
    presence
    Optional
    Interface version
    2.0

    Sogenactif server response code.

    List of values
    00
    Operation accepted
    01
    For panToToken and tokenToPan methods, partial success
    02
    Request of authorized on via telephone with the issuer because of exceeding the card authorization threshold
    03
    Invalid merchant contract
    05
    Refused authorization
    11
    Used for differed check. The PAN is blocked
    12
    Invalid transaction. Please check the request parameters
    14
    Invalid PAN or payment mean data check is failed (e.g. card number or the visual cryptogram of the card or AVS address)
    17
    Customer cancellation
    24
    • In response to a cash management operation: operation not authorized. The operation you wish to perform is not compliant with the transaction status or another operation is in progress at the same time
    • In response to a payment creation: operation rejected, request already carried out with the same data and the same parameters
    25
    Transaction unknown by Sogenactif
    30
    Format error
    34
    Fraud suspicion (seal erroneous)
    40
    Function not supported: the operation that you wish to perform is not part of the operation type for which you are authorized
    51
    Amount too high
    54
    Payment mean expiry date is past
    55
    Merchant doesn’t accept prepaid cards
    57
    Refund operation refused because the original transaction was subject of an unpaid
    60
    Transaction pending
    62
    Waiting the confirmation for the transaction (used by PayPal 1.0)
    63
    Security rules not observed, transaction stopped
    75
    Number of attempts to enter the data of the payment mean from Sogenactif Paypage is exceeded
    90
    Service temporarily not available
    94
    Duplicated transaction: the transactionReference has been used previously
    97
    Session expired (no action from the user during 15 minutes), transaction refused
    99
    Temporarily problem with the payment server

Response sample

            {
"responseCode": "00",
"paymentMeanDataProvider": "GOOGLEPAY",
"paymentToken": "somePaymentToken",
"expiryDate": "209912",
"authenticationResult": {},
"errorFieldName": ""
}

        
                  <paymentDataProviderCheckResponse xmlns="urn:sips:cn:contract:office:checkout:v2">
         <output>
            <responseCode>00</responseCode>
            <paymentMeanDataProvider>GOOGLEPAY</paymentMeanDataProvider>
            <paymentToken>somePaymentToken</paymentToken>
            <expiryDate>209912</expiryDate>
            <authenticationResult/>
            <errorFieldName/>
         </output>
      </paymentDataProviderCheckResponse>

        

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