İç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.
POST/reseller/codes/{uuid}/cancel

Cancel my gift code

Cancels an unredeemed reseller code within the window after issue (reseller_cancel_window_minutes from the settings); the cost returns to the reseller balance. Outside the window — 409 gift_code_cancel_window_expired; already redeemed or cancelled — 409 gift_code_not_cancellable. Key permission: reseller.write.

reseller.write
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.

POSThttps://api.lumean.app/api/public/reseller/codes//cancel
  • stringyoldazorunlu

    Gift code UUID — 36 characters, not the LUM-… code itself.

    Take it from the uuid field: POST /reseller/codes returns it on issue and GET /reseller/codes lists it. Someone else's or a missing code returns 404 with reason: gift_code_not_found.

    Değer doğrudan yukarıdaki istek satırına yerleşir.

Olası yanıtlar

200

Success. The payload is in data.

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

The response payload.

GiftCodeGiftCode
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

İlgili içerik

Nesneler

Bu sayfayı yapay zekâya verin

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

spesifikasyon 0.0.1