Заявки и пользователи
Как связать чеки со своими ID и найти сохранённые проверки.
Передайте свои идентификаторы
Добавьте поля к запросу проверки чека:
| Поле | Для чего | Формат |
|---|---|---|
external_id | Найти проверки своей заявки | Необязательная строка, 1–128 символов |
external_user_id | Найти историю своего пользователя | Необязательная строка, 1–200 символов |
Например: external_id=payment-123, external_user_id=customer:00042.
Значения сохраняются без изменения регистра и ведущих нулей.
ID принадлежат вашей компании и не связываются с данными других компаний.
Одна заявка может иметь несколько проверок. external_id не защищает от повторной
отправки запроса — для этого нужен Idempotency-Key.
Если ID пользователя неизвестен, не передавайте external_user_id.
Найдите проверки заявки
curl --get 'https://api.kvitera.tech/v1/checks' \
-H "Authorization: Bearer $KVITERA_API_KEY" \
--data-urlencode 'external_id=payment-123' \
--data-urlencode 'page=1' \
--data-urlencode 'limit=20'Ответ содержит items — список проверок, total — общее число результатов,
а также page, limit и pages. По умолчанию новые проверки идут первыми.
Для полного результата используйте ID из списка:
GET /v1/checks/{id}.
Найдите историю пользователя
В том же запросе замените фильтр на external_user_id=customer:00042.
Можно передать оба поля, чтобы найти проверки конкретной заявки этого пользователя.
Поиск по этим ID точный. Передайте хотя бы один из них, иначе получите 422.
В списке может быть проверка со статусом processing: дождитесь её завершения.
Поиск и чтение результата не расходуют лимит проверок.