Release 25.5

aller directement au contenu

Rechercher par mots clés

paymentTokenGenerate

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

Génère un token de paiement pour un paiement avec hosted fields.

interfaceVersion recommandée : TR_WS_2.58

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

Obligatoire

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

  • 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

  • cardCSCValue
    présence
    Optionnel
    Interface version
    2.0

    Cryptogramme visuel de la carte bancaire véhiculé dans la demande d’autorisation (CSC, Card Security Code, appelé CVV pour Visa, CVC pour Mastercard et 4DBC pour American Express).

  • cardExpiryDate
    présence
    Optionnel
    Interface version
    2.0

    Date d’expiration de la carte. Si la carte n’a pas de date d’expiration, ce champ doit être vide.

  • cardNumber
    présence
    Optionnel
    Interface version
    2.0

    Numéro de la carte (format N19 sauf si le numéro de la carte est un Token, auquel cas, son format est ANS128).

  • interfaceVersion
    présence
    Optionnel
    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
    TR_WS_2.
    interface Sherlock’s Office (SOAP) pour les fonctions de token.
  • 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.

  • merchantId
    présence
    Optionnel
    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.

  • paymentMeanBrand
    présence
    Optionnel
    Interface version
    2.0

    Nom du moyen de paiement utilisé. Il est lié à un paymentMeanType.

    Liste des valeurs
    1EUROCOM
    Cofidis Pay 5x10x20x Contrat d’acquisition : ONLINE_CREDIT
    3XCBCOFINOGA
    Valeur Obsolète. Cofinoga 3xCB paymentMeanBrandType : CARD
    ACCEPTGIRO
    AcceptGiro paymentMeanBrandType : CREDIT_TRANSFER
    AIRPLUS
    Carte Airplus paymentMeanBrandType : CARD
    AIRPLUS_LOGEE
    Carte Airplus logée paymentMeanBrandType : CARD
    AMEX
    Carte American Express paymentMeanBrandType : CARD
    AMEX_LOGEE
    Carte American Express logée paymentMeanBrandType : CARD
    AURORE
    Carte CPAY paymentMeanBrandType : CARD
    BCACB_3X
    Floa Bank CB paiement en 3 fois paymentMeanBrandType : ONLINE_CREDIT
    BCACB_4X
    Floa Bank CB paiement en 4 fois paymentMeanBrandType : ONLINE_CREDIT
    BCACUP
    Carte CUP de Floa Bank paymentMeanBrandType : CARD
    BCMC
    Bancontact paymentMeanBrandType : CARD
    CACF_3X
    CACF paiement en 3 fois paymentMeanBrandType : ONLINE_CREDIT
    CACF_3XSANSFRAIS
    CACF paiement en 3 fois sans frais paymentMeanBrandType : ONLINE_CREDIT
    CACF_4X
    CACF paiement en 4 fois paymentMeanBrandType : ONLINE_CREDIT
    CACF_4XSANSFRAIS
    CACF paiement en 4 fois sans frais paymentMeanBrandType : ONLINE_CREDIT
    CADHOC
    Cadhoc paymentMeanBrandType : CARD
    CADOCARTE
    Cado Carte paymentMeanBrandType : CARD
    CB
    Carte Bancaire paymentMeanBrandType : CARD
    CETELEM_3X
    Cetelem 3xCB paymentMeanBrandType : ONLINE_CREDIT
    CETELEM_4X
    Cetelem 4xCB paymentMeanBrandType : ONLINE_CREDIT
    COFIDIS_3X
    Cofidis 3xCB paymentMeanBrandType : ONLINE_CREDIT
    COFIDIS_4X
    Cofidis 4xCB paymentMeanBrandType : ONLINE_CREDIT
    CONECS
    Titres Restaurants Dématérialisés Conecs paymentMeanBrandType : VOUCHER
    CUP
    Carte China UnionPay paymentMeanBrandType : CARD
    CVA
    Carte Visa Aurore paymentMeanBrandType : CARD
    CVCO
    Chèque-Vacances Connect paymentMeanBrandType : VOUCHER
    DINERS
    Carte Diners club international paymentMeanBrandType : CARD
    FRANFINANCE_3X
    Franfinance 3xCB paymentMeanBrandType : ONLINE_CREDIT
    FRANFINANCE_4X
    Franfinance 4xCB paymentMeanBrandType : ONLINE_CREDIT
    GIROPAY
    Giropay paymentMeanBrandType : CREDIT_TRANSFER
    ILLICADO
    Illicado paymentMeanBrandType : CARD
    INCASSO
    Incasso paymentMeanBrandType : DIRECT_DEBIT
    INGHOMEPAY
    PayButton ING Home’Pay paymentMeanBrandType : CREDIT_TRANSFER
    JCB
    Carte Japan Credit Bureau paymentMeanBrandType : CARD
    LEPOTCOMMUN
    Le Pot Commun paymentMeanBrandType : CARD
    LYDIA
    Lydia paymentMeanBrandType : PROVIDER
    MAESTRO
    Carte Maestro (Mastercard) paymentMeanBrandType : CARD
    MASTERCARD
    Carte Mastercard paymentMeanBrandType : CARD
    MASTERPASS
    Obsolète - Portefeuille virtuel MasterPass paymentMeanBrandType :
    ONEY34X
    Oney Paiement 3 fois ou 4 fois paymentMeanBrandType : ONLINE_CREDIT
    PAYLIB
    Portefeuille virtuel Paylib paymentMeanBrandType :
    PAYPAL
    Paypal paymentMeanBrandType : WALLET
    PAYTRAIL
    Paytrail paymentMeanBrandType : CREDIT_TRANSFER
    PAY_BY_BANK
    Virement bancaire SEPA paymentMeanBrandType : CREDIT_TRANSFER
    SEPA_DIRECT_DEBIT
    SDD (SEPA Direct Debit) paymentMeanBrandType : DIRECT_DEBIT
    SOFINCO
    Carte Sofinco paymentMeanBrandType : CARD
    UNKNOWN
    Moyen de paiement inconnu (cette valeur peut être retournée par Sherlock’s mais ne doit pas être utilisée dans une requête)
    VISA
    Carte Visa paymentMeanBrandType : CARD
    VISACHECKOUT
    Obsolète - Portefeuille virtuel Visa Checkout paymentMeanBrandType : WALLET
    VISA_ELECTRON
    Carte Visa Electron paymentMeanBrandType : CARD
    VPAY
    Carte VPAY (Visa) paymentMeanBrandType : CARD
  • paymentMeanBrandSelectionStatus
    présence
    Optionnel
    Interface version
    2.0

    Statut du traitement de la sélection de la marque sur la page de paiement.

    Liste des valeurs
    APPLIED_DEFAULT
    Le porteur a accepté la marque par défaut proposée par le commerçant
    APPLIED_HOLDER
    Le porteur a choisi une marque différente de celle proposée par défaut par le commerçant
    Empty
    La transaction n’est pas traitée selon les modalités de la sélection de la marque
    NOT_APPLICABLE
    La carte utilisée n’est pas co-badgée
  • paymentTokenConsumerMerchantId
    présence
    Optionnel
    Interface version
    2.0

    Identifiant du commerçant qui est autorisé à consommer le jeton de paiement sur les services le supportant.

  • 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

            {
  "cardCSCValue": "123",
  "cardExpiryDate": "202212",
  "cardNumber": "1234123412341234",
  "interfaceVersion": "TR_WS_2.41",
  "keyVersion": "1",
  "merchantId": "001112233440000",
  "paymentMeanBrand": "VISA",
  "seal": "3f1d96361442af3ed0df832bf655d4de7349e9451b973a335514ab9f670d26ea"
}

        
                  <urn:paymentTokenGenerate>
         <urn:input>
            <urn:merchantId>001112233440000</urn:merchantId>
            <urn:interfaceVersion>TR_WS_2.41</urn:interfaceVersion>
            <urn:cardNumber>1234123412341234</urn:cardNumber>
            <urn:cardExpiryDate>202212</urn:cardExpiryDate>
            <urn:cardCSCValue>123</urn:cardCSCValue>
            <urn:paymentMeanBrand>VISA</urn:paymentMeanBrand>
         </urn:input>
      </urn:paymentTokenGenerate>

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

  • errorFieldName
    présence
    Optionnel
    Interface version
    2.0

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

  • paymentToken
    présence
    Optionnel
    Interface version
    2.0

    Jeton de paiement Hosted Fields à transmettre lors des appels à Sherlock’s Office et permettant de trouver les informations de paiement carte lors de paiement classique ou 3-D Secure, par wallet ou non.

  • 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

            {
  "paymentToken": "eyJ0eXAiOiJKV1QiLCJhbGciOiJIUzUxMiJ9.eyJkYXRhIjoiWXpjNU16RmtNekE0TVRGaE5HTTBOamd6TlRFd016WTRPVFl6TkRVMllqVT0iLCJwcm9jZXNzSWQiOiI3N2Q1NzYyMDFhOTM0YzAyYWVkNzc2MzJkMDMxMTBmNCIsInVzZVR5cGUiOiJQQVlNRU5UIiwicHJvY2Vzc0ludGVyZmFjZSI6IlNJUFNfTUFDSElORV9UT19NQUNISU5FIn0.j4DZnnMupH4SAbgMIpuk-fSOqnKgZs27H1qXXmfIBY48lwdYzhRGN1KspIFhH25c-5Q_osjHyUu_4URQMdcU_w",
  "responseCode": "00",
  "seal": "338ce205c8de01746d1b8a42aeda9460473acf3c11027f3fc22469bd2bcdfd38",
}

        
                  <paymentTokenGenerateResponse xmlns="urn:sips:cn:contract:office:token:v2">
         <output>
            <responseCode>00</responseCode>
            <paymentToken>eyJ0eXAiOiJKV1QiLCJhbGciOiJIUzUxMiJ9.eyJkYXRhIjoiWXpjNU16RmtNekE0TVRGaE5HTTBOamd6TlRFd016WTRPVFl6TkRVMllqVT0iLCJwcm9jZXNzSWQiOiI3N2Q1NzYyMDFhOTM0YzAyYWVkNzc2MzJkMDMxMTBmNCIsInVzZVR5cGUiOiJQQVlNRU5UIiwicHJvY2Vzc0ludGVyZmFjZSI6IlNJUFNfTUFDSElORV9UT19NQUNISU5FIn0.j4DZnnMupH4SAbgMIpuk-fSOqnKgZs27H1qXXmfIBY48lwdYzhRGN1KspIFhH25c-5Q_osjHyUu_4URQMdcU_w</paymentToken>
         </output>
      </paymentTokenGenerateResponse>

Changelog


Interface version Donnée Présence Conteneur
2.0 cardCSCValue Requête
2.0 cardExpiryDate Requête
2.0 cardNumber Requête
2.0 interfaceVersion Requête
2.0 intermediateServiceProviderId Requête
2.0 merchantId Requête
2.0 paymentMeanBrand Requête
2.0 paymentMeanBrandSelectionStatus Requête
2.0 paymentTokenConsumerMerchantId Requête
2.0 sealAlgorithm Requête
2.0 keyVersion Requête
2.0 seal Requête/Réponse
2.0 errorFieldName Réponse
2.0 paymentToken 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