Simulations

Reject a payout

Changed on

Submits a network rejection for an existing payout through the sandbox provider pipeline. This endpoint is unavailable in live production.

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

Request

  • Base URL
    https://api.augustus.com
  • URL
    https://api.augustus.com/v1/simulations/payouts/{id}/reject
  • Auth
    HTTP bearer

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.

Request body

reason'invalid_routing_number' | 'invalid_account_format' required

Reason the sandbox provider rejects the payout. Use invalid_routing_number for domestic rails and invalid_account_format for a SWIFT correspondent rejecting on the beneficiary details.

Response

The payout rejection simulation acknowledgement

type'payout_simulation' required

Resource type discriminator.

payout_idstring uuid required

Payout whose lifecycle is being simulated.

Changes