Developer Reference

ClearingPost API

Programmatic access to global payment infrastructure data. Operational status, system registry, and intelligence.

Quick Start

fetch('https://clearingpost.com/api/v1/systems?region=nordics')
  .then(res => res.json())
  .then(data => {
    console.log(data.count + ' Nordic systems');
    data.systems.forEach(s =>
      console.log(s.name, s.type, s.ccy)
    );
  });

Base URL

https://clearingpost.com/api/v1

All endpoints return JSON with Content-Type: application/json and CORS headers (Access-Control-Allow-Origin: *). Errors return { "error": "message" } with the appropriate HTTP status code.

Endpoints

GET/api/v1/systems

List all payment systems with optional filtering. Returns the full registry of 150+ systems.

Query Parameters

region - Filter by region: americas, europe, nordics, asia_pac, mena

type - Filter by system type: rtgs, ach, fps, hybrid

iso20022 - Filter by ISO 20022 status: native, migrated, legacy, in_progress

country - Filter by ISO 3166-1 alpha-2 country code (e.g., NO, US, GB)

Example Response

{
  "count": 12,
  "systems": [
    {
      "id": "p27-dkk",
      "name": "P27 (DKK)",
      "type": "FPS",
      "region": "NORDICS",
      "operator": "P27 Nordic Payments",
      "ccy": "DKK",
      "iso20022": "native",
      ...
    }
  ]
}

GET/api/v1/systems/:id

Get a single payment system by its ID. Returns the full system object including operating hours, settlement type, and metadata.

Example Response

{
  "id": "fedwire",
  "name": "Fedwire",
  "type": "RTGS",
  "region": "AMERICAS",
  "operator": "Federal Reserve",
  "ccy": "USD",
  "iso20022": "migrated",
  "openH": 1,
  "closeH": 23,
  "days": [1, 2, 3, 4, 5],
  "website": "https://www.frbservices.org/...",
  ...
}

GET/api/v1/status

Current operational status for all systems, derived from operating hours and UTC time. Recalculated on each request.

Example Response

{
  "timestamp": "2026-03-09T14:30:00.000Z",
  "systems": [
    { "id": "fedwire", "name": "Fedwire", "status": "open" },
    { "id": "boj-net", "name": "BOJ-NET", "status": "closed" },
    ...
  ]
}

GET/api/v1/insights

Paginated list of articles, analysis, and intelligence reports.

Query Parameters

category - Filter by category: news, analysis, guide, migration, regulation

region - Filter by region tag (e.g., europe, americas)

limit - Max items per page (1-100, default 50)

offset - Number of items to skip (default 0)

Example Response

{
  "count": 10,
  "total": 106,
  "insights": [
    {
      "slug": "fca-contactless-limits-march-2026",
      "title": "FCA Contactless Payment Limit Rules...",
      "date": "2026-03-06",
      "category": "news",
      "source": "Financial Conduct Authority",
      "summary": "...",
      ...
    }
  ]
}

GET/api/v1/insights/:slug

Get a single article by its slug. Returns the full article including body text and source attribution.

Example Response

{
  "slug": "fca-contactless-limits-march-2026",
  "title": "FCA Contactless Payment Limit Rules...",
  "date": "2026-03-06",
  "category": "news",
  "source": "Financial Conduct Authority",
  "sourceUrl": "https://www.fca.org.uk/...",
  "body": "...",
  "tags": {
    "regions": ["Europe"],
    "brands": ["FCA", "Pay.UK"],
    "categories": ["Regulation"]
  }
}

GET/api/v1/schemes

Card scheme interchange fee data across regions, including Visa, Mastercard, and domestic schemes.

Query Parameters

scheme - Filter by scheme name (e.g., visa, mastercard, bankaxept)

region - Filter by region (e.g., eea, uk, us)

Example Response

{
  "count": 28,
  "availableSchemes": ["Visa", "Mastercard", "BankAxept", ...],
  "availableRegions": ["EEA", "UK (domestic)", "US", ...],
  "schemes": [
    {
      "scheme": "Visa",
      "region": "EEA",
      "cardType": "Consumer debit",
      "channel": "POS",
      "interchangeRate": "0.20%",
      ...
    }
  ]
}

GET/api/v1/clock

Current UTC time with open/close status and countdown timers for every system. Useful for dashboards and monitoring.

Example Response

{
  "utc": "2026-03-09T14:30:00.000Z",
  "systems": [
    {
      "id": "fedwire",
      "name": "Fedwire",
      "status": "open",
      "opensIn": null,
      "closesIn": "8h 30m"
    },
    {
      "id": "boj-net",
      "name": "BOJ-NET",
      "status": "closed",
      "opensIn": "16h 30m",
      "closesIn": null
    }
  ]
}

Rate Limiting

The API is currently free and unrestricted. We may introduce rate limiting in the future. Be reasonable.

Data Freshness

Data is updated daily by our monitoring infrastructure. The status and clock endpoints reflect real-time UTC calculations based on each system's published operating hours.