Documentation/Référence API

API REFERENCE

Paiements via Mini Program

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

Paiements via Mini Program

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

Request parameters10

Required fields first

小程序支付

pay_methodRequiredstringdata.pay_methodonline
sub_pay_methodRequiredstringdata.sub_pay_methodWeChat Pay
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支付完成后异步通知地址
sub_app_idRequiredstringdata.sub_app_id小程序的APPID
sub_open_idRequiredstringdata.sub_open_id小程序获得的用户OpenID
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✓
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.notify_urlstring支付完成后异步通知地址✓
data.sub_app_idstring小程序的APPID✓
data.sub_open_idstring小程序获得的用户OpenID✓

Conseil

Remarque : communiquez à YabandPay l’AppID de votre Mini Program WeChat. Cette fonctionnalité doit être activée avant utilisation.

ParamètreTypeDescriptionObligatoire
userStringCompte marchand UIDObligatoire
signStringSignatureObligatoire
methodStringv3.CreatePaymentsWechatMiniPayObligatoire
timeLongTimestampObligatoire
  • Parameters | Paramètre | Type | Description | Obligatoire | |:--- |:--- |:--- |:--- | | pay_method | String | online | Obligatoire | | sub_pay_method | String | WeChat Pay | Obligatoire | | order_id | String | ID de commande du marchand | Obligatoire | | amount | String | Montant au format chaîne numérique. Par exemple, saisissez 24.99 for € 24.99. montant en CNY ≥1; montant en EUR ≥0.1. | Obligatoire | | currency | String | code devise ISO 4217, par exemple EUR ou CHF | Obligatoire | | description | String | Description de la commande | Obligatoire | | demo | String | Champ personnalisé | Facultatif | | timeout | String | Durée d’expiration en minutes (0-1440) | Obligatoire | | notify_url | String | URL de notification asynchrone après le paiement | Obligatoire | | sub_app_id | String | APPID du Mini Program | Obligatoire | | sub_open_id | String | OpenID utilisateur obtenu par le Mini Program | Obligatoire |

Exemple de signature:

Paramètres triés et concaténés sous forme de chaîne de requête au format URL

"amount=1.23&currency=EUR&description=test&method=v3.CreatePaymentsWechatMiniPay&notify_url=https://imenuapi.yabandpay.com/api/Notify/yabandpay&order_id=202413271095510835&pay_method=online&sub_app_id=wx7a5355d3d2a904a4&sub_open_id=opilP5dyazU7pTpyps8TDc53OGyU&sub_pay_method=WeChat Pay&time=1732672545&timeout=300&user=011844"

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

La signature obtenue est :

"YOUR_SIGNATURE"

Exemple de requête:

{
    "user": "011844",
    "sign": "YOUR_SIGNATURE",
    "method": "v3.CreatePaymentsWechatMiniPay",
    "time": 1732672545,
    "data": {
        "description": "test",
        "timeout": "300",
        "pay_method": "online",
        "sub_pay_method": "WeChat Pay",
        "order_id": "YOUR_ORDER_ID",
        "amount": "1.23",
        "currency": "EUR",
        "notify_url": "https://imenuapi.yabandpay.com/api/Notify/yabandpay",
        "sub_open_id": "opilP5dyazU7pTpyps8TDc53OGyU",
        "sub_app_id": "wx7a5355d3d2a904a4"
    }
}

Exemple de réponse:

{
    "status": true,
    "code": "200",
    "data": {
        "order_id": "YOUR_ORDER_ID",
        "trade_id": "e405c9d5-069f-34f5-9eb2-16919cd7e411",
        "amount": "1.23",
        "currency": "EUR",
        "parameters": {
            "appId": "wx7a5355d3d2a904a4",
            "package": "prepay_id=wx270959141300258779d83459e08e4b0000",
            "paySign": "Av83Y6u+Ua8hkU3VyoAN5MUu7cm9vPfID8OstMkS+3BbbNnl1bax5nRapKoFTz2DUzaGyzPiT+gDUzyGW7DshqPLy+NsmKvQGSQM5vyfSjXsz5F4LKOeI3YaaUBTnVXkKX6qBrzbVUfStyjvYwtqPJUXx0X2zZEiGV5ScEf44IOmWQXeiRKyv8j34KnhMHcSFgSVAPN/B10Z1BnN34VUpak6DyaM/d0zfEkUbtODzD260An9NBSKZqAg1Wh35o/Eebqd5KoPIPX74lfRjUH4O9IZUCXnb2NqTxCR2M8j7Yx5zzz3xiQGhqEPzc7m0vXQTYv3TjD+158LeF993e/c2w==",
            "nonceStr": "0ypozLSDOzutrUA7WUI7eTfWUHtDqO9n",
            "signType": "RSA",
            "timeStamp": "1732672754"
        },
        "state": "processing"
    },
    "message": ""
}

Utilisez la valeur « parameters » renvoyée pour lancer le paiement WeChat Mini Program.

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 Consulter la commande and 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