Class: ThePlaidApi::BankTransferCreateRequest

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

Overview

Defines the request schema for ‘/bank_transfer/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(idempotency_key:, access_token:, account_id:, type:, network:, amount:, iso_currency_code:, description:, user:, client_id: SKIP, secret: SKIP, ach_class: SKIP, custom_tag: SKIP, metadata: SKIP, origination_account_id: SKIP, additional_properties: nil) ⇒ BankTransferCreateRequest

Returns a new instance of BankTransferCreateRequest.



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
 
# File 'lib/the_plaid_api/models/bank_transfer_create_request.rb', line 153

def initialize(idempotency_key:, access_token:, account_id:, type:,
               network:, amount:, iso_currency_code:, description:, user:,
               client_id: SKIP, secret: SKIP, ach_class: SKIP,
               custom_tag: SKIP, metadata: SKIP,
               origination_account_id: 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
  @idempotency_key = idempotency_key
  @access_token = access_token
  @account_id = 
  @type = type
  @network = network
  @amount = amount
  @iso_currency_code = iso_currency_code
  @description = description
  @ach_class = ach_class unless ach_class == SKIP
  @user = user
  @custom_tag = custom_tag unless custom_tag == SKIP
  @metadata = metadata unless metadata == SKIP
  @origination_account_id =  unless  == SKIP
  @additional_properties = additional_properties
end

Instance Attribute Details

#access_token ⇒ String

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

Returns:

  • (String) 


35
36
37
 
# File 'lib/the_plaid_api/models/bank_transfer_create_request.rb', line 35

def access_token
  @access_token
end

#account_id ⇒ String

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

Returns:

  • (String) 


39
40
41
 
# File 'lib/the_plaid_api/models/bank_transfer_create_request.rb', line 39

def 
  @account_id
end

#ach_class ⇒ AchClass

Specifies the use case of the transfer. Required for transfers on an ACH network. For more details, see [ACH SEC codes](plaid.com/docs/transfer/creating-transfers/#ach-sec-codes). Codes supported for credits: ‘ccd`, `ppd` Codes supported for debits: `ccd`, `tel`, `web` `“ccd”` - Corporate Credit or Debit - fund transfer between two corporate bank accounts `“ppd”` - Prearranged Payment or Deposit - The transfer is part of a pre-existing relationship with a consumer. Authorization was obtained in writing either in person or via an electronic document signing, e.g. Docusign, by the consumer. Can be used for credits or debits. `“web”` - Internet-Initiated Entry. The transfer debits a consumer’s bank account. Authorization from the consumer is obtained over the Internet (e.g. a web or mobile application). Can be used for single debits or recurring debits. `“tel”` - Telephone-Initiated Entry. The transfer debits a consumer. Debit authorization has been received orally over the telephone via a recorded call.

Returns:



84
85
86
 
# File 'lib/the_plaid_api/models/bank_transfer_create_request.rb', line 84

def ach_class
  @ach_class
end

#amount ⇒ String

The amount of the bank transfer (decimal string with two digits of precision e.g. “10.00”).

Returns:

  • (String) 


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

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) 


16
17
18
 
# File 'lib/the_plaid_api/models/bank_transfer_create_request.rb', line 16

def client_id
  @client_id
end

#custom_tag ⇒ String

An arbitrary string provided by the client for storage with the bank transfer. May be up to 100 characters.

Returns:

  • (String) 


93
94
95
 
# File 'lib/the_plaid_api/models/bank_transfer_create_request.rb', line 93

def custom_tag
  @custom_tag
end

#description ⇒ String

The transfer description. Maximum of 10 characters.

Returns:

  • (String) 


63
64
65
 
# File 'lib/the_plaid_api/models/bank_transfer_create_request.rb', line 63

def description
  @description
end

#idempotency_key ⇒ String

A random key provided by the client, per unique bank 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 bank transfer fails due to a network connection error, you can retry the request with the same idempotency key to guarantee that only a single bank transfer is created.

Returns:

  • (String) 


31
32
33
 
# File 'lib/the_plaid_api/models/bank_transfer_create_request.rb', line 31

def idempotency_key
  @idempotency_key
end

#iso_currency_code ⇒ String

The currency of the transfer amount – should be set to “USD”.

Returns:

  • (String) 


59
60
61
 
# File 'lib/the_plaid_api/models/bank_transfer_create_request.rb', line 59

def iso_currency_code
  @iso_currency_code
end

#metadata ⇒ Hash[String, String]

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

Returns:

  • (Hash[String, String]) 


103
104
105
 
# File 'lib/the_plaid_api/models/bank_transfer_create_request.rb', line 103

def metadata
  @metadata
end

#network ⇒ BankTransferNetwork

The network or rails used for the transfer. Valid options are ‘ach`, `same-day-ach`, or `wire`.

Returns:



50
51
52
 
# File 'lib/the_plaid_api/models/bank_transfer_create_request.rb', line 50

def network
  @network
end

#origination_account_id ⇒ String

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.

Returns:

  • (String) 


109
110
111
 
# File 'lib/the_plaid_api/models/bank_transfer_create_request.rb', line 109

def 
  @origination_account_id
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) 


21
22
23
 
# File 'lib/the_plaid_api/models/bank_transfer_create_request.rb', line 21

def secret
  @secret
end

#type ⇒ BankTransferType

The type of bank transfer. This will be either ‘debit` or `credit`. A `debit` indicates a transfer of money into the origination account; a `credit` indicates a transfer of money out of the origination account.

Returns:



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

def type
  @type
end

#user ⇒ BankTransferUser

The legal name and other information for the account holder.

Returns:



88
89
90
 
# File 'lib/the_plaid_api/models/bank_transfer_create_request.rb', line 88

def user
  @user
end

Class Method Details

.from_hash(hash) ⇒ Object

Creates an instance of the object from a hash.



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
212
213
214
215
216
217
218
219
220
221
222
223
224
225
226
227
 
# File 'lib/the_plaid_api/models/bank_transfer_create_request.rb', line 180

def self.from_hash(hash)
  return nil unless hash

  # Extract variables from the hash.
  idempotency_key =
    hash.key?('idempotency_key') ? hash['idempotency_key'] : nil
  access_token = hash.key?('access_token') ? hash['access_token'] : nil
   = hash.key?('account_id') ? hash['account_id'] : nil
  type = hash.key?('type') ? hash['type'] : nil
  network = hash.key?('network') ? hash['network'] : nil
  amount = hash.key?('amount') ? hash['amount'] : nil
  iso_currency_code =
    hash.key?('iso_currency_code') ? hash['iso_currency_code'] : nil
  description = hash.key?('description') ? hash['description'] : nil
  user = BankTransferUser.from_hash(hash['user']) if hash['user']
  client_id = hash.key?('client_id') ? hash['client_id'] : SKIP
  secret = hash.key?('secret') ? hash['secret'] : SKIP
  ach_class = hash.key?('ach_class') ? hash['ach_class'] : SKIP
  custom_tag = hash.key?('custom_tag') ? hash['custom_tag'] : SKIP
  metadata = hash.key?('metadata') ? hash['metadata'] : SKIP
   =
    hash.key?('origination_account_id') ? hash['origination_account_id'] : SKIP

  # 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.
  BankTransferCreateRequest.new(idempotency_key: idempotency_key,
                                access_token: access_token,
                                account_id: ,
                                type: type,
                                network: network,
                                amount: amount,
                                iso_currency_code: iso_currency_code,
                                description: description,
                                user: user,
                                client_id: client_id,
                                secret: secret,
                                ach_class: ach_class,
                                custom_tag: custom_tag,
                                metadata: metadata,
                                origination_account_id: ,
                                additional_properties: additional_properties)
end

.names ⇒ Object

A mapping from model property names to API property names.



112
113
114
115
116
117
118
119
120
121
122
123
124
125
126
127
128
129
130
 
# File 'lib/the_plaid_api/models/bank_transfer_create_request.rb', line 112

def self.names
  @_hash = {} if @_hash.nil?
  @_hash['client_id'] = 'client_id'
  @_hash['secret'] = 'secret'
  @_hash['idempotency_key'] = 'idempotency_key'
  @_hash['access_token'] = 'access_token'
  @_hash['account_id'] = 'account_id'
  @_hash['type'] = 'type'
  @_hash['network'] = 'network'
  @_hash['amount'] = 'amount'
  @_hash['iso_currency_code'] = 'iso_currency_code'
  @_hash['description'] = 'description'
  @_hash['ach_class'] = 'ach_class'
  @_hash['user'] = 'user'
  @_hash['custom_tag'] = 'custom_tag'
  @_hash['metadata'] = 'metadata'
  @_hash['origination_account_id'] = 'origination_account_id'
  @_hash
end

.nullables ⇒ Object

An array for nullable fields



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

def self.nullables
  %w[
    custom_tag
    metadata
    origination_account_id
  ]
end

.optionals ⇒ Object

An array for optional fields



133
134
135
136
137
138
139
140
141
142
 
# File 'lib/the_plaid_api/models/bank_transfer_create_request.rb', line 133

def self.optionals
  %w[
    client_id
    secret
    ach_class
    custom_tag
    metadata
    origination_account_id
  ]
end

Instance Method Details

#inspect ⇒ Object

Provides a debugging-friendly string with detailed object information.



241
242
243
244
245
246
247
248
249
250
251
 
# File 'lib/the_plaid_api/models/bank_transfer_create_request.rb', line 241

def inspect
  class_name = self.class.name.split('::').last
  "<#{class_name} client_id: #{@client_id.inspect}, secret: #{@secret.inspect},"\
  " idempotency_key: #{@idempotency_key.inspect}, access_token: #{@access_token.inspect},"\
  " account_id: #{@account_id.inspect}, type: #{@type.inspect}, network: #{@network.inspect},"\
  " amount: #{@amount.inspect}, iso_currency_code: #{@iso_currency_code.inspect}, description:"\
  " #{@description.inspect}, ach_class: #{@ach_class.inspect}, user: #{@user.inspect},"\
  " custom_tag: #{@custom_tag.inspect}, metadata: #{@metadata.inspect},"\
  " origination_account_id: #{@origination_account_id.inspect}, additional_properties:"\
  " #{@additional_properties}>"
end

#to_s ⇒ Object

Provides a human-readable string representation of the object.



230
231
232
233
234
235
236
237
238
 
# File 'lib/the_plaid_api/models/bank_transfer_create_request.rb', line 230

def to_s
  class_name = self.class.name.split('::').last
  "<#{class_name} client_id: #{@client_id}, secret: #{@secret}, idempotency_key:"\
  " #{@idempotency_key}, access_token: #{@access_token}, account_id: #{@account_id}, type:"\
  " #{@type}, network: #{@network}, amount: #{@amount}, iso_currency_code:"\
  " #{@iso_currency_code}, description: #{@description}, ach_class: #{@ach_class}, user:"\
  " #{@user}, custom_tag: #{@custom_tag}, metadata: #{@metadata}, origination_account_id:"\
  " #{@origination_account_id}, additional_properties: #{@additional_properties}>"
end