Documentatie/API-referentie

API REFERENCE

Gehoste betaaloplossing (HPP)

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

Gehoste betaaloplossing (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.amount金额数字。例如 € 24.99 应该写成24.99,CNY金额>=1,欧元金额>=0.1(iDeal支付、Sofort支付、PayPal支付,欧元金额>=1)
currencyRequiredstringdata.currency货币代码,ISO 4217,例如EUR,CHF
descriptionRequiredstringdata.description订单描述
timeoutRequiredstringdata.timeout过期时间单位分钟(0-1440)
notify_urlRequiredstringdata.notify_url支付完成后异步通知地址
Optional parameters 2
demoOptionalstringdata.demo自定义字段
redirect_urlOptionalstringdata.redirect_url支付完成后跳转地址

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

Ondersteunde betaalmethoden: all payment methods

Dit is een Hosted Payment Page-oplossing (HPP): YabandPay host de checkout, waar klanten een betaalmethode kiezen en betalen. Handelaren hoeven alleen deze checkout te integreren in plaats van elke betaalmethode afzonderlijk. Dit vereenvoudigt het beheer en toekomstige upgrades.

ParameterTypeBeschrijvingVerplicht
userStringKassiersaccount UIDVerplicht
signStringSignatureVerplicht
methodStringv3.CreatePaymentsVerplicht
timeLongTimestampVerplicht
  • Parameters
ParameterTypeBeschrijvingVerplicht
pay_methodStringonlineVerplicht
sub_pay_methodStringListVerplicht
order_idStringMerchant order IDVerplicht
operationString1.Sales 2.Authorisation;Verplicht
amountStringBedrag als numerieke tekenreeks. Voer bijvoorbeeld 24.99 in voor € 24.99. CNY-bedrag >=1; EUR-bedrag >=0.1 (voor iDeal, Sofort en PayPal moet het EUR-bedrag >=1 zijn).Verplicht
currencyStringISO 4217-valutacode, bijvoorbeeld EUR of CHFVerplicht
descriptionStringOrder descriptionVerplicht
demoStringCustom fieldOptioneel
timeoutStringVervaltijd in minuten (0-1440)Verplicht
redirect_urlStringRedirect URL after paymentOptioneel
notify_urlStringAsynchronous notification URL after paymentVerplicht

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": ""
}

Aanvullende informatie:

Resultaat van het antwoord:
  1. Een geslaagde aanvraag retourneert "status": true.
  2. Een mislukte aanvraag retourneert "status": false.

We raden sterk aan zowel Query Order als Asynchronous Notifications te gebruiken om de betalingsstatussen actueel en nauwkeurig te houden.

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