Release 24.5

aller directement au contenu

Rechercher par mots clés

validate (batch)

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

Cette fonction permet de déclencher la remise en paiement d’une transaction. Elle vous permet de faire du paiement différé en débitant votre client à l’expédition des produits achetés.

Obligatoire

  • currencyCode
    présence
    Obligatoire
    Interface version
    4
    Ordre
    5

    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
  • merchantId
    présence
    Obligatoire
    Interface version
    4
    Ordre
    2

    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
    4
    Ordre
    4

    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.

  • recordSequence
    présence
    Obligatoire
    Interface version
    4
    Ordre
    1

    Ordre d’une transaction dans un fichier Sherlock’s Office Batch.

Optionnel

Exemple de requête

            FILE;request;office;v19
HEADER;023101122334455;2021-12-16+0100;14:26:45+0100;1
VALIDATE;11;023101122334456;SIM20220329092501;66;978;origin;101;20210329;lastRecoveryIndicator
END;1

        
            <?xml version="1.0" encoding="UTF-8"?>
<file format="office" type="request" version="5">
	<header>
		<remitterId>023101122334455</remitterId>
		<date>2018-07-25+02:00</date>
		<time>09:00:00+01:00</time>
		<sequence>1</sequence>
	</header>
	<body>
		<validate recordSequence="1">
            <merchantId>023101122334456</merchantId>
            <transactionReference>SIM20220329092501</transactionReference>
            <operationAmount>66</operationAmount>
            <currencyCode>978</currencyCode>
            <operationOrigin>origin</operationOrigin>
            <s10TransactionReference>
                <s10TransactionId>101</s10TransactionId>
                <s10TransactionIdDate>20210329</s10TransactionIdDate>
            </s10TransactionReference>
            <lastRecoveryIndicator>lastRecoveryIndicator</lastRecoveryIndicator>
        </validate>
	</body>
	<end nbRecord="1" />
</file>

        

Obligatoire

  • currencyCode
    présence
    Obligatoire
    Interface version
    4
    Ordre
    5

    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
  • merchantId
    présence
    Obligatoire
    Interface version
    4
    Ordre
    2

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

  • officeBatchResponseCode
    présence
    Obligatoire
    Interface version
    4
    Ordre
    15

    officeBatchResponseCode complète le résultat du traitement d’une demande de paiement traitée par Sherlock’s Office Batch qui serait rejetée (code de réponse classique de rejet) et contient le champ de la demande de paiement en erreur.

    Liste des valeurs
    00
    Aucun (tous les champs sont corrects).
    01
    merchantId error
    03
    transactionReference error
    04
    merchantTransactionDateTime error
    05
    amount error
    06
    captureDay error
    07
    captureMode error
    08
    operationAmount error
    09
    operationOrigin error
    11
    currencyCode error
    12
    customerIpAddress error
    13
    customerEmail error
    14
    customerId error
    16
    orderId error
    17
    orderChannel error
    18
    transactionOrigin error
    19
    returnContext error
    20
    fromTransactionReference error
    21
    cardExpiryDate error
    22
    cardNumber error
    23
    cardCSCValue error
    24
    cardEffectiveDate error
    25
    cardSeqNumber error
    26
    paymentMeanBrand error
    27
    authorisationId error
    28
    merchantWalletId error
    29
    paymentMeanId error
    30
    paymentPattern error
    31
    number error
    32
    statementReference error
    33
    panType error
    34
    mandateId error
    35
    valueDate error
    36
    paymentMeanAlias error
    37
    account error
    38
    bankCode error
    39
    transactionActors error
    45
    Date fields format error
    46
    settlementMode error
    47
    comment error
    48
    validationIndicator error
    50
    s10TransactionId error
    51
    s10TransactionIdDate error
    52
    s10FromTransactionId error
    53
    s10FromTransactionIdDate error
    54
    fraudData error
    55
    riskManagementDynamicParam error
    56
    riskManagementDynamicValue error
    57
    riskManagementDynamicSettingList error
    58
    fraudListReason error
    59
    fraudListType error
    60
    fraudListLevel error
    61
    fraudListElementType error
    62
    fraudListElementValue error
    63
    lastRecoveryIndicator error
    64
    orderContext error
    65
    travelContext error
    66
    deliveryData error
    67
    address error
    68
    contact error
    69
    cardAuthPolicy error
    70
    shoppingCartDetail error
    71
    merchantExternalId error
    72
    paymentMeansBrandSelectionStatus error
    73
    settlementArchivingReference error
    74
    settlementMerchantSpecificData error
    75
    fromTransactionAcceptor error
    80
    Commerçant non enregistré pour Sherlock’s Office Batch /non lié au remettant déclaré dans l’en-tête.
  • operationAmount
    présence
    Obligatoire
    Interface version
    4
    Ordre
    4

    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.

  • recordSequence
    présence
    Obligatoire
    Interface version
    4
    Ordre
    1

    Ordre d’une transaction dans un fichier Sherlock’s Office Batch.

Optionnel

  • acquirerResponseCode
    présence
    Optionnel
    Interface version
    4
    Ordre
    14

    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
  • authorisationId
    présence
    Optionnel
    Interface version
    4
    Ordre
    13

    Identifiant d’autorisation, retourné par l’acquéreur si la demande d’autorisation est acceptée.

  • captureLimitDate
    présence
    Optionnel
    Interface version
    4
    Ordre
    16

    Date à partir de laquelle la transaction sera envoyée en remise. Au delà de cette date, le commerçant ne peut plus valider ou annuler la transaction.

  • initialSchemeTransactionIdentifier
    présence
    Optionnel
    Interface version XML
    14
    Interface version CSV
    14
    Ordre
    19

    Référence de la transaction servant au chainage MIT-CIT.

  • lastRecoveryIndicator
    présence
    Optionnel
    Interface version XML
    7
    Interface version CSV
    7
    Ordre
    8

    indicateur qui précise que cette opération est la dernière opération de remise sur cette transaction.

    Liste des valeurs
    false
    L’indicateur booléen est faux
    true
    l’indicateur booléen est vrai
  • newAmount
    présence
    Optionnel
    Interface version
    4
    Ordre
    12

    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
    4
    Ordre
    11

    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
    4
    Ordre
    9

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

  • operationOrigin
    présence
    Optionnel
    Interface version
    4
    Ordre
    6

    Origine d’une opération (ex : nom du programme), valorisé par l’émetteur de la requête (commerçant ou Sherlock’s).Ce champ sera présent dans le journal des opérations expédié quotidiennement au commerçant.

  • paymentAccountReference
    présence
    Optionnel
    Interface version XML
    12
    Interface version CSV
    12
    Ordre
    18

    référence du compte associée à la carte utilisée pour le paiement.

  • reattemptEndDateTime
    présence
    Optionnel
    Interface version XML
    20
    Interface version CSV
    20
    Ordre
    23

    Date de fin de la période de rejeu, où une nouvelle tentative de demande d’autorisation d’une transaction refusée est permise

  • reattemptMax
    présence
    Optionnel
    Interface version XML
    20
    Interface version CSV
    20
    Ordre
    21

    Nombre maximum de tentatives de demande d’autorisation pendant la période de rejeu permis

  • reattemptMode
    présence
    Optionnel
    Interface version XML
    20
    Interface version CSV
    20
    Ordre
    20

    Condition de rejeu suite à une autorisation refusée.

    Liste des valeurs
    LATER
    Réessayer plus tard
    NEVER
    Ne plus jamais réessayer
    UPDATE
    Obtenir de nouvelles informations avant de procéder à une nouvelle tentative
  • reattemptStartDateTime
    présence
    Optionnel
    Interface version XML
    20
    Interface version CSV
    20
    Ordre
    22

    Date de début de la période de rejeu, où une nouvelle tentative de demande d’autorisation d’une transaction refusée est permise

  • responseCode
    présence
    Optionnel
    Interface version
    4
    Ordre
    10

    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.
  • s10TransactionReference
    présence
    Optionnel
    Interface version XML
    5
    Interface version CSV
    5
    Ordre
    7

    Contient les informations sur l’identification de la transaction, compatible avec Sherlock’s 1.0.Contient le s10TransactionId / s10TransactionIdDate qui assure l’unicité de la transaction 1.0.

    Contient
  • schemeTransactionIdentifier
    présence
    Optionnel
    Interface version XML
    12
    Interface version CSV
    12
    Ordre
    17

    Référence unique de la transaction calculée par le SAE (Serveur d’autorisation de l’émetteur) et retournée en réponse d’autorisation.Cette référence permet de chainer une MIT (Merchant Initiated Transaction) à une CIT (Customer Initiated Transaction) d’origine (Pour un usage futur via le champ initialSchemeTransactionIdentifier). Précision sur le format qui est dépendant des protocoles et schemes : CB2A : ANS50 (acquéreur FR) BXAP : N15 (acquéreur BE) AMEX : N15 PAYPAL : ANS56

  • transactionReference
    présence
    Optionnel
    Interface version
    4
    Ordre
    3

    Le commerçant a le choix d’identifier ses transactions par un transactionReference (mode par défaut) ou par un transactionId. transactionReference identifie de manière unique une transaction tout au long de la vie de la boutique.

Exemple de réponse

            FILE;response;office;v19
HEADER;023101122334455;2021-12-16+0100;14:26:45+0100;1;00;2021-12-16T00:00:00+0100;2021-12-16T00:00:00+0100
VALIDATE;11;023101122334456;SIM20220329092501;66;978;origin;101;20210329;lastRecoveryIndicator;operationDateTime;00;TO_CAPTURE;65;authorisationId;00;00;captureLimitDate;schemeTransactionIdentifier;paymentAccountReference;initialSchemeTransactionIdentifier
END;1

        
            <?xml version="1.0" encoding="UTF-8"?>
<file version="v19" format="office" type="response">
    <header>
        <remitterId>023101122334455</remitterId>
        <date>2021-12-16+01:00</date>
        <time>14:26:45+01:00</time>
        <sequence>1</sequence>
        <processingResponseCode>00</processingResponseCode>
        <beginProcessTime>2021-12-16T00:00:00+01:00</beginProcessTime>
        <endProcessTime>2021-12-16T00:00:00+01:00</endProcessTime>
    </header>
	<body>
		<validate recordSequence="1">
            <merchantId>023101122334456</merchantId>
            <transactionReference>SIM20220329092501</transactionReference>
            <operationAmount>66</operationAmount>
            <currencyCode>978</currencyCode>
            <operationOrigin>origin</operationOrigin>
            <s10TransactionReference>
                <s10TransactionId>101</s10TransactionId>
                <s10TransactionIdDate>20210329</s10TransactionIdDate>
            </s10TransactionReference>
            <lastRecoveryIndicator>lastRecoveryIndicator</lastRecoveryIndicator>
            <operationDateTime>operationDateTime</operationDateTime>
            <responseCode>00</responseCode>
            <newStatus>TO_CAPTURE</newStatus>
            <newAmount>65</newAmount>
            <authorisationId>authorisationId</authorisationId>
            <acquirerResponseCode>00</acquirerResponseCode>
            <officeBatchResponseCode>00</officeBatchResponseCode>
            <captureLimitDate>captureLimitDate</captureLimitDate>
            <schemeTransactionIdentifier>schemeTransactionIdentifier</schemeTransactionIdentifier>
            <paymentAccountReference>paymentAccountReference</paymentAccountReference>
            <initialSchemeTransactionIdentifier>initialSchemeTransactionIdentifier</initialSchemeTransactionIdentifier>
        </validate>
	</body>
	<end nbRecord="1" />
</file>

        

Changelog


Interface version Donnée Présence Conteneur
4 currencyCode Requête/Réponse
4 merchantId Requête/Réponse
4 operationAmount Requête/Réponse
4 recordSequence Requête/Réponse
XML: 7
CSV: 7
lastRecoveryIndicator Requête/Réponse
4 operationOrigin Requête/Réponse
XML: 5
CSV: 5
s10TransactionReference Requête/Réponse
4 s10TransactionId Conteneur
  • s10TransactionReference
  • 4 s10TransactionIdDate Conteneur
  • s10TransactionReference
  • 4 transactionReference Requête/Réponse
    4 acquirerResponseCode Réponse
    4 authorisationId Réponse
    4 captureLimitDate Réponse
    XML: 14
    CSV: 14
    initialSchemeTransactionIdentifier Réponse
    4 newAmount Réponse
    4 newStatus Réponse
    4 operationDateTime Réponse
    XML: 12
    CSV: 12
    paymentAccountReference Réponse
    XML: 20
    CSV: 20
    reattemptEndDateTime Réponse
    XML: 20
    CSV: 20
    reattemptMax Réponse
    XML: 20
    CSV: 20
    reattemptMode Réponse
    XML: 20
    CSV: 20
    reattemptStartDateTime Réponse
    4 responseCode Réponse
    XML: 12
    CSV: 12
    schemeTransactionIdentifier Réponse
    4 officeBatchResponseCode Réponse
    Retourner en haut de page Besoin d'aide ?

    Besoin d'aide ?

    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