Skip to main content
POST
/
platform
/
admin
/
proposals
/
{proposalId}
/
cancel
Cancel transaction proposal
curl --request POST \
  --url https://api.example.com/platform/admin/proposals/{proposalId}/cancel
{
  "isSuccess": true,
  "isFailure": false,
  "error": null,
  "value": {
    "id": 42,
    "name": "Example"
  }
}

​
Description

Marks a transaction proposal as cancelled, preventing any further approvals or execution. This action is irreversible and can only be performed on proposals that have not yet been executed on the blockchain.

​
Input

  • proposalId (long, required) — The unique identifier of the proposal to cancel.

​
Output

Returns a containing:
  • success (bool) — Indicates if the proposal was cancelled successfully.
  • message (string) — Confirmation message about the cancellation.

​
Examples

Request 
POST /api/platform/tenant/transaction-proposals/10002/cancel
Response (200 OK) 
{
  "success": true,
  "message": "Transaction proposal cancelled successfully"
}

​
Errors

  • 400 Bad Request: Proposal ID is invalid or malformed.
  • 401 Unauthorized: Caller is not authenticated.
  • 403 Forbidden: Caller lacks permission to cancel proposals.
  • 404 Not Found: Proposal with specified ID does not exist.
  • 409 Conflict: Proposal has already been executed or cancelled and cannot be modified.
  • 500 Internal Server Error: An unexpected error occurred.

​
Notes

Only proposals in “Pending” or “Approved” states can be cancelled. Once a proposal has been executed on the blockchain, it cannot be cancelled. Cancelled proposals retain their approval history for audit purposes but can no longer be executed.

Path Parameters

​
proposalId
integer<int64>
required

The unique identifier of the transaction proposal to cancel.

Query Parameters

​
api-version
string | null

Response

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 }