Api

Class CustomerPaymentInstrumentApi

java.lang.Object

Api.CustomerPaymentInstrumentApi

public class CustomerPaymentInstrumentApi
extends Object

Constructor Summary

Constructors

Constructor and Description
CustomerPaymentInstrumentApi()
CustomerPaymentInstrumentApi(ApiClient apiClient)

Method Summary

Modifier and Type	Method and Description
void	deleteCustomerPaymentInstrument(String customerId, String paymentInstrumentId, String profileId) Delete a Customer Payment Instrument | | | | | --- | --- | --- | |**Customer Payment Instrument**<br>A Customer Payment Instrument represents tokenized customer payment information such as expiration date, billing address & card type.<br>A [Customer](#token-management_customer_create-a-customer) can have [one or more Payment Instruments](#token-management_customer-payment-instrument_retrieve-a-customer-payment-instrument), with one allocated as the Customers default for use in payments.<br>A Payment Instrument token does not store the card number.
okhttp3.Call	deleteCustomerPaymentInstrumentAsync(String customerId, String paymentInstrumentId, String profileId, ApiCallback<Void> callback) Delete a Customer Payment Instrument (asynchronously) | | | | | --- | --- | --- | |**Customer Payment Instrument**<br>A Customer Payment Instrument represents tokenized customer payment information such as expiration date, billing address & card type.<br>A [Customer](#token-management_customer_create-a-customer) can have [one or more Payment Instruments](#token-management_customer-payment-instrument_retrieve-a-customer-payment-instrument), with one allocated as the Customers default for use in payments.<br>A Payment Instrument token does not store the card number.
okhttp3.Call	deleteCustomerPaymentInstrumentCall(String customerId, String paymentInstrumentId, String profileId, ProgressResponseBody.ProgressListener progressListener, ProgressRequestBody.ProgressRequestListener progressRequestListener) Build call for deleteCustomerPaymentInstrument
ApiResponse<Void>	deleteCustomerPaymentInstrumentWithHttpInfo(String customerId, String paymentInstrumentId, String profileId) Delete a Customer Payment Instrument | | | | | --- | --- | --- | |**Customer Payment Instrument**<br>A Customer Payment Instrument represents tokenized customer payment information such as expiration date, billing address & card type.<br>A [Customer](#token-management_customer_create-a-customer) can have [one or more Payment Instruments](#token-management_customer-payment-instrument_retrieve-a-customer-payment-instrument), with one allocated as the Customers default for use in payments.<br>A Payment Instrument token does not store the card number.
ApiClient	getApiClient()
PostCustomerPaymentInstrumentRequest	getCustomerPaymentInstrument(String customerId, String paymentInstrumentId, String profileId) Retrieve a Customer Payment Instrument | | | | | --- | --- | --- | |**Customer Payment Instrument**<br>A Customer Payment Instrument represents tokenized customer payment information such as expiration date, billing address & card type.<br>A [Customer](#token-management_customer_create-a-customer) can have [one or more Payment Instruments](#token-management_customer-payment-instrument_retrieve-a-customer-payment-instrument), with one allocated as the Customers default for use in payments.<br>A Payment Instrument token does not store the card number.
okhttp3.Call	getCustomerPaymentInstrumentAsync(String customerId, String paymentInstrumentId, String profileId, ApiCallback<PostCustomerPaymentInstrumentRequest> callback) Retrieve a Customer Payment Instrument (asynchronously) | | | | | --- | --- | --- | |**Customer Payment Instrument**<br>A Customer Payment Instrument represents tokenized customer payment information such as expiration date, billing address & card type.<br>A [Customer](#token-management_customer_create-a-customer) can have [one or more Payment Instruments](#token-management_customer-payment-instrument_retrieve-a-customer-payment-instrument), with one allocated as the Customers default for use in payments.<br>A Payment Instrument token does not store the card number.
okhttp3.Call	getCustomerPaymentInstrumentCall(String customerId, String paymentInstrumentId, String profileId, ProgressResponseBody.ProgressListener progressListener, ProgressRequestBody.ProgressRequestListener progressRequestListener) Build call for getCustomerPaymentInstrument
PaymentInstrumentList	getCustomerPaymentInstrumentsList(String customerId, String profileId, Long offset, Long limit) List Payment Instruments for a Customer | | | | | --- | --- | --- | |**Customer Payment Instrument**<br>A Customer Payment Instrument represents tokenized customer payment information such as expiration date, billing address & card type.<br>A [Customer](#token-management_customer_create-a-customer) can have [one or more Payment Instruments](#token-management_customer-payment-instrument_retrieve-a-customer-payment-instrument), with one allocated as the Customers default for use in payments.<br>A Payment Instrument token does not store the card number.
okhttp3.Call	getCustomerPaymentInstrumentsListAsync(String customerId, String profileId, Long offset, Long limit, ApiCallback<PaymentInstrumentList> callback) List Payment Instruments for a Customer (asynchronously) | | | | | --- | --- | --- | |**Customer Payment Instrument**<br>A Customer Payment Instrument represents tokenized customer payment information such as expiration date, billing address & card type.<br>A [Customer](#token-management_customer_create-a-customer) can have [one or more Payment Instruments](#token-management_customer-payment-instrument_retrieve-a-customer-payment-instrument), with one allocated as the Customers default for use in payments.<br>A Payment Instrument token does not store the card number.
okhttp3.Call	getCustomerPaymentInstrumentsListCall(String customerId, String profileId, Long offset, Long limit, ProgressResponseBody.ProgressListener progressListener, ProgressRequestBody.ProgressRequestListener progressRequestListener) Build call for getCustomerPaymentInstrumentsList
ApiResponse<PaymentInstrumentList>	getCustomerPaymentInstrumentsListWithHttpInfo(String customerId, String profileId, Long offset, Long limit) List Payment Instruments for a Customer | | | | | --- | --- | --- | |**Customer Payment Instrument**<br>A Customer Payment Instrument represents tokenized customer payment information such as expiration date, billing address & card type.<br>A [Customer](#token-management_customer_create-a-customer) can have [one or more Payment Instruments](#token-management_customer-payment-instrument_retrieve-a-customer-payment-instrument), with one allocated as the Customers default for use in payments.<br>A Payment Instrument token does not store the card number.
ApiResponse<PostCustomerPaymentInstrumentRequest>	getCustomerPaymentInstrumentWithHttpInfo(String customerId, String paymentInstrumentId, String profileId) Retrieve a Customer Payment Instrument | | | | | --- | --- | --- | |**Customer Payment Instrument**<br>A Customer Payment Instrument represents tokenized customer payment information such as expiration date, billing address & card type.<br>A [Customer](#token-management_customer_create-a-customer) can have [one or more Payment Instruments](#token-management_customer-payment-instrument_retrieve-a-customer-payment-instrument), with one allocated as the Customers default for use in payments.<br>A Payment Instrument token does not store the card number.
PatchCustomerPaymentInstrumentRequest	patchCustomersPaymentInstrument(String customerId, String paymentInstrumentId, PatchCustomerPaymentInstrumentRequest patchCustomerPaymentInstrumentRequest, String profileId, String ifMatch) Update a Customer Payment Instrument | | | | | --- | --- | --- | |**Customer Payment Instrument**<br>A Customer Payment Instrument represents tokenized customer payment information such as expiration date, billing address & card type.<br>A [Customer](#token-management_customer_create-a-customer) can have [one or more Payment Instruments](#token-management_customer-payment-instrument_retrieve-a-customer-payment-instrument), with one allocated as the Customers default for use in payments.<br>A Payment Instrument token does not store the card number.
okhttp3.Call	patchCustomersPaymentInstrumentAsync(String customerId, String paymentInstrumentId, PatchCustomerPaymentInstrumentRequest patchCustomerPaymentInstrumentRequest, String profileId, String ifMatch, ApiCallback<PatchCustomerPaymentInstrumentRequest> callback) Update a Customer Payment Instrument (asynchronously) | | | | | --- | --- | --- | |**Customer Payment Instrument**<br>A Customer Payment Instrument represents tokenized customer payment information such as expiration date, billing address & card type.<br>A [Customer](#token-management_customer_create-a-customer) can have [one or more Payment Instruments](#token-management_customer-payment-instrument_retrieve-a-customer-payment-instrument), with one allocated as the Customers default for use in payments.<br>A Payment Instrument token does not store the card number.
okhttp3.Call	patchCustomersPaymentInstrumentCall(String customerId, String paymentInstrumentId, PatchCustomerPaymentInstrumentRequest patchCustomerPaymentInstrumentRequest, String profileId, String ifMatch, ProgressResponseBody.ProgressListener progressListener, ProgressRequestBody.ProgressRequestListener progressRequestListener) Build call for patchCustomersPaymentInstrument
ApiResponse<PatchCustomerPaymentInstrumentRequest>	patchCustomersPaymentInstrumentWithHttpInfo(String customerId, String paymentInstrumentId, PatchCustomerPaymentInstrumentRequest patchCustomerPaymentInstrumentRequest, String profileId, String ifMatch) Update a Customer Payment Instrument | | | | | --- | --- | --- | |**Customer Payment Instrument**<br>A Customer Payment Instrument represents tokenized customer payment information such as expiration date, billing address & card type.<br>A [Customer](#token-management_customer_create-a-customer) can have [one or more Payment Instruments](#token-management_customer-payment-instrument_retrieve-a-customer-payment-instrument), with one allocated as the Customers default for use in payments.<br>A Payment Instrument token does not store the card number.
PostCustomerPaymentInstrumentRequest	postCustomerPaymentInstrument(String customerId, PostCustomerPaymentInstrumentRequest postCustomerPaymentInstrumentRequest, String profileId) Create a Customer Payment Instrument | | | | | --- | --- | --- | |**Customer Payment Instrument**<br>A Customer Payment Instrument represents tokenized customer payment information such as expiration date, billing address & card type.<br>A [Customer](#token-management_customer_create-a-customer) can have [one or more Payment Instruments](#token-management_customer-payment-instrument_retrieve-a-customer-payment-instrument), with one allocated as the Customers default for use in payments.<br>A Payment Instrument token does not store the card number.
okhttp3.Call	postCustomerPaymentInstrumentAsync(String customerId, PostCustomerPaymentInstrumentRequest postCustomerPaymentInstrumentRequest, String profileId, ApiCallback<PostCustomerPaymentInstrumentRequest> callback) Create a Customer Payment Instrument (asynchronously) | | | | | --- | --- | --- | |**Customer Payment Instrument**<br>A Customer Payment Instrument represents tokenized customer payment information such as expiration date, billing address & card type.<br>A [Customer](#token-management_customer_create-a-customer) can have [one or more Payment Instruments](#token-management_customer-payment-instrument_retrieve-a-customer-payment-instrument), with one allocated as the Customers default for use in payments.<br>A Payment Instrument token does not store the card number.
okhttp3.Call	postCustomerPaymentInstrumentCall(String customerId, PostCustomerPaymentInstrumentRequest postCustomerPaymentInstrumentRequest, String profileId, ProgressResponseBody.ProgressListener progressListener, ProgressRequestBody.ProgressRequestListener progressRequestListener) Build call for postCustomerPaymentInstrument
ApiResponse<PostCustomerPaymentInstrumentRequest>	postCustomerPaymentInstrumentWithHttpInfo(String customerId, PostCustomerPaymentInstrumentRequest postCustomerPaymentInstrumentRequest, String profileId) Create a Customer Payment Instrument | | | | | --- | --- | --- | |**Customer Payment Instrument**<br>A Customer Payment Instrument represents tokenized customer payment information such as expiration date, billing address & card type.<br>A [Customer](#token-management_customer_create-a-customer) can have [one or more Payment Instruments](#token-management_customer-payment-instrument_retrieve-a-customer-payment-instrument), with one allocated as the Customers default for use in payments.<br>A Payment Instrument token does not store the card number.
void	setApiClient(ApiClient apiClient)

Methods inherited from class java.lang.Object

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

Constructor Detail

CustomerPaymentInstrumentApi

public CustomerPaymentInstrumentApi()

CustomerPaymentInstrumentApi

public CustomerPaymentInstrumentApi(ApiClient apiClient)

Method Detail

getApiClient

public ApiClient getApiClient()

setApiClient

public void setApiClient(ApiClient apiClient)

deleteCustomerPaymentInstrumentCall

public okhttp3.Call deleteCustomerPaymentInstrumentCall(String customerId,
                                                        String paymentInstrumentId,
                                                        String profileId,
                                                        ProgressResponseBody.ProgressListener progressListener,
                                                        ProgressRequestBody.ProgressRequestListener progressRequestListener)
                                                 throws ApiException

Build call for deleteCustomerPaymentInstrument

Parameters:

customerId - The Id of a Customer. (required)

paymentInstrumentId - The Id 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

deleteCustomerPaymentInstrument

public void deleteCustomerPaymentInstrument(String customerId,
                                            String paymentInstrumentId,
                                            String profileId)
                                     throws ApiException

Delete a Customer Payment Instrument | | | | | --- | --- | --- | |**Customer Payment Instrument**<br>A Customer Payment Instrument represents tokenized customer payment information such as expiration date, billing address & card type.<br>A [Customer](#token-management_customer_create-a-customer) can have [one or more Payment Instruments](#token-management_customer-payment-instrument_retrieve-a-customer-payment-instrument), with one allocated as the Customers default for use in payments.<br>A Payment Instrument token does not store the card number. A Payment Instrument is associated with an [Instrument Identifier](#token-management_instrument-identifier_create-an-instrument-identifier) that represents either a payment card number, or in the case of an ACH bank account, the routing and account number.<br>|&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;|**Deleting a Customers Payment Instrument**<br>Your system can use this API to delete an existing Payment Instrument for a Customer.<br>Any Instrument Identifiers representing the card number will also be deleted if they are not associated with any other Payment Instruments.<br>If a customer has more than one Payment Instrument then the default Payment Instrument cannot be deleted without first selecting a [new default Payment Instrument](#token-management_customer-payment-instrument_update-a-customer-payment-instrument_samplerequests-dropdown_make-customer-payment-instrument-the-default_liveconsole-tab-request-body).

Parameters:

customerId - The Id of a Customer. (required)

paymentInstrumentId - The Id 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

deleteCustomerPaymentInstrumentWithHttpInfo

public ApiResponse<Void> deleteCustomerPaymentInstrumentWithHttpInfo(String customerId,
                                                                     String paymentInstrumentId,
                                                                     String profileId)
                                                              throws ApiException

Delete a Customer Payment Instrument | | | | | --- | --- | --- | |**Customer Payment Instrument**<br>A Customer Payment Instrument represents tokenized customer payment information such as expiration date, billing address & card type.<br>A [Customer](#token-management_customer_create-a-customer) can have [one or more Payment Instruments](#token-management_customer-payment-instrument_retrieve-a-customer-payment-instrument), with one allocated as the Customers default for use in payments.<br>A Payment Instrument token does not store the card number. A Payment Instrument is associated with an [Instrument Identifier](#token-management_instrument-identifier_create-an-instrument-identifier) that represents either a payment card number, or in the case of an ACH bank account, the routing and account number.<br>|&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;|**Deleting a Customers Payment Instrument**<br>Your system can use this API to delete an existing Payment Instrument for a Customer.<br>Any Instrument Identifiers representing the card number will also be deleted if they are not associated with any other Payment Instruments.<br>If a customer has more than one Payment Instrument then the default Payment Instrument cannot be deleted without first selecting a [new default Payment Instrument](#token-management_customer-payment-instrument_update-a-customer-payment-instrument_samplerequests-dropdown_make-customer-payment-instrument-the-default_liveconsole-tab-request-body).

Parameters:

customerId - The Id of a Customer. (required)

paymentInstrumentId - The Id 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

deleteCustomerPaymentInstrumentAsync

public okhttp3.Call deleteCustomerPaymentInstrumentAsync(String customerId,
                                                         String paymentInstrumentId,
                                                         String profileId,
                                                         ApiCallback<Void> callback)
                                                  throws ApiException

Delete a Customer Payment Instrument (asynchronously) | | | | | --- | --- | --- | |**Customer Payment Instrument**<br>A Customer Payment Instrument represents tokenized customer payment information such as expiration date, billing address & card type.<br>A [Customer](#token-management_customer_create-a-customer) can have [one or more Payment Instruments](#token-management_customer-payment-instrument_retrieve-a-customer-payment-instrument), with one allocated as the Customers default for use in payments.<br>A Payment Instrument token does not store the card number. A Payment Instrument is associated with an [Instrument Identifier](#token-management_instrument-identifier_create-an-instrument-identifier) that represents either a payment card number, or in the case of an ACH bank account, the routing and account number.<br>|&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;|**Deleting a Customers Payment Instrument**<br>Your system can use this API to delete an existing Payment Instrument for a Customer.<br>Any Instrument Identifiers representing the card number will also be deleted if they are not associated with any other Payment Instruments.<br>If a customer has more than one Payment Instrument then the default Payment Instrument cannot be deleted without first selecting a [new default Payment Instrument](#token-management_customer-payment-instrument_update-a-customer-payment-instrument_samplerequests-dropdown_make-customer-payment-instrument-the-default_liveconsole-tab-request-body).

Parameters:

customerId - The Id of a Customer. (required)

paymentInstrumentId - The Id 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

getCustomerPaymentInstrumentCall

public okhttp3.Call getCustomerPaymentInstrumentCall(String customerId,
                                                     String paymentInstrumentId,
                                                     String profileId,
                                                     ProgressResponseBody.ProgressListener progressListener,
                                                     ProgressRequestBody.ProgressRequestListener progressRequestListener)
                                              throws ApiException

Build call for getCustomerPaymentInstrument

Parameters:

customerId - The Id of a Customer. (required)

paymentInstrumentId - The Id 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

getCustomerPaymentInstrument

public PostCustomerPaymentInstrumentRequest getCustomerPaymentInstrument(String customerId,
                                                                         String paymentInstrumentId,
                                                                         String profileId)
                                                                  throws ApiException

Retrieve a Customer Payment Instrument | | | | | --- | --- | --- | |**Customer Payment Instrument**<br>A Customer Payment Instrument represents tokenized customer payment information such as expiration date, billing address & card type.<br>A [Customer](#token-management_customer_create-a-customer) can have [one or more Payment Instruments](#token-management_customer-payment-instrument_retrieve-a-customer-payment-instrument), with one allocated as the Customers default for use in payments.<br>A Payment Instrument token does not store the card number. A Payment Instrument is associated with an [Instrument Identifier](#token-management_instrument-identifier_create-an-instrument-identifier) that represents either a payment card number, or in the case of an ACH bank account, the routing and account number.<br>|&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;|**Retrieving a Customer Payment Instrument**<br>Your system can use this API to retrieve an existing Payment Instrument for a Customer.<br>To perform a payment with a particular Payment Instrument simply specify the [Payment Instrument Id in the payments request](#payments_payments_process-a-payment_samplerequests-dropdown_authorization-using-tokens_authorization-with-customer-payment-instrument-and-shipping-address-token-id_liveconsole-tab-request-body).

Parameters:

customerId - The Id of a Customer. (required)

paymentInstrumentId - The Id of a payment instrument. (required)

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

Returns:

PostCustomerPaymentInstrumentRequest

Throws:

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

getCustomerPaymentInstrumentWithHttpInfo

public ApiResponse<PostCustomerPaymentInstrumentRequest> getCustomerPaymentInstrumentWithHttpInfo(String customerId,
                                                                                                  String paymentInstrumentId,
                                                                                                  String profileId)
                                                                                           throws ApiException

Retrieve a Customer Payment Instrument | | | | | --- | --- | --- | |**Customer Payment Instrument**<br>A Customer Payment Instrument represents tokenized customer payment information such as expiration date, billing address & card type.<br>A [Customer](#token-management_customer_create-a-customer) can have [one or more Payment Instruments](#token-management_customer-payment-instrument_retrieve-a-customer-payment-instrument), with one allocated as the Customers default for use in payments.<br>A Payment Instrument token does not store the card number. A Payment Instrument is associated with an [Instrument Identifier](#token-management_instrument-identifier_create-an-instrument-identifier) that represents either a payment card number, or in the case of an ACH bank account, the routing and account number.<br>|&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;|**Retrieving a Customer Payment Instrument**<br>Your system can use this API to retrieve an existing Payment Instrument for a Customer.<br>To perform a payment with a particular Payment Instrument simply specify the [Payment Instrument Id in the payments request](#payments_payments_process-a-payment_samplerequests-dropdown_authorization-using-tokens_authorization-with-customer-payment-instrument-and-shipping-address-token-id_liveconsole-tab-request-body).

Parameters:

customerId - The Id of a Customer. (required)

paymentInstrumentId - The Id of a payment instrument. (required)

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

Returns:

ApiResponse<PostCustomerPaymentInstrumentRequest>

Throws:

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

getCustomerPaymentInstrumentAsync

public okhttp3.Call getCustomerPaymentInstrumentAsync(String customerId,
                                                      String paymentInstrumentId,
                                                      String profileId,
                                                      ApiCallback<PostCustomerPaymentInstrumentRequest> callback)
                                               throws ApiException

Retrieve a Customer Payment Instrument (asynchronously) | | | | | --- | --- | --- | |**Customer Payment Instrument**<br>A Customer Payment Instrument represents tokenized customer payment information such as expiration date, billing address & card type.<br>A [Customer](#token-management_customer_create-a-customer) can have [one or more Payment Instruments](#token-management_customer-payment-instrument_retrieve-a-customer-payment-instrument), with one allocated as the Customers default for use in payments.<br>A Payment Instrument token does not store the card number. A Payment Instrument is associated with an [Instrument Identifier](#token-management_instrument-identifier_create-an-instrument-identifier) that represents either a payment card number, or in the case of an ACH bank account, the routing and account number.<br>|&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;|**Retrieving a Customer Payment Instrument**<br>Your system can use this API to retrieve an existing Payment Instrument for a Customer.<br>To perform a payment with a particular Payment Instrument simply specify the [Payment Instrument Id in the payments request](#payments_payments_process-a-payment_samplerequests-dropdown_authorization-using-tokens_authorization-with-customer-payment-instrument-and-shipping-address-token-id_liveconsole-tab-request-body).

Parameters:

customerId - The Id of a Customer. (required)

paymentInstrumentId - The Id 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

getCustomerPaymentInstrumentsListCall

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

Build call for getCustomerPaymentInstrumentsList

Parameters:

customerId - The Id of a Customer. (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

getCustomerPaymentInstrumentsList

public PaymentInstrumentList getCustomerPaymentInstrumentsList(String customerId,
                                                               String profileId,
                                                               Long offset,
                                                               Long limit)
                                                        throws ApiException

List Payment Instruments for a Customer | | | | | --- | --- | --- | |**Customer Payment Instrument**<br>A Customer Payment Instrument represents tokenized customer payment information such as expiration date, billing address & card type.<br>A [Customer](#token-management_customer_create-a-customer) can have [one or more Payment Instruments](#token-management_customer-payment-instrument_retrieve-a-customer-payment-instrument), with one allocated as the Customers default for use in payments.<br>A Payment Instrument token does not store the card number. A Payment Instrument is associated with an [Instrument Identifier](#token-management_instrument-identifier_create-an-instrument-identifier) that represents either a payment card number, or in the case of an ACH bank account, the routing and account number.<br>|&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;|**Retrieving all Customer Payment Instruments**<br>Your system can use this API to retrieve all existing Payment Instruments for a Customer.

Parameters:

customerId - The Id of a Customer. (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:

PaymentInstrumentList

Throws:

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

getCustomerPaymentInstrumentsListWithHttpInfo

public ApiResponse<PaymentInstrumentList> getCustomerPaymentInstrumentsListWithHttpInfo(String customerId,
                                                                                        String profileId,
                                                                                        Long offset,
                                                                                        Long limit)
                                                                                 throws ApiException

List Payment Instruments for a Customer | | | | | --- | --- | --- | |**Customer Payment Instrument**<br>A Customer Payment Instrument represents tokenized customer payment information such as expiration date, billing address & card type.<br>A [Customer](#token-management_customer_create-a-customer) can have [one or more Payment Instruments](#token-management_customer-payment-instrument_retrieve-a-customer-payment-instrument), with one allocated as the Customers default for use in payments.<br>A Payment Instrument token does not store the card number. A Payment Instrument is associated with an [Instrument Identifier](#token-management_instrument-identifier_create-an-instrument-identifier) that represents either a payment card number, or in the case of an ACH bank account, the routing and account number.<br>|&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;|**Retrieving all Customer Payment Instruments**<br>Your system can use this API to retrieve all existing Payment Instruments for a Customer.

Parameters:

customerId - The Id of a Customer. (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<PaymentInstrumentList>

Throws:

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

getCustomerPaymentInstrumentsListAsync

public okhttp3.Call getCustomerPaymentInstrumentsListAsync(String customerId,
                                                           String profileId,
                                                           Long offset,
                                                           Long limit,
                                                           ApiCallback<PaymentInstrumentList> callback)
                                                    throws ApiException

List Payment Instruments for a Customer (asynchronously) | | | | | --- | --- | --- | |**Customer Payment Instrument**<br>A Customer Payment Instrument represents tokenized customer payment information such as expiration date, billing address & card type.<br>A [Customer](#token-management_customer_create-a-customer) can have [one or more Payment Instruments](#token-management_customer-payment-instrument_retrieve-a-customer-payment-instrument), with one allocated as the Customers default for use in payments.<br>A Payment Instrument token does not store the card number. A Payment Instrument is associated with an [Instrument Identifier](#token-management_instrument-identifier_create-an-instrument-identifier) that represents either a payment card number, or in the case of an ACH bank account, the routing and account number.<br>|&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;|**Retrieving all Customer Payment Instruments**<br>Your system can use this API to retrieve all existing Payment Instruments for a Customer.

Parameters:

customerId - The Id of a Customer. (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

patchCustomersPaymentInstrumentCall

public okhttp3.Call patchCustomersPaymentInstrumentCall(String customerId,
                                                        String paymentInstrumentId,
                                                        PatchCustomerPaymentInstrumentRequest patchCustomerPaymentInstrumentRequest,
                                                        String profileId,
                                                        String ifMatch,
                                                        ProgressResponseBody.ProgressListener progressListener,
                                                        ProgressRequestBody.ProgressRequestListener progressRequestListener)
                                                 throws ApiException

Build call for patchCustomersPaymentInstrument

Parameters:

customerId - The Id of a Customer. (required)

paymentInstrumentId - The Id of a payment instrument. (required)

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

patchCustomersPaymentInstrument

public PatchCustomerPaymentInstrumentRequest patchCustomersPaymentInstrument(String customerId,
                                                                             String paymentInstrumentId,
                                                                             PatchCustomerPaymentInstrumentRequest patchCustomerPaymentInstrumentRequest,
                                                                             String profileId,
                                                                             String ifMatch)
                                                                      throws ApiException

Update a Customer Payment Instrument | | | | | --- | --- | --- | |**Customer Payment Instrument**<br>A Customer Payment Instrument represents tokenized customer payment information such as expiration date, billing address & card type.<br>A [Customer](#token-management_customer_create-a-customer) can have [one or more Payment Instruments](#token-management_customer-payment-instrument_retrieve-a-customer-payment-instrument), with one allocated as the Customers default for use in payments.<br>A Payment Instrument token does not store the card number. A Payment Instrument is associated with an [Instrument Identifier](#token-management_instrument-identifier_create-an-instrument-identifier) that represents either a payment card number, or in the case of an ACH bank account, the routing and account number.<br>|&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;|**Updating a Customers Payment Instrument**<br>Your system can use this API to update an existing Payment Instrument for a Customer, including selecting a [default Payment Instrument](#token-management_customer-payment-instrument_update-a-customer-payment-instrument_samplerequests-dropdown_make-customer-payment-instrument-the-default_liveconsole-tab-request-body) for use in payments.

Parameters:

customerId - The Id of a Customer. (required)

paymentInstrumentId - The Id of a payment instrument. (required)

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

PatchCustomerPaymentInstrumentRequest

Throws:

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

patchCustomersPaymentInstrumentWithHttpInfo

public ApiResponse<PatchCustomerPaymentInstrumentRequest> patchCustomersPaymentInstrumentWithHttpInfo(String customerId,
                                                                                                      String paymentInstrumentId,
                                                                                                      PatchCustomerPaymentInstrumentRequest patchCustomerPaymentInstrumentRequest,
                                                                                                      String profileId,
                                                                                                      String ifMatch)
                                                                                               throws ApiException

Update a Customer Payment Instrument | | | | | --- | --- | --- | |**Customer Payment Instrument**<br>A Customer Payment Instrument represents tokenized customer payment information such as expiration date, billing address & card type.<br>A [Customer](#token-management_customer_create-a-customer) can have [one or more Payment Instruments](#token-management_customer-payment-instrument_retrieve-a-customer-payment-instrument), with one allocated as the Customers default for use in payments.<br>A Payment Instrument token does not store the card number. A Payment Instrument is associated with an [Instrument Identifier](#token-management_instrument-identifier_create-an-instrument-identifier) that represents either a payment card number, or in the case of an ACH bank account, the routing and account number.<br>|&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;|**Updating a Customers Payment Instrument**<br>Your system can use this API to update an existing Payment Instrument for a Customer, including selecting a [default Payment Instrument](#token-management_customer-payment-instrument_update-a-customer-payment-instrument_samplerequests-dropdown_make-customer-payment-instrument-the-default_liveconsole-tab-request-body) for use in payments.

Parameters:

customerId - The Id of a Customer. (required)

paymentInstrumentId - The Id of a payment instrument. (required)

patchCustomerPaymentInstrumentRequest - (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<PatchCustomerPaymentInstrumentRequest>

Throws:

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

patchCustomersPaymentInstrumentAsync

public okhttp3.Call patchCustomersPaymentInstrumentAsync(String customerId,
                                                         String paymentInstrumentId,
                                                         PatchCustomerPaymentInstrumentRequest patchCustomerPaymentInstrumentRequest,
                                                         String profileId,
                                                         String ifMatch,
                                                         ApiCallback<PatchCustomerPaymentInstrumentRequest> callback)
                                                  throws ApiException

Update a Customer Payment Instrument (asynchronously) | | | | | --- | --- | --- | |**Customer Payment Instrument**<br>A Customer Payment Instrument represents tokenized customer payment information such as expiration date, billing address & card type.<br>A [Customer](#token-management_customer_create-a-customer) can have [one or more Payment Instruments](#token-management_customer-payment-instrument_retrieve-a-customer-payment-instrument), with one allocated as the Customers default for use in payments.<br>A Payment Instrument token does not store the card number. A Payment Instrument is associated with an [Instrument Identifier](#token-management_instrument-identifier_create-an-instrument-identifier) that represents either a payment card number, or in the case of an ACH bank account, the routing and account number.<br>|&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;|**Updating a Customers Payment Instrument**<br>Your system can use this API to update an existing Payment Instrument for a Customer, including selecting a [default Payment Instrument](#token-management_customer-payment-instrument_update-a-customer-payment-instrument_samplerequests-dropdown_make-customer-payment-instrument-the-default_liveconsole-tab-request-body) for use in payments.

Parameters:

customerId - The Id of a Customer. (required)

paymentInstrumentId - The Id of a payment instrument. (required)

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

postCustomerPaymentInstrumentCall

public okhttp3.Call postCustomerPaymentInstrumentCall(String customerId,
                                                      PostCustomerPaymentInstrumentRequest postCustomerPaymentInstrumentRequest,
                                                      String profileId,
                                                      ProgressResponseBody.ProgressListener progressListener,
                                                      ProgressRequestBody.ProgressRequestListener progressRequestListener)
                                               throws ApiException

Build call for postCustomerPaymentInstrument

Parameters:

customerId - The Id of a Customer. (required)

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

postCustomerPaymentInstrument

public PostCustomerPaymentInstrumentRequest postCustomerPaymentInstrument(String customerId,
                                                                          PostCustomerPaymentInstrumentRequest postCustomerPaymentInstrumentRequest,
                                                                          String profileId)
                                                                   throws ApiException

Create a Customer Payment Instrument | | | | | --- | --- | --- | |**Customer Payment Instrument**<br>A Customer Payment Instrument represents tokenized customer payment information such as expiration date, billing address & card type.<br>A [Customer](#token-management_customer_create-a-customer) can have [one or more Payment Instruments](#token-management_customer-payment-instrument_retrieve-a-customer-payment-instrument), with one allocated as the Customers default for use in payments.<br>A Payment Instrument token does not store the card number. A Payment Instrument is associated with an [Instrument Identifier](#token-management_instrument-identifier_create-an-instrument-identifier) that represents either a payment card number, or in the case of an ACH bank account, the routing and account number.<br><br>**Creating a Customer Payment Instrument**<br>It is recommended you [create a Customer Payment Instrument via a Payment Authorization](#payments_payments_process-a-payment_samplerequests-dropdown_authorization-with-token-create_authorization-create-default-payment-instrument-shipping-address-for-existing-customer_liveconsole-tab-request-body), this can be for a zero amount.<br>In Europe: You should perform Payer Authentication alongside the Authorization.|&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;|**Payment Network Tokens**<br>Network tokens perform better than regular card numbers and they are not necessarily invalidated when a cardholder loses their card, or it expires.<br>A Payment Network Token will be automatically created and used in future payments if you are enabled for the service.<br>A Payment Network Token can also be [provisioned for an existing Instrument Identifier](#token-management_instrument-identifier_enroll-an-instrument-identifier-for-payment-network-token).<br>For more information about Payment Network Tokens see the Developer Guide.<br><br>**Payments with Customers Payment Instrument**<br>To perform a payment with a particular Payment Instrument or Shipping Address specify the [Payment Instrument in the payment request](#payments_payments_process-a-payment_samplerequests-dropdown_authorization-using-tokens_authorization-with-customer-payment-instrument-and-shipping-address-token-id_liveconsole-tab-request-body).

Parameters:

customerId - The Id of a Customer. (required)

postCustomerPaymentInstrumentRequest - (required)

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

Returns:

PostCustomerPaymentInstrumentRequest

Throws:

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

postCustomerPaymentInstrumentWithHttpInfo

public ApiResponse<PostCustomerPaymentInstrumentRequest> postCustomerPaymentInstrumentWithHttpInfo(String customerId,
                                                                                                   PostCustomerPaymentInstrumentRequest postCustomerPaymentInstrumentRequest,
                                                                                                   String profileId)
                                                                                            throws ApiException

Create a Customer Payment Instrument | | | | | --- | --- | --- | |**Customer Payment Instrument**<br>A Customer Payment Instrument represents tokenized customer payment information such as expiration date, billing address & card type.<br>A [Customer](#token-management_customer_create-a-customer) can have [one or more Payment Instruments](#token-management_customer-payment-instrument_retrieve-a-customer-payment-instrument), with one allocated as the Customers default for use in payments.<br>A Payment Instrument token does not store the card number. A Payment Instrument is associated with an [Instrument Identifier](#token-management_instrument-identifier_create-an-instrument-identifier) that represents either a payment card number, or in the case of an ACH bank account, the routing and account number.<br><br>**Creating a Customer Payment Instrument**<br>It is recommended you [create a Customer Payment Instrument via a Payment Authorization](#payments_payments_process-a-payment_samplerequests-dropdown_authorization-with-token-create_authorization-create-default-payment-instrument-shipping-address-for-existing-customer_liveconsole-tab-request-body), this can be for a zero amount.<br>In Europe: You should perform Payer Authentication alongside the Authorization.|&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;|**Payment Network Tokens**<br>Network tokens perform better than regular card numbers and they are not necessarily invalidated when a cardholder loses their card, or it expires.<br>A Payment Network Token will be automatically created and used in future payments if you are enabled for the service.<br>A Payment Network Token can also be [provisioned for an existing Instrument Identifier](#token-management_instrument-identifier_enroll-an-instrument-identifier-for-payment-network-token).<br>For more information about Payment Network Tokens see the Developer Guide.<br><br>**Payments with Customers Payment Instrument**<br>To perform a payment with a particular Payment Instrument or Shipping Address specify the [Payment Instrument in the payment request](#payments_payments_process-a-payment_samplerequests-dropdown_authorization-using-tokens_authorization-with-customer-payment-instrument-and-shipping-address-token-id_liveconsole-tab-request-body).

Parameters:

customerId - The Id of a Customer. (required)

postCustomerPaymentInstrumentRequest - (required)

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

Returns:

ApiResponse<PostCustomerPaymentInstrumentRequest>

Throws:

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

postCustomerPaymentInstrumentAsync

public okhttp3.Call postCustomerPaymentInstrumentAsync(String customerId,
                                                       PostCustomerPaymentInstrumentRequest postCustomerPaymentInstrumentRequest,
                                                       String profileId,
                                                       ApiCallback<PostCustomerPaymentInstrumentRequest> callback)
                                                throws ApiException

Create a Customer Payment Instrument (asynchronously) | | | | | --- | --- | --- | |**Customer Payment Instrument**<br>A Customer Payment Instrument represents tokenized customer payment information such as expiration date, billing address & card type.<br>A [Customer](#token-management_customer_create-a-customer) can have [one or more Payment Instruments](#token-management_customer-payment-instrument_retrieve-a-customer-payment-instrument), with one allocated as the Customers default for use in payments.<br>A Payment Instrument token does not store the card number. A Payment Instrument is associated with an [Instrument Identifier](#token-management_instrument-identifier_create-an-instrument-identifier) that represents either a payment card number, or in the case of an ACH bank account, the routing and account number.<br><br>**Creating a Customer Payment Instrument**<br>It is recommended you [create a Customer Payment Instrument via a Payment Authorization](#payments_payments_process-a-payment_samplerequests-dropdown_authorization-with-token-create_authorization-create-default-payment-instrument-shipping-address-for-existing-customer_liveconsole-tab-request-body), this can be for a zero amount.<br>In Europe: You should perform Payer Authentication alongside the Authorization.|&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;|**Payment Network Tokens**<br>Network tokens perform better than regular card numbers and they are not necessarily invalidated when a cardholder loses their card, or it expires.<br>A Payment Network Token will be automatically created and used in future payments if you are enabled for the service.<br>A Payment Network Token can also be [provisioned for an existing Instrument Identifier](#token-management_instrument-identifier_enroll-an-instrument-identifier-for-payment-network-token).<br>For more information about Payment Network Tokens see the Developer Guide.<br><br>**Payments with Customers Payment Instrument**<br>To perform a payment with a particular Payment Instrument or Shipping Address specify the [Payment Instrument in the payment request](#payments_payments_process-a-payment_samplerequests-dropdown_authorization-using-tokens_authorization-with-customer-payment-instrument-and-shipping-address-token-id_liveconsole-tab-request-body).

Parameters:

customerId - The Id of a Customer. (required)

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