Post External Bank Account Balance

RocketKOR does not maintain a ledger or track account balances for external Financial Accounts, as these accounts are managed by outside financial institutions.

You can track the balance of an external bank Financial Account by posting it to RocketKOR. This balance will be used by RocketKOR to ensure there are sufficient funds to process scheduled transactions.

Note To stop tracking the account balance, invoke the Delete External Bank Account Balance API.

Endpoint

POST /v1/external-bank-accounts/{financialAccountId}/external-balance

Authorization Header

Authorization: Bearer <access_token>

Path Parameters

financialAccountId REQUIRED

string (UUID)

ID of the Financial Account.

Request Body

amount REQUIRED

string (decimal)

Account balance as reported by the external aggregation service.

effectiveAt

string (date-time)

Effective date and time of the account balance.

Returns

If successful, returns 201 External balance has been recorded.

SAMPLE REQUEST

				
					{
  "amount": "2500.00",
  "effectiveAt": "2023-10-31T03:15:09.275Z"
}

SAMPLE RESPONSE

				
					{
  201 External balance has been recorded
}