---
title: "Simulate inbound payment"
method: POST
path: "/v1/simulate/inbound-payment"
tags: ["Simulation"]
---

# Simulate inbound payment

`POST /v1/simulate/inbound-payment`

Simulate inbound payment

## Request body

- SimulateInboundRequest — Parameters to simulate an inbound payment.
  - `amount` integer, required — Payment amount.
  - `beneficiary_account_id` string, uuid, required — The id of the account that should receive the funds. Can both be an internal account and an account.
  - `external_id` string, uuid, nullable — External id.
  - `reference` string, required — Payment reference.
  - `remitter` union
    - object
      - `iban` string, string, required
    - object
      - `wire` WireBankDetails, required
        - `account_number` string, string, required
        - `routing_number` string, string, required
    - object
      - `scan` ScanDetails, required
        - `account_number` string, string, required
        - `sort_code` string, string, required
  - `remitter_iban` string, string, nullable — The IBAN of the account that is sending the funds. DEPRECATED - will be removed
  - `remitter_name` string, string, nullable — Optional remitter name. If not provided, topup will be used as the default value.

## Response `200`

Simulated Inbound payment created

---

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