AT&T API Platform SDK for Microsoft®  2.3.2
Wrapper classes that allow developers to build robust applications using .NET
 All Classes Namespaces Functions Enumerations Enumerator Properties Groups Pages
ATT_MSSDK.Paymentv3.SubscriptionStatus Class Reference

Encapsulates return values from the SubscriptionRaw Status API More...

Public Member Functions

 SubscriptionStatus ()
 Initializes a new instance of the SubscriptionStatus class. More...
 

Static Public Member Functions

static SubscriptionStatus ParseXML (string xmlInput)
 Parse an XML document and create a SubscriptionStatus object More...
 

Properties

string Id [get, set]
 Gets or sets the Id of the SubscriptionStatus object More...
 
string Status [get, set]
 Gets or sets the Status of the SubscriptionStatus object More...
 
string Type [get, set]
 Gets or sets the Type of the SubscriptionStatus object More...
 
string ConsumerId [get, set]
 Gets or sets the Unique Consumer Id. More...
 
string MerchantTransactionId [get, set]
 Gets or sets the MerchantTransactionId of the SubscriptionStatus object More...
 
string MerchantSubscriptionId [get, set]
 Gets or sets the Subscription ID that is being created/used, if transaction was a subscription. This field will only appear after the transaction has been authorized (status = AUTHORIZED). More...
 
string Description [get, set]
 Gets or sets the Short description of the product that is being sold. More...
 
double Amount [get, set]
 Gets or sets the Amount of transaction with a maximum of 2 decimal places. Examples: 0.99 to 2.99 More...
 
string ContentCategory [get, set]
 Gets or sets the Content Category from a predefined list. More...
 
string MerchantProductId [get, set]
 Gets or sets the Purchased Product ID in the merchant's system More...
 
string MerchantApplicationId [get, set]
 Gets or sets the Merchant application identifier that initiated the payment transaction. More...
 
string MerchantId [get, set]
 Gets or sets the Merchant identifier in the external system More...
 
bool IsSuccess [get, set]
 Gets or sets a Boolean flag indicating the status of the request. More...
 
string Version [get, set]
 Gets or sets the Version of the API signature. More...
 
string IsAutoCommitted [get, set]
 Gets or sets the True in R2. Read only parameter. More...
 
string Channel [get, set]
 Gets or sets the Merchant UI channel. Must be set to MOBILE_WEB in Release R1. More...
 
string Currency [get, set]
 Gets or sets as USD More...
 
string SubscriptionPeriod [get, set]
 Gets or sets the value of period. The interval at which the subscription will be charged. More...
 
int PeriodAmount [get, set]
 Gets or sets the number of periods that pass between the renewals More...
 
string Recurrences [get, set]
 Gets or sets the number of times the subscription will be renewed More...
 

Detailed Description

Encapsulates return values from the SubscriptionRaw Status API

Constructor & Destructor Documentation

ATT_MSSDK.Paymentv3.SubscriptionStatus.SubscriptionStatus ( )

Initializes a new instance of the SubscriptionStatus class.

Member Function Documentation

static SubscriptionStatus ATT_MSSDK.Paymentv3.SubscriptionStatus.ParseXML ( string  xmlInput)
static

Parse an XML document and create a SubscriptionStatus object

Parameters
xmlInputThe XML document to parse
Returns
The SubscriptionStatus values returned.

Property Documentation

double ATT_MSSDK.Paymentv3.SubscriptionStatus.Amount
getset

Gets or sets the Amount of transaction with a maximum of 2 decimal places. Examples: 0.99 to 2.99

string ATT_MSSDK.Paymentv3.SubscriptionStatus.Channel
getset

Gets or sets the Merchant UI channel. Must be set to MOBILE_WEB in Release R1.

string ATT_MSSDK.Paymentv3.SubscriptionStatus.ConsumerId
getset

Gets or sets the Unique Consumer Id.

string ATT_MSSDK.Paymentv3.SubscriptionStatus.ContentCategory
getset

Gets or sets the Content Category from a predefined list.

string ATT_MSSDK.Paymentv3.SubscriptionStatus.Currency
getset

Gets or sets as USD

string ATT_MSSDK.Paymentv3.SubscriptionStatus.Description
getset

Gets or sets the Short description of the product that is being sold.

string ATT_MSSDK.Paymentv3.SubscriptionStatus.Id
getset

Gets or sets the Id of the SubscriptionStatus object

string ATT_MSSDK.Paymentv3.SubscriptionStatus.IsAutoCommitted
getset

Gets or sets the True in R2. Read only parameter.

bool ATT_MSSDK.Paymentv3.SubscriptionStatus.IsSuccess
getset

Gets or sets a Boolean flag indicating the status of the request.

string ATT_MSSDK.Paymentv3.SubscriptionStatus.MerchantApplicationId
getset

Gets or sets the Merchant application identifier that initiated the payment transaction.

string ATT_MSSDK.Paymentv3.SubscriptionStatus.MerchantId
getset

Gets or sets the Merchant identifier in the external system

string ATT_MSSDK.Paymentv3.SubscriptionStatus.MerchantProductId
getset

Gets or sets the Purchased Product ID in the merchant's system

string ATT_MSSDK.Paymentv3.SubscriptionStatus.MerchantSubscriptionId
getset

Gets or sets the Subscription ID that is being created/used, if transaction was a subscription. This field will only appear after the transaction has been authorized (status = AUTHORIZED).

string ATT_MSSDK.Paymentv3.SubscriptionStatus.MerchantTransactionId
getset

Gets or sets the MerchantTransactionId of the SubscriptionStatus object

int ATT_MSSDK.Paymentv3.SubscriptionStatus.PeriodAmount
getset

Gets or sets the number of periods that pass between the renewals

string ATT_MSSDK.Paymentv3.SubscriptionStatus.Recurrences
getset

Gets or sets the number of times the subscription will be renewed

string ATT_MSSDK.Paymentv3.SubscriptionStatus.Status
getset

Gets or sets the Status of the SubscriptionStatus object

string ATT_MSSDK.Paymentv3.SubscriptionStatus.SubscriptionPeriod
getset

Gets or sets the value of period. The interval at which the subscription will be charged.

string ATT_MSSDK.Paymentv3.SubscriptionStatus.Type
getset

Gets or sets the Type of the SubscriptionStatus object

string ATT_MSSDK.Paymentv3.SubscriptionStatus.Version
getset

Gets or sets the Version of the API signature.