К содержанию
Lumean API

GET/reseller/codes

Коды, выпущенные владельцем ключа, новые первыми, С ПОЛНЫМ значением code. Фильтры status, source; страничная пагинация (page, per_page до 100). Право: reseller.read.

reseller.read
На этой странице(3)

Параметры

Поля ввода живут прямо в строке запроса: подставьте значение — и получите готовый URL. Ниже — тип, обязательность и допустимые значения каждого параметра.

GEThttps://api.lumean.app/api/public/reseller/codes
  • integerв queryнеобязательный≥ 1

    Номер страницы, начиная с 1.

  • integerв queryнеобязательный1..100

    Сколько записей вернуть на странице. Метаданные пагинации лежат рядом с items: current_page, last_page, per_page, total.

  • GiftCodeStatusв queryнеобязательный

    Вернуть только коды в этом статусе. Неизвестное значение → 422.

    Допустимые значения
  • GiftCodeSourceв queryнеобязательный

    Вернуть только коды этого источника: reseller — выпущенные вами со своего баланса, purchase — купленные вами как обычным покупателем. Неизвестное значение → 422.

    Допустимые значения

Возможные ответы

200

GiftCodeCollection

Пример тела
{
  "data": {
    "items": [
      {
        "uuid": "string",
        "code_masked": "string",
        "code": "string",
        "nominal": "string",
        "nominal_formatted": 1,
        "cost": "string",
        "cost_formatted": 1,
        "discount_bps": 1,
        "source": "string",
        "funding": "string",
        "status": "string",
        "activatable_at": "string",
        "redeemed_at": "string",
        "cancelled_at": "string",
        "created_at": "string",
        "currency_asset": {
          "code": "string",
          "precision": 1
        }
      }
    ],
    "current_page": 1,
    "last_page": 1,
    "per_page": 1,
    "total": 1
  }
}
Поля ответа
dataобязательное

Полезная нагрузка ответа.

GiftCodeListGiftCodeList
itemsобязательное

Записи текущей страницы в порядке сортировки списка.

array<GiftCode>GiftCode
элемент массива
uuidобязательное

UUID кода. Его подставляют в пути GET /reseller/codes/{uuid} и POST /reseller/codes/{uuid}/cancel.

string
code_maskedобязательное

Код с маской, LUM-****-****-XXXX: его безопасно показывать в интерфейсе и писать в логи.

string
codeнеобязательное

ПОЛНОЕ значение кода — то, что вводит получатель при активации. Публичный API реселлера отдаёт его в списке, при показе и при выпуске. Обращайтесь как с секретом: кто знает код, тот его и активирует.

string
nominalобязательное

Номинал кода в минимальных единицах LMC: real = nominal / 10^currency_asset.precision. Столько LMC получит активатор.

string
nominal_formattedобязательное

Тот же номинал в целых LMC — число, готовое к показу.

number
costнеобязательное

Сколько код стоил реселлеру с учётом скидки, в минимальных единицах LMC. Приходит только у кодов реселлера (source: reseller).

string
cost_formattedнеобязательное

Та же стоимость в целых LMC. Приходит только у кодов реселлера.

number
discount_bpsнеобязательное

Скидка реселлера на момент выпуска, в базисных пунктах (100 = 1%). Позднейшая смена личной скидки этот код не меняет. Приходит только у кодов реселлера.

integer
sourceобязательное
string
fundingобязательное
string
statusобязательное
string
activatable_atобязательное

С какого момента код можно активировать: до него код заморожен. null — ограничения нет.

string
redeemed_atобязательное

Когда код активирован. null, пока не активирован. Кто его активировал, API не раскрывает.

string
cancelled_atобязательное

Когда реселлер отменил код. null, если код не отменялся.

string
created_atобязательное

Когда код выпущен.

string
currency_assetобязательное

Валюта сумм ответа — LMC. По precision суммы в минимальных единицах переводятся в целые LMC.

object
codeобязательное

Код актива, в котором выражены суммы.

ЗначенияLUMC
string
precisionобязательное

Сколько знаков после запятой у LMC: real = value / 10^precision.

integer
current_pageобязательное

Номер текущей страницы, с единицы.

integer
last_pageобязательное

Номер последней страницы. Обход списка закончен, когда current_page равен last_page.

integer
per_pageобязательное

Размер страницы, применённый сервером.

integer
totalобязательное

Сколько записей всего по фильтру.

integer
422

Ошибка валидации. Поля с ошибками перечислены в errors.

Разобрать этот ответ
Пример тела
{
  "message": "string",
  "errors": {}
}
Поля ответа
messageобязательное

Errors overview.

string
errorsобязательное

A detailed description of each field that failed validation.

object
*необязательное
произвольные ключи
array<string>

Рядом

Объекты

Соседние операции

Скормить страницу ИИ

Открыть .mdllm.md

спека 0.0.1