com.cybersource.payments.api

Class RefundsApi

java.lang.Object

com.cybersource.payments.api.RefundsApi

public class RefundsApi
extends Object

Constructor Summary

Constructors

Constructor and Description
RefundsApi(Configuration configuration)

Method Summary

Modifier and Type	Method and Description
ApiClient	getApiClient()
List<RefundCollection>	getCaptureRefunds(String captureId, Integer offset, Integer limit) Lists refunds for a capture.
GetRefund	getRefund(String id) Retrieve a refund.
RefundCollection	getRefunds(Integer offset, Integer limit) List refunds.
RefundCollection	getSaleRefunds(String saleId, Integer offset, Integer limit) List refunds for a sale.
Refund	refundCapture(String id, RefundRequest request) Refund a captured payment.
Refund	refundSale(String id, RefundRequest request) Refund a sale payment.
void	setApiClient(ApiClient apiClient)

Methods inherited from class java.lang.Object

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

Constructor Detail

RefundsApi

public RefundsApi(Configuration configuration)

Method Detail

getApiClient

public ApiClient getApiClient()

setApiClient

public void setApiClient(ApiClient apiClient)

getCaptureRefunds

public List<RefundCollection> getCaptureRefunds(String captureId,
                                                Integer offset,
                                                Integer limit)
                                         throws ApiException

Lists refunds for a capture. Returns a list of refunds for a particular capture transaction.

Parameters:

captureId - The ID of the capture to refund.

offset - offset

limit - limit

Returns:

List

Throws:

ApiException

refundCapture

public Refund refundCapture(String id,
                            RefundRequest request)
                     throws ApiException

Refund a captured payment. Creates a refund for a particular capture.

Parameters:

id - ID of the capture to refund.

request - Capture request data.

Returns:

Refund

Throws:

ApiException

getRefunds

public RefundCollection getRefunds(Integer offset,
                                   Integer limit)
                            throws ApiException

List refunds. Lists all successful refunds.

Parameters:

offset - offset

limit - limit

Returns:

RefundCollection

Throws:

ApiException

getRefund

public GetRefund getRefund(String id)
                    throws ApiException

Retrieve a refund. Retrieves a specific refund transaction by specifying the ID of the refund.

Parameters:

id - The ID of the refund.

Returns:

GetRefund

Throws:

ApiException

getSaleRefunds

public RefundCollection getSaleRefunds(String saleId,
                                       Integer offset,
                                       Integer limit)
                                throws ApiException

List refunds for a sale. Returns a list of refunds for a particular sale transaction.

Parameters:

saleId - The ID of the sale to refund.

offset - offset

limit - limit

Returns:

RefundCollection

Throws:

ApiException

refundSale

public Refund refundSale(String id,
                         RefundRequest request)
                  throws ApiException

Refund a sale payment. Creates a refund for a particular sale.

Parameters:

id - ID of the sale to refund.

request - Sale request data.

Returns:

Refund

Throws:

ApiException