Skip to main content
GET
/
entities
/
{entityId}
/
insights
/
moratory-interest
Get moratory interest
curl --request GET \
  --url https://api.syntage.com/entities/{entityId}/insights/moratory-interest \
  --header 'X-API-Key: <api-key>'
import requests

url = "https://api.syntage.com/entities/{entityId}/insights/moratory-interest"

headers = {"X-API-Key": "<api-key>"}

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

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

fetch('https://api.syntage.com/entities/{entityId}/insights/moratory-interest', 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://api.syntage.com/entities/{entityId}/insights/moratory-interest",
CURLOPT_RETURNTRANSFER => true,
CURLOPT_ENCODING => "",
CURLOPT_MAXREDIRS => 10,
CURLOPT_TIMEOUT => 30,
CURLOPT_HTTP_VERSION => CURL_HTTP_VERSION_1_1,
CURLOPT_CUSTOMREQUEST => "GET",
CURLOPT_HTTPHEADER => [
"X-API-Key: <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://api.syntage.com/entities/{entityId}/insights/moratory-interest"

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

req.Header.Add("X-API-Key", "<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://api.syntage.com/entities/{entityId}/insights/moratory-interest")
.header("X-API-Key", "<api-key>")
.asString();
require 'uri'
require 'net/http'

url = URI("https://api.syntage.com/entities/{entityId}/insights/moratory-interest")

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

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

response = http.request(request)
puts response.read_body
{
  "summary": {
    "lastMonthTotal": 1250.75,
    "threeMonthAverage": 940.25,
    "twelveMonthTotal": 18250.5,
    "yoyThreeMonthPercentage": 18.45,
    "lastMonthVsThreeMonthPercentage": 33.02,
    "trendPercentage": 12.3,
    "isRecurring": true,
    "institutionCount": 2,
    "periodTotal": 18250.5,
    "periodInstitutionCount": 2,
    "periodFrom": "2025-01-01",
    "periodTo": "2025-12-31"
  },
  "monthly": [
    {
      "date": "2025-01-01",
      "totalAmount": 1250.75
    }
  ],
  "monthlyByInstitution": [
    {
      "date": "2025-01-01",
      "issuerRfc": "PEIC211118IS0",
      "issuerName": "BANCO EJEMPLO SA",
      "legalName": "BANCO EJEMPLO SA INSTITUCION DE BANCA MULTIPLE",
      "tradeName": "Banco Ejemplo",
      "totalAmount": 1250.75
    }
  ],
  "institutions": [
    {
      "issuerRfc": "PEIC211118IS0",
      "issuerName": "BANCO EJEMPLO SA",
      "legalName": "BANCO EJEMPLO SA INSTITUCION DE BANCA MULTIPLE",
      "tradeName": "Banco Ejemplo",
      "totalAmount": 18250.5
    }
  ]
}
{
"message": "<string>"
}
{
"message": "<string>"
}

Authorizations

X-API-Key
string
header
required

Your API key is available in the Production and Sandbox dashboards.

Path Parameters

entityId
string<uuid>
required

Query Parameters

options[from]
string<date-time>

Start date of the period to analyze.

Example:

"2025-01-01T00:00:00.000Z"

options[to]
string<date-time>

End date of the period to analyze.

Example:

"2025-12-31T23:59:59.999Z"

Response

Moratory Interest

summary
object

Summary KPIs for moratory-interest charges.

monthly
object[]

Monthly moratory-interest totals for the selected period.

monthlyByInstitution
object[]

Monthly moratory-interest totals broken down by financial institution.

institutions
object[]

Financial institution aggregates over the 12-month window, sorted by total amount descending.