Managing Transactions

To download the full code sample see our Code Share site.

This topic describes how to retrieve, update, archive, and delete a transaction.

Retrieving Transactions

To retrieve a transaction, you will first need to create a PackageId object using the ID returned to you during the creation of the transaction. Then, retrieve the transaction using this PackageId in the OneSpan Sign client. The following code will do this:

 PackageId packageId = new PackageId("package_id_here");   DocumentPackage retrievedPkg = eslClient.getPackage(packageId); 

You can also retrieve a list of transactions. The following code will do this:

 Page<DocumentPackage> resultPage = eslClient.getPackageService().getPackages( new PackageStatusConverter(PackageStatus.SENT).toAPIPackageStatus(), new PageRequest(1, 10)); 

The code example above will return the first ten transactions that are in a SENT status. You can, however, query other statuses, such as DRAFT, COMPLETED, DECLINED, EXPIRED, and ARCHIVED.

Updating a Transaction

To update a transaction, the transaction must be in a DRAFT status.

To update an existing transaction, create a transaction object with only the updates you want to make to the transaction. Then, call the UpdatePackage function with the PackageId of the existing transaction. The following code will do this:

 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();   eslClient.updatePackage(packageId, packageToUpdate); 

Deleting Transactions

If you want to permanently remove a transaction from your account, call the deletePackage function using the PackageId of the transaction you wish to delete.

Deleting a transaction cannot be undone.

The following code will do this:

 eslClient.getPackageService().deletePackage(packageId); 

If you do not want to permanently delete this transaction, you can instead move it to your Trash folder. This way it will not be deleted and can be retrieved at a later date. The following code will do this:

 eslClient.getPackageService().trash(packageId); 

Archiving Transactions

The Archive action moves the selected transactions from your Inbox to the Archived folder containing all your archived transactions. This action is available only for COMPLETED transactions in your Inbox.

To do this, call on the OneSpan Sign client with the PackageId of the transaction you wish to archive. The following code will do this:

 eslClient.getPackageService().archive(new PackageId("packageId")); 

To download the full code sample see our Code Share site.

This topic describes how to retrieve, update, archive, and delete a transaction.

Retrieving Transactions

To retrieve a transaction, you will first need to create a PackageId object using the ID returned to you during the creation of the transaction. Then, retrieve the transaction using this PackageId in the OneSpan Sign client. The following code will do this:

 PackageId packageId = new PackageId("package_id_here");   DocumentPackage retrievedPkg = eslClient.GetPackage(packageId); 

You can also retrieve a list of transactions. The following code will do this:

 Page<DocumentPackage> packages = eslClient.PackageService.GetPackages (DocumentPackageStatus.SENT, new PageRequest(1, 10)); 

The code example above will return the first ten transactions that are in a SENT status. You can, however, query other statuses, such as DRAFT, COMPLETED, DECLINED, EXPIRED, and ARCHIVED.

Updating a Transaction

To update an existing transaction, create a transaction object with only the updates you want to make to the transaction. Then, call the UpdatePackage function with the PackageId of the existing transaction. The following code will do this:

 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();   eslClient.UpdatePackage(packageId, packageToUpdate); 

Deleting Transactions

If you want to permanently remove a transaction from your account, call the deletePackage function using the PackageId of the transaction you wish to delete.

Deleting a transaction cannot be undone.

The following code will do this:

 eslClient.PackageService.DeletePackage(packageId); 

If you do not want to permanently delete this transaction, you can instead move it to your Trash folder. This way it will not be deleted and can be retrieved at a later date. The following code will do this:

 eslClient.PackageService.Trash(packageId); 

Archiving Transactions

The Archive action moves the selected transactions from your Inbox to the Archived folder containing all your archived transactions. This action is available only for COMPLETED transactions in your Inbox.

To do this, call on the OneSpan Sign client with the PackageId of the transaction you wish to archive. The following code will do this:

 eslClient.PackageService.Archive(new PackageId("packageId")); 

To download the full code sample see our Code Share site.

This topic describes how to retrieve, update, archive, and delete a transaction.

Retrieving Transactions

To retrieve a transaction, you will first need to create a PackageId object using the ID returned to you during the creation of the transaction. Then, retrieve the transaction using this PackageId in the OneSpan Sign client. The following code will do this:

 //retrieve a package   ESignLiveSDK sdk = new ESignLiveSDK();   ESignLiveAPIObjects.Package_x pkg = sdk.getPackage(packageId); 

You can also retrieve a list of transactions. The following code will do this:

 public List<ESignLiveAPIObjects.Package_x> getPackages(Map<String,String> queryParameters) 

You can pass a map of query parameters in order to narrow your search like this:

 List<ESignLiveAPIObjects.Package_x> pkgs = getPackages(new Map<String,String>{'from'=>'0','to'=>'9','status'=>'SENT'}); 

The code example above will return the first ten transactions that are in a SENT status. You can, however, query other statuses, such as DRAFT, COMPLETED, DECLINED, EXPIRED, and ARCHIVED.

Updating a Transaction

To update an existing transaction, create a transaction object with only the updates you want to make to the transaction. Then, call the updatePackage() function with the PackageId of the existing transaction and the updates Package_x object. The following code will do this:

 //update package   ESignLiveAPIObjects.Package_x pkg = sdk.getPackage(packageId); //or   ESignLiveAPIObjects.Package_x pkg = new ESignLiveAPIObjects.Package_x();   pkg.name = 'changed package name';   sdk.updatePackage(pkg, packageId); 

Deleting Transactions

If you want to permanently remove a transaction from your account, call the deletePackage () function using the PackageId of the transaction you wish to delete.

Deleting a transaction cannot be undone.

The following code will do this:

 //delete package   sdk.deletePackage(packageId);  

If you do not want to permanently delete this transaction, you can instead move it to your Trash folder. This way it will not be deleted and can be retrieved at a later date. The following code will do this:

 //trash package   ESignLiveAPIObjects.Package_x pkg = sdk.getPackage(packageId);   pkg.trashed = true;   sdk.updatePackage(pkg, packageId); 

Archiving Transactions

The Archive action moves the selected transactions from your Inbox to the Archived folder containing all your archived transactions. This action is available only for COMPLETED transactions in your Inbox.

To do this, call the setStatus() function with the PackageId of the transaction you wish to archive. The following code will do this:

 //archive package   sdk.setStatus(packageId, ESignLiveAPIObjects.PackageStatus.ARCHIVED);   //you can only archive completed packages   sdk.setStatus(packageId, ESignLiveAPIObjects.PackageStatus.COMPLETED); //restore archive