Class: Increase::Resources::ACHTransfers

Inherits:
Object
  • Object
show all
Defined in:
lib/increase/resources/ach_transfers.rb,
sig/increase/resources/ach_transfers.rbs

Instance Method Summary collapse

Constructor Details

#initialize(client:) ⇒ ACHTransfers

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 ACHTransfers.

API:

  • private



220
221
222
 
# File 'lib/increase/resources/ach_transfers.rb', line 220

def initialize(client:)
  @client = client
end

Instance Method Details

#approve(ach_transfer_id, request_options: {}) ⇒ Increase::Models::ACHTransfer

Approves an ACH Transfer in a pending_approval state.

See Also:



188
189
190
191
192
193
194
195
 
# File 'lib/increase/resources/ach_transfers.rb', line 188

def approve(ach_transfer_id, params = {})
  @client.request(
    method: :post,
    path: ["ach_transfers/%1$s/approve", ach_transfer_id],
    model: Increase::ACHTransfer,
    options: params[:request_options]
  )
end

#cancel(ach_transfer_id, request_options: {}) ⇒ Increase::Models::ACHTransfer

Cancels an ACH Transfer in a pending_approval state.

See Also:



208
209
210
211
212
213
214
215
 
# File 'lib/increase/resources/ach_transfers.rb', line 208

def cancel(ach_transfer_id, params = {})
  @client.request(
    method: :post,
    path: ["ach_transfers/%1$s/cancel", ach_transfer_id],
    model: Increase::ACHTransfer,
    options: params[:request_options]
  )
end

#create(account_id:, amount:, statement_descriptor:, account_number: nil, addenda: nil, company_descriptive_date: nil, company_discretionary_data: nil, company_entry_description: nil, company_name: nil, destination_account_holder: nil, external_account_id: nil, funding: nil, individual_id: nil, individual_name: nil, preferred_effective_date: nil, require_approval: nil, routing_number: nil, standard_entry_class_code: nil, request_options: {}) ⇒ Increase::Models::ACHTransfer

Create an ACH Transfer

See Also:



102
103
104
105
106
107
108
109
110
111
 
# File 'lib/increase/resources/ach_transfers.rb', line 102

def create(params)
  parsed, options = Increase::ACHTransferCreateParams.dump_request(params)
  @client.request(
    method: :post,
    path: "ach_transfers",
    body: parsed,
    model: Increase::ACHTransfer,
    options: options
  )
end

#list(account_id: nil, created_at: nil, cursor: nil, external_account_id: nil, idempotency_key: nil, limit: nil, status: nil, request_options: {}) ⇒ Increase::Internal::Page<Increase::Models::ACHTransfer>

List ACH Transfers

See Also:



164
165
166
167
168
169
170
171
172
173
174
175
 
# File 'lib/increase/resources/ach_transfers.rb', line 164

def list(params = {})
  parsed, options = Increase::ACHTransferListParams.dump_request(params)
  query = Increase::Internal::Util.encode_query_params(parsed)
  @client.request(
    method: :get,
    path: "ach_transfers",
    query: query,
    page: Increase::Internal::Page,
    model: Increase::ACHTransfer,
    options: options
  )
end

#retrieve(ach_transfer_id, request_options: {}) ⇒ Increase::Models::ACHTransfer

Retrieve an ACH Transfer

See Also:



124
125
126
127
128
129
130
131
 
# File 'lib/increase/resources/ach_transfers.rb', line 124

def retrieve(ach_transfer_id, params = {})
  @client.request(
    method: :get,
    path: ["ach_transfers/%1$s", ach_transfer_id],
    model: Increase::ACHTransfer,
    options: params[:request_options]
  )
end