Rückgabe-Transaktionen

Rückgabe von Transaktionen

Eine Rückgabe kann über die URL https://api.barzahlen.de/v1/transactions/refund ausgelöst werden.

Alternativ können Rückgaben auch im Händlerbereich getätigt werden. Für eine Transaktion können mehrere Rückgaben gemacht werden. Dabei ist nur wichtig, dass die Summe der Rückgabebeträge nicht größer ist, als der Betrag der ursprünglichen Transaktion.

Folgende XML-Antwort wird bei einer erfolgreichen Operation zurückgeliefert:

<?xml version="1.0" encoding="UTF-8"?>
<response>
  <origin-transaction-id>22780174</origin-transaction-id>
  <refund-transaction-id>22791842</refund-transaction-id>
  <result>0</result>
  <hash>0714be1522e16fe67f397767c98cf37e37fd9c2a5391f49f8b01cb66642150751c77a0cce1ef7268e7bdeee792ed63eab53ef9b860f721c9d9d47ffc871ee3f9</hash>
</response>

Die Origin-Transaction-ID bezieht sich auf die ursprüngliche Transaktion. Die Refund-Transaction-ID kennzeichnet die Rückgabe eindeutig und wird auch bei den entsprechenden Benachrichtigungen angegeben.

Im Fehlerfall wird eine entsprechende Antwort zurückgeliefert.

Beschreibung der Parameter von /refund

Legende

Formatangabe Erläuterung
N..X Numerischer Wert (maximal x Zeichen)
AN..X Alphanumerischer Wert (maximal x Zeichen)
Vorgabe Vorgabewerte (siehe Beschreibungsfeld)
Regulärer Ausdruck Ein regulärer Ausdruck definiert erlaubte Werte eindeutig.

Parameterbeschreibung

Die Übergabe der Daten erfolgt über einen HTTPS-POST Aufruf (key/value pairs). Die Antwort ist im XML-Format.

Parameter Beschreibung Format Pflicht
shop_id eindeutige Identifikationsnummer, um den Online-Shop zu identifizieren; im Händlerbereich von Barzahlen ersichtlich N..18 Ja
transaction_id eindeutige Nummer der Transaktion, die zurückgegeben werden soll N..18 Ja
amount positiver Betrag, nur Zahlen und ein "." erlaubt; muss dem ursprünglichen Betrag entsprechen oder kleiner sein ˆ[0-9]{1,3}(\. [0-9][0-9]?)?$ Ja
currency 3-stelliger Währungscode (ISO 4217) Vorgabe Ja
language 2-stelliger Sprachcode (ISO 639-1), beeinflusst Sprache der PDF-Datei, Standard ist DE Vorgabe Nein
hash Hash aus Parametern und API- Zahlungsschlüssel des Online-Shops AN..128 Ja

Bildung des Hashwertes

Details zur Berechnung finden Sie hier.

Die Reihenfolge zur Berechnung des Hashwertes für Rückgaben lautet:
	
shop_id;transaction_id;amount;currency;language;payment_key
	

Verifizierung der Antwort

Details zur Verifizerung finden Sie hier.

Die Reihenfolge zur Verifizierung des Hashwertes lautet:
  
origin-transaction-id;refund-transaction-id;result;payment_key