Dokumentation/API-Referenz

API REFERENCE

Token-Zahlungen

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

Token-Zahlungen

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

Request parameters12

Required fields first

Token支付

pay_methodRequiredstringdata.pay_methodonline
sub_pay_methodRequiredstringdata.sub_pay_methodToken
operationRequiredstringdata.operation11.Token for sales 12.Token for authorisation;
amountRequiredstringdata.amount金额数字。例如 € 24.99 应该写成24.99
currencyRequiredstringdata.currency货币代码,ISO 4217,例如EUR,CHF
payment_token_objectRequiredstringdata.payment_token_object支付Token
descriptionRequiredstringdata.description订单描述
timeoutRequiredstringdata.timeout过期时间单位分钟(0-1440)
notify_urlRequiredstringdata.notify_url支付完成后异步通知地址
request_idRequiredstringdata.request_id请求id需保持唯一,建议24以上位数字+字母
Optional parameters 1
demoOptionalstringdata.demo自定义字段

请求参数

3ds_initiateRequiredstringdata.3ds_initiate01. 开启3ds验证; 02.不开启3DS(需申请开通);03. SCA豁免(需申请开通);

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

Gilt für: Token-Zahlungen mit Kreditkarten

Nachdem der Zahler auf der gehosteten Zahlungsseite von YabandPay eine reguläre Kreditkartentransaktion abgeschlossen und zugestimmt hat, wandelt YabandPay sensible Karteninhaberdaten in eine zufällige Ziffernfolge (ein Token) um, sodass keine Rückschlüsse auf die Person möglich sind. Das Token kann für folgende Zahlungen verwendet werden:

  1. Nutzer können auf der Bezahlseite mit einem Klick bezahlen, ohne Kreditkartendaten einzugeben.
  2. Händler können dieses Token für wiederkehrende Zahlungen, Abonnementgebühren und ähnliche Zwecke verwenden.

[!TIP|style:flat] Workflow

  1. Aktivieren Sie Token-Zahlungen. Wenden Sie sich an Ihren Kundenbetreuer, um die Token-Zahlungsfunktion freischalten zu lassen.
  1. Holen Sie die Zustimmung des Nutzers ein. Wenn Sie Express-Zahlungen (Token-Zahlungen) für Verbraucher aktivieren, müssen Sie die Nutzer klar informieren und ihre Zustimmung einholen, um mögliche Streitfälle zu vermeiden.
  1. Rufen Sie ein Token ab. Starten Sie zunächst eine reguläre Kreditkartentransaktion. YabandPay returns a payment url. After the user completes payment through that url and gives consent, YabandPay returns the Token in an asynchronous notification using the payment_token_object parameter.
  1. Starten Sie eine Token-Zahlung. Übergeben Sie das Token in der payment_token_object Variable. Ist die Token-Prüfung erfolgreich, verarbeitet YabandPay die Token-Zahlung. Schlägt die Prüfung fehl, gibt YabandPay einen Fehler zurück. In diesem Fall empfehlen wir, eine weitere reguläre Kreditkartentransaktion zu starten, um ein Token abzurufen, und anschließend die Zahlung erneut einzuleiten.
ParameterTypBeschreibungErforderlich
userStringKassiererkonto UIDErforderlich
signStringSignatureErforderlich
methodStringv3.CreateCardPaymentsErforderlich
timeLongTimestampErforderlich
  • Parameter
ParameterTypBeschreibungErforderlich
pay_methodStringonlineErforderlich
sub_pay_methodStringTokenErforderlich
operationString11.Token for sales 12.Token for authorisation;Erforderlich
order_idStringHändlerbestellnummerErforderlich
3ds_initiateString01. Enable 3DS verification; 02. Disable 3DS (requires activation approval); 03. SCA exemption (requires activation approval).Erforderlich
sca_exemptionStringLowValue3ds_initiate=03 Required
amountStringBetrag als numerische Zeichenfolge. Geben Sie beispielsweise 24.99 for € 24.99.Erforderlich
currencyStringISO 4217 Währungscode, zum Beispiel EUR oder CHFErforderlich
payment_token_objectStringZahlungs-TokenErforderlich
descriptionStringBestellbeschreibungErforderlich
demoStringBenutzerdefiniertes FeldOptional
timeoutStringAblaufzeit in Minuten (0-1440)Erforderlich
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

"3ds_initiate=01&amount=1&currency=EUR&description=test&method=v3.CreateCardPayments&notify_url=https://www.yabandpay.com/notify&operation=11&order_id=1725875543&pay_method=online&payment_token_object=VnXaRabcsedfsSlPFZXavcsdfasdEFDd&request_id=hjf5lv32i40lh7oh86j6az98tnscwv37&sub_pay_method=Token&time=1725875543&timeout=0&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.CreateCardPayments",
    "time": 1725875543,
    "data": {
        "3ds_initiate": "01",
        "description": "test",
        "timeout": "0",
        "pay_method": "online",
        "sub_pay_method": "Token",
        "operation": "11",
        "order_id": 1725875543,
        "amount": "1",
        "currency": "EUR",
        "payment_token_object": "VnXaRabcsedfsSlPFZXavcsdfasdEFDd",
        "notify_url": "https://www.yabandpay.com/notify",
        "request_id": "hjf5lv32i40lh7oh86j6az98tnscwv37"
    }
}

Eintwortbeispiel:

{
    "status": true,
    "code": "200",
    "data": {
        "order_id": "YOUR_ORDER_ID",
        "trade_id": "109bb0e9-e1fb-49cb-c537-ec944f33c388",
        "amount": "1.00",
        "currency": "EUR",
        "state": "paid"
    },
    "message": "",
    "response_id": "202409091752241912726578"
}

Zusätzliche Informationen:

MIT und CIT:

MIT = vom Händler ausgelöste Folgetransaktionen. Vom Händler veranlasste Token-Zahlungen.

CIT = vom Karteninhaber ausgelöste Folgetransaktionen. Token-Zahlungen unter Beteiligung des Kunden. Geben Sie bei der Aktivierung der Zahlungen an, ob Sie MIT oder CIT benötigen, damit der passende Modus eingerichtet werden kann.

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

  2. Bei fehlgeschlagenem Aufruf wird "status": false is returned. If you receive Invalid Token, we recommend calling HPP Token again to obtain a new Token.

The API returns the Zahlungsstatus synchronously. Wir empfehlen dringend, sowohl Bestellabfrage and Asynchrone Benachrichtigungen zu verwenden, um den Zahlungsstatus zu synchronisieren und Zahlungsinformationen in Echtzeit aktuell zu halten. a) If the order status state is paid, payment succeeded; b) if the order status state is authorized, Autorisierung succeeded. To capture funds after successful Autorisierung, call the Autorisierung capture API.

3DS low-value exemption:

Transaktionen innerhalb der folgenden Grenzwerte können als Kleinbetragszahlungen gelten. Liegt der Bestellbetrag unter oder gleich dem jeweils geltenden Betrag, kann nach Genehmigung der Transaktionscode 02 (Kleinbetragsausnahme) verwendet werden.

Nr.WährungBetrag
1EUR30
2DKK225
3GBP27
4SEK310
5ISK5000
6NOK325
7CHF32
8PLN135
9USD36
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-4119Invalid Token
false-4120No operational permissions