Zum Inhalt
Lumean API

Beschreibungen auf Englisch

Die Oberfläche des Bereichs ist in Ihre Sprache übersetzt, Beschreibungen von Operationen, Schemata und Fehlern gibt es aber nur auf Russisch und Englisch — hier wird die englische Fassung angezeigt.
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.

Auf dieser Seite(3)

Parameter

Die Eingabefelder liegen direkt in der Anfragezeile: Wert eintragen und die URL ist fertig. Darunter stehen Typ, Pflichtangabe und erlaubte Werte jedes Parameters.

GEThttps://api.lumean.app/api/public/reseller/codes
  • integerin der Queryoptional≥ 1

    Page number, starting at 1.

  • integerin der Queryoptional1..100

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

  • GiftCodeStatusin der Queryoptional

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

    Zulässige Werte
  • GiftCodeSourcein der Queryoptional

    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.

    Zulässige Werte

Mögliche Antworten

200

Success. The payload is in data.

Beispiel für den Body
{
  "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
  }
}
Felder der Antwort
dataerforderlich

The response payload.

GiftCodeListGiftCodeList
itemserforderlich

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

array<GiftCode>GiftCode
Array-Element
uuiderforderlich

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

string
code_maskederforderlich

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

string
codeoptional

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
nominalerforderlich

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_formattederforderlich

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

number
costoptional

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

string
cost_formattedoptional

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

number
discount_bpsoptional

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
sourceerforderlich
string
fundingerforderlich
string
statuserforderlich
string
activatable_aterforderlich

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

string
redeemed_aterforderlich

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

string
cancelled_aterforderlich

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

string
created_aterforderlich

When the code was issued.

string
currency_asseterforderlich

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

object
codeerforderlich

Code of the asset the amounts are expressed in.

WerteLUMC
string
precisionerforderlich

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

integer
current_pageerforderlich

Current page number, starting from one.

integer
last_pageerforderlich

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

integer
per_pageerforderlich

Page size the server applied.

integer
totalerforderlich

Total number of records matching the filter.

integer
422

Validation error. Offending fields are listed in errors.

Diese Antwort analysieren
Beispiel für den Body
{
  "message": "string",
  "errors": {}
}
Felder der Antwort
messageerforderlich

Errors overview.

string
errorserforderlich

A detailed description of each field that failed validation.

object
*optional
beliebige Schlüssel
array<string>

Diese Seite einer KI geben

.md öffnenllm.md

Spezifikation 0.0.1