com.cybersource.payments.api

Class VoidsApi

java.lang.Object

com.cybersource.payments.api.VoidsApi

public class VoidsApi
extends Object

Constructor Summary

Constructors

Constructor and Description
VoidsApi(Configuration configuration)

Method Summary

Modifier and Type	Method and Description
ApiClient	getApiClient()
Void	getVoid(String id) Retrieve a void by specifying the void ID.
void	setApiClient(ApiClient apiClient)
Void	voidCapture(String id, VoidRequest request) Void a particular captured transaction by specifying the capture ID.
Void	voidCredit(String id, VoidRequest request) Void a credit.
Void	voidRefund(String id, VoidRequest request) Void a refund transaction.
Void	voidSale(String id, VoidRequest request) Void a particular sale transaction by specifying the sale ID.

Methods inherited from class java.lang.Object

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

Constructor Detail

VoidsApi

public VoidsApi(Configuration configuration)

Method Detail

getApiClient

public ApiClient getApiClient()

setApiClient

public void setApiClient(ApiClient apiClient)

voidCapture

public Void voidCapture(String id,
                        VoidRequest request)
                 throws ApiException

Void a particular captured transaction by specifying the capture ID.

Parameters:

id - Capture transaction ID.

request - Void request data.

Returns:

Void

Throws:

ApiException

voidCredit

public Void voidCredit(String id,
                       VoidRequest request)
                throws ApiException

Void a credit. Void a credit by specifying the credit ID.

Parameters:

id - Credit ID.

request - Request data.

Returns:

Void

Throws:

ApiException

voidRefund

public Void voidRefund(String id,
                       VoidRequest request)
                throws ApiException

Void a refund transaction.

Parameters:

id - Refund transaction ID.

request - Void request data.

Returns:

Void

Throws:

ApiException

voidSale

public Void voidSale(String id,
                     VoidRequest request)
              throws ApiException

Void a particular sale transaction by specifying the sale ID.

Parameters:

id - Sales transaction ID.

request - Void request data.

Returns:

Void

Throws:

ApiException

getVoid

public Void getVoid(String id)
             throws ApiException

Retrieve a void by specifying the void ID.

Parameters:

id - Unique identifier for the transaction.

Returns:

Void

Throws:

ApiException