Назад к журналу
27 января 2026 г.documentation

Обновление точности API документации

Комплексное обновление документации API для соответствия фактической реализации бэкенда.

Мы провели тщательную проверку и обновление документации API для обеспечения точности всех endpoint'ов, webhook'ов и примеров кода.

Основные обновления

Схемы запросов и ответов

  • Корректные имена полей: Ответ использует paymentId (не id) и generatedAddress (не address)
  • Обязательные поля: Создание платежа теперь четко документирует amount, currency и network как обязательные
  • Значения статусов: Все статусы в нижнем регистре (pending, confirmed, underpaid, overpaid, expired, failed, canceled)
  • Новые статусы: Добавлены underpaid и overpaid для обработки частичных платежей
  • Заголовки аутентификации

  • Корректные имена заголовков: X-Pulse2Pay-Key, X-Pulse2Pay-Signature, X-Pulse2Pay-Timestamp
  • Формат timestamp: Теперь четко документирован как миллисекунды (не секунды)
  • Префикс API ключей: Публичные ключи используют pk_live_ / pk_test_, секретные ключи используют sk_live_ / sk_test_
  • Документация Webhook

  • Формат подписи: Подписи webhook используют timestamp.body (отличается от формата подписи API)
  • Структура payload: Использует поле type (не event) и оборачивает данные платежа в объект data
  • Политика повторов: Обновлена до 5 попыток с задержками 1с, 5с, 30с, 1мин, 5мин
  • Все 8 событий: payment.created, payment.pending, payment.confirmed, payment.underpaid, payment.overpaid, payment.expired, payment.failed, payment.canceled
  • Новые документированные функции

  • Поля payload webhook: externalId, differenceAmount, overpaidAmount, underpaidAmount, alertType
  • Чеклист интеграции: Добавлен в портал мерчанта для упрощения онбординга
  • Обновленные ресурсы

  • API Reference
  • Документация Webhooks
  • Руководство по аутентификации API
  • Руководство по безопасности Webhook
  • Приём USDT платежей
  • Процесс криптоплатежей
#api#документация#webhooks#интеграция