Documentatie/API-referentie

API REFERENCE

Gecombineerde betalingsopdracht

API-parameters, instructies voor ondertekening en voorbeelden van aanvragen en antwoorden uit de bestaande SimplePay API-documentatie.

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

Gecombineerde betalingsopdracht

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

Request parameters9

Required fields first

统一下单支付

pay_methodRequiredstringdata.pay_methodonline
sub_pay_methodRequiredstringdata.sub_pay_methodWeChat Pay,Alipay,YabandPay
amountRequiredstringdata.amount金额数字。例如 € 24.99 应该写成24.99,CNY金额>=1,欧元金额>=0.1
currencyRequiredstringdata.currency货币代码,ISO 4217,例如EUR,CHF
descriptionRequiredstringdata.description订单描述
timeoutRequiredstringdata.timeout过期时间单位分钟(0-1440)
redirect_urlRequiredstringdata.redirect_url支付完成后跳转地址
notify_urlRequiredstringdata.notify_url支付完成后异步通知地址
Optional parameters 1
demoOptionalstringdata.demo自定义字段

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

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

ParameterTypeBeschrijvingVerplicht
userStringKassiersaccount UIDVerplicht
signStringSignatureVerplicht
methodStringv3.CreatePaymentsVerplicht
timeLongTimestampVerplicht
  • Parameters
ParameterTypeBeschrijvingVerplicht
pay_methodStringonlineVerplicht
sub_pay_methodStringWeChat Pay, Alipay, YabandPayVerplicht
order_idStringBestel-ID van de handelaarVerplicht
amountStringBedrag als numerieke tekenreeks. Voer bijvoorbeeld 24.99 in voor € 24.99. Het CNY-bedrag moet >=1 zijn; het EUR-bedrag >=0.1.Verplicht
currencyStringISO-valutacode 4217, bijvoorbeeld EUR of CHFVerplicht
descriptionStringBestelomschrijvingVerplicht
demoStringAangepast veldOptioneel
timeoutStringVervaltijd in minuten (0-1440)Verplicht
redirect_urlStringOmleidings-URL na betalingVerplicht
notify_urlStringURL voor asynchrone melding na betalingVerplicht

Handtekeningvoorbeeld:

Gesorteerde parameters aaneengevoegd tot een queryreeks in URL-stijl

 "amount=0.1&currency=EUR&demo=test&description=YabandPay test&method=v3.CreatePayments&notify_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 typeWeChat PayAlipayYabandPay
Mobile browserGenereert een WeChat Pay-QR-code (start WeChat Pay als H5 is ingeschakeld)Start AlipayGenereert een uniforme QR-code
Webview in a mobile AppGenereert een WeChat Pay-QR-codeStart AlipayGenereert een uniforme QR-code
WeChat browser (inside the WeChat App)Start WeChat PayGenereert een Alipay-QR-codeStart WeChat Pay
Alipay browser (inside the Alipay App)Genereert een WeChat Pay-QR-codeStart AlipayStart Alipay
All desktop browsersGenereert een WeChat Pay-QR-codeGenereert een Alipay-QR-codeGenereert een uniforme QR-code

Aanvullende informatie:

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

  2. 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:
StatusCodeBericht
true200Success
false-1000Internal error
false-3001Required field is missing
false-403The signature Error
false-4011Not support the payment method