Class: ThePlaidApi::PaymentInitiationPaymentCreateRequest

Inherits:
BaseModel
  • Object
show all
Defined in:
lib/the_plaid_api/models/payment_initiation_payment_create_request.rb

Overview

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

Instance Attribute Summary collapse

Class Method Summary collapse

Instance Method Summary collapse

Methods inherited from BaseModel

#check_for_conflict, #process_additional_properties, #process_array, #process_basic_value, #process_hash, #to_hash, #to_json

Constructor Details

#initialize(recipient_id:, reference:, amount:, client_id: SKIP, secret: SKIP, schedule: SKIP, options: SKIP, additional_properties: nil) ⇒ PaymentInitiationPaymentCreateRequest

Returns a new instance of PaymentInitiationPaymentCreateRequest.



88
89
90
91
92
93
94
95
96
97
98
99
100
101
102
 
# File 'lib/the_plaid_api/models/payment_initiation_payment_create_request.rb', line 88

def initialize(recipient_id:, reference:, amount:, client_id: SKIP,
               secret: SKIP, schedule: SKIP, options: SKIP,
               additional_properties: nil)
  # Add additional model properties to the instance
  additional_properties = {} if additional_properties.nil?

  @client_id = client_id unless client_id == SKIP
  @secret = secret unless secret == SKIP
  @recipient_id = recipient_id
  @reference = reference
  @amount = amount
  @schedule = schedule unless schedule == SKIP
  @options = options unless options == SKIP
  @additional_properties = additional_properties
end

Instance Attribute Details

#amount ⇒ PaymentAmount

The amount and currency of a payment

Returns:



45
46
47
 
# File 'lib/the_plaid_api/models/payment_initiation_payment_create_request.rb', line 45

def amount
  @amount
end

#client_id ⇒ String

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.

Returns:

  • (String) 


17
18
19
 
# File 'lib/the_plaid_api/models/payment_initiation_payment_create_request.rb', line 17

def client_id
  @client_id
end

#options ⇒ PaymentOptions

Additional payment options

Returns:



55
56
57
 
# File 'lib/the_plaid_api/models/payment_initiation_payment_create_request.rb', line 55

def options
  @options
end

#recipient_id ⇒ String

The ID of the recipient the payment is for.

Returns:

  • (String) 


26
27
28
 
# File 'lib/the_plaid_api/models/payment_initiation_payment_create_request.rb', line 26

def recipient_id
  @recipient_id
end

#reference ⇒ String

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. Some institutions may limit the reference to less than 18 characters. If necessary, Plaid will adjust the reference by truncating it to fit the institution’s requirements. Both the originally provided and automatically adjusted references (if any) can be found in the ‘reference` and `adjusted_reference` fields, respectively.

Returns:

  • (String) 


41
42
43
 
# File 'lib/the_plaid_api/models/payment_initiation_payment_create_request.rb', line 41

def reference
  @reference
end

#schedule ⇒ ExternalPaymentScheduleRequest

The schedule that the payment will be executed on. If a schedule is provided, the payment is automatically set up as a standing order. If no schedule is specified, the payment will be executed only once.

Returns:



51
52
53
 
# File 'lib/the_plaid_api/models/payment_initiation_payment_create_request.rb', line 51

def schedule
  @schedule
end

#secret ⇒ String

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.

Returns:

  • (String) 


22
23
24
 
# File 'lib/the_plaid_api/models/payment_initiation_payment_create_request.rb', line 22

def secret
  @secret
end

Class Method Details

.from_hash(hash) ⇒ Object

Creates an instance of the object from a hash.



105
106
107
108
109
110
111
112
113
114
115
116
117
118
119
120
121
122
123
124
125
126
127
128
129
130
131
132
133
 
# File 'lib/the_plaid_api/models/payment_initiation_payment_create_request.rb', line 105

def self.from_hash(hash)
  return nil unless hash

  # Extract variables from the hash.
  recipient_id = hash.key?('recipient_id') ? hash['recipient_id'] : nil
  reference = hash.key?('reference') ? hash['reference'] : nil
  amount = PaymentAmount.from_hash(hash['amount']) if hash['amount']
  client_id = hash.key?('client_id') ? hash['client_id'] : SKIP
  secret = hash.key?('secret') ? hash['secret'] : SKIP
  schedule = ExternalPaymentScheduleRequest.from_hash(hash['schedule']) if hash['schedule']
  options = PaymentOptions.from_hash(hash['options']) if hash['options']

  # Create a new hash for additional properties, removing known properties.
  new_hash = hash.reject { |k, _| names.value?(k) }

  additional_properties = APIHelper.get_additional_properties(
    new_hash, proc { |value| value }
  )

  # Create object from extracted values.
  PaymentInitiationPaymentCreateRequest.new(recipient_id: recipient_id,
                                            reference: reference,
                                            amount: amount,
                                            client_id: client_id,
                                            secret: secret,
                                            schedule: schedule,
                                            options: options,
                                            additional_properties: additional_properties)
end

.names ⇒ Object

A mapping from model property names to API property names.



58
59
60
61
62
63
64
65
66
67
68
 
# File 'lib/the_plaid_api/models/payment_initiation_payment_create_request.rb', line 58

def self.names
  @_hash = {} if @_hash.nil?
  @_hash['client_id'] = 'client_id'
  @_hash['secret'] = 'secret'
  @_hash['recipient_id'] = 'recipient_id'
  @_hash['reference'] = 'reference'
  @_hash['amount'] = 'amount'
  @_hash['schedule'] = 'schedule'
  @_hash['options'] = 'options'
  @_hash
end

.nullables ⇒ Object

An array for nullable fields



81
82
83
84
85
86
 
# File 'lib/the_plaid_api/models/payment_initiation_payment_create_request.rb', line 81

def self.nullables
  %w[
    schedule
    options
  ]
end

.optionals ⇒ Object

An array for optional fields



71
72
73
74
75
76
77
78
 
# File 'lib/the_plaid_api/models/payment_initiation_payment_create_request.rb', line 71

def self.optionals
  %w[
    client_id
    secret
    schedule
    options
  ]
end

Instance Method Details

#inspect ⇒ Object

Provides a debugging-friendly string with detailed object information.



144
145
146
147
148
149
150
 
# File 'lib/the_plaid_api/models/payment_initiation_payment_create_request.rb', line 144

def inspect
  class_name = self.class.name.split('::').last
  "<#{class_name} client_id: #{@client_id.inspect}, secret: #{@secret.inspect}, recipient_id:"\
  " #{@recipient_id.inspect}, reference: #{@reference.inspect}, amount: #{@amount.inspect},"\
  " schedule: #{@schedule.inspect}, options: #{@options.inspect}, additional_properties:"\
  " #{@additional_properties}>"
end

#to_s ⇒ Object

Provides a human-readable string representation of the object.



136
137
138
139
140
141
 
# File 'lib/the_plaid_api/models/payment_initiation_payment_create_request.rb', line 136

def to_s
  class_name = self.class.name.split('::').last
  "<#{class_name} client_id: #{@client_id}, secret: #{@secret}, recipient_id:"\
  " #{@recipient_id}, reference: #{@reference}, amount: #{@amount}, schedule: #{@schedule},"\
  " options: #{@options}, additional_properties: #{@additional_properties}>"
end