Return a settled payout
Submits an inbound return for a settled payout through the sandbox provider pipeline. The original payout remains settled and a standalone deposit is created. This endpoint is unavailable in live production.
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.
Body
Payout return simulation parameters
Reason the receiving bank returns the settled payout.
account_closed, invalid_account_format, invalid_routing_number, account_blocked, unknown Response
The payout return simulation acknowledgement
Resource type discriminator.
payout_simulation Whether the simulation submission was successful.
Payout whose lifecycle is being simulated.
Payout lifecycle event submitted to the sandbox provider.
send, reject, return