Skip to main content
POST
Preview limit change

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

A Platform Default, VSP Default or Account Override to preview, or its reset. Name one target.

amount

The proposed daily limit in the currency's minor units (e.g. cents for USD). Zero stops Instant Payments; it must not be negative. Leave it out to preview a reset: the bank accounts then follow the default above.

currencyCode
string
default:USD

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

targetBankAccountId
null | string<uuid>

The bank account whose Account Override is proposed. Give this or targetOrganizationId, not both.

targetOrganizationId
null | string<uuid>

The Platform or VSP whose default is proposed. Give this or targetBankAccountId, not both.

Response

Returns the proposal's effect on Limit Exposure.

What a proposed limit change would do to the Bank's Limit Exposure, and the Alert Levels it would cross. Nothing is saved.

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

The Alert Levels, and 100, that the change would take Limit Exposure from below to at or above, lowest first. Made, the change would alert the Bank naming them. Empty when it crosses none.

currentLimitExposure
object
required

The sum of the Effective Limits of every open bank account at the Bank, as they stand. An account whose limit does not resolve adds nothing.

projectedLimitExposure
object
required

The same sum were the change made.

organization
null | object

For a proposed Platform Default or VSP Default, or its reset, the open bank accounts beneath that Platform or VSP. Absent for an Account Override.

threshold
null | object

The Exposure Threshold. Absent until the Bank sets one; without it no Alert Level is crossed.