Package com.ibm.soa.parlayx21.payment

Payment.

See:
          Description

Interface Summary
AmountCharging The interface containing the charge operations by amount.
AmountCharging_RI  
AmountChargingHome  
AmountChargingService  
ReserveAmountCharging The interface containing the operations to manage reservation charging by amount.
ReserveAmountCharging_RI  
ReserveAmountChargingHome  
ReserveAmountChargingService  
ReserveVolumeCharging The interface containing the operations to manage reservation charging by amount.
ReserveVolumeCharging_RI  
ReserveVolumeChargingHome  
ReserveVolumeChargingService  
VolumeCharging The interface containing the charging operations by volume.
VolumeCharging_RI  
VolumeChargingHome  
VolumeChargingService  
 

Class Summary
AmountChargingBindingStub  
AmountChargingProxy  
AmountChargingServiceInformation  
AmountChargingServiceLocator  
Property The class contains the property with a name and value.
Property_Deser  
Property_Helper  
Property_Ser  
ReserveAmountChargingBindingStub  
ReserveAmountChargingProxy  
ReserveAmountChargingServiceInformation  
ReserveAmountChargingServiceLocator  
ReserveVolumeChargingBindingStub  
ReserveVolumeChargingProxy  
ReserveVolumeChargingServiceInformation  
ReserveVolumeChargingServiceLocator  
VolumeChargingBindingStub  
VolumeChargingProxy  
VolumeChargingServiceInformation  
VolumeChargingServiceLocator  
 

Package com.ibm.soa.parlayx21.payment Description

Payment.

Common Data Types

For common data types associated with this package see Common Data Types.

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, for example, 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.

References

The following documents contain provisions which, through reference in this text, constitute provisions of the present document.
  * References are either specific (identified by date of publication and/or edition number or version number) or nonspecific.
  * For a specific reference, subsequent revisions do not apply.
  * For a non-specific reference, the latest version applies.

Referenced documents which are not found to be publicly available in the expected location might be found at http://docbox.etsi.org/Reference.

[1] W3C Recommendation (2 May 2001): "XML Schema Part 2: Datatypes".

NOTE: Available at http://www.w3.org/TR/2001/REC-xmlschema-2-20010502/. [2] ETSI ES 202 391-1: "Open Service Access (OSA); Parlay X 2 Web Services;

Part 1: Common".

[3] ISO 4217: "Codes for the representation of currencies and funds".

Definitions and abbreviations

Definitions

For the purposes of the present document, the terms and definitions given in ES 202 391-1 [2] apply.

Abbreviations

For the purposes of the present document, the abbreviations defined in ES 202 391-1 [2] apply.

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.

Namespaces

The AmountCharging interface uses the namespace: http://www.csapi.org/wsdl/parlayx/payment/amount_charging/v2_1

The VolumeCharging interface uses the namespace: http://www.csapi.org/wsdl/parlayx/payment/volume_charging/v2_1

The ReserveAmountCharging interface uses the namespace: http://www.csapi.org/wsdl/parlayx/payment/reserve_amount_charging/v2_1

The ReserveVolumeCharging interface uses the namespace: http://www.csapi.org/wsdl/parlayx/payment/reserve_volume_charging/v2_12

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.

Sequence diagrams

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

Figure 1

XML Schema data type definition

Property structure

Property with a name and value.


name xsd:string

Name of property
value xsd:string

Value of property

Web Service interface definition

Fault definitions

ServiceException

SVC0270: Charge failed


messageId SVC0270
text

Charging operation failed, the charge was not applied.
variables None

Service policies

Service policies for this service.


Currency xsd:string Currency used by service (per ISO 4217 [3])



Copyright © 2003 IBM Corp. All Rights Reserved.