Skip to main content
POST
/
tenant
/
{tenantId}
/
proposals
/
{proposalId}
/
cancel
Cancels a transaction proposal that has not yet been executed.
curl --request POST \
  --url https://api.example.com/tenant/{tenantId}/proposals/{proposalId}/cancel
{
  "isSuccess": true,
  "isFailure": false,
  "error": null,
  "value": {
    "id": 42,
    "name": "Example"
  }
}

Path Parameters

​
tenantId
integer<int64>
required

Identifier of the tenant.

​
proposalId
integer<int64>
required

Identifier of the transaction proposal.

Response

200 - application/json

Transaction proposal cancelled successfully.

Wrapper for API operation results containing success status, error information, and return value.

​
isSuccess
boolean

True if the operation completed successfully, false otherwise.

Example:

true

​
isFailure
boolean

True if the operation failed, false otherwise.

Example:

false

​
error
object

Error information returned when the operation fails.

Example:
{
  "code": "ValidationError",
  "message": "The request parameters failed validation.",
  "info": [
    "The Name field is required.",
    "The Id field must be greater than 0."
  ]
}
​
value
object

The result value returned when the operation is successful.

Example:
{ "success": true }