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

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

Parameters:



42
43
44
 
# File 'lib/increase/resources/routing_numbers.rb', line 42

def initialize(client:)
  @client = client
end

Instance Method Details

#list(routing_number: , cursor: nil, limit: nil, request_options: {}) ⇒ Increase::Internal::Page<Increase::Models::RoutingNumberListResponse>

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

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:

  • 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 ob

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

Returns:

See Also:



27
28
29
30
31
32
33
34
35
36
37
 
# File 'lib/increase/resources/routing_numbers.rb', line 27

def list(params)
  parsed, options = Increase::RoutingNumberListParams.dump_request(params)
  @client.request(
    method: :get,
    path: "routing_numbers",
    query: parsed,
    page: Increase::Internal::Page,
    model: Increase::Models::RoutingNumberListResponse,
    options: options
  )
end