POST api/ValueCard/Busi/StartPay
(跨平台方法)使用储值卡进行支付操作(result.errcode=0且result.tag.TradeStatus="S"表示收款成功)。 (1)当前操作是支付的起手动作,一般情况下,会直接返回成功或失败; (2)当未返回成功或失败时,请使用查询API查询交易的情况。
Request Information
URI Parameters
None.
Body Parameters
发起交易的参数。
ValueCardStartPayParm| Name | Description | Type | Additional information |
|---|---|---|---|
| BusiTradeType |
同系统业务类型1-票务(含景区和演出);2-自营零售业务;3-包车业务;4-即上即下环保车业务;5-装备租赁业务,6-联营零售业务,7-餐饮业务,8-其他业务。 |
string |
Required Max length: 1 Min length: 1 |
| BusiBillId |
来自于业务系统的单据号。这个与“业务类型”加起来必须是唯一的。 业务系统是指发起本次调用的系统,如餐饮系统等。 |
string |
Required Max length: 32 |
| StartedBy |
U-储值卡序列号,C-储值卡卡号,P-储值卡付款码,必须是这三个值之一。 |
string |
Required Max length: 1 Min length: 1 |
| PayCode |
若StartedBy=’P’,此值必填。表示扫描到的客人的付款码。 |
string |
Max length: 20 |
| CardNo |
若StartedBy=’C’,此值必填。表示输入的客人的储值卡的卡号。 |
string |
Max length: 20 |
| CardSerialNum |
若StartedBy=’U’,此值必填。表示使用IC卡阅读器读取到的卡片的序列号。 |
string |
Max length: 20 |
| PayWithPwd |
‘1’表示是,‘0’表示否。当StartedBy=’U’或‘C’时,此值有意义。付款码暂时不支持凭密支付。 |
string |
Max length: 20 |
| PayPwd |
支付密码,由会员自行输入,当@PayWithPwd = '1'时,此值不能为空,本字段的值= UPPER(MD5(持卡人输入的密码))。 |
string |
Max length: 64 |
| TradeFrom |
交易来源,不能为空,1-前台或自助机,2互联网 |
string |
Required Max length: 1 Min length: 1 |
| TradeFromDetail |
交易来源说明,可以为空,如“微信小程序”,“web”,“餐饮客户端”等字样。 最长10个字符(或5个汉字)。 |
string |
Max length: 10 |
| PayAmount |
付款金额,必须大于等于零,单位“元”。最多两位小数。 |
decimal number |
Required |
| MerchantId |
商户ID,仅在收款发起者是“联营商户的门店时有效”,表示联营商户的ID,0和NULL都表示不限,但给定此值时,若业务类型为6-联营零售业务,此值对应的商户必须存在且未被禁用,其他业务类型此值将只会被记录 |
integer |
None. |
| ShopId |
店铺号,仅在业务类型为2-自营零售业务; 5-装备租赁业务,6-联营零售业务,7-餐饮业务时有效,如果是2,5,6时,此值将会被较验,对应的门店必须存在并且可用,其他业务类型本值只会被记录。 |
string |
Max length: 4 |
| Attach |
支付的发起才发来的,直接被保存的内容,不会做任何处理,查询交易时会直接返回。 |
string |
Max length: 100 |
Request Formats
application/json, text/json
{
"BusiTradeType": "sample string 1",
"BusiBillId": "sample string 2",
"StartedBy": "sample string 3",
"PayCode": "sample string 4",
"CardNo": "sample string 5",
"CardSerialNum": "sample string 6",
"PayWithPwd": "sample string 7",
"PayPwd": "sample string 8",
"TradeFrom": "sample string 9",
"TradeFromDetail": "sample string 10",
"PayAmount": 11.0,
"MerchantId": 12,
"ShopId": "sample string 13",
"Attach": "sample string 14"
}
application/xml, text/xml
<ValueCardStartPayParm xmlns:i="http://www.w3.org/2001/XMLSchema-instance" xmlns="http://schemas.datacontract.org/2004/07/DigitalScience.DataTransfer.Tour.V5.Parm.ValueCard"> <Attach>sample string 14</Attach> <BusiBillId>sample string 2</BusiBillId> <BusiTradeType>sample string 1</BusiTradeType> <CardNo>sample string 5</CardNo> <CardSerialNum>sample string 6</CardSerialNum> <MerchantId>12</MerchantId> <PayAmount>11</PayAmount> <PayCode>sample string 4</PayCode> <PayPwd>sample string 8</PayPwd> <PayWithPwd>sample string 7</PayWithPwd> <ShopId>sample string 13</ShopId> <StartedBy>sample string 3</StartedBy> <TradeFrom>sample string 9</TradeFrom> <TradeFromDetail>sample string 10</TradeFromDetail> </ValueCardStartPayParm>
application/x-www-form-urlencoded
Sample not available.
application/bson
Binary JSON content. See http://bsonspec.org for details.
Response Information
Resource Description
(跨平台方法)使用储值卡进行支付操作(result.errcode=0且result.tag.TradeStatus="S"表示收款成功)。 (1)当前操作是支付的起手动作,一般情况下,会直接返回成功或失败; (2)当未返回成功或失败时,请使用查询API查询交易的情况。
CommonOperationResultWithTagOfValueCardPaymentResult| Name | Description | Type | Additional information |
|---|---|---|---|
| errcode | integer |
None. |
|
| errmsg | string |
None. |
|
| tag | ValueCardPaymentResult |
None. |
Response Formats
application/json, text/json
{
"errcode": 1,
"errmsg": "sample string 2",
"tag": {
"BillId": "sample string 1",
"StartedBy": "sample string 2",
"TradeFrom": "sample string 3",
"TradeFromDetail": "sample string 4",
"CardNo": "sample string 5",
"TradeTime": "sample string 6",
"PayAmount": 7.0,
"TradeStatus": "sample string 8",
"TradeMessage": "sample string 9",
"UserLoginName": "sample string 10",
"BusiTradeType": "sample string 11",
"BusiBillId": "sample string 12",
"MerchantId": 13,
"ShopId": "sample string 14",
"Attach": "sample string 15"
}
}
application/xml, text/xml
<CommonOperationResultWithTagOfValueCardPaymentResultjuXQ_SQCk xmlns:i="http://www.w3.org/2001/XMLSchema-instance" xmlns="http://schemas.datacontract.org/2004/07/DigitalScience.DataTransfer">
<errcode>1</errcode>
<errmsg>sample string 2</errmsg>
<tag xmlns:d2p1="http://schemas.datacontract.org/2004/07/DigitalScience.DataTransfer.Tour.V5.Result.ValueCard">
<d2p1:Attach>sample string 15</d2p1:Attach>
<d2p1:BillId>sample string 1</d2p1:BillId>
<d2p1:BusiBillId>sample string 12</d2p1:BusiBillId>
<d2p1:BusiTradeType>sample string 11</d2p1:BusiTradeType>
<d2p1:CardNo>sample string 5</d2p1:CardNo>
<d2p1:MerchantId>13</d2p1:MerchantId>
<d2p1:PayAmount>7</d2p1:PayAmount>
<d2p1:ShopId>sample string 14</d2p1:ShopId>
<d2p1:StartedBy>sample string 2</d2p1:StartedBy>
<d2p1:TradeFrom>sample string 3</d2p1:TradeFrom>
<d2p1:TradeFromDetail>sample string 4</d2p1:TradeFromDetail>
<d2p1:TradeMessage>sample string 9</d2p1:TradeMessage>
<d2p1:TradeStatus>sample string 8</d2p1:TradeStatus>
<d2p1:TradeTime>sample string 6</d2p1:TradeTime>
<d2p1:UserLoginName>sample string 10</d2p1:UserLoginName>
</tag>
</CommonOperationResultWithTagOfValueCardPaymentResultjuXQ_SQCk>
application/bson
Binary JSON content. See http://bsonspec.org for details.