plaid2.model.deposit_switch_get_response module

class plaid2.model.deposit_switch_get_response.DepositSwitchGetResponse(*, amount_allocated: Optional[float] = None, account_has_multiple_allocations: Optional[bool] = None, institution_name: Optional[str] = None, target_item_id: Optional[str] = None, target_account_id: Optional[str] = None, date_created: str, is_allocated_remainder: Optional[bool] = None, percent_allocated: Optional[float] = None, date_completed: Optional[str] = None, request_id: str, switch_method: Optional[str] = None, employer_name: Optional[str] = None, employer_id: Optional[str] = None, institution_id: Optional[str] = None, state: str, deposit_switch_id: str)[source]

Bases: BaseModel

account_has_multiple_allocations: Optional[bool]

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.

amount_allocated: Optional[float]

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.

date_completed: Optional[str]

//wikipedia.org/wiki/ISO_8601) date the deposit switch was completed. Always null if the deposit switch has not been completed.

Type

[ISO 8601](https

date_created: str

//wikipedia.org/wiki/ISO_8601) date the deposit switch was created.

Type

[ISO 8601](https

deposit_switch_id: str

The ID of the deposit switch.

dict(**kwargs: Any) → Dict[str, Any][source]

Return a dict representation of the object. Takes same keyword arguments as pydantic.BaseModel.dict

employer_id: Optional[str]

The ID of the employer selected by the user. If the user did not select an employer, the value returned is null.

employer_name: Optional[str]

The name of the employer selected by the user. If the user did not select an employer, the value returned is null.

institution_id: Optional[str]

The ID of the institution selected by the user. If the user did not select an institution, the value returned is null.

institution_name: Optional[str]

The name of the institution selected by the user. If the user did not select an institution, the value returned is null.

is_allocated_remainder: Optional[bool]

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.

json(**kwargs: Any) → str[source]

Return a json string representation of the object. Takes same keyword arguments as pydantic.BaseModel.json

classmethod parse_obj(data: Any) → DepositSwitchGetResponse[source]

Parse a dict into the object. Takes same keyword arguments as pydantic.BaseModel.parse_obj

classmethod parse_raw(b: Union[bytes, str], **kwargs: Any) → DepositSwitchGetResponse[source]

Parse a json string into the object. Takes same keyword arguments as pydantic.BaseModel.parse_raw

percent_allocated: Optional[float]

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.

request_id: str

A unique identifier for the request, which can be used for troubleshooting. This identifier, like all Plaid identifiers, is case sensitive.

state: str

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.

switch_method: Optional[str]

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.’

target_account_id: Optional[str]

The ID of the bank account the direct deposit was switched to.

target_item_id: Optional[str]

The ID of the Item the direct deposit was switched to.