increase-test
POST/simulations/wire_transfers/{wire_transfer_id}/submit

Submit a Wire Transfer to the Federal Reserve in the sandbox

Simulates submitting a Wire Transfer to the Federal Reserve. Use this operation to test the transfer submission flow. The transfer must have pending_approval or pending_creating status before you submit it.

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

1 parameter
wire_transfer_idstringrequired
The identifier of the Wire Transfer to submit.

3 status codes
200Returns the updated Wire Transfer, including its identifier, amount, currency, accounts, and transfer 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 fails with a client error.
5XXReturned when the request fails with a server error.

Error handling

The wire_transfer_id path parameter must identify a Wire Transfer with pending_approval or pending_creating status. Transfers in other statuses do not meet the submission precondition.