Get funding account balance - V1

The Funding Account Balance API allows authorized bank users to retrieve the balance of their funding accounts maintained with the Federal Reserve (Fed) or The Clearing House (TCH).

This API helps banks monitor available liquidity and make informed funding decisions to support payment processing.

The service is applicable from 6.3.2.0 release.

SecurityoAuth2
Request
path Parameters
fundingAccount
required
string [ 1 .. 20 ] characters

Identifier of the funding account to look up.

Responses
200

OK (200). The funding account balance was retrieved.

400

Invalid path parameter, or a validation failure reported by the downstream liquidity service.

Code Meaning
FUND_ACC_REQUIRED fundingAccount is missing or blank.
FUND_ACC_MAX fundingAccount exceeds 20 characters.
FUND_BALANCE_NOTFOUND The downstream liquidity service returned no balance for the account.

Error codes are not a closed enumeration.

401

Unauthorized (401). The request does not contain a valid Bearer JWT access token. No response body is returned.

403

Caller lacks the required authority, or the calling organization is missing or inactive.

500

An unexpected error occurred while processing the request.

get/v1/liquidity/funding-account/{fundingAccount}/balance
Request samples
Response samples
application/json
{
  • "accountBalance": 125000.55
}