class

Plaid::SignalEvaluateRequest

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

SignalEvaluateRequest defines the request schema for /signal/evaluate

Constants

MAX_LENGTH_FOR_CLIENT_TRANSACTION_ID = 36
MIN_LENGTH_FOR_CLIENT_TRANSACTION_ID = 1

Constructors

new(pull : JSON::PullParser)
Source
new(*, __pull_for_json_serializable pull : JSON::PullParser)
Source
new(*, access_token : String | Nil = nil, account_id : String | Nil = nil, client_transaction_id : String | Nil = nil, amount : Float64 | Nil = nil, client_id : String | Nil = nil, secret : String | Nil = nil, user_present : Bool | Nil = nil, client_user_id : String | Nil = nil, is_recurring : Bool | Nil = nil, default_payment_method : String | Nil = nil, user : Plaid::SignalUser | Nil = nil, device : Plaid::SignalDevice | 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

access_token

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

Source
access_token=(new_value : String | Nil)

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

Source
account_id

The Plaid account_id of the account that is the funding source for the proposed transaction. The account_id is returned in the /accounts/get endpoint as well as the onSuccess callback metadata. This will return an INVALID_ACCOUNT_ID error if the account has been removed at the bank or if the account_id is no longer valid.

Source
account_id=(new_value : String | Nil)

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

Source
amount

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

Source
amount=(new_value : Float64 | Nil)

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

Source
client_id

Your Plaid API client_id. The client_id is required and may be provided either in the PLAID-CLIENT-ID header or as part of a request body.

Source
client_id=(new_value : String | Nil)

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

Source
client_transaction_id

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.

Source
client_transaction_id=(new_value : String | Nil)

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

Source
client_user_id

A unique ID that identifies the end user in your system. This ID is used to correlate requests by a user with multiple Items. Personally identifiable information, such as an email address or phone number, should not be used in the client_user_id.

Source
client_user_id=(new_value : String | Nil)

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

Source
default_payment_method

The default ACH or non-ACH payment method to complete the transaction. SAME_DAY_ACH: Same Day ACH by NACHA. The debit transaction is processed and settled on the same day NEXT_DAY_ACH: Next Day ACH settlement for debit transactions, offered by some payment processors STANDARD_ACH: standard ACH by NACHA REAL_TIME_PAYMENTS: real-time payments such as RTP and FedNow DEBIT_CARD: if the default payment is over debit card networks MULTIPLE_PAYMENT_METHODS: if there is no default debit rail or there are multiple payment methods Possible values: SAME_DAY_ACH, NEXT_DAY_ACH, STANDARD_ACH, REAL_TIME_PAYMENTS, DEBIT_CARD, MULTIPLE_PAYMENT_METHODS

Source
default_payment_method=(new_value : String | Nil)

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

Source
default_payment_method_present=(default_payment_method_present : Bool)
Source
default_payment_method_present?
Source
device
Source
device=(new_value : Plaid::SignalDevice | Nil)

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

is_recurring

true if the ACH transaction is a recurring transaction; false otherwise

Source
is_recurring=(new_value : Bool | Nil)

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

Source
is_recurring_present=(is_recurring_present : Bool)
Source
is_recurring_present?
Source
list_invalid_properties

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

Source
secret

Your Plaid API secret. The secret is required and may be provided either in the PLAID-SECRET header or as part of a request body.

Source
secret=(new_value : String | Nil)

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

Source
user
Source
user=(new_value : Plaid::SignalUser | Nil)

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

Source
user_present

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).

Source
user_present=(new_value : Bool | Nil)

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

Source
user_present_present=(user_present_present : Bool)
Source
user_present_present?
Source
valid?

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

Source