Listi yfir gjafabréf · Myntkaup API

Gjafabréf sem aðgangurinn hefur búið til. code fylgir aðeins fyrir lykla með giftcards:create.

Heimild: transactions:read
Takmarkaflokkur: read
Auðkenning: Undirrituð

Færibreytur

statusstring (enum)fyrirspurnvalfrjálst
Eitt af unredeemed, redeemed.
fromstring (date-time)fyrirspurnvalfrjálst
tostring (date-time)fyrirspurnvalfrjálst
limitintegerfyrirspurnvalfrjálst
Stærð síðu, 1 til 100. Sjálfgefið 50.
1 til 100.
cursorstringfyrirspurnvalfrjálst
next_cursor af fyrri síðu.
Passar við ^[A-Za-z0-9._~=+/-]{1,512}$.

Svör

200 OK

Síða af gjafabréfum. application/json · GiftcardList

datafylki af Giftcard
9 reitir í hverju staki
- idstring
  Byrjar á gc_.
- assetstring
  Tákn rafmyntar, í hástöfum.
  Passar við ^[A-Z0-9]{1,15}$.
- amountstring (tugatala)
- recipient_namestring | null
- statusstring (enum)
  Eitt af unredeemed, redeemed.
- codestringgetur vantað
  Aðeins fyrir lykla sem hafa líka giftcards:create. Farðu með hann eins og reiðufé.
- sourcestring (enum)
  Hvar færslan varð til: í þessu API, í appinu eða í vefappinu.
  Eitt af public_api, app, web.
- created_atstring (date-time)
- redeemed_atstring (date-time)getur verið null
next_cursorstringgetur verið null
Sendu sem cursor fyrir næstu síðu; null á síðustu síðunni.
0 til 1024 stafir.

Öll svör bera MK-Request-Id, auk RateLimit-Policy og RateLimit.

Villur

Villur nota villuumslagið. Greindu þær eftir code.

Staða	Kóði	Merking
400	`invalid_request`	Beiðnin er gölluð: ógilt JSON, óþekktur eða ógildur reitur, eða haus vantar.
401	`invalid_signature`	`MK-*` hausana vantar eða þeir eru gallaðir, auðkenni lykilsins er óþekkt eða undirskriftin passar ekki.
401	`key_expired`	Gildistími lykilsins er liðinn.
401	`key_revoked`	Lykillinn var afturkallaður.
401	`timestamp_out_of_range`	`MK-Timestamp` munar meira en 30 sekúndum frá klukku netþjónsins.
401	`nonce_reused`	Þessi lykill hefur þegar notað þetta `MK-Nonce`.
403	`ip_not_allowed`	Beiðnin kom frá IP tölu sem er ekki meðal leyfðra IP talna lykilsins.
403	`insufficient_scope`	Lykilinn vantar heimildina sem þessi endapunktur þarf.
403	`account_restricted`	Aðgangurinn getur ekki notað API-ið eins og er (til dæmis læstur, óvirkur eða nýskráningu ólokið).
403	`api_access_disabled`	Slökkt er á aðgangi að API-inu.
429	`rate_limited`	Of margar beiðnir. Bíddu í `Retry-After` sekúndur.
429	`too_many_concurrent_requests`	Of margar beiðnir í vinnslu í einu fyrir þennan lykil eða aðgang.
429	`key_suspended`	Lykillinn er stöðvaður, til dæmis eftir að hafa farið ítrekað yfir beiðnatakmörk.
500	`internal_error`	Eitthvað fór úrskeiðis hjá okkur.
502	`bad_gateway`	Undirliggjandi þjónusta svaraði á óvæntan hátt.
503	`overloaded`	Þjónustan er undir of miklu álagi. Reyndu aftur eftir `Retry-After` sekúndur.
503	`service_unavailable`	Þjónustan er tímabundið ekki tiltæk.
504	`gateway_timeout`	Undirliggjandi þjónusta svaraði ekki í tæka tíð. `POST` beiðni gæti samt klárast; reyndu aftur með sama `Idempotency-Key`.

# Signed by sign-headers.sh: see Authentication
curl "https://public-api.myntkaup.is/v1/giftcards?status=unredeemed" \
  $(./sign-headers.sh GET "/v1/giftcards?status=unredeemed" | sed 's/^/-H /')

import { Myntkaup } from "@myntkaup/api";

const client = new Myntkaup(); // reads the key from the environment
const page = await client.giftcards.list({ status: "unredeemed" });
console.log(page.data.map((card) => card.id));

from myntkaup import Myntkaup

client = Myntkaup()  # reads the key from the environment
page = client.giftcards.list(status="unredeemed")
print([card["id"] for card in page["data"]])

200 OK

{
  "data": [
    {
      "id": "gc_01JB8X2Q4M7Z3V9K5T1N6R0P2W",
      "asset": "BTC",
      "amount": "0.0005",
      "recipient_name": "Anna",
      "status": "unredeemed",
      "code": "m-k3x9q2ab",
      "source": "public_api",
      "created_at": "2026-11-03T10:15:10Z",
      "redeemed_at": null
    }
  ],
  "next_cursor": "eyJpZCI6IjY3MjdhMWMzIn0"
}

Grunnslóð https://public-api.myntkaup.is