Skip to content
Lumean API
GET/reseller

Reseller profile

The reseller profile: status, personal discount, limits, balance (available, held, debt). Key permission: reseller.read.

reseller.read
On this page(2)

Possible responses

200

The reseller profile.

Body example
{
  "data": {
    "id": "string",
    "status": "string",
    "discount_bps": "string",
    "blocked_reason": "string",
    "approved_at": "string",
    "limits": "string",
    "balance": {
      "key": 1
    },
    "currency_asset": {
      "code": "string",
      "precision": 1
    }
  }
}
Response fields
datarequired

The response payload.

ResellerProfileResellerProfile
idrequired

Reseller ID.

string
statusrequired
string
discount_bpsrequired

The reseller’s personal discount on issued codes, in basis points: 100 = 1%. It sets the price of a code: cost = nominal × (1 − discount_bps / 10000).

string
blocked_reasonrequired

Why the account is blocked. null while it is not blocked.

string
approved_atrequired

When the reseller application was approved.

string
limitsoptional

Limits — personal when an administrator set them, otherwise the shared defaults: max_topup_rub is the ceiling of a single top-up in roubles, max_codes_per_issue is how many codes one POST /reseller/codes request may issue.

string
balanceoptional

The account balance. Every amount comes as a pair: in minor LMC units (available, held, debt, …; real = value / 10^currency_asset.precision) and <name>_formatted, the same amount in whole LMC. available is what sits on the account, held is frozen, debt is owed to the platform (the next top-up repays it), spendable is what can actually be spent on issuing (available minus the debt).

object
*optional
arbitrary keys
integer | number
currency_assetrequired

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

object
coderequired

Code of the asset the amounts are expressed in.

ValuesLUMC
string
precisionrequired

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

integer
404

not_reseller — the key owner has no reseller profile; gift_codes_disabled — the feature is switched off.

Analyse this response
Body example
{
  "success": false,
  "message": "Resource not found."
}
Response fields
successrequired

Always false in error responses.

boolean
messagerequired

Error text in the key's language (set through the X-Locale header).

string
reasonoptional

Machine-readable reason — present on business refusals (for example, invalid_order_status); other errors omit it. Branch on it, not on the message text.

string
error_codeoptional

The same machine-readable code as in reason — a second name for the field. Arrives together with reason; the values always match.

string

Nearby

Neighbouring operations

Feed this page to an AI

Open .mdllm.md

spec 0.0.1