Increase.CheckTransfers (Increase v1.0.0)

Check Transfers move funds from your Increase account by mailing a physical check.

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

Summary

Functions

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

Approve a Check Transfer

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

Cancel a Check Transfer with the pending_approval status. See [Transfer Approvals] for more information.

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

Create a Check Transfer

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

List Check Transfers

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

Retrieve a Check Transfer

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

Stop payment on a Check Transfer

Functions

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

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

Approve a Check Transfer

POST /check_transfers/{check_transfer_id}/approve

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

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

Cancel a Check Transfer with the pending_approval status. See [Transfer Approvals] for more information.

POST /check_transfers/{check_transfer_id}/cancel

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

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

Create a Check Transfer

POST /check_transfers

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

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

List Check Transfers

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

GET /check_transfers

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

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

Retrieve a Check Transfer

GET /check_transfers/{check_transfer_id}

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

@spec stop_payment(
  Increase.Client.t() | keyword() | nil,
  String.t(),
  map() | keyword(),
  keyword()
) ::
  {:ok, Increase.CheckTransfers.CheckTransfer.t()}
  | {:error, Increase.Error.t()}

Stop payment on a Check Transfer

POST /check_transfers/{check_transfer_id}/stop_payment