POST
/v2/sandbox/transaction/cancelCancel Transaction
Cancels a pending transaction created in the sandbox environment.
Note: FVNet transactions cannot be cancelled; they can only be denied by the user the transaction is directed to.
Test environment only — not available in production.
Headers
| Field | Type | Required | Possible values | Description |
|---|---|---|---|---|
Authorization | string | Required | Bearer {SessionToken} | Session token from Get Session Token, sent as `Authorization: Bearer {SessionToken}`. Replace with the value from the `x-refresh-token` response header when present (typically within 2 minutes of expiry). Secured calls must use the same IP as the auth request. |
Request body
| Field | Type | Required | Possible values | Description |
|---|---|---|---|---|
TransactionNumber | string | Required | {transactionNumber} | Transaction number of the pending sandbox transaction. |
Comments | string | Required | Cancelling Deposit | Comments recorded with the cancellation. |
Example request
{
"Comments": "Cancelling Deposit",
"TransactionNumber": "{transactionNumber}"
}Response
| Field | Type | Possible values | Description |
|---|---|---|---|
ResponseCode | integer | 200 | 201 | 204 | 400 | 401 | 403 | 404 | 410 | 422 | 500 | 301 | 503 | 422 | 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 | Result message for the cancel attempt. |
Example response
{
"ResponseCode": 200,
"ResponseMessage": "Success",
"ResponseData": {
"Message": "Transaction cancelled"
}
}Other possible Message values include "Transaction has already been processed.", "Transaction not found.", and "FVNet transactions cannot be cancelled".
Requires `Authorization: Bearer {SessionToken}` from Get Session Token. Refresh via `x-refresh-token` when supplied; use the same client IP as authentication.