Dokumentation/API-Referenz

API REFERENCE

Zahlung stornieren

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

Zahlung stornieren

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

Request parameters1

Required fields first

取消支付

trade_idRequiredstringdata.trade_idYabandPay订单编号

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

Diese API storniert Zahlungsaufträge, einschließlich unbezahlter, bezahlter und erfolgreich autorisierter Aufträge.

Wenn Sie das endgültige Zahlungsergebnis von YabandPay (Erfolg oder Misserfolg) noch nicht erhalten haben oder einen Zahlungsauftrag schließen möchten, rufen Sie diese API auf, um ihn zu stornieren.

Tipp

  1. Zeitlimit: Zahlungsaufträge können nur innerhalb des festgelegten Zeitfensters storniert werden – vom Transaktionsbeginn bis 00:30 am Folgetag (Tag T+1, 00:30), mitteleuropäische Zeit.
  1. Betragsbeschränkung: Eine Stornierung muss den Gesamtbetrag umfassen. Teilstornierungen werden nicht unterstützt.
  1. Rückerstattungsbeschränkung: Ein Zahlungsauftrag kann nicht storniert werden, wenn dafür bereits eine Rückerstattung ausgeführt wurde.
  1. Abrechnung und Gebühren: Stornierte Zahlungsaufträge werden weder verrechnet noch abgerechnet; YabandPay erhebt dafür keine Transaktionsgebühren.
ParameterTypBeschreibungErforderlich
userStringKassiererkonto UIDErforderlich
signStringSignatureErforderlich
methodStringv3.CancelPaymentErforderlich
timeLongTimestampErforderlich
  • Parameter
ParameterTypBeschreibungErforderlich
trade_idStringYabandPay-BestellnummerErforderlich

Signaturbeispiel:

Die sortierten Parameter werden zu einer URL-ähnlichen Abfragezeichenfolge verkettet.

"method=v3.CancelPayment&time=1546588959&trade_id=4a49ffb3-a30f-ba92-9422-1969afb6f121&user=YOUR_CASHIER_UID"

Signieren Sie stringA mit secret_key.

Die resultierende Signatur lautet:

"YOUR_SIGNATURE"

Anfragebeispiel:

{
    "user": "YOUR_CASHIER_UID",
	"sign": "YOUR_SIGNATURE",
	"method": "v3.CancelPayment",
	"time": 1546588959,
	"data": {
		"trade_id": "4a49ffb3-a30f-ba92-9422-1969afb6f121"
    }
}

Antwortbeispiel:

{
    "status": true,
    "code": "200",
    "data": {
        "type": "payment",
        "user": "YOUR_CASHIER_UID",
        "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 erfolgreicher Stornierung wird "status": true zurückgegeben.
  2. Bei fehlgeschlagener Stornierung wird "status": false zurückgegeben.

Rufen Sie Bestellung abfragen auf, um den Bestellstatus zu prüfen. Lautet der Bestellstatus state gleich cancelled, war die Stornierung erfolgreich.

Antwortcodes:
StatusCodeMessage
true200
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