Documentation/API Reference

API REFERENCE

Hosted Payment Solution (HPP)

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

Hosted Payment Solution (HPP)

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

Request parameters10

Required fields first

Hosted Payment Page

pay_methodRequiredstringdata.pay_methodonline
sub_pay_methodRequiredstringdata.sub_pay_methodList
operationRequiredstringdata.operation1.Sales 2.Authorisation;
amountRequiredstringdata.amountAmount as a numeric string. For example, enter 24.99 for € 24.99. CNY amount >=1; EUR amount >=0.1 (for iDeal, Sofort, and PayPal, EUR amount >=1).
currencyRequiredstringdata.currencyISO 4217 currency code, for example EUR or CHF
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.

Supported payment methods: all payment methods

This is a Hosted Payment Page (HPP) solution: YabandPay hosts the checkout, where customers select a payment method and pay. Merchants only need to integrate this checkout instead of integrating each payment method individually, simplifying management and future upgrades.

ParameterTypeDescriptionRequired
userStringCashier account UIDRequired
signStringSignatureRequired
methodStringv3.CreatePaymentsRequired
timeLongTimestampRequired
  • Parameters
ParameterTypeDescriptionRequired
pay_methodStringonlineRequired
sub_pay_methodStringListRequired
order_idStringMerchant order IDRequired
operationString1.Sales 2.Authorisation;Required
amountStringAmount as a numeric string. For example, enter 24.99 for € 24.99. CNY amount >=1; EUR amount >=0.1 (for iDeal, Sofort, and PayPal, EUR amount >=1).Required
currencyStringISO 4217 currency code, for example EUR or CHFRequired
descriptionStringOrder descriptionRequired
demoStringCustom fieldOptional
timeoutStringExpiration time in minutes (0-1440)Required
redirect_urlStringRedirect URL after paymentOptional
notify_urlStringAsynchronous notification URL after paymentRequired

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&operation=1&order_id=20248746132489&pay_method=online&redirect_url=https://www.yabandpay.com&sub_pay_method=List&time=1546588900&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": 1546588900,
    "data": {
        "description": "YabandPay test",
        "timeout": "0",
        "operation": "1",
        "pay_method": "online",
        "sub_pay_method": "List",
        "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": "b769e338-20e7-35fa-dbb4-986892b96079",
        "amount": "1.00",
        "currency": "EUR",
        "url": "https://pay.yabandpay.com/SelectPay/Yjc2OWUzMzgtMjBlNy0zNWZhLWRiYjQtOTg2ODkyYjk2MDc5",
        "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