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 Properties
Payment Methods

Classes

class  ATT_MSSDK.RequestFactory
 The RequestFactory manages the connections and calls to the AT&T API Platform. More...

Functions

string ATT_MSSDK.RequestFactory.GetNewTransactionRedirect (NotaryResponse notaryResponse)
 Get the redirect url pointing to AT&T Platform payment endpoint. This url can be used by the application to redirect the user to AT&T payment endpoint which collects user consent for the transaction.
string ATT_MSSDK.RequestFactory.GetNewTransactionRedirect (double amount, PaymentCategories category, string description, string transactionId, string productId, string redirectUrl, TransactionOperationStatus transactionOperationStatus=TransactionOperationStatus.Charged)
 Get the redirect url pointing to AT&T Platform payment endpoint. This url can be used by the application to redirect the user to AT&T payment endpoint which collects user consent for the transaction.
NotaryResponse ATT_MSSDK.RequestFactory.GetNotarizedForNewTransaction (double amount, PaymentCategories category, string description, string transactionId, string productId, string redirectUrl, TransactionOperationStatus transactionOperationStatus=TransactionOperationStatus.Charged)
 This method notarizes/encrypts the transaction payload. The Notary Response can be used to initiate a new Transaction Purchase.
NotaryResponse ATT_MSSDK.RequestFactory.GetNotarizedForNewSubscription (double amount, PaymentCategories category, string description, string transactionId, string productId, string redirectUrl, TransactionOperationStatus transactionOperationStatus=TransactionOperationStatus.Charged)
 This method notarizes/encrypts the subscription payload. The Notary Response can be used to initiate a new subscription Purchase.
NotaryResponse ATT_MSSDK.RequestFactory.GetNotaryResponse (string payload)
 Get the Notary Response for given payload.
string ATT_MSSDK.RequestFactory.GetNewSubscriptionRedirect (double amount, PaymentCategories category, string description, string transactionId, string productId, string redirectUrl, TransactionOperationStatus transactionOperationStatus=TransactionOperationStatus.Charged)
 Get the redirect url pointing to AT&T Platform payment endpoint. This url can be used by the application to redirect the user to AT&T payment endpoint which collects user consent for the subscription.
string ATT_MSSDK.RequestFactory.GetNewSubscriptionRedirect (NotaryResponse notaryResponse)
 Get the redirect url pointing to AT&T Platform payment endpoint. This url can be used by the application to redirect the user to AT&T payment endpoint which collects user consent for the subscription.
TransactionStatus ATT_MSSDK.RequestFactory.GetTransactionStatus (TransactionIdTypes idType, string id)
 This method retrieves the status of an existing transaction.
SubscriptionDetails ATT_MSSDK.RequestFactory.GetSubscriptionDetails (string merchantSubscriptionId, string consumerId)
 Get the Subscription Details for a given subscription Id and consumer Id.
SubscriptionStatus ATT_MSSDK.RequestFactory.GetSubscriptionStatus (SubscriptionIdTypes idType, string id)
 Get the Subscription Status for a given subscription Id.
RefundResponseObject ATT_MSSDK.RequestFactory.Refund (string id, int reasonCode, string reasonText)
 Refunds a transaction for a given transaction Id.
CancelSubscriptionResponse ATT_MSSDK.RequestFactory.CancelSubscription (string id, int reasonCode, string reasonText)
 Cancels a given subscription.
CommitTransactionResponse ATT_MSSDK.RequestFactory.CommitTransaction (decimal amount, string transactionId, TransactionOperationStatus transactionOperationStatus=TransactionOperationStatus.Charged)
 Commit Transaction.
List< NotificationId > ATT_MSSDK.RequestFactory.GetNotificationIds (System.IO.Stream stream)
 Method fetches notification ids from the stream.
List< NotificationObject > ATT_MSSDK.RequestFactory.AcknowledgeNotifications (System.IO.Stream stream)
 Method fetches notification ids, and get the notification data and acknowledge the nofitication.
NotificationObject ATT_MSSDK.RequestFactory.GetNotification (string notificationId)
 Method fetches notification data for the given notification Id.
List< NotificationObject > ATT_MSSDK.RequestFactory.GetNotification (List< string > notificationIds)
 Method fetches notification data for the given list of notification Ids.
List
< AcknowledgeNotificationResponse > 
ATT_MSSDK.RequestFactory.AcknowledgeNotifications (List< string > notificationIds)
 This method acknowledges notifications, and requests that the notifications be stopped for a list of NotificationIds.
AcknowledgeNotificationResponse ATT_MSSDK.RequestFactory.AcknowledgeNotifications (string notificationId)
 Method acknowledges notification and requests that the notifications be stopped for a particular NotificationId.

Function Documentation

List<NotificationObject> ATT_MSSDK.RequestFactory.AcknowledgeNotifications ( System.IO.Stream  stream)

Method fetches notification ids, and get the notification data and acknowledge the nofitication.

Parameters:
streamInput stream received from listener
Returns:
The NotificationObject List of Notification Data
List<AcknowledgeNotificationResponse> ATT_MSSDK.RequestFactory.AcknowledgeNotifications ( List< string >  notificationIds)

This method acknowledges notifications, and requests that the notifications be stopped for a list of NotificationIds.

Parameters:
notificationIdsInput stream received from listener
Returns:
The AcknowledgeNotificationResponse List of Acknowledgement Notification responses
AcknowledgeNotificationResponse ATT_MSSDK.RequestFactory.AcknowledgeNotifications ( string  notificationId)

Method acknowledges notification and requests that the notifications be stopped for a particular NotificationId.

Parameters:
notificationIdInput stream received from listener
Returns:
The AcknowledgeNotificationResponse response of Acknowledgement Notification
CancelSubscriptionResponse ATT_MSSDK.RequestFactory.CancelSubscription ( string  id,
int  reasonCode,
string  reasonText 
)

Cancels a given subscription.

Parameters:
idThe id of the subscription to cancel.
reasonCodeThe integer cancel subscription reason code.
reasonTextThe text reason field.
Returns:
The CancelSubscriptionResponse object.
CommitTransactionResponse ATT_MSSDK.RequestFactory.CommitTransaction ( decimal  amount,
string  transactionId,
TransactionOperationStatus  transactionOperationStatus = TransactionOperationStatus.Charged 
)

Commit Transaction.

Parameters:
amountAmount to commit for the transaction
transactionIdTransaction Id to commit
transactionOperationStatusTransaction operation status
Returns:
The CommitTransactionResponse containing the commit transaction response
string ATT_MSSDK.RequestFactory.GetNewSubscriptionRedirect ( double  amount,
PaymentCategories  category,
string  description,
string  transactionId,
string  productId,
string  redirectUrl,
TransactionOperationStatus  transactionOperationStatus = TransactionOperationStatus.Charged 
)

Get the redirect url pointing to AT&T Platform payment endpoint. This url can be used by the application to redirect the user to AT&T payment endpoint which collects user consent for the subscription.

Parameters:
amountDollar amount of the purchase
categoryProduct category of the purchase.
See also:
PaymentCategories
descriptionText description of the purchase that will be displayed on the Advice of Charge page
transactionIdUnique transaction id assigned by the developer to this transaction
productIdA value the developer uses to describe the purchase
redirectUrlThe URL where the users's browser will be redirected after the purchase.
transactionOperationStatusTransaction operation status
Returns:
The URL that the browser should be redirected to.

Get the redirect url pointing to AT&T Platform payment endpoint. This url can be used by the application to redirect the user to AT&T payment endpoint which collects user consent for the subscription.

Parameters:
notaryResponseNotary reponse used to create new subscription
Returns:
The URL that the browser should be redirected to.

Get the redirect url pointing to AT&T Platform payment endpoint. This url can be used by the application to redirect the user to AT&T payment endpoint which collects user consent for the transaction.

Parameters:
notaryResponseNotaryResponse used to create new transaction. Notarized Response received from GetNotarizedForNewTransaction()
Returns:
New transaction redirect url.
string ATT_MSSDK.RequestFactory.GetNewTransactionRedirect ( double  amount,
PaymentCategories  category,
string  description,
string  transactionId,
string  productId,
string  redirectUrl,
TransactionOperationStatus  transactionOperationStatus = TransactionOperationStatus.Charged 
)

Get the redirect url pointing to AT&T Platform payment endpoint. This url can be used by the application to redirect the user to AT&T payment endpoint which collects user consent for the transaction.

Parameters:
amountAmount of the charge
categoryCategory id
descriptionDescription that will show up on the Advice of Charge page
transactionIdThe unique merchant transaction id
productIdThe product identifier
redirectUrlThe URL that the browser will redirect to
transactionOperationStatusTransaction operation status
Returns:
New transaction redirect url.
NotaryResponse ATT_MSSDK.RequestFactory.GetNotarizedForNewSubscription ( double  amount,
PaymentCategories  category,
string  description,
string  transactionId,
string  productId,
string  redirectUrl,
TransactionOperationStatus  transactionOperationStatus = TransactionOperationStatus.Charged 
)

This method notarizes/encrypts the subscription payload. The Notary Response can be used to initiate a new subscription Purchase.

Parameters:
amountDollar amount of the purchase
categoryProduct category of the purchase.
See also:
PaymentCategories
descriptionText description of the purchase that will be displayed on the Advice of Charge page
transactionIdUnique transaction id assigned by the developer to this transaction
productIdA value the developer uses to describe the purchase
redirectUrlThe URL where the users's browser will be redirected after the purchase.
transactionOperationStatusTransaction operation status
Returns:
The NotaryResponse object
NotaryResponse ATT_MSSDK.RequestFactory.GetNotarizedForNewTransaction ( double  amount,
PaymentCategories  category,
string  description,
string  transactionId,
string  productId,
string  redirectUrl,
TransactionOperationStatus  transactionOperationStatus = TransactionOperationStatus.Charged 
)

This method notarizes/encrypts the transaction payload. The Notary Response can be used to initiate a new Transaction Purchase.

Parameters:
amountAmount of the charge
categoryCategory id
descriptionDescription that will show up on the Advice of Charge page
transactionIdThe unique merchant transaction id
productIdThe product identifier
redirectUrlThe URL that the browser will redirect to
transactionOperationStatusTransaction operation status
Returns:
The NotaryResponse object
NotaryResponse ATT_MSSDK.RequestFactory.GetNotaryResponse ( string  payload)

Get the Notary Response for given payload.

Parameters:
payloadpayload to notarize. Example- transaction/subscription payload
Returns:
The NotaryResponse object
NotificationObject ATT_MSSDK.RequestFactory.GetNotification ( string  notificationId)

Method fetches notification data for the given notification Id.

Parameters:
notificationIdNotification Id
Returns:
The NotificationObjectNotificaiton Data
List<NotificationObject> ATT_MSSDK.RequestFactory.GetNotification ( List< string >  notificationIds)

Method fetches notification data for the given list of notification Ids.

Parameters:
notificationIdsList of Notification Ids
Returns:
The NotificationObjectList of Notificaiton Data
List<NotificationId> ATT_MSSDK.RequestFactory.GetNotificationIds ( System.IO.Stream  stream)

Method fetches notification ids from the stream.

Parameters:
streamInput stream received from listener
Returns:
The NotificationIdList of Notification Ids
SubscriptionDetails ATT_MSSDK.RequestFactory.GetSubscriptionDetails ( string  merchantSubscriptionId,
string  consumerId 
)

Get the Subscription Details for a given subscription Id and consumer Id.

Parameters:
merchantSubscriptionIdThe id of merchant subscription product.
consumerIdId of the consumer
Returns:
The SubscriptionDetails containing the subscription details.
SubscriptionStatus ATT_MSSDK.RequestFactory.GetSubscriptionStatus ( SubscriptionIdTypes  idType,
string  id 
)

Get the Subscription Status for a given subscription Id.

Parameters:
idTypeThe type of id.
See also:
SubscriptionIdTypes
idThe id value.
Returns:
The SubscriptionStatus object containing the subscription status.
TransactionStatus ATT_MSSDK.RequestFactory.GetTransactionStatus ( TransactionIdTypes  idType,
string  id 
)

This method retrieves the status of an existing transaction.

Parameters:
idTypeThe type of id.
See also:
TransactionIdTypes
idThe id value.
Returns:
The TransactionStatus containing the transaction status.
RefundResponseObject ATT_MSSDK.RequestFactory.Refund ( string  id,
int  reasonCode,
string  reasonText 
)

Refunds a transaction for a given transaction Id.

Parameters:
idThe id of the transaction to refund.
reasonCodeThe integer refund reason code.
reasonTextThe text reason field.
Returns:
The RefundResponseObject.