POST/sandbox/transaction/cancel

Cancel Transaction

Cancels a pending sandbox transaction.

FVNet transactions cannot be cancelled and return a 200 with "FVNet transactions cannot be cancelled" in ResponseData.Message.

Non-production only. This endpoint is blocked in production.

Headers

Field	Type	Required	Possible values	Description
`session-token`	string	Required	—	SessionToken obtained from the Create GMA Session endpoint. All secured endpoints require this header.

Request body

Field	Type	Required	Possible values	Description
`TransactionNumber`	string	Required	—	Transaction number to cancel.
`Comments`	string	Required	sandbox cancel	Cancellation comment for the transaction.

Example request

{
  "TransactionNumber": "FV000757183",
  "Comments": "sandbox cancel"
}

{
  "TransactionNumber": "FV000757183",
  "Comments": "sandbox cancel"
}

Response

Field	Type	Possible values	Description
`ResponseCode`	integer	200 \| 201 \| 204 \| 301 \| 400 \| 401 \| 403 \| 404 \| 410 \| 422 \| 500 \| 503	API result code in the response envelope. Indicates success or the error category (e.g. 200 success, 400 bad request, 401 unauthorized).
`ResponseMessage`	string	Success \| Created \| NoContent \| BadRequest \| Unauthorized \| Forbidden \| NotFound \| Gone \| UnprocessableContent \| ServerError \| ResourceMoved \| ServiceUnAvailable \| UnProcessableEntity	Human-readable label paired with ResponseCode (e.g. Success, BadRequest, Unauthorized). Use with ResponseCode to interpret the outcome.
`ResponseData`	object	Please refer to below example for response body	`Message` — outcome of the cancellation. A 200 is returned for successful cancellations, FVNet transactions, and already-processed transactions.

Example response

{
  "ResponseCode": 200,
  "ResponseMessage": "Success",
  "ResponseData": {
    "Message": "Transaction cancelled"
  }
}

{
  "ResponseCode": 200,
  "ResponseMessage": "Success",
  "ResponseData": {
    "Message": "Transaction cancelled"
  }
}

FVNet transactions cannot be cancelled and return 200 with `"FVNet transactions cannot be cancelled"`. Already-processed and not-found outcomes also return 200 with a descriptive `Message`.

Requires `session-token: {SessionToken}` from Create GMA Session. Use the same client IP as authentication.