JavaScript
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
JavaScript
Authorizations
Bearer token for authentication with Augustus Banking API
Headers
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.
Path Parameters
ID of the payout whose lifecycle is being simulated.
Response
200 - application/json
The payout send simulation acknowledgement
Resource type discriminator.
Available options:
payout_simulation Whether the simulation submission was successful.
Payout whose lifecycle is being simulated.
Payout lifecycle event submitted to the sandbox provider.
Available options:
send, reject, return