Skip to main content
GET
Get exposure settings

Authorizations

Authorization
string
header
required

Application (M2M) OAuth2 access token (client credentials).

Path Parameters

bankOrganizationId
string<uuid>
required

The Bank's organization ID.

Response

Returns the Bank's exposure settings.

A Bank's exposure settings and its current Limit Exposure.

alertLevels
(integer<int32> | string<int32>)[]
required

The Alert Levels, as whole percentages of the threshold, lowest first. 100 is always on and is not listed.

bankOrganizationId
string<uuid>
required

The Bank the settings belong to.

limitExposure
object
required

The sum of the Effective Limits of every open bank account at the Bank, whatever has been sent. An account whose limit does not resolve adds nothing.

recipients
string[]
required

The email addresses alerted when Limit Exposure crosses an Alert Level.

limitDaySettings
null | object

When the Bank's Limit Day resets. A Bank Tesouro has not configured resets at 00:00 America/New_York. Absent while the Bank's Limit Day settings cannot be read, when its Instant Payments are refused.

threshold
null | object

The Exposure Threshold. Absent until the Bank sets one; without it no alert is sent.