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

Public Member Functions
string	GetPaymentAuthReference ()
	The unique identifier in the client system for the payment. More...

string	GetId ()
	The unique identifier assigned by EBPP to the payment authorization. More...

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

string	GetAuthAmount ()
	The amount being authorized. More...

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

string	GetPaymentMethod ()
	The fulfillment method for the payment authorization. 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	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	GetEntryTime ()
	The date on which the payment authorization created in UTC timestamp, with ISO8601 format. For e.g., 2019-08-13T09:21:34.359+0000. More...

string	GetCapturedTime ()
	The date on which the payment authorization is captured in UTC timestamp, with ISO8601 format. For e.g., 2019-08-13T09:21:34.359+0000.. 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...

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. Only the custom fields enabled for the client, in EBPP, would be accepted in the requests. 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_AUTHORIZATION ()
	The unique identifier assigned by EBPP to the payment authorization. More...

	PaymentAuthorization (string iDAUTHORIZATION=null)

PaymentAuthorization	ForClient (string clientKey)

PaymentAuthorization	VideChannel (string channel)

PaymentAuthorization	WithDetails (string authAmount, string cardCvvNumber)

PaymentAuthorization	ForCustomer (string iDCUSTOMER)

PaymentAuthorization	FromAccount (FundingAccount fundingAccount)

PaymentAuthorization	ToAccount (CustomerAccount customerAccount)

PaymentAuthorization	WithReference (string paymentAuthReference)

PaymentAuthorization	WithCustomFields (Dictionary< string, string > customFields)

PaymentAuthorization	WithMemo (string comments)

PaymentAuthorization	CancelledBy (string requestor, string requestorType)
	CancelledBy Method. More...

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

PaymentAuthorization	Cancel (InvocationContext invocation_context, string live_mode=null, string api_end_point=null)
	Cancel Method. More...

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

IEnumerator< PaymentAuthorization >	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	PaymentAuthReference
	The unique identifier in the client system for the payment. More...

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

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

string	AuthAmount
	The amount being authorized. More...

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

string	PaymentMethod
	The fulfillment method for the payment authorization. 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	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	EntryTime
	The date on which the payment authorization created in UTC timestamp, with ISO8601 format. For e.g., 2019-08-13T09:21:34.359+0000. More...

string	CapturedTime
	The date on which the payment authorization is captured in UTC timestamp, with ISO8601 format. For e.g., 2019-08-13T09:21:34.359+0000.. 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...

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. Only the custom fields enabled for the client, in EBPP, would be accepted in the requests. 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_AUTHORIZATION
	The unique identifier assigned by EBPP to the payment authorization. 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.PaymentAuthorization.PaymentAuthorization ( string iDAUTHORIZATION = null )

PaymentAuthorization Constructor.

Parameters

ID_AUTHORIZATION The ID_AUTHORIZATION is of type string

Member Function Documentation

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

Cancel 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: PaymentAuthorization

PaymentAuthorization Orbipay.PaymentsApi.Client.Wrappers.PaymentAuthorization.CancelledBy	(	string	requestor,
		string	requestorType
	)

CancelledBy Method.

Parameters

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

Returns: PaymentAuthorization

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

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

CreatedBy Method.

Parameters

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

Returns: PaymentAuthorization

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

ForClient Method.

Parameters

ClientKey The ClientKey is of type string

Returns: PaymentAuthorization

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

ForCustomer Method.

Parameters

ID_CUSTOMER The ID_CUSTOMER is of type string

Returns: PaymentAuthorization

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

FromAccount Method.

Parameters

FundingAccount The FundingAccount is of type FundingAccount

Returns: PaymentAuthorization

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

Gets AuditInfo

string Orbipay.PaymentsApi.Client.Wrappers.PaymentAuthorization.GetAuthAmount ( )

The amount being authorized.

string Orbipay.PaymentsApi.Client.Wrappers.PaymentAuthorization.GetCapturedTime ( )

The date on which the payment authorization is captured in UTC timestamp, with ISO8601 format. For e.g., 2019-08-13T09:21:34.359+0000..

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

Gets Customer

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

Gets CustomerAccount

Dictionary<string, string> Orbipay.PaymentsApi.Client.Wrappers.PaymentAuthorization.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. Only the custom fields enabled for the client, in EBPP, would be accepted in the requests.

string Orbipay.PaymentsApi.Client.Wrappers.PaymentAuthorization.GetEntryTime ( )

The date on which the payment authorization created in UTC timestamp, with ISO8601 format. For e.g., 2019-08-13T09:21:34.359+0000.

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

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

Gets FundingAccount

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

The unique identifier assigned by EBPP to the payment authorization.

string Orbipay.PaymentsApi.Client.Wrappers.PaymentAuthorization.GetID_AUTHORIZATION ( )

The unique identifier assigned by EBPP to the payment authorization.

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

The unique identifier assigned by EBPP to the customer.

string Orbipay.PaymentsApi.Client.Wrappers.PaymentAuthorization.GetPaymentAuthReference ( )

The unique identifier in the client system for the payment.

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

The fulfillment method for the payment authorization.

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

Gets PaymentNetworkResponse

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

The status of the payment.

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

This URL fetches the details of payment authorization.

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

ToAccount Method.

Parameters

CustomerAccount The CustomerAccount is of type CustomerAccount

Returns: PaymentAuthorization

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

VideChannel Method.

Parameters

Channel The Channel is of type string

Returns: PaymentAuthorization

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

WithCustomFields Method.

Parameters

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

Returns: PaymentAuthorization

PaymentAuthorization Orbipay.PaymentsApi.Client.Wrappers.PaymentAuthorization.WithDetails	(	string	authAmount,
		string	cardCvvNumber
	)

WithDetails Method.

Parameters

AuthAmount	The AuthAmount is of type string
CardCvvNumber	The CardCvvNumber is of type string

Returns: PaymentAuthorization

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

WithMemo Method.

Parameters

Comments The Comments is of type string

Returns: PaymentAuthorization

PaymentAuthorization Orbipay.PaymentsApi.Client.Wrappers.PaymentAuthorization.WithReference ( string paymentAuthReference )

WithReference Method.

Parameters

PaymentAuthReference The PaymentAuthReference is of type string

Returns: PaymentAuthorization

Member Data Documentation

AuditInfo Orbipay.PaymentsApi.Client.Wrappers.PaymentAuthorization.AuditInfo

AuditInfo

string Orbipay.PaymentsApi.Client.Wrappers.PaymentAuthorization.AuthAmount

The amount being authorized.

string Orbipay.PaymentsApi.Client.Wrappers.PaymentAuthorization.CapturedTime

The date on which the payment authorization is captured in UTC timestamp, with ISO8601 format. For e.g., 2019-08-13T09:21:34.359+0000..

string Orbipay.PaymentsApi.Client.Wrappers.PaymentAuthorization.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.PaymentAuthorization.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.PaymentAuthorization.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.PaymentAuthorization.Customer

Customer

CustomerAccount Orbipay.PaymentsApi.Client.Wrappers.PaymentAuthorization.CustomerAccount

CustomerAccount

Dictionary<string, string> Orbipay.PaymentsApi.Client.Wrappers.PaymentAuthorization.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. Only the custom fields enabled for the client, in EBPP, would be accepted in the requests.

string Orbipay.PaymentsApi.Client.Wrappers.PaymentAuthorization.EntryTime

The date on which the payment authorization created in UTC timestamp, with ISO8601 format. For e.g., 2019-08-13T09:21:34.359+0000.

FundingAccount Orbipay.PaymentsApi.Client.Wrappers.PaymentAuthorization.FundingAccount

FundingAccount

string Orbipay.PaymentsApi.Client.Wrappers.PaymentAuthorization.Id

The unique identifier assigned by EBPP to the payment authorization.

string Orbipay.PaymentsApi.Client.Wrappers.PaymentAuthorization.ID_AUTHORIZATION

The unique identifier assigned by EBPP to the payment authorization.

string Orbipay.PaymentsApi.Client.Wrappers.PaymentAuthorization.ID_CUSTOMER

The unique identifier assigned by EBPP to the customer.

string Orbipay.PaymentsApi.Client.Wrappers.PaymentAuthorization.PaymentAuthReference

The unique identifier in the client system for the payment.

string Orbipay.PaymentsApi.Client.Wrappers.PaymentAuthorization.PaymentMethod

The fulfillment method for the payment authorization.

PaymentNetworkResponse Orbipay.PaymentsApi.Client.Wrappers.PaymentAuthorization.PaymentNetworkResponse

PaymentNetworkResponse

string Orbipay.PaymentsApi.Client.Wrappers.PaymentAuthorization.Status

The status of the payment.

string Orbipay.PaymentsApi.Client.Wrappers.PaymentAuthorization.Url

This URL fetches the details of payment authorization.

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

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

Public Member Functions

Public Attributes

Additional Inherited Members

Constructor & Destructor Documentation

Member Function Documentation

Member Data Documentation