CreateRefresh
The CreateRefresh web service
XML- or JSON-based information exchange systems that use the Internet for direct application-to-application interaction. These systems can include programs, objects, messages, or documents. provides the ability to add one new Refresh to a CMP Converged Monetisation Platform. The MDS Global product that supports customer care and billing for digital service providers. Subscription A billing entity that incurs a charge. Examples include a network attached device whose usage you want to measure and charge for, or a monthly software subscription.
CreateRefresh Request
The CreateRefresh tag instructs the Basket Service to create a Refresh. This request contains the following elements:
|
Element Name |
Content Type |
Description |
Required? |
|---|---|---|---|
|
ExternalReference |
String69 |
The client may use this identifier to correlate the request and the response. |
Optional |
|
TargetIdentifier |
Container |
Choice of:
|
Mandatory |
|
Refresh |
Container |
Contains the details of the Refresh to be created for the specified TargerIdentifier. See Refresh Request Container for details. |
Mandatory |
|
AuditRecord |
Container |
See AuditRecord request container for details. |
Optional |
Refresh Request Container
The Refresh request container contains the following elements:
|
Element Name |
Content Type |
Description |
Required? |
|---|---|---|---|
|
RefreshType |
Container |
Choice of:
|
Mandatory |
|
StartDate |
Date |
The Refresh Effective Date must be specified. |
Mandatory |
Automatic Request Container
The Automatic request container contains the following elements:
|
Element Name |
Content Type |
Description |
Required? |
|---|---|---|---|
|
ReloadMethod |
String6 |
Unique Reload Method ID configured specifically for Auto Refresh. |
Mandatory |
|
ReloadOption |
String6 |
Unique CMP identifier identifying Reload to be applied for automatic |
Mandatory |
|
AutoPurchase |
Boolean |
True or False. If true then the reload will be purchased automatically. |
Optional |
Recurring Request Container
The Recurring request container contains the following elements:
|
Element Name |
Content Type |
Description |
Required? |
|---|---|---|---|
|
ServiceCode |
String6 |
Unique CMP identifier identifying service to be applied for recurring |
Mandatory |
|
FirstPaymentTaken |
Boolean |
True or False. Confirmation if they first payment has been taken or not. |
Optional |
AuditRecord Request Container
The AuditRecord request container has the following elements:
|
Element Name |
Content Type |
Description |
Required? |
|---|---|---|---|
|
UserID |
String10 |
User ID associated with the profile. This is the ID which the calling program adds to the records that are created. |
Mandatory |
|
Program |
String10 |
The Program Name should be hard coded in the calling application to uniquely identify that application. |
Mandatory |
CreateRefresh Response
The CreateRefresh response is the response to the CreateRefresh Request. It has the following elements:
|
Element Name |
Content Type |
Description |
Required? |
|---|---|---|---|
|
ExternalReference |
String69 |
Returned unmodified in the response. The client may use this identifier to correlate the request and the response. |
Optional |