POST/sandbox/transaction/accept

Accept Transaction

Authorizes (accepts) a pending sandbox transaction.

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

Headers

FieldTypeRequiredPossible valuesDescription
session-tokenstringRequired

SessionToken obtained from the Create GMA Session endpoint. All secured endpoints require this header.

Request body

FieldTypeRequiredPossible valuesDescription
TransactionNumberstringRequired

Transaction number to authorize.

CommentsstringRequiredsandbox accept

Authorization comment for the transaction.

Example request

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

Response

FieldTypePossible valuesDescription
ResponseCodeinteger200 | 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).

ResponseMessagestringSuccess | 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.

ResponseDataobjectPlease refer to below example for response body

`Message` — outcome of the authorization. A 200 is returned for both successful authorization and already-processed transactions.

Example response

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

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

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

Search guide books, endpoints, paths, or parameters

↑↓navigateopenEscclose