Dokumentation/API-Referenz

API REFERENCE

Kartenzahlung

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

Kartenzahlung

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

Request parameters15

Required fields first

Card Payment

pay_methodRequiredstringdata.pay_methodonline
sub_pay_methodRequiredstringdata.sub_pay_methodCard
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 4
payment_token_objectChoose onestringdata.payment_token_object从YabandPay支付插件获得的字符串cardinfo和payment_token_object二选一
cardinfoChoose onestringdata.cardinfo卡信息cardinfo和payment_token_object二选一,cardinfo的值作为string处理(cardinfo内的字段不用加入排序)
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

Diese API ist für Kunden vorgesehen, die ihre Kartendaten auf der Händlerseite eingeben und nicht auf einer weitergeleiteten YabandPay-Zahlungsseite. Bitte beachten Sie:

  1. Händler mit PCI-DSS-Zertifizierung, die Karteninhaberdaten sicher verarbeiten können, können ein eigenes Kartendatenformular erstellen und die Daten über cardinfo.

  2. Wenn der Händler Kartendaten über das Frontend-Plugin von YabandPay erfasst (Integrationsanweisungen erhalten Sie von YabandPay), gibt das Plugin einen einmalig verwendbaren, verschlüsselten payment_token_object for the subsequent payment request.

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_methodStringCardErforderlich
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
payment_token_objectStringString obtained from the YabandPay payment pluginProvide either cardinfo or payment_token_object
cardinfoStringKarteninformationenProvide either cardinfo or payment_token_object. Treat cardinfo as a string (do not include the fields inside cardinfo in the parameter 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
amountStringBetrag als numerische Zeichenfolge. Geben Sie beispielsweise 24.99 for € 24.99.Erforderlich
currencyStringISO 4217 Währungscode, zum Beispiel EUR oder CHFErforderlich
descriptionStringBestellbeschreibungErforderlich
demoStringBenutzerdefiniertes FeldOptional
emailstringE-Mail-Adresse des KarteninhabersErforderlich
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","card_number":"4356789012345670","expiration_month":"01","expiration_year":"2023","cvc":"123"}&currency=EUR&description=test&email=JohnSmith@gmail.com&method=v3.CreateCardPayments&notify_url=https://www.yabandpay.com/notify&operation=1&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“

Einfragebeispiel using cardinfo:


{
	"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": "1",
		"order_id": 1756878556,
		"cardinfo": "{\"card_holder\":\"John Smith\",\"card_number\":\"4356789012345670\",\"expiration_month\":\"01\",\"expiration_year\":\"2023\",\"cvc\":\"123\"}",
		"sca_exemption": "LowValue",
        "email": "JohnSmith@gmail.com",
		"amount": "0.1",
		"currency": "EUR",
        "redirect_url": "https://www.yabandpay.com/redirect_url",
        "notify_url": "https://www.yabandpay.com/notify",
		"request_id": "a7z1lox4l6z6mdx1udgn5gtezasze1x0"
	}
}

Einfragebeispiel using payment_token_object:

{
    "user": "YOUR_CASHIER_UID",
    "sign": "YOUR_SIGNATURE",
    "method": "v3.CreateCardPayments",
    "time": 1720680417,
    "data": {
        "payment_token_object": "4564sf65as4f5awe4ft65awe4gt65ewaa4t65ew4t65ew4t65rew4t",
        "description": "test",
        "3ds_initiate": "01",
        "timeout": "0",
        "pay_method": "online",
        "sub_pay_method": "Card",
        "operation": "1",
        "order_id": "YOUR_ORDER_ID",
        "amount": "1",
        "currency": "EUR",
        "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 completing 3DS 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