Api

Class EnrollmentApi

java.lang.Object

Api.EnrollmentApi

public class EnrollmentApi
extends Object

Constructor Summary

Constructors

Constructor	Description
EnrollmentApi()
EnrollmentApi(ApiClient apiClient)

Method Summary

Modifier and Type	Method	Description
AgenticCardEnrollmentResponse200	enrollCard(AgenticCardEnrollmentRequest agenticCardEnrollmentRequest)	Enroll a card Enroll a payment card for agentic or e-commerce transactions.
okhttp3.Call	enrollCardAsync(AgenticCardEnrollmentRequest agenticCardEnrollmentRequest, ApiCallback<AgenticCardEnrollmentResponse200> callback)	Enroll a card (asynchronously) Enroll a payment card for agentic or e-commerce transactions.
okhttp3.Call	enrollCardCall(AgenticCardEnrollmentRequest agenticCardEnrollmentRequest, ProgressResponseBody.ProgressListener progressListener, ProgressRequestBody.ProgressRequestListener progressRequestListener)	Build call for enrollCard
ApiResponse<AgenticCardEnrollmentResponse200>	enrollCardWithHttpInfo(AgenticCardEnrollmentRequest agenticCardEnrollmentRequest)	Enroll a card Enroll a payment card for agentic or e-commerce transactions.
ApiClient	getApiClient()
void	setApiClient(ApiClient apiClient)

Methods inherited from class java.lang.Object

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

Constructor Detail

EnrollmentApi

public EnrollmentApi()

EnrollmentApi

public EnrollmentApi(ApiClient apiClient)

Method Detail

getApiClient

public ApiClient getApiClient()

setApiClient

public void setApiClient(ApiClient apiClient)

enrollCardCall

public okhttp3.Call enrollCardCall(AgenticCardEnrollmentRequest agenticCardEnrollmentRequest,
                                   ProgressResponseBody.ProgressListener progressListener,
                                   ProgressRequestBody.ProgressRequestListener progressRequestListener)
                            throws ApiException,
                                   com.cybersource.authsdk.core.ConfigException

Build call for enrollCard

Parameters:

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

enrollCard

public AgenticCardEnrollmentResponse200 enrollCard(AgenticCardEnrollmentRequest agenticCardEnrollmentRequest)
                                            throws ApiException,
                                                   com.cybersource.authsdk.core.ConfigException

Enroll a card Enroll a payment card for agentic or e-commerce transactions. This is typically the first step in the Intelligent Commerce payment lifecycle — the agent calls this endpoint to register a consumer's card, creating a tokenized reference that can be used in subsequent purchase instructions and payment credential retrieval. Requires device information, consumer identity, billing details, and payment instrument references. Returns a status of ACTIVE (HTTP 200) if enrollment completes immediately, or PENDING (HTTP 202) with pendingEvents if cardholder authentication is required. Call this endpoint when a consumer wants to add a new payment card or when setting up a card for agentic payment flows.

Parameters:

agenticCardEnrollmentRequest - (required)

Returns:

AgenticCardEnrollmentResponse200

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

enrollCardWithHttpInfo

public ApiResponse<AgenticCardEnrollmentResponse200> enrollCardWithHttpInfo(AgenticCardEnrollmentRequest agenticCardEnrollmentRequest)
                                                                     throws ApiException,
                                                                            com.cybersource.authsdk.core.ConfigException

Enroll a card Enroll a payment card for agentic or e-commerce transactions. This is typically the first step in the Intelligent Commerce payment lifecycle — the agent calls this endpoint to register a consumer's card, creating a tokenized reference that can be used in subsequent purchase instructions and payment credential retrieval. Requires device information, consumer identity, billing details, and payment instrument references. Returns a status of ACTIVE (HTTP 200) if enrollment completes immediately, or PENDING (HTTP 202) with pendingEvents if cardholder authentication is required. Call this endpoint when a consumer wants to add a new payment card or when setting up a card for agentic payment flows.

Parameters:

agenticCardEnrollmentRequest - (required)

Returns:

ApiResponse<AgenticCardEnrollmentResponse200>

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

enrollCardAsync

public okhttp3.Call enrollCardAsync(AgenticCardEnrollmentRequest agenticCardEnrollmentRequest,
                                    ApiCallback<AgenticCardEnrollmentResponse200> callback)
                             throws ApiException,
                                    com.cybersource.authsdk.core.ConfigException

Enroll a card (asynchronously) Enroll a payment card for agentic or e-commerce transactions. This is typically the first step in the Intelligent Commerce payment lifecycle — the agent calls this endpoint to register a consumer's card, creating a tokenized reference that can be used in subsequent purchase instructions and payment credential retrieval. Requires device information, consumer identity, billing details, and payment instrument references. Returns a status of ACTIVE (HTTP 200) if enrollment completes immediately, or PENDING (HTTP 202) with pendingEvents if cardholder authentication is required. Call this endpoint when a consumer wants to add a new payment card or when setting up a card for agentic payment flows.

Parameters:

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