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.
The identifier for the account this Pending Transaction belongs to.
The Pending Transaction amount in the minor unit of its currency. For dollars, for example, this is cents.
How the Pending Transaction affects the balance of its Account while its status is pending.
The ISO 8601 date on which the Pending Transaction was completed.
The ISO 8601 date on which the Pending Transaction occurred.
The ISO 4217 code for the Pending Transaction's currency. This will match the currency on the Pending Transaction's Account.
For a Pending Transaction related to a transfer, this is the description you provide. For a Pending Transaction related to a payment, this is the description the vendor provides.
The Pending Transaction identifier.
The identifier for the route this Pending Transaction came through. Routes are things like cards and ACH details.
The type of the route this Pending Transaction came through.
This is an object giving more details on the network-level event that caused the Pending Transaction. For example, for a card transaction this lists the merchant's industry and location.
Whether the Pending Transaction has been confirmed and has an associated Transaction.
A constant representing the object's type. For this resource it will always be pending_transaction.
Return the page of entries after this one.
Limit the size of the list that is returned. The default (and maximum) is 100 objects.
Filter pending transactions to those belonging to the specified Account.
Filter pending transactions to those belonging to the specified Route.
Return results whose value is in the provided list. For GET requests, this should be encoded as a comma-delimited string, such as ?in=one,two,three.
Filter Pending Transactions for those with the specified status. By default only Pending Transactions in with status pending will be returned. For GET requests, this should be encoded as a comma-delimited string, such as ?in=one,two,three.
Return results after this ISO 8601 timestamp.
Return results before this ISO 8601 timestamp.
Return results on or after this ISO 8601 timestamp.
Return results on or before this ISO 8601 timestamp.
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. The resulting Pending Transaction will have a category of user_initiated_hold and can be released via the API to unlock the held funds.
The Account to place the hold on.
The amount to hold in the minor unit of the account's currency. For dollars, for example, this is cents. This should be a negative amount - to hold $1.00 from the account, you would pass -100.
The description you choose to give the hold.
The identifier of the Pending Transaction.
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.
The identifier of the Pending Transaction to release.
This endpoint simulates immediately releasing an Inbound Funds Hold, which might be created as a result of e.g., an ACH debit.
The inbound funds hold to release.