首页 > 通信行业标准(YD) > YD/T 2765-2014 基于表述性状态转移(REST)技术的业务能力开放应用程序接口(API)支付业务
YD/T 2765-2014

基本信息

标准号: YD/T 2765-2014

中文名称:基于表述性状态转移(REST)技术的业务能力开放应用程序接口(API)支付业务

标准类别:通信行业标准(YD)

标准状态:现行

出版语种:简体中文

下载格式:.zip .pdf

相关标签: 基于 表述 状态 转移 技术 业务 能力 开放 应用 程序接口 支付

标准分类号

关联标准

出版信息

相关单位信息

标准简介

YD/T 2765-2014.RESTful based service capability open API-Payment.
1范围
YD/T 2765规定了用REST技术实现支付业务的开放应用程序接口(API),包括接口数据结构、接口定义和安全要求等。
YD/T 2765适用于提供支付业务能力开放的应用程序接口(API) 。
2规范性引用文件
下列文件对于本文件的应用是必不可少的。凡事注日期的引用文件,仅注日期的版本适用于本文件。凡是不注日期的引用文件,其最新版本(包括所有的修改单)适用于本文件。
IETF RFC 2616 超文本传送协议 --HTTP/1.1 (Hypertext Transfer Protocol - HTTP/1.1)
GB/T 12406-1996表示货币和资金的代码
YD/T 2423-2012基于表述性状态转移(REST) 技术的电信业务能力开放平台技术要求
移动通信网络的应用编程接口的授权技术要求
3术语、定义和缩略词语
3.1术语和定义
3.1.1
表述性状态转移Representational State Transfer
是一种针对网络应用的设计和开发方式,指的是一组架构约束条件和原则,可以降低开发的复杂性,提高系统的可伸缩性。具体见《基于表述性状态转移(REST) 技术的电信业务能力开放平台技术要求》对REST的定义。
3.1.2
支付Payment
通过运营商帐户作为载体进行资金的划转和管理,包括资金的支付、预留、扣除及查询等功能。
3.1.3
预留金额Reserve Amount

标准图片预览






标准内容

ICS33.040
中华人民共和国通信行业标准
YD/T2765-2014
基于表述性状态转移(REST)技术的业务能力开放应用程序接口(API)支付业务RESTful based service capabilityopenAPI-Payment2014-10-14发布
2014-10-14实施
中华人民共和国工业和信息化部发布前
范围·
规范性引用文件
3术语、定义和缩略词语·
术语和定义
缩略语
支付API定义
支付概述·
资源概述·
数据类型-
流程图·
资源详细规范
资源:用户所有扣费和返款的交易5.2
资源:列出单笔扣费或返款交易记录,资源:用户所有金额预留的交易,5.3
5.4资源:单笔金额追加预留、扣除或释放的交易安全要求·
附录A(规范性附录)响应码要求次
YD/T2765-2014
YD/T2765-2014
本标准是“基于表述性状态转移(REST)技术的业务能力开放应用程序接口(API)”系列标准之一,该系列标准的名称和结构预计如下:一基于表述性状态转移(REST)技术的电信业务能力开放平台技术要求:基于表述性状态转移(REST)技术的业务能力开放应用程序接口(AP)短消息和多媒体消息业务:
基于表述性状态转移(REST)技术的业务能力开放应用程序接口(API)点击拨号业务:基于表述性状态转移(REST)技术的业务能力开放应用程序接口(API)微博业务:一基于表述性状态转移(REST)技术的业务能力开放应用程序接口(API)搜索业务:一一基于表述性状态转移(REST)技术的业务能力开放应用程序接口(API)支付业务:一基于表述性状态转移(REST)技术的业务能力开放应用程序接口(API)定位业务:一基于表述性状态转移(REST)技术的业务能力开放应用程序接口(API)地址本;一基于表述性状态转移(REST)技术的业务能力开放应用程序接口(API)终端状态。随着技术和市场的发展,还将制定其他标准。本标准按照GB1.1给出的规则起草。请注意本文件的某些内容可能涉及专利。本文件的发布机构不承担识别这些专利的责任。本标准修改采用OMA-TS-RESTNetAPlPayment-V10-20130219-C(报批稿)标准具体差异如下:1)本标准的资源仅限于上述OMA标准下的“金额扣除/返还交易”和“金额预留交易”相关的资源;2)本标准的数据类型参数根据国内运营商的需求,对照OMA标准数据类型参数有所不同3)本标准涉及认证鉴权方面的部分,主要参考CCSA认证鉴权标准。本标准由中国通信标准化协会提出并归口。本标准起草单位:中国联合网络通信集团有限公司、工业和信息化部电信研究院、中兴通讯股份有限公司、华为技术有限公司、北京邮电大学。本标准主要起草人:廖慧、宫雪、王志军、王蓉、刘晓靖。I
1范围
基于表述性状态转移(REST)技术的业务能力开放应用程序接口(AP)支付业务
YD/T2765-2014
本标准规定了用REST技术实现支付业务的开放应用程序接口(API),包括接口数据结构、接口定义和安全要求等
本标准适用于提供支付业务能力开放的应用程序接口(API)。2规范性引用文件
下列文件对于本文件的应用是必不可少的。凡事注日期的引用文件,仅注日期的版本适用于本文件。凡是不注日期的引用文件,其最新版本(包括所有的修改单)适用于本文件。IETFRFC2616
GB/T12406-1996
YD/T2423-2012
超文本传送协议--HTTP/1.1(HypertextTransferProtocol-HTTP/1.1)表示货币和资金的代码
基于表述性状态转移(REST)技术的电信业务能力开放平台技术要求移动通信网络的应用编程接口的授权技术要求3术语、定义和缩略词语
3.1术语和定义
表述性状态转移RepresentationalStateTransfer是一种针对网络应用的设计和开发方式,指的是一组架构约束条件和原则,可以降低开发的复杂性,提高系统的可伸缩性。具体见《基于表述性状态转移(REST)技术的电信业务能力开放平台技术要求》对REST的定义。
支付Payment
通过运营商帐户作为载体进行资金的划转和管理,包括资金的支付、预留、扣除及查询等功能。3.1.3
预留金额
ReserveAmount
当用户的消费与结算不在同一时间完成时,为了确保结算时用户账户中有足够的金额支付,服务供应商预先向运营商申请预留出能够确保用户完成消费的金额。3.1.4
释放金额
ReleaseAmount
当预留的金额大于用户所消费的金额时,多出的部分会退回到用户账户中。3.2缩略语
下列缩略语适用于本文件。
ApplicationProgrammingInterface应用程序编程接口HyperTextTransferProtocol
超文本传送协议bZxz.net
YD/T2765-2014
MSISDN
4支付API定义
4.1支付概述
Identifier
JavaScript Object Notation
MobileSubscriberISDNNumber
Representational StateTransfenShort Message Service
Uniform Resource Identifier
Uniform Resource Locator
Wireless Application ProtocolTelecom service Open Platform标识符
JavaScript对象表示法
移动用户综合业务数字网号码
表述性状态转移
短信服务
统一资源标识符
统一资源定位符
无线应用协议
电信业务能力开放平台
随着移动通信和信息安全技术的迅速发展,金融支付系统正在从有线扩展到无线,电子支付正在迎来一个辨新的发展机遇,而运营商下的手机移动支付更是由于操作简单、交易迅速,将成为未来移动支付业务的主流实现方式。因此支付API变得非常重要,它能够支持运营商实现一种具备提供综合计费能力的商业模式,可以支持任何应用的支付,包括网上购物、手机订票、用户缴费、用户余额信息查询等。本文描述的支付API服务能够支持预付费和后付费的支付模式。本支付业务应用场景举例:客户收看某个服务提供商提供的足球比赛视频,此时服务提供商和运营商在客户收看前将预留适量的金额,以确保客户能够完全付清他收看的视频流量费。比赛开始后,服务提供商和运营商将会定期的从预留出的金额中扣费并再次增加预留的金额。此时,一支球队进球了使得比赛结束,部分预留的金额没有被使用,服务提供商和运营商则要释放所预留的金额,此金额可以供客户以后继续使用。此外,扩展本场景至客户参与服务提供商下的广告互动,即客户参与广告互动后,服务提供商将根据客户购买广告上的产品金额大小,退还一定比例的金额。比如,客户购买的产品超过100元,则退还全部金额,而如果购买的产品在50元~100元范围内则会被退还50%的金额。4.2资源概述
本节简要概括了REST风格的地址本API中使用的资源。资源的定义见\apiVersion\URL变量需要用\v1\的值来表明API对应的规范版本。关于变量语义的说明,见[REST_NetAPICommon]。图1展示了规范中定义的资源结构,注意:资源树中具有HTTP方法的节点以实体箱的形状标注。/(serverRoot)
L/payment/(apiVersion)
(endUserld)
/transactions0
Camounta
/amountReservationO
图1规范中定义的资源结构
itransactionld)O
(transactionld)0
表1和表2给出了规范中定义的资源的详细说明、代表的数据类型以及允许的HTTP方法。其中,数据类型均采用w3cSchema定义。
BaseURL:http://(serverRoot)
/payment/(apiVersion)
表1扣费,返款交易
数据结构
用户所有/endUserld)/transactions/amountPaymentTransactionList扣费和返
款的交易
(usedforGET)
AmountTransaction
(usedforPOST)
列出单笔(endUserId)/transactions/amount/AmountTransaction扣费或返(transactionId)
款交易记
表2金额预留交易
URLBase URL: http:/
(serverRoot)
/payment(apiVersion)
用户所有/(endUserld)/transactions/amount金额预留Reservation
的交易
数据结构
YD/T2765-2014
HTTPverbs
返回用户所有扣费
和返款的交易记录
返回单笔交易记录
(扣费或返款)
AmountReservationTransaction(usedforPOST)
单笔金额/(endUserId)/transactions/amountAmountReservationTransaction追加预留、Reservation/(transactionId)扣除或释
放的交易
4.3数据类型
4.3.1 Type:PaymentTransactionList表示支付交易的集合,见表3。
表3AmountTransactionList数据结构元素
amountTransaction
resourceURL
AmoutTransaction
[O..unbounded]
xsd:anyURI
4.3.2 Type:AmountTransaction表示消费交易的详细内容,见表4。必选/可选
具体交易信息
资源URL
表4AmountTransaction数据结构元素
endUserld
paymentAmount
transactionOperationStatus
xsd:anyURI
PaymentAmount
TransactionOperation
必选/可选
扣费/返款
HTTPverbs
预留金额
扣除预留金额/
追加预留金额/
释放预留金额
DELETE
DELETE
终端用户账户的唯一标识:如SIPURI、telURI、acrURI。该字段也是请求URL的一部分,要求请求URL的cndUserld与本数据结构的取值一致表示支付金额的内容(金额数量等)表示将要进行的交易状态
YD/T2765-2014
referenceCode
serverReferenceCode
clientCorrelator
resourceURL
Status
xsd:string
xsd:string
xsd:string
xsd:anyURI
表4(续)
必选/可选
4.3.3Type:AmountReservationTransaction表示预留金额交易的详细信息,见表5。对账的参考依据。通过和该参数进行匹配来确定所售项目
在计费或退款交易中,服务器后台系统出于对账目的提供的代码
对交易请求的唯一标识。防止重复交易资源URL
表5AmountReservationTransaction数据结构元素
endUserld
paymentAmount
xsd:anyURI
PaymentAmount
transactionOperationStatus
TransactionOperationStatus
referenceSequence
referenceCode
serverReferenceCode
clientCorrelator
resourceURL
xsd:int
xsd:string
xsd:string
xsd:string
xsd:anyURI
4.3.4Type:PaymentAmount
表示支付金额的内容,见表6。
必选/可选
终端用户账户的唯一标识:如SIPURI、telURI、acrURI。该字段也是请求URL的一部分,要求请求URL的endUserld与本数据结构的取值一致表示支付金额的内容(金额数量等)表示将要进行的交易状态
在通信失败时服务器通过这个参数来区分首次请求和重复请求
对账的参考依据。通过和该参数进行匹配来确定所售项目
在计费或退款交易中,服务器后台系统出于对账目的提供的代码
对交易请求的唯一标识。防止重复交易资源URL
PaymentAmount数据结构
charginglnformation
chargingMetaData
totalAmountCharged
totalAmountRefunded
amountReserved
ChargingInformation
ChargingMetaData
xsd:decimal
xsd:decimal
xsd:decimal
Type:Charginglnformation
表示交易的费用金额信息,见表7。表7
amount
currency
必选/可选
费用金额信息
费用相关数据
最终支付的总额
退款总金额
Charginginformation数据结构
xsd:decimal
xsd:string
必选/选
收费的金额
交易所使用的货币,货币单位具体见GB/T12406-1996
description
xsd:string
xsd:string
4.3.6Type:ChargingMetaData
表示交易费用的其他相关信息,见表8。必选
YD/T2765-2014
用于描述通知和账单的文本
根据已经生效的收费合约产生的交易代码表8chargingMetaData数据结构
onBehalfof
purchaseCategoryCode
channel
taxAmount
ServiceID
productID
xsd:string
xsd:string
xsd:string
xsd:decimal
xsd:string
xsd:string
必选/向选
TransactionOperationStatus
Enumeration:
交易状态信息,见表9。
使用这个参数来指定收款人
指出交易内容的类型
交易通道,可以是“Wap\“Web\或者\SMS\交易中供应商应缴纳的税款金额业务ID
产品ID
表9TransactionOperationStatus枚举枚举值
Charged
Processing
Reserved
Released
Refunded
Denied
Refused
4.4流程图
4.4.1概述
交易操作状态:付费
交易操作状态:交易处理中
交易操作状态:预留金额
交易操作状态:释放预留金额
交易操作状态:退款
交易操作状态:响应中的策略异常交易操作状态:交易被拒绝
下面的小节描述了典型的场景下的资源、方法和步骤。4.4.2扣费和返还交易
图2所示为创建扣费或返还交易的场景。使用以下资源:http://(serverRoot)/payment/(apiVersion)/(endUserld)资源:为扣费或返还交易,1
transactions/amount
应用程序
LPOSTC“扣费或返还”)
创建新的扣费或返还交易
响应(“扣费或返还”):
服务器
创建资源,
并分配交易ID
带有交易标识的扣费交易或返还交易图2扣费和返还交易
流程说明:
YD/T2765-2014
1.应用程序通过执行POST操作请求创建扣费或返还交易,并接收带有交易ID的响应。4.4.3金额预留交易
图3所示为金额预留、预留金额扣除、预留金额追加、预留金额释放交易的场景。资源:
为创建金额预留,使用以下资源:http://(serverRoot)/payment/(apiVersion)/(endUserId)/transactions/amountReservation为更新金额预留交易(扣除、追加、释放),使用以下资源:http://(serverRoot)/payment/(apiVersion)/(endUserld)/transactions/amountReservation/(transactionld)应用程庄
1.POST(“扣费或返还”):
创建新的金额预留交易
响应(“预留\)
带有交易标识的金额预留交易
2.POST(“扣除”):
带有交易标识的预留金额扣除交易响应(“扣除”
3.POST(“预留”):
带有交易标识的追加金额预留交易响应(“预留”)
4.POST(扣除”):
带有交易标识的预留金额扣除交易响应(“扣除”):
5.POST(“释放”)
带有交易标识的预留金额释放交易响应(“释放”)
服务盟
创建资源,
并分配交易ID
图3金额预留交易
应用程序创建新的金额预留交易(POST):2.
应用程序对预留金额进行扣除(POST):应用程序对已预留金额进行追加(POST):应用程序对追加的预留金额进行扣除(POST)4.
5.应用程序对已预留的金额进行释放(POST)。4.4.4列出交易信息
图4所示为列出所有交易信息和单个交易信息的场景。资源:
为列出所有交易信息,使用以下资源:http://&serverRoot/payment/(apiVersion//(endUserld)/transactions/amount为列出单个交易信息,使用以下资源:6
小提示:此标准内容仅展示完整标准里的部分截取内容,若需要完整标准请到上方自行免费下载完整标准文档。