Perform an operation advertised by a vault item
Retrieve the item first and invoke only an operation listed in
available_operations, following its natural-language description.
Availability is rechecked at execution time; unavailable operations return 409.
Authorization and preparation may call an external provider and return updated state.
Link cards advertise authorize without checkout context. Eligible unused
AgentCard cards advertise prepare_checkout, which requires checkout context
and obtains device approval before native Square Pay. Keep the returned
approval page open, poll until ready_to_submit, then submit before
preparation.expires_at. Unused preparations expire automatically and cannot
be reused. If spend-request creation is rate limited,
returns HTTP 429 with code spend_request_rate_limited; stop and back
off before retrying.
Fill returns a value-free execution result. Validation failures before
writing return 400 (invalid request or targets), 403 (access or destination
denied), 404 (resource not found), or 409 (item or browser not ready).
Once writing starts, known partial failures and indeterminate field outcomes
return 200 with status failed or unknown, not an automatic-retry signal.
A transport error may leave the outcome unknown; do not automatically retry.
Authorizations
Bearer authentication header of the form Bearer <token>, where <token> is your auth token.
Body
- Option 1
- Option 2
- Option 3
- Option 4
Authorize a Link card using its existing purchase specification. Use only after explicit user approval and when the item advertises authorize. Do not automatically retry provider failures or indeterminate outcomes. Checkout context is not accepted.
authorize Response
Authorization or preparation completed or resumed, or fill execution outcomes returned
- Option 1
- Option 2
- Option 3
- Option 4
Authorization and preparation return the existing item shape. Fill returns a value-free execution result; it does not persist transient field outcomes on the item.
Immutable item key assigned when the item is created.
- Option 1
- Option 2
- Option 1
- Option 2
wallet - Option 1
- Option 2
- Option 3
- Option 4
- Option 5
- Option 6
- Option 7
Live, non-persisted data requested through the item GET expand parameter.