plaid2.model.signal_evaluate_request module

class plaid2.model.signal_evaluate_request.SignalEvaluateRequest(*, access_token: str, device: Optional[SignalDevice] = None, amount: float, client_user_id: Optional[str] = None, account_id: str, user_present: Optional[bool] = None, client_transaction_id: str, user: Optional[SignalUser] = None)

Bases: BaseModel

access_token: str

The access token associated with the Item data is being requested for.

account_id: str

The account_id of the account whose verification status is to be modified

amount: float

The transaction amount, in USD (e.g. 102.05)

client_transaction_id: str

The unique ID that you would like to use to refer to this transaction. For your convenience mapping your internal data, you could use your internal ID/identifier for this transaction. The max length for this field is 36 characters.

client_user_id: Optional[str]

A unique ID that identifies the end user in your system. This ID is used to correlate requests by a user with multiple Items. The max length for this field is 36 characters.

device: Optional[SignalDevice]

Details about the end user’s device

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

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

json(**kwargs: Any) → str

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

classmethod parse_obj(data: Any) → SignalEvaluateRequest

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

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

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

user: Optional[SignalUser]

Details about the end user initiating the transaction (i.e., the account holder).

user_present: Optional[bool]

true if the end user is present while initiating the ACH transfer and the endpoint is being called; false otherwise (for example, when the ACH transfer is scheduled and the end user is not present, or you call this endpoint after the ACH transfer but before submitting the Nacha file for ACH processing).