The maximum lifetime of a transaction is 60 days (86400 minutes) or 180 days (259200 minutes) depending on your workspace entitlements.
If you wish to enable long-term transactions (180 days), you must contact your account manager at Universign. Once long-term transactions are enabled, all new transactions will have a maximum lifetime of 180 days. However, the activation is not retroactive: transactions created prior to the activation will remain on a maximum lifetime of 60 days.
You can define the lifetime of a transaction by setting either its duration or expiration date. By default, a transaction expires 14 days (20160 minutes) after it is started.
If you set a duration
, this can only be done while the transaction is in draft. The value of the duration is expressed in minutes and takes effect when the transaction is started. Once the transaction is started, the duration is automatically converted into an expiration date. If you want to modify the expiration once the transaction is started, you must therefore pass a date. Be careful when updating the expiration date: if you set a date prior to the current date, the transaction will expire immediately.
Setting an expiration date can be done when the transaction is in draft or started, via the expires_at
parameter. The expected input date format is ISO 8601 (yyyy-MM-ddTHH:mm:ssZ
). Seconds (ss
) are optional, for example 2022-11-14T17:32Z
. The maximum duration of a transaction being 60 or 180 days, you can set the expiry date to current date + 67 days or 187 days (the 7 extra days correspond to the maximum period in draft state.)
Important: a transaction can be left in draft for 7 days but will be automatically deleted after that time, even if a duration or expiration date has been configured.
Set a transaction duration
To set a duration upon transaction creation, send a request to POST /v1/transactions
and pass the duration
argument in minutes:
curl
https://api.universign.com/v1/transactions \
-d duration=20160
Update the transaction duration
To update the duration of an existing transaction in draft, send a request to POST /v1/transactions/{transaction_id}
and pass the duration
argument in minutes:
curl
https://api.universign.com/v1/transactions/tx_AWo949MOq0JE \
-d duration=86400
Set an expiration date
To set an expiration date when you create a transaction, send a request to POST /v1/transactions
and pass the expires_at
argument in an ISO 8601 date format:
curl
https://api.universign.com/v1/transactions \
-d expires_at=2021-10-14T17:32Z
Update expiration date
To update the expiration of an existing transaction, send a request to POST /v1/transactions/{transaction_id}
and pass the expires_at
argument in an ISO 8601 date format:
curl
https://api.universign.com/v1/transactions/tx_AWo949MOq0JE \
-d expires_at=2022-11-14T17:32Z
Important: do not pass both expires_at
and duration
parameters or will be returned an error.