increase-test
POST/account_transfers/{account_transfer_id}/cancel

Cancel an Account Transfer

Cancels an Account Transfer in pending_approval status. Use the account_transfer_id path parameter to identify the pending transfer you want to cancel.

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

1 parameter
account_transfer_idstringrequired
The identifier of the pending Account Transfer to cancel.

3 status codes
200Returns the Account Transfer object, including its amount, accounts, lifecycle status, and cancellation details.
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-side error.
5XXReturned when the request encounters a server-side error.

Error handling

The account_transfer_id path parameter must identify an Account Transfer in pending_approval status.