Api

Class BatchesApi

java.lang.Object

Api.BatchesApi

public class BatchesApi
extends Object

Constructor Summary

Constructors

Constructor and Description
BatchesApi()
BatchesApi(ApiClient apiClient)

Method Summary

Modifier and Type	Method and Description
ApiClient	getApiClient()
InlineResponse2005	getBatchesList(Long offset, Long limit, String fromDate, String toDate) List Batches **List Batches**<br>This resource accepts a optional date range, record offset and limit, returning a paginated response of batches containing: - The batch id.
okhttp3.Call	getBatchesListAsync(Long offset, Long limit, String fromDate, String toDate, ApiCallback<InlineResponse2005> callback) List Batches (asynchronously) **List Batches**<br>This resource accepts a optional date range, record offset and limit, returning a paginated response of batches containing: - The batch id.
okhttp3.Call	getBatchesListCall(Long offset, Long limit, String fromDate, String toDate, ProgressResponseBody.ProgressListener progressListener, ProgressRequestBody.ProgressRequestListener progressRequestListener) Build call for getBatchesList
ApiResponse<InlineResponse2005>	getBatchesListWithHttpInfo(Long offset, Long limit, String fromDate, String toDate) List Batches **List Batches**<br>This resource accepts a optional date range, record offset and limit, returning a paginated response of batches containing: - The batch id.
InlineResponse2007	getBatchReport(String batchId) Retrieve a Batch Report **Get Batch Report**<br>This resource accepts a batch id and returns: - The batch status.
okhttp3.Call	getBatchReportAsync(String batchId, ApiCallback<InlineResponse2007> callback) Retrieve a Batch Report (asynchronously) **Get Batch Report**<br>This resource accepts a batch id and returns: - The batch status.
okhttp3.Call	getBatchReportCall(String batchId, ProgressResponseBody.ProgressListener progressListener, ProgressRequestBody.ProgressRequestListener progressRequestListener) Build call for getBatchReport
ApiResponse<InlineResponse2007>	getBatchReportWithHttpInfo(String batchId) Retrieve a Batch Report **Get Batch Report**<br>This resource accepts a batch id and returns: - The batch status.
InlineResponse2006	getBatchStatus(String batchId) Retrieve a Batch Status **Get Batch Status**<br>This resource accepts a batch id and returns: - The batch status.
okhttp3.Call	getBatchStatusAsync(String batchId, ApiCallback<InlineResponse2006> callback) Retrieve a Batch Status (asynchronously) **Get Batch Status**<br>This resource accepts a batch id and returns: - The batch status.
okhttp3.Call	getBatchStatusCall(String batchId, ProgressResponseBody.ProgressListener progressListener, ProgressRequestBody.ProgressRequestListener progressRequestListener) Build call for getBatchStatus
ApiResponse<InlineResponse2006>	getBatchStatusWithHttpInfo(String batchId) Retrieve a Batch Status **Get Batch Status**<br>This resource accepts a batch id and returns: - The batch status.
InlineResponse202	postBatch(Body body) Create a Batch **Create a Batch**<br>This resource accepts TMS tokens ids of a Customer, Payment Instrument or Instrument Identifier.
okhttp3.Call	postBatchAsync(Body body, ApiCallback<InlineResponse202> callback) Create a Batch (asynchronously) **Create a Batch**<br>This resource accepts TMS tokens ids of a Customer, Payment Instrument or Instrument Identifier.
okhttp3.Call	postBatchCall(Body body, ProgressResponseBody.ProgressListener progressListener, ProgressRequestBody.ProgressRequestListener progressRequestListener) Build call for postBatch
ApiResponse<InlineResponse202>	postBatchWithHttpInfo(Body body) Create a Batch **Create a Batch**<br>This resource accepts TMS tokens ids of a Customer, Payment Instrument or Instrument Identifier.
void	setApiClient(ApiClient apiClient)

Methods inherited from class java.lang.Object

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

Constructor Detail

BatchesApi

public BatchesApi()

BatchesApi

public BatchesApi(ApiClient apiClient)

Method Detail

getApiClient

public ApiClient getApiClient()

setApiClient

public void setApiClient(ApiClient apiClient)

getBatchReportCall

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

Build call for getBatchReport

Parameters:

batchId - Unique identification number assigned to the submitted request. (required)

progressListener - Progress listener

progressRequestListener - Progress request listener

Returns:

Call to execute

Throws:

ApiException - If fail to serialize the request body object

getBatchReport

public InlineResponse2007 getBatchReport(String batchId)
                                  throws ApiException

Retrieve a Batch Report **Get Batch Report**<br>This resource accepts a batch id and returns: - The batch status. - The total number of accepted, rejected, updated records. - The total number of card association responses. - The billable quantities of: - New Account Numbers (NAN) - New Expiry Dates (NED) - Account Closures (ACL) - Contact Card Holders (CCH) - Source record information including token ids, masked card number, expiration dates & card type. - Response record information including response code, reason, token ids, masked card number, expiration dates & card type.

Parameters:

batchId - Unique identification number assigned to the submitted request. (required)

Returns:

InlineResponse2007

Throws:

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

getBatchReportWithHttpInfo

public ApiResponse<InlineResponse2007> getBatchReportWithHttpInfo(String batchId)
                                                           throws ApiException

Retrieve a Batch Report **Get Batch Report**<br>This resource accepts a batch id and returns: - The batch status. - The total number of accepted, rejected, updated records. - The total number of card association responses. - The billable quantities of: - New Account Numbers (NAN) - New Expiry Dates (NED) - Account Closures (ACL) - Contact Card Holders (CCH) - Source record information including token ids, masked card number, expiration dates & card type. - Response record information including response code, reason, token ids, masked card number, expiration dates & card type.

Parameters:

batchId - Unique identification number assigned to the submitted request. (required)

Returns:

ApiResponse<InlineResponse2007>

Throws:

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

getBatchReportAsync

public okhttp3.Call getBatchReportAsync(String batchId,
                                        ApiCallback<InlineResponse2007> callback)
                                 throws ApiException

Retrieve a Batch Report (asynchronously) **Get Batch Report**<br>This resource accepts a batch id and returns: - The batch status. - The total number of accepted, rejected, updated records. - The total number of card association responses. - The billable quantities of: - New Account Numbers (NAN) - New Expiry Dates (NED) - Account Closures (ACL) - Contact Card Holders (CCH) - Source record information including token ids, masked card number, expiration dates & card type. - Response record information including response code, reason, token ids, masked card number, expiration dates & card type.

Parameters:

batchId - Unique identification number assigned to the submitted request. (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

getBatchStatusCall

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

Build call for getBatchStatus

Parameters:

batchId - Unique identification number assigned to the submitted request. (required)

progressListener - Progress listener

progressRequestListener - Progress request listener

Returns:

Call to execute

Throws:

ApiException - If fail to serialize the request body object

getBatchStatus

public InlineResponse2006 getBatchStatus(String batchId)
                                  throws ApiException

Retrieve a Batch Status **Get Batch Status**<br>This resource accepts a batch id and returns: - The batch status. - The total number of accepted, rejected, updated records. - The total number of card association responses. - The billable quantities of: - New Account Numbers (NAN) - New Expiry Dates (NED) - Account Closures (ACL) - Contact Card Holders (CCH)

Parameters:

batchId - Unique identification number assigned to the submitted request. (required)

Returns:

InlineResponse2006

Throws:

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

getBatchStatusWithHttpInfo

public ApiResponse<InlineResponse2006> getBatchStatusWithHttpInfo(String batchId)
                                                           throws ApiException

Retrieve a Batch Status **Get Batch Status**<br>This resource accepts a batch id and returns: - The batch status. - The total number of accepted, rejected, updated records. - The total number of card association responses. - The billable quantities of: - New Account Numbers (NAN) - New Expiry Dates (NED) - Account Closures (ACL) - Contact Card Holders (CCH)

Parameters:

batchId - Unique identification number assigned to the submitted request. (required)

Returns:

ApiResponse<InlineResponse2006>

Throws:

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

getBatchStatusAsync

public okhttp3.Call getBatchStatusAsync(String batchId,
                                        ApiCallback<InlineResponse2006> callback)
                                 throws ApiException

Retrieve a Batch Status (asynchronously) **Get Batch Status**<br>This resource accepts a batch id and returns: - The batch status. - The total number of accepted, rejected, updated records. - The total number of card association responses. - The billable quantities of: - New Account Numbers (NAN) - New Expiry Dates (NED) - Account Closures (ACL) - Contact Card Holders (CCH)

Parameters:

batchId - Unique identification number assigned to the submitted request. (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

getBatchesListCall

public okhttp3.Call getBatchesListCall(Long offset,
                                       Long limit,
                                       String fromDate,
                                       String toDate,
                                       ProgressResponseBody.ProgressListener progressListener,
                                       ProgressRequestBody.ProgressRequestListener progressRequestListener)
                                throws ApiException

Build call for getBatchesList

Parameters:

offset - Starting record in zero-based dataset that should be returned as the first object in the array. (optional, default to 0)

limit - The maximum number that can be returned in the array starting from the offset record in zero-based dataset. (optional, default to 20)

fromDate - ISO-8601 format: yyyyMMddTHHmmssZ (optional)

toDate - ISO-8601 format: yyyyMMddTHHmmssZ (optional)

progressListener - Progress listener

progressRequestListener - Progress request listener

Returns:

Call to execute

Throws:

ApiException - If fail to serialize the request body object

getBatchesList

public InlineResponse2005 getBatchesList(Long offset,
                                         Long limit,
                                         String fromDate,
                                         String toDate)
                                  throws ApiException

List Batches **List Batches**<br>This resource accepts a optional date range, record offset and limit, returning a paginated response of batches containing: - The batch id. - The batch status. - The batch created / modified dates. - The total number of accepted, rejected, updated records. - The total number of card association responses.

Parameters:

offset - Starting record in zero-based dataset that should be returned as the first object in the array. (optional, default to 0)

limit - The maximum number that can be returned in the array starting from the offset record in zero-based dataset. (optional, default to 20)

fromDate - ISO-8601 format: yyyyMMddTHHmmssZ (optional)

toDate - ISO-8601 format: yyyyMMddTHHmmssZ (optional)

Returns:

InlineResponse2005

Throws:

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

getBatchesListWithHttpInfo

public ApiResponse<InlineResponse2005> getBatchesListWithHttpInfo(Long offset,
                                                                  Long limit,
                                                                  String fromDate,
                                                                  String toDate)
                                                           throws ApiException

List Batches **List Batches**<br>This resource accepts a optional date range, record offset and limit, returning a paginated response of batches containing: - The batch id. - The batch status. - The batch created / modified dates. - The total number of accepted, rejected, updated records. - The total number of card association responses.

Parameters:

offset - Starting record in zero-based dataset that should be returned as the first object in the array. (optional, default to 0)

limit - The maximum number that can be returned in the array starting from the offset record in zero-based dataset. (optional, default to 20)

fromDate - ISO-8601 format: yyyyMMddTHHmmssZ (optional)

toDate - ISO-8601 format: yyyyMMddTHHmmssZ (optional)

Returns:

ApiResponse<InlineResponse2005>

Throws:

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

getBatchesListAsync

public okhttp3.Call getBatchesListAsync(Long offset,
                                        Long limit,
                                        String fromDate,
                                        String toDate,
                                        ApiCallback<InlineResponse2005> callback)
                                 throws ApiException

List Batches (asynchronously) **List Batches**<br>This resource accepts a optional date range, record offset and limit, returning a paginated response of batches containing: - The batch id. - The batch status. - The batch created / modified dates. - The total number of accepted, rejected, updated records. - The total number of card association responses.

Parameters:

offset - Starting record in zero-based dataset that should be returned as the first object in the array. (optional, default to 0)

limit - The maximum number that can be returned in the array starting from the offset record in zero-based dataset. (optional, default to 20)

fromDate - ISO-8601 format: yyyyMMddTHHmmssZ (optional)

toDate - ISO-8601 format: yyyyMMddTHHmmssZ (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

postBatchCall

public okhttp3.Call postBatchCall(Body body,
                                  ProgressResponseBody.ProgressListener progressListener,
                                  ProgressRequestBody.ProgressRequestListener progressRequestListener)
                           throws ApiException

Build call for postBatch

Parameters:

body - (required)

progressListener - Progress listener

progressRequestListener - Progress request listener

Returns:

Call to execute

Throws:

ApiException - If fail to serialize the request body object

postBatch

public InlineResponse202 postBatch(Body body)
                            throws ApiException

Create a Batch **Create a Batch**<br>This resource accepts TMS tokens ids of a Customer, Payment Instrument or Instrument Identifier. <br> The card numbers for the supplied tokens ids are then sent to the relevant card associations to check for updates.<br>The following type of batches can be submitted: - **oneOff** batch containing tokens id for Visa or MasterCard card numbers. - **amexRegistration** batch containing tokens id for Amex card numbers. A batch id will be returned on a successful response which can be used to get the batch status and the batch report. The availability of API features for a merchant may depend on the portfolio configuration and may need to be enabled at the portfolio level before they can be added to merchant accounts.

Parameters:

body - (required)

Returns:

InlineResponse202

Throws:

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

postBatchWithHttpInfo

public ApiResponse<InlineResponse202> postBatchWithHttpInfo(Body body)
                                                     throws ApiException

Create a Batch **Create a Batch**<br>This resource accepts TMS tokens ids of a Customer, Payment Instrument or Instrument Identifier. <br> The card numbers for the supplied tokens ids are then sent to the relevant card associations to check for updates.<br>The following type of batches can be submitted: - **oneOff** batch containing tokens id for Visa or MasterCard card numbers. - **amexRegistration** batch containing tokens id for Amex card numbers. A batch id will be returned on a successful response which can be used to get the batch status and the batch report. The availability of API features for a merchant may depend on the portfolio configuration and may need to be enabled at the portfolio level before they can be added to merchant accounts.

Parameters:

body - (required)

Returns:

ApiResponse<InlineResponse202>

Throws:

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

postBatchAsync

public okhttp3.Call postBatchAsync(Body body,
                                   ApiCallback<InlineResponse202> callback)
                            throws ApiException

Create a Batch (asynchronously) **Create a Batch**<br>This resource accepts TMS tokens ids of a Customer, Payment Instrument or Instrument Identifier. <br> The card numbers for the supplied tokens ids are then sent to the relevant card associations to check for updates.<br>The following type of batches can be submitted: - **oneOff** batch containing tokens id for Visa or MasterCard card numbers. - **amexRegistration** batch containing tokens id for Amex card numbers. A batch id will be returned on a successful response which can be used to get the batch status and the batch report. The availability of API features for a merchant may depend on the portfolio configuration and may need to be enabled at the portfolio level before they can be added to merchant accounts.

Parameters:

body - (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