class

Plaid::TransferAuthorizationPaymentRisk

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

This object includes the scores and risk level. This response is offered as an add-on to /transfer/authorization/create. To request access to these fields please contact your Plaid account manager.

Constants

MAX_FOR_BANK_INITIATED_RETURN_SCORE = Int32.new("99")
MAX_FOR_CUSTOMER_INITIATED_RETURN_SCORE = Int32.new("99")
MIN_FOR_BANK_INITIATED_RETURN_SCORE = Int32.new("1")
MIN_FOR_CUSTOMER_INITIATED_RETURN_SCORE = Int32.new("1")

Constructors

new(*, __pull_for_json_serializable pull : JSON::PullParser)
Source
new(*, bank_initiated_return_score : Int32 | Nil = nil, customer_initiated_return_score : Int32 | Nil = nil, risk_level : Plaid::TransferAuthorizationRiskLevel | Nil = nil, warnings : Array(Plaid::SignalWarning) | 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

bank_initiated_return_score

A score from 1-99 that indicates the transaction return risk: a higher risk score suggests a higher return likelihood. The score evaluates the transaction return risk because an account is overdrawn or because an ineligible account is used and covers return codes: "R01", "R02", "R03", "R04", "R06", "R08", "R09", "R13", "R16", "R17", "R20", "R23". These returns have a turnaround time of 2 banking days.

Source
bank_initiated_return_score=(new_value : Int32 | Nil)

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

Source
customer_initiated_return_score

A score from 1-99 that indicates the transaction return risk: a higher risk score suggests a higher return likelihood. The score evaluates the transaction return risk of an unauthorized debit and covers return codes: "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.

Source
customer_initiated_return_score=(new_value : Int32 | Nil)

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

Source
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_level
Source
risk_level=(new_value : Plaid::TransferAuthorizationRiskLevel | Nil)

Custom attribute writer method checking allowed values (enum). @param [Object] risk_level 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
warnings

If bank information was not available to be used in the Signal model, this array contains warnings describing why bank data is missing. If you want to receive an API error instead of Signal scores in the case of missing bank data, file a support ticket or contact your Plaid account manager.

Source
warnings=(new_value : Array(Plaid::SignalWarning) | Nil)

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

Source