Delete / Cancel a Transaction
Method: DELETE
Path: /api/transaction/{transactionId}
Cancelling a Transaction
When a transaction is not in an end-state (eg. Status = 5, 10, or 20) the transaction will be cancelled and deleted. When cancelling a transaction, you can choose to send an email notification to any awaiting signers informing them that the transaction has been cancelled. The status of the transaction will be set to cancelled.
Deleting a Transaction
When a transaction is in an end-state (eg. Status = 30, 40, 50, or 60) the transaction will be deleted. When deleting a transaction, you can choose to send an email notification to any awaiting signers informing them that the transaction has been deleted. The status of the transaction will remain the same but any uploaded documents and sensitive data will be deleted as soon as possible.
Parameters
| Name | In | Type | Required | Description |
|---|---|---|---|---|
| transactionId | path | string | Yes | The transaction ID to cancel or delete |
Request Body
Options for cancelling or deleting the transaction
Content-Type: application/json
Schema: TransactionDeleteOptions
Properties
| Name | Type | Description |
|---|---|---|
| Reason | String | Reason for cancelling the transaction |
| SendNotifications | Boolean | Whether to notify signers about the cancellation. Note that this only applies when SendSignRequest has been set to true during the transaction creation. |
Responses
200
Transaction cancelled successfully
Content-Type: application/json
Schema: Transaction
Properties
| Name | Type | Description |
|---|---|---|
| Id | String | Unique transaction identifier |
| Seal | Boolean | Whether the transaction is sealed (no signers required) |
| Reference | String | Custom reference identifier |
| PostbackUrl | String | Webhook URL for status notifications |
| DaysToExpire | Integer | Days until the transaction expires. |
| SendEmailNotifications | Boolean | Send e-mail notifications to the sender. |
| SignRequestMode | enum:
| Sign request delivery mode
|
| Language | enum:
| Language code for the Sender email notifications, and transaction receipt. |
| Status | enum:
| Current transaction status:
|
| Context | Object | Custom JSON object for additional transaction metadata that was provided during creation. |
| CreatedDateTime | String | When the transaction was created |
| ModifiedDateTime | String | When the transaction was last modified |
| CanceledDateTime | String | When the transaction was cancelled, if applicable |
| Files | Object | Files attached to the transaction as a key-value mapping. Key is the file ID, value is the file information. |
| Signers | Array<Signer> | List of signers attached to this transaction, including their configuration, current status, verification methods, and signing progress. Each signer represents an individual who needs to sign the document or has already completed the signing process. |
| Receivers | Array<Receiver> | List of receivers who will receive copies of the completed signed documents. Receivers are notified via email once the transaction is successfully completed and all required signatures have been obtained. |
| CancelationReason | String | The reason for the cancellation of the transaction, if applicable. This is provided when the transaction is cancelled via the DELETE endpoint. |
401
Unauthorized - user not creator of transaction
Content-Type: application/json
Schema: ErrorResponse
Properties
| Name | Type | Description |
|---|---|---|
| Message | String | Required. Human-readable error message |
403
Forbidden - authorization policy violation
Content-Type: application/json
Schema: ErrorResponse
Properties
| Name | Type | Description |
|---|---|---|
| Message | String | Required. Human-readable error message |
500
Internal server error
Content-Type: application/json
Schema: ErrorResponse
Properties
| Name | Type | Description |
|---|---|---|
| Message | String | Required. Human-readable error message |