com.plaid.client.model

Enum CreditBankIncomeCategory

java.lang.Object

java.lang.Enum<CreditBankIncomeCategory>

com.plaid.client.model.CreditBankIncomeCategory

All Implemented Interfaces:

Serializable, Comparable<CreditBankIncomeCategory>

public enum CreditBankIncomeCategory
extends Enum<CreditBankIncomeCategory>

The income category. `BANK_INTEREST`: Interest earned from a bank account. `BENEFIT_OTHER`: Government benefits other than retirement, unemployment, child support, or disability. Currently used only in the UK, to represent benefits such as Cost of Living Payments. `CASH`: Deprecated and used only for existing legacy implementations. Has been replaced by `CASH_DEPOSIT` and `TRANSFER_FROM_APPLICATION`. `CASH_DEPOSIT`: A cash or check deposit. `CHILD_SUPPORT`: Child support payments received. `GIG_ECONOMY`: Income earned as a gig economy worker, e.g. driving for Uber, Lyft, Postmates, DoorDash, etc. `LONG_TERM_DISABILITY`: Disability payments, including Social Security disability benefits. `OTHER`: Income that could not be categorized as any other income category. `MILITARY`: Veterans benefits. Income earned as salary for serving in the military (e.g. through DFAS) will be classified as `SALARY` rather than `MILITARY`. `RENTAL`: Income earned from a rental property. Income may be identified as rental when the payment is received through a rental platform, e.g. Airbnb; rent paid directly by the tenant to the property owner (e.g. via cash, check, or ACH) will typically not be classified as rental income. `RETIREMENT`: Payments from private retirement systems, pensions, and government retirement programs, including Social Security retirement benefits. `SALARY`: Payment from an employer to an earner or other form of permanent employment. `TAX_REFUND`: A tax refund. `TRANSFER_FROM_APPLICATION`: Deposits from a money transfer app, such as Venmo, Cash App, or Zelle. `UNEMPLOYMENT`: Unemployment benefits. In the UK, includes certain low-income benefits such as the Universal Credit.

Nested Class Summary

Nested Classes

Modifier and Type	Class and Description
static class	CreditBankIncomeCategory.Adapter

Enum Constant Summary

Enum Constants

Enum Constant and Description
BANK_INTEREST
BENEFIT_OTHER
CASH
CASH_DEPOSIT
CHILD_SUPPORT
ENUM_UNKNOWN
GIG_ECONOMY
LONG_TERM_DISABILITY
MILITARY
OTHER
RENTAL
RETIREMENT
SALARY
TAX_REFUND
TRANSFER_FROM_APPLICATION
UNEMPLOYMENT

Method Summary

Modifier and Type	Method and Description
static CreditBankIncomeCategory	fromValue(String value)
String	getValue()
String	toString()
static CreditBankIncomeCategory	valueOf(String name) Returns the enum constant of this type with the specified name.
static CreditBankIncomeCategory[]	values() Returns an array containing the constants of this enum type, in the order they are declared.

Methods inherited from class java.lang.Enum

clone, compareTo, equals, finalize, getDeclaringClass, hashCode, name, ordinal, valueOf

Methods inherited from class java.lang.Object

getClass, notify, notifyAll, wait, wait, wait

Enum Constant Detail

SALARY

public static final CreditBankIncomeCategory SALARY

UNEMPLOYMENT

public static final CreditBankIncomeCategory UNEMPLOYMENT

CASH

public static final CreditBankIncomeCategory CASH

GIG_ECONOMY

public static final CreditBankIncomeCategory GIG_ECONOMY

RENTAL

public static final CreditBankIncomeCategory RENTAL

CHILD_SUPPORT

public static final CreditBankIncomeCategory CHILD_SUPPORT

MILITARY

public static final CreditBankIncomeCategory MILITARY

RETIREMENT

public static final CreditBankIncomeCategory RETIREMENT

LONG_TERM_DISABILITY

public static final CreditBankIncomeCategory LONG_TERM_DISABILITY

BANK_INTEREST

public static final CreditBankIncomeCategory BANK_INTEREST

CASH_DEPOSIT

public static final CreditBankIncomeCategory CASH_DEPOSIT

TRANSFER_FROM_APPLICATION

public static final CreditBankIncomeCategory TRANSFER_FROM_APPLICATION

TAX_REFUND

public static final CreditBankIncomeCategory TAX_REFUND

BENEFIT_OTHER

public static final CreditBankIncomeCategory BENEFIT_OTHER

OTHER

public static final CreditBankIncomeCategory OTHER

ENUM_UNKNOWN

public static final CreditBankIncomeCategory ENUM_UNKNOWN

Method Detail

values

public static CreditBankIncomeCategory[] values()

Returns an array containing the constants of this enum type, in the order they are declared. This method may be used to iterate over the constants as follows:

for (CreditBankIncomeCategory c : CreditBankIncomeCategory.values())
    System.out.println(c);

Returns:

an array containing the constants of this enum type, in the order they are declared

valueOf

public static CreditBankIncomeCategory valueOf(String name)

Returns the enum constant of this type with the specified name. The string must match exactly an identifier used to declare an enum constant in this type. (Extraneous whitespace characters are not permitted.)

Parameters:

name - the name of the enum constant to be returned.

Returns:

the enum constant with the specified name

Throws:

IllegalArgumentException - if this enum type has no constant with the specified name

NullPointerException - if the argument is null

getValue

public String getValue()

toString

public String toString()

Overrides:

toString in class Enum<CreditBankIncomeCategory>

fromValue

public static CreditBankIncomeCategory fromValue(String value)