Api

Class VoidApi

java.lang.Object

Api.VoidApi

public class VoidApi
extends Object

Constructor Summary

Constructors

Constructor and Description
VoidApi()
VoidApi(ApiClient apiClient)

Method Summary

Modifier and Type	Method and Description
ApiClient	getApiClient()
InlineResponse2015	getVoid(String id) Retrieve A Void Include the void ID in the GET request to retrieve the void details.
com.squareup.okhttp.Call	getVoidAsync(String id, ApiCallback<InlineResponse2015> callback) Retrieve A Void (asynchronously) Include the void ID in the GET request to retrieve the void details.
com.squareup.okhttp.Call	getVoidCall(String id, ProgressResponseBody.ProgressListener progressListener, ProgressRequestBody.ProgressRequestListener progressRequestListener) Build call for getVoid
ApiResponse<InlineResponse2015>	getVoidWithHttpInfo(String id) Retrieve A Void Include the void ID in the GET request to retrieve the void details.
void	setApiClient(ApiClient apiClient)
InlineResponse2015	voidCapture(VoidCaptureRequest voidCaptureRequest, String id) Void a Capture Include the capture ID in the POST request to cancel the capture.
com.squareup.okhttp.Call	voidCaptureAsync(VoidCaptureRequest voidCaptureRequest, String id, ApiCallback<InlineResponse2015> callback) Void a Capture (asynchronously) Include the capture ID in the POST request to cancel the capture.
com.squareup.okhttp.Call	voidCaptureCall(VoidCaptureRequest voidCaptureRequest, String id, ProgressResponseBody.ProgressListener progressListener, ProgressRequestBody.ProgressRequestListener progressRequestListener) Build call for voidCapture
ApiResponse<InlineResponse2015>	voidCaptureWithHttpInfo(VoidCaptureRequest voidCaptureRequest, String id) Void a Capture Include the capture ID in the POST request to cancel the capture.
InlineResponse2015	voidCredit(VoidCreditRequest voidCreditRequest, String id) Void a Credit Include the credit ID in the POST request to cancel the credit.
com.squareup.okhttp.Call	voidCreditAsync(VoidCreditRequest voidCreditRequest, String id, ApiCallback<InlineResponse2015> callback) Void a Credit (asynchronously) Include the credit ID in the POST request to cancel the credit.
com.squareup.okhttp.Call	voidCreditCall(VoidCreditRequest voidCreditRequest, String id, ProgressResponseBody.ProgressListener progressListener, ProgressRequestBody.ProgressRequestListener progressRequestListener) Build call for voidCredit
ApiResponse<InlineResponse2015>	voidCreditWithHttpInfo(VoidCreditRequest voidCreditRequest, String id) Void a Credit Include the credit ID in the POST request to cancel the credit.
InlineResponse2015	voidPayment(VoidPaymentRequest voidPaymentRequest, String id) Void a Payment Include the payment ID in the POST request to cancel the payment.
com.squareup.okhttp.Call	voidPaymentAsync(VoidPaymentRequest voidPaymentRequest, String id, ApiCallback<InlineResponse2015> callback) Void a Payment (asynchronously) Include the payment ID in the POST request to cancel the payment.
com.squareup.okhttp.Call	voidPaymentCall(VoidPaymentRequest voidPaymentRequest, String id, ProgressResponseBody.ProgressListener progressListener, ProgressRequestBody.ProgressRequestListener progressRequestListener) Build call for voidPayment
ApiResponse<InlineResponse2015>	voidPaymentWithHttpInfo(VoidPaymentRequest voidPaymentRequest, String id) Void a Payment Include the payment ID in the POST request to cancel the payment.
InlineResponse2015	voidRefund(VoidRefundRequest voidRefundRequest, String id) Void a Refund Include the refund ID in the POST request to cancel the refund.
com.squareup.okhttp.Call	voidRefundAsync(VoidRefundRequest voidRefundRequest, String id, ApiCallback<InlineResponse2015> callback) Void a Refund (asynchronously) Include the refund ID in the POST request to cancel the refund.
com.squareup.okhttp.Call	voidRefundCall(VoidRefundRequest voidRefundRequest, String id, ProgressResponseBody.ProgressListener progressListener, ProgressRequestBody.ProgressRequestListener progressRequestListener) Build call for voidRefund
ApiResponse<InlineResponse2015>	voidRefundWithHttpInfo(VoidRefundRequest voidRefundRequest, String id) Void a Refund Include the refund ID in the POST request to cancel the refund.

Methods inherited from class java.lang.Object

clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait

Constructor Detail

VoidApi

public VoidApi()

VoidApi

public VoidApi(ApiClient apiClient)

Method Detail

getApiClient

public ApiClient getApiClient()

setApiClient

public void setApiClient(ApiClient apiClient)

getVoidCall

public com.squareup.okhttp.Call getVoidCall(String id,
                                            ProgressResponseBody.ProgressListener progressListener,
                                            ProgressRequestBody.ProgressRequestListener progressRequestListener)
                                     throws ApiException

Build call for getVoid

Parameters:

id - The void ID returned from a previous void request. (required)

progressListener - Progress listener

progressRequestListener - Progress request listener

Returns:

Call to execute

Throws:

ApiException - If fail to serialize the request body object

getVoid

public InlineResponse2015 getVoid(String id)
                           throws ApiException

Retrieve A Void Include the void ID in the GET request to retrieve the void details.

Parameters:

id - The void ID returned from a previous void request. (required)

Returns:

InlineResponse2015 generated.

Throws:

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

getVoidWithHttpInfo

public ApiResponse<InlineResponse2015> getVoidWithHttpInfo(String id)
                                                    throws ApiException

Retrieve A Void Include the void ID in the GET request to retrieve the void details.

Parameters:

id - The void ID returned from a previous void request. (required)

Returns:

ApiResponse - InlineResponse2015.

Throws:

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

getVoidAsync

public com.squareup.okhttp.Call getVoidAsync(String id,
                                             ApiCallback<InlineResponse2015> callback)
                                      throws ApiException

Retrieve A Void (asynchronously) Include the void ID in the GET request to retrieve the void details.

Parameters:

id - The void ID returned from a previous void request. (required)

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

voidCaptureCall

public com.squareup.okhttp.Call voidCaptureCall(VoidCaptureRequest voidCaptureRequest,
                                                String id,
                                                ProgressResponseBody.ProgressListener progressListener,
                                                ProgressRequestBody.ProgressRequestListener progressRequestListener)
                                         throws ApiException

Build call for voidCapture

Parameters:

voidCaptureRequest - (required)

id - The capture ID returned from a previous capture request. (required)

progressListener - Progress listener

progressRequestListener - Progress request listener

Returns:

Call to execute

Throws:

ApiException - If fail to serialize the request body object

voidCapture

public InlineResponse2015 voidCapture(VoidCaptureRequest voidCaptureRequest,
                                      String id)
                               throws ApiException

Void a Capture Include the capture ID in the POST request to cancel the capture.

Parameters:

voidCaptureRequest - (required)

id - The capture ID returned from a previous capture request. (required)

Returns:

InlineResponse2015 generated.

Throws:

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

voidCaptureWithHttpInfo

public ApiResponse<InlineResponse2015> voidCaptureWithHttpInfo(VoidCaptureRequest voidCaptureRequest,
                                                               String id)
                                                        throws ApiException

Void a Capture Include the capture ID in the POST request to cancel the capture.

Parameters:

voidCaptureRequest - (required)

id - The capture ID returned from a previous capture request. (required)

Returns:

ApiResponse - InlineResponse2015.

Throws:

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

voidCaptureAsync

public com.squareup.okhttp.Call voidCaptureAsync(VoidCaptureRequest voidCaptureRequest,
                                                 String id,
                                                 ApiCallback<InlineResponse2015> callback)
                                          throws ApiException

Void a Capture (asynchronously) Include the capture ID in the POST request to cancel the capture.

Parameters:

voidCaptureRequest - (required)

id - The capture ID returned from a previous capture request. (required)

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

voidCreditCall

public com.squareup.okhttp.Call voidCreditCall(VoidCreditRequest voidCreditRequest,
                                               String id,
                                               ProgressResponseBody.ProgressListener progressListener,
                                               ProgressRequestBody.ProgressRequestListener progressRequestListener)
                                        throws ApiException

Build call for voidCredit

Parameters:

voidCreditRequest - (required)

id - The credit ID returned from a previous credit request. (required)

progressListener - Progress listener

progressRequestListener - Progress request listener

Returns:

Call to execute

Throws:

ApiException - If fail to serialize the request body object

voidCredit

public InlineResponse2015 voidCredit(VoidCreditRequest voidCreditRequest,
                                     String id)
                              throws ApiException

Void a Credit Include the credit ID in the POST request to cancel the credit.

Parameters:

voidCreditRequest - (required)

id - The credit ID returned from a previous credit request. (required)

Returns:

InlineResponse2015 generated.

Throws:

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

voidCreditWithHttpInfo

public ApiResponse<InlineResponse2015> voidCreditWithHttpInfo(VoidCreditRequest voidCreditRequest,
                                                              String id)
                                                       throws ApiException

Void a Credit Include the credit ID in the POST request to cancel the credit.

Parameters:

voidCreditRequest - (required)

id - The credit ID returned from a previous credit request. (required)

Returns:

ApiResponse - InlineResponse2015.

Throws:

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

voidCreditAsync

public com.squareup.okhttp.Call voidCreditAsync(VoidCreditRequest voidCreditRequest,
                                                String id,
                                                ApiCallback<InlineResponse2015> callback)
                                         throws ApiException

Void a Credit (asynchronously) Include the credit ID in the POST request to cancel the credit.

Parameters:

voidCreditRequest - (required)

id - The credit ID returned from a previous credit request. (required)

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

voidPaymentCall

public com.squareup.okhttp.Call voidPaymentCall(VoidPaymentRequest voidPaymentRequest,
                                                String id,
                                                ProgressResponseBody.ProgressListener progressListener,
                                                ProgressRequestBody.ProgressRequestListener progressRequestListener)
                                         throws ApiException

Build call for voidPayment

Parameters:

voidPaymentRequest - (required)

id - The payment ID returned from a previous payment request. (required)

progressListener - Progress listener

progressRequestListener - Progress request listener

Returns:

Call to execute

Throws:

ApiException - If fail to serialize the request body object

voidPayment

public InlineResponse2015 voidPayment(VoidPaymentRequest voidPaymentRequest,
                                      String id)
                               throws ApiException

Void a Payment Include the payment ID in the POST request to cancel the payment.

Parameters:

voidPaymentRequest - (required)

id - The payment ID returned from a previous payment request. (required)

Returns:

InlineResponse2015 generated.

Throws:

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

voidPaymentWithHttpInfo

public ApiResponse<InlineResponse2015> voidPaymentWithHttpInfo(VoidPaymentRequest voidPaymentRequest,
                                                               String id)
                                                        throws ApiException

Void a Payment Include the payment ID in the POST request to cancel the payment.

Parameters:

voidPaymentRequest - (required)

id - The payment ID returned from a previous payment request. (required)

Returns:

ApiResponse - InlineResponse2015.

Throws:

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

voidPaymentAsync

public com.squareup.okhttp.Call voidPaymentAsync(VoidPaymentRequest voidPaymentRequest,
                                                 String id,
                                                 ApiCallback<InlineResponse2015> callback)
                                          throws ApiException

Void a Payment (asynchronously) Include the payment ID in the POST request to cancel the payment.

Parameters:

voidPaymentRequest - (required)

id - The payment ID returned from a previous payment request. (required)

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

voidRefundCall

public com.squareup.okhttp.Call voidRefundCall(VoidRefundRequest voidRefundRequest,
                                               String id,
                                               ProgressResponseBody.ProgressListener progressListener,
                                               ProgressRequestBody.ProgressRequestListener progressRequestListener)
                                        throws ApiException

Build call for voidRefund

Parameters:

voidRefundRequest - (required)

id - The refund ID returned from a previous refund request. (required)

progressListener - Progress listener

progressRequestListener - Progress request listener

Returns:

Call to execute

Throws:

ApiException - If fail to serialize the request body object

voidRefund

public InlineResponse2015 voidRefund(VoidRefundRequest voidRefundRequest,
                                     String id)
                              throws ApiException

Void a Refund Include the refund ID in the POST request to cancel the refund.

Parameters:

voidRefundRequest - (required)

id - The refund ID returned from a previous refund request. (required)

Returns:

InlineResponse2015 generated.

Throws:

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

voidRefundWithHttpInfo

public ApiResponse<InlineResponse2015> voidRefundWithHttpInfo(VoidRefundRequest voidRefundRequest,
                                                              String id)
                                                       throws ApiException

Void a Refund Include the refund ID in the POST request to cancel the refund.

Parameters:

voidRefundRequest - (required)

id - The refund ID returned from a previous refund request. (required)

Returns:

ApiResponse - InlineResponse2015.

Throws:

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

voidRefundAsync

public com.squareup.okhttp.Call voidRefundAsync(VoidRefundRequest voidRefundRequest,
                                                String id,
                                                ApiCallback<InlineResponse2015> callback)
                                         throws ApiException

Void a Refund (asynchronously) Include the refund ID in the POST request to cancel the refund.

Parameters:

voidRefundRequest - (required)

id - The refund ID returned from a previous refund request. (required)

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