v6

OpenAPI 3.1.12026-08-027636.5 MB

PaymentRequests

Cancel payment request

Cancel an open outgoing payment request

post/payment-requests/{paymentRequestId}/cancel

Path parameters

paymentRequestIdstring required

Payment request ID (prq_*).

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