C# Класс Rock.NMI.Gateway

Наследование: Rock.Financial.ThreeStepGatewayComponent

Открытые методы

Метод	Описание
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.

Приватные методы

Метод	Описание
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.

Описание методов

AddScheduledPayment() публичный Метод

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.
Результат	FinancialScheduledTransaction

AddScheduledPaymentStep1() публичный Метод

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.
Результат	string

AddScheduledPaymentStep3() публичный Метод

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.
Результат	FinancialScheduledTransaction

CancelScheduledPayment() публичный Метод

Cancels the scheduled payment.

public CancelScheduledPayment ( FinancialScheduledTransaction transaction, string &errorMessage ) : bool
transaction	FinancialScheduledTransaction	The transaction.
errorMessage	string	The error message.
Результат	bool

Charge() публичный Метод

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.
Результат	FinancialTransaction

ChargeStep1() публичный Метод

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.
Результат	string

ChargeStep3() публичный Метод

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.
Результат	FinancialTransaction

Credit() публичный Метод

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.
Результат	FinancialTransaction

GetPayments() публичный Метод

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.
Результат	List

GetReferenceNumber() публичный Метод

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.
Результат	string

GetReferenceNumber() публичный Метод

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.
Результат	string

GetScheduledPaymentStatus() публичный Метод

Gets the scheduled payment status.

public GetScheduledPaymentStatus ( FinancialScheduledTransaction transaction, string &errorMessage ) : bool
transaction	FinancialScheduledTransaction	The transaction.
errorMessage	string	The error message.
Результат	bool

GetStep1Parameters() публичный Метод

Gets the financial transaction parameters that are passed to step 1

public GetStep1Parameters ( string redirectUrl ) : string>.Dictionary
redirectUrl	string	The redirect URL.
Результат	string>.Dictionary

PromptForBankAccountName() публичный Метод

Prompts the name of for bank account.

public PromptForBankAccountName ( FinancialGateway financialGateway ) : bool
financialGateway	FinancialGateway	The financial gateway.
Результат	bool

PromptForBillingAddress() публичный Метод

Gets a value indicating whether [address required].

public PromptForBillingAddress ( FinancialGateway financialGateway ) : bool
financialGateway	FinancialGateway
Результат	bool

PromptForNameOnCard() публичный Метод

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

public PromptForNameOnCard ( FinancialGateway financialGateway ) : bool
financialGateway	FinancialGateway
Результат	bool

ReactivateScheduledPayment() публичный Метод

Reactivates the scheduled payment.

public ReactivateScheduledPayment ( FinancialScheduledTransaction transaction, string &errorMessage ) : bool
transaction	FinancialScheduledTransaction	The transaction.
errorMessage	string	The error message.
Результат	bool

SupportsSavedAccount() публичный Метод

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].
Результат	bool

UpdateScheduledPayment() публичный Метод

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.
Результат	bool