Api

Class ReversalApi

java.lang.Object

Api.ReversalApi

public class ReversalApi
extends Object

Constructor Summary

Constructors

Constructor	Description
ReversalApi()
ReversalApi(ApiClient apiClient)

Method Summary

Modifier and Type	Method	Description
PtsV2PaymentsReversalsPost201Response	authReversal(String id, AuthReversalRequest authReversalRequest)	Process an Authorization Reversal Include the payment ID in the POST request to reverse the payment amount.
okhttp3.Call	authReversalAsync(String id, AuthReversalRequest authReversalRequest, ApiCallback<PtsV2PaymentsReversalsPost201Response> callback)	Process an Authorization Reversal (asynchronously) Include the payment ID in the POST request to reverse the payment amount.
okhttp3.Call	authReversalCall(String id, AuthReversalRequest authReversalRequest, ProgressResponseBody.ProgressListener progressListener, ProgressRequestBody.ProgressRequestListener progressRequestListener)	Build call for authReversal
ApiResponse<PtsV2PaymentsReversalsPost201Response>	authReversalWithHttpInfo(String id, AuthReversalRequest authReversalRequest)	Process an Authorization Reversal Include the payment ID in the POST request to reverse the payment amount.
ApiClient	getApiClient()
PtsV2PaymentsReversalsPost201Response	mitReversal(MitReversalRequest mitReversalRequest)	Timeout Reversal This is to reverse a previous payment that merchant does not receive a reply(Mostly due to Timeout).
okhttp3.Call	mitReversalAsync(MitReversalRequest mitReversalRequest, ApiCallback<PtsV2PaymentsReversalsPost201Response> callback)	Timeout Reversal (asynchronously) This is to reverse a previous payment that merchant does not receive a reply(Mostly due to Timeout).
okhttp3.Call	mitReversalCall(MitReversalRequest mitReversalRequest, ProgressResponseBody.ProgressListener progressListener, ProgressRequestBody.ProgressRequestListener progressRequestListener)	Build call for mitReversal
ApiResponse<PtsV2PaymentsReversalsPost201Response>	mitReversalWithHttpInfo(MitReversalRequest mitReversalRequest)	Timeout Reversal This is to reverse a previous payment that merchant does not receive a reply(Mostly due to Timeout).
void	setApiClient(ApiClient apiClient)

Methods inherited from class java.lang.Object

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

Constructor Detail

ReversalApi

public ReversalApi()

ReversalApi

public ReversalApi(ApiClient apiClient)

Method Detail

getApiClient

public ApiClient getApiClient()

setApiClient

public void setApiClient(ApiClient apiClient)

authReversalCall

public okhttp3.Call authReversalCall(String id,
                                     AuthReversalRequest authReversalRequest,
                                     ProgressResponseBody.ProgressListener progressListener,
                                     ProgressRequestBody.ProgressRequestListener progressRequestListener)
                              throws ApiException,
                                     com.cybersource.authsdk.core.ConfigException

Build call for authReversal

Parameters:

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

authReversalRequest - (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

authReversal

public PtsV2PaymentsReversalsPost201Response authReversal(String id,
                                                          AuthReversalRequest authReversalRequest)
                                                   throws ApiException,
                                                          com.cybersource.authsdk.core.ConfigException

Process an Authorization Reversal Include the payment ID in the POST request to reverse the payment amount.

Parameters:

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

authReversalRequest - (required)

Returns:

PtsV2PaymentsReversalsPost201Response

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

authReversalWithHttpInfo

public ApiResponse<PtsV2PaymentsReversalsPost201Response> authReversalWithHttpInfo(String id,
                                                                                   AuthReversalRequest authReversalRequest)
                                                                            throws ApiException,
                                                                                   com.cybersource.authsdk.core.ConfigException

Process an Authorization Reversal Include the payment ID in the POST request to reverse the payment amount.

Parameters:

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

authReversalRequest - (required)

Returns:

ApiResponse<PtsV2PaymentsReversalsPost201Response>

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

authReversalAsync

public okhttp3.Call authReversalAsync(String id,
                                      AuthReversalRequest authReversalRequest,
                                      ApiCallback<PtsV2PaymentsReversalsPost201Response> callback)
                               throws ApiException,
                                      com.cybersource.authsdk.core.ConfigException

Process an Authorization Reversal (asynchronously) Include the payment ID in the POST request to reverse the payment amount.

Parameters:

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

authReversalRequest - (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

mitReversalCall

public okhttp3.Call mitReversalCall(MitReversalRequest mitReversalRequest,
                                    ProgressResponseBody.ProgressListener progressListener,
                                    ProgressRequestBody.ProgressRequestListener progressRequestListener)
                             throws ApiException,
                                    com.cybersource.authsdk.core.ConfigException

Build call for mitReversal

Parameters:

mitReversalRequest - (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

mitReversal

public PtsV2PaymentsReversalsPost201Response mitReversal(MitReversalRequest mitReversalRequest)
                                                  throws ApiException,
                                                         com.cybersource.authsdk.core.ConfigException

Timeout Reversal This is to reverse a previous payment 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 [/pts/v2/payments](https://developer.cybersource.com/api-reference-assets/index.html#payments_payments) API call and use same transactionId in this API request payload to reverse the payment.

Parameters:

mitReversalRequest - (required)

Returns:

PtsV2PaymentsReversalsPost201Response

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

mitReversalWithHttpInfo

public ApiResponse<PtsV2PaymentsReversalsPost201Response> mitReversalWithHttpInfo(MitReversalRequest mitReversalRequest)
                                                                           throws ApiException,
                                                                                  com.cybersource.authsdk.core.ConfigException

Timeout Reversal This is to reverse a previous payment 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 [/pts/v2/payments](https://developer.cybersource.com/api-reference-assets/index.html#payments_payments) API call and use same transactionId in this API request payload to reverse the payment.

Parameters:

mitReversalRequest - (required)

Returns:

ApiResponse<PtsV2PaymentsReversalsPost201Response>

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

mitReversalAsync

public okhttp3.Call mitReversalAsync(MitReversalRequest mitReversalRequest,
                                     ApiCallback<PtsV2PaymentsReversalsPost201Response> callback)
                              throws ApiException,
                                     com.cybersource.authsdk.core.ConfigException

Timeout Reversal (asynchronously) This is to reverse a previous payment 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 [/pts/v2/payments](https://developer.cybersource.com/api-reference-assets/index.html#payments_payments) API call and use same transactionId in this API request payload to reverse the payment.

Parameters:

mitReversalRequest - (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