getMandateData
Pour rechercher dans la page utiliser Ctrl+F sur votre clavier
Cette opération permet d’obtenir des informations concernant un mandat existant. La réponse contient des informations propres au mandat telles que le statut, l’IBAN, etc… mais aussi la liste des transactions « SEPA direct debit » associées aux mandats (s’il y en a).
interfaceVersion recommandée : MR_WS_2.55
Urls des environnements
-
- PROD
-
https://sherlocks-office-server.secure.lcl.fr/rs-services/v2/mandate/getMandateData
- méthode
- POST
-
- TEST
-
https://office-server-sherlocks.test.sips-services.com/rs-services/v2/mandate/getMandateData
- 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
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
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
Numéro de mandat.
-
merchantId
- présence
- Obligatoire
- Interface version
- 2.0
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
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
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
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
Réponse
Obligatoire
-
seal
- présence
- Obligatoire
- Interface version
- 2.0
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
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
-
bic
- présence
- Optionnel
- Interface version
- 2.0
Business Identifier Code (BIC), tel que défini par la norme ISO 9362. Le BIC identifie le code institution (financier ou non), son pays et sa localisation (sur 8 caractères), ainsi que la branche de l’institution (pour un code sur 11 caractères).
-
customerAddress
- présence
- Optionnel
- Interface version
- 2.0
Contient les données de l’adresse du client.
Contient
-
addressAdditional3
- présence
- Optionnel
- Interface version
- 2.0
Complément 3 de l’adresse.
-
businessName
- présence
- Optionnel
- Interface version
- 2.0
Raison sociale.
-
country
- présence
- Optionnel
- Interface version
- 2.0
Code pays de l’adresse.
Liste des valeurs
ABW
- ARUBA
AFG
- AFGHANISTAN
AGO
- ANGOLA
AIA
- ANGUILLA
ALA
- ÅLAND, ÎLES
ALB
- ALBANIE
AND
- ANDORRE
ARE
- ÉMIRATS ARABES UNIS
ARG
- ARGENTINE
ARM
- ARMÉNIE
ASM
- SAMOA AMÉRICAINES
ATA
- ANTARCTIQUE
ATF
- TERRES AUSTRALES FRANÇAISES
ATG
- ANTIGUA-ET-BARBUDA
AUS
- AUSTRALIE
AUT
- AUTRICHE
AZE
- AZERBAÏDJAN
BDI
- BURUNDI
BEL
- BELGIQUE
BEN
- BÉNIN
BES
- BONAIRE, SAINT-EUSTACHE ET SABA
BFA
- BURKINA FASO
BGD
- BANGLADESH
BGR
- BULGARIE
BHR
- BAHREÏN
BHS
- BAHAMAS
BIH
- BOSNIE-HERZÉGOVINE
BLM
- SAINT-KITTS-ET-NEVIS
BLR
- BÉLARUS
BLZ
- BELIZE
BMU
- BERMUDES
BOL
- BOLIVIE, l’ÉTAT PLURINATIONAL DE
BRA
- BRÉSIL
BRB
- BARBADE
BRN
- BRUNEI DARUSSALAM
BTN
- BHOUTAN
BVT
- BOUVET, ÎLE
BWA
- BOTSWANA
CAF
- CENTRAFRICAINE, RÉPUBLIQUE
CAN
- CANADA
CCK
- COCOS (KEELING), ÎLES
CHE
- SUISSE
CHL
- CHILI
CHN
- CHINE
CIV
- CÔTE D’IVOIRE
CMR
- CAMEROUN
COD
- CONGO, LA RÉPUBLIQUE DÉMOCRATIQUE DU
COG
- CONGO
COK
- COOK, ÎLES
COL
- COLOMBIE
COM
- COMORES
CPV
- CAP-VERT
CRI
- COSTA RICA
CUB
- CUBA
CUW
- CURAÇAO
CXR
- CHRISTMAS, ÎLE
CYM
- CAÏMANS, ÎLES
CYP
- CHYPRE
CZE
- TCHÈQUE, RÉPUBLIQUE
DEU
- ALLEMAGNE
DJI
- DJIBOUTI
DMA
- DOMINIQUE
DNK
- DANEMARK
DOM
- DOMINICAINE, RÉPUBLIQUE
DZA
- ALGÉRIE
ECU
- ÉQUATEUR
EGY
- ÉGYPTE
ERI
- ÉRYTHRÉE
ESH
- SAHARA OCCIDENTAL
ESP
- ESPAGNE
EST
- ESTONIE
ETH
- ÉTHIOPIE
FIN
- FINLANDE
FJI
- FIDJI
FLK
- FALKLAND, ÎLES (MALVINAS)
FRA
- FRANCE
FRO
- FÉROÉ, ÎLES
FSM
- MICRONÉSIE, ÉTATS FÉDÉRÉS DE
GAB
- GABON
GBR
- ROYAUME-UNI
GEO
- GÉORGIE
GGY
- GUERNESEY
GHA
- GHANA
GIB
- GIBRALTAR
GIN
- GUINÉE
GLP
- GUADELOUPE
GMB
- GAMBIE
GNB
- GUINÉE-BISSAU
GNQ
- GUINÉE ÉQUATORIALE
GRC
- GRÈCE
GRD
- GRENADE
GRL
- GROENLAND
GTM
- GUATEMALA
GUF
- GUYANE FRANÇAISE
GUM
- GUAM
GUY
- GUYANA
HKG
- HONG KONG
HMD
- HEARD-ET-ÎLES MACDONALD, ÎLE
HND
- HONDURAS
HRV
- CROATIE
HTI
- HAÏTI
HUN
- HONGRIE
IDN
- INDONÉSIE
IMN
- ÎLE DE MAN
IND
- INDE
IOT
- OCÉAN INDIEN, TERRITOIRE BRITANNIQUE DE L’
IRL
- IRLANDE
IRN
- IRAN, RÉPUBLIQUE ISLAMIQUE D’
IRQ
- IRAQ
ISL
- ISLANDE
ISR
- ISRAËL
ITA
- ITALIE
JAM
- JAMAÏQUE
JEY
- JERSEY
JOR
- JORDANIE
JPN
- JAPON
KAZ
- KAZAKHSTAN
KEN
- KENYA
KGZ
- KIRGHIZISTAN
KHM
- CAMBODGE
KIR
- KIRIBATI
KNA
- SAINT-BARTHÉLEMY
KOR
- CORÉE, RÉPUBLIQUE DE
KWT
- KOWEÏT
LAO
- LAO, RÉPUBLIQUE DÉMOCRATIQUE POPULAIRE
LBN
- LIBAN
LBR
- LIBÉRIA
LBY
- LIBYE
LCA
- SAINTE-HÉLÈNE, ASCENSION ET TRISTAN DA CUNHA
LIE
- LIECHTENSTEIN
LKA
- SRI LANKA
LSO
- LESOTHO
LTU
- LITUANIE
LUX
- LUXEMBOURG
LVA
- LETTONIE
MAC
- MACAO
MAF
- SAINT-MARTIN(PARTIE FRANÇAISE)
MAR
- MAROC
MCO
- MONACO
MDA
- MOLDOVA, RÉPUBLIQUE DE
MDG
- MADAGASCAR
MDV
- MALDIVES
MEX
- MEXIQUE
MHL
- MARSHALL, ÎLES
MKD
- MACÉDOINE, L’EX-RÉPUBLIQUE YOUGOSLAVE DE
MLI
- MALI
MLT
- MALTE
MMR
- MYANMAR
MNE
- MONTÉNÉGRO
MNG
- MONGOLIE
MNP
- MARIANNES DU NORD, ÎLES
MOZ
- MOZAMBIQUE
MRT
- MAURITANIE
MSR
- MONTSERRAT
MTQ
- MARTINIQUE
MUS
- MAURICE
MWI
- MALAWI
MYS
- MALAISIE
MYT
- MAYOTTE
NAM
- NAMIBIE
NCL
- NOUVELLE-CALÉDONIE
NER
- NIGER
NFK
- NORFOLK, ÎLE
NGA
- NIGÉRIA
NIC
- NICARAGUA
NIU
- NIUÉ
NLD
- PAYS-BAS
NOR
- NORVÈGE
NPL
- NÉPAL
NRU
- NAURU
NZL
- NOUVELLE-ZÉLANDE
OMN
- OMAN
PAK
- PAKISTAN
PAN
- PANAMA
PCN
- PITCAIRN
PER
- PÉROU
PHL
- PHILIPPINES
PLW
- PALAOS
PNG
- PAPOUASIE-NOUVELLE-GUINÉE
POL
- POLOGNE
PRI
- PORTO RICO
PRK
- CORÉE, RÉPUBLIQUE POPULAIRE DÉMOCRATIQUE DE
PRT
- PORTUGAL
PRY
- PARAGUAY
PSE
- PALESTINIEN OCCUPÉ, TERRITOIRE
PYF
- POLYNÉSIE FRANÇAISE
QAT
- QATAR
REU
- RÉUNION
ROU
- ROUMANIE
RUS
- RUSSIE, FÉDÉRATION DE
RWA
- RWANDA
SAU
- ARABIE SAOUDITE
SDN
- SOUDAN
SEN
- SÉNÉGAL
SGP
- SINGAPOUR
SGS
- GÉORGIE DU SUD-ET-LES ÎLES SANDWICH DU SUD
SHN
- SAINT-MARIN
SJM
- SVALBARD ET ÎLE JAN MAYEN
SLB
- SALOMON, ÎLES
SLE
- SIERRA LEONE
SLV
- EL SALVADOR
SMR
- SAINT-MARTIN (PARTIE NÉERLANDAISE)
SOM
- SOMALIE
SPM
- SAINT-SIÈGE (ÉTAT DE LA CITÉ DU VATICAN)
SRB
- SERBIE
SSD
- SOUDAN DU SUD
STP
- SAO TOMÉ-ET-PRINCIPE
SUR
- SURINAME
SVK
- SLOVAQUIE
SVN
- SLOVÉNIE
SWE
- SUÈDE
SWZ
- SWAZILAND
SXM
- SAINT-PIERRE-ET-MIQUELON
SYC
- SEYCHELLES
SYR
- SYRIENNE, RÉPUBLIQUE ARABE
TCA
- TURKS-ET-CAÏCOS, ÎLES
TCD
- TCHAD
TGO
- TOGO
THA
- THAÏLANDE
TJK
- TADJIKISTAN
TKL
- TOKELAU
TKM
- TURKMÉNISTAN
TLS
- TIMOR-LESTE
TON
- TONGA
TTO
- TRINITÉ-ET-TOBAGO
TUN
- TUNISIE
TUR
- TURQUIE
TUV
- TUVALU
TWN
- TAÏWAN, PROVINCE DE CHINE
TZA
- TANZANIE, RÉPUBLIQUE-UNIE DE
UGA
- OUGANDA
UKR
- UKRAINE
UMI
- ÎLES MINEURES ÉLOIGNÉES DES ÉTATS-UNIS
URY
- URUGUAY
USA
- ÉTATS-UNIS
UZB
- OUZBÉKISTAN
VAT
- SAINT-VINCENT-ET-LES GRENADINES
VCT
- SAINTE-LUCIE
VEN
- VENEZUELA, RÉPUBLIQUE BOLIVARIENNE DU
VGB
- ÎLES VIERGES BRITANNIQUES
VIR
- ÎLES VIERGES DES ÉTATS-UNIS
VNM
- VIET NAM
VUT
- VANUATU
WLF
- WALLIS ET FUTUNA
WSM
- SAMOA
YEM
- YÉMEN
ZAF
- AFRIQUE DU SUD
ZMB
- ZAMBIE
ZWE
- ZIMBABWE
-
city
- présence
- Optionnel
- Interface version
- 2.0
Ville de l’adresse.
-
company
- présence
- Optionnel
- Interface version
- 2.0
Entreprise de l’adresse.
-
addressAdditional1
- présence
- Optionnel
- Interface version
- 2.0
Complément 1 de l’adresse.
-
addressAdditional2
- présence
- Optionnel
- Interface version
- 2.0
Complément 2 de l’adresse.
-
postBox
- présence
- Optionnel
- Interface version
- 2.0
Boîte postale de l’adresse.
-
state
- présence
- Optionnel
- Interface version
- 2.0
Etat/département de l’adresse. A remplir en respectant la norme ISO 3166-2. Les deux premières lettres désignent le pays et les lettres suivant le tiret désignent la subdivision, ex : FR-ARA pour la région française Auvergne-Rhône-Alpes.
-
street
- présence
- Optionnel
- Interface version
- 2.0
Nom de la rue de l’adresse.
-
streetNumber
- présence
- Optionnel
- Interface version
- 2.0
Numéro de la rue de l’adresse.
-
zipCode
- présence
- Optionnel
- Interface version
- 2.0
Code postal de l’adresse.
-
customerContact
- présence
- Optionnel
- Interface version
- 2.0
Contient les informations du client.
Contient
-
email
- présence
- Optionnel
- Interface version
- 2.0
E-mail du contact.
-
firstname
- présence
- Optionnel
- Interface version
- 2.0
Prénom du contact.
-
gender
- présence
- Optionnel
- Interface version
- 2.0
Sexe du contact, masculin (=M) ou féminin (=F).
-
initials
- présence
- Optionnel
- Interface version
- 2.0
Initiales du contact
-
lastname
- présence
- Optionnel
- Interface version
- 2.0
Nom de famille du contact.
-
legalId
- présence
- Optionnel
- Interface version
- 2.0
Identifiant national d’établissement (SIRET pour la France). Cette donnée s’applique au commerçant et au client (c.f. champs Contact).
-
mobile
- présence
- Optionnel
- Interface version
- 2.0
Numéro de téléphone mobile du contact.
-
phone
- présence
- Optionnel
- Interface version
- 2.0
Numéro de téléphone du contact.
-
positionOccupied
- présence
- Optionnel
- Interface version
- 2.0
Fonction exercée.
-
title
- présence
- Optionnel
- Interface version
- 2.0
Titre de civilité du contact.
-
debtorName
- présence
- Optionnel
- Interface version
- 2.19
Nom complet du débiteur du mandat SDD (nom et prénom du mandataire).
-
directDebitList
- présence
- Optionnel
- Interface version
- 2.0
Liste des débits faits avec un mandat.
Contient
-
directDebit
- présence
- Optionnel
- Interface version
- 2.0
Contient les informations sur les débits faits avec un mandat.
Contient
-
amount
- présence
- Optionnel
- Interface version
- 2.0
Montant de la transaction. Le montant doit être transmis dans la plus petite unité de la devise.Exemple pour l’Euro : un montant de 10,50 Euros doit être transmis sous la forme 1050.
-
directDebitCreationDate
- présence
- Optionnel
- Interface version
- 2.0
Date de création du prélèvement.
-
directDebitStatus
- présence
- Optionnel
- Interface version
- 2.0
Statut du prélèvement.
Liste des valeurs
CANCELLED
- Annulé
CREATED
- Créé
DELETED
- Supprimé
ISSUED
- Émis
REFUND
- Remboursé
REJECTED
- Rejeté
RETURNED
- Retourné (renvoi d’une operation, après règlement interbancaire, à l’initiative de la banque du débiteur)
REVERSAL_REJECTED
- Remboursement rejeté
REVERSED
- Reversé (annulation, après règlement interbancaire à l’initiative du créancier ou de sa banque d’une opération qui n’aurait pas dû être réglée)
SETTLED
- Réglé
-
dueDate
- présence
- Optionnel
- Interface version
- 2.0
Voir “valueDate”.
-
iban
- présence
- Optionnel
- Interface version
- 2.0
International Bank Account Number (IBAN) identifiant un numéro de compte bancaire comme définit par la norme ISO 13616.
-
mandateCreationDate
- présence
- Optionnel
- Interface version
- 2.0
Date de création du mandat.
-
mandateId
- présence
- Optionnel
- Interface version
- 2.0
Numéro de mandat.
-
mandateLastUpdateDate
- présence
- Optionnel
- Interface version
- 2.0
Dernière date de mise à jour du mandat.
-
mandateResponseCode
- présence
- Optionnel
- Interface version
- 2.0
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
-
mandateSignatureDate
- présence
- Optionnel
- Interface version
- 2.0
Date de signature du mandat.
-
mandateStatus
- présence
- Optionnel
- Interface version
- 2.0
Statut du mandat.
Liste des valeurs
ACTIVE
- Actif
CANCELED
- Annulé
DELETED
- Supprimé
FINALIZED
- Finalisé
INACTIVE
- Inactive
OBSOLETE
- Obsolete (le client n’a pas validé son mandat dans les délais).
PENDING
- En attente
REVOKED
- Révoqué
SENT_TO_DEBTOR
- Envoyé au débiteur
SUSPENDED
- Suspendu
WAITING_FOR_VALIDATION
- En attente de validation
WAITING_REACHABILITY
- En attente de connexion (verification que l’établissement bancaire est joignable).
-
mandateUsage
- présence
- Optionnel
- Interface version
- 2.0
Type de mandat utilisé.
Liste des valeurs
ONE_OFF
- Mandat à usage unique
RECURRENT
- Mandat à usage récurrent
-
transactionActors
- présence
- Optionnel
- Interface version
- 2.0
Indique les acteurs de la transaction.
Liste des valeurs
BTOB
- Professionnel à Professionnel
BTOC
- Professionnel à Particulier
BTOF
- Professionnel à organisation / association
Exemple de réponse
Changelog