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
}
]
}
'import requests
url = "https://api.swippee.com/v1/sandbox/reports"
payload = {
"scenario": "salaried",
"override_transactions": [
{
"date": "2023-12-25",
"description": "<string>",
"amount": 123
}
]
}
headers = {
"Authorization": "Bearer <token>",
"Content-Type": "application/json"
}
response = requests.post(url, json=payload, headers=headers)
print(response.text)const options = {
method: 'POST',
headers: {Authorization: 'Bearer <token>', 'Content-Type': 'application/json'},
body: JSON.stringify({
scenario: 'salaried',
override_transactions: [{date: '2023-12-25', description: '<string>', amount: 123}]
})
};
fetch('https://api.swippee.com/v1/sandbox/reports', 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/sandbox/reports",
CURLOPT_RETURNTRANSFER => true,
CURLOPT_ENCODING => "",
CURLOPT_MAXREDIRS => 10,
CURLOPT_TIMEOUT => 30,
CURLOPT_HTTP_VERSION => CURL_HTTP_VERSION_1_1,
CURLOPT_CUSTOMREQUEST => "POST",
CURLOPT_POSTFIELDS => json_encode([
'scenario' => 'salaried',
'override_transactions' => [
[
'date' => '2023-12-25',
'description' => '<string>',
'amount' => 123
]
]
]),
CURLOPT_HTTPHEADER => [
"Authorization: Bearer <token>",
"Content-Type: application/json"
],
]);
$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/sandbox/reports"
payload := strings.NewReader("{\n \"scenario\": \"salaried\",\n \"override_transactions\": [\n {\n \"date\": \"2023-12-25\",\n \"description\": \"<string>\",\n \"amount\": 123\n }\n ]\n}")
req, _ := http.NewRequest("POST", url, payload)
req.Header.Add("Authorization", "Bearer <token>")
req.Header.Add("Content-Type", "application/json")
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/sandbox/reports")
.header("Authorization", "Bearer <token>")
.header("Content-Type", "application/json")
.body("{\n \"scenario\": \"salaried\",\n \"override_transactions\": [\n {\n \"date\": \"2023-12-25\",\n \"description\": \"<string>\",\n \"amount\": 123\n }\n ]\n}")
.asString();require 'uri'
require 'net/http'
url = URI("https://api.swippee.com/v1/sandbox/reports")
http = Net::HTTP.new(url.host, url.port)
http.use_ssl = true
request = Net::HTTP::Post.new(url)
request["Authorization"] = 'Bearer <token>'
request["Content-Type"] = 'application/json'
request.body = "{\n \"scenario\": \"salaried\",\n \"override_transactions\": [\n {\n \"date\": \"2023-12-25\",\n \"description\": \"<string>\",\n \"amount\": 123\n }\n ]\n}"
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."
}{
"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."
}Create a sandbox report
Create a deterministic, fully-synthetic StatementReport (or force a deterministic error). No file required. Report scenarios persist a complete, test-environment report, so every /v1/reports/{id}/* sub-endpoint works against the returned report_id. Requires a test key; never consumes quota.
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
}
]
}
'import requests
url = "https://api.swippee.com/v1/sandbox/reports"
payload = {
"scenario": "salaried",
"override_transactions": [
{
"date": "2023-12-25",
"description": "<string>",
"amount": 123
}
]
}
headers = {
"Authorization": "Bearer <token>",
"Content-Type": "application/json"
}
response = requests.post(url, json=payload, headers=headers)
print(response.text)const options = {
method: 'POST',
headers: {Authorization: 'Bearer <token>', 'Content-Type': 'application/json'},
body: JSON.stringify({
scenario: 'salaried',
override_transactions: [{date: '2023-12-25', description: '<string>', amount: 123}]
})
};
fetch('https://api.swippee.com/v1/sandbox/reports', 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/sandbox/reports",
CURLOPT_RETURNTRANSFER => true,
CURLOPT_ENCODING => "",
CURLOPT_MAXREDIRS => 10,
CURLOPT_TIMEOUT => 30,
CURLOPT_HTTP_VERSION => CURL_HTTP_VERSION_1_1,
CURLOPT_CUSTOMREQUEST => "POST",
CURLOPT_POSTFIELDS => json_encode([
'scenario' => 'salaried',
'override_transactions' => [
[
'date' => '2023-12-25',
'description' => '<string>',
'amount' => 123
]
]
]),
CURLOPT_HTTPHEADER => [
"Authorization: Bearer <token>",
"Content-Type: application/json"
],
]);
$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/sandbox/reports"
payload := strings.NewReader("{\n \"scenario\": \"salaried\",\n \"override_transactions\": [\n {\n \"date\": \"2023-12-25\",\n \"description\": \"<string>\",\n \"amount\": 123\n }\n ]\n}")
req, _ := http.NewRequest("POST", url, payload)
req.Header.Add("Authorization", "Bearer <token>")
req.Header.Add("Content-Type", "application/json")
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/sandbox/reports")
.header("Authorization", "Bearer <token>")
.header("Content-Type", "application/json")
.body("{\n \"scenario\": \"salaried\",\n \"override_transactions\": [\n {\n \"date\": \"2023-12-25\",\n \"description\": \"<string>\",\n \"amount\": 123\n }\n ]\n}")
.asString();require 'uri'
require 'net/http'
url = URI("https://api.swippee.com/v1/sandbox/reports")
http = Net::HTTP.new(url.host, url.port)
http.use_ssl = true
request = Net::HTTP::Post.new(url)
request["Authorization"] = 'Bearer <token>'
request["Content-Type"] = 'application/json'
request.body = "{\n \"scenario\": \"salaried\",\n \"override_transactions\": [\n {\n \"date\": \"2023-12-25\",\n \"description\": \"<string>\",\n \"amount\": 123\n }\n ]\n}"
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."
}{
"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_....
Body
A report scenario, or an error_* scenario to force a failure.
salaried, thin_file, high_risk, remittance, error_unsupported_bank, error_unsupported_document, error_password_required, error_image_not_tamper_verified, error_tamper_detected Extra transactions appended to the scenario (balance is recomputed).
Show child attributes
Show child attributes
Response
Synthetic 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