Dokumentation/API-Referenz

API REFERENCE

Transaktion stornieren

POSThttps://mapi.yabandpay.com/Payments
Live API
API PLAYGROUND · Live API

Transaktion stornieren

POSThttps://mapi.yabandpay.com/Payments
Automatically signed with your credentials

Request parameters3

Required fields first

交易撤销

tidRequiredstringdata.tid设备的TID
trade_idRequiredstringdata.trade_idYabandPay订单编号
request_idRequiredstringdata.request_id请求id需保持唯一,建议24以上位数字+字母

Credentials stay on this page. Your secret key is never stored or sent to the documentation server.

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

ParameterTypBeschreibungErforderlich
userStringGeräte-TIDErforderlich
signStringSignatureErforderlich
methodStringv3.POSReversalErforderlich
timeLongTimestampErforderlich
  • Parameter
ParameterTypBeschreibungErforderlich
tidstringGeräte-TIDErforderlich
trade_idStringYabandPay-BestellnummerErforderlich
request_idStringEindeutige Anfrage-ID; empfohlen wird eine Kombination aus mindestens 24 Ziffern und BuchstabenErforderlich

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:
  1. Bei erfolgreichem Aufruf wird "status": true zurückgegeben.

  2. 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:
StatusCodeMessage
true200
false-3001Required field is missing
false-3002duplicate request_id
false-4111Exceed cancel window
false-4112The transaction has been cleared cannot be cancelled
false-4114The trade_id does not exist
false-4115The transaction cannot be cancelled
false-4116The transaction has been cancelled
false-4117The transaction has been Expired