Skip to main content
POST
Request Cancellation

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

Submission display ID

Body

application/json
effective_date_transaction
string
required

Cancellation effective date (MM/DD/YYYY)

Example:

"03/01/2026"

effective_date_transaction_al
string

Optional separate AL cancellation date (MM/DD/YYYY)

Example:

"03/01/2026"

Response

Cancellation request created

status
string
Example:

"success"

submission_number
string
transaction_id
integer
cancellation_status
string