plaid2.model.deposit_switch_state_update_webhook module

class plaid2.model.deposit_switch_state_update_webhook.DepositSwitchStateUpdateWebhook(*, webhook_code: Optional[str] = None, state: Optional[str] = None, deposit_switch_id: Optional[str] = None, webhook_type: Optional[str] = None)[source]

Bases: BaseModel

deposit_switch_id: Optional[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

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) → DepositSwitchStateUpdateWebhook[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) → DepositSwitchStateUpdateWebhook[source]: Parse a json string into the object. Takes same keyword arguments as pydantic.BaseModel.parse_raw

state: Optional[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 and completed the deposit switch request.

error: There was an error processing the deposit switch request.

For more information, see the [Deposit Switch API reference](/docs/deposit-switch/reference#deposit_switchget).

webhook_code: Optional[str]: “SWITCH_STATE_UPDATE”

webhook_type: Optional[str]: “DEPOSIT_SWITCH”