NAnatural
Payment Intents

Cancel payment intent

Changed on

Cancel an open payment intent

post/payment-intents/{paymentIntentId}/cancel

Request

  • Base URL
    https://api.natural.com
  • URL
    https://api.natural.com/payment-intents/{paymentIntentId}/cancel
  • Auth
    HTTP bearer

Path parameters

paymentIntentIdstring required

Payment intent ID (pmi_*).

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

  • 59c1208fa5dcRevision changes
    • info

      added the optional property // to the response with the status

  • 46c3e5516668Revision changes
    • warning

      added the new authorized enum value to the // response property for the response status

    • info

      added the optional property // to the response with the status

    • info

      added the optional property // to the response with the status