Skip to main content
POST
Reject a return

Authorizations

Authorization
string
header
required

Bearer token for authentication with Augustus Banking API

Headers

Idempotency-Key
string
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.

Path Parameters

id
string<uuid>
required

ID of the return whose lifecycle is being simulated.

Body

application/json

Return rejection simulation parameters

reason
enum<string>
required

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

Available options:
invalid_routing_number,
invalid_account_format

Response

200 - application/json

The return rejection simulation acknowledgement

type
enum<string>
required

Resource type discriminator.

Available options:
return_simulation
return_id
string<uuid>
required

Return whose lifecycle is being simulated.