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
ApiClient	getApiClient()
InlineResponse2016	paymentinstrumentsPost(String profileId, Body2 body) Create a Payment Instrument
com.squareup.okhttp.Call	paymentinstrumentsPostAsync(String profileId, Body2 body, ApiCallback<InlineResponse2016> callback) Create a Payment Instrument (asynchronously)
com.squareup.okhttp.Call	paymentinstrumentsPostCall(String profileId, Body2 body, ProgressResponseBody.ProgressListener progressListener, ProgressRequestBody.ProgressRequestListener progressRequestListener) Build call for paymentinstrumentsPost
ApiResponse<InlineResponse2016>	paymentinstrumentsPostWithHttpInfo(String profileId, Body2 body) Create a Payment Instrument
void	paymentinstrumentsTokenIdDelete(String profileId, String tokenId) Delete a Payment Instrument
com.squareup.okhttp.Call	paymentinstrumentsTokenIdDeleteAsync(String profileId, String tokenId, ApiCallback<Void> callback) Delete a Payment Instrument (asynchronously)
com.squareup.okhttp.Call	paymentinstrumentsTokenIdDeleteCall(String profileId, String tokenId, ProgressResponseBody.ProgressListener progressListener, ProgressRequestBody.ProgressRequestListener progressRequestListener) Build call for paymentinstrumentsTokenIdDelete
ApiResponse<Void>	paymentinstrumentsTokenIdDeleteWithHttpInfo(String profileId, String tokenId) Delete a Payment Instrument
InlineResponse2016	paymentinstrumentsTokenIdGet(String profileId, String tokenId) Retrieve a Payment Instrument
com.squareup.okhttp.Call	paymentinstrumentsTokenIdGetAsync(String profileId, String tokenId, ApiCallback<InlineResponse2016> callback) Retrieve a Payment Instrument (asynchronously)
com.squareup.okhttp.Call	paymentinstrumentsTokenIdGetCall(String profileId, String tokenId, ProgressResponseBody.ProgressListener progressListener, ProgressRequestBody.ProgressRequestListener progressRequestListener) Build call for paymentinstrumentsTokenIdGet
ApiResponse<InlineResponse2016>	paymentinstrumentsTokenIdGetWithHttpInfo(String profileId, String tokenId) Retrieve a Payment Instrument
InlineResponse2016	paymentinstrumentsTokenIdPatch(String profileId, String tokenId, Body3 body) Update a Payment Instrument
com.squareup.okhttp.Call	paymentinstrumentsTokenIdPatchAsync(String profileId, String tokenId, Body3 body, ApiCallback<InlineResponse2016> callback) Update a Payment Instrument (asynchronously)
com.squareup.okhttp.Call	paymentinstrumentsTokenIdPatchCall(String profileId, String tokenId, Body3 body, ProgressResponseBody.ProgressListener progressListener, ProgressRequestBody.ProgressRequestListener progressRequestListener) Build call for paymentinstrumentsTokenIdPatch
ApiResponse<InlineResponse2016>	paymentinstrumentsTokenIdPatchWithHttpInfo(String profileId, String tokenId, Body3 body) Update a Payment Instrument
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)

paymentinstrumentsPostCall

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

Build call for paymentinstrumentsPost

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

paymentinstrumentsPost

public InlineResponse2016 paymentinstrumentsPost(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:

InlineResponse2016 generated.

Throws:

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

paymentinstrumentsPostWithHttpInfo

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

paymentinstrumentsPostAsync

public com.squareup.okhttp.Call paymentinstrumentsPostAsync(String profileId,
                                                            Body2 body,
                                                            ApiCallback<InlineResponse2016> 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

paymentinstrumentsTokenIdDeleteCall

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

Build call for paymentinstrumentsTokenIdDelete

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

paymentinstrumentsTokenIdDelete

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

paymentinstrumentsTokenIdDeleteWithHttpInfo

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

paymentinstrumentsTokenIdDeleteAsync

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

paymentinstrumentsTokenIdGetCall

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

Build call for paymentinstrumentsTokenIdGet

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

paymentinstrumentsTokenIdGet

public InlineResponse2016 paymentinstrumentsTokenIdGet(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 generated.

Throws:

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

paymentinstrumentsTokenIdGetWithHttpInfo

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

paymentinstrumentsTokenIdGetAsync

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

paymentinstrumentsTokenIdPatchCall

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

Build call for paymentinstrumentsTokenIdPatch

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

paymentinstrumentsTokenIdPatch

public InlineResponse2016 paymentinstrumentsTokenIdPatch(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:

InlineResponse2016 generated.

Throws:

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

paymentinstrumentsTokenIdPatchWithHttpInfo

public ApiResponse<InlineResponse2016> paymentinstrumentsTokenIdPatchWithHttpInfo(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 - InlineResponse2016.

Throws:

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

paymentinstrumentsTokenIdPatchAsync

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