API lýsing · Gjafabréf

Sækja gjafabréf

GET/v1/giftcards/{id}

code fylgir aðeins fyrir lykla með giftcards:create.

Takmarkaflokkur
read
Auðkenning
Undirrituð

Færibreytur

  • idstringslóðskylda

    Byrjar á gc_. Dæmi: gc_01JB8X2Q4M7Z3V9K5T1N6R0P2W.

Svör

200 OK

Gjafabréfið. application/json · Giftcard

  • 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

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

Villur

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

StaðaKóðiMerking
400invalid_requestBeiðnin er gölluð: ógilt JSON, óþekktur eða ógildur reitur, eða haus vantar.
401invalid_signatureMK-* hausana vantar eða þeir eru gallaðir, auðkenni lykilsins er óþekkt eða undirskriftin passar ekki.
401key_expiredGildistími lykilsins er liðinn.
401key_revokedLykillinn var afturkallaður.
401timestamp_out_of_rangeMK-Timestamp munar meira en 30 sekúndum frá klukku netþjónsins.
401nonce_reusedÞessi lykill hefur þegar notað þetta MK-Nonce.
403ip_not_allowedBeiðnin kom frá IP tölu sem er ekki meðal leyfðra IP talna lykilsins.
403insufficient_scopeLykilinn vantar heimildina sem þessi endapunktur þarf.
403account_restrictedAðgangurinn getur ekki notað API-ið eins og er (til dæmis læstur, óvirkur eða nýskráningu ólokið).
403api_access_disabledSlökkt er á aðgangi að API-inu.
404not_foundÞetta fannst ekki.
429rate_limitedOf margar beiðnir. Bíddu í Retry-After sekúndur.
429too_many_concurrent_requestsOf margar beiðnir í vinnslu í einu fyrir þennan lykil eða aðgang.
429key_suspendedLykillinn er stöðvaður, til dæmis eftir að hafa farið ítrekað yfir beiðnatakmörk.
500internal_errorEitthvað fór úrskeiðis hjá okkur.
502bad_gatewayUndirliggjandi þjónusta svaraði á óvæntan hátt.
503overloadedÞjónustan er undir of miklu álagi. Reyndu aftur eftir Retry-After sekúndur.
503service_unavailableÞjónustan er tímabundið ekki tiltæk.
504gateway_timeoutUndirliggjandi þjónusta svaraði ekki í tæka tíð. POST beiðni gæti samt klárast; reyndu aftur með sama Idempotency-Key.

Beiðni

# Signed by sign-headers.sh: see Authentication
curl https://public-api.myntkaup.is/v1/giftcards/gc_01JB8X2Q4M7Z3V9K5T1N6R0P2W \
  $(./sign-headers.sh GET /v1/giftcards/gc_01JB8X2Q4M7Z3V9K5T1N6R0P2W | sed 's/^/-H /')
import { Myntkaup } from "@myntkaup/api";

const client = new Myntkaup(); // reads the key from the environment
const card = await client.giftcards.get("gc_01JB8X2Q4M7Z3V9K5T1N6R0P2W");
console.log(card.status, card.redeemed_at);
from myntkaup import Myntkaup

client = Myntkaup()  # reads the key from the environment
card = client.giftcards.get("gc_01JB8X2Q4M7Z3V9K5T1N6R0P2W")
print(card["status"], card["redeemed_at"])

Svar

200 OK
{
  "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
}

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