class

Plaid::PaymentInitiationConsentCreateRequest

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

PaymentInitiationConsentCreateRequest defines the request schema for /payment_initiation/consent/create

Constants

MAX_LENGTH_FOR_REFERENCE = 18
MIN_ITEMS_FOR_SCOPES = 1
MIN_LENGTH_FOR_REFERENCE = 1

Constructors

new(*, __pull_for_json_serializable pull : JSON::PullParser)
Source
new(*, recipient_id : String | Nil = nil, reference : String | Nil = nil, scopes : Array(PaymentInitiationConsentScope) | Nil = nil, constraints : Plaid::PaymentInitiationConsentConstraints | Nil = nil, client_id : String | Nil = nil, secret : String | Nil = nil, options : Plaid::ExternalPaymentInitiationConsentOptions | 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

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
constraints
Source
constraints=(new_value : Plaid::PaymentInitiationConsentConstraints | Nil)

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

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 consent is for. The created consent can be used to transfer funds to this recipient only.

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 consent. This must be an alphanumeric string with at most 18 characters and must not contain any special characters.

Source
reference=(new_value : String | Nil)

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

Source
scopes

An array of payment consent scopes.

Source
scopes=(new_value : Array(PaymentInitiationConsentScope) | Nil)

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