getPdfMandate

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

Cette fonction permet de récupérer le PDF d’un mandat existant. Le PDF est sérialisé en Base64. La chaîne de caractères doit être décodée et convertie en fichier PDF pour permettre la lecture ou le téléchargement.

interfaceVersion recommandée : MR_WS_2.55

PROD

https://sherlocks-office-server.secure.lcl.fr/rs-services/v2/mandate/getPDFMandate

méthode

POST
TEST

https://office-server-sherlocks.test.sips-services.com/rs-services/v2/mandate/getPDFMandate

méthode

POST

PROD

https://sherlocks-office-server.secure.lcl.fr/services/v2/mandate?wsdl

méthode

POST
TEST

https://office-server-sherlocks.test.sips-services.com/services/v2/mandate?wsdl

méthode

POST

Requête

Obligatoire

interfaceVersion
présence

Obligatoire

Interface version

2.0
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

MR_WS_2.

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

présence

Obligatoire

Interface version

2.0

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).
mandateId

présence

Obligatoire

Interface version

2.0

Format

AN35

Numéro de mandat.
merchantId

présence

Obligatoire

Interface version

2.0

Format

N15

Identifiant de la boutique, sa valeur est fournie par Sherlock’s au commerçant lors de l’inscription de sa boutique.
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

intermediateServiceProviderId

présence

Optionnel

Interface version

2.0

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

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
soap

            {
  "interfaceVersion": "MR_WS_2.20",
  "keyVersion": "1",
  "mandateId": "000000000000000677",
  "merchantId": "011223344550000",
  "seal": "fc24b9e6bd7a433d258a1df1a8af2698b917d1632aaa1bc12c5c8f45adbeba11"
}

                  <urn:getPDFMandate>
         <urn:input>
            <urn:interfaceVersion>MR_WS_2.18</urn:interfaceVersion>
            <urn:merchantId>011223344550000</urn:merchantId>
            <urn:mandateId>000000000000000667</urn:mandateId>
            <urn:keyVersion>1</urn:keyVersion>
            <urn:seal>ae13163cfb5c7c8adb39c032876323f6d34d22d378f95d3e05ef774af7f0a720</urn:seal>
         </urn:input>
      </urn:getPDFMandate>

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

acquirerResponseCode

présence

Optionnel

Interface version

2.0

Format

AN2(restricted values)

Code réponse retourné par l’acquéreur lors d’une demande d’autorisation.

Liste des valeurs

00

Transaction approuvée ou traitée avec succès

02

Contactez l’émetteur du moyen de paiement

03

Accepteur invalide

04

Conservez le support du moyen de paiement

05

Ne pas honorer

07

Conservez le support du moyen de paiement, conditions spéciales

08

Approuvez après l’identification

12

Transaction invalide

13

Montant invalide

14

Coordonnées du moyen de paiement invalides

15

Émetteur du moyen de paiement inconnu

17

Paiement interrompu par l’acheteur

20

Réponse erronée (erreur dans le domaine serveur)

24

Opération impossible

25

Transaction inconnue

30

Erreur de format

31

Id de l’organisation d’acquisition inconnu

33

Moyen de paiement expiré (Paypal / Cofidis)

34

Suspicion de fraude

40

Fonction non supportée

41

Moyen de paiement perdu

43

Moyen de paiement volé

51

Provision insuffisante ou crédit dépassé

54

Moyen de paiement expiré (CB / Visa / MC / WLAcq / BCMC)

55

PIN invalide

56

Moyen de paiement manquant dans le fichier

57

Transaction non autorisée pour ce porteur

58

Transaction interdite au terminal

59

Suspicion de fraude

60

L’accepteur du moyen de paiement doit contacter l’acquéreur

61

Excède le maximum autorisé

62

Transaction en attente de confirmation de paiement

63

Règles de sécurité non respectées

65

Nombre de transactions du jour dépassé

68

Réponse non parvenue ou reçue trop tard

75

Nombre de tentatives de saisie des coordonnées du moyen de paiement dépassé

87

Terminal inconnu

90

Arrêt momentané du système

91

Emetteur du moyen de paiement inaccessible

92

La transaction ne contient pas les informations suffisantes pour être redirigées vers l’organisme d’autorisation

93

La transaction n’a pas pu aboutir car non conforme à la réglementation

94

Transaction dupliquée

96

Mauvais fonctionnement du système

97

Requête expirée: transaction refusée

98

Serveur inaccessible

99

Incident technique

A1

Transaction refusée pour cause d’absence des données d’authentification 3-D Secure

A4

Transaction refusée pour cause de mauvaise utilisation de l’exemption d’authentification 3-D Secure

R1

Le porteur (ou sa banque) a révoqué les paiements récurrents effectués chez un commerçant

R3

Le porteur (ou sa banque) a révoqué tous les paiements récurrents
errorFieldName

présence

Optionnel

Interface version

2.21

Format

ANS50

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

présence

Optionnel

Interface version

2.0

Format

ANS10240

Pdf du mandat encodé en base64.
mandateResponseCode

présence

Optionnel

Interface version

2.0

Format

N2

Code réponse fourni par le service de gestion d’un mandat.

Liste des valeurs

00

Opération sur mandat acceptée

03

Contrat commerçant invalide

05

Opération sur mandat refusé

12

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

17

Annulation de l’acheteur

25

Mandat non trouvé

30

Erreur de format

34

Suspicion de fraude (seal erroné)

40

Fonction non supportée : l’opération que vous souhaitez réaliser ne fait pas partie de la liste des opérations auxquelles vous êtes autorisés

99

Problème temporaire au niveau du serveur Sherlock’s

Exemple de réponse

json
soap

            {
  "mandateResponseCode": "00",
  "acquirerResponseCode": "00",
  "mandatePdf": "JVBERi0xLjQdqzdzqdqzdqzhcnR4cmVmCjIxNzA2CiUlRU9GCg\u003d\u003d",
  "seal": "df97074b81e534d70cccbff5446b71d36c4d4de6d995fe630c8077d6fa85c0a3"
}

            <getPDFMandateResponse xmlns="urn:sips:cn:contract:office:mandatemanagement:v2">
         <output>
            <responseCode>00</responseCode>
            <acquirerResponseCode>00</acquirerResponseCode>
            <mandatePdf>JVBERi0xLjQKJeLjz9MKNSAwIG9iaiA8PC9MZW5ndGggMjA5MzkvRmlsdGVyL0ZsYXRlRGVjb2RlPj5zdHJlYW0KeJztvcuWJMeRJbjPr/DdgNWkl9vbrFeDR7IOeIoAmEhWT7HQi0BGJBDNeCTjATbqa+Yj+oNq2dlfMaauoiJyRUQzzHrOmdWQh/QUDZHrV+91F1fzMNX426sv3r46Hea+MjE3MDIKJSVFT0YK</mandatePdf>
            <seal>bf3055b267483d68c9b192915433dd5c7b07b42af38b8c1b00b1b66eea108728</seal>
         </output>
</getPDFMandateResponse>

Changelog

Filtre

Interface version	Donnée	Présence
2.0	`intermediateServiceProviderId`	Requête
2.0	`sealAlgorithm`	Requête
2.0	`interfaceVersion`	Requête
2.0	`keyVersion`	Requête
2.0	`mandateId`	Requête
2.0	`merchantId`	Requête
2.0	`seal`	Requête/Réponse
2.0	`acquirerResponseCode`	Réponse
2.21	`errorFieldName`	Réponse
2.0	`mandatePdf`	Réponse
2.0	`mandateResponseCode`	Réponse

getPdfMandate

Urls des environnements

Requête

Obligatoire

`interfaceVersion`

`keyVersion`

`mandateId`

`merchantId`

`seal`

Optionnel

`intermediateServiceProviderId`

`sealAlgorithm`

Exemple de requête

Réponse

Obligatoire

`seal`

Optionnel

`acquirerResponseCode`

`errorFieldName`

`mandatePdf`

`mandateResponseCode`

Exemple de réponse

Changelog

Besoin d'aide ?