NAnatural
Simulations

Sandbox: void a check payment

Changed on

Drive a sandbox check payment to CANCELED through a second presentment return after a failed reclear

post/simulations/check/{checkId}/void

Request

  • Base URL
    https://api.sandbox.natural.com
  • URL
    https://api.sandbox.natural.com/simulations/check/{checkId}/void
  • Auth
    HTTP bearer

Path parameters

checkIdstring required

Check ID (chk_*).

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