C# Class Rock.Financial.ThreeStepGatewayComponent

Base class for financial provider components
Inheritance: GatewayComponent
Datei anzeigen Open project: NewSpring/Rock

Public Methods

Method Description
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
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.
GetStep1Parameters ( string redirectUrl ) : string>.Dictionary

Gets the financial transaction parameters that are passed to step 1

Method Details

AddScheduledPaymentStep1() public abstract method

Performs the first step of adding a new payment schedule
public abstract AddScheduledPaymentStep1 ( FinancialGateway financialGateway, PaymentSchedule schedule, PaymentInfo paymentInfo, string &errorMessage ) : string
financialGateway FinancialGateway The financial gateway.
schedule PaymentSchedule The schedule.
paymentInfo PaymentInfo The payment information.
errorMessage string The error message.
return string

AddScheduledPaymentStep3() public abstract method

Performs the third step of adding a new payment schedule
public abstract 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

ChargeStep1() public abstract method

Performs the first step of a three-step charge
public abstract ChargeStep1 ( FinancialGateway financialGateway, PaymentInfo paymentInfo, string &errorMessage ) : string
financialGateway FinancialGateway The financial gateway.
paymentInfo PaymentInfo The payment information.
errorMessage string The error message.
return string

ChargeStep3() public abstract method

Performs the final step of a three-step charge.
public abstract 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

GetStep1Parameters() public abstract method

Gets the financial transaction parameters that are passed to step 1
public abstract GetStep1Parameters ( string redirectUrl ) : string>.Dictionary
redirectUrl string The redirect URL.
return string>.Dictionary