Documentatie/API-referentie

API REFERENCE

Kaartbetaling

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

Kaartbetaling

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

Request parameters15

Required fields first

Card Payment

pay_methodRequiredstringdata.pay_methodonline
sub_pay_methodRequiredstringdata.sub_pay_methodCard
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 4
payment_token_objectChoose onestringdata.payment_token_object从YabandPay支付插件获得的字符串cardinfo和payment_token_object二选一
cardinfoChoose onestringdata.cardinfo卡信息cardinfo和payment_token_object二选一,cardinfo的值作为string处理(cardinfo内的字段不用加入排序)
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

Deze API is bedoeld voor klanten die kaartgegevens invoeren op de pagina van de handelaar en niet op een gehoste betaalpagina van YabandPay waarnaar zij zijn doorgestuurd. Let op:

  1. Handelaren met een PCI DSS-certificering die kaarthoudergegevens veilig kunnen verwerken, kunnen zelf een formulier voor kaartgegevens bouwen en de gegevens verzenden via cardinfo.

  2. Als de handelaar kaartgegevens verzamelt met de frontendplug-in van YabandPay (neem contact op met YabandPay voor integratie-instructies), retourneert de plug-in een eenmalig versleuteld payment_token_object for the subsequent payment request.

Tip

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

ParameterTypeBeschrijvingVerplicht
userStringCashier account UIDVerplicht
signStringSignatureVerplicht
methodStringv3.CreateCardPaymentsVerplicht
timeLongTimestampVerplicht
  • Parameters
ParameterTypeBeschrijvingVerplicht
pay_methodStringonlineVerplicht
sub_pay_methodStringCardVerplicht
operationString1.Sales 2.Authorisation;Verplicht
order_idStringMerchant order IDVerplicht
3ds_initiateString01. Schakel 3DS-verificatie in; 02. Schakel 3DS uit (activering vereist goedkeuring); 03. SCA-vrijstelling (activering vereist goedkeuring).Verplicht
sca_exemptionStringLowValueVerplicht wanneer 3ds_initiate=03
payment_token_objectStringTekenreeks verkregen via de betalingsplug-in van YabandPayGeef cardinfo of payment_token_object
cardinfoStringKaartgegevensGeef cardinfo of payment_token_object. Behandel cardinfo als een tekenreeks (neem velden binnen cardinfo niet op in de parametersortering).
cardinfo.card_holderstringNaam van de kaarthouderVerplicht
cardinfo.card_numberstringKaartnummerVerplicht
cardinfo.expiration_monthstringVervalmaand van de kaart, MMVerplicht
cardinfo.expiration_yearstringVervaljaar van de kaart, YYYYVerplicht
cardinfo.cvcstringCVC (het opslaan van de CVC in welke vorm dan ook is in strijd met PCI DSS-vereisten)Verplicht
amountStringBedrag als numerieke tekenreeks. Voer bijvoorbeeld 24.99 in voor € 24.99.Verplicht
currencyStringISO 4217 currency code, bijvoorbeeld EUR of CHFVerplicht
descriptionStringBestelomschrijvingVerplicht
demoStringAangepast veldOptioneel
emailstringE-mailadres van de kaarthouderVerplicht
timeoutStringVervaltijd in minuten (0-1440)Verplicht
redirect_urlStringRedirect URL after paymentOptioneel
notify_urlStringURL voor asynchrone melding na betalingVerplicht
request_idStringUnieke aanvraag-ID; aanbevolen wordt een combinatie van cijfers en letters van ten minste 24 characters is recommendedVerplicht

Signature example:

Gesorteerde parameters aaneengevoegd tot een queryreeks in URL-stijl

”3ds_initiate=01&amount=0.1&cardinfo={"card_holder":"John Smith","card_number":"4356789012345670","expiration_month":"01","expiration_year":"2023","cvc":"123"}&currency=EUR&description=test&email=JohnSmith@gmail.com&method=v3.CreateCardPayments&notify_url=https://www.yabandpay.com/notify&operation=1&order_id=1756878556&pay_method=online&redirect_url=https://www.yabandpay.com/redirect_url&request_id=a7z1lox4l6z6mdx1udgn5gtezasze1x0&sca_exemption=LowValue&sub_pay_method=Card&time=1756878556&timeout=0&user=YOUR_CASHIER_UID“

Request example met cardinfo:


{
	"user": "YOUR_CASHIER_UID",
	"sign": "YOUR_SIGNATURE",
	"method": "v3.CreateCardPayments",
	"time": 1756878556,
	"data": {
		"description": "test",
		"3ds_initiate": "01",
		"timeout": "0",
		"pay_method": "online",
		"sub_pay_method": "Card",
		"operation": "1",
		"order_id": 1756878556,
		"cardinfo": "{\"card_holder\":\"John Smith\",\"card_number\":\"4356789012345670\",\"expiration_month\":\"01\",\"expiration_year\":\"2023\",\"cvc\":\"123\"}",
		"sca_exemption": "LowValue",
        "email": "JohnSmith@gmail.com",
		"amount": "0.1",
		"currency": "EUR",
        "redirect_url": "https://www.yabandpay.com/redirect_url",
        "notify_url": "https://www.yabandpay.com/notify",
		"request_id": "a7z1lox4l6z6mdx1udgn5gtezasze1x0"
	}
}

Request example met payment_token_object:

{
    "user": "YOUR_CASHIER_UID",
    "sign": "YOUR_SIGNATURE",
    "method": "v3.CreateCardPayments",
    "time": 1720680417,
    "data": {
        "payment_token_object": "4564sf65as4f5awe4ft65awe4gt65ewaa4t65ew4t65ew4t65rew4t",
        "description": "test",
        "3ds_initiate": "01",
        "timeout": "0",
        "pay_method": "online",
        "sub_pay_method": "Card",
        "operation": "1",
        "order_id": "YOUR_ORDER_ID",
        "amount": "1",
        "currency": "EUR",
        "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:

Response result:
  1. Een geslaagde aanvraag retourneert "status": true.

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

Stuur de klant door naar de geretourneerde url. Na het voltooien van 3DS wordt de klant doorgestuurd naar redirect_url. We raden sterk aan zowel Query Order and Asynchronous Notifications te gebruiken om de betalingsstatussen actueel en nauwkeurig te houden. a) Een bestelling met status state of paid duidt op een geslaagde betaling. b) Een bestelling met status state of authorized duidt op een geslaagde autorisatie. Roep de API Capture Authorization 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