Skip to main content
PUT
Set exposure settings

Authorizations

Authorization
string
header
required

User OAuth2 access token (authorization code with PKCE).

Path Parameters

bankOrganizationId
string<uuid>
required

The Bank's organization ID.

Body

Request model for setting a Bank's Exposure Threshold, Alert Levels, and alert recipients. Replaces every setting.

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

Up to three unique Alert Levels, as whole percentages of the threshold from 1 to 99. 100 is always on and is not sent. An empty list leaves only 100.

reason
string
required

Why the settings are changing, recorded in the limit-change history. A ticket reference is enough.

recipients
string[]
required

Up to ten unique email addresses to alert when Limit Exposure crosses an Alert Level. May be empty.

threshold
required

The Exposure Threshold in the currency's minor units (e.g. cents for USD). It must be positive.

currencyCode
string
default:USD

ISO 4217 alphabetic currency code of the threshold. Only USD is accepted. Defaults to USD when omitted.

Response

The settings were set.

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.