Documentatie/API-referentie

API REFERENCE

In-appbetalingen

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

In-appbetalingen

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

Request parameters11

Required fields first

App支付

pay_methodRequiredstringdata.pay_methodonline
sub_pay_methodRequiredstringdata.sub_pay_methodAlipay
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支付完成后异步通知地址
os_typeRequiredstringdata.os_type安卓端传android 苹果端传ios
Optional parameters 3
sub_pay_method_typeOptionalstringdata.sub_pay_method_type参考支持的钱包列表
demoOptionalstringdata.demo自定义字段
redirect_urlOptionalstringdata.redirect_url支付完成后跳转地址;IOS和Android注意:回调到APP处理的,需要applink或者deeplink做回调处理

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.CreatePaymentsAlipayAppPayVerplicht
timeLongTimestampVerplicht
  • Parameters
ParameterTypeBeschrijvingVerplicht
pay_methodStringonlineVerplicht
sub_pay_methodStringAlipayVerplicht
sub_pay_method_typeStringBekijk de lijst met ondersteunde walletsOptioneel
order_idStringBestel-ID van de handelaarVerplicht
amountStringNumeriek bedrag. Schrijf bijvoorbeeld € 24.99 als 24.99; het CNY-bedrag moet >=1 zijn; het eurobedrag >=0.1Verplicht
currencyStringISO-valutacode 4217, bijvoorbeeld EUR of CHFVerplicht
descriptionStringBestelomschrijvingVerplicht
demoStringAangepast veldOptioneel
timeoutStringVervaltijd in minuten (0-1440)Verplicht
notify_urlStringURL voor asynchrone melding na afronding van de betalingVerplicht
redirect_urlStringOmleidings-URL na afronding van de betaling. Gebruik voor iOS en Android een applink of deeplink om callbacks naar de APP af te handelenOptioneel
os_typeStringGeef android op voor Android en ios voor AppleVerplicht

Handtekeningvoorbeeld:

Gesorteerde parameters aaneengevoegd tot een queryreeks in URL-stijl

"amount=1&currency=EUR&description=YabandPay test&method=v3.CreatePaymentsAlipayAppPay&notify_url=https://www.yabandpay.com/notify&order_id=202412654894165484&os_type=ios&pay_method=online&redirect_url=https://www.yabandpay.com/redirect_url&sub_pay_method=Alipay&time=1546588959&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.CreatePaymentsAlipayAppPay",
    "time": 1546588959,
    "data": {
        "description": "YabandPay test",
        "timeout": "0",
        "pay_method": "online",
        "sub_pay_method": "Alipay",
        "order_id": "YOUR_ORDER_ID",
        "amount": "1",
        "currency": "EUR",
        "notify_url": "https://www.yabandpay.com/notify",
        "redirect_url": "https://www.yabandpay.com/redirect_url",
        "os_type": "ios"
    }
}

Antwoordvoorbeeld:

{
  "status": true,
  "code": "200",
  "data": {
    "order_id": "YOUR_ORDER_ID",
    "trade_id": "e5baf40b-08b2-4660-ed20-d632eeeceab3",
    "amount": "0.01",
    "currency": "EUR",
    "parameters": {
      "pay_url": "https://open-sea-global.alipayplus.com/api/open/v1/ac/cashier/self/codevalue/checkout.htm?codeValue=281666040097PyqF6IxZEzTURq7PhvTv3ken",
      "payments_data": "{\"displayPaymentAmount\":\"0.01\",\"displayPaymentCurrency\":\"EUR\",\"wallets\":[{\"enabled\":true,\"promoNames\":[\"{\\\"en_US\\\":\\\"test\\\",\\\"nl_NL\\\":\\\"test\\\"}\"],\"searchKeywords\":[\"dana wallet\"],\"walletName\":\"DANA\"}]}"
    },
    "state": "processing"
  },
  "message": ""
}

Aanvullende informatie:

Als uw APP een webview gebruikt, leid dan rechtstreeks om naar pay_url.

Als uw APP voor iOS of Android is ontwikkeld, download dan de bijbehorende SDK: Downloaden.

Raadpleeg de officiële documentatie van AliPay+ voor de integratie.

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.

Wallets die Alipay+ ondersteunen:

De wallets die bij sub_pay_method_type horen, ondersteunen de volgende betaalscenario's:

sub_pay_method_typeAPPWAPWebMiniprogramma
ALIPAY_CN✅❌✅✅
TRUEMONEY✅❌✅✅
ALIPAY_HK✅✅✅✅
TNG✅✅✅✅
GCASH✅✅✅✅
DANA✅✅✅✅
KAKAOPAY✅❌✅❌
RABBIT_LINE_PAY✅❌✅❌
BPI❌✅✅❌
BOOST✅✅✅❌
AKULAKU_PAYLATER✅✅✅❌
BILLEASE✅✅✅❌
TINABA✅✅✅❌
NAVERPAY❌✅✅❌
TOSSPAY✅❌✅✅
MPAY✅✅✅❌
KREDIVO_ID✅❌✅❌
KPLUS✅✅✅❌
HIPAY✅✅✅✅
Antwoordcodes:
StatusCodeBericht
true200Success
false-1000Internal error
false-3001Required field is missing
false-403The signature Error
false-4011Not support the payment method