Class: Increase::Resources::RoutingNumbers

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

Instance Method Summary collapse

Constructor Details

#initialize(client:) ⇒ RoutingNumbers

Returns a new instance of RoutingNumbers.



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

def initialize(client:)
  @client = client
end

Instance Method Details

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

You can use this API to confirm if a routing number is valid, such as when a user is providing you with bank account details. Since routing numbers uniquely identify a bank, this will always return 0 or 1 entry. In Sandbox, the only valid routing number for this method is 110000000.

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):

  • :routing_number (String) —

    Filter financial institutions by routing number.

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

Returns:



24
25
26
27
28
29
30
31
32
 
# File 'lib/increase/resources/routing_numbers.rb', line 24

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