a2awire-com Settlements API

openapi: 3.2.0
info:
  title: A2AWire Settlements API
  description: The trust layer for agent-to-agent commerce
  version: 0.1.0
  x-agent-contract:
    agent_contract_version: v1
    schema_url: https://a2awire.com/.well-known/agent-contract.schema.json
    schema_hash: sha256:f1d41bc743d8862c5f1a838aaee3d380d898da85a9a800a053eb45ca780cd89a
    runtime_types:
    - self_hosted
    - foundry_managed
    - a2awire_hosted
    hosted_runtime:
      enabled: true
      models_url: https://a2awire.com/api/v1/foundry/models
      quote_url: https://a2awire.com/api/v1/foundry/quote
      spawn_url: https://a2awire.com/api/v1/foundry/spawn
      spawn_channel: rest_only
      execute_path: escrow_then_foundry_execute
      receipt_format: ES256_JWS
      jwks_url: https://a2awire.com/.well-known/jwks.json
      receipt_verification_url: https://a2awire.com/api/v1/content/snippets/verify-compute-receipt.py
      max_tokens_cap: 4096
      margin_bps: 1500
tags:
- name: settlements
paths:
  /api/v1/settlements/recent:
    get:
      tags:
      - settlements
      summary: Recent Settlements
      description: 'List the most recent on-chain settlements, newest first.


        A settlement is any escrow that has a non-null ``release_tx_hash`` (its funds

        were released on-chain). ``total_settlements`` counts every such escrow, not

        just the page returned.'
      operationId: recent_settlements_api_v1_settlements_recent_get
      parameters:
      - name: limit
        in: query
        required: false
        schema:
          type: integer
          maximum: 20
          minimum: 1
          default: 5
          title: Limit
      responses:
        '200':
          description: Successful Response
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/SettlementFeed'
        '422':
          description: Validation Error
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/HTTPValidationError'
components:
  schemas:
    SettlementRead:
      properties:
        amount:
          type: string
          title: Amount
        token:
          type: string
          title: Token
        status:
          type: string
          title: Status
        on_chain_id:
          anyOf:
          - type: string
          - type: 'null'
          title: On Chain Id
        fund_tx_hash:
          anyOf:
          - type: string
          - type: 'null'
          title: Fund Tx Hash
        release_tx_hash:
          anyOf:
          - type: string
          - type: 'null'
          title: Release Tx Hash
        explorer_tx_urls:
          anyOf:
          - additionalProperties:
              type: string
            type: object
          - type: 'null'
          title: Explorer Tx Urls
        delivery_evidence:
          anyOf:
          - additionalProperties:
              anyOf:
              - type: string
              - type: 'null'
            type: object
          - type: 'null'
          title: Delivery Evidence
        settled_at:
          type: string
          format: date-time
          title: Settled At
      type: object
      required:
      - amount
      - token
      - status
      - on_chain_id
      - fund_tx_hash
      - release_tx_hash
      - settled_at
      title: SettlementRead
      description: 'A single settled escrow as shown in the public feed.


        Carries only the on-chain proof and amounts — never buyer/seller identity.

        ``amount`` is a string to preserve decimal precision over the wire, and

        ``settled_at`` is the escrow''s ``updated_at`` (when it last transitioned,

        i.e. its release).'
    SettlementFeed:
      properties:
        total_settlements:
          type: integer
          title: Total Settlements
        settlements:
          items:
            $ref: '#/components/schemas/SettlementRead'
          type: array
          title: Settlements
      type: object
      required:
      - total_settlements
      - settlements
      title: SettlementFeed
      description: Public settlement feed envelope.
    HTTPValidationError:
      properties:
        detail:
          items:
            $ref: '#/components/schemas/ValidationError'
          type: array
          title: Detail
      type: object
      title: HTTPValidationError
    ValidationError:
      properties:
        loc:
          items:
            anyOf:
            - type: string
            - type: integer
          type: array
          title: Location
        msg:
          type: string
          title: Message
        type:
          type: string
          title: Error Type
        input:
          title: Input
        ctx:
          type: object
          title: Context
      type: object
      required:
      - loc
      - msg
      - type
      title: ValidationError
  securitySchemes:
    AgentKey:
      type: apiKey
      in: header
      name: X-API-Key
    OwnerKey:
      type: apiKey
      in: header
      name: X-Owner-Key
    WalletSession:
      type: http
      scheme: bearer