increase-test
POST/wire_transfers

Create a wire transfer

Creates a wire transfer from an account to a destination account accessible by Fedwire. Provide the amount, creditor, and remittance details, along with either an external account identifier or the destination account and routing numbers. Include debtor details when transferring from a commingled account.

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

11 body fields

Wire transfer details, including the sending account, amount, recipient, and remittance information.

account_idstringrequired
The identifier for the account that will send the transfer.
account_numberstringoptional
The account number for the destination account.
amountintegerrequired
The transfer amount in USD cents.
creditorobjectrequired
The person or business that is receiving the funds from the transfer.
debtorobjectoptional
The person or business whose funds are being transferred. This is only necessary if you're transferring from a commingled account. Otherwise, we'll use the associated entity's details.
external_account_idstringoptional
The ID of an External Account to initiate a transfer to. If this parameter is provided, `account_number` and `routing_number` must be absent.
inbound_wire_drawdown_request_idstringoptional
The ID of an Inbound Wire Drawdown Request in response to which this transfer is being sent.
remittanceobjectrequired
Additional remittance information related to the wire transfer.
require_approvalbooleanoptional
Whether the transfer requires explicit approval via the dashboard or API.
routing_numberstringoptional
The American Bankers' Association (ABA) Routing Transit Number (RTN) for the destination account.
source_account_number_idstringoptional
The ID of an Account Number that will be passed to the wire's recipient.

3 status codes
200Returns the created wire transfer, including its identifier, amount, currency, destination details, remittance information, and approval and cancellation details.
account_idstringrequired
The Account to which the transfer belongs.
account_numberstringrequired
The destination account number.
amountintegerrequired
The transfer amount in USD cents.
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.
creditorobjectrequired
The person or business that is receiving the funds from the transfer.
currencystringrequired
The [ISO 4217](https://en.wikipedia.org/wiki/ISO_4217) code for the transfer's currency. For wire transfers this is always equal to `usd`.
Allowed:USD
debtorobjectrequired
The person or business whose funds are being transferred.
external_account_idstringrequired
The identifier of the External Account the transfer was made to, if any.
idstringrequired
The wire 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).
inbound_wire_drawdown_request_idstringrequired
The ID of an Inbound Wire Drawdown Request in response to which this transfer was sent.
networkstringrequired
The transfer's network.
Allowed:wire
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.
remittanceobjectrequired
Remittance information sent with the wire transfer.
reversalobjectrequired
If your transfer is reversed, this will contain details of the reversal.
routing_numberstringrequired
The American Bankers' Association (ABA) Routing Transit Number (RTN).
source_account_number_idstringrequired
The Account Number that was passed to the wire's recipient.
statusstringrequired
The lifecycle status of the transfer.
Allowed:pending_approvalcanceledpending_creatingpending_reviewingrejectedrequires_attentionreversedsubmittedcomplete
submissionobjectrequired
After the transfer is submitted to Fedwire, this will contain supplemental details.
transaction_idstringrequired
The ID for the transaction funding the transfer.
typestringrequired
A constant representing the object's type. For this resource it will always be `wire_transfer`.
Allowed:wire_transfer
unique_end_to_end_transaction_referencestringrequired
The unique end-to-end transaction reference ([UETR](https://www.swift.com/payments/what-unique-end-end-transaction-reference-uetr)) of the transfer.
4XXReturned when the request results in a client error.
5XXReturned when the request results in a server error.

Error handling

account_id, amount, remittance, and creditor are required; amount must be between 1 and 999999999999 cents. remittance.category must be unstructured or tax, with the corresponding unstructured.message or all three tax fields supplied; if external_account_id is provided, omit account_number and routing_number.