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
Property | Data Type (length) | Description |
---|---|---|
availabilityAmounts | array | An array of availabilityAmount objects. |
availabilityCode | string | Availability Code that was used to determine Partial Deposit Availability windows. |
totalReleasedAmount | decimal | Total released deposit amount. |
totalRemainingAmount | decimal | Total 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.
Property | Data Type (length) | Description |
---|---|---|
availableDate | datetime | Date and time deposit amount will be made available. Returned in time zone local to the bank. |
effectiveAvailableDate | datetime | This will be the value of availableDate unless overrideAvailableDate was set. Returned in time zone local to the bank. |
isReleased | boolean | true if this availability window deposit amount has been releases. When true , releasedDate will also be returned. |
overrideAvailableDate | datetime | Override 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. |
releaseAmount | decimal | The amount of total deposit amount that will be or has been released as part of this availability window/record. |
releasedDate | datetime | The 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. |
remainingAmount | decimal | Total remaining amount of the total deposit amoun to be released in subsequent deposit availability windows. |
Updated 11 months ago