plaid2.model.transfer_event_list_request module

class plaid2.model.transfer_event_list_request.TransferEventListRequest(*, end_date: Optional[str] = None, sweep_id: Optional[str] = None, count: Optional[int] = None, event_types: Optional[List[str]] = None, origination_account_id: Optional[str] = None, start_date: Optional[str] = None, transfer_id: Optional[str] = None, offset: Optional[int] = None, account_id: Optional[str] = None, transfer_type: Optional[str] = None)[source]

Bases: BaseModel

account_id: Optional[str]: The account ID to get events for all transactions to/from an account.

count: Optional[int]: The maximum number of transfer events to return. If the number of events matching the above parameters is greater than count, the most recent events will be returned.

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

end_date: Optional[str]

49Z`)

Type: The end datetime of transfers to list. This should be in RFC 3339 format (i.e. `2019-12-06T22
Type: 35

event_types: Optional[List[str]]: Filter events by event type.

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

offset: Optional[int]: The offset into the list of transfer events. When `count`=25 and `offset`=0, the first 25 events will be returned. When `count`=25 and `offset`=25, the next 25 bank transfer events will be returned.

origination_account_id: Optional[str]: The origination account ID to get events for transfers from a specific origination account.

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

start_date: Optional[str]

49Z`)

Type: The start datetime of transfers to list. This should be in RFC 3339 format (i.e. `2019-12-06T22
Type: 35

sweep_id: Optional[str]: Plaid’s unique identifier for a sweep.

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

transfer_type: Optional[str]: The type of transfer. This will be either debit or credit. A debit indicates a transfer of money into your origination account; a credit indicates a transfer of money out of your origination account.