hostedFieldsInitialize

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

Initialize a Hosted Fields session.

Recommended interfaceVersion: AUT_WS_2.55

Endpoints

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

Request

Required

interfaceVersion
presence

Required

Interface version

2.34
Format
AN20(restricted String)
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

AUT_WS_2.

Sogenactif Office Serveur (SOAP/JSON) interface for the Sogenactif authentication services.
keyVersion

presence

Required

Interface version

2.34

Format

N10

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

Format

N15

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

presence

Required

Interface version

2.34

Format

ANS128

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

Format

ipAddress

Buyer’s IP address.
intermediateServiceProviderId

presence

Optional

Interface version

2.34

Format

AN30

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

presence

Optional

Interface version

2.34

Format

ANS128(list)

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_3X

Facily Pay 3 X payment paymentMeanBrandType: ONLINE_CREDIT

ACCORD_4X

Facily Pay 4 X payment paymentMeanBrandType: ONLINE_CREDIT

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

APPLEPAY

Apple Pay 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

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

FRANFINANCE_3X

Franfinance 3xCB paymentMeanBrandType: ONLINE_CREDIT

FRANFINANCE_4X

Franfinance 4xCB paymentMeanBrandType: ONLINE_CREDIT

GIROPAY

Giropay paymentMeanBrandType: CREDIT_TRANSFER

GOOGLEPAY

Google Pay paymentMeanBrandType : CARD

ILLICADO

Illicado paymentMeanBrandType: CARD

INCASSO

Incasso paymentMeanBrandType: DIRECT_DEBIT

INGHOMEPAY

PayButton ING Home’Pay paymentMeanBrandType: CREDIT_TRANSFER

JCB

Japan Credit Bureau card paymentMeanBrandType: CARD

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

SAMSUNGPAY

Samsung Pay paymentMeanBrandType : CARD

SEPA_DIRECT_DEBIT

SDD (SEPA Direct Debit) paymentMeanBrandType: DIRECT_DEBIT

SOFINCO

Sofinco card paymentMeanBrandType: CARD

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

Format

ANS20(restricted values)

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

            {
  "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>

Response

Required

seal

presence

Required

Interface version

2.0

Format

ANS128

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

Format

ANS50

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

presence

Optional

Interface version

2.34

Format

ANS1024

Merchant session token that contains the context of information for the Hosted Fields session.
responseCode

presence

Optional

Interface version

2.0

Format

N2(restricted values)

Sogenactif server response code.

List of values

00

Operation accepted

03

Invalid merchant contract

34

Fraud suspicion (seal erroneous)

99

Temporarily problem with the payment server
sdkUrl

presence

Optional

Interface version

2.34

Format

url

Url of the Hosted Fields SDK.

Response sample

json
soap

            {
  "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>

Changelog

Filter

Interface version	Data	Attendance
2.34	`customerIpAddress`	Request
2.34	`intermediateServiceProviderId`	Request
2.34	`paymentMeanBrandList`	Request
2.34	`sealAlgorithm`	Request
2.34	`interfaceVersion`	Request
2.34	`keyVersion`	Request
2.34	`merchantId`	Request
2.34	`seal`	Request/Response
2.0	`errorFieldName`	Response
2.34	`merchantSessionToken`	Response
2.0	`responseCode`	Response
2.34	`sdkUrl`	Response

hostedFieldsInitialize

Endpoints

Request

Required

`interfaceVersion`

`keyVersion`

`merchantId`

`seal`

Optional

`customerIpAddress`

`intermediateServiceProviderId`

`paymentMeanBrandList`

`sealAlgorithm`

Request sample

Response

Required

`seal`

Optional

`errorFieldName`

`merchantSessionToken`

`responseCode`

`sdkUrl`

Response sample

Changelog

Need help?