![]() |
AT&T API Platform SDK for Microsoft®
2.3.3
Wrapper classes that allow developers to build robust applications using .NET
|
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. |
List<NotificationObject> ATT_MSSDK.RequestFactory.AcknowledgeNotifications | ( | System.IO.Stream | stream | ) |
Method fetches notification ids, and get the notification data and acknowledge the nofitication.
stream | Input stream received from listener |
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.
notificationIds | Input stream received from listener |
AcknowledgeNotificationResponse ATT_MSSDK.RequestFactory.AcknowledgeNotifications | ( | string | notificationId | ) |
Method acknowledges notification and requests that the notifications be stopped for a particular NotificationId.
notificationId | Input stream received from listener |
CancelSubscriptionResponse ATT_MSSDK.RequestFactory.CancelSubscription | ( | string | id, |
int | reasonCode, | ||
string | reasonText | ||
) |
Cancels a given subscription.
id | The id of the subscription to cancel. |
reasonCode | The integer cancel subscription reason code. |
reasonText | The text reason field. |
CommitTransactionResponse ATT_MSSDK.RequestFactory.CommitTransaction | ( | decimal | amount, |
string | transactionId, | ||
TransactionOperationStatus | transactionOperationStatus = TransactionOperationStatus.Charged |
||
) |
Commit Transaction.
amount | Amount to commit for the transaction |
transactionId | Transaction Id to commit |
transactionOperationStatus | Transaction operation status |
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.
amount | Dollar amount of the purchase |
category | Product category of the purchase.
|
description | Text description of the purchase that will be displayed on the Advice of Charge page |
transactionId | Unique transaction id assigned by the developer to this transaction |
productId | A value the developer uses to describe the purchase |
redirectUrl | The URL where the users's browser will be redirected after the purchase. |
transactionOperationStatus | Transaction operation status |
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.
notaryResponse | Notary reponse used to create new subscription |
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.
notaryResponse | NotaryResponse used to create new transaction. Notarized Response received from GetNotarizedForNewTransaction() |
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.
amount | Amount of the charge |
category | Category id |
description | Description that will show up on the Advice of Charge page |
transactionId | The unique merchant transaction id |
productId | The product identifier |
redirectUrl | The URL that the browser will redirect to |
transactionOperationStatus | Transaction operation status |
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.
amount | Dollar amount of the purchase |
category | Product category of the purchase.
|
description | Text description of the purchase that will be displayed on the Advice of Charge page |
transactionId | Unique transaction id assigned by the developer to this transaction |
productId | A value the developer uses to describe the purchase |
redirectUrl | The URL where the users's browser will be redirected after the purchase. |
transactionOperationStatus | Transaction operation status |
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.
amount | Amount of the charge |
category | Category id |
description | Description that will show up on the Advice of Charge page |
transactionId | The unique merchant transaction id |
productId | The product identifier |
redirectUrl | The URL that the browser will redirect to |
transactionOperationStatus | Transaction operation status |
NotaryResponse ATT_MSSDK.RequestFactory.GetNotaryResponse | ( | string | payload | ) |
Get the Notary Response for given payload.
payload | payload to notarize. Example- transaction/subscription payload |
NotificationObject ATT_MSSDK.RequestFactory.GetNotification | ( | string | notificationId | ) |
Method fetches notification data for the given notification Id.
notificationId | Notification Id |
List<NotificationObject> ATT_MSSDK.RequestFactory.GetNotification | ( | List< string > | notificationIds | ) |
Method fetches notification data for the given list of notification Ids.
notificationIds | List of Notification Ids |
List<NotificationId> ATT_MSSDK.RequestFactory.GetNotificationIds | ( | System.IO.Stream | stream | ) |
Method fetches notification ids from the stream.
stream | Input stream received from listener |
SubscriptionDetails ATT_MSSDK.RequestFactory.GetSubscriptionDetails | ( | string | merchantSubscriptionId, |
string | consumerId | ||
) |
Get the Subscription Details for a given subscription Id and consumer Id.
merchantSubscriptionId | The id of merchant subscription product. |
consumerId | Id of the consumer |
SubscriptionStatus ATT_MSSDK.RequestFactory.GetSubscriptionStatus | ( | SubscriptionIdTypes | idType, |
string | id | ||
) |
Get the Subscription Status for a given subscription Id.
idType | The type of id.
|
id | The id value. |
TransactionStatus ATT_MSSDK.RequestFactory.GetTransactionStatus | ( | TransactionIdTypes | idType, |
string | id | ||
) |
This method retrieves the status of an existing transaction.
idType | The type of id.
|
id | The id value. |
RefundResponseObject ATT_MSSDK.RequestFactory.Refund | ( | string | id, |
int | reasonCode, | ||
string | reasonText | ||
) |
Refunds a transaction for a given transaction Id.
id | The id of the transaction to refund. |
reasonCode | The integer refund reason code. |
reasonText | The text reason field. |