Increase.ACHTransfers (Increase v1.0.0)

Copy Markdown View Source

ACH transfers move funds between your Increase account and any other account accessible by the Automated Clearing House (ACH).

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

Summary

Functions

Approves an ACH Transfer in a pending_approval state.

Cancels an ACH Transfer in a pending_approval state.

Functions

approve(client, ach_transfer_id, opts \\ [])

@spec approve(Increase.Client.t() | keyword() | nil, String.t(), keyword()) ::
  {:ok, Increase.ACHTransfers.ACHTransfer.t()} | {:error, Increase.Error.t()}

Approves an ACH Transfer in a pending_approval state.

POST /ach_transfers/{ach_transfer_id}/approve

cancel(client, ach_transfer_id, opts \\ [])

@spec cancel(Increase.Client.t() | keyword() | nil, String.t(), keyword()) ::
  {:ok, Increase.ACHTransfers.ACHTransfer.t()} | {:error, Increase.Error.t()}

Cancels an ACH Transfer in a pending_approval state.

POST /ach_transfers/{ach_transfer_id}/cancel

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

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

Create an ACH Transfer

POST /ach_transfers

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

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

List ACH Transfers

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

GET /ach_transfers

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

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

Retrieve an ACH Transfer

GET /ach_transfers/{ach_transfer_id}