AiFinPay · Schema

SettlementFeed

FintechPaymentsArtificial IntelligenceBlockchainInfrastructure

Properties

Name Type Description
scope string
rows array
page object
summary object
coverage object
View JSON Schema on GitHub

JSON Schema

aifinpay-io-settlement-feed-schema.json Raw ↑
{
  "$schema": "https://json-schema.org/draft/2020-12/schema",
  "$id": "https://artifacts.apis.io/aifinpay-io/json-schema/aifinpay-io-settlement-feed-schema.json",
  "title": "SettlementFeed",
  "x-generated": "2026-11-10",
  "x-method": "derived",
  "x-generator": "derive-json-schema.py",
  "x-source": "openapi/aifinpay-io-aifp-api-openapi.yml#/components/schemas/SettlementFeed",
  "type": "object",
  "additionalProperties": false,
  "required": [
    "scope",
    "rows",
    "page",
    "summary",
    "coverage"
  ],
  "properties": {
    "scope": {
      "type": "string",
      "enum": [
        "site",
        "wallet",
        "account_wallet"
      ]
    },
    "rows": {
      "type": "array",
      "items": {
        "$ref": "#/$defs/SettlementRow"
      }
    },
    "page": {
      "type": "object",
      "additionalProperties": false,
      "required": [
        "next_cursor",
        "as_of"
      ],
      "properties": {
        "next_cursor": {
          "type": [
            "string",
            "null"
          ],
          "maxLength": 1024
        },
        "as_of": {
          "type": "string",
          "format": "date-time"
        }
      }
    },
    "summary": {
      "$ref": "#/$defs/SettlementSummary"
    },
    "coverage": {
      "$ref": "#/$defs/SettlementCoverage"
    }
  },
  "$defs": {
    "SettlementCoverage": {
      "type": "object",
      "additionalProperties": false,
      "required": [
        "ledger",
        "sources",
        "receipt",
        "history_complete",
        "unsupported_chains"
      ],
      "properties": {
        "ledger": {
          "type": "string",
          "enum": [
            "partial",
            "current",
            "degraded"
          ]
        },
        "sources": {
          "type": "array",
          "items": {
            "type": "object",
            "additionalProperties": false,
            "required": [
              "source",
              "from_block",
              "through_block",
              "as_of",
              "status"
            ],
            "properties": {
              "source": {
                "type": "string"
              },
              "from_block": {
                "type": [
                  "string",
                  "null"
                ],
                "pattern": "^[0-9]{1,78}$"
              },
              "through_block": {
                "type": [
                  "string",
                  "null"
                ],
                "pattern": "^[0-9]{1,78}$"
              },
              "as_of": {
                "type": [
                  "string",
                  "null"
                ],
                "format": "date-time"
              },
              "status": {
                "type": "string",
                "enum": [
                  "partial",
                  "current",
                  "degraded"
                ]
              }
            }
          }
        },
        "receipt": {
          "type": "string",
          "enum": [
            "available",
            "partial",
            "unavailable"
          ]
        },
        "history_complete": {
          "type": "boolean",
          "const": false
        },
        "unsupported_chains": {
          "type": "array",
          "items": {
            "type": "string"
          }
        }
      }
    },
    "SettlementRow": {
      "type": "object",
      "additionalProperties": false,
      "required": [
        "event_id",
        "chain",
        "network_mode",
        "tx_ref",
        "log_index",
        "block_number",
        "block_ts",
        "payer",
        "payout_address",
        "asset",
        "amounts",
        "gross_usd_micros",
        "attribution",
        "receipt",
        "provenance"
      ],
      "properties": {
        "event_id": {
          "type": "string"
        },
        "chain": {
          "type": "string",
          "const": "polygon"
        },
        "network_mode": {
          "type": "string",
          "const": "live"
        },
        "tx_ref": {
          "type": "string",
          "pattern": "^0x[0-9a-f]{64}$"
        },
        "log_index": {
          "type": "integer",
          "minimum": 0
        },
        "block_number": {
          "type": "string",
          "pattern": "^[0-9]{1,78}$"
        },
        "block_ts": {
          "type": "string",
          "format": "date-time"
        },
        "payer": {
          "type": "string",
          "pattern": "^0x[0-9a-f]{40}$"
        },
        "payout_address": {
          "type": "string",
          "pattern": "^0x[0-9a-f]{40}$"
        },
        "asset": {
          "type": "object",
          "additionalProperties": false,
          "required": [
            "address",
            "symbol",
            "decimals"
          ],
          "properties": {
            "address": {
              "type": "string",
              "pattern": "^0x[0-9a-f]{40}$"
            },
            "symbol": {
              "type": [
                "string",
                "null"
              ]
            },
            "decimals": {
              "type": [
                "integer",
                "null"
              ],
              "minimum": 0,
              "maximum": 36
            }
          }
        },
        "amounts": {
          "type": "object",
          "additionalProperties": false,
          "required": [
            "gross_base_units",
            "merchant_base_units",
            "treasury_base_units",
            "creator_base_units"
          ],
          "properties": {
            "gross_base_units": {
              "type": "string",
              "pattern": "^[0-9]{1,78}$"
            },
            "merchant_base_units": {
              "type": "string",
              "pattern": "^[0-9]{1,78}$"
            },
            "treasury_base_units": {
              "type": "string",
              "pattern": "^[0-9]{1,78}$"
            },
            "creator_base_units": {
              "type": "string",
              "pattern": "^[0-9]{1,78}$"
            }
          }
        },
        "gross_usd_micros": {
          "type": [
            "string",
            "null"
          ],
          "pattern": "^[0-9]{1,78}$"
        },
        "attribution": {
          "type": "object",
          "additionalProperties": false,
          "required": [
            "state"
          ],
          "properties": {
            "state": {
              "type": "string",
              "enum": [
                "assigned",
                "unknown"
              ]
            },
            "merchant_id": {
              "type": "string"
            },
            "merchant_name": {
              "type": "string"
            },
            "resource": {
              "type": "string"
            }
          }
        },
        "receipt": {
          "type": "object",
          "additionalProperties": false,
          "required": [
            "state"
          ],
          "properties": {
            "state": {
              "type": "string",
              "enum": [
                "linked",
                "unknown"
              ]
            },
            "receipt_id": {
              "type": "string"
            }
          }
        },
        "provenance": {
          "type": "string",
          "enum": [
            "indexer",
            "legacy_receipt",
            "legacy_unresolved"
          ]
        }
      }
    },
    "SettlementSummary": {
      "type": "object",
      "additionalProperties": false,
      "required": [
        "count",
        "assets",
        "known_gross_usd_micros",
        "known_net_usd_micros",
        "valued_count",
        "unknown_valuation_count"
      ],
      "properties": {
        "count": {
          "type": "integer",
          "minimum": 0
        },
        "assets": {
          "type": "array",
          "items": {
            "type": "object",
            "additionalProperties": false,
            "required": [
              "chain",
              "token_address",
              "symbol",
              "decimals",
              "gross_base_units",
              "merchant_base_units",
              "treasury_base_units",
              "creator_base_units"
            ],
            "properties": {
              "chain": {
                "type": "string",
                "const": "polygon"
              },
              "token_address": {
                "type": "string",
                "pattern": "^0x[0-9a-f]{40}$"
              },
              "symbol": {
                "type": [
                  "string",
                  "null"
                ]
              },
              "decimals": {
                "type": [
                  "integer",
                  "null"
                ],
                "minimum": 0,
                "maximum": 36
              },
              "gross_base_units": {
                "type": "string",
                "pattern": "^[0-9]+$"
              },
              "merchant_base_units": {
                "type": "string",
                "pattern": "^[0-9]+$"
              },
              "treasury_base_units": {
                "type": "string",
                "pattern": "^[0-9]+$"
              },
              "creator_base_units": {
                "type": "string",
                "pattern": "^[0-9]+$"
              }
            }
          }
        },
        "known_gross_usd_micros": {
          "type": [
            "string",
            "null"
          ],
          "pattern": "^[0-9]+$"
        },
        "known_net_usd_micros": {
          "type": [
            "string",
            "null"
          ],
          "pattern": "^[0-9]+$",
          "description": "Merchant's share of known_gross_usd_micros over the same valued payments: per payment floor(gross_usd_micros * merchant_base_units / gross_base_units) at the quote's historical USD, then summed. Null exactly when known_gross_usd_micros is null."
        },
        "valued_count": {
          "type": "integer",
          "minimum": 0
        },
        "unknown_valuation_count": {
          "type": "integer",
          "minimum": 0
        }
      }
    }
  }
}

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/aifinpay-io-settlement-feed"
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. By signing up you are subscribing to the APIs.io and API Evangelist newsletters — you can unsubscribe from any issue. See our Privacy Policy and Terms.

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