Documentation/API Reference

API REFERENCE

EPS

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

EPS

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

Request parameters9

Required fields first

Introduction

pay_methodRequiredstringdata.pay_methodonline
sub_pay_methodRequiredstringdata.sub_pay_methodEPS
amountRequiredstringdata.amountNumeric amount. For example, € 24.99 must be written as 24.99; euro amount>=1
currencyRequiredstringdata.currencyEUR
descriptionRequiredstringdata.descriptionOrder description
timeoutRequiredstringdata.timeoutExpiration time in minutes (0-1440)
notify_urlRequiredstringdata.notify_urlAsynchronous notification URL after payment
Optional parameters 2
demoOptionalstringdata.demoCustom field
redirect_urlOptionalstringdata.redirect_urlRedirect URL after payment

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

EPS is an online transfer system jointly developed by Austrian banks and the government. It is a major bank transfer payment method in Austria and is popular with Austrian shoppers. Customers who select EPS at checkout are redirected to their bank's online banking page, where they authorize payment through the online banking interface using the bank's security protocols. Funds are transferred from their bank account, payment is processed in real time, and both customer and merchant receive immediate payment confirmation.


ParameterTypeDescriptionRequired
userStringCashier account UIDRequired
signStringSignatureRequired
methodStringv3.CreatePaymentsRequired
timeLongTimestampRequired
  • Parameters
ParameterTypeDescriptionRequired
pay_methodStringonlineRequired
sub_pay_methodStringEPSRequired
order_idStringMerchant order IDRequired
amountStringNumeric amount. For example, € 24.99 must be written as 24.99; euro amount>=1Required
currencyStringEURRequired
descriptionStringOrder descriptionRequired
demoStringCustom fieldOptional
timeoutStringExpiration time in minutes (0-1440)Required
redirect_urlStringRedirect URL after payment completionOptional
notify_urlStringAsynchronous notification URL after payment completionRequired

Signature example:

Sorted parameters concatenated into a URL-style query string

"amount=1&currency=EUR&demo=test&description=YabandPay test&method=v3.CreatePayments&notify_url=https://www.yabandpay.com/notify&order_id=202508271641&pay_method=online&redirect_url=https://www.yabandpay.com&sub_pay_method=EPS&time=1646388458&timeout=0&user=YOUR_CASHIER_UID"

Sign stringA using secret_key

The resulting signature is:

"YOUR_SIGNATURE"

Request example:

{
  "user": "YOUR_CASHIER_UID",
  "sign": "YOUR_SIGNATURE",
  "method": "v3.CreatePayments",
  "time": 1646388458,
  "data": {
    "description": "YabandPay test",
    "timeout":"0",
    "pay_method": "online",
    "sub_pay_method": "EPS",
    "order_id": "YOUR_ORDER_ID",
    "amount": "1",
    "currency": "EUR",
    "redirect_url": "https://www.yabandpay.com",
    "notify_url": "https://www.yabandpay.com/notify",
    "demo": "test"
  }
}

Response example:

{
  "status": true,
  "code": "200",
  "data": {
    "order_id": "YOUR_ORDER_ID",
    "trade_id": "c9a8217a-69d2-8338-c065-d24947aabd5a",
    "amount": "1.00",
    "currency": "EUR",
    "url": "https://pay.yabandpay.com/pay_method/ZXBz/YzlhODIxN2EtNjlkMi04MzM4LWMwNjUtZDI0OTQ3YWFiZDVh",
    "state": "processing"
  },
  "message": ""
}

Additional information:

Response result:
  1. A successful request returns "status": true.

  2. A failed request returns "status": false.

We strongly recommend using both Query Order and Asynchronous Notifications to keep payment statuses accurate and up to date.

Response codes:
StatusCodeMessage
true200Success
false-1000Internal error
false-3001Required field is missing
false-403The signature Error
false-4011Not support the payment method