Api

Class PaymentBatchSummariesApi

java.lang.Object

Api.PaymentBatchSummariesApi

public class PaymentBatchSummariesApi
extends Object

Constructor Summary

Constructors

Constructor and Description
PaymentBatchSummariesApi()
PaymentBatchSummariesApi(ApiClient apiClient)

Method Summary

Modifier and Type	Method and Description
ApiClient	getApiClient()
ReportingV3PaymentBatchSummariesGet200Response	getPaymentBatchSummary(org.joda.time.DateTime startTime, org.joda.time.DateTime endTime, String organizationId, String rollUp, String breakdown, Integer startDayOfWeek) Get Payment Batch Summary Data Scope can be either account/merchant or reseller.
okhttp3.Call	getPaymentBatchSummaryAsync(org.joda.time.DateTime startTime, org.joda.time.DateTime endTime, String organizationId, String rollUp, String breakdown, Integer startDayOfWeek, ApiCallback<ReportingV3PaymentBatchSummariesGet200Response> callback) Get Payment Batch Summary Data (asynchronously) Scope can be either account/merchant or reseller.
okhttp3.Call	getPaymentBatchSummaryCall(org.joda.time.DateTime startTime, org.joda.time.DateTime endTime, String organizationId, String rollUp, String breakdown, Integer startDayOfWeek, ProgressResponseBody.ProgressListener progressListener, ProgressRequestBody.ProgressRequestListener progressRequestListener) Build call for getPaymentBatchSummary
ApiResponse<ReportingV3PaymentBatchSummariesGet200Response>	getPaymentBatchSummaryWithHttpInfo(org.joda.time.DateTime startTime, org.joda.time.DateTime endTime, String organizationId, String rollUp, String breakdown, Integer startDayOfWeek) Get Payment Batch Summary Data Scope can be either account/merchant or reseller.
void	setApiClient(ApiClient apiClient)

Methods inherited from class java.lang.Object

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

Constructor Detail

PaymentBatchSummariesApi

public PaymentBatchSummariesApi()

PaymentBatchSummariesApi

public PaymentBatchSummariesApi(ApiClient apiClient)

Method Detail

getApiClient

public ApiClient getApiClient()

setApiClient

public void setApiClient(ApiClient apiClient)

getPaymentBatchSummaryCall

public okhttp3.Call getPaymentBatchSummaryCall(org.joda.time.DateTime startTime,
                                               org.joda.time.DateTime endTime,
                                               String organizationId,
                                               String rollUp,
                                               String breakdown,
                                               Integer startDayOfWeek,
                                               ProgressResponseBody.ProgressListener progressListener,
                                               ProgressRequestBody.ProgressRequestListener progressRequestListener)
                                        throws ApiException

Build call for getPaymentBatchSummary

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 Cybersource Organization Id (optional)

rollUp - Conditional - RollUp for data for day/week/month. Required while getting breakdown data for a Merchant (optional)

breakdown - Conditional - Breakdown on account_rollup/all_merchant/selected_merchant. Required while getting breakdown data for a Merchant. (optional)

startDayOfWeek - Optional - Start day of week to breakdown data for weeks in a month (optional)

progressListener - Progress listener

progressRequestListener - Progress request listener

Returns:

Call to execute

Throws:

ApiException - If fail to serialize the request body object

getPaymentBatchSummary

public ReportingV3PaymentBatchSummariesGet200Response getPaymentBatchSummary(org.joda.time.DateTime startTime,
                                                                             org.joda.time.DateTime endTime,
                                                                             String organizationId,
                                                                             String rollUp,
                                                                             String breakdown,
                                                                             Integer startDayOfWeek)
                                                                      throws ApiException

Get Payment Batch Summary Data Scope can be either account/merchant or reseller.

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 Cybersource Organization Id (optional)

rollUp - Conditional - RollUp for data for day/week/month. Required while getting breakdown data for a Merchant (optional)

breakdown - Conditional - Breakdown on account_rollup/all_merchant/selected_merchant. Required while getting breakdown data for a Merchant. (optional)

startDayOfWeek - Optional - Start day of week to breakdown data for weeks in a month (optional)

Returns:

ReportingV3PaymentBatchSummariesGet200Response

Throws:

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

getPaymentBatchSummaryWithHttpInfo

public ApiResponse<ReportingV3PaymentBatchSummariesGet200Response> getPaymentBatchSummaryWithHttpInfo(org.joda.time.DateTime startTime,
                                                                                                      org.joda.time.DateTime endTime,
                                                                                                      String organizationId,
                                                                                                      String rollUp,
                                                                                                      String breakdown,
                                                                                                      Integer startDayOfWeek)
                                                                                               throws ApiException

Get Payment Batch Summary Data Scope can be either account/merchant or reseller.

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 Cybersource Organization Id (optional)

rollUp - Conditional - RollUp for data for day/week/month. Required while getting breakdown data for a Merchant (optional)

breakdown - Conditional - Breakdown on account_rollup/all_merchant/selected_merchant. Required while getting breakdown data for a Merchant. (optional)

startDayOfWeek - Optional - Start day of week to breakdown data for weeks in a month (optional)

Returns:

ApiResponse<ReportingV3PaymentBatchSummariesGet200Response>

Throws:

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

getPaymentBatchSummaryAsync

public okhttp3.Call getPaymentBatchSummaryAsync(org.joda.time.DateTime startTime,
                                                org.joda.time.DateTime endTime,
                                                String organizationId,
                                                String rollUp,
                                                String breakdown,
                                                Integer startDayOfWeek,
                                                ApiCallback<ReportingV3PaymentBatchSummariesGet200Response> callback)
                                         throws ApiException

Get Payment Batch Summary Data (asynchronously) Scope can be either account/merchant or reseller.

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 Cybersource Organization Id (optional)

rollUp - Conditional - RollUp for data for day/week/month. Required while getting breakdown data for a Merchant (optional)

breakdown - Conditional - Breakdown on account_rollup/all_merchant/selected_merchant. Required while getting breakdown data for a Merchant. (optional)

startDayOfWeek - Optional - Start day of week to breakdown data for weeks in a month (optional)

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