Release 24.5

aller directement au contenu

Rechercher par mots clés

cancel

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

Cette fonction permet d’annuler une transaction avant l’envoi en banque ou de modifier son montant. Une opération d’annulation ne peut pas être annulée et on ne peut pas annuler un montant supérieur au montant d’origine de la transaction.

interfaceVersion recommandée : CR_WS_2.55

  • PROD
    https://sherlocks-office-server.secure.lcl.fr/rs-services/v2/cashManagement/cancel
    méthode
    POST
  • TEST
    https://office-server-sherlocks.test.sips-services.com/rs-services/v2/cashManagement/cancel
    méthode
    POST
  • PROD
    https://sherlocks-office-server.secure.lcl.fr/services/v2/cashManagement?wsdl
    méthode
    POST
  • TEST
    https://office-server-sherlocks.test.sips-services.com/services/v2/cashManagement?wsdl
    méthode
    POST

Obligatoire

  • currencyCode
    présence
    Obligatoire
    Interface version
    2.0

    Code de la devise de la transaction. Ce code est compatible ISO 4217.

    Liste des valeurs
    032
    Peso argentin
    036
    Dollar australien
    048
    Dinar de Bahreïn
    116
    Riel cambodgien
    124
    Dollar canadien
    144
    Roupie sri lankaise
    156
    Yuan Renminbi
    191
    Kuna croate
    203
    Couronne tchèque
    208
    Couronne danoise
    344
    Dollar de Hong Kong
    348
    Forint hongrois
    352
    Couronne islandaise
    356
    Roupie indienne
    376
    Nouveau Shekel israélien
    392
    Yen japonais
    410
    Won coréen
    414
    Dinar koweïtien
    458
    Ringgit malaisien
    480
    Roupie de Maurice
    484
    Peso mexicain
    524
    Roupie népalaise
    554
    Dollar néo-zélandais
    578
    Couronne norvégienne
    634
    Rial qatari
    643
    Rouble russe
    682
    Riyal saoudien
    702
    Dollar de Singapour
    710
    Rand sud-africain
    752
    Couronne suédoise
    756
    Franc suisse
    764
    Baht thaïlandais
    784
    Dirham des Émirats arabes unis
    788
    Dinar tunisien
    826
    Livre Sterling
    840
    Dollar américain
    901
    Dollar de Taiwan
    941
    Dinar serbe
    946
    Leu roumain
    949
    Nouvelle livre turque
    952
    Franc CFA
    953
    Franc Pacifique
    975
    Lev bulgare
    978
    Euro
    980
    Hryvnia ukrainien
    985
    Zloty polonaise
    986
    Real brésilien
  • 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
    CR_WS_2.
    interface Sherlock’s Office (SOAP/JSON) pour les fonctions de gestion de caisse.
  • 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).

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

  • operationAmount
    présence
    Obligatoire
    Interface version
    2.0

    Montant de l’opération (remboursement, annulation, validation …). 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.

  • 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

Exemple de requête

            {
  "currencyCode": "978",
  "interfaceVersion": "CR_WS_2.3",
  "merchantId": "011223344550000",
  "operationAmount": "120",
  "operationOrigin": "SO_BATCH",
  "transactionReference": "TREFEXA2012",
  "keyVersion": "1",
  "seal": "bed2f99d4137d402fde0c86a182f7d4f01c68e57d8a073fe5e920c57d06da1b5"
}

        
                  <urn:cancel>
         <urn:input>
            <urn:operationAmount>120</urn:operationAmount>
            <urn:currencyCode>978</urn:currencyCode>
            <urn:merchantId>011223344550000</urn:merchantId>
            <urn:interfaceVersion>CR_WS_2.2</urn:interfaceVersion>
            <urn:transactionReference>TREFEXA2012</urn:transactionReference>
            <urn:operationOrigin>SO_BATCH</urn:operationOrigin>
         </urn:input>
      </urn:cancel>

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

    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

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

  • newAmount
    présence
    Optionnel
    Interface version
    2.0

    Montant de la transaction mis à jour après opération de caisse;Par exemple, si après avoir effectué une demande d’autorisation acceptée de 10,00 Euros, un commerçant annule 3,00 Euros, le champ newAmount à la fin de l’annulation sera de 7,00 Euros.Le montant est 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.

  • newStatus
    présence
    Optionnel
    Interface version
    2.0

    Etat de la transaction mis à jour après une opération de caisse L’état d’une transaction est décrit par différents mots clés évoluant au fil des opérations qu’elle subit.

    Liste des valeurs
    ABORTED
    Transaction totalement abandonnée
    CANCELLED
    Transaction totalement annulée
    CAPTURED
    Transaction envoyée en banque
    CAPTURE_REFUSED
    Remise refusée
    CREDITED
    Transaction totalement remboursée
    ENDED
    Transaction terminée
    EXPIRED
    Transaction expirée
    PENDING
    Transaction en attente de la réponse à la demande d’autorisation
    PREPROD
    Transaction d’un commerçant qui est en mode Pré-production. Elle ne pourra pas être remisée.
    REFUSED
    Transaction refusée
    TO_AUTHORIZE
    Transaction en attente de demande d’autorisation
    TO_CAPTURE
    Transaction à envoyer en banque pour débiter l’internaute
    TO_CHALLENGE
    Transaction avec une suspicion de fraude
    TO_CONFIRM_AUTHOR
    Transaction en attente de confirmation d’autorisation.
    TO_CONFIRM_CAPTURE
    Transaction en attente de confirmation de remise.
    TO_CONFIRM_CREDIT
    Transaction en attente de confirmation de remboursement.
    TO_CREDIT
    Transaction à envoyer en banque pour créditer l’internaute
    TO_REPLAY
    Transaction en attente d’une validation avec demande d’autorisation
    TO_VALIDATE
    Transaction en attente de validation
    UNDEFINED
    Statut de la transaction non défini
    WAITING_AUTHOR
    Transaction extraite par les serveurs Sherlock’s pour réaliser une demande d’autorisation automatique à la fin du délai de capture différée
  • operationDateTime
    présence
    Optionnel
    Interface version
    2.0

    Date et heure calculée par Sherlock’s à laquelle l’opération a été effectuée.

  • responseCode
    présence
    Optionnel
    Interface version
    2.0

    Code réponse du serveur Sherlock’s.

    Liste des valeurs
    00
    Opération acceptée
    01
    Pour les méthodes panToToken et tokenToPan, succès partiel
    02
    Demande d’autorisation par téléphone à la banque à cause d’un dépassement du plafond d’autorisation sur la carte
    03
    Contrat commerçant invalide
    05
    Autorisation refusée
    11
    Utilisé dans le cas d’un contrôle différé. Le PAN est en opposition
    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 ou cryptogramme visuel de la carte) ou vérification AVS échouée
    17
    Annulation de l’acheteur
    24
    • En réponse d’une opération de gestion de caisse : opération impossible. L’opération que vous souhaitez réaliser n’est pas compatible avec l’état de la transaction ou une autre opération de caisse est en cours sur la transaction au même moment.
    • En réponse d’une création de paiement : opération rejetée, requête déjà effectuée avec les mêmes données et les mêmes paramètres
    25
    Transaction inconnue de Sherlock’s
    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
    51
    Montant trop élevé
    54
    Date de validité du moyen de paiement dépassée
    55
    Cartes prépayées non acceptées
    57
    Remboursement refusé car la transaction d’origine a fait l’objet d’un impayé
    60
    Transaction en attente
    62
    En attente de confirmation pour la transaction (utilisé par PayPal 1.0)
    63
    Règles de sécurité non respectées, transaction arrêtée
    75
    Nombre de tentatives de saisie des coordonnées du moyen de paiement sous Sherlock’s Paypage dépassé
    90
    Service temporairement indisponible
    94
    Transaction dupliquée : le transactionReference de la transaction est déjà utilisé
    97
    Session expirée (aucune action de l’utilisateur pendant 15 minutes), transaction refusée
    99
    Problème temporaire du serveur de paiement.

Exemple de réponse

            {
  "newAmount": 0,
  "operationDateTime": "2012-10-16T23:51:42-12:00",
  "responseCode": "00",
  "newStatus": "CANCELLED",
  "seal": "919b544bfb60539c8979992bc469e0b4229030ee2462a51f62c9cbd3510b3647"
}

        
                  <cancelResponse xmlns="urn:sips:cn:contract:office:cashmanagement:v2">
         <output>
            <newAmount>0</newAmount>
            <operationDateTime>2012-10-16T23:51:42-12:00</operationDateTime>
            <responseCode>00</responseCode>
            <newStatus>CANCELLED</newStatus>
         </output>
      </cancelResponse>

Changelog


Interface version Donnée Présence Conteneur
2.20 customerContact Requête
2.20 email Conteneur
  • customerContact
    • 2.20 firstname Conteneur
  • customerContact
    • 2.20 gender Conteneur
  • customerContact
    • 2.20 initials Conteneur
  • customerContact
    • 2.20 lastname Conteneur
  • customerContact
    • 2.20 mobile Conteneur
  • customerContact
    • 2.20 phone Conteneur
  • customerContact
    • 2.20 title Conteneur
  • customerContact
    • 2.12 intermediateServiceProviderId Requête
    2.0 operationOrigin Requête
    2.6 s10TransactionReference Requête
    2.6 s10TransactionId Conteneur
  • s10TransactionReference
    • 2.6 s10TransactionIdDate Conteneur
  • s10TransactionReference
    • 2.12 sealAlgorithm Requête
    2.0 transactionReference Requête
    2.0 currencyCode Requête
    2.0 interfaceVersion Requête
    2.0 keyVersion Requête
    2.0 merchantId Requête
    2.0 operationAmount Requête
    2.0 seal Requête/Réponse
    2.20 acquirerResponseCode Réponse
    2.21 errorFieldName Réponse
    2.0 newAmount Réponse
    2.0 newStatus Réponse
    2.0 operationDateTime Réponse
    2.0 responseCode Réponse
    Retourner en haut de page Besoin d'aide ?

    Besoin d'aide ?

    Contacter le support
    Fermer

    Ce site utilise des traceurs pour améliorer votre expérience de navigation, effectuer des analyses et des recherches sur votre utilisation du site web de documentation Sherlock's.
    En fermant ce bandeau vous refusez notre utilisation des traceurs sur votre appareil.

    Paramètres