Aktualisierung der Bestellnummer

Bestellnummer nachträglich ändern

Falls eine Transaktion vor dem Anlegen der Bestellung erstellt wird und die Bestellnummer zu diesem Zeitpunkt noch nicht feststeht, kann die Bestellnummer im Nachhinein aktualisert werden. Dies ist jedoch nur möglich, wenn noch keine Bestellnummer gesetzt wurde. Dazu muss die URL https://api.barzahlen.de/v1/transactions/update mit den entsprechenden Parametern aufgerufen werden. Die folgende Abbildung stellt diesen Ablauf schematisch dar.

Die XML-Antwort, die bei einer erfolgreichen Operation zurückgeliefert wird, ist im Folgenden zu sehen. Result "0" gibt an, dass der Vorgang erfolgreich war. Im Fehlerfall wird eine entsprechende Antwort zurückgeliefert.

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

Beschreibung der Parameter von /update

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 (Bezahlung oder Rückgabe), deren Bestellnummer gesetzt werden soll N..18 Ja
order_id zu setzende Bestellnummer AN..20 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 lautet:

  
shop_id;transaction_id;order_id;payment_key
  

Verifizierung der Antwort

Details zur Verifizerung finden Sie hier.

Die Reihenfolge zur Verifizierung des Hashwertes lautet:

  
transaction-id;result;payment_key