plaid2.model.bank_transfer_create_request module

class plaid2.model.bank_transfer_create_request.BankTransferCreateRequest(*, type: str, amount: str, custom_tag: Optional[str] = None, description: str, metadata: Optional[BankTransferMetadata] = None, iso_currency_code: str, ach_class: Optional[str] = None, account_id: str, network: str, idempotency_key: str, origination_account_id: Optional[str] = None, user: BankTransferUser, access_token: str)

Bases: BaseModel

access_token: str

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

account_id: str

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

ach_class: Optional[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”).

custom_tag: Optional[str]

An arbitrary string provided by the client for storage with the bank transfer. May be up to 100 characters.

description: str

The transfer description. Maximum of 10 characters.

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

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

idempotency_key: str

A random key provided by the client, per unique bank transfer. Maximum of 50 characters.

The API supports idempotency for safely retrying requests without accidentally performing the same operation twice. For example, if a request to create a bank transfer fails due to a network connection error, you can retry the request with the same idempotency key to guarantee that only a single bank transfer is created.

iso_currency_code: str

The currency of the transfer amount – should be set to “USD”.

json(**kwargs: Any) → str

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: Optional[str]

Plaid’s unique identifier for the origination account for this transfer. If you have more than one origination account, this value must be specified. Otherwise, this field should be left blank.

classmethod parse_obj(data: Any) → BankTransferCreateRequest

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

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

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

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.