My Project
 All Classes Namespaces Files Functions Variables Typedefs Properties Pages
Orbipay.PaymentsApi.Client.Api.IPaymentAuthorizationApi Interface Reference

More...

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

Public Member Functions

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 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 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 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 More...
 
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 More...
 
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 More...
 
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 More...
 
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 More...
 
- Public Member Functions inherited from Orbipay.PaymentsApi.Client.Client.IApiAccessor
String GetBasePath ()
 Gets the base path of the API client. More...
 

Additional Inherited Members

- 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

This class subject to change without prior notice, Please dont use this class directly.

Member Function Documentation

ApiResponse<Object> Orbipay.PaymentsApi.Client.Api.IPaymentAuthorizationApi.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.ApiExceptionThrown when fails to make API call
Parameters
channelThe channel through which the API is invoked.
clientKeyThe unique identifier assigned by EBPP to the client.
productThe product identifier corresponding to the API.
timestampThe timestamp for the moment when the API request is created.
idempotentRequestKeyThe unique token that clients can generate and maintain in order to identify an API request.
requestorTypeType of the requestor of the API.
ID_CUSTOMERThe unique identifier assigned by EBPP to the customer.
ID_AUTHORIZATIONThe unique identifier assigned by EBPP to the payment authorization.
cancelPaymentAuthorizationRequestDetails of payment authorization to be cancelled
requestorThe identifier for the requestor of the API. (optional)
xOPAYHeadersIntended for the future use. (optional)
traceIdThe unique reference that can be used for tracing and debugging an API call. (optional)
Returns

Implemented in Orbipay.PaymentsApi.Client.Api.PaymentAuthorizationApi.

System.Threading.Tasks.Task Orbipay.PaymentsApi.Client.Api.IPaymentAuthorizationApi.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.ApiExceptionThrown when fails to make API call
Parameters
channelThe channel through which the API is invoked.
clientKeyThe unique identifier assigned by EBPP to the client.
productThe product identifier corresponding to the API.
timestampThe timestamp for the moment when the API request is created.
idempotentRequestKeyThe unique token that clients can generate and maintain in order to identify an API request.
requestorTypeType of the requestor of the API.
ID_CUSTOMERThe unique identifier assigned by EBPP to the customer.
ID_AUTHORIZATIONThe unique identifier assigned by EBPP to the payment authorization.
cancelPaymentAuthorizationRequestDetails of payment authorization to be cancelled
requestorThe identifier for the requestor of the API. (optional)
xOPAYHeadersIntended for the future use. (optional)
traceIdThe unique reference that can be used for tracing and debugging an API call. (optional)
Returns
Task of void

Implemented in Orbipay.PaymentsApi.Client.Api.PaymentAuthorizationApi.

System.Threading.Tasks.Task<ApiResponse<Object> > Orbipay.PaymentsApi.Client.Api.IPaymentAuthorizationApi.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.ApiExceptionThrown when fails to make API call
Parameters
channelThe channel through which the API is invoked.
clientKeyThe unique identifier assigned by EBPP to the client.
productThe product identifier corresponding to the API.
timestampThe timestamp for the moment when the API request is created.
idempotentRequestKeyThe unique token that clients can generate and maintain in order to identify an API request.
requestorTypeType of the requestor of the API.
ID_CUSTOMERThe unique identifier assigned by EBPP to the customer.
ID_AUTHORIZATIONThe unique identifier assigned by EBPP to the payment authorization.
cancelPaymentAuthorizationRequestDetails of payment authorization to be cancelled
requestorThe identifier for the requestor of the API. (optional)
xOPAYHeadersIntended for the future use. (optional)
traceIdThe unique reference that can be used for tracing and debugging an API call. (optional)
Returns
Task of ApiResponse

Implemented in Orbipay.PaymentsApi.Client.Api.PaymentAuthorizationApi.

ApiResponse<Object> Orbipay.PaymentsApi.Client.Api.IPaymentAuthorizationApi.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.ApiExceptionThrown when fails to make API call
Parameters
channelThe channel through which the API is invoked.
clientKeyThe unique identifier assigned by EBPP to the client.
productThe product identifier corresponding to the API.
timestampThe timestamp for the moment when the API request is created.
idempotentRequestKeyThe unique token that clients can generate and maintain in order to identify an API request.
requestorTypeType of the requestor of the API.
ID_CUSTOMERThe unique identifier assigned by EBPP to the customer.
ID_AUTHORIZATIONThe unique identifier assigned by EBPP to the payment authorization.
cancelPaymentAuthorizationRequestDetails of payment authorization to be cancelled
requestorThe identifier for the requestor of the API. (optional)
xOPAYHeadersIntended for the future use. (optional)
traceIdThe unique reference that can be used for tracing and debugging an API call. (optional)
Returns
ApiResponse of Object(void)

Implemented in Orbipay.PaymentsApi.Client.Api.PaymentAuthorizationApi.

ApiResponse<PaymentAuthorizationResponse> Orbipay.PaymentsApi.Client.Api.IPaymentAuthorizationApi.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.ApiExceptionThrown when fails to make API call
Parameters
channelThe channel through which the API is invoked.
clientKeyThe unique identifier assigned by EBPP to the client.
productThe product identifier corresponding to the API.
timestampThe timestamp for the moment when the API request is created.
idempotentRequestKeyThe unique token that clients can generate and maintain in order to identify an API request.
requestorTypeType of the requestor of the API.
createPaymentAuthorizationRequestJSON containing all the fields required to make a payment.
requestorThe identifier for the requestor of the API. (optional)
xOPAYHeadersIntended for the future use. (optional)
traceIdThe unique reference that can be used for tracing and debugging an API call. (optional)
Returns
ApiResponse<PaymentAuthorizationResponse>

Implemented in Orbipay.PaymentsApi.Client.Api.PaymentAuthorizationApi.

System.Threading.Tasks.Task<PaymentAuthorizationResponse> Orbipay.PaymentsApi.Client.Api.IPaymentAuthorizationApi.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.ApiExceptionThrown when fails to make API call
Parameters
channelThe channel through which the API is invoked.
clientKeyThe unique identifier assigned by EBPP to the client.
productThe product identifier corresponding to the API.
timestampThe timestamp for the moment when the API request is created.
idempotentRequestKeyThe unique token that clients can generate and maintain in order to identify an API request.
requestorTypeType of the requestor of the API.
createPaymentAuthorizationRequestJSON containing all the fields required to make a payment.
requestorThe identifier for the requestor of the API. (optional)
xOPAYHeadersIntended for the future use. (optional)
traceIdThe unique reference that can be used for tracing and debugging an API call. (optional)
Returns
Task of PaymentAuthorizationResponse

Implemented in Orbipay.PaymentsApi.Client.Api.PaymentAuthorizationApi.

System.Threading.Tasks.Task<ApiResponse<PaymentAuthorizationResponse> > Orbipay.PaymentsApi.Client.Api.IPaymentAuthorizationApi.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.ApiExceptionThrown when fails to make API call
Parameters
channelThe channel through which the API is invoked.
clientKeyThe unique identifier assigned by EBPP to the client.
productThe product identifier corresponding to the API.
timestampThe timestamp for the moment when the API request is created.
idempotentRequestKeyThe unique token that clients can generate and maintain in order to identify an API request.
requestorTypeType of the requestor of the API.
createPaymentAuthorizationRequestJSON containing all the fields required to make a payment.
requestorThe identifier for the requestor of the API. (optional)
xOPAYHeadersIntended for the future use. (optional)
traceIdThe unique reference that can be used for tracing and debugging an API call. (optional)
Returns
Task of ApiResponse (PaymentAuthorizationResponse)

Implemented in Orbipay.PaymentsApi.Client.Api.PaymentAuthorizationApi.

ApiResponse<PaymentAuthorizationResponse> Orbipay.PaymentsApi.Client.Api.IPaymentAuthorizationApi.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.ApiExceptionThrown when fails to make API call
Parameters
channelThe channel through which the API is invoked.
clientKeyThe unique identifier assigned by EBPP to the client.
productThe product identifier corresponding to the API.
timestampThe timestamp for the moment when the API request is created.
idempotentRequestKeyThe unique token that clients can generate and maintain in order to identify an API request.
requestorTypeType of the requestor of the API.
createPaymentAuthorizationRequestJSON containing all the fields required to make a payment.
requestorThe identifier for the requestor of the API. (optional)
xOPAYHeadersIntended for the future use. (optional)
traceIdThe unique reference that can be used for tracing and debugging an API call. (optional)
Returns
ApiResponse of PaymentAuthorizationResponse

Implemented in Orbipay.PaymentsApi.Client.Api.PaymentAuthorizationApi.


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