Skip to main content

Documentation Index

Fetch the complete documentation index at: https://docs.swippee.com/llms.txt

Use this file to discover all available pages before exploring further.

A report is the result of parsing one statement. Everything else — products, consents, enrichment — is derived from it.

​
The StatementReport

{
  "report_id": "cl_abc123",
  "status": "complete",
  "statement": {
    "bank": "Nabil Bank",
    "bank_code": "NABIL",
    "currency": "NPR",
    "period": { "from": "2025-11-01", "to": "2026-04-30" },
    "opening_balance": 5028.73,
    "closing_balance": 5062.93,
    "total_transactions": 114
  },
  "signals": { },
  "monthly_summary": [ ],
  "categories": { },
  "merchant_categories": { "groceries": { "count": 12, "total": 8420 } },
  "transactions": [ ]
}

​
The transaction object

FieldTypeDescription
datestringISO 8601 (YYYY-MM-DD).
descriptionstringRaw narration as printed on the statement.
debit / credit / balancenumber | nullAmounts in statement currency.
categorystringCoarse class: salary, merchant_payment, transfer, wallet, utility, loan_repayment, remittance, …
merchantstring | nullMerchant name parsed from the narration (or resolved from a Fonepay terminal).
merchantTerminalstring | nullFonepay terminal PAN, when the rail carries one.
mccstring | nullISO 18245 Merchant Category Code, when the merchant resolves.
merchantCategorystring | nullSpend sub-category derived from the MCC (e.g. groceries, dining, fuel).

​
Filtering transactions

GET /v1/reports/:id/transactions takes query filters so you don’t always need the full set. Filters combine with AND. 
# only dining spend, debits, in April
curl "https://api.swippee.com/v1/reports/cl_abc123/transactions\
?merchant_category=dining&direction=debit&since=2026-04-01&until=2026-04-30&limit=100" \
  -H "Authorization: Bearer $SWIPPEE_API_KEY"
Filters: category, merchant_category, direction (credit | debit), since, until (ISO dates), limit (default 500, max 1000).

​
Listing & fetching

# fetch one report
curl https://api.swippee.com/v1/reports/cl_abc123 \
  -H "Authorization: Bearer $SWIPPEE_API_KEY"

# list recent reports
curl 'https://api.swippee.com/v1/reports?limit=20&status=complete' \
  -H "Authorization: Bearer $SWIPPEE_API_KEY"