---
title: "Sandbox: Create an Inbound Wire Transfer"
method: POST
path: "/simulations/inbound_wire_transfers"
---

# Sandbox: Create an Inbound Wire Transfer

`POST /simulations/inbound_wire_transfers`

Simulates an [Inbound Wire Transfer](#inbound-wire-transfers) to your account.

## Request body

- SandboxCreateAnInboundWireTransferParameters
  - `account_number_id` string, required — The identifier of the Account Number the inbound Wire Transfer is for.
  - `amount` integer, required — The transfer amount in cents. Must be positive.
  - `creditor_address_line1` string — The sending bank will set creditor_address_line1 in production. You can simulate any value here.
  - `creditor_address_line2` string — The sending bank will set creditor_address_line2 in production. You can simulate any value here.
  - `creditor_address_line3` string — The sending bank will set creditor_address_line3 in production. You can simulate any value here.
  - `creditor_name` string — The sending bank will set creditor_name in production. You can simulate any value here.
  - `debtor_address_line1` string — The sending bank will set debtor_address_line1 in production. You can simulate any value here.
  - `debtor_address_line2` string — The sending bank will set debtor_address_line2 in production. You can simulate any value here.
  - `debtor_address_line3` string — The sending bank will set debtor_address_line3 in production. You can simulate any value here.
  - `debtor_name` string — The sending bank will set debtor_name in production. You can simulate any value here.
  - `end_to_end_identification` string — The sending bank will set end_to_end_identification in production. You can simulate any value here.
  - `instructing_agent_routing_number` string — The sending bank will set instructing_agent_routing_number in production. You can simulate any value here.
  - `instruction_identification` string — The sending bank will set instruction_identification in production. You can simulate any value here.
  - `purpose` string — The sending bank will set purpose in production. You can simulate any value here.
  - `unique_end_to_end_transaction_reference` string — The sending bank will set unique_end_to_end_transaction_reference in production. You can simulate any value here.
  - `unstructured_remittance_information` string — The sending bank will set unstructured_remittance_information in production. You can simulate any value here.
  - `wire_drawdown_request_id` string — The identifier of a Wire Drawdown Request the inbound Wire Transfer is fulfilling.

## Response `200`

Inbound Wire Transfer

- InboundWireTransfer — An Inbound Wire Transfer is a wire transfer initiated outside of Increase to your account.
  - `acceptance` object, nullable, required — If the transfer is accepted, this will contain details of the acceptance.
    - `accepted_at` string, date-time, required — The [ISO 8601](https://en.wikipedia.org/wiki/ISO_8601) date and time at which the transfer was accepted.
    - `transaction_id` string, required — The identifier of the transaction for the accepted transfer.
  - `account_id` string, required — The Account to which the transfer belongs.
  - `account_number_id` string, required — The identifier of the Account Number to which this transfer was sent.
  - `amount` integer, required — The amount in USD cents.
  - `created_at` string, date-time, required — The [ISO 8601](https://en.wikipedia.org/wiki/ISO_8601) date and time at which the inbound wire transfer was created.
  - `creditor_address_line1` string, nullable, required — A free-form address field set by the sender.
  - `creditor_address_line2` string, nullable, required — A free-form address field set by the sender.
  - `creditor_address_line3` string, nullable, required — A free-form address field set by the sender.
  - `creditor_name` string, nullable, required — A name set by the sender.
  - `debtor_account_number` string, nullable, required — The account number of the sender.
  - `debtor_address_line1` string, nullable, required — A free-form address field set by the sender.
  - `debtor_address_line2` string, nullable, required — A free-form address field set by the sender.
  - `debtor_address_line3` string, nullable, required — A free-form address field set by the sender.
  - `debtor_name` string, nullable, required — A name set by the sender.
  - `debtor_routing_number` string, nullable, required — The American Banking Association (ABA) routing number of the sender.
  - `description` string, required — An Increase-constructed description of the transfer.
  - `end_to_end_identification` string, nullable, required — A free-form reference string set by the sender, to help identify the transfer.
  - `id` string, required — The inbound wire transfer's identifier.
  - `input_message_accountability_data` string, nullable, required — A unique identifier available to the originating and receiving banks, commonly abbreviated as IMAD. It is created when the wire is submitted to the Fedwire service and is helpful when debugging wires with the originating bank.
  - `instructing_agent_routing_number` string, nullable, required — The American Banking Association (ABA) routing number of the bank that sent the wire.
  - `instruction_identification` string, nullable, required — The sending bank's identifier for the wire transfer.
  - `purpose` string, nullable, required — The reason for the wire transfer, as set by the sender.
  - `reversal` object, nullable, required — If the transfer is reversed, this will contain details of the reversal.
    - `reason` 'duplicate' | 'creditor_request' | 'transaction_forbidden', required — The reason for the reversal.
    - `reversed_at` string, date-time, required — The [ISO 8601](https://en.wikipedia.org/wiki/ISO_8601) date and time at which the transfer was reversed.
  - `status` 'pending' | 'accepted' | 'declined' | 'reversed', required — The status of the transfer.
  - `type` 'inbound_wire_transfer', required — A constant representing the object's type. For this resource it will always be `inbound_wire_transfer`.
  - `unique_end_to_end_transaction_reference` string, nullable, required — The Unique End-to-end Transaction Reference ([UETR](https://www.swift.com/payments/what-unique-end-end-transaction-reference-uetr)) of the transfer.
  - `unstructured_remittance_information` string, nullable, required — A free-form message set by the sender.
  - `wire_drawdown_request_id` string, nullable, required — The wire drawdown request the inbound wire transfer is fulfilling.

## Other responses

- `4XX` — Error
- `5XX` — Error

---

[API](https://skmtc.net/increase/apis/increase-api-2.md) · [All operations](https://skmtc.net/increase/apis/increase-api-2/llms.txt) · [OpenAPI document](https://skmtc-service-staging.skmtc.workers.dev/v1/apis/increase/increase-api-2/versions/e968bcd4dcf9/schema)