com.cybersource.payments.api

Class CapturesApi

java.lang.Object

com.cybersource.payments.api.CapturesApi

public class CapturesApi
extends Object

Constructor Summary

Constructors

Constructor and Description
CapturesApi(Configuration configuration)

Method Summary

Modifier and Type	Method and Description
Capture	captureAuthorization(String id, CaptureRequest request) Capture a payment authorization.
ApiClient	getApiClient()
CaptureCollection	getAuthorizationCaptures(String id, Integer offset, Integer limit) Search for all captures.
GetCapture	getCapture(String id) Search for a specific capture.
CaptureCollection	getCaptures(Integer offset, Integer limit) Search for all captures.
void	setApiClient(ApiClient apiClient)

Methods inherited from class java.lang.Object

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

Constructor Detail

CapturesApi

public CapturesApi(Configuration configuration)

Method Detail

getApiClient

public ApiClient getApiClient()

setApiClient

public void setApiClient(ApiClient apiClient)

getAuthorizationCaptures

public CaptureCollection getAuthorizationCaptures(String id,
                                                  Integer offset,
                                                  Integer limit)
                                           throws ApiException

Search for all captures. Search for all captures by specifying an authorization ID.

Parameters:

id - Authorization transaction ID.

offset - This paging parameter specifies the page number.

limit - This paging parameter specifies the number of records per page.

Returns:

CaptureCollection

Throws:

ApiException

captureAuthorization

public Capture captureAuthorization(String id,
                                    CaptureRequest request)
                             throws ApiException

Capture a payment authorization. Capture a payment using the ID of the original authorization.

Parameters:

id - Transaction ID of the original authorization.

request - Capture request data.

Returns:

Capture

Throws:

ApiException

getCaptures

public CaptureCollection getCaptures(Integer offset,
                                     Integer limit)
                              throws ApiException

Search for all captures. Search for all captures.

Parameters:

offset - Element number.

limit - Page size.

Returns:

CaptureCollection

Throws:

ApiException

getCapture

public GetCapture getCapture(String id)
                      throws ApiException

Search for a specific capture. Search for a specific capture by specifying the original authorization ID.

Parameters:

id - Authorization transaction ID.

Returns:

GetCapture

Throws:

ApiException