Dès sa création et jusqu’à sa clôture, une transaction passe par différents statuts.
Lancer une transaction
Une transaction est créée sous forme de brouillon jusqu’à ce qu’elle soit lancée. Une fois la transaction lancée, les documents sont prêts à être traités par les premiers participants dans la file d’attente. Une transaction lancée peut être mise à jour si les modifications n’affectent pas les tâches déjà effectuées par les participants.
Pour lancer une transaction, envoyez une requête à POST /v1/transactions/{transaction_id}/start.
curl
https://api.universign.com/v1/transactions/tx_dy9Qn27PQ3mb/start \
L’API renvoie un objet transaction avec une date started_at. Une fois la transaction lancée, vous pouvez toujours la mettre à jour de manière dynamique, à condition que vos requêtes soient compatibles avec le statut de la ressource ou de la sous-ressource avec laquelle vous interagissez, et cohérentes avec le flux de signature. Par exemple, il n’est pas possible de modifier le nom d’un document après sa signature. Il n’est pas non plus possible de mettre à jour les coordonnées d’un signataire une fois qu’il a déjà signé.
Mettre une transaction en pauseon
Lorsqu’une transaction est en pause, vous pouvez la modifier sans effet immédiat. Les modifications prendront effet lorsque vous re lancerez la transaction. Pendant que la transaction est mise en pause, les participants ne peuvent effectuer aucune des actions requises sur la page de signature et ne reçoivent aucune notification. Notez que la mise en pause d’une transaction n’a aucune incidence sur son expiration : le compte à rebours continue de fonctionner normalement. Une transaction mise en pause expirera donc si elle n’est pas relancée après la durée autorisée.
Pour mettre une transaction en pause, envoyez une requête à POST /v1/transactions/{transaction_id}/pause.
curl
https://api.universign.com/v1/transactions/tx_dy9Qn27PQ3mb/pause \
L’API renvoie un objet transaction avec un statut paused. Bien que les participants ne puissent plus accéder à une transaction mise en pause ni recevoir de notifications, notez que la mise en pause d’une transaction n’affecte pas son expiration. Si vous souhaitez reporter la date d’expiration de la transaction, vous devez le faire en mettant à jour la transaction (notez que la durée d’une transaction ne peut pas dépasser 45 jours après son lancement).
Annuler une transaction
Une transaction annulée ne peut plus être modifiée, et les documents partiellement signés ne peuvent pas être récupérés. Si une transaction était à l’statut draft avant son annulation, elle est définitivement supprimée après 24 heures. Si elle était started ou paused avant son annulation, elle est définitivement supprimée après 60 ou 180 jours, selon la configuration de votre espace de travail.
Pour annuler une transaction, envoyez une requête à POST /v1/transactions/{transaction_id}/cancel.
curl
https://api.universign.com/v1/transactions/tx_dy9Qn27PQ3mb/cancel \
L’API renvoie un objet transaction avec un statut cancelled et un cancel_code, si vous en avez spécifié un. Si vous essayez d’annuler une transaction au statut autre que draft, started ou paused, vous obtenez une erreur API. Notez que les transactions cancelled sont définitivement supprimées du système après 60 jours. Notez également qu’il n’est pas possible de télécharger des documents à partir d’une transaction cancelled, même s’ils ont été partiellement signés.
Récupérer une transaction
Pour récupérer des informations sur une transaction spécifique initiée par votre espace de travail, envoyez une requête à GET /v1/transactions/{transaction_id}/.
curl
https://api.universign.com/v1/transactions/tx_dy9Qn27PQ3mb \
L’API renvoie un objet transaction, tel qu’il a été mis à jour pour la dernière fois.
Lister toutes les transactions
Pour récupérer toutes les transactions initiées par votre espace de travail, que vous êtes autorisé à modifier et/ou consulter, envoyez une requête à GET /v1/transactions et définissez des filtres facultatifs pour affiner votre requête.
curl
https://api.universign.com/v1/transactions?size=5&state=started&text_search=^contract \
L’API renvoie la liste de toutes les transactions correspondant à votre requête.
