SIST ES 202 504-6 V1.1.1:2008
Open Service Access (OSA) - Parlay X Web Services - Part 6: Payment (Parlay X 3)
- Abstract
New edition of ParlayX specification based on requirements in EG 201 988-4, corresponding to 3GPP TS 29.199 Rel-7. The present document is part 6 of the Stage 3 Parlay X 3 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
- 14-Jul-2008
- Technical Committee
- SPN - Services and Protocols for Networks
- Current Stage
- 6060 - National Implementation/Publication (Adopted Project)
- Start Date
- 18-Jun-2008
- Due Date
- 23-Aug-2008
- Completion Date
- 15-Jul-2008
Buy Documents
ETSI ES 202 504-6 V1.1.1 (2008-02) - Open Service Access (OSA); Parlay X Web Services; Part 6: Payment (Parlay X 3)
ETSI ES 202 504-6 V1.1.1 (2008-05) - Open Service Access (OSA); Parlay X Web Services; Part 6: Payment (Parlay X 3)
SIST ES 202 504-6 V1.1.1:2008 is the SIST publication of the ETSI standard for Open Service Access (OSA) Parlay X Web Services Part 6: Payment (Parlay X 3). It specifies the Payment Web Service used to expose charging, refund and reservation functions through a standardized web-service interface for applications that work with network billing. The document is aimed at service developers, platform integrators, operators and billing system designers who need to charge by amount or volume, reserve credit and split charges between end-user accounts.
What does SIST ES 202 504-6 V1.1.1:2008 specify?
SIST ES 202 504-6 V1.1.1:2008 is part 6 of the Stage 3 Parlay X 3 Web Services specification for Open Service Access (OSA). It describes the Payment Web Service and organizes the specification into clauses for scope, references, definitions, service description, namespaces, sequence diagrams, XML schema data types, interface definitions, fault definitions and service policies.
The scope covers payment reservation, pre-paid and post-paid payments, charging by currency amount or by volume, a conversion function, and settlement support for a financially resolved dispute. It also defines the WSDL representation of the interface.
| Annex | What it covers |
|---|---|
| Annex A | Normative WSDL for Payment |
| Annex B | Informative bibliography |
What are the key requirements of SIST ES 202 504-6 V1.1.1:2008?
The service supports several payment patterns
SIST ES 202 504-6 V1.1.1:2008 defines direct charging, refunds, split charging and reservation-based charging. In practice, that means one application can bill a user immediately, reverse a charge, divide a charge across several accounts, or reserve credit first and settle it later.
Clause 4 says the service supports both currency and volume charging. It also includes a conversion function so an application can ask for the amount corresponding to a usage volume before it charges the user.
The service uses four named interfaces
SIST ES 202 504-6 V1.1.1:2008 defines the interfaces AmountCharging, VolumeCharging, ReserveAmountCharging and ReserveVolumeCharging. Each interface groups related operations so implementers can select the model they need instead of building one large generic call.
AmountCharging contains chargeAmount, refundAmount and chargeSplitAmount. VolumeCharging contains chargeVolume, getAmount, refundVolume and chargeSplitVolume. ReserveAmountCharging and ReserveVolumeCharging add reservation and settlement operations for amount-based and volume-based charging.
Split charging has specific rules
SIST ES 202 504-6 V1.1.1:2008 uses the SplitType structure to allocate part of a charge to each end user account. Each split entry names an end user account and a percentage, and the percentage shares must add up to 100.
In practice, this matters when one payment has to be shared across participants, such as a group service or conference. The document also names the faults that apply when split charging is misused: SVC0271 for an invalid percentage total, POL0250 for too many end user accounts, and POL0251 when split charging is not supported.
Charging requests carry billing text and a unique reference
SIST ES 202 504-6 V1.1.1:2008 uses ChargingInformation for the charge or refund details, including the amount or code, an optional currency and descriptive text that can appear on the bill. For chargeAmount, refundAmount, chargeSplitAmount, chargeReservation and similar operations, the application is responsible for providing a unique referenceCode within its own scope.
For a buyer or integrator, this means the charging side needs enough information to identify the transaction later in disputes, billing reconciliation or customer support.
Volume charging can use rating parameters
SIST ES 202 504-6 V1.1.1:2008 allows a Property list of rating parameters for volume-based operations. The documented parameter names are unit, contract, service and operation, and the text gives examples such as bytes, a contract number or a service name.
This is important because the charge for a volume can depend on the context of use, not only on the raw quantity. The same service can therefore be rated differently depending on the contract or the operation being performed.
Reservations are time-limited and can be extended or released
SIST ES 202 504-6 V1.1.1:2008 defines reserveAmount and reserveVolume to create a reservation and return a reservation identifier. It also defines reserveAdditionalAmount and reserveAdditionalVolume to adjust an existing reservation, chargeReservation to settle against a reservation, and releaseReservation to return unused credit or volume.
The service policies define the reservation duration, so implementations need to handle expiry as well as explicit release. The document also notes that one charging session to a reservation results in one bill entry, which matters for billing clarity.
The service behavior is controlled by policies
SIST ES 202 504-6 V1.1.1:2008 defines service policies for Currency, MaximumEndUserIdentifier, SplitChargingAvailable and ReservationDuration. Currency uses ISO 4217 codes, so billing systems need to use the configured currency consistently.
MaximumEndUserIdentifier and SplitChargingAvailable control whether multi-account charging is allowed and how many accounts can be charged at once. ReservationDuration sets the default life of amount and volume reservations.
What terms does SIST ES 202 504-6 V1.1.1:2008 define?
- ChargingInformation - The data structure that carries charge or refund details, including the amount, code, currency and description used for billing.
- Property - A simple name-value pair used for rating parameters such as unit, contract, service and operation.
- SplitType - The structure that links an end user account to a percentage share of a split charge.
- referenceCode - A request identifier used by the application to distinguish one charging transaction from another.
- reservationIdentifier - The identifier returned for a reservation and used later to charge, extend or release it.
- ServiceException - The fault class used for charging failures and invalid charging information.
- PolicyException - The fault class used when a request breaks service policy limits, such as too many end user accounts or unsupported split charging.
Who uses SIST ES 202 504-6 V1.1.1:2008?
SIST ES 202 504-6 V1.1.1:2008 is used by telecommunications operators, service providers, portal developers and billing or rating system implementers. It is relevant wherever network services are charged through an application-facing interface.
Typical uses include charging for downloaded content, rating a usage volume before presentation to the user, reserving credit for an ongoing session, splitting a charge across several participants and refunding part of a fee after a business rule or dispute outcome. The document also fits integration work where a web service must connect application logic to operator billing systems.
What changed in SIST ES 202 504-6 V1.1.1:2008 from the previous edition?
SIST ES 202 504-6 V1.1.1:2008 is presented as a new edition of the Parlay X specification and is equivalent to 3GPP TS 29.199-06 V7.2.2 (Release 7). It is based on requirements in EG 201 988-4.
Which standards are used with SIST ES 202 504-6 V1.1.1:2008?
| Standard | Contribution |
|---|---|
| ETSI ES 202 504-1 | Common Parlay X 3 material, including shared definitions and abbreviations |
| W3C Recommendation, XML Schema Part 2: Datatypes | The XML schema datatypes used for values such as strings, integers, anyURI and long |
| ISO 4217 | The currency code list used by the Currency service policy |
What does the SIST ES 202 504-6 V1.1.1:2008 document contain?
The document contains a sequence diagram for a charge-for-content scenario, showing how a service can trigger charging after a content download. It also contains XML schema definitions for the Property and SplitType data structures.
Clause 8 gives the interface definitions, input and output messages and referenced faults for AmountCharging, VolumeCharging, ReserveAmountCharging and ReserveVolumeCharging. Clause 9 defines the ServiceException and PolicyException faults, and clause 10 sets out the service policies.
Annex A provides the normative WSDL for Payment in document/literal form, and Annex B lists bibliography material.
Buy Documents
ETSI ES 202 504-6 V1.1.1 (2008-02) - Open Service Access (OSA); Parlay X Web Services; Part 6: Payment (Parlay X 3)
ETSI ES 202 504-6 V1.1.1 (2008-05) - Open Service Access (OSA); Parlay X Web Services; Part 6: Payment (Parlay X 3)
Get Certified
Connect with accredited certification bodies for this standard
BSI Group
BSI (British Standards Institution) is the business standards company that helps organizations make excellence a habit.
NYCE
Mexican standards and certification body.
Sponsored listings
Frequently Asked Questions
SIST ES 202 504-6 V1.1.1:2008 is a standard published by the Slovenian Institute for Standardization (SIST). Its full title is "Open Service Access (OSA) - Parlay X Web Services - Part 6: Payment (Parlay X 3)". This standard covers: New edition of ParlayX specification based on requirements in EG 201 988-4, corresponding to 3GPP TS 29.199 Rel-7. The present document is part 6 of the Stage 3 Parlay X 3 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.
New edition of ParlayX specification based on requirements in EG 201 988-4, corresponding to 3GPP TS 29.199 Rel-7. The present document is part 6 of the Stage 3 Parlay X 3 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.
SIST ES 202 504-6 V1.1.1:2008 is classified under the following ICS (International Classification for Standards) categories: 35.100.01 - Open systems interconnection in general. The ICS classification helps identify the subject area and facilitates finding related standards.
SIST ES 202 504-6 V1.1.1:2008 is available in PDF format for immediate download after purchase. The document can be added to your cart and obtained through the secure checkout process. Digital delivery ensures instant access to the complete standard document.
Standards Content (Sample)
Final draft ETSI ES 202 504-6 V1.1.1 (2008-02)
ETSI Standard
Open Service Access (OSA);
Parlay X Web Services;
Part 6: Payment
(Parlay X 3)
�
2 Final draft ETSI ES 202 504-6 V1.1.1 (2008-02)
Reference
DES/TISPAN-01034-6-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
3 Final draft ETSI ES 202 504-6 V1.1.1 (2008-02)
Contents
Intellectual Property Rights.5
Foreword.5
1 Scope.7
2 References.7
2.1 Normative references.7
3 Definitions and abbreviations.8
3.1 Definitions.8
3.2 Abbreviations.8
4 Detailed service description .8
5 Namespaces.8
6 Sequence diagrams.9
6.1 Charge for content.9
7 XML Schema data type definition .10
7.1 Property structure.10
7.2 SplitType structure .10
8 Web Service interface definition.10
8.1 Interface: AmountCharging.10
8.1.1 Operation: chargeAmount.10
8.1.1.1 Input message: chargeAmountRequest.10
8.1.1.2 Output message: chargeAmountResponse.11
8.1.1.3 Referenced faults.11
8.1.2 Operation: refundAmount.11
8.1.2.1 Input message: refundAmountRequest.11
8.1.2.2 Output message: refundAmountResponse.11
8.1.2.3 Referenced faults.11
8.1.3 Operation: chargeSplitAmount.12
8.1.3.1 Input message: chargeSplitAmountRequest.12
8.1.3.2 Output message: chargeSplitAmountResponse.12
8.1.3.3 Referenced faults.12
8.2 Interface: VolumeCharging.13
8.2.1 Operation: chargeVolume.13
8.2.1.1 Input message: chargeVolumeRequest.13
8.2.1.2 Output message: chargeVolumeResponse.13
8.2.1.3 Referenced faults.13
8.2.2 Operation: getAmount.13
8.2.2.1 Input message: getAmountRequest.14
8.2.2.2 Output message: getAmountResponse.14
8.2.2.3 Referenced faults.14
8.2.3 Operation: refundVolume.14
8.2.3.1 Input message: refundVolumeRequest.14
8.2.3.2 Output message: refundVolumeResponse.14
8.2.3.3 Referenced faults.14
8.2.4 Operation: chargeSplitVolume.15
8.2.4.1 Input message: chargeSplitVolumeRequest.15
8.2.4.2 Output message: chargeSplitVolumeResponse.15
8.2.4.3 Referenced faults.15
8.3 Interface: ReserveAmountCharging.15
8.3.1 Operation: reserveAmount.16
8.3.1.1 Input message: reserveAmountRequest.16
8.3.1.2 Output message: reserveAmountResponse.16
8.3.1.3 Referenced faults.16
ETSI
4 Final draft ETSI ES 202 504-6 V1.1.1 (2008-02)
8.3.2 Operation: reserveAdditionalAmount.16
8.3.2.1 Input message: reserveAdditionalAmountRequest .17
8.3.2.2 Output message : reserveAdditionalAmountResponse .17
8.3.2.3 Referenced faults.17
8.3.3 Operation: chargeReservation.18
8.3.3.1 Input message: chargeReservationRequest.18
8.3.3.2 Output message: chargeReservationResponse .18
8.3.3.3 Referenced faults.18
8.3.4 Operation: releaseReservation.18
8.3.4.1 Input message: releaseReservationRequest.18
8.3.4.2 Output message: releaseReservationResponse.19
8.3.4.3 Referenced faults.19
8.4 Interface: ReserveVolumeCharging.19
8.4.1 Operation: getAmount.19
8.4.1.1 Input message: getAmountRequest.19
8.4.1.2 Output message: getAmountResponse.19
8.4.1.3 Referenced faults.19
8.4.2 Operation: reserveVolume.20
8.4.2.1 Input message: reserveVolumeRequest.20
8.4.2.2 Output message: reserveVolumeResponse.20
8.4.2.3 Referenced faults.20
8.4.3 Operation: reserveAdditionalVolume.20
8.4.3.1 Input message: reserveAdditionalVolumeRequest.21
8.4.3.2 Output message: reserveAdditionalVolumeResponse .21
8.4.3.3 Referenced faults.21
8.4.4 Operation: chargeReservation.21
8.4.4.1 Input message: chargeReservationRequest.21
8.4.4.2 Output message: chargeReservationResponse .21
8.4.4.3 Referenced faults.22
8.4.5 Operation: releaseReservation.22
8.4.5.1 Input message: releaseReservationRequest.22
8.4.5.2 Output message: releaseReservationResponse.22
8.4.5.3 Referenced faults.22
9 Fault definitions.22
9.1 ServiceException.22
9.1.1 SVC0270: Charge failed.22
9.1.2 SVC0271: Invalid sum of percentage allocations.23
9.2 PolicyException.23
9.2.1 POL0250: Too many end user accounts specified.23
9.2.2 POL0251: Split charging not supported.23
10 Service policies .23
Annex A (normative): WSDL for Payment .24
Annex B (informative): Bibliography.25
History .26
ETSI
5 Final draft ETSI ES 202 504-6 V1.1.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 3 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";
Part 15: "Message Broadcast";
Part 16: "Geocoding";
Part 17: "Application-driven Quality of Service (QoS)";
Part 18: "Device Capabilities and Configuration";
Part 19: "Multimedia Streaming Control";
Part 20: "Multimedia Multicast Session Management".
ETSI
6 Final draft ETSI ES 202 504-6 V1.1.1 (2008-02)
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 3.0 set of specifications.
The present document is equivalent to 3GPP TS 29.199-06 V7.2.2 (Release7).
ETSI
7 Final draft ETSI ES 202 504-6 V1.1.1 (2008-02)
1 Scope
The present document is part 6 of the Stage 3 Parlay X 3 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
8 Final draft ETSI ES 202 504-6 V1.1.1 (2008-02)
[2] ETSI ES 202 504-1: "Open Service Access (OSA); Parlay X Web Services; Part 1: Common
(Parlay X 3)".
[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 504-1 [2] apply.
3.2 Abbreviations
For the purposes of the present document, the abbreviations given in ES 202 504-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 as part of a service level agreement. For example 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/v3_1
The VolumeCharging interface uses the namespace:
http://www.csapi.org/wsdl/parlayx/payment/volume_charging/v3_1
ETSI
9 Final draft ETSI ES 202 504-6 V1.1.1 (2008-02)
The ReserveAmountCharging interface uses the namespace:
http://www.csapi.org/wsdl/parlayx/payment/reserve_amount_charging/v3_1
The ReserveVolumeCharging interface uses the namespace:
http://www.csapi.org/wsdl/parlayx/payment/reserve_volume_charging/v3_1
The data types are defined in the namespace:
http://www.csapi.org/schema/parlayx/payment/v3_0
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
10 Final draft ETSI ES 202 504-6 V1.1.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
7.2 SplitType structure
Identifies the percentage of the total charge that is be allocated to the specified end user's account.
Element name Type Optional Description
endUserIdentifier xsd:anyURI No The end user's account to be charged
percent xsd: Int No Specifies the allocation of the total charge for this
account. The sum of all allocations must equal 100. If
sum of percentage allocations is not equal to 100 a
service exception (SVC0271) will be thrown. The value
of percentage should be positive.
8 Web Service interface definition
8.1 Interface: AmountCharging
Charge operations by currency 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. I
...
ETSI Standard
Open Service Access (OSA);
Parlay X Web Services;
Part 6: Payment
(Parlay X 3)
�
2 ETSI ES 202 504-6 V1.1.1 (2008-05)
Reference
DES/TISPAN-01034-6-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
3 ETSI ES 202 504-6 V1.1.1 (2008-05)
Contents
Intellectual Property Rights.5
Foreword.5
1 Scope.7
2 References.7
2.1 Normative references.7
3 Definitions and abbreviations.8
3.1 Definitions.8
3.2 Abbreviations.8
4 Detailed service description .8
5 Namespaces.8
6 Sequence diagrams.9
6.1 Charge for content.9
7 XML Schema data type definition .10
7.1 Property structure.10
7.2 SplitType structure .10
8 Web Service interface definition.10
8.1 Interface: AmountCharging.10
8.1.1 Operation: chargeAmount.10
8.1.1.1 Input message: chargeAmountRequest.10
8.1.1.2 Output message: chargeAmountResponse.11
8.1.1.3 Referenced faults.11
8.1.2 Operation: refundAmount.11
8.1.2.1 Input message: refundAmountRequest.11
8.1.2.2 Output message: refundAmountResponse.11
8.1.2.3 Referenced faults.11
8.1.3 Operation: chargeSplitAmount.12
8.1.3.1 Input message: chargeSplitAmountRequest.12
8.1.3.2 Output message: chargeSplitAmountResponse.12
8.1.3.3 Referenced faults.12
8.2 Interface: VolumeCharging.13
8.2.1 Operation: chargeVolume.13
8.2.1.1 Input message: chargeVolumeRequest.13
8.2.1.2 Output message: chargeVolumeResponse.13
8.2.1.3 Referenced faults.13
8.2.2 Operation: getAmount.13
8.2.2.1 Input message: getAmountRequest.14
8.2.2.2 Output message: getAmountResponse.14
8.2.2.3 Referenced faults.14
8.2.3 Operation: refundVolume.14
8.2.3.1 Input message: refundVolumeRequest.14
8.2.3.2 Output message: refundVolumeResponse.14
8.2.3.3 Referenced faults.14
8.2.4 Operation: chargeSplitVolume.15
8.2.4.1 Input message: chargeSplitVolumeRequest.15
8.2.4.2 Output message: chargeSplitVolumeResponse.15
8.2.4.3 Referenced faults.15
8.3 Interface: ReserveAmountCharging.15
8.3.1 Operation: reserveAmount.16
8.3.1.1 Input message: reserveAmountRequest.16
8.3.1.2 Output message: reserveAmountResponse.16
8.3.1.3 Referenced faults.16
ETSI
4 ETSI ES 202 504-6 V1.1.1 (2008-05)
8.3.2 Operation: reserveAdditionalAmount.16
8.3.2.1 Input message: reserveAdditionalAmountRequest .17
8.3.2.2 Output message : reserveAdditionalAmountResponse .17
8.3.2.3 Referenced faults.17
8.3.3 Operation: chargeReservation.18
8.3.3.1 Input message: chargeReservationRequest.18
8.3.3.2 Output message: chargeReservationResponse .18
8.3.3.3 Referenced faults.18
8.3.4 Operation: releaseReservation.18
8.3.4.1 Input message: releaseReservationRequest.18
8.3.4.2 Output message: releaseReservationResponse.19
8.3.4.3 Referenced faults.19
8.4 Interface: ReserveVolumeCharging.19
8.4.1 Operation: getAmount.19
8.4.1.1 Input message: getAmountRequest.19
8.4.1.2 Output message: getAmountResponse.19
8.4.1.3 Referenced faults.19
8.4.2 Operation: reserveVolume.20
8.4.2.1 Input message: reserveVolumeRequest.20
8.4.2.2 Output message: reserveVolumeResponse.20
8.4.2.3 Referenced faults.20
8.4.3 Operation: reserveAdditionalVolume.20
8.4.3.1 Input message: reserveAdditionalVolumeRequest.21
8.4.3.2 Output message: reserveAdditionalVolumeResponse .21
8.4.3.3 Referenced faults.21
8.4.4 Operation: chargeReservation.21
8.4.4.1 Input message: chargeReservationRequest.21
8.4.4.2 Output message: chargeReservationResponse .21
8.4.4.3 Referenced faults.22
8.4.5 Operation: releaseReservation.22
8.4.5.1 Input message: releaseReservationRequest.22
8.4.5.2 Output message: releaseReservationResponse.22
8.4.5.3 Referenced faults.22
9 Fault definitions.22
9.1 ServiceException.22
9.1.1 SVC0270: Charge failed.22
9.1.2 SVC0271: Invalid sum of percentage allocations.23
9.2 PolicyException.23
9.2.1 POL0250: Too many end user accounts specified.23
9.2.2 POL0251: Split charging not supported.23
10 Service policies .23
Annex A (normative): WSDL for Payment .24
Annex B (informative): Bibliography.25
History .26
ETSI
5 ETSI ES 202 504-6 V1.1.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 3 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";
Part 15: "Message Broadcast";
Part 16: "Geocoding";
Part 17: "Application-driven Quality of Service (QoS)";
Part 18: "Device Capabilities and Configuration";
Part 19: "Multimedia Streaming Control";
Part 20: "Multimedia Multicast Session Management".
ETSI
6 ETSI ES 202 504-6 V1.1.1 (2008-05)
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 3.0 set of specifications.
The present document is equivalent to 3GPP TS 29.199-06 V7.2.2 (Release7).
ETSI
7 ETSI ES 202 504-6 V1.1.1 (2008-05)
1 Scope
The present document is part 6 of the Stage 3 Parlay X 3 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
8 ETSI ES 202 504-6 V1.1.1 (2008-05)
[2] ETSI ES 202 504-1: "Open Service Access (OSA); Parlay X Web Services; Part 1: Common
(Parlay X 3)".
[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 504-1 [2] apply.
3.2 Abbreviations
For the purposes of the present document, the abbreviations given in ES 202 504-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 as part of a service level agreement. For example 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/v3_1
The VolumeCharging interface uses the namespace:
http://www.csapi.org/wsdl/parlayx/payment/volume_charging/v3_1
ETSI
9 ETSI ES 202 504-6 V1.1.1 (2008-05)
The ReserveAmountCharging interface uses the namespace:
http://www.csapi.org/wsdl/parlayx/payment/reserve_amount_charging/v3_1
The ReserveVolumeCharging interface uses the namespace:
http://www.csapi.org/wsdl/parlayx/payment/reserve_volume_charging/v3_1
The data types are defined in the namespace:
http://www.csapi.org/schema/parlayx/payment/v3_0
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
10 ETSI ES 202 504-6 V1.1.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
7.2 SplitType structure
Identifies the percentage of the total charge that is be allocated to the specified end user's account.
Element name Type Optional Description
endUserIdentifier xsd:anyURI No The end user's account to be charged
percent xsd: Int No Specifies the allocation of the total charge for this
account. The sum of all allocations must equal 100. If
sum of percentage allocations is not equal to 100 a
service exception (SVC0271) will be thrown. The value
of percentage should be positive.
8 Web Service interface definition
8.1 Interface: AmountCharging
Charge operations by currency 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
nformati
...
SLOVENSKI STANDARD
01-september-2008
2GSUWLGRVWRSGRVWRULWYH 26$ 6SOHWQHVWRULWYH3DUOD\;GHO 3ODþLOR 3DUOD\
;
Open Service Access (OSA) - Parlay X Web Services - Part 6: Payment (Parlay X 3)
Ta slovenski standard je istoveten z: ES 202 504-6 Version 1.1.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 3)
�
2 ETSI ES 202 504-6 V1.1.1 (2008-05)
Reference
DES/TISPAN-01034-6-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
3 ETSI ES 202 504-6 V1.1.1 (2008-05)
Contents
Intellectual Property Rights.5
Foreword.5
1 Scope.7
2 References.7
2.1 Normative references.7
3 Definitions and abbreviations.8
3.1 Definitions.8
3.2 Abbreviations.8
4 Detailed service description .8
5 Namespaces.8
6 Sequence diagrams.9
6.1 Charge for content.9
7 XML Schema data type definition .10
7.1 Property structure.10
7.2 SplitType structure .10
8 Web Service interface definition.10
8.1 Interface: AmountCharging.10
8.1.1 Operation: chargeAmount.10
8.1.1.1 Input message: chargeAmountRequest.10
8.1.1.2 Output message: chargeAmountResponse.11
8.1.1.3 Referenced faults.11
8.1.2 Operation: refundAmount.11
8.1.2.1 Input message: refundAmountRequest.11
8.1.2.2 Output message: refundAmountResponse.11
8.1.2.3 Referenced faults.11
8.1.3 Operation: chargeSplitAmount.12
8.1.3.1 Input message: chargeSplitAmountRequest.12
8.1.3.2 Output message: chargeSplitAmountResponse.12
8.1.3.3 Referenced faults.12
8.2 Interface: VolumeCharging.13
8.2.1 Operation: chargeVolume.13
8.2.1.1 Input message: chargeVolumeRequest.13
8.2.1.2 Output message: chargeVolumeResponse.13
8.2.1.3 Referenced faults.13
8.2.2 Operation: getAmount.13
8.2.2.1 Input message: getAmountRequest.14
8.2.2.2 Output message: getAmountResponse.14
8.2.2.3 Referenced faults.14
8.2.3 Operation: refundVolume.14
8.2.3.1 Input message: refundVolumeRequest.14
8.2.3.2 Output message: refundVolumeResponse.14
8.2.3.3 Referenced faults.14
8.2.4 Operation: chargeSplitVolume.15
8.2.4.1 Input message: chargeSplitVolumeRequest.15
8.2.4.2 Output message: chargeSplitVolumeResponse.15
8.2.4.3 Referenced faults.15
8.3 Interface: ReserveAmountCharging.15
8.3.1 Operation: reserveAmount.16
8.3.1.1 Input message: reserveAmountRequest.16
8.3.1.2 Output message: reserveAmountResponse.16
8.3.1.3 Referenced faults.16
ETSI
4 ETSI ES 202 504-6 V1.1.1 (2008-05)
8.3.2 Operation: reserveAdditionalAmount.16
8.3.2.1 Input message: reserveAdditionalAmountRequest .17
8.3.2.2 Output message : reserveAdditionalAmountResponse .17
8.3.2.3 Referenced faults.17
8.3.3 Operation: chargeReservation.18
8.3.3.1 Input message: chargeReservationRequest.18
8.3.3.2 Output message: chargeReservationResponse .18
8.3.3.3 Referenced faults.18
8.3.4 Operation: releaseReservation.18
8.3.4.1 Input message: releaseReservationRequest.18
8.3.4.2 Output message: releaseReservationResponse.19
8.3.4.3 Referenced faults.19
8.4 Interface: ReserveVolumeCharging.19
8.4.1 Operation: getAmount.19
8.4.1.1 Input message: getAmountRequest.19
8.4.1.2 Output message: getAmountResponse.19
8.4.1.3 Referenced faults.19
8.4.2 Operation: reserveVolume.20
8.4.2.1 Input message: reserveVolumeRequest.20
8.4.2.2 Output message: reserveVolumeResponse.20
8.4.2.3 Referenced faults.20
8.4.3 Operation: reserveAdditionalVolume.20
8.4.3.1 Input message: reserveAdditionalVolumeRequest.21
8.4.3.2 Output message: reserveAdditionalVolumeResponse .21
8.4.3.3 Referenced faults.21
8.4.4 Operation: chargeReservation.21
8.4.4.1 Input message: chargeReservationRequest.21
8.4.4.2 Output message: chargeReservationResponse .21
8.4.4.3 Referenced faults.22
8.4.5 Operation: releaseReservation.22
8.4.5.1 Input message: releaseReservationRequest.22
8.4.5.2 Output message: releaseReservationResponse.22
8.4.5.3 Referenced faults.22
9 Fault definitions.22
9.1 ServiceException.22
9.1.1 SVC0270: Charge failed.22
9.1.2 SVC0271: Invalid sum of percentage allocations.23
9.2 PolicyException.23
9.2.1 POL0250: Too many end user accounts specified.23
9.2.2 POL0251: Split charging not supported.23
10 Service policies .23
Annex A (normative): WSDL for Payment .24
Annex B (informative): Bibliography.25
History .26
ETSI
5 ETSI ES 202 504-6 V1.1.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 3 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";
Part 15: "Message Broadcast";
Part 16: "Geocoding";
Part 17: "Application-driven Quality of Service (QoS)";
Part 18: "Device Capabilities and Configuration";
Part 19: "Multimedia Streaming Control";
Part 20: "Multimedia Multicast Session Management".
ETSI
6 ETSI ES 202 504-6 V1.1.1 (2008-05)
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 3.0 set of specifications.
The present document is equivalent to 3GPP TS 29.199-06 V7.2.2 (Release7).
ETSI
7 ETSI ES 202 504-6 V1.1.1 (2008-05)
1 Scope
The present document is part 6 of the Stage 3 Parlay X 3 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
8 ETSI ES 202 504-6 V1.1.1 (2008-05)
[2] ETSI ES 202 504-1: "Open Service Access (OSA); Parlay X Web Services; Part 1: Common
(Parlay X 3)".
[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 504-1 [2] apply.
3.2 Abbreviations
For the purposes of the present document, the abbreviations given in ES 202 504-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 as part of a service level agreement. For example 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/v3_1
The VolumeCharging interface uses the namespace:
http://www.csapi.org/wsdl/parlayx/payment/volume_charging/v3_1
ETSI
9 ETSI ES 202 504-6 V1.1.1 (2008-05)
The ReserveAmountCharging interface uses the namespace:
http://www.csapi.org/wsdl/parlayx/payment/reserve_amount_charging/v3_1
The ReserveVolumeCharging interface uses the namespace:
http://www.csapi.org/wsdl/parlayx/payment/reserve_volume_charging/v3_1
The data types are defined in the namespace:
http://www.csapi.org/schema/parlayx/payment/v3_0
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
10 ETSI ES 202 504-6 V1.1.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
7.2 SplitType structure
Identifies the percentage of the total charge that is be allocated to the specified end user's account.
Element name Type Optional Description
endUserIdentifier xsd:anyURI No The end user's account to be charged
percent xsd: Int No Specifies the allocation of the total charge for this
account. The sum of all allocations must equal 100. If
sum of percentage allocations is not equal to 100 a
service exception (SVC0271) will be thrown. The value
of percentage should be positive.
8 Web Service interface definition
8.1 Interface: AmountCharging
Charge operations by currency 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 applic
...