文档中心/API 接口

API REFERENCE

Twint

POSThttps://mapi.yabandpay.com/Payments
实际接口
API PLAYGROUND · 实际接口

Twint

POSThttps://mapi.yabandpay.com/Payments
填写凭据后自动签名

请求参数9

先填写必填项

介绍

pay_method必填stringdata.pay_methodonline
sub_pay_method必填stringdata.sub_pay_methodTwint
amount必填stringdata.amount金额数字。例如 EUR 24.99 应写成 24.99
currency必填stringdata.currencyEUR
description必填stringdata.description订单描述
timeout必填stringdata.timeout过期时间单位分钟(0-1440)
notify_url必填stringdata.notify_url支付完成后异步通知地址
可选参数 2
demo可选stringdata.demo自定义字段
redirect_url可选stringdata.redirect_url支付完成后跳转地址

凭据仅在当前页面使用。secret_key 不保存,也不发送给文档服务器。

Twint 支持通过设置 pay_method 为 online、sub_pay_method 为 Twint 发起在线支付订单。


参数类型描述是否必填
userString收银员账号的UID必填
signString签名必填
methodStringv3.CreatePayments必填
timeLong时间戳必填
  • 参数
ParameterTypeDescription是否必填
pay_methodStringonline必填
sub_pay_methodStringTwint必填
order_idString商户的订单ID必填
amountString金额数字。例如 EUR 24.99 应写成 24.99必填
currencyStringEUR必填
descriptionString订单描述必填
demoString自定义字段选填
timeoutString过期时间单位分钟(0-1440)必填
redirect_urlString支付完成后跳转地址选填
notify_urlString支付完成后异步通知地址必填

签名示例:

拼接为 URL 方式并排序后的字符串

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

得到的 stringA 使用 secret_key 做签名

得到的签名如下:

"YOUR_SIGNATURE"

提交示例:

{
  "user": "YOUR_CASHIER_UID",
  "sign": "YOUR_SIGNATURE",
  "method": "v3.CreatePayments",
  "time": 1646388458,
  "data": {
    "description": "YabandPay test",
    "timeout": "0",
    "pay_method": "online",
    "sub_pay_method": "Twint",
    "order_id": "YOUR_ORDER_ID",
    "amount": "1",
    "currency": "EUR",
    "redirect_url": "https://www.yabandpay.com",
    "notify_url": "https://www.yabandpay.com/notify",
    "demo": "test"
  }
}

返回示例:

{
  "status": true,
  "code": "200",
  "data": {
    "order_id": "YOUR_ORDER_ID",
    "trade_id": "c21f5489-6ea5-469d-b176-bdf2fd0f61a8",
    "amount": "1.00",
    "currency": "EUR",
    "url": "https://pay.yabandpay.com/pay_method/dHdpbnQ=/YzIxZjU0ODktNmVhNS00NjlkLWIxNzYtYmRmMmZkMGY2MWE4",
    "state": "processing"
  },
  "message": ""
}

更多信息:

返回结果:
  1. 若调用成功,则返回 "status": true

  2. 若调用失败,则返回 "status": false

我们强烈建议同时使用订单查询和异步通知来同步和更新支付状态,以确保支付信息的实时准确性。

返回代码:
StatusCodeMessage
true200Success
false-1000Internal error
false-3001Required field is missing
false-403The signature Error
false-4011Not support the payment method