paymentTokenInitialize

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

Initialise une cinématique de génération d’un token de paiement avec “Sherlock’s In-App”.

interfaceVersion recommandée : IR_MB_3.0

Urls des environnements

PROD

https://sherlocks-office-server.secure.lcl.fr/rs-services/v2/tokenInApp/paymentTokenInitialize

méthode

POST
TEST

https://office-server-sherlocks.test.sips-services.com/rs-services/v2/tokenInApp/paymentTokenInitialize

méthode

POST

Requête

Obligatoire

interfaceVersion
présence

Obligatoire

Interface version

2.37
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

AR_WS_2.

Obsolète

AUT_WS_2.

interface Sherlock’s Office (SOAP/JSON) pour les services d’authentification Sherlock’s

AU_WS_2.

AU_WS: interface Sherlock’s Office (SOAP/JSON) pour les services de mise à jour de compte Sherlock’s.

CR_WS_2.

interface Sherlock’s Office (SOAP/JSON) pour les fonctions de gestion de caisse.

DR_WS_2.

interface Sherlock’s Office (SOAP/JSON) pour les fonctions de diagnostique.

FR_WS_2.

interface Sherlock’s Office (SOAP) interface pour les fonctions de fraude.

HP_x.x

interface Sherlock’s Paypage et Sherlock’s Walletpage (POST).

IR_MB_

interface Sherlock’s In-App (JSON) pour les fonctions Sherlock’s In-App.

IR_WS_

interface Sherlock’s Paypage et Sherlock’s Office (SOAP/JSON).

MR_WS_2.

interface Sherlock’s Office (SOAP/JSON) pour les fonctions liées aux mandats.

PMR_WS_2.

interface Sherlock’s Office (SOAP/JSON) pour les fonctions de demande d’information sur le référentiel des moyens de paiement.

TR_WS_2.

interface Sherlock’s Office (SOAP) pour les fonctions de token.

WMR_WS_2.

interface Sherlock’s Walletpage(SOAP/JSON).

WR_WS_2.

interface Sherlock’s Office (SOAP/JSON) pour les fonctions liées au wallet.
keyVersion

présence

Obligatoire

Interface version

2.37

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

Format

N15

Identifiant de la boutique, sa valeur est fournie par Sherlock’s au commerçant lors de l’inscription de sa boutique.
sdkOperationName

présence

Obligatoire

Interface version

2.37

Format

ANS30(restricted values)

Pour un paiement Sherlock’s In-App (ex : application mobile), indique au moment de la phase d’initialisation, le nom de l’opération qui a été choisie (ex : paiement carte).

Liste des valeurs

ADDCARD

Ajout d’une carte au Wallet Sherlock’s pour la phase d’initialisation d’une transaction Sherlock’s In-App

CARDORDER

Paiement par carte pour la phase d’initialisation d’une transaction Sherlock’s In-App

GETWALLETDATA

Consultation des informations d’un Wallet Sherlock’s pour la phase d’initialisation d’une transaction Sherlock’s In-App

PAYMENTPROVIDERORDER

Paiement via un partenaire externe pour la phase d’initialisation d’une transaction Sherlock’s In-App

PAYMENTTOKENGENERATE

Génération d’un Token pour une transaction Sherlock’s In-App

THREEDSECUREANDORDER

Paiement par carte pour la phase d’initialisation d’une transaction Sherlock’s In-App avec authentification 3-D Secure

THREEDSECUREANDWALLETORDER

Paiement avec un moyen de paiement enregistré dans le Wallet Sherlock’s pour la phase d’initialisation d’une transaction Sherlock’s In-App avec authentification 3-D Secure

WALLETORDER

Paiement avec un Wallet Sherlock’s pour la phase d’initialisation d’une transaction Sherlock’s In-App
sdkVersion

présence

Obligatoire

Interface version

2.37

Format

ANS20

Version de la librairie utilisée pour un paiement ou opération Sherlock’s In-App (ex : 2.0.4)
seal

présence

Obligatoire

Interface version

2.37

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

Format

ipAddress

Adresse IP de l’acheteur.
intermediateServiceProviderId

présence

Optionnel

Interface version

2.37

Format

AN30

Identifiant du service utilisé par le commerçant pour les échanges de flux avec la plateforme Sherlock’s.
sealAlgorithm

présence

Optionnel

Interface version

2.37

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

Exemple de requête

json

            {
    "interfaceVersion" : "IR_MB_2.37",
    "keyVersion" : "1",
    "merchantId" : "011223344550000",
    "sdkOperationName" : "PAYMENTTOKENGENERATE",
    "sdkVersion" : "SDK100",
    "seal" : "a5fc2c68e7051671c7b81c70ba971310b8d6188360199922cb3bd57778f3ffa4"
}

Réponse

Obligatoire

seal

présence

Obligatoire

Interface version

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

publicKeyValue

présence

Optionnel

Interface version

1.0

Format

ANS16

Dans le contexte d’un paiement via Sherlock’s In-App, valeur de la clé publique envoyée par Sherlock’s au commerçant en réponse de la requête d’initialisation permettant au commerçant de crypter les données carte à envoyer à Sherlock’s.
redirectionStatusCode

présence

Optionnel

Interface version

1.0

Format

N2(restricted values)

Code réponse retourné par Sherlock’s lors d’une redirection (exemple : redirection vers l’ACS, redirection vers le serveur Sherlock’s). Indique si la redirection est possible ou non.
Liste des valeurs
00
En retour de paymentWebInit : transaction initialisée

En retour de walletCheckEnrollment et cardCheckEnrollment : Carte enrôlée
01

En retour de cardCheckEnrollment et walletCheckEnrollment : carte non enrôlée 3-D Secure

03

Contrat commerçant invalide

10

Enrôlement de la carte n’a pas pu être défini (uniquement en réponse de cardCheckEnrollment et walletCheckEnrollment)

12

Transaction invalide, vérifier les paramètres transférés dans la requête

14

Coordonnées du moyen de paiement invalides (ex: n° de carte)

30

Erreur de format (Webinit ERROR)

34

Suspicion de fraude, erreur signature (Webinit ERROR)

80

Erreur rencontrée lors de l’interrogation du DS

89

Session du serveur 3-D Secure expirée

91

Commerçant non configuré dans le serveur 3-D Secure
94
En réponse de paymentWebInit : transaction dupliquée. Le transactionReference de la transaction a déjà été utilisé

En réponse de cardCheckEnrollment ou walletCheckEnrollment : erreur pendant la vérification de l’enrôlement
99

Erreur interne
redirectionStatusMessage

présence

Optionnel

Interface version

1.0

Format

ANS50

Information complémentaire retournée en plus du redirectionStatusCode.
redirectionUrl

présence

Optionnel

Interface version

1.0

Format

url

Dans le cas d’une vérification d’enrôlement, contient l’URL de redirection vers l’ACS requis pour l’authentification du porteur. Dans le cas d’un paiement in-App, contient l’URL du prochain appel.Dans le cas de 3-D Secure standalone, contient l’URL de redirection vers l’ACS requis pour l’authentification du porteur.
redirectionVersion
présence

Optionnel

Interface version

1.0
Format
AN20 (restricted String)
Version du message de redirection.

Exemple de réponse

json

            {
  "publicKeyValue":"30820122...10001",
  "redirectionStatusCode":"00",
  "redirectionStatusMessage":"Process succeeded",
  "redirectionUrl":"https://office-server.sips-services.com/rs-api/public/v2/tokenInApp/paymentTokenGenerate",
  "redirectionVersion":"IR_MB_2.37",
  "seal":"48670660a9167df5734d8f11546ee1d296557055e5861e8e2d1b85d6de7357fb"
}

Changelog

Filtre

Interface version	Donnée	Présence
2.37	`customerIpAddress`	Requête
2.37	`intermediateServiceProviderId`	Requête
2.37	`sealAlgorithm`	Requête
2.37	`interfaceVersion`	Requête
2.37	`keyVersion`	Requête
2.37	`merchantId`	Requête
2.37	`sdkOperationName`	Requête
2.37	`sdkVersion`	Requête
2.37	`seal`	Requête/Réponse
1.0	`publicKeyValue`	Réponse
1.0	`redirectionStatusCode`	Réponse
1.0	`redirectionStatusMessage`	Réponse
1.0	`redirectionUrl`	Réponse
1.0	`redirectionVersion`	Réponse

paymentTokenInitialize

Urls des environnements

Requête

Obligatoire

`interfaceVersion`

`keyVersion`

`merchantId`

`sdkOperationName`

`sdkVersion`

`seal`

Optionnel

`customerIpAddress`

`intermediateServiceProviderId`

`sealAlgorithm`

Exemple de requête

Réponse

Obligatoire

`seal`

Optionnel

`publicKeyValue`

`redirectionStatusCode`

`redirectionStatusMessage`

`redirectionUrl`

`redirectionVersion`

Exemple de réponse

Changelog

Besoin d'aide ?