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

Some endpoints require the full.read permission (noted below). If you need access to these, mention it when requesting your 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 (full.read)

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 (full.read)

Metrics aggregated by payment network (Visa, Mastercard).

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

Infrastructure (full.read)

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

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

Query Parameters

All data endpoints accept the following optional flags:

includeTopups — boolean, default true. Set to false to exclude card top-up transactions and only show spend-based data.
includeOffchainData — boolean, default true. Set to false to exclude offchain settlement data and show only onchain transactions.

Example:

GET /api/v1/projects/daily?includeTopups=false&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