---
title: "Sandbox: settle a realtime payment"
method: POST
path: "/simulations/realtime/{realtimeId}/settle"
tags: ["Simulations"]
---

# Sandbox: settle a realtime payment

`POST /simulations/realtime/{realtimeId}/settle`

Drive a sandbox realtime payment to settlement

## Path parameters

- `realtimeId` string, required

## Headers

- `Idempotency-Key` string, required
- `X-Instance-ID` string, nullable

## Request body

- object
  - `data` object
    - `attributes` object, required
      - `customerPartyId` string — Defaults to your party. To act for another party, pass the ID of a party that has authorized you to act on its behalf.

## Response `200`

Successful Response

- object
  - `data` object, required
    - `type` 'realtime-simulation', required
    - `id` string, required — The realtime payment the action was applied to.
    - `attributes` object, required
      - `action` 'settle' | 'fail', required — Lifecycle action applied.
      - `mmRequestId` string, required — Money-movement request the fixtures were fired against.
      - `scenario` string, required — Fixture scenario fired on the money-movement side.
      - `fixturesFired` integer, required — Number of webhook events emitted.

## Other responses

- `400` — Validation Error
- `401` — Unauthorized
- `403` — Forbidden
- `404` — Not Found. Returned when the resource does not exist, or when it exists but is not accessible to your account. The two cases are intentionally indistinguishable, so that resource IDs cannot be enumerated by probing.
- `409` — Conflict
- `422` — Validation Error. The response contains one error object for each invalid request value.
- `428` — Precondition Required
- `429` — Too Many Requests
- `500` — Internal Server Error
- `501` — Not Implemented
- `502` — Bad Gateway
- `503` — Service Unavailable

## Changes

- **2026-09-05** `1197c1fb1ef2` — 1 info
  - endpoint added

[Change history](https://skmtc.dev/natural/apis/natural-api/changes/simulations/realtime/:realtimeId/settle/post.md)

---

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