Class: ModernTreasury::Resources::ExternalAccounts

Inherits:
Object
  • Object
show all
Defined in:
lib/modern_treasury/resources/external_accounts.rb

Instance Method Summary collapse

Constructor Details

#initialize(client:) ⇒ ExternalAccounts

This method is part of a private API. You should avoid using this method if possible, as it may be removed or be changed in the future.

Returns a new instance of ExternalAccounts.

Parameters:



234
235
236
 
# File 'lib/modern_treasury/resources/external_accounts.rb', line 234

def initialize(client:)
  @client = client
end

Instance Method Details

#complete_verification(id, amounts: nil, request_options: {}) ⇒ ModernTreasury::Models::ExternalAccount

complete verification of external account

Parameters:

Returns:

See Also:



185
186
187
188
189
190
191
192
193
194
 
# File 'lib/modern_treasury/resources/external_accounts.rb', line 185

def complete_verification(id, params = {})
  parsed, options = ModernTreasury::ExternalAccountCompleteVerificationParams.dump_request(params)
  @client.request(
    method: :post,
    path: ["api/external_accounts/%1$s/complete_verification", id],
    body: parsed,
    model: ModernTreasury::ExternalAccount,
    options: options
  )
end

#create(counterparty_id: , account_details: nil, account_type: nil, contact_details: nil, external_id: nil, ledger_account: nil, metadata: nil, name: nil, party_address: nil, party_identifier: nil, party_name: nil, party_type: nil, plaid_processor_token: nil, routing_details: nil, request_options: {}) ⇒ ModernTreasury::Models::ExternalAccount

Some parameter documentations has been truncated, see Models::ExternalAccountCreateParams for more details.

create external account

Parameters:

Returns:

See Also:



46
47
48
49
50
51
52
53
54
55
 
# File 'lib/modern_treasury/resources/external_accounts.rb', line 46

def create(params)
  parsed, options = ModernTreasury::ExternalAccountCreateParams.dump_request(params)
  @client.request(
    method: :post,
    path: "api/external_accounts",
    body: parsed,
    model: ModernTreasury::ExternalAccount,
    options: options
  )
end

#delete(id, request_options: {}) ⇒ nil

delete external account

Parameters:

Returns:

  • (nil)

See Also:



163
164
165
166
167
168
169
170
 
# File 'lib/modern_treasury/resources/external_accounts.rb', line 163

def delete(id, params = {})
  @client.request(
    method: :delete,
    path: ["api/external_accounts/%1$s", id],
    model: NilClass,
    options: params[:request_options]
  )
end

#list(after_cursor: nil, counterparty_id: nil, external_id: nil, metadata: nil, party_name: nil, per_page: nil, request_options: {}) ⇒ ModernTreasury::Internal::Page<ModernTreasury::Models::ExternalAccount>

Some parameter documentations has been truncated, see Models::ExternalAccountListParams for more details.

list external accounts

Parameters:

  • after_cursor (String, nil)
  • counterparty_id (String)
  • external_id (String) —

    An optional user-defined 180 character unique identifier.

  • metadata (Hash{Symbol=>String}) —

    For example, if you want to query for records with metadata key ‘Type` and value

  • party_name (String) —

    Searches the ExternalAccount’s party_name AND the Counterparty’s party_name

  • per_page (Integer)
  • request_options (ModernTreasury::RequestOptions, Hash{Symbol=>Object}, nil)

Returns:

See Also:



140
141
142
143
144
145
146
147
148
149
150
 
# File 'lib/modern_treasury/resources/external_accounts.rb', line 140

def list(params = {})
  parsed, options = ModernTreasury::ExternalAccountListParams.dump_request(params)
  @client.request(
    method: :get,
    path: "api/external_accounts",
    query: parsed,
    page: ModernTreasury::Internal::Page,
    model: ModernTreasury::ExternalAccount,
    options: options
  )
end

#retrieve(id, request_options: {}) ⇒ ModernTreasury::Models::ExternalAccount

show external account

Parameters:

Returns:

See Also:



68
69
70
71
72
73
74
75
 
# File 'lib/modern_treasury/resources/external_accounts.rb', line 68

def retrieve(id, params = {})
  @client.request(
    method: :get,
    path: ["api/external_accounts/%1$s", id],
    model: ModernTreasury::ExternalAccount,
    options: params[:request_options]
  )
end

#update(id, account_type: nil, counterparty_id: nil, metadata: nil, name: nil, party_address: nil, party_name: nil, party_type: nil, request_options: {}) ⇒ ModernTreasury::Models::ExternalAccount

Some parameter documentations has been truncated, see Models::ExternalAccountUpdateParams for more details.

update external account

Parameters:

Returns:

See Also:



105
106
107
108
109
110
111
112
113
114
 
# File 'lib/modern_treasury/resources/external_accounts.rb', line 105

def update(id, params = {})
  parsed, options = ModernTreasury::ExternalAccountUpdateParams.dump_request(params)
  @client.request(
    method: :patch,
    path: ["api/external_accounts/%1$s", id],
    body: parsed,
    model: ModernTreasury::ExternalAccount,
    options: options
  )
end

#verify(id, originating_account_id: , payment_type: , currency: nil, fallback_type: nil, priority: nil, request_options: {}) ⇒ ModernTreasury::Models::ExternalAccount, ModernTreasury::Models::ExternalAccountVerifyResponse::ExternalAccountVerificationAttempt

Some parameter documentations has been truncated, see Models::ExternalAccountVerifyParams for more details.

verify external account

Parameters:

Returns:

See Also:



220
221
222
223
224
225
226
227
228
229
 
# File 'lib/modern_treasury/resources/external_accounts.rb', line 220

def verify(id, params)
  parsed, options = ModernTreasury::ExternalAccountVerifyParams.dump_request(params)
  @client.request(
    method: :post,
    path: ["api/external_accounts/%1$s/verify", id],
    body: parsed,
    model: ModernTreasury::Models::ExternalAccountVerifyResponse,
    options: options
  )
end