API REFERENCE
CardCheck
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
| Parameter | Type | Beschrijving | Verplicht |
|---|---|---|---|
| user | String | Kassiersaccount UID | Verplicht |
| sign | String | Signature | Verplicht |
| method | String | v3.CardCheck | Verplicht |
| time | Long | Timestamp | Verplicht |
- Parameters
| Parameter | Type | Beschrijving | Verplicht |
|---|---|---|---|
| pay_method | String | online | Verplicht |
| sub_pay_method | String | CardCheck | Verplicht |
| operation | String | 3 | Verplicht |
| order_id | String | Bestel-ID van de handelaar | Verplicht |
| description | String | Bestelomschrijving | Verplicht |
| form_type | String | Type van de geretourneerde url; standaard is 01. 01.completed, 02.iframe | Optioneel |
| demo | String | Aangepast veld | Optioneel |
| timeout | String | Vervaltijd in minuten (0-1440) | Verplicht |
| redirect_url | String | Omleidings-URL na betaling | 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 tekens | Verplicht |
Handtekeningvoorbeeld:
Gesorteerde parameters aaneengevoegd tot een queryreeks in URL-stijl
"description=cardcheck test&form_type=01&method=v3.CardCheck¬ify_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:
-
Een geslaagde aanvraag retourneert "status": true.
-
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:
| Status | Code | Bericht |
|---|---|---|
| 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 |
