--- title: "Gestion des transactions" slug: "managing-transactions" updated: 2025-11-04T14:28:07Z published: 2025-11-04T14:29:07Z canonical: "docs.onespan.com/managing-transactions" --- > ## Documentation Index > Fetch the complete documentation index at: https://docs.onespan.com/llms.txt > Use this file to discover all available pages before exploring further. # Gestion des transactions  ## Java SDK Pour télécharger l'exemple de code complet, consultez notre site [Code Share](https://community.onespan.com/documentation/onespan-sign/codeshare/package-management-java-sdk/) . Cette rubrique décrit comment récupérer, mettre à jour, archiver et supprimer une transaction. ### Récupération des transactions Pour récupérer une transaction, vous devez d'abord créer un objet PackageId à l'aide de l'ID qui vous a été renvoyé lors de la création de la transaction. Ensuite, récupérez la transaction à l'aide de ce PackageId dans le client OneSpan Sign . Pour ce faire, le code suivant : ```java // Create a PackageId instance using the specified ID PackageId packageId = new PackageId("package_id_here"); // Retrieve the document package using the ESL client DocumentPackage retrievedPkg = eslClient.getPackage(packageId); ``` Vous pouvez également récupérer une liste de transactions. Pour ce faire, le code suivant : ```java // Retrieve a page of document packages with status SENT Page resultPage = eslClient    .getPackageService()    .getPackages(        new PackageStatusConverter(PackageStatus.SENT).toAPIPackageStatus(),        new PageRequest(1, 10)    ); ``` L'exemple de code ci-dessus renverra les dix premières transactions qui ont l'état ENVOYÉ. Vous pouvez toutefois interroger d'autres statuts, tels que BROUILLON, TERMINÉ, REFUSÉ, EXPIRÉ et ARCHIVÉ. #### Limites de notification SMS Pour éviter toute utilisation abusive et l'envoi excessif de notifications SMS, il y a une limite de 50 notifications SMS par transaction. Une fois la limite de 50 notifications SMS atteinte pour une transaction particulière, un message s'affichera dans l'interface utilisateur et le client ne pourra plus envoyer de SMS pour cette transaction. Pour les intégrateurs Java et .NET, une alerte indiquant que la limite de notification SMS est atteinte peut être obtenue lors de la récupération d'un paquet. Pour ce faire, le code suivant : ```java // Retrieve the document package with alerts extension DocumentPackage packageWithAlerts = eslClient.getPackageWithExtensions(    packageId,    DocumentPackageRequestExtension.ALERTS ); // Extract the list of system alerts from the package List alerts = packageWithAlerts.getAlerts(); `` ``` ### Mise à jour d'une transaction Pour mettre à jour une transaction, celle-ci doit avoir le statut BROUILLON. Pour mettre à jour une transaction existante, créez un objet de transaction avec uniquement les mises à jour que vous souhaitez apporter à la transaction. Ensuite, appelez la fonction UpdatePackage avec le PackageId de la transaction existante. Pour ce faire, le code suivant : ```java // Build a new document package with updated properties DocumentPackage packageToUpdate = PackageBuilder    .newPackageNamed(NEW_PACKAGE_NAME)    .describedAs(NEW_DESCRIPTION)    .withEmailMessage(NEW_EMAIL_MESSAGE)    .expiresAt(LocalDateTime.now().toDate())    .withLanguage(Locale.FRENCH)    .withVisibility(NEW_VISIBILITY)    .withNotarized(NEW_NOTARIZED)    .autocomplete(false)    .withSettings(settingsToUpdate)    .build(); // Update the package using the ESL client eslClient.updatePackage(packageId, packageToUpdate); ``` ### Suppression de transactions Si vous souhaitez supprimer définitivement une transaction de votre compte, appelez la fonction deletePackage à l'aide du PackageId de la transaction que vous souhaitez supprimer. La suppression d'une transaction ne peut pas être annulée. Pour ce faire, le code suivant : ```java // Delete the document package using its package ID eslClient.getPackageService().deletePackage(packageId); `` ``` Si vous ne souhaitez pas supprimer définitivement cette transaction, vous pouvez la déplacer vers votre dossier Corbeille . De cette façon, il ne sera pas supprimé et pourra être récupéré à une date ultérieure. Pour ce faire, le code suivant : ```java // Move the document package to the trash using its package ID eslClient.getPackageService().trash(packageId); ``` ### Archivage des transactions L'action Archiver déplace les transactions sélectionnées de votre boîte de réception vers le dossier Archivé contenant toutes vos transactions archivées. Cette action n'est disponible que pour les transactions TERMINÉES dans votre boîte de réception. Pour ce faire, appelez le client OneSpan Sign avec le PackageId de la transaction que vous souhaitez archiver. Pour ce faire, le code suivant : ```java // Archive the document package using its package ID eslClient.getPackageService().archive(new PackageId("packageId")); ``` ## Kit de développement logiciel (SDK) .NET Pour télécharger l'exemple de code complet, consultez notre site [Code Share](https://community.onespan.com/documentation/onespan-sign/codeshare/package-management-net-sdk/) . Cette rubrique décrit comment récupérer, mettre à jour, archiver et supprimer une transaction. ### Récupération des transactions Pour récupérer une transaction, vous devez d'abord créer un objet PackageId à l'aide de l'ID qui vous a été renvoyé lors de la création de la transaction. Ensuite, récupérez la transaction à l'aide de ce PackageId dans le client OneSpan Sign. Pour ce faire, le code suivant : ```csharp // Create a PackageId instance using the specified ID PackageId packageId = new PackageId("package_id_here"); // Retrieve the document package using the ESL client DocumentPackage retrievedPkg = eslClient.GetPackage(packageId); ``` Vous pouvez également récupérer une liste de transactions. Pour ce faire, le code suivant : ```csharp // Retrieve a page of document packages with status SENT Page packages = eslClient.PackageService.GetPackages(    DocumentPackageStatus.SENT,    new PageRequest(1, 10) ); ``` L'exemple de code ci-dessus renverra les dix premières transactions qui ont l'état ENVOYÉ. Vous pouvez toutefois interroger d'autres statuts, tels que BROUILLON, TERMINÉ, REFUSÉ, EXPIRÉ et ARCHIVÉ. #### Limites de notification SMS Pour éviter toute utilisation abusive et l'envoi excessif de notifications SMS, il y a une limite de 50 notifications SMS par transaction. Une fois la limite de 50 notifications SMS atteinte pour une transaction particulière, un message s'affichera dans l'interface utilisateur et le client ne pourra plus envoyer de SMS pour cette transaction. Pour les intégrateurs Java et .NET, une alerte indiquant que la limite de notification SMS est atteinte peut être obtenue lors de la récupération d'un paquet. Pour ce faire, le code suivant : ```csharp // Retrieve the document package with the specified extensions DocumentPackage packageWithAlerts = ossClient.GetPackageWithExtensions(id, extensions); // Access the list of system alerts from the package IList alerts = packageWithAlerts.Alerts; `` ``` ### Mise à jour d'une transaction Pour mettre à jour une transaction existante, créez un objet de transaction avec uniquement les mises à jour que vous souhaitez apporter à la transaction. Ensuite, appelez la fonction UpdatePackage avec le PackageId de la transaction existante. Pour ce faire, le code suivant : ```csharp // Build a new document package with updated properties DocumentPackage packageToUpdate = PackageBuilder    .NewPackageNamed(NEW_PACKAGE_NAME)    .WithEmailMessage(NEW_EMAIL_MESSAGE)    .ExpiresOn(NEW_EXPIRY_DATE)    .WithLanguage(NEW_LANGUAGE)    .WithVisibility(NEW_VISIBILITY)    .WithNotarized(NEW_NOTARIZED)    .WithoutAutomaticCompletion()    .WithSettings(settingsToUpdate)    .Build(); // Update the package using the ESL client eslClient.UpdatePackage(packageId, packageToUpdate); ``` ### Suppression de transactions Si vous souhaitez supprimer définitivement une transaction de votre compte, appelez la fonction deletePackage à l'aide du PackageId de la transaction que vous souhaitez supprimer. La suppression d'une transaction ne peut pas être annulée. Pour ce faire, le code suivant : ```csharp // Delete the document package using its package ID eslClient.PackageService.DeletePackage(packageId); ``` Si vous ne souhaitez pas supprimer définitivement cette transaction, vous pouvez la déplacer vers votre dossier Corbeille . De cette façon, il ne sera pas supprimé et pourra être récupéré à une date ultérieure. Pour ce faire, le code suivant : ```csharp // Move the document package to the trash using its package ID eslClient.PackageService.Trash(packageId); ``` ### Archivage des transactions L'action Archiver déplace les transactions sélectionnées de votre boîte de réception vers le dossier Archivé contenant toutes vos transactions archivées. Cette action n'est disponible que pour les transactions TERMINÉES dans votre boîte de réception. Pour ce faire, appelez le client OneSpan Sign avec le PackageId de la transaction que vous souhaitez archiver. Pour ce faire, le code suivant : ```csharp // Archive the document package using its package ID eslClient.PackageService.Archive(new PackageId("packageId")); ``` ## REST API Pour télécharger l'exemple de code complet, consultez notre site [Code Share](https://community.onespan.com/documentation/onespan-sign/codeshare/package-management-rest-api/) . Cette rubrique décrit comment récupérer, mettre à jour, archiver et supprimer une transaction. ### Récupération des transactions Pour récupérer un package (GET), mettre à jour (PUT) ou supprimer un package (DELETE), vous devez envoyer votre demande à l'URL suivante à l'aide du PackageId qui vous a été renvoyé lors de la création de la transaction. Pour ce faire, le code suivant : ```http {instance_url}/api/packages/{packageId} ``` Vous pouvez également récupérer une liste de transactions. Pour ce faire, le code suivant : #### Requête HTTP ```http GET /api/packages?from=1&to=5&query=SENT ``` #### En-têtes HTTP ```http Accept: application/json   Content-Type: application/json   Authorization: Basic api_key ``` #### Charge utile de réponse ```json {  "results": [    { ... },    { ... },    { ... },    { ... },    { ... }  ],  "count": 30 } ``` Pour une description complète de chaque champ, consultez le tableau Charge utile de la demande ci-dessous. L'exemple de code ci-dessus renverra les cinq premières transactions qui ont l'état ENVOYÉ, sur un total de 30. Vous pouvez toutefois interroger d'autres statuts, tels que BROUILLON, TERMINÉ, REFUSÉ, EXPIRÉ et ARCHIVÉ. ### Mise à jour d'une transaction Pour mettre à jour un package existant qui est à l'état DRAFT, il vous suffit de créer une charge utile avec uniquement les mises à jour que vous souhaitez apporter au package et d'effectuer votre requête PUT : #### Requête HTTP ```http PUT /api/packages/{packageId} ``` #### En-têtes HTTP ```http Accept: application/json   Content-Type: application/json   Authorization: Basic api_key ``` #### Charge utile de la demande ```json { "due": "2017-02-13T21:18:40Z", "emailMessage": "new email message", "notarized": true, "settings": { ... }, "description": "", "autocomplete": false, "visibility": "ACCOUNT", "status": "DRAFT", "type": "PACKAGE", "roles": [{ "reassign": false, "locked": false, "index": 0, "type": "SENDER", "signers": [{ "title": null, "address": null, "phone": "", "firstName": "Haris", "lastName": "Haidary", "email": "signer1@example.com", "company": "Onespan", "language": "fr", "name": "" }], "name": "Owner" }], "language": "fr", "name": "new package name", "bulkSendable": false } ``` ### Suppression de transactions La suppression d'une transaction ne peut pas être annulée. Si vous souhaitez supprimer définitivement une transaction de votre compte, il vous suffit d'effectuer une demande de suppression à l'aide du PackageId de la transaction que vous souhaitez supprimer. Si vous ne souhaitez pas supprimer définitivement cette transaction, vous pouvez la déplacer vers votre dossier Corbeille . De cette façon, il ne sera pas supprimé et pourra être récupéré à une date ultérieure. Pour ce faire, effectuez une requête PUT avec la charge utile suivante : #### Requête HTTP ```http PUT /api/packages/{packageId} ``` #### En-têtes HTTP ```http Accept: application/json   Content-Type: application/json   Authorization: Basic api_key ``` #### Charge utile de la demande ```http {   "trashed": true   } ``` ### Archivage des transactions L'action Archiver déplace les transactions sélectionnées de votre boîte de réception vers le dossier Archivé contenant toutes vos transactions archivées. Cette action n'est disponible que pour les transactions TERMINÉES dans votre boîte de réception. Pour archiver un paquet, il suffit de mettre à jour le statut du paquet sur ARCHIVÉ : #### Requête HTTP ```http PUT /api/packages/{packageId} ``` #### En-têtes HTTP ```http Accept: application/json   Content-Type: application/json   Authorization: Basic api_key ``` #### Charge utile de la demande ```json {   "status": "ARCHIVED"   } ``` #### Tableau des données utiles de la demande | Propriété | Type | Modifiable | Obligatoire | Faire défaut | Exemples de valeurs | | --- | --- | --- | --- | --- | --- | | statut | corde | Oui | Non | BROUILLON | BROUILLON / ENVOYÉ / TERMINÉ / ARCHIVÉ / REFUSÉ / EXPIRÉ | | due | corde | Oui | Oui | zéro | 2017-02-13T21:18:40Z | | par e-mailMessage | corde | Oui | Oui | zéro | Nouveau message électronique | | Notariée | booléen | Oui | Oui | faux | vrai / faux | | description | corde | Oui | Oui | zéro | Exemple de transaction de STU BANK | | Saisie semi-automatique | booléen | Oui | Non | vrai | vrai / faux | | type | corde | Oui | Non | COLIS | EMBALLAGE / MODÈLE / MISE EN PAGE | | nom | corde | Oui | Oui | n/a | Exemple d'attributs de document | | Saccagé | booléen | Oui | Non | faux | vrai / faux | | Langue | corde | Oui | Oui | en | en / fr / es ... | | visibilité | corde | Oui | Non | COMPTE | COMPTE / EXPÉDITEUR | | en vracSendable | booléen | Oui | Non | faux | Faux / Vrai | | Rôles | | | | | | | id | corde | Oui | Non | n/a | Le client1 | | index | entier | Oui | Non | 0 | 0 / 1 / 2 ... | | réaffecter | booléen | Oui | Non | faux | Faux / Vrai | | verrouillé | booléen | Oui | Non | faux | Faux / Vrai | | nom | corde | Oui | Non | n/a | Le client1 | | type | corde | Oui | Non | SIGNATAIRE | SIGNATAIRE / ÉMETTEUR | | Signataires | | | | | | | Messagerie électronique | corde | Oui | Oui | n/a | preparer.email@example.com | | prénom | corde | Oui | Oui | n/a | John | | nomNom de famille | corde | Oui | Oui | n/a | Forgeron | | Téléphone | corde | Oui | Non | n/a | 514-555-8888 | | id | corde | Oui | Non | n/a | Le client1 | | compagnie | corde | Oui | Non | n/a | Acme Inc. | | adresse | corde | Oui | Non | n/a | 123, rue Main | | titre | corde | Oui | Non | n/a | Directeur général | | Paramètres | | | | | | | cérémonie | | | | | | | en personne | booléen | Oui | Non | faux | Faux / Vrai | | declineButton | booléen | Oui | Non | vrai | Faux / Vrai | | refuserRaisons | corde | Oui | Non | n/a | Nouvelle raison de refus #1 | | optOutRaisons | corde | Oui | Non | n/a | Nouvelle raison de désinscription #1 Remarque : L'option de désinscription n'est plus disponible dans l'expérience du signataire. | | désactiverRefuserAutre | booléen | Oui | Non | faux | Faux / Vrai | | disableDownloadForUncompletedPackage | booléen | Oui | Non | faux | Faux / Vrai | | désactiverFirstInPersonAffidavit | booléen | Oui | Non | faux | Faux / Vrai | | disableInPersonAffidavit | booléen | Oui | Non | faux | Faux / Vrai | | disableOptOutAutre | booléen | Oui | Non | faux | Faux / Vrai Remarque : L'option de désinscription n'est plus disponible dans l'expérience du signataire. | | désactiverSecondInPersonAffidavit | booléen | Oui | Non | faux | Faux / Vrai | | hideCaptureText | booléen | Oui | Non | faux | Faux / Vrai | | hideLanguageDropdown | booléen | Oui | Non | faux | Faux / Vrai | | hidePackageOwnerInPerson | booléen | Oui | Non | faux | Faux / Vrai | | masqueFiligrane | booléen | Oui | Non | faux | Faux / Vrai | | maxAuthFailsAutorisé | entier | Oui | Non | 3 | 1 / 2 / 3 ... | | optOutButton | booléen | Oui | Non | faux | Faux / Vrai Remarque : L'option de désinscription n'est plus disponible dans l'expérience du signataire. | | disposition | | | | | | | iframe | booléen | Oui | Non | faux | Faux / Vrai | | navigateur | booléen | Oui | Non | faux | Faux / Vrai | | en-tête | | | | | | | rétroaction | booléen | Oui | Non | faux | Faux / Vrai | | chapelure | booléen | Oui | Non | faux | Faux / Vrai | | globalNavigation | booléen | Oui | Non | faux | Faux / Vrai | | Barre de session | booléen | Oui | Non | faux | Faux / Vrai | | titleBar | | | | | | | progressBar | booléen | Oui | Non | faux | Faux / Vrai | | titleBar | booléen | Oui | Non | faux | Faux / Vrai | | globalActions | | | | | | | confirmer | booléen | Oui | Non | faux | Faux / Vrai | | télécharger | booléen | Oui | Non | faux | Faux / Vrai | | hideEvidenceSummary | booléen | Oui | Non | faux | Faux / Vrai | | saveAsLayout | booléen | Oui | Non | faux | Faux / Vrai | | image de marqueBar | | | | | | | logo | | | | | | | src | corde | Oui | Non | zéro | Source de l'image du nouveau logo | | lien | corde | Oui | Non | zéro | Nouveau lien vers l'image du logo | | épreuves | | | | | | | complet | | | | | | | dialogue | booléen | Oui | Non | faux | vrai / faux | | rediriger | corde | Oui | Non | zéro | https://www.google.ca | | Remise | | | | | | | href | corde | Oui | Non | zéro | http://www.new.ca | | titre | corde | Oui | Non | zéro | NOUVELLE INFO-BULLE DU LIEN DE TRANSFERT | | SMS | corde | Oui | Non | zéro | Nouveau texte du lien de transfert | ## APEX SDK Pour télécharger l'exemple de code complet, consultez notre site [Code Share](https://community.onespan.com/documentation/onespan-sign/codeshare/package-management-apex-sdk/) . Cette rubrique décrit comment récupérer, mettre à jour, archiver et supprimer une transaction. ### Récupération des transactions Pour récupérer une transaction, vous devez d'abord créer un objet PackageId à l'aide de l'ID qui vous a été renvoyé lors de la création de la transaction. Ensuite, récupérez la transaction à l'aide de ce PackageId dans le client OneSpan Sign. Pour ce faire, le code suivant : ```plaintext //retrieve a package   ESignLiveSDK sdk = new ESignLiveSDK();   ESignLiveAPIObjects.Package_x pkg = sdk.getPackage(packageId); ``` Vous pouvez également récupérer une liste de transactions. Pour ce faire, le code suivant : ```plaintext public List getPackages(Map queryParameters) ``` Vous pouvez passer une carte des paramètres de requête afin d'affiner votre recherche comme ceci : ```plaintext List pkgs = getPackages(new Map{'from'=>'0','to'=>'9','status'=>'SENT'}); ``` L'exemple de code ci-dessus renverra les dix premières transactions qui ont l'état ENVOYÉ. Vous pouvez toutefois interroger d'autres statuts, tels que BROUILLON, TERMINÉ, REFUSÉ, EXPIRÉ et ARCHIVÉ. ### Mise à jour d'une transaction Pour mettre à jour une transaction existante, créez un objet de transaction avec uniquement les mises à jour que vous souhaitez apporter à la transaction. Ensuite, appelez la fonction updatePackage() avec le PackageId de la transaction existante et l'objet Package_x mises à jour. Pour ce faire, le code suivant : ```plaintext // Option 1: Retrieve and update an existing package ESignLiveAPIObjects.Package_x pkg = sdk.getPackage(packageId); // Option 2: Create a new package object and update its name ESignLiveAPIObjects.Package_x pkg = new ESignLiveAPIObjects.Package_x(); pkg.name = 'changed package name'; // Update the package using the SDK sdk.updatePackage(pkg, packageId); ``` ### Suppression de transactions Si vous souhaitez supprimer définitivement une transaction de votre compte, appelez la fonction deletePackage() à l'aide du PackageId de la transaction que vous souhaitez supprimer. La suppression d'une transaction ne peut pas être annulée. Pour ce faire, le code suivant : ```plaintext // Delete the document package using its package ID sdk.deletePackage(packageId); ``` Si vous ne souhaitez pas supprimer définitivement cette transaction, vous pouvez la déplacer vers votre dossier Corbeille . De cette façon, il ne sera pas supprimé et pourra être récupéré à une date ultérieure. Pour ce faire, le code suivant : ```plaintext // Retrieve the package using its ID ESignLiveAPIObjects.Package_x pkg = sdk.getPackage(packageId); // Mark the package as trashed pkg.trashed = true; // Update the package to apply the change sdk.updatePackage(pkg, packageId); ``` ### Archivage des transactions L'action Archiver déplace les transactions sélectionnées de votre boîte de réception vers le dossier Archivé contenant toutes vos transactions archivées. Cette action n'est disponible que pour les transactions TERMINÉES dans votre boîte de réception. Pour ce faire, appelez la fonction setStatus() avec le PackageId de la transaction que vous souhaitez archiver. Pour ce faire, le code suivant : ```plaintext // Archive the document package (only possible if the package is completed) sdk.setStatus(packageId, ESignLiveAPIObjects.PackageStatus.ARCHIVED); // Restore the archived package by setting its status back to COMPLETED sdk.setStatus(packageId, ESignLiveAPIObjects.PackageStatus.COMPLETED); ```