Erstattungen

Cost+ unterstützt sowohl vollständige als auch teilweise Erstattungen bei abgeschlossenen Bestellungen. Erstattungen werden über die ursprünglich verwendete Zahlungsmethode der Transaktion verarbeitet.

Erstattung erstellen

Senden Sie einen POST-Request an /v1/orders/\{id\}/refunds/, um eine Erstattung für eine abgeschlossene Bestellung einzuleiten.

Request

{
  "amount": 100,
  "description": "Refund for item",
  "merchant_order_id": "refund-001"
}

Das Feld amount verwendet die Nebeneinheit ISO 4217 der Währung. Für EUR bedeutet die Rückerstattung von 1,00 EUR, dass amount auf 100 gesetzt wird. Um eine vollständige Rückerstattung zu veranlassen, verwenden Sie den gesamten Bestellbetrag.

Anfragefelder

Feld	Erforderlich	Beschreibung
`amount`	Ja	Rückerstattungsbetrag in der Nebeneinheit ISO 4217 der Währung
`description`	Nein	Grund für die Erstattung
`merchant_order_id`	Nein	Ihre eigene Referenz-ID für die Erstattung
`extra`	Nein	Zusätzliche Metadaten als Schlüssel-Wert-Objekt

Antwort

Die API gibt das Erstattungsobjekt mit seinem aktuellen Status zurück:

{
  "id": "ref_abc123...",
  "created": "2024-01-02T10:00:00.000000+00:00",
  "modified": "2024-01-02T10:00:00.000000+00:00",
  "amount": 100,
  "currency": "EUR",
  "status": "pending",
  "description": "Refund for item",
  "merchant_order_id": "refund-001",
  "extra": null
}

Antwortfelder

Feld	Beschreibung
`id`	Eindeutiger Bezeichner der Erstattung
`created`	Zeitstempel der Erstattungserstellung
`modified`	Zeitstempel der letzten Aktualisierung
`amount`	Rückerstattungsbetrag in der Nebeneinheit ISO 4217 der Währung
`currency`	Währung der Erstattung (entspricht der Bestellungswährung)
`status`	Aktueller Erstattungsstatus (`pending`, `completed`, `failed`)
`description`	Grund für die Erstattung
`merchant_order_id`	Ihre Referenz-ID
`extra`	Zusätzliche Metadaten

Vollständige vs. teilweise Erstattungen

Vollständige Erstattung: Setzen Sie den amount auf den gesamten Bestellungsbetrag. Der vollständige Zahlungsbetrag wird an den Kunden zurückerstattet.
Teilweise Erstattung: Setzen Sie den amount auf weniger als den gesamten Bestellungsbetrag. Nur der angegebene Betrag wird zurückerstattet.

Sie können mehrere teilweise Erstattungen für dieselbe Bestellung ausstellen, solange der erstattete Gesamtbetrag den ursprünglichen Bestellungsbetrag nicht übersteigt.

{
  "amount": 500,
  "description": "Partial refund - damaged item"
}

Erstattungen können nur für Bestellungen mit dem Status completed ausgestellt werden. Der Versuch, eine noch nicht abgeschlossene Bestellung zu erstatten, führt zu einem Fehler.

Verwenden Sie das Feld merchant_order_id, um Erstattungen mit Ihren internen Systemen zu verknüpfen. Dies ist besonders nützlich, wenn Sie mehrere teilweise Erstattungen für dieselbe Bestellung ausstellen.

Erstattungsstatus

Status	Beschreibung
`pending`	Die Erstattung wurde eingeleitet und wird verarbeitet.
`completed`	Die Erstattung wurde erfolgreich verarbeitet. Das Geld wird an den Kunden zurückerstattet.
`failed`	Die Erstattung konnte nicht verarbeitet werden. Kontaktieren Sie den Cost+ Support.

Die Zeit, bis der erstattete Betrag auf dem Konto des Kunden erscheint, hängt von der Zahlungsmethode und der Bank des Kunden ab. Kreditkarten-Erstattungen dauern in der Regel 5-10 Werktage.

Erstattbaren Betrag prüfen

Bevor Sie eine teilweise Erstattung ausstellen, können Sie überprüfen, wie viel verfügbar ist:

curl -u YOUR_API_KEY: \
  "https://api.costplus.online/v1/orders/{order_id}/?fields[]=amount_details"

Das Feld refundable in der Antwort zeigt den maximalen Betrag, den Sie erstatten können.