文档中心/API 接口

API REFERENCE

获取Token

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

获取Token

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

请求参数15

先填写必填项

获取Token(HPP)

pay_method必填stringdata.pay_methodonline
sub_pay_method必填stringdata.sub_pay_methodCards HPP
operation必填stringdata.operation10.Create Token only; 11.Token for sales; 12.Token for authorisation
amount必填stringdata.amount金额数字。例如 € 24.99 应该写成24.99。如果operation为10,请设置amount=0
currency必填stringdata.currency货币代码,ISO 4217,例如EUR,CHF
description必填stringdata.description订单描述
email必填stringdata.email持卡人email
timeout必填stringdata.timeout过期时间单位分钟(0-1440)
notify_url必填stringdata.notify_url支付完成后异步通知地址
request_id必填stringdata.request_id请求id需保持唯一,建议24以上位数字+字母
可选参数 4
cardinfo可选stringdata.cardinfo卡信息
form_type可选stringdata.form_type返回的url类型,默认01。 01.completed, 02.iframe
demo可选stringdata.demo自定义字段
redirect_url可选stringdata.redirect_url支付完成后跳转地址

请求参数

3ds_initiate必填stringdata.3ds_initiate3ds设置。 01. 必须开启3ds验证;

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

适用于:通过YabandPay托管支付页面获取Token

YabandPay的托管支付页面 (HPP) 是一个现成的支付页面,由 YabandPay 全面维护。它使商家能够通过在 YabandPay 系统上托管敏感的 PCI 数据来安全地接受付款。该表单可以作为 iframe 或重定向页面嵌入到商家的结帐流程中。

付款用户在YabandPay托管的支付页面完成一次标准信用卡交易并同意授权,YabandPay将持卡人敏感数据转换成一串随机字符串(即Token)以去除身份信息。使用Token可以发起如下支付:

  1. 用户可以在结账页面一键完成付款,无需输入信用卡信息。
  2. 商户可以使用此Token来执行定期付款或订阅收费等。

[!TIP|style:flat] 使用流程

  1. 激活Token。联系您的客户经理开通Token支付功能。
  1. 用户授权。为消费者启用**快捷支付(Token支付)**时您有义务明确告知用户并获得授权,以避免可能的纠纷。
  1. 获取Token。要获得Token,首先需要发起一个标准的信用卡交易,YabandPay将会返回支付url,用户通过该url完成支付并同意授权后,YabandPay将会通过异步通知返回Token,参数是payment_token_object。
  1. 发起Token支付。请包含Token在变量payment_token_object中。如果Token校验正确,YabandPay将执行Token支付;如果Token校验失败,YabandPay将返回错误信息,这时建议重新通过发起标准信用卡交易以获取Token并再次发起支付。
参数类型描述是否必填
userString收银员账号的UID必填
signString签名必填
methodStringv3.CreateCardPayments必填
timeLong时间戳必填
  • 参数
ParameterTypeDescription是否必填
pay_methodStringonline必填
sub_pay_methodStringCards HPP必填
operationString10.Create Token only; 11.Token for sales; 12.Token for authorisation必填
order_idString商户的订单ID必填
3ds_initiateString3ds设置。 01. 必须开启3ds验证;必填
cardinfoString卡信息cardinfo的值作为string处理(cardinfo内的字段不用加入排序)
cardinfo.card_holderstring持卡人姓名必填
cardinfo.card_numberstring卡号必填
cardinfo.expiration_monthstring卡有效期月MM必填
cardinfo.expiration_yearstring卡有效期年YYYY必填
cardinfo.cvcstringCVC(任何形式存储CVC均违反PCI DSS规定)必填
amountString金额数字。例如 € 24.99 应该写成24.99。如果operation为10,请设置amount=0必填
currencyString货币代码,ISO 4217,例如EUR,CHF必填
descriptionString订单描述必填
form_typeString返回的url类型,默认01。 01.completed, 02.iframe选填
demoString自定义字段选填
emailstring持卡人email必填
timeoutString过期时间单位分钟(0-1440)必填
redirect_urlString支付完成后跳转地址选填
notify_urlString支付完成后异步通知地址必填
request_idString请求id需保持唯一,建议24以上位数字+字母必填

签名示例:

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

"3ds_initiate=01&amount=0.1&currency=EUR&description=test&email=JohnSmith@gmail.com&form_type=01&method=v3.CreateCardPayments&notify_url=https://www.yabandpay.com/notify&operation=11&order_id=1725875388&pay_method=online&request_id=dxktqiedfpkswnripi631ppg6fl2uoym&sub_pay_method=Cards HPP&time=1725875388&timeout=30&user=YOUR_CASHIER_UID"

得到的 stringA 使用 secret_key做签名

得到的签名如下:

"YOUR_SIGNATURE"

提交示例:

{
    "user": "YOUR_CASHIER_UID",
    "sign": "YOUR_SIGNATURE",
    "method": "v3.CreateCardPayments",
    "time": 1725875388,
    "data": {
        "3ds_initiate": "01",
        "description": "test",
        "timeout": "30",
        "pay_method": "online",
        "sub_pay_method": "Cards HPP",
        "operation": "11",
        "form_type": "01",
        "order_id": 1725875388,
        "amount": "0.1",
        "currency": "EUR",
        "email": "JohnSmith@gmail.com",
        "notify_url": "https://www.yabandpay.com/notify",
        "request_id": "dxktqiedfpkswnripi631ppg6fl2uoym"
    }
}

返回示例:

{
    "status": true,
    "code": "200",
    "data": {
        "order_id": "YOUR_ORDER_ID",
        "trade_id": "2b2aa1af-6e97-4c01-8c52-86200bf66c82",
        "amount": "0.1",
        "currency": "EUR",
        "url": "https://pay.yabandpay.com/pay_method/Y3JlZGl0Y2FyZA==/MmIyYWExYWYtNmU5Ny00YzAxLThjNTItODYyMDBiZjY2Yzgy",
        "state": "processing"
    },
    "message": "",
    "response_id": "202409091749500451314672"
}

更多信息:

MIT & CIT :

MIT= Merchant Initiated subsequent transactions.由商户发起的Token扣款。

CIT= Cardholder Initiated Subsequent transactions.有用户参与的Token支付。 请在开通支付时候沟通好需要MIT还是CIT模式,做相应配置的开通

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

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

您需要跳转返回的url。用户在此url输入卡号信息并完成支付后,会同步跳转回redirect_url。我们强烈建议同时使用订单查询和异步通知来同步和更新支付状态,以确保支付信息的实时准确性。

返回Token:
  1. 当用户同意授权并支付成功以后,YabandPay将通过异步通知返回payment_token_object;

  2. 如果用户不同意授权或未完成支付,在异步通知中不将返回payment_token_object。

3DS低价值豁免:

在下列限额范围内的交易可被认定为低价值交易。当订单金额小于或等于以下金额时,经过批准可适用交易代码 02(低价值豁免)。

#货币金额
1EUR30
2DKK225
3GBP27
4SEK310
5ISK5000
6NOK325
7CHF32
8PLN135
9USD36
返回代码:
StatusCodeMessage
true200
false-1000Internal error
false-403The signature Error
false-2001The user not exist
false-3001Required field is missing
false-4118Incorrect request ID
false-4120No operational permissions