Api

Class TransactionBatchesApi

java.lang.Object

Api.TransactionBatchesApi

public class TransactionBatchesApi
extends Object

Constructor Summary

Constructors

Constructor and Description
TransactionBatchesApi()
TransactionBatchesApi(ApiClient apiClient)

Method Summary

Modifier and Type	Method and Description
ApiClient	getApiClient()
void	getTransactionBatchDetails(String id, org.joda.time.LocalDate uploadDate, String status) Get Transaction Details for a given Batch Id Provides real-time detailed status information about the transactions that you previously uploaded in the Business Center or processed with the Offline Transaction File Submission service.
okhttp3.Call	getTransactionBatchDetailsAsync(String id, org.joda.time.LocalDate uploadDate, String status, ApiCallback<Void> callback) Get Transaction Details for a given Batch Id (asynchronously) Provides real-time detailed status information about the transactions that you previously uploaded in the Business Center or processed with the Offline Transaction File Submission service.
okhttp3.Call	getTransactionBatchDetailsCall(String id, org.joda.time.LocalDate uploadDate, String status, ProgressResponseBody.ProgressListener progressListener, ProgressRequestBody.ProgressRequestListener progressRequestListener) Build call for getTransactionBatchDetails
ApiResponse<InputStream>	getTransactionBatchDetailsWithHttpInfo(String id, org.joda.time.LocalDate uploadDate, String status) Get Transaction Details for a given Batch Id Provides real-time detailed status information about the transactions that you previously uploaded in the Business Center or processed with the Offline Transaction File Submission service.
PtsV1TransactionBatchesGet200Response	getTransactionBatches(org.joda.time.DateTime startTime, org.joda.time.DateTime endTime) Get a List of Batch Files Provide the search range
okhttp3.Call	getTransactionBatchesAsync(org.joda.time.DateTime startTime, org.joda.time.DateTime endTime, ApiCallback<PtsV1TransactionBatchesGet200Response> callback) Get a List of Batch Files (asynchronously) Provide the search range
okhttp3.Call	getTransactionBatchesCall(org.joda.time.DateTime startTime, org.joda.time.DateTime endTime, ProgressResponseBody.ProgressListener progressListener, ProgressRequestBody.ProgressRequestListener progressRequestListener) Build call for getTransactionBatches
ApiResponse<PtsV1TransactionBatchesGet200Response>	getTransactionBatchesWithHttpInfo(org.joda.time.DateTime startTime, org.joda.time.DateTime endTime) Get a List of Batch Files Provide the search range
PtsV1TransactionBatchesIdGet200Response	getTransactionBatchId(String id) Get Individual Batch File Provide the search range
okhttp3.Call	getTransactionBatchIdAsync(String id, ApiCallback<PtsV1TransactionBatchesIdGet200Response> callback) Get Individual Batch File (asynchronously) Provide the search range
okhttp3.Call	getTransactionBatchIdCall(String id, ProgressResponseBody.ProgressListener progressListener, ProgressRequestBody.ProgressRequestListener progressRequestListener) Build call for getTransactionBatchId
ApiResponse<PtsV1TransactionBatchesIdGet200Response>	getTransactionBatchIdWithHttpInfo(String id) Get Individual Batch File Provide the search range
void	setApiClient(ApiClient apiClient)

Methods inherited from class java.lang.Object

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

Constructor Detail

TransactionBatchesApi

public TransactionBatchesApi()

TransactionBatchesApi

public TransactionBatchesApi(ApiClient apiClient)

Method Detail

getApiClient

public ApiClient getApiClient()

setApiClient

public void setApiClient(ApiClient apiClient)

getTransactionBatchDetailsCall

public okhttp3.Call getTransactionBatchDetailsCall(String id,
                                                   org.joda.time.LocalDate uploadDate,
                                                   String status,
                                                   ProgressResponseBody.ProgressListener progressListener,
                                                   ProgressRequestBody.ProgressRequestListener progressRequestListener)
                                            throws ApiException

Build call for getTransactionBatchDetails

Parameters:

id - The batch id assigned for the template. (required)

uploadDate - Date in which the original batch file was uploaded. Date must be 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 (optional)

status - Allows you to filter by rejected response. Valid values: - Rejected (optional)

progressListener - Progress listener

progressRequestListener - Progress request listener

Returns:

Call to execute

Throws:

ApiException - If fail to serialize the request body object

getTransactionBatchDetails

public void getTransactionBatchDetails(String id,
                                       org.joda.time.LocalDate uploadDate,
                                       String status)
                                throws ApiException

Get Transaction Details for a given Batch Id Provides real-time detailed status information about the transactions that you previously uploaded in the Business Center or processed with the Offline Transaction File Submission service.

Parameters:

id - The batch id assigned for the template. (required)

uploadDate - Date in which the original batch file was uploaded. Date must be 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 (optional)

status - Allows you to filter by rejected response. Valid values: - Rejected (optional)

Throws:

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

getTransactionBatchDetailsWithHttpInfo

public ApiResponse<InputStream> getTransactionBatchDetailsWithHttpInfo(String id,
                                                                       org.joda.time.LocalDate uploadDate,
                                                                       String status)
                                                                throws ApiException

Get Transaction Details for a given Batch Id Provides real-time detailed status information about the transactions that you previously uploaded in the Business Center or processed with the Offline Transaction File Submission service.

Parameters:

id - The batch id assigned for the template. (required)

uploadDate - Date in which the original batch file was uploaded. Date must be 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 (optional)

status - Allows you to filter by rejected response. Valid values: - Rejected (optional)

Returns:

ApiResponse<Void>

Throws:

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

getTransactionBatchDetailsAsync

public okhttp3.Call getTransactionBatchDetailsAsync(String id,
                                                    org.joda.time.LocalDate uploadDate,
                                                    String status,
                                                    ApiCallback<Void> callback)
                                             throws ApiException

Get Transaction Details for a given Batch Id (asynchronously) Provides real-time detailed status information about the transactions that you previously uploaded in the Business Center or processed with the Offline Transaction File Submission service.

Parameters:

id - The batch id assigned for the template. (required)

uploadDate - Date in which the original batch file was uploaded. Date must be 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 (optional)

status - Allows you to filter by rejected response. Valid values: - Rejected (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

getTransactionBatchIdCall

public okhttp3.Call getTransactionBatchIdCall(String id,
                                              ProgressResponseBody.ProgressListener progressListener,
                                              ProgressRequestBody.ProgressRequestListener progressRequestListener)
                                       throws ApiException

Build call for getTransactionBatchId

Parameters:

id - The batch id assigned for the template. (required)

progressListener - Progress listener

progressRequestListener - Progress request listener

Returns:

Call to execute

Throws:

ApiException - If fail to serialize the request body object

getTransactionBatchId

public PtsV1TransactionBatchesIdGet200Response getTransactionBatchId(String id)
                                                              throws ApiException

Get Individual Batch File Provide the search range

Parameters:

id - The batch id assigned for the template. (required)

Returns:

PtsV1TransactionBatchesIdGet200Response

Throws:

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

getTransactionBatchIdWithHttpInfo

public ApiResponse<PtsV1TransactionBatchesIdGet200Response> getTransactionBatchIdWithHttpInfo(String id)
                                                                                       throws ApiException

Get Individual Batch File Provide the search range

Parameters:

id - The batch id assigned for the template. (required)

Returns:

ApiResponse<PtsV1TransactionBatchesIdGet200Response>

Throws:

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

getTransactionBatchIdAsync

public okhttp3.Call getTransactionBatchIdAsync(String id,
                                               ApiCallback<PtsV1TransactionBatchesIdGet200Response> callback)
                                        throws ApiException

Get Individual Batch File (asynchronously) Provide the search range

Parameters:

id - The batch id assigned for the template. (required)

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

getTransactionBatchesCall

public okhttp3.Call getTransactionBatchesCall(org.joda.time.DateTime startTime,
                                              org.joda.time.DateTime endTime,
                                              ProgressResponseBody.ProgressListener progressListener,
                                              ProgressRequestBody.ProgressRequestListener progressRequestListener)
                                       throws ApiException

Build call for getTransactionBatches

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.SSSZZ (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.SSSZZ (required)

progressListener - Progress listener

progressRequestListener - Progress request listener

Returns:

Call to execute

Throws:

ApiException - If fail to serialize the request body object

getTransactionBatches

public PtsV1TransactionBatchesGet200Response getTransactionBatches(org.joda.time.DateTime startTime,
                                                                   org.joda.time.DateTime endTime)
                                                            throws ApiException

Get a List of Batch Files Provide the search range

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.SSSZZ (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.SSSZZ (required)

Returns:

PtsV1TransactionBatchesGet200Response

Throws:

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

getTransactionBatchesWithHttpInfo

public ApiResponse<PtsV1TransactionBatchesGet200Response> getTransactionBatchesWithHttpInfo(org.joda.time.DateTime startTime,
                                                                                            org.joda.time.DateTime endTime)
                                                                                     throws ApiException

Get a List of Batch Files Provide the search range

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.SSSZZ (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.SSSZZ (required)

Returns:

ApiResponse<PtsV1TransactionBatchesGet200Response>

Throws:

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

getTransactionBatchesAsync

public okhttp3.Call getTransactionBatchesAsync(org.joda.time.DateTime startTime,
                                               org.joda.time.DateTime endTime,
                                               ApiCallback<PtsV1TransactionBatchesGet200Response> callback)
                                        throws ApiException

Get a List of Batch Files (asynchronously) Provide the search range

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.SSSZZ (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.SSSZZ (required)

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