Доступ для розробників · Працює
API для конвертації банківських виписок
Видобувайте структуровані дані транзакцій у форматі JSON із будь-якого PDF банківської виписки через простий REST API. Створено на тому ж рушії аналізу, що й PivotBank, понад 1000 банків, підтримка кількох сторінок, інтеграція без налаштування.
Проста інтеграція
Один endpoint. Структурований JSON.
Надішліть PDF методом POST. Отримайте чисті, структуровані дані транзакцій. Кожна відповідь містить назву банку, період виписки та повний масив транзакцій із нормалізованими полями дати, опису, дебету, кредиту та балансу.
- ✓Узгоджені назви полів для всіх банків
- ✓Значення null для відсутніх дебету/кредиту (ніколи неоднозначно)
- ✓Вивід у форматі дати ISO
- ✓Назва банку та період визначаються автоматично
- ✓Кількість сторінок включено для відстеження використання
POST /api/v1/convert
Authorization: Bearer {API_KEY}
Content-Type: multipart/form-data
# Response: 200 OK
{
"bankName": "HSBC",
"accountNumber": "1234 5678",
"period": "Jan 2025, Mar 2025",
"pageCount": 3,
"transactionCount": 2,
"reconciliation": {
"verified": true,
"status": "ok",
"opening": 2384.21,
"closing": 6841.22,
"expectedClosing": 6841.22,
"difference": 0,
"totalIn": 4500.00,
"totalOut": 42.99
},
"transactions": [
{
"date": "2025-01-03",
"description": "AMAZON.CO.UK",
"debit": 42.99,
"credit": null,
"balance": 2341.22
},
{
"date": "2025-01-07",
"description": "SALARY - ACME LTD",
"debit": null,
"credit": 4500.00,
"balance": 6841.22
}
]
}Як її викликати
Оформіть Pro
Доступ до API потребує активної підписки Pro; endpoint відхиляє ключі будь-якого іншого акаунта.
Створіть ключ API
Згенеруйте його на сторінці акаунта. Він показується один раз, і зберігається лише його хеш.
Надішліть PDF через POST
Надішліть PDF на /api/v1/convert із заголовком Authorization: Bearer, як multipart form-data у полі "file" або як тіло application/pdf, до 15 МБ.
Прочитайте JSON
Відповідь 200 повертає bankName, accountNumber, period, pageCount, transactionCount, об’єкт reconciliation і масив transactions з date, description, debit, credit та balance.
Хто використовує API
Інтеграція з бухгалтерським ПЗ
Надсилайте PDF клієнтів до власної системи та отримуйте структурований JSON, готовий для прямого внесення до книг Xero, QuickBooks або Sage, без ручного перенабору.
Фінтех і кредитування
Автоматизуйте аналіз платоспроможності для кредитних заявок. Аналізуйте 3-12 місяців виписок заявника за секунди та видобувайте доходи, регулярні зобов’язання й тенденції балансу.
Корпоративна автоматизація
Інтегруйте аналіз банківських виписок у внутрішні робочі процеси, перевірки відповідності, обробку витрат, підтримку аудиту або власні фінансові дашборди.
Модель ціноутворення
Оплата за виписку
Доступ
Входить у Pro
Підтримувані банки
Понад 1000
The API is a Pro feature
Upgrade to Pro to create API keys and convert statements programmatically.
Upgrade to ProРобота з API
Як пройти автентифікацію?
Надішліть ключ як bearer-токен: Authorization: Bearer pvb_live_... Ключі створюються і відкликаються на цій сторінці, а endpoint вимагає активної підписки Pro, тож дійсний ключ на обліковому записі без Pro буде відхилено з 403.
Як надіслати PDF?
Як multipart/form-data з файлом у полі "file", або як сире тіло запиту з Content-Type: application/pdf. Той самий endpoint приймає обидва варіанти. Ліміт 15 МБ перевіряється за оголошеною довжиною ще до читання тіла, тож завеликий файл відхиляється з 413, а не передається спершу.
Що повертається?
Один об'єкт JSON: bankName, accountNumber, period і pageCount, визначені з виписки, transactionCount і масив transactions. Кожна транзакція має дату, опис і поля debit, credit та balance, з null замість нуля там, де стовпця справді немає.
Чи читає він відскановані виписки?
Ні, і це єдине місце, де API вужчий за вебзастосунок. Браузер виконує OCR для сканування; API аналізує лише текстовий шар, і виписка без придатного тексту повертається як 422 з проханням надіслати цифровий PDF. Якщо серед ваших файлів є сканування, конвертуйте їх у браузері або напишіть нам.
Що означають коди помилок?
401 — ключ відсутній, недійсний або відкликаний. 403 — дійсний ключ на обліковому записі без Pro. 400 — тіло не є придатним PDF. 413 — понад 15 МБ. 422 — PDF розібрано, але придатного тексту немає, що на практиці означає сканування.
Як рахується використання?
Одна конвертація на кожен успішний виклик, записана у ваш обліковий запис разом із кількістю сторінок, так само як конвертація в браузері. Виклик із помилкою не рахується.
Обсяги та підприємства
Конвертуєте великі обсяги?
API працює і входить у підписку Pro. Створіть ключ вище і починайте надсилати виписки; тут немає жодної черги.
Напишіть нам, якщо конвертуєте великі обсяги, потрібен окремий тариф або хочете обговорити інтеграцію, перш ніж її будувати.
