Represents a collection of functions to interact with the API endpoints More...

Inheritance diagram for Orbipay.PaymentsApi.Client.Api.PaymentAuthorizationApi:

Public Member Functions
	PaymentAuthorizationApi (String basePath)
	Initializes a new instance of the PaymentAuthorizationApi class. More...

	PaymentAuthorizationApi (Orbipay.PaymentsApi.Client.Client.Configuration configuration=null)
	Initializes a new instance of the PaymentAuthorizationApi class using Configuration object More...

String	GetBasePath ()
	Gets the base path of the API client. More...

void	SetBasePath (String basePath)
	Sets the base path of the API client. More...

IDictionary< String, String >	DefaultHeader ()
	Gets the default header. More...

void	AddDefaultHeader (string key, string value)
	Add default header. More...

ApiResponse< Object >	CancelPaymentAuthorization (string channel, string clientKey, string product, string timestamp, string idempotentRequestKey, string requestorType, string ID_CUSTOMER, string ID_AUTHORIZATION, CancelPaymentAuthorizationRequest cancelPaymentAuthorizationRequest, string requestor=null, string xOPAYHeaders=null, string traceId=null)
	Cancel Payment Authorization The API is used to cancel a payment authorization. Payment Authorizations that are already been processed into Payment cannot be cancelled. It returns 204 http status code with empty body in successful case. More...

ApiResponse< Object >	CancelPaymentAuthorizationWithHttpInfo (string channel, string clientKey, string product, string timestamp, string idempotentRequestKey, string requestorType, string ID_CUSTOMER, string ID_AUTHORIZATION, CancelPaymentAuthorizationRequest cancelPaymentAuthorizationRequest, string requestor=null, string xOPAYHeaders=null, string traceId=null)
	Cancel Payment Authorization The API is used to cancel a payment authorization. Payment Authorizations that are already been processed into Payment cannot be cancelled. It returns 204 http status code with empty body in successful case. More...

async System.Threading.Tasks.Task	CancelPaymentAuthorizationAsync (string channel, string clientKey, string product, string timestamp, string idempotentRequestKey, string requestorType, string ID_CUSTOMER, string ID_AUTHORIZATION, CancelPaymentAuthorizationRequest cancelPaymentAuthorizationRequest, string requestor=null, string xOPAYHeaders=null, string traceId=null)
	Cancel Payment Authorization The API is used to cancel a payment authorization. Payment Authorizations that are already been processed into Payment cannot be cancelled. It returns 204 http status code with empty body in successful case. More...

async System.Threading.Tasks.Task < ApiResponse< Object > >	CancelPaymentAuthorizationAsyncWithHttpInfo (string channel, string clientKey, string product, string timestamp, string idempotentRequestKey, string requestorType, string ID_CUSTOMER, string ID_AUTHORIZATION, CancelPaymentAuthorizationRequest cancelPaymentAuthorizationRequest, string requestor=null, string xOPAYHeaders=null, string traceId=null)
	Cancel Payment Authorization The API is used to cancel a payment authorization. Payment Authorizations that are already been processed into Payment cannot be cancelled. It returns 204 http status code with empty body in successful case. More...

ApiResponse < PaymentAuthorizationResponse >	CreatePaymentAuthorization (string channel, string clientKey, string product, string timestamp, string idempotentRequestKey, string requestorType, CreatePaymentAuthorizationRequest createPaymentAuthorizationRequest, string requestor=null, string xOPAYHeaders=null, string traceId=null)
	Create Payment Authorization The API is used to create a payment authorization with certain amount on a given card account. Client systems can provide the unique identifier for the payment authorization in their system as payment_auth_reference. As of now this API is supported only for voyager fleet card payments More...

ApiResponse < PaymentAuthorizationResponse >	CreatePaymentAuthorizationWithHttpInfo (string channel, string clientKey, string product, string timestamp, string idempotentRequestKey, string requestorType, CreatePaymentAuthorizationRequest createPaymentAuthorizationRequest, string requestor=null, string xOPAYHeaders=null, string traceId=null)
	Create Payment Authorization The API is used to create a payment authorization with certain amount on a given card account. Client systems can provide the unique identifier for the payment authorization in their system as payment_auth_reference. As of now this API is supported only for voyager fleet card payments More...

async System.Threading.Tasks.Task < PaymentAuthorizationResponse >	CreatePaymentAuthorizationAsync (string channel, string clientKey, string product, string timestamp, string idempotentRequestKey, string requestorType, CreatePaymentAuthorizationRequest createPaymentAuthorizationRequest, string requestor=null, string xOPAYHeaders=null, string traceId=null)
	Create Payment Authorization The API is used to create a payment authorization with certain amount on a given card account. Client systems can provide the unique identifier for the payment authorization in their system as payment_auth_reference. As of now this API is supported only for voyager fleet card payments More...

async System.Threading.Tasks.Task < ApiResponse < PaymentAuthorizationResponse > >	CreatePaymentAuthorizationAsyncWithHttpInfo (string channel, string clientKey, string product, string timestamp, string idempotentRequestKey, string requestorType, CreatePaymentAuthorizationRequest createPaymentAuthorizationRequest, string requestor=null, string xOPAYHeaders=null, string traceId=null)
	Create Payment Authorization The API is used to create a payment authorization with certain amount on a given card account. Client systems can provide the unique identifier for the payment authorization in their system as payment_auth_reference. As of now this API is supported only for voyager fleet card payments More...

Properties
Orbipay.PaymentsApi.Client.Client.Configuration	Configuration `[get, set]`
	Gets or sets the configuration object More...

Orbipay.PaymentsApi.Client.Client.ExceptionFactory	ExceptionFactory `[get, set]`
	Provides a factory method hook for the creation of exceptions. More...

Properties inherited from Orbipay.PaymentsApi.Client.Client.IApiAccessor
Configuration	Configuration `[get, set]`
	Gets or sets the configuration object More...

ExceptionFactory	ExceptionFactory `[get, set]`
	Provides a factory method hook for the creation of exceptions. More...

Detailed Description

Represents a collection of functions to interact with the API endpoints

Constructor & Destructor Documentation

Orbipay.PaymentsApi.Client.Api.PaymentAuthorizationApi.PaymentAuthorizationApi ( String basePath )

Initializes a new instance of the PaymentAuthorizationApi class.

Returns

Orbipay.PaymentsApi.Client.Api.PaymentAuthorizationApi.PaymentAuthorizationApi ( Orbipay.PaymentsApi.Client.Client.Configuration configuration = null )

Initializes a new instance of the PaymentAuthorizationApi class using Configuration object

Parameters

configuration An instance of Configuration

Returns

Member Function Documentation

void Orbipay.PaymentsApi.Client.Api.PaymentAuthorizationApi.AddDefaultHeader	(	string	key,
		string	value
	)

Add default header.

Parameters

key	Header field name.
value	Header field value.

Returns

ApiResponse<Object> Orbipay.PaymentsApi.Client.Api.PaymentAuthorizationApi.CancelPaymentAuthorization	(	string	channel,
		string	clientKey,
		string	product,
		string	timestamp,
		string	idempotentRequestKey,
		string	requestorType,
		string	ID_CUSTOMER,
		string	ID_AUTHORIZATION,
		CancelPaymentAuthorizationRequest	cancelPaymentAuthorizationRequest,
		string	requestor = `null`,
		string	xOPAYHeaders = `null`,
		string	traceId = `null`
	)

Cancel Payment Authorization The API is used to cancel a payment authorization. Payment Authorizations that are already been processed into Payment cannot be cancelled. It returns 204 http status code with empty body in successful case.

Exceptions

Orbipay.PaymentsApi.Client.Client.ApiException Thrown when fails to make API call

Parameters

channel	The channel through which the API is invoked.
clientKey	The unique identifier assigned by EBPP to the client.
product	The product identifier corresponding to the API.
timestamp	The timestamp for the moment when the API request is created.
idempotentRequestKey	The unique token that clients can generate and maintain in order to identify an API request.
requestorType	Type of the requestor of the API.
ID_CUSTOMER	The unique identifier assigned by EBPP to the customer.
ID_AUTHORIZATION	The unique identifier assigned by EBPP to the payment authorization.
cancelPaymentAuthorizationRequest	Details of payment authorization to be cancelled
requestor	The identifier for the requestor of the API. (optional)
xOPAYHeaders	Intended for the future use. (optional)
traceId	The unique reference that can be used for tracing and debugging an API call. (optional)

Returns

Implements Orbipay.PaymentsApi.Client.Api.IPaymentAuthorizationApi.

async System.Threading.Tasks.Task Orbipay.PaymentsApi.Client.Api.PaymentAuthorizationApi.CancelPaymentAuthorizationAsync	(	string	channel,
		string	clientKey,
		string	product,
		string	timestamp,
		string	idempotentRequestKey,
		string	requestorType,
		string	ID_CUSTOMER,
		string	ID_AUTHORIZATION,
		CancelPaymentAuthorizationRequest	cancelPaymentAuthorizationRequest,
		string	requestor = `null`,
		string	xOPAYHeaders = `null`,
		string	traceId = `null`
	)

Cancel Payment Authorization The API is used to cancel a payment authorization. Payment Authorizations that are already been processed into Payment cannot be cancelled. It returns 204 http status code with empty body in successful case.

Exceptions

Orbipay.PaymentsApi.Client.Client.ApiException Thrown when fails to make API call

Parameters

channel	The channel through which the API is invoked.
clientKey	The unique identifier assigned by EBPP to the client.
product	The product identifier corresponding to the API.
timestamp	The timestamp for the moment when the API request is created.
idempotentRequestKey	The unique token that clients can generate and maintain in order to identify an API request.
requestorType	Type of the requestor of the API.
ID_CUSTOMER	The unique identifier assigned by EBPP to the customer.
ID_AUTHORIZATION	The unique identifier assigned by EBPP to the payment authorization.
cancelPaymentAuthorizationRequest	Details of payment authorization to be cancelled
requestor	The identifier for the requestor of the API. (optional)
xOPAYHeaders	Intended for the future use. (optional)
traceId	The unique reference that can be used for tracing and debugging an API call. (optional)

Returns: Task of void

Implements Orbipay.PaymentsApi.Client.Api.IPaymentAuthorizationApi.

async System.Threading.Tasks.Task<ApiResponse<Object> > Orbipay.PaymentsApi.Client.Api.PaymentAuthorizationApi.CancelPaymentAuthorizationAsyncWithHttpInfo	(	string	channel,
		string	clientKey,
		string	product,
		string	timestamp,
		string	idempotentRequestKey,
		string	requestorType,
		string	ID_CUSTOMER,
		string	ID_AUTHORIZATION,
		CancelPaymentAuthorizationRequest	cancelPaymentAuthorizationRequest,
		string	requestor = `null`,
		string	xOPAYHeaders = `null`,
		string	traceId = `null`
	)

Cancel Payment Authorization The API is used to cancel a payment authorization. Payment Authorizations that are already been processed into Payment cannot be cancelled. It returns 204 http status code with empty body in successful case.

Exceptions

Orbipay.PaymentsApi.Client.Client.ApiException Thrown when fails to make API call

Parameters

channel	The channel through which the API is invoked.
clientKey	The unique identifier assigned by EBPP to the client.
product	The product identifier corresponding to the API.
timestamp	The timestamp for the moment when the API request is created.
idempotentRequestKey	The unique token that clients can generate and maintain in order to identify an API request.
requestorType	Type of the requestor of the API.
ID_CUSTOMER	The unique identifier assigned by EBPP to the customer.
ID_AUTHORIZATION	The unique identifier assigned by EBPP to the payment authorization.
cancelPaymentAuthorizationRequest	Details of payment authorization to be cancelled
requestor	The identifier for the requestor of the API. (optional)
xOPAYHeaders	Intended for the future use. (optional)
traceId	The unique reference that can be used for tracing and debugging an API call. (optional)

Returns: Task of ApiResponse

Implements Orbipay.PaymentsApi.Client.Api.IPaymentAuthorizationApi.

ApiResponse<Object> Orbipay.PaymentsApi.Client.Api.PaymentAuthorizationApi.CancelPaymentAuthorizationWithHttpInfo	(	string	channel,
		string	clientKey,
		string	product,
		string	timestamp,
		string	idempotentRequestKey,
		string	requestorType,
		string	ID_CUSTOMER,
		string	ID_AUTHORIZATION,
		CancelPaymentAuthorizationRequest	cancelPaymentAuthorizationRequest,
		string	requestor = `null`,
		string	xOPAYHeaders = `null`,
		string	traceId = `null`
	)

Cancel Payment Authorization The API is used to cancel a payment authorization. Payment Authorizations that are already been processed into Payment cannot be cancelled. It returns 204 http status code with empty body in successful case.

Exceptions

Orbipay.PaymentsApi.Client.Client.ApiException Thrown when fails to make API call

Parameters

channel	The channel through which the API is invoked.
clientKey	The unique identifier assigned by EBPP to the client.
product	The product identifier corresponding to the API.
timestamp	The timestamp for the moment when the API request is created.
idempotentRequestKey	The unique token that clients can generate and maintain in order to identify an API request.
requestorType	Type of the requestor of the API.
ID_CUSTOMER	The unique identifier assigned by EBPP to the customer.
ID_AUTHORIZATION	The unique identifier assigned by EBPP to the payment authorization.
cancelPaymentAuthorizationRequest	Details of payment authorization to be cancelled
requestor	The identifier for the requestor of the API. (optional)
xOPAYHeaders	Intended for the future use. (optional)
traceId	The unique reference that can be used for tracing and debugging an API call. (optional)

Returns: ApiResponse of Object(void)

Implements Orbipay.PaymentsApi.Client.Api.IPaymentAuthorizationApi.

ApiResponse<PaymentAuthorizationResponse> Orbipay.PaymentsApi.Client.Api.PaymentAuthorizationApi.CreatePaymentAuthorization	(	string	channel,
		string	clientKey,
		string	product,
		string	timestamp,
		string	idempotentRequestKey,
		string	requestorType,
		CreatePaymentAuthorizationRequest	createPaymentAuthorizationRequest,
		string	requestor = `null`,
		string	xOPAYHeaders = `null`,
		string	traceId = `null`
	)

Create Payment Authorization The API is used to create a payment authorization with certain amount on a given card account. Client systems can provide the unique identifier for the payment authorization in their system as payment_auth_reference. As of now this API is supported only for voyager fleet card payments

Exceptions

Orbipay.PaymentsApi.Client.Client.ApiException Thrown when fails to make API call

Parameters

channel	The channel through which the API is invoked.
clientKey	The unique identifier assigned by EBPP to the client.
product	The product identifier corresponding to the API.
timestamp	The timestamp for the moment when the API request is created.
idempotentRequestKey	The unique token that clients can generate and maintain in order to identify an API request.
requestorType	Type of the requestor of the API.
createPaymentAuthorizationRequest	JSON containing all the fields required to make a payment.
requestor	The identifier for the requestor of the API. (optional)
xOPAYHeaders	Intended for the future use. (optional)
traceId	The unique reference that can be used for tracing and debugging an API call. (optional)

Returns: PaymentAuthorizationResponse

Implements Orbipay.PaymentsApi.Client.Api.IPaymentAuthorizationApi.

async System.Threading.Tasks.Task<PaymentAuthorizationResponse> Orbipay.PaymentsApi.Client.Api.PaymentAuthorizationApi.CreatePaymentAuthorizationAsync	(	string	channel,
		string	clientKey,
		string	product,
		string	timestamp,
		string	idempotentRequestKey,
		string	requestorType,
		CreatePaymentAuthorizationRequest	createPaymentAuthorizationRequest,
		string	requestor = `null`,
		string	xOPAYHeaders = `null`,
		string	traceId = `null`
	)

Create Payment Authorization The API is used to create a payment authorization with certain amount on a given card account. Client systems can provide the unique identifier for the payment authorization in their system as payment_auth_reference. As of now this API is supported only for voyager fleet card payments

Exceptions

Orbipay.PaymentsApi.Client.Client.ApiException Thrown when fails to make API call

Parameters

channel	The channel through which the API is invoked.
clientKey	The unique identifier assigned by EBPP to the client.
product	The product identifier corresponding to the API.
timestamp	The timestamp for the moment when the API request is created.
idempotentRequestKey	The unique token that clients can generate and maintain in order to identify an API request.
requestorType	Type of the requestor of the API.
createPaymentAuthorizationRequest	JSON containing all the fields required to make a payment.
requestor	The identifier for the requestor of the API. (optional)
xOPAYHeaders	Intended for the future use. (optional)
traceId	The unique reference that can be used for tracing and debugging an API call. (optional)

Returns: Task of PaymentAuthorizationResponse

Implements Orbipay.PaymentsApi.Client.Api.IPaymentAuthorizationApi.

async System.Threading.Tasks.Task<ApiResponse<PaymentAuthorizationResponse> > Orbipay.PaymentsApi.Client.Api.PaymentAuthorizationApi.CreatePaymentAuthorizationAsyncWithHttpInfo	(	string	channel,
		string	clientKey,
		string	product,
		string	timestamp,
		string	idempotentRequestKey,
		string	requestorType,
		CreatePaymentAuthorizationRequest	createPaymentAuthorizationRequest,
		string	requestor = `null`,
		string	xOPAYHeaders = `null`,
		string	traceId = `null`
	)

Create Payment Authorization The API is used to create a payment authorization with certain amount on a given card account. Client systems can provide the unique identifier for the payment authorization in their system as payment_auth_reference. As of now this API is supported only for voyager fleet card payments

Exceptions

Orbipay.PaymentsApi.Client.Client.ApiException Thrown when fails to make API call

Parameters

channel	The channel through which the API is invoked.
clientKey	The unique identifier assigned by EBPP to the client.
product	The product identifier corresponding to the API.
timestamp	The timestamp for the moment when the API request is created.
idempotentRequestKey	The unique token that clients can generate and maintain in order to identify an API request.
requestorType	Type of the requestor of the API.
createPaymentAuthorizationRequest	JSON containing all the fields required to make a payment.
requestor	The identifier for the requestor of the API. (optional)
xOPAYHeaders	Intended for the future use. (optional)
traceId	The unique reference that can be used for tracing and debugging an API call. (optional)

Returns: Task of ApiResponse (PaymentAuthorizationResponse)

Implements Orbipay.PaymentsApi.Client.Api.IPaymentAuthorizationApi.

ApiResponse< PaymentAuthorizationResponse > Orbipay.PaymentsApi.Client.Api.PaymentAuthorizationApi.CreatePaymentAuthorizationWithHttpInfo	(	string	channel,
		string	clientKey,
		string	product,
		string	timestamp,
		string	idempotentRequestKey,
		string	requestorType,
		CreatePaymentAuthorizationRequest	createPaymentAuthorizationRequest,
		string	requestor = `null`,
		string	xOPAYHeaders = `null`,
		string	traceId = `null`
	)

Create Payment Authorization The API is used to create a payment authorization with certain amount on a given card account. Client systems can provide the unique identifier for the payment authorization in their system as payment_auth_reference. As of now this API is supported only for voyager fleet card payments

Exceptions

Orbipay.PaymentsApi.Client.Client.ApiException Thrown when fails to make API call

Parameters

channel	The channel through which the API is invoked.
clientKey	The unique identifier assigned by EBPP to the client.
product	The product identifier corresponding to the API.
timestamp	The timestamp for the moment when the API request is created.
idempotentRequestKey	The unique token that clients can generate and maintain in order to identify an API request.
requestorType	Type of the requestor of the API.
createPaymentAuthorizationRequest	JSON containing all the fields required to make a payment.
requestor	The identifier for the requestor of the API. (optional)
xOPAYHeaders	Intended for the future use. (optional)
traceId	The unique reference that can be used for tracing and debugging an API call. (optional)

Returns: ApiResponse of PaymentAuthorizationResponse

Implements Orbipay.PaymentsApi.Client.Api.IPaymentAuthorizationApi.

IDictionary<String, String> Orbipay.PaymentsApi.Client.Api.PaymentAuthorizationApi.DefaultHeader ( )

Gets the default header.

Returns: Dictionary of HTTP header

String Orbipay.PaymentsApi.Client.Api.PaymentAuthorizationApi.GetBasePath ( )

Gets the base path of the API client.

The base path

Implements Orbipay.PaymentsApi.Client.Client.IApiAccessor.

void Orbipay.PaymentsApi.Client.Api.PaymentAuthorizationApi.SetBasePath ( String basePath )

Sets the base path of the API client.

The base path

Property Documentation

Orbipay.PaymentsApi.Client.Client.Configuration Orbipay.PaymentsApi.Client.Api.PaymentAuthorizationApi.Configuration

getset

Gets or sets the configuration object

An instance of the Configuration

Orbipay.PaymentsApi.Client.Client.ExceptionFactory Orbipay.PaymentsApi.Client.Api.PaymentAuthorizationApi.ExceptionFactory

getset

Provides a factory method hook for the creation of exceptions.

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

src/Orbipay.PaymentsApi.Client/Api/PaymentAuthorizationApi.cs

Public Member Functions

Properties

Detailed Description

Constructor & Destructor Documentation

Member Function Documentation

Property Documentation