plaid2.model.transfer_authorization_create_request module

class plaid2.model.transfer_authorization_create_request.TransferAuthorizationCreateRequest(*, user_present: Optional[bool] = None, type: str, access_token: Optional[str] = None, network: str, user: TransferAuthorizationUserInRequest, payment_profile_id: Optional[str] = None, amount: str, ach_class: str, account_id: Optional[str] = None, device: Optional[TransferAuthorizationDevice] = None, origination_account_id: Optional[str] = None, iso_currency_code: 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”).

device: Optional[TransferAuthorizationDevice]: Information about the device being used to initiate the authorization.

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

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

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 authorization. If not specified, the default account will be used.

classmethod parse_obj(data: Any) → TransferAuthorizationCreateRequest[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) → TransferAuthorizationCreateRequest[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: TransferAuthorizationUserInRequest: The legal name and other information for the account holder.

user_present: Optional[bool]: Required for guaranteed ACH customers. If the end user is initiating the specific transfer themselves via an interactive UI, this should be true; for automatic recurring payments where the end user is not actually initiating each individual transfer, it should be false.