Documentation/Référence API

API REFERENCE

Paiements natifs

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

Paiements natifs

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.

Paramètres

ParameterTypeDescriptionObligatoire
data.order_idstring商户的订单ID✓
data.url_typestring默认01, 01:返回的url直接跳转到YabandPay托管页面 ;02:微信原生的二维码URL—
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.redirect_urlstring支付完成后跳转地址—
ParamètreTypeDescriptionObligatoire
userStringCompte marchand UIDObligatoire
signStringSignatureObligatoire
methodStringv3.CreateWechatNativePayObligatoire
timeLongTimestampObligatoire
  • Parameters | Paramètre | Type | Description | Obligatoire | |:--- |:--- |:--- |:--- | | order_id | String | ID de commande du marchand | Obligatoire | | url_type | String | Valeur par défaut : 01. 01 : l’URL renvoyée redirige directement vers la page hébergée par YabandPay ; 02 : URL du code QR WeChat natif | Facultatif | | 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 | | redirect_url | String | URL de redirection après le paiement | Facultatif |

Exemple de signature:

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

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

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

Exemple de réponse:

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

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