Increase.RoutingNumbers (Increase v1.0.0)

Copy Markdown View Source

Functions for working with RoutingNumbers via the Increase API.

See https://increase.com/documentation/api/routing-numbers for the full API reference for this resource.

Summary

Functions

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, only a few [routing numbers are valid] 110000000 is an example of a Sandbox routing number.

Functions

list(client, params \\ %{}, opts \\ [])

@spec list(Increase.Client.t() | keyword() | nil, map() | keyword(), keyword()) ::
  {:ok, Increase.Page.t()} | {:error, Increase.Error.t()}

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, only a few [routing numbers are valid] 110000000 is an example of a Sandbox routing number.

Returns a %Increase.Page{} whose data is a list of %__MODULE__. RoutingNumberListResponse{} structs. Page through results with Increase.Page.auto_paging_stream/1 or Increase.Page.auto_paging_each/2.

GET /routing_numbers