API REFERENCE
Token abrufen
Gilt für: Abruf eines Tokens über die gehostete Zahlungsseite von YabandPay
Die Gehostete Zahlungsseite (HPP) von YabandPay ist eine sofort einsatzbereite, vollständig von YabandPay verwaltete Zahlungsseite. Händler können Zahlungen sicher annehmen, da sensible PCI-Daten im System von YabandPay verarbeitet werden. Das Formular kann als iFrame oder Weiterleitungsseite in den Bezahlvorgang des Händlers eingebunden werden.
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 Zeichenfolge (ein Token) um, sodass keine Rückschlüsse auf die Person möglich sind. Das Token kann für folgende Zahlungen verwendet werden:
- Nutzer können auf der Bezahlseite mit einem Klick bezahlen, ohne Kreditkartendaten einzugeben.
- Händler können dieses Token für wiederkehrende Zahlungen, Abonnementgebühren und ähnliche Zwecke verwenden.
[!TIP|style:flat] Workflow
- Aktivieren Sie Token-Zahlungen. Wenden Sie sich an Ihren Kundenbetreuer, um die Token-Zahlungsfunktion freischalten zu lassen.
- 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.
- 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.
- 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.
| Parameter | Typ | Beschreibung | Erforderlich |
|---|---|---|---|
| user | String | Kassiererkonto UID | Erforderlich |
| sign | String | Signature | Erforderlich |
| method | String | v3.CreateCardPayments | Erforderlich |
| time | Long | Timestamp | Erforderlich |
- Parameter
| Parameter | Typ | Beschreibung | Erforderlich |
|---|---|---|---|
| pay_method | String | online | Erforderlich |
| sub_pay_method | String | Karten-HPP | Erforderlich |
| operation | String | 10.Create Token only; 11.Token for sales; 12.Token for authorisation | Erforderlich |
| order_id | String | Händlerbestellnummer | Erforderlich |
| 3ds_initiate | String | 3ds settings. 01. 3ds verification must be enabled; | Erforderlich |
| cardinfo | String | Karteninformationen | Treat the value of cardinfo as a string (fields within cardinfo do not need to be included in sorting) |
| cardinfo.card_holder | string | Name des Karteninhabers | Erforderlich |
| cardinfo.card_number | string | Kartennummer | Erforderlich |
| cardinfo.expiration_month | string | Ablaufmonat der Karte, MM | Erforderlich |
| cardinfo.expiration_year | string | Ablaufjahr der Karte, JJJJ | Erforderlich |
| cardinfo.cvc | string | CVC (die Speicherung des CVC in jeglicher Form verstößt gegen die PCI-DSS-Einforderungen) | Erforderlich |
| amount | String | Numerischer Betrag. Zum Beispiel € 24.99 muss angegeben werden als 24.99. If operation is 10, set amount=0 | Erforderlich |
| currency | String | ISO 4217 Währungscode, zum Beispiel EUR oder CHF | Erforderlich |
| description | String | Bestellbeschreibung | Erforderlich |
| form_type | String | Type of the returned url. Default: 01. 01.completed, 02.iframe | Optional |
| demo | String | Benutzerdefiniertes Feld | Optional |
| string | E-Mail-Adresse des Karteninhabers | Erforderlich | |
| timeout | String | Ablaufzeit in Minuten (0-1440) | Erforderlich |
| redirect_url | String | Weiterleitungs-URL nach der Zahlung | Optional |
| notify_url | String | URL für asynchrone Benachrichtigung nach der Zahlung | Erforderlich |
| request_id | String | Eindeutige Einfrage-ID; empfohlen wird eine Kombination aus Ziffern und Buchstaben mit mindestens 24 Zeichen | Erforderlich |
Signaturbeispiel:
Nach Parametern sortierte Werte, verkettet zu einer URL-ähnlichen Abfragezeichenfolge
"3ds_initiate=01&amount=0.1¤cy=EUR&description=test&email=JohnSmith@gmail.com&form_type=01&method=v3.CreateCardPayments¬ify_url=https://www.yabandpay.com/notify&operation=11&order_id=1725875388&pay_method=online&request_id=dxktqiedfpkswnripi631ppg6fl2uoym&sub_pay_method=Cards HPP&time=1725875388&timeout=30&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": 1725875388,
"data": {
"3ds_initiate": "01",
"description": "test",
"timeout": "30",
"pay_method": "online",
"sub_pay_method": "Cards HPP",
"operation": "11",
"form_type": "01",
"order_id": 1725875388,
"amount": "0.1",
"currency": "EUR",
"email": "JohnSmith@gmail.com",
"notify_url": "https://www.yabandpay.com/notify",
"request_id": "dxktqiedfpkswnripi631ppg6fl2uoym"
}
}
Eintwortbeispiel:
{
"status": true,
"code": "200",
"data": {
"order_id": "YOUR_ORDER_ID",
"trade_id": "2b2aa1af-6e97-4c01-8c52-86200bf66c82",
"amount": "0.1",
"currency": "EUR",
"url": "https://pay.yabandpay.com/pay_method/Y3JlZGl0Y2FyZA==/MmIyYWExYWYtNmU5Ny00YzAxLThjNTItODYyMDBiZjY2Yzgy",
"state": "processing"
},
"message": "",
"response_id": "202409091749500451314672"
}
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.
Zahlungsergebnis:
-
Eine erfolgreiche Einfrage gibt "status": true.
-
Eine fehlgeschlagene Einfrage gibt "status": false.
Redirect the customer to the returned url. After entering card details and completing payment at this url, the customer is redirected to redirect_url. Wir empfehlen dringend, sowohl Bestellabfrage and Asynchrone Benachrichtigungen zu verwenden, damit die Zahlungsstatus korrekt und aktuell bleiben.
Returned Token:
-
After the customer grants Autorisierung and the payment succeeds, YabandPay returns payment_token_object through an asynchronous notification.
-
If the customer does not grant Autorisierung or does not complete payment, the asynchronous notification does not return payment_token_object.
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ährung | Betrag |
|---|---|---|
| 1 | EUR | 30 |
| 2 | DKK | 225 |
| 3 | GBP | 27 |
| 4 | SEK | 310 |
| 5 | ISK | 5000 |
| 6 | NOK | 325 |
| 7 | CHF | 32 |
| 8 | PLN | 135 |
| 9 | USD | 36 |
Eintwortcodes:
| Status | Code | Message |
|---|---|---|
| true | 200 | |
| false | -1000 | Internal error |
| false | -403 | The signature Error |
| false | -2001 | The user not exist |
| false | -3001 | Required field is missing |
| false | -4118 | Incorrect request ID |
| false | -4120 | No operational permissions |
