increase-test
POST/account_transfers

Create an Account Transfer

Creates an Account Transfer to move funds between two Accounts. Supply the originating and destination Account identifiers, a positive amount in the account currency's minor unit, and a description; you can also require explicit approval.

  • IdempotentThe SDK sends Idempotency-Key, so a retried request is only applied once.

5 body fields

Details for transferring funds between Accounts.

account_idstringrequired
The identifier for the originating Account that will send the transfer.
amountintegerrequired
The transfer amount in the minor unit of the account currency. For dollars, for example, this is cents.
descriptionstringrequired
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.
destination_account_idstringrequired
The identifier for the destination Account that will receive the transfer.
require_approvalbooleanoptional
Whether the transfer should require explicit approval via the dashboard or API. For more information, see [Transfer Approvals](/documentation/transfer-approvals).

3 status codes
200Returns the Account Transfer, including its amount, originating and destination Account identifiers, description, and lifecycle status.
account_idstringrequired
The Account from which the transfer originated.
amountintegerrequired
The transfer amount in cents. This will always be positive and indicates the amount of money leaving the originating account.
approvalobjectrequired
If your account requires approvals for transfers and the transfer was approved, this will contain details of the approval.
cancellationobjectrequired
If your account requires approvals for transfers and the transfer was not approved, this will contain details of the cancellation.
created_atstringrequired
The [ISO 8601](https://en.wikipedia.org/wiki/ISO_8601) date and time at which the transfer was created.
created_byobjectrequired
What object created the transfer, either via the API or the dashboard.
currencystringrequired
The [ISO 4217](https://en.wikipedia.org/wiki/ISO_4217) code for the transfer's currency.
Allowed:USD
descriptionstringrequired
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.
destination_account_idstringrequired
The destination Account's identifier.
destination_transaction_idstringrequired
The identifier of the Transaction on the destination Account representing the received funds.
idstringrequired
The Account Transfer's identifier.
idempotency_keystringrequired
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](https://increase.com/documentation/idempotency-keys).
pending_transaction_idstringrequired
The ID for the pending transaction representing the transfer. A pending transaction is created when the transfer [requires approval](https://increase.com/documentation/transfer-approvals#transfer-approvals) by someone else in your organization.
statusstringrequired
The lifecycle status of the transfer.
Allowed:pending_approvalcanceledcomplete
transaction_idstringrequired
The identifier of the Transaction on the originating account representing the transferred funds.
typestringrequired
A constant representing the object's type. For this resource it will always be `account_transfer`.
Allowed:account_transfer
4XXReturned when the request encounters a client error.
5XXReturned when the service encounters a server error.

Error handling

account_id, amount, description, and destination_account_id are required, and amount must be at least 1. description must be 1 to 200 characters; the Account identifiers must identify the originating and destination Accounts.