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.
On this page(3)
Parameters
The inputs live inside the request line: fill in a value and you get a ready URL. Below are the type, whether it is required and the allowed values of every parameter.
- integerin queryoptional≥ 1
Page number, starting at
1. - integerin queryoptional1..100
How many records to return per page. Pagination metadata sits next to
items:current_page,last_page,per_page,total. - GiftCodeStatusin queryoptional
Return only codes in this status. An unknown value returns
422.Allowed values - GiftCodeSourcein 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 returns422.Allowed values
Possible responses
200Success. The payload is in data.
Success. The payload is in data.
{
"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
}
}datarequiredThe response payload.
GiftCodeListGiftCodeList
The response payload.
itemsrequiredRecords on the current page, in the list’s sort order.
array<GiftCode>GiftCode
Records on the current page, in the list’s sort order.
Code UUID. Use it in the GET /reseller/codes/{uuid} and POST /reseller/codes/{uuid}/cancel paths.
The code with a mask, LUM-****-****-XXXX: safe to show in a UI and to write to logs.
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.
The code’s nominal value in minor LMC units: real = nominal / 10^currency_asset.precision. This is how much LMC the redeemer receives.
The same nominal value in whole LMC — a number ready to display.
What the code cost the reseller after the discount, in minor LMC units. Present only for reseller codes (source: reseller).
The same cost in whole LMC. Present only for reseller codes.
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.
The moment from which the code can be redeemed; until then it is frozen. null means no restriction.
When the code was redeemed. null until it is. The API never reveals who redeemed it.
When the reseller cancelled the code. null if it was not cancelled.
When the code was issued.
currency_assetrequiredThe currency of the amounts in the response — LMC. Use precision to convert amounts in minor units into whole LMC.
object
The currency of the amounts in the response — LMC. Use precision to convert amounts in minor units into whole LMC.
Code of the asset the amounts are expressed in.
How many decimals LMC has: real = value / 10^precision.
Current page number, starting from one.
Number of the last page. The walk is over once current_page equals last_page.
Page size the server applied.
Total number of records matching the filter.
422Validation error. Offending fields are listed in errors.
Validation error. Offending fields are listed in errors.
{
"message": "string",
"errors": {}
}Errors overview.
errorsrequiredA detailed description of each field that failed validation.
object
A detailed description of each field that failed validation.
Nearby
The same in words
Objects
Neighbouring operations
Feed this page to an AI
spec 0.0.1