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

Returns a new instance of InboundACHTransfers.



6
7
8
 
# File 'lib/increase/resources/inbound_ach_transfers.rb', line 6

def initialize(client:)
  @client = client
end

Instance Method Details

#create_notification_of_change(inbound_ach_transfer_id, params = {}, opts = {}) ⇒ Increase::Models::InboundACHTransfer

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

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

    Attributes to send in this request.

  • opts (Hash|RequestOptions) (defaults to: {}) —

    Options to specify HTTP behaviour for this request.

Options Hash (params):

  • :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.

Returns:



60
61
62
63
64
65
66
67
 
# File 'lib/increase/resources/inbound_ach_transfers.rb', line 60

def create_notification_of_change(inbound_ach_transfer_id, params = {}, opts = {})
  req = {}
  req[:method] = :post
  req[:path] = "/inbound_ach_transfers/#{inbound_ach_transfer_id}/create_notification_of_change"
  req[:body] = params
  req[:model] = Increase::Models::InboundACHTransfer
  @client.request(req, opts)
end

#decline(inbound_ach_transfer_id, opts = {}) ⇒ Increase::Models::InboundACHTransfer

Decline an Inbound ACH Transfer

Parameters:

  • inbound_ach_transfer_id (String) —

    The identifier of the Inbound ACH Transfer to decline.

  • opts (Hash|RequestOptions) (defaults to: {}) —

    Options to specify HTTP behaviour for this request.

Returns:



75
76
77
78
79
80
81
 
# File 'lib/increase/resources/inbound_ach_transfers.rb', line 75

def decline(inbound_ach_transfer_id, opts = {})
  req = {}
  req[:method] = :post
  req[:path] = "/inbound_ach_transfers/#{inbound_ach_transfer_id}/decline"
  req[:model] = Increase::Models::InboundACHTransfer
  @client.request(req, opts)
end

#list(params = {}, opts = {}) ⇒ Increase::Page<Increase::Models::InboundACHTransfer>

List Inbound ACH Transfers

Parameters:

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

    Attributes to send in this request.

  • opts (Hash|RequestOptions) (defaults to: {}) —

    Options to specify HTTP behaviour for this request.

Options Hash (params):

  • :account_id (String) —

    Filter Inbound ACH Tranfers to ones belonging to the specified Account.

  • :account_number_id (String) —

    Filter Inbound ACH Tranfers to ones belonging to the specified Account Number.

  • :created_at (CreatedAt)
  • :cursor (String) —

    Return the page of entries after this one.

  • :limit (Integer) —

    Limit the size of the list that is returned. The default (and maximum) is 100 objects.

  • :status (Symbol) —

    Filter Inbound ACH Transfers to those with the specified status.

Returns:



38
39
40
41
42
43
44
45
46
 
# File 'lib/increase/resources/inbound_ach_transfers.rb', line 38

def list(params = {}, opts = {})
  req = {}
  req[:method] = :get
  req[:path] = "/inbound_ach_transfers"
  req[:query] = params
  req[:page] = Increase::Page
  req[:model] = Increase::Models::InboundACHTransfer
  @client.request(req, opts)
end

#retrieve(inbound_ach_transfer_id, opts = {}) ⇒ 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.

  • opts (Hash|RequestOptions) (defaults to: {}) —

    Options to specify HTTP behaviour for this request.

Returns:



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

def retrieve(inbound_ach_transfer_id, opts = {})
  req = {}
  req[:method] = :get
  req[:path] = "/inbound_ach_transfers/#{inbound_ach_transfer_id}"
  req[:model] = Increase::Models::InboundACHTransfer
  @client.request(req, opts)
end

#transfer_return(inbound_ach_transfer_id, params = {}, opts = {}) ⇒ Increase::Models::InboundACHTransfer

Return an Inbound ACH Transfer

Parameters:

  • inbound_ach_transfer_id (String) —

    The identifier of the Inbound ACH Transfer to return to the originating financial institution.

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

    Attributes to send in this request.

  • opts (Hash|RequestOptions) (defaults to: {}) —

    Options to specify HTTP behaviour for this request.

Options Hash (params):

  • :reason (Symbol) —

    The reason why this transfer will be returned. The most usual return codes are payment_stopped for debits and credit_entry_refused_by_receiver for credits.

Returns:



95
96
97
98
99
100
101
102
 
# File 'lib/increase/resources/inbound_ach_transfers.rb', line 95

def transfer_return(inbound_ach_transfer_id, params = {}, opts = {})
  req = {}
  req[:method] = :post
  req[:path] = "/inbound_ach_transfers/#{inbound_ach_transfer_id}/transfer_return"
  req[:body] = params
  req[:model] = Increase::Models::InboundACHTransfer
  @client.request(req, opts)
end