Gift card PDF · Myntkaup API

Scope: giftcards:create
Rate-limit class: read
Authentication: Signed

Parameters

idstringpathrequired
Starts with gc_. Example: gc_01JB8X2Q4M7Z3V9K5T1N6R0P2W.

Responses

200 OK

The printable gift card. application/pdf

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

Errors

Errors use the error envelope. Match on code.

Status	Code	Meaning
400	`invalid_request`	The request is malformed: bad JSON, an unknown or invalid field, or a missing header.
401	`invalid_signature`	The MK-* headers are missing or malformed, the key id is unknown, or the signature doesn't match.
401	`key_expired`	The key has passed its expiry date.
401	`key_revoked`	The key was revoked.
401	`timestamp_out_of_range`	MK-Timestamp is more than 30 seconds from the server clock.
401	`nonce_reused`	This key already used this MK-Nonce.
403	`ip_not_allowed`	The request came from an address outside the key's IP allowlist.
403	`insufficient_scope`	The key doesn't have the scope this endpoint needs.
403	`account_restricted`	The account can't use the API right now (for example locked, inactive, or onboarding not finished).
403	`api_access_disabled`	API access is switched off.
404	`not_found`	No such resource.
429	`rate_limited`	Too many requests. Wait for Retry-After seconds.
429	`too_many_concurrent_requests`	Too many requests in flight for this key or account.
429	`key_suspended`	The key is suspended, for example after sustained rate limiting.
500	`internal_error`	Something went wrong on our side.
502	`bad_gateway`	An upstream service answered unexpectedly.
503	`overloaded`	The service is overloaded. Retry after Retry-After seconds.
503	`service_unavailable`	The service is temporarily unavailable.
504	`gateway_timeout`	An upstream service didn't answer in time. A POST may still complete; retry with the same Idempotency-Key.

# Signed by sign-headers.sh: see Authentication
curl https://public-api.myntkaup.is/v1/giftcards/gc_01JB8X2Q4M7Z3V9K5T1N6R0P2W/pdf \
  $(./sign-headers.sh GET /v1/giftcards/gc_01JB8X2Q4M7Z3V9K5T1N6R0P2W/pdf | sed 's/^/-H /') \
  -o giftcard.pdf

import { writeFile } from "node:fs/promises";
import { Myntkaup } from "@myntkaup/api";

const client = new Myntkaup(); // reads the key from the environment
const pdf = await client.giftcards.pdf("gc_01JB8X2Q4M7Z3V9K5T1N6R0P2W"); // Uint8Array
await writeFile("giftcard.pdf", pdf);

from myntkaup import Myntkaup

client = Myntkaup()  # reads the key from the environment
pdf = client.giftcards.pdf("gc_01JB8X2Q4M7Z3V9K5T1N6R0P2W")  # bytes
with open("giftcard.pdf", "wb") as file:
    file.write(pdf)

application/pdf: the file itself.

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