plaid2.model.transfer_create_request module

class plaid2.model.transfer_create_request.TransferCreateRequest(*, origination_account_id: Optional[str] = None, ach_class: str, network: str, authorization_id: str, metadata: Optional[TransferMetadata] = None, type: str, access_token: Optional[str] = None, description: str, idempotency_key: Optional[str] = None, account_id: Optional[str] = None, user: TransferUserInRequest, iso_currency_code: Optional[str] = None, amount: str, payment_profile_id: Optional[str] = None)[source]

Bases: BaseModel

access_token: Optional[str]: The Plaid access_token for the account that will be debited or credited.

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

authorization_id: str: Plaid’s unique identifier for a transfer authorization. This parameter also serves the purpose of acting as an idempotency identifier.

description: str: The transfer description. Maximum of 10 characters.

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

idempotency_key: Optional[str]

Deprecated. authorization_id is now used as idempotency instead.

A random key provided by the client, per unique 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 transfer fails due to a network connection error, you can retry the request with the same idempotency key to guarantee that only a single transfer is created.

iso_currency_code: Optional[str]: The currency of the transfer amount. The default value is “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

network: str

45 PM Pacific Time. It is recommended to submit a transfer at least 15 minutes before the cutoff time in order to ensure that it will be processed before the cutoff. Any transfer that is indicated as same-day-ach and that misses the same-day cutoff, but is submitted in time for the next-day cutoff, will be sent over next-day rails and will not incur same-day charges. Note that both legs of the transfer will be downgraded if applicable.

Type: The network or rails used for the transfer. Valid options are ach or same-day-ach. The cutoff for same-day transfers is 7
Type: 45 AM Pacific Time and the cutoff for next-day transfers is 5

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

payment_profile_id: Optional[str]: Plaid’s unique identifier for a payment profile.

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: TransferUserInRequest: The legal name and other information for the account holder.