Api

Class PaymentInstrumentApi

java.lang.Object

Api.PaymentInstrumentApi

public class PaymentInstrumentApi
extends Object

Constructor Summary

Constructors

Constructor and Description
PaymentInstrumentApi()
PaymentInstrumentApi(ApiClient apiClient)

Method Summary

Modifier and Type	Method and Description
void	deletePaymentInstrument(String paymentInstrumentTokenId, String profileId) Delete a Payment Instrument
okhttp3.Call	deletePaymentInstrumentAsync(String paymentInstrumentTokenId, String profileId, ApiCallback<Void> callback) Delete a Payment Instrument (asynchronously)
okhttp3.Call	deletePaymentInstrumentCall(String paymentInstrumentTokenId, String profileId, ProgressResponseBody.ProgressListener progressListener, ProgressRequestBody.ProgressRequestListener progressRequestListener) Build call for deletePaymentInstrument
ApiResponse<Void>	deletePaymentInstrumentWithHttpInfo(String paymentInstrumentTokenId, String profileId) Delete a Payment Instrument
ApiClient	getApiClient()
Tmsv2customersEmbeddedDefaultPaymentInstrument	getPaymentInstrument(String paymentInstrumentTokenId, String profileId) Retrieve a Payment Instrument
okhttp3.Call	getPaymentInstrumentAsync(String paymentInstrumentTokenId, String profileId, ApiCallback<Tmsv2customersEmbeddedDefaultPaymentInstrument> callback) Retrieve a Payment Instrument (asynchronously)
okhttp3.Call	getPaymentInstrumentCall(String paymentInstrumentTokenId, String profileId, ProgressResponseBody.ProgressListener progressListener, ProgressRequestBody.ProgressRequestListener progressRequestListener) Build call for getPaymentInstrument
ApiResponse<Tmsv2customersEmbeddedDefaultPaymentInstrument>	getPaymentInstrumentWithHttpInfo(String paymentInstrumentTokenId, String profileId) Retrieve a Payment Instrument
Tmsv2customersEmbeddedDefaultPaymentInstrument	patchPaymentInstrument(String paymentInstrumentTokenId, PatchPaymentInstrumentRequest patchPaymentInstrumentRequest, String profileId, String ifMatch) Update a Payment Instrument
okhttp3.Call	patchPaymentInstrumentAsync(String paymentInstrumentTokenId, PatchPaymentInstrumentRequest patchPaymentInstrumentRequest, String profileId, String ifMatch, ApiCallback<Tmsv2customersEmbeddedDefaultPaymentInstrument> callback) Update a Payment Instrument (asynchronously)
okhttp3.Call	patchPaymentInstrumentCall(String paymentInstrumentTokenId, PatchPaymentInstrumentRequest patchPaymentInstrumentRequest, String profileId, String ifMatch, ProgressResponseBody.ProgressListener progressListener, ProgressRequestBody.ProgressRequestListener progressRequestListener) Build call for patchPaymentInstrument
ApiResponse<Tmsv2customersEmbeddedDefaultPaymentInstrument>	patchPaymentInstrumentWithHttpInfo(String paymentInstrumentTokenId, PatchPaymentInstrumentRequest patchPaymentInstrumentRequest, String profileId, String ifMatch) Update a Payment Instrument
Tmsv2customersEmbeddedDefaultPaymentInstrument	postPaymentInstrument(PostPaymentInstrumentRequest postPaymentInstrumentRequest, String profileId) Create a Payment Instrument Include an existing TMS Instrument Identifier id in the request body.
okhttp3.Call	postPaymentInstrumentAsync(PostPaymentInstrumentRequest postPaymentInstrumentRequest, String profileId, ApiCallback<Tmsv2customersEmbeddedDefaultPaymentInstrument> callback) Create a Payment Instrument (asynchronously) Include an existing TMS Instrument Identifier id in the request body.
okhttp3.Call	postPaymentInstrumentCall(PostPaymentInstrumentRequest postPaymentInstrumentRequest, String profileId, ProgressResponseBody.ProgressListener progressListener, ProgressRequestBody.ProgressRequestListener progressRequestListener) Build call for postPaymentInstrument
ApiResponse<Tmsv2customersEmbeddedDefaultPaymentInstrument>	postPaymentInstrumentWithHttpInfo(PostPaymentInstrumentRequest postPaymentInstrumentRequest, String profileId) Create a Payment Instrument Include an existing TMS Instrument Identifier id in the request body.
void	setApiClient(ApiClient apiClient)

Methods inherited from class java.lang.Object

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

Constructor Detail

PaymentInstrumentApi

public PaymentInstrumentApi()

PaymentInstrumentApi

public PaymentInstrumentApi(ApiClient apiClient)

Method Detail

getApiClient

public ApiClient getApiClient()

setApiClient

public void setApiClient(ApiClient apiClient)

deletePaymentInstrumentCall

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

Build call for deletePaymentInstrument

Parameters:

paymentInstrumentTokenId - The TokenId of a payment instrument. (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

deletePaymentInstrument

public void deletePaymentInstrument(String paymentInstrumentTokenId,
                                    String profileId)
                             throws ApiException

Delete a Payment Instrument

Parameters:

paymentInstrumentTokenId - The TokenId of a payment instrument. (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

deletePaymentInstrumentWithHttpInfo

public ApiResponse<Void> deletePaymentInstrumentWithHttpInfo(String paymentInstrumentTokenId,
                                                             String profileId)
                                                      throws ApiException

Delete a Payment Instrument

Parameters:

paymentInstrumentTokenId - The TokenId of a payment instrument. (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

deletePaymentInstrumentAsync

public okhttp3.Call deletePaymentInstrumentAsync(String paymentInstrumentTokenId,
                                                 String profileId,
                                                 ApiCallback<Void> callback)
                                          throws ApiException

Delete a Payment Instrument (asynchronously)

Parameters:

paymentInstrumentTokenId - The TokenId of a payment instrument. (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

getPaymentInstrumentCall

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

Build call for getPaymentInstrument

Parameters:

paymentInstrumentTokenId - The TokenId of a payment instrument. (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

getPaymentInstrument

public Tmsv2customersEmbeddedDefaultPaymentInstrument getPaymentInstrument(String paymentInstrumentTokenId,
                                                                           String profileId)
                                                                    throws ApiException

Retrieve a Payment Instrument

Parameters:

paymentInstrumentTokenId - The TokenId of a payment instrument. (required)

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

Returns:

Tmsv2customersEmbeddedDefaultPaymentInstrument

Throws:

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

getPaymentInstrumentWithHttpInfo

public ApiResponse<Tmsv2customersEmbeddedDefaultPaymentInstrument> getPaymentInstrumentWithHttpInfo(String paymentInstrumentTokenId,
                                                                                                    String profileId)
                                                                                             throws ApiException

Retrieve a Payment Instrument

Parameters:

paymentInstrumentTokenId - The TokenId of a payment instrument. (required)

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

Returns:

ApiResponse<Tmsv2customersEmbeddedDefaultPaymentInstrument>

Throws:

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

getPaymentInstrumentAsync

public okhttp3.Call getPaymentInstrumentAsync(String paymentInstrumentTokenId,
                                              String profileId,
                                              ApiCallback<Tmsv2customersEmbeddedDefaultPaymentInstrument> callback)
                                       throws ApiException

Retrieve a Payment Instrument (asynchronously)

Parameters:

paymentInstrumentTokenId - The TokenId of a payment instrument. (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

patchPaymentInstrumentCall

public okhttp3.Call patchPaymentInstrumentCall(String paymentInstrumentTokenId,
                                               PatchPaymentInstrumentRequest patchPaymentInstrumentRequest,
                                               String profileId,
                                               String ifMatch,
                                               ProgressResponseBody.ProgressListener progressListener,
                                               ProgressRequestBody.ProgressRequestListener progressRequestListener)
                                        throws ApiException

Build call for patchPaymentInstrument

Parameters:

paymentInstrumentTokenId - The TokenId of a payment instrument. (required)

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

patchPaymentInstrument

public Tmsv2customersEmbeddedDefaultPaymentInstrument patchPaymentInstrument(String paymentInstrumentTokenId,
                                                                             PatchPaymentInstrumentRequest patchPaymentInstrumentRequest,
                                                                             String profileId,
                                                                             String ifMatch)
                                                                      throws ApiException

Update a Payment Instrument

Parameters:

paymentInstrumentTokenId - The TokenId of a payment instrument. (required)

patchPaymentInstrumentRequest - (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:

Tmsv2customersEmbeddedDefaultPaymentInstrument

Throws:

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

patchPaymentInstrumentWithHttpInfo

public ApiResponse<Tmsv2customersEmbeddedDefaultPaymentInstrument> patchPaymentInstrumentWithHttpInfo(String paymentInstrumentTokenId,
                                                                                                      PatchPaymentInstrumentRequest patchPaymentInstrumentRequest,
                                                                                                      String profileId,
                                                                                                      String ifMatch)
                                                                                               throws ApiException

Update a Payment Instrument

Parameters:

paymentInstrumentTokenId - The TokenId of a payment instrument. (required)

patchPaymentInstrumentRequest - (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<Tmsv2customersEmbeddedDefaultPaymentInstrument>

Throws:

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

patchPaymentInstrumentAsync

public okhttp3.Call patchPaymentInstrumentAsync(String paymentInstrumentTokenId,
                                                PatchPaymentInstrumentRequest patchPaymentInstrumentRequest,
                                                String profileId,
                                                String ifMatch,
                                                ApiCallback<Tmsv2customersEmbeddedDefaultPaymentInstrument> callback)
                                         throws ApiException

Update a Payment Instrument (asynchronously)

Parameters:

paymentInstrumentTokenId - The TokenId of a payment instrument. (required)

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

postPaymentInstrumentCall

public okhttp3.Call postPaymentInstrumentCall(PostPaymentInstrumentRequest postPaymentInstrumentRequest,
                                              String profileId,
                                              ProgressResponseBody.ProgressListener progressListener,
                                              ProgressRequestBody.ProgressRequestListener progressRequestListener)
                                       throws ApiException

Build call for postPaymentInstrument

Parameters:

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

postPaymentInstrument

public Tmsv2customersEmbeddedDefaultPaymentInstrument postPaymentInstrument(PostPaymentInstrumentRequest postPaymentInstrumentRequest,
                                                                            String profileId)
                                                                     throws ApiException

Create a Payment Instrument Include an existing TMS Instrument Identifier id in the request body. * An Instrument Identifier token can be created by calling: **POST *_/tms/v1/instrumentidentifiers***

Parameters:

postPaymentInstrumentRequest - (required)

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

Returns:

Tmsv2customersEmbeddedDefaultPaymentInstrument

Throws:

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

postPaymentInstrumentWithHttpInfo

public ApiResponse<Tmsv2customersEmbeddedDefaultPaymentInstrument> postPaymentInstrumentWithHttpInfo(PostPaymentInstrumentRequest postPaymentInstrumentRequest,
                                                                                                     String profileId)
                                                                                              throws ApiException

Create a Payment Instrument Include an existing TMS Instrument Identifier id in the request body. * An Instrument Identifier token can be created by calling: **POST *_/tms/v1/instrumentidentifiers***

Parameters:

postPaymentInstrumentRequest - (required)

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

Returns:

ApiResponse<Tmsv2customersEmbeddedDefaultPaymentInstrument>

Throws:

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

postPaymentInstrumentAsync

public okhttp3.Call postPaymentInstrumentAsync(PostPaymentInstrumentRequest postPaymentInstrumentRequest,
                                               String profileId,
                                               ApiCallback<Tmsv2customersEmbeddedDefaultPaymentInstrument> callback)
                                        throws ApiException

Create a Payment Instrument (asynchronously) Include an existing TMS Instrument Identifier id in the request body. * An Instrument Identifier token can be created by calling: **POST *_/tms/v1/instrumentidentifiers***

Parameters:

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