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

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

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

Fee	GetFee ()
	Gets Fee More...

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

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

string	GetPaymentSetupScheduleType ()
	The schedule type for the payment setup. More...

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

Dictionary< string, string >	GetCustomFields ()
	The additional information or meta-information that Orbipay can accept, maintain and transmit back to the client. The custom fields need to be configured with Orbipay before they can be accepted. Orbipay 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. Only the custom fields enabled for the client, in Orbipay, would be accepted in the requests. 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 Orbipay. 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 Orbipay. This needs to be passed to Orbipay when making or editing a payment setup with a card funding account. More...

string	GetNextPaymentDate ()
	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	GetPaymentSetupReference ()
	The unique identifier in the client system for the payment setup. More...

PaymentSchedule	GetPaymentSchedule ()
	Gets PaymentSchedule More...

string	GetPaymentSetupEntryDate ()
	The date on which the payment setup is captured in Orbipay. It must be in ISO8601 full-date format, namely, YYYY-MM-DD. 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 (Orbipay) is not responsible for the security of any sensitive information that may be passed as part of the memo. More...

string	GetDeleted ()
	The status of payment which says whether the payment is deleted or not 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	GetID_CUSTOMER ()
	The unique identifier assigned by EBPP to the customer. More...

string	GetID_PAYMENT_SETUP ()
	The unique identifier assigned by EBPP to the payment setup. More...

	PaymentSetup (string iDPAYMENTSETUP=null)

PaymentSetup	ForClient (string clientKey)

PaymentSetup	VideChannel (string channel)

PaymentSetup	WithDetails (string amount, string cardCvvNumber, string paymentSetupScheduleType)

PaymentSetup	FromAccount (FundingAccount fundingAccount)

PaymentSetup	ToAccount (CustomerAccount customerAccount)

PaymentSetup	WithReference (string paymentSetupReference)

PaymentSetup	WithPaymentSchedule (PaymentSchedule paymentSchedule)

PaymentSetup	WithStatus (string status)

PaymentSetup	WithCustomFields (Dictionary< string, string > customFields)

PaymentSetup	WithMemo (string comments)

PaymentSetup	WithFee (Fee fee)

PaymentSetup	ForCustomer (string iDCUSTOMER)

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

PaymentSetup	DeletedBy (string requestor, string requestorType)
	DeletedBy Method. More...

PaymentSetup	RetrievedBy (string requestor, string requestorType)
	RetrievedBy Method. More...

PaymentSetup	UpdatedBy (string requestor, string requestorType)
	UpdatedBy Method. More...

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

PaymentSetup	Delete (InvocationContext invocation_context, string live_mode=null, string api_end_point=null)
	Delete Method. More...

PaymentSetup	Get (InvocationContext invocation_context, string live_mode=null, string api_end_point=null)
	Get Method. More...

PaymentSetup	Update (InvocationContext invocation_context, string live_mode=null, string api_end_point=null)
	Update Method. More...

IEnumerator< PaymentSetup >	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 Orbipay to the payment setup. More...

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

Fee	Fee
	Fee More...

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

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

string	PaymentSetupScheduleType
	The schedule type for the payment setup. More...

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

Dictionary< string, string >	CustomFields
	The additional information or meta-information that Orbipay can accept, maintain and transmit back to the client. The custom fields need to be configured with Orbipay before they can be accepted. Orbipay 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. Only the custom fields enabled for the client, in Orbipay, would be accepted in the requests. 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 Orbipay. 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 Orbipay. This needs to be passed to Orbipay when making or editing a payment setup with a card funding account. More...

string	NextPaymentDate
	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	PaymentSetupReference
	The unique identifier in the client system for the payment setup. More...

PaymentSchedule	PaymentSchedule
	PaymentSchedule More...

string	PaymentSetupEntryDate
	The date on which the payment setup is captured in Orbipay. It must be in ISO8601 full-date format, namely, YYYY-MM-DD. 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 (Orbipay) is not responsible for the security of any sensitive information that may be passed as part of the memo. More...

string	Deleted
	The status of payment which says whether the payment is deleted or not More...

Customer	Customer
	Customer More...

FundingAccount	FundingAccount
	FundingAccount More...

CustomerAccount	CustomerAccount
	CustomerAccount More...

PaymentNetworkResponse	PaymentNetworkResponse
	PaymentNetworkResponse More...

AuditInfo	AuditInfo
	AuditInfo More...

string	ID_CUSTOMER
	The unique identifier assigned by EBPP to the customer. More...

string	ID_PAYMENT_SETUP
	The unique identifier assigned by EBPP to the payment setup. 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)

Constructor & Destructor Documentation

Orbipay.PaymentsApi.Client.Wrappers.PaymentSetup.PaymentSetup ( string iDPAYMENTSETUP = null )

PaymentSetup Constructor.

Parameters

ID_PAYMENT_SETUP The ID_PAYMENT_SETUP is of type string

Member Function Documentation

PaymentSetup Orbipay.PaymentsApi.Client.Wrappers.PaymentSetup.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: PaymentSetup

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

CreatedBy Method.

Parameters

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

Returns: PaymentSetup

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

Delete 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: PaymentSetup

PaymentSetup Orbipay.PaymentsApi.Client.Wrappers.PaymentSetup.DeletedBy	(	string	requestor,
		string	requestorType
	)

DeletedBy Method.

Parameters

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

Returns: PaymentSetup

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

ForClient Method.

Parameters

ClientKey The ClientKey is of type string

Returns: PaymentSetup

PaymentSetup Orbipay.PaymentsApi.Client.Wrappers.PaymentSetup.ForCustomer ( string iDCUSTOMER )

ForCustomer Method.

Parameters

ID_CUSTOMER The ID_CUSTOMER is of type string

Returns: PaymentSetup

PaymentSetup Orbipay.PaymentsApi.Client.Wrappers.PaymentSetup.FromAccount ( FundingAccount fundingAccount )

FromAccount Method.

Parameters

FundingAccount The FundingAccount is of type FundingAccount

Returns: PaymentSetup

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

Get 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: PaymentSetup

string Orbipay.PaymentsApi.Client.Wrappers.PaymentSetup.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.PaymentSetup.GetAuditInfo ( )

Gets AuditInfo

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

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

string Orbipay.PaymentsApi.Client.Wrappers.PaymentSetup.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 (Orbipay) is not responsible for the security of any sensitive information that may be passed as part of the memo.

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

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

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

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

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

Gets Customer

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

Gets CustomerAccount

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

The additional information or meta-information that Orbipay can accept, maintain and transmit back to the client. The custom fields need to be configured with Orbipay before they can be accepted. Orbipay 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. Only the custom fields enabled for the client, in Orbipay, would be accepted in the requests.

string Orbipay.PaymentsApi.Client.Wrappers.PaymentSetup.GetDeleted ( )

The status of payment which says whether the payment is deleted or not

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

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

Gets Fee

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

Gets FundingAccount

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

The unique identifier assigned by Orbipay to the payment setup.

string Orbipay.PaymentsApi.Client.Wrappers.PaymentSetup.GetID_CUSTOMER ( )

The unique identifier assigned by EBPP to the customer.

string Orbipay.PaymentsApi.Client.Wrappers.PaymentSetup.GetID_PAYMENT_SETUP ( )

The unique identifier assigned by EBPP to the payment setup.

string Orbipay.PaymentsApi.Client.Wrappers.PaymentSetup.GetNextPaymentDate ( )

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.PaymentSetup.GetPaymentMethod ( )

The fulfillment method for the payment.

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

Gets PaymentNetworkResponse

PaymentSchedule Orbipay.PaymentsApi.Client.Wrappers.PaymentSetup.GetPaymentSchedule ( )

Gets PaymentSchedule

string Orbipay.PaymentsApi.Client.Wrappers.PaymentSetup.GetPaymentSetupEntryDate ( )

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

string Orbipay.PaymentsApi.Client.Wrappers.PaymentSetup.GetPaymentSetupReference ( )

The unique identifier in the client system for the payment setup.

string Orbipay.PaymentsApi.Client.Wrappers.PaymentSetup.GetPaymentSetupScheduleType ( )

The schedule type for the payment setup.

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

The status of the payment.

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

This URL fetches the details of payment setup.

PaymentSetup Orbipay.PaymentsApi.Client.Wrappers.PaymentSetup.RetrievedBy	(	string	requestor,
		string	requestorType
	)

RetrievedBy Method.

Parameters

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

Returns: PaymentSetup

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

ToAccount Method.

Parameters

CustomerAccount The CustomerAccount is of type CustomerAccount

Returns: PaymentSetup

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

Update 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: PaymentSetup

PaymentSetup Orbipay.PaymentsApi.Client.Wrappers.PaymentSetup.UpdatedBy	(	string	requestor,
		string	requestorType
	)

UpdatedBy Method.

Parameters

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

Returns: PaymentSetup

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

VideChannel Method.

Parameters

Channel The Channel is of type string

Returns: PaymentSetup

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

WithCustomFields Method.

Parameters

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

Returns: PaymentSetup

PaymentSetup Orbipay.PaymentsApi.Client.Wrappers.PaymentSetup.WithDetails	(	string	amount,
		string	cardCvvNumber,
		string	paymentSetupScheduleType
	)

WithDetails Method.

Parameters

Amount	The Amount is of type string
CardCvvNumber	The CardCvvNumber is of type string
PaymentSetupScheduleType	The PaymentSetupScheduleType is of type string

Returns: PaymentSetup

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

WithFee Method.

Parameters

Fee	The Fee is of type Fee

Returns: PaymentSetup

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

WithMemo Method.

Parameters

Comments The Comments is of type string

Returns: PaymentSetup

PaymentSetup Orbipay.PaymentsApi.Client.Wrappers.PaymentSetup.WithPaymentSchedule ( PaymentSchedule paymentSchedule )

WithPaymentSchedule Method.

Parameters

PaymentSchedule The PaymentSchedule is of type PaymentSchedule

Returns: PaymentSetup

PaymentSetup Orbipay.PaymentsApi.Client.Wrappers.PaymentSetup.WithReference ( string paymentSetupReference )

WithReference Method.

Parameters

PaymentSetupReference The PaymentSetupReference is of type string

Returns: PaymentSetup

PaymentSetup Orbipay.PaymentsApi.Client.Wrappers.PaymentSetup.WithStatus ( string status )

WithStatus Method.

Parameters

Status The Status is of type string

Returns: PaymentSetup

Member Data Documentation

string Orbipay.PaymentsApi.Client.Wrappers.PaymentSetup.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.PaymentSetup.AuditInfo

AuditInfo

string Orbipay.PaymentsApi.Client.Wrappers.PaymentSetup.CardCvvNumber

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

string Orbipay.PaymentsApi.Client.Wrappers.PaymentSetup.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 (Orbipay) is not responsible for the security of any sensitive information that may be passed as part of the memo.

string Orbipay.PaymentsApi.Client.Wrappers.PaymentSetup.ConfirmationNumber

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

string Orbipay.PaymentsApi.Client.Wrappers.PaymentSetup.CurrencyCode3d

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

Customer Orbipay.PaymentsApi.Client.Wrappers.PaymentSetup.Customer

Customer

CustomerAccount Orbipay.PaymentsApi.Client.Wrappers.PaymentSetup.CustomerAccount

CustomerAccount

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

The additional information or meta-information that Orbipay can accept, maintain and transmit back to the client. The custom fields need to be configured with Orbipay before they can be accepted. Orbipay 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. Only the custom fields enabled for the client, in Orbipay, would be accepted in the requests.

string Orbipay.PaymentsApi.Client.Wrappers.PaymentSetup.Deleted

The status of payment which says whether the payment is deleted or not

Fee Orbipay.PaymentsApi.Client.Wrappers.PaymentSetup.Fee

Fee

FundingAccount Orbipay.PaymentsApi.Client.Wrappers.PaymentSetup.FundingAccount

FundingAccount

string Orbipay.PaymentsApi.Client.Wrappers.PaymentSetup.Id

The unique identifier assigned by Orbipay to the payment setup.

string Orbipay.PaymentsApi.Client.Wrappers.PaymentSetup.ID_CUSTOMER

The unique identifier assigned by EBPP to the customer.

string Orbipay.PaymentsApi.Client.Wrappers.PaymentSetup.ID_PAYMENT_SETUP

The unique identifier assigned by EBPP to the payment setup.

string Orbipay.PaymentsApi.Client.Wrappers.PaymentSetup.NextPaymentDate

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.PaymentSetup.PaymentMethod

The fulfillment method for the payment.

PaymentNetworkResponse Orbipay.PaymentsApi.Client.Wrappers.PaymentSetup.PaymentNetworkResponse

PaymentNetworkResponse

PaymentSchedule Orbipay.PaymentsApi.Client.Wrappers.PaymentSetup.PaymentSchedule

PaymentSchedule

string Orbipay.PaymentsApi.Client.Wrappers.PaymentSetup.PaymentSetupEntryDate

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

string Orbipay.PaymentsApi.Client.Wrappers.PaymentSetup.PaymentSetupReference

The unique identifier in the client system for the payment setup.

string Orbipay.PaymentsApi.Client.Wrappers.PaymentSetup.PaymentSetupScheduleType

The schedule type for the payment setup.

string Orbipay.PaymentsApi.Client.Wrappers.PaymentSetup.Status

The status of the payment.

string Orbipay.PaymentsApi.Client.Wrappers.PaymentSetup.Url

This URL fetches the details of payment setup.

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

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

Public Member Functions

Public Attributes

Additional Inherited Members

Constructor & Destructor Documentation

Member Function Documentation

Member Data Documentation