plaid2.model.bank_transfer module

class plaid2.model.bank_transfer.BankTransfer(*, metadata: Optional[BankTransferMetadata] = None, origination_account_id: str, amount: str, ach_class: str, direction: Optional[str] = None, created: str, cancellable: bool, network: str, iso_currency_code: str, status: str, type: str, account_id: str, description: str, failure_reason: Optional[BankTransferFailure] = None, custom_tag: Optional[str] = None, id: str, user: BankTransferUser)[source]

Bases: BaseModel

account_id: str: The account ID that should be credited/debited for this bank transfer.

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 bank transfer (decimal string with two digits of precision e.g. “10.00”).

cancellable: bool: When true, you can still cancel this bank transfer.

created: str

05Z`

Type: The datetime when this bank transfer was created. This will be of the form `2006-01-02T15
Type: 04

custom_tag: Optional[str]: A string containing the custom tag provided by the client in the create request. Will be null if not provided.

description: str: The description of the transfer.

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

failure_reason: Optional[BankTransferFailure]: The failure reason if the type of this transfer is “failed” or “reversed”. Null value otherwise.

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

iso_currency_code: str: The currency of the transfer amount, e.g. “USD”

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

metadata: Optional[BankTransferMetadata]: The Metadata object is a mapping of client-provided string fields to any string value. The following limitations apply: - The JSON values must be Strings (no nested JSON objects allowed) - Only ASCII characters may be used - Maximum of 50 key/value pairs - Maximum key length of 40 characters - Maximum value length of 500 characters

network: str: The network or rails used for the transfer. Valid options are ach, same-day-ach, or wire.

origination_account_id: str: Plaid’s unique identifier for the origination account that was used for this transfer.

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

status: str: The status of the 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.

user: BankTransferUser: The legal name and other information for the account holder.