Cancel a non-terminal transfer

Flips the transfer to Canceled when its current state is in the cancelable set.

POST /v1/transfers/{id}/cancel

Cancel a non-terminal transfer

cURL

curl --request POST \
  --url https://sta.sandbox.lerian.net/v1/transfers/{id}/cancel \
  --header 'Authorization: Bearer <token>' \
  --header 'Content-Type: application/json' \
  --data '
{
  "reason": "<string>"
}
'

200

{
  "bytesDownloaded": 123,
  "bytesUploaded": 123,
  "createdAt": "2023-11-07T05:31:56Z",
  "credentialId": "<string>",
  "currentState": "<string>",
  "currentStateCode": 123,
  "direction": "<string>",
  "documentType": "<string>",
  "downloadAttempts": 123,
  "expired": true,
  "fileName": "<string>",
  "fileSizeBytes": 123,
  "hashMismatchAttempts": 123,
  "id": "<string>",
  "secondsRemaining": 123,
  "transmissionAttempts": 123,
  "updatedAt": "2023-11-07T05:31:56Z",
  "uploadAttempts": 123,
  "errorCode": "<string>",
  "expiresAt": "2023-11-07T05:31:56Z",
  "fileRef": "<string>",
  "lastTransitError": "<string>",
  "protocolGeneratedAt": "2023-11-07T05:31:56Z",
  "protocolNumber": "<string>",
  "sourceProduct": "<string>",
  "urgentRequestedAt": "2023-11-07T05:31:56Z"
}

Authorizations

Authorization · string · header · required

JWT bearer token issued by the identity provider.

Path Parameters

id · string · required

Transfer UUID

Example:

"018f3b2a-0c1d-7a2b-9e4f-1a2b3c4d5e6f"

Body

application/json

Optional cancel reason payload

reason · string

Response

200

application/json

OK

bytesDownloaded · integer<int64> · required

bytesUploaded · integer<int64> · required

createdAt · string<date-time> · required

credentialId · string · required

currentState · string · required

currentStateCode · integer<int64> · required

direction · string · required

documentType · string · required

downloadAttempts · integer<int64> · required

expired · boolean · required

fileName · string · required

fileSizeBytes · integer<int64> · required

hashMismatchAttempts · integer<int64> · required

id · string · required

secondsRemaining · integer<int64> · required

transmissionAttempts · integer<int64> · required

updatedAt · string<date-time> · required

uploadAttempts · integer<int64> · required

errorCode · string

expiresAt · string<date-time>

fileRef · string

lastTransitError · string

protocolGeneratedAt · string<date-time>

protocolNumber · string

sourceProduct · string

urgentRequestedAt · string<date-time>