Increase.AccountNumbers (Increase v1.0.0)

Copy Markdown View Source

Each account can have multiple account and routing numbers. We recommend that you use a set per vendor. This is similar to how you use different passwords for different websites. Account numbers can also be used to seamlessly reconcile inbound payments. Generating a unique account number per vendor ensures you always know the originator of an incoming payment.

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

Summary

Functions

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

@spec create(Increase.Client.t() | keyword() | nil, map() | keyword(), keyword()) ::
  {:ok, Increase.AccountNumbers.AccountNumber.t()}
  | {:error, Increase.Error.t()}

Create an Account Number

POST /account_numbers

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

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

List Account Numbers

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

GET /account_numbers

retrieve(client, account_number_id, opts \\ [])

@spec retrieve(Increase.Client.t() | keyword() | nil, String.t(), keyword()) ::
  {:ok, Increase.AccountNumbers.AccountNumber.t()}
  | {:error, Increase.Error.t()}

Retrieve an Account Number

GET /account_numbers/{account_number_id}

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

@spec update(
  Increase.Client.t() | keyword() | nil,
  String.t(),
  map() | keyword(),
  keyword()
) ::
  {:ok, Increase.AccountNumbers.AccountNumber.t()}
  | {:error, Increase.Error.t()}

Update an Account Number

PATCH /account_numbers/{account_number_id}