Перейти к основному содержимому

Получение статуса транзакции

Метод возвращает актуальный статус конкретной транзакции по ее id с использованием API-ключа.

Запрос

GET /api/v1/transactions/{transaction_id}
Заголовок: x-api-key: <api_key>

{transaction_id} — внутренний id транзакции (UUID), передаётся как сегмент пути.

Поля ответа

ПолеОписание
amountСумма (минорные единицы)
amount_with_feeСумма с комиссией (минорные единицы)
amount_destСумма зачисления при конвертации (минорные единицы), если применимо
currencyВалюта
currency_destВалюта зачисления при конвертации, если применимо
descriptionОписание транзакции
envСреда (prod / test)
error_descriptionОписание ошибки при rejected
finishedВремя завершения (ISO)
idВнутренний UUID транзакции
routeИспользованный маршрут обработки
startedВремя старта (ISO)
statusТекущий статус (см. раздел «Статусы» в Глоссарии; created, charging, charged, refunded, rejected, failed)
txidВнешний идентификатор клиента
typeТип (payment / payout)
widget_urlСсылка на виджет (если применимо)
simple_auth_redirect_urlСсылка для доп. авторизации / 3DS

Пример

curl --location 'https://app.heth.me/api/v1/transactions/c033ceaa-3726-4479-8be3-c9af8a0b2336' \
--header 'x-api-key: ВАШ_КЛЮЧ'

Рекомендации

  • Используйте экспоненциальный backoff при опросе.
  • Отсутствие finished значит, что транзакция еще обрабатывается.
  • Значения txid делайте идемпотентными.