# Erstattung erstellen

> Erstatten Sie eine bezahlte oder überzahlte Rechnung vollständig oder in Höhe der Überzahlung an die erste bestätigte Absenderadresse.

`POST /v1/refunds`

:::endpoint
POST /v1/refunds
:::

**API-Schlüssel:** `Payment`

Erstellt eine On-Chain-Erstattung für eine Rechnung im Status `paid` oder `paid_over` innerhalb von 14 Tagen nach der letzten bestätigten Einzahlung. Zieladresse und Betrag werden serverseitig berechnet: Die Mittel gehen an die Absenderadresse der ersten bestätigten Einzahlung (`first_sender`) zurück, und das Händlerguthaben wird mit `amount + fee` belastet.

## Anfragekörper

| Parameter | Typ | Erforderlich | Beschreibung |
|-----------|-----|--------------|--------------|
| `invoice_id` | string | Ja | Rechnungskennung mit Präfix (`inv_...`), die zu einem Projekt im Geltungsbereich des Schlüssels gehört |
| `mode` | string | Ja | `"full"` (erstattet den verbleibenden erstattungsfähigen Rechnungsbetrag) oder `"overpayment"` (erstattet nur den Überschuss über dem angeforderten Rechnungsbetrag) |
| `external_order_id` | string | Ja | Ihre Idempotenzreferenz (maximal 200 Zeichen), eindeutig pro Händler und Umgebung |

## Beispielanfrage

```json
{
  "invoice_id": "inv_7K2M9P4Q8R1X5Z3A0bC2dE",
  "mode": "full",
  "external_order_id": "refund-1042-full"
}
```

## Codebeispiele

Jeder Tab verwendet ein offizielles SDK mit einem Payment-Schlüssel (`pk_`). Signierung, Serialisierung, sichere Wiederholungen und typisierte Fehler übernimmt das SDK.

```curl
API_KEY_ID="pk_live_xxxxxxxxxxxx"
API_SECRET="sk_live_xxxxxxxxxxxx"
BODY='{"invoice_id":"inv_7K2M9P4Q8R1X5Z3A0bC2dE","mode":"full","external_order_id":"refund-1042-full"}'

TS=$(date +%s)
BODY_HASH=$(printf '%s' "$BODY" | openssl dgst -sha256 -hex | sed 's/^.* //')
SIGNATURE=$(printf '%s\n%s\n%s\n%s\n%s' "$TS" POST /v1/refunds '' "$BODY_HASH" \
  | openssl dgst -sha256 -hmac "$API_SECRET" -binary | base64)

curl -sS https://api.paymos.io/v1/refunds \
  -H "Authorization: HMAC-SHA256 $API_KEY_ID:$SIGNATURE" \
  -H "X-Request-Timestamp: $TS" \
  -H "Content-Type: application/json" \
  -d "$BODY"
```

```javascript
import { Paymos, externalOrderId } from '@paymos/sdk';

const paymos = new Paymos({
  apiKey: process.env.PAYMOS_API_KEY,
  apiSecret: process.env.PAYMOS_API_SECRET,
});
const refund = await paymos.refunds.create({
  invoiceId: 'inv_7K2M9P4Q8R1X5Z3A0bC2dE',
  mode: 'full',
  externalOrderId: externalOrderId('refund'),
});

console.log(refund.withdrawalId, refund.status);
```

```python
import os

from paymos import Paymos

paymos = Paymos(
    api_key=os.environ["PAYMOS_API_KEY"],
    api_secret=os.environ["PAYMOS_API_SECRET"],
)
refund = paymos.refunds.create(
    invoice_id="inv_7K2M9P4Q8R1X5Z3A0bC2dE",
    mode="full",
    external_order_id="refund-1042-full",
)

print(refund["withdrawal_id"], refund["status"])
```

```php
<?php
use Paymos\Client;
use Paymos\ClientConfig;
use Paymos\IdempotencyKey;

$paymos = new Client(new ClientConfig(
    getenv('PAYMOS_API_KEY'),
    getenv('PAYMOS_API_SECRET')
));
$refund = $paymos->refunds()->create(array(
    'invoice_id' => 'inv_7K2M9P4Q8R1X5Z3A0bC2dE',
    'mode' => 'full',
    'external_order_id' => IdempotencyKey::externalOrderId('refund'),
));

echo $refund['withdrawal_id'] . ' ' . $refund['status'];
```

```go
package main

import (
	"context"
	"fmt"
	"os"

	paymos "github.com/Paymos-labs/go-sdk/v2"
)

func main() {
	client, err := paymos.NewClient(os.Getenv("PAYMOS_API_KEY"), os.Getenv("PAYMOS_API_SECRET"))
	if err != nil {
		panic(err)
	}
	refund, err := client.Refunds.Create(context.Background(), paymos.CreateRefundParams{
		InvoiceID:       "inv_7K2M9P4Q8R1X5Z3A0bC2dE",
		Mode:            paymos.RefundModeFull,
		ExternalOrderID: "refund-1042-full",
	})
	if err != nil {
		panic(err)
	}
	fmt.Println(refund.WithdrawalID, refund.Status)
}
```

```csharp
using Paymos;

using var paymos = new PaymosClient(
    Environment.GetEnvironmentVariable("PAYMOS_API_KEY")!,
    Environment.GetEnvironmentVariable("PAYMOS_API_SECRET")!);

var refund = await paymos.Refunds.CreateAsync(new CreateRefundRequest(
    InvoiceId: "inv_7K2M9P4Q8R1X5Z3A0bC2dE",
    Mode: RefundMode.Full,
    ExternalOrderId: "refund-1042-full"));

Console.WriteLine($"{refund.WithdrawalId} {refund.Status}");
```

```java
import io.paymos.CreateRefundRequest;
import io.paymos.PaymosClient;
import io.paymos.Refund;
import io.paymos.RefundMode;

PaymosClient paymos = new PaymosClient(
    System.getenv("PAYMOS_API_KEY"),
    System.getenv("PAYMOS_API_SECRET"));

Refund refund = paymos.refunds.create(new CreateRefundRequest(
    "inv_7K2M9P4Q8R1X5Z3A0bC2dE",
    RefundMode.FULL,
    "refund-1042-full"));

System.out.println(refund.withdrawalId() + " " + refund.status());
```

```ruby
require 'paymos'

paymos = Paymos::Client.new(
  api_key: ENV.fetch('PAYMOS_API_KEY'),
  api_secret: ENV.fetch('PAYMOS_API_SECRET')
)
refund = paymos.refunds.create(
  invoice_id: 'inv_7K2M9P4Q8R1X5Z3A0bC2dE',
  mode: 'full',
  external_order_id: 'refund-1042-full'
)

puts "#{refund.withdrawal_id} #{refund.status}"
```

```rust
use paymos::{CreateRefundRequest, PaymosClient, RefundMode};

let paymos = PaymosClient::new(
    std::env::var("PAYMOS_API_KEY")?,
    std::env::var("PAYMOS_API_SECRET")?,
)?;
let refund = paymos
    .refunds()
    .create(&CreateRefundRequest {
        invoice_id: "inv_7K2M9P4Q8R1X5Z3A0bC2dE".to_owned(),
        mode: RefundMode::Full,
        external_order_id: "refund-1042-full".to_owned(),
    })
    .await?;

println!("{} {}", refund.withdrawal_id, refund.status);
```

## Antwort (201 Created / 200 bei idempotentem Treffer)

```json
{
  "withdrawal_id": "wdr_6Qm2fK8xR4vN7cT1bY9dL5",
  "invoice_id": "inv_7K2M9P4Q8R1X5Z3A0bC2dE",
  "mode": "full",
  "external_order_id": "refund-1042-full",
  "status": "created",
  "is_final": false,
  "is_test": false,
  "amount": "100.00",
  "fee": "1.00",
  "currency": "USDT",
  "network": "TRC20",
  "destination_address": "TN3W4H6rK2ce4vX9YnFQHwKENnHjoxb3m9",
  "first_sender": "TN3W4H6rK2ce4vX9YnFQHwKENnHjoxb3m9",
  "created_at": 1767225600,
  "type": "refund",
  "project_id": "prj_3F9xL2mN8pQ4rT6vW1yZ5b"
}
```

## Antwortfelder

| Feld | Typ | Beschreibung |
|------|-----|--------------|
| `withdrawal_id` | string | Auszahlungskennung mit Präfix (`wdr_...`) für diese Erstattung |
| `invoice_id` | string | Rechnungskennung mit Präfix (`inv_...`), die erstattet wird |
| `mode` | string | Erstattungsmodus: `"full"` oder `"overpayment"` |
| `external_order_id` | string | Ihre Idempotenzreferenz aus der Erstellungsanfrage |
| `status` | string | Aktueller Status (`created`, `signed`, `pending_review`, `cancelling`, `completed`, `failed` oder `cancelled`) |
| `is_final` | boolean | `true`, sobald die Erstattung einen Endstatus erreicht hat (`completed`, `failed`, `cancelled`) |
| `is_test` | boolean | `true` für Sandbox-Erstattungen |
| `amount` | string | Exakter Token-Betrag, der an den Zahler zurückgesendet wird |
| `fee` | string? | Feste Netzwerk-Auszahlungsgebühr pro Token, die zusätzlich zu `amount` vom Händlerguthaben abgezogen wird. Entfällt bei null |
| `currency` | string | Krypto-Asset-Symbol (entspricht der Zahlungswährung der Rechnung) |
| `network` | string | Blockchain-Netzwerkcode (entspricht dem Zahlungsnetzwerk der Rechnung) |
| `destination_address` | string | Zieladresse der Auszahlung (immer identisch mit `first_sender`) |
| `first_sender` | string | Kanonische Absenderadresse der ersten bestätigten Einzahlung auf die Rechnung |
| `tx_hash` | string? | On-Chain-Transaktions-Hash, sobald `status` auf `completed` steht |
| `explorer_url` | string? | Block-Explorer-Link für `tx_hash`, sobald `status` auf `completed` steht |
| `created_at` | integer | Unix-Zeitstempel in Sekunden |
| `completed_at` | integer? | Unix-Zeitstempel in Sekunden bei Abschluss der Erstattung |
| `failed_at` | integer? | Unix-Zeitstempel in Sekunden bei Fehlschlag der Erstattung |
| `cancelled_at` | integer? | Unix-Zeitstempel in Sekunden bei Stornierung der Erstattung |
| `type` | string | Immer `"refund"` |
| `project_id` | string | Projektkennung mit Präfix (`prj_...`), zu der die Rechnung gehört |

## Idempotenz

Senden Sie bei jedem Erstattungsversuch eine deterministische `external_order_id`. Ein erneuter Aufruf von `POST /v1/refunds` mit demselben Tupel `(invoice_id, mode, external_order_id)` liefert die bestehende Erstattung mit `200 OK` zurück, ohne eine zweite Auszahlung anzulegen. Die Wiederverwendung einer `external_order_id` mit einer anderen `invoice_id` oder einem anderen `mode` wird mit `409 idempotency_conflict` abgewiesen.

Pro Rechnung darf jeweils nur eine aktive Erstattung gleichzeitig laufen. Sie können zuerst eine `"overpayment"`-Erstattung ausführen und nach deren Abschluss (`completed`) eine `"full"`-Erstattung über den verbleibenden Hauptbetrag senden.

## Fehler

| Code | HTTP | Wann |
|------|------|------|
| `payment_key_required` | 403 | Die Anfrage wurde mit einem Payout-Schlüssel (`rk_`) statt einem Payment-Schlüssel (`pk_`) signiert |
| `refunds_not_enabled` | 503 | Rechnungserstattungen sind in dieser Umgebung deaktiviert |
| `invoice_not_found` | 404 | `invoice_id` existiert nicht oder liegt außerhalb des Projektbereichs des API-Schlüssels |
| `refund_not_eligible` | 409 | Die Rechnung hat nicht den Status `paid` oder `paid_over`, oder ihre Einzahlungen sind nicht erstattungsfähig |
| `refund_no_overpayment` | 409 | `mode` ist `"overpayment"`, aber die Rechnung weist keinen verbleibenden Überzahlungsbetrag auf |
| `refund_sender_unknown` | 409 | Die Absenderadresse der ersten bestätigten Einzahlung ist nicht verfügbar |
| `refund_window_expired` | 409 | Seit der letzten bestätigten Einzahlung der Rechnung sind mehr als 14 Tage vergangen |
| `refund_network_unsupported` | 409 | Auszahlungen werden im Zahlungsnetzwerk der Rechnung nicht unterstützt |
| `refund_in_flight` | 409 | Für diese Rechnung befindet sich bereits eine andere Erstattung in einem nicht-terminalen Status |
| `invoice_already_refunded` | 409 | Die Rechnung wurde bereits vollständig erstattet |
| `refund_source_inconsistent` | 409 | Die Einzahlungs- oder Erstattungshistorie der Rechnung hat die Konsistenzprüfung nicht bestanden |
| `insufficient_balance` | 409 | Das Händlerguthaben reicht für `amount + fee` nicht aus |

Siehe [Fehlercodes](/de/docs/errors/codes.md) für den vollständigen Katalog.