com.cybersource.payments.api

Class SalesApi

java.lang.Object

com.cybersource.payments.api.SalesApi

public class SalesApi
extends Object

Constructor Summary

Constructors

Constructor and Description
SalesApi(Configuration configuration)

Method Summary

Modifier and Type	Method and Description
Sale	createSale(AuthCaptureRequest request) Perform a sale.
ApiClient	getApiClient()
GetSale	getSale(String id) Search for a sale.
SaleCollection	getSales(Integer offset, Integer limit) Search for all sales.
void	setApiClient(ApiClient apiClient)

Methods inherited from class java.lang.Object

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

Constructor Detail

SalesApi

public SalesApi(Configuration configuration)

Method Detail

getApiClient

public ApiClient getApiClient()

setApiClient

public void setApiClient(ApiClient apiClient)

getSales

public SaleCollection getSales(Integer offset,
                               Integer limit)
                        throws ApiException

Search for all sales. Search for all sales transactions using several paging options to narrow the results.

Parameters:

offset - Element number

limit - Page size

Returns:

SaleCollection

Throws:

ApiException

createSale

public Sale createSale(AuthCaptureRequest request)
                throws ApiException

Perform a sale. A sale transaction authorizes and captures a payment.

Parameters:

request - Perform a sale.

Returns:

Sale

Throws:

ApiException

getSale

public GetSale getSale(String id)
                throws ApiException

Search for a sale. Search for a specific sale transaction by specifying its ID.

Parameters:

id - Sales ID

Returns:

GetSale

Throws:

ApiException