AddRegisteredCard

The AddRegisteredCard SOAP 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. has been deprecated.

The AddRegisteredCard web service enables an external client system to store new card details in the CMP Converged Monetisation Platform. The MDS Global product that supports customer care and billing for digital service providers. database for future use and 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. convenience.

AddRegisteredCard Request

The AddRegisteredCard tag instructs the 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. Service to add a token representing a registered credit card. 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 Account Number automatically allocated upon Account creation in CMP.	Mandatory
AddRegisteredCardData	Container	Choice of: SubscriptionNumber NetworkSerialNumber See AddRegisteredCardData Container for details.	Optional
RegisterOnly	Container	Contains: RegisterOnlyType See RegisterOnly Request Container for details.	Optional
Card	Container	Contains: PaymentType PaymentCardToken Container See Card Container for details	Mandatory
CancelExistingCard	Boolean	This flag indicates whether or not to cancel the existing card when registering a new card.	Optional
CancellationReason	String	The valid cancellation reason depends on what card is being cancelled, e.g. Credit Card/Debit Card etc.	Optional
AuditRecord	Container	Contains: UserID Program See AuditRecord Request Container for details	Optional

AddRegisteredCardData Request Container

The AddRegisteredCardData request container contains the following elements:

Element Name	Content Type	Description	Required?
SubscriptionNumber	Integer8	This indicates the unique system generated subscription number.	Optional
NetworkSerialNumber	String25	Network Serial Number associated with CMP Subscription Number.	Optional

RegisterOnly Container

Element Name	Content Type	Description	Required?
RegisterOnlyType	String1	Choice of: "1" = Yes: The card is added with a status of 'One Off Payment' and the payment type on the account is not updated. Even if this is the first card being added to the account, it is not with a status of 'Active' and the payment type of the account remains unchanged. "0" = No: If the account has no active card already, the new card is added with the status 'Active' and the payment type of the account is updated to CARD. If the account already has an active card, the new card is added with status 'One Off Payment' and the payment type of the account is not updated.	Optional

Card Request Container

The Card request container has the following elements:

Element Name	Content Type	Description	Required?
PaymentType	String6	The type of credit / debit card used (for example VISA).	Mandatory
PaymentCardToken	Container	Contains: CardReference CardNumber NameOnCard StartYear StartMonth ExpiryYear ExpiryMonth See PaymentCardToken Request Container for details	Mandatory

PaymentCardToken Request Container

The PaymentCardToken request container has the following elements:

Element Name	Content Type	Description	Required?
CardReference	VARCHAR(100)	The tokenised string representing the card.	Mandatory*
CardNumber	String4	The last four digits of card number.	Mandatory
NameOnCard	String20	The name of the cardholder exactly as displayed on the card.	Optional
StartYear	String2	The year from which the card becomes valid, as shown on the card.	Optional
StartMonth	String2	The month from which the card becomes valid, as shown on the card.	Optional
ExpiryYear	String2	The year that the card expires, as shown on the card.	Mandatory*
ExpiryMonth	String2	The month that the card expires, as shown on the card.	Mandatory*

* Mandatory if the system property GENERIC.PAYMENTS - PAYMENT.INTEGRATION is set to true.

AuditRecord 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

AddRegisteredCard Sample Request

AddRegisteredCard Response

AddRegisteredCard response is the response to the AddRegisteredCard 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

Sample AddRegisteredCard Response