Decline payment request as test payer

Decline an open payment request addressed to your test payer

post/simulations/payment-requests/{paymentRequestId}/decline

Path parameters

paymentRequestIdstring required

Payment request controlled by the fixture.

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.

Successful Response

Changed in 4 of the 28 revisions of this API.4

Aug 27, 2026359d267dca881See the full diff
- ○
  deleted the header request parameter X-Agent-ID with deprecation
  request-parameter-removed-with-deprecation
Aug 23, 2026b1ad79e918ac1See the full diff
- ○
  header request parameter X-Agent-ID was deprecated
  request-parameter-deprecated
Aug 13, 2026ba1fb54c59391See the full diff
- ○
  added the required property data/attributes/tags to the response with the 200 status
  response-required-property-added
Aug 4, 20260e0686ff0b441See the full diff
- ○
  endpoint added
  endpoint-added