API REFERENCE
Kaartbetaling
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:
-
Handelaren met een PCI DSS-certificering die kaarthoudergegevens veilig kunnen verwerken, kunnen zelf een formulier voor kaartgegevens bouwen en de gegevens verzenden via cardinfo.
-
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.
| Parameter | Type | Beschrijving | Verplicht |
|---|---|---|---|
| user | String | Cashier account UID | Verplicht |
| sign | String | Signature | Verplicht |
| method | String | v3.CreateCardPayments | Verplicht |
| time | Long | Timestamp | Verplicht |
- Parameters
| Parameter | Type | Beschrijving | Verplicht |
|---|---|---|---|
| pay_method | String | online | Verplicht |
| sub_pay_method | String | Card | Verplicht |
| operation | String | 1.Sales 2.Authorisation; | Verplicht |
| order_id | String | Merchant order ID | Verplicht |
| 3ds_initiate | String | 01. Schakel 3DS-verificatie in; 02. Schakel 3DS uit (activering vereist goedkeuring); 03. SCA-vrijstelling (activering vereist goedkeuring). | Verplicht |
| sca_exemption | String | LowValue | Verplicht wanneer 3ds_initiate=03 |
| payment_token_object | String | Tekenreeks verkregen via de betalingsplug-in van YabandPay | Geef cardinfo of payment_token_object |
| cardinfo | String | Kaartgegevens | Geef cardinfo of payment_token_object. Behandel cardinfo als een tekenreeks (neem velden binnen cardinfo niet op in de parametersortering). |
| cardinfo.card_holder | string | Naam van de kaarthouder | Verplicht |
| cardinfo.card_number | string | Kaartnummer | Verplicht |
| cardinfo.expiration_month | string | Vervalmaand van de kaart, MM | Verplicht |
| cardinfo.expiration_year | string | Vervaljaar van de kaart, YYYY | Verplicht |
| cardinfo.cvc | string | CVC (het opslaan van de CVC in welke vorm dan ook is in strijd met PCI DSS-vereisten) | Verplicht |
| amount | String | Bedrag als numerieke tekenreeks. Voer bijvoorbeeld 24.99 in voor € 24.99. | Verplicht |
| currency | String | ISO 4217 currency code, bijvoorbeeld EUR of CHF | Verplicht |
| description | String | Bestelomschrijving | Verplicht |
| demo | String | Aangepast veld | Optioneel |
| string | E-mailadres van de kaarthouder | Verplicht | |
| timeout | String | Vervaltijd in minuten (0-1440) | Verplicht |
| redirect_url | String | Redirect URL after payment | Optioneel |
| notify_url | String | URL voor asynchrone melding na betaling | Verplicht |
| request_id | String | Unieke aanvraag-ID; aanbevolen wordt een combinatie van cijfers en letters van ten minste 24 characters is recommended | Verplicht |
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"}¤cy=EUR&description=test&email=JohnSmith@gmail.com&method=v3.CreateCardPayments¬ify_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:
-
Een geslaagde aanvraag retourneert "status": true.
-
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:
| Status | Code | Message |
|---|---|---|
| true | 200 | |
| false | -1000 | Internal error |
| false | -403 | The signature Error |
| false | -2001 | The user not exist |
| false | -3001 | Required field is missing |
| false | -4118 | Incorrect request ID |
