Cleared · JSON-LD Context

Clearedpay Xyz Context

JSON-LD context defining the semantic vocabulary for Clearedpay Xyz from Cleared.

9 Classes 74 Properties 4 Namespaces
View Context View on GitHub

Namespaces

schema: https://schema.org/
xsd: http://www.w3.org/2001/XMLSchema#
dcterms: http://purl.org/dc/terms/
clearedpay: https://clearedpay.xyz/schema#

Classes

Invoice AccountMetrics ProtocolStats InvoiceStats ErrorResponse IdempotencyMeta ReadMeta CliOAuthToken OAuthError

Properties

Property Type Container
id string
chainId integer
agent string
payer string
merchant string
token string
amount string
dueAt string
metaHash string
tokenURI reference
status string
refBps integer
referrer string
issuedAt string
paidAt string
canceledAt string
quoteId string
currency string
amountFormatted string
fee
address string
quotesCreated integer
quotesAccepted integer
quotesRejected integer
quotesExpired integer
invoicesIssued integer
invoicesPaid integer
invoicesCanceled integer
grossVolume string
protocolFees string
netVolume string
totalQuotes integer
totalQuotesAccepted integer
totalQuotesRejected integer
totalQuotesExpired integer
totalInvoices integer
totalInvoicesPaid integer
totalInvoicesCanceled integer
totalVolume6d string
totalFees6d string
chain
fees
lastUpdated string
totalCount integer
pendingCount integer
paidCount integer
canceledCount integer
totalPaidAmount string
totalPendingAmount string
coverage string
feesPaid
statuses
error
requestId string
key string
replayed boolean
state string
source string
indexerSyncedBlock integer
chainHeadBlock integer
reconciled boolean
access_token string
token_type string
expires_in integer
refresh_token string
refresh_expires_in integer
scope string
grant_id string
user
studio
api_origin reference
web_origin reference
error_description string
request_id string

JSON-LD Document

Raw ↑
{
  "@context": {
    "@vocab": "https://clearedpay.xyz/schema#",
    "schema": "https://schema.org/",
    "xsd": "http://www.w3.org/2001/XMLSchema#",
    "dcterms": "http://purl.org/dc/terms/",
    "clearedpay": "https://clearedpay.xyz/schema#",
    "Invoice": "clearedpay:Invoice",
    "id": {
      "@id": "clearedpay:id",
      "@type": "xsd:string"
    },
    "chainId": {
      "@id": "clearedpay:chainId",
      "@type": "xsd:integer"
    },
    "agent": {
      "@id": "clearedpay:agent",
      "@type": "xsd:string"
    },
    "payer": {
      "@id": "clearedpay:payer",
      "@type": "xsd:string"
    },
    "merchant": {
      "@id": "clearedpay:merchant",
      "@type": "xsd:string"
    },
    "token": {
      "@id": "clearedpay:token",
      "@type": "xsd:string"
    },
    "amount": {
      "@id": "clearedpay:amount",
      "@type": "xsd:string"
    },
    "dueAt": {
      "@id": "clearedpay:dueAt",
      "@type": "xsd:string"
    },
    "metaHash": {
      "@id": "clearedpay:metaHash",
      "@type": "xsd:string"
    },
    "tokenURI": {
      "@id": "clearedpay:tokenURI",
      "@type": "@id"
    },
    "status": {
      "@id": "clearedpay:status",
      "@type": "xsd:string"
    },
    "refBps": {
      "@id": "clearedpay:refBps",
      "@type": "xsd:integer"
    },
    "referrer": {
      "@id": "clearedpay:referrer",
      "@type": "xsd:string"
    },
    "issuedAt": {
      "@id": "clearedpay:issuedAt",
      "@type": "xsd:string"
    },
    "paidAt": {
      "@id": "clearedpay:paidAt",
      "@type": "xsd:string"
    },
    "canceledAt": {
      "@id": "clearedpay:canceledAt",
      "@type": "xsd:string"
    },
    "quoteId": {
      "@id": "clearedpay:quoteId",
      "@type": "xsd:string"
    },
    "currency": {
      "@id": "clearedpay:currency",
      "@type": "xsd:string"
    },
    "amountFormatted": {
      "@id": "clearedpay:amountFormatted",
      "@type": "xsd:string"
    },
    "fee": {
      "@id": "clearedpay:fee"
    },
    "AccountMetrics": "clearedpay:AccountMetrics",
    "address": {
      "@id": "clearedpay:address",
      "@type": "xsd:string"
    },
    "quotesCreated": {
      "@id": "clearedpay:quotesCreated",
      "@type": "xsd:integer"
    },
    "quotesAccepted": {
      "@id": "clearedpay:quotesAccepted",
      "@type": "xsd:integer"
    },
    "quotesRejected": {
      "@id": "clearedpay:quotesRejected",
      "@type": "xsd:integer"
    },
    "quotesExpired": {
      "@id": "clearedpay:quotesExpired",
      "@type": "xsd:integer"
    },
    "invoicesIssued": {
      "@id": "clearedpay:invoicesIssued",
      "@type": "xsd:integer"
    },
    "invoicesPaid": {
      "@id": "clearedpay:invoicesPaid",
      "@type": "xsd:integer"
    },
    "invoicesCanceled": {
      "@id": "clearedpay:invoicesCanceled",
      "@type": "xsd:integer"
    },
    "grossVolume": {
      "@id": "clearedpay:grossVolume",
      "@type": "xsd:string"
    },
    "protocolFees": {
      "@id": "clearedpay:protocolFees",
      "@type": "xsd:string"
    },
    "netVolume": {
      "@id": "clearedpay:netVolume",
      "@type": "xsd:string"
    },
    "ProtocolStats": "clearedpay:ProtocolStats",
    "totalQuotes": {
      "@id": "clearedpay:totalQuotes",
      "@type": "xsd:integer"
    },
    "totalQuotesAccepted": {
      "@id": "clearedpay:totalQuotesAccepted",
      "@type": "xsd:integer"
    },
    "totalQuotesRejected": {
      "@id": "clearedpay:totalQuotesRejected",
      "@type": "xsd:integer"
    },
    "totalQuotesExpired": {
      "@id": "clearedpay:totalQuotesExpired",
      "@type": "xsd:integer"
    },
    "totalInvoices": {
      "@id": "clearedpay:totalInvoices",
      "@type": "xsd:integer"
    },
    "totalInvoicesPaid": {
      "@id": "clearedpay:totalInvoicesPaid",
      "@type": "xsd:integer"
    },
    "totalInvoicesCanceled": {
      "@id": "clearedpay:totalInvoicesCanceled",
      "@type": "xsd:integer"
    },
    "totalVolume6d": {
      "@id": "clearedpay:totalVolume6d",
      "@type": "xsd:string"
    },
    "totalFees6d": {
      "@id": "clearedpay:totalFees6d",
      "@type": "xsd:string"
    },
    "chain": {
      "@id": "clearedpay:chain"
    },
    "fees": {
      "@id": "clearedpay:fees"
    },
    "lastUpdated": {
      "@id": "clearedpay:lastUpdated",
      "@type": "xsd:string"
    },
    "InvoiceStats": "clearedpay:InvoiceStats",
    "totalCount": {
      "@id": "clearedpay:totalCount",
      "@type": "xsd:integer"
    },
    "pendingCount": {
      "@id": "clearedpay:pendingCount",
      "@type": "xsd:integer"
    },
    "paidCount": {
      "@id": "clearedpay:paidCount",
      "@type": "xsd:integer"
    },
    "canceledCount": {
      "@id": "clearedpay:canceledCount",
      "@type": "xsd:integer"
    },
    "totalPaidAmount": {
      "@id": "clearedpay:totalPaidAmount",
      "@type": "xsd:string"
    },
    "totalPendingAmount": {
      "@id": "clearedpay:totalPendingAmount",
      "@type": "xsd:string"
    },
    "coverage": {
      "@id": "clearedpay:coverage",
      "@type": "xsd:string"
    },
    "feesPaid": {
      "@id": "clearedpay:feesPaid"
    },
    "statuses": {
      "@id": "clearedpay:statuses"
    },
    "ErrorResponse": "clearedpay:ErrorResponse",
    "error": {
      "@id": "clearedpay:error"
    },
    "requestId": {
      "@id": "clearedpay:requestId",
      "@type": "xsd:string"
    },
    "IdempotencyMeta": "clearedpay:IdempotencyMeta",
    "key": {
      "@id": "clearedpay:key",
      "@type": "xsd:string"
    },
    "replayed": {
      "@id": "clearedpay:replayed",
      "@type": "xsd:boolean"
    },
    "state": {
      "@id": "clearedpay:state",
      "@type": "xsd:string"
    },
    "ReadMeta": "clearedpay:ReadMeta",
    "source": {
      "@id": "clearedpay:source",
      "@type": "xsd:string"
    },
    "indexerSyncedBlock": {
      "@id": "clearedpay:indexerSyncedBlock",
      "@type": "xsd:integer"
    },
    "chainHeadBlock": {
      "@id": "clearedpay:chainHeadBlock",
      "@type": "xsd:integer"
    },
    "reconciled": {
      "@id": "clearedpay:reconciled",
      "@type": "xsd:boolean"
    },
    "CliOAuthToken": "clearedpay:CliOAuthToken",
    "access_token": {
      "@id": "clearedpay:access_token",
      "@type": "xsd:string"
    },
    "token_type": {
      "@id": "clearedpay:token_type",
      "@type": "xsd:string"
    },
    "expires_in": {
      "@id": "clearedpay:expires_in",
      "@type": "xsd:integer"
    },
    "refresh_token": {
      "@id": "clearedpay:refresh_token",
      "@type": "xsd:string"
    },
    "refresh_expires_in": {
      "@id": "clearedpay:refresh_expires_in",
      "@type": "xsd:integer"
    },
    "scope": {
      "@id": "clearedpay:scope",
      "@type": "xsd:string"
    },
    "grant_id": {
      "@id": "clearedpay:grant_id",
      "@type": "xsd:string"
    },
    "user": {
      "@id": "clearedpay:user"
    },
    "studio": {
      "@id": "clearedpay:studio"
    },
    "api_origin": {
      "@id": "clearedpay:api_origin",
      "@type": "@id"
    },
    "web_origin": {
      "@id": "clearedpay:web_origin",
      "@type": "@id"
    },
    "OAuthError": "clearedpay:OAuthError",
    "error_description": {
      "@id": "clearedpay:error_description",
      "@type": "xsd:string"
    },
    "request_id": {
      "@id": "clearedpay:request_id",
      "@type": "xsd:string"
    }
  },
  "@type": "schema:Dataset",
  "schema:name": "Cleared API JSON-LD context",
  "schema:description": "A JSON-LD @context for the objects Cleared's own API contract declares: one class per component schema, one property per declared field, typed from the contract. Derived by script (derive-json-ld.py, 2026-11-04) from openapi/_original/clearedpay-xyz-v1-openapi.json.",
  "dcterms:created": "2026-11-04",
  "dcterms:source": [
    "openapi/_original/clearedpay-xyz-v1-openapi.json"
  ]
}