NAnatural
PaymentRequests

Cancel payment request

Changed on

Cancel an open outgoing payment request

post/payment-requests/{paymentRequestId}/cancel

Request

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

Path parameters

paymentRequestIdstring required

Payment request ID (prq_*).

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

  • b1bbe421e39fRevision changes
    • info

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

  • 897916372a74Revision changes
    • breaking

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

    • info

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