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-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

Changed in 7 of the 50 revisions of this API.123

Sep 23, 20266f76de3472aa5See the full diff
- ○
  added the required property // to the response with the status
  response-required-property-added
- ○
  added the required property // to the response with the status
  response-required-property-added
- ○
  added the required property // to the response with the status
  response-required-property-added
- ○
  added the required property // to the response with the status
  response-required-property-added
- ○
  added the required property // to the response with the status
  response-required-property-added
Sep 23, 2026bcf3b028c3e52See the full diff
- ○
  added optional request body
  request-body-added-optional
- ○
  added the required property // to the response with the status
  response-required-property-added
Sep 2, 2026c7c12da5915f12See the full diff
- ○
  added the optional property /// to the response with the status
  response-optional-property-added
- ○
  added the optional property /// to the response with the status
  response-optional-property-added
- ○
  added the optional property /// to the response with the status
  response-optional-property-added
- ○
  added the optional property /// to the response with the status
  response-optional-property-added
- ○
  added the optional property /// to the response with the status
  response-optional-property-added
- ○
  added the optional property /// to the response with the status
  response-optional-property-added
- ○
  added the optional property /// to the response with the status
  response-optional-property-added
- ○
  added the optional property /// to the response with the status
  response-optional-property-added
- ○
  added the optional property /// to the response with the status
  response-optional-property-added
- ○
  added the optional property /// to the response with the status
  response-optional-property-added
- ○
  added the optional property /// to the response with the status
  response-optional-property-added
- ○
  added the optional property /// to the response with the status
  response-optional-property-added
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 // to the response with the status
  response-required-property-added
Jul 26, 2026270e233e401c11See the full diff
- ●
  for the header request parameter Idempotency-Key, the maxLength was set to 255
  request-parameter-max-length-set
- ○
  added the required property // to the response with the status
  response-required-property-added

Full history