API REFERENCE
Gecombineerde betalingsopdracht
API-parameters, instructies voor ondertekening en voorbeelden van aanvragen en antwoorden uit de bestaande SimplePay API-documentatie.
Ondersteunde betaalmethoden: WeChat Pay en Alipay
Tip
Houd er rekening mee dat deze betaaloptie alleen WeChat Pay en Alipay ondersteunt. We raden Hosted Checkout aan, dat alle ingeschakelde betaalmethoden omvat.
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.CreatePayments | Verplicht |
| time | Long | Timestamp | Verplicht |
- Parameters
| Parameter | Type | Beschrijving | Verplicht |
|---|---|---|---|
| pay_method | String | online | Verplicht |
| sub_pay_method | String | WeChat Pay, Alipay, YabandPay | Verplicht |
| order_id | String | Bestel-ID van de handelaar | Verplicht |
| amount | String | Bedrag als numerieke tekenreeks. Voer bijvoorbeeld 24.99 in voor € 24.99. Het CNY-bedrag moet >=1 zijn; het EUR-bedrag >=0.1. | Verplicht |
| currency | String | ISO-valutacode 4217, bijvoorbeeld EUR of CHF | Verplicht |
| description | String | Bestelomschrijving | Verplicht |
| demo | String | Aangepast veld | Optioneel |
| timeout | String | Vervaltijd in minuten (0-1440) | Verplicht |
| redirect_url | String | Omleidings-URL na betaling | Verplicht |
| notify_url | String | URL voor asynchrone melding na betaling | Verplicht |
Handtekeningvoorbeeld:
Gesorteerde parameters aaneengevoegd tot een queryreeks in URL-stijl
"amount=0.1¤cy=EUR&demo=test&description=YabandPay test&method=v3.CreatePayments¬ify_url=https://www.yabandpay.com/notify&order_id=2024849687894683&pay_method=online&redirect_url=https://www.yabandpay.com&sub_pay_method=WeChat Pay&time=1555498137&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.CreatePayments",
"time": 1555498137,
"data": {
"amount": "0.2",
"currency": "EUR",
"demo": "test",
"description": "YabandPay test",
"notify_url": "https://www.yabandpay.com/notify",
"order_id": "YOUR_ORDER_ID",
"pay_method": "online",
"redirect_url": "https://www.yabandpay.com",
"sub_pay_method": "WeChat Pay",
"timeout": "0"
}
}
Antwoordvoorbeeld:
{
"status": true,
"code": "200",
"data": {
"order_id": "YOUR_ORDER_ID",
"trade_id": "4552eeea-1ae8-1e40-3b4b-802dc2f5686a",
"amount": "0.2",
"currency": "EUR",
"settlement_amount": "0.2",
"settlement_currency": "EUR",
"exchange_rate": "1",
"url": "https://pay.yabandpay.com/payments/callback/order/NDU1MmVlZWEtMWFlOC0xZTQwLTNiNGItODAyZGMyZjU2ODZh",
"state": "processing"
},
"message": ""}
1. Desktop- of tabletbrowser
In een desktop- of tabletbrowser genereert de handelaar een QR-code die de klant kan scannen om te betalen.
YabandPay ondersteunt de native QR-codes van WeChat Pay en Alipay, en ook uniforme betaal-QR-codes die zowel WeChat Pay als Alipay ondersteunen.
De handelaar kan de klant doorsturen naar de URL die de YabandPay-API retourneert om een native betaal-QR-code voor WeChat Pay of Alipay te genereren.
Voor een uniforme betaal-QR-code kan de handelaar de door de YabandPay-API geretourneerde URL coderen als QR-code en deze aan de klant tonen. Vraag vervolgens de betalingsstatus op via Query Order of wacht op een asynchrone melding.
2. Gecombineerde betalingen
YabandPay start de juiste betaalstroom voor WeChat Pay of Alipay op basis van de browseromgeving en het gebruiksscenario (pc, H5, app enzovoort).
sub_pay_method=
| Browser type | WeChat Pay | Alipay | YabandPay |
|---|---|---|---|
| Mobile browser | Genereert een WeChat Pay-QR-code (start WeChat Pay als H5 is ingeschakeld) | Start Alipay | Genereert een uniforme QR-code |
| Webview in a mobile App | Genereert een WeChat Pay-QR-code | Start Alipay | Genereert een uniforme QR-code |
| WeChat browser (inside the WeChat App) | Start WeChat Pay | Genereert een Alipay-QR-code | Start WeChat Pay |
| Alipay browser (inside the Alipay App) | Genereert een WeChat Pay-QR-code | Start Alipay | Start Alipay |
| All desktop browsers | Genereert een WeChat Pay-QR-code | Genereert een Alipay-QR-code | Genereert een uniforme QR-code |
Aanvullende informatie:
Resultaat van het antwoord:
-
Een geslaagde aanvraag retourneert "status": true.
-
Een mislukte aanvraag retourneert "status": false.
We raden sterk aan zowel Bestelling opvragen als Asynchrone meldingen te gebruiken om de betalingsstatussen actueel en nauwkeurig te houden.
Antwoordcodes:
| Status | Code | Bericht |
|---|---|---|
| true | 200 | Success |
| false | -1000 | Internal error |
| false | -3001 | Required field is missing |
| false | -403 | The signature Error |
| false | -4011 | Not support the payment method |
