Documentatie/API-referentie

API REFERENCE

Tokenbetalingen

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

Tokenbetalingen

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

Request parameters12

Required fields first

Token支付

pay_methodRequiredstringdata.pay_methodonline
sub_pay_methodRequiredstringdata.sub_pay_methodToken
operationRequiredstringdata.operation11.Token for sales 12.Token for authorisation;
amountRequiredstringdata.amount金额数字。例如 € 24.99 应该写成24.99
currencyRequiredstringdata.currency货币代码,ISO 4217,例如EUR,CHF
payment_token_objectRequiredstringdata.payment_token_object支付Token
descriptionRequiredstringdata.description订单描述
timeoutRequiredstringdata.timeout过期时间单位分钟(0-1440)
notify_urlRequiredstringdata.notify_url支付完成后异步通知地址
request_idRequiredstringdata.request_id请求id需保持唯一,建议24以上位数字+字母
Optional parameters 1
demoOptionalstringdata.demo自定义字段

请求参数

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.

Van toepassing op: betalingen met Token starten - creditcards

Nadat de betaler een standaardcreditcardtransactie op de gehoste betaalpagina van YabandPay heeft voltooid en toestemming heeft gegeven, zet YabandPay de gevoelige kaarthoudergegevens om in een willekeurige numerieke tekenreeks (een Token), zodat de gegevens niet meer naar de kaarthouder te herleiden zijn. Het Token kan voor de volgende betalingen worden gebruikt:

  1. Klanten kunnen met één klik op de checkoutpagina betalen zonder creditcardgegevens in te voeren.
  2. Handelaren kunnen het Token gebruiken voor terugkerende betalingen, abonnementskosten en vergelijkbare doeleinden.

[!TIP|style:flat] Workflow

  1. Schakel Token-betalingen in. Neem contact op met uw accountmanager om de Token-betaalfunctie te activeren.
  1. Verkrijg toestemming van de gebruiker. Wanneer u expressbetalingen (Token-betalingen) voor consumenten inschakelt, moet u gebruikers duidelijk informeren en hun toestemming verkrijgen om mogelijke geschillen te voorkomen.
  1. Verkrijg een Token. Start eerst een standaardcreditcardtransactie. YabandPay retourneert een betaal-URL. Nadat de gebruiker via die URL heeft betaald en toestemming heeft gegeven, retourneert YabandPay het Token in een asynchrone melding met de parameter payment_token_object.
  1. Start een Token-betaling. Neem het Token op in de variabele payment_token_object. Als de Token-validatie slaagt, verwerkt YabandPay de betaling. Als de validatie mislukt, retourneert YabandPay een fout. In dat geval raden we aan opnieuw een standaardcreditcardtransactie te starten om een Token te verkrijgen en daarna de betaling opnieuw te starten.
ParameterTypeBeschrijvingVerplicht
userStringKassiersaccount UIDVerplicht
signStringSignatureVerplicht
methodStringv3.CreateCardPaymentsVerplicht
timeLongTimestampVerplicht
  • Parameters
ParameterTypeBeschrijvingVerplicht
pay_methodStringonlineVerplicht
sub_pay_methodStringTokenVerplicht
operationString11.Token for sales 12.Token for 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_exemptionStringLowValue3ds_initiate=03 Required
amountStringBedrag als numerieke tekenreeks. Voer bijvoorbeeld 24.99 in voor € 24.99.Verplicht
currencyStringISO 4217 currency code, for example EUR or CHFVerplicht
payment_token_objectStringPayment TokenVerplicht
descriptionStringBestelomschrijvingVerplicht
demoStringAangepast veldOptioneel
timeoutStringVervaltijd in minuten (0-1440)Verplicht
notify_urlStringURL voor asynchrone melding na betalingVerplicht
request_idStringUnieke aanvraag-ID; aanbevolen wordt een combinatie van cijfers en letters van ten minste 24 tekensVerplicht

Signature example:

Sorted parameters concatenated into a URL-style query string

"3ds_initiate=01&amount=1&currency=EUR&description=test&method=v3.CreateCardPayments&notify_url=https://www.yabandpay.com/notify&operation=11&order_id=1725875543&pay_method=online&payment_token_object=VnXaRabcsedfsSlPFZXavcsdfasdEFDd&request_id=hjf5lv32i40lh7oh86j6az98tnscwv37&sub_pay_method=Token&time=1725875543&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": 1725875543,
    "data": {
        "3ds_initiate": "01",
        "description": "test",
        "timeout": "0",
        "pay_method": "online",
        "sub_pay_method": "Token",
        "operation": "11",
        "order_id": 1725875543,
        "amount": "1",
        "currency": "EUR",
        "payment_token_object": "VnXaRabcsedfsSlPFZXavcsdfasdEFDd",
        "notify_url": "https://www.yabandpay.com/notify",
        "request_id": "hjf5lv32i40lh7oh86j6az98tnscwv37"
    }
}

Response example:

{
    "status": true,
    "code": "200",
    "data": {
        "order_id": "YOUR_ORDER_ID",
        "trade_id": "109bb0e9-e1fb-49cb-c537-ec944f33c388",
        "amount": "1.00",
        "currency": "EUR",
        "state": "paid"
    },
    "message": "",
    "response_id": "202409091752241912726578"
}

Aanvullende informatie:

MIT & CIT:

MIT = Merchant Initiated subsequent transactions. Token-betalingen die door de handelaar worden gestart.

CIT = Cardholder Initiated Subsequent transactions. Token-betalingen waarbij de klant betrokken is. Geef bij het activeren van betalingen aan of u MIT of CIT nodig hebt, zodat de juiste modus kan worden ingesteld.

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

  2. Bij een mislukte aanroep wordt "status": false geretourneerd. Als u Invalid Token ontvangt, raden we aan HPP Token opnieuw aan te roepen om een nieuw Token te verkrijgen.

De API retourneert de betalingsstatus synchroon. We raden sterk aan zowel Order Query als Asynchronous Notifications te gebruiken om de betalingsstatus te synchroniseren en bij te werken, zodat de betalingsinformatie in realtime actueel blijft. a) Als de bestelstatus state gelijk is aan paid, is de betaling geslaagd; b) als de bestelstatus state gelijk is aan authorized, is de autorisatie geslaagd. Roep na een geslaagde autorisatie de API voor het incasseren van de autorisatie aan om het bedrag te incasseren.

Vrijstelling van 3DS voor lage bedragen:

Transacties tot de onderstaande limieten komen mogelijk in aanmerking als transactie met een laag bedrag. Als het bestelbedrag niet hoger is dan het toepasselijke bedrag hieronder, mag transactiecode 02 (vrijstelling voor lage bedragen) met goedkeuring worden gebruikt.

#CurrencyAmount
1EUR30
2DKK225
3GBP27
4SEK310
5ISK5000
6NOK325
7CHF32
8PLN135
9USD36
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
false-4119Invalid Token
false-4120No operational permissions