Api

Class RefundApi

java.lang.Object

Api.RefundApi

public class RefundApi
extends Object

Constructor Summary

Constructors

Constructor and Description
RefundApi()
RefundApi(ApiClient apiClient)

Method Summary

Modifier and Type	Method and Description
ApiClient	getApiClient()
InlineResponse2005	getRefund(String id) Retrieve a Refund Include the refund ID in the GET request to to retrieve the refund details.
com.squareup.okhttp.Call	getRefundAsync(String id, ApiCallback<InlineResponse2005> callback) Retrieve a Refund (asynchronously) Include the refund ID in the GET request to to retrieve the refund details.
com.squareup.okhttp.Call	getRefundCall(String id, ProgressResponseBody.ProgressListener progressListener, ProgressRequestBody.ProgressRequestListener progressRequestListener) Build call for getRefund
ApiResponse<InlineResponse2005>	getRefundWithHttpInfo(String id) Retrieve a Refund Include the refund ID in the GET request to to retrieve the refund details.
InlineResponse2013	refundCapture(RefundCaptureRequest refundCaptureRequest, String id) Refund a Capture Include the capture ID in the POST request to refund the captured amount.
com.squareup.okhttp.Call	refundCaptureAsync(RefundCaptureRequest refundCaptureRequest, String id, ApiCallback<InlineResponse2013> callback) Refund a Capture (asynchronously) Include the capture ID in the POST request to refund the captured amount.
com.squareup.okhttp.Call	refundCaptureCall(RefundCaptureRequest refundCaptureRequest, String id, ProgressResponseBody.ProgressListener progressListener, ProgressRequestBody.ProgressRequestListener progressRequestListener) Build call for refundCapture
ApiResponse<InlineResponse2013>	refundCaptureWithHttpInfo(RefundCaptureRequest refundCaptureRequest, String id) Refund a Capture Include the capture ID in the POST request to refund the captured amount.
InlineResponse2013	refundPayment(RefundPaymentRequest refundPaymentRequest, String id) Refund a Payment Include the payment ID in the POST request to refund the payment amount.
com.squareup.okhttp.Call	refundPaymentAsync(RefundPaymentRequest refundPaymentRequest, String id, ApiCallback<InlineResponse2013> callback) Refund a Payment (asynchronously) Include the payment ID in the POST request to refund the payment amount.
com.squareup.okhttp.Call	refundPaymentCall(RefundPaymentRequest refundPaymentRequest, String id, ProgressResponseBody.ProgressListener progressListener, ProgressRequestBody.ProgressRequestListener progressRequestListener) Build call for refundPayment
ApiResponse<InlineResponse2013>	refundPaymentWithHttpInfo(RefundPaymentRequest refundPaymentRequest, String id) Refund a Payment Include the payment ID in the POST request to refund the payment amount.
void	setApiClient(ApiClient apiClient)

Methods inherited from class java.lang.Object

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

Constructor Detail

RefundApi

public RefundApi()

RefundApi

public RefundApi(ApiClient apiClient)

Method Detail

getApiClient

public ApiClient getApiClient()

setApiClient

public void setApiClient(ApiClient apiClient)

getRefundCall

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

Build call for getRefund

Parameters:

id - The refund ID. This ID is 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

getRefund

public InlineResponse2005 getRefund(String id)
                             throws ApiException

Retrieve a Refund Include the refund ID in the GET request to to retrieve the refund details.

Parameters:

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

Returns:

InlineResponse2005 generated.

Throws:

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

getRefundWithHttpInfo

public ApiResponse<InlineResponse2005> getRefundWithHttpInfo(String id)
                                                      throws ApiException

Retrieve a Refund Include the refund ID in the GET request to to retrieve the refund details.

Parameters:

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

Returns:

ApiResponse - InlineResponse2005.

Throws:

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

getRefundAsync

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

Retrieve a Refund (asynchronously) Include the refund ID in the GET request to to retrieve the refund details.

Parameters:

id - The refund ID. This ID is 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

refundCaptureCall

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

Build call for refundCapture

Parameters:

refundCaptureRequest - (required)

id - The capture ID. This ID is 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

refundCapture

public InlineResponse2013 refundCapture(RefundCaptureRequest refundCaptureRequest,
                                        String id)
                                 throws ApiException

Refund a Capture Include the capture ID in the POST request to refund the captured amount.

Parameters:

refundCaptureRequest - (required)

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

Returns:

InlineResponse2013 generated.

Throws:

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

refundCaptureWithHttpInfo

public ApiResponse<InlineResponse2013> refundCaptureWithHttpInfo(RefundCaptureRequest refundCaptureRequest,
                                                                 String id)
                                                          throws ApiException

Refund a Capture Include the capture ID in the POST request to refund the captured amount.

Parameters:

refundCaptureRequest - (required)

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

Returns:

ApiResponse - InlineResponse2013.

Throws:

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

refundCaptureAsync

public com.squareup.okhttp.Call refundCaptureAsync(RefundCaptureRequest refundCaptureRequest,
                                                   String id,
                                                   ApiCallback<InlineResponse2013> callback)
                                            throws ApiException

Refund a Capture (asynchronously) Include the capture ID in the POST request to refund the captured amount.

Parameters:

refundCaptureRequest - (required)

id - The capture ID. This ID is 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

refundPaymentCall

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

Build call for refundPayment

Parameters:

refundPaymentRequest - (required)

id - The payment ID. This ID is 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

refundPayment

public InlineResponse2013 refundPayment(RefundPaymentRequest refundPaymentRequest,
                                        String id)
                                 throws ApiException

Refund a Payment Include the payment ID in the POST request to refund the payment amount.

Parameters:

refundPaymentRequest - (required)

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

Returns:

InlineResponse2013 generated.

Throws:

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

refundPaymentWithHttpInfo

public ApiResponse<InlineResponse2013> refundPaymentWithHttpInfo(RefundPaymentRequest refundPaymentRequest,
                                                                 String id)
                                                          throws ApiException

Refund a Payment Include the payment ID in the POST request to refund the payment amount.

Parameters:

refundPaymentRequest - (required)

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

Returns:

ApiResponse - InlineResponse2013.

Throws:

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

refundPaymentAsync

public com.squareup.okhttp.Call refundPaymentAsync(RefundPaymentRequest refundPaymentRequest,
                                                   String id,
                                                   ApiCallback<InlineResponse2013> callback)
                                            throws ApiException

Refund a Payment (asynchronously) Include the payment ID in the POST request to refund the payment amount.

Parameters:

refundPaymentRequest - (required)

id - The payment ID. This ID is 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