Dokumentation/API-Referenz

API REFERENCE

Autorisierung einziehen

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

Autorisierung einziehen

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

Request parameters6

Required fields first

预授权请款

trade_idRequiredstringdata.trade_id对应预授权的trade_id
amountRequiredstringdata.amount金额数字。例如 € 24.99 应该写成24.99
currencyRequiredstringdata.currency货币代码,ISO 4217,例如EUR,CHF
descriptionRequiredstringdata.description订单描述
notify_urlRequiredstringdata.notify_url支付完成后异步通知地址
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: Einzug nach der Autorisierung

Ziehen Sie den Betrag nach erfolgreicher Autorisierung ein. Der Einzug muss innerhalb von 30 Tagen nach Abschluss der Autorisierung erfolgen. Andernfalls läuft die Autorisierung automatisch ab.

Die Einzugswährung muss mit der Autorisierungswährung übereinstimmen. Der Betrag darf den ursprünglich autorisierten Betrag nicht überschreiten.

Für jede autorisierte Transaktion ist nur ein Einzug zulässig. Mehrere Einzüge werden nicht unterstützt.

ParameterTypBeschreibungErforderlich
userStringKassiererkonto UIDErforderlich
signStringSignatureErforderlich
methodStringv3.CaptureErforderlich
timeLongTimestampErforderlich
  • Parameter
ParameterTypBeschreibungErforderlich
trade_idStringtrade_id of the AutorisierungErforderlich
amountStringBetrag als numerische Zeichenfolge. Geben Sie beispielsweise 24.99 for € 24.99.Erforderlich
currencyStringISO 4217 Währungscode, zum Beispiel EUR oder CHFErforderlich
descriptionStringBestellbeschreibungErforderlich
notify_urlStringURL für asynchrone Benachrichtigung nach der ZahlungErforderlich
request_idStringEindeutige Einfrage-ID; empfohlen wird eine Kombination aus Ziffern und Buchstaben mit mindestens 24 ZeichenErforderlich

Signaturbeispiel:

Nach Parametern sortierte Werte, verkettet zu einer URL-ähnlichen Abfragezeichenfolge

"amount=1&currency=EUR&description=test&method=v3.Capture&notify_url=https://www.yabandpay.com/notify&request_id=ca51f2fas3i0f8uiw7efj6oe4i2w1ghj&time=1720684254&trade_id=160899f3-f6d9-a8d8-ab5b-82eacdab9c5b&user=YOUR_CASHIER_UID"

Sign stringA using secret_key

The resulting signature is:

"YOUR_SIGNATURE"

Einfragebeispiel:

{
    "user": "YOUR_CASHIER_UID",
    "sign": "YOUR_SIGNATURE",
    "method": "v3.Capture",
    "time": 1720684254,
    "data": {
        "description": "test",
        "trade_id": "160899f3-f6d9-a8d8-ab5b-82eacdab9c5b",
        "amount": "1",
        "currency": "EUR",
        "notify_url": "https://www.yabandpay.com/notify",
        "request_id": "ca51f2fas3i0f8uiw7efj6oe4i2w1ghj"
    }
}

Eintwortbeispiel:

{
    "status": true,
    "code": "200",
    "data": {
        "order_id": "YOUR_ORDER_ID",
        "trade_id": "160899f3-f6d9-a8d8-ab5b-82eacdab9c5b",
        "amount": "1",
        "currency": "EUR",
        "state": "paid"},
    "message": "",
    "response_id": "202407111550570060848432"
}

Zusätzliche Informationen:

Eintwortergebnis:
  1. Eine erfolgreiche Einfrage gibt "status": true.

  2. Eine fehlgeschlagene Einfrage gibt "status": false.

Wir empfehlen dringend, sowohl Bestellabfrage and Asynchrone Benachrichtigungen zu verwenden, damit die Zahlungsstatus korrekt und aktuell bleiben.

Eintwortcodes:
StatusCodeMessage
true200
false-1000Internal error
false-403The signature Error
false-2001The user not exist
false-3001Required field is missing
false-4118Incorrect request ID
false-4089Exceed capture window
false-4084The captured amount exceeds the original authorized amount
false-4085The captured currency is different from the original authorization currency
false-4024The original trade ID is incorrect