You are here: Ektron Namespace > Providers API > PaymentGatewayProvider Class
Ektron CMS400.NET API Documentation
ContentsIndexHome
PreviousUpNext
PaymentGatewayProvider Class

Base class for Payment Gateway Providers. A Payment Gateway Provider is a pluggable component that is integrated into Ektron’s CMS400.NET eCommerce module. A Payment provider handles eCommerce customer payments by utilizing third party payment gateways. CMS400.NET’s eCommerce module accepts payments such as, credit cards. Then, it passes that information to a third party service. The third party service processes the payment, and returns a transaction ID that’s stored with the customer's order.  

You can use this base class to create your own custom payment gateway. For additional information on payment gateways, see the Ektron CMS400.NET Developer Manual's "Customizing eCommerce" > "Payment Gateway Providers" section.

C#
public abstract class PaymentGatewayProvider : ProviderBase;
Visual Basic
Public abstract Class PaymentGatewayProvider
Inherits ProviderBase

PaymentProvider.cs

Name 
Description 
The methods of the PaymentGatewayProvider class are listed here. 
The properties of the PaymentGatewayProvider class are listed here. 
 
Name 
Description 
 
Authorizes a payment, but does not capture it. Returns an authorization code so it can be captured at a later date.  
 
Authorizes and captures a payment.  
 
Authorizes a recurring payment transaction.  
 
Cancels a recurring payment by providing its ID.  
 
Captures a preauthorized payment.  
 
Handles a recurring payment that has failed. This method should be the callback point when a recurring payment has failed.  
 
Handles a recurring payment that has been processed. This method should be the callback point when a recurring payment is processed.  
 
Voids a preauthorized payment.  
 
Name 
Description 
 
Gets or sets the payment amount being submitted.  
 
Gets or sets the PaymentAuthorization result. Payment submission results should be set on the Authorization.  
 
Gets the PaymentProvider config result.  
 
Gets or sets the currency's Alpha ISO Code.  
 
Gets or sets the currency's Numeric ISO Code.  
 
Gets or sets the data associated with this payment gateway provider including the user ID and password for the gateway.  
 
Gets or sets the "Test Mode" flag. True indicates the application is configured for testing.  
 
Returns true if authorization was successful.  
 
Gets or sets the ID of the order associated with the payment submittal.  
 
Gets or sets the Payment Method for this payment submittal. This could be a CreditCardPayment, eCheckPayment, etc.  
 
Returns any error messages that occurred during submission.  
 
Gets or sets whether the payment gateway supports check payments.
  • True = the payment gateway supports check payments
  • False = the payment gateway does not support check payments
 
 
Gets or sets whether the payment gateway supports credit cards.
  • True = the payment gateway supports credit cards
  • False = the payment gateway does not support credit cards
 
 
Gets or sets the "Supports Recurring Payments" flag. If true, this provider supports recurring payments.  
Created with a commercial version of Doc-O-Matic. In order to make this message disappear you need to register this software. If you have problems registering this software please contact us at [email protected].
Copyright (c) 2008. All rights reserved.
What do you think about this topic? Send feedback!