Skip to main content
PUT
Set organization limit

Authorizations

Authorization
string
header
required

User OAuth2 access token (authorization code with PKCE).

Path Parameters

organizationId
string<uuid>
required

The Platform's or VSP's organization ID.

Body

Request model for setting a daily Instant Payment limit, shared by RTP and FedNow.

amount
required

The daily limit in the currency's minor units (e.g. cents for USD). Zero stops Instant Payments; it must not be negative.

reason
string
required

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

currencyCode
string
default:USD

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

Response

The default was set.

The daily Instant Payment limit a Platform or VSP gives every bank account beneath it. A VSP beneath a Platform without a default of its own follows the Platform's.

organizationId
string<uuid>
required

The organization the default belongs to.

defaultLimit
null | object

The organization's own default. Absent when it has none.

platformDefaultLimit
null | object

The Platform's default. Absent when the organization is not a VSP beneath a Platform, or the Platform has none.

platformOrganizationId
null | string<uuid>

The Platform above the VSP, whose default the VSP follows while it has none of its own. Absent for a Platform and for a VSP not beneath a Platform, whose own default is required and cannot be reset.