POST/sandbox/transaction/deny

Deny Transaction

Denies a pending sandbox transaction.

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 deny.
`Comments`	string	Required	sandbox deny	Denial comment for the transaction.

Example request

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

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

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 denial. A 200 is returned for both successful denial and already-processed transactions.

Example response

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

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

Already-processed and not-found outcomes are mapped to 200 with a descriptive `Message` (e.g. `"Transaction has already been processed."` or `"Transaction not found."`).

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