Account transfers move funds between your own accounts at Increase (accounting systems often refer to these as Book Transfers). Account Transfers are free and synchronous. Upon creation they create two Transactions, one negative on the originating account and one positive on the destination account (unless the transfer requires approval, in which case the Transactions will be created when the transfer is approved).
The Account from which the transfer originated.
The transfer amount in cents. This will always be positive and indicates the amount of money leaving the originating account.
If your account requires approvals for transfers and the transfer was approved, this will contain details of the approval.
If your account requires approvals for transfers and the transfer was not approved, this will contain details of the cancellation.
The ISO 8601 date and time at which the transfer was created.
What object created the transfer, either via the API or the dashboard.
An internal-facing description for the transfer for display in the API and dashboard. This will also show in the description of the created Transactions.
The destination Account’s identifier.
The identifier of the Transaction on the destination Account representing the received funds.
The Account Transfer’s identifier.
The idempotency key you chose for this object. This value is unique across Increase and is used to ensure that a request is only processed once. Learn more about idempotency.
The ID for the pending transaction representing the transfer. A pending transaction is created when the transfer requires approval by someone else in your organization.
The lifecycle status of the transfer.
The identifier of the Transaction on the originating account representing the transferred funds.
A constant representing the object’s type. For this resource it will always be account_transfer.
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 Account Transfers to those that originated from the specified Account.
Filter records to the one with the specified idempotency_key you chose for that object. This value is unique across Increase and is used to ensure that a request is only processed once. Learn more about idempotency.
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.
The identifier for the originating Account that will send the transfer.
The transfer amount in the minor unit of the account currency. For dollars, for example, this is cents.
An internal-facing description for the transfer for display in the API and dashboard. This will also show in the description of the created Transactions.
The identifier for the destination Account that will receive the transfer.
Whether the transfer should require explicit approval via the dashboard or API. For more information, see Transfer Approvals.
The identifier of the Account Transfer.
Approves an Account Transfer in status pending_approval.
The identifier of the Account Transfer to approve.
Cancels an Account Transfer in status pending_approval.
The identifier of the pending Account Transfer to cancel.
If your account is configured to require approval for each transfer, this endpoint simulates the approval of an Account Transfer. You can also approve sandbox Account Transfers in the dashboard. This transfer must first have a status of pending_approval.
The identifier of the Account Transfer you wish to complete.