Increase.InboundACHTransfers (Increase v1.0.0)

Copy Markdown View Source

An Inbound ACH Transfer is an ACH transfer initiated outside of Increase to your account.

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

Summary

Functions

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

@spec decline(
  Increase.Client.t() | keyword() | nil,
  String.t(),
  map() | keyword(),
  keyword()
) ::
  {:ok, Increase.InboundACHTransfers.InboundACHTransfer.t()}
  | {:error, Increase.Error.t()}

Decline an Inbound ACH Transfer

POST /inbound_ach_transfers/{inbound_ach_transfer_id}/decline

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

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

List Inbound ACH Transfers

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

GET /inbound_ach_transfers

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

@spec new_notification_of_change(
  Increase.Client.t() | keyword() | nil,
  String.t(),
  map() | keyword(),
  keyword()
) ::
  {:ok, Increase.InboundACHTransfers.InboundACHTransfer.t()}
  | {:error, Increase.Error.t()}

Create a notification of change for an Inbound ACH Transfer

POST /inbound_ach_transfers/{inbound_ach_transfer_id}/create_notification_of_change

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

Retrieve an Inbound ACH Transfer

GET /inbound_ach_transfers/{inbound_ach_transfer_id}

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

@spec transfer_return(
  Increase.Client.t() | keyword() | nil,
  String.t(),
  map() | keyword(),
  keyword()
) ::
  {:ok, Increase.InboundACHTransfers.InboundACHTransfer.t()}
  | {:error, Increase.Error.t()}

Return an Inbound ACH Transfer

POST /inbound_ach_transfers/{inbound_ach_transfer_id}/transfer_return