Documentatie/API-referentie

API REFERENCE

Native betalingen

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

Native betalingen

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

Request parameters8

Required fields first

Native支付

amountRequiredstringdata.amount金额数字。例如 € 24.99 应该写成24.99,CNY金额>=1,欧元金额>=0.1
currencyRequiredstringdata.currency货币代码,ISO 4217,例如EUR,CHF
descriptionRequiredstringdata.description订单描述
timeoutRequiredstringdata.timeout过期时间单位分钟(0-1440)
notify_urlRequiredstringdata.notify_url支付完成后异步通知地址
Optional parameters 3
url_typeOptionalstringdata.url_type默认01, 01:返回的url直接跳转到YabandPay托管页面 ;02:微信原生的二维码URL
demoOptionalstringdata.demo自定义字段
redirect_urlOptionalstringdata.redirect_url支付完成后跳转地址

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

API-URL:https://mapi.yabandpay.com/Payments

Methode:POST

POST gegevenstype:Json

ParameterTypeBeschrijvingVerplicht
userStringKassiersaccount UIDVerplicht
signStringSignatureVerplicht
methodStringv3.CreateWechatNativePayVerplicht
timeLongTimestampVerplicht
  • Parameters
ParameterTypeBeschrijvingVerplicht
order_idStringBestel-ID van de handelaarVerplicht
url_typeStringStandaard: 01. 01: de geretourneerde url leidt rechtstreeks naar de door YabandPay gehoste pagina; 02: de url van de native WeChat QR-codeOptioneel
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
notify_urlStringURL voor asynchrone melding na betalingVerplicht
redirect_urlStringOmleidings-URL na betalingOptioneel

Handtekeningvoorbeeld:

Gesorteerde parameters aaneengevoegd tot een queryreeks in URL-stijl

"amount=1&currency=EUR&description=yaband test&method=v3.CreateWechatNativePay&notify_url=https://www.yabandpay.com/notify&order_id=2024821984761654842&redirect_url=https://www.yabandpay.com&time=1568553105&timeout=0&user=h5@yaband.com"

Onderteken stringA met secret_key

De resulterende handtekening is:

"YOUR_SIGNATURE"

Aanvraagvoorbeeld:

{
    "user": "YOUR_CASHIER_UID",
    "sign": "YOUR_SIGNATURE",
    "method": "v3.CreateWechatNativePay",
    "time": 1568553105,
    "data": {
            "url_type": "01",
            "order_id": "YOUR_ORDER_ID",
            "amount": "1",
            "currency": "EUR",
            "timeout": "0",
            "description": "yaband test",
		    "redirect_url": "https://www.yabandpay.com",
		    "notify_url": "https://www.yabandpay.com/notify"
    }
}

Antwoordvoorbeeld:

{
    "status": true,
    "code": "200",
    "data": {
        "order_id": "YOUR_ORDER_ID",
        "trade_id": "289c6441-056e-676e-80e6-672651911070",
        "amount": "1.00",
        "currency": "EUR",
        "url": "https://pay.yabandpay.com/payments/wechat_native_callback/order/Mjg5YzY0NDEtMDU2ZS02NzZlLTgwZTYtNjcyNjUxOTExMDcw",
        "state": "processing"
    },
    "message": ""
}

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