public class CustomerPaymentInstrumentApi extends Object
| Constructor and Description |
|---|
CustomerPaymentInstrumentApi() |
CustomerPaymentInstrumentApi(ApiClient apiClient) |
| 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) |
public CustomerPaymentInstrumentApi()
public CustomerPaymentInstrumentApi(ApiClient apiClient)
public ApiClient getApiClient()
public void setApiClient(ApiClient apiClient)
public okhttp3.Call deleteCustomerPaymentInstrumentCall(String customerId, String paymentInstrumentId, String profileId, ProgressResponseBody.ProgressListener progressListener, ProgressRequestBody.ProgressRequestListener progressRequestListener) throws ApiException
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 listenerprogressRequestListener - Progress request listenerApiException - If fail to serialize the request body objectpublic void deleteCustomerPaymentInstrument(String customerId, String paymentInstrumentId, String profileId) throws ApiException
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)ApiException - If fail to call the API, e.g. server error or cannot deserialize the response bodypublic ApiResponse<Void> deleteCustomerPaymentInstrumentWithHttpInfo(String customerId, String paymentInstrumentId, String profileId) throws ApiException
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)ApiException - If fail to call the API, e.g. server error or cannot deserialize the response bodypublic okhttp3.Call deleteCustomerPaymentInstrumentAsync(String customerId, String paymentInstrumentId, String profileId, ApiCallback<Void> callback) throws ApiException
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 finishesApiException - If fail to process the API call, e.g. serializing the request body objectpublic okhttp3.Call getCustomerPaymentInstrumentCall(String customerId, String paymentInstrumentId, String profileId, ProgressResponseBody.ProgressListener progressListener, ProgressRequestBody.ProgressRequestListener progressRequestListener) throws ApiException
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 listenerprogressRequestListener - Progress request listenerApiException - If fail to serialize the request body objectpublic PostCustomerPaymentInstrumentRequest getCustomerPaymentInstrument(String customerId, String paymentInstrumentId, String profileId) throws ApiException
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)ApiException - If fail to call the API, e.g. server error or cannot deserialize the response bodypublic ApiResponse<PostCustomerPaymentInstrumentRequest> getCustomerPaymentInstrumentWithHttpInfo(String customerId, String paymentInstrumentId, String profileId) throws ApiException
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)ApiException - If fail to call the API, e.g. server error or cannot deserialize the response bodypublic okhttp3.Call getCustomerPaymentInstrumentAsync(String customerId, String paymentInstrumentId, String profileId, ApiCallback<PostCustomerPaymentInstrumentRequest> callback) throws ApiException
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 finishesApiException - If fail to process the API call, e.g. serializing the request body objectpublic okhttp3.Call getCustomerPaymentInstrumentsListCall(String customerId, String profileId, Long offset, Long limit, ProgressResponseBody.ProgressListener progressListener, ProgressRequestBody.ProgressRequestListener progressRequestListener) throws ApiException
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 listenerprogressRequestListener - Progress request listenerApiException - If fail to serialize the request body objectpublic PaymentInstrumentList getCustomerPaymentInstrumentsList(String customerId, String profileId, Long offset, Long limit) throws ApiException
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)ApiException - If fail to call the API, e.g. server error or cannot deserialize the response bodypublic ApiResponse<PaymentInstrumentList> getCustomerPaymentInstrumentsListWithHttpInfo(String customerId, String profileId, Long offset, Long limit) throws ApiException
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)ApiException - If fail to call the API, e.g. server error or cannot deserialize the response bodypublic okhttp3.Call getCustomerPaymentInstrumentsListAsync(String customerId, String profileId, Long offset, Long limit, ApiCallback<PaymentInstrumentList> callback) throws ApiException
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 finishesApiException - If fail to process the API call, e.g. serializing the request body objectpublic okhttp3.Call patchCustomersPaymentInstrumentCall(String customerId, String paymentInstrumentId, PatchCustomerPaymentInstrumentRequest patchCustomerPaymentInstrumentRequest, String profileId, String ifMatch, ProgressResponseBody.ProgressListener progressListener, ProgressRequestBody.ProgressRequestListener progressRequestListener) throws ApiException
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 listenerprogressRequestListener - Progress request listenerApiException - If fail to serialize the request body objectpublic PatchCustomerPaymentInstrumentRequest patchCustomersPaymentInstrument(String customerId, String paymentInstrumentId, PatchCustomerPaymentInstrumentRequest patchCustomerPaymentInstrumentRequest, String profileId, String ifMatch) throws ApiException
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)ApiException - If fail to call the API, e.g. server error or cannot deserialize the response bodypublic ApiResponse<PatchCustomerPaymentInstrumentRequest> patchCustomersPaymentInstrumentWithHttpInfo(String customerId, String paymentInstrumentId, PatchCustomerPaymentInstrumentRequest patchCustomerPaymentInstrumentRequest, String profileId, String ifMatch) throws ApiException
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)ApiException - If fail to call the API, e.g. server error or cannot deserialize the response bodypublic okhttp3.Call patchCustomersPaymentInstrumentAsync(String customerId, String paymentInstrumentId, PatchCustomerPaymentInstrumentRequest patchCustomerPaymentInstrumentRequest, String profileId, String ifMatch, ApiCallback<PatchCustomerPaymentInstrumentRequest> callback) throws ApiException
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 finishesApiException - If fail to process the API call, e.g. serializing the request body objectpublic okhttp3.Call postCustomerPaymentInstrumentCall(String customerId, PostCustomerPaymentInstrumentRequest postCustomerPaymentInstrumentRequest, String profileId, ProgressResponseBody.ProgressListener progressListener, ProgressRequestBody.ProgressRequestListener progressRequestListener) throws ApiException
customerId - The Id of a Customer. (required)postCustomerPaymentInstrumentRequest - (required)profileId - The Id of a profile containing user specific TMS configuration. (optional)progressListener - Progress listenerprogressRequestListener - Progress request listenerApiException - If fail to serialize the request body objectpublic PostCustomerPaymentInstrumentRequest postCustomerPaymentInstrument(String customerId, PostCustomerPaymentInstrumentRequest postCustomerPaymentInstrumentRequest, String profileId) throws ApiException
customerId - The Id of a Customer. (required)postCustomerPaymentInstrumentRequest - (required)profileId - The Id of a profile containing user specific TMS configuration. (optional)ApiException - If fail to call the API, e.g. server error or cannot deserialize the response bodypublic ApiResponse<PostCustomerPaymentInstrumentRequest> postCustomerPaymentInstrumentWithHttpInfo(String customerId, PostCustomerPaymentInstrumentRequest postCustomerPaymentInstrumentRequest, String profileId) throws ApiException
customerId - The Id of a Customer. (required)postCustomerPaymentInstrumentRequest - (required)profileId - The Id of a profile containing user specific TMS configuration. (optional)ApiException - If fail to call the API, e.g. server error or cannot deserialize the response bodypublic okhttp3.Call postCustomerPaymentInstrumentAsync(String customerId, PostCustomerPaymentInstrumentRequest postCustomerPaymentInstrumentRequest, String profileId, ApiCallback<PostCustomerPaymentInstrumentRequest> callback) throws ApiException
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 finishesApiException - If fail to process the API call, e.g. serializing the request body objectCopyright © 2025. All rights reserved.