NAnatural
Payments

Cancel payment

Changed on

Cancel a pending payment claim before the recipient claims it

post/payments/{paymentId}/cancel

Request

  • Base URL
    https://api.natural.com
  • URL
    https://api.natural.com/payments/{paymentId}/cancel
  • Auth
    HTTP bearer

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

  • 897916372a74Revision changes
    • breaking

      removed the required property // from the response with the status

    • info

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

  • 6f76de3472aaRevision changes
    • info

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

    • info

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

    • info

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

    • info

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

    • info

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