intents

Get an intent by id

get/intents/{id}

Request

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

Path parameters

idstring required

Response

Intent state. A completed payment intent's data carries paymentCredential (the credential to present to the seller) and transaction (the same shape send/transfer serve); data.x402 is a deprecated protocol-named copy of both. A payment carried by a movement plan carries movement: its nextStep reads wait while a person decides it, an admin signs it, or its signature is in flight, then done or blocked. A payment a person approved is signed by an admin, not the agent; an agent that restarted before signing a payment nobody had to approve sends its original request again on the same Idempotency-Key. status cannot carry this on its own, because a payment an admin is signing and one whose signature is in flight both read processing. A policy proposal carries proposal, whose reason says whether to wait or resubmit; once completed, its data names the policy approval created and the counterparty each proposed reference became.

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.