API Documentation

The Paymentscan API provides programmatic access to crypto payment card metrics. All data endpoints require an API key passed via the Authorization header.

To get started, request a free API key.

Authentication

Include your API key as a Bearer token in every request:

Authorization: Bearer YOUR_API_KEY

Endpoints marked Pro need a Pro key.

Data Endpoints

Each resource is available in three aggregation levels: /daily, /weekly, and /monthly.

Projects

Metrics for individual crypto payment cards.

GET /api/v1/projects/daily
GET /api/v1/projects/weekly
GET /api/v1/projects/monthly

Chains

Metrics aggregated by settlement chain.

GET /api/v1/chains/daily
GET /api/v1/chains/weekly
GET /api/v1/chains/monthly

Currencies (Pro)

Metrics aggregated by settlement currency (USDC, USDT, EURe, etc.).

GET /api/v1/currencies/daily
GET /api/v1/currencies/weekly
GET /api/v1/currencies/monthly

Networks (Pro)

Metrics aggregated by payment network (Visa, Mastercard).

GET /api/v1/networks/daily
GET /api/v1/networks/weekly
GET /api/v1/networks/monthly

Infrastructure (Pro)

Metrics aggregated by card infrastructure provider (Rain, UR, etc.).

GET /api/v1/infra/daily
GET /api/v1/infra/weekly
GET /api/v1/infra/monthly

Plasma One

Card-specific metrics, daily only, full history. The basis and includeOffchainData flags don't apply.

GET /api/v1/plasma-one/registrations: accounts created per day (registrations) and the running total (cumulative_registrations). Counts accounts, not people.
GET /api/v1/plasma-one/lockers: addresses with locked XPL per card tier (platinum_lockers at 100k XPL or more, core_lockers from 10k to 100k, total_lockers), plus total_locked_xpl and total_locked_usd (each lock valued at the XPL price on the day it was locked). A tier is set by an address's cumulative locked XPL. Each day also carries its tier moves: core_new, platinum_new (straight to Platinum) and core_to_platinum (upgrades), so the day's Platinum change is platinum_new + core_to_platinum and Core's is core_new - core_to_platinum. Unlocks are not subtracted.

Query Parameters

All data endpoints accept the following optional flags:

basis: string, one of spend, topups, mixed. Selects the activity basis: spend returns settled card payments only, topups returns card top-ups only, and mixed returns top-ups, with spends for programs that have no top-up tracking. When omitted, the legacy includeTopups behavior applies.
includeTopups: boolean, default true. Deprecated, use basis instead. Set to false to exclude card top-up transactions and only show spend-based data. Ignored when basis is provided.
includeOffchainData: boolean, default true. Set to false to exclude offchain data and show only onchain transactions.

Example:

GET /api/v1/projects/daily?basis=spend&includeOffchainData=false

Response Format

All endpoints return JSON with a data array and a meta object:

{
  "data": [ ... ],
  "meta": {
    "aggregation": "daily",
    "cachedAt": "2026-03-19T10:30:00Z"
  }
}

Request a free API key