plaid2.model.bank_transfer_event_list_request module
- class plaid2.model.bank_transfer_event_list_request.BankTransferEventListRequest(*, end_date: Optional[str] = None, bank_transfer_id: Optional[str] = None, offset: Optional[int] = None, direction: Optional[str] = None, account_id: Optional[str] = None, bank_transfer_type: Optional[str] = None, origination_account_id: Optional[str] = None, event_types: Optional[List[str]] = None, count: Optional[int] = None, start_date: Optional[str] = None)[source]
Bases:
BaseModel- account_id: Optional[str]
The account ID to get events for all transactions to/from an account.
- bank_transfer_id: Optional[str]
Plaid’s unique identifier for a bank transfer.
- bank_transfer_type: Optional[str]
The type of bank 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.
- count: Optional[int]
The maximum number of bank 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
- direction: Optional[str]
for API-initiated transfers inbound: for payments received by the FBO account.
- Type
Indicates the direction of the transfer
- Type
outbound
- end_date: Optional[str]
49Z`)
- Type
The end datetime of bank 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 bank 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) BankTransferEventListRequest[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) BankTransferEventListRequest[source]
Parse a json string into the object. Takes same keyword arguments as pydantic.BaseModel.parse_raw