Api

Class CaptureApi

java.lang.Object

Api.CaptureApi

public class CaptureApi
extends Object

Constructor Summary

Constructors

Constructor	Description
CaptureApi()
CaptureApi(ApiClient apiClient)

Method Summary

Modifier and Type	Method	Description
PtsV2PaymentsCapturesPost201Response	capturePayment(CapturePaymentRequest capturePaymentRequest, String id)	Capture a Payment Include the payment ID in the POST request to capture the payment amount.
okhttp3.Call	capturePaymentAsync(CapturePaymentRequest capturePaymentRequest, String id, ApiCallback<PtsV2PaymentsCapturesPost201Response> callback)	Capture a Payment (asynchronously) Include the payment ID in the POST request to capture the payment amount.
okhttp3.Call	capturePaymentCall(CapturePaymentRequest capturePaymentRequest, String id, ProgressResponseBody.ProgressListener progressListener, ProgressRequestBody.ProgressRequestListener progressRequestListener)	Build call for capturePayment
ApiResponse<PtsV2PaymentsCapturesPost201Response>	capturePaymentWithHttpInfo(CapturePaymentRequest capturePaymentRequest, String id)	Capture a Payment Include the payment ID in the POST request to capture the payment amount.
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

CaptureApi

public CaptureApi()

CaptureApi

public CaptureApi(ApiClient apiClient)

Method Detail

getApiClient

public ApiClient getApiClient()

setApiClient

public void setApiClient(ApiClient apiClient)

capturePaymentCall

public okhttp3.Call capturePaymentCall(CapturePaymentRequest capturePaymentRequest,
                                       String id,
                                       ProgressResponseBody.ProgressListener progressListener,
                                       ProgressRequestBody.ProgressRequestListener progressRequestListener)
                                throws ApiException,
                                       com.cybersource.authsdk.core.ConfigException

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

com.cybersource.authsdk.core.ConfigException - If creation of merchant configuration fails in ApiClient

capturePayment

public PtsV2PaymentsCapturesPost201Response capturePayment(CapturePaymentRequest capturePaymentRequest,
                                                           String id)
                                                    throws ApiException,
                                                           com.cybersource.authsdk.core.ConfigException

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:

PtsV2PaymentsCapturesPost201Response

Throws:

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

com.cybersource.authsdk.core.ConfigException - If creation of merchant configuration fails in ApiClient

capturePaymentWithHttpInfo

public ApiResponse<PtsV2PaymentsCapturesPost201Response> capturePaymentWithHttpInfo(CapturePaymentRequest capturePaymentRequest,
                                                                                    String id)
                                                                             throws ApiException,
                                                                                    com.cybersource.authsdk.core.ConfigException

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<PtsV2PaymentsCapturesPost201Response>

Throws:

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

com.cybersource.authsdk.core.ConfigException - If creation of merchant configuration fails in ApiClient

capturePaymentAsync

public okhttp3.Call capturePaymentAsync(CapturePaymentRequest capturePaymentRequest,
                                        String id,
                                        ApiCallback<PtsV2PaymentsCapturesPost201Response> callback)
                                 throws ApiException,
                                        com.cybersource.authsdk.core.ConfigException

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

com.cybersource.authsdk.core.ConfigException - If creation of merchant configuration fails in ApiClient