İçeriğe geç
Lumean API

Açıklamalar İngilizce

Bölümün arayüzü dilinize çevrildi, ancak işlem, şema ve hata açıklamaları yalnızca Rusça ve İngilizce mevcut — burada İngilizce sürüm gösteriliyor.
GET/reseller/codes

List my gift codes

Codes issued by the key owner, newest first, WITH the FULL code value. Filters status and source; page-based pagination (page, per_page up to 100). Key permission: reseller.read.

Bu sayfada(3)

Parametreler

Giriş alanları doğrudan istek satırında yer alır: bir değer girin, hazır URL'yi alın. Aşağıda her parametrenin türü, zorunlu olup olmadığı ve izin verilen değerleri var.

GEThttps://api.lumean.app/api/public/reseller/codes
  • integersorgudaisteğe bağlı≥ 1

    Page number, starting at 1.

  • integersorgudaisteğe bağlı1..100

    How many records to return per page. Pagination metadata sits next to items: current_page, last_page, per_page, total.

  • GiftCodeStatussorgudaisteğe bağlı

    Return only codes in this status. An unknown value returns 422.

    İzin verilen değerler
  • GiftCodeSourcesorgudaisteğe bağlı

    Return only codes of this source: reseller — issued by you from your balance, purchase — bought by you as an ordinary buyer. An unknown value returns 422.

    İzin verilen değerler

Olası yanıtlar

200

Success. The payload is in data.

Gövde örneği
{
  "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
  }
}
Yanıt alanları
datazorunlu

The response payload.

GiftCodeListGiftCodeList
itemszorunlu

Records on the current page, in the list’s sort order.

array<GiftCode>GiftCode
dizi öğesi
uuidzorunlu

Code UUID. Use it in the GET /reseller/codes/{uuid} and POST /reseller/codes/{uuid}/cancel paths.

string
code_maskedzorunlu

The code with a mask, LUM-****-****-XXXX: safe to show in a UI and to write to logs.

string
codeisteğe bağlı

The FULL code value — what the recipient types to redeem it. The reseller public API returns it in the list, on show and on issue. Treat it as a secret: whoever knows the code can redeem it.

string
nominalzorunlu

The code’s nominal value in minor LMC units: real = nominal / 10^currency_asset.precision. This is how much LMC the redeemer receives.

string
nominal_formattedzorunlu

The same nominal value in whole LMC — a number ready to display.

number
costisteğe bağlı

What the code cost the reseller after the discount, in minor LMC units. Present only for reseller codes (source: reseller).

string
cost_formattedisteğe bağlı

The same cost in whole LMC. Present only for reseller codes.

number
discount_bpsisteğe bağlı

The reseller’s discount at the moment of issue, in basis points (100 = 1%). A later change of the personal discount does not affect this code. Present only for reseller codes.

integer
sourcezorunlu
string
fundingzorunlu
string
statuszorunlu
string
activatable_atzorunlu

The moment from which the code can be redeemed; until then it is frozen. null means no restriction.

string
redeemed_atzorunlu

When the code was redeemed. null until it is. The API never reveals who redeemed it.

string
cancelled_atzorunlu

When the reseller cancelled the code. null if it was not cancelled.

string
created_atzorunlu

When the code was issued.

string
currency_assetzorunlu

The currency of the amounts in the response — LMC. Use precision to convert amounts in minor units into whole LMC.

object
codezorunlu

Code of the asset the amounts are expressed in.

DeğerlerLUMC
string
precisionzorunlu

How many decimals LMC has: real = value / 10^precision.

integer
current_pagezorunlu

Current page number, starting from one.

integer
last_pagezorunlu

Number of the last page. The walk is over once current_page equals last_page.

integer
per_pagezorunlu

Page size the server applied.

integer
totalzorunlu

Total number of records matching the filter.

integer
422

Validation error. Offending fields are listed in errors.

Bu yanıtı çözümle
Gövde örneği
{
  "message": "string",
  "errors": {}
}
Yanıt alanları
messagezorunlu

Errors overview.

string
errorszorunlu

A detailed description of each field that failed validation.

object
*isteğe bağlı
rastgele anahtarlar
array<string>

Bu sayfayı yapay zekâya verin

.md sürümünü açllm.md

spesifikasyon 0.0.1