C# Class Rock.NMI.Gateway

Inheritance: Rock.Financial.ThreeStepGatewayComponent

Mostrar archivo Open project: NewSpring/Rock

Public Methods

Method	Description
AddScheduledPayment ( FinancialGateway financialGateway, PaymentSchedule schedule, PaymentInfo paymentInfo, string &errorMessage ) : FinancialScheduledTransaction	Adds the scheduled payment.
AddScheduledPaymentStep1 ( FinancialGateway financialGateway, PaymentSchedule schedule, PaymentInfo paymentInfo, string &errorMessage ) : string	Performs the first step of adding a new payment schedule
AddScheduledPaymentStep3 ( FinancialGateway financialGateway, string resultQueryString, string &errorMessage ) : FinancialScheduledTransaction	Performs the third step of adding a new payment schedule
CancelScheduledPayment ( FinancialScheduledTransaction transaction, string &errorMessage ) : bool	Cancels the scheduled payment.
Charge ( FinancialGateway financialGateway, PaymentInfo paymentInfo, string &errorMessage ) : FinancialTransaction	Charges the specified payment info.
ChargeStep1 ( FinancialGateway financialGateway, PaymentInfo paymentInfo, string &errorMessage ) : string	Performs the first step of a three-step charge
ChargeStep3 ( FinancialGateway financialGateway, string resultQueryString, string &errorMessage ) : FinancialTransaction	Performs the final step of a three-step charge.
Credit ( FinancialTransaction origTransaction, decimal amount, string comment, string &errorMessage ) : FinancialTransaction	Credits (Refunds) the specified transaction.
GetPayments ( FinancialGateway financialGateway, System.DateTime startDate, System.DateTime endDate, string &errorMessage ) : List	Gets the payments that have been processed for any scheduled transactions
GetReferenceNumber ( FinancialScheduledTransaction scheduledTransaction, string &errorMessage ) : string	Gets an optional reference identifier needed to process future transaction from saved account.
GetReferenceNumber ( FinancialTransaction transaction, string &errorMessage ) : string	Gets an optional reference identifier needed to process future transaction from saved account.
GetScheduledPaymentStatus ( FinancialScheduledTransaction transaction, string &errorMessage ) : bool	Gets the scheduled payment status.
GetStep1Parameters ( string redirectUrl ) : string>.Dictionary	Gets the financial transaction parameters that are passed to step 1
PromptForBankAccountName ( FinancialGateway financialGateway ) : bool	Prompts the name of for bank account.
PromptForBillingAddress ( FinancialGateway financialGateway ) : bool	Gets a value indicating whether [address required].
PromptForNameOnCard ( FinancialGateway financialGateway ) : bool	Gets a value indicating whether the gateway requires the name on card for CC processing
ReactivateScheduledPayment ( FinancialScheduledTransaction transaction, string &errorMessage ) : bool	Reactivates the scheduled payment.
SupportsSavedAccount ( bool isRepeating ) : bool	Returnes a boolean value indicating if 'Saved Account' functionality is supported for frequency (i.e. one-time vs repeating )
UpdateScheduledPayment ( FinancialScheduledTransaction transaction, PaymentInfo paymentInfo, string &errorMessage ) : bool	Updates the scheduled payment.

Private Methods

Method	Description
GetBilling ( PaymentInfo paymentInfo ) : System.Xml.Linq.XElement	Creates a billing XML element
GetPlan ( PaymentSchedule schedule, PaymentInfo paymentInfo ) : System.Xml.Linq.XElement	Creates a scheduled transaction plan XML element
GetResponseMessage ( Stream responseStream ) : string	Gets the response message.
GetRoot ( FinancialGateway financialGateway, string elementName ) : System.Xml.Linq.XElement
GetXElementValue ( System.Xml.Linq.XElement parentElement, string elementName ) : string
GetXmlResponse ( IRestResponse response ) : System.Xml.Linq.XDocument	Gets the response as an XDocument
ParseDateValue ( string dateString ) : DateTime?
PostToGateway ( FinancialGateway financialGateway, System.Xml.Linq.XDocument data ) : string>.Dictionary	Posts to gateway.

Method Details

AddScheduledPayment() public method

Adds the scheduled payment.

public AddScheduledPayment ( FinancialGateway financialGateway, PaymentSchedule schedule, PaymentInfo paymentInfo, string &errorMessage ) : FinancialScheduledTransaction
financialGateway	FinancialGateway	The financial gateway.
schedule	Rock.Financial.PaymentSchedule	The schedule.
paymentInfo	Rock.Financial.PaymentInfo	The payment info.
errorMessage	string	The error message.
return	FinancialScheduledTransaction

AddScheduledPaymentStep1() public method

Performs the first step of adding a new payment schedule

paymentInfo

public AddScheduledPaymentStep1 ( FinancialGateway financialGateway, PaymentSchedule schedule, PaymentInfo paymentInfo, string &errorMessage ) : string
financialGateway	FinancialGateway	The financial gateway.
schedule	Rock.Financial.PaymentSchedule	The schedule.
paymentInfo	Rock.Financial.PaymentInfo	The payment information.
errorMessage	string	The error message.
return	string

AddScheduledPaymentStep3() public method

Performs the third step of adding a new payment schedule

tokenId

public AddScheduledPaymentStep3 ( FinancialGateway financialGateway, string resultQueryString, string &errorMessage ) : FinancialScheduledTransaction
financialGateway	FinancialGateway	The financial gateway.
resultQueryString	string	The result query string from step 2.
errorMessage	string	The error message.
return	FinancialScheduledTransaction

CancelScheduledPayment() public method

Cancels the scheduled payment.

public CancelScheduledPayment ( FinancialScheduledTransaction transaction, string &errorMessage ) : bool
transaction	FinancialScheduledTransaction	The transaction.
errorMessage	string	The error message.
return	bool

Charge() public method

Charges the specified payment info.

public Charge ( FinancialGateway financialGateway, PaymentInfo paymentInfo, string &errorMessage ) : FinancialTransaction
financialGateway	FinancialGateway	The financial gateway.
paymentInfo	Rock.Financial.PaymentInfo	The payment info.
errorMessage	string	The error message.
return	FinancialTransaction

ChargeStep1() public method

Performs the first step of a three-step charge

paymentInfo

public ChargeStep1 ( FinancialGateway financialGateway, PaymentInfo paymentInfo, string &errorMessage ) : string
financialGateway	FinancialGateway	The financial gateway.
paymentInfo	Rock.Financial.PaymentInfo	The payment information.
errorMessage	string	The error message.
return	string

ChargeStep3() public method

Performs the final step of a three-step charge.

public ChargeStep3 ( FinancialGateway financialGateway, string resultQueryString, string &errorMessage ) : FinancialTransaction
financialGateway	FinancialGateway	The financial gateway.
resultQueryString	string	The result query string from step 2.
errorMessage	string	The error message.
return	FinancialTransaction

Credit() public method

Credits (Refunds) the specified transaction.

public Credit ( FinancialTransaction origTransaction, decimal amount, string comment, string &errorMessage ) : FinancialTransaction
origTransaction	FinancialTransaction	The original transaction.
amount	decimal	The amount.
comment	string	The comment.
errorMessage	string	The error message.
return	FinancialTransaction

GetPayments() public method

Gets the payments that have been processed for any scheduled transactions

public GetPayments ( FinancialGateway financialGateway, System.DateTime startDate, System.DateTime endDate, string &errorMessage ) : List
financialGateway	FinancialGateway	The financial gateway.
startDate	System.DateTime	The start date.
endDate	System.DateTime	The end date.
errorMessage	string	The error message.
return	List

GetReferenceNumber() public method

Gets an optional reference identifier needed to process future transaction from saved account.

public GetReferenceNumber ( FinancialScheduledTransaction scheduledTransaction, string &errorMessage ) : string
scheduledTransaction	FinancialScheduledTransaction	The scheduled transaction.
errorMessage	string	The error message.
return	string

GetReferenceNumber() public method

Gets an optional reference identifier needed to process future transaction from saved account.

public GetReferenceNumber ( FinancialTransaction transaction, string &errorMessage ) : string
transaction	FinancialTransaction	The transaction.
errorMessage	string	The error message.
return	string

GetScheduledPaymentStatus() public method

Gets the scheduled payment status.

public GetScheduledPaymentStatus ( FinancialScheduledTransaction transaction, string &errorMessage ) : bool
transaction	FinancialScheduledTransaction	The transaction.
errorMessage	string	The error message.
return	bool

GetStep1Parameters() public method

Gets the financial transaction parameters that are passed to step 1

public GetStep1Parameters ( string redirectUrl ) : string>.Dictionary
redirectUrl	string	The redirect URL.
return	string>.Dictionary

PromptForBankAccountName() public method

Prompts the name of for bank account.

public PromptForBankAccountName ( FinancialGateway financialGateway ) : bool
financialGateway	FinancialGateway	The financial gateway.
return	bool

PromptForBillingAddress() public method

Gets a value indicating whether [address required].

public PromptForBillingAddress ( FinancialGateway financialGateway ) : bool
financialGateway	FinancialGateway
return	bool

PromptForNameOnCard() public method

Gets a value indicating whether the gateway requires the name on card for CC processing

public PromptForNameOnCard ( FinancialGateway financialGateway ) : bool
financialGateway	FinancialGateway
return	bool

ReactivateScheduledPayment() public method

Reactivates the scheduled payment.

public ReactivateScheduledPayment ( FinancialScheduledTransaction transaction, string &errorMessage ) : bool
transaction	FinancialScheduledTransaction	The transaction.
errorMessage	string	The error message.
return	bool

SupportsSavedAccount() public method

Returnes a boolean value indicating if 'Saved Account' functionality is supported for frequency (i.e. one-time vs repeating )

public SupportsSavedAccount ( bool isRepeating ) : bool
isRepeating	bool	if set to true [is repeating].
return	bool

UpdateScheduledPayment() public method

Updates the scheduled payment.

public UpdateScheduledPayment ( FinancialScheduledTransaction transaction, PaymentInfo paymentInfo, string &errorMessage ) : bool
transaction	FinancialScheduledTransaction	The transaction.
paymentInfo	Rock.Financial.PaymentInfo	The payment info.
errorMessage	string	The error message.
return	bool