API reference · Gift cards

Get a gift card

GET/v1/giftcards/{id}

code is included only for keys with giftcards:create.

Rate-limit class
read
Authentication
Signed

Parameters

  • idstringpathrequired

    Starts with gc_. Example: gc_01JB8X2Q4M7Z3V9K5T1N6R0P2W.

Responses

200 OK

The gift card. application/json · Giftcard

  • idstring

    Starts with gc_.

  • assetstring

    An upper-case asset symbol.

    Matches ^[A-Z0-9]{1,15}$.

  • amountstring (decimal)
  • recipient_namestring | null
  • statusstring (enum)

    One of unredeemed, redeemed.

  • codestringmay be absent

    Only for keys that also have giftcards:create. Treat it like cash.

  • sourcestring (enum)

    Where the record was made: this API, the mobile app or the webapp.

    One of public_api, app, web.

  • created_atstring (date-time)
  • redeemed_atstring (date-time)nullable

Every response carries MK-Request-Id, plus RateLimit-Policy and RateLimit.

Errors

Errors use the error envelope. Match on code.

StatusCodeMeaning
400invalid_requestThe request is malformed: bad JSON, an unknown or invalid field, or a missing header.
401invalid_signatureThe MK-* headers are missing or malformed, the key id is unknown, or the signature doesn't match.
401key_expiredThe key has passed its expiry date.
401key_revokedThe key was revoked.
401timestamp_out_of_rangeMK-Timestamp is more than 30 seconds from the server clock.
401nonce_reusedThis key already used this MK-Nonce.
403ip_not_allowedThe request came from an address outside the key's IP allowlist.
403insufficient_scopeThe key doesn't have the scope this endpoint needs.
403account_restrictedThe account can't use the API right now (for example locked, inactive, or onboarding not finished).
403api_access_disabledAPI access is switched off.
404not_foundNo such resource.
429rate_limitedToo many requests. Wait for Retry-After seconds.
429too_many_concurrent_requestsToo many requests in flight for this key or account.
429key_suspendedThe key is suspended, for example after sustained rate limiting.
500internal_errorSomething went wrong on our side.
502bad_gatewayAn upstream service answered unexpectedly.
503overloadedThe service is overloaded. Retry after Retry-After seconds.
503service_unavailableThe service is temporarily unavailable.
504gateway_timeoutAn upstream service didn't answer in time. A POST may still complete; retry with the same Idempotency-Key.

Request

# 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"])

Response

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
}

Base URL https://public-api.myntkaup.is