Skip to main content
GET
Get bank account limit

Authorizations

Authorization
string
header
required

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

Path Parameters

id
string<uuid>
required

The bank account ID.

Response

Returns the bank account's Instant Payment limit.

A bank account's daily Instant Payment limit, shared by RTP and FedNow, and how much of it today's Instant Payments have used.

limitDayEndsAt
string<date-time>
required

When the current Limit Day ends and Usage starts again (UTC).

usage
object
required

The Instant Payments counted against the limit in the current Limit Day.

accountOverride
null | object

The bank account's own Account Override, which is then its Effective Limit. Absent when it has none.

effectiveLimit
null | object

The daily limit that applies to the bank account now. Absent when no limit resolves for it.

remaining
null | object

How much of the Effective Limit is left today, never below zero. Absent when no limit resolves.

source
null | enum<string>

Where the Effective Limit comes from. Absent when no limit resolves.

Available options:
ACCOUNT_OVERRIDE,
VSP_DEFAULT,
PLATFORM_DEFAULT