文档中心/API 接口

API REFERENCE

Voucher

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

Voucher

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

请求参数11

先填写必填项

介绍

pay_method必填stringdata.pay_methodonline
sub_pay_method必填stringdata.sub_pay_methodVoucher
amount必填stringdata.amount金额数字。例如 € 24.99 应该写成24.99,欧元金额>=1
currency必填stringdata.currencyEUR
description必填stringdata.description订单描述
timeout必填stringdata.timeout过期时间单位分钟(0-1440)
notify_url必填stringdata.notify_url支付完成后异步通知地址
可选参数 4
demo可选stringdata.demo自定义字段
redirect_url可选stringdata.redirect_url如果使用托管页面,支付完成后跳转地址
cardnumber可选stringdata.cardnumber礼品卡卡号(如使用页面跳转托管方式非必填)
pincode可选stringdata.pincode礼品卡密码(如传cardnumber该字段必填)

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

适用于:礼品卡

该支付方式通过使用礼品卡的资金支付订单。礼品卡必须在销售地点激活。

参数类型描述是否必填
userString收银员账号的UID必填
signString签名必填
methodStringv3.CreatePaymentsVoucher必填
timeLong时间戳必填
  • 参数
ParameterTypeDescription是否必填
pay_methodStringonline必填
sub_pay_methodStringVoucher必填
order_idString商户的订单ID必填
amountString金额数字。例如 € 24.99 应该写成24.99,欧元金额>=1必填
currencyStringEUR必填
descriptionString订单描述必填
demoString自定义字段选填
timeoutString过期时间单位分钟(0-1440)必填
redirect_urlString如果使用托管页面,支付完成后跳转地址选填
notify_urlString支付完成后异步通知地址必填
cardnumberString礼品卡卡号(如使用页面跳转托管方式非必填)选填
pincodeString礼品卡密码(如传cardnumber该字段必填)选填

签名示例:

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

"amount=0.01&cardnumber=6064364245787814896&currency=EUR&demo=test&description=YabandPay test VVV&method=v3.CreatePaymentsVoucher&notify_url=https://www.yabandpay.com/notify&order_id=202405110140188881&pay_method=online&pincode=568971&redirect_url=https://www.yabandpay.com&sub_pay_method=Voucher&time=1546588959&timeout=0&user=YOUR_CASHIER_UID"

得到的 stringA 使用 secret_key做签名

得到的签名如下:

"YOUR_SIGNATURE"

提交示例:

{
    "user": "YOUR_CASHIER_UID",
    "sign": "YOUR_SIGNATURE",
    "method": "v3.CreatePaymentsVoucher",
    "time": 1546588959,
    "data": {
        "description": "YabandPay test VVV",
        "timeout": "0",
        "pay_method": "online",
        "sub_pay_method": "Voucher",
        "order_id": "YOUR_ORDER_ID",
        "amount": "0.01",
        "currency": "EUR",
        "redirect_url": "https://www.yabandpay.com",
        "notify_url": "https://www.yabandpay.com/notify",
        "demo": "test",
        "cardnumber": "6064364245787814896",
        "pincode": "568971"
    }
}

返回示例:

{
    "status": true,
    "code": "200",
    "data": {
        "order_id": "YOUR_ORDER_ID",
        "trade_id": "535ea4a1-917a-bc14-58e2-d1565720af90",
        "amount": "0.01",
        "currency": "EUR",
        "settlement_amount": "0.01",
        "settlement_currency": "EUR",
        "exchange_rate": "1",
        "url": "",
        "state": "processing"
    },
    "message": ""
}

托管页面方式:

如需要在YabandPay的托管页面上完成礼品卡的账号和密码验证,请使用该支付方式。这时cardnumber和pincode不用传。在调用后跳转到返回url进行下一步的支付流程。

提交示例:

{
    "user": "YOUR_CASHIER_UID",
    "sign": "YOUR_SIGNATURE",
    "method": "v3.CreatePaymentsVoucher",
    "time": 1546588959,
    "data": {
        "description": "YabandPay test VVV",
        "timeout": "0",
        "pay_method": "online",
        "sub_pay_method": "Voucher",
        "order_id": "YOUR_ORDER_ID",
        "amount": "0.01",
        "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": "c0d9c0bb-0b40-1cb6-7373-fd1a97c7124e",
        "amount": "0.01",
        "currency": "EUR",
        "url": "https://pay.yabandpay.com/payments/callback/order/YzBkOWMwYmItMGI0MC0xY2I2LTczNzMtZmQxYTk3YzcxMjRl",
        "state": "processing"
    },
    "message": ""
}

更多信息:

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

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

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

返回代码:
StatusCodeMessage
true200
false-1000Internal error
false-104000You have entered an invalid amount
false-104221The voucher has insufficient funds
false-104222Invaild PinCode
false-104223This is an invalid giftcard, we are unable to find the giftcard brand