Documentation/Référence API

API REFERENCE

UnionPay - QuickPass

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

UnionPay - QuickPass

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

Request parameters9

Required fields first

银联云闪付

pay_methodRequiredstringdata.pay_methodonline
sub_pay_methodRequiredstringdata.sub_pay_methodUnionPay QuickPass
amountRequiredstringdata.amount金额数字。例如 € 24.99 应该写成24.99,欧元金额>=1
currencyRequiredstringdata.currency货币代码,ISO 4217,例如EUR,CHF
descriptionRequiredstringdata.description订单描述
timeoutRequiredstringdata.timeout过期时间单位分钟(0-1440)
notify_urlRequiredstringdata.notify_url支付完成后异步通知地址
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_methodstringUnionPay QuickPass✓
data.order_idstring商户的订单ID✓
data.amountstring金额数字。例如 € 24.99 应该写成24.99,欧元金额>=1✓
data.currencystring货币代码,ISO 4217,例如EUR,CHF✓
data.descriptionstring订单描述✓
data.demostring自定义字段—
data.timeoutstring过期时间单位分钟(0-1440)✓
data.redirect_urlstring支付完成后跳转地址—
data.notify_urlstring支付完成后异步通知地址✓
ParamètreTypeDescriptionObligatoire
userStringCompte marchand UIDObligatoire
signStringSignatureObligatoire
methodStringv3.CreatePaymentsObligatoire
timeLongTimestampObligatoire
  • Parameters | Paramètre | Type | Description | Obligatoire | |:--- |:--- |:--- |:--- | | pay_method | String | online | Obligatoire | | sub_pay_method | String | UnionPay QuickPass | Obligatoire | | order_id | String | ID de commande du marchand | Obligatoire | | amount | String | Montant numérique. Par exemple, € 24.99 doit être indiqué sous la forme 24.99; montant en euros ≥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 | | redirect_url | String | URL de redirection après le paiement | Facultatif | | notify_url | String | URL de notification asynchrone après le paiement | 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&currency=EUR&demo=test&description=YabandPay test&method=v3.CreatePayments&notify_url=https://www.yabandpay.com/notify&order_id=202456876489416484&pay_method=online&redirect_url=https://www.yabandpay.com&sub_pay_method=UnionPay QuickPass&time=1546588959&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": 1546588959,
    "data": {
        "description": "YabandPay test",
        "timeout":"0",
        "pay_method": "online",
        "sub_pay_method": "UnionPay QuickPass",
        "order_id": "YOUR_ORDER_ID",
        "amount": "1",
        "currency": "EUR",
        "redirect_url": "https://www.yabandpay.com",
        "notify_url": "https://www.yabandpay.com/notify",
        "demo": "test"
    }
}

Exemple de réponse:

{
    "status": true,
    "code": "200",
    "data": {
        "order_id": "YOUR_ORDER_ID",
        "trade_id": "f0684a9c-715e-1ed6-eb23-dd04e6b3c016",
        "amount": "1.00",
        "currency": "EUR",
        "url": "https://pay.yabandpay.com/payments/callback/order/ZjA2ODRhOWMtNzE1ZS0xZWQ2LWViMjMtZGQwNGU2YjNjMDE2",
        "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