Documentatie/API-referentie

API REFERENCE

CardCheck

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

CardCheck

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

Request parameters10

Required fields first

CardCheck

pay_methodRequiredstringdata.pay_methodonline
sub_pay_methodRequiredstringdata.sub_pay_methodCardCheck
operationRequiredstringdata.operation3
descriptionRequiredstringdata.description订单描述
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支付完成后跳转地址

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

Start een autorisatie van 0-waarde zodat de kaarthouder het opgegeven kaartnummer kan laten valideren. De kaarthouder moet geldige gegevens verstrekken om de verificatie te voltooien.

Verificatie kan worden uitgevoerd via de door YabandPay gehoste pagina. Handelaren kunnen aanvragen veilig verwerken door gevoelige PCI DSS-gegevens op het YabandPay-systeem te laten hosten.

Tip

Haal het verificatieresultaat op via Bestelling opvragen.

API-URL:https://mapi.yabandpay.com/Payments

Methode:POST

POST gegevenstype:Json

ParameterTypeBeschrijvingVerplicht
userStringKassiersaccount UIDVerplicht
signStringSignatureVerplicht
methodStringv3.CardCheckVerplicht
timeLongTimestampVerplicht
  • Parameters
ParameterTypeBeschrijvingVerplicht
pay_methodStringonlineVerplicht
sub_pay_methodStringCardCheckVerplicht
operationString3Verplicht
order_idStringBestel-ID van de handelaarVerplicht
descriptionStringBestelomschrijvingVerplicht
form_typeStringType van de geretourneerde url; standaard is 01. 01.completed, 02.iframeOptioneel
demoStringAangepast veldOptioneel
timeoutStringVervaltijd in minuten (0-1440)Verplicht
redirect_urlStringOmleidings-URL na betalingOptioneel
notify_urlStringURL voor asynchrone melding na betalingVerplicht
request_idStringUnieke aanvraag-ID; aanbevolen wordt een combinatie van cijfers en letters van ten minste 24 tekensVerplicht

Handtekeningvoorbeeld:

Gesorteerde parameters aaneengevoegd tot een queryreeks in URL-stijl

"description=cardcheck test&form_type=01&method=v3.CardCheck&notify_url=https://www.yabandpay.com/notify&operation=3&order_id=203040950640690239603690&pay_method=online&redirect_url=https://www.yabandpay.com/redirect_url&request_id=tscqf7ki76o7aem4z1yl1xs72f89fptl&sub_pay_method=CardCheck&time=1720680417&timeout=0&user=YOUR_CASHIER_UID"

Onderteken stringA met secret_key

De resulterende handtekening is:

"YOUR_SIGNATURE"

Aanvraagvoorbeeld:

{
    "user": "YOUR_CASHIER_UID",
    "sign": "YOUR_SIGNATURE",
    "method": "v3.CardCheck",
    "time": 1720680417,
    "data": {
        "description": "cardcheck test",
        "form_type": "01",
        "timeout": "0",
        "pay_method": "online",
        "sub_pay_method": "CardCheck",
        "operation": "3",
        "order_id": "YOUR_ORDER_ID",
        "redirect_url": "https://www.yabandpay.com/redirect_url",
        "notify_url": "https://www.yabandpay.com/notify",
        "request_id": "tscqf7ki76o7aem4z1yl1xs72f89fptl"
    }
}

Antwoordvoorbeeld:

{
    "status": true,
    "code": "200",
    "data": {
        "order_id": "YOUR_ORDER_ID",
        "trade_id": "160899f3-f6d9-a8d8-ab5b-82eacdab9c5b",
        "amount": "0.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.

Leid de gebruiker om naar de geretourneerde url. Nadat de gebruiker de kaartgegevens op deze url heeft ingevoerd en de betaling heeft voltooid, wordt die gebruiker synchroon teruggestuurd naar redirect_url. We raden sterk aan zowel Bestelling opvragen als Asynchrone meldingen te gebruiken om de betalingsstatus te synchroniseren en bij te werken, zodat de betalingsinformatie in realtime actueel blijft. a) Als de bestelstatus state op paid staat, is de betaling geslaagd;

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