WebSphere brand IBM WebSphere Telecom Web Services Server, Version 7.1

Usage records for Parlay X Payment (PostPaid)

The Parlay X Payment (PostPaid) Web service implementation uses usage records to store accounting and billing information.

The Payment service implementation generates Payment service usage records for use by security and accounting tools. All Payment service implementation usage records contain the requester URI to identify which client application sent the Payment service request, the operation name to identify the requested action, and the reference code to uniquely identify the Payment request.

The Payment service issues a WriteUsageRecordRequest to the Usage Record component Web service at the following event points:

If the Usage Record component Web service cannot write a Payment service usage record in the service usage database, a WriteUsageRecordFault fault is generated.

An exception or a WriteUsageRecordFault fault that is generated while trying to create a Payment service charge record is a severe error. The Payment service calls the Fault and Alarm component Web service with the fault information and a SVC0270 (charge failed) fault is returned to the Payment Web service requester.

An exception or a WriteUsageRecordFault fault that is generated while trying to create a Payment service results record is not a severe error and does not cause a fault to be returned to the Payment Web service requester. The Payment service calls the Fault and Alarm component Web service to record the exception or fault information and continue.

Payment service usage records

The service usage database is used by all services, including the Payment service implementation, to record events related to a service request. The Payment service invokes the Usage Record component Web service to write service usage records to the database, and also uses the database to store charging information for use by a billing mediator application. Storage of charging information in the service usage database is dependent on the configuration of the service.config.PaymentUsageRecordEnabled policy attribute. Depending on the billing mediator application implementation, Payment service usage records might be deleted in the service usage database after being used to successfully integrate charging information to a user's account in the billing domain.

Payment service charge record

The Payment service implementation creates a Payment service charge record by calling the Usage Record component Web service. The following tables describe the information that is passed to the Usage Record component Web service in order to create a Payment service charge record.

The following table lists part names and service attributes used by payment service.

Table 1. payment service charge service attributes and descriptions
Attribute Description
globalTransactionId Generated by Access Gateway and passed in the globalTransactionID SOAP header
SERVICE The service implementation that is writing the usage record.

This record is created if requester.operation.postpaid.PaymentUsageRecordEnabled is set to TRUE

eventType The operation name. This record is created if service.config.Payment_PostPaid_IMS.PaymentUsageRecordEnabled is set to TRUE
code Indicates that the Payment service implementation is proceeding without errors
REQUESTOR The requester URI is converted to a string that identifies the application that issued the service request
OPERATION The name of the operation that was invoked.

Can be any of the following:

chargeAmount
refundAmount
chargeVolume
refundVolume

REFERENCE_CODE This is the reference code from the input message - This code uniquely identifies the Payment request (in case of customer payment dispute) The reference code is not the same things as the charging code
END_USER_IDENTIFIER The account for the end user who will be billed is converted from xsd:anyURI to a String - The content format of the URI data is operator service dependent

The following table lists part names and service attributes used by chargeAmount and refundAmount.

Table 2. chargeAmount and refundAmount service attributes and descriptions
Attribute Description
CHARGE_DESCRIPTION Description text to be used for information and billing text
CHARGE_CURRENCY Optional: Currency identifier as defined in ISO 4217
CHARGE_AMOUNT Optional: (if CHARGE_CODE is not empty) Amount to be charged converted from xsd:Decimal to a string
CHARGE_CODE Optional: (if CHARGE_AMOUNT is not empty) References a contract under which the charge is applied - The Code field in the ChargingInformation part may be empty because it is an optional item

The following table lists part names and service attributes used by chargeVolume and refundVolume.

Table 3. chargeVolume and refundVolume service attributes and descriptions
Attribute Description
VOLUME The volume to be charged converted from xsd:long to a String
BILLING_TEXT Textual information to appear on the bill
UNIT The unit used for measuring volume (for example, bytes)
CONTRACT The number of a contract that may govern use
SERVICE The name of the service to be used (such as SendMultimediaMessage)
OPERATION The name of the operation to be used
Note: The number of property attributes for UNIT, CONTRACT, SERVICE, and OPERATION will vary, and may be zero. These attributes are used to perform rating operations.

Payment service results record

The Usage Record component Web service creates entries in the USAGERECORDS table. The following tables describe the information that is passed to the Usage Record component Web service in order to create a Payment service results record.

The following table lists part names and service attributes used by payment service results.

Table 4. payment service results attributes and descriptions
Attribute Description
globalTransactionId Generated by Access Gateway and passed in the globalTransactionID SOAP header
SERVICE This is a Payment service charge record - This record is created at the end of the Payment service
eventType This identifies a Payment service charge record. This record is created at the end of the Payment service; if service.config.Payment_PostPaid_IMS.ResultsUsageRecordEnabled is set to TRUE
code One of the following: 0 = Payment service request was successful 1 = Payment service request was a general failure
REQUESTER This is the requester URI converted to a String; it identifies the application that issued the Payment service request
OPERATION The name of the operation that was invoked. Can be any of the following: chargeAmount refundAmount chargeVolume refundVolume
REFERENCE_CODE The reference code from the input message - The code uniquely identifies the Payment request (in case of customer Payment dispute) The reference code is not the same thing as the charging code



Terms of use
(C) Copyright IBM Corporation 2009. All Rights Reserved.