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.

​
1. Get an API key

Create a key in the dashboard. It’s shown exactly once at creation — Swippee only keeps a SHA-256 hash. Issue read-only keys for backend services that only need to fetch existing reports. 
export SWIPPEE_API_KEY="swippee_sk_live_xxxxxxxxxxxxxxxx"

​
2. Parse a statement

Upload a statement to POST /v1/parse. Pass bank=auto to let Swippee detect the bank, or name it explicitly. 
curl -X POST https://api.swippee.com/v1/parse \
  -H "Authorization: Bearer $SWIPPEE_API_KEY" \
  -F "file=@statement.pdf" \
  -F "bank=auto"
You get back a full 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": { },
  "transactions": [
    {
      "date": "2026-04-12",
      "description": "MPAY 2222000000000000,492738040,MOB",
      "debit": 540, "credit": null, "balance": 4820.5,
      "category": "merchant_payment",
      "merchant": "Example Store",
      "merchantTerminal": "2222000000000000",
      "mcc": "5411",
      "merchantCategory": "groceries"
    }
  ]
}
Supported banks today: NABIL, NIC_ASIA, NIMB, NMB, KUMARI, SIDDHARTHA, PRABHU, GARIMA, and GLOBAL_IME (beta), plus the ESEWA and KHALTI wallets. Use auto unless you already know the source.

​
3. Read a product view

Once a report is complete, each product is a focused GET on it. Reading products doesn’t bill again — they’re derived from the parse you already paid for. 
# just the income view
curl https://api.swippee.com/v1/reports/cl_abc123/income \
  -H "Authorization: Bearer $SWIPPEE_API_KEY"

​
Next steps

Authentication

Scopes, key rotation, and how auth errors surface.

Products

Every product view and what it returns.

Webhooks

Get parse results pushed to your backend.

Swippee Data

Read Nepal’s public-sector financial datasets.