v8
latestOpenAPI 3.1.12026-08-048937.6 MBSimulations
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.
Headers
Idempotency-Keystring required
Unique key for safely retrying a request without creating duplicates.
X-Agent-IDstring nullable
Agent (agt_*) to attribute this request to when authenticating with a party API key; omit for agent keys and agent-scoped OAuth grants, which already carry agent identity.
X-Instance-IDstring nullable
Caller-chosen identifier for the agent run, session, or conversation, required when an agent moves money.
Response
Successful Response