Deposit Availability

The depositAvailability object shows totals and individual deposit availability window records for when and how much of a deposit has been released and is available in the account.

depositAvailability Object

PropertyData Type (length)Description
availabilityAmountsarrayAn array of availabilityAmount objects.
availabilityCodestringAvailability Code that was used to determine Partial Deposit Availability windows.
totalReleasedAmountdecimalTotal released deposit amount.
totalRemainingAmountdecimalTotal remaining deposit amount that has not been released yet.

availabilityAmount Object

Deposit availability object shows individual deposit availability window record for when and how much of a deposit has been released and is available in the account.

PropertyData Type (length)Description
availableDatedatetimeDate and time deposit amount will be made available. Returned in time zone local to the bank.
effectiveAvailableDatedatetimeThis will be the value of availableDate unless overrideAvailableDate was set. Returned in time zone local to the bank.
isReleasedbooleantrue if this availability window deposit amount has been releases. When true, releasedDate will also be returned.
overrideAvailableDatedatetimeOverride date and time deposit amount will be made available. Returned in time zone local to the bank. This field is only present if someone does set this override date.
releaseAmountdecimalThe amount of total deposit amount that will be or has been released as part of this availability window/record.
releasedDatedatetimeThe exact date and time deposit amount was released. Returned in time zone local to the bank. This field is not returned until amount has been released.
remainingAmountdecimalTotal remaining amount of the total deposit amoun to be released in subsequent deposit availability windows.