|
| 1 | +# BatchesApi |
| 2 | + |
| 3 | +All URIs are relative to *https://apitest.cybersource.com* |
| 4 | + |
| 5 | +Method | HTTP request | Description |
| 6 | +------------- | ------------- | ------------- |
| 7 | +[**getBatchReport**](BatchesApi.md#getBatchReport) | **GET** /accountupdater/v1/batches/{batchId}/report | Retrieve a Batch Report |
| 8 | +[**getBatchStatus**](BatchesApi.md#getBatchStatus) | **GET** /accountupdater/v1/batches/{batchId}/status | Retrieve a Batch Status |
| 9 | +[**getBatchesList**](BatchesApi.md#getBatchesList) | **GET** /accountupdater/v1/batches | List Batches |
| 10 | +[**postBatch**](BatchesApi.md#postBatch) | **POST** /accountupdater/v1/batches | Create a Batch |
| 11 | + |
| 12 | + |
| 13 | +<a name="getBatchReport"></a> |
| 14 | +# **getBatchReport** |
| 15 | +> InlineResponse20014 getBatchReport(batchId) |
| 16 | +
|
| 17 | +Retrieve a Batch Report |
| 18 | + |
| 19 | +**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. |
| 20 | + |
| 21 | +### Example |
| 22 | +```java |
| 23 | +// Import classes: |
| 24 | +//import Invokers.ApiException; |
| 25 | +//import Api.BatchesApi; |
| 26 | + |
| 27 | + |
| 28 | +BatchesApi apiInstance = new BatchesApi(); |
| 29 | +String batchId = "batchId_example"; // String | Unique identification number assigned to the submitted request. |
| 30 | +try { |
| 31 | + InlineResponse20014 result = apiInstance.getBatchReport(batchId); |
| 32 | + System.out.println(result); |
| 33 | +} catch (ApiException e) { |
| 34 | + System.err.println("Exception when calling BatchesApi#getBatchReport"); |
| 35 | + e.printStackTrace(); |
| 36 | +} |
| 37 | +``` |
| 38 | + |
| 39 | +### Parameters |
| 40 | + |
| 41 | +Name | Type | Description | Notes |
| 42 | +------------- | ------------- | ------------- | ------------- |
| 43 | + **batchId** | **String**| Unique identification number assigned to the submitted request. | |
| 44 | + |
| 45 | +### Return type |
| 46 | + |
| 47 | +[**InlineResponse20014**](InlineResponse20014.md) |
| 48 | + |
| 49 | +### Authorization |
| 50 | + |
| 51 | +No authorization required |
| 52 | + |
| 53 | +### HTTP request headers |
| 54 | + |
| 55 | + - **Content-Type**: application/json;charset=utf-8 |
| 56 | + - **Accept**: application/json;charset=utf-8 |
| 57 | + |
| 58 | +<a name="getBatchStatus"></a> |
| 59 | +# **getBatchStatus** |
| 60 | +> InlineResponse20013 getBatchStatus(batchId) |
| 61 | +
|
| 62 | +Retrieve a Batch Status |
| 63 | + |
| 64 | +**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) |
| 65 | + |
| 66 | +### Example |
| 67 | +```java |
| 68 | +// Import classes: |
| 69 | +//import Invokers.ApiException; |
| 70 | +//import Api.BatchesApi; |
| 71 | + |
| 72 | + |
| 73 | +BatchesApi apiInstance = new BatchesApi(); |
| 74 | +String batchId = "batchId_example"; // String | Unique identification number assigned to the submitted request. |
| 75 | +try { |
| 76 | + InlineResponse20013 result = apiInstance.getBatchStatus(batchId); |
| 77 | + System.out.println(result); |
| 78 | +} catch (ApiException e) { |
| 79 | + System.err.println("Exception when calling BatchesApi#getBatchStatus"); |
| 80 | + e.printStackTrace(); |
| 81 | +} |
| 82 | +``` |
| 83 | + |
| 84 | +### Parameters |
| 85 | + |
| 86 | +Name | Type | Description | Notes |
| 87 | +------------- | ------------- | ------------- | ------------- |
| 88 | + **batchId** | **String**| Unique identification number assigned to the submitted request. | |
| 89 | + |
| 90 | +### Return type |
| 91 | + |
| 92 | +[**InlineResponse20013**](InlineResponse20013.md) |
| 93 | + |
| 94 | +### Authorization |
| 95 | + |
| 96 | +No authorization required |
| 97 | + |
| 98 | +### HTTP request headers |
| 99 | + |
| 100 | + - **Content-Type**: application/json;charset=utf-8 |
| 101 | + - **Accept**: application/json;charset=utf-8 |
| 102 | + |
| 103 | +<a name="getBatchesList"></a> |
| 104 | +# **getBatchesList** |
| 105 | +> InlineResponse20012 getBatchesList(offset, limit, fromDate, toDate) |
| 106 | +
|
| 107 | +List Batches |
| 108 | + |
| 109 | +**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. |
| 110 | + |
| 111 | +### Example |
| 112 | +```java |
| 113 | +// Import classes: |
| 114 | +//import Invokers.ApiException; |
| 115 | +//import Api.BatchesApi; |
| 116 | + |
| 117 | + |
| 118 | +BatchesApi apiInstance = new BatchesApi(); |
| 119 | +Long offset = 0L; // Long | Starting record in zero-based dataset that should be returned as the first object in the array. |
| 120 | +Long limit = 20L; // Long | The maximum number that can be returned in the array starting from the offset record in zero-based dataset. |
| 121 | +String fromDate = "fromDate_example"; // String | ISO-8601 format: yyyyMMddTHHmmssZ |
| 122 | +String toDate = "toDate_example"; // String | ISO-8601 format: yyyyMMddTHHmmssZ |
| 123 | +try { |
| 124 | + InlineResponse20012 result = apiInstance.getBatchesList(offset, limit, fromDate, toDate); |
| 125 | + System.out.println(result); |
| 126 | +} catch (ApiException e) { |
| 127 | + System.err.println("Exception when calling BatchesApi#getBatchesList"); |
| 128 | + e.printStackTrace(); |
| 129 | +} |
| 130 | +``` |
| 131 | + |
| 132 | +### Parameters |
| 133 | + |
| 134 | +Name | Type | Description | Notes |
| 135 | +------------- | ------------- | ------------- | ------------- |
| 136 | + **offset** | **Long**| Starting record in zero-based dataset that should be returned as the first object in the array. | [optional] [default to 0] |
| 137 | + **limit** | **Long**| The maximum number that can be returned in the array starting from the offset record in zero-based dataset. | [optional] [default to 20] |
| 138 | + **fromDate** | **String**| ISO-8601 format: yyyyMMddTHHmmssZ | [optional] |
| 139 | + **toDate** | **String**| ISO-8601 format: yyyyMMddTHHmmssZ | [optional] |
| 140 | + |
| 141 | +### Return type |
| 142 | + |
| 143 | +[**InlineResponse20012**](InlineResponse20012.md) |
| 144 | + |
| 145 | +### Authorization |
| 146 | + |
| 147 | +No authorization required |
| 148 | + |
| 149 | +### HTTP request headers |
| 150 | + |
| 151 | + - **Content-Type**: application/json;charset=utf-8 |
| 152 | + - **Accept**: application/json;charset=utf-8 |
| 153 | + |
| 154 | +<a name="postBatch"></a> |
| 155 | +# **postBatch** |
| 156 | +> InlineResponse2022 postBatch(body) |
| 157 | +
|
| 158 | +Create a Batch |
| 159 | + |
| 160 | +**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. |
| 161 | + |
| 162 | +### Example |
| 163 | +```java |
| 164 | +// Import classes: |
| 165 | +//import Invokers.ApiException; |
| 166 | +//import Api.BatchesApi; |
| 167 | + |
| 168 | + |
| 169 | +BatchesApi apiInstance = new BatchesApi(); |
| 170 | +Body body = new Body(); // Body | |
| 171 | +try { |
| 172 | + InlineResponse2022 result = apiInstance.postBatch(body); |
| 173 | + System.out.println(result); |
| 174 | +} catch (ApiException e) { |
| 175 | + System.err.println("Exception when calling BatchesApi#postBatch"); |
| 176 | + e.printStackTrace(); |
| 177 | +} |
| 178 | +``` |
| 179 | + |
| 180 | +### Parameters |
| 181 | + |
| 182 | +Name | Type | Description | Notes |
| 183 | +------------- | ------------- | ------------- | ------------- |
| 184 | + **body** | [**Body**](Body.md)| | |
| 185 | + |
| 186 | +### Return type |
| 187 | + |
| 188 | +[**InlineResponse2022**](InlineResponse2022.md) |
| 189 | + |
| 190 | +### Authorization |
| 191 | + |
| 192 | +No authorization required |
| 193 | + |
| 194 | +### HTTP request headers |
| 195 | + |
| 196 | + - **Content-Type**: application/json;charset=utf-8 |
| 197 | + - **Accept**: application/json;charset=utf-8 |
| 198 | + |
0 commit comments