API REFERENCE
Kartenzahlung
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:
-
Händler mit PCI-DSS-Zertifizierung, die Karteninhaberdaten sicher verarbeiten können, können ein eigenes Kartendatenformular erstellen und die Daten über cardinfo.
-
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.
| 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 | Card | Erforderlich |
| operation | String | 1.Sales 2.Authorisation; | Erforderlich |
| order_id | String | Händlerbestellnummer | Erforderlich |
| 3ds_initiate | String | 01. Enable 3DS verification; 02. Disable 3DS (requires activation approval); 03. SCA exemption (requires activation approval). | Erforderlich |
| sca_exemption | String | LowValue | Required when 3ds_initiate=03 |
| payment_token_object | String | String obtained from the YabandPay payment plugin | Provide either cardinfo or payment_token_object |
| cardinfo | String | Karteninformationen | Provide either cardinfo or payment_token_object. Treat cardinfo as a string (do not include the fields inside cardinfo in the parameter 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 | Betrag als numerische Zeichenfolge. Geben Sie beispielsweise 24.99 for € 24.99. | Erforderlich |
| currency | String | ISO 4217 Währungscode, zum Beispiel EUR oder CHF | Erforderlich |
| description | String | Bestellbeschreibung | Erforderlich |
| 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&cardinfo={"card_holder":"John Smith","card_number":"4356789012345670","expiration_month":"01","expiration_year":"2023","cvc":"123"}¤cy=EUR&description=test&email=JohnSmith@gmail.com&method=v3.CreateCardPayments¬ify_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:
-
Eine erfolgreiche Einfrage gibt "status": true.
-
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:
| 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 |
