Documentatie/API-referentie

API REFERENCE

Gehoste betaalpagina

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

Gehoste betaalpagina

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

Request parameters14

Required fields first

Hosted Payment Page

pay_methodRequiredstringdata.pay_methodonline
sub_pay_methodRequiredstringdata.sub_pay_methodCards HPP
operationRequiredstringdata.operation1.Sales 2.Authorisation;
amountRequiredstringdata.amount金额数字。例如 € 24.99 应该写成24.99
currencyRequiredstringdata.currency货币代码,ISO 4217,例如EUR,CHF
descriptionRequiredstringdata.description订单描述
emailRequiredstringdata.email持卡人email
timeoutRequiredstringdata.timeout过期时间单位分钟(0-1440)
notify_urlRequiredstringdata.notify_url支付完成后异步通知地址
request_idRequiredstringdata.request_id请求id需保持唯一,建议24以上位数字+字母
Optional parameters 3
form_typeOptionalstringdata.form_type返回的url类型,默认01。 01.completed, 02.iframe
demoOptionalstringdata.demo自定义字段
redirect_urlOptionalstringdata.redirect_url支付完成后跳转地址

请求参数

3ds_initiateRequiredstringdata.3ds_initiate01. 开启3ds验证; 02.不开启3DS(需申请开通);03. SCA豁免(需申请开通);

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

Voor kaartautorisaties en directe aankopen

De Hosted Payment Page (HPP) van YabandPay is een gebruiksklare betaalpagina die volledig door YabandPay wordt beheerd. Handelaren kunnen betalingen veilig accepteren doordat gevoelige PCI-gegevens op het systeem van YabandPay worden gehost. Het formulier kan als iframe of omleidingspagina in de checkout van de handelaar worden opgenomen.

Tip

Autorisaties zijn 30 dagen geldig. Autorisatiebestellingen verlopen automatisch na 30 dagen.

ParameterTypeBeschrijvingVerplicht
userStringKassiersaccount UIDVerplicht
signStringSignatureVerplicht
methodStringv3.CreateCardPaymentsVerplicht
timeLongTimestampVerplicht
  • Parameters
ParameterTypeBeschrijvingVerplicht
pay_methodStringonlineVerplicht
sub_pay_methodStringCards HPPVerplicht
operationString1.Sales 2.Authorisation;Verplicht
order_idStringMerchant order IDVerplicht
3ds_initiateString01. Enable 3DS verification; 02. Disable 3DS (requires activation approval); 03. SCA exemption (requires activation approval).Verplicht
sca_exemptionStringLowValueRequired when 3ds_initiate=03
amountStringBedrag als numerieke tekenreeks. Voer bijvoorbeeld 24.99 in voor € 24.99.Verplicht
currencyStringISO 4217 currency code, for example EUR or CHFVerplicht
descriptionStringOrder descriptionVerplicht
form_typeStringType of returned url; defaults to 01. 01.completed, 02.iframeOptioneel
emailstringCardholder emailVerplicht
demoStringCustom fieldOptioneel
timeoutStringVervaltijd in minuten (0-1440)Verplicht
redirect_urlStringRedirect URL after paymentOptioneel
notify_urlStringAsynchronous notification URL after paymentVerplicht
request_idStringUnique request ID; a combination of digits and letters at least 24 characters is recommendedVerplicht

Signature example:

Sorted parameters concatenated into a URL-style query string

"3ds_initiate=01&amount=1&currency=EUR&description=test&email=JohnSmith@gmail.com&form_type=01&method=v3.CreateCardPayments&notify_url=https://www.yabandpay.com/notify&operation=1&order_id=203040950640690239603690&pay_method=online&redirect_url=https://www.yabandpay.com/redirect_url&request_id=tscqf7ki76o7aem4z1yl1xs72f89fptl&sub_pay_method=Cards HPP&time=1720680417&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.CreateCardPayments",
    "time": 1720680417,
    "data": {
        "description": "test",
        "form_type": "01",
        "3ds_initiate": "01",
        "timeout": "0",
        "pay_method": "online",
        "sub_pay_method": "Cards HPP",
        "operation": "1",
        "order_id": "YOUR_ORDER_ID",
        "amount": "1",
        "currency": "EUR",
        "email": "JohnSmith@gmail.com",
        "redirect_url": "https://www.yabandpay.com/redirect_url",
        "notify_url": "https://www.yabandpay.com/notify",
        "request_id": "tscqf7ki76o7aem4z1yl1xs72f89fptl"
    }
}

Response example:

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

Aanvullende informatie:

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

  2. Een mislukte aanvraag retourneert "status": false.

Stuur de klant door naar de geretourneerde url. Nadat de klant daar de kaartgegevens heeft ingevoerd en de betaling heeft voltooid, wordt deze doorgestuurd naar redirect_url. We raden sterk aan zowel Query Order als Asynchronous Notifications te gebruiken om de betalingsstatussen actueel en nauwkeurig te houden. a) Een bestelstatus state van paid betekent dat de betaling is geslaagd. b) Een bestelstatus state van authorized betekent dat de autorisatie is geslaagd. Roep de API voor het incasseren van de autorisatie aan om een geautoriseerde betaling te incasseren.

Response codes:
StatusCodeMessage
true200
false-1000Internal error
false-403The signature Error
false-2001The user not exist
false-3001Required field is missing
false-4118Incorrect request ID