Dokumentation/API-Referenz

API REFERENCE

Gehostete Zahlungsseite

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

Gehostete Zahlungsseite

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

Request parameters14

Required fields first

Hosted Payment Page

pay_methodRequiredstringdata.pay_methodonline
sub_pay_methodRequiredstringdata.sub_pay_methodCards HPP
operationRequiredstringdata.operation1.Sales 2.Authorisation;
amountRequiredstringdata.amount金额数字。例如 € 24.99 应该写成24.99
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
form_typeOptionalstringdata.form_type返回的url类型,默认01。 01.completed, 02.iframe
demoOptionalstringdata.demo自定义字段
redirect_urlOptionalstringdata.redirect_url支付完成后跳转地址

请求参数

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.

Für Kartenautorisierungen und Direktkäufe

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.

Tipp

Authorizations are valid for 30 days. Authorization orders expire automatically after 30 days.

ParameterTypBeschreibungErforderlich
userStringKassiererkonto UIDErforderlich
signStringSignatureErforderlich
methodStringv3.CreateCardPaymentsErforderlich
timeLongTimestampErforderlich
  • Parameter
ParameterTypBeschreibungErforderlich
pay_methodStringonlineErforderlich
sub_pay_methodStringKarten-HPPErforderlich
operationString1.Sales 2.Authorisation;Erforderlich
order_idStringHändlerbestellnummerErforderlich
3ds_initiateString01. Enable 3DS verification; 02. Disable 3DS (requires activation approval); 03. SCA exemption (requires activation approval).Erforderlich
sca_exemptionStringLowValueRequired when 3ds_initiate=03
amountStringBetrag als numerische Zeichenfolge. Geben Sie beispielsweise 24.99 for € 24.99.Erforderlich
currencyStringISO 4217 Währungscode, zum Beispiel EUR oder CHFErforderlich
descriptionStringBestellbeschreibungErforderlich
form_typeStringType of returned url; defaults to 01. 01.completed, 02.iframeOptional
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=1&currency=EUR&description=test&email=JohnSmith@gmail.com&form_type=01&method=v3.CreateCardPayments&notify_url=https://www.yabandpay.com/notify&operation=1&order_id=203040950640690239603690&pay_method=online&redirect_url=https://www.yabandpay.com/redirect_url&request_id=tscqf7ki76o7aem4z1yl1xs72f89fptl&sub_pay_method=Cards HPP&time=1720680417&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": 1720680417,
    "data": {
        "description": "test",
        "form_type": "01",
        "3ds_initiate": "01",
        "timeout": "0",
        "pay_method": "online",
        "sub_pay_method": "Cards HPP",
        "operation": "1",
        "order_id": "YOUR_ORDER_ID",
        "amount": "1",
        "currency": "EUR",
        "email": "JohnSmith@gmail.com",
        "redirect_url": "https://www.yabandpay.com/redirect_url",
        "notify_url": "https://www.yabandpay.com/notify",
        "request_id": "tscqf7ki76o7aem4z1yl1xs72f89fptl"
    }
}

Eintwortbeispiel:

{
    "status": true,
    "code": "200",
    "data": {
        "order_id": "YOUR_ORDER_ID",
        "trade_id": "160899f3-f6d9-a8d8-ab5b-82eacdab9c5b",
        "amount": "1.00",
        "currency": "EUR",
        "url": "https://pay.yabandpay.com/payments/callback/order/MTYwODk5ZjMtZjZkOS1hOGQ4LWFiNWItODJlYWNkYWI5YzVi",
        "state": "processing"
    },
    "message": "",
    "response_id": "202407111544200649155078"
}

Zusätzliche Informationen:

Eintwortergebnis:
  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 there, the customer is redirected to redirect_url. Wir empfehlen dringend, sowohl Bestellabfrage and Asynchrone Benachrichtigungen zu verwenden, damit die Zahlungsstatus korrekt und aktuell bleiben. a) Ein order state of paid indicates a successful payment. b) Ein order state of authorized indicates a successful Autorisierung. To capture an authorized payment, call the Capture Authorization API.

Eintwortcodes:
StatusCodeMessage
true200
false-1000Internal error
false-403The signature Error
false-2001The user not exist
false-3001Required field is missing
false-4118Incorrect request ID