NAnatural
Simulations

Sandbox: fail a wire payment

Changed on

Reject a test wire payment

post/simulations/wire/{wireId}/fail

Request

  • Base URL
    https://api.sandbox.natural.com
  • Auth
    HTTP bearer

Path parameters

wireIdstring required

Wire ID (wire_*).

Headers

Idempotency-Keystring required

Unique key for safely retrying a request without creating duplicates.

X-Instance-IDstring nullable

Caller-chosen identifier for the agent run, session, or conversation, required when an agent moves money.

Request body

Response

Successful Response

Changes

  • bb3d10115255Revision changes
    • warning

      added the new wireSimulation enum value to the / response property for the response status

    • info

      removed the wire-simulation enum value from the / response property for the response status

  • bbac797fe7f1Revision changes
    • breaking

      removed the required property // from the response with the status