plaid2.model.transfer_authorization module

class plaid2.model.transfer_authorization.TransferAuthorization(*, decision_rationale: Optional[TransferAuthorizationDecisionRationale] = None, guarantee_decision: Optional[str] = None, id: str, guarantee_decision_rationale: Optional[TransferAuthorizationGuaranteeDecisionRationale] = None, decision: str, proposed_transfer: TransferAuthorizationProposedTransfer, created: str)[source]

Bases: BaseModel

created: str

05Z`.

Type: The datetime representing when the authorization was created, in the format `2006-01-02T15
Type: 04

decision: str

A decision regarding the proposed transfer.

approved – The proposed transfer has received the end user’s consent and has been approved for processing by Plaid. The decision_rationale field is set if Plaid was unable to fetch the account information. You may proceed with the transfer, but further review is recommended (i.e., use Link in update to re-authenticate your user when decision_rationale.code is LOGIN_REQUIRED). Refer to the code field in the decision_rationale object for details.

declined – Plaid reviewed the proposed transfer and declined processing. Refer to the code field in the decision_rationale object for details.

decision_rationale: Optional[TransferAuthorizationDecisionRationale]: The rationale for Plaid’s decision regarding a proposed transfer. It is always set for declined decisions, and may or may not be null for approved decisions.

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

guarantee_decision: Optional[str]: Indicates whether the transfer is guaranteed by Plaid (Guaranteed ACH customers only). This field will contain either GUARANTEED or NOT_GUARANTEED indicating whether Plaid will guarantee the transfer. If the transfer is not guaranteed, additional information will be provided in the guarantee_decision_rationale field. Refer to the code field in guarantee_decision_rationale for details.

guarantee_decision_rationale: Optional[TransferAuthorizationGuaranteeDecisionRationale]: The rationale for Plaid’s decision to not guarantee a transfer. Will be null unless guarantee_decision is NOT_GUARANTEED.

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

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

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

proposed_transfer: TransferAuthorizationProposedTransfer: Details regarding the proposed transfer.