Increase.InboundCheckDeposits (Increase v1.0.0)

Copy Markdown View Source

Inbound Check Deposits are records of third-parties attempting to deposit checks against your account.

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

Summary

Functions

decline(client, inbound_check_deposit_id, opts \\ [])

Decline an Inbound Check Deposit

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

List Inbound Check Deposits

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

Retrieve an Inbound Check Deposit

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

Return an Inbound Check Deposit

Functions

decline(client, inbound_check_deposit_id, opts \\ [])

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

Decline an Inbound Check Deposit

POST /inbound_check_deposits/{inbound_check_deposit_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 Check Deposits

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

GET /inbound_check_deposits

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

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

Retrieve an Inbound Check Deposit

GET /inbound_check_deposits/{inbound_check_deposit_id}

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

@spec return(
  Increase.Client.t() | keyword() | nil,
  String.t(),
  map() | keyword(),
  keyword()
) ::
  {:ok, Increase.InboundCheckDeposits.InboundCheckDeposit.t()}
  | {:error, Increase.Error.t()}

Return an Inbound Check Deposit

POST /inbound_check_deposits/{inbound_check_deposit_id}/return