plaid2.model.sandbox_transfer_simulate_request module

class plaid2.model.sandbox_transfer_simulate_request.SandboxTransferSimulateRequest(*, failure_reason: Optional[TransferFailure] = None, transfer_id: str, event_type: str)[source]

Bases: BaseModel

dict(**kwargs: Any) → Dict[str, Any][source]: Return a dict representation of the object. Takes same keyword arguments as pydantic.BaseModel.dict

event_type: str

posted, failed, or returned.

An error will be returned if the event type is incompatible with the current transfer status. Compatible status –> event type transitions include:

pending –> failed

pending –> posted

posted –> returned

Type: The asynchronous event to be simulated. May be

failure_reason: Optional[TransferFailure]: The failure reason if the event type for a transfer is “failed” or “returned”. Null value otherwise.

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

transfer_id: str: Plaid’s unique identifier for a transfer.