Class: Plaid::TransferCreateRequest

Inherits:
Object
  • Object
show all
Defined in:
lib/plaid/models/transfer_create_request.rb

Overview

Defines the request schema for ‘/transfer/create`

Instance Attribute Summary collapse

Class Method Summary collapse

Instance Method Summary collapse

Constructor Details

#initialize(attributes = {}) ⇒ TransferCreateRequest

Initializes the object

Parameters:

  • attributes (Hash) (defaults to: {}) —

    Model attributes in the form of hash



129
130
131
132
133
134
135
136
137
138
139
140
141
142
143
144
145
146
147
148
149
150
151
152
153
154
155
156
157
158
159
160
161
162
163
164
165
166
167
168
169
170
171
172
173
174
175
176
177
178
179
180
181
182
183
184
185
186
187
188
189
190
191
192
193
194
195
196
197
198
199
200
201
202
203
204
205
206
207
208
209
210
211
 
# File 'lib/plaid/models/transfer_create_request.rb', line 129

def initialize(attributes = {})
  if (!attributes.is_a?(Hash))
    fail ArgumentError, "The input argument (attributes) must be a hash in `Plaid::TransferCreateRequest` initialize method"
  end

  # check to see if the attribute exists and convert string to symbol for hash key
  attributes = attributes.each_with_object({}) { |(k, v), h|
    if (!self.class.attribute_map.key?(k.to_sym))
      fail ArgumentError, "`#{k}` is not a valid attribute in `Plaid::TransferCreateRequest`. Please check the name to make sure it's valid. List of attributes: " + self.class.attribute_map.keys.inspect
    end
    h[k.to_sym] = v
  }

  if attributes.key?(:'client_id')
    self.client_id = attributes[:'client_id']
  end

  if attributes.key?(:'secret')
    self.secret = attributes[:'secret']
  end

  if attributes.key?(:'idempotency_key')
    self.idempotency_key = attributes[:'idempotency_key']
  end

  if attributes.key?(:'access_token')
    self.access_token = attributes[:'access_token']
  end

  if attributes.key?(:'account_id')
    self. = attributes[:'account_id']
  end

  if attributes.key?(:'authorization_id')
    self.authorization_id = attributes[:'authorization_id']
  end

  if attributes.key?(:'type')
    self.type = attributes[:'type']
  end

  if attributes.key?(:'network')
    self.network = attributes[:'network']
  end

  if attributes.key?(:'amount')
    self.amount = attributes[:'amount']
  end

  if attributes.key?(:'description')
    self.description = attributes[:'description']
  end

  if attributes.key?(:'ach_class')
    self.ach_class = attributes[:'ach_class']
  end

  if attributes.key?(:'user')
    self.user = attributes[:'user']
  end

  if attributes.key?(:'metadata')
    if (value = attributes[:'metadata']).is_a?(Hash)
      self.metadata = value
    end
  end

  if attributes.key?(:'origination_account_id')
    self. = attributes[:'origination_account_id']
  end

  if attributes.key?(:'iso_currency_code')
    self.iso_currency_code = attributes[:'iso_currency_code']
  end

  if attributes.key?(:'test_clock_id')
    self.test_clock_id = attributes[:'test_clock_id']
  end

  if attributes.key?(:'facilitator_fee')
    self.facilitator_fee = attributes[:'facilitator_fee']
  end
end

Instance Attribute Details

#access_token ⇒ Object

The Plaid ‘access_token` for the account that will be debited or credited.



29
30
31
 
# File 'lib/plaid/models/transfer_create_request.rb', line 29

def access_token
  @access_token
end

#account_id ⇒ Object

The Plaid ‘account_id` corresponding to the end-user account that will be debited or credited.



32
33
34
 
# File 'lib/plaid/models/transfer_create_request.rb', line 32

def 
  @account_id
end

#ach_class ⇒ Object

Returns the value of attribute ach_class.



47
48
49
 
# File 'lib/plaid/models/transfer_create_request.rb', line 47

def ach_class
  @ach_class
end

#amount ⇒ Object

The amount of the transfer (decimal string with two digits of precision e.g. "10.00"). When calling ‘/transfer/authorization/create`, specify the maximum amount to authorize. When calling `/transfer/create`, specify the exact amount of the transfer, up to a maximum of the amount authorized. If this field is left blank when calling `/transfer/create`, the maximum amount authorized in the `authorization_id` will be sent.



42
43
44
 
# File 'lib/plaid/models/transfer_create_request.rb', line 42

def amount
  @amount
end

#authorization_id ⇒ Object

Plaid’s unique identifier for a transfer authorization. This parameter also serves the purpose of acting as an idempotency identifier.



35
36
37
 
# File 'lib/plaid/models/transfer_create_request.rb', line 35

def authorization_id
  @authorization_id
end

#client_id ⇒ Object

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.



20
21
22
 
# File 'lib/plaid/models/transfer_create_request.rb', line 20

def client_id
  @client_id
end

#description ⇒ Object

The transfer description, maximum of 15 characters. Should represent why the money is moving, not your company name. For recommendations on setting the ‘description` field to avoid ACH returns, see [Description field recommendations](www.plaid.com/docs/transfers/creating-transfers/#description-field-recommendations). If reprocessing a returned transfer, the `description` field must be `"Retry 1"` or `"Retry 2"`. You may retry a transfer up to 2 times, within 180 days of creating the original transfer. Only transfers that were returned with code `R01` or `R09` may be retried.



45
46
47
 
# File 'lib/plaid/models/transfer_create_request.rb', line 45

def description
  @description
end

#facilitator_fee ⇒ Object

The amount to deduct from ‘transfer.amount` and distribute to the platform’s Ledger balance as a facilitator fee (decimal string with two digits of precision e.g. "10.00"). The remainder will go to the end-customer’s Ledger balance. This must be value greater than 0 and less than or equal to the `transfer.amount`.



64
65
66
 
# File 'lib/plaid/models/transfer_create_request.rb', line 64

def facilitator_fee
  @facilitator_fee
end

#idempotency_key ⇒ Object

Deprecated. ‘authorization_id` is now used as idempotency instead. A random key provided by the client, per unique transfer. Maximum of 50 characters. The API supports idempotency for safely retrying requests without accidentally performing the same operation twice. For example, if a request to create a transfer fails due to a network connection error, you can retry the request with the same idempotency key to guarantee that only a single transfer is created.



26
27
28
 
# File 'lib/plaid/models/transfer_create_request.rb', line 26

def idempotency_key
  @idempotency_key
end

#iso_currency_code ⇒ Object

The currency of the transfer amount. The default value is "USD".



58
59
60
 
# File 'lib/plaid/models/transfer_create_request.rb', line 58

def iso_currency_code
  @iso_currency_code
end

#metadata ⇒ Object

The Metadata object is a mapping of client-provided string fields to any string value. The following limitations apply: The JSON values must be Strings (no nested JSON objects allowed) Only ASCII characters may be used Maximum of 50 key/value pairs Maximum key length of 40 characters Maximum value length of 500 characters



52
53
54
 
# File 'lib/plaid/models/transfer_create_request.rb', line 52

def metadata
  @metadata
end

#network ⇒ Object

Returns the value of attribute network.



39
40
41
 
# File 'lib/plaid/models/transfer_create_request.rb', line 39

def network
  @network
end

#origination_account_id ⇒ Object

Plaid’s unique identifier for the origination account for this transfer. If you have more than one origination account, this value must be specified. Otherwise, this field should be left blank.



55
56
57
 
# File 'lib/plaid/models/transfer_create_request.rb', line 55

def 
  @origination_account_id
end

#secret ⇒ Object

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.



23
24
25
 
# File 'lib/plaid/models/transfer_create_request.rb', line 23

def secret
  @secret
end

#test_clock_id ⇒ Object

Plaid’s unique identifier for a test clock. This field may only be used when using ‘sandbox` environment. If provided, the `transfer` is created at the `virtual_time` on the provided `test_clock`.



61
62
63
 
# File 'lib/plaid/models/transfer_create_request.rb', line 61

def test_clock_id
  @test_clock_id
end

#type ⇒ Object

Returns the value of attribute type.



37
38
39
 
# File 'lib/plaid/models/transfer_create_request.rb', line 37

def type
  @type
end

#user ⇒ Object

Returns the value of attribute user.



49
50
51
 
# File 'lib/plaid/models/transfer_create_request.rb', line 49

def user
  @user
end

Class Method Details

.acceptable_attributes ⇒ Object

Returns all the JSON keys this model knows about



90
91
92
 
# File 'lib/plaid/models/transfer_create_request.rb', line 90

def self.acceptable_attributes
  attribute_map.values
end

.attribute_map ⇒ Object

Attribute mapping from ruby-style variable name to JSON key.



67
68
69
70
71
72
73
74
75
76
77
78
79
80
81
82
83
84
85
86
87
 
# File 'lib/plaid/models/transfer_create_request.rb', line 67

def self.attribute_map
  {
    :'client_id' => :'client_id',
    :'secret' => :'secret',
    :'idempotency_key' => :'idempotency_key',
    :'access_token' => :'access_token',
    :'account_id' => :'account_id',
    :'authorization_id' => :'authorization_id',
    :'type' => :'type',
    :'network' => :'network',
    :'amount' => :'amount',
    :'description' => :'description',
    :'ach_class' => :'ach_class',
    :'user' => :'user',
    :'metadata' => :'metadata',
    :'origination_account_id' => :'origination_account_id',
    :'iso_currency_code' => :'iso_currency_code',
    :'test_clock_id' => :'test_clock_id',
    :'facilitator_fee' => :'facilitator_fee'
  }
end

.build_from_hash(attributes) ⇒ Object

Builds the object from hash

Parameters:

  • attributes (Hash) —

    Model attributes in the form of hash

Returns:

  • (Object) —

    Returns the model itself



332
333
334
 
# File 'lib/plaid/models/transfer_create_request.rb', line 332

def self.build_from_hash(attributes)
  new.build_from_hash(attributes)
end

.openapi_nullable ⇒ Object

List of attributes with nullable: true



118
119
120
121
122
123
124
125
 
# File 'lib/plaid/models/transfer_create_request.rb', line 118

def self.openapi_nullable
  Set.new([
    :'user',
    :'metadata',
    :'origination_account_id',
    :'test_clock_id',
  ])
end

.openapi_types ⇒ Object

Attribute type mapping.



95
96
97
98
99
100
101
102
103
104
105
106
107
108
109
110
111
112
113
114
115
 
# File 'lib/plaid/models/transfer_create_request.rb', line 95

def self.openapi_types
  {
    :'client_id' => :'String',
    :'secret' => :'String',
    :'idempotency_key' => :'String',
    :'access_token' => :'String',
    :'account_id' => :'String',
    :'authorization_id' => :'String',
    :'type' => :'TransferType',
    :'network' => :'TransferNetwork',
    :'amount' => :'String',
    :'description' => :'String',
    :'ach_class' => :'ACHClass',
    :'user' => :'TransferUserInRequestDeprecated',
    :'metadata' => :'Hash<String, String>',
    :'origination_account_id' => :'String',
    :'iso_currency_code' => :'String',
    :'test_clock_id' => :'String',
    :'facilitator_fee' => :'String'
  }
end

Instance Method Details

#==(o) ⇒ Object

Checks equality by comparing each attribute.

Parameters:

  • Object (Object) —

    to be compared



295
296
297
298
299
300
301
302
303
304
305
306
307
308
309
310
311
312
313
314
315
 
# File 'lib/plaid/models/transfer_create_request.rb', line 295

def ==(o)
  return true if self.equal?(o)
  self.class == o.class &&
      client_id == o.client_id &&
      secret == o.secret &&
      idempotency_key == o.idempotency_key &&
      access_token == o.access_token &&
       == o. &&
      authorization_id == o.authorization_id &&
      type == o.type &&
      network == o.network &&
      amount == o.amount &&
      description == o.description &&
      ach_class == o.ach_class &&
      user == o.user &&
      metadata == o.metadata &&
       == o. &&
      iso_currency_code == o.iso_currency_code &&
      test_clock_id == o.test_clock_id &&
      facilitator_fee == o.facilitator_fee
end

#_deserialize(type, value) ⇒ Object

Deserializes the data based on type

Parameters:

  • string —

    type Data type

  • string —

    value Value to be deserialized

Returns:

  • (Object) —

    Deserialized data



363
364
365
366
367
368
369
370
371
372
373
374
375
376
377
378
379
380
381
382
383
384
385
386
387
388
389
390
391
392
393
394
395
396
397
398
399
400
 
# File 'lib/plaid/models/transfer_create_request.rb', line 363

def _deserialize(type, value)
  case type.to_sym
  when :Time
    Time.parse(value)
  when :Date
    Date.parse(value)
  when :String
    value.to_s
  when :Integer
    value.to_i
  when :Float
    value.to_f
  when :Boolean
    if value.to_s =~ /\A(true|t|yes|y|1)\z/i
      true
    else
      false
    end
  when :Object
    # generic object (usually a Hash), return directly
    value
  when /\AArray<(?<inner_type>.+)>\z/
    inner_type = Regexp.last_match[:inner_type]
    value.map { |v| _deserialize(inner_type, v) }
  when /\AHash<(?<k_type>.+?), (?<v_type>.+)>\z/
    k_type = Regexp.last_match[:k_type]
    v_type = Regexp.last_match[:v_type]
    {}.tap do |hash|
      value.each do |k, v|
        hash[_deserialize(k_type, k)] = _deserialize(v_type, v)
      end
    end
  else # model
    # models (e.g. Pet) or oneOf
    klass = Plaid.const_get(type)
    klass.respond_to?(:openapi_one_of) ? klass.build(value) : klass.build_from_hash(value)
  end
end

#_to_hash(value) ⇒ Hash

Outputs non-array value in the form of hash For object, use to_hash. Otherwise, just return the value

Parameters:

  • value (Object) —

    Any valid value

Returns:

  • (Hash) —

    Returns the value in the form of hash



434
435
436
437
438
439
440
441
442
443
444
445
446
 
# File 'lib/plaid/models/transfer_create_request.rb', line 434

def _to_hash(value)
  if value.is_a?(Array)
    value.compact.map { |v| _to_hash(v) }
  elsif value.is_a?(Hash)
    {}.tap do |hash|
      value.each { |k, v| hash[k] = _to_hash(v) }
    end
  elsif value.respond_to? :to_hash
    value.to_hash
  else
    value
  end
end

#build_from_hash(attributes) ⇒ Object

Builds the object from hash

Parameters:

  • attributes (Hash) —

    Model attributes in the form of hash

Returns:

  • (Object) —

    Returns the model itself



339
340
341
342
343
344
345
346
347
348
349
350
351
352
353
354
355
356
357
 
# File 'lib/plaid/models/transfer_create_request.rb', line 339

def build_from_hash(attributes)
  return nil unless attributes.is_a?(Hash)
  attributes = attributes.transform_keys(&:to_sym)
  self.class.openapi_types.each_pair do |key, type|
    if attributes[self.class.attribute_map[key]].nil? && self.class.openapi_nullable.include?(key)
      self.send("#{key}=", nil)
    elsif type =~ /\AArray<(.*)>/i
      # check to ensure the input is an array given that the attribute
      # is documented as an array but the input is not
      if attributes[self.class.attribute_map[key]].is_a?(Array)
        self.send("#{key}=", attributes[self.class.attribute_map[key]].map { |v| _deserialize($1, v) })
      end
    elsif !attributes[self.class.attribute_map[key]].nil?
      self.send("#{key}=", _deserialize(type, attributes[self.class.attribute_map[key]]))
    end
  end

  self
end

#eql?(o) ⇒ Boolean

Parameters:

  • Object (Object) —

    to be compared

Returns:

  • (Boolean)

See Also:

  • `==` method


319
320
321
 
# File 'lib/plaid/models/transfer_create_request.rb', line 319

def eql?(o)
  self == o
end

#hash ⇒ Integer

Calculates hash code according to all attributes.

Returns:

  • (Integer) —

    Hash code



325
326
327
 
# File 'lib/plaid/models/transfer_create_request.rb', line 325

def hash
  [client_id, secret, idempotency_key, access_token, , authorization_id, type, network, amount, description, ach_class, user, metadata, , iso_currency_code, test_clock_id, facilitator_fee].hash
end

#list_invalid_properties ⇒ Object

Show invalid properties with the reasons. Usually used together with valid?

Returns:

  • Array for valid properties with the reasons



215
216
217
218
219
220
221
222
223
224
225
226
227
228
229
230
231
232
233
234
235
236
237
238
239
240
241
242
243
244
245
 
# File 'lib/plaid/models/transfer_create_request.rb', line 215

def list_invalid_properties
  invalid_properties = Array.new
  if !@idempotency_key.nil? && @idempotency_key.to_s.length > 50
    invalid_properties.push('invalid value for "idempotency_key", the character length must be smaller than or equal to 50.')
  end


  if @access_token.nil?
    invalid_properties.push('invalid value for "access_token", access_token cannot be nil.')
  end

  if @account_id.nil?
    invalid_properties.push('invalid value for "account_id", account_id cannot be nil.')
  end

  if @authorization_id.nil?
    invalid_properties.push('invalid value for "authorization_id", authorization_id cannot be nil.')
  end

  if @description.nil?
    invalid_properties.push('invalid value for "description", description cannot be nil.')
  end

  if @description.to_s.length > 15
    invalid_properties.push('invalid value for "description", the character length must be smaller than or equal to 15.')
  end



  invalid_properties
end

#to_body ⇒ Hash

to_body is an alias to to_hash (backward compatibility)

Returns:

  • (Hash) —

    Returns the object in the form of hash



410
411
412
 
# File 'lib/plaid/models/transfer_create_request.rb', line 410

def to_body
  to_hash
end

#to_hash ⇒ Hash

Returns the object in the form of hash

Returns:

  • (Hash) —

    Returns the object in the form of hash



416
417
418
419
420
421
422
423
424
425
426
427
428
 
# File 'lib/plaid/models/transfer_create_request.rb', line 416

def to_hash
  hash = {}
  self.class.attribute_map.each_pair do |attr, param|
    value = self.send(attr)
    if value.nil?
      is_nullable = self.class.openapi_nullable.include?(attr)
      next if !is_nullable || (is_nullable && !instance_variable_defined?(:"@#{attr}"))
    end

    hash[param] = _to_hash(value)
  end
  hash
end

#to_s ⇒ String

Returns the string representation of the object

Returns:

  • (String) —

    String presentation of the object



404
405
406
 
# File 'lib/plaid/models/transfer_create_request.rb', line 404

def to_s
  to_hash.to_s
end

#valid? ⇒ Boolean

Check to see if the all the properties in the model are valid

Returns:

  • (Boolean) —

    true if the model is valid



249
250
251
252
253
254
255
256
257
258
 
# File 'lib/plaid/models/transfer_create_request.rb', line 249

def valid?
  return false if !@idempotency_key.nil? && @idempotency_key.to_s.length > 50
  return false if @access_token.nil?
  return false if @account_id.nil?
  return false if @authorization_id.nil?
  return false if @description.nil?
  return false if @description.to_s.length > 15
  return false if !@metadata.nil? && @metadata.length > 50
  true
end