plaid2.model.transfer_event module

class plaid2.model.transfer_event.TransferEvent(*, transfer_amount: str, event_id: int, transfer_type: str, event_type: str, timestamp: str, failure_reason: Optional[TransferFailure] = None, account_id: str, sweep_amount: Optional[str] = None, sweep_id: Optional[str] = None, transfer_id: str, origination_account_id: Optional[str] = None)[source]

Bases: BaseModel

account_id: str: The account ID associated with the transfer.

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

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 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.

returned: A posted transfer was returned.

swept: The transfer was swept to / from the sweep account.

return_swept: Due to the transfer being returned, funds were pulled from or pushed back to the sweep account.

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

origination_account_id: Optional[str]: The ID of the origination account that this balance belongs to.

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

sweep_amount: Optional[str]: A signed amount of how much was swept or return_swept (decimal string with two digits of precision e.g. “-5.50”).

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

timestamp: str

05Z`.

Type: The datetime when this event occurred. This will be of the form `2006-01-02T15
Type: 04

transfer_amount: str: The amount of the transfer (decimal string with two digits of precision e.g. “10.00”).

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

transfer_type: str: The type of 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.