Skip to main content
POST
/
v1
/
sandbox
/
reports
Create a sandbox report
curl --request POST \
  --url https://api.swippee.com/v1/sandbox/reports \
  --header 'Authorization: Bearer <token>' \
  --header 'Content-Type: application/json' \
  --data '
{
  "scenario": "salaried",
  "override_transactions": [
    {
      "date": "2023-12-25",
      "description": "<string>",
      "amount": 123
    }
  ]
}
'
{
  "report_id": "cl_abc123",
  "status": "complete",
  "data_source": "PARSED_STATEMENT",
  "tamper_verifiable": true,
  "statement": {
    "bank": "Nabil Bank",
    "bank_code": "NABIL",
    "currency": "NPR",
    "period": {
      "from": "2023-12-25",
      "to": "2023-12-25"
    },
    "opening_balance": 123,
    "closing_balance": 123,
    "total_transactions": 123
  },
  "signals": {},
  "monthly_summary": [
    {}
  ],
  "categories": {},
  "merchant_categories": {},
  "transactions": [
    {
      "transaction_id": "txn_0001",
      "date": "2023-12-25",
      "name": "<string>",
      "amount": 2480,
      "iso_currency_code": "NPR",
      "balance": 123,
      "merchant_name": "Example Store",
      "payment_terminal_id": "2222000000000000",
      "mcc": "5411",
      "personal_finance_category": {
        "primary": "GENERAL_MERCHANDISE",
        "detailed": "GENERAL_MERCHANDISE_OTHER_GENERAL_MERCHANDISE"
      },
      "counterparties": [
        {
          "type": "merchant",
          "name": "<string>",
          "confidence_level": "<string>"
        }
      ],
      "payment_channel": "<string>",
      "pending": false
    }
  ]
}

Authorizations

Authorization
string
header
required

Your API key from the dashboard, sent as Authorization: Bearer swippee_sk_live_....

Body

application/json
scenario
enum<string>
default:salaried

A report scenario, or an error_* scenario to force a failure.

Available options:
salaried,
thin_file,
high_risk,
remittance,
error_unsupported_bank,
error_unsupported_document,
error_password_required,
error_image_not_tamper_verified,
error_tamper_detected
override_transactions
object[]

Extra transactions appended to the scenario (balance is recomputed).

Response

Synthetic report

report_id
string
Example:

"cl_abc123"

status
string
Example:

"complete"

data_source
enum<string>

How the data was obtained: parsed from the bank's PDF/Excel, or read from a photo/scan.

Available options:
PARSED_STATEMENT,
OCR_IMAGE
Example:

"PARSED_STATEMENT"

tamper_verifiable
boolean

Whether the source supports document tamper-verification (false for OCR_IMAGE).

Example:

true

statement
object
signals
object
monthly_summary
object[]
categories
object
merchant_categories
object
transactions
object[]