latestOpenAPI 3.1.12026-08-239938.6 MB
b1ad79e918ac
Payments
Cancel payment
Cancel a payment before the recipient begins claiming it
post/payments/{paymentId}/cancel
Path parameters
paymentIdstring required
Payment ID (pay_*).
Headers
Idempotency-Keystring required
Unique key for safely retrying a request without creating duplicates.
X-Agent-IDstring nullable
Deprecated: agent identity comes from the credential. Sending this header with a party API key or user credential returns 403 agent_credential_required.
X-Instance-IDstring nullable
Caller-chosen identifier for the agent run, session, or conversation, required when an agent moves money.
Response
Successful Response