cursor для списков, page_token для чтения транзакций).
Суммы передаются десятичными строками с отдельным полем currency в формате ISO 4217, даты указываются в формате ISO 8601, а страны указываются в формате ISO alpha-3.
Запросы на чтение никогда не тарифицируются.
Счета
GET /v3/bank/connections/{id}/accounts/ возвращает список счетов подключения, а GET /v3/bank/accounts/{account_id}/ возвращает один счёт.
Используйте
account_ref, чтобы распознать банковский счёт, когда человек подключает его повторно, а id для всего, что относится к одному подключению.
Балансы
GET /v3/bank/accounts/{account_id}/balances/ возвращает балансы с указанием типа и опорных дат.
type принимает значения booked, available или expected. Поле iso_type содержит код ISO 20022 от банка, если банк его предоставляет.
Транзакции
GET /v3/bank/accounts/{account_id}/transactions/ читает транзакции за диапазон дат.
Он принимает date_from и date_to (календарные даты в том виде, в каком их передаёт банк, границы включаются), status (booked или pending, по умолчанию оба), limit (до 500) и page_token.
Он сортирует по effective_date по убыванию, затем по id.
idназначает Didit, сохраняется при первом обнаружении. Одно и то же движение сохраняет свой id при последующих чтениях, синхронизациях и продлениях.identity_qualityпоказывает, насколько надёжна эта гарантия.bank_referenceиroute_idстабильны.derivedозначает, что движение сопоставлено по содержимому, поэтому исправление банка может появиться как одна записьremovedи одна записьadded.statusпринимает значенияbookedилиpending. У транзакции в ожидании свой id. Когда банк проводит её, проведённая транзакция приходит какadded, а транзакция в ожидании приходит какremovedсreason: pending_booked.pending_idзаполняется только там, где банк связывает эти записи.amountимеет знак: отрицательное значение означает списание.directionповторяет знак.bank_reference: неизменяемая ссылка на запись банка; равнаnull, если банк её не передаёт. Didit никогда не формирует её сам.category: собственная категоризация Didit, когда она применима.- Исправление банком проведённой транзакции помечается как
modified. Сторно создаёт новую транзакцию;reverses_idзаполняется, если банк связывает её с исходной.
Поля, которые банк не передаёт, равны null
Каждое поле, которое банк не передаёт, имеет значениеnull.
Учреждение перечисляет поля, которые, как известно, передаются, в transaction_fields, а также в pending_transactions, pending_linkage, balance_types и history_days_max, чтобы пробелы не обнаруживались в продакшне.
Чтобы проверить свой код на банке, который передаёт мало данных, используйте тестового клиента sparse_fields в песочнице.
Постраничное чтение диапазона дат
Продолжайте чтение сpage_token, пока has_more равен true.
Токен фиксирует снимок данных запроса на один час: добавления, появившиеся после первой страницы, в него не входят; каждая строка возвращается в текущем состоянии; строка, удалённая во время постраничного чтения, выпадает из последующих страниц и появляется в ленте изменений.
Истёкший токен возвращает ответ 410 page_expired: начните чтение заново с исходного запроса.
Лента изменений
GET /v3/bank/connections/{id}/transactions/sync/ возвращает все изменения по всем счетам подключения после указанного cursor.
- Пустой курсор возвращает все текущие транзакции как
addedсreset: true. Замените ими свою копию, а не добавляйте их к ней. - Продолжайте постраничную выборку с помощью
page_token, покаhas_moreравен true. Сохраняйтеnext_cursorтолько после ответа сhas_more: false. Если при постраничной выборке произошла ошибка, начните заново с ранее сохранённого курсора. - Курсор непрозрачен и привязан к подключению и среде. Журнал изменений можно воспроизводить повторно в течение 90 дней. Более старый курсор возвращает
410 cursor_expiredсbootstrap: true: начните заново с пустого курсора и замените свою копию. removed[].reasonпринимает значенияpending_booked,pending_expired,bank_removedилиaccess_removed.
Заголовки
Оба запроса на чтение транзакций возвращают заголовкиX-RateLimit-* (600 запросов на чтение и 300 на запись в минуту на приложение, при превышении возвращается код 429 с заголовком Retry-After) и X-Bank-Last-Synced-At.
Лимиты API и собственные лимиты банка на получение данных различаются: см. раздел Обновление данных банка по запросу.