Api

Class CaptureApi

java.lang.Object

Api.CaptureApi

public class CaptureApi
extends Object

Constructor Summary

Constructors

Constructor and Description
CaptureApi()
CaptureApi(ApiClient apiClient)

Method Summary

Modifier and Type	Method and Description
InlineResponse2012	capturePayment(CapturePaymentRequest capturePaymentRequest, String id) Capture a Payment Include the payment ID in the POST request to capture the payment amount.
com.squareup.okhttp.Call	capturePaymentAsync(CapturePaymentRequest capturePaymentRequest, String id, ApiCallback<InlineResponse2012> callback) Capture a Payment (asynchronously) Include the payment ID in the POST request to capture the payment amount.
com.squareup.okhttp.Call	capturePaymentCall(CapturePaymentRequest capturePaymentRequest, String id, ProgressResponseBody.ProgressListener progressListener, ProgressRequestBody.ProgressRequestListener progressRequestListener) Build call for capturePayment
ApiResponse<InlineResponse2012>	capturePaymentWithHttpInfo(CapturePaymentRequest capturePaymentRequest, String id) Capture a Payment Include the payment ID in the POST request to capture the payment amount.
ApiClient	getApiClient()
InlineResponse2004	getCapture(String id) Retrieve a Capture Include the capture ID in the GET request to retrieve the capture details.
com.squareup.okhttp.Call	getCaptureAsync(String id, ApiCallback<InlineResponse2004> callback) Retrieve a Capture (asynchronously) Include the capture ID in the GET request to retrieve the capture details.
com.squareup.okhttp.Call	getCaptureCall(String id, ProgressResponseBody.ProgressListener progressListener, ProgressRequestBody.ProgressRequestListener progressRequestListener) Build call for getCapture
ApiResponse<InlineResponse2004>	getCaptureWithHttpInfo(String id) Retrieve a Capture Include the capture ID in the GET request to retrieve the capture details.
void	setApiClient(ApiClient apiClient)

Methods inherited from class java.lang.Object

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

Constructor Detail

CaptureApi

public CaptureApi()

CaptureApi

public CaptureApi(ApiClient apiClient)

Method Detail

getApiClient

public ApiClient getApiClient()

setApiClient

public void setApiClient(ApiClient apiClient)

capturePaymentCall

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

Build call for capturePayment

Parameters:

capturePaymentRequest - (required)

id - The payment ID returned from a previous payment request. This ID links the capture to the payment. (required)

progressListener - Progress listener

progressRequestListener - Progress request listener

Returns:

Call to execute

Throws:

ApiException - If fail to serialize the request body object

capturePayment

public InlineResponse2012 capturePayment(CapturePaymentRequest capturePaymentRequest,
                                         String id)
                                  throws ApiException

Capture a Payment Include the payment ID in the POST request to capture the payment amount.

Parameters:

capturePaymentRequest - (required)

id - The payment ID returned from a previous payment request. This ID links the capture to the payment. (required)

Returns:

InlineResponse2012

Throws:

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

capturePaymentWithHttpInfo

public ApiResponse<InlineResponse2012> capturePaymentWithHttpInfo(CapturePaymentRequest capturePaymentRequest,
                                                                  String id)
                                                           throws ApiException

Capture a Payment Include the payment ID in the POST request to capture the payment amount.

Parameters:

capturePaymentRequest - (required)

id - The payment ID returned from a previous payment request. This ID links the capture to the payment. (required)

Returns:

ApiResponse - InlineResponse2012;

Throws:

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

capturePaymentAsync

public com.squareup.okhttp.Call capturePaymentAsync(CapturePaymentRequest capturePaymentRequest,
                                                    String id,
                                                    ApiCallback<InlineResponse2012> callback)
                                             throws ApiException

Capture a Payment (asynchronously) Include the payment ID in the POST request to capture the payment amount.

Parameters:

capturePaymentRequest - (required)

id - The payment ID returned from a previous payment request. This ID links the capture to the payment. (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

getCaptureCall

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

Build call for getCapture

Parameters:

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

getCapture

public InlineResponse2004 getCapture(String id)
                              throws ApiException

Retrieve a Capture Include the capture ID in the GET request to retrieve the capture details.

Parameters:

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

Returns:

InlineResponse2004 generated.

Throws:

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

getCaptureWithHttpInfo

public ApiResponse<InlineResponse2004> getCaptureWithHttpInfo(String id)
                                                       throws ApiException

Retrieve a Capture Include the capture ID in the GET request to retrieve the capture details.

Parameters:

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

Returns:

ApiResponse - InlineResponse2004

Throws:

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

getCaptureAsync

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

Retrieve a Capture (asynchronously) Include the capture ID in the GET request to retrieve the capture details.

Parameters:

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