openapi: 3.1.0
info:
  title: OptOut.cash API
  version: 0.1.0
  description: |
    Agent-facing API for converting supported USDC and USDT rails to native BTC. Runtime quote and
    payment responses are authoritative. The server does not custody funds or
    provide first-party BTC liquidity.
  x-guidance: |
    Prefer POST /api/settlements/quote and POST /api/settlements/create.
    Settlement create requires an Idempotency-Key header. Do not expose memos,
    vaults, router internals, or provider details in user-facing flows.
servers:
  - url: /
paths:
  /api/x402/capabilities:
    get:
      operationId: getCapabilities
      summary: Inspect the stablecoin to BTC capability boundary.
      responses:
        "200":
          description: Supported input, output, route policy, and replay policy.
          content:
            application/json:
              schema:
                $ref: "#/components/schemas/Capabilities"
  /api/settlements/quote:
    post:
      operationId: quoteStablecoinToBtc
      summary: Quote stablecoin settlement to native BTC.
      description: |
        Preferred agent entry point. Returns a private-only quote with hidden
        route details, network cost metadata, quote expiry, privacy caveats, and output
        amount.
      requestBody:
        required: true
        content:
          application/json:
            schema:
              $ref: "#/components/schemas/SettlementRequest"
            examples:
              base:
                value:
                  sourceAssetId: base-usdc
                  amountUsd: "10.00"
                  refundAddress: "0x0000000000000000000000000000000000000000"
                  output:
                    type: bitcoin
                    address: bc1qexampleaddressreplacewithrealmainnetaddress000000
                  privacyMode: required
      responses:
        "200":
          description: Private settlement quote.
          content:
            application/json:
              schema:
                $ref: "#/components/schemas/PrivateSettlementQuote"
        "400":
          $ref: "#/components/responses/Error"
        "502":
          $ref: "#/components/responses/Error"
  /api/settlements/create:
    post:
      operationId: createStablecoinToBtc
      summary: Create stablecoin to BTC funding instructions.
      description: |
        Preferred state-changing agent entry point. Requires an Idempotency-Key
        header. Returns private quote metadata plus wallet-signed funding
        instructions.
      x-replay-policy: idempotency_key_required
      parameters:
        - name: Idempotency-Key
          in: header
          required: true
          schema:
            type: string
            minLength: 8
            maxLength: 180
      requestBody:
        required: true
        content:
          application/json:
            schema:
              $ref: "#/components/schemas/SettlementRequest"
      responses:
        "200":
          description: Private settlement funding instructions.
          content:
            application/json:
              schema:
                $ref: "#/components/schemas/PrivateSettlement"
        "400":
          $ref: "#/components/responses/Error"
        "502":
          $ref: "#/components/responses/Error"
  /api/quotes/thorchain:
    post:
      operationId: quoteThorchainBtcPurchase
      summary: Adapter-level quote for supported stablecoins to native BTC.
      description: Low-level testing route. Agents should prefer `/api/settlements/quote`.
      requestBody:
        required: true
        content:
          application/json:
            schema:
              $ref: "#/components/schemas/ThorchainQuoteRequest"
            examples:
              base:
                value:
                  sourceAssetId: base-usdc
                  destinationId: bitcoin
                  amountUsd: "10.00"
                  destinationAddress: bc1qexampleaddressreplacewithrealmainnetaddress000000
                  refundAddress: "0x0000000000000000000000000000000000000000"
                  liquidityToleranceBps: 300
      responses:
        "200":
          description: THORChain quote.
          content:
            application/json:
              schema:
                type: object
                additionalProperties: true
        "400":
          $ref: "#/components/responses/Error"
        "502":
          $ref: "#/components/responses/Error"
  /api/status/thorchain:
    get:
      operationId: getThorchainStatus
      summary: Get settlement status by funding transaction hash.
      parameters:
        - name: txHash
          in: query
          required: true
          schema:
            type: string
            pattern: "^(0x)?[a-fA-F0-9]{64}$"
      responses:
        "200":
          description: Upstream status payload.
          content:
            application/json:
              schema:
                type: object
                additionalProperties: true
        "400":
          $ref: "#/components/responses/Error"
  /api/status/bitcoin:
    get:
      operationId: getBitcoinStatus
      summary: Get Bitcoin delivery confirmation status by Bitcoin transaction hash.
      parameters:
        - name: txHash
          in: query
          required: true
          schema:
            type: string
            pattern: "^[a-fA-F0-9]{64}$"
      responses:
        "200":
          description: Bitcoin mempool or confirmation status.
          content:
            application/json:
              schema:
                type: object
                additionalProperties: false
                required: [state, txHash, confirmed]
                properties:
                  state:
                    type: string
                    enum: [not_found, mempool, confirmed]
                  txHash:
                    type: string
                  confirmed:
                    type: boolean
                  blockHeight:
                    type:
                      - integer
                      - "null"
                  blockTime:
                    type:
                      - integer
                      - "null"
        "400":
          $ref: "#/components/responses/Error"
components:
  responses:
    Error:
      description: Machine-readable error response.
      content:
        application/json:
          schema:
            $ref: "#/components/schemas/ErrorResponse"
  schemas:
    ErrorResponse:
      type: object
      additionalProperties: false
      required: [error]
      properties:
        error:
          type: object
          additionalProperties: true
          required: [code, message]
          properties:
            code:
              type: string
            message:
              type: string
    Capabilities:
      type: object
      additionalProperties: true
      required: [service, productBoundary, inputBoundary, outputBoundary, settlementApis, routePolicy]
      properties:
        service:
          type: string
          const: optout
        name:
          type: string
          const: OptOut.cash
        productBoundary:
          type: object
          additionalProperties: true
        inputBoundary:
          type: object
          additionalProperties: true
        outputBoundary:
          type: object
          additionalProperties: true
        settlementApis:
          type: object
          additionalProperties: true
        routePolicy:
          type: object
          additionalProperties: true
        x402:
          type: object
          additionalProperties: true
        replayPolicy:
          type: object
          additionalProperties: true
        unsupported:
          type: object
          additionalProperties: true
    SettlementRequest:
      type: object
      additionalProperties: false
      required: [sourceAssetId, amountUsd, refundAddress, output]
      properties:
        sourceAssetId:
          type: string
          enum: [base-usdc, eth-usdc, bsc-usdc, bsc-usdt, tron-usdt]
          default: base-usdc
        amountUsd:
          type: string
          minLength: 1
        refundAddress:
          type: string
          minLength: 26
          maxLength: 120
          description: Source-chain refund address used by THORChain for returns.
        output:
          type: object
          additionalProperties: false
          required: [type, address]
          properties:
            type:
              type: string
              const: bitcoin
            address:
              type: string
              minLength: 26
              maxLength: 120
              description: Fresh Bitcoin mainnet address.
        privacyMode:
          type: string
          const: required
          default: required
    PrivateSettlementQuote:
      type: object
      additionalProperties: true
      required: [settlementId, mode, input, output, quote, fees, privacy, settlementRoute, generatedAt]
      properties:
        settlementId:
          type: string
        mode:
          type: string
          const: private
        input:
          type: object
          additionalProperties: true
        output:
          type: object
          additionalProperties: true
        quote:
          type: object
          additionalProperties: true
          required: [expectedAmountOutSats, estimatedUsdValue, totalSettlementSeconds, refreshAt]
          properties:
            expectedAmountOutSats:
              type: string
            estimatedUsdValue:
              type: string
            totalSettlementSeconds:
              type: number
            refreshAt:
              type: number
        fees:
          type: object
          additionalProperties: true
        privacy:
          type: object
          additionalProperties: true
        settlementRoute:
          type: object
          additionalProperties: true
        generatedAt:
          type: string
          format: date-time
    PrivateSettlement:
      allOf:
        - $ref: "#/components/schemas/PrivateSettlementQuote"
        - type: object
          additionalProperties: true
          required: [execution]
          properties:
            execution:
              type: object
              additionalProperties: true
    ThorchainQuoteRequest:
      type: object
      additionalProperties: false
      required: [amountUsd, destinationAddress, refundAddress]
      properties:
        sourceAssetId:
          type: string
          enum: [base-usdc, eth-usdc, bsc-usdc, bsc-usdt, tron-usdt]
          default: base-usdc
        destinationId:
          type: string
          const: bitcoin
          default: bitcoin
        amountUsd:
          type: string
          minLength: 1
        destinationAddress:
          type: string
          minLength: 26
          maxLength: 120
        refundAddress:
          type: string
          description: Source-chain refund address used by THORChain for returns.
        liquidityToleranceBps:
          type: integer
          minimum: 1
          maximum: 9999