Sign in
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.

Response

Successful Response

Changes

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

  • 359d267dca881See the full diff
    • ○

      deleted the header request parameter X-Agent-ID with deprecation

      request-parameter-removed-with-deprecation

  • b1ad79e918ac1See the full diff
    • ○

      header request parameter X-Agent-ID was deprecated

      request-parameter-deprecated

  • ba1fb54c59391See the full diff
    • ○

      added the required property data/attributes/tags to the response with the 200 status

      response-required-property-added

  • 270e233e401c11See 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 data/relationships/senderAgent to the response with the 200 status

      response-required-property-added