Get dashboard summary

curl --request GET \
  --url https://ted.sandbox.lerian.net/v1/transfers/dashboard/summary \
  --header 'Authorization: Bearer <token>' \
  --header 'X-Organization-Id: <x-organization-id>'

import requests

url = "https://ted.sandbox.lerian.net/v1/transfers/dashboard/summary"

headers = {
    "X-Organization-Id": "<x-organization-id>",
    "Authorization": "Bearer <token>"
}

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

print(response.text)

const options = {
  method: 'GET',
  headers: {'X-Organization-Id': '<x-organization-id>', Authorization: 'Bearer <token>'}
};

fetch('https://ted.sandbox.lerian.net/v1/transfers/dashboard/summary', 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://ted.sandbox.lerian.net/v1/transfers/dashboard/summary",
  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: Bearer <token>",
    "X-Organization-Id: <x-organization-id>"
  ],
]);

$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://ted.sandbox.lerian.net/v1/transfers/dashboard/summary"

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

	req.Header.Add("X-Organization-Id", "<x-organization-id>")
	req.Header.Add("Authorization", "Bearer <token>")

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

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

	fmt.Println(string(body))

}

HttpResponse<String> response = Unirest.get("https://ted.sandbox.lerian.net/v1/transfers/dashboard/summary")
  .header("X-Organization-Id", "<x-organization-id>")
  .header("Authorization", "Bearer <token>")
  .asString();

require 'uri'
require 'net/http'

url = URI("https://ted.sandbox.lerian.net/v1/transfers/dashboard/summary")

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

request = Net::HTTP::Get.new(url)
request["X-Organization-Id"] = '<x-organization-id>'
request["Authorization"] = 'Bearer <token>'

response = http.request(request)
puts response.read_body

{
  "contractVersion": "v1",
  "totalTransfers": 128,
  "byStatus": [
    {
      "status": "COMPLETED",
      "count": 101
    }
  ],
  "byType": [
    {
      "type": "TED_OUT",
      "count": 97
    }
  ],
  "health": {
    "status": "UP",
    "pendingCount": 0,
    "processingCount": 7,
    "terminalCount": 121,
    "failureCount": 20,
    "terminalFailRate": 0.1653
  },
  "generatedAt": "2026-02-01T12:00:00-03:00",
  "degraded": false,
  "degradationReasons": [
    "<string>"
  ]
}

GET

transfers

dashboard

summary

Get dashboard summary

curl --request GET \
  --url https://ted.sandbox.lerian.net/v1/transfers/dashboard/summary \
  --header 'Authorization: Bearer <token>' \
  --header 'X-Organization-Id: <x-organization-id>'

import requests

url = "https://ted.sandbox.lerian.net/v1/transfers/dashboard/summary"

headers = {
    "X-Organization-Id": "<x-organization-id>",
    "Authorization": "Bearer <token>"
}

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

print(response.text)

const options = {
  method: 'GET',
  headers: {'X-Organization-Id': '<x-organization-id>', Authorization: 'Bearer <token>'}
};

fetch('https://ted.sandbox.lerian.net/v1/transfers/dashboard/summary', 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://ted.sandbox.lerian.net/v1/transfers/dashboard/summary",
  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: Bearer <token>",
    "X-Organization-Id: <x-organization-id>"
  ],
]);

$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://ted.sandbox.lerian.net/v1/transfers/dashboard/summary"

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

	req.Header.Add("X-Organization-Id", "<x-organization-id>")
	req.Header.Add("Authorization", "Bearer <token>")

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

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

	fmt.Println(string(body))

}

HttpResponse<String> response = Unirest.get("https://ted.sandbox.lerian.net/v1/transfers/dashboard/summary")
  .header("X-Organization-Id", "<x-organization-id>")
  .header("Authorization", "Bearer <token>")
  .asString();

require 'uri'
require 'net/http'

url = URI("https://ted.sandbox.lerian.net/v1/transfers/dashboard/summary")

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

request = Net::HTTP::Get.new(url)
request["X-Organization-Id"] = '<x-organization-id>'
request["Authorization"] = 'Bearer <token>'

response = http.request(request)
puts response.read_body

{
  "contractVersion": "v1",
  "totalTransfers": 128,
  "byStatus": [
    {
      "status": "COMPLETED",
      "count": 101
    }
  ],
  "byType": [
    {
      "type": "TED_OUT",
      "count": 97
    }
  ],
  "health": {
    "status": "UP",
    "pendingCount": 0,
    "processingCount": 7,
    "terminalCount": 121,
    "failureCount": 20,
    "terminalFailRate": 0.1653
  },
  "generatedAt": "2026-02-01T12:00:00-03:00",
  "degraded": false,
  "degradationReasons": [
    "<string>"
  ]
}

Authorizations

Authorization

string

header

required

JWT Bearer token authentication. The tenantId is derived from the bearer token or authenticated request context and is not supplied through X-Organization-Id.

Headers

X-Organization-Id

string<uuid>

required

Midaz organization scope for the request, used for downstream CRM, Fees, and Midaz calls. Required on org-scoped transfer routes in every deployment mode; a missing or non-UUID value returns 400. This is not the tenant identifier — tenantId is derived from the bearer JWT or authenticated context, never from this header. Background workers (TED IN poller, reconciliation) have no request header and, in single-tenant mode, fall back to the deployment's ORGANIZATION_ID env.

Response

Dashboard summary returned successfully.

contractVersion

string

Version of the dashboard response contract.

Example:

"v1"

totalTransfers

integer

Total number of transfers in the period.

Example:

128

byStatus

object[]

Transfer count grouped by status.

Show child attributes

byType

object[]

Transfer count grouped by type.

Show child attributes

health

object

Operational health snapshot.

Show child attributes

generatedAt

string<date-time>

Timestamp when the summary was generated.

Example:

"2026-02-01T12:00:00-03:00"

degraded

boolean

Whether the system is in a degraded state.

Example:

false

degradationReasons

string[]

List of degradation reasons when degraded is true.

Cancel a Transfer

List pending reconciliation transfers

⌘I