FiatDock · Schema

Session

A created ramp session. Forward checkoutUrl to the human owner (valid ~2 hours).

MarketplaceArtificial IntelligencePaymentsBlockchainCryptocurrencyCompany

Properties

Name	Type	Description
partnerOrderId	string	Order id — track it with get_order_status
provider	string	Licensed fiat provider handling this session (e.g. mtpelerin)
checkoutUrl	string	Branded checkout URL (valid ~2 hours) — forward to the human owner
note	string	Next-step instructions
emailedTo	string	Present when an `email` was supplied and email is configured: the checkout link was also emailed to this address (best-effort)
customerKey	string	Returned ONCE on the first session with a new customerId — store securely
customerKeyNote	string	How to use customerKey

View JSON Schema on GitHub

JSON Schema

{
  "$schema": "https://json-schema.org/draft/2020-12/schema",
  "$id": "https://artifacts.apis.io/fiatdock-com/json-schema/fiatdock-com-session-schema.json",
  "title": "Session",
  "description": "A created ramp session. Forward checkoutUrl to the human owner (valid ~2 hours).",
  "x-generated": "2026-11-10",
  "x-method": "derived",
  "x-generator": "derive-json-schema.py",
  "x-source": "openapi/fiatdock-com-offramp-api-openapi.yml#/components/schemas/Session",
  "type": "object",
  "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"
  ]
}

Work with this as data

Every JSON Schema here is available over the APIs.io API and to AI agents over MCP.

MCP server

One button, every client — Claude, Cursor, VS Code and the rest.

https://apis.io/mcp

Tools for schemas

4 MCP tools reach this

find_json_schemasBrowse and filter every JSON Schema in the catalog.
apis_io_searchSTART HERE — APIs, providers and tags for one query, each with its total.
resolveTurn a domain, URL or GitHub org into the provider it belongs to.
find_cohortsEvery scored population of providers in the catalog.

All 92 tools →

Call it yourself

curl for this page

This JSON Schema

curl "https://apis.io/api/v1/json-schemas/fiatdock-com-session"

All schemas

curl "https://apis.io/api/v1/json-schemas?limit=25"

Calls without X-API-Key need no key. Calls with it need a paid plan — get a key.

Get an API key

Free tier, no form to fill in. Signing in shares your email address with us — we store it to create your key and to recognise you if you sign in with another provider. See our Privacy Policy and Terms.

GitHub Google LinkedIn

A second provider on the same verified email joins the account you already have.