Documentation/Référence API

API REFERENCE

Commande de paiement unifiée

Paramètres d’API, instructions de signature et exemples de requêtes et de réponses issus de la documentation API SimplePay existante.

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

Commande de paiement unifiée

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.

Paramètres

ParameterTypeDescriptionObligatoire
data.pay_methodstringonline✓
data.sub_pay_methodstringWeChat Pay,Alipay,YabandPay✓
data.order_idstring商户的订单ID✓
data.amountstring金额数字。例如 € 24.99 应该写成24.99,CNY金额>=1,欧元金额>=0.1✓
data.currencystring货币代码,ISO 4217,例如EUR,CHF✓
data.descriptionstring订单描述✓
data.demostring自定义字段—
data.timeoutstring过期时间单位分钟(0-1440)✓
data.redirect_urlstring支付完成后跳转地址✓
data.notify_urlstring支付完成后异步通知地址✓

Moyens de paiement pris en charge : WeChat Pay et Alipay

Conseil

Veuillez noter que cette option de paiement prend uniquement en charge WeChat Pay et Alipay. Nous recommandons Hosted Checkout, qui inclut tous les moyens de paiement activés.

ParamètreTypeDescriptionObligatoire
userStringCompte marchand UIDObligatoire
signStringSignatureObligatoire
methodStringv3.CreatePaymentsObligatoire
timeLongTimestampObligatoire
  • Parameters
ParamètreTypeDescriptionObligatoire
pay_methodStringonlineObligatoire
sub_pay_methodStringWeChat Pay, Alipay, YabandPayObligatoire
order_idStringID de commande du marchandObligatoire
amountStringMontant au format chaîne numérique. Par exemple, saisissez 24.99 pour € 24.99. Montant en CNY ≥1 ; montant en EUR ≥0.1.Obligatoire
currencyStringCode devise ISO 4217, par exemple EUR ou CHFObligatoire
descriptionStringDescription de la commandeObligatoire
demoStringChamp personnaliséFacultatif
timeoutStringDurée d’expiration en minutes (0-1440)Obligatoire
redirect_urlStringURL de redirection après le paiementObligatoire
notify_urlStringURL de notification asynchrone après le paiementObligatoire

Exemple de signature :

Concaténez les paramètres triés sous forme de chaîne de requête au format URL.

 "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" 

Signez la chaîne A à l’aide de secret_key.

La signature obtenue est :

"YOUR_SIGNATURE"

Exemple de requête :

 {
  "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"
  }
}

Exemple de réponse :

 {
  "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. Navigateur sur ordinateur ou tablette

Dans un navigateur sur ordinateur ou tablette, le marchand génère un code QR que le client peut scanner pour payer.

YabandPay prend en charge les codes QR natifs WeChat Pay et Alipay, ainsi que les codes QR de paiement unifié compatibles avec WeChat Pay et Alipay.

Le marchand peut rediriger le client vers l’URL renvoyée par l’API YabandPay afin de générer un code QR de paiement natif WeChat Pay ou Alipay.

Pour un code QR de paiement unifié, le marchand peut encoder l’URL renvoyée par l’API YabandPay dans un code QR et l’afficher au client, puis interroger périodiquement Query Order pour obtenir le résultat du paiement ou attendre une notification asynchrone.

2. Paiements unifiés

YabandPay lance le parcours de paiement WeChat Pay ou Alipay approprié selon l’environnement du navigateur et le cas d’utilisation (PC, H5, App, etc.).

sub_pay_method=

Browser typeWeChat PayAlipayYabandPay
Mobile browserGénère un code QR WeChat Pay (lance WeChat Pay si H5 est activé)Lance AlipayGénère un code QR unifié
Webview in a mobile AppGénère un code QR WeChat PayLance AlipayGénère un code QR unifié
WeChat browser (inside the WeChat App)Lance WeChat PayGénère un code QR AlipayLance WeChat Pay
Alipay browser (inside the Alipay App)Génère un code QR WeChat PayLance AlipayLance Alipay
All desktop browsersGénère un code QR WeChat PayGénère un code QR AlipayGénère un code QR unifié

Informations complémentaires :

Résultat de la réponse :
  1. Une requête réussie renvoie "status": true.

  2. Une requête échouée renvoie "status": false.

Nous recommandons vivement d’utiliser à la fois Query Order et Asynchronous Notifications afin de maintenir les statuts de paiement exacts et à jour.

Codes de réponse :
StatusCodeMessage
true200Success
false-1000Internal error
false-3001Required field is missing
false-403The signature Error
false-4011Not support the payment method