Class: Increase::Resources::InboundACHTransfers

Inherits:
Object
  • Object
show all
Defined in:
lib/increase/resources/inbound_ach_transfers.rb

Instance Method Summary collapse

Constructor Details

#initialize(client:) ⇒ InboundACHTransfers

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

Parameters:



149
150
151
 
# File 'lib/increase/resources/inbound_ach_transfers.rb', line 149

def initialize(client:)
  @client = client
end

Instance Method Details

#create_notification_of_change(inbound_ach_transfer_id, updated_account_number: nil, updated_routing_number: nil, request_options: {}) ⇒ Increase::Models::InboundACHTransfer

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

Create a notification of change for an Inbound ACH Transfer

Parameters:

  • inbound_ach_transfer_id (String) —

    The identifier of the Inbound ACH Transfer for which to create a notification of

  • updated_account_number (String) —

    The updated account number to send in the notification of change.

  • updated_routing_number (String) —

    The updated routing number to send in the notification of change.

  • request_options (Increase::RequestOptions, Hash{Symbol=>Object}, nil)

Returns:

See Also:



81
82
83
84
85
86
87
88
89
90
 
# File 'lib/increase/resources/inbound_ach_transfers.rb', line 81

def create_notification_of_change(inbound_ach_transfer_id, params = {})
  parsed, options = Increase::InboundACHTransferCreateNotificationOfChangeParams.dump_request(params)
  @client.request(
    method: :post,
    path: ["inbound_ach_transfers/%1$s/create_notification_of_change", inbound_ach_transfer_id],
    body: parsed,
    model: Increase::InboundACHTransfer,
    options: options
  )
end

#decline(inbound_ach_transfer_id, reason: nil, request_options: {}) ⇒ Increase::Models::InboundACHTransfer

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

Decline an Inbound ACH Transfer

Parameters:

Returns:

See Also:



108
109
110
111
112
113
114
115
116
117
 
# File 'lib/increase/resources/inbound_ach_transfers.rb', line 108

def decline(inbound_ach_transfer_id, params = {})
  parsed, options = Increase::InboundACHTransferDeclineParams.dump_request(params)
  @client.request(
    method: :post,
    path: ["inbound_ach_transfers/%1$s/decline", inbound_ach_transfer_id],
    body: parsed,
    model: Increase::InboundACHTransfer,
    options: options
  )
end

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

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

List Inbound ACH Transfers

Parameters:

Returns:

See Also:



50
51
52
53
54
55
56
57
58
59
60
 
# File 'lib/increase/resources/inbound_ach_transfers.rb', line 50

def list(params = {})
  parsed, options = Increase::InboundACHTransferListParams.dump_request(params)
  @client.request(
    method: :get,
    path: "inbound_ach_transfers",
    query: parsed,
    page: Increase::Internal::Page,
    model: Increase::InboundACHTransfer,
    options: options
  )
end

#retrieve(inbound_ach_transfer_id, request_options: {}) ⇒ Increase::Models::InboundACHTransfer

Retrieve an Inbound ACH Transfer

Parameters:

  • inbound_ach_transfer_id (String) —

    The identifier of the Inbound ACH Transfer to get details for.

  • request_options (Increase::RequestOptions, Hash{Symbol=>Object}, nil)

Returns:

See Also:



17
18
19
20
21
22
23
24
 
# File 'lib/increase/resources/inbound_ach_transfers.rb', line 17

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

#transfer_return(inbound_ach_transfer_id, reason: , request_options: {}) ⇒ Increase::Models::InboundACHTransfer

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

Return an Inbound ACH Transfer

Parameters:

Returns:

See Also:



135
136
137
138
139
140
141
142
143
144
 
# File 'lib/increase/resources/inbound_ach_transfers.rb', line 135

def transfer_return(inbound_ach_transfer_id, params)
  parsed, options = Increase::InboundACHTransferTransferReturnParams.dump_request(params)
  @client.request(
    method: :post,
    path: ["inbound_ach_transfers/%1$s/transfer_return", inbound_ach_transfer_id],
    body: parsed,
    model: Increase::InboundACHTransfer,
    options: options
  )
end