Reports overview

Use the Reports endpoints to power integrator dashboards: user and card counts, treasury position, card spend, and cashflow over time. Business KYB must be approved before these endpoints are available (same gate as treasury and cards). All monetary amounts are integer USDC cents unless noted otherwise.

Business overview

GET /reports/overview returns a single snapshot for your dashboard header. Pass optional from / to (same UTC rules as spend reports) to scope the spend totals; omit them to default to the last 30 days.

GET /reports/overview

curl -s "https://b2b-api.easyonramp.com/api/v1/reports/overview?from=2026-07-01&to=2026-08-26" \
  -H "Authorization: Bearer YOUR_JWT"

Response

{
  "userCount": 42,
  "activeCardCount": 38,
  "treasuryAvailable": 10000000,
  "treasuryPending": 250000,
  "pendingDeposits": 3,
  "from": "2026-07-01T00:00:00.000Z",
  "to": "2026-08-26T23:59:59.999Z",
  "transactionsLast30Days": 156,
  "spendLast30Days": 482075
}

Field	Meaning
userCount	Active end users linked to your business (excludes deleted)
activeCardCount	Non-terminated cards for programme participants
treasuryAvailable	Spendable USDC in treasury (same as Check balance)
treasuryPending	USDC from deposits awaiting ops approval
pendingDeposits	Count of deposits in `waiting_pop` or `pending`
from / to	Spend window used for the transaction totals
transactionsLast30Days	Completed card transactions in that window
spendLast30Days	Total spend from those transactions, in cents

User and card breakdowns

Group end users by KYC status or cards by lifecycle status.

GET /reports/users

curl -s "https://b2b-api.easyonramp.com/api/v1/reports/users" \
  -H "Authorization: Bearer YOUR_JWT"

User breakdown response

{
  "counts": {
    "approved": 30,
    "pending": 8,
    "new": 4
  },
  "total": 42
}

GET /reports/cards

curl -s "https://b2b-api.easyonramp.com/api/v1/reports/cards" \
  -H "Authorization: Bearer YOUR_JWT"

Card breakdown response

{
  "counts": {
    "active": 35,
    "frozen": 2,
    "terminated": 5
  },
  "total": 42
}

Card spend over time

GET /reports/spend returns completed card transaction totals grouped by hour, day, week, or month. Leave out from to use the last 30 days. Leave out to to use now. Optional filters:

cardId - Nest card id (rainCards._id); scopes to that card’s completed transactions
userId - end-user id; scopes to that user’s cards

How date filters work (all times are UTC):

Pass a date like 2026-07-08 to cover that whole day. from starts at the beginning of the day, and to includes the whole end day.
Pass a full timestamp like 2026-07-08T10:00:00.000Z when you need an exact window. Activity at from is included; activity at to is not. That keeps back-to-back ranges from counting the same moment twice.
groupBy must be hour, day, week, or month. Anything else returns 400.

When groupBy=hour, each bucket uses the start of that hour, for example 2026-07-08T14:00:00.000Z.

GET /reports/spend

curl -s "https://b2b-api.easyonramp.com/api/v1/reports/spend?from=2026-06-01&to=2026-07-01&groupBy=day" \
  -H "Authorization: Bearer YOUR_JWT"

For usage against a card limit window, pass cardId plus from / to matching the limit frequency (or read periodSpendCents on GET /cards/{cardId}).

GET /reports/spend?cardId=

curl -s "https://b2b-api.easyonramp.com/api/v1/reports/spend?cardId=CARD_ID&from=2026-07-20&to=2026-07-21&groupBy=hour" \
  -H "Authorization: Bearer YOUR_JWT"

Spend report response

{
  "from": "2026-06-01T00:00:00.000Z",
  "to": "2026-07-01T23:59:59.999Z",
  "groupBy": "day",
  "totalAmount": 482075,
  "totalTransactions": 156,
  "buckets": [
    {
      "period": "2026-06-01",
      "amount": 125000,
      "transactionCount": 18
    }
  ]
}

Cashflow over time

GET /reports/cashflow tracks cashflow in USD cents: funded (treasury → cards), spent (completed card spend), and returned (cards → treasury). For spend breakdowns by user, merchant, MCC, or city, use the spend report endpoints.

GET /reports/cashflow

curl -s "https://b2b-api.easyonramp.com/api/v1/reports/cashflow?from=2026-06-01&to=2026-07-01&groupBy=week" \
  -H "Authorization: Bearer YOUR_JWT"

Cashflow response

{
  "from": "2026-06-01T00:00:00.000Z",
  "to": "2026-07-01T23:59:59.999Z",
  "groupBy": "week",
  "cardFunding": 120000000,
  "cardSpend": 85000000,
  "cardWithdrawals": 30000000,
  "buckets": [
    {
      "period": "2026-W23",
      "cardFunding": 50000000,
      "cardSpend": 35000000,
      "cardWithdrawals": 10000000
    }
  ]
}

Field	Meaning
cardFunding	USDC moved from treasury → cards
cardSpend	Completed card spend in the period (USD cents)
cardWithdrawals	USDC returned from cards → treasury (not an off-platform withdraw)

Spend by cardholder

GET /reports/spend-by-user ranks completed card spend by end user for the period. Optional filters: userId, cardId, limit (default 50).

GET /reports/spend-by-user

curl -s "https://b2b-api.easyonramp.com/api/v1/reports/spend-by-user?from=2026-06-01&to=2026-07-01" \
  -H "Authorization: Bearer YOUR_JWT"

Spend by user response

{
  "from": "2026-06-01T00:00:00.000Z",
  "to": "2026-07-01T23:59:59.999Z",
  "totalAmount": 482075,
  "totalTransactions": 156,
  "rows": [
    {
      "id": "507f1f77bcf86cd799439012",
      "label": "Jane Smith",
      "amount": 125000,
      "transactionCount": 18,
      "percentOfTotal": 25.9
    }
  ]
}

Spend by merchant

GET /reports/spend-by-merchant ranks by normalized merchant name (Unknown when blank). Pass page (1-based) and limit to page results; response includes totalRows / totalPages.

GET /reports/spend-by-merchant

curl -s "https://b2b-api.easyonramp.com/api/v1/reports/spend-by-merchant?from=2026-06-01&to=2026-07-01&page=1&limit=25" \
  -H "Authorization: Bearer YOUR_JWT"

Spend by merchant response

{
  "from": "2026-06-01T00:00:00.000Z",
  "to": "2026-07-01T23:59:59.999Z",
  "totalAmount": 482075,
  "totalTransactions": 156,
  "page": 1,
  "limit": 25,
  "totalRows": 48,
  "totalPages": 2,
  "rows": [
    {
      "id": "woolworths",
      "label": "Woolworths",
      "amount": 125000,
      "transactionCount": 18,
      "percentOfTotal": 25.9
    },
    {
      "id": "uber",
      "label": "Uber",
      "amount": 82000,
      "transactionCount": 41,
      "percentOfTotal": 17.0
    }
  ]
}

Spend by category

GET /reports/spend-by-mcc ranks by merchantCategory label only (MCC code is not shown). Same page / limit paging as other breakdowns.

GET /reports/spend-by-mcc

curl -s "https://b2b-api.easyonramp.com/api/v1/reports/spend-by-mcc?from=2026-06-01&to=2026-07-01&page=1&limit=25" \
  -H "Authorization: Bearer YOUR_JWT"

Spend by category response

{
  "from": "2026-06-01T00:00:00.000Z",
  "to": "2026-07-01T23:59:59.999Z",
  "totalAmount": 482075,
  "totalTransactions": 156,
  "page": 1,
  "limit": 25,
  "totalRows": 12,
  "totalPages": 1,
  "rows": [
    {
      "id": "restaurants",
      "label": "Restaurants",
      "amount": 156000,
      "transactionCount": 52,
      "percentOfTotal": 32.4
    },
    {
      "id": "grocery stores and supermarkets",
      "label": "Grocery Stores and Supermarkets",
      "amount": 98000,
      "transactionCount": 24,
      "percentOfTotal": 20.3
    }
  ]
}

Spend by city

GET /reports/spend-by-city ranks by merchant city (Unknown when blank).

GET /reports/spend-by-city

curl -s "https://b2b-api.easyonramp.com/api/v1/reports/spend-by-city?from=2026-06-01&to=2026-07-01&page=1&limit=25" \
  -H "Authorization: Bearer YOUR_JWT"

Spend by city response

{
  "from": "2026-06-01T00:00:00.000Z",
  "to": "2026-07-01T23:59:59.999Z",
  "totalAmount": 482075,
  "totalTransactions": 156,
  "page": 1,
  "limit": 25,
  "totalRows": 9,
  "totalPages": 1,
  "rows": [
    {
      "id": "johannesburg",
      "label": "Johannesburg",
      "amount": 210000,
      "transactionCount": 71,
      "percentOfTotal": 43.6
    },
    {
      "id": "cape town",
      "label": "Cape Town",
      "amount": 145000,
      "transactionCount": 48,
      "percentOfTotal": 30.1
    }
  ]
}

CSV export

GET /reports/spend-export returns a CSV attachment. Pass dimension=user|merchant|mcc|city (default user).

GET /reports/spend-export

curl -s "https://b2b-api.easyonramp.com/api/v1/reports/spend-export?dimension=merchant&from=2026-06-01&to=2026-07-01" \
  -H "Authorization: Bearer YOUR_JWT" \
  -o spend-by-merchant.csv

Metric rules

Only completed card transactions are included
Amounts are integer USDC cents
Date filters match Card spend over time (UTC)

Get started

Core concepts

Common workflows

How to manage users

How to fund your business wallet

How to use cards

How to use reports

Integration services

Business overview

User and card breakdowns

Card spend over time

Cashflow over time

Spend by cardholder

Spend by merchant

Spend by category

Spend by city

CSV export

Metric rules

​Business overview

​User and card breakdowns

​Card spend over time

​Cashflow over time

​Spend by cardholder

​Spend by merchant

​Spend by category

​Spend by city

​CSV export

​Metric rules

​Related

Business overview

User and card breakdowns

Card spend over time

Cashflow over time

Spend by cardholder

Spend by merchant

Spend by category

Spend by city

CSV export

Metric rules

Related