LOYALTIРоссийская версия
English edition Запросить демо

Справочник API

Каждый вызов, три контракта, файлы OpenAPI

Кабинет — такой же клиент API, как и интеграторы. Три контракта описывают платформу, кассу и POS-терминалы; каждый опубликован как файл OpenAPI 3, который открывается в Postman, Swagger UI или генераторе кода.

Platform API/api/v1 · 303 вызова · JWT с обновлением; роли и доступ по точкам у пользователя Кассовый API/v2 · 41 вызов · ключ кассы или 1С в заголовке Authorization, привязка к точке; совместим с PremiumBonus POS API/pos/v1 · 16 вызовов · ключ терминала в заголовке; совместим с «1С:Сервер лояльности 3.0»

Авторизация

Platform API: вход по e-mail и паролю, JWT и refresh-токен; двухфакторные коды для суперадминов. Кассовый API: ключ, созданный в кабинете, показывается один раз и ротируется; принимается как есть или с префиксом Bearer. POS API: заголовок X-POS-Api-Key. Обмен CommerceML: HTTP Basic пользователя с ролью «1С».

Соглашения

JSON на входе и выходе. Списки постраничные. Ошибки несут машиночитаемый код и, для валидации, список полей. Деньги в кассовом API в рублях, идентификаторы — UUID.

Лимиты и защита

Лимиты запросов на ключ и на вход; идемпотентная фиксация покупки по номеру чека; подписи вебхуков в обе стороны; каждая запись попадает в журнал аудита.

Platform API /api/v1

Кабинет, портал участника и суперадмин: всё, что делает веб-приложение, доступно интеграторам.

303 вызовов · Скачать файл OpenAPI

Авторизация 13 Участники 12 Кошельки 9 Транзакции 3 Уровни 5 Правила 9 Сегменты 7 Кампании 8 Бонусные пакеты 10 Триггеры по датам 5 Сценарии 9 Шаблоны сообщений 5 Локации 5 Пользователи 8 Тенанты 2 Ключи касс 4 Интеграции 7 Вебхуки 8 Каталог 11 Источники каталога 5 Оплата и доставка 10 Скидки каталога 4 Заказы 5 Импорт 5 Аналитика 11 Дашборд 1 Аудит 1 Согласия 7 Рефералы 1 Электронные карты 3 Настройки компании 2 Настройки лояльности 2 Настройки рефералов 2 Настройки уведомлений 9 Резервные копии 4 Портал участника 12 Суперадмин: вход 11 Суперадмин: тенанты 6 Суперадмин: администраторы 4 Суперадмин: платформа 3 Суперадмин: настройки 4 Суперадмин: уведомления 13 Суперадмин: коалиции 5 Суперадмин: переводы 7 Суперадмин: резервные копии 6 О платформе 1 Переводы 3 Здоровье сервиса 1 Метрики 1 Обмен с 1С 1 Вебхуки 1С 3 Вебхуки Bitrix24 5 Списание 5

Авторизация

МетодПутьЧто делает
POST/auth/registerРегистрация новой компании
POST/auth/loginВход пользователя
GET/auth/meПрофиль текущего пользователя
PUT/auth/profileОбновить свой профиль
POST/auth/passwordСменить пароль
POST/auth/refreshОбновить JWT по refresh_token
POST/auth/forgot-passwordЗапросить ссылку на сброс пароля
POST/auth/reset-passwordУстановить новый пароль по токену
POST/auth/2fa/setupНачать настройку 2FA
POST/auth/2fa/confirmПодтвердить настройку 2FA
POST/auth/2fa/disableОтключить 2FA
POST/auth/2fa/verifyВерифицировать 2FA при логине
POST/auth/logoutВыйти и отозвать refresh token

Участники

МетодПутьЧто делает
GET/membersСписок участников
POST/membersЗарегистрировать нового участника
GET/members/exportЭкспорт всех участников в CSV
POST/members/bulkМассовое создание участников (до 500)
GET/members/{memberId}Детали участника
PUT/members/{memberId}Обновить участника
POST/members/{memberId}/activateАктивировать участника
POST/members/{memberId}/deactivateДеактивировать участника
GET/members/{memberId}/cardКарта лояльности (JSON с QR и штрихкодом в base64)
GET/members/{memberId}/card/qrQR-код карты (PNG)
GET/members/{memberId}/card/barcodeШтрихкод Code128 (PNG)
GET/members/{memberId}/referral-qrQR со ссылкой на портал регистрации по рефералу

Кошельки

МетодПутьЧто делает
POST/wallets/bulk/earnМассовое начисление баллов (до 100 операций)
POST/wallets/bulk/redeemМассовое списание баллов
GET/wallets/{walletId}/balanceТекущий баланс кошелька
POST/wallets/{walletId}/earnНачислить баллы
POST/wallets/{walletId}/redeemСписать баллы
GET/wallets/member/{memberId}Кошелёк по memberId
POST/wallets/member/{memberId}/earnНачислить баллы по memberId
POST/wallets/member/{memberId}/redeemСписать баллы по memberId
POST/wallets/member/{memberId}/giftПодарить баллы участнику (admin gift)

Транзакции

МетодПутьЧто делает
GET/wallets/{walletId}/transactionsИстория операций кошелька
GET/wallets/member/{memberId}/transactionsИстория операций участника
GET/transactionsСписок всех транзакций тенанта с фильтрами

Уровни

МетодПутьЧто делает
GET/tiersВсе уровни тенанта
POST/tiersСоздать уровень
GET/tiers/{id}Детали уровня
PUT/tiers/{id}Обновить уровень
DELETE/tiers/{id}Удалить уровень

Правила

МетодПутьЧто делает
GET/rulesСписок правил
POST/rulesСоздать правило
GET/rules/{id}Детали правила
PUT/rules/{id}Обновить правило
DELETE/rules/{id}Архивировать правило
POST/rules/{id}/activateАктивировать правило
POST/rules/{id}/deactivateДеактивировать правило
POST/rules/dry-runТестовый прогон правила без сохранения
POST/rules/{id}/simulateСимуляция существующего правила

Сегменты

МетодПутьЧто делает
GET/segmentsСписок сегментов
POST/segmentsСоздать сегмент
GET/segments/{id}Детали сегмента
PUT/segments/{id}Update segment
DELETE/segments/{id}Удалить сегмент
POST/segments/{id}/recalculateПересчитать состав сегмента
GET/segments/{id}/membersУчастники сегмента

Кампании

МетодПутьЧто делает
GET/campaignsСписок кампаний
POST/campaignsCreate campaign
GET/campaigns/{id}Get campaign
PUT/campaigns/{id}Update campaign
DELETE/campaigns/{id}Delete campaign
POST/campaigns/{id}/activateActivate campaign
POST/campaigns/{id}/pausePause campaign
POST/campaigns/{id}/sendЗапланировать/запустить рассылку кампании

Бонусные пакеты

МетодПутьЧто делает
GET/bonus-packagesList bonus packages
POST/bonus-packagesCreate bonus package
GET/bonus-packages/{id}Get bonus package
PUT/bonus-packages/{id}Update bonus package
DELETE/bonus-packages/{id}Archive bonus package
POST/bonus-packages/{id}/activateActivate bonus package
POST/bonus-packages/{id}/deactivateDeactivate bonus package
POST/bonus-packages/{id}/grantGrant bonus package
POST/bonus-packages/{id}/bulk-grantBulk grant bonus package
GET/bonus-packages/{id}/grantsList bonus package grants

Триггеры по датам

МетодПутьЧто делает
GET/date-triggersList date triggers
GET/date-triggers/{type}Get date trigger
PUT/date-triggers/{type}Update date trigger
GET/date-triggers/{type}/logGet date trigger log
POST/date-triggers/{type}/testTest date trigger

Сценарии

МетодПутьЧто делает
GET/scenariosList scenarios
POST/scenariosCreate scenario
GET/scenarios/{id}Get scenario
PUT/scenarios/{id}Update scenario
DELETE/scenarios/{id}Archive scenario
POST/scenarios/{id}/activateActivate scenario
POST/scenarios/{id}/pausePause scenario
POST/scenarios/{id}/startStart scenario for member
GET/scenarios/{id}/executionsList scenario executions

Шаблоны сообщений

МетодПутьЧто делает
GET/message-templatesList message templates
POST/message-templatesCreate message template
GET/message-templates/{id}Get message template
PUT/message-templates/{id}Update message template
DELETE/message-templates/{id}Archive message template

Локации

МетодПутьЧто делает
GET/locationsList locations
POST/locationsCreate location
GET/locations/{id}Get location
PUT/locations/{id}Update location
DELETE/locations/{id}Delete location

Пользователи

МетодПутьЧто делает
GET/usersList users
POST/usersCreate user
GET/users/{id}Get user
PUT/users/{id}Update user
DELETE/users/{id}Delete user
POST/users/{id}/rolesAssign role
DELETE/users/{id}/roles/{roleId}Remove role
GET/rolesList roles

Тенанты

МетодПутьЧто делает
POST/tenantsСоздать тенанта (доступно авторизованному пользователю при self-service)
GET/tenants/{id}Get tenant

Ключи касс

МетодПутьЧто делает
GET/pos-keysList pos keys
POST/pos-keysСоздать новый POS ключ
DELETE/pos-keys/{id}Отозвать ключ
POST/pos-keys/{id}/rotateРотировать ключ (новое секретное значение)

Интеграции

МетодПутьЧто делает
GET/integrationsList integrations
POST/integrationsCreate integration
GET/integrations/{id}Get integration
PUT/integrations/{id}Update integration
DELETE/integrations/{id}Delete integration
POST/integrations/{id}/testПроверить подключение
POST/integrations/{id}/syncЗапустить синхронизацию

Вебхуки

МетодПутьЧто делает
GET/webhooksList webhooks
POST/webhooksCreate webhook
GET/webhooks/{id}Get webhook
PUT/webhooks/{id}Update webhook
DELETE/webhooks/{id}Delete webhook
POST/webhooks/{id}/testTest webhook
GET/webhooks/{id}/logsWebhook logs
POST/webhooks/{webhookId}/logs/{logId}/retryRetry webhook log

Каталог

МетодПутьЧто делает
GET/catalog/productsList products
POST/catalog/products/bulkМассовая загрузка/обновление товаров
GET/catalog/categoriesList categories
POST/catalog/categoriesCreate category
PUT/catalog/categories/{id}Update category
DELETE/catalog/categories/{id}Delete category
GET/catalog/propertiesList product properties
POST/catalog/propertiesCreate product property
PUT/catalog/properties/{id}Update product property
DELETE/catalog/properties/{id}Delete product property
POST/catalog/properties/bulkBulk product properties

Источники каталога

МетодПутьЧто делает
GET/catalog/sourcesList catalog sources
POST/catalog/sourcesCreate catalog source
PUT/catalog/sources/{id}Update catalog source
DELETE/catalog/sources/{id}Delete catalog source
POST/catalog/sources/{id}/syncЗапустить синхронизацию источника

Оплата и доставка

МетодПутьЧто делает
GET/catalog/payment-typesList payment types
POST/catalog/payment-typesCreate payment type
PUT/catalog/payment-types/{id}Update payment type
DELETE/catalog/payment-types/{id}Delete payment type
POST/catalog/payment-types/bulkBulk payment types
GET/catalog/delivery-typesList delivery types
POST/catalog/delivery-typesCreate delivery type
PUT/catalog/delivery-types/{id}Update delivery type
DELETE/catalog/delivery-types/{id}Delete delivery type
POST/catalog/delivery-types/bulkBulk delivery types

Скидки каталога

МетодПутьЧто делает
GET/catalog/products/{productId}/discountsList product discounts
POST/catalog/products/{productId}/discountsCreate product discount
PUT/catalog/products/{productId}/discounts/{discountId}Update product discount
DELETE/catalog/products/{productId}/discounts/{discountId}Delete product discount

Заказы

МетодПутьЧто делает
GET/catalog/orders/{id}Детали заказа
GET/ordersList orders
POST/orders/{id}/approveApprove order
POST/orders/{id}/cancelCancel order
POST/orders/{id}/refundRefund order

Импорт

МетодПутьЧто делает
POST/import/uploadЗагрузить CSV для импорта
GET/import/jobsList import jobs
GET/import/jobs/{id}Get import job
POST/import/headerПрочитать заголовки загруженного CSV
POST/import/mapping-previewПревью маппинга колонок

Аналитика

МетодПутьЧто делает
GET/analytics/rfmAnalytics rfm
GET/analytics/dashboardAnalytics dashboard
GET/analytics/revenueAnalytics revenue
GET/analytics/members/growthAnalytics members growth
GET/analytics/points/flowAnalytics points flow
GET/analytics/cohortsAnalytics cohorts
GET/analytics/ltvAnalytics ltv
GET/analytics/churnAnalytics churn
GET/analytics/rfm/membersAnalytics rfm members
GET/analytics/locationsAnalytics locations
GET/analytics/locations/{locationId}/transactionsAnalytics location transactions

Дашборд

МетодПутьЧто делает
GET/dashboard/statsDashboard stats

Аудит

МетодПутьЧто делает
GET/auditList audit log

Согласия

МетодПутьЧто делает
GET/members/{memberId}/consentsСогласия участника
POST/members/{memberId}/consentsВыдать согласие
DELETE/members/{memberId}/consents/{type}Отозвать согласие
GET/members/{memberId}/consents/historyИстория изменений согласий
GET/settings/consentsТексты согласий тенанта
POST/settings/consentsСоздать версию текста согласия
PUT/settings/consents/{id}Обновить текст согласия

Рефералы

МетодПутьЧто делает
GET/referrals/statsReferral stats

Электронные карты

МетодПутьЧто делает
GET/passes/typesList pass types
GET/passes/member/{memberId}/appleApple Wallet .pkpass
GET/passes/member/{memberId}/googleGoogle Pay save-link

Настройки компании

МетодПутьЧто делает
GET/settings/companyGet company settings
PUT/settings/companyUpdate company settings

Настройки лояльности

МетодПутьЧто делает
GET/settings/loyaltyGet loyalty settings
PUT/settings/loyaltyUpdate loyalty settings

Настройки рефералов

МетодПутьЧто делает
GET/settings/referralsGet referral settings
PUT/settings/referralsUpdate referral settings

Настройки уведомлений

МетодПутьЧто делает
GET/notifications/templatesList tenant notification templates
GET/notifications/templates/{id}Get tenant notification template
PUT/notifications/templates/{id}Customize tenant notification template
POST/notifications/templates/{id}/resetReset tenant notification template
PUT/notifications/templates/{id}/toggleToggle tenant notification template
POST/notifications/templates/{id}/previewPreview tenant notification template
GET/notifications/channelsList tenant channels
PUT/notifications/channels/{channel}Update tenant channel
POST/notifications/channels/{channel}/testTest tenant channel

Резервные копии

МетодПутьЧто делает
GET/backupList tenant backups
POST/backupCreate tenant backup
GET/backup/{date}Download tenant backup
POST/backup/{date}/restoreRestore tenant backup

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

МетодПутьЧто делает
POST/portal/request-codeЗапросить SMS-код для входа в личный кабинет
POST/portal/verify-codeВерифицировать SMS-код и получить portal_token
POST/portal/registerРегистрация нового участника через портал
GET/portal/referrer-infoИнформация о реферере по memberId
GET/portal/member/{token}Данные ЛК по portal_token (token в path — legacy)
GET/portal/member/{token}/transactionsPortal member transactions
GET/portal/member/{token}/profilePortal get profile
PUT/portal/member/{token}/profilePortal update profile
GET/portal/meДанные ЛК по X-Portal-Token header
GET/portal/me/transactionsPortal me transactions
GET/portal/me/profilePortal me get profile
PUT/portal/me/profilePortal me update profile

Суперадмин: вход

МетодПутьЧто делает
POST/super-admin/auth/loginSuper admin login
POST/super-admin/auth/verify-2faSuper admin verify2fa
GET/super-admin/auth/meSuper admin me
POST/super-admin/auth/change-passwordSuper admin change password
GET/super-admin/2fa/statusSuper admin2fa status
POST/super-admin/2fa/setupSuper admin2fa setup
GET/super-admin/2fa/qrSuper admin2fa qr
POST/super-admin/2fa/confirmSuper admin2fa confirm
PUT/super-admin/2fa/methodSuper admin2fa method
POST/super-admin/2fa/resendSuper admin2fa resend
POST/super-admin/2fa/disableSuper admin2fa disable

Суперадмин: тенанты

МетодПутьЧто делает
GET/super-admin/tenantsSuper admin list tenants
POST/super-admin/tenantsSuper admin create tenant
GET/super-admin/tenants/{id}Super admin get tenant
PUT/super-admin/tenants/{id}Super admin update tenant
POST/super-admin/tenants/{id}/activateSuper admin activate tenant
POST/super-admin/tenants/{id}/suspendSuper admin suspend tenant

Суперадмин: администраторы

МетодПутьЧто делает
GET/super-admin/adminsSuper admin list admins
POST/super-admin/adminsSuper admin create admin
PUT/super-admin/admins/{id}Super admin update admin
DELETE/super-admin/admins/{id}Super admin delete admin

Суперадмин: платформа

МетодПутьЧто делает
GET/super-admin/platform/statsSuper admin platform stats
GET/super-admin/platform/healthSuper admin platform health
GET/super-admin/platform/logsSuper admin platform logs

Суперадмин: настройки

МетодПутьЧто делает
GET/super-admin/settingsSuper admin list settings
GET/super-admin/settings/{key}Super admin get setting
PUT/super-admin/settings/{key}Super admin update setting
POST/super-admin/settings/smtp/testSuper admin test smtp

Суперадмин: уведомления

МетодПутьЧто делает
GET/super-admin/notifications/channelsSuper admin list notification channels
PUT/super-admin/notifications/channels/{id}Super admin update notification channel
GET/super-admin/notifications/platform-templatesSuper admin list platform templates
GET/super-admin/notifications/platform-templates/groupedSuper admin platform templates grouped
GET/super-admin/notifications/platform-templates/{id}Super admin get platform template
PUT/super-admin/notifications/platform-templates/{id}Super admin update platform template
POST/super-admin/notifications/platform-templates/{id}/previewSuper admin preview platform template
GET/super-admin/notifications/default-templatesSuper admin list default templates
GET/super-admin/notifications/default-templates/groupedSuper admin default templates grouped
GET/super-admin/notifications/default-templates/{id}Super admin get default template
PUT/super-admin/notifications/default-templates/{id}Super admin update default template
POST/super-admin/notifications/default-templates/{id}/previewSuper admin preview default template
GET/super-admin/notifications/statsSuper admin notification stats

Суперадмин: коалиции

МетодПутьЧто делает
GET/super-admin/coalitionsSuper admin list coalitions
POST/super-admin/coalitionsSuper admin create coalition
GET/super-admin/coalitions/{id}Super admin get coalition
POST/super-admin/coalitions/{id}/tenantsSuper admin add coalition tenant
DELETE/super-admin/coalitions/{id}/tenants/{tenantId}Super admin remove coalition tenant

Суперадмин: переводы

МетодПутьЧто делает
GET/super-admin/translations/languagesSuper admin list languages
GET/super-admin/translations/{locale}Super admin get translations
DELETE/super-admin/translations/{locale}Super admin delete locale
POST/super-admin/translations/{locale}/uploadSuper admin upload translations
GET/super-admin/translations/{locale}/exportSuper admin export translations
POST/super-admin/translations/languages/{locale}/activateSuper admin activate language
POST/super-admin/translations/languages/{locale}/deactivateSuper admin deactivate language

Суперадмин: резервные копии

МетодПутьЧто делает
GET/super-admin/backupSuper admin list global backups
POST/super-admin/backupSuper admin create global backup
POST/super-admin/backup/{date}/restoreSuper admin restore global backup
GET/super-admin/backup/tenant/{tenantId}Super admin list tenant backups
POST/super-admin/backup/tenant/{tenantId}Super admin create tenant backup
POST/super-admin/backup/tenant/{tenantId}/{date}/restoreSuper admin restore tenant backup

О платформе

МетодПутьЧто делает
GET/platform/infoПубличная информация о платформе

Переводы

МетодПутьЧто делает
GET/translations/languagesСписок активных языков
GET/translations/{locale}Словарь переводов по локали
GET/translationsСловари всех языков

Здоровье сервиса

МетодПутьЧто делает
GET/healthHealth check

Метрики

МетодПутьЧто делает
GET/metricsPrometheus metrics

Обмен с 1С

МетодПутьЧто делает
POST/loyalty/hs/v3/pingPing для 1C HTTP-Bridge (полное описание — в 1c.yaml)

Вебхуки 1С

МетодПутьЧто делает
POST/webhooks/1c/purchaseВходящий вебхук покупки из 1C
POST/webhooks/1c/returnВходящий вебхук возврата из 1C (см. 1c.yaml)
POST/webhooks/1c/customerВходящий вебхук клиента из 1C

Вебхуки Bitrix24

МетодПутьЧто делает
POST/webhooks/bitrix24/contactКонтакт создан/изменён
POST/webhooks/bitrix24/dealСделка создана/закрыта (генерирует покупку)
GET/webhooks/bitrix24/pingWebhook bitrix24 ping
POST/webhooks/bitrix24/contact/{tenantId}Webhook bitrix24 contact tenant
POST/webhooks/bitrix24/deal/{tenantId}Webhook bitrix24 deal tenant

Списание

МетодПутьЧто делает
POST/redeem/requestЗапрос OTP-кода на списание бонусов
POST/redeem/confirmПодтверждение OTP-кода
POST/redeem/commitФинализация списания (после подтверждения заказа)
POST/redeem/cancelОтмена hold (заказ не состоялся)
GET/redeem/status/{redemption_id}Статус операции списания

Кассовый API /v2

То, что вызывают кассы, сайты и приложения: определить покупателя, рассчитать чек, начислить и списать баллы, отменить и вернуть, промокоды и подарочные карты. Совместим с протоколом PremiumBonus.

41 вызовов · Скачать файл OpenAPI

Покупатель 14 Покупка 10 Коды подтверждения 5 Мобильное приложение PremiumBonus 3 Подарочные сертификаты 4 Дополнительно 4 Служебные 1

Покупатель

МетодПутьЧто делает
POST/buyer-registerРегистрация покупателя
POST/buyer-infoИнформация о покупателе
POST/buyer-info-detailПодробная информация о покупателе
POST/buyer-info-messagesСписок сообщений покупателя
POST/buyer-invite-codeПолучение кода приглашения в MLM
POST/buyer-editРедактирование покупателя
POST/buyer/status-transition-infoИнформация о динамическом статусе покупателя
POST/buyer/purchase-listДетальная информация о покупках гостя
POST/generate-order-codeГенерация кода покупателя
POST/card-activateАктивация карты
POST/card-get-infoПолучение электронной карты покупателя
POST/buyer-bonusБонусные пакеты покупателя
POST/buyer-groupsПолучение списка групп пользователей
POST/present-bonusПодарить бонусы другу

Покупка

МетодПутьЧто делает
POST/write-off-requestПолучение максимальной доступной выгоды(скидки+бонусы)
POST/purchase-dry-runЭмуляция проведения покупки
POST/purchase-requestинформации о покупателе + максимальной доступной Получение >- выгоды(скидки+бонусы)
POST/purchaseДобавление покупки
POST/purchase-set-external-idДобавление или изменение внешнего ID покупки
POST/edit-purchaseРедактирование покупки
POST/cancel-purchaseОтмена покупки
POST/change-purchase-statusИзменение статуса покупки
POST/reserve-infoИнформация по резерву
POST/purchase-infoИнформация о покупке

Коды подтверждения

МетодПутьЧто делает
POST/send-register-codeОтправка кода подтверждения регистрации
POST/send-write-off-confirmation-codeОтправка кода подтверждения списания
POST/verify-confirmation-codeПроверка кода подтверждения регистрации или списания
POST/send-custom-codeОтправка кастомного кода подтверждения
POST/verify-custom-codeПроверка кастомного кода подтверждения

Мобильное приложение PremiumBonus

МетодПутьЧто делает
POST/get-ordersПолучение списка заказов
POST/change-order-statusИзменение внешнего статуса заказа
POST/send-pushОтправка PUSH уведомления гостю в Мобильное приложение

Подарочные сертификаты

МетодПутьЧто делает
POST/infoПолучение информации о сертификате
POST/pin-checkПроверка PIN кода
POST/debitПокупка по сертификату (списание)
POST/activeПокупка сертификата (активация)

Дополнительно

МетодПутьЧто делает
POST/triggerАктивация триггера
POST/cashbox-listПолучение списка точек продаж
POST/city-listПолучение информации о городах и их ID
POST/promocode/activate-promocodeАктивация промокода для покупателя

Служебные

МетодПутьЧто делает
GET/healthPublic liveness/readiness probe

POS API /pos/v1

Компактный протокол для кассовых терминалов, совместимый с «1С:Сервер лояльности 3.0»: регистрация покупки, поиск участника, резерв и подтверждение списания.

16 вызовов · Скачать файл OpenAPI

Общие 11 Списание 5

Общие

МетодПутьЧто делает
GET/pingПроверка доступности
POST/balanceПолучить баланс карты
POST/discountsРасчёт скидок для чека
POST/purchaseРегистрация покупки
POST/earnНачисление бонусов
POST/redeemСписание бонусов
POST/reversalОтмена операции
GET/members/searchПоиск участника по телефону или номеру карты
POST/referral/lookupПоиск реферера по QR/штрих-коду карты
POST/referral/registerРегистрация участника с привязкой к рефереру
POST/registerРегистрация участника

Списание

МетодПутьЧто делает
POST/redeem/requestЗапрос OTP-кода на списание бонусов
POST/redeem/confirmПодтверждение OTP-кода
POST/redeem/commitФинализация списания после закрытия чека
POST/redeem/cancelОтмена hold (отказ клиента / отмена чека)
GET/redeem/status/{redemption_id}Статус операции списания (диагностика)