plaid2.model.customer_initiated_return_risk module

class plaid2.model.customer_initiated_return_risk.CustomerInitiatedReturnRisk(*, score: int, risk_tier: int)

Bases: BaseModel

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

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

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

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

risk_tier: int

A tier corresponding to the projected likelihood that the transaction, if initiated, will be subject to a return.

In the customer_initiated_return_risk object, there are five risk tiers corresponding to the scores:

1: Predicted customer-initiated return incidence rate between 0.00% - 0.02% 2: Predicted customer-initiated return incidence rate between 0.02% - 0.05% 3: Predicted customer-initiated return incidence rate between 0.05% - 0.1% 4: Predicted customer-initiated return incidence rate between 0.1% - 0.5% 5: Predicted customer-initiated return incidence rate greater than 0.5%

score: int

a higher risk score suggests a higher return likelihood.

Type

A score from 0-99 that indicates the transaction return risk