Skip to main content
GET
/
v1
/
transfers
List transfers
curl --request GET \
  --url https://sta.sandbox.lerian.net/v1/transfers \
  --header 'Authorization: <api-key>'
import requests

url = "https://sta.sandbox.lerian.net/v1/transfers"

headers = {"Authorization": "<api-key>"}

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

print(response.text)
const options = {method: 'GET', headers: {Authorization: '<api-key>'}};

fetch('https://sta.sandbox.lerian.net/v1/transfers', 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",
CURLOPT_RETURNTRANSFER => true,
CURLOPT_ENCODING => "",
CURLOPT_MAXREDIRS => 10,
CURLOPT_TIMEOUT => 30,
CURLOPT_HTTP_VERSION => CURL_HTTP_VERSION_1_1,
CURLOPT_CUSTOMREQUEST => "GET",
CURLOPT_HTTPHEADER => [
"Authorization: <api-key>"
],
]);

$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/transfers"

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

req.Header.Add("Authorization", "<api-key>")

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

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

fmt.Println(string(body))

}
HttpResponse<String> response = Unirest.get("https://sta.sandbox.lerian.net/v1/transfers")
.header("Authorization", "<api-key>")
.asString();
require 'uri'
require 'net/http'

url = URI("https://sta.sandbox.lerian.net/v1/transfers")

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

request = Net::HTTP::Get.new(url)
request["Authorization"] = '<api-key>'

response = http.request(request)
puts response.read_body
{
  "hasMore": true,
  "items": [
    {
      "bytesDownloaded": 123,
      "bytesUploaded": 123,
      "createdAt": "<string>",
      "credentialId": "<string>",
      "currentState": "<string>",
      "currentStateCode": 123,
      "direction": "<string>",
      "documentType": "<string>",
      "downloadAttempts": 123,
      "errorCode": "<string>",
      "expired": true,
      "expiresAt": "<string>",
      "fileName": "<string>",
      "fileRef": "<string>",
      "fileSizeBytes": 123,
      "hashMismatchAttempts": 123,
      "id": "<string>",
      "lastTransitError": "<string>",
      "protocolGeneratedAt": "<string>",
      "protocolNumber": "<string>",
      "secondsRemaining": 123,
      "sourceProduct": "<string>",
      "transmissionAttempts": 123,
      "updatedAt": "<string>",
      "uploadAttempts": 123,
      "urgentRequestedAt": "<string>"
    }
  ],
  "nextCursor": "<string>",
  "pageSize": 123
}
{}
{}
{}

Authorizations

Authorization
string
header
required

Bearer token authentication (format: "Bearer {token}")

Query Parameters

state
string

filter by state name

direction
string

outbound | inbound

sourceProduct
string

filter by source_product

cursor
string

opaque continuation cursor

pageSize
integer

page size (1..100)

Response

OK

hasMore
boolean
items
object[]
nextCursor
string
pageSize
integer