Api

Class TokenApi

java.lang.Object

Api.TokenApi

public class TokenApi
extends Object

Constructor Summary

Constructors

Constructor and Description
TokenApi()
TokenApi(ApiClient apiClient)

Method Summary

Modifier and Type	Method and Description
ApiClient	getApiClient()
InlineResponse2002	getCardArtAsset(String instrumentIdentifierId, String tokenProvider, String assetType) Retrieve Card Art Retrieves Card Art for a specific Instrument Identifier.
okhttp3.Call	getCardArtAssetAsync(String instrumentIdentifierId, String tokenProvider, String assetType, ApiCallback<InlineResponse2002> callback) Retrieve Card Art (asynchronously) Retrieves Card Art for a specific Instrument Identifier.
okhttp3.Call	getCardArtAssetCall(String instrumentIdentifierId, String tokenProvider, String assetType, ProgressResponseBody.ProgressListener progressListener, ProgressRequestBody.ProgressRequestListener progressRequestListener) Build call for getCardArtAsset
ApiResponse<InlineResponse2002>	getCardArtAssetWithHttpInfo(String instrumentIdentifierId, String tokenProvider, String assetType) Retrieve Card Art Retrieves Card Art for a specific Instrument Identifier.
String	postTokenPaymentCredentials(String tokenId, PostPaymentCredentialsRequest1 postPaymentCredentialsRequest, String profileId) Generate Payment Credentials v2 **Note**: This resource will be replace by [payment credentials version 3](#/paths/~1tms~1v3~1tokens~1{tokenId}~1payment-credentials/post).
okhttp3.Call	postTokenPaymentCredentialsAsync(String tokenId, PostPaymentCredentialsRequest1 postPaymentCredentialsRequest, String profileId, ApiCallback<String> callback) Generate Payment Credentials v2 (asynchronously) **Note**: This resource will be replace by [payment credentials version 3](#/paths/~1tms~1v3~1tokens~1{tokenId}~1payment-credentials/post).
okhttp3.Call	postTokenPaymentCredentialsCall(String tokenId, PostPaymentCredentialsRequest1 postPaymentCredentialsRequest, String profileId, ProgressResponseBody.ProgressListener progressListener, ProgressRequestBody.ProgressRequestListener progressRequestListener) Build call for postTokenPaymentCredentials
InlineResponse2011	postTokenPaymentCredentialsV3(String tokenId, PostPaymentCredentialsRequest postPaymentCredentialsRequest, String profileId) Generate Payment Credentials Latest Version v3 **Payment Credentials**<br>Contains payment information such as the network token, generated TAVV cryptogram for Visa & MasterCard, dynamic CVV for Amex, or DTVV cryptogram for VISA.
okhttp3.Call	postTokenPaymentCredentialsV3Async(String tokenId, PostPaymentCredentialsRequest postPaymentCredentialsRequest, String profileId, ApiCallback<InlineResponse2011> callback) Generate Payment Credentials Latest Version v3 (asynchronously) **Payment Credentials**<br>Contains payment information such as the network token, generated TAVV cryptogram for Visa & MasterCard, dynamic CVV for Amex, or DTVV cryptogram for VISA.
okhttp3.Call	postTokenPaymentCredentialsV3Call(String tokenId, PostPaymentCredentialsRequest postPaymentCredentialsRequest, String profileId, ProgressResponseBody.ProgressListener progressListener, ProgressRequestBody.ProgressRequestListener progressRequestListener) Build call for postTokenPaymentCredentialsV3
ApiResponse<InlineResponse2011>	postTokenPaymentCredentialsV3WithHttpInfo(String tokenId, PostPaymentCredentialsRequest postPaymentCredentialsRequest, String profileId) Generate Payment Credentials Latest Version v3 **Payment Credentials**<br>Contains payment information such as the network token, generated TAVV cryptogram for Visa & MasterCard, dynamic CVV for Amex, or DTVV cryptogram for VISA.
ApiResponse<String>	postTokenPaymentCredentialsWithHttpInfo(String tokenId, PostPaymentCredentialsRequest1 postPaymentCredentialsRequest, String profileId) Generate Payment Credentials v2 **Note**: This resource will be replace by [payment credentials version 3](#/paths/~1tms~1v3~1tokens~1{tokenId}~1payment-credentials/post).
void	setApiClient(ApiClient apiClient)

Methods inherited from class java.lang.Object

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

Constructor Detail

TokenApi

public TokenApi()

TokenApi

public TokenApi(ApiClient apiClient)

Method Detail

getApiClient

public ApiClient getApiClient()

setApiClient

public void setApiClient(ApiClient apiClient)

getCardArtAssetCall

public okhttp3.Call getCardArtAssetCall(String instrumentIdentifierId,
                                        String tokenProvider,
                                        String assetType,
                                        ProgressResponseBody.ProgressListener progressListener,
                                        ProgressRequestBody.ProgressRequestListener progressRequestListener)
                                 throws ApiException,
                                        com.cybersource.authsdk.core.ConfigException

Build call for getCardArtAsset

Parameters:

instrumentIdentifierId - The Id of an Instrument Identifier. (required)

tokenProvider - The token provider. (required)

assetType - The type of asset. (required)

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

getCardArtAsset

public InlineResponse2002 getCardArtAsset(String instrumentIdentifierId,
                                          String tokenProvider,
                                          String assetType)
                                   throws ApiException,
                                          com.cybersource.authsdk.core.ConfigException

Retrieve Card Art Retrieves Card Art for a specific Instrument Identifier. The Card Art is a visual representation of the cardholder's payment card. Card Art is only available if a Network Token is successfully provisioned.

Parameters:

instrumentIdentifierId - The Id of an Instrument Identifier. (required)

tokenProvider - The token provider. (required)

assetType - The type of asset. (required)

Returns:

InlineResponse2002

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

getCardArtAssetWithHttpInfo

public ApiResponse<InlineResponse2002> getCardArtAssetWithHttpInfo(String instrumentIdentifierId,
                                                                   String tokenProvider,
                                                                   String assetType)
                                                            throws ApiException,
                                                                   com.cybersource.authsdk.core.ConfigException

Retrieve Card Art Retrieves Card Art for a specific Instrument Identifier. The Card Art is a visual representation of the cardholder's payment card. Card Art is only available if a Network Token is successfully provisioned.

Parameters:

instrumentIdentifierId - The Id of an Instrument Identifier. (required)

tokenProvider - The token provider. (required)

assetType - The type of asset. (required)

Returns:

ApiResponse<InlineResponse2002>

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

getCardArtAssetAsync

public okhttp3.Call getCardArtAssetAsync(String instrumentIdentifierId,
                                         String tokenProvider,
                                         String assetType,
                                         ApiCallback<InlineResponse2002> callback)
                                  throws ApiException,
                                         com.cybersource.authsdk.core.ConfigException

Retrieve Card Art (asynchronously) Retrieves Card Art for a specific Instrument Identifier. The Card Art is a visual representation of the cardholder's payment card. Card Art is only available if a Network Token is successfully provisioned.

Parameters:

instrumentIdentifierId - The Id of an Instrument Identifier. (required)

tokenProvider - The token provider. (required)

assetType - The type of asset. (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

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

postTokenPaymentCredentialsCall

public okhttp3.Call postTokenPaymentCredentialsCall(String tokenId,
                                                    PostPaymentCredentialsRequest1 postPaymentCredentialsRequest,
                                                    String profileId,
                                                    ProgressResponseBody.ProgressListener progressListener,
                                                    ProgressRequestBody.ProgressRequestListener progressRequestListener)
                                             throws ApiException,
                                                    com.cybersource.authsdk.core.ConfigException

Build call for postTokenPaymentCredentials

Parameters:

tokenId - The Id of a token representing a Customer, Payment Instrument or Instrument Identifier. (required)

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

postTokenPaymentCredentials

public String postTokenPaymentCredentials(String tokenId,
                                          PostPaymentCredentialsRequest1 postPaymentCredentialsRequest,
                                          String profileId)
                                   throws ApiException,
                                          com.cybersource.authsdk.core.ConfigException

Generate Payment Credentials v2 **Note**: This resource will be replace by [payment credentials version 3](#/paths/~1tms~1v3~1tokens~1{tokenId}~1payment-credentials/post). The SDK will remain available for now; however, it will no longer be documented or maintain in the Developer Centre.<br> **Token**<br>A Token can represent your tokenized Customer, Payment Instrument, Instrument Identifier or Tokenized Card information.<br> **Payment Credentials**<br>Contains payment information such as the network token, generated cryptogram for Visa & MasterCard or dynamic CVV for Amex in a JSON Web Encryption (JWE) response.<br>Your system can use this API to retrieve the Payment Credentials for an existing Customer, Payment Instrument, Instrument Identifier or Tokenized Card.<br>Optionally, **authenticated identities** information from Passkey authentication can be provided to potentially achieve liability shift, which may result in the return of an e-commerce indicator of 5 if successful.

Parameters:

tokenId - The Id of a token representing a Customer, Payment Instrument or Instrument Identifier. (required)

postPaymentCredentialsRequest - (required)

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

Returns:

String

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

postTokenPaymentCredentialsWithHttpInfo

public ApiResponse<String> postTokenPaymentCredentialsWithHttpInfo(String tokenId,
                                                                   PostPaymentCredentialsRequest1 postPaymentCredentialsRequest,
                                                                   String profileId)
                                                            throws ApiException,
                                                                   com.cybersource.authsdk.core.ConfigException

Generate Payment Credentials v2 **Note**: This resource will be replace by [payment credentials version 3](#/paths/~1tms~1v3~1tokens~1{tokenId}~1payment-credentials/post). The SDK will remain available for now; however, it will no longer be documented or maintain in the Developer Centre.<br> **Token**<br>A Token can represent your tokenized Customer, Payment Instrument, Instrument Identifier or Tokenized Card information.<br> **Payment Credentials**<br>Contains payment information such as the network token, generated cryptogram for Visa & MasterCard or dynamic CVV for Amex in a JSON Web Encryption (JWE) response.<br>Your system can use this API to retrieve the Payment Credentials for an existing Customer, Payment Instrument, Instrument Identifier or Tokenized Card.<br>Optionally, **authenticated identities** information from Passkey authentication can be provided to potentially achieve liability shift, which may result in the return of an e-commerce indicator of 5 if successful.

Parameters:

tokenId - The Id of a token representing a Customer, Payment Instrument or Instrument Identifier. (required)

postPaymentCredentialsRequest - (required)

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

Returns:

ApiResponse<String>

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

postTokenPaymentCredentialsAsync

public okhttp3.Call postTokenPaymentCredentialsAsync(String tokenId,
                                                     PostPaymentCredentialsRequest1 postPaymentCredentialsRequest,
                                                     String profileId,
                                                     ApiCallback<String> callback)
                                              throws ApiException,
                                                     com.cybersource.authsdk.core.ConfigException

Generate Payment Credentials v2 (asynchronously) **Note**: This resource will be replace by [payment credentials version 3](#/paths/~1tms~1v3~1tokens~1{tokenId}~1payment-credentials/post). The SDK will remain available for now; however, it will no longer be documented or maintain in the Developer Centre.<br> **Token**<br>A Token can represent your tokenized Customer, Payment Instrument, Instrument Identifier or Tokenized Card information.<br> **Payment Credentials**<br>Contains payment information such as the network token, generated cryptogram for Visa & MasterCard or dynamic CVV for Amex in a JSON Web Encryption (JWE) response.<br>Your system can use this API to retrieve the Payment Credentials for an existing Customer, Payment Instrument, Instrument Identifier or Tokenized Card.<br>Optionally, **authenticated identities** information from Passkey authentication can be provided to potentially achieve liability shift, which may result in the return of an e-commerce indicator of 5 if successful.

Parameters:

tokenId - The Id of a token representing a Customer, Payment Instrument or Instrument Identifier. (required)

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

postTokenPaymentCredentialsV3Call

public okhttp3.Call postTokenPaymentCredentialsV3Call(String tokenId,
                                                      PostPaymentCredentialsRequest postPaymentCredentialsRequest,
                                                      String profileId,
                                                      ProgressResponseBody.ProgressListener progressListener,
                                                      ProgressRequestBody.ProgressRequestListener progressRequestListener)
                                               throws ApiException,
                                                      com.cybersource.authsdk.core.ConfigException

Build call for postTokenPaymentCredentialsV3

Parameters:

tokenId - The Id of a token representing a Customer, Payment Instrument or Instrument Identifier. (required)

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

postTokenPaymentCredentialsV3

public InlineResponse2011 postTokenPaymentCredentialsV3(String tokenId,
                                                        PostPaymentCredentialsRequest postPaymentCredentialsRequest,
                                                        String profileId)
                                                 throws ApiException,
                                                        com.cybersource.authsdk.core.ConfigException

Generate Payment Credentials Latest Version v3 **Payment Credentials**<br>Contains payment information such as the network token, generated TAVV cryptogram for Visa & MasterCard, dynamic CVV for Amex, or DTVV cryptogram for VISA. This latest version (v3) returns the Primary Account Number details, if the network token is not present. The response is provided in JSON Web Encryption (JWE) format. <br>Your system can use this API to retrieve the Payment Credentials for an existing Customer, Payment Instrument, Instrument Identifier or Tokenized Card.<br>Optionally, **authenticated identities** information from Passkey authentication can be provided to potentially achieve liability shift, which may result in the return of an e-commerce indicator of 5 if successful.

Parameters:

tokenId - The Id of a token representing a Customer, Payment Instrument or Instrument Identifier. (required)

postPaymentCredentialsRequest - (required)

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

Returns:

InlineResponse2011

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

postTokenPaymentCredentialsV3WithHttpInfo

public ApiResponse<InlineResponse2011> postTokenPaymentCredentialsV3WithHttpInfo(String tokenId,
                                                                                 PostPaymentCredentialsRequest postPaymentCredentialsRequest,
                                                                                 String profileId)
                                                                          throws ApiException,
                                                                                 com.cybersource.authsdk.core.ConfigException

Generate Payment Credentials Latest Version v3 **Payment Credentials**<br>Contains payment information such as the network token, generated TAVV cryptogram for Visa & MasterCard, dynamic CVV for Amex, or DTVV cryptogram for VISA. This latest version (v3) returns the Primary Account Number details, if the network token is not present. The response is provided in JSON Web Encryption (JWE) format. <br>Your system can use this API to retrieve the Payment Credentials for an existing Customer, Payment Instrument, Instrument Identifier or Tokenized Card.<br>Optionally, **authenticated identities** information from Passkey authentication can be provided to potentially achieve liability shift, which may result in the return of an e-commerce indicator of 5 if successful.

Parameters:

tokenId - The Id of a token representing a Customer, Payment Instrument or Instrument Identifier. (required)

postPaymentCredentialsRequest - (required)

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

Returns:

ApiResponse<InlineResponse2011>

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

postTokenPaymentCredentialsV3Async

public okhttp3.Call postTokenPaymentCredentialsV3Async(String tokenId,
                                                       PostPaymentCredentialsRequest postPaymentCredentialsRequest,
                                                       String profileId,
                                                       ApiCallback<InlineResponse2011> callback)
                                                throws ApiException,
                                                       com.cybersource.authsdk.core.ConfigException

Generate Payment Credentials Latest Version v3 (asynchronously) **Payment Credentials**<br>Contains payment information such as the network token, generated TAVV cryptogram for Visa & MasterCard, dynamic CVV for Amex, or DTVV cryptogram for VISA. This latest version (v3) returns the Primary Account Number details, if the network token is not present. The response is provided in JSON Web Encryption (JWE) format. <br>Your system can use this API to retrieve the Payment Credentials for an existing Customer, Payment Instrument, Instrument Identifier or Tokenized Card.<br>Optionally, **authenticated identities** information from Passkey authentication can be provided to potentially achieve liability shift, which may result in the return of an e-commerce indicator of 5 if successful.

Parameters:

tokenId - The Id of a token representing a Customer, Payment Instrument or Instrument Identifier. (required)

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