Zum Inhalt

refundPayment

Eine Voll- oder Teilerstattung für eine abgeschlossene Zahlung anfordern.

Request

POST /api/v2/refundPayment

Headers

Header Erforderlich Beschreibung
token Ja Ihre API Key
Content-Type Ja application/json

Body-Parameter

Feld Typ Erforderlich Beschreibung
pay_id integer Ja Die linktopay_id der zu erstattenden Zahlung
refund_amount number Ja Erstattungsbetrag in EUR
isFullRefund boolean Nein Auf true setzen für Vollerstattung (erfordert trotzdem refund_amount)

refund_amount erforderlich

Das Feld refund_amount ist immer erforderlich — auch bei Vollerstattungen.

Antwort

Erfolg (ResponseCode: 1)

{
  "ResponseCode": 1,
  "ResponseMsg": "Refund request has been sent successfully, You will get update within 5-10 days",
  "Result": "True",
  "ServerTime": "CEST"
}

Fehler (ResponseCode: 0)

ResponseMsg Ursache
Please enter pay_id Fehlendes pay_id-Feld
Please enter refund_amount Fehlendes refund_amount-Feld
Invalid link ID Link nicht gefunden oder gehört anderem Benutzer
Link is cancelled Abgebrochener Link kann nicht erstattet werden
Refund already requested Erstattung für diesen Link bereits eingereicht
Refund blocked by dispute Aktiver Dispute verhindert Erstattung
Invalid refund amount Betrag übersteigt Zahlung oder ist ≤ 0

Beispiele

curl -X POST https://app.secpaid.com/api/v2/refundPayment \
  -H "Content-Type: application/json" \
  -H "token: IHR_API_KEY" \
  -d '{
    "pay_id": 12345,
    "refund_amount": 49.99,
    "isFullRefund": true
  }'
curl -X POST https://app.secpaid.com/api/v2/refundPayment \
  -H "Content-Type: application/json" \
  -H "token: IHR_API_KEY" \
  -d '{
    "pay_id": 12345,
    "refund_amount": 20.00
  }'

Prozess

  1. Sie senden die Erstattungsanfrage per API
  2. Die Anfrage geht in einen Pending-Status zur Admin-Prüfung
  3. Ein SecPaid-Admin genehmigt oder lehnt ab
  4. Bei Genehmigung wird die Erstattung auf die originale Zahlungsmethode verarbeitet

Nicht sofort

Erstattungen werden nicht sofort verarbeitet. Sie erfordern Admin-Genehmigung.

Hinweise

  • Nur eine Erstattungsanfrage pro Payment Link erlaubt
  • Erstattungsbetrag kann den originalen Zahlungsbetrag nicht übersteigen
  • Kein Webhook bei Erstattungsverarbeitung
  • Siehe Erstattungen Konzept für den vollständigen Lebenszyklus