Sign in
Simulations

Send a payout

Submits a successful send event for an existing payout through the sandbox provider pipeline. This endpoint is unavailable in live production.

post/v1/simulations/payouts/{id}/send

Path parameters

idstring uuid required

ID of the payout whose lifecycle is being simulated.

Headers

Idempotency-Keystring required

Idempotency key for safe retries. Reusing a key with an identical request body returns the cached response. Reusing a key with a different body returns 409.

Response

The payout send simulation acknowledgement

type'payout_simulation' required

Resource type discriminator.

successboolean required

Whether the simulation submission was successful.

payout_idstring uuid required

Payout whose lifecycle is being simulated.

event'send' | 'reject' | 'return' required

Payout lifecycle event submitted to the sandbox provider.

Changes

Changed in 1 of the 38 revisions of this API.1