Skip to main content
Initiate a payment inside the agent vault envelope. An amount at or above the step-up threshold can create a pending payment and return an approval URL if other policy checks pass. The configured worker handles execution. Track the pending payment through settlement; an accepted request is not proof that funds moved.

Metadata

Annotations

Input schema

Output schema

Auth

Caller’s grant must include the payments:initiate scope. Grants whose scope set is a superset of the required scope are accepted.

Request examples

Response examples

Success — payment accepted and queued for broadcast:
Step-up required (amount exceeds step_up_amount_cents in the envelope):
Policy denied — daily cap exceeded:

Errors

Step-up flow

When the amount is at or above the envelope’s step_up_amount_cents threshold, the server returns -32003 with data.step_up_url. The pending payment or vault proposal already exists. Open that URL for the principal to review and approve the existing action. The reference client returns a StepUpRequired result for this response. Check for it before reading payment fields. An accepted response means the action was enqueued; check its recorded status before treating it as settled. payments.initiate has no step_up_sigil input or client sigil option. Do not create another payment or change the idempotency key to complete approval. Follow the approval URL and monitor the existing action in the audit feed. See Step-up approvals for the approval model and API clients for handling the response.