---
title: "Simulate an incoming wire"
method: POST
path: "/v0/sandbox/incoming-wires"
tags: ["Sandbox"]
---

# Simulate an incoming wire

`POST /v0/sandbox/incoming-wires`

## Request

- Base URL: `https://distributor-api.spiko.io`
- URL: `https://distributor-api.spiko.io/v0/sandbox/incoming-wires`
- Auth: HTTP basic
- TypeScript: <https://skmtc.dev/spiko/apis/spiko-distributor-api/docs/v0/sandbox/incoming-wires/post.ts> (a function with typed inputs; its response is checked against the schema)

Credits an IBAN as though a wire had arrived, and lets the ordinary processing run. The IBAN is either one of your investors' virtual IBANs, where an existing deposit order is matched and funded and otherwise one is created, or the `wireInstructions.iban` of a bulk deposit, where the wire funds its deposit orders when `message` carries its `wireInstructions.reference`, `counterpartyIban` is one of your registered bank accounts and `amount` is its total in cents. Available in the sandbox environment only.

## Request body

- object
  - `localIban` string, required: a valid IBAN (International Bank Account Number)
  - `amount` integer, required: Amount of the wire in cents of EUR, e.g. 15025 for 150.25 EUR.
  - `counterpartyName` string
  - `counterpartyIban` string: a valid IBAN (International Bank Account Number)
  - `message` string
  - `endToEndId` string

## Response `204`

Incoming wire simulated

## Other responses

- `400`: The request did not match the expected schema
- `401`: Authentication failed. Two bodies are possible: the schema below when the API rejects the credentials, and `{ "error": { "code", "status", "request", "message" } }` when the API gateway rejects them first. Only the former carries a `_tag`.
- `403`: Forbidden
- `404`: NotFound
- `422`: Unprocessable Content
- `503`: The investor is undergoing a scheduled upgrade, access is temporarily paused to ensure data safety.

---

[API](https://skmtc.dev/spiko/apis/spiko-distributor-api.md) - [All operations](https://skmtc.dev/spiko/apis/spiko-distributor-api/llms.txt) - [OpenAPI document](https://skmtc.dev/spiko/apis/spiko-distributor-api/revisions/b78ad4e0f3fc?raw)
