FiatDock Offramp API

openapi: 3.2.0
info:
  title: FiatDock Offramp API
  version: 1.16.1
  contact:
    name: FiatDock
    email: osama@fiatdock.com
    url: https://fiatdock.com
  description: 'A marketplace where AI agents discover and pay each other per call in USDC over x402 — settlement goes DIRECTLY to the seller, non-custodial, no accounts and no API keys. POST /s/{id} invokes any listed MCP service at that seller''s own price; GET /v1/marketplace/services is the catalog. Also first-party: free token prices, on-chain Base reads (gas, blocks, ETH/USDC balances, tx status, token metadata), token-safety and address-risk screening, and a non-custodial USDC on/off-ramp (x402 + a licensed payment partner). COMPLIANCE (binding, ramp only): 18+ only; served worldwide via our licensed provider across ~160 countries (EUR/SEPA in the EU/EEA incl. Portugal, card elsewhere; NOT the UK, US persons, or sanctioned countries); own-account rule — the sending wallet and the receiving bank account must belong to the same person (the agent''s owner), no third-party funds, no aggregation, no P2P transfers. Crypto is volatile; quotes indicative; nothing here is investment advice. RETRIES: GET endpoints are idempotent — repeat freely. Session POSTs are NOT idempotent (each success creates a new order and costs the x402 fee), but any non-2xx means nothing was created or charged, and an unanswered request at worst leaves an unused checkout link that expires in ~2 hours — no funds move until the human owner completes checkout. Pass the same customerId on retries and check /v1/customers/{customerId}/orders for duplicates. On 429, sleep Retry-After seconds.'
  termsOfService: https://fiatdock.com/terms.html
  x-guidance: 'Start FREE: GET /v1/token/price?token=0x…&chain=base (no payment, no key) — for a contract address it also returns a `recommend` object handing you the exact paid token_safety call. Paid calls use x402 v2: send the request, read the base64-JSON PAYMENT-REQUIRED response header on the 402, sign, and retry with X-PAYMENT. Nothing is charged on a 402. Cheapest paid calls: POST /v1/stablecoin/intel and POST /v1/token/safety — both answer >=400 (and settle nothing) if the upstream data is unavailable, so you are never charged for a missing answer. Everything here is also exposed as MCP tools at https://fiatdock.com/mcp (Streamable HTTP) or `npx fiatdock-mcp` (stdio, pays automatically).'
  x-agent-rules:
    neverChargedFor:
    - A 402 — that is the price quote, not a charge. Retrying is always safe.
    - Any 4xx. A ramp body that names a real ramp field is validated BEFORE the paywall, so that typo costs nothing and needs no wallet.
    - A 5xx or an upstream failure on a paid data route — x402 settles only on <400.
    beforeYouPayAnything:
    - GET /v1/quote?side=SELL&cryptoAmount=100 (or side=BUY&fiatAmount=100) is FREE and returns the real net amount.
    - 'POST the session body with no payment header. A 400 means fix the body. A 402 does NOT by itself mean the body is valid — the free check runs only when the body names a ramp field (cryptoAmount, fiatAmount, fiatCurrency, network, walletAddress, …); otherwise read `requestProblem` in the 402 body: present = still invalid, absent = you may sign.'
    inputWeAccept:
      amounts: Numbers or strings. "100,50", "1.234,56", "1,234.56", "١٠٠", "€100" are all understood.
      walletAddress: 0x + 40 hex. A bare 40-hex string (no 0x) and surrounding whitespace are accepted.
      fiatCurrency: 'ISO code, any case. "eur", "€", "euro" → EUR. 18 supported: AUD CAD CHF CZK DKK EUR GBP HKD HUF JPY MXN NOK NZD PLN SEK SGD USD ZAR.'
      network: base | ethereum | polygon | arbitrum | optimism | avalanche | bsc. Chain ids (8453, eip155:8453) and short forms (eth, arb, op, avax, bnb) also work.
      side: Exactly "SELL" or "BUY". Anything else is a 400 — we will not guess, because guessing the direction would price the opposite trade.
    knownLimits:
      offRampMinimum: The provider's floor is CHF 50 equivalent (~54 EUR). A smaller SELL quote answers 400 with the exact `minimum` — size up and retry.
      orderStatus: Orders stay SESSION_CREATED. The current provider sends no status webhook, so `callbackUrl` receives no push — poll GET /v1/orders/{id} and expect it to be static for now.
      checkoutTtl: checkoutUrl is valid ~2 hours. Forward it to the human owner promptly.
      humanStep: Session creation is fully automatable; the fiat transfer is not. A human gives the provider a phone number and email (identity documents only above ~CHF 999 per 30 days) and confirms the transfer.
    ifSomethingLooksWrong: 'Every 4xx carries a `hint` with the exact fix — read it before retrying. Live health: GET https://fiatdock.com/status. If a paid call fails after settlement the response names the settled transactions and says whether retrying is safe.'
servers:
- url: https://fiatdock.com
tags:
- name: Offramp
paths:
  /v1/offramp/session:
    post:
      operationId: createOfframpSession
      description: 'Sell the agent''s USDC to fiat in the OWNER''S OWN bank account (own-account rule: same person owns the sending wallet and the receiving bank account; no third-party funds, no aggregation, no P2P).'
      requestBody:
        required: true
        content:
          application/json:
            example:
              cryptoAmount: 100
            schema:
              type: object
              required:
              - cryptoAmount
              properties:
                cryptoAmount:
                  type: number
                  exclusiveMinimum: 0
                  example: 100
                  description: 'USDC to sell. Notation is coerced: "100,50", "١٠٠", "1,234.56" all work. Below the provider''s ~CHF 50 floor the QUOTE returns the exact minimum.'
                fiatCurrency:
                  type: string
                  description: 'ISO code; "eur"/"€"/"euro" are accepted. Supported: AUD CAD CHF CZK DKK EUR GBP HKD HUF JPY MXN NOK NZD PLN SEK SGD USD ZAR'
                network:
                  type: string
                  default: base
                  description: base | ethereum | polygon | arbitrum | optimism | avalanche | bsc. Chain ids (8453, eip155:8453) and short forms (eth, arb, op) are also accepted.
                walletAddress:
                  type: string
                  pattern: ^0x[0-9a-fA-F]{40}$
                  description: optional SELL source wallet (EIP-55 checksum verified when mixed-case) — pre-fills the widget; required with walletCode/walletHash
                email:
                  type: string
                customerId:
                  type: string
                callbackUrl:
                  type: string
                  description: stored for a future provider with status webhooks — the CURRENT provider sends none, so no push will arrive (order stays SESSION_CREATED)
                walletCode:
                  type: string
                  pattern: ^[1-9][0-9]{3}$
                  description: 'optional Mt Pelerin address lock, part 1: 4-digit code — requires walletHash + walletAddress'
                walletHash:
                  type: string
                  description: 'optional Mt Pelerin address lock, part 2: base64 signature of ''MtPelerin-<code>'' by the agent''s OWN wallet key — requires walletCode'
                ref:
                  type: string
                  description: 'optional referral code (1-64 chars: letters, digits, _ or -)'
                provider:
                  type: string
                  enum:
                  - mtpelerin
                  description: Licensed fiat provider. `mtpelerin` is the only provider on this server and the default — omit this field. It settles by SEPA bank transfer across the SEPA zone (incl. Portugal); its order status is not push-updated. Any other value returns 400 (no other provider is configured on this server).
      responses:
        '200':
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/Session'
          description: checkoutUrl + partnerOrderId (+ customerKey, shown once)
        '400':
          description: 'Invalid request — answered FREE by the pre-paywall preflight (ADR-0054): no payment is attempted and nothing is charged. Body carries `error`, `hint` and a `note` confirming no charge. Notation is coerced first — decimal commas, Arabic-Indic/Persian digits, currency symbols, an address missing its 0x, and chain ids or short forms (8453, eip155:8453, eth, arb, op) are all accepted — so only genuinely invalid input reaches this.'
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/Error'
        '402':
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/PaymentRequired'
          description: 'x402 v2 Payment Required: the exact requirements arrive base64-JSON in the PAYMENT-REQUIRED response header (pay $0.01 USDC on base = CAIP-2 eip155 id), then retry with the PAYMENT-SIGNATURE header (x402 v2; the v1 name X-PAYMENT is also accepted). Nothing is charged on a 402 — retrying is always safe.'
        '429':
          description: Rate limited (global 120/min/IP; stricter buckets on /mcp, webhook, auth). Sleep exactly Retry-After seconds, then retry.
          headers:
            Retry-After:
              schema:
                type: integer
              description: Seconds until the window resets — sleep this long, then retry
            RateLimit-Limit:
              schema:
                type: integer
              description: Requests allowed per window in this bucket
            RateLimit-Remaining:
              schema:
                type: integer
              description: Requests left in the current window (0 on 429)
            RateLimit-Reset:
              schema:
                type: integer
              description: Seconds until the window resets
        '503':
          description: 'Provider activation in progress: {"status":"activating","retryAfterSeconds":3600} with a friendly error message. RAMP_CHARGE_ON_ACTIVATION is on, so paid ramp calls reach the paywall instead of short-circuiting — but nothing is charged: the 200 that would settle the fee needs an account-level failure from the provider, and the current provider composes the checkout URL locally, so there is no upstream call left to fail that way (ADR-0050). The normal 402 flow resumes automatically once the provider is active. Quote 503s also carry an "indicative" object (real public market spot rate, labelled non-executable). Respect Retry-After (or watch /status), then retry.'
          headers:
            Retry-After:
              schema:
                type: integer
              description: Seconds to wait before retrying (3600)
      x-payment-info:
        price:
          mode: fixed
          currency: USD
          amount: '0.010000'
        protocols:
        - x402: {}
      tags:
      - Offramp
      summary: Create offramp session
      x-summary-source: derived
components:
  schemas:
    PaymentRequired:
      type: object
      description: The 402 body (ADR-0045). Nothing is charged and nothing is created on a 402 — retrying is always safe.
      properties:
        error:
          type: string
        priceUsd:
          type: number
          description: Price in dollars. Present on single-leg challenges; multi-leg challenges omit it — read `accepts`.
        accepts:
          type: array
          description: The exact payment terms to sign, mirrored from the PAYMENT-REQUIRED header.
          items:
            type: object
        hint:
          type: string
          description: How to pay, and what to do if you have no wallet.
        docs:
          type: string
      required:
      - error
      - accepts
      - hint
    Error:
      type: object
      description: Every 4xx carries a `hint` with the exact fix — treat it as part of the contract.
      properties:
        error:
          type: string
        hint:
          type: string
      required:
      - error
      - hint
    Session:
      type: object
      description: A created ramp session. Forward checkoutUrl to the human owner (valid ~2 hours).
      properties:
        partnerOrderId:
          type: string
          description: Order id — track it with get_order_status
        provider:
          type: string
          description: Licensed fiat provider handling this session (e.g. mtpelerin)
        checkoutUrl:
          type: string
          description: Branded checkout URL (valid ~2 hours) — forward to the human owner
        note:
          type: string
          description: Next-step instructions
        emailedTo:
          type: string
          description: 'Present when an `email` was supplied and email is configured: the checkout link was also emailed to this address (best-effort)'
        customerKey:
          type: string
          description: Returned ONCE on the first session with a new customerId — store securely
        customerKeyNote:
          type: string
          description: How to use customerKey
      required:
      - partnerOrderId
      - checkoutUrl
externalDocs:
  description: Agent skill file — what to run before acting on a token, an address or a counterparty (text/markdown, live prices and catalog)
  url: https://fiatdock.com/skill.md
x-payment-protocol:
  protocol: x402
  version: 2
  network: base
  asset: USDC
  payTo: '0xeB12bB2f52EeD33DBa6A00774E48324032Fd87C6'
  mode: per-call
  paid:
  - path: /v1/offramp/session
    method: POST
    priceUsd: 0.01
  - path: /v1/onramp/session
    method: POST
    priceUsd: 0.01
  - path: /v1/token/safety
    method: POST
    priceUsd: 0.0045
  - path: /v1/stablecoin/intel
    method: POST
    priceUsd: 0.002
  - path: /v1/chain/token-metadata
    method: POST
    priceUsd: 0.002
  - path: /v1/chain/gas-price
    method: POST
    priceUsd: 0.001
  - path: /v1/chain/block
    method: POST
    priceUsd: 0.001
  - path: /v1/chain/eth-balance
    method: POST
    priceUsd: 0.001
  - path: /v1/chain/usdc-balance
    method: POST
    priceUsd: 0.001
  - path: /v1/chain/tx-status
    method: POST
    priceUsd: 0.001
  - path: /v1/chain/address-intel
    method: POST
    priceUsd: 0.0045
  - path: /v1/chain/token-report
    method: POST
    priceUsd: 0.0045
  - path: /v1/web/read
    method: POST
    priceUsd: 0.0018
  - path: /v1/email/check
    method: POST
    priceUsd: 0.001
  - path: /v1/market/perp
    method: POST
    priceUsd: 0.001
  - path: /v1/markets/prediction
    method: POST
    priceUsd: 0.0045
  - path: /v1/defi/yields
    method: POST
    priceUsd: 0.001
  - path: /v1/fx/rates
    method: POST
    priceUsd: 0.001
  - path: /v1/chain/portfolio
    method: POST
    priceUsd: 0.0045
  - path: /v1/token/holders
    method: POST
    priceUsd: 0.0027
  - path: /v1/domain/intel
    method: POST
    priceUsd: 0.0045
  - path: /v1/web/contacts
    method: POST
    priceUsd: 0.0027
  - path: /v1/news/crypto
    method: POST
    priceUsd: 0.001
  - path: /v1/sec/filings
    method: POST
    priceUsd: 0.0027
  - path: /v1/text/prompt-check
    method: POST
    priceUsd: 0.0045
  - path: /v1/token/screener
    method: POST
    priceUsd: 0.009
  - path: /v1/papers/search
    method: POST
    priceUsd: 0.009
  - path: /v1/geo/satellite
    method: POST
    priceUsd: 0.009
  - path: /v1/web/seo-audit
    method: POST
    priceUsd: 0.009
  - path: /v1/x402/top
    method: POST
    priceUsd: 0.009
  - path: /v1/chain/ens
    method: POST
    priceUsd: 0.0027
  - path: /v1/time/convert
    method: POST
    priceUsd: 0.001
  - path: /v1/calendar/holidays
    method: POST
    priceUsd: 0.001
  - path: /v1/weather/forecast
    method: POST
    priceUsd: 0.0018
  - path: /v1/wiki/summary
    method: POST
    priceUsd: 0.0018
  - path: /v1/news/hackernews
    method: POST
    priceUsd: 0.0027
  - path: /v1/feed/read
    method: POST
    priceUsd: 0.0022
  - path: /v1/dev/package
    method: POST
    priceUsd: 0.0027
  - path: /v1/sec/financials
    method: POST
    priceUsd: 0.0045
  - path: /v1/token/verdict
    method: POST
    priceUsd: 0.009
  - path: /v1/market/backtest
    method: POST
    priceUsd: 0.009
  - path: /s/{id}
    method: POST
    priceUsd: null
    note: per-listing price; the 402 is authoritative
  free:
  - /v1/quote
  - /v1/token/price
  - /v1/orders/{partnerOrderId}
  - /v1/marketplace/services
  - /v1/marketplace/services/{id}
  - /v1/marketplace/demand
  - /v1/x402/search
  relay:
  - path: /v1/x402/call
    method: POST
    priceUsd: null
    note: carries the caller's PAYMENT-SIGNATURE to an index-listed x402 endpoint; that endpoint's 402 is authoritative and its payTo receives the money — FiatDock charges nothing here