---
title: "Simulate Incoming Wire"
method: POST
path: "/v1/simulate/wires/incoming"
tags: ["Simulation"]
---

# Simulate Incoming Wire

`POST /v1/simulate/wires/incoming`

Simulate an incoming Wire.

## Headers

- `Idempotency-Key` string, required

## Request body

- SimulateIncomingWireRequest — Request body to simulate an incoming wire.
  - `amount` integer, required — The amount of the wire transaction in cents.
  - `creditor_account_number_id` string, required — The ID of the Lead Bank Account Number object.
  - `debtor` SimulateWireDebtorRequest, required — The person or entity sending the wire.
    - `name` string, required — Name of the person or entity sending the wire.
    - `account_identifier` object, required — Account identifier of the debtor.
      - `type` 'account_number', required — Indicator for the type of account identifier sending the wire.
      - `value` string, required — The value associated with the account identifier sending the wire.
    - `address` WirePostalAddress, required
      - `department` string — Identification of a division of a large organization or building.
      - `sub_department` string — Identification of a sub-division of a large organization or building.
      - `street_name` string — Name of a street or thoroughfare.
      - `building_number` string — Number that identifies the position of a building on a street.
      - `building_name` string — Name of the building or house.
      - `floor` string — Floor or storey within a building.
      - `post_box` string — Numbered box in a post office, assigned to a person or organisation, where letters are kept until called for.
      - `room` string — Building room number.
      - `post_code` string — Identifier consisting of a group of letters and/or numbers that is added to a postal address to assist the sorting of mail.
      - `town_name` string — Name of a built-up area, with defined boundaries, and a local government.
      - `town_location_name` string — Specific location name within the town. Note that this field is not commonly used for US-based addresses.
      - `district_name` string — Identifies a subdivision within a country sub-division. Note that this field is not commonly used for US-based addresses.
      - `country_sub_division` string — Identifies a subdivision of a country such as state, region, county.
      - `country` string — ISO 3166, alpha-2 code representing a nation with its own government.
      - `line_one` string — Line one address of the party represented in an unstructured format.
      - `line_two` string — Line two address of the party represented in an unstructured format.
      - `line_three` string — Line three address of the party represented in an unstructured format.
  - `remittance_details` object — Details of the remittance information for the wire.
    - `message_to_creditor` string — Information intended specifically for the creditor.
  - `payment_identifiers` object — Payment identifiers for the wire.
    - `end_to_end_identification` string — Unique identification that the initiating party in a wire message can use to unambiguously identify the transaction. This is passed through, unchanged, throughout the entire wire chain.
  - `debtor_agent` DebtorAgent, required — Details of the debtor agent financial institution.
    - `routing_number` string — Nine-character numeric ABA routing number for the debtor agent financial institution.

## Response `200`

Incoming Wire object created.

- SimulateResponse

## Other responses

- `400` — Your request parameters did not validate.
- `422` — We couldn't parse your request body, please check that your request body is valid JSON.

---

[API](https://skmtc.net/lead/apis/lead-bank.md) · [All operations](https://skmtc.net/lead/apis/lead-bank/llms.txt) · [OpenAPI document](https://skmtc-service-staging.skmtc.workers.dev/v1/apis/lead/lead-bank/versions/25c2a92d55e2/schema)