Increase.ACHPrenotifications (Increase v1.0.0)

ACH Prenotifications are one way you can verify account and routing numbers by Automated Clearing House (ACH).

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

Summary

Functions

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

Create an ACH Prenotification

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

List ACH Prenotifications

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

Retrieve an ACH Prenotification

Functions

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

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

Create an ACH Prenotification

POST /ach_prenotifications

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

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

List ACH Prenotifications

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

GET /ach_prenotifications

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

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

Retrieve an ACH Prenotification

GET /ach_prenotifications/{ach_prenotification_id}