plaid2.model.bank_transfer_event module
- class plaid2.model.bank_transfer_event.BankTransferEvent(*, origination_account_id: Optional[str] = None, timestamp: str, account_id: str, event_type: str, bank_transfer_id: str, bank_transfer_type: str, failure_reason: Optional[BankTransferFailure] = None, bank_transfer_amount: str, event_id: int, bank_transfer_iso_currency_code: str, direction: Optional[str] = None)[source]
Bases:
BaseModel- account_id: str
The account ID associated with the bank transfer.
- bank_transfer_amount: str
The bank transfer amount.
- bank_transfer_id: str
Plaid’s unique identifier for a bank transfer.
- bank_transfer_iso_currency_code: str
The currency of the bank transfer amount.
- bank_transfer_type: str
The type of bank transfer. This will be either debit or credit. A debit indicates a transfer of money into the origination account; a credit indicates a transfer of money out of the origination account.
- 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]
outbound for API-initiated transfers, or inbound for payments received by the FBO account.
- Type
Indicates the direction of the transfer
- event_id: int
Plaid’s unique identifier for this event. IDs are sequential unsigned 64-bit integers.
- event_type: str
The type of event that this bank transfer represents.
pending: A new transfer was created; it is in the pending state.
cancelled: The transfer was cancelled by the client.
failed: The transfer failed, no funds were moved.
posted: The transfer has been successfully submitted to the payment network.
reversed: A posted transfer was reversed.
- failure_reason: Optional[BankTransferFailure]
The failure reason if the type of this transfer is “failed” or “reversed”. Null value otherwise.
- json(**kwargs: Any) str[source]
Return a json string representation of the object. Takes same keyword arguments as pydantic.BaseModel.json
- origination_account_id: Optional[str]
The ID of the origination account that this balance belongs to.
- classmethod parse_obj(data: Any) BankTransferEvent[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) BankTransferEvent[source]
Parse a json string into the object. Takes same keyword arguments as pydantic.BaseModel.parse_raw