intents

Cancel an intent before execution starts, or while its bank payment waits to be signed

post/intents/{intentId}/cancel

Request

  • Base URL
    https://api.catena.com/v1/agent-api
  • Auth
    HTTP bearer

Path parameters

intentIdstring required

Response

Full intent state after cancellation. Repeating the request for an already-cancelled intent returns the same successful projection. An intent can be cancelled while it waits for approval, after approval, or while it executes a bank payment that is prepared but not yet signed. Cancellation cannot stop or reverse a signed payment or other work already executing.

idstring required
accountIdstring

Resolved source account, pinned when the intent was created. Omitted for actions without an account.

type'send' | 'transfer' | 'create_counterparty' | 'request_counterparty_details' | 'x402' | 'mpp' | 'policy_override' | 'policy_proposal' | 'card_purchase' required
status'pending' | 'processing' | 'completed' | 'blocked' | 'failed' required
reasonsstring[] required
expiresAtstring date-time nullable required
evidenceobject

The evidence submitted with the intent, keyed by field key: text exactly as sent, or a file's details. Absent when the intent carries none

Changes

No recorded changes to this operation across all 1 revision of this API.