Dokumentation/API-Referenz

API REFERENCE

Token abrufen (direkte Integration)

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

Token abrufen (direkte Integration)

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

Request parameters14

Required fields first

获取Token(Card)

pay_methodRequiredstringdata.pay_methodonline
sub_pay_methodRequiredstringdata.sub_pay_methodCard
operationRequiredstringdata.operation10.Create Token only; 11.Token for sales; 12.Token for authorisation
amountRequiredstringdata.amount金额数字。例如 € 24.99 应该写成24.99。如果operation为10,请设置amount=0
currencyRequiredstringdata.currency货币代码,ISO 4217,例如EUR,CHF
descriptionRequiredstringdata.description订单描述
emailRequiredstringdata.email持卡人email
timeoutRequiredstringdata.timeout过期时间单位分钟(0-1440)
notify_urlRequiredstringdata.notify_url支付完成后异步通知地址
request_idRequiredstringdata.request_id请求id需保持唯一,建议24以上位数字+字母
Optional parameters 3
cardinfoOptionalstringdata.cardinfo卡信息
demoOptionalstringdata.demo自定义字段
redirect_urlOptionalstringdata.redirect_url支付完成后跳转地址

请求参数

3ds_initiateRequiredstringdata.3ds_initiate3ds设置。 01. 必须开启3ds验证;

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

Gilt für: PCI-DSS-zertifizierte Händler und Institutionen

Verwenden Sie diese API für eine vollständige Zahlung (3DS-Prüfung ist obligatorisch). YabandPay wandelt 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:

  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 url. After the user completes 3DS verification through that url, 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 that case, we recommend repeating this transaction flow to obtain a Token and then initiating payment again.
ParameterTypBeschreibungErforderlich
userStringKassiererkonto UIDErforderlich
signStringSignatureErforderlich
methodStringv3.CreateCardPaymentsErforderlich
timeLongTimestampErforderlich
  • Parameter
ParameterTypBeschreibungErforderlich
pay_methodStringonlineErforderlich
sub_pay_methodStringCardErforderlich
operationString10.Create Token only; 11.Token for sales; 12.Token for authorisationErforderlich
order_idStringHändlerbestellnummerErforderlich
3ds_initiateString3ds settings. 01. 3ds verification must be enabled;Erforderlich
cardinfoStringKarteninformationenTreat the value of cardinfo as a string (fields within cardinfo do not need to be included in sorting)
cardinfo.card_holderstringName des KarteninhabersErforderlich
cardinfo.card_numberstringKartennummerErforderlich
cardinfo.expiration_monthstringAblaufmonat der Karte, MMErforderlich
cardinfo.expiration_yearstringAblaufjahr der Karte, JJJJErforderlich
cardinfo.cvcstringCVC (die Speicherung des CVC in jeglicher Form verstößt gegen die PCI-DSS-Einforderungen)Erforderlich
amountStringNumerischer Betrag. Zum Beispiel € 24.99 muss angegeben werden als 24.99. If operation is 10, set amount=0Erforderlich
currencyStringISO 4217 Währungscode, zum Beispiel EUR oder CHFErforderlich
descriptionStringBestellbeschreibungErforderlich
emailstringE-Mail-Adresse des KarteninhabersErforderlich
demoStringBenutzerdefiniertes FeldOptional
timeoutStringAblaufzeit in Minuten (0-1440)Erforderlich
redirect_urlStringWeiterleitungs-URL nach der ZahlungOptional
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=0.1&cardinfo={"card_holder":"John Smith","email":"JohnSmith@gmail.com","card_number":"4356789012345670","expiration_month":"01","expiration_year":"2023","cvc":"123"}&currency=EUR&description=test&method=v3.CreateCardPayments&notify_url=https://www.yabandpay.com/notify&operation=11&order_id=1756878556&pay_method=online&redirect_url=https://www.yabandpay.com/redirect_url&request_id=a7z1lox4l6z6mdx1udgn5gtezasze1x0&sca_exemption=LowValue&sub_pay_method=Card&time=1756878556&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": 1756878556,
	"data": {
		"description": "test",
		"3ds_initiate": "01",
		"timeout": "0",
		"pay_method": "online",
		"sub_pay_method": "Card",
		"operation": "11",
		"order_id": 1756878556,
		"cardinfo": "{\"card_holder\":\"John Smith\",\"card_number\":\"4356789012345670\",\"expiration_month\":\"01\",\"expiration_year\":\"2023\",\"cvc\":\"123\"}",
		"sca_exemption": "LowValue",
		"amount": "0.1",
		"currency": "EUR",
		"email": "JohnSmith@gmail.com",
        "redirect_url": "https://www.yabandpay.com/redirect_url",
        "notify_url": "https://www.yabandpay.com/notify",
		"request_id": "a7z1lox4l6z6mdx1udgn5gtezasze1x0"
	}
}

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:
  1. Eine erfolgreiche Einfrage gibt "status": true.

  2. 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:
  1. After the customer grants Autorisierung and the payment succeeds, YabandPay returns payment_token_object through an asynchronous notification.

  2. 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ä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-4120No operational permissions