- JSON representation
- AccountBlock
- SourceOfWealthStatus
- SimplifiedSourceOfWealthStatus
- AccountStatus
- AccountStatusReason
- MonetaryLimit
- Limit
- CurrentLimit
JSON representation | |
---|---|
{ "accountBalanceSummary": { object ( |
Fields | ||
---|---|---|
accountBalanceSummary |
DEPRECATED: Up-to-date summary of the customer's account balance. Deprecated due to the balance amounts not containing timestamps. This will be removed before the final version of this spec. Please use |
|
accountBlocks[] |
OPTIONAL: Any Cache-related blocks that the bank has on this account. |
|
sourceOfWealthStatus |
OPTIONAL: The status of the user's progress in providing source of wealth ( |
|
accountStatus |
REQUIRED: Current status of this account. |
|
mobileCheckDepositLimit |
Limits related to depositing checks via a mobile device. |
|
debitCardTopupLimit |
Limits related to funding the Cache account from an external non-Cache account using a debit card. |
|
debitCardFundOutLimit |
Limits related to sending money from the Cache account to an external non-cache account using the debit card associated with that account. |
|
achPullLimit |
Limits related to funding the Cache account from an external non-Cache account using the account and routing number from the non-cache account. |
|
achPushLimit |
Limits related to sending money from the Cache account to an external non-Cache account by using the account and routing number from the non-cache account. |
|
cashWithdrawalLimit |
Limits related to cash withdrawals (including ATM and OTC). |
|
atmWithdrawalLimit |
Limits related to cash withdrawals via ATMs. |
|
accountBalances |
REQUIRED: An up-to-date summary of the customer's account balance. |
|
Union field apr . A union field to ensure an explicit APR case is set in all responses. apr can be only one of the following: |
||
annualPercentageRateInMicros |
The Annual Percentage Rate of the account, in micros of a percent. For example, An APR of 2.25% would be represented as 2_250_000. This value might change depending on the current balance of the account, so the value returned should be relevant for the balance reported in An APR of 0% is valid if the account just happens to have a 0% APR right now. Don't use 0% if the account is not interest bearing in general. Use |
|
accountIsNotInterestBearing |
Indicates this account never bears interest. |
|
Union field apy . A union field to ensure an explicit APY case is set in all responses. apy can be only one of the following: |
||
annualPercentageYieldInMicros |
The Annual Percentage Yield of the account, in micros of a percent. For example, An APY of 2.25% would be represented as 2_250_000. An APY of 0% is valid if the account just happens to have a 0% APY right now. Don't use 0% if the account is not interest bearing in general. Use |
|
accountHasNoApy |
Indicates this account never bears interest. |
AccountBlock
JSON representation | |
---|---|
{ // Union field |
Fields | ||
---|---|---|
Union field
|
||
risk |
The bank's risk systems have flagged an Account as suspicious. |
|
sanctionsBlock |
The user has been blocked from doing business due to a sanctions match. Note: users will be blocked from opening cache accounts if they are sanctioned. This covers the scenario where an existing, previously non-sanctioned user is now covered by sanctions. |
SourceOfWealthStatus
Messages containing the status of the user's progress in providing full source of wealth (advancedSourceOfWealth
) information to the bank.
JSON representation | |
---|---|
{ // Union field |
Fields | ||
---|---|---|
Union field status . The status of the user's progress in providing full source of wealth (advancedSourceOfWealth ) information to the bank. status can be only one of the following: |
||
advancedSourceOfWealthStatus |
The user's |
|
simplifiedSourceOfWealthStatus |
The user has not provided the complete |
SimplifiedSourceOfWealthStatus
Messages containing the user's standing given that they have only provided partial source of wealth (sourceOfWealth
) information to the bank.
JSON representation | |
---|---|
{ // Union field |
Fields | ||
---|---|---|
Union field status . The user's standing in providing partial source of wealth (sourceOfWealth ) information to the bank. status can be only one of the following: |
||
inGoodStanding |
The user is in good standing. |
|
inWarningPeriod |
The user is within the warning period. The user should be prompted to provide the complete |
|
inGracePeriod |
The user is still within the grace period. The user should be prompted to provide the complete |
|
inBlockedPeriod |
The user is within the blocked period and some account features have been blocked. The user should be prompted to provide the complete |
AccountStatus
Message containing the status of this account.
JSON representation | |
---|---|
{ // Union field |
Fields | ||
---|---|---|
Union field status . The status of this account. status can be only one of the following: |
||
open |
This account is open. |
|
postNoCredit |
No credits can be posted to this account. |
|
postNoDebit |
No debits can be posted to this account. |
|
blocked |
This account is blocked. |
|
closed |
This account has been closed. |
|
blockedPendingClosure |
This account is blocked due to an impending closure. |
AccountStatusReason
Message containing the reason why the account is in its current state.
JSON representation | |
---|---|
{ // Union field |
Fields | ||
---|---|---|
Union field reason . The reason why the account is in its current state. reason can be only one of the following: |
||
fraud |
The account's current state is due to suspected fraudulent activity. |
|
compliance |
The account's current state is due to compliance issues. |
|
sanctions |
Sanctions have been imposed on this account. |
|
legal |
The account's current state is due to legal reasons. |
|
other |
Any reason that does not fit into the buckets above. |
MonetaryLimit
Contains details regarding total, remaining, and existence of limits pertaining to monetary amounts.
JSON representation | |
---|---|
{ "dailyLimit": { object ( |
Fields | |
---|---|
dailyLimit |
The limits per day. |
thirtyDayRollingLimit |
The limits within a rolling 30-day cycle. |
Limit
Details regarding whether a limit is required and if so, the total and remaining limit values.
JSON representation | |
---|---|
{ // Union field |
Fields | ||
---|---|---|
Union field
|
||
noLimit |
There are no limits specified. |
|
limit |
The total and remaining monetary limits. |
CurrentLimit
Details regarding total and remaining monetary limits.
JSON representation | |
---|---|
{ "remaining": { object ( |
Fields | |
---|---|
remaining |
The remaining amount allowed within a certain time period. |
total |
The absolute total amount allowed within a certain time period. |