Pending Transactions are potential future additions and removals of money from your bank account. They impact your available balance, but not your current balance. To learn more, see [Transactions and Transfers].
See https://increase.com/documentation/api/pending-transactions for the full API reference for this resource.
Summary
Functions
Creates a pending transaction on an account. This can be useful to hold
funds for an external payment or known future transaction outside of
Increase (only negative amounts are supported). The resulting Pending
Transaction will have a category of user_initiated_hold and can be
released via the API to unlock the held funds.
List Pending Transactions
Release a Pending Transaction you had previously created. The Pending
Transaction must have a category of user_initiated_hold and a status
of pending. This will unlock the held funds and mark the Pending
Transaction as complete.
Retrieve a Pending Transaction
Functions
@spec create(Increase.Client.t() | keyword() | nil, map() | keyword(), keyword()) :: {:ok, Increase.PendingTransactions.PendingTransaction.t()} | {:error, Increase.Error.t()}
Creates a pending transaction on an account. This can be useful to hold
funds for an external payment or known future transaction outside of
Increase (only negative amounts are supported). The resulting Pending
Transaction will have a category of user_initiated_hold and can be
released via the API to unlock the held funds.
POST /pending_transactions
@spec list(Increase.Client.t() | keyword() | nil, map() | keyword(), keyword()) :: {:ok, Increase.Page.t()} | {:error, Increase.Error.t()}
List Pending Transactions
Returns a %Increase.Page{} whose data is a list of %__MODULE__. PendingTransaction{} structs. Page through results with
Increase.Page.auto_paging_stream/1 or Increase.Page.auto_paging_each/2.
GET /pending_transactions
@spec release(Increase.Client.t() | keyword() | nil, String.t(), keyword()) :: {:ok, Increase.PendingTransactions.PendingTransaction.t()} | {:error, Increase.Error.t()}
Release a Pending Transaction you had previously created. The Pending
Transaction must have a category of user_initiated_hold and a status
of pending. This will unlock the held funds and mark the Pending
Transaction as complete.
POST /pending_transactions/{pending_transaction_id}/release
@spec retrieve(Increase.Client.t() | keyword() | nil, String.t(), keyword()) :: {:ok, Increase.PendingTransactions.PendingTransaction.t()} | {:error, Increase.Error.t()}
Retrieve a Pending Transaction
GET /pending_transactions/{pending_transaction_id}