Api

Class PaymentInstrumentsApi

java.lang.Object

Api.PaymentInstrumentsApi

public class PaymentInstrumentsApi
extends Object

Constructor Summary

Constructors

Constructor and Description
PaymentInstrumentsApi()
PaymentInstrumentsApi(ApiClient apiClient)

Method Summary

Modifier and Type	Method and Description
ApiClient	getApiClient()
void	setApiClient(ApiClient apiClient)
TmsV1InstrumentidentifiersPaymentinstrumentsGet200Response	tmsV1InstrumentidentifiersTokenIdPaymentinstrumentsGet(String profileId, String tokenId, String offset, String limit) Retrieve all Payment Instruments associated with an Instrument Identifier
com.squareup.okhttp.Call	tmsV1InstrumentidentifiersTokenIdPaymentinstrumentsGetAsync(String profileId, String tokenId, String offset, String limit, ApiCallback<TmsV1InstrumentidentifiersPaymentinstrumentsGet200Response> callback) Retrieve all Payment Instruments associated with an Instrument Identifier (asynchronously)
com.squareup.okhttp.Call	tmsV1InstrumentidentifiersTokenIdPaymentinstrumentsGetCall(String profileId, String tokenId, String offset, String limit, ProgressResponseBody.ProgressListener progressListener, ProgressRequestBody.ProgressRequestListener progressRequestListener) Build call for tmsV1InstrumentidentifiersTokenIdPaymentinstrumentsGet
ApiResponse<TmsV1InstrumentidentifiersPaymentinstrumentsGet200Response>	tmsV1InstrumentidentifiersTokenIdPaymentinstrumentsGetWithHttpInfo(String profileId, String tokenId, String offset, String limit) Retrieve all Payment Instruments associated with an Instrument Identifier
TmsV1PaymentinstrumentsPost201Response	tmsV1PaymentinstrumentsPost(String profileId, Body2 body) Create a Payment Instrument
com.squareup.okhttp.Call	tmsV1PaymentinstrumentsPostAsync(String profileId, Body2 body, ApiCallback<TmsV1PaymentinstrumentsPost201Response> callback) Create a Payment Instrument (asynchronously)
com.squareup.okhttp.Call	tmsV1PaymentinstrumentsPostCall(String profileId, Body2 body, ProgressResponseBody.ProgressListener progressListener, ProgressRequestBody.ProgressRequestListener progressRequestListener) Build call for tmsV1PaymentinstrumentsPost
ApiResponse<TmsV1PaymentinstrumentsPost201Response>	tmsV1PaymentinstrumentsPostWithHttpInfo(String profileId, Body2 body) Create a Payment Instrument
void	tmsV1PaymentinstrumentsTokenIdDelete(String profileId, String tokenId) Delete a Payment Instrument
com.squareup.okhttp.Call	tmsV1PaymentinstrumentsTokenIdDeleteAsync(String profileId, String tokenId, ApiCallback<Void> callback) Delete a Payment Instrument (asynchronously)
com.squareup.okhttp.Call	tmsV1PaymentinstrumentsTokenIdDeleteCall(String profileId, String tokenId, ProgressResponseBody.ProgressListener progressListener, ProgressRequestBody.ProgressRequestListener progressRequestListener) Build call for tmsV1PaymentinstrumentsTokenIdDelete
ApiResponse<Void>	tmsV1PaymentinstrumentsTokenIdDeleteWithHttpInfo(String profileId, String tokenId) Delete a Payment Instrument
TmsV1PaymentinstrumentsPost201Response	tmsV1PaymentinstrumentsTokenIdGet(String profileId, String tokenId) Retrieve a Payment Instrument
com.squareup.okhttp.Call	tmsV1PaymentinstrumentsTokenIdGetAsync(String profileId, String tokenId, ApiCallback<TmsV1PaymentinstrumentsPost201Response> callback) Retrieve a Payment Instrument (asynchronously)
com.squareup.okhttp.Call	tmsV1PaymentinstrumentsTokenIdGetCall(String profileId, String tokenId, ProgressResponseBody.ProgressListener progressListener, ProgressRequestBody.ProgressRequestListener progressRequestListener) Build call for tmsV1PaymentinstrumentsTokenIdGet
ApiResponse<TmsV1PaymentinstrumentsPost201Response>	tmsV1PaymentinstrumentsTokenIdGetWithHttpInfo(String profileId, String tokenId) Retrieve a Payment Instrument
TmsV1PaymentinstrumentsPost201Response	tmsV1PaymentinstrumentsTokenIdPatch(String profileId, String tokenId, Body3 body) Update a Payment Instrument
com.squareup.okhttp.Call	tmsV1PaymentinstrumentsTokenIdPatchAsync(String profileId, String tokenId, Body3 body, ApiCallback<TmsV1PaymentinstrumentsPost201Response> callback) Update a Payment Instrument (asynchronously)
com.squareup.okhttp.Call	tmsV1PaymentinstrumentsTokenIdPatchCall(String profileId, String tokenId, Body3 body, ProgressResponseBody.ProgressListener progressListener, ProgressRequestBody.ProgressRequestListener progressRequestListener) Build call for tmsV1PaymentinstrumentsTokenIdPatch
ApiResponse<TmsV1PaymentinstrumentsPost201Response>	tmsV1PaymentinstrumentsTokenIdPatchWithHttpInfo(String profileId, String tokenId, Body3 body) Update a Payment Instrument

Methods inherited from class java.lang.Object

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

Constructor Detail

PaymentInstrumentsApi

public PaymentInstrumentsApi()

PaymentInstrumentsApi

public PaymentInstrumentsApi(ApiClient apiClient)

Method Detail

getApiClient

public ApiClient getApiClient()

setApiClient

public void setApiClient(ApiClient apiClient)

tmsV1InstrumentidentifiersTokenIdPaymentinstrumentsGetCall

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

Build call for tmsV1InstrumentidentifiersTokenIdPaymentinstrumentsGet

Parameters:

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

tokenId - The TokenId of an Instrument Identifier. (required)

offset - Starting Payment Instrument record in zero-based dataset that should be returned as the first object in the array. Default is 0. (optional)

limit - The maximum number of Payment Instruments 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

tmsV1InstrumentidentifiersTokenIdPaymentinstrumentsGet

public TmsV1InstrumentidentifiersPaymentinstrumentsGet200Response tmsV1InstrumentidentifiersTokenIdPaymentinstrumentsGet(String profileId,
                                                                                                                         String tokenId,
                                                                                                                         String offset,
                                                                                                                         String limit)
                                                                                                                  throws ApiException

Retrieve all Payment Instruments associated with an Instrument Identifier

Parameters:

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

tokenId - The TokenId of an Instrument Identifier. (required)

offset - Starting Payment Instrument record in zero-based dataset that should be returned as the first object in the array. Default is 0. (optional)

limit - The maximum number of Payment Instruments 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:

TmsV1InstrumentidentifiersPaymentinstrumentsGet200Response

Throws:

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

tmsV1InstrumentidentifiersTokenIdPaymentinstrumentsGetWithHttpInfo

public ApiResponse<TmsV1InstrumentidentifiersPaymentinstrumentsGet200Response> tmsV1InstrumentidentifiersTokenIdPaymentinstrumentsGetWithHttpInfo(String profileId,
                                                                                                                                                  String tokenId,
                                                                                                                                                  String offset,
                                                                                                                                                  String limit)
                                                                                                                                           throws ApiException

Retrieve all Payment Instruments associated with an Instrument Identifier

Parameters:

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

tokenId - The TokenId of an Instrument Identifier. (required)

offset - Starting Payment Instrument record in zero-based dataset that should be returned as the first object in the array. Default is 0. (optional)

limit - The maximum number of Payment Instruments 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<TmsV1InstrumentidentifiersPaymentinstrumentsGet200Response>

Throws:

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

tmsV1InstrumentidentifiersTokenIdPaymentinstrumentsGetAsync

public com.squareup.okhttp.Call tmsV1InstrumentidentifiersTokenIdPaymentinstrumentsGetAsync(String profileId,
                                                                                            String tokenId,
                                                                                            String offset,
                                                                                            String limit,
                                                                                            ApiCallback<TmsV1InstrumentidentifiersPaymentinstrumentsGet200Response> callback)
                                                                                     throws ApiException

Retrieve all Payment Instruments associated with an Instrument Identifier (asynchronously)

Parameters:

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

tokenId - The TokenId of an Instrument Identifier. (required)

offset - Starting Payment Instrument record in zero-based dataset that should be returned as the first object in the array. Default is 0. (optional)

limit - The maximum number of Payment Instruments 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

tmsV1PaymentinstrumentsPostCall

public com.squareup.okhttp.Call tmsV1PaymentinstrumentsPostCall(String profileId,
                                                                Body2 body,
                                                                ProgressResponseBody.ProgressListener progressListener,
                                                                ProgressRequestBody.ProgressRequestListener progressRequestListener)
                                                         throws ApiException

Build call for tmsV1PaymentinstrumentsPost

Parameters:

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

body - Please specify the customers 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

tmsV1PaymentinstrumentsPost

public TmsV1PaymentinstrumentsPost201Response tmsV1PaymentinstrumentsPost(String profileId,
                                                                          Body2 body)
                                                                   throws ApiException

Create a Payment Instrument

Parameters:

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

body - Please specify the customers payment details for card or bank account. (required)

Returns:

TmsV1PaymentinstrumentsPost201Response

Throws:

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

tmsV1PaymentinstrumentsPostWithHttpInfo

public ApiResponse<TmsV1PaymentinstrumentsPost201Response> tmsV1PaymentinstrumentsPostWithHttpInfo(String profileId,
                                                                                                   Body2 body)
                                                                                            throws ApiException

Create a Payment Instrument

Parameters:

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

body - Please specify the customers payment details for card or bank account. (required)

Returns:

ApiResponse<InlineResponse2016>

Throws:

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

tmsV1PaymentinstrumentsPostAsync

public com.squareup.okhttp.Call tmsV1PaymentinstrumentsPostAsync(String profileId,
                                                                 Body2 body,
                                                                 ApiCallback<TmsV1PaymentinstrumentsPost201Response> callback)
                                                          throws ApiException

Create a Payment Instrument (asynchronously)

Parameters:

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

body - Please specify the customers 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

tmsV1PaymentinstrumentsTokenIdDeleteCall

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

Build call for tmsV1PaymentinstrumentsTokenIdDelete

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

tmsV1PaymentinstrumentsTokenIdDelete

public void tmsV1PaymentinstrumentsTokenIdDelete(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

tmsV1PaymentinstrumentsTokenIdDeleteWithHttpInfo

public ApiResponse<Void> tmsV1PaymentinstrumentsTokenIdDeleteWithHttpInfo(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

tmsV1PaymentinstrumentsTokenIdDeleteAsync

public com.squareup.okhttp.Call tmsV1PaymentinstrumentsTokenIdDeleteAsync(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

tmsV1PaymentinstrumentsTokenIdGetCall

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

Build call for tmsV1PaymentinstrumentsTokenIdGet

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

tmsV1PaymentinstrumentsTokenIdGet

public TmsV1PaymentinstrumentsPost201Response tmsV1PaymentinstrumentsTokenIdGet(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:

InlineResponse2016

Throws:

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

tmsV1PaymentinstrumentsTokenIdGetWithHttpInfo

public ApiResponse<TmsV1PaymentinstrumentsPost201Response> tmsV1PaymentinstrumentsTokenIdGetWithHttpInfo(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<InlineResponse2016>

Throws:

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

tmsV1PaymentinstrumentsTokenIdGetAsync

public com.squareup.okhttp.Call tmsV1PaymentinstrumentsTokenIdGetAsync(String profileId,
                                                                       String tokenId,
                                                                       ApiCallback<TmsV1PaymentinstrumentsPost201Response> 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

tmsV1PaymentinstrumentsTokenIdPatchCall

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

Build call for tmsV1PaymentinstrumentsTokenIdPatch

Parameters:

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

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

body - Please specify the customers payment details. (required)

progressListener - Progress listener

progressRequestListener - Progress request listener

Returns:

Call to execute

Throws:

ApiException - If fail to serialize the request body object

tmsV1PaymentinstrumentsTokenIdPatch

public TmsV1PaymentinstrumentsPost201Response tmsV1PaymentinstrumentsTokenIdPatch(String profileId,
                                                                                  String tokenId,
                                                                                  Body3 body)
                                                                           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)

body - Please specify the customers payment details. (required)

Returns:

TmsV1PaymentinstrumentsPost201Response

Throws:

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

tmsV1PaymentinstrumentsTokenIdPatchWithHttpInfo

public ApiResponse<TmsV1PaymentinstrumentsPost201Response> tmsV1PaymentinstrumentsTokenIdPatchWithHttpInfo(String profileId,
                                                                                                           String tokenId,
                                                                                                           Body3 body)
                                                                                                    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)

body - Please specify the customers payment details. (required)

Returns:

ApiResponse<TmsV1PaymentinstrumentsPost201Response>

Throws:

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

tmsV1PaymentinstrumentsTokenIdPatchAsync

public com.squareup.okhttp.Call tmsV1PaymentinstrumentsTokenIdPatchAsync(String profileId,
                                                                         String tokenId,
                                                                         Body3 body,
                                                                         ApiCallback<TmsV1PaymentinstrumentsPost201Response> 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)

body - Please specify the customers 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