logo Sogenactif

Release 24.6

aller directement au contenu

Rechercher par mots clés

searchMandate

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

Cette opération permet de rechercher les mandats existants d’un client. Les mandats sont liés à un client donné seulement si le champ customerId a été fourni dans les paramètres de la requête initializeMandate.

interfaceVersion recommandée : MR_WS_2.55

Avant de lire ce document nous vous conseillons

  • PROD
    https://office-server.sogenactif.com/rs-services/v2/mandate/searchMandate
    méthode
    POST
  • TEST
    https://office-server-sogenactif.test.sips-services.com/rs-services/v2/mandate/searchMandate
    méthode
    POST
  • PROD
    https://office-server.sogenactif.com/services/v2/mandate?wsdl
    méthode
    POST
  • TEST
    https://office-server-sogenactif.test.sips-services.com/services/v2/mandate?wsdl
    méthode
    POST

Obligatoire

  • customerId
    présence
    Obligatoire
    Interface version
    2.0

    Identifiant du client

    Attention : utiliser ce champ libre uniquement pour l’usage prévu, et par conséquent ne pas y insérer des données à caractère personnel, et plus particulièrement des données de porteur de carte. En cas de non-respect de cette consigne SG ne serait être tenu responsable d’un point de vu légal, de tout incident qui pourrait survenir.

    En tant que sous-traitant, SG traite les données à caractère personnel conformément aux Conditions de Traitement des Données à Caractère Personnel (CTDCP), annexées à tous les contrats.

    Ainsi :

    • Les données personnelles prévues par le CTDCP doivent uniquement être transmises à SG au travers des champs prévus à cet effet (cf. dictionnaire des données).
    • Toutes autres données à caractère personnel non listées dans le CTDCP ne doivent pas être transmises à SG
  • 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 Sogenactif Office Serveur (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).

  • merchantId
    présence
    Obligatoire
    Interface version
    2.0

    Identifiant de la boutique, sa valeur est fournie par Sogenactif 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

Exemple de requête

            {
  "customerId": "test123",
  "interfaceVersion": "MR_WS_2.20",
  "keyVersion": "1",
  "merchantId": "011223344550000",
  "seal": "df97074b81e534d70cccbff5446b71d36c4d4de6d995fe630c8077d6fa85c0a3"
}

        
                  <urn:searchMandate>
         <urn:input>
            <urn:interfaceVersion>MR_WS_2.18</urn:interfaceVersion>
            <urn:merchantId>011223344550000</urn:merchantId>
            <urn:customerId>test123</urn:customerId>
            <urn:keyVersion>1</urn:keyVersion>
            <urn:seal>4528716bcc78a6e47ae49b1a5dd3dc5ad7a36732f59d3a8c7f0c00a4d3aba79c</urn:seal>
         </urn:input>
      </urn:searchMandate>

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

            {
  "mandateResponseCode": "00",
  "acquirerResponseCode": "00",
  "mandateList": [
    {
      "mandateId": "6768",
      "mandateStatus": "ACTIVE",
      "bic": "123456789",
      "iban": "987654321",
      "transactionActors": "B2C",
      "mandateUsage": "RECURRENT"
    },
    {
      "mandateId": "4659",
      "mandateStatus": "ACTIVE",
      "bic": "123456789",
      "iban": "987654321",
      "transactionActors": "B2C",
      "mandateUsage": "RECURRENT"
    },
    {
      "mandateId": "7083",
      "mandateStatus": "ACTIVE",
      "bic": "123456789",
      "iban": "987654321",
      "transactionActors": "B2C",
      "mandateUsage": "RECURRENT"
    }
  ],
  "seal": "10a575f493ac8a791e78d750ec7bbaa15ebec2c5a39f95dbc49d9a5f1b6ef671"
}

        
                  <searchMandateResponse xmlns="urn:sips:cn:contract:office:mandatemanagement:v2">
         <output>
            <responseCode>00</responseCode>
            <acquirerResponseCode>00</acquirerResponseCode>
            <mandateList>
               <mandate>
                  <mandateId>5840</mandateId>
                  <mandateStatus>ACTIVE</mandateStatus>
                  <bic>123456789</bic>
                  <iban>987654321</iban>
                  <transactionActors>B2C</transactionActors>
                  <mandateUsage>RECURRENT</mandateUsage>
               </mandate>
               <mandate>
                  <mandateId>1514</mandateId>
                  <mandateStatus>ACTIVE</mandateStatus>
                  <bic>123456789</bic>
                  <iban>987654321</iban>
                  <transactionActors>B2C</transactionActors>
                  <mandateUsage>RECURRENT</mandateUsage>
               </mandate>
               <mandate>
                  <mandateId>9500</mandateId>
                  <mandateStatus>ACTIVE</mandateStatus>
                  <bic>123456789</bic>
                  <iban>987654321</iban>
                  <transactionActors>B2C</transactionActors>
                  <mandateUsage>RECURRENT</mandateUsage>
               </mandate>
            </mandateList>
            <seal>ef7354b3881b5116ec41c10ea2685ad3a48711f629814ca2fa856fd93aa14c07</seal>
         </output>
      </searchMandateResponse>

Changelog


Interface version Donnée Présence Conteneur
2.0 intermediateServiceProviderId Requête
2.0 sealAlgorithm Requête
2.0 customerId Requête
2.0 interfaceVersion Requête
2.0 keyVersion Requête
2.0 merchantId Requête
2.0 seal Requête/Réponse
2.0 acquirerResponseCode Réponse
2.21 errorFieldName Réponse
2.0 mandateList Réponse
2.0 mandate Conteneur
  • mandateList
    • 2.0 iban Conteneur
  • mandate
    • 2.0 bic Conteneur
  • mandate
    • 2.0 mandateCreationDate Conteneur
  • mandate
    • 2.0 mandateId Conteneur
  • mandate
    • 2.0 mandateLastUpdateDate Conteneur
  • mandate
    • 2.29 mandateSecureReference Conteneur
  • mandate
    • 2.0 mandateSignatureDate Conteneur
  • mandate
    • 2.0 mandateStatus Conteneur
  • mandate
    • 2.0 mandateUsage Conteneur
  • mandate
    • 2.29 riskyMandate Conteneur
  • mandate
    • 2.0 transactionActors Conteneur
  • mandate
    • 2.0 mandateResponseCode 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 Sogenactif.
    En fermant ce bandeau vous refusez notre utilisation des traceurs sur votre appareil.

    Paramètres