Cancel a non-terminal transfer
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>"
}
'import requests
url = "https://sta.sandbox.lerian.net/v1/transfers/{id}/cancel"
payload = { "reason": "<string>" }
headers = {
"Authorization": "Bearer <token>",
"Content-Type": "application/json"
}
response = requests.post(url, json=payload, headers=headers)
print(response.text)const options = {
method: 'POST',
headers: {Authorization: 'Bearer <token>', 'Content-Type': 'application/json'},
body: JSON.stringify({reason: '<string>'})
};
fetch('https://sta.sandbox.lerian.net/v1/transfers/{id}/cancel', options)
.then(res => res.json())
.then(res => console.log(res))
.catch(err => console.error(err));<?php
$curl = curl_init();
curl_setopt_array($curl, [
CURLOPT_URL => "https://sta.sandbox.lerian.net/v1/transfers/{id}/cancel",
CURLOPT_RETURNTRANSFER => true,
CURLOPT_ENCODING => "",
CURLOPT_MAXREDIRS => 10,
CURLOPT_TIMEOUT => 30,
CURLOPT_HTTP_VERSION => CURL_HTTP_VERSION_1_1,
CURLOPT_CUSTOMREQUEST => "POST",
CURLOPT_POSTFIELDS => json_encode([
'reason' => '<string>'
]),
CURLOPT_HTTPHEADER => [
"Authorization: Bearer <token>",
"Content-Type: application/json"
],
]);
$response = curl_exec($curl);
$err = curl_error($curl);
curl_close($curl);
if ($err) {
echo "cURL Error #:" . $err;
} else {
echo $response;
}package main
import (
"fmt"
"strings"
"net/http"
"io"
)
func main() {
url := "https://sta.sandbox.lerian.net/v1/transfers/{id}/cancel"
payload := strings.NewReader("{\n \"reason\": \"<string>\"\n}")
req, _ := http.NewRequest("POST", url, payload)
req.Header.Add("Authorization", "Bearer <token>")
req.Header.Add("Content-Type", "application/json")
res, _ := http.DefaultClient.Do(req)
defer res.Body.Close()
body, _ := io.ReadAll(res.Body)
fmt.Println(string(body))
}HttpResponse<String> response = Unirest.post("https://sta.sandbox.lerian.net/v1/transfers/{id}/cancel")
.header("Authorization", "Bearer <token>")
.header("Content-Type", "application/json")
.body("{\n \"reason\": \"<string>\"\n}")
.asString();require 'uri'
require 'net/http'
url = URI("https://sta.sandbox.lerian.net/v1/transfers/{id}/cancel")
http = Net::HTTP.new(url.host, url.port)
http.use_ssl = true
request = Net::HTTP::Post.new(url)
request["Authorization"] = 'Bearer <token>'
request["Content-Type"] = 'application/json'
request.body = "{\n \"reason\": \"<string>\"\n}"
response = http.request(request)
puts response.read_body{
"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"
}{
"code": "<string>",
"detail": "<string>",
"errors": [
{
"location": "<string>",
"message": "<string>",
"value": "<unknown>"
}
],
"instance": "<string>",
"status": 123,
"title": "<string>",
"type": "about:blank"
}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 --request POST \
--url https://sta.sandbox.lerian.net/v1/transfers/{id}/cancel \
--header 'Authorization: Bearer <token>' \
--header 'Content-Type: application/json' \
--data '
{
"reason": "<string>"
}
'import requests
url = "https://sta.sandbox.lerian.net/v1/transfers/{id}/cancel"
payload = { "reason": "<string>" }
headers = {
"Authorization": "Bearer <token>",
"Content-Type": "application/json"
}
response = requests.post(url, json=payload, headers=headers)
print(response.text)const options = {
method: 'POST',
headers: {Authorization: 'Bearer <token>', 'Content-Type': 'application/json'},
body: JSON.stringify({reason: '<string>'})
};
fetch('https://sta.sandbox.lerian.net/v1/transfers/{id}/cancel', options)
.then(res => res.json())
.then(res => console.log(res))
.catch(err => console.error(err));<?php
$curl = curl_init();
curl_setopt_array($curl, [
CURLOPT_URL => "https://sta.sandbox.lerian.net/v1/transfers/{id}/cancel",
CURLOPT_RETURNTRANSFER => true,
CURLOPT_ENCODING => "",
CURLOPT_MAXREDIRS => 10,
CURLOPT_TIMEOUT => 30,
CURLOPT_HTTP_VERSION => CURL_HTTP_VERSION_1_1,
CURLOPT_CUSTOMREQUEST => "POST",
CURLOPT_POSTFIELDS => json_encode([
'reason' => '<string>'
]),
CURLOPT_HTTPHEADER => [
"Authorization: Bearer <token>",
"Content-Type: application/json"
],
]);
$response = curl_exec($curl);
$err = curl_error($curl);
curl_close($curl);
if ($err) {
echo "cURL Error #:" . $err;
} else {
echo $response;
}package main
import (
"fmt"
"strings"
"net/http"
"io"
)
func main() {
url := "https://sta.sandbox.lerian.net/v1/transfers/{id}/cancel"
payload := strings.NewReader("{\n \"reason\": \"<string>\"\n}")
req, _ := http.NewRequest("POST", url, payload)
req.Header.Add("Authorization", "Bearer <token>")
req.Header.Add("Content-Type", "application/json")
res, _ := http.DefaultClient.Do(req)
defer res.Body.Close()
body, _ := io.ReadAll(res.Body)
fmt.Println(string(body))
}HttpResponse<String> response = Unirest.post("https://sta.sandbox.lerian.net/v1/transfers/{id}/cancel")
.header("Authorization", "Bearer <token>")
.header("Content-Type", "application/json")
.body("{\n \"reason\": \"<string>\"\n}")
.asString();require 'uri'
require 'net/http'
url = URI("https://sta.sandbox.lerian.net/v1/transfers/{id}/cancel")
http = Net::HTTP.new(url.host, url.port)
http.use_ssl = true
request = Net::HTTP::Post.new(url)
request["Authorization"] = 'Bearer <token>'
request["Content-Type"] = 'application/json'
request.body = "{\n \"reason\": \"<string>\"\n}"
response = http.request(request)
puts response.read_body{
"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"
}{
"code": "<string>",
"detail": "<string>",
"errors": [
{
"location": "<string>",
"message": "<string>",
"value": "<unknown>"
}
],
"instance": "<string>",
"status": 123,
"title": "<string>",
"type": "about:blank"
}Authorizations
JWT bearer token issued by the identity provider.
Path Parameters
Transfer UUID
Example:
"018f3b2a-0c1d-7a2b-9e4f-1a2b3c4d5e6f"
Body
application/json
Optional cancel reason payload
Response
OK
Was this page helpful?
⌘I