ETSI ES 202 391-6 V1.3.1 (2008-05)
Open Service Access (OSA); Parlay X Web Services; Part 6: Payment (Parlay X 2)
Open Service Access (OSA); Parlay X Web Services; Part 6: Payment (Parlay X 2)
RES/TISPAN-01056-06-OSA
Odprti dostop do storitve (OSA) - Spletne storitve Parlay X - 6. del: Plačilo (Parlay X 2)
General Information
Buy Standard
Standards Content (Sample)
ETSI ES 202 391-6 V1.3.1 (2008-05)
ETSI Standard
Open Service Access (OSA);
Parlay X Web Services;
Part 6: Payment
(Parlay X 2)
�
---------------------- Page: 1 ----------------------
2 ETSI ES 202 391-6 V1.3.1 (2008-05)
Reference
RES/TISPAN-01056-06-OSA
Keywords
API, OSA, service
ETSI
650 Route des Lucioles
F-06921 Sophia Antipolis Cedex - FRANCE
Tel.: +33 4 92 94 42 00 Fax: +33 4 93 65 47 16
Siret N° 348 623 562 00017 - NAF 742 C
Association à but non lucratif enregistrée à la
Sous-Préfecture de Grasse (06) N° 7803/88
Important notice
Individual copies of the present document can be downloaded from:
http://www.etsi.org
The present document may be made available in more than one electronic version or in print. In any case of existing or
perceived difference in contents between such versions, the reference version is the Portable Document Format (PDF).
In case of dispute, the reference shall be the printing on ETSI printers of the PDF version kept on a specific network drive
within ETSI Secretariat.
Users of the present document should be aware that the document may be subject to revision or change of status.
Information on the current status of this and other ETSI documents is available at
http://portal.etsi.org/tb/status/status.asp
If you find errors in the present document, please send your comment to one of the following services:
http://portal.etsi.org/chaircor/ETSI_support.asp
Copyright Notification
No part may be reproduced except as authorized by written permission.
The copyright and the foregoing restriction extend to reproduction in all media.
© European Telecommunications Standards Institute 2008.
© The Parlay Group 2008.
All rights reserved.
TM TM TM TM
DECT , PLUGTESTS , UMTS , TIPHON , the TIPHON logo and the ETSI logo are Trade Marks of ETSI registered
for the benefit of its Members.
TM
3GPP is a Trade Mark of ETSI registered for the benefit of its Members and of the 3GPP Organizational Partners.
ETSI
---------------------- Page: 2 ----------------------
3 ETSI ES 202 391-6 V1.3.1 (2008-05)
Contents
Intellectual Property Rights.5
Foreword.5
1 Scope.6
2 References.6
2.1 Normative references.6
3 Definitions and abbreviations.7
3.1 Definitions.7
3.2 Abbreviations.7
4 Detailed service description .7
5 Namespaces.7
6 Sequence diagrams.8
6.1 Charge for content.8
7 XML Schema data type definition .9
7.1 Property structure.9
8 Web Service interface definition.9
8.1 Interface: AmountCharging.9
8.1.1 Operation: chargeAmount.9
8.1.1.1 Input message: chargeAmountRequest.9
8.1.1.2 Output message: chargeAmountResponse.9
8.1.1.3 Referenced faults.9
8.1.2 Operation: refundAmount.10
8.1.2.1 Input message: refundAmountRequest.10
8.1.2.2 Output message: refundAmountResponse.10
8.1.2.3 Referenced faults.10
8.2 Interface: VolumeCharging.10
8.2.1 Operation: chargeVolume.11
8.2.1.1 Input message: chargeVolumeRequest.11
8.2.1.2 Output message: chargeVolumeResponse.11
8.2.1.3 Referenced faults.11
8.2.2 Operation: getAmount.11
8.2.2.1 Input message: getAmountRequest.12
8.2.2.2 Output message: getAmountResponse.12
8.2.2.3 Referenced faults.12
8.2.3 Operation: refundVolume.12
8.2.3.1 Input message: refundVolumeRequest.12
8.2.3.2 Output message: refundVolumeResponse.12
8.2.3.3 Referenced faults.12
8.3 Interface: ReserveAmountCharging.13
8.3.1 Operation: reserveAmount.13
8.3.1.1 Input message: reserveAmountRequest.13
8.3.1.2 Output message: reserveAmountResponse.13
8.3.1.3 Referenced faults.13
8.3.2 Operation: reserveAdditionalAmount.14
8.3.2.1 Input message: reserveAdditionalAmountRequest .14
8.3.2.2 Output message : reserveAdditionalAmountResponse .14
8.3.2.3 Referenced faults.14
8.3.3 Operation: chargeReservation.15
8.3.3.1 Input message: chargeReservationRequest.15
8.3.3.2 Output message: chargeReservationResponse .15
8.3.3.3 Referenced faults.15
8.3.4 Operation: releaseReservation.15
ETSI
---------------------- Page: 3 ----------------------
4 ETSI ES 202 391-6 V1.3.1 (2008-05)
8.3.4.1 Input message: releaseReservationRequest.15
8.3.4.2 Output message: releaseReservationResponse.16
8.3.4.3 Referenced faults.16
8.4 Interface: ReserveVolumeCharging.16
8.4.1 Operation: getAmount.16
8.4.1.1 Input message: getAmountRequest.16
8.4.1.2 Output message : getAmountResponse.16
8.4.1.3 Referenced faults.16
8.4.2 Operation: reserveVolume.17
8.4.2.1 Input message: reserveVolumeRequest.17
8.4.2.2 Output message: reserveVolumeResponse.17
8.4.2.3 Referenced faults.17
8.4.3 Operation: reserveAdditionalVolume.17
8.4.3.1 Input message: reserveAdditionalVolumeRequest.18
8.4.3.2 Output message: reserveAdditionalVolumeResponse .18
8.4.3.3 Referenced faults.18
8.4.4 Operation: chargeReservation.18
8.4.4.1 Input message: chargeReservationRequest.18
8.4.4.2 Output message: chargeReservationResponse .18
8.4.4.3 Referenced faults.19
8.4.5 Operation: releaseReservation.19
8.4.5.1 Input message: releaseReservationRequest.19
8.4.5.2 Output message: releaseReservationResponse.19
8.4.5.3 Referenced faults.19
9 Fault definitions.19
9.1 ServiceException.19
9.1.1 SVC0270: Charge failed.19
10 Service policies .20
Annex A (normative): WSDL for Payment .21
Annex B (informative): Bibliography.22
History .23
ETSI
---------------------- Page: 4 ----------------------
5 ETSI ES 202 391-6 V1.3.1 (2008-05)
Intellectual Property Rights
IPRs essential or potentially essential to the present document may have been declared to ETSI. The information
pertaining to these essential IPRs, if any, is publicly available for ETSI members and non-members, and can be found
in ETSI SR 000 314: "Intellectual Property Rights (IPRs); Essential, or potentially Essential, IPRs notified to ETSI in
respect of ETSI standards", which is available from the ETSI Secretariat. Latest updates are available on the ETSI Web
server (http://webapp.etsi.org/IPR/home.asp).
Pursuant to the ETSI IPR Policy, no investigation, including IPR searches, has been carried out by ETSI. No guarantee
can be given as to the existence of other IPRs not referenced in ETSI SR 000 314 (or the updates on the ETSI Web
server) which are, or may be, or may become, essential to the present document.
Foreword
This ETSI Standard (ES) has been produced by ETSI Technical Committee Telecommunications and Internet
converged Services and Protocols for Advanced Networking (TISPAN).
The present document is part 6 of a multi-part deliverable covering Open Service Access (OSA); Parlay X
Web Services, as identified below:
Part 1: "Common";
Part 2: "Third Party Call";
Part 3: "Call Notification";
Part 4: "Short Messaging";
Part 5: "Multimedia Messaging";
Part 6: "Payment";
Part 7: "Account Management";
Part 8: "Terminal Status";
Part 9: "Terminal Location";
Part 10: "Call Handling";
Part 11: "Audio Call";
Part 12: "Multimedia Conference";
Part 13: "Address List Management";
Part 14: "Presence".
The present document has been defined jointly between ETSI, The Parlay Group (http://www.parlay.org), PayCircle
(http://www.paycircle.org/) and the 3GPP.
The present document forms part of the Parlay X 2.2 set of specifications.
The present document is equivalent to 3GPP TS 29.199-06 V6.5.0 (Release 6).
ETSI
---------------------- Page: 5 ----------------------
6 ETSI ES 202 391-6 V1.3.1 (2008-05)
1 Scope
The present document is part 6 of the Stage 3 Parlay X 2 Web Services specification for Open Service Access (OSA).
The OSA specifications define an architecture that enables application developers to make use of network functionality
through an open standardized interface, i.e. the OSA APIs.
The present document specifies the Payment Web Service. The following are defined here:
• Name spaces.
• Sequence diagrams.
• Data definitions.
• Interface specification plus detailed method descriptions.
• Fault definitions.
• Service Policies.
• WSDL Description of the interfaces.
2 References
References are either specific (identified by date of publication and/or edition number or version number) or
non-specific.
• For a specific reference, subsequent revisions do not apply.
• Non-specific reference may be made only to a complete document or a part thereof and only in the following
cases:
- if it is accepted that it will be possible to use all future changes of the referenced document for the
purposes of the referring document;
- for informative references.
Referenced documents which are not found to be publicly available in the expected location might be found at
http://docbox.etsi.org/Reference.
For online referenced documents, information sufficient to identify and locate the source shall be provided. Preferably,
the primary source of the referenced document should be cited, in order to ensure traceability. Furthermore, the
reference should, as far as possible, remain valid for the expected life of the document. The reference shall include the
method of access to the referenced document and the full network address, with the same punctuation and use of upper
case and lower case letters.
NOTE: While any hyperlinks included in this clause were valid at the time of publication ETSI cannot guarantee
their long term validity.
2.1 Normative references
The following referenced documents are indispensable for the application of the present document. For dated
references, only the edition cited applies. For non-specific references, the latest edition of the referenced document
(including any amendments) applies.
[1] W3C Recommendation (2 May 2001): "XML Schema Part 2: Datatypes".
NOTE: Available at: http://www.w3.org/TR/2001/REC-xmlschema-2-20010502/.
ETSI
---------------------- Page: 6 ----------------------
7 ETSI ES 202 391-6 V1.3.1 (2008-05)
[2] ETSI ES 202 391-1: "Open Service Access (OSA); Parlay X Web Services; Part 1: Common
(Parlay X 2)".
[3] ISO 4217: "Codes for the representation of currencies and funds".
3 Definitions and abbreviations
3.1 Definitions
For the purposes of the present document, the terms and definitions given in ES 202 391-1 [2] apply.
3.2 Abbreviations
For the purposes of the present document, the abbreviations given in ES 202 391-1 [2] apply.
4 Detailed service description
A vast amount of content, both information and entertainment, will be made available to subscribers. To support a
business model that enables operators to offer integrated billing, a payment API is crucial. Open and inter-operable
"payment APIs" are the key to market growth and investment protection. The Payment Web Service supports payments
for any content in an open, Web-like environment.
The Payment Web Service described in the present document supports payment reservation, pre-paid payments, and
post-paid payments. It supports charging of both volume and currency amounts, a conversion function and a settlement
function in case of a financially resolved dispute.
Note that certain parameters are negotiated off line. For example the currency, volume type, default reservation
enforcement time, as well as the taxation procedures and parameters.
An example of an application scenario could be a multimedia service. Assume a subscriber is interested in receiving a
stream of, say, a soccer match. The subscriber selects a match and establishes a trusted relation with the provider.
Again, the provider obtains the MSISDN and other information from the subscriber. The subscriber wants to know what
the service will cost and the provider interacts with the operators rating engine (getAmount) taking into account the
subscriber's subscription, time of day, etc. The value returned is a ChargingInformation amount and is printed on the
page that is displayed at the MS. The subscriber then decides to stream the match to his MS. Subsequently, the provider
will reserve the appropriate amount with the operator (reserveAmount) to ensure that the subscriber can fulfil his
payment obligations. The match starts and the provider periodically charges against the reservation
(chargeReservation). The match ends in a draw and is extended with a "sudden death" phase. The subscriber continues
listening, so the existing reservation is enlarged (reserveAdditionalAmount). Suddenly, one of the teams scores a goal,
so the match abruptly ends, leaving part of the reserved amount unused. The provider now releases the reservation
(releaseReservation), and the remaining amount is available for future use by the subscriber.
Now we can extend this scenario by having the subscriber participate in a game of chance in which the provider refunds
a percentage of the usage costs (refundAmount) based on the ranking of a particular team in this tournament. For
example, the subscriber gambling on the team that wins the tournament receives a full refund, while for gambling on the
team that finishes in second place, the refund is 50 %, etc.
5 Namespaces
The AmountCharging interface uses the namespace:
http://www.csapi.org/wsdl/parlayx/payment/amount_charging/v2_2
The VolumeCharging interface uses the namespace:
http://www.csapi.org/wsdl/parlayx/payment/volume_charging/v2_2
ETSI
---------------------- Page: 7 ----------------------
8 ETSI ES 202 391-6 V1.3.1 (2008-05)
The ReserveAmountCharging interface uses the namespace:
http://www.csapi.org/wsdl/parlayx/payment/reserve_amount_charging/v2_2
The ReserveVolumeCharging interface uses the namespace:
http://www.csapi.org/wsdl/parlayx/payment/reserve_volume_charging/v2_3
The data types are defined in the namespace:
http://www.csapi.org/schema/parlayx/payment/v2_1
The "xsd" namespace is used in the present document to refer to the XML Schema data types defined in XML
Schema [1]. The use of the name "xsd" is not semantically significant.
6 Sequence diagrams
6.1 Charge for content
Assume a subscriber is interested in downloading a ring tone to his device. The subscriber selects a ring tone and
establishes a trusted relation with the ring tone provider. Essentially, the ring tone provider obtains the address
(MSISDN) and other information from the subscriber. The ring tone may be downloaded to the device using SMS. As
soon as the download succeeds, the provider of the ring tone will charge the subscriber (chargeAmount).
: End User : Self Serve : Send Sms : Amount Charging
Portal Web Service Web Service
Log on to content portal
Order Ringtone
Send ringtone to device
Message identifier
Create charge for content
Display status page
Figure 1
ETSI
---------------------- Page: 8 ----------------------
9 ETSI ES 202 391-6 V1.3.1 (2008-05)
7 XML Schema data type definition
7.1 Property structure
Property with a name and value.
Element name Type Optional Description
name xsd:string No Name of property
value xsd:string No Value of property
8 Web Service interface definition
8.1 Interface: AmountCharging
Charge operations by amount.
8.1.1 Operation: chargeAmount
This operation results in directly charging to the account indicated by the end user identifier. The charge is specified as
a ChargingInformation data structure, consisting of information on the amount to be charged and a description to
appear on the bill. The reference code is used to uniquely identify the request; it is the application's responsibility to
provide a unique reference code within the scope of the application.
8.1.1.1 Input message: chargeAmountRequest
Part name Part type Optional Description
endUserIdentifier xsd:anyURI No The end user's account to be charged
charge common:ChargingI No Information on the charge to be made. In the
nformation ChargingInformation structure:
• The description element is information to appear on the
bill.
• The amount to be charged appears either directly in the
amount element or encoded in the code element. If
both these elements are missing or empty, a service
exception (SVC0007) will be thrown.
• The optional currency element specifies the currency to
be used for the charge.
referenceCode xsd:string No Textual information to uniquely identify the request, e.g. in
case of disputes.
8.1.1.2 Output message: chargeAmountResponse
Part name Part type Optional Description
None
8.1.1.3 Referenced faults
ServiceException from ES 202 391-1 [2]:
• SVC0001 - Service error.
• SVC0002 - Invalid input value.
• SVC0007 - Invalid charging information.
ETSI
---------------------- Page: 9 ----------------------
10 ETSI ES 202 391-6 V1.3.1 (2008-05)
• SVC0270 - Charge failed.
PolicyException from ES 202 391-1 [2]:
• POL0001 - Policy error.
8.1.2 Operation: refundAmount
This operation results in directly applying a refund to the account indicated by the end user identifier. The refund is
specified as a currency amount. The billing text field is used for textual information to appear on the bill. The reference
code is used to uniquely identify the request; it is the application's responsibility to provide a unique reference code
within the scope of the application.
8.1.2.1 Input message: refundAmountRequest
Part name Part type Optional Description
endUserIdentifier xsd:anyURI No The end user's account to be refunded
charge common:ChargingI No Information on the refund to be made. In the
nformation ChargingInformation structure:
• The description element is information to appear on
the bill.
• The amount to be refunded appears either directly in
the amount element or encoded in the code element. If
both these elements are missing or empty, a service
exception (SVC0007) will be thrown.
• The optional currency element specifies the currency
to be used for the refund.
referenceCode xsd:string No Textual information to uniquely identify the request, e.g. in
case of disputes.
8.1.2.2 Output message: refundAmountResponse
Part name Part type Optional Description
None
8.1.2.3 Referenced faults
ServiceException from ES 202 391-1 [2]:
• SVC0001 - Service error.
• SVC0002 - Invalid input value.
• SVC0007 - Invalid charging information.
• SVC0270 - Charge failed.
PolicyException from ES 202 391-1 [2]:
• POL0001 - Policy error.
8.2 Interface: VolumeCharging
Charging operations by volume.
ETSI
---------------------- Page: 10 ----------------------
11 ETSI ES 202 391-6 V1.3.1 (2008-05)
8.2.1 Operation: chargeVolume
This operation results in directly charging to the account indicated by the end user identifier. The charge is specified as
a volume. The billing text field is used for textual information to appear on the bill. The reference code is used to
uniquely identify the request; it is the application's responsibility to provide a unique reference code within the scope of
the application.
8.2.1.1 Input message: chargeVolumeRequest
Part name Part type Optional Description
endUserIdentifier xsd:anyURI No The end user's account to be charged
volume xsd:long No The volume to be charged
billingText xsd:string No Textual information to appear on the bill
referenceCode xsd:string No Textual information to uniquely identify
the request, e.g. in case of disputes
parameters Property Yes Parameters to use to perform rating
[0.unbounded] ("unit", "contract", "service", "operation")
8.2.1.2 Output message: chargeVolumeResponse
Part name Part type Optional Description
None
8.2.1.3 Referenced faults
ServiceException from ES 202 391-1 [2]:
• SVC0001 - Service error.
• SVC0002 - Invalid input value.
• SVC0270 - Charge failed.
PolicyException from ES 202 391-1 [2]:
• POL0001 - Policy error.
8.2.2 Operation: getAmount
This operation results in converting the given volume to a currency amount. The end user identifier is given to indicate
the subscriber for whom this conversion calculation must be made. The message returns a currency amount if
successful.
The following properties may be provided:
• unit, specifying the unit used for measuring volume (e.g. bytes);
• contract, number of a contract that may govern the use;
• service, name of the service to be used (e.g. SendMessageService);
• operation, name of the operation to be used (e.g. sendMessage).
ETSI
---------------------- Page: 11 ----------------------
12 ETSI ES 202 391-6 V1.3.1 (2008-05)
8.2.2.1 Input message: getAmountRequest
Part name Part type Optional Description
endUserIdentifier xsd:anyURI No The end user's account to be charged
volume xsd:long No The volume to be converted
parameters Property Yes Parameters to use to perform rating
[0.unbounded] ("unit", "contract", "service", "operation")
8.2.2.2 Output message: getAmo
...
Final draft ETSI ES 202 391-6 V1.3.1 (2008-02)
ETSI Standard
Open Service Access (OSA);
Parlay X Web Services;
Part 6: Payment
(Parlay X 2)
�
---------------------- Page: 1 ----------------------
2 Final draft ETSI ES 202 391-6 V1.3.1 (2008-02)
Reference
RES/TISPAN-01056-06-OSA
Keywords
API, OSA, service
ETSI
650 Route des Lucioles
F-06921 Sophia Antipolis Cedex - FRANCE
Tel.: +33 4 92 94 42 00 Fax: +33 4 93 65 47 16
Siret N° 348 623 562 00017 - NAF 742 C
Association à but non lucratif enregistrée à la
Sous-Préfecture de Grasse (06) N° 7803/88
Important notice
Individual copies of the present document can be downloaded from:
http://www.etsi.org
The present document may be made available in more than one electronic version or in print. In any case of existing or
perceived difference in contents between such versions, the reference version is the Portable Document Format (PDF).
In case of dispute, the reference shall be the printing on ETSI printers of the PDF version kept on a specific network drive
within ETSI Secretariat.
Users of the present document should be aware that the document may be subject to revision or change of status.
Information on the current status of this and other ETSI documents is available at
http://portal.etsi.org/tb/status/status.asp
If you find errors in the present document, please send your comment to one of the following services:
http://portal.etsi.org/chaircor/ETSI_support.asp
Copyright Notification
No part may be reproduced except as authorized by written permission.
The copyright and the foregoing restriction extend to reproduction in all media.
© European Telecommunications Standards Institute 2008.
© The Parlay Group 2008.
All rights reserved.
TM TM TM TM
DECT , PLUGTESTS , UMTS , TIPHON , the TIPHON logo and the ETSI logo are Trade Marks of ETSI registered
for the benefit of its Members.
TM
3GPP is a Trade Mark of ETSI registered for the benefit of its Members and of the 3GPP Organizational Partners.
ETSI
---------------------- Page: 2 ----------------------
3 Final draft ETSI ES 202 391-6 V1.3.1 (2008-02)
Contents
Intellectual Property Rights.5
Foreword.5
1 Scope.6
2 References.6
2.1 Normative references.6
3 Definitions and abbreviations.7
3.1 Definitions.7
3.2 Abbreviations.7
4 Detailed service description .7
5 Namespaces.7
6 Sequence diagrams.8
6.1 Charge for content.8
7 XML Schema data type definition .9
7.1 Property structure.9
8 Web Service interface definition.9
8.1 Interface: AmountCharging.9
8.1.1 Operation: chargeAmount.9
8.1.1.1 Input message: chargeAmountRequest.9
8.1.1.2 Output message: chargeAmountResponse.9
8.1.1.3 Referenced faults.9
8.1.2 Operation: refundAmount.10
8.1.2.1 Input message: refundAmountRequest.10
8.1.2.2 Output message: refundAmountResponse.10
8.1.2.3 Referenced faults.10
8.2 Interface: VolumeCharging.10
8.2.1 Operation: chargeVolume.11
8.2.1.1 Input message: chargeVolumeRequest.11
8.2.1.2 Output message: chargeVolumeResponse.11
8.2.1.3 Referenced faults.11
8.2.2 Operation: getAmount.11
8.2.2.1 Input message: getAmountRequest.12
8.2.2.2 Output message: getAmountResponse.12
8.2.2.3 Referenced faults.12
8.2.3 Operation: refundVolume.12
8.2.3.1 Input message: refundVolumeRequest.12
8.2.3.2 Output message: refundVolumeResponse.12
8.2.3.3 Referenced faults.12
8.3 Interface: ReserveAmountCharging.13
8.3.1 Operation: reserveAmount.13
8.3.1.1 Input message: reserveAmountRequest.13
8.3.1.2 Output message: reserveAmountResponse.13
8.3.1.3 Referenced faults.13
8.3.2 Operation: reserveAdditionalAmount.14
8.3.2.1 Input message: reserveAdditionalAmountRequest .14
8.3.2.2 Output message : reserveAdditionalAmountResponse .14
8.3.2.3 Referenced faults.14
8.3.3 Operation: chargeReservation.15
8.3.3.1 Input message: chargeReservationRequest.15
8.3.3.2 Output message: chargeReservationResponse .15
8.3.3.3 Referenced faults.15
8.3.4 Operation: releaseReservation.15
ETSI
---------------------- Page: 3 ----------------------
4 Final draft ETSI ES 202 391-6 V1.3.1 (2008-02)
8.3.4.1 Input message: releaseReservationRequest.15
8.3.4.2 Output message: releaseReservationResponse.16
8.3.4.3 Referenced faults.16
8.4 Interface: ReserveVolumeCharging.16
8.4.1 Operation: getAmount.16
8.4.1.1 Input message: getAmountRequest.16
8.4.1.2 Output message : getAmountResponse.16
8.4.1.3 Referenced faults.16
8.4.2 Operation: reserveVolume.17
8.4.2.1 Input message: reserveVolumeRequest.17
8.4.2.2 Output message: reserveVolumeResponse.17
8.4.2.3 Referenced faults.17
8.4.3 Operation: reserveAdditionalVolume.17
8.4.3.1 Input message: reserveAdditionalVolumeRequest.18
8.4.3.2 Output message: reserveAdditionalVolumeResponse .18
8.4.3.3 Referenced faults.18
8.4.4 Operation: chargeReservation.18
8.4.4.1 Input message: chargeReservationRequest.18
8.4.4.2 Output message: chargeReservationResponse .18
8.4.4.3 Referenced faults.19
8.4.5 Operation: releaseReservation.19
8.4.5.1 Input message: releaseReservationRequest.19
8.4.5.2 Output message: releaseReservationResponse.19
8.4.5.3 Referenced faults.19
9 Fault definitions.19
9.1 ServiceException.19
9.1.1 SVC0270: Charge failed.19
10 Service policies .20
Annex A (normative): WSDL for Payment .21
Annex B (informative): Bibliography.22
History .23
ETSI
---------------------- Page: 4 ----------------------
5 Final draft ETSI ES 202 391-6 V1.3.1 (2008-02)
Intellectual Property Rights
IPRs essential or potentially essential to the present document may have been declared to ETSI. The information
pertaining to these essential IPRs, if any, is publicly available for ETSI members and non-members, and can be found
in ETSI SR 000 314: "Intellectual Property Rights (IPRs); Essential, or potentially Essential, IPRs notified to ETSI in
respect of ETSI standards", which is available from the ETSI Secretariat. Latest updates are available on the ETSI Web
server (http://webapp.etsi.org/IPR/home.asp).
Pursuant to the ETSI IPR Policy, no investigation, including IPR searches, has been carried out by ETSI. No guarantee
can be given as to the existence of other IPRs not referenced in ETSI SR 000 314 (or the updates on the ETSI Web
server) which are, or may be, or may become, essential to the present document.
Foreword
This ETSI Standard (ES) has been produced by ETSI Technical Committee Telecommunications and Internet
converged Services and Protocols for Advanced Networking (TISPAN), and is now submitted for the ETSI standards
Membership Approval Procedure.
The present document is part 6 of a multi-part deliverable covering Open Service Access (OSA); Parlay X
Web Services, as identified below:
Part 1: "Common";
Part 2: "Third Party Call";
Part 3: "Call Notification";
Part 4: "Short Messaging";
Part 5: "Multimedia Messaging";
Part 6: "Payment";
Part 7: "Account Management";
Part 8: "Terminal Status";
Part 9: "Terminal Location";
Part 10: "Call Handling";
Part 11: "Audio Call";
Part 12: "Multimedia Conference";
Part 13: "Address List Management";
Part 14: "Presence".
The present document has been defined jointly between ETSI, The Parlay Group (http://www.parlay.org), PayCircle
(http://www.paycircle.org/) and the 3GPP.
The present document forms part of the Parlay X 2.2 set of specifications.
The present document is equivalent to 3GPP TS 29.199-06 V6.5.0 (Release 6).
ETSI
---------------------- Page: 5 ----------------------
6 Final draft ETSI ES 202 391-6 V1.3.1 (2008-02)
1 Scope
The present document is part 6 of the Stage 3 Parlay X 2 Web Services specification for Open Service Access (OSA).
The OSA specifications define an architecture that enables application developers to make use of network functionality
through an open standardized interface, i.e. the OSA APIs.
The present document specifies the Payment Web Service. The following are defined here:
• Name spaces.
• Sequence diagrams.
• Data definitions.
• Interface specification plus detailed method descriptions.
• Fault definitions.
• Service Policies.
• WSDL Description of the interfaces.
2 References
References are either specific (identified by date of publication and/or edition number or version number) or
non-specific.
• For a specific reference, subsequent revisions do not apply.
• Non-specific reference may be made only to a complete document or a part thereof and only in the following
cases:
- if it is accepted that it will be possible to use all future changes of the referenced document for the
purposes of the referring document;
- for informative references.
Referenced documents which are not found to be publicly available in the expected location might be found at
http://docbox.etsi.org/Reference.
For online referenced documents, information sufficient to identify and locate the source shall be provided. Preferably,
the primary source of the referenced document should be cited, in order to ensure traceability. Furthermore, the
reference should, as far as possible, remain valid for the expected life of the document. The reference shall include the
method of access to the referenced document and the full network address, with the same punctuation and use of upper
case and lower case letters.
NOTE: While any hyperlinks included in this clause were valid at the time of publication ETSI cannot guarantee
their long term validity.
2.1 Normative references
The following referenced documents are indispensable for the application of the present document. For dated
references, only the edition cited applies. For non-specific references, the latest edition of the referenced document
(including any amendments) applies.
[1] W3C Recommendation (2 May 2001): "XML Schema Part 2: Datatypes".
NOTE: Available at: http://www.w3.org/TR/2001/REC-xmlschema-2-20010502/.
ETSI
---------------------- Page: 6 ----------------------
7 Final draft ETSI ES 202 391-6 V1.3.1 (2008-02)
[2] ETSI ES 202 391-1: "Open Service Access (OSA); Parlay X Web Services; Part 1: Common
(Parlay X 2)".
[3] ISO 4217: "Codes for the representation of currencies and funds".
3 Definitions and abbreviations
3.1 Definitions
For the purposes of the present document, the terms and definitions given in ES 202 391-1 [2] apply.
3.2 Abbreviations
For the purposes of the present document, the abbreviations given in ES 202 391-1 [2] apply.
4 Detailed service description
A vast amount of content, both information and entertainment, will be made available to subscribers. To support a
business model that enables operators to offer integrated billing, a payment API is crucial. Open and inter-operable
"payment APIs" are the key to market growth and investment protection. The Payment Web Service supports payments
for any content in an open, Web-like environment.
The Payment Web Service described in the present document supports payment reservation, pre-paid payments, and
post-paid payments. It supports charging of both volume and currency amounts, a conversion function and a settlement
function in case of a financially resolved dispute.
Note that certain parameters are negotiated off line. For example the currency, volume type, default reservation
enforcement time, as well as the taxation procedures and parameters.
An example of an application scenario could be a multimedia service. Assume a subscriber is interested in receiving a
stream of, say, a soccer match. The subscriber selects a match and establishes a trusted relation with the provider.
Again, the provider obtains the MSISDN and other information from the subscriber. The subscriber wants to know what
the service will cost and the provider interacts with the operators rating engine (getAmount) taking into account the
subscriber's subscription, time of day, etc. The value returned is a ChargingInformation amount and is printed on the
page that is displayed at the MS. The subscriber then decides to stream the match to his MS. Subsequently, the provider
will reserve the appropriate amount with the operator (reserveAmount) to ensure that the subscriber can fulfil his
payment obligations. The match starts and the provider periodically charges against the reservation
(chargeReservation). The match ends in a draw and is extended with a "sudden death" phase. The subscriber continues
listening, so the existing reservation is enlarged (reserveAdditionalAmount). Suddenly, one of the teams scores a goal,
so the match abruptly ends, leaving part of the reserved amount unused. The provider now releases the reservation
(releaseReservation), and the remaining amount is available for future use by the subscriber.
Now we can extend this scenario by having the subscriber participate in a game of chance in which the provider refunds
a percentage of the usage costs (refundAmount) based on the ranking of a particular team in this tournament. For
example, the subscriber gambling on the team that wins the tournament receives a full refund, while for gambling on the
team that finishes in second place, the refund is 50 %, etc.
5 Namespaces
The AmountCharging interface uses the namespace:
http://www.csapi.org/wsdl/parlayx/payment/amount_charging/v2_2
The VolumeCharging interface uses the namespace:
http://www.csapi.org/wsdl/parlayx/payment/volume_charging/v2_2
ETSI
---------------------- Page: 7 ----------------------
8 Final draft ETSI ES 202 391-6 V1.3.1 (2008-02)
The ReserveAmountCharging interface uses the namespace:
http://www.csapi.org/wsdl/parlayx/payment/reserve_amount_charging/v2_2
The ReserveVolumeCharging interface uses the namespace:
http://www.csapi.org/wsdl/parlayx/payment/reserve_volume_charging/v2_3
The data types are defined in the namespace:
http://www.csapi.org/schema/parlayx/payment/v2_1
The "xsd" namespace is used in the present document to refer to the XML Schema data types defined in XML
Schema [1]. The use of the name "xsd" is not semantically significant.
6 Sequence diagrams
6.1 Charge for content
Assume a subscriber is interested in downloading a ring tone to his device. The subscriber selects a ring tone and
establishes a trusted relation with the ring tone provider. Essentially, the ring tone provider obtains the address
(MSISDN) and other information from the subscriber. The ring tone may be downloaded to the device using SMS. As
soon as the download succeeds, the provider of the ring tone will charge the subscriber (chargeAmount).
: End User : Self Serve : Send Sms : Amount Charging
Portal Web Service Web Service
Log on to content portal
Order Ringtone
Send ringtone to device
Message identifier
Create charge for content
Display status page
Figure 1
ETSI
---------------------- Page: 8 ----------------------
9 Final draft ETSI ES 202 391-6 V1.3.1 (2008-02)
7 XML Schema data type definition
7.1 Property structure
Property with a name and value.
Element name Type Optional Description
name xsd:string No Name of property
value xsd:string No Value of property
8 Web Service interface definition
8.1 Interface: AmountCharging
Charge operations by amount.
8.1.1 Operation: chargeAmount
This operation results in directly charging to the account indicated by the end user identifier. The charge is specified as
a ChargingInformation data structure, consisting of information on the amount to be charged and a description to
appear on the bill. The reference code is used to uniquely identify the request; it is the application's responsibility to
provide a unique reference code within the scope of the application.
8.1.1.1 Input message: chargeAmountRequest
Part name Part type Optional Description
endUserIdentifier xsd:anyURI No The end user's account to be charged
charge common:Charging No Information on the charge to be made. In the
Information ChargingInformation structure:
• The description element is information to appear on
the bill.
• The amount to be charged appears either directly in the
amount element or encoded in the code element. If
both these elements are missing or empty, a service
exception (SVC0007) will be thrown.
• The optional currency element specifies the currency
to be used for the charge.
referenceCode xsd:string No Textual information to uniquely identify the request, e.g. in
case of disputes.
8.1.1.2 Output message: chargeAmountResponse
Part name Part type Optional Description
None
8.1.1.3 Referenced faults
ServiceException from ES 202 391-1 [2]:
• SVC0001 - Service error.
• SVC0002 - Invalid input value.
• SVC0007 - Invalid charging information.
ETSI
---------------------- Page: 9 ----------------------
10 Final draft ETSI ES 202 391-6 V1.3.1 (2008-02)
• SVC0270 - Charge failed.
PolicyException from ES 202 391-1 [2]:
• POL0001 - Policy error.
8.1.2 Operation: refundAmount
This operation results in directly applying a refund to the account indicated by the end user identifier. The refund is
specified as a currency amount. The billing text field is used for textual information to appear on the bill. The reference
code is used to uniquely identify the request; it is the application's responsibility to provide a unique reference code
within the scope of the application.
8.1.2.1 Input message: refundAmountRequest
Part name Part type Optional Description
endUserIdentifier xsd:anyURI No The end user's account to be refunded
charge common:Charging No Information on the refund to be made. In the
Information ChargingInformation structure:
• The description element is information to appear on
the bill.
• The amount to be refunded appears either directly in
the amount element or encoded in the code element.
If both these elements are missing or empty, a service
exception (SVC0007) will be thrown.
• The optional currency element specifies the currency
to be used for the refund.
referenceCode xsd:string No Textual information to uniquely identify the request, e.g. in
case of disputes.
8.1.2.2 Output message: refundAmountResponse
Part name Part type Optional Description
None
8.1.2.3 Referenced faults
ServiceException from ES 202 391-1 [2]:
• SVC0001 - Service error.
• SVC0002 - Invalid input value.
• SVC0007 - Invalid charging information.
• SVC0270 - Charge failed.
PolicyException from ES 202 391-1 [2]:
• POL0001 - Policy error.
8.2 Interface: VolumeCharging
Charging operations by volume.
ETSI
---------------------- Page: 10 ----------------------
11 Final draft ETSI ES 202 391-6 V1.3.1 (2008-02)
8.2.1 Operation: chargeVolume
This operation results in directly charging to the account indicated by the end user identifier. The charge is specified as
a volume. The billing text field is used for textual information to appear on the bill. The reference code is used to
uniquely identify the request; it is the application's responsibility to provide a unique reference code within the scope of
the application.
8.2.1.1 Input message: chargeVolumeRequest
Part name Part type Optional Description
endUserIdentifier xsd:anyURI No The end user's account to be charged
volume xsd:long No The volume to be charged
billingText xsd:string No Textual information to appear on the bill
referenceCode xsd:string No Textual information to uniquely identify
the request, e.g. in case of disputes
parameters Property Yes Parameters to use to perform rating
[0.unbounded] ("unit", "contract", "service", "operation")
8.2.1.2 Output message: chargeVolumeResponse
Part name Part type Optional Description
None
8.2.1.3 Referenced faults
ServiceException from ES 202 391-1 [2]:
• SVC0001 - Service error.
• SVC0002 - Invalid input value.
• SVC0270 - Charge failed.
PolicyException from ES 202 391-1 [2]:
• POL0001 - Policy error.
8.2.2 Operation: getAmount
This operation results in converting the given volume to a currency amount. The end user identifier is given to indicate
the subscriber for whom this conversion calculation must be made. The message returns a currency amount if
successful.
The following properties may be provided:
• unit, specifying the unit used for measuring volume (e.g. bytes);
• contract, number of a contract that may govern the use;
• service, name of the service to be used (e.g. SendMessageService);
• operation, name of the operation to be used (e.g. sendMessage).
ETSI
---------------------- Page: 11 ----------------------
12 Final draft ETSI ES 202 391-6 V1.3.1 (2008-02)
8.2.2.1 Input message: getAmountRequest
Part name Part type Optional Description
endUserIdentifier xsd:anyURI No The end user's acco
...
SLOVENSKI STANDARD
SIST ES 202 391-6 V1.3.1:2008
01-september-2008
2GSUWLGRVWRSGRVWRULWYH 26$ 6SOHWQHVWRULWYH3DUOD\;GHO 3ODþLOR 3DUOD\
;
Open Service Access (OSA) - Parlay X Web Services - Part 6: Payment (Parlay X 2)
Ta slovenski standard je istoveten z: ES 202 391-6 Version 1.3.1
ICS:
35.100.01 Medsebojno povezovanje Open systems
odprtih sistemov na splošno interconnection in general
SIST ES 202 391-6 V1.3.1:2008 en
2003-01.Slovenski inštitut za standardizacijo. Razmnoževanje celote ali delov tega standarda ni dovoljeno.
---------------------- Page: 1 ----------------------
SIST ES 202 391-6 V1.3.1:2008
---------------------- Page: 2 ----------------------
SIST ES 202 391-6 V1.3.1:2008
ETSI ES 202 391-6 V1.3.1 (2008-05)
ETSI Standard
Open Service Access (OSA);
Parlay X Web Services;
Part 6: Payment
(Parlay X 2)
�
---------------------- Page: 3 ----------------------
SIST ES 202 391-6 V1.3.1:2008
2 ETSI ES 202 391-6 V1.3.1 (2008-05)
Reference
RES/TISPAN-01056-06-OSA
Keywords
API, OSA, service
ETSI
650 Route des Lucioles
F-06921 Sophia Antipolis Cedex - FRANCE
Tel.: +33 4 92 94 42 00 Fax: +33 4 93 65 47 16
Siret N° 348 623 562 00017 - NAF 742 C
Association à but non lucratif enregistrée à la
Sous-Préfecture de Grasse (06) N° 7803/88
Important notice
Individual copies of the present document can be downloaded from:
http://www.etsi.org
The present document may be made available in more than one electronic version or in print. In any case of existing or
perceived difference in contents between such versions, the reference version is the Portable Document Format (PDF).
In case of dispute, the reference shall be the printing on ETSI printers of the PDF version kept on a specific network drive
within ETSI Secretariat.
Users of the present document should be aware that the document may be subject to revision or change of status.
Information on the current status of this and other ETSI documents is available at
http://portal.etsi.org/tb/status/status.asp
If you find errors in the present document, please send your comment to one of the following services:
http://portal.etsi.org/chaircor/ETSI_support.asp
Copyright Notification
No part may be reproduced except as authorized by written permission.
The copyright and the foregoing restriction extend to reproduction in all media.
© European Telecommunications Standards Institute 2008.
© The Parlay Group 2008.
All rights reserved.
TM TM TM TM
DECT , PLUGTESTS , UMTS , TIPHON , the TIPHON logo and the ETSI logo are Trade Marks of ETSI registered
for the benefit of its Members.
TM
3GPP is a Trade Mark of ETSI registered for the benefit of its Members and of the 3GPP Organizational Partners.
ETSI
---------------------- Page: 4 ----------------------
SIST ES 202 391-6 V1.3.1:2008
3 ETSI ES 202 391-6 V1.3.1 (2008-05)
Contents
Intellectual Property Rights.5
Foreword.5
1 Scope.6
2 References.6
2.1 Normative references.6
3 Definitions and abbreviations.7
3.1 Definitions.7
3.2 Abbreviations.7
4 Detailed service description .7
5 Namespaces.7
6 Sequence diagrams.8
6.1 Charge for content.8
7 XML Schema data type definition .9
7.1 Property structure.9
8 Web Service interface definition.9
8.1 Interface: AmountCharging.9
8.1.1 Operation: chargeAmount.9
8.1.1.1 Input message: chargeAmountRequest.9
8.1.1.2 Output message: chargeAmountResponse.9
8.1.1.3 Referenced faults.9
8.1.2 Operation: refundAmount.10
8.1.2.1 Input message: refundAmountRequest.10
8.1.2.2 Output message: refundAmountResponse.10
8.1.2.3 Referenced faults.10
8.2 Interface: VolumeCharging.10
8.2.1 Operation: chargeVolume.11
8.2.1.1 Input message: chargeVolumeRequest.11
8.2.1.2 Output message: chargeVolumeResponse.11
8.2.1.3 Referenced faults.11
8.2.2 Operation: getAmount.11
8.2.2.1 Input message: getAmountRequest.12
8.2.2.2 Output message: getAmountResponse.12
8.2.2.3 Referenced faults.12
8.2.3 Operation: refundVolume.12
8.2.3.1 Input message: refundVolumeRequest.12
8.2.3.2 Output message: refundVolumeResponse.12
8.2.3.3 Referenced faults.12
8.3 Interface: ReserveAmountCharging.13
8.3.1 Operation: reserveAmount.13
8.3.1.1 Input message: reserveAmountRequest.13
8.3.1.2 Output message: reserveAmountResponse.13
8.3.1.3 Referenced faults.13
8.3.2 Operation: reserveAdditionalAmount.14
8.3.2.1 Input message: reserveAdditionalAmountRequest .14
8.3.2.2 Output message : reserveAdditionalAmountResponse .14
8.3.2.3 Referenced faults.14
8.3.3 Operation: chargeReservation.15
8.3.3.1 Input message: chargeReservationRequest.15
8.3.3.2 Output message: chargeReservationResponse .15
8.3.3.3 Referenced faults.15
8.3.4 Operation: releaseReservation.15
ETSI
---------------------- Page: 5 ----------------------
SIST ES 202 391-6 V1.3.1:2008
4 ETSI ES 202 391-6 V1.3.1 (2008-05)
8.3.4.1 Input message: releaseReservationRequest.15
8.3.4.2 Output message: releaseReservationResponse.16
8.3.4.3 Referenced faults.16
8.4 Interface: ReserveVolumeCharging.16
8.4.1 Operation: getAmount.16
8.4.1.1 Input message: getAmountRequest.16
8.4.1.2 Output message : getAmountResponse.16
8.4.1.3 Referenced faults.16
8.4.2 Operation: reserveVolume.17
8.4.2.1 Input message: reserveVolumeRequest.17
8.4.2.2 Output message: reserveVolumeResponse.17
8.4.2.3 Referenced faults.17
8.4.3 Operation: reserveAdditionalVolume.17
8.4.3.1 Input message: reserveAdditionalVolumeRequest.18
8.4.3.2 Output message: reserveAdditionalVolumeResponse .18
8.4.3.3 Referenced faults.18
8.4.4 Operation: chargeReservation.18
8.4.4.1 Input message: chargeReservationRequest.18
8.4.4.2 Output message: chargeReservationResponse .18
8.4.4.3 Referenced faults.19
8.4.5 Operation: releaseReservation.19
8.4.5.1 Input message: releaseReservationRequest.19
8.4.5.2 Output message: releaseReservationResponse.19
8.4.5.3 Referenced faults.19
9 Fault definitions.19
9.1 ServiceException.19
9.1.1 SVC0270: Charge failed.19
10 Service policies .20
Annex A (normative): WSDL for Payment .21
Annex B (informative): Bibliography.22
History .23
ETSI
---------------------- Page: 6 ----------------------
SIST ES 202 391-6 V1.3.1:2008
5 ETSI ES 202 391-6 V1.3.1 (2008-05)
Intellectual Property Rights
IPRs essential or potentially essential to the present document may have been declared to ETSI. The information
pertaining to these essential IPRs, if any, is publicly available for ETSI members and non-members, and can be found
in ETSI SR 000 314: "Intellectual Property Rights (IPRs); Essential, or potentially Essential, IPRs notified to ETSI in
respect of ETSI standards", which is available from the ETSI Secretariat. Latest updates are available on the ETSI Web
server (http://webapp.etsi.org/IPR/home.asp).
Pursuant to the ETSI IPR Policy, no investigation, including IPR searches, has been carried out by ETSI. No guarantee
can be given as to the existence of other IPRs not referenced in ETSI SR 000 314 (or the updates on the ETSI Web
server) which are, or may be, or may become, essential to the present document.
Foreword
This ETSI Standard (ES) has been produced by ETSI Technical Committee Telecommunications and Internet
converged Services and Protocols for Advanced Networking (TISPAN).
The present document is part 6 of a multi-part deliverable covering Open Service Access (OSA); Parlay X
Web Services, as identified below:
Part 1: "Common";
Part 2: "Third Party Call";
Part 3: "Call Notification";
Part 4: "Short Messaging";
Part 5: "Multimedia Messaging";
Part 6: "Payment";
Part 7: "Account Management";
Part 8: "Terminal Status";
Part 9: "Terminal Location";
Part 10: "Call Handling";
Part 11: "Audio Call";
Part 12: "Multimedia Conference";
Part 13: "Address List Management";
Part 14: "Presence".
The present document has been defined jointly between ETSI, The Parlay Group (http://www.parlay.org), PayCircle
(http://www.paycircle.org/) and the 3GPP.
The present document forms part of the Parlay X 2.2 set of specifications.
The present document is equivalent to 3GPP TS 29.199-06 V6.5.0 (Release 6).
ETSI
---------------------- Page: 7 ----------------------
SIST ES 202 391-6 V1.3.1:2008
6 ETSI ES 202 391-6 V1.3.1 (2008-05)
1 Scope
The present document is part 6 of the Stage 3 Parlay X 2 Web Services specification for Open Service Access (OSA).
The OSA specifications define an architecture that enables application developers to make use of network functionality
through an open standardized interface, i.e. the OSA APIs.
The present document specifies the Payment Web Service. The following are defined here:
• Name spaces.
• Sequence diagrams.
• Data definitions.
• Interface specification plus detailed method descriptions.
• Fault definitions.
• Service Policies.
• WSDL Description of the interfaces.
2 References
References are either specific (identified by date of publication and/or edition number or version number) or
non-specific.
• For a specific reference, subsequent revisions do not apply.
• Non-specific reference may be made only to a complete document or a part thereof and only in the following
cases:
- if it is accepted that it will be possible to use all future changes of the referenced document for the
purposes of the referring document;
- for informative references.
Referenced documents which are not found to be publicly available in the expected location might be found at
http://docbox.etsi.org/Reference.
For online referenced documents, information sufficient to identify and locate the source shall be provided. Preferably,
the primary source of the referenced document should be cited, in order to ensure traceability. Furthermore, the
reference should, as far as possible, remain valid for the expected life of the document. The reference shall include the
method of access to the referenced document and the full network address, with the same punctuation and use of upper
case and lower case letters.
NOTE: While any hyperlinks included in this clause were valid at the time of publication ETSI cannot guarantee
their long term validity.
2.1 Normative references
The following referenced documents are indispensable for the application of the present document. For dated
references, only the edition cited applies. For non-specific references, the latest edition of the referenced document
(including any amendments) applies.
[1] W3C Recommendation (2 May 2001): "XML Schema Part 2: Datatypes".
NOTE: Available at: http://www.w3.org/TR/2001/REC-xmlschema-2-20010502/.
ETSI
---------------------- Page: 8 ----------------------
SIST ES 202 391-6 V1.3.1:2008
7 ETSI ES 202 391-6 V1.3.1 (2008-05)
[2] ETSI ES 202 391-1: "Open Service Access (OSA); Parlay X Web Services; Part 1: Common
(Parlay X 2)".
[3] ISO 4217: "Codes for the representation of currencies and funds".
3 Definitions and abbreviations
3.1 Definitions
For the purposes of the present document, the terms and definitions given in ES 202 391-1 [2] apply.
3.2 Abbreviations
For the purposes of the present document, the abbreviations given in ES 202 391-1 [2] apply.
4 Detailed service description
A vast amount of content, both information and entertainment, will be made available to subscribers. To support a
business model that enables operators to offer integrated billing, a payment API is crucial. Open and inter-operable
"payment APIs" are the key to market growth and investment protection. The Payment Web Service supports payments
for any content in an open, Web-like environment.
The Payment Web Service described in the present document supports payment reservation, pre-paid payments, and
post-paid payments. It supports charging of both volume and currency amounts, a conversion function and a settlement
function in case of a financially resolved dispute.
Note that certain parameters are negotiated off line. For example the currency, volume type, default reservation
enforcement time, as well as the taxation procedures and parameters.
An example of an application scenario could be a multimedia service. Assume a subscriber is interested in receiving a
stream of, say, a soccer match. The subscriber selects a match and establishes a trusted relation with the provider.
Again, the provider obtains the MSISDN and other information from the subscriber. The subscriber wants to know what
the service will cost and the provider interacts with the operators rating engine (getAmount) taking into account the
subscriber's subscription, time of day, etc. The value returned is a ChargingInformation amount and is printed on the
page that is displayed at the MS. The subscriber then decides to stream the match to his MS. Subsequently, the provider
will reserve the appropriate amount with the operator (reserveAmount) to ensure that the subscriber can fulfil his
payment obligations. The match starts and the provider periodically charges against the reservation
(chargeReservation). The match ends in a draw and is extended with a "sudden death" phase. The subscriber continues
listening, so the existing reservation is enlarged (reserveAdditionalAmount). Suddenly, one of the teams scores a goal,
so the match abruptly ends, leaving part of the reserved amount unused. The provider now releases the reservation
(releaseReservation), and the remaining amount is available for future use by the subscriber.
Now we can extend this scenario by having the subscriber participate in a game of chance in which the provider refunds
a percentage of the usage costs (refundAmount) based on the ranking of a particular team in this tournament. For
example, the subscriber gambling on the team that wins the tournament receives a full refund, while for gambling on the
team that finishes in second place, the refund is 50 %, etc.
5 Namespaces
The AmountCharging interface uses the namespace:
http://www.csapi.org/wsdl/parlayx/payment/amount_charging/v2_2
The VolumeCharging interface uses the namespace:
http://www.csapi.org/wsdl/parlayx/payment/volume_charging/v2_2
ETSI
---------------------- Page: 9 ----------------------
SIST ES 202 391-6 V1.3.1:2008
8 ETSI ES 202 391-6 V1.3.1 (2008-05)
The ReserveAmountCharging interface uses the namespace:
http://www.csapi.org/wsdl/parlayx/payment/reserve_amount_charging/v2_2
The ReserveVolumeCharging interface uses the namespace:
http://www.csapi.org/wsdl/parlayx/payment/reserve_volume_charging/v2_3
The data types are defined in the namespace:
http://www.csapi.org/schema/parlayx/payment/v2_1
The "xsd" namespace is used in the present document to refer to the XML Schema data types defined in XML
Schema [1]. The use of the name "xsd" is not semantically significant.
6 Sequence diagrams
6.1 Charge for content
Assume a subscriber is interested in downloading a ring tone to his device. The subscriber selects a ring tone and
establishes a trusted relation with the ring tone provider. Essentially, the ring tone provider obtains the address
(MSISDN) and other information from the subscriber. The ring tone may be downloaded to the device using SMS. As
soon as the download succeeds, the provider of the ring tone will charge the subscriber (chargeAmount).
: End User : Self Serve : Send Sms : Amount Charging
Portal Web Service Web Service
Log on to content portal
Order Ringtone
Send ringtone to device
Message identifier
Create charge for content
Display status page
Figure 1
ETSI
---------------------- Page: 10 ----------------------
SIST ES 202 391-6 V1.3.1:2008
9 ETSI ES 202 391-6 V1.3.1 (2008-05)
7 XML Schema data type definition
7.1 Property structure
Property with a name and value.
Element name Type Optional Description
name xsd:string No Name of property
value xsd:string No Value of property
8 Web Service interface definition
8.1 Interface: AmountCharging
Charge operations by amount.
8.1.1 Operation: chargeAmount
This operation results in directly charging to the account indicated by the end user identifier. The charge is specified as
a ChargingInformation data structure, consisting of information on the amount to be charged and a description to
appear on the bill. The reference code is used to uniquely identify the request; it is the application's responsibility to
provide a unique reference code within the scope of the application.
8.1.1.1 Input message: chargeAmountRequest
Part name Part type Optional Description
endUserIdentifier xsd:anyURI No The end user's account to be charged
charge common:ChargingI No Information on the charge to be made. In the
nformation ChargingInformation structure:
• The description element is information to appear on the
bill.
• The amount to be charged appears either directly in the
amount element or encoded in the code element. If
both these elements are missing or empty, a service
exception (SVC0007) will be thrown.
• The optional currency element specifies the currency to
be used for the charge.
referenceCode xsd:string No Textual information to uniquely identify the request, e.g. in
case of disputes.
8.1.1.2 Output message: chargeAmountResponse
Part name Part type Optional Description
None
8.1.1.3 Referenced faults
ServiceException from ES 202 391-1 [2]:
• SVC0001 - Service error.
• SVC0002 - Invalid input value.
• SVC0007 - Invalid charging information.
ETSI
---------------------- Page: 11 ----------------------
SIST ES 202 391-6 V1.3.1:2008
10 ETSI ES 202 391-6 V1.3.1 (2008-05)
• SVC0270 - Charge failed.
PolicyException from ES 202 391-1 [2]:
• POL0001 - Policy error.
8.1.2 Operation: refundAmount
This operation results in directly applying a refund to the account indicated by the end user identifier. The refund is
specified as a currency amount. The billing text field is used for textual information to appear on the bill. The reference
code is used to uniquely identify the request; it is the application's responsibility to provide a unique reference code
within the scope of the application.
8.1.2.1 Input message: refundAmountRequest
Part name Part type Optional Description
endUserIdentifier xsd:anyURI No The end user's account to be refunded
charge common:ChargingI No Information on the refund to be made. In the
nformation ChargingInformation structure:
• The description element is information to appear on
the bill.
• The amount to be refunded appears either directly in
the amount element or encoded in the code element. If
both these elements are missing or empty, a service
exception (SVC0007) will be thrown.
• The optional currency element specifies the currency
to be used for the refund.
referenceCode xsd:string No Textual information to uniquely identify the request, e.g. in
case of disputes.
8.1.2.2 Output message: refundAmountResponse
Part name Part type Optional Description
None
8.1.2.3 Referenced faults
ServiceException from ES 202 391-1 [2]:
• SVC0001 - Service error.
• SVC0002 - Invalid input value.
• SVC0007 - Invalid charging information.
• SVC0270 - Charge failed.
PolicyException from ES 202 391-1 [2]:
• POL0001 - Policy error.
8.2 Interface: VolumeCharging
Charging operations by volume.
ETSI
---------------------- Page: 12 ----------------------
SIST ES 202 391-6 V1.3.1:2008
11 ETSI ES 202 391-6 V1.3.1 (2008-05)
8.2.1 Operation: chargeVolume
This operation results in directly charging to the account indicated by the end user identifier. The charge is specified as
a volume. The billing text field is used for textual information to appear on the bill. The reference code is used to
uniquely identify the request; it is the application's responsibility to provide a unique reference code within the scope of
the application.
8.2.1.1 Input message: chargeVolumeRequest
Part name Part type Optional Description
endUserIdentifier xsd:anyURI No The end user's account to be charged
volume xsd:long No The volume to be charged
billingText xsd:string No Textual information to appear on the bill
referenceCode xsd:string No Textual information to uniquely identify
the request, e.g. in case of disputes
parameters Property Yes Parameters to use to perform rating
[0.unbounded] ("unit", "contract", "service", "operation")
8.2.1.2 Output message: chargeVolumeResponse
Part name Part type Optional Description
None
8.2.1.3 Referenced faults
ServiceException from ES 202 391-1 [2]:
• SVC0001 - Service error.
• SVC0002 - Invalid input value.
• SVC0270 - Charge failed.
PolicyException from ES 202
...
Questions, Comments and Discussion
Ask us and Technical Secretary will try to provide an answer. You can facilitate discussion about the standard in here.