API REFERENCE
Transaktion stornieren
Gilt für POS-Zahlungen vor Ort
Diese API leitet über die Cloud die Stornierung erfolgreicher Transaktionen ein.
Eine Transaktionsstornierung ist nur für Transaktionen des aktuellen Tages möglich; es sind ausschließlich vollständige Stornierungen zulässig.
Für Teilstornierungen oder Transaktionen eines früheren Tages verwenden Sie die Rückerstattungs-API.
Nach dem Senden einer Stornierungsanweisung zeigt das POS-Terminal den Ablauf und das endgültige Ergebnis der Stornierung in Echtzeit an, sodass Händler und Nutzer den Status sofort überprüfen können. Für eine stille Stornierung (ohne Anzeige des Ablaufs auf dem POS-Terminal) verwenden Sie die API „Zahlung stornieren“.
Stellen Sie vor dem Aufruf dieser API sicher, dass das POS-Gerät online und verfügbar ist, damit die Stornierungsanweisung zugestellt und erfolgreich verarbeitet werden kann.
API-URL (Produktion): https://mapi.yabandpay.com/Payments
API-URL (Test): https://acc-mapi.yabandpay.com/Payments
| Parameter | Typ | Beschreibung | Erforderlich |
|---|---|---|---|
| user | String | Geräte-TID | Erforderlich |
| sign | String | Signature | Erforderlich |
| method | String | v3.POSReversal | Erforderlich |
| time | Long | Timestamp | Erforderlich |
- Parameter
| Parameter | Typ | Beschreibung | Erforderlich |
|---|---|---|---|
| tid | string | Geräte-TID | Erforderlich |
| trade_id | String | YabandPay-Bestellnummer | Erforderlich |
| request_id | String | Eindeutige Anfrage-ID; empfohlen wird eine Kombination aus mindestens 24 Ziffern und Buchstaben | Erforderlich |
Signaturbeispiel:
Die sortierten Parameter werden zu einer URL-ähnlichen Abfragezeichenfolge verkettet.
"method=v3.POSReversal&request_id=a7z1lox4l6z6mdx1udgn5gtezasze1x0&tid=T125119061&time=1555498137&trade_id=4a49ffb3-a30f-ba92-9422-1969afb6f121&user=T125119061"
Signieren Sie stringA mit secret_key.
Die resultierende Signatur lautet:
"YOUR_SIGNATURE"
Anfragebeispiel:
{
"user": "T125119061",
"sign": "YOUR_SIGNATURE",
"method": "v3.POSReversal",
"time": 1555498137,
"data": {
"tid": "T125119061",
"trade_id": "4a49ffb3-a30f-ba92-9422-1969afb6f121",
"request_id": "a7z1lox4l6z6mdx1udgn5gtezasze1x0"
}
}
Antwortbeispiel:
{
"status": true,
"code": "200",
"data": {
"type": "payment",
"user": "T125119061",
"amount": "0.10",
"currency": "EUR",
"trade_id": "4a49ffb3-a30f-ba92-9422-1969afb6f121",
"description": "YabandPay test",
"order_id": "YOUR_ORDER_ID",
"createDate": "1706771212",
"demo": "test",
"transaction_id": "",
"state": "cancelled"
},
"message": ""}
Weitere Informationen:
Antwortergebnis:
-
Bei erfolgreichem Aufruf wird "status": true zurückgegeben.
-
Bei fehlgeschlagenem Aufruf wird "status": false zurückgegeben.
Wir empfehlen dringend, sowohl Bestellabfragen als auch asynchrone Benachrichtigungen zu verwenden, um den Zahlungsstatus zu synchronisieren und aktuell zu halten.
Antwortcodes:
| Status | Code | Message |
|---|---|---|
| true | 200 | |
| false | -3001 | Required field is missing |
| false | -3002 | duplicate request_id |
| false | -4111 | Exceed cancel window |
| false | -4112 | The transaction has been cleared cannot be cancelled |
| false | -4114 | The trade_id does not exist |
| false | -4115 | The transaction cannot be cancelled |
| false | -4116 | The transaction has been cancelled |
| false | -4117 | The transaction has been Expired |
