Documentation/Référence API

API REFERENCE

Solution de paiement hébergée (HPP)

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

Solution de paiement hébergée (HPP)

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

Request parameters10

Required fields first

Hosted Payment Page

pay_methodRequiredstringdata.pay_methodonline
sub_pay_methodRequiredstringdata.sub_pay_methodList
operationRequiredstringdata.operation1.Sales 2.Authorisation;
amountRequiredstringdata.amount金额数字。例如 € 24.99 应该写成24.99,CNY金额>=1,欧元金额>=0.1(iDeal支付、Sofort支付、PayPal支付,欧元金额>=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_methodstringList✓
data.order_idstring商户的订单ID✓
data.operationstring1.Sales 2.Authorisation;✓
data.amountstring金额数字。例如 € 24.99 应该写成24.99,CNY金额>=1,欧元金额>=0.1(iDeal支付、Sofort支付、PayPal支付,欧元金额>=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 : tous les moyens de paiement

This is a Page de paiement hébergée (HPP) solution: YabandPay hosts the checkout, where customers select a payment method and pay. Merchants only need to integrate this checkout instead of integrating each payment method individually, simplifying management and future upgrades.

ParamètreTypeDescriptionObligatoire
userStringCashier account UIDObligatoire
signStringSignatureObligatoire
methodStringv3.CreatePaymentsObligatoire
timeLongTimestampObligatoire
  • Parameters
ParamètreTypeDescriptionObligatoire
pay_methodStringonlineObligatoire
sub_pay_methodStringListObligatoire
order_idStringMerchant order IDObligatoire
operationString1.Sales 2.Authorisation;Obligatoire
amountStringAmount as a numeric string. For example, enter 24.99 for € 24.99. CNY amount >=1; EUR amount >=0.1 (for iDeal, Sofort, and PayPal, EUR amount >=1).Obligatoire
currencyStringISO 4217 currency code, for example EUR or CHFObligatoire
descriptionStringOrder descriptionObligatoire
demoStringCustom fieldFacultatif
timeoutStringExpiration time in minutes (0-1440)Obligatoire
redirect_urlStringRedirect URL after paymentFacultatif
notify_urlStringAsynchronous notification URL after paymentObligatoire

Signature example:

Sorted parameters concatenated into a URL-style query string

 "amount=1&currency=EUR&demo=test&description=YabandPay test&method=v3.CreatePayments&notify_url=https://www.yabandpay.com/notify&operation=1&order_id=20248746132489&pay_method=online&redirect_url=https://www.yabandpay.com&sub_pay_method=List&time=1546588900&timeout=0&user=YOUR_CASHIER_UID" 

Sign stringA using secret_key

Le champ resulting signature is:

"YOUR_SIGNATURE"

Exemple de requête:

{
    "user": "YOUR_CASHIER_UID",
    "sign": "YOUR_SIGNATURE",
    "method": "v3.CreatePayments",
    "time": 1546588900,
    "data": {
        "description": "YabandPay test",
        "timeout": "0",
        "operation": "1",
        "pay_method": "online",
        "sub_pay_method": "List",
        "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": "b769e338-20e7-35fa-dbb4-986892b96079",
        "amount": "1.00",
        "currency": "EUR",
        "url": "https://pay.yabandpay.com/SelectPay/Yjc2OWUzMzgtMjBlNy0zNWZhLWRiYjQtOTg2ODkyYjk2MDc5",
        "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 Query Order and Asynchronous Notifications afin de maintenir les statuts de paiement exacts et à jour.

Response codes:
StatusCodeMessage
true200Success
false-1000Internal error
false-3001Required field is missing
false-403The signature Error
false-4011Not support the payment method