Skip to main content
POST
/
submission
/
{displayId}
/
{transactionId}
/
cancel
Execute Cancellation
curl --request POST \
  --url https://api.coverwhale.dev/v1/submission/{displayId}/{transactionId}/cancel \
  --header 'AccessToken: <api-key>' \
  --header 'Content-Type: application/json' \
  --data '
{
  "cancellation_reason": "<string>",
  "cancel_reason_others": "<string>"
}
'
{
  "status": "success",
  "submission_number": "<string>",
  "transaction_id": 123,
  "submission_status": "<string>"
}

Authorizations

​
AccessToken
string
header
required

AWS Cognito access token obtained from the /authentication endpoint. Token expires after 3600 seconds.

Headers

​
AccessToken
string
required

Path Parameters

​
displayId
string
required
​
transactionId
integer
required

Body

application/json
​
cancellation_reason
string

Cancellation reason

​
cancel_reason_others
string

Free-text cancellation reason

Response

Cancellation executed

​
status
string
Example:

"success"

​
submission_number
string
​
transaction_id
integer
​
submission_status
string