Simulate Float Revenue Payout
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.
Request
- Base URLhttps://merchant-api.accruesavings.com
- Authnone declared. Required headers: Client-ID, Authorization
- TypeScriptA function with typed inputs. Its response is checked against the schema.
Headers
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.
Secure secret to access privileged endpoints.
Request body
Example request
{
"data": {
"attributes": {
"amount": 3493200
}
}
}Response
Simulation accepted. The payout is recorded and paid asynchronously.
Changes
No recorded changes to this operation across all 1 revision of this API.