文档中心/API 接口

API REFERENCE

统一下单支付

展示来自现有 SimplePay API 资料的接口参数、签名说明和请求响应示例。

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

统一下单支付

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

请求参数9

先填写必填项

统一下单支付

pay_method必填stringdata.pay_methodonline
sub_pay_method必填stringdata.sub_pay_methodWeChat Pay,Alipay,YabandPay
amount必填stringdata.amount金额数字。例如 € 24.99 应该写成24.99,CNY金额>=1,欧元金额>=0.1
currency必填stringdata.currency货币代码,ISO 4217,例如EUR,CHF
description必填stringdata.description订单描述
timeout必填stringdata.timeout过期时间单位分钟(0-1440)
redirect_url必填stringdata.redirect_url支付完成后跳转地址
notify_url必填stringdata.notify_url支付完成后异步通知地址
可选参数 1
demo可选stringdata.demo自定义字段

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

适用于:微信支付和支付宝支付

该支付仅包支持微信支付和支付宝,我们推荐使用托管收银台,其包含了全部已开启的支付方式。

如果微信公众号支付,sub_pay_method使用WeChat Pay即可。

参数类型描述是否必填
userString收银员账号的UID必填
signString签名必填
methodStringv3.CreatePayments必填
timeLong时间戳必填
  • 参数
ParameterTypeDescription是否必填
pay_methodStringonline必填
sub_pay_methodStringWeChat Pay,Alipay,YabandPay必填
order_idString商户的订单ID必填
amountString金额数字。例如 € 24.99 应该写成24.99,CNY金额>=1,欧元金额>=0.1必填
currencyString货币代码,ISO 4217,例如EUR,CHF必填
descriptionString订单描述必填
demoString自定义字段选填
timeoutString过期时间单位分钟(0-1440)必填
redirect_urlString支付完成后跳转地址必填
notify_urlString支付完成后异步通知地址必填

签名示例:

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

 "amount=0.1&currency=EUR&demo=test&description=YabandPay test&method=v3.CreatePayments&notify_url=https://www.yabandpay.com/notify&order_id=2024849687894683&pay_method=online&redirect_url=https://www.yabandpay.com&sub_pay_method=WeChat Pay&time=1555498137&timeout=0&user=YOUR_CASHIER_UID" 

得到的 stringA 使用 secret_key做签名

得到的签名如下:

"YOUR_SIGNATURE"

提交示例:

 {
  "user": "YOUR_CASHIER_UID",
  "sign": "YOUR_SIGNATURE",
  "method": "v3.CreatePayments",
  "time": 1555498137,
  "data": {
    "amount": "0.2",
    "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"
  }
}

返回示例:

 {
  "status": true,
  "code": "200",
  "data": {
    "order_id": "YOUR_ORDER_ID",
    "trade_id": "4552eeea-1ae8-1e40-3b4b-802dc2f5686a",
    "amount": "0.2",
    "currency": "EUR",
    "settlement_amount": "0.2",
    "settlement_currency": "EUR",
    "exchange_rate": "1",
    "url": "https://pay.yabandpay.com/payments/callback/order/NDU1MmVlZWEtMWFlOC0xZTQwLTNiNGItODAyZGMyZjU2ODZh",
    "state": "processing"
  },
  "message": ""} 

1. 电脑浏览器或者平板电脑浏览器

在电脑浏览器或者平板电脑,由商家生成二维码,用户扫描支付。

YabandPay支持微信和支付宝原生二维码,也支持生成聚合支付二维码(同时支持微信支付和支付宝)。

商户可以根据YabandPay的API返回URL跳转到支付页面去生成微信支付或支付宝的原生二维码。

关于聚合支付二维码,商户可以把YabandPay的API返回的URL生成二维码并出示给用户,然后使用Query Order 去轮训支付结果,或者等待异步通知结果。

2. 聚合支付

根据不同的浏览器环境和使用场景(PC、H5、App等),YabandPay将会唤起合适的微信支付或支付宝以完成支付。

sub_pay_method=

浏览器类型WeChat PayAlipayYabandPay
手机浏览器生成微信支付二维码(如开通H5就唤起微信支付)唤起支付宝支付生成聚合二维码
Webview在手机App生成微信支付二维码唤起支付宝支付生成聚合二维码
微信浏览器 (在微信App内)唤起微信支付生成支付宝二维码唤起微信支付
支付宝浏览器 ( 支付宝App内)生成微信支付二维码唤起支付宝支付唤起支付宝
电脑所有浏览器生成微信支付二维码生成支付宝二维码生成聚合二维码

更多信息:

返回结果:
  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