Api

Class TokenizeApi

java.lang.Object

Api.TokenizeApi

public class TokenizeApi
extends Object

Constructor Summary

Constructors

Constructor	Description
TokenizeApi()
TokenizeApi(ApiClient apiClient)

Method Summary

Modifier and Type	Method	Description
ApiClient	getApiClient()
void	setApiClient(ApiClient apiClient)
InlineResponse200	tokenize(PostTokenizeRequest postTokenizeRequest, String profileId)	Tokenize | | | | | --- | --- | --- | |The **Tokenize API** endpoint facilitates the creation of various TMS tokens such as Customers, Payment Instruments, Shipping Addresses, and Instrument Identifiers in a single operation.
okhttp3.Call	tokenizeAsync(PostTokenizeRequest postTokenizeRequest, String profileId, ApiCallback<InlineResponse200> callback)	Tokenize (asynchronously) | | | | | --- | --- | --- | |The **Tokenize API** endpoint facilitates the creation of various TMS tokens such as Customers, Payment Instruments, Shipping Addresses, and Instrument Identifiers in a single operation.
okhttp3.Call	tokenizeCall(PostTokenizeRequest postTokenizeRequest, String profileId, ProgressResponseBody.ProgressListener progressListener, ProgressRequestBody.ProgressRequestListener progressRequestListener)	Build call for tokenize
ApiResponse<InlineResponse200>	tokenizeWithHttpInfo(PostTokenizeRequest postTokenizeRequest, String profileId)	Tokenize | | | | | --- | --- | --- | |The **Tokenize API** endpoint facilitates the creation of various TMS tokens such as Customers, Payment Instruments, Shipping Addresses, and Instrument Identifiers in a single operation.

Methods inherited from class java.lang.Object

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

Constructor Detail

TokenizeApi

public TokenizeApi()

TokenizeApi

public TokenizeApi(ApiClient apiClient)

Method Detail

getApiClient

public ApiClient getApiClient()

setApiClient

public void setApiClient(ApiClient apiClient)

tokenizeCall

public okhttp3.Call tokenizeCall(PostTokenizeRequest postTokenizeRequest,
                                 String profileId,
                                 ProgressResponseBody.ProgressListener progressListener,
                                 ProgressRequestBody.ProgressRequestListener progressRequestListener)
                          throws ApiException,
                                 com.cybersource.authsdk.core.ConfigException

Build call for tokenize

Parameters:

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

com.cybersource.authsdk.core.ConfigException - If creation of merchant configuration fails in ApiClient

tokenize

public InlineResponse200 tokenize(PostTokenizeRequest postTokenizeRequest,
                                  String profileId)
                           throws ApiException,
                                  com.cybersource.authsdk.core.ConfigException

Tokenize | | | | | --- | --- | --- | |The **Tokenize API** endpoint facilitates the creation of various TMS tokens such as Customers, Payment Instruments, Shipping Addresses, and Instrument Identifiers in a single operation. The request includes a processingInformation object, which specifies **\"TOKEN_CREATE\"** and the types of tokens to be created. The **tokenInformation** section of the request includes detailed information relevant to each token type. This includes attributes for Customers, Payment Instruments, Shipping Addresses, Instrument Identifiers and Transient Token data. The payload is flexible, allowing for different combinations of tokens to be created in a single request.|&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;|The **API response** includes a responses array, which details the outcome of the tokenization process for each requested resource type, such as Customer, Payment Instrument, Shipping Address, and Instrument Identifier. Each entry in this array provides an HTTP status code such as **201/200 for successful creations**, and a unique identifier for the newly created token.<br>In cases where token creation encounters issues, the response includes a **non-2XX** status code and an errors array for the affected resource. Each error object in the array details the **error type and a descriptive message** providing insight into why a particular token creation was not attempted or failed.

Parameters:

postTokenizeRequest - (required)

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

Returns:

InlineResponse200

Throws:

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

com.cybersource.authsdk.core.ConfigException - If creation of merchant configuration fails in ApiClient

tokenizeWithHttpInfo

public ApiResponse<InlineResponse200> tokenizeWithHttpInfo(PostTokenizeRequest postTokenizeRequest,
                                                           String profileId)
                                                    throws ApiException,
                                                           com.cybersource.authsdk.core.ConfigException

Tokenize | | | | | --- | --- | --- | |The **Tokenize API** endpoint facilitates the creation of various TMS tokens such as Customers, Payment Instruments, Shipping Addresses, and Instrument Identifiers in a single operation. The request includes a processingInformation object, which specifies **\"TOKEN_CREATE\"** and the types of tokens to be created. The **tokenInformation** section of the request includes detailed information relevant to each token type. This includes attributes for Customers, Payment Instruments, Shipping Addresses, Instrument Identifiers and Transient Token data. The payload is flexible, allowing for different combinations of tokens to be created in a single request.|&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;|The **API response** includes a responses array, which details the outcome of the tokenization process for each requested resource type, such as Customer, Payment Instrument, Shipping Address, and Instrument Identifier. Each entry in this array provides an HTTP status code such as **201/200 for successful creations**, and a unique identifier for the newly created token.<br>In cases where token creation encounters issues, the response includes a **non-2XX** status code and an errors array for the affected resource. Each error object in the array details the **error type and a descriptive message** providing insight into why a particular token creation was not attempted or failed.

Parameters:

postTokenizeRequest - (required)

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

Returns:

ApiResponse<InlineResponse200>

Throws:

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

com.cybersource.authsdk.core.ConfigException - If creation of merchant configuration fails in ApiClient

tokenizeAsync

public okhttp3.Call tokenizeAsync(PostTokenizeRequest postTokenizeRequest,
                                  String profileId,
                                  ApiCallback<InlineResponse200> callback)
                           throws ApiException,
                                  com.cybersource.authsdk.core.ConfigException

Tokenize (asynchronously) | | | | | --- | --- | --- | |The **Tokenize API** endpoint facilitates the creation of various TMS tokens such as Customers, Payment Instruments, Shipping Addresses, and Instrument Identifiers in a single operation. The request includes a processingInformation object, which specifies **\"TOKEN_CREATE\"** and the types of tokens to be created. The **tokenInformation** section of the request includes detailed information relevant to each token type. This includes attributes for Customers, Payment Instruments, Shipping Addresses, Instrument Identifiers and Transient Token data. The payload is flexible, allowing for different combinations of tokens to be created in a single request.|&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;|The **API response** includes a responses array, which details the outcome of the tokenization process for each requested resource type, such as Customer, Payment Instrument, Shipping Address, and Instrument Identifier. Each entry in this array provides an HTTP status code such as **201/200 for successful creations**, and a unique identifier for the newly created token.<br>In cases where token creation encounters issues, the response includes a **non-2XX** status code and an errors array for the affected resource. Each error object in the array details the **error type and a descriptive message** providing insight into why a particular token creation was not attempted or failed.

Parameters:

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

com.cybersource.authsdk.core.ConfigException - If creation of merchant configuration fails in ApiClient