Increase.AccountTransfers (Increase v1.0.0)

Account transfers move funds between your own accounts at Increase (accounting systems often refer to these as Book Transfers). Account Transfers are free and synchronous. Upon creation they create two Transactions, one negative on the originating account and one positive on the destination account (unless the transfer requires approval, in which case the Transactions will be created when the transfer is approved).

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

Summary

Functions

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

Approves an Account Transfer in status pending_approval.

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

Cancels an Account Transfer in status pending_approval.

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

Create an Account Transfer

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

List Account Transfers

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

Retrieve an Account Transfer

Functions

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

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

Approves an Account Transfer in status pending_approval.

POST /account_transfers/{account_transfer_id}/approve

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

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

Cancels an Account Transfer in status pending_approval.

POST /account_transfers/{account_transfer_id}/cancel

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

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

Create an Account Transfer

POST /account_transfers

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

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

List Account Transfers

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

GET /account_transfers

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

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

Retrieve an Account Transfer

GET /account_transfers/{account_transfer_id}