Mark an inbound transfer for urgent processing

curl --request POST \
  --url https://sta.sandbox.lerian.net/v1/inbound/transfers/{id}/mark-urgent \
  --header 'Authorization: Bearer <token>'

import requests

url = "https://sta.sandbox.lerian.net/v1/inbound/transfers/{id}/mark-urgent"

headers = {"Authorization": "Bearer <token>"}

response = requests.post(url, headers=headers)

print(response.text)

const options = {method: 'POST', headers: {Authorization: 'Bearer <token>'}};

fetch('https://sta.sandbox.lerian.net/v1/inbound/transfers/{id}/mark-urgent', 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/inbound/transfers/{id}/mark-urgent",
  CURLOPT_RETURNTRANSFER => true,
  CURLOPT_ENCODING => "",
  CURLOPT_MAXREDIRS => 10,
  CURLOPT_TIMEOUT => 30,
  CURLOPT_HTTP_VERSION => CURL_HTTP_VERSION_1_1,
  CURLOPT_CUSTOMREQUEST => "POST",
  CURLOPT_HTTPHEADER => [
    "Authorization: Bearer <token>"
  ],
]);

$response = curl_exec($curl);
$err = curl_error($curl);

curl_close($curl);

if ($err) {
  echo "cURL Error #:" . $err;
} else {
  echo $response;
}

package main

import (
	"fmt"
	"net/http"
	"io"
)

func main() {

	url := "https://sta.sandbox.lerian.net/v1/inbound/transfers/{id}/mark-urgent"

	req, _ := http.NewRequest("POST", url, nil)

	req.Header.Add("Authorization", "Bearer <token>")

	res, _ := http.DefaultClient.Do(req)

	defer res.Body.Close()
	body, _ := io.ReadAll(res.Body)

	fmt.Println(string(body))

}

require 'uri'
require 'net/http'

url = URI("https://sta.sandbox.lerian.net/v1/inbound/transfers/{id}/mark-urgent")

http = Net::HTTP.new(url.host, url.port)
http.use_ssl = true

request = Net::HTTP::Post.new(url)
request["Authorization"] = 'Bearer <token>'

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"
}

POST

inbound

transfers

{id}

mark-urgent

Mark an inbound transfer for urgent processing

curl --request POST \
  --url https://sta.sandbox.lerian.net/v1/inbound/transfers/{id}/mark-urgent \
  --header 'Authorization: Bearer <token>'

import requests

url = "https://sta.sandbox.lerian.net/v1/inbound/transfers/{id}/mark-urgent"

headers = {"Authorization": "Bearer <token>"}

response = requests.post(url, headers=headers)

print(response.text)

const options = {method: 'POST', headers: {Authorization: 'Bearer <token>'}};

fetch('https://sta.sandbox.lerian.net/v1/inbound/transfers/{id}/mark-urgent', 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/inbound/transfers/{id}/mark-urgent",
  CURLOPT_RETURNTRANSFER => true,
  CURLOPT_ENCODING => "",
  CURLOPT_MAXREDIRS => 10,
  CURLOPT_TIMEOUT => 30,
  CURLOPT_HTTP_VERSION => CURL_HTTP_VERSION_1_1,
  CURLOPT_CUSTOMREQUEST => "POST",
  CURLOPT_HTTPHEADER => [
    "Authorization: Bearer <token>"
  ],
]);

$response = curl_exec($curl);
$err = curl_error($curl);

curl_close($curl);

if ($err) {
  echo "cURL Error #:" . $err;
} else {
  echo $response;
}

package main

import (
	"fmt"
	"net/http"
	"io"
)

func main() {

	url := "https://sta.sandbox.lerian.net/v1/inbound/transfers/{id}/mark-urgent"

	req, _ := http.NewRequest("POST", url, nil)

	req.Header.Add("Authorization", "Bearer <token>")

	res, _ := http.DefaultClient.Do(req)

	defer res.Body.Close()
	body, _ := io.ReadAll(res.Body)

	fmt.Println(string(body))

}

require 'uri'
require 'net/http'

url = URI("https://sta.sandbox.lerian.net/v1/inbound/transfers/{id}/mark-urgent")

http = Net::HTTP.new(url.host, url.port)
http.use_ssl = true

request = Net::HTTP::Post.new(url)
request["Authorization"] = 'Bearer <token>'

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

Authorization

string

header

required

JWT bearer token issued by the identity provider.

Path Parameters

string

required

Inbound transfer UUID

Example:

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

Response

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

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>

⌘I

Pix — Lerian SPI (native messaging)

Pix — JD (interface, direct)

Pix — BTG (interface, indirect)

TED — Lerian SPB (native messaging)

TED — JD (interface)

Boletos — BTG (interface)

Lerian SILOC (native messaging)

Lerian SLC (native messaging)

Lerian STA (native messaging)

Lerian SISBAJUD (native messaging)

Lerian Consignado (native messaging)

Mark an inbound transfer for urgent processing

Authorizations

Path Parameters

Response