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.
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.
The following table lists part names and service attributes used by payment service.
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 |
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.
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.
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 |
The following table lists part names and service attributes used by payment service results.
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 |