Reject a payout
Submits a network rejection for an existing payout through the sandbox provider pipeline. 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 rejection simulation parameters
Reason the sandbox provider rejects the payout.
invalid_routing_number Response
The payout rejection 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