Cancel a transfer

Cancel a requested transfer. Repeating cancellation of an already-cancelled transfer returns the same record.

POST/transfers/{transfer_id}/cancel

Authorization

X-API-KeyAPI key · headerrequired

API key in format `sk_*`. Scoped to your partner account; server-side use only.

Path parameters

transfer_idstring<uuid>required

Header parameters

Idempotency-Keystringrequired

Unique key for safe retries. Reusing a key on the same endpoint returns the original result.

max length 255

Responses

200Transfer cancelled.

created_atstring<date-time>required

external_refstring | null

idstring<uuid>required

qidsQID[]required

statusTransferStatusrequired

Allowed:requestedcompleteddeclinedcancelled

typeTransferTyperequired

Allowed:sell_back

updated_atstring<date-time>required

400Validation failed.

codeErrorCoderequired

Stable machine-readable error vocabulary for v1.

Allowed:validation_errorstate_conflictenvironment_mismatchunsupported_destinationinvalid_api_keynot_foundrate_limited

extraobjectrequired

Structured details such as field errors or SKU availability.

messagestringrequired

Human-readable summary.

401Missing, invalid, expired, or environment-mismatched API key.

codeErrorCoderequired

Stable machine-readable error vocabulary for v1.

Allowed:validation_errorstate_conflictenvironment_mismatchunsupported_destinationinvalid_api_keynot_foundrate_limited

extraobjectrequired

Structured details such as field errors or SKU availability.

messagestringrequired

Human-readable summary.

404No such resource exists for this partner and environment.

codeErrorCoderequired

Stable machine-readable error vocabulary for v1.

Allowed:validation_errorstate_conflictenvironment_mismatchunsupported_destinationinvalid_api_keynot_foundrate_limited

extraobjectrequired

Structured details such as field errors or SKU availability.

messagestringrequired

Human-readable summary.

409The resource state prevents the requested action.

codeErrorCoderequired

Stable machine-readable error vocabulary for v1.

Allowed:validation_errorstate_conflictenvironment_mismatchunsupported_destinationinvalid_api_keynot_foundrate_limited

extraobjectrequired

Structured details such as field errors or SKU availability.

messagestringrequired

Human-readable summary.

429Rate limit exceeded for this API key.

codeErrorCoderequired

Stable machine-readable error vocabulary for v1.

Allowed:validation_errorstate_conflictenvironment_mismatchunsupported_destinationinvalid_api_keynot_foundrate_limited

extraobjectrequired

Structured details such as field errors or SKU availability.

messagestringrequired

Human-readable summary.

Try it

Server

Base URLCustom base URLOverrides the selected server when set.

Authorization

API keyRemember on this deviceInclude my values in samples

Parameters

transfer_idpath*Idempotency-Keyheader*Unique key for safe retries. Reusing a key on the same endpoint returns the original result.

Request

curl -X POST "https://api.vault.stashtab.gg/v1/transfers/497f6eca-6276-4993-bfeb-53cbbbba6f08/cancel" \
  -H "X-API-Key: YOUR_API_KEY" \
  -H "Idempotency-Key: string"

const response = await fetch("https://api.vault.stashtab.gg/v1/transfers/497f6eca-6276-4993-bfeb-53cbbbba6f08/cancel", {
  method: "POST",
  headers: {
    "X-API-Key": "YOUR_API_KEY",
    "Idempotency-Key": "string"
  }
});

Response

{
  "created_at": "2019-08-24T14:15:22Z",
  "external_ref": "string",
  "id": "497f6eca-6276-4993-bfeb-53cbbbba6f08",
  "qids": [
    "7c9e6679-7425-40de-944b-e07fc1f90ae7"
  ],
  "status": "requested",
  "type": "sell_back",
  "updated_at": "2019-08-24T14:15:22Z"
}

{
  "code": "validation_error",
  "extra": {},
  "message": "string"
}

{
  "code": "validation_error",
  "extra": {},
  "message": "string"
}

{
  "code": "validation_error",
  "extra": {},
  "message": "string"
}

{
  "code": "validation_error",
  "extra": {},
  "message": "string"
}

{
  "code": "validation_error",
  "extra": {},
  "message": "string"
}