hostedFieldsInitialize

Pour rechercher dans la page utiliser Ctrl+F sur votre clavier

Initialise une session Hosted Fields.

interfaceVersion recommandée : AUT_WS_2.55

Urls des environnements

PROD

https://office-server.sogenactif.com/rs-services/v2/authentication/hostedFieldsInitialize

méthode

POST
TEST

https://office-server-sogenactif.test.sips-services.com/rs-services/v2/authentication/hostedFieldsInitialize

méthode

POST

Requête

Obligatoire

interfaceVersion
présence

Obligatoire

Interface version

2.34
Format
AN20(restricted String)
Version de l’interface utilisée. Elle est composée d’un préfixe qui varie selon la fonction utilisée et d’un numéro de version (ex : IR_WS_2.47).

Veuillez-vous référer à la page de la fonction pour connaître la valeur à utiliser. Utilisez le dernier numéro d’interfaceVersion.

Liste des valeurs

AUT_WS_2.

interface Sogenactif Office Serveur (SOAP/JSON) pour les services d’authentification Sogenactif
keyVersion

présence

Obligatoire

Interface version

2.34

Format

N10

Version de la clé secrète du commerçant utilisée pour calculer l’empreinte du message (clé stockée par le commerçant pour vérifier l’empreinte des notifications automatiques et manuelles).
merchantId

présence

Obligatoire

Interface version

2.34

Format

N15

Identifiant de la boutique, sa valeur est fournie par Sogenactif au commerçant lors de l’inscription de sa boutique.
seal

présence

Obligatoire

Interface version

2.34

Format

ANS128

Sceau du message utilisé pour assurer l’intégrité de la requête et l’authentification de l’émetteur/destinataire du message (partage de la clé secrète).

Optionnel

customerIpAddress

présence

Optionnel

Interface version

2.34

Format

ipAddress

Adresse IP de l’acheteur.
intermediateServiceProviderId

présence

Optionnel

Interface version

2.34

Format

AN30

Identifiant du service utilisé par le commerçant pour les échanges de flux avec la plateforme Sogenactif.
paymentMeanBrandList

présence

Optionnel

Interface version

2.34

Format

ANS128(list)

Liste des moyens de paiement acceptés pour une transaction.Si ce champ n’est pas renseigné, le serveur Sogenactif récupère la liste des moyens de paiements disponibles de la configuration de la boutique.

Liste des valeurs

1EUROCOM

Cofidis Pay 5x10x20x paymentMeanBrandType : ONLINE_CREDIT

3XCBCOFINOGA

Valeur Obsolète. Cofinoga 3xCB paymentMeanBrandType : CARD

ACCEPTGIRO

AcceptGiro paymentMeanBrandType : CREDIT_TRANSFER

ACCORD_3X

Facily Pay Paiement 3 fois paymentMeanBrandType : ONLINE_CREDIT

ACCORD_4X

Facily Pay Paiement 4 fois paymentMeanBrandType : ONLINE_CREDIT

AIRPLUS

Carte Airplus paymentMeanBrandType : CARD

AIRPLUS_LOGEE

Carte Airplus logée paymentMeanBrandType : CARD

AMEX

Carte American Express paymentMeanBrandType : CARD

AMEX_LOGEE

Carte American Express logée paymentMeanBrandType : CARD

APPLEPAY

Apple Pay paymentMeanBrandType : CARD

AURORE

Carte CPAY paymentMeanBrandType : CARD

BCACB_3X

Floa Bank CB paiement en 3 fois paymentMeanBrandType : ONLINE_CREDIT

BCACB_4X

Floa Bank CB paiement en 4 fois paymentMeanBrandType : ONLINE_CREDIT

BCACUP

Carte CUP de Floa Bank paymentMeanBrandType : CARD

BCMC

Bancontact paymentMeanBrandType : CARD

CACF_3X

CACF paiement en 3 fois paymentMeanBrandType : ONLINE_CREDIT

CACF_4X

CACF paiement en 4 fois 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

Carte China UnionPay paymentMeanBrandType : CARD

CVA

Carte Visa Aurore paymentMeanBrandType : CARD

CVCO

Chèque-Vacances Connect paymentMeanBrandType : VOUCHER

DINERS

Carte Diners club international 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

Carte Japan Credit Bureau paymentMeanBrandType : CARD

LEPOTCOMMUN

Le Pot Commun paymentMeanBrandType : CARD

LYDIA

Lydia paymentMeanBrandType : PROVIDER

MAESTRO

Carte Maestro (Mastercard) paymentMeanBrandType : CARD

MASTERCARD

Carte Mastercard paymentMeanBrandType : CARD

MASTERPASS

Obsolète - Portefeuille virtuel MasterPass paymentMeanBrandType : WALLET

ONEY34X

Oney Paiement 3 fois ou 4 fois paymentMeanBrandType : ONLINE_CREDIT

PAYLIB

Portefeuille virtuel Paylib paymentMeanBrandType : WALLET

PAYPAL

Paypal paymentMeanBrandType : WALLET

PAYTRAIL

Paytrail paymentMeanBrandType : CREDIT_TRANSFER

PAY_BY_BANK

Virement bancaire SEPA paymentMeanBrandType : CREDIT_TRANSFER

SAMSUNGPAY

Samsung Pay paymentMeanBrandType : CARD

SEPA_DIRECT_DEBIT

SDD (SEPA Direct Debit) paymentMeanBrandType : DIRECT_DEBIT

SOFINCO

Carte Sofinco paymentMeanBrandType : CARD

UNKNOWN

Inconnu

VISA

Carte Visa paymentMeanBrandType : CARD

VISACHECKOUT

Obsolète - Portefeuille virtuel Visa Checkout paymentMeanBrandType : WALLET

VISA_ELECTRON

Carte Visa Electron paymentMeanBrandType : CARD

VPAY

Carte VPAY (Visa) paymentMeanBrandType : CARD
sealAlgorithm

présence

Optionnel

Interface version

2.34

Format

ANS20(restricted values)

Algorithme de cryptage utilisé pour le calcul du sceau.

Liste des valeurs

HMAC-SHA-256

L’algorithme de cryptage utilisé est HMAC-SHA-256

HMAC-SHA-512

L’algorithme de cryptage utilisé est HMAC-SHA-512

SHA-256

L’algorithme de cryptage utilisé est 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>

Réponse

Obligatoire

seal

présence

Obligatoire

Interface version

2.0

Format

ANS128

Sceau du message utilisé pour assurer l’intégrité de la requête et l’authentification de l’émetteur/destinataire du message (partage de la clé secrète).

Optionnel

errorFieldName

présence

Optionnel

Interface version

2.0

Format

ANS50

Nom du champ en erreur dans la requête. Présent lorsque responseCode = 12 ou 30.
merchantSessionToken

présence

Optionnel

Interface version

2.34

Format

ANS1024

Token de session commerçant qui contient le contexte des informations de la session Hosted Fields.
responseCode

présence

Optionnel

Interface version

2.0

Format

N2(restricted values)

Code réponse du serveur Sogenactif.

Liste des valeurs

00

Opération acceptée

03

Contrat commerçant invalide

34

Suspicion de fraude (seal erroné)

99

Problème temporaire du serveur de paiement.
sdkUrl

présence

Optionnel

Interface version

2.34

Format

url

Url du SDK Hosted Fields.

Exemple de réponse

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

Filtre

Interface version	Donnée	Présence
2.34	`customerIpAddress`	Requête
2.34	`intermediateServiceProviderId`	Requête
2.34	`paymentMeanBrandList`	Requête
2.34	`sealAlgorithm`	Requête
2.34	`interfaceVersion`	Requête
2.34	`keyVersion`	Requête
2.34	`merchantId`	Requête
2.34	`seal`	Requête/Réponse
2.0	`errorFieldName`	Réponse
2.34	`merchantSessionToken`	Réponse
2.0	`responseCode`	Réponse
2.34	`sdkUrl`	Réponse

hostedFieldsInitialize

Urls des environnements

Requête

Obligatoire

`interfaceVersion`

`keyVersion`

`merchantId`

`seal`

Optionnel

`customerIpAddress`

`intermediateServiceProviderId`

`paymentMeanBrandList`

`sealAlgorithm`

Exemple de requête

Réponse

Obligatoire

`seal`

Optionnel

`errorFieldName`

`merchantSessionToken`

`responseCode`

`sdkUrl`

Exemple de réponse

Changelog

Besoin d'aide ?