plaid2.model.transfer_intent_create module

class plaid2.model.transfer_intent_create.TransferIntentCreate(*, id: str, ach_class: str, account_id: Optional[str] = None, created: str, description: str, status: str, amount: str, origination_account_id: str, user: TransferUserInResponse, metadata: Optional[TransferMetadata] = None, require_guarantee: Optional[bool] = None, iso_currency_code: str, mode: str)[source]

Bases: BaseModel

account_id: Optional[str]

The Plaid account_id for the account that will be debited or credited. Returned only if account_id was set on intent creation.

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

created: str

05Z`.

Type

The datetime the transfer was created. This will be of the form `2006-01-02T15

Type

04

description: str

A description for the underlying transfer. Maximum of 8 characters.

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

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

id: str

Plaid’s unique identifier for the transfer intent object.

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[TransferMetadata]

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

mode: str

The direction of the flow of transfer funds.

  • PAYMENT – Transfers funds from an end user’s account to your business account.

  • DISBURSEMENT – Transfers funds from your business account to an end user’s account.

origination_account_id: str

Plaid’s unique identifier for the origination account for the intent. If not provided, the default account will be used.

classmethod parse_obj(data: Any) → TransferIntentCreate[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) → TransferIntentCreate[source]

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

require_guarantee: Optional[bool]

When true, the transfer requires a GUARANTEED decision by Plaid to proceed (Guaranteed ACH customers only).

status: str

The status of the transfer intent.

  • PENDING – The transfer intent is pending.

  • SUCCEEDED – The transfer intent was successfully created.

  • FAILED – The transfer intent was unable to be created.

user: TransferUserInResponse

The legal name and other information for the account holder.