Release 24.5

aller directement au contenu

Rechercher par mots clés

paymentProviderGetContext

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

Cette requête est facultative et vous permet de connaître l’identité et l’adresse de livraison du payeur pour les afficher avant la confirmation de la transaction lors d’une transaction PayPal.

interfaceVersion recommandée : IR_WS_2.55

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

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
    IR_WS_
    interface Sherlock’s Paypage et Sherlock’s Office (SOAP/JSON).
  • 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.

  • messageVersion
    présence
    Obligatoire
    Interface version
    2.0

    Version des paramètres de redirection.

  • redirectionData
    présence
    Obligatoire
    Interface version
    2.0

    Dans le cas d’un paiement 3-D Secure, contient le contexte de la transaction récupéré en sortie de la méthode cardCheckEnrolment. Dans le cas de 3-D Secure Server Standalone, Message PARes que le commerçant doit transmettre à l’ACS (Access Control Server) pour l’authentification 3-D Secure du porteur (format : encodage base 64).Dans le cas d’un paiement via un partenaire externe, contient le contexte de la transaction envoyée par le commerçant pendant l’initialisation de la transaction.

  • 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

            {
  "interfaceVersion": "IR_WS_2.0",
  "keyVersion": "1",
  "merchantId": "011223344550000",
  "messageVersion": "0.1",
  "redirectionData": "RSs7cZy...L1DqsVso",
  "transactionReference": "TREFEXA2012",
  "seal": "30218c85ca303d33d5e7b60bb48222b9826fbc30b6c2ec98fff285702e445ae1"
}

        
                  <urn:paymentProviderGetContext>
         <urn:input>
            <urn:merchantId>011223344550000</urn:merchantId>
            <urn:transactionReference>TREFEXA2012</urn:transactionReference>
            <urn:interfaceVersion>IR_WS_2.2</urn:interfaceVersion>
            <urn:redirectionData>RSs7cZyL1DqsV... 9P15xVe</urn:redirectionData>
            <urn:messageVersion>0.1</urn:messageVersion>
         </urn:input>
      </urn:paymentProviderGetContext>

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

Exemple de réponse

            {
  "responseCode": "00",
  "deliveryAddress": {
    "addressAdditional1": "devliveryAdd11",
    "city": "Blois",
    "country": "FR",
    "street": "Street",
    "zipCode": "41000"
  },
  "deliveryContact": {
    "email": "team@email.com",
    "firstname": "Team",
    "lastname": "John",
    "phone": "0254440000"
  },
  "customerAddress": {
    "addressAdditional1": "devliveryAdd11",
    "city": "Blois",
    "country": "FR",
    "street": "Street",
    "zipCode": "41000"
  },
  "customerContact": {
    "firstname": "Team",
    "lastname": "BO",
    "phone": "0254440000"
  },
  "paymentMeanData": {
    "paypal": {
      "token": "EC-4S931937D5977923H",
      "deliveryAddressStatus": "Confirmed",
      "payerId": "H3G7GWRLLSBDY",
      "payerStatus": "verified",
      "paymentStatus": "PaymentActionNotInitiated"
    }
  },
  "acquirerResponseMessage": "Process succeeded",
  "acquirerResponseIdentifier": "419d14fb8a5c",
  "seal": "18509963c41e3102967ee0ebc149165032b1b53cffec29f46d29ab37d8bc1df4"
}

        
                  <paymentProviderGetcontextResponse xmlns="urn:sips:cn:contract:office:checkout:v2">
         <output>
            <deliveryAddress>
                <addressAdditional1>devliveryAdd11</addressAdditional1>
                <city>Blois</city>
                <country>FRA</country>
                <street>Street</street>
                <zipCode>41000</zipCode>
            </deliveryAddress>
            <deliveryContact>
               <email>john@email.com</email>
               <firstname>John</firstname>
               <lastname>Bush</lastname>
               <phone>0254440000</phone>
            </deliveryContact>
            <customerAddress>
               <addressAdditional1>devliveryAdd21</addressAdditional1>
               <city>Paris</city>
               <country>FRA</country>
               <street>Avenue</street>
               <zipCode>75000</zipCode>
            </customerAddress>
            <customerContact>
               <email>sue@email.com</email>
               <firstname>Sue</firstname>
               <lastname>Smith</lastname>
               <phone>0254441111</phone>
            </customerContact>
            <paymentMeanData>
               <paypal>
                  <token>EC-4S931937D5977923H</token>
                  <deliveryAddressStatus>Confirmed</deliveryAddressStatus>
                  <payerId>H3G7GWRLLSBDY</payerId>
                  <payerStatus>verified</payerStatus> 
                  <paymentStatus>PaymentActionNotInitiated</paymentStatus>
               </paypal>
            </paymentMeanData >
            <responseCode>00</responseCode>
            <acquirerResponseMessage>Process succeeded</acquirerResponseMessage>
         </output>
      </paymentProviderGetcontextResponse>

Changelog


Interface version Donnée Présence Conteneur
1.2 intermediateServiceProviderId Requête
2.0 s10TransactionReference Requête
2.0 s10TransactionId Conteneur
  • s10TransactionReference
    • 2.0 s10TransactionIdDate Conteneur
  • s10TransactionReference
    • 2.12 sealAlgorithm Requête
    2.0 transactionReference Requête
    2.0 interfaceVersion Requête
    2.0 keyVersion Requête
    2.0 merchantId Requête
    2.0 messageVersion Requête
    2.0 redirectionData Requête
    2.0 seal Requête/Réponse
    2.0 acquirerNativeResponseCode Réponse
    2.0 acquirerResponseIdentifier Réponse
    2.0 acquirerResponseMessage Réponse
    2.0 customerAddress Réponse
    2.0 addressAdditional3 Conteneur
  • customerAddress
  • deliveryAddress
  • holderAddress
    • 2.0 country Conteneur
  • customerAddress
  • deliveryAddress
  • holderAddress
    • 2.0 city Conteneur
  • customerAddress
  • deliveryAddress
  • holderAddress
    • 2.0 company Conteneur
  • customerAddress
  • deliveryAddress
  • holderAddress
    • 2.0 addressAdditional1 Conteneur
  • customerAddress
  • deliveryAddress
  • holderAddress
    • 2.0 addressAdditional2 Conteneur
  • customerAddress
  • deliveryAddress
  • holderAddress
    • 2.0 postBox Conteneur
  • customerAddress
  • deliveryAddress
  • holderAddress
    • 2.0 state Conteneur
  • customerAddress
  • deliveryAddress
  • holderAddress
    • 2.0 street Conteneur
  • customerAddress
  • deliveryAddress
  • holderAddress
    • 2.0 streetNumber Conteneur
  • customerAddress
  • deliveryAddress
  • holderAddress
    • 2.0 zipCode Conteneur
  • customerAddress
  • deliveryAddress
  • holderAddress
    • 2.0 customerContact Réponse
    2.0 email Conteneur
  • customerContact
  • deliveryContact
    • 2.0 firstname Conteneur
  • customerContact
  • deliveryContact
    • 2.0 gender Conteneur
  • customerContact
  • deliveryContact
    • 2.11 initials Conteneur
  • customerContact
  • deliveryContact
    • 2.0 lastname Conteneur
  • customerContact
  • deliveryContact
    • 2.0 mobile Conteneur
  • customerContact
  • deliveryContact
  • paypal
    • 2.0 phone Conteneur
  • customerContact
  • deliveryContact
    • 2.0 title Conteneur
  • customerContact
  • deliveryContact
    • 2.23 workphone Conteneur
  • customerContact
  • deliveryContact
    • 2.0 deliveryAddress Réponse
    2.0 deliveryContact Réponse
    2.21 errorFieldName Réponse
    2.0 holderAddress Réponse
    2.0 paymentMeanData Réponse
    2.21 bcmcMobile Conteneur
  • paymentMeanData
    • 2.21 completionRedirectUrl Conteneur
  • bcmcMobile
    • 2.21 defaultRedirectUrl Conteneur
  • bcmcMobile
    • 2.0 cofinoga3xcb Conteneur
  • paymentMeanData
    • 2.0 creditIndicator Conteneur
  • cofinoga3xcb
    • 2.14 cofinoga Conteneur
  • paymentMeanData
    • 2.14 settlementMode Conteneur
  • cofinoga
  • bcaCup
    • 2.12 bcaCup Conteneur
  • paymentMeanData
    • 2.38 bancontact Conteneur
  • paymentMeanData
    • 2.38 bancontactMerchantCustomerAuthenticationMethod Conteneur
  • bancontact
    • 2.38 initialAuthenticationCavv Conteneur
  • bancontact
    • 2.38 payeeCardNumber Conteneur
  • bancontact
    • 2.38 payeeHolderName Conteneur
  • bancontact
    • 2.0 paypal Conteneur
  • paymentMeanData
    • 2.14 orderDescription Conteneur
  • paypal
    • 2.12 deliveryAddressStatus Conteneur
  • paypal
    • 2.12 payerStatus Conteneur
  • paypal
    • 2.12 payerBusiness Conteneur
  • paypal
    • 2.0 dupDesc Conteneur
  • paypal
    • 2.0 invoiceId Conteneur
  • paypal
    • 2.0 addrOverride Conteneur
  • paypal
    • 2.0 dupFlag Conteneur
  • paypal
    • 2.12 paymentStatus Conteneur
  • paypal
    • 2.12 payerId Conteneur
  • paypal
    • 2.12 payerSuffix Conteneur
  • paypal
    • 2.0 dupCustom Conteneur
  • paypal
    • 2.0 dupType Conteneur
  • paypal
    • 2.0 landingPage Conteneur
  • paypal
    • 2.12 token Conteneur
  • paypal
    • 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