C# Class Rock.PayFlowPro.Gateway

Inheritance: Rock.Financial.GatewayComponent
Show file Open project: NewSpring/Rock

Public Methods

Method Description
AddScheduledPayment ( FinancialGateway financialGateway, PaymentSchedule schedule, PaymentInfo paymentInfo, string &errorMessage ) : FinancialScheduledTransaction

Adds the scheduled payment.
Authorize ( FinancialGateway financialGateway, PaymentInfo paymentInfo, string &errorMessage ) : FinancialTransaction

Authorizes the specified payment info.
CancelScheduledPayment ( FinancialScheduledTransaction transaction, string &errorMessage ) : bool

Cancels the scheduled payment.
Charge ( FinancialGateway financialGateway, PaymentInfo paymentInfo, string &errorMessage ) : FinancialTransaction

Charges the specified payment info.
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.
ReactivateScheduledPayment ( FinancialScheduledTransaction transaction, string &errorMessage ) : bool

Reactivates the scheduled payment.
SupportsSavedAccount ( DefinedValueCache currencyType ) : bool

Returnes a boolean value indicating if 'Saved Account' functionality is supported for the given currency type.
UpdateScheduledPayment ( FinancialScheduledTransaction transaction, PaymentInfo paymentInfo, string &errorMessage ) : bool

Updates the scheduled payment.

Private Methods

Method Description
GetConnection ( FinancialGateway financialGateway ) : PayflowConnectionData
GetDate ( string date ) : DateTime?
GetFinancialGateway ( FinancialGateway financialGateway, int financialGatewayId ) : FinancialGateway
GetFinancialGateway ( FinancialScheduledTransaction scheduledTransaction ) : FinancialGateway
GetFinancialGateway ( FinancialTransaction transaction ) : FinancialGateway
GetGatewayUrl ( FinancialGateway financialGateway ) : string
GetInvoice ( PaymentInfo paymentInfo ) : Invoice
GetRecurring ( FinancialScheduledTransaction schedule ) : RecurringInfo
GetRecurring ( PaymentSchedule schedule ) : RecurringInfo
GetTender ( PaymentInfo paymentInfo ) : BaseTender
GetUserInfo ( FinancialGateway financialGateway ) : UserInfo
SetPayPeriod ( RecurringInfo recurringInfo, DefinedValueCache transactionFrequencyValue ) : void

Method Details

AddScheduledPayment() public method

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

Authorize() public method

Authorizes the specified payment info.
public Authorize ( FinancialGateway financialGateway, PaymentInfo paymentInfo, string &errorMessage ) : FinancialTransaction
financialGateway FinancialGateway
paymentInfo Rock.Financial.PaymentInfo The payment info.
errorMessage string The error message.
return FinancialTransaction

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
paymentInfo Rock.Financial.PaymentInfo The payment info.
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
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

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 the given currency type.
public SupportsSavedAccount ( DefinedValueCache currencyType ) : bool
currencyType DefinedValueCache Type of the currency.
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