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()
PtsV2PaymentsVoidsPost201Response	mitVoid(MitVoidRequest mitVoidRequest) Timeout Void This is to void a previous payment, capture, refund, or credit that merchant does not receive a reply(Mostly due to timeout).
okhttp3.Call	mitVoidAsync(MitVoidRequest mitVoidRequest, ApiCallback<PtsV2PaymentsVoidsPost201Response> callback) Timeout Void (asynchronously) This is to void a previous payment, capture, refund, or credit that merchant does not receive a reply(Mostly due to timeout).
okhttp3.Call	mitVoidCall(MitVoidRequest mitVoidRequest, ProgressResponseBody.ProgressListener progressListener, ProgressRequestBody.ProgressRequestListener progressRequestListener) Build call for mitVoid
ApiResponse<PtsV2PaymentsVoidsPost201Response>	mitVoidWithHttpInfo(MitVoidRequest mitVoidRequest) Timeout Void This is to void a previous payment, capture, refund, or credit that merchant does not receive a reply(Mostly due to timeout).
void	setApiClient(ApiClient apiClient)
PtsV2PaymentsVoidsPost201Response	voidCapture(VoidCaptureRequest voidCaptureRequest, String id) Void a Capture Refund a capture API is only used, if you have requested Capture independenlty using [/pts/v2/payments/{id}/captures](https://developer.cybersource.com/api-reference-assets/index.html#payments_capture) API call.
okhttp3.Call	voidCaptureAsync(VoidCaptureRequest voidCaptureRequest, String id, ApiCallback<PtsV2PaymentsVoidsPost201Response> callback) Void a Capture (asynchronously) Refund a capture API is only used, if you have requested Capture independenlty using [/pts/v2/payments/{id}/captures](https://developer.cybersource.com/api-reference-assets/index.html#payments_capture) API call.
okhttp3.Call	voidCaptureCall(VoidCaptureRequest voidCaptureRequest, String id, ProgressResponseBody.ProgressListener progressListener, ProgressRequestBody.ProgressRequestListener progressRequestListener) Build call for voidCapture
ApiResponse<PtsV2PaymentsVoidsPost201Response>	voidCaptureWithHttpInfo(VoidCaptureRequest voidCaptureRequest, String id) Void a Capture Refund a capture API is only used, if you have requested Capture independenlty using [/pts/v2/payments/{id}/captures](https://developer.cybersource.com/api-reference-assets/index.html#payments_capture) API call.
PtsV2PaymentsVoidsPost201Response	voidCredit(VoidCreditRequest voidCreditRequest, String id) Void a Credit Include the credit ID in the POST request to cancel the credit.
okhttp3.Call	voidCreditAsync(VoidCreditRequest voidCreditRequest, String id, ApiCallback<PtsV2PaymentsVoidsPost201Response> callback) Void a Credit (asynchronously) Include the credit ID in the POST request to cancel the credit.
okhttp3.Call	voidCreditCall(VoidCreditRequest voidCreditRequest, String id, ProgressResponseBody.ProgressListener progressListener, ProgressRequestBody.ProgressRequestListener progressRequestListener) Build call for voidCredit
ApiResponse<PtsV2PaymentsVoidsPost201Response>	voidCreditWithHttpInfo(VoidCreditRequest voidCreditRequest, String id) Void a Credit Include the credit ID in the POST request to cancel the credit.
PtsV2PaymentsVoidsPost201Response	voidPayment(VoidPaymentRequest voidPaymentRequest, String id) Void a Payment Void a Payment API is only used, if you have requested Authorization and Capture together in [/pts/v2/payments](https://developer.cybersource.com/api-reference-assets/index.html#payments_payments) API call.
okhttp3.Call	voidPaymentAsync(VoidPaymentRequest voidPaymentRequest, String id, ApiCallback<PtsV2PaymentsVoidsPost201Response> callback) Void a Payment (asynchronously) Void a Payment API is only used, if you have requested Authorization and Capture together in [/pts/v2/payments](https://developer.cybersource.com/api-reference-assets/index.html#payments_payments) API call.
okhttp3.Call	voidPaymentCall(VoidPaymentRequest voidPaymentRequest, String id, ProgressResponseBody.ProgressListener progressListener, ProgressRequestBody.ProgressRequestListener progressRequestListener) Build call for voidPayment
ApiResponse<PtsV2PaymentsVoidsPost201Response>	voidPaymentWithHttpInfo(VoidPaymentRequest voidPaymentRequest, String id) Void a Payment Void a Payment API is only used, if you have requested Authorization and Capture together in [/pts/v2/payments](https://developer.cybersource.com/api-reference-assets/index.html#payments_payments) API call.
PtsV2PaymentsVoidsPost201Response	voidRefund(VoidRefundRequest voidRefundRequest, String id) Void a Refund Include the refund ID in the POST request to cancel the refund.
okhttp3.Call	voidRefundAsync(VoidRefundRequest voidRefundRequest, String id, ApiCallback<PtsV2PaymentsVoidsPost201Response> callback) Void a Refund (asynchronously) Include the refund ID in the POST request to cancel the refund.
okhttp3.Call	voidRefundCall(VoidRefundRequest voidRefundRequest, String id, ProgressResponseBody.ProgressListener progressListener, ProgressRequestBody.ProgressRequestListener progressRequestListener) Build call for voidRefund
ApiResponse<PtsV2PaymentsVoidsPost201Response>	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)

mitVoidCall

public okhttp3.Call mitVoidCall(MitVoidRequest mitVoidRequest,
                                ProgressResponseBody.ProgressListener progressListener,
                                ProgressRequestBody.ProgressRequestListener progressRequestListener)
                         throws ApiException

Build call for mitVoid

Parameters:

mitVoidRequest - (required)

progressListener - Progress listener

progressRequestListener - Progress request listener

Returns:

Call to execute

Throws:

ApiException - If fail to serialize the request body object

mitVoid

public PtsV2PaymentsVoidsPost201Response mitVoid(MitVoidRequest mitVoidRequest)
                                          throws ApiException

Timeout Void This is to void a previous payment, capture, refund, or credit that merchant does not receive a reply(Mostly due to timeout). To use this feature/API, make sure to pass unique value to field - clientReferenceInformation -> transactionId in your payment, capture, refund, or credit API call and use same transactionId in this API request payload to reverse the payment.

Parameters:

mitVoidRequest - (required)

Returns:

PtsV2PaymentsVoidsPost201Response

Throws:

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

mitVoidWithHttpInfo

public ApiResponse<PtsV2PaymentsVoidsPost201Response> mitVoidWithHttpInfo(MitVoidRequest mitVoidRequest)
                                                                   throws ApiException

Timeout Void This is to void a previous payment, capture, refund, or credit that merchant does not receive a reply(Mostly due to timeout). To use this feature/API, make sure to pass unique value to field - clientReferenceInformation -> transactionId in your payment, capture, refund, or credit API call and use same transactionId in this API request payload to reverse the payment.

Parameters:

mitVoidRequest - (required)

Returns:

ApiResponse<PtsV2PaymentsVoidsPost201Response>

Throws:

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

mitVoidAsync

public okhttp3.Call mitVoidAsync(MitVoidRequest mitVoidRequest,
                                 ApiCallback<PtsV2PaymentsVoidsPost201Response> callback)
                          throws ApiException

Timeout Void (asynchronously) This is to void a previous payment, capture, refund, or credit that merchant does not receive a reply(Mostly due to timeout). To use this feature/API, make sure to pass unique value to field - clientReferenceInformation -> transactionId in your payment, capture, refund, or credit API call and use same transactionId in this API request payload to reverse the payment.

Parameters:

mitVoidRequest - (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 okhttp3.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 PtsV2PaymentsVoidsPost201Response voidCapture(VoidCaptureRequest voidCaptureRequest,
                                                     String id)
                                              throws ApiException

Void a Capture Refund a capture API is only used, if you have requested Capture independenlty using [/pts/v2/payments/{id}/captures](https://developer.cybersource.com/api-reference-assets/index.html#payments_capture) API call. 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:

PtsV2PaymentsVoidsPost201Response

Throws:

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

voidCaptureWithHttpInfo

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

Void a Capture Refund a capture API is only used, if you have requested Capture independenlty using [/pts/v2/payments/{id}/captures](https://developer.cybersource.com/api-reference-assets/index.html#payments_capture) API call. 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<PtsV2PaymentsVoidsPost201Response>

Throws:

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

voidCaptureAsync

public okhttp3.Call voidCaptureAsync(VoidCaptureRequest voidCaptureRequest,
                                     String id,
                                     ApiCallback<PtsV2PaymentsVoidsPost201Response> callback)
                              throws ApiException

Void a Capture (asynchronously) Refund a capture API is only used, if you have requested Capture independenlty using [/pts/v2/payments/{id}/captures](https://developer.cybersource.com/api-reference-assets/index.html#payments_capture) API call. 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 okhttp3.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 PtsV2PaymentsVoidsPost201Response 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:

PtsV2PaymentsVoidsPost201Response

Throws:

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

voidCreditWithHttpInfo

public ApiResponse<PtsV2PaymentsVoidsPost201Response> 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<PtsV2PaymentsVoidsPost201Response>

Throws:

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

voidCreditAsync

public okhttp3.Call voidCreditAsync(VoidCreditRequest voidCreditRequest,
                                    String id,
                                    ApiCallback<PtsV2PaymentsVoidsPost201Response> 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 okhttp3.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 PtsV2PaymentsVoidsPost201Response voidPayment(VoidPaymentRequest voidPaymentRequest,
                                                     String id)
                                              throws ApiException

Void a Payment Void a Payment API is only used, if you have requested Authorization and Capture together in [/pts/v2/payments](https://developer.cybersource.com/api-reference-assets/index.html#payments_payments) API call. 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:

PtsV2PaymentsVoidsPost201Response

Throws:

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

voidPaymentWithHttpInfo

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

Void a Payment Void a Payment API is only used, if you have requested Authorization and Capture together in [/pts/v2/payments](https://developer.cybersource.com/api-reference-assets/index.html#payments_payments) API call. 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<PtsV2PaymentsVoidsPost201Response>

Throws:

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

voidPaymentAsync

public okhttp3.Call voidPaymentAsync(VoidPaymentRequest voidPaymentRequest,
                                     String id,
                                     ApiCallback<PtsV2PaymentsVoidsPost201Response> callback)
                              throws ApiException

Void a Payment (asynchronously) Void a Payment API is only used, if you have requested Authorization and Capture together in [/pts/v2/payments](https://developer.cybersource.com/api-reference-assets/index.html#payments_payments) API call. 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 okhttp3.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 PtsV2PaymentsVoidsPost201Response 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:

PtsV2PaymentsVoidsPost201Response

Throws:

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

voidRefundWithHttpInfo

public ApiResponse<PtsV2PaymentsVoidsPost201Response> 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<PtsV2PaymentsVoidsPost201Response>

Throws:

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

voidRefundAsync

public okhttp3.Call voidRefundAsync(VoidRefundRequest voidRefundRequest,
                                    String id,
                                    ApiCallback<PtsV2PaymentsVoidsPost201Response> 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