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
TmsV1InstrumentIdentifiersPaymentInstrumentsGet200ResponseEmbeddedPaymentInstruments	createPaymentInstrument(String profileId, CreatePaymentInstrumentRequest createPaymentInstrumentRequest) Create a Payment Instrument
com.squareup.okhttp.Call	createPaymentInstrumentAsync(String profileId, CreatePaymentInstrumentRequest createPaymentInstrumentRequest, ApiCallback<TmsV1InstrumentIdentifiersPaymentInstrumentsGet200ResponseEmbeddedPaymentInstruments> callback) Create a Payment Instrument (asynchronously)
com.squareup.okhttp.Call	createPaymentInstrumentCall(String profileId, CreatePaymentInstrumentRequest createPaymentInstrumentRequest, ProgressResponseBody.ProgressListener progressListener, ProgressRequestBody.ProgressRequestListener progressRequestListener) Build call for createPaymentInstrument
ApiResponse<TmsV1InstrumentIdentifiersPaymentInstrumentsGet200ResponseEmbeddedPaymentInstruments>	createPaymentInstrumentWithHttpInfo(String profileId, CreatePaymentInstrumentRequest createPaymentInstrumentRequest) Create a Payment Instrument
void	deletePaymentInstrument(String profileId, String tokenId) Delete a Payment Instrument
com.squareup.okhttp.Call	deletePaymentInstrumentAsync(String profileId, String tokenId, ApiCallback<Void> callback) Delete a Payment Instrument (asynchronously)
com.squareup.okhttp.Call	deletePaymentInstrumentCall(String profileId, String tokenId, ProgressResponseBody.ProgressListener progressListener, ProgressRequestBody.ProgressRequestListener progressRequestListener) Build call for deletePaymentInstrument
ApiResponse<Void>	deletePaymentInstrumentWithHttpInfo(String profileId, String tokenId) Delete a Payment Instrument
ApiClient	getApiClient()
TmsV1InstrumentIdentifiersPaymentInstrumentsGet200ResponseEmbeddedPaymentInstruments	getPaymentInstrument(String profileId, String tokenId) Retrieve a Payment Instrument
com.squareup.okhttp.Call	getPaymentInstrumentAsync(String profileId, String tokenId, ApiCallback<TmsV1InstrumentIdentifiersPaymentInstrumentsGet200ResponseEmbeddedPaymentInstruments> callback) Retrieve a Payment Instrument (asynchronously)
com.squareup.okhttp.Call	getPaymentInstrumentCall(String profileId, String tokenId, ProgressResponseBody.ProgressListener progressListener, ProgressRequestBody.ProgressRequestListener progressRequestListener) Build call for getPaymentInstrument
ApiResponse<TmsV1InstrumentIdentifiersPaymentInstrumentsGet200ResponseEmbeddedPaymentInstruments>	getPaymentInstrumentWithHttpInfo(String profileId, String tokenId) Retrieve a Payment Instrument
void	setApiClient(ApiClient apiClient)
TmsV1InstrumentIdentifiersPaymentInstrumentsGet200ResponseEmbeddedPaymentInstruments	updatePaymentInstrument(String profileId, String tokenId, UpdatePaymentInstrumentRequest updatePaymentInstrumentRequest) Update a Payment Instrument
com.squareup.okhttp.Call	updatePaymentInstrumentAsync(String profileId, String tokenId, UpdatePaymentInstrumentRequest updatePaymentInstrumentRequest, ApiCallback<TmsV1InstrumentIdentifiersPaymentInstrumentsGet200ResponseEmbeddedPaymentInstruments> callback) Update a Payment Instrument (asynchronously)
com.squareup.okhttp.Call	updatePaymentInstrumentCall(String profileId, String tokenId, UpdatePaymentInstrumentRequest updatePaymentInstrumentRequest, ProgressResponseBody.ProgressListener progressListener, ProgressRequestBody.ProgressRequestListener progressRequestListener) Build call for updatePaymentInstrument
ApiResponse<TmsV1InstrumentIdentifiersPaymentInstrumentsGet200ResponseEmbeddedPaymentInstruments>	updatePaymentInstrumentWithHttpInfo(String profileId, String tokenId, UpdatePaymentInstrumentRequest updatePaymentInstrumentRequest) Update a Payment Instrument

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)

createPaymentInstrumentCall

public com.squareup.okhttp.Call createPaymentInstrumentCall(String profileId,
                                                            CreatePaymentInstrumentRequest createPaymentInstrumentRequest,
                                                            ProgressResponseBody.ProgressListener progressListener,
                                                            ProgressRequestBody.ProgressRequestListener progressRequestListener)
                                                     throws ApiException

Build call for createPaymentInstrument

Parameters:

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

createPaymentInstrumentRequest - Specify the customer's payment details for card or bank account. (required)

progressListener - Progress listener

progressRequestListener - Progress request listener

Returns:

Call to execute

Throws:

ApiException - If fail to serialize the request body object

createPaymentInstrument

public TmsV1InstrumentIdentifiersPaymentInstrumentsGet200ResponseEmbeddedPaymentInstruments createPaymentInstrument(String profileId,
                                                                                                                    CreatePaymentInstrumentRequest createPaymentInstrumentRequest)
                                                                                                             throws ApiException

Create a Payment Instrument

Parameters:

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

createPaymentInstrumentRequest - Specify the customer's payment details for card or bank account. (required)

Returns:

TmsV1InstrumentIdentifiersPaymentInstrumentsGet200ResponseEmbeddedPaymentInstruments

Throws:

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

createPaymentInstrumentWithHttpInfo

public ApiResponse<TmsV1InstrumentIdentifiersPaymentInstrumentsGet200ResponseEmbeddedPaymentInstruments> createPaymentInstrumentWithHttpInfo(String profileId,
                                                                                                                                             CreatePaymentInstrumentRequest createPaymentInstrumentRequest)
                                                                                                                                      throws ApiException

Create a Payment Instrument

Parameters:

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

createPaymentInstrumentRequest - Specify the customer's payment details for card or bank account. (required)

Returns:

ApiResponse<TmsV1InstrumentIdentifiersPaymentInstrumentsGet200ResponseEmbeddedPaymentInstruments>

Throws:

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

createPaymentInstrumentAsync

public com.squareup.okhttp.Call createPaymentInstrumentAsync(String profileId,
                                                             CreatePaymentInstrumentRequest createPaymentInstrumentRequest,
                                                             ApiCallback<TmsV1InstrumentIdentifiersPaymentInstrumentsGet200ResponseEmbeddedPaymentInstruments> callback)
                                                      throws ApiException

Create a Payment Instrument (asynchronously)

Parameters:

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

createPaymentInstrumentRequest - Specify the customer's payment details for card or bank account. (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

deletePaymentInstrumentCall

public com.squareup.okhttp.Call deletePaymentInstrumentCall(String profileId,
                                                            String tokenId,
                                                            ProgressResponseBody.ProgressListener progressListener,
                                                            ProgressRequestBody.ProgressRequestListener progressRequestListener)
                                                     throws ApiException

Build call for deletePaymentInstrument

Parameters:

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

tokenId - The TokenId of a Payment Instrument. (required)

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 profileId,
                                    String tokenId)
                             throws ApiException

Delete a Payment Instrument

Parameters:

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

tokenId - The TokenId of a Payment Instrument. (required)

Throws:

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

deletePaymentInstrumentWithHttpInfo

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

Delete a Payment Instrument

Parameters:

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

tokenId - The TokenId of a Payment Instrument. (required)

Returns:

ApiResponse<Void>

Throws:

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

deletePaymentInstrumentAsync

public com.squareup.okhttp.Call deletePaymentInstrumentAsync(String profileId,
                                                             String tokenId,
                                                             ApiCallback<Void> callback)
                                                      throws ApiException

Delete a Payment Instrument (asynchronously)

Parameters:

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

tokenId - The TokenId of a Payment Instrument. (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

getPaymentInstrumentCall

public com.squareup.okhttp.Call getPaymentInstrumentCall(String profileId,
                                                         String tokenId,
                                                         ProgressResponseBody.ProgressListener progressListener,
                                                         ProgressRequestBody.ProgressRequestListener progressRequestListener)
                                                  throws ApiException

Build call for getPaymentInstrument

Parameters:

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

tokenId - The TokenId of a Payment Instrument. (required)

progressListener - Progress listener

progressRequestListener - Progress request listener

Returns:

Call to execute

Throws:

ApiException - If fail to serialize the request body object

getPaymentInstrument

public TmsV1InstrumentIdentifiersPaymentInstrumentsGet200ResponseEmbeddedPaymentInstruments getPaymentInstrument(String profileId,
                                                                                                                 String tokenId)
                                                                                                          throws ApiException

Retrieve a Payment Instrument

Parameters:

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

tokenId - The TokenId of a Payment Instrument. (required)

Returns:

TmsV1InstrumentIdentifiersPaymentInstrumentsGet200ResponseEmbeddedPaymentInstruments

Throws:

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

getPaymentInstrumentWithHttpInfo

public ApiResponse<TmsV1InstrumentIdentifiersPaymentInstrumentsGet200ResponseEmbeddedPaymentInstruments> getPaymentInstrumentWithHttpInfo(String profileId,
                                                                                                                                          String tokenId)
                                                                                                                                   throws ApiException

Retrieve a Payment Instrument

Parameters:

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

tokenId - The TokenId of a Payment Instrument. (required)

Returns:

ApiResponse<TmsV1InstrumentIdentifiersPaymentInstrumentsGet200ResponseEmbeddedPaymentInstruments>

Throws:

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

getPaymentInstrumentAsync

public com.squareup.okhttp.Call getPaymentInstrumentAsync(String profileId,
                                                          String tokenId,
                                                          ApiCallback<TmsV1InstrumentIdentifiersPaymentInstrumentsGet200ResponseEmbeddedPaymentInstruments> callback)
                                                   throws ApiException

Retrieve a Payment Instrument (asynchronously)

Parameters:

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

tokenId - The TokenId of a Payment Instrument. (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

updatePaymentInstrumentCall

public com.squareup.okhttp.Call updatePaymentInstrumentCall(String profileId,
                                                            String tokenId,
                                                            UpdatePaymentInstrumentRequest updatePaymentInstrumentRequest,
                                                            ProgressResponseBody.ProgressListener progressListener,
                                                            ProgressRequestBody.ProgressRequestListener progressRequestListener)
                                                     throws ApiException

Build call for updatePaymentInstrument

Parameters:

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

tokenId - The TokenId of a Payment Instrument. (required)

updatePaymentInstrumentRequest - Specify the customer's payment details. (required)

progressListener - Progress listener

progressRequestListener - Progress request listener

Returns:

Call to execute

Throws:

ApiException - If fail to serialize the request body object

updatePaymentInstrument

public TmsV1InstrumentIdentifiersPaymentInstrumentsGet200ResponseEmbeddedPaymentInstruments updatePaymentInstrument(String profileId,
                                                                                                                    String tokenId,
                                                                                                                    UpdatePaymentInstrumentRequest updatePaymentInstrumentRequest)
                                                                                                             throws ApiException

Update a Payment Instrument

Parameters:

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

tokenId - The TokenId of a Payment Instrument. (required)

updatePaymentInstrumentRequest - Specify the customer's payment details. (required)

Returns:

TmsV1InstrumentIdentifiersPaymentInstrumentsGet200ResponseEmbeddedPaymentInstruments

Throws:

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

updatePaymentInstrumentWithHttpInfo

public ApiResponse<TmsV1InstrumentIdentifiersPaymentInstrumentsGet200ResponseEmbeddedPaymentInstruments> updatePaymentInstrumentWithHttpInfo(String profileId,
                                                                                                                                             String tokenId,
                                                                                                                                             UpdatePaymentInstrumentRequest updatePaymentInstrumentRequest)
                                                                                                                                      throws ApiException

Update a Payment Instrument

Parameters:

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

tokenId - The TokenId of a Payment Instrument. (required)

updatePaymentInstrumentRequest - Specify the customer's payment details. (required)

Returns:

ApiResponse<TmsV1InstrumentIdentifiersPaymentInstrumentsGet200ResponseEmbeddedPaymentInstruments>

Throws:

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

updatePaymentInstrumentAsync

public com.squareup.okhttp.Call updatePaymentInstrumentAsync(String profileId,
                                                             String tokenId,
                                                             UpdatePaymentInstrumentRequest updatePaymentInstrumentRequest,
                                                             ApiCallback<TmsV1InstrumentIdentifiersPaymentInstrumentsGet200ResponseEmbeddedPaymentInstruments> callback)
                                                      throws ApiException

Update a Payment Instrument (asynchronously)

Parameters:

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

tokenId - The TokenId of a Payment Instrument. (required)

updatePaymentInstrumentRequest - Specify the customer's payment details. (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