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()
PtsV2PaymentsRefundPost201Response	refundCapture(RefundCaptureRequest refundCaptureRequest, String id) Refund 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 refund the captured amount.
okhttp3.Call	refundCaptureAsync(RefundCaptureRequest refundCaptureRequest, String id, ApiCallback<PtsV2PaymentsRefundPost201Response> callback) Refund 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 refund the captured amount.
okhttp3.Call	refundCaptureCall(RefundCaptureRequest refundCaptureRequest, String id, ProgressResponseBody.ProgressListener progressListener, ProgressRequestBody.ProgressRequestListener progressRequestListener) Build call for refundCapture
ApiResponse<PtsV2PaymentsRefundPost201Response>	refundCaptureWithHttpInfo(RefundCaptureRequest refundCaptureRequest, String id) Refund 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 refund the captured amount.
PtsV2PaymentsRefundPost201Response	refundPayment(RefundPaymentRequest refundPaymentRequest, String id) Refund a Payment Refund 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	refundPaymentAsync(RefundPaymentRequest refundPaymentRequest, String id, ApiCallback<PtsV2PaymentsRefundPost201Response> callback) Refund a Payment (asynchronously) Refund 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	refundPaymentCall(RefundPaymentRequest refundPaymentRequest, String id, ProgressResponseBody.ProgressListener progressListener, ProgressRequestBody.ProgressRequestListener progressRequestListener) Build call for refundPayment
ApiResponse<PtsV2PaymentsRefundPost201Response>	refundPaymentWithHttpInfo(RefundPaymentRequest refundPaymentRequest, String id) Refund a Payment Refund 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.
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)

refundCaptureCall

public okhttp3.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 PtsV2PaymentsRefundPost201Response refundCapture(RefundCaptureRequest refundCaptureRequest,
                                                        String id)
                                                 throws ApiException

Refund 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 refund the captured amount.

Parameters:

refundCaptureRequest - (required)

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

Returns:

PtsV2PaymentsRefundPost201Response

Throws:

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

refundCaptureWithHttpInfo

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

Refund 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 refund the captured amount.

Parameters:

refundCaptureRequest - (required)

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

Returns:

ApiResponse<PtsV2PaymentsRefundPost201Response>

Throws:

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

refundCaptureAsync

public okhttp3.Call refundCaptureAsync(RefundCaptureRequest refundCaptureRequest,
                                       String id,
                                       ApiCallback<PtsV2PaymentsRefundPost201Response> callback)
                                throws ApiException

Refund 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 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 okhttp3.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 PtsV2PaymentsRefundPost201Response refundPayment(RefundPaymentRequest refundPaymentRequest,
                                                        String id)
                                                 throws ApiException

Refund a Payment Refund 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 refund the payment amount.

Parameters:

refundPaymentRequest - (required)

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

Returns:

PtsV2PaymentsRefundPost201Response

Throws:

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

refundPaymentWithHttpInfo

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

Refund a Payment Refund 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 refund the payment amount.

Parameters:

refundPaymentRequest - (required)

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

Returns:

ApiResponse<PtsV2PaymentsRefundPost201Response>

Throws:

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

refundPaymentAsync

public okhttp3.Call refundPaymentAsync(RefundPaymentRequest refundPaymentRequest,
                                       String id,
                                       ApiCallback<PtsV2PaymentsRefundPost201Response> callback)
                                throws ApiException

Refund a Payment (asynchronously) Refund 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 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