API REFERENCE
Gutschein
Gilt für: Geschenkkarten
Bei dieser Zahlungsmethode wird eine Bestellung mit dem Guthaben einer Geschenkkarte bezahlt. Geschenkkarten müssen an der Verkaufsstelle aktiviert werden.
| Parameter | Typ | Beschreibung | Erforderlich |
|---|---|---|---|
| user | String | Kassiererkonauf UID | Erforderlich |
| sign | String | Signature | Erforderlich |
| method | String | v3.CreatePaymentsVoucher | Erforderlich |
| time | Long | Timestamp | Erforderlich |
- Parameter
| Parameter | Typ | Beschreibung | Erforderlich |
|---|---|---|---|
| pay_method | String | online | Erforderlich |
| sub_pay_method | String | Voucher | Erforderlich |
| order_id | String | Händlerbestellnummer | Erforderlich |
| amount | String | Numerischer Betrag. Zum Beispiel € 24.99 muss angegeben werden als 24.99; Euro-Betrag >=1 | Erforderlich |
| currency | String | EUR | Erforderlich |
| description | String | Bestellbeschreibung | Erforderlich |
| demo | String | Benutzerdefiniertes Feld | Optional |
| timeout | String | Ablaufzeit in Minuten (0-1440) | Erforderlich |
| redirect_url | String | Weiterleitungs-URL nach der Zahlung bei Verwendung der gehosteten Seite | Optional |
| notify_url | String | URL für asynchrone Benachrichtigung nach der Zahlung | Erforderlich |
| cardnumber | String | Gift card number (not required when redirecting auf the hosted page) | Optional |
| pincode | String | Gift card PIN (required if cardnumber is provided) | Optional |
Signaturbeispiel:
Nach Parametern sortierte Werte, verkettet zu einer URL-ähnlichen Abfragezeichenfolge
"amount=0.01&cardnumber=6064364245787814896¤cy=EUR&demo=test&description=YabandPay test VVV&method=v3.CreatePaymentsVoucher¬ify_url=https://www.yabandpay.com/notify&order_id=202405110140188881&pay_method=online&pincode=568971&redirect_url=https://www.yabandpay.com&sub_pay_method=Voucher&time=1546588959&timeout=0&user=YOUR_CASHIER_UID"
Signieren Sie die Zeichenfolge A mit secret_key
Die resultierende Signatur lautet:
"YOUR_SIGNATURE"
Anfragebeispiel:
{
"user": "YOUR_CASHIER_UID",
"sign": "YOUR_SIGNATURE",
"method": "v3.CreatePaymentsVoucher",
"time": 1546588959,
"data": {
"description": "YabandPay test VVV",
"timeout": "0",
"pay_method": "online",
"sub_pay_method": "Voucher",
"order_id": "YOUR_ORDER_ID",
"amount": "0.01",
"currency": "EUR",
"redirect_url": "https://www.yabandpay.com",
"notify_url": "https://www.yabandpay.com/notify",
"demo": "test",
"cardnumber": "6064364245787814896",
"pincode": "568971"
}
}
Antwortbeispiel:
{
"status": true,
"code": "200",
"data": {
"order_id": "YOUR_ORDER_ID",
"trade_id": "535ea4a1-917a-bc14-58e2-d1565720af90",
"amount": "0.01",
"currency": "EUR",
"settlement_amount": "0.01",
"settlement_currency": "EUR",
"exchange_rate": "1",
"url": "",
"state": "processing"
},
"message": ""
}
Hosted page integration:
Use this method auf verify the gift card number und PIN on the YabundPay hosted page. In this case, do not pass cardnumber or pincode. After the API call, redirect auf the returned url auf continue the payment flow.
Anfragebeispiel:
{
"user": "YOUR_CASHIER_UID",
"sign": "YOUR_SIGNATURE",
"method": "v3.CreatePaymentsVoucher",
"time": 1546588959,
"data": {
"description": "YabandPay test VVV",
"timeout": "0",
"pay_method": "online",
"sub_pay_method": "Voucher",
"order_id": "YOUR_ORDER_ID",
"amount": "0.01",
"currency": "EUR",
"redirect_url": "https://www.yabandpay.com",
"notify_url": "https://www.yabandpay.com/notify",
"demo": "test"
}
}
Antwortbeispiel:
{
"status": true,
"code": "200",
"data": {
"order_id": "YOUR_ORDER_ID",
"trade_id": "c0d9c0bb-0b40-1cb6-7373-fd1a97c7124e",
"amount": "0.01",
"currency": "EUR",
"url": "https://pay.yabandpay.com/payments/callback/order/YzBkOWMwYmItMGI0MC0xY2I2LTczNzMtZmQxYTk3YzcxMjRl",
"state": "processing"
},
"message": ""
}
Zusätzliche Informationen:
Antwortergebnis:
-
Eine erfolgreiche Anfrage gibt "status": true.
-
Eine fehlgeschlagene Anfrage gibt "status": false.
Wir empfehlen dringend, sowohl Bestellabfrage und Asynchrone Benachrichtigungen um Zahlungsstatus korrekt und aktuell zu halten.
Antwortcodes:
| Status | Code | Message |
|---|---|---|
| true | 200 | |
| false | -1000 | Internal error |
| false | -104000 | You have entered an invalid amount |
| false | -104221 | The voucher has insufficient funds |
| false | -104222 | Invaild PinCode |
| false | -104223 | This is an invalid giftcard, we are unable to find the giftcard brand |
