Inheritance diagram for Orbipay.PaymentsApi.Client.Wrappers.SimplePayment:

Public Member Functions
string	GetId ()
	The unique identifier assigned by EBPP to the payment. More...

string	GetUrl ()
	This URL fetches the details of payment. More...

Fee	GetFee ()
	Gets Fee More...

string	GetStatus ()
	The status of the payment. More...

string	GetPaymentMethod ()
	The fulfillment method for the payment. More...

string	GetConfirmationNumber ()
	The confirmation number or reference provided to the customer for the payment. More...

Dictionary< string, string >	GetCustomFields ()
	The additional information or meta-information that EBPP can accept, maintain and transmit back to the client. The custom fields need to be configured with EBPP before they can be accepted. EBPP would reject custom fields that are not pre-configured. Please contact <a href = "mailto: suppo.nosp@m.rt@b.nosp@m.iller.nosp@m.paym.nosp@m.ents..nosp@m.com">suppo.nosp@m.rt@b.nosp@m.iller.nosp@m.paym.nosp@m.ents..nosp@m.com</a> for more information on configuring and using custom fields. More...

string	GetCurrencyCode3d ()
	The three-letter currency code in the ISO4217 format, in uppercase, for the card account. It must be a currency supported by EBPP. This defaults to USD. More...

string	GetAmount ()
	The amount being paid. In case the payment_amount_type is 'discounted_amount', 'penalty_amount' or 'other', the amount needs to be specified. In other cases, this is derived from the payment_amount_type. More...

string	GetCardCvvNumber ()
	This is never returned by EBPP. This needs to be passed to EBPP when making or editing a payment with a card funding account. More...

string	GetPaymentDate ()
	The date on which the payment is scheduled to be made. It must be in ISO8601 full-date format, namely, YYYY-MM-DD. More...

string	GetPaymentScheduleType ()
	The schedule type for the payment. This defaults to one_time_payment. More...

string	GetPaymentRequestDate ()
	The date on which the biller wants the payment to be settled. It must be in ISO8601 full-date format, namely, YYYY-MM-DD. This is applicable only if the client has opted for it. More...

string	GetPaymentAmountType ()
	The type of amount, as per the bill/statement, that is being paid. The payment amount is derived from the amount type selected for the payment. This defaults to other. More...

string	GetPaymentReference ()
	The unique identifier in the client system for the payment. More...

string	GetExpectedPaymentSettlementDate ()
	The date on which the payment is expected to be settled with the biller. It must be in ISO8601 full-date format, namely, YYYY-MM-DD. More...

string	GetPaymentEntryDate ()
	The date on which the payment is captured in EBPP. It must be in ISO8601 full-date format, namely, YYYY-MM-DD. More...

string	GetPaymentReturnDate ()
	The date on which the ACH returns is received by EBPP. More...

string	GetReturnCode ()
	The ACH return code or the chargeback code received from Visa/Mastercard, in the event of returned payments. More...

string	GetPaymentNotificationEmail ()
	The email address of the customer to which payment notifications from EBPP will be sent. The notifications will be sent to customer email in case if this field is not present. More...

string	GetComments ()
	Comments that can be used to recollect the operation performed on the resource object. API clients need to ensure that no sensitive information is passed in the memo. Alacriti (EBPP) is not responsible for the security of any sensitive information that may be passed as part of the memo. More...

Customer	GetCustomer ()
	Gets Customer More...

FundingAccount	GetFundingAccount ()
	Gets FundingAccount More...

CustomerAccount	GetCustomerAccount ()
	Gets CustomerAccount More...

PaymentNetworkResponse	GetPaymentNetworkResponse ()
	Gets PaymentNetworkResponse More...

AuditInfo	GetAuditInfo ()
	Gets AuditInfo More...

string	GetSaveFundingAccount ()
	query param More...

SimplePayment	ForClient (string clientKey)

SimplePayment	VideChannel (string channel)

SimplePayment	WithDetails (string paymentAmountType, string amount, string paymentDate, string paymentRequestDate, string cardCvvNumber)

SimplePayment	FromAccount (FundingAccount fundingAccount, string saveFundingAccount)

SimplePayment	ToAccount (CustomerAccount customerAccount)

SimplePayment	WithReference (string paymentReference)

SimplePayment	WithPaymentNotificationEmail (string paymentNotificationEmail)

SimplePayment	WithCustomFields (Dictionary< string, string > customFields)

SimplePayment	WithMemo (string comments)

SimplePayment	WithFee (Fee fee)

SimplePayment	ForCustomer (Customer customer)

SimplePayment	CreatedBy (string requestor, string requestorType)
	CreatedBy Method. More...

SimplePayment	Create (InvocationContext invocation_context, string live_mode=null, string api_end_point=null)
	Create Method. More...

IEnumerator< SimplePayment >	GetEnumerator ()

Public Member Functions inherited from Orbipay.PaymentsApi.Client.Wrappers.Base
String	GetLiveMode ()

string	GetApiEndPoint ()

void	SetLiveMode (String LiveMode=default(String))

void	SetHttpStatusCode (int httpStatusCode)

InvocationContext	GetInvocationContext ()

int	GetHttpStatusCode ()

void	SetInvocationContext (InvocationContext invocationContext)

void	Dispose ()

Public Attributes
string	Id
	The unique identifier assigned by EBPP to the payment. More...

string	Url
	This URL fetches the details of payment. More...

Fee	Fee
	Fee More...

string	Status
	The status of the payment. More...

string	PaymentMethod
	The fulfillment method for the payment. More...

string	ConfirmationNumber
	The confirmation number or reference provided to the customer for the payment. More...

Dictionary< string, string >	CustomFields
	The additional information or meta-information that EBPP can accept, maintain and transmit back to the client. The custom fields need to be configured with EBPP before they can be accepted. EBPP would reject custom fields that are not pre-configured. Please contact <a href = "mailto: suppo.nosp@m.rt@b.nosp@m.iller.nosp@m.paym.nosp@m.ents..nosp@m.com">suppo.nosp@m.rt@b.nosp@m.iller.nosp@m.paym.nosp@m.ents..nosp@m.com</a> for more information on configuring and using custom fields. More...

string	CurrencyCode3d
	The three-letter currency code in the ISO4217 format, in uppercase, for the card account. It must be a currency supported by EBPP. This defaults to USD. More...

string	Amount
	The amount being paid. In case the payment_amount_type is 'discounted_amount', 'penalty_amount' or 'other', the amount needs to be specified. In other cases, this is derived from the payment_amount_type. More...

string	CardCvvNumber
	This is never returned by EBPP. This needs to be passed to EBPP when making or editing a payment with a card funding account. More...

string	PaymentDate
	The date on which the payment is scheduled to be made. It must be in ISO8601 full-date format, namely, YYYY-MM-DD. More...

string	PaymentScheduleType
	The schedule type for the payment. This defaults to one_time_payment. More...

string	PaymentRequestDate
	The date on which the biller wants the payment to be settled. It must be in ISO8601 full-date format, namely, YYYY-MM-DD. This is applicable only if the client has opted for it. More...

string	PaymentAmountType
	The type of amount, as per the bill/statement, that is being paid. The payment amount is derived from the amount type selected for the payment. This defaults to other. More...

string	PaymentReference
	The unique identifier in the client system for the payment. More...

string	ExpectedPaymentSettlementDate
	The date on which the payment is expected to be settled with the biller. It must be in ISO8601 full-date format, namely, YYYY-MM-DD. More...

string	PaymentEntryDate
	The date on which the payment is captured in EBPP. It must be in ISO8601 full-date format, namely, YYYY-MM-DD. More...

string	PaymentReturnDate
	The date on which the ACH returns is received by EBPP. More...

string	ReturnCode
	The ACH return code or the chargeback code received from Visa/Mastercard, in the event of returned payments. More...

string	PaymentNotificationEmail
	The email address of the customer to which payment notifications from EBPP will be sent. The notifications will be sent to customer email in case if this field is not present. More...

string	Comments
	Comments that can be used to recollect the operation performed on the resource object. API clients need to ensure that no sensitive information is passed in the memo. Alacriti (EBPP) is not responsible for the security of any sensitive information that may be passed as part of the memo. More...

Customer	Customer
	Customer More...

FundingAccount	FundingAccount
	FundingAccount More...

CustomerAccount	CustomerAccount
	CustomerAccount More...

PaymentNetworkResponse	PaymentNetworkResponse
	PaymentNetworkResponse More...

AuditInfo	AuditInfo
	AuditInfo More...

string	saveFundingAccount
	query param More...

Public Attributes inherited from Orbipay.PaymentsApi.Client.Wrappers.Base
int	HttpStatusCode

Additional Inherited Members
Protected Member Functions inherited from Orbipay.PaymentsApi.Client.Wrappers.Base
Base	VideChannel (string channel)

Base	RequestedBy (string requestor, string requestorType)

Base	ForClient (string clientKey)

Base	SetAPIEndpoint (String LiveMode=null, String apiEndPoint=null)

Base	WithContext (InvocationContext request, String LiveMode=default(String), String apiEndPoint=null)

Member Function Documentation

SimplePayment Orbipay.PaymentsApi.Client.Wrappers.SimplePayment.Create	(	InvocationContext	invocation_context,
		string	live_mode = `null`,
		string	api_end_point = `null`
	)

Create Method.

Parameters

invocationContext	The invocationContext is of type InvocationContext
liveMode	The liveMode is of type String

Exceptions

OrbipayApiException The only Exception that is thrown in Exceptional case

Returns: SimplePayment

SimplePayment Orbipay.PaymentsApi.Client.Wrappers.SimplePayment.CreatedBy	(	string	requestor,
		string	requestorType
	)

CreatedBy Method.

Parameters

Requestor	The Requestor is of type string
RequestorType	The RequestorType is of type string

Returns: SimplePayment

SimplePayment Orbipay.PaymentsApi.Client.Wrappers.SimplePayment.ForClient ( string clientKey )

ForClient Method.

Parameters

ClientKey The ClientKey is of type string

Returns: SimplePayment

SimplePayment Orbipay.PaymentsApi.Client.Wrappers.SimplePayment.ForCustomer ( Customer customer )

ForCustomer Method.

Parameters

Customer The Customer is of type Customer

Returns: SimplePayment

SimplePayment Orbipay.PaymentsApi.Client.Wrappers.SimplePayment.FromAccount	(	FundingAccount	fundingAccount,
		string	saveFundingAccount
	)

FromAccount Method.

Parameters

FundingAccount	The FundingAccount is of type FundingAccount
saveFundingAccount	The saveFundingAccount is of type string

Returns: SimplePayment

string Orbipay.PaymentsApi.Client.Wrappers.SimplePayment.GetAmount ( )

The amount being paid. In case the payment_amount_type is 'discounted_amount', 'penalty_amount' or 'other', the amount needs to be specified. In other cases, this is derived from the payment_amount_type.

AuditInfo Orbipay.PaymentsApi.Client.Wrappers.SimplePayment.GetAuditInfo ( )

Gets AuditInfo

string Orbipay.PaymentsApi.Client.Wrappers.SimplePayment.GetCardCvvNumber ( )

This is never returned by EBPP. This needs to be passed to EBPP when making or editing a payment with a card funding account.

string Orbipay.PaymentsApi.Client.Wrappers.SimplePayment.GetComments ( )

Comments that can be used to recollect the operation performed on the resource object. API clients need to ensure that no sensitive information is passed in the memo. Alacriti (EBPP) is not responsible for the security of any sensitive information that may be passed as part of the memo.

string Orbipay.PaymentsApi.Client.Wrappers.SimplePayment.GetConfirmationNumber ( )

The confirmation number or reference provided to the customer for the payment.

string Orbipay.PaymentsApi.Client.Wrappers.SimplePayment.GetCurrencyCode3d ( )

The three-letter currency code in the ISO4217 format, in uppercase, for the card account. It must be a currency supported by EBPP. This defaults to USD.

Customer Orbipay.PaymentsApi.Client.Wrappers.SimplePayment.GetCustomer ( )

Gets Customer

CustomerAccount Orbipay.PaymentsApi.Client.Wrappers.SimplePayment.GetCustomerAccount ( )

Gets CustomerAccount

Dictionary<string, string> Orbipay.PaymentsApi.Client.Wrappers.SimplePayment.GetCustomFields ( )

The additional information or meta-information that EBPP can accept, maintain and transmit back to the client. The custom fields need to be configured with EBPP before they can be accepted. EBPP would reject custom fields that are not pre-configured. Please contact <a href = "mailto: suppo.nosp@m.rt@b.nosp@m.iller.nosp@m.paym.nosp@m.ents..nosp@m.com">suppo.nosp@m.rt@b.nosp@m.iller.nosp@m.paym.nosp@m.ents..nosp@m.com</a> for more information on configuring and using custom fields.

IEnumerator<SimplePayment> Orbipay.PaymentsApi.Client.Wrappers.SimplePayment.GetEnumerator ( )

string Orbipay.PaymentsApi.Client.Wrappers.SimplePayment.GetExpectedPaymentSettlementDate ( )

The date on which the payment is expected to be settled with the biller. It must be in ISO8601 full-date format, namely, YYYY-MM-DD.

Fee Orbipay.PaymentsApi.Client.Wrappers.SimplePayment.GetFee ( )

Gets Fee

FundingAccount Orbipay.PaymentsApi.Client.Wrappers.SimplePayment.GetFundingAccount ( )

Gets FundingAccount

string Orbipay.PaymentsApi.Client.Wrappers.SimplePayment.GetId ( )

The unique identifier assigned by EBPP to the payment.

string Orbipay.PaymentsApi.Client.Wrappers.SimplePayment.GetPaymentAmountType ( )

The type of amount, as per the bill/statement, that is being paid. The payment amount is derived from the amount type selected for the payment. This defaults to other.

string Orbipay.PaymentsApi.Client.Wrappers.SimplePayment.GetPaymentDate ( )

The date on which the payment is scheduled to be made. It must be in ISO8601 full-date format, namely, YYYY-MM-DD.

string Orbipay.PaymentsApi.Client.Wrappers.SimplePayment.GetPaymentEntryDate ( )

The date on which the payment is captured in EBPP. It must be in ISO8601 full-date format, namely, YYYY-MM-DD.

string Orbipay.PaymentsApi.Client.Wrappers.SimplePayment.GetPaymentMethod ( )

The fulfillment method for the payment.

PaymentNetworkResponse Orbipay.PaymentsApi.Client.Wrappers.SimplePayment.GetPaymentNetworkResponse ( )

Gets PaymentNetworkResponse

string Orbipay.PaymentsApi.Client.Wrappers.SimplePayment.GetPaymentNotificationEmail ( )

The email address of the customer to which payment notifications from EBPP will be sent. The notifications will be sent to customer email in case if this field is not present.

string Orbipay.PaymentsApi.Client.Wrappers.SimplePayment.GetPaymentReference ( )

The unique identifier in the client system for the payment.

string Orbipay.PaymentsApi.Client.Wrappers.SimplePayment.GetPaymentRequestDate ( )

The date on which the biller wants the payment to be settled. It must be in ISO8601 full-date format, namely, YYYY-MM-DD. This is applicable only if the client has opted for it.

string Orbipay.PaymentsApi.Client.Wrappers.SimplePayment.GetPaymentReturnDate ( )

The date on which the ACH returns is received by EBPP.

string Orbipay.PaymentsApi.Client.Wrappers.SimplePayment.GetPaymentScheduleType ( )

The schedule type for the payment. This defaults to one_time_payment.

string Orbipay.PaymentsApi.Client.Wrappers.SimplePayment.GetReturnCode ( )

The ACH return code or the chargeback code received from Visa/Mastercard, in the event of returned payments.

string Orbipay.PaymentsApi.Client.Wrappers.SimplePayment.GetSaveFundingAccount ( )

query param

string Orbipay.PaymentsApi.Client.Wrappers.SimplePayment.GetStatus ( )

The status of the payment.

string Orbipay.PaymentsApi.Client.Wrappers.SimplePayment.GetUrl ( )

This URL fetches the details of payment.

SimplePayment Orbipay.PaymentsApi.Client.Wrappers.SimplePayment.ToAccount ( CustomerAccount customerAccount )

ToAccount Method.

Parameters

CustomerAccount The CustomerAccount is of type CustomerAccount

Returns: SimplePayment

SimplePayment Orbipay.PaymentsApi.Client.Wrappers.SimplePayment.VideChannel ( string channel )

VideChannel Method.

Parameters

Channel The Channel is of type string

Returns: SimplePayment

SimplePayment Orbipay.PaymentsApi.Client.Wrappers.SimplePayment.WithCustomFields ( Dictionary< string, string > customFields )

WithCustomFields Method.

Parameters

CustomFields The CustomFields is of type Dictionary<string, string>

Returns: SimplePayment

SimplePayment Orbipay.PaymentsApi.Client.Wrappers.SimplePayment.WithDetails	(	string	paymentAmountType,
		string	amount,
		string	paymentDate,
		string	paymentRequestDate,
		string	cardCvvNumber
	)

WithDetails Method.

Parameters

PaymentAmountType	The PaymentAmountType is of type string
Amount	The Amount is of type string
PaymentDate	The PaymentDate is of type string
PaymentRequestDate	The PaymentRequestDate is of type string
CardCvvNumber	The CardCvvNumber is of type string

Returns: SimplePayment

SimplePayment Orbipay.PaymentsApi.Client.Wrappers.SimplePayment.WithFee ( Fee fee )

WithFee Method.

Parameters

Fee	The Fee is of type Fee

Returns: SimplePayment

SimplePayment Orbipay.PaymentsApi.Client.Wrappers.SimplePayment.WithMemo ( string comments )

WithMemo Method.

Parameters

Comments The Comments is of type string

Returns: SimplePayment

SimplePayment Orbipay.PaymentsApi.Client.Wrappers.SimplePayment.WithPaymentNotificationEmail ( string paymentNotificationEmail )

WithPaymentNotificationEmail Method.

Parameters

PaymentNotificationEmail The PaymentNotificationEmail is of type string

Returns: SimplePayment

SimplePayment Orbipay.PaymentsApi.Client.Wrappers.SimplePayment.WithReference ( string paymentReference )

WithReference Method.

Parameters

PaymentReference The PaymentReference is of type string

Returns: SimplePayment

Member Data Documentation

string Orbipay.PaymentsApi.Client.Wrappers.SimplePayment.Amount

The amount being paid. In case the payment_amount_type is 'discounted_amount', 'penalty_amount' or 'other', the amount needs to be specified. In other cases, this is derived from the payment_amount_type.

AuditInfo Orbipay.PaymentsApi.Client.Wrappers.SimplePayment.AuditInfo

AuditInfo

string Orbipay.PaymentsApi.Client.Wrappers.SimplePayment.CardCvvNumber

This is never returned by EBPP. This needs to be passed to EBPP when making or editing a payment with a card funding account.

string Orbipay.PaymentsApi.Client.Wrappers.SimplePayment.Comments

Comments that can be used to recollect the operation performed on the resource object. API clients need to ensure that no sensitive information is passed in the memo. Alacriti (EBPP) is not responsible for the security of any sensitive information that may be passed as part of the memo.

string Orbipay.PaymentsApi.Client.Wrappers.SimplePayment.ConfirmationNumber

The confirmation number or reference provided to the customer for the payment.

string Orbipay.PaymentsApi.Client.Wrappers.SimplePayment.CurrencyCode3d

The three-letter currency code in the ISO4217 format, in uppercase, for the card account. It must be a currency supported by EBPP. This defaults to USD.

Customer Orbipay.PaymentsApi.Client.Wrappers.SimplePayment.Customer

Customer

CustomerAccount Orbipay.PaymentsApi.Client.Wrappers.SimplePayment.CustomerAccount

CustomerAccount

Dictionary<string, string> Orbipay.PaymentsApi.Client.Wrappers.SimplePayment.CustomFields

The additional information or meta-information that EBPP can accept, maintain and transmit back to the client. The custom fields need to be configured with EBPP before they can be accepted. EBPP would reject custom fields that are not pre-configured. Please contact <a href = "mailto: suppo.nosp@m.rt@b.nosp@m.iller.nosp@m.paym.nosp@m.ents..nosp@m.com">suppo.nosp@m.rt@b.nosp@m.iller.nosp@m.paym.nosp@m.ents..nosp@m.com</a> for more information on configuring and using custom fields.

string Orbipay.PaymentsApi.Client.Wrappers.SimplePayment.ExpectedPaymentSettlementDate

The date on which the payment is expected to be settled with the biller. It must be in ISO8601 full-date format, namely, YYYY-MM-DD.

Fee Orbipay.PaymentsApi.Client.Wrappers.SimplePayment.Fee

Fee

FundingAccount Orbipay.PaymentsApi.Client.Wrappers.SimplePayment.FundingAccount

FundingAccount

string Orbipay.PaymentsApi.Client.Wrappers.SimplePayment.Id

The unique identifier assigned by EBPP to the payment.

string Orbipay.PaymentsApi.Client.Wrappers.SimplePayment.PaymentAmountType

The type of amount, as per the bill/statement, that is being paid. The payment amount is derived from the amount type selected for the payment. This defaults to other.

string Orbipay.PaymentsApi.Client.Wrappers.SimplePayment.PaymentDate

The date on which the payment is scheduled to be made. It must be in ISO8601 full-date format, namely, YYYY-MM-DD.

string Orbipay.PaymentsApi.Client.Wrappers.SimplePayment.PaymentEntryDate

The date on which the payment is captured in EBPP. It must be in ISO8601 full-date format, namely, YYYY-MM-DD.

string Orbipay.PaymentsApi.Client.Wrappers.SimplePayment.PaymentMethod

The fulfillment method for the payment.

PaymentNetworkResponse Orbipay.PaymentsApi.Client.Wrappers.SimplePayment.PaymentNetworkResponse

PaymentNetworkResponse

string Orbipay.PaymentsApi.Client.Wrappers.SimplePayment.PaymentNotificationEmail

The email address of the customer to which payment notifications from EBPP will be sent. The notifications will be sent to customer email in case if this field is not present.

string Orbipay.PaymentsApi.Client.Wrappers.SimplePayment.PaymentReference

The unique identifier in the client system for the payment.

string Orbipay.PaymentsApi.Client.Wrappers.SimplePayment.PaymentRequestDate

The date on which the biller wants the payment to be settled. It must be in ISO8601 full-date format, namely, YYYY-MM-DD. This is applicable only if the client has opted for it.

string Orbipay.PaymentsApi.Client.Wrappers.SimplePayment.PaymentReturnDate

The date on which the ACH returns is received by EBPP.

string Orbipay.PaymentsApi.Client.Wrappers.SimplePayment.PaymentScheduleType

The schedule type for the payment. This defaults to one_time_payment.

string Orbipay.PaymentsApi.Client.Wrappers.SimplePayment.ReturnCode

The ACH return code or the chargeback code received from Visa/Mastercard, in the event of returned payments.

string Orbipay.PaymentsApi.Client.Wrappers.SimplePayment.saveFundingAccount

query param

string Orbipay.PaymentsApi.Client.Wrappers.SimplePayment.Status

The status of the payment.

string Orbipay.PaymentsApi.Client.Wrappers.SimplePayment.Url

This URL fetches the details of payment.

The documentation for this class was generated from the following file:

src/Orbipay.PaymentsApi.Client/Wrappers/SimplePayment.cs

Public Member Functions

Public Attributes

Additional Inherited Members

Member Function Documentation

Member Data Documentation