plaid2.model.transfer_authorization_proposed_transfer module

class plaid2.model.transfer_authorization_proposed_transfer.TransferAuthorizationProposedTransfer(*, user: TransferUserInResponse, network: str, iso_currency_code: str, ach_class: str, account_id: str, type: str, amount: str, origination_account_id: str)

Bases: BaseModel

account_id: str

The Plaid account_id for the account that will be debited or credited.

ach_class: str

Specifies the use case of the transfer. Required for transfers on an ACH network.

“ccd” - Corporate Credit or Debit - fund transfer between two corporate bank accounts

“ppd” - Prearranged Payment or Deposit - the transfer is part of a pre-existing relationship with a consumer, eg. bill payment

“tel” - Telephone-Initiated Entry

“web” - Internet-Initiated Entry - debits from a consumer’s account where their authorization is obtained over the Internet

amount: str

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

dict(**kwargs: Any) → Dict[str, Any]

Return a dict representation of the object. Takes same keyword arguments as pydantic.BaseModel.dict

iso_currency_code: str

The currency of the transfer amount. The default value is “USD”.

json(**kwargs: Any) → str

Return a json string representation of the object. Takes same keyword arguments as pydantic.BaseModel.json

network: str

The network or rails used for the transfer.

origination_account_id: str

Plaid’s unique identifier for the origination account that was used for this transfer.

classmethod parse_obj(data: Any) → TransferAuthorizationProposedTransfer

Parse a dict into the object. Takes same keyword arguments as pydantic.BaseModel.parse_obj

classmethod parse_raw(b: Union[bytes, str], **kwargs: Any) → TransferAuthorizationProposedTransfer

Parse a json string into the object. Takes same keyword arguments as pydantic.BaseModel.parse_raw

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.

user: TransferUserInResponse

The legal name and other information for the account holder.