API: Gutscheine | Kuvert-Dokumentation

Eine Stornierung kann nicht rückgängig gemacht werden. Es gibt keine Reaktivierung, weil eine Karte, die beendet und später stillschweigend wiederbelebt wurde, eine Verbindlichkeit ist, der niemand zugestimmt hat. Erstatten ist der einzige Endpunkt, der Geld bewegt: Stripe schickt den Betrag an die Karte zurück, mit der bezahlt wurde, und nirgendwo sonst hin.

Probieren Sie es hier auf der Seite aus

Die untenstehende Konsole führt dieselben Schemata und dieselbe Einlösungsregel wie die API aus, für eine Karte, die nur in Ihrem Browser existiert. Bearbeiten Sie den Body und sehen Sie, welchen Status Ihr eigener Aufruf bekommen würde.

Die Konsole

Gutschein: KUV-DLT2-9GPW
Guthaben: 500,00 DKK
Status: active

Anfrage

GET /v1/api/giftcards/KUV-DLT2-9GPW

Authorization: Bearer pk_test_…

Kein Text. Der Code ist im Pfad.

Antwort

200 OK

{
  "giftCard": {
    "id": "gc_3n8qk2vh",
    "code": "KUV-DLT2-9GPW",
    "orderId": null,
    "status": "active",
    "initialOre": 50000,
    "balanceOre": 50000,
    "expiresAt": "2029-01-15T12:00:00.000Z",
    "merchantSlug": "cafe-noir",
    "origin": "b2b",
    "reference": "Faktura 2026-114",
    "punchValueOre": null,
    "noCashClaim": false,
    "productName": null
  }
}

Das Guthaben wird aus den Buchungen berechnet, statt aus einem Feld gelesen zu werden. Deshalb stimmt es immer mit den Einlösungen überein.

Die Konsole nimmt keine Verbindung ins Internet auf. Sie führt die gleichen Schemata und die gleiche Einlösungsregel wie die API aus, gegen einen Gutschein, den es nur in Ihrem Browser gibt. Statuscodes und Fehlertexte sind daher die, die Ihre eigene Integration bekommt.

Idempotenz

Ausstellen und Einlösen können beide einen Schlüssel tragen, der den Aufruf sicher wiederholbar macht. Derselbe Schlüssel zweimal liefert das Ergebnis des ERSTEN Aufrufs (dieselbe Karte, dieselbe Buchung), statt zweimal auszustellen oder abzuziehen. Die beiden Verben erkennen jedoch nicht dasselbe: Beim EINLÖSEN antworten wir 409 idempotency_key_conflict, wenn der Schlüssel bereits für eine andere Karte oder für eine Auszahlung verwendet wurde, statt das Falsche zu treffen. Beim AUSSTELLEN vergleichen wir den Aufruf nicht. Verwenden Sie einen Schlüssel mit einem anderen Betrag erneut, erhalten Sie 201 und die Daten der ERSTEN Karte zurück, ohne Fehler. Verwenden Sie einen Schlüssel pro Karte.

Der Schlüssel kann an drei Stellen stehen. Wir lesen idempotencyKey zuerst im Body, sonst den Header Idempotency-Key und dann X-Request-Guid. Der Body gewinnt, wenn beides vorhanden ist.

Wo	Name
Body	`idempotencyKey`: die ausdrückliche Wahl, und die, die gewinnt.
Header	`Idempotency-Key`: der Name, den Stripe zum Standard gemacht hat.
Header	`X-Request-Guid`, damit eine Integration, die von Lifepeaks wechselt, ohne Umschreiben funktioniert.

Karte ausgeben

POST/v1/api/giftcards

Stellt eine Karte außerhalb des Zahlungsablaufs aus, etwa verkauft über Ihr eigenes System, einem Unternehmen in Rechnung gestellt oder aufs Haus gegeben.

origin ist hier erforderlich, wo es im Dashboard optional ist. Ein System gibt aus, ohne dass jemand zuschaut, und die Wahl begleitet die Karte den Rest ihres Lebens: sold bedeutet, dass ein Kunde dafür bezahlt hat, und dann trägt die Karte das Recht des Kunden, das Restguthaben in bar ausbezahlt zu bekommen. b2b und comp tun das nicht.

curl -X POST https://api.kuvert.dk/v1/api/giftcards \
  -H "Authorization: Bearer $KUVERT_API_KEY" \
  -H "Content-Type: application/json" \
  -d '{
    "amountOre": 50000,
    "origin": "b2b",
    "reference": "Faktura 2026-114",
    "idempotencyKey": "faktura-2026-114"
  }'

201 CreatedJSON

{
  "giftCard": {
    "id": "gc_4f1c9a2e7b3d48e6a0c5d9f2b8e1a7c3",
    "code": "KUV-7K9F-2XQD",
    "orderId": null,
    "status": "active",
    "initialOre": 50000,
    "balanceOre": 50000,
    "expiresAt": "2029-09-29T08:00:00.000Z",
    "merchantSlug": "cafe-noir",
    "origin": "b2b",
    "reference": "Faktura 2026-114",
    "punchValueOre": null,
    "noCashClaim": false,
    "productName": null
  }
}

In der Konsole ausprobieren

Body

amountOreintegerErforderlich: Der Wert der Karte in Øre, mindestens 1 Øre und höchstens 100.000,00 DKK.
origin"sold" | "b2b" | "comp"Erforderlich: sold: Ein Kunde hat bezahlt. b2b: an ein Unternehmen fakturiert. comp: aufs Haus.
validityMonthsintegerOptional: Gültigkeit in Monaten, mindestens 36 und höchstens 600. Fehlt sie, gilt die Karte 36.
referencestring | nullOptional: Ihre eigene Notiz, z. B. eine Rechnungsnummer. Höchstens 200 Zeichen.
noCashClaimbooleanOptional: Kennzeichnet die Karte als «nicht in bar umtauschbar», zum Beispiel wenn sie für eine bestimmte Sache gilt. Das allein macht ein Mitarbeitergeschenk nicht steuerfrei: SKAT, die dänische Steuerbehörde, behandelt digitale Gutscheine als steuerpflichtig. Nur bei b2b und comp.
idempotencyKeystringOptional: Derselbe Schlüssel zweimal stellt nur eine Karte aus. Höchstens 120 Zeichen. Kann auch als Header gesendet werden (siehe Idempotenz).

Antwortfelder

Die Karte steht unter giftCard, in derselben Form wie bei Karte nachschlagen, wo die Felder beschrieben sind.

Statuscodes

201
Die Karte ist ausgestellt. Mit einem bereits verwendeten idempotencyKey ist die Antwort die Karte, die dieser Schlüssel beim ersten Mal ausgestellt hat.
400invalid_issue_request
Der Textteil entspricht nicht dem, was die Ausstellung erfordert.
404merchant_not_found
Der Schlüssel ist gültig, aber das Unternehmen dahinter existiert nicht mehr. Das kommt selten vor und kann von keinem Client behoben werden. Kontaktieren Sie uns.
409cash_claim_cannot_be_denied
noCashClaim auf einer sold-Karte. Der Kunde hat bezahlt, und das Recht auf Auszahlung des Restguthabens kann ein Flag nicht aufheben.

Ein Fehler hat immer die Form { "error": "…" }. Jeder Aufruf kann außerdem mit 401, 403, 429 und 500 antworten. Siehe Fehler.

Karten auflisten

GET/v1/api/giftcards

Alle Karten des Unternehmens, die neueste zuerst, mit dem Guthaben, im selben Moment aus den Buchungen berechnet. Die Liste ist nicht paginiert.

curl https://api.kuvert.dk/v1/api/giftcards \
  -H "Authorization: Bearer $KUVERT_API_KEY"

200 OKJSON

{
  "giftCards": [
    {
      "id": "gc_4f1c9a2e7b3d48e6a0c5d9f2b8e1a7c3",
      "code": "KUV-7K9F-2XQD",
      "orderId": null,
      "status": "active",
      "initialOre": 50000,
      "balanceOre": 50000,
      "expiresAt": "2029-09-29T08:00:00.000Z",
      "merchantSlug": "cafe-noir",
      "origin": "b2b",
      "reference": "Faktura 2026-114",
      "punchValueOre": null,
      "noCashClaim": false,
      "productName": null
    },
    {
      "id": "gc_9b2e61d04c7f4a3e8d5b1c6a0f2e9d47",
      "code": "KUV-M4TQ-8WZR",
      "orderId": "ord_7d3f0b9c1e2a45f68b4c9d0e1f2a3b5c",
      "status": "active",
      "initialOre": 50000,
      "balanceOre": 43600,
      "expiresAt": "2029-06-12T14:31:07.000Z",
      "merchantSlug": "cafe-noir",
      "origin": "paid",
      "reference": null,
      "punchValueOre": null,
      "noCashClaim": false,
      "productName": "Gavekort"
    }
  ]
}

Antwortfelder

Die Karten stehen unter giftCards, jede in derselben Form wie bei Karte nachschlagen.

Statuscodes

200
Die Liste, gegebenenfalls leer.

Ein Fehler hat immer die Form { "error": "…" }. Jeder Aufruf kann außerdem mit 401, 403, 429 und 500 antworten. Siehe Fehler.

Oft zusammen verwendet mit

GETKarte nachschlagen
POSTKarte ausgeben

Karte nachschlagen

GET/v1/api/giftcards/{code}

Eine Karte anhand ihres Codes, mit dem Guthaben, wie es gerade steht.

curl https://api.kuvert.dk/v1/api/giftcards/KUV-7K9F-2XQD \
  -H "Authorization: Bearer $KUVERT_API_KEY"

200 OKJSON

{
  "giftCard": {
    "id": "gc_4f1c9a2e7b3d48e6a0c5d9f2b8e1a7c3",
    "code": "KUV-7K9F-2XQD",
    "orderId": null,
    "status": "active",
    "initialOre": 50000,
    "balanceOre": 50000,
    "expiresAt": "2029-09-29T08:00:00.000Z",
    "merchantSlug": "cafe-noir",
    "origin": "b2b",
    "reference": "Faktura 2026-114",
    "punchValueOre": null,
    "noCashClaim": false,
    "productName": null
  }
}

In der Konsole ausprobieren

Pfadparameter

codestringErforderlich: Der Code der Karte, z. B. KUV-7K9F-2XQD.

Antwortfelder

Die Karte steht unter giftCard:

idstring: Die ID der Karte (gc_…). Nachgeschlagen wird mit dem Code.
codestring: Der Code, der auf der Karte steht.
orderIdstring | null: Die Bestellung, aus der die Karte stammt. null bei einer Karte, die von Hand oder über die API ausgegeben wurde.
status"active" | "redeemed" | "expired" | "void" | "disputed": Der Zustand der Karte. Nur active kann eingelöst werden.
initialOreinteger: Der Wert der Karte in Ore, bevor etwas eingelöst wurde.
balanceOreinteger: Das Guthaben in Øre, aus den Buchungen berechnet und nicht aus einem Feld gelesen.
expiresAtstring: Wann die Karte abläuft, ISO 8601 in UTC.
merchantSlugstring: Die Adresse des Shops auf shop.kuvert.dk.
origin"paid" | "sold" | "b2b" | "corporate" | "comp": Woher der Wert stammt. paid wurde im Shop gekauft und corporate als Firmengeschenk gekauft; sold, b2b und comp wurden von Hand oder über die API ausgegeben.
referencestring | null: Ihre eigene Notiz aus der Ausgabe. null bei einer gekauften Karte.
punchValueOreinteger | null: Der Wert eines Stempels, wenn die Karte eine Stempelkarte ist, sonst null. Eine Stempelkarte wird in ganzen Stempeln eingelöst.
noCashClaimboolean: Die Karte kann nicht in bar umgetauscht werden.
productNamestring | null: Der Name des Produkts, wie er bei der Ausgabe der Karte lautete. null bei einer von Hand ausgegebenen Karte.

Statuscodes

200
Die Karte.
400not_a_gift_card
Der Code im Pfad ist ein Ticketcode (TKT-…), kein Gutschein.
404gift_card_not_found
Der Code wird in Ihrem Unternehmen nicht gefunden.

Ein Fehler hat immer die Form { "error": "…" }. Jeder Aufruf kann außerdem mit 401, 403, 429 und 500 antworten. Siehe Fehler.

Oft zusammen verwendet mit

POSTEinlösen
GETKarten auflisten
POSTKarte erneut senden

Einlösen

POST/v1/api/giftcards/{code}/redeem

Zieht einen Betrag vom Guthaben der Karte ab. Der Code steht im Pfad, der Betrag im Body.

Speichern Sie id. Es ist die Buchung und das Einzige, das diese spezifische Einlösung rückgängig machen kann.

Wenn es nicht funktioniert, ist die Antwort eine davon. Sie sind für das Kassenterminal nicht gleich: einige sind etwas, das der Gast wissen sollte, und einige sind etwas, für das das Unternehmen angerufen werden sollte.

curl -X POST https://api.kuvert.dk/v1/api/giftcards/KUV-7K9F-2XQD/redeem \
  -H "Authorization: Bearer $KUVERT_API_KEY" \
  -H "Content-Type: application/json" \
  -d '{
    "amountOre": 6400,
    "location": "Vesterbro",
    "idempotencyKey": "pos-3-20260929-0142"
  }'

200 OKJSON

{
  "id": "red_8f21c0b45d3e4a9b8c7d6e5f4a3b2c1d",
  "code": "KUV-7K9F-2XQD",
  "amountOre": 6400,
  "remainingBalanceOre": 43600,
  "status": "active"
}

In der Konsole ausprobieren

Pfadparameter

codestringErforderlich: Der Code der Karte, z. B. KUV-7K9F-2XQD.

Body

amountOreintegerErforderlich: Der Betrag in Ore, mindestens 1. Eine Stempelkarte nimmt nur eine ganze Zahl von Stempeln.
locationstring | nullOptional: Wo es geschah, z. B. «Vesterbro». Höchstens 120 Zeichen.
idempotencyKeystringOptional: Derselbe Schlüssel zweimal zieht nur einmal ab. Höchstens 120 Zeichen. Kann auch als Header gesendet werden (siehe Idempotenz).

Antwortfelder

Die Antwort ist die Buchung:

idstring: Die ID der Buchung (red_…), mit der Sie sie rückgängig machen.
codestring: Der Code der Karte.
amountOreinteger: Der abgezogene Betrag in Ore.
remainingBalanceOreinteger: Das Guthaben nach der Einlösung.
status"active" | "redeemed" | "expired" | "void" | "disputed": status ist der Zustand der Karte nach der Einlösung, einer von active, redeemed, expired, void, disputed. Ist das Guthaben aufgebraucht, wechselt er zu redeemed.

Statuscodes

200
Der Betrag ist abgezogen. Mit einem idempotencyKey, der schon einmal für dieselbe Karte verwendet wurde, ist die Antwort die vom ersten Mal, ohne dass erneut abgezogen wird.
400invalid_redeem_request
Der Body entspricht nicht dem, was die Einlösung verlangt, typischerweise ein Betrag, der keine ganze Zahl von Øre ist oder null ist.
400not_a_gift_card
Der Code im Pfad ist ein Ticketcode (TKT-…), kein Gutschein.
404gift_card_not_found
Der Code wird in Ihrem Unternehmen nicht gefunden.
409card_inactive
Die Karte ist nicht aktiv: aufgebraucht, storniert, auf abgelaufen gesetzt oder während eines Zahlungseinspruchs eingefroren. Das erledigt sich nicht von selbst, das Unternehmen muss also kontaktiert werden.
409redeem_too_soon
Das Unternehmen hat eine Einlösungsverzögerung eingestellt, und sie ist noch nicht abgelaufen. Die Karte funktioniert einwandfrei; sie kann nur noch nicht verwendet werden. Versuchen Sie es später erneut.
409idempotency_key_conflict
Der Schlüssel wurde bereits für eine andere Karte oder für eine Auszahlung derselben Karte verwendet. Siehe Idempotenz.
410gift_card_expired
Die Karte ist noch als aktiv eingestuft, aber das Gültigkeitsdatum ist verstrichen. Im Gegensatz zu card_inactive war es die Zeit und nicht eine Entscheidung, die die Karte geschlossen hat.
422insufficient_balance
Der Betrag ist höher als das Guthaben. Wir ziehen nie von uns aus einen Teilbetrag ab. Fragen Sie die Karte ab, ziehen Sie das Guthaben ab und nehmen Sie den Rest auf andere Weise.
422invalid_amount
Die eigene Antwort der Einlösungsregel auf einen illegalen Betrag. Das Schema erfasst es normalerweise bereits als 400 invalid_redeem_request, daher sollte ein Client beide lesen können.
422punch_amount_not_whole
Die Karte ist eine Stempelkarte, und der Betrag ist keine ganze Zahl von Stempeln. Mit der Zahl ist nichts falsch, aber es ist die falsche Art Karte dafür. Fragen Sie die Karte ab, lesen Sie punchValueOre und senden Sie diesen Wert oder ein Vielfaches davon. Eine Stempelkarte, auf der ein Rest unter einem Stempel übrig bleibt, ist Geld, an das weder die Kasse noch der Kunde herankommt.

Ein Fehler hat immer die Form { "error": "…" }. Jeder Aufruf kann außerdem mit 401, 403, 429 und 500 antworten. Siehe Fehler.

Oft zusammen verwendet mit

GETKarte nachschlagen
POSTEinlösung rückgängig machen

Einlösung rückgängig machen

POST/v1/api/redemptions/{id}/reverse

Bucht den Betrag auf die Karte zurück. Das geschieht als neue Buchung mit negativem Betrag, die auf die Buchung verweist, die sie rückgängig macht. Nichts wird gelöscht, und beide Zeilen bleiben in der Historie der Karte stehen. War die Karte vollständig aufgebraucht, wird sie wieder aktiv.

curl -X POST https://api.kuvert.dk/v1/api/redemptions/red_8f21c0b45d3e4a9b8c7d6e5f4a3b2c1d/reverse \
  -H "Authorization: Bearer $KUVERT_API_KEY"

200 OKJSON

{
  "id": "red_2c77af90e1d24b3c9a8f7e6d5c4b3a21",
  "code": "KUV-7K9F-2XQD",
  "amountOre": -6400,
  "remainingBalanceOre": 50000,
  "status": "active"
}

Pfadparameter

idstringErforderlich: Die ID der Einlösung (red_…), die Sie von Einlösen zurückbekommen haben.

Antwortfelder

Die Antwort ist die Buchung, die den Betrag zurückgebucht hat, in derselben Form wie bei Einlösen, mit negativem amountOre.

Statuscodes

200
Der Betrag ist zurückgelegt.
404redemption_not_found
Die Buchung wird in Ihrem Unternehmen nicht gefunden.
409already_reversed
Es wurde bereits rückgängig gemacht. Einmal, niemals zweimal.
409not_reversible
Die Buchung selbst ist eine Rückgängigmachung oder eine Barauszahlung.
409card_inactive
Die Karte ist storniert oder während einer Anfechtung eingefroren.
409order_refunded
Die Bestellung hinter der Karte wurde erstattet. Der Käufer hat das Geld bereits zurückbekommen, daher würde eine Rückgängigmachung ihm den Wert zweimal geben.

Ein Fehler hat immer die Form { "error": "…" }. Jeder Aufruf kann außerdem mit 401, 403, 429 und 500 antworten. Siehe Fehler.

Oft zusammen verwendet mit

POSTEinlösen
GETKarte nachschlagen

Karte erneut senden

POST/v1/api/giftcards/{code}/resend

Sendet die Karte erneut an den Empfänger. Das macht eine Kasse, wenn ein Kunde sagt, dass die E-Mail nie angekommen ist.

Ohne recipient senden wir das, was aus der Bestellung der Karte noch nicht zugestellt wurde, an die hinterlegte Adresse. Eine bereits zugestellte Karte wird nicht erneut gesendet. Mit recipient korrigieren Sie die Adresse genau dieser Karte und senden sie dorthin, auch wenn sie schon einmal zugestellt wurde. Nur aktive Karten werden gesendet.

curl -X POST https://api.kuvert.dk/v1/api/giftcards/KUV-M4TQ-8WZR/resend \
  -H "Authorization: Bearer $KUVERT_API_KEY" \
  -H "Content-Type: application/json" \
  -d '{
    "recipient": "ny-adresse@dit-domaene.dk"
  }'

200 OKJSON

{
  "delivered": 1
}

Pfadparameter

codestringErforderlich: Der Code der Karte, z. B. KUV-7K9F-2XQD.

Body

recipientstringOptional: Eine neue E-Mail-Adresse für die Karte. Der Body kann ganz entfallen.

Antwortfelder

Die Antwort sagt, wie viel gesendet wurde:

deliveredinteger: Anzahl der gesendeten Karten. 0 bedeutet, dass es nichts zu senden gab.

Statuscodes

200
Gesendet, oder nichts zu senden.
400not_a_gift_card
Der Code im Pfad ist ein Ticketcode (TKT-…), kein Gutschein.
404gift_card_not_found
Der Code wird in Ihrem Unternehmen nicht gefunden.
404order_not_found
Resend hat die Karte gefunden, aber nicht die Bestellung, aus der sie stammt. Eine manuell ausgegebene Karte hat keine Bestellung und kann daher nicht auf diese Weise erneut gesendet werden.
409card_has_no_delivery
Die Karte wurde nie von uns versendet, denn sie wurde an der Kasse ausgehändigt. Es gibt keine Zustellung, die wiederholt werden könnte.
422invalid_recipient
recipient im Body von Resend ist keine E-Mail-Adresse, an die wir senden können. Lassen Sie das Feld weg, um an die Adresse zu senden, die die Karte bereits hat.
502delivery_failed
Wir haben unseren Anbieter erreicht, und er hat den Versand abgelehnt. Mit der Karte ist alles in Ordnung, und es wurde nichts abgezogen. Versuchen Sie es erneut oder prüfen Sie die Adresse.

Ein Fehler hat immer die Form { "error": "…" }. Jeder Aufruf kann außerdem mit 401, 403, 429 und 500 antworten. Siehe Fehler.

Oft zusammen verwendet mit

GETKarte nachschlagen

Karte stornieren

POST/v1/api/giftcards/{code}/cancel

Storniert die Karte sofort. Das Guthaben bleibt auf der Karte stehen, kann aber nicht mehr verwendet werden, und das lässt sich nicht rückgängig machen. Ist die Karte bereits storniert, erhalten Sie sie unverändert zurück, ohne Fehler.

curl -X POST https://api.kuvert.dk/v1/api/giftcards/KUV-7K9F-2XQD/cancel \
  -H "Authorization: Bearer $KUVERT_API_KEY"

200 OKJSON

{
  "giftCard": {
    "id": "gc_4f1c9a2e7b3d48e6a0c5d9f2b8e1a7c3",
    "code": "KUV-7K9F-2XQD",
    "orderId": null,
    "status": "void",
    "initialOre": 50000,
    "balanceOre": 50000,
    "expiresAt": "2029-09-29T08:00:00.000Z",
    "merchantSlug": "cafe-noir",
    "origin": "b2b",
    "reference": "Faktura 2026-114",
    "punchValueOre": null,
    "noCashClaim": false,
    "productName": null
  }
}

Pfadparameter

codestringErforderlich: Der Code der Karte, z. B. KUV-7K9F-2XQD.

Antwortfelder

Die Karte steht unter giftCard, jetzt mit status void.

Statuscodes

200
Die Karte ist storniert, oder sie war es bereits.
400not_a_gift_card
Der Code im Pfad ist ein Ticketcode (TKT-…), kein Gutschein.
404gift_card_not_found
Der Code wird in Ihrem Unternehmen nicht gefunden.

Ein Fehler hat immer die Form { "error": "…" }. Jeder Aufruf kann außerdem mit 401, 403, 429 und 500 antworten. Siehe Fehler.

Oft zusammen verwendet mit

GETKarte nachschlagen
POSTBestellung erstatten

Bestellung erstatten

POST/v1/api/orders/{id}/refund

Schickt die gesamte Zahlung für die Bestellung an die Karte zurück, mit der bezahlt wurde, einschließlich der Bearbeitungsgebühr des Käufers, und die Gebühr von Kuvert auf den Verkauf geht an Sie zurück. Das ist der einzige Endpunkt, der Geld bewegt.

Sobald Stripe die Erstattung bestätigt hat, wird der Wert von den Karten der Bestellung genommen, ihre Tickets werden storniert, und order.refunded wird gesendet. Das geschieht meist wenige Sekunden nach der Antwort.

Der Aufruf nimmt keinen Idempotenzschlüssel an, weil der Status der Bestellung selbst die Sperre ist. Eine bereits erstattete Bestellung ergibt 409 order_not_refundable.

curl -X POST https://api.kuvert.dk/v1/api/orders/ord_7d3f0b9c1e2a45f68b4c9d0e1f2a3b5c/refund \
  -H "Authorization: Bearer $KUVERT_API_KEY"

200 OKJSON

{
  "orderId": "ord_7d3f0b9c1e2a45f68b4c9d0e1f2a3b5c",
  "refundId": "re_3PqX9aLkT2mN8vRb1c4D7eFg",
  "amountOre": 50500
}

Pfadparameter

idstringErforderlich: Die ID der Bestellung (ord_…): orderId auf der Karte oder in order.paid.

Antwortfelder

Die Antwort ist die Erstattung, wie Stripe sie angenommen hat:

orderIdstring: Die Bestellung.
refundIdstring: Die ID der Erstattung bei Stripe (re_…), unter der Sie sie in Stripe finden.
amountOreinteger: Der zurückgesendete Betrag in Ore.

Statuscodes

200
Stripe hat die Erstattung angenommen.
404order_not_found
Die Bestellung existiert in Ihrem Unternehmen nicht.
409order_not_refundable
Die Bestellung kann nicht erstattet werden: Sie ist nicht bezahlt, bereits erstattet oder während eines Widerspruchs eingefroren.
409merchant_not_payment_ready
Ihr Stripe-Konto ist nicht verbunden.
503stripe_not_configured
Zahlungen sind bei uns vorübergehend nicht verfügbar. Versuchen Sie es später erneut.

Ein Fehler hat immer die Form { "error": "…" }. Jeder Aufruf kann außerdem mit 401, 403, 429 und 500 antworten. Siehe Fehler.

Oft zusammen verwendet mit

GETKarte nachschlagen
POSTKarte stornieren

War diese Seite hilfreich?