---
title: "Simulate receiving Wire transaction"
method: POST
path: "/wires/transaction_simulations/receiving_transaction"
tags: ["Wire Transaction Simulations"]
---

# Simulate receiving Wire transaction

`POST /wires/transaction_simulations/receiving_transaction`

Use to simulate receiving Wire transaction in test environments. Creates an incoming Wire file, which gets automatically processed.

## Request body

- WireTransactionSimulationRequest — Simulate receiving a Wire transaction
  - `account_number` string, required — Number of the receiving account
  - `amount` integer, required — Amount to transfer in cents (e.g. 100 = $1).
  - `beneficiary_account_override` string — Simulation-only knob. If present, replaces `account_number` as the value placed in the generated pacs.008 `CdtrAcct` field (use the empty string to omit `CdtrAcct` entirely). `account_number` still drives partner-prefix validation and the receiver-info lookup; this override only affects what is stamped on the wire, which is what the receiver code parses into `IncomingWire.AccountNo`. Used to construct the "structured account is missing/short, account digits embedded in recipient message" scenario. Not used in production wires. FEDWIRE only.
  - `network` 'DATASOFT' | 'FEDWIRE' — Network to use for the Wire transfer
  - `recipient_message` string — Simulation-only knob. Overrides the unstructured remittance information (ISO 20022 RmtInf/Ustrd) on the generated wire so we can exercise the recipient-message account-number extraction path. Not used in production wires. FEDWIRE only — rejected for DATASOFT since the Datasoft webhook payload has no field to carry an unstructured recipient message.

## Response `201`

Simulated receiving a Wire transaction

- union
  - object — Incoming Wire simulation result with the created file name
    - `file_name` string, required
  - object — Incoming Wire simulation result with the webhook ID
    - `webhook_id` string, uuid, required

## Other responses

- `400` — BadRequest
- `401` — Unauthorized
- `403` — Forbidden error
- `500` — Internal server error

---

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