logo Sogenactif

Release 23.1

go directly to content

Search by keywords

hostedFieldsInitialize

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

Initialize a Hosted Fields session.

  • PROD
    https://office-server.sogenactif.com/rs-services/v2/authentication/hostedFieldsInitialize
    method
    POST
  • TEST
    https://office-server-sogenactif.test.sips-services.com/rs-services/v2/authentication/hostedFieldsInitialize
    method
    POST

Required

  • interfaceVersion
    presence
    Required
    Interface version
    2.34

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

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

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

  • seal
    presence
    Required
    Interface version
    2.34

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

Optional

  • customerIpAddress
    presence
    Optional
    Interface version
    2.34

    Buyer’s IP address.

  • intermediateServiceProviderId
    presence
    Optional
    Interface version
    2.34

    Identifier of the Service used by the merchant for the exchanges with the Sogenactif platform.

  • paymentMeanBrandList
    presence
    Optional
    Interface version
    2.34

    List of payment methods accepted for a transaction. If this field is not filled out, the Sogenactif server recovers the list of payment methods available for the configuration of the shop.

    List of values
    1EUROCOM
    Cofidis Pay 5x10x20x paymentMeanBrandType: ONLINE_CREDIT
    3XCBCOFINOGA
    Deprecated. Cofinoga 3xCB paymentMeanBrandType: CARD
    ACCEPTGIRO
    AcceptGiro paymentMeanBrandType: CREDIT_TRANSFER
    ACCORD
    Oney card paymentMeanBrandType: CARD
    ACCORD_3X
    Facily Pay 3 X payment paymentMeanBrandType: ONLINE_CREDIT
    ACCORD_4X
    Facily Pay 4 X payment paymentMeanBrandType: ONLINE_CREDIT
    ACCORD_KDO
    Oney gift card paymentMeanBrandType: CARD
    AIRPLUS
    Airplus card paymentMeanBrandType: CARD
    AIRPLUS_LOGEE
    Airplus logee card paymentMeanBrandType: CARD
    AMEX
    American Express card paymentMeanBrandType: CARD
    AMEX_LOGEE
    American Express logee card paymentMeanBrandType: CARD
    AURORE
    CPAY card paymentMeanBrandType : CARD
    BCACB_3X
    Floa Bank CB 3 X payment paymentMeanBrandType: ONLINE_CREDIT
    BCACB_4X
    Floa Bank CB 4 X payment paymentMeanBrandType: ONLINE_CREDIT
    BCACUP
    CUP card issued by Floa Bank paymentMeanBrandType: CARD
    BCMC
    Bancontact paymentMeanBrandType: CARD
    CACF_3X
    CACF 3 X payment paymentMeanBrandType: ONLINE_CREDIT
    CACF_4X
    CACF 4 X payment 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
    Diners club international card 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
    Japan Credit Bureau card paymentMeanBrandType: CARD
    KBCONLINE
    PayButton KBC Online paymentMeanBrandType: CREDIT_TRANSFER
    LEPOTCOMMUN
    Le Pot Commun paymentMeanBrandType: CARD
    LYDIA
    Lydia paymentMeanBrandType: PROVIDER
    MAESTRO
    Carte Maestro (Mastercard) paymentMeanBrandType: CARD
    MASTERCARD
    Mastercard card paymentMeanBrandType: CARD
    MASTERPASS
    Deprecated - MasterPass electronic wallet paymentMeanBrandType: WALLET
    ONEY34X
    Oney Paiement 3 or 4 X payment paymentMeanBrandType: ONLINE_CREDIT
    PAYLIB
    Paylib electronic wallet paymentMeanBrandType: WALLET
    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
    VISA
    Visa card paymentMeanBrandType: CARD
    VISACHECKOUT
    Deprecated - Visa Checkout electronic wallet paymentMeanBrandType: WALLET
    VISA_ELECTRON
    Visa Electron card paymentMeanBrandType: CARD
    VPAY
    VPAY card (Visa) paymentMeanBrandType: CARD
  • sealAlgorithm
    presence
    Optional
    Interface version
    2.34

    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

Request sample

            {
  "customerIpAddress": "216.58.21.43",
  "interfaceVersion": "AUT_WS_2.34",
  "keyVersion": "1",
  "merchantId": "011223344550000",
  "paymentMeanBrandList": ["VISA", "CB"],
  "seal": "8217a6163368bee3b5baebc47a822d40327344ce578411055f95d6e5752d00f4"
}

        
                  <urn:hostedFieldsInitialize>
         <urn:input>
            <urn:customerIpAddress>216.58.21.43</urn:customerIpAddress>
            <urn:interfaceVersion>AUT_WS_2.34</urn:interfaceVersion>
            <urn:keyVersion>1</urn:keyVersion>
            <urn:merchantId>011223344550000</urn:merchantId>
            <urn:paymentMeanBrandList>
               <urn:paymentMeanBrand>VISA</urn:paymentMeanBrand>
               <urn:paymentMeanBrand>CB</urn:paymentMeanBrand>
            </urn:paymentMeanBrandList>
            <urn:seal>a7eb2054b6054bedc02e918e7eeb07e3bcecfca945b3e1697fe2a2c4cc3b52a6</urn:seal>
         </urn:input>
      </urn:hostedFieldsInitialize>

        

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

Response sample

            {
  "merchantSessionToken": "eyJ0eXAiOiJKV1QiLCJhbGciOiJIUzUxMiJ9.eyJkY[...]PTiJ9.lpENU[...]O61_g",
  "responseCode": "00",
  "sdkUrl" : "https://payment-web.test.sips-services.com/paymentprovider/hostedfields/services/sdpx-hostedfields-sdk.js",
  "seal": "4579cfc4044c29550327f9cba0be400129e95cb5b2639c6e301484930b4f9f94"
}

        
                  <hostedFieldsInitializeResponse xmlns="sips:cn:contract:office:checkout:v2">
         <output>
            <merchantSessionToken>eyJ0eXAiOiJKV1QiLCJhbGciOiJIUzUxMiJ9.eyJkY[...]PTiJ9.lpENU[...]O61_g</merchantSessionToken>
            <responseCode>00</responseCode>
            <sdkUrl>https://payment-web.test.sips-services.com/paymentprovider/hostedfields/services/sdpx-hostedfields-sdk.js</sdkUrl>
            <seal>a7eb2054b6054bedc02e918e7eeb07e3bcecfca945b3e1697fe2a2c4cc3b52a6</seal>
         </output>
      </hostedFieldsInitializeResponse>

        

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