---
title: "Simulate Float Revenue Payout"
method: POST
path: "/api/v1/simulation/yield-payouts"
tags: ["Simulations"]
---

# Simulate Float Revenue Payout

`POST /api/v1/simulation/yield-payouts`

## Request

- Base URL: `https://merchant-api.accruesavings.com`
- URL: `https://merchant-api.accruesavings.com/api/v1/simulation/yield-payouts`
- Auth: none declared. Required headers: `Client-ID`, `Authorization`
- TypeScript: <https://skmtc.dev/byaccrue/apis/accrue-merchant-api/docs/api/v1/simulation/yield-payouts/post.ts> (a function with typed inputs; its response is checked against the schema)

Simulate the interest deposit that produces a float revenue payout, so an integration can be exercised before a real payout settles.

  Everything after the deposit is the real pipeline: the deposit is recorded, split across your accounts, and paid, then the `YieldPayoutCreated` webhook fires and the payout becomes retrievable from the yield payouts API. Nothing about the resulting payout is synthetic.

  The request is accepted immediately and returns 204. The payout appears asynchronously, so a read straight afterwards will not find it yet — wait for the webhook, or poll the list endpoint.

  `amount` is the deposit, not the payout. The payout is your contractual share of it, so it will be smaller.

  **This endpoint is only available in development, sandbox, and local testing environments.**

## Headers

- `Client-ID` string, uuid, required: The unique identifier of the client making the request. This header is required to retrieve the client-specific configuration and ensure that the response is tailored to the client's settings and permissions.
- `Authorization` string, uuid, required: Secure secret to access privileged endpoints.

## Request body

- object
  - `data` SimulateYieldPayout, required: SimulateYieldPayout
    - `id` string, uuid, required: Unique identifier for the object.
    - `type` 'SimulateYieldPayout', required
    - `attributes` object, required
      - `amount` integer, required: Interest deposit amount in cents. The payout produced from it is your contractual share of this, not the whole of it.

## Response `204`

Simulation accepted. The payout is recorded and paid asynchronously.

## Other responses

- `400`: Invalid amount, or the merchant has no account that can receive the deposit

---

[API](https://skmtc.dev/byaccrue/apis/accrue-merchant-api.md) - [All operations](https://skmtc.dev/byaccrue/apis/accrue-merchant-api/llms.txt) - [OpenAPI document](https://skmtc.dev/byaccrue/apis/accrue-merchant-api/revisions/3e2d97ef2e6e?raw)