PaymentHistory
The PaymentHistory 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. enables an external client system to retrieve a view of the customer In the context of the Cloud Monetisation Platform, an individual or organisation who has signed an agreement to take goods and services from a service provider. A customer receives a bill associated with one or more subscriptions, and can be a single end user or a large company with many subscriptions assigned to one agreement.'s payment history against their CMP Converged Monetisation Platform. The MDS Global product that supports customer care and billing for digital service providers. Account In the Cloud Monetisation Platform, a billing entity that can be used to manage payments on one or more subscriptions or payments for services. An account can hold details such as payments or invoices..
PaymentHistory Request
The PaymentData tag instructs the Payment Service to retrieve the payment history of an Account. 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 |
|
AccountNumber |
Integer8 |
The unique system generated reference number for the Account. |
Mandatory |
PaymentHistory Response
The PaymentHistory response is the response to the PaymentHistory Request. This contains 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 |
|
PaymentDetails |
Container |
Contains one or more payment. See Payment Response Container for details. |
Mandatory |
Payment Response Container
The PaymentDetails response container has the following elements:
|
Element Name |
Content Type |
Description |
Required? |
|---|---|---|---|
|
Payment |
Container |
Zero or more repetitions. See Payment response container for details. |
Optional |
Payment Response Container
The Payment response container has the following elements:
|
Element Name |
Content Type |
Description |
Required? |
|---|---|---|---|
|
PaymentTypeCode |
String |
The type of Credit / Debit Card to be used (for example VISA) Value must already be setup in CMP Payment Type set up. If not supplied a default will be derived from Company Parameters setup. |
Mandatory |
|
AccountNumber |
Integer8 |
The unique system generated reference number for the account. |
Mandatory |
|
CardNumber |
String20 |
The actual number of the Credit or Debit Card. If the Payment Method associated with the payment type specified is Credit Card, then the Bank Account Number must be supplied. |
Mandatory |
|
NameOnCard |
String30 |
The Name of the cardholder. Mandatory if the Payment Method associated with the Payment Type specified is Direct Debit. |
Optional |
|
StartDateMMYYNumber |
Token |
Start Date on the card. YYYY-MM-DDZ |
Optional |
|
ExpiryDateMMYYNumber |
Token |
End Date on the card. YYYY-MM-DDZ |
Mandatory |
|
Amount |
Currency (Decimal) |
|
Mandatory |
|
IssueNumber |
Integer2 |
The Issue Number on the payment card if appropriate. |
Optional |
|
AVSHouseStreetNumber |
String |
The Address of the payment cardholder. |
Optional |
|
CSCNumber |
String6 |
The Card Security Code. On many card types it is the last group of digits on the signature panel. |
Optional |
|
CurrencyCode |
String |
ISO 4217 Currency code (e.g. GBP, EUR, USD). |
Optional |
|
HoldPayment |
Boolean |
If set to True, payment using the chosen card is placed on hold within CMP and not forwarded to the bank until released. |
Optional |
|
PaymentNumber |
String30 |
This a reference number against the payment to indicate if the request has been successful. |
Mandatory |
|
PaymentStatus |
String |
Indicates if the payment type is active or not. |
|
|
ProcessedDate |
Date |
Date on which the payment is processed. YYYY-MM-DDZ |
Optional |
|
ProcessedDateTime |
DateTime |
Date and time at which the payment is processed. |
Optional |
|
PostCode |
String10 |
The cardholder's Post Code. |
Optional |
|
CountryCode |
String2 |
The number code for the country where the payment cardholder resides. |
Optional |
|
ProductService |
String30 |
This is used to capture a description of what the payment was for. |
Optional |