API REFERENCE
Page de paiement hébergée
Paramètres
| Parameter | Type | Description | Obligatoire |
|---|---|---|---|
| data.pay_method | string | online | ✓ |
| data.sub_pay_method | string | Cards HPP | ✓ |
| data.operation | string | 1.Sales 2.Authorisation; | ✓ |
| data.order_id | string | 商户的订单ID | ✓ |
| data.sca_exemption | string | LowValue | ✓ |
| data.amount | string | 金额数字。例如 € 24.99 应该写成24.99 | ✓ |
| data.currency | string | 货币代码,ISO 4217,例如EUR,CHF | ✓ |
| data.description | string | 订单描述 | ✓ |
| data.form_type | string | 返回的url类型,默认01。 01.completed, 02.iframe | — |
| data.email | string | 持卡人email | ✓ |
| data.demo | string | 自定义字段 | — |
| data.timeout | string | 过期时间单位分钟(0-1440) | ✓ |
| data.redirect_url | string | 支付完成后跳转地址 | — |
| data.notify_url | string | 支付完成后异步通知地址 | ✓ |
| data.request_id | string | 请求id需保持唯一,建议24以上位数字+字母 | ✓ |
| data.3ds_initiate | string | 01. 开启3ds验证; 02.不开启3DS(需申请开通);03. SCA豁免(需申请开通); | ✓ |
S’applique aux autorisations de carte et aux achats directs
La page de paiement hébergée (HPP) de YabandPay est une page prête à l’emploi, entièrement gérée par YabandPay. Les marchands peuvent accepter des paiements en toute sécurité en hébergeant les données PCI sensibles dans le système YabandPay. Le formulaire peut être intégré au parcours de paiement du marchand sous forme d’iframe ou de page de redirection.
Conseil
Authorizations are valid for 30 days. Authorization orders expire automatically after 30 days.
| Paramètre | Type | Description | Obligatoire |
|---|---|---|---|
| user | String | Cashier account UID | Obligatoire |
| sign | String | Signature | Obligatoire |
| method | String | v3.CreateCardPayments | Obligatoire |
| time | Long | Timestamp | Obligatoire |
- Parameters
| Paramètre | Type | Description | Obligatoire |
|---|---|---|---|
| pay_method | String | online | Obligatoire |
| sub_pay_method | String | Cards HPP | Obligatoire |
| operation | String | 1.Sales 2.Authorisation; | Obligatoire |
| order_id | String | Merchant order ID | Obligatoire |
| 3ds_initiate | String | 01. Enable 3DS verification; 02. Disable 3DS (requires activation approval); 03. SCA exemption (requires activation approval). | Obligatoire |
| sca_exemption | String | LowValue | Required when 3ds_initiate=03 |
| amount | String | Amount as a numeric string. For example, enter 24.99 for € 24.99. | Obligatoire |
| currency | String | ISO 4217 currency code, for example EUR or CHF | Obligatoire |
| description | String | Order description | Obligatoire |
| form_type | String | Type of returned url; defaults to 01. 01.completed, 02.iframe | Facultatif |
| string | Cardholder email | Obligatoire | |
| demo | String | Custom field | Facultatif |
| timeout | String | Expiration time in minutes (0-1440) | Obligatoire |
| redirect_url | String | Redirect URL after payment | Facultatif |
| notify_url | String | Asynchronous notification URL after payment | Obligatoire |
| request_id | String | Unique request ID; a combination of digits and letters at least 24 characters is recommended | Obligatoire |
Signature example:
Sorted parameters concatenated into a URL-style query string
"3ds_initiate=01&amount=1¤cy=EUR&description=test&email=JohnSmith@gmail.com&form_type=01&method=v3.CreateCardPayments¬ify_url=https://www.yabandpay.com/notify&operation=1&order_id=203040950640690239603690&pay_method=online&redirect_url=https://www.yabandpay.com/redirect_url&request_id=tscqf7ki76o7aem4z1yl1xs72f89fptl&sub_pay_method=Cards HPP&time=1720680417&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.CreateCardPayments",
"time": 1720680417,
"data": {
"description": "test",
"form_type": "01",
"3ds_initiate": "01",
"timeout": "0",
"pay_method": "online",
"sub_pay_method": "Cards HPP",
"operation": "1",
"order_id": "YOUR_ORDER_ID",
"amount": "1",
"currency": "EUR",
"email": "JohnSmith@gmail.com",
"redirect_url": "https://www.yabandpay.com/redirect_url",
"notify_url": "https://www.yabandpay.com/notify",
"request_id": "tscqf7ki76o7aem4z1yl1xs72f89fptl"
}
}
Exemple de réponse:
{
"status": true,
"code": "200",
"data": {
"order_id": "YOUR_ORDER_ID",
"trade_id": "160899f3-f6d9-a8d8-ab5b-82eacdab9c5b",
"amount": "1.00",
"currency": "EUR",
"url": "https://pay.yabandpay.com/payments/callback/order/MTYwODk5ZjMtZjZkOS1hOGQ4LWFiNWItODJlYWNkYWI5YzVi",
"state": "processing"
},
"message": "",
"response_id": "202407111544200649155078"
}
Informations complémentaires:
Résultat de la réponse:
-
Une requête réussie renvoie "status": true.
-
Une requête échouée renvoie "status": false.
Redirect the customer to the returned url. After entering card details and completing payment there, the customer is redirected to redirect_url. Nous recommandons vivement d’utiliser à la fois Query Order and Asynchronous Notifications afin de maintenir les statuts de paiement exacts et à jour. a) An order state of paid indicates a successful payment. b) An order state of authorized indicates a successful authorization. To capture an authorized payment, call the Capture Authorization API.
Response codes:
| Status | Code | Message |
|---|---|---|
| true | 200 | |
| false | -1000 | Internal error |
| false | -403 | The signature Error |
| false | -2001 | The user not exist |
| false | -3001 | Required field is missing |
| false | -4118 | Incorrect request ID |
