com.cybersource.payments.api

Class PaymentsApi

java.lang.Object

com.cybersource.payments.api.PaymentsApi

public class PaymentsApi
extends Object

Constructor Summary

Constructors

Constructor and Description
PaymentsApi(Configuration configuration)

Method Summary

Modifier and Type	Method and Description
ApiClient	getApiClient()
ErrorResource	getError(String id) Get error Details.
Transaction	getPayment(String id) Get submitted authorizations, sales, captures, or refunds.
TransactionSearchCollection	searchPayment(TransactionSearchRequest request, Integer offset, Integer limit) Transaction Search.
void	setApiClient(ApiClient apiClient)

Methods inherited from class java.lang.Object

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

Constructor Detail

PaymentsApi

public PaymentsApi(Configuration configuration)

Method Detail

getApiClient

public ApiClient getApiClient()

setApiClient

public void setApiClient(ApiClient apiClient)

getError

public ErrorResource getError(String id)
                       throws ApiException

Get error Details. Retrieve the error details, including the associated request and response data, by specifying the correlation ID that uniquely identifies the error.

Parameters:

id - Correlation ID

Returns:

ErrorResource

Throws:

ApiException

searchPayment

public TransactionSearchCollection searchPayment(TransactionSearchRequest request,
                                                 Integer offset,
                                                 Integer limit)
                                          throws ApiException

Transaction Search. Search for transactions by specifying certain parameters.

Parameters:

request - Search transaction request.

offset - This paging parameter is used to specify the page number.

limit - This paging parameter is used to specify the number of records per page.

Returns:

TransactionSearchCollection

Throws:

ApiException

getPayment

public Transaction getPayment(String id)
                       throws ApiException

Get submitted authorizations, sales, captures, or refunds. Specify a transaction ID to return a specific payment resource. The payments endpoint returns information about your submitted payments. The response includes transaction details.

Parameters:

id - transaction id

Returns:

Transaction

Throws:

ApiException