plaid2.model.signal_scores module

class plaid2.model.signal_scores.SignalScores(*, bank_initiated_return_risk: Optional[BankInitiatedReturnRisk] = None, customer_initiated_return_risk: Optional[CustomerInitiatedReturnRisk] = None)

Bases: BaseModel

bank_initiated_return_risk: Optional[BankInitiatedReturnRisk]

“R01”, “R02”, “R03”, “R04”, “R06”, “R08”, “R09”, “R13”, “R16”, “R17”, “R20”, “R23”. These returns have a turnaround time of 2 banking days.

Type

The object contains a risk score and a risk tier that evaluate the transaction return risk because an account is overdrawn or because an ineligible account is used. Common return codes in this category include

customer_initiated_return_risk: Optional[CustomerInitiatedReturnRisk]

“R05”, “R07”, “R10”, “R11”, “R29”. These returns typically have a return time frame of up to 60 calendar days. During this period, the customer of financial institutions can dispute a transaction as unauthorized.

Type

The object contains a risk score and a risk tier that evaluate the transaction return risk of an unauthorized debit. Common return codes in this category include

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) → SignalScores

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

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

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