java.lang.Object

com.plaid.client.model.DepositSwitchGetResponse

@Generated(value="org.openapitools.codegen.languages.JavaClientCodegen",
           date="2021-10-15T19:47:39.714Z[GMT]")
public class DepositSwitchGetResponse
extends java.lang.Object

DepositSwitchGetResponse defines the response schema for `/deposit_switch/get`

Nested Class Summary

Nested Classes
Modifier and Type	Class	Description
`static class`	`DepositSwitchGetResponse.StateEnum`	The state, or status, of the deposit switch.
`static class`	`DepositSwitchGetResponse.SwitchMethodEnum`	The method used to make the deposit switch.

Field Summary

Fields
Modifier and Type	Field	Description
`static java.lang.String`	`SERIALIZED_NAME_ACCOUNT_HAS_MULTIPLE_ALLOCATIONS`
`static java.lang.String`	`SERIALIZED_NAME_AMOUNT_ALLOCATED`
`static java.lang.String`	`SERIALIZED_NAME_DATE_COMPLETED`
`static java.lang.String`	`SERIALIZED_NAME_DATE_CREATED`
`static java.lang.String`	`SERIALIZED_NAME_DEPOSIT_SWITCH_ID`
`static java.lang.String`	`SERIALIZED_NAME_EMPLOYER_ID`
`static java.lang.String`	`SERIALIZED_NAME_EMPLOYER_NAME`
`static java.lang.String`	`SERIALIZED_NAME_INSTITUTION_ID`
`static java.lang.String`	`SERIALIZED_NAME_INSTITUTION_NAME`
`static java.lang.String`	`SERIALIZED_NAME_IS_ALLOCATED_REMAINDER`
`static java.lang.String`	`SERIALIZED_NAME_PERCENT_ALLOCATED`
`static java.lang.String`	`SERIALIZED_NAME_REQUEST_ID`
`static java.lang.String`	`SERIALIZED_NAME_STATE`
`static java.lang.String`	`SERIALIZED_NAME_SWITCH_METHOD`
`static java.lang.String`	`SERIALIZED_NAME_TARGET_ACCOUNT_ID`
`static java.lang.String`	`SERIALIZED_NAME_TARGET_ITEM_ID`

Constructor Summary

Constructors

Constructor Description

DepositSwitchGetResponse()

Method Summary

Modifier and Type	Method	Description
`DepositSwitchGetResponse`	`accountHasMultipleAllocations(java.lang.Boolean accountHasMultipleAllocations)`
`DepositSwitchGetResponse`	`amountAllocated(java.lang.Double amountAllocated)`
`DepositSwitchGetResponse`	`dateCompleted(java.time.LocalDate dateCompleted)`
`DepositSwitchGetResponse`	`dateCreated(java.time.LocalDate dateCreated)`
`DepositSwitchGetResponse`	`depositSwitchId(java.lang.String depositSwitchId)`
`DepositSwitchGetResponse`	`employerId(java.lang.String employerId)`
`DepositSwitchGetResponse`	`employerName(java.lang.String employerName)`
`boolean`	`equals(java.lang.Object o)`
`java.lang.Boolean`	`getAccountHasMultipleAllocations()`	When `true`, user’s direct deposit goes to multiple banks.
`java.lang.Double`	`getAmountAllocated()`	The dollar amount of direct deposit allocated to the target account.
`java.time.LocalDate`	`getDateCompleted()`	[ISO 8601](https://wikipedia.org/wiki/ISO_8601) date the deposit switch was completed.
`java.time.LocalDate`	`getDateCreated()`	[ISO 8601](https://wikipedia.org/wiki/ISO_8601) date the deposit switch was created.
`java.lang.String`	`getDepositSwitchId()`	The ID of the deposit switch.
`java.lang.String`	`getEmployerId()`	The ID of the employer selected by the user.
`java.lang.String`	`getEmployerName()`	The name of the employer selected by the user.
`java.lang.String`	`getInstitutionId()`	The ID of the institution selected by the user.
`java.lang.String`	`getInstitutionName()`	The name of the institution selected by the user.
`java.lang.Boolean`	`getIsAllocatedRemainder()`	When `true`, the target account is allocated the remainder of direct deposit after all other allocations have been deducted.
`java.lang.Double`	`getPercentAllocated()`	The percentage of direct deposit allocated to the target account.
`java.lang.String`	`getRequestId()`	A unique identifier for the request, which can be used for troubleshooting.
`DepositSwitchGetResponse.StateEnum`	`getState()`	The state, or status, of the deposit switch.
`DepositSwitchGetResponse.SwitchMethodEnum`	`getSwitchMethod()`	The method used to make the deposit switch.
`java.lang.String`	`getTargetAccountId()`	The ID of the bank account the direct deposit was switched to.
`java.lang.String`	`getTargetItemId()`	The ID of the Item the direct deposit was switched to.
`int`	`hashCode()`
`DepositSwitchGetResponse`	`institutionId(java.lang.String institutionId)`
`DepositSwitchGetResponse`	`institutionName(java.lang.String institutionName)`
`DepositSwitchGetResponse`	`isAllocatedRemainder(java.lang.Boolean isAllocatedRemainder)`
`DepositSwitchGetResponse`	`percentAllocated(java.lang.Double percentAllocated)`
`DepositSwitchGetResponse`	`requestId(java.lang.String requestId)`
`void`	`setAccountHasMultipleAllocations(java.lang.Boolean accountHasMultipleAllocations)`
`void`	`setAmountAllocated(java.lang.Double amountAllocated)`
`void`	`setDateCompleted(java.time.LocalDate dateCompleted)`
`void`	`setDateCreated(java.time.LocalDate dateCreated)`
`void`	`setDepositSwitchId(java.lang.String depositSwitchId)`
`void`	`setEmployerId(java.lang.String employerId)`
`void`	`setEmployerName(java.lang.String employerName)`
`void`	`setInstitutionId(java.lang.String institutionId)`
`void`	`setInstitutionName(java.lang.String institutionName)`
`void`	`setIsAllocatedRemainder(java.lang.Boolean isAllocatedRemainder)`
`void`	`setPercentAllocated(java.lang.Double percentAllocated)`
`void`	`setRequestId(java.lang.String requestId)`
`void`	`setState(DepositSwitchGetResponse.StateEnum state)`
`void`	`setSwitchMethod(DepositSwitchGetResponse.SwitchMethodEnum switchMethod)`
`void`	`setTargetAccountId(java.lang.String targetAccountId)`
`void`	`setTargetItemId(java.lang.String targetItemId)`
`DepositSwitchGetResponse`	`state(DepositSwitchGetResponse.StateEnum state)`
`DepositSwitchGetResponse`	`switchMethod(DepositSwitchGetResponse.SwitchMethodEnum switchMethod)`
`DepositSwitchGetResponse`	`targetAccountId(java.lang.String targetAccountId)`
`DepositSwitchGetResponse`	`targetItemId(java.lang.String targetItemId)`
`java.lang.String`	`toString()`

Methods inherited from class java.lang.Object

clone, finalize, getClass, notify, notifyAll, wait, wait, wait

Field Details
- SERIALIZED_NAME_DEPOSIT_SWITCH_ID
  
  public static final java.lang.String SERIALIZED_NAME_DEPOSIT_SWITCH_ID
  
  See Also:
  
  Constant Field Values
- SERIALIZED_NAME_TARGET_ACCOUNT_ID
  
  public static final java.lang.String SERIALIZED_NAME_TARGET_ACCOUNT_ID
  
  See Also:
  
  Constant Field Values
- SERIALIZED_NAME_TARGET_ITEM_ID
  
  public static final java.lang.String SERIALIZED_NAME_TARGET_ITEM_ID
  
  See Also:
  
  Constant Field Values
- SERIALIZED_NAME_STATE
  
  public static final java.lang.String SERIALIZED_NAME_STATE
  
  See Also:
  
  Constant Field Values
- SERIALIZED_NAME_SWITCH_METHOD
  
  public static final java.lang.String SERIALIZED_NAME_SWITCH_METHOD
  
  See Also:
  
  Constant Field Values
- SERIALIZED_NAME_ACCOUNT_HAS_MULTIPLE_ALLOCATIONS
  
  public static final java.lang.String SERIALIZED_NAME_ACCOUNT_HAS_MULTIPLE_ALLOCATIONS
  
  See Also:
  
  Constant Field Values
- SERIALIZED_NAME_IS_ALLOCATED_REMAINDER
  
  public static final java.lang.String SERIALIZED_NAME_IS_ALLOCATED_REMAINDER
  
  See Also:
  
  Constant Field Values
- SERIALIZED_NAME_PERCENT_ALLOCATED
  
  public static final java.lang.String SERIALIZED_NAME_PERCENT_ALLOCATED
  
  See Also:
  
  Constant Field Values
- SERIALIZED_NAME_AMOUNT_ALLOCATED
  
  public static final java.lang.String SERIALIZED_NAME_AMOUNT_ALLOCATED
  
  See Also:
  
  Constant Field Values
- SERIALIZED_NAME_EMPLOYER_NAME
  
  public static final java.lang.String SERIALIZED_NAME_EMPLOYER_NAME
  
  See Also:
  
  Constant Field Values
- SERIALIZED_NAME_EMPLOYER_ID
  
  public static final java.lang.String SERIALIZED_NAME_EMPLOYER_ID
  
  See Also:
  
  Constant Field Values
- SERIALIZED_NAME_INSTITUTION_NAME
  
  public static final java.lang.String SERIALIZED_NAME_INSTITUTION_NAME
  
  See Also:
  
  Constant Field Values
- SERIALIZED_NAME_INSTITUTION_ID
  
  public static final java.lang.String SERIALIZED_NAME_INSTITUTION_ID
  
  See Also:
  
  Constant Field Values
- SERIALIZED_NAME_DATE_CREATED
  
  public static final java.lang.String SERIALIZED_NAME_DATE_CREATED
  
  See Also:
  
  Constant Field Values
- SERIALIZED_NAME_DATE_COMPLETED
  
  public static final java.lang.String SERIALIZED_NAME_DATE_COMPLETED
  
  See Also:
  
  Constant Field Values
- SERIALIZED_NAME_REQUEST_ID
  
  public static final java.lang.String SERIALIZED_NAME_REQUEST_ID
  
  See Also:
  
  Constant Field Values
Constructor Details
- DepositSwitchGetResponse
  
  public DepositSwitchGetResponse()
Method Details
- depositSwitchId
  
  public DepositSwitchGetResponse depositSwitchId(java.lang.String depositSwitchId)
- getDepositSwitchId
  
  public java.lang.String getDepositSwitchId()
  
  The ID of the deposit switch.
  
  Returns:
  
  depositSwitchId
- setDepositSwitchId
  
  public void setDepositSwitchId(java.lang.String depositSwitchId)
- targetAccountId
  
  public DepositSwitchGetResponse targetAccountId(java.lang.String targetAccountId)
- getTargetAccountId
  
  @Nullable public java.lang.String getTargetAccountId()
  
  The ID of the bank account the direct deposit was switched to.
  
  Returns:
  
  targetAccountId
- setTargetAccountId
  
  public void setTargetAccountId(java.lang.String targetAccountId)
- targetItemId
  
  public DepositSwitchGetResponse targetItemId(java.lang.String targetItemId)
- getTargetItemId
  
  @Nullable public java.lang.String getTargetItemId()
  
  The ID of the Item the direct deposit was switched to.
  
  Returns:
  
  targetItemId
- setTargetItemId
  
  public void setTargetItemId(java.lang.String targetItemId)
- state
  
  public DepositSwitchGetResponse state(DepositSwitchGetResponse.StateEnum state)
- getState
  
  public DepositSwitchGetResponse.StateEnum getState()
  
  The state, or status, of the deposit switch. - `initialized` – The deposit switch has been initialized with the user entering the information required to submit the deposit switch request. - `processing` – The deposit switch request has been submitted and is being processed. - `completed` – The user's employer has fulfilled the deposit switch request. - `error` – There was an error processing the deposit switch request.
  
  Returns:
  
  state
- setState
  
  public void setState(DepositSwitchGetResponse.StateEnum state)
- switchMethod
  
  public DepositSwitchGetResponse switchMethod(DepositSwitchGetResponse.SwitchMethodEnum switchMethod)
- getSwitchMethod
  
  @Nullable public DepositSwitchGetResponse.SwitchMethodEnum getSwitchMethod()
  
  The method used to make the deposit switch. - `instant` – User instantly switched their direct deposit to a new or existing bank account by connecting their payroll or employer account. - `mail` – User requested that Plaid contact their employer by mail to make the direct deposit switch. - `pdf` – User generated a PDF or email to be sent to their employer with the information necessary to make the deposit switch.'
  
  Returns:
  
  switchMethod
- setSwitchMethod
  
  public void setSwitchMethod(DepositSwitchGetResponse.SwitchMethodEnum switchMethod)
- accountHasMultipleAllocations
  
  public DepositSwitchGetResponse accountHasMultipleAllocations(java.lang.Boolean accountHasMultipleAllocations)
- getAccountHasMultipleAllocations
  
  @Nullable public java.lang.Boolean getAccountHasMultipleAllocations()
  
  When `true`, user’s direct deposit goes to multiple banks. When false, user’s direct deposit only goes to the target account. Always `null` if the deposit switch has not been completed.
  
  Returns:
  
  accountHasMultipleAllocations
- setAccountHasMultipleAllocations
  
  public void setAccountHasMultipleAllocations(java.lang.Boolean accountHasMultipleAllocations)
- isAllocatedRemainder
  
  public DepositSwitchGetResponse isAllocatedRemainder(java.lang.Boolean isAllocatedRemainder)
- getIsAllocatedRemainder
  
  @Nullable public java.lang.Boolean getIsAllocatedRemainder()
  
  When `true`, the target account is allocated the remainder of direct deposit after all other allocations have been deducted. When `false`, user’s direct deposit is allocated as a percent or amount. Always `null` if the deposit switch has not been completed.
  
  Returns:
  
  isAllocatedRemainder
- setIsAllocatedRemainder
  
  public void setIsAllocatedRemainder(java.lang.Boolean isAllocatedRemainder)
- percentAllocated
  
  public DepositSwitchGetResponse percentAllocated(java.lang.Double percentAllocated)
- getPercentAllocated
  
  @Nullable public java.lang.Double getPercentAllocated()
  
  The percentage of direct deposit allocated to the target account. Always `null` if the target account is not allocated a percentage or if the deposit switch has not been completed or if `is_allocated_remainder` is true.
  
  Returns:
  
  percentAllocated
- setPercentAllocated
  
  public void setPercentAllocated(java.lang.Double percentAllocated)
- amountAllocated
  
  public DepositSwitchGetResponse amountAllocated(java.lang.Double amountAllocated)
- getAmountAllocated
  
  @Nullable public java.lang.Double getAmountAllocated()
  
  The dollar amount of direct deposit allocated to the target account. Always `null` if the target account is not allocated an amount or if the deposit switch has not been completed.
  
  Returns:
  
  amountAllocated
- setAmountAllocated
  
  public void setAmountAllocated(java.lang.Double amountAllocated)
- employerName
  
  public DepositSwitchGetResponse employerName(java.lang.String employerName)
- getEmployerName
  
  @Nullable public java.lang.String getEmployerName()
  
  The name of the employer selected by the user. If the user did not select an employer, the value returned is `null`.
  
  Returns:
  
  employerName
- setEmployerName
  
  public void setEmployerName(java.lang.String employerName)
- employerId
  
  public DepositSwitchGetResponse employerId(java.lang.String employerId)
- getEmployerId
  
  @Nullable public java.lang.String getEmployerId()
  
  The ID of the employer selected by the user. If the user did not select an employer, the value returned is `null`.
  
  Returns:
  
  employerId
- setEmployerId
  
  public void setEmployerId(java.lang.String employerId)
- institutionName
  
  public DepositSwitchGetResponse institutionName(java.lang.String institutionName)
- getInstitutionName
  
  @Nullable public java.lang.String getInstitutionName()
  
  The name of the institution selected by the user. If the user did not select an institution, the value returned is `null`.
  
  Returns:
  
  institutionName
- setInstitutionName
  
  public void setInstitutionName(java.lang.String institutionName)
- institutionId
  
  public DepositSwitchGetResponse institutionId(java.lang.String institutionId)
- getInstitutionId
  
  @Nullable public java.lang.String getInstitutionId()
  
  The ID of the institution selected by the user. If the user did not select an institution, the value returned is `null`.
  
  Returns:
  
  institutionId
- setInstitutionId
  
  public void setInstitutionId(java.lang.String institutionId)
- dateCreated
  
  public DepositSwitchGetResponse dateCreated(java.time.LocalDate dateCreated)
- getDateCreated
  
  public java.time.LocalDate getDateCreated()
  
  [ISO 8601](https://wikipedia.org/wiki/ISO_8601) date the deposit switch was created.
  
  Returns:
  
  dateCreated
- setDateCreated
  
  public void setDateCreated(java.time.LocalDate dateCreated)
- dateCompleted
  
  public DepositSwitchGetResponse dateCompleted(java.time.LocalDate dateCompleted)
- getDateCompleted
  
  @Nullable public java.time.LocalDate getDateCompleted()
  
  [ISO 8601](https://wikipedia.org/wiki/ISO_8601) date the deposit switch was completed. Always `null` if the deposit switch has not been completed.
  
  Returns:
  
  dateCompleted
- setDateCompleted
  
  public void setDateCompleted(java.time.LocalDate dateCompleted)
- requestId
  
  public DepositSwitchGetResponse requestId(java.lang.String requestId)
- getRequestId
  
  public java.lang.String getRequestId()
  
  A unique identifier for the request, which can be used for troubleshooting. This identifier, like all Plaid identifiers, is case sensitive.
  
  Returns:
  
  requestId
- setRequestId
  
  public void setRequestId(java.lang.String requestId)
- equals
  
  public boolean equals(java.lang.Object o)
  
  Overrides:
  
  equals in class java.lang.Object
- hashCode
  
  public int hashCode()
  
  Overrides:
  
  hashCode in class java.lang.Object
- toString
  
  public java.lang.String toString()
  
  Overrides:
  
  toString in class java.lang.Object

Class DepositSwitchGetResponse

Nested Class Summary

Field Summary

Constructor Summary

Method Summary

Methods inherited from class java.lang.Object

Field Details

Constructor Details

Method Details