Documentation/Référence API

API REFERENCE

Paiements H5

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

Paiements H5

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

Request parameters10

Required fields first

H5支付

pay_methodRequiredstringdata.pay_methodonline
sub_pay_methodRequiredstringdata.sub_pay_methodWeChat Pay
amountRequiredstringdata.amount金额数字。例如 € 24.99 应该写成24.99,CNY金额>=1,欧元金额>=0.1
currencyRequiredstringdata.currencyE货币代码,ISO 4217,例如EUR,CHF
descriptionRequiredstringdata.description订单描述
timeoutRequiredstringdata.timeout过期时间单位分钟(0-1440)
notify_urlRequiredstringdata.notify_url支付完成后异步通知地址
ip_addressRequiredstringdata.ip_addressIp地址
Optional parameters 2
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.pay_methodstringonline✓
data.sub_pay_methodstringWeChat Pay✓
data.order_idstring商户的订单ID✓
data.amountstring金额数字。例如 € 24.99 应该写成24.99,CNY金额>=1,欧元金额>=0.1✓
data.currencystringE货币代码,ISO 4217,例如EUR,CHF✓
data.descriptionstring订单描述✓
data.demostring自定义字段—
data.timeoutstring过期时间单位分钟(0-1440)✓
data.notify_urlstring支付完成后异步通知地址✓
data.redirect_urlstring支付完成后跳转地址—
data.ip_addressstringIp地址✓

Conseil

Remarque : WeChat ne prend pas en charge les paiements H5 par défaut. Contactez YabandPay pour activer cette fonctionnalité avant de l’utiliser.

ParamètreTypeDescriptionObligatoire
userStringCompte marchand UIDObligatoire
signStringSignatureObligatoire
methodStringv3.CreatePaymentsWechatH5PayObligatoire
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 | E currency code, ISO 4217, such as EUR or 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 | | ip_address | String | Ip address | Obligatoire |

Exemple de signature:

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

"amount=0.1&currency=EUR&demo=test&description=YabandPay test&ip_address=127.0.0.1&method=v3.CreatePaymentsWechatH5Pay&notify_url=https://www.yabandpay.com/notify&order_id=202487816549841654&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.CreatePaymentsWechatH5Pay",
  "time": 1555498137,
  "data": {
    "amount": "0.1",
    "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",
    "ip_address" : "127.0.0.1"
  }
}

Exemple de réponse:

{
    "status": true,
    "code": "200",
    "data": {
        "order_id": "YOUR_ORDER_ID",
        "trade_id": "ced03b0a-3bb1-ce9b-237e-eed85f4b7e33",
        "amount": "0.10",
        "currency": "EUR",
        "parameters": {
            "pay_url": "https://pay.yabandpay.com/payments/wechat_native_callback/order/M80d5a3f88dfb16716f04479e36dda8d79fbea0dc52cf8d902bd3330bb41"
        },
        "state": "processing"
    },
    "message": ""
}

Transmettez le paramètre pay_url à l’interface H5 correspondante pour lancer WeChat Pay.

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