Api

Class PurchaseAndRefundDetailsApi

java.lang.Object

Api.PurchaseAndRefundDetailsApi

public class PurchaseAndRefundDetailsApi
extends Object

Constructor Summary

Constructors

Constructor and Description
PurchaseAndRefundDetailsApi()
PurchaseAndRefundDetailsApi(ApiClient apiClient)

Method Summary

Modifier and Type	Method and Description
ApiClient	getApiClient()
ReportingV3PurchaseRefundDetailsGet200Response	getPurchaseAndRefundDetails(org.joda.time.DateTime startTime, org.joda.time.DateTime endTime, String organizationId, String paymentSubtype, String viewBy, String groupName, Integer offset, Integer limit) Get Purchase and Refund Details Download the Purchase and Refund Details report.
okhttp3.Call	getPurchaseAndRefundDetailsAsync(org.joda.time.DateTime startTime, org.joda.time.DateTime endTime, String organizationId, String paymentSubtype, String viewBy, String groupName, Integer offset, Integer limit, ApiCallback<ReportingV3PurchaseRefundDetailsGet200Response> callback) Get Purchase and Refund Details (asynchronously) Download the Purchase and Refund Details report.
okhttp3.Call	getPurchaseAndRefundDetailsCall(org.joda.time.DateTime startTime, org.joda.time.DateTime endTime, String organizationId, String paymentSubtype, String viewBy, String groupName, Integer offset, Integer limit, ProgressResponseBody.ProgressListener progressListener, ProgressRequestBody.ProgressRequestListener progressRequestListener) Build call for getPurchaseAndRefundDetails
ApiResponse<ReportingV3PurchaseRefundDetailsGet200Response>	getPurchaseAndRefundDetailsWithHttpInfo(org.joda.time.DateTime startTime, org.joda.time.DateTime endTime, String organizationId, String paymentSubtype, String viewBy, String groupName, Integer offset, Integer limit) Get Purchase and Refund Details Download the Purchase and Refund Details report.
void	setApiClient(ApiClient apiClient)

Methods inherited from class java.lang.Object

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

Constructor Detail

PurchaseAndRefundDetailsApi

public PurchaseAndRefundDetailsApi()

PurchaseAndRefundDetailsApi

public PurchaseAndRefundDetailsApi(ApiClient apiClient)

Method Detail

getApiClient

public ApiClient getApiClient()

setApiClient

public void setApiClient(ApiClient apiClient)

getPurchaseAndRefundDetailsCall

public okhttp3.Call getPurchaseAndRefundDetailsCall(org.joda.time.DateTime startTime,
                                                    org.joda.time.DateTime endTime,
                                                    String organizationId,
                                                    String paymentSubtype,
                                                    String viewBy,
                                                    String groupName,
                                                    Integer offset,
                                                    Integer limit,
                                                    ProgressResponseBody.ProgressListener progressListener,
                                                    ProgressRequestBody.ProgressRequestListener progressRequestListener)
                                             throws ApiException

Build call for getPurchaseAndRefundDetails

Parameters:

startTime - Valid report Start Time in **ISO 8601 format** Please refer the following link to know more about ISO 8601 format.[Rfc Date Format](https://xml2rfc.tools.ietf.org/public/rfc/html/rfc3339.html#anchor14) **Example date format:** - yyyy-MM-dd'T'HH:mm:ss.SSSZ (e.g. 2018-01-01T00:00:00.000Z) (required)

endTime - Valid report End Time in **ISO 8601 format** Please refer the following link to know more about ISO 8601 format.[Rfc Date Format](https://xml2rfc.tools.ietf.org/public/rfc/html/rfc3339.html#anchor14) **Example date format:** - yyyy-MM-dd'T'HH:mm:ss.SSSZ (e.g. 2018-01-01T00:00:00.000Z) (required)

organizationId - Valid Organization Id (optional)

paymentSubtype - Payment Subtypes. - **ALL**: All Payment Subtypes - **VI** : Visa - **MC** : Master Card - **AX** : American Express - **DI** : Discover - **DP** : Pinless Debit (optional, default to ALL)

viewBy - View results by Request Date or Submission Date. - **requestDate** : Request Date - **submissionDate**: Submission Date (optional, default to requestDate)

groupName - Valid CyberSource Group Name.User can define groups using CBAPI and Group Management Module in EBC2. Groups are collection of organizationIds (optional)

offset - Offset of the Purchase and Refund Results. (optional)

limit - Results count per page. Range(1-2000) (optional, default to 2000)

progressListener - Progress listener

progressRequestListener - Progress request listener

Returns:

Call to execute

Throws:

ApiException - If fail to serialize the request body object

getPurchaseAndRefundDetails

public ReportingV3PurchaseRefundDetailsGet200Response getPurchaseAndRefundDetails(org.joda.time.DateTime startTime,
                                                                                  org.joda.time.DateTime endTime,
                                                                                  String organizationId,
                                                                                  String paymentSubtype,
                                                                                  String viewBy,
                                                                                  String groupName,
                                                                                  Integer offset,
                                                                                  Integer limit)
                                                                           throws ApiException

Get Purchase and Refund Details Download the Purchase and Refund Details report. This report report includes all purchases and refund transactions, as well as all activities related to transactions resulting in an adjustment to the net proceeds.

Parameters:

startTime - Valid report Start Time in **ISO 8601 format** Please refer the following link to know more about ISO 8601 format.[Rfc Date Format](https://xml2rfc.tools.ietf.org/public/rfc/html/rfc3339.html#anchor14) **Example date format:** - yyyy-MM-dd'T'HH:mm:ss.SSSZ (e.g. 2018-01-01T00:00:00.000Z) (required)

endTime - Valid report End Time in **ISO 8601 format** Please refer the following link to know more about ISO 8601 format.[Rfc Date Format](https://xml2rfc.tools.ietf.org/public/rfc/html/rfc3339.html#anchor14) **Example date format:** - yyyy-MM-dd'T'HH:mm:ss.SSSZ (e.g. 2018-01-01T00:00:00.000Z) (required)

organizationId - Valid Organization Id (optional)

paymentSubtype - Payment Subtypes. - **ALL**: All Payment Subtypes - **VI** : Visa - **MC** : Master Card - **AX** : American Express - **DI** : Discover - **DP** : Pinless Debit (optional, default to ALL)

viewBy - View results by Request Date or Submission Date. - **requestDate** : Request Date - **submissionDate**: Submission Date (optional, default to requestDate)

groupName - Valid CyberSource Group Name.User can define groups using CBAPI and Group Management Module in EBC2. Groups are collection of organizationIds (optional)

offset - Offset of the Purchase and Refund Results. (optional)

limit - Results count per page. Range(1-2000) (optional, default to 2000)

Returns:

ReportingV3PurchaseRefundDetailsGet200Response

Throws:

ApiException - If fail to call the API, e.g. server error or cannot deserialize the response body

getPurchaseAndRefundDetailsWithHttpInfo

public ApiResponse<ReportingV3PurchaseRefundDetailsGet200Response> getPurchaseAndRefundDetailsWithHttpInfo(org.joda.time.DateTime startTime,
                                                                                                           org.joda.time.DateTime endTime,
                                                                                                           String organizationId,
                                                                                                           String paymentSubtype,
                                                                                                           String viewBy,
                                                                                                           String groupName,
                                                                                                           Integer offset,
                                                                                                           Integer limit)
                                                                                                    throws ApiException

Get Purchase and Refund Details Download the Purchase and Refund Details report. This report report includes all purchases and refund transactions, as well as all activities related to transactions resulting in an adjustment to the net proceeds.

Parameters:

startTime - Valid report Start Time in **ISO 8601 format** Please refer the following link to know more about ISO 8601 format.[Rfc Date Format](https://xml2rfc.tools.ietf.org/public/rfc/html/rfc3339.html#anchor14) **Example date format:** - yyyy-MM-dd'T'HH:mm:ss.SSSZ (e.g. 2018-01-01T00:00:00.000Z) (required)

endTime - Valid report End Time in **ISO 8601 format** Please refer the following link to know more about ISO 8601 format.[Rfc Date Format](https://xml2rfc.tools.ietf.org/public/rfc/html/rfc3339.html#anchor14) **Example date format:** - yyyy-MM-dd'T'HH:mm:ss.SSSZ (e.g. 2018-01-01T00:00:00.000Z) (required)

organizationId - Valid Organization Id (optional)

paymentSubtype - Payment Subtypes. - **ALL**: All Payment Subtypes - **VI** : Visa - **MC** : Master Card - **AX** : American Express - **DI** : Discover - **DP** : Pinless Debit (optional, default to ALL)

viewBy - View results by Request Date or Submission Date. - **requestDate** : Request Date - **submissionDate**: Submission Date (optional, default to requestDate)

groupName - Valid CyberSource Group Name.User can define groups using CBAPI and Group Management Module in EBC2. Groups are collection of organizationIds (optional)

offset - Offset of the Purchase and Refund Results. (optional)

limit - Results count per page. Range(1-2000) (optional, default to 2000)

Returns:

ApiResponse<ReportingV3PurchaseRefundDetailsGet200Response>

Throws:

ApiException - If fail to call the API, e.g. server error or cannot deserialize the response body

getPurchaseAndRefundDetailsAsync

public okhttp3.Call getPurchaseAndRefundDetailsAsync(org.joda.time.DateTime startTime,
                                                     org.joda.time.DateTime endTime,
                                                     String organizationId,
                                                     String paymentSubtype,
                                                     String viewBy,
                                                     String groupName,
                                                     Integer offset,
                                                     Integer limit,
                                                     ApiCallback<ReportingV3PurchaseRefundDetailsGet200Response> callback)
                                              throws ApiException

Get Purchase and Refund Details (asynchronously) Download the Purchase and Refund Details report. This report report includes all purchases and refund transactions, as well as all activities related to transactions resulting in an adjustment to the net proceeds.

Parameters:

startTime - Valid report Start Time in **ISO 8601 format** Please refer the following link to know more about ISO 8601 format.[Rfc Date Format](https://xml2rfc.tools.ietf.org/public/rfc/html/rfc3339.html#anchor14) **Example date format:** - yyyy-MM-dd'T'HH:mm:ss.SSSZ (e.g. 2018-01-01T00:00:00.000Z) (required)

endTime - Valid report End Time in **ISO 8601 format** Please refer the following link to know more about ISO 8601 format.[Rfc Date Format](https://xml2rfc.tools.ietf.org/public/rfc/html/rfc3339.html#anchor14) **Example date format:** - yyyy-MM-dd'T'HH:mm:ss.SSSZ (e.g. 2018-01-01T00:00:00.000Z) (required)

organizationId - Valid Organization Id (optional)

paymentSubtype - Payment Subtypes. - **ALL**: All Payment Subtypes - **VI** : Visa - **MC** : Master Card - **AX** : American Express - **DI** : Discover - **DP** : Pinless Debit (optional, default to ALL)

viewBy - View results by Request Date or Submission Date. - **requestDate** : Request Date - **submissionDate**: Submission Date (optional, default to requestDate)

groupName - Valid CyberSource Group Name.User can define groups using CBAPI and Group Management Module in EBC2. Groups are collection of organizationIds (optional)

offset - Offset of the Purchase and Refund Results. (optional)

limit - Results count per page. Range(1-2000) (optional, default to 2000)

callback - The callback to be executed when the API call finishes

Returns:

The request call

Throws:

ApiException - If fail to process the API call, e.g. serializing the request body object