class

Plaid::PaymentInitiationPaymentCreateRequest

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

PaymentInitiationPaymentCreateRequest defines the request schema for /payment_initiation/payment/create

Constants

MAX_LENGTH_FOR_REFERENCE = 18
MIN_LENGTH_FOR_REFERENCE = 1

Constructors

new(pull : JSON::PullParser)
Source
new(*, __pull_for_json_serializable pull : JSON::PullParser)
Source
new(*, recipient_id : String | Nil = nil, reference : String | Nil = nil, amount : Plaid::PaymentAmount | Nil = nil, client_id : String | Nil = nil, secret : String | Nil = nil, schedule : Plaid::ExternalPaymentScheduleRequest | Nil = nil, options : Plaid::ExternalPaymentOptions | 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

amount
Source
amount=(new_value : Plaid::PaymentAmount | 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
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
options
Source
options=(new_value : Plaid::ExternalPaymentOptions | Nil)

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

Source
options_present=(options_present : Bool)
Source
options_present?
Source
recipient_id

The ID of the recipient the payment is for.

Source
recipient_id=(new_value : String | Nil)

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

Source
reference

A reference for the payment. This must be an alphanumeric string with at most 18 characters and must not contain any special characters (since not all institutions support them). In order to track settlement via Payment Confirmation, each payment must have a unique reference. If the reference provided through the API is not unique, Plaid will adjust it. Both the originally provided and automatically adjusted references (if any) can be found in the reference and adjusted_reference fields, respectively.

Source
reference=(new_value : String | Nil)

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

Source
schedule
Source
schedule=(new_value : Plaid::ExternalPaymentScheduleRequest | Nil)

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

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
valid?

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

Source