class

Plaid::BankInitiatedReturnRisk

Inherits OpenApi::Json < OpenApi::Validatable < JSON::Serializable::Unmapped < JSON::Serializable < Reference < Object

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: "R01", "R02", "R03", "R04", "R06", "R08", "R09", "R13", "R16", "R17", "R20", "R23". These returns have a turnaround time of 2 banking days.

Constants

MAX_FOR_RISK_TIER = Int32.new("8")
MAX_FOR_SCORE = Int32.new("99")
MIN_FOR_RISK_TIER = Int32.new("1")
MIN_FOR_SCORE = Int32.new("1")

Constructors

new(pull : JSON::PullParser)
Source
new(*, __pull_for_json_serializable pull : JSON::PullParser)
Source
new(*, score : Int32 | Nil = nil, risk_tier : Int32 | Nil = nil)

Initializes the object @param [Hash] attributes Model attributes in the form of hash

Source

Instance methods

==(other : self)

Generates #hash and #== methods from all fields #== @return [Bool] #hash calculates hash code according to all attributes. #hash @return [UInt64] Hash code

hash(hasher)

Generates #hash and #== methods from all fields #== @return [Bool] #hash calculates hash code according to all attributes. #hash @return [UInt64] Hash code

list_invalid_properties

Show invalid properties with the reasons. Usually used together with valid? @return Array for valid properties with the reasons

Source
risk_tier

In the bank_initiated_return_risk object, there are eight risk tiers corresponding to the scores: 1: Predicted bank-initiated return incidence rate between 0.0% - 0.5% 2: Predicted bank-initiated return incidence rate between 0.5% - 1.5% 3: Predicted bank-initiated return incidence rate between 1.5% - 3% 4: Predicted bank-initiated return incidence rate between 3% - 5% 5: Predicted bank-initiated return incidence rate between 5% - 10% 6: Predicted bank-initiated return incidence rate between 10% - 15% 7: Predicted bank-initiated return incidence rate between 15% and 50% 8: Predicted bank-initiated return incidence rate greater than 50%

Source
risk_tier=(new_value : Int32 | Nil)

Custom attribute writer method checking allowed values (enum). @param [Object] risk_tier Object to be assigned

Source
score

A score from 1-99 that indicates the transaction return risk: a higher risk score suggests a higher return likelihood.

Source
score=(new_value : Int32 | Nil)

Custom attribute writer method checking allowed values (enum). @param [Object] score Object to be assigned

Source
valid?

Check to see if the all the properties in the model are valid @return true if the model is valid

Source