|
||||||||||
PREV PACKAGE NEXT PACKAGE | FRAMES NO FRAMES |
See:
Description
Interface Summary | |
---|---|
AccountManagement | The Account Management interface provides access to account information for update and query operations. |
AccountManagement_RI | |
AccountManagementHome | |
AccountManagementService |
Account Management.
The present document is part 7 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 Account Management 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.
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".
For the purposes of the present document, the terms and definitions given in ES 202 391-1 [2] apply.
For the purposes of the present document, the abbreviations defined in ES 202 391-1 [2] apply.
Pre-paid subscribers, whether they have subscribed to pre-paid telephony, SMS, or data service, have credits with their service providers; the consumption of services will lead to reduction of their credit, or the credit may expire. Therefore, from time to time, subscribers may have to recharge their accounts. This occurs through an application that interfaces with the subscriber either directly or indirectly. Examples of direct interaction are voice prompts and WAP/web pages, or even SMS. Typically, such multi-modal applications either request a currency amount and, e.g. credit card information, or a voucher number plus credentials. The voucher number and credentials are then validated and causes a pre-determined currency amount to be transferred.
The Parlay X 2 Account Management API described in the present document supports account querying, direct recharging and recharging through vouchers. As a side effect, it may prevent subscribers from having their account balance credits expire.
The AccountManagement interface uses the namespace: http://www.csapi.org/wsdl/parlayx/account_management/v2_12
The data types are defined in the namespace: http://www.csapi.org/schema/parlayx/account_management/v2_12
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.
This clause discusses three scenarios; one where a subscriber uses a voucher, one where the subscriber directly recharges after the payment is cleared, and one where the subscriber checks the recent transactions.
NOTE: Associated Account Management API messages are shown in 'bold' format: e.g. (getBalance).
The prepaid subscriber wishes to recharge their account with a voucher and query their account balance. The subscriber uses their mobile phone or other wireline phone to interact with an IVR system. In order to recharge their account, the subscriber must enter the voucher number, the MSISDN to be recharged , and PIN(s). The IVR system accesses an external voucher database to validate the voucher number. The subscriber's account balance is then increased with the value of the voucher (voucherUpdate). The subscriber queries their account balance (getBalance), before and/or after the recharge.
Directly recharging (i.e. without a voucher) works much along the same way. In this case, we assume the prepaid subscriber interacts with a web page. After providing the MSISDN, along with the PIN, the user can query the account balance (getBalance). For recharging, the subscriber must enter payment details, for example credit card information, from which the payment will be made. After clearing the payment details, the currency amount will be transferred and the subscriber's prepaid account balance expiration date will be reset (balanceUpdate). The subscriber also queries their account balance expiration date (getCreditExpiryDate), after the recharge.
This data structure represents a transaction record.
transactionDate
xsd:dateTime
The date the transaction occurred.
transactionDetails
xsd:string
The transaction details.
This data structure represents a balance record.
balanceType
xsd:string
Identifies the type of balance. End user accounts may have one or more balances for different types of usage (e.g Voice, SMS, gaming etc)
amount
xsd:decimal
Amount of balance
This data structure represents balance expiry details.
balanceType
xsd:string
Identifies the type of balance. End user accounts may have one or more balances for different types of usage (e.g Voice, SMS, gaming etc)
date
xsd:dateTime
NoYes
It is the date the identified balance will expire. Nill is returnedDo not specify if the balance does not expire
messageId
SVC0250
text
End user authentication failed.
variables
None.
messageId
SVC0251
text
Voucher %1 is not valid.
variables
%1 Voucher identifier.
messageId
POL0220
text
Vouchers not accepted.
variables
None.
Service policies for this service.
VouchersAccepted
xsd:Boolean
Are vouchers accepted
|
||||||||||
PREV PACKAGE NEXT PACKAGE | FRAMES NO FRAMES |