Skip to main content
GET
Get moratory interest

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.