InstrumentIdentifierApi (cybersource-rest-client-java 0.0.26 API)

java.lang.Object
- Api.InstrumentIdentifierApi

public class InstrumentIdentifierApi
extends Object

Constructor Summary

Constructors
Constructor and Description

InstrumentIdentifierApi()

InstrumentIdentifierApi(ApiClient apiClient)

Constructors
Constructor and Description
`InstrumentIdentifierApi()`
`InstrumentIdentifierApi(ApiClient apiClient)`

Method Summary

All Methods Instance Methods Concrete Methods
Modifier and Type	Method and Description
`void`	`deleteInstrumentIdentifier(String instrumentIdentifierTokenId, String profileId)` Delete an Instrument Identifier
`okhttp3.Call`	`deleteInstrumentIdentifierAsync(String instrumentIdentifierTokenId, String profileId, ApiCallback<Void> callback)` Delete an Instrument Identifier (asynchronously)
`okhttp3.Call`	`deleteInstrumentIdentifierCall(String instrumentIdentifierTokenId, String profileId, ProgressResponseBody.ProgressListener progressListener, ProgressRequestBody.ProgressRequestListener progressRequestListener)` Build call for deleteInstrumentIdentifier
`ApiResponse<Void>`	`deleteInstrumentIdentifierWithHttpInfo(String instrumentIdentifierTokenId, String profileId)` Delete an Instrument Identifier
`ApiClient`	`getApiClient()`
`Tmsv2customersEmbeddedDefaultPaymentInstrumentEmbeddedInstrumentIdentifier`	`getInstrumentIdentifier(String instrumentIdentifierTokenId, String profileId)` Retrieve an Instrument Identifier
`okhttp3.Call`	`getInstrumentIdentifierAsync(String instrumentIdentifierTokenId, String profileId, ApiCallback<Tmsv2customersEmbeddedDefaultPaymentInstrumentEmbeddedInstrumentIdentifier> callback)` Retrieve an Instrument Identifier (asynchronously)
`okhttp3.Call`	`getInstrumentIdentifierCall(String instrumentIdentifierTokenId, String profileId, ProgressResponseBody.ProgressListener progressListener, ProgressRequestBody.ProgressRequestListener progressRequestListener)` Build call for getInstrumentIdentifier
`PaymentInstrumentListForCustomer`	`getInstrumentIdentifierPaymentInstrumentsList(String instrumentIdentifierTokenId, String profileId, Long offset, Long limit)` List Payment Instruments for an Instrument Identifier
`okhttp3.Call`	`getInstrumentIdentifierPaymentInstrumentsListAsync(String instrumentIdentifierTokenId, String profileId, Long offset, Long limit, ApiCallback<PaymentInstrumentListForCustomer> callback)` List Payment Instruments for an Instrument Identifier (asynchronously)
`okhttp3.Call`	`getInstrumentIdentifierPaymentInstrumentsListCall(String instrumentIdentifierTokenId, String profileId, Long offset, Long limit, ProgressResponseBody.ProgressListener progressListener, ProgressRequestBody.ProgressRequestListener progressRequestListener)` Build call for getInstrumentIdentifierPaymentInstrumentsList
`ApiResponse<PaymentInstrumentListForCustomer>`	`getInstrumentIdentifierPaymentInstrumentsListWithHttpInfo(String instrumentIdentifierTokenId, String profileId, Long offset, Long limit)` List Payment Instruments for an Instrument Identifier
`ApiResponse<Tmsv2customersEmbeddedDefaultPaymentInstrumentEmbeddedInstrumentIdentifier>`	`getInstrumentIdentifierWithHttpInfo(String instrumentIdentifierTokenId, String profileId)` Retrieve an Instrument Identifier
`Tmsv2customersEmbeddedDefaultPaymentInstrumentEmbeddedInstrumentIdentifier`	`patchInstrumentIdentifier(String instrumentIdentifierTokenId, PatchInstrumentIdentifierRequest patchInstrumentIdentifierRequest, String profileId, String ifMatch)` Update an Instrument Identifier
`okhttp3.Call`	`patchInstrumentIdentifierAsync(String instrumentIdentifierTokenId, PatchInstrumentIdentifierRequest patchInstrumentIdentifierRequest, String profileId, String ifMatch, ApiCallback<Tmsv2customersEmbeddedDefaultPaymentInstrumentEmbeddedInstrumentIdentifier> callback)` Update an Instrument Identifier (asynchronously)
`okhttp3.Call`	`patchInstrumentIdentifierCall(String instrumentIdentifierTokenId, PatchInstrumentIdentifierRequest patchInstrumentIdentifierRequest, String profileId, String ifMatch, ProgressResponseBody.ProgressListener progressListener, ProgressRequestBody.ProgressRequestListener progressRequestListener)` Build call for patchInstrumentIdentifier
`ApiResponse<Tmsv2customersEmbeddedDefaultPaymentInstrumentEmbeddedInstrumentIdentifier>`	`patchInstrumentIdentifierWithHttpInfo(String instrumentIdentifierTokenId, PatchInstrumentIdentifierRequest patchInstrumentIdentifierRequest, String profileId, String ifMatch)` Update an Instrument Identifier
`Tmsv2customersEmbeddedDefaultPaymentInstrumentEmbeddedInstrumentIdentifier`	`postInstrumentIdentifier(PostInstrumentIdentifierRequest postInstrumentIdentifierRequest, String profileId)` Create an Instrument Identifier
`okhttp3.Call`	`postInstrumentIdentifierAsync(PostInstrumentIdentifierRequest postInstrumentIdentifierRequest, String profileId, ApiCallback<Tmsv2customersEmbeddedDefaultPaymentInstrumentEmbeddedInstrumentIdentifier> callback)` Create an Instrument Identifier (asynchronously)
`okhttp3.Call`	`postInstrumentIdentifierCall(PostInstrumentIdentifierRequest postInstrumentIdentifierRequest, String profileId, ProgressResponseBody.ProgressListener progressListener, ProgressRequestBody.ProgressRequestListener progressRequestListener)` Build call for postInstrumentIdentifier
`ApiResponse<Tmsv2customersEmbeddedDefaultPaymentInstrumentEmbeddedInstrumentIdentifier>`	`postInstrumentIdentifierWithHttpInfo(PostInstrumentIdentifierRequest postInstrumentIdentifierRequest, String profileId)` Create an 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

InstrumentIdentifierApi
```
public InstrumentIdentifierApi()
```

InstrumentIdentifierApi

public InstrumentIdentifierApi(ApiClient apiClient)

Method Detail

getApiClient
```
public ApiClient getApiClient()
```

setApiClient

public void setApiClient(ApiClient apiClient)

deleteInstrumentIdentifierCall

public okhttp3.Call deleteInstrumentIdentifierCall(String instrumentIdentifierTokenId,
                                                   String profileId,
                                                   ProgressResponseBody.ProgressListener progressListener,
                                                   ProgressRequestBody.ProgressRequestListener progressRequestListener)
                                            throws ApiException

Build call for deleteInstrumentIdentifier

Parameters:: instrumentIdentifierTokenId - The TokenId of a Instrument Identifier. (required); profileId - The id of a profile containing user specific TMS configuration. (optional); progressListener - Progress listener; progressRequestListener - Progress request listener
Returns:: Call to execute
Throws:: ApiException - If fail to serialize the request body object

deleteInstrumentIdentifier
```
public void deleteInstrumentIdentifier(String instrumentIdentifierTokenId,
                                       String profileId)
                                throws ApiException
```
Delete an Instrument Identifier

Parameters:

instrumentIdentifierTokenId - The TokenId of a Instrument Identifier. (required)

profileId - The id of a profile containing user specific TMS configuration. (optional)

Throws:

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

deleteInstrumentIdentifierWithHttpInfo
```
public ApiResponse<Void> deleteInstrumentIdentifierWithHttpInfo(String instrumentIdentifierTokenId,
                                                                String profileId)
                                                         throws ApiException
```
Delete an Instrument Identifier

Parameters:

instrumentIdentifierTokenId - The TokenId of a Instrument Identifier. (required)

profileId - The id of a profile containing user specific TMS configuration. (optional)

Returns:

ApiResponse<Void>

Throws:

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

deleteInstrumentIdentifierAsync
```
public okhttp3.Call deleteInstrumentIdentifierAsync(String instrumentIdentifierTokenId,
                                                    String profileId,
                                                    ApiCallback<Void> callback)
                                             throws ApiException
```
Delete an Instrument Identifier (asynchronously)

Parameters:

instrumentIdentifierTokenId - The TokenId of a Instrument Identifier. (required)

profileId - The id of a profile containing user specific TMS configuration. (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

getInstrumentIdentifierCall

public okhttp3.Call getInstrumentIdentifierCall(String instrumentIdentifierTokenId,
                                                String profileId,
                                                ProgressResponseBody.ProgressListener progressListener,
                                                ProgressRequestBody.ProgressRequestListener progressRequestListener)
                                         throws ApiException

Build call for getInstrumentIdentifier

Parameters:: instrumentIdentifierTokenId - The TokenId of a Instrument Identifier. (required); profileId - The id of a profile containing user specific TMS configuration. (optional); progressListener - Progress listener; progressRequestListener - Progress request listener
Returns:: Call to execute
Throws:: ApiException - If fail to serialize the request body object

getInstrumentIdentifier

public Tmsv2customersEmbeddedDefaultPaymentInstrumentEmbeddedInstrumentIdentifier getInstrumentIdentifier(String instrumentIdentifierTokenId,
                                                                                                          String profileId)
                                                                                                   throws ApiException

Retrieve an Instrument Identifier

Parameters:: instrumentIdentifierTokenId - The TokenId of a Instrument Identifier. (required); profileId - The id of a profile containing user specific TMS configuration. (optional)
Returns:: Tmsv2customersEmbeddedDefaultPaymentInstrumentEmbeddedInstrumentIdentifier
Throws:: ApiException - If fail to call the API, e.g. server error or cannot deserialize the response body

getInstrumentIdentifierWithHttpInfo

public ApiResponse<Tmsv2customersEmbeddedDefaultPaymentInstrumentEmbeddedInstrumentIdentifier> getInstrumentIdentifierWithHttpInfo(String instrumentIdentifierTokenId,
                                                                                                                                   String profileId)
                                                                                                                            throws ApiException

Retrieve an Instrument Identifier

Parameters:: instrumentIdentifierTokenId - The TokenId of a Instrument Identifier. (required); profileId - The id of a profile containing user specific TMS configuration. (optional)
Returns:: ApiResponse<Tmsv2customersEmbeddedDefaultPaymentInstrumentEmbeddedInstrumentIdentifier>
Throws:: ApiException - If fail to call the API, e.g. server error or cannot deserialize the response body

getInstrumentIdentifierAsync

public okhttp3.Call getInstrumentIdentifierAsync(String instrumentIdentifierTokenId,
                                                 String profileId,
                                                 ApiCallback<Tmsv2customersEmbeddedDefaultPaymentInstrumentEmbeddedInstrumentIdentifier> callback)
                                          throws ApiException

Retrieve an Instrument Identifier (asynchronously)

Parameters:: instrumentIdentifierTokenId - The TokenId of a Instrument Identifier. (required); profileId - The id of a profile containing user specific TMS configuration. (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

getInstrumentIdentifierPaymentInstrumentsListCall

public okhttp3.Call getInstrumentIdentifierPaymentInstrumentsListCall(String instrumentIdentifierTokenId,
                                                                      String profileId,
                                                                      Long offset,
                                                                      Long limit,
                                                                      ProgressResponseBody.ProgressListener progressListener,
                                                                      ProgressRequestBody.ProgressRequestListener progressRequestListener)
                                                               throws ApiException

Build call for getInstrumentIdentifierPaymentInstrumentsList

Parameters:: instrumentIdentifierTokenId - The TokenId of a Instrument Identifier. (required); profileId - The id of a profile containing user specific TMS configuration. (optional); offset - Starting record in zero-based dataset that should be returned as the first object in the array. Default is 0. (optional, default to 0); limit - The maximum number that can be returned in the array starting from the offset record in zero-based dataset. Default is 20, maximum is 100. (optional, default to 20); progressListener - Progress listener; progressRequestListener - Progress request listener
Returns:: Call to execute
Throws:: ApiException - If fail to serialize the request body object

getInstrumentIdentifierPaymentInstrumentsList

public PaymentInstrumentListForCustomer getInstrumentIdentifierPaymentInstrumentsList(String instrumentIdentifierTokenId,
                                                                                      String profileId,
                                                                                      Long offset,
                                                                                      Long limit)
                                                                               throws ApiException

List Payment Instruments for an Instrument Identifier

Parameters:: instrumentIdentifierTokenId - The TokenId of a Instrument Identifier. (required); profileId - The id of a profile containing user specific TMS configuration. (optional); offset - Starting record in zero-based dataset that should be returned as the first object in the array. Default is 0. (optional, default to 0); limit - The maximum number that can be returned in the array starting from the offset record in zero-based dataset. Default is 20, maximum is 100. (optional, default to 20)
Returns:: PaymentInstrumentListForCustomer
Throws:: ApiException - If fail to call the API, e.g. server error or cannot deserialize the response body

getInstrumentIdentifierPaymentInstrumentsListWithHttpInfo

public ApiResponse<PaymentInstrumentListForCustomer> getInstrumentIdentifierPaymentInstrumentsListWithHttpInfo(String instrumentIdentifierTokenId,
                                                                                                               String profileId,
                                                                                                               Long offset,
                                                                                                               Long limit)
                                                                                                        throws ApiException

List Payment Instruments for an Instrument Identifier

Parameters:: instrumentIdentifierTokenId - The TokenId of a Instrument Identifier. (required); profileId - The id of a profile containing user specific TMS configuration. (optional); offset - Starting record in zero-based dataset that should be returned as the first object in the array. Default is 0. (optional, default to 0); limit - The maximum number that can be returned in the array starting from the offset record in zero-based dataset. Default is 20, maximum is 100. (optional, default to 20)
Returns:: ApiResponse<PaymentInstrumentListForCustomer>
Throws:: ApiException - If fail to call the API, e.g. server error or cannot deserialize the response body

getInstrumentIdentifierPaymentInstrumentsListAsync

public okhttp3.Call getInstrumentIdentifierPaymentInstrumentsListAsync(String instrumentIdentifierTokenId,
                                                                       String profileId,
                                                                       Long offset,
                                                                       Long limit,
                                                                       ApiCallback<PaymentInstrumentListForCustomer> callback)
                                                                throws ApiException

List Payment Instruments for an Instrument Identifier (asynchronously)

Parameters:: instrumentIdentifierTokenId - The TokenId of a Instrument Identifier. (required); profileId - The id of a profile containing user specific TMS configuration. (optional); offset - Starting record in zero-based dataset that should be returned as the first object in the array. Default is 0. (optional, default to 0); limit - The maximum number that can be returned in the array starting from the offset record in zero-based dataset. Default is 20, maximum is 100. (optional, default to 20); 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

patchInstrumentIdentifierCall

public okhttp3.Call patchInstrumentIdentifierCall(String instrumentIdentifierTokenId,
                                                  PatchInstrumentIdentifierRequest patchInstrumentIdentifierRequest,
                                                  String profileId,
                                                  String ifMatch,
                                                  ProgressResponseBody.ProgressListener progressListener,
                                                  ProgressRequestBody.ProgressRequestListener progressRequestListener)
                                           throws ApiException

Build call for patchInstrumentIdentifier

Parameters:: instrumentIdentifierTokenId - The TokenId of a Instrument Identifier. (required); patchInstrumentIdentifierRequest - Specify the previous transaction ID to update. (required); profileId - The id of a profile containing user specific TMS configuration. (optional); ifMatch - Contains an ETag value from a GET request to make the request conditional. (optional); progressListener - Progress listener; progressRequestListener - Progress request listener
Returns:: Call to execute
Throws:: ApiException - If fail to serialize the request body object

patchInstrumentIdentifier

public Tmsv2customersEmbeddedDefaultPaymentInstrumentEmbeddedInstrumentIdentifier patchInstrumentIdentifier(String instrumentIdentifierTokenId,
                                                                                                            PatchInstrumentIdentifierRequest patchInstrumentIdentifierRequest,
                                                                                                            String profileId,
                                                                                                            String ifMatch)
                                                                                                     throws ApiException

Update an Instrument Identifier

Parameters:: instrumentIdentifierTokenId - The TokenId of a Instrument Identifier. (required); patchInstrumentIdentifierRequest - Specify the previous transaction ID to update. (required); profileId - The id of a profile containing user specific TMS configuration. (optional); ifMatch - Contains an ETag value from a GET request to make the request conditional. (optional)
Returns:: Tmsv2customersEmbeddedDefaultPaymentInstrumentEmbeddedInstrumentIdentifier
Throws:: ApiException - If fail to call the API, e.g. server error or cannot deserialize the response body

patchInstrumentIdentifierWithHttpInfo

public ApiResponse<Tmsv2customersEmbeddedDefaultPaymentInstrumentEmbeddedInstrumentIdentifier> patchInstrumentIdentifierWithHttpInfo(String instrumentIdentifierTokenId,
                                                                                                                                     PatchInstrumentIdentifierRequest patchInstrumentIdentifierRequest,
                                                                                                                                     String profileId,
                                                                                                                                     String ifMatch)
                                                                                                                              throws ApiException

Update an Instrument Identifier

Parameters:: instrumentIdentifierTokenId - The TokenId of a Instrument Identifier. (required); patchInstrumentIdentifierRequest - Specify the previous transaction ID to update. (required); profileId - The id of a profile containing user specific TMS configuration. (optional); ifMatch - Contains an ETag value from a GET request to make the request conditional. (optional)
Returns:: ApiResponse<Tmsv2customersEmbeddedDefaultPaymentInstrumentEmbeddedInstrumentIdentifier>
Throws:: ApiException - If fail to call the API, e.g. server error or cannot deserialize the response body

patchInstrumentIdentifierAsync

public okhttp3.Call patchInstrumentIdentifierAsync(String instrumentIdentifierTokenId,
                                                   PatchInstrumentIdentifierRequest patchInstrumentIdentifierRequest,
                                                   String profileId,
                                                   String ifMatch,
                                                   ApiCallback<Tmsv2customersEmbeddedDefaultPaymentInstrumentEmbeddedInstrumentIdentifier> callback)
                                            throws ApiException

Update an Instrument Identifier (asynchronously)

Parameters:: instrumentIdentifierTokenId - The TokenId of a Instrument Identifier. (required); patchInstrumentIdentifierRequest - Specify the previous transaction ID to update. (required); profileId - The id of a profile containing user specific TMS configuration. (optional); ifMatch - Contains an ETag value from a GET request to make the request conditional. (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

postInstrumentIdentifierCall

public okhttp3.Call postInstrumentIdentifierCall(PostInstrumentIdentifierRequest postInstrumentIdentifierRequest,
                                                 String profileId,
                                                 ProgressResponseBody.ProgressListener progressListener,
                                                 ProgressRequestBody.ProgressRequestListener progressRequestListener)
                                          throws ApiException

Build call for postInstrumentIdentifier

Parameters:: postInstrumentIdentifierRequest - Please specify either a Card, Bank Account or Enrollable Card (required); profileId - The id of a profile containing user specific TMS configuration. (optional); progressListener - Progress listener; progressRequestListener - Progress request listener
Returns:: Call to execute
Throws:: ApiException - If fail to serialize the request body object

postInstrumentIdentifier

public Tmsv2customersEmbeddedDefaultPaymentInstrumentEmbeddedInstrumentIdentifier postInstrumentIdentifier(PostInstrumentIdentifierRequest postInstrumentIdentifierRequest,
                                                                                                           String profileId)
                                                                                                    throws ApiException

Create an Instrument Identifier

Parameters:: postInstrumentIdentifierRequest - Please specify either a Card, Bank Account or Enrollable Card (required); profileId - The id of a profile containing user specific TMS configuration. (optional)
Returns:: Tmsv2customersEmbeddedDefaultPaymentInstrumentEmbeddedInstrumentIdentifier
Throws:: ApiException - If fail to call the API, e.g. server error or cannot deserialize the response body

postInstrumentIdentifierWithHttpInfo

public ApiResponse<Tmsv2customersEmbeddedDefaultPaymentInstrumentEmbeddedInstrumentIdentifier> postInstrumentIdentifierWithHttpInfo(PostInstrumentIdentifierRequest postInstrumentIdentifierRequest,
                                                                                                                                    String profileId)
                                                                                                                             throws ApiException

Create an Instrument Identifier

Parameters:: postInstrumentIdentifierRequest - Please specify either a Card, Bank Account or Enrollable Card (required); profileId - The id of a profile containing user specific TMS configuration. (optional)
Returns:: ApiResponse<Tmsv2customersEmbeddedDefaultPaymentInstrumentEmbeddedInstrumentIdentifier>
Throws:: ApiException - If fail to call the API, e.g. server error or cannot deserialize the response body

postInstrumentIdentifierAsync

public okhttp3.Call postInstrumentIdentifierAsync(PostInstrumentIdentifierRequest postInstrumentIdentifierRequest,
                                                  String profileId,
                                                  ApiCallback<Tmsv2customersEmbeddedDefaultPaymentInstrumentEmbeddedInstrumentIdentifier> callback)
                                           throws ApiException

Create an Instrument Identifier (asynchronously)

Parameters:: postInstrumentIdentifierRequest - Please specify either a Card, Bank Account or Enrollable Card (required); profileId - The id of a profile containing user specific TMS configuration. (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

Class InstrumentIdentifierApi

Constructor Summary

Method Summary

Methods inherited from class java.lang.Object

Constructor Detail

InstrumentIdentifierApi

InstrumentIdentifierApi

Method Detail

getApiClient

setApiClient

deleteInstrumentIdentifierCall

deleteInstrumentIdentifier

deleteInstrumentIdentifierWithHttpInfo

deleteInstrumentIdentifierAsync

getInstrumentIdentifierCall

getInstrumentIdentifier

getInstrumentIdentifierWithHttpInfo

getInstrumentIdentifierAsync

getInstrumentIdentifierPaymentInstrumentsListCall

getInstrumentIdentifierPaymentInstrumentsList

getInstrumentIdentifierPaymentInstrumentsListWithHttpInfo

getInstrumentIdentifierPaymentInstrumentsListAsync

patchInstrumentIdentifierCall

patchInstrumentIdentifier

patchInstrumentIdentifierWithHttpInfo

patchInstrumentIdentifierAsync

postInstrumentIdentifierCall

postInstrumentIdentifier

postInstrumentIdentifierWithHttpInfo

postInstrumentIdentifierAsync