java.lang.Object
- com.orbipay.paymentsapi.internal.api.PaymentAuthorizationApi

```
public class PaymentAuthorizationApi
extends java.lang.Object
```
This class subject to change without prior notice, Please dont use this class directly.

Constructor Summary

Constructors
Constructor Description

PaymentAuthorizationApi(ApiClient apiClient)

Method Summary

All Methods Instance Methods Concrete Methods
Modifier and Type	Method	Description
`ApiResponse<java.lang.Void>`	`cancelPaymentAuthorization(java.lang.String channel, java.lang.String clientKey, java.lang.String product, java.lang.String timestamp, java.lang.String idempotentRequestKey, java.lang.String requestorType, java.lang.String ID_CUSTOMER, java.lang.String ID_AUTHORIZATION, CancelPaymentAuthorizationRequest cancelPaymentAuthorizationRequest, java.lang.String requestor, java.lang.String xOPAYHeaders, java.lang.String traceId)`	Cancel Payment Authorization The API is used to cancel a payment authorization.
`com.squareup.okhttp.Call`	`cancelPaymentAuthorizationAsync(java.lang.String channel, java.lang.String clientKey, java.lang.String product, java.lang.String timestamp, java.lang.String idempotentRequestKey, java.lang.String requestorType, java.lang.String ID_CUSTOMER, java.lang.String ID_AUTHORIZATION, CancelPaymentAuthorizationRequest cancelPaymentAuthorizationRequest, java.lang.String requestor, java.lang.String xOPAYHeaders, java.lang.String traceId, ApiCallback<java.lang.Void> callback)`	Cancel Payment Authorization (asynchronously) The API is used to cancel a payment authorization.
`com.squareup.okhttp.Call`	cancelPaymentAuthorizationCall(java.lang.String channel, java.lang.String clientKey, java.lang.String product, java.lang.String timestamp, java.lang.String idempotentRequestKey, java.lang.String requestorType, java.lang.String ID_CUSTOMER, java.lang.String ID_AUTHORIZATION, CancelPaymentAuthorizationRequest cancelPaymentAuthorizationRequest, java.lang.String requestor, java.lang.String xOPAYHeaders, java.lang.String traceId, ProgressResponseBody.ProgressListener progressListener, ProgressRequestBody.ProgressRequestListener progressRequestListener)	Build call for cancelPaymentAuthorization
`ApiResponse<java.lang.Void>`	`cancelPaymentAuthorizationWithHttpInfo(java.lang.String channel, java.lang.String clientKey, java.lang.String product, java.lang.String timestamp, java.lang.String idempotentRequestKey, java.lang.String requestorType, java.lang.String ID_CUSTOMER, java.lang.String ID_AUTHORIZATION, CancelPaymentAuthorizationRequest cancelPaymentAuthorizationRequest, java.lang.String requestor, java.lang.String xOPAYHeaders, java.lang.String traceId)`	Cancel Payment Authorization The API is used to cancel a payment authorization.
`ApiResponse<PaymentAuthorizationResponse>`	`createPaymentAuthorization(java.lang.String channel, java.lang.String clientKey, java.lang.String product, java.lang.String timestamp, java.lang.String idempotentRequestKey, java.lang.String requestorType, CreatePaymentAuthorizationRequest createPaymentAuthorizationRequest, java.lang.String requestor, java.lang.String xOPAYHeaders, java.lang.String traceId)`	Create Payment Authorization The API is used to create a payment authorization with certain amount on a given card account.
`com.squareup.okhttp.Call`	`createPaymentAuthorizationAsync(java.lang.String channel, java.lang.String clientKey, java.lang.String product, java.lang.String timestamp, java.lang.String idempotentRequestKey, java.lang.String requestorType, CreatePaymentAuthorizationRequest createPaymentAuthorizationRequest, java.lang.String requestor, java.lang.String xOPAYHeaders, java.lang.String traceId, ApiCallback<PaymentAuthorizationResponse> callback)`	Create Payment Authorization (asynchronously) The API is used to create a payment authorization with certain amount on a given card account.
`com.squareup.okhttp.Call`	`createPaymentAuthorizationCall(java.lang.String channel, java.lang.String clientKey, java.lang.String product, java.lang.String timestamp, java.lang.String idempotentRequestKey, java.lang.String requestorType, CreatePaymentAuthorizationRequest createPaymentAuthorizationRequest, java.lang.String requestor, java.lang.String xOPAYHeaders, java.lang.String traceId, ProgressResponseBody.ProgressListener progressListener, ProgressRequestBody.ProgressRequestListener progressRequestListener)`	Build call for createPaymentAuthorization
`ApiResponse<PaymentAuthorizationResponse>`	`createPaymentAuthorizationWithHttpInfo(java.lang.String channel, java.lang.String clientKey, java.lang.String product, java.lang.String timestamp, java.lang.String idempotentRequestKey, java.lang.String requestorType, CreatePaymentAuthorizationRequest createPaymentAuthorizationRequest, java.lang.String requestor, java.lang.String xOPAYHeaders, java.lang.String traceId)`	Create Payment Authorization The API is used to create a payment authorization with certain amount on a given card account.
`ApiClient`	`getApiClient()`
`void`	`setApiClient(ApiClient apiClient)`

Methods inherited from class java.lang.Object
clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait

Constructor Detail

PaymentAuthorizationApi

public PaymentAuthorizationApi(ApiClient apiClient)

Method Detail

getApiClient
```
public ApiClient getApiClient()
```

setApiClient

public void setApiClient(ApiClient apiClient)

cancelPaymentAuthorizationCall

public com.squareup.okhttp.Call cancelPaymentAuthorizationCall(java.lang.String channel,
                                                               java.lang.String clientKey,
                                                               java.lang.String product,
                                                               java.lang.String timestamp,
                                                               java.lang.String idempotentRequestKey,
                                                               java.lang.String requestorType,
                                                               java.lang.String ID_CUSTOMER,
                                                               java.lang.String ID_AUTHORIZATION,
                                                               CancelPaymentAuthorizationRequest cancelPaymentAuthorizationRequest,
                                                               java.lang.String requestor,
                                                               java.lang.String xOPAYHeaders,
                                                               java.lang.String traceId,
                                                               ProgressResponseBody.ProgressListener progressListener,
                                                               ProgressRequestBody.ProgressRequestListener progressRequestListener)
                                                        throws ApiException

Build call for cancelPaymentAuthorization

Parameters:: channel - The channel through which the API is invoked. (required); clientKey - The unique identifier assigned by EBPP to the client. (required); product - The product identifier corresponding to the API. (required); timestamp - The timestamp for the moment when the API request is created. (required); idempotentRequestKey - The unique token that clients can generate and maintain in order to identify an API request. (required); requestorType - Type of the requestor of the API. (required); ID_CUSTOMER - The unique identifier assigned by EBPP to the customer. (required); ID_AUTHORIZATION - The unique identifier assigned by EBPP to the payment authorization. (required); cancelPaymentAuthorizationRequest - Details of payment authorization to be cancelled (required); 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); progressListener - Progress listener; progressRequestListener - Progress request listener
Returns:: Call to execute
Throws:: ApiException - If fail to serialize the request body object

cancelPaymentAuthorization
```
public ApiResponse<java.lang.Void> cancelPaymentAuthorization(java.lang.String channel,
                                                              java.lang.String clientKey,
                                                              java.lang.String product,
                                                              java.lang.String timestamp,
                                                              java.lang.String idempotentRequestKey,
                                                              java.lang.String requestorType,
                                                              java.lang.String ID_CUSTOMER,
                                                              java.lang.String ID_AUTHORIZATION,
                                                              CancelPaymentAuthorizationRequest cancelPaymentAuthorizationRequest,
                                                              java.lang.String requestor,
                                                              java.lang.String xOPAYHeaders,
                                                              java.lang.String traceId)
                                                       throws ApiException
```
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.

Parameters:

channel - The channel through which the API is invoked. (required)

clientKey - The unique identifier assigned by EBPP to the client. (required)

product - The product identifier corresponding to the API. (required)

timestamp - The timestamp for the moment when the API request is created. (required)

idempotentRequestKey - The unique token that clients can generate and maintain in order to identify an API request. (required)

requestorType - Type of the requestor of the API. (required)

ID_CUSTOMER - The unique identifier assigned by EBPP to the customer. (required)

ID_AUTHORIZATION - The unique identifier assigned by EBPP to the payment authorization. (required)

cancelPaymentAuthorizationRequest - Details of payment authorization to be cancelled (required)

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)

Throws:

ApiException - If fail to call the API, e.g. server error or cannot deserialize the response body

cancelPaymentAuthorizationWithHttpInfo

public ApiResponse<java.lang.Void> cancelPaymentAuthorizationWithHttpInfo(java.lang.String channel,
                                                                          java.lang.String clientKey,
                                                                          java.lang.String product,
                                                                          java.lang.String timestamp,
                                                                          java.lang.String idempotentRequestKey,
                                                                          java.lang.String requestorType,
                                                                          java.lang.String ID_CUSTOMER,
                                                                          java.lang.String ID_AUTHORIZATION,
                                                                          CancelPaymentAuthorizationRequest cancelPaymentAuthorizationRequest,
                                                                          java.lang.String requestor,
                                                                          java.lang.String xOPAYHeaders,
                                                                          java.lang.String traceId)
                                                                   throws ApiException

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.

Parameters:: channel - The channel through which the API is invoked. (required); clientKey - The unique identifier assigned by EBPP to the client. (required); product - The product identifier corresponding to the API. (required); timestamp - The timestamp for the moment when the API request is created. (required); idempotentRequestKey - The unique token that clients can generate and maintain in order to identify an API request. (required); requestorType - Type of the requestor of the API. (required); ID_CUSTOMER - The unique identifier assigned by EBPP to the customer. (required); ID_AUTHORIZATION - The unique identifier assigned by EBPP to the payment authorization. (required); cancelPaymentAuthorizationRequest - Details of payment authorization to be cancelled (required); 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<Void>
Throws:: ApiException - If fail to call the API, e.g. server error or cannot deserialize the response body

cancelPaymentAuthorizationAsync

public com.squareup.okhttp.Call cancelPaymentAuthorizationAsync(java.lang.String channel,
                                                                java.lang.String clientKey,
                                                                java.lang.String product,
                                                                java.lang.String timestamp,
                                                                java.lang.String idempotentRequestKey,
                                                                java.lang.String requestorType,
                                                                java.lang.String ID_CUSTOMER,
                                                                java.lang.String ID_AUTHORIZATION,
                                                                CancelPaymentAuthorizationRequest cancelPaymentAuthorizationRequest,
                                                                java.lang.String requestor,
                                                                java.lang.String xOPAYHeaders,
                                                                java.lang.String traceId,
                                                                ApiCallback<java.lang.Void> callback)
                                                         throws ApiException

Cancel Payment Authorization (asynchronously) 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.

Parameters:: channel - The channel through which the API is invoked. (required); clientKey - The unique identifier assigned by EBPP to the client. (required); product - The product identifier corresponding to the API. (required); timestamp - The timestamp for the moment when the API request is created. (required); idempotentRequestKey - The unique token that clients can generate and maintain in order to identify an API request. (required); requestorType - Type of the requestor of the API. (required); ID_CUSTOMER - The unique identifier assigned by EBPP to the customer. (required); ID_AUTHORIZATION - The unique identifier assigned by EBPP to the payment authorization. (required); cancelPaymentAuthorizationRequest - Details of payment authorization to be cancelled (required); 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); callback - The callback to be executed when the API call finishes
Returns:: The request call
Throws:: ApiException - If fail to process the API call, e.g. serializing the request body object

createPaymentAuthorizationCall

public com.squareup.okhttp.Call createPaymentAuthorizationCall(java.lang.String channel,
                                                               java.lang.String clientKey,
                                                               java.lang.String product,
                                                               java.lang.String timestamp,
                                                               java.lang.String idempotentRequestKey,
                                                               java.lang.String requestorType,
                                                               CreatePaymentAuthorizationRequest createPaymentAuthorizationRequest,
                                                               java.lang.String requestor,
                                                               java.lang.String xOPAYHeaders,
                                                               java.lang.String traceId,
                                                               ProgressResponseBody.ProgressListener progressListener,
                                                               ProgressRequestBody.ProgressRequestListener progressRequestListener)
                                                        throws ApiException

Build call for createPaymentAuthorization

Parameters:: channel - The channel through which the API is invoked. (required); clientKey - The unique identifier assigned by EBPP to the client. (required); product - The product identifier corresponding to the API. (required); timestamp - The timestamp for the moment when the API request is created. (required); idempotentRequestKey - The unique token that clients can generate and maintain in order to identify an API request. (required); requestorType - Type of the requestor of the API. (required); createPaymentAuthorizationRequest - JSON containing all the fields required to make a payment. (required); 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); progressListener - Progress listener; progressRequestListener - Progress request listener
Returns:: Call to execute
Throws:: ApiException - If fail to serialize the request body object

createPaymentAuthorization

public ApiResponse<PaymentAuthorizationResponse> createPaymentAuthorization(java.lang.String channel,
                                                                            java.lang.String clientKey,
                                                                            java.lang.String product,
                                                                            java.lang.String timestamp,
                                                                            java.lang.String idempotentRequestKey,
                                                                            java.lang.String requestorType,
                                                                            CreatePaymentAuthorizationRequest createPaymentAuthorizationRequest,
                                                                            java.lang.String requestor,
                                                                            java.lang.String xOPAYHeaders,
                                                                            java.lang.String traceId)
                                                                     throws ApiException

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.

Parameters:: channel - The channel through which the API is invoked. (required); clientKey - The unique identifier assigned by EBPP to the client. (required); product - The product identifier corresponding to the API. (required); timestamp - The timestamp for the moment when the API request is created. (required); idempotentRequestKey - The unique token that clients can generate and maintain in order to identify an API request. (required); requestorType - Type of the requestor of the API. (required); createPaymentAuthorizationRequest - JSON containing all the fields required to make a payment. (required); 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
Throws:: ApiException - If fail to call the API, e.g. server error or cannot deserialize the response body

createPaymentAuthorizationWithHttpInfo

public ApiResponse<PaymentAuthorizationResponse> createPaymentAuthorizationWithHttpInfo(java.lang.String channel,
                                                                                        java.lang.String clientKey,
                                                                                        java.lang.String product,
                                                                                        java.lang.String timestamp,
                                                                                        java.lang.String idempotentRequestKey,
                                                                                        java.lang.String requestorType,
                                                                                        CreatePaymentAuthorizationRequest createPaymentAuthorizationRequest,
                                                                                        java.lang.String requestor,
                                                                                        java.lang.String xOPAYHeaders,
                                                                                        java.lang.String traceId)
                                                                                 throws ApiException

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.

Parameters:: channel - The channel through which the API is invoked. (required); clientKey - The unique identifier assigned by EBPP to the client. (required); product - The product identifier corresponding to the API. (required); timestamp - The timestamp for the moment when the API request is created. (required); idempotentRequestKey - The unique token that clients can generate and maintain in order to identify an API request. (required); requestorType - Type of the requestor of the API. (required); createPaymentAuthorizationRequest - JSON containing all the fields required to make a payment. (required); 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<PaymentAuthorizationResponse>
Throws:: ApiException - If fail to call the API, e.g. server error or cannot deserialize the response body

createPaymentAuthorizationAsync

public com.squareup.okhttp.Call createPaymentAuthorizationAsync(java.lang.String channel,
                                                                java.lang.String clientKey,
                                                                java.lang.String product,
                                                                java.lang.String timestamp,
                                                                java.lang.String idempotentRequestKey,
                                                                java.lang.String requestorType,
                                                                CreatePaymentAuthorizationRequest createPaymentAuthorizationRequest,
                                                                java.lang.String requestor,
                                                                java.lang.String xOPAYHeaders,
                                                                java.lang.String traceId,
                                                                ApiCallback<PaymentAuthorizationResponse> callback)
                                                         throws ApiException

Create Payment Authorization (asynchronously) 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.

Parameters:: channel - The channel through which the API is invoked. (required); clientKey - The unique identifier assigned by EBPP to the client. (required); product - The product identifier corresponding to the API. (required); timestamp - The timestamp for the moment when the API request is created. (required); idempotentRequestKey - The unique token that clients can generate and maintain in order to identify an API request. (required); requestorType - Type of the requestor of the API. (required); createPaymentAuthorizationRequest - JSON containing all the fields required to make a payment. (required); 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); callback - The callback to be executed when the API call finishes
Returns:: The request call
Throws:: ApiException - If fail to process the API call, e.g. serializing the request body object

Class PaymentAuthorizationApi

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

Constructor Summary