Реализация промокода на площадке

Фиксирует факт выдачи кода покупателю: available → realized, код привязывается к площадке.

Зачем нужен метод

Фиксирует факт выдачи кода покупателю: available → realized, код привязывается к площадке. Обязателен для корректной аналитики и последующего redeem.

Когда использовать

Успешная оплата / выдача в ЛК. Idempotency-Key по orderId.

Эндпоинт

POST /v1/platform/promo-codes/realize

Аутентификация: API-ключ в заголовке X-Api-Key (префикс bk_plt_). projectId и actor id в body не передаются — берутся из ключа.

Scope: platform:codes:realize

Пример запроса

{
  "meta": { "requestId": "optional-uuid" },
  "data": { "codeId": "code-uuid", "externalRef": "order-554433", "realizedRef": "checkout-xyz" }
}

Пример ответа

{
  "success": true,
  "data": {
    "codeId": "code-uuid",
    "codeDisplay": "QUEEN14-48AMU",
    "status": "realized",
    "platformId": "platform-uuid",
    "realizedAt": "2026-07-13T11:00:00Z",
    "realizedChannel": "Ригла"
  }
}

Ошибки

UNAUTHORIZED / ACCESS_DENIED — нет доступа
VALIDATION_ERROR — некорректное тело
NOT_FOUND — сущность не найдена
RATE_LIMIT_EXCEEDED (429) — превышен лимит

cURL

curl -X POST "https://api-external.promanta.ru/v1/platform/promo-codes/realize" \
  -H "Content-Type: application/json" \
  -H "X-Api-Key: YOUR_API_KEY" \
  -d '{"data": { "codeId": "code-uuid", "externalRef": "order-554433", "realizedRef": "checkout-xyz" }}'