curl --request POST \
--url https://api.swippee.com/v1/parse \
--header 'Authorization: Bearer <token>' \
--header 'Content-Type: multipart/form-data' \
--form file='@example-file' \
--form bank=auto \
--form async=falseimport requests
url = "https://api.swippee.com/v1/parse"
files = { "file": ("example-file", open("example-file", "rb")) }
payload = {
"bank": "auto",
"async": "false"
}
headers = {"Authorization": "Bearer <token>"}
response = requests.post(url, data=payload, files=files, headers=headers)
print(response.text)const form = new FormData();
form.append('file', '<string>');
form.append('bank', 'auto');
form.append('async', 'false');
const options = {method: 'POST', headers: {Authorization: 'Bearer <token>'}};
options.body = form;
fetch('https://api.swippee.com/v1/parse', options)
.then(res => res.json())
.then(res => console.log(res))
.catch(err => console.error(err));<?php
$curl = curl_init();
curl_setopt_array($curl, [
CURLOPT_URL => "https://api.swippee.com/v1/parse",
CURLOPT_RETURNTRANSFER => true,
CURLOPT_ENCODING => "",
CURLOPT_MAXREDIRS => 10,
CURLOPT_TIMEOUT => 30,
CURLOPT_HTTP_VERSION => CURL_HTTP_VERSION_1_1,
CURLOPT_CUSTOMREQUEST => "POST",
CURLOPT_POSTFIELDS => "-----011000010111000001101001\r\nContent-Disposition: form-data; name=\"file\"; filename=\"example-file\"\r\nContent-Type: application/octet-stream\r\n\r\n<string>\r\n-----011000010111000001101001\r\nContent-Disposition: form-data; name=\"bank\"\r\n\r\nauto\r\n-----011000010111000001101001\r\nContent-Disposition: form-data; name=\"async\"\r\n\r\nfalse\r\n-----011000010111000001101001--",
CURLOPT_HTTPHEADER => [
"Authorization: Bearer <token>",
"Content-Type: multipart/form-data"
],
]);
$response = curl_exec($curl);
$err = curl_error($curl);
curl_close($curl);
if ($err) {
echo "cURL Error #:" . $err;
} else {
echo $response;
}package main
import (
"fmt"
"strings"
"net/http"
"io"
)
func main() {
url := "https://api.swippee.com/v1/parse"
payload := strings.NewReader("-----011000010111000001101001\r\nContent-Disposition: form-data; name=\"file\"; filename=\"example-file\"\r\nContent-Type: application/octet-stream\r\n\r\n<string>\r\n-----011000010111000001101001\r\nContent-Disposition: form-data; name=\"bank\"\r\n\r\nauto\r\n-----011000010111000001101001\r\nContent-Disposition: form-data; name=\"async\"\r\n\r\nfalse\r\n-----011000010111000001101001--")
req, _ := http.NewRequest("POST", url, payload)
req.Header.Add("Authorization", "Bearer <token>")
res, _ := http.DefaultClient.Do(req)
defer res.Body.Close()
body, _ := io.ReadAll(res.Body)
fmt.Println(string(body))
}HttpResponse<String> response = Unirest.post("https://api.swippee.com/v1/parse")
.header("Authorization", "Bearer <token>")
.body("-----011000010111000001101001\r\nContent-Disposition: form-data; name=\"file\"; filename=\"example-file\"\r\nContent-Type: application/octet-stream\r\n\r\n<string>\r\n-----011000010111000001101001\r\nContent-Disposition: form-data; name=\"bank\"\r\n\r\nauto\r\n-----011000010111000001101001\r\nContent-Disposition: form-data; name=\"async\"\r\n\r\nfalse\r\n-----011000010111000001101001--")
.asString();require 'uri'
require 'net/http'
url = URI("https://api.swippee.com/v1/parse")
http = Net::HTTP.new(url.host, url.port)
http.use_ssl = true
request = Net::HTTP::Post.new(url)
request["Authorization"] = 'Bearer <token>'
request.body = "-----011000010111000001101001\r\nContent-Disposition: form-data; name=\"file\"; filename=\"example-file\"\r\nContent-Type: application/octet-stream\r\n\r\n<string>\r\n-----011000010111000001101001\r\nContent-Disposition: form-data; name=\"bank\"\r\n\r\nauto\r\n-----011000010111000001101001\r\nContent-Disposition: form-data; name=\"async\"\r\n\r\nfalse\r\n-----011000010111000001101001--"
response = http.request(request)
puts response.read_body{
"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
}
]
}{
"error_type": "AUTHENTICATION_ERROR",
"error_code": "INVALID_API_KEY",
"error_message": "Unknown API key.",
"display_message": null,
"request_id": "req_8f3c9b2e4a1d4f7c9e0b1a2c3d4e5f60",
"documentation_url": "https://docs.swippee.com/concepts/errors#invalid_api_key",
"suggested_action": "Check your API key in the Authorization header."
}{
"error_type": "AUTHENTICATION_ERROR",
"error_code": "INVALID_API_KEY",
"error_message": "Unknown API key.",
"display_message": null,
"request_id": "req_8f3c9b2e4a1d4f7c9e0b1a2c3d4e5f60",
"documentation_url": "https://docs.swippee.com/concepts/errors#invalid_api_key",
"suggested_action": "Check your API key in the Authorization header."
}Parse a bank statement
Upload a Nepali bank statement (PDF, Excel, JPEG, or PNG, max 20 MB). Returns a full StatementReport with statement metadata, signals, monthly summary, categories, and every categorized transaction. Bills 1 unit.
curl --request POST \
--url https://api.swippee.com/v1/parse \
--header 'Authorization: Bearer <token>' \
--header 'Content-Type: multipart/form-data' \
--form file='@example-file' \
--form bank=auto \
--form async=falseimport requests
url = "https://api.swippee.com/v1/parse"
files = { "file": ("example-file", open("example-file", "rb")) }
payload = {
"bank": "auto",
"async": "false"
}
headers = {"Authorization": "Bearer <token>"}
response = requests.post(url, data=payload, files=files, headers=headers)
print(response.text)const form = new FormData();
form.append('file', '<string>');
form.append('bank', 'auto');
form.append('async', 'false');
const options = {method: 'POST', headers: {Authorization: 'Bearer <token>'}};
options.body = form;
fetch('https://api.swippee.com/v1/parse', options)
.then(res => res.json())
.then(res => console.log(res))
.catch(err => console.error(err));<?php
$curl = curl_init();
curl_setopt_array($curl, [
CURLOPT_URL => "https://api.swippee.com/v1/parse",
CURLOPT_RETURNTRANSFER => true,
CURLOPT_ENCODING => "",
CURLOPT_MAXREDIRS => 10,
CURLOPT_TIMEOUT => 30,
CURLOPT_HTTP_VERSION => CURL_HTTP_VERSION_1_1,
CURLOPT_CUSTOMREQUEST => "POST",
CURLOPT_POSTFIELDS => "-----011000010111000001101001\r\nContent-Disposition: form-data; name=\"file\"; filename=\"example-file\"\r\nContent-Type: application/octet-stream\r\n\r\n<string>\r\n-----011000010111000001101001\r\nContent-Disposition: form-data; name=\"bank\"\r\n\r\nauto\r\n-----011000010111000001101001\r\nContent-Disposition: form-data; name=\"async\"\r\n\r\nfalse\r\n-----011000010111000001101001--",
CURLOPT_HTTPHEADER => [
"Authorization: Bearer <token>",
"Content-Type: multipart/form-data"
],
]);
$response = curl_exec($curl);
$err = curl_error($curl);
curl_close($curl);
if ($err) {
echo "cURL Error #:" . $err;
} else {
echo $response;
}package main
import (
"fmt"
"strings"
"net/http"
"io"
)
func main() {
url := "https://api.swippee.com/v1/parse"
payload := strings.NewReader("-----011000010111000001101001\r\nContent-Disposition: form-data; name=\"file\"; filename=\"example-file\"\r\nContent-Type: application/octet-stream\r\n\r\n<string>\r\n-----011000010111000001101001\r\nContent-Disposition: form-data; name=\"bank\"\r\n\r\nauto\r\n-----011000010111000001101001\r\nContent-Disposition: form-data; name=\"async\"\r\n\r\nfalse\r\n-----011000010111000001101001--")
req, _ := http.NewRequest("POST", url, payload)
req.Header.Add("Authorization", "Bearer <token>")
res, _ := http.DefaultClient.Do(req)
defer res.Body.Close()
body, _ := io.ReadAll(res.Body)
fmt.Println(string(body))
}HttpResponse<String> response = Unirest.post("https://api.swippee.com/v1/parse")
.header("Authorization", "Bearer <token>")
.body("-----011000010111000001101001\r\nContent-Disposition: form-data; name=\"file\"; filename=\"example-file\"\r\nContent-Type: application/octet-stream\r\n\r\n<string>\r\n-----011000010111000001101001\r\nContent-Disposition: form-data; name=\"bank\"\r\n\r\nauto\r\n-----011000010111000001101001\r\nContent-Disposition: form-data; name=\"async\"\r\n\r\nfalse\r\n-----011000010111000001101001--")
.asString();require 'uri'
require 'net/http'
url = URI("https://api.swippee.com/v1/parse")
http = Net::HTTP.new(url.host, url.port)
http.use_ssl = true
request = Net::HTTP::Post.new(url)
request["Authorization"] = 'Bearer <token>'
request.body = "-----011000010111000001101001\r\nContent-Disposition: form-data; name=\"file\"; filename=\"example-file\"\r\nContent-Type: application/octet-stream\r\n\r\n<string>\r\n-----011000010111000001101001\r\nContent-Disposition: form-data; name=\"bank\"\r\n\r\nauto\r\n-----011000010111000001101001\r\nContent-Disposition: form-data; name=\"async\"\r\n\r\nfalse\r\n-----011000010111000001101001--"
response = http.request(request)
puts response.read_body{
"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
}
]
}{
"error_type": "AUTHENTICATION_ERROR",
"error_code": "INVALID_API_KEY",
"error_message": "Unknown API key.",
"display_message": null,
"request_id": "req_8f3c9b2e4a1d4f7c9e0b1a2c3d4e5f60",
"documentation_url": "https://docs.swippee.com/concepts/errors#invalid_api_key",
"suggested_action": "Check your API key in the Authorization header."
}{
"error_type": "AUTHENTICATION_ERROR",
"error_code": "INVALID_API_KEY",
"error_message": "Unknown API key.",
"display_message": null,
"request_id": "req_8f3c9b2e4a1d4f7c9e0b1a2c3d4e5f60",
"documentation_url": "https://docs.swippee.com/concepts/errors#invalid_api_key",
"suggested_action": "Check your API key in the Authorization header."
}Authorizations
Your API key from the dashboard, sent as Authorization: Bearer swippee_sk_live_....
Headers
Optional. A unique key (e.g. a UUID v4) so a retry replays the original response instead of creating a duplicate report or double-charging. See https://docs.swippee.com/concepts/idempotency
8 - 255Body
The statement file. PDF, Excel, JPEG, or PNG. Max 20 MB.
Bank hint, or auto to detect. GLOBAL_IME is in beta.
auto, NABIL, NIC_ASIA, NIMB, NMB, KUMARI, SIDDHARTHA, PRABHU, GARIMA, GLOBAL_IME, ESEWA, KHALTI If true, returns 202 + poll_url immediately and processes in the background.
Response
Parsed report
"cl_abc123"
"complete"
How the data was obtained: parsed from the bank's PDF/Excel, or read from a photo/scan.
PARSED_STATEMENT, OCR_IMAGE "PARSED_STATEMENT"
Whether the source supports document tamper-verification (false for OCR_IMAGE).
true
Show child attributes
Show child attributes
Show child attributes
Show child attributes