SIST ES 202 391-6 V1.3.1:2008

• Abstract:

  Update of ES 202 391 to become Parlay X 2.2, to cover maintenance updates.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.

• Status: Published
• Publication Date: 15-Jul-2008
• ICS: 35.100.01 - Open systems interconnection in general
• Technical Committee: SPN - Services and Protocols for Networks
• Current Stage: 6060 - National Implementation/Publication (Adopted Project)
• Start Date: 19-Jun-2008
• Due Date: 24-Aug-2008
• Completion Date: 16-Jul-2008
• Ref Project: ETSI ES 202 391-6 V1.3.1 (2008-05) - Open Service Access (OSA); Parlay X Web Services; Part 6: Payment (Parlay X 2)

SIST ES 202 391-6 V1.3.1:2008 is the Payment part of the Open Service Access (OSA) Parlay X Web Services series, published as an ETSI Standard. It specifies the Payment Web Service for application developers and service providers that use OSA APIs to access network charging functions through a standardized web-service interface. The document defines the service namespaces, data types, operations, faults, service policies, and the WSDL needed to implement the interface.

What does SIST ES 202 391-6 V1.3.1:2008 specify?

SIST ES 202 391-6 V1.3.1:2008 specifies the Payment Web Service as part 6 of the Stage 3 Parlay X 2 Web Services specification for OSA. It covers payment and charging interactions for amount-based and volume-based services, including reservations, refunds, conversion to currency amounts, and release of unused reservations.

The document is organized into the usual service-specification blocks: scope, references, definitions and abbreviations, detailed service description, namespaces, sequence diagrams, XML Schema data type definitions, interface definitions, fault definitions, service policies, and annexes. Clause 4 explains the service model, including pre-paid and post-paid payment support and some parameters that are negotiated off line, such as currency, volume type, reservation enforcement time, and taxation settings.

Annex	What it covers
Annex A	Normative WSDL for the Payment interface
Annex B	Informative bibliography

What are the key requirements of SIST ES 202 391-6 V1.3.1:2008?

SIST ES 202 391-6 V1.3.1:2008 defines four interface families: amount charging, volume charging, amount reservation, and volume reservation. In practice, this means the service can be used both for direct billing and for “hold and settle later” billing flows.

Namespaces, schema, and WSDL

Clause 5 assigns separate namespaces to each interface and to the data types. The document also uses the xsd prefix for XML Schema datatypes, and Annex A provides the document/literal WSDL representation. For implementers, this is the material that drives client generation and message validation.

Clause 7 defines Property as a simple name-value pair. This matters because rating parameters are passed as named properties such as unit, contract, service, and operation.

Amount-based charging

Clause 8.1.1 defines chargeAmount, which charges an account identified by endUserIdentifier. The request carries ChargingInformation plus a referenceCode that the application uses to uniquely identify the request. Clause 8.1.2 defines refundAmount in the same style for direct refunds.

Volume-based charging

Clause 8.2.1 defines chargeVolume, which charges a volume against an account and can include billing text, a reference code, and rating parameters. Clause 8.2.2 defines getAmount, which converts a volume into a currency amount for the named subscriber; the returned ChargingInformation must contain non-null description, amount, and currency fields. Clause 8.2.3 defines refundVolume, which mirrors the charge flow for volume refunds.

Reservation charging

Clause 8.3.1 defines reserveAmount, which creates an amount reservation and returns a reservation identifier. Clause 8.3.2 defines reserveAdditionalAmount, which can add to or subtract from an existing reservation and extends the reservation time. Clause 8.3.3 defines chargeReservation, which consumes part of a reservation, and Clause 8.3.4 defines releaseReservation, which returns unused funds to the original account. The bill text is accumulated so one reservation session produces one bill entry.

Volume reservation charging

Clause 8.4 follows the same pattern for volume reservations. reserveVolume creates the reservation, reserveAdditionalVolume adjusts it, chargeReservation consumes it, and releaseReservation returns unused volume. The rating parameters used for reserveAdditionalVolume are the same as those set in the original reservation request, which matters when the charging logic must stay consistent across the whole session.

Faults and service policy

Clause 9 defines the ServiceException SVC0270, with the message “Charge failed” and the meaning that the charge was not applied. Clause 10 defines the Currency service policy and ties it to ISO 4217. That gives implementations a standard currency-code basis for message exchange.

What terms does SIST ES 202 391-6 V1.3.1:2008 define?

• Open Service Access (OSA) - The architecture that lets application developers use network functionality through open standardized interfaces.
• Application Programming Interface (API) - The standardized interface that applications call to use service capabilities.
• ChargingInformation - The data structure that carries the charge description, amount, and optional currency or code details.
• endUserIdentifier - The account identifier used when charging or refunding an end user.
• referenceCode - Application-provided text used to uniquely identify a request, especially for later dispute handling.
• reservationIdentifier - The identifier returned for a reservation and used later to charge or release that reservation.
• Property - A name-value pair used to pass rating parameters such as unit, contract, service, or operation.
• WSDL - The web service description format used here to publish the interface in machine-readable form.

Who uses SIST ES 202 391-6 V1.3.1:2008?

SIST ES 202 391-6 V1.3.1:2008 is used by telecom operators, service providers, billing and rating system integrators, and application developers who need standardized payment functions. Typical tasks include pricing a service before use, charging a completed transaction, reserving value before delivery, refunding unused or disputed charges, and releasing unused reservation balances. It is also relevant to teams that generate or consume WSDL-based service interfaces.

What changed in SIST ES 202 391-6 V1.3.1:2008 from the previous edition?

This edition updates ES 202 391 to become Parlay X 2.2 and covers maintenance updates. The document history lists earlier publications V1.1.1 and V1.2.1 before this V1.3.1 publication.

Which standards are used with SIST ES 202 391-6 V1.3.1:2008?

• W3C Recommendation XML Schema Part 2: Datatypes - Provides the XML Schema datatypes used by the message and schema definitions, including xsd:string, xsd:anyURI, and xsd:long.
• ETSI ES 202 391-1, Open Service Access (OSA); Parlay X Web Services; Part 1: Common (Parlay X 2) - Supplies the shared definitions and abbreviations and is the base common specification for the series.
• ISO 4217, Codes for the representation of currencies and funds - Provides the currency coding basis used by the Currency service policy.
• 3GPP TS 29.199-06 V6.5.0 (Release 6) - The foreword states that this ETSI standard is equivalent to the 3GPP specification for the same payment service.

What does the SIST ES 202 391-6 V1.3.1:2008 document contain?

SIST ES 202 391-6 V1.3.1:2008 contains one service scenario figure for charging content after delivery, plus the XML Schema property structure used by the service. It then gives detailed request and response definitions for the AmountCharging, VolumeCharging, ReserveAmountCharging, and ReserveVolumeCharging interfaces, including the operations, message fields, and referenced faults.

Clause 9 defines the service fault SVC0270, and Clause 10 gives the service-wide currency policy. Annex A supplies the normative WSDL, which is the part implementers use to build clients and service endpoints consistently. Annex B is a bibliography for background reading.

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)
�
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.: [phone]  Fax: [phone]

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
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
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
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
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
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
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
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.
...

ETSI Standard
Open Service Access (OSA);
Parlay X Web Services;
Part 6: Payment
(Parlay X 2)
�
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.: [phone]  Fax: [phone]

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
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
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
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
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
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
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
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
...

SLOVENSKI STANDARD
01-september-2008
2GSUWLGRVWRSGRVWRULWYH26$6SOHWQHVWRULWYH3DUOD\;GHO3ODþLOR3DUOD\
;
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
2003-01.Slovenski inštitut za standardizacijo. Razmnoževanje celote ali delov tega standarda ni dovoljeno.

ETSI Standard
Open Service Access (OSA);
Parlay X Web Services;
Part 6: Payment
(Parlay X 2)
�
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.: [phone]  Fax: [phone]

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
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
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
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
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
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
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
...