Api

Class InstructionsApi

java.lang.Object

Api.InstructionsApi

public class InstructionsApi
extends Object

Constructor Summary

Constructors

Constructor	Description
InstructionsApi()
InstructionsApi(ApiClient apiClient)

Method Summary

Modifier and Type	Method	Description
AgenticCreatePurchaseIntentResponse200	cancelPurchaseIntent(String instructionId, AgenticCancelPurchaseIntentRequest agenticCancelPurchaseIntentRequest)	Cancel a purchase intent Cancel an existing purchase intent (instruction) identified by its instructionId.
okhttp3.Call	cancelPurchaseIntentAsync(String instructionId, AgenticCancelPurchaseIntentRequest agenticCancelPurchaseIntentRequest, ApiCallback<AgenticCreatePurchaseIntentResponse200> callback)	Cancel a purchase intent (asynchronously) Cancel an existing purchase intent (instruction) identified by its instructionId.
okhttp3.Call	cancelPurchaseIntentCall(String instructionId, AgenticCancelPurchaseIntentRequest agenticCancelPurchaseIntentRequest, ProgressResponseBody.ProgressListener progressListener, ProgressRequestBody.ProgressRequestListener progressRequestListener)	Build call for cancelPurchaseIntent
ApiResponse<AgenticCreatePurchaseIntentResponse200>	cancelPurchaseIntentWithHttpInfo(String instructionId, AgenticCancelPurchaseIntentRequest agenticCancelPurchaseIntentRequest)	Cancel a purchase intent Cancel an existing purchase intent (instruction) identified by its instructionId.
AgenticConfirmTransactionEventsResponse202	confirmTransactionEvents(String instructionId, AgenticConfirmTransactionEventsRequest agenticConfirmTransactionEventsRequest)	Confirm transaction events Confirm transaction events for a completed purchase.
okhttp3.Call	confirmTransactionEventsAsync(String instructionId, AgenticConfirmTransactionEventsRequest agenticConfirmTransactionEventsRequest, ApiCallback<AgenticConfirmTransactionEventsResponse202> callback)	Confirm transaction events (asynchronously) Confirm transaction events for a completed purchase.
okhttp3.Call	confirmTransactionEventsCall(String instructionId, AgenticConfirmTransactionEventsRequest agenticConfirmTransactionEventsRequest, ProgressResponseBody.ProgressListener progressListener, ProgressRequestBody.ProgressRequestListener progressRequestListener)	Build call for confirmTransactionEvents
ApiResponse<AgenticConfirmTransactionEventsResponse202>	confirmTransactionEventsWithHttpInfo(String instructionId, AgenticConfirmTransactionEventsRequest agenticConfirmTransactionEventsRequest)	Confirm transaction events Confirm transaction events for a completed purchase.
ApiClient	getApiClient()
AgenticCreatePurchaseIntentResponse200	initiatePurchaseIntent(AgenticCreatePurchaseIntentRequest agenticCreatePurchaseIntentRequest)	Initiate a purchase intent Create a new purchase intent (instruction) for an agentic transaction.
okhttp3.Call	initiatePurchaseIntentAsync(AgenticCreatePurchaseIntentRequest agenticCreatePurchaseIntentRequest, ApiCallback<AgenticCreatePurchaseIntentResponse200> callback)	Initiate a purchase intent (asynchronously) Create a new purchase intent (instruction) for an agentic transaction.
okhttp3.Call	initiatePurchaseIntentCall(AgenticCreatePurchaseIntentRequest agenticCreatePurchaseIntentRequest, ProgressResponseBody.ProgressListener progressListener, ProgressRequestBody.ProgressRequestListener progressRequestListener)	Build call for initiatePurchaseIntent
ApiResponse<AgenticCreatePurchaseIntentResponse200>	initiatePurchaseIntentWithHttpInfo(AgenticCreatePurchaseIntentRequest agenticCreatePurchaseIntentRequest)	Initiate a purchase intent Create a new purchase intent (instruction) for an agentic transaction.
AgenticRetrievePaymentCredentialsResponse200	retrievePaymentCredentials(String instructionId, AgenticRetrievePaymentCredentialsRequest agenticRetrievePaymentCredentialsRequest)	Retrieve payment credentials Retrieve tokenized payment credentials for a purchase intent to complete the transaction at a merchant.
okhttp3.Call	retrievePaymentCredentialsAsync(String instructionId, AgenticRetrievePaymentCredentialsRequest agenticRetrievePaymentCredentialsRequest, ApiCallback<AgenticRetrievePaymentCredentialsResponse200> callback)	Retrieve payment credentials (asynchronously) Retrieve tokenized payment credentials for a purchase intent to complete the transaction at a merchant.
okhttp3.Call	retrievePaymentCredentialsCall(String instructionId, AgenticRetrievePaymentCredentialsRequest agenticRetrievePaymentCredentialsRequest, ProgressResponseBody.ProgressListener progressListener, ProgressRequestBody.ProgressRequestListener progressRequestListener)	Build call for retrievePaymentCredentials
ApiResponse<AgenticRetrievePaymentCredentialsResponse200>	retrievePaymentCredentialsWithHttpInfo(String instructionId, AgenticRetrievePaymentCredentialsRequest agenticRetrievePaymentCredentialsRequest)	Retrieve payment credentials Retrieve tokenized payment credentials for a purchase intent to complete the transaction at a merchant.
void	setApiClient(ApiClient apiClient)
AgenticCreatePurchaseIntentResponse200	updatePurchaseIntent(String instructionId, AgenticUpdatePurchaseIntentRequest agenticUpdatePurchaseIntentRequest)	Update a purchase intent Update an existing purchase intent (instruction) identified by its instructionId.
okhttp3.Call	updatePurchaseIntentAsync(String instructionId, AgenticUpdatePurchaseIntentRequest agenticUpdatePurchaseIntentRequest, ApiCallback<AgenticCreatePurchaseIntentResponse200> callback)	Update a purchase intent (asynchronously) Update an existing purchase intent (instruction) identified by its instructionId.
okhttp3.Call	updatePurchaseIntentCall(String instructionId, AgenticUpdatePurchaseIntentRequest agenticUpdatePurchaseIntentRequest, ProgressResponseBody.ProgressListener progressListener, ProgressRequestBody.ProgressRequestListener progressRequestListener)	Build call for updatePurchaseIntent
ApiResponse<AgenticCreatePurchaseIntentResponse200>	updatePurchaseIntentWithHttpInfo(String instructionId, AgenticUpdatePurchaseIntentRequest agenticUpdatePurchaseIntentRequest)	Update a purchase intent Update an existing purchase intent (instruction) identified by its instructionId.

Methods inherited from class java.lang.Object

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

Constructor Detail

InstructionsApi

public InstructionsApi()

InstructionsApi

public InstructionsApi(ApiClient apiClient)

Method Detail

getApiClient

public ApiClient getApiClient()

setApiClient

public void setApiClient(ApiClient apiClient)

cancelPurchaseIntentCall

public okhttp3.Call cancelPurchaseIntentCall(String instructionId,
                                             AgenticCancelPurchaseIntentRequest agenticCancelPurchaseIntentRequest,
                                             ProgressResponseBody.ProgressListener progressListener,
                                             ProgressRequestBody.ProgressRequestListener progressRequestListener)
                                      throws ApiException,
                                             com.cybersource.authsdk.core.ConfigException

Build call for cancelPurchaseIntent

Parameters:

instructionId - (required)

agenticCancelPurchaseIntentRequest - Unique identifier for the purchase intent instruction. (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

cancelPurchaseIntent

public AgenticCreatePurchaseIntentResponse200 cancelPurchaseIntent(String instructionId,
                                                                   AgenticCancelPurchaseIntentRequest agenticCancelPurchaseIntentRequest)
                                                            throws ApiException,
                                                                   com.cybersource.authsdk.core.ConfigException

Cancel a purchase intent Cancel an existing purchase intent (instruction) identified by its instructionId. The agent calls this endpoint when the consumer decides to abandon the purchase before payment credentials have been used. Requires device information and assurance data for identity verification. Returns status CANCELLED (HTTP 200) on success, or PENDING (HTTP 202) with pendingEvents if cardholder authentication is required before cancellation can proceed.

Parameters:

instructionId - (required)

agenticCancelPurchaseIntentRequest - Unique identifier for the purchase intent instruction. (required)

Returns:

AgenticCreatePurchaseIntentResponse200

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

cancelPurchaseIntentWithHttpInfo

public ApiResponse<AgenticCreatePurchaseIntentResponse200> cancelPurchaseIntentWithHttpInfo(String instructionId,
                                                                                            AgenticCancelPurchaseIntentRequest agenticCancelPurchaseIntentRequest)
                                                                                     throws ApiException,
                                                                                            com.cybersource.authsdk.core.ConfigException

Cancel a purchase intent Cancel an existing purchase intent (instruction) identified by its instructionId. The agent calls this endpoint when the consumer decides to abandon the purchase before payment credentials have been used. Requires device information and assurance data for identity verification. Returns status CANCELLED (HTTP 200) on success, or PENDING (HTTP 202) with pendingEvents if cardholder authentication is required before cancellation can proceed.

Parameters:

instructionId - (required)

agenticCancelPurchaseIntentRequest - Unique identifier for the purchase intent instruction. (required)

Returns:

ApiResponse<AgenticCreatePurchaseIntentResponse200>

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

cancelPurchaseIntentAsync

public okhttp3.Call cancelPurchaseIntentAsync(String instructionId,
                                              AgenticCancelPurchaseIntentRequest agenticCancelPurchaseIntentRequest,
                                              ApiCallback<AgenticCreatePurchaseIntentResponse200> callback)
                                       throws ApiException,
                                              com.cybersource.authsdk.core.ConfigException

Cancel a purchase intent (asynchronously) Cancel an existing purchase intent (instruction) identified by its instructionId. The agent calls this endpoint when the consumer decides to abandon the purchase before payment credentials have been used. Requires device information and assurance data for identity verification. Returns status CANCELLED (HTTP 200) on success, or PENDING (HTTP 202) with pendingEvents if cardholder authentication is required before cancellation can proceed.

Parameters:

instructionId - (required)

agenticCancelPurchaseIntentRequest - Unique identifier for the purchase intent instruction. (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

confirmTransactionEventsCall

public okhttp3.Call confirmTransactionEventsCall(String instructionId,
                                                 AgenticConfirmTransactionEventsRequest agenticConfirmTransactionEventsRequest,
                                                 ProgressResponseBody.ProgressListener progressListener,
                                                 ProgressRequestBody.ProgressRequestListener progressRequestListener)
                                          throws ApiException,
                                                 com.cybersource.authsdk.core.ConfigException

Build call for confirmTransactionEvents

Parameters:

instructionId - Unique identifier for the purchase intent instruction. (required)

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

confirmTransactionEvents

public AgenticConfirmTransactionEventsResponse202 confirmTransactionEvents(String instructionId,
                                                                           AgenticConfirmTransactionEventsRequest agenticConfirmTransactionEventsRequest)
                                                                    throws ApiException,
                                                                           com.cybersource.authsdk.core.ConfigException

Confirm transaction events Confirm transaction events for a completed purchase. The agent calls this endpoint after the payment has been submitted to notify the Intelligent Commerce Connect of the transaction outcome. The request includes processor information (transaction type, status, approval codes), order details (shipping, tracking, product information), and merchant information. Returns HTTP 202 acknowledging receipt of the confirmation.

Parameters:

instructionId - Unique identifier for the purchase intent instruction. (required)

agenticConfirmTransactionEventsRequest - (required)

Returns:

AgenticConfirmTransactionEventsResponse202

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

confirmTransactionEventsWithHttpInfo

public ApiResponse<AgenticConfirmTransactionEventsResponse202> confirmTransactionEventsWithHttpInfo(String instructionId,
                                                                                                    AgenticConfirmTransactionEventsRequest agenticConfirmTransactionEventsRequest)
                                                                                             throws ApiException,
                                                                                                    com.cybersource.authsdk.core.ConfigException

Confirm transaction events Confirm transaction events for a completed purchase. The agent calls this endpoint after the payment has been submitted to notify the Intelligent Commerce Connect of the transaction outcome. The request includes processor information (transaction type, status, approval codes), order details (shipping, tracking, product information), and merchant information. Returns HTTP 202 acknowledging receipt of the confirmation.

Parameters:

instructionId - Unique identifier for the purchase intent instruction. (required)

agenticConfirmTransactionEventsRequest - (required)

Returns:

ApiResponse<AgenticConfirmTransactionEventsResponse202>

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

confirmTransactionEventsAsync

public okhttp3.Call confirmTransactionEventsAsync(String instructionId,
                                                  AgenticConfirmTransactionEventsRequest agenticConfirmTransactionEventsRequest,
                                                  ApiCallback<AgenticConfirmTransactionEventsResponse202> callback)
                                           throws ApiException,
                                                  com.cybersource.authsdk.core.ConfigException

Confirm transaction events (asynchronously) Confirm transaction events for a completed purchase. The agent calls this endpoint after the payment has been submitted to notify the Intelligent Commerce Connect of the transaction outcome. The request includes processor information (transaction type, status, approval codes), order details (shipping, tracking, product information), and merchant information. Returns HTTP 202 acknowledging receipt of the confirmation.

Parameters:

instructionId - Unique identifier for the purchase intent instruction. (required)

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

initiatePurchaseIntentCall

public okhttp3.Call initiatePurchaseIntentCall(AgenticCreatePurchaseIntentRequest agenticCreatePurchaseIntentRequest,
                                               ProgressResponseBody.ProgressListener progressListener,
                                               ProgressRequestBody.ProgressRequestListener progressRequestListener)
                                        throws ApiException,
                                               com.cybersource.authsdk.core.ConfigException

Build call for initiatePurchaseIntent

Parameters:

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

initiatePurchaseIntent

public AgenticCreatePurchaseIntentResponse200 initiatePurchaseIntent(AgenticCreatePurchaseIntentRequest agenticCreatePurchaseIntentRequest)
                                                              throws ApiException,
                                                                     com.cybersource.authsdk.core.ConfigException

Initiate a purchase intent Create a new purchase intent (instruction) for an agentic transaction. The agent calls this endpoint after a card has been enrolled to define what the consumer wants to buy. The request includes payment instrument references, device and assurance data, mandates (spending limits, merchant preferences, and product descriptions), and optional buyer information. Return an instructionId (HTTP 200) if the intent is created immediately, or PENDING (HTTP 202) with pendingEvents if cardholder authentication is required. The instructionId returned is used in all subsequent operations - update, cancel, retrieve credentials, and confirm transaction.

Parameters:

agenticCreatePurchaseIntentRequest - (required)

Returns:

AgenticCreatePurchaseIntentResponse200

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

initiatePurchaseIntentWithHttpInfo

public ApiResponse<AgenticCreatePurchaseIntentResponse200> initiatePurchaseIntentWithHttpInfo(AgenticCreatePurchaseIntentRequest agenticCreatePurchaseIntentRequest)
                                                                                       throws ApiException,
                                                                                              com.cybersource.authsdk.core.ConfigException

Initiate a purchase intent Create a new purchase intent (instruction) for an agentic transaction. The agent calls this endpoint after a card has been enrolled to define what the consumer wants to buy. The request includes payment instrument references, device and assurance data, mandates (spending limits, merchant preferences, and product descriptions), and optional buyer information. Return an instructionId (HTTP 200) if the intent is created immediately, or PENDING (HTTP 202) with pendingEvents if cardholder authentication is required. The instructionId returned is used in all subsequent operations - update, cancel, retrieve credentials, and confirm transaction.

Parameters:

agenticCreatePurchaseIntentRequest - (required)

Returns:

ApiResponse<AgenticCreatePurchaseIntentResponse200>

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

initiatePurchaseIntentAsync

public okhttp3.Call initiatePurchaseIntentAsync(AgenticCreatePurchaseIntentRequest agenticCreatePurchaseIntentRequest,
                                                ApiCallback<AgenticCreatePurchaseIntentResponse200> callback)
                                         throws ApiException,
                                                com.cybersource.authsdk.core.ConfigException

Initiate a purchase intent (asynchronously) Create a new purchase intent (instruction) for an agentic transaction. The agent calls this endpoint after a card has been enrolled to define what the consumer wants to buy. The request includes payment instrument references, device and assurance data, mandates (spending limits, merchant preferences, and product descriptions), and optional buyer information. Return an instructionId (HTTP 200) if the intent is created immediately, or PENDING (HTTP 202) with pendingEvents if cardholder authentication is required. The instructionId returned is used in all subsequent operations - update, cancel, retrieve credentials, and confirm transaction.

Parameters:

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

retrievePaymentCredentialsCall

public okhttp3.Call retrievePaymentCredentialsCall(String instructionId,
                                                   AgenticRetrievePaymentCredentialsRequest agenticRetrievePaymentCredentialsRequest,
                                                   ProgressResponseBody.ProgressListener progressListener,
                                                   ProgressRequestBody.ProgressRequestListener progressRequestListener)
                                            throws ApiException,
                                                   com.cybersource.authsdk.core.ConfigException

Build call for retrievePaymentCredentials

Parameters:

instructionId - Unique identifier for the purchase intent instruction. (required)

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

retrievePaymentCredentials

public AgenticRetrievePaymentCredentialsResponse200 retrievePaymentCredentials(String instructionId,
                                                                               AgenticRetrievePaymentCredentialsRequest agenticRetrievePaymentCredentialsRequest)
                                                                        throws ApiException,
                                                                               com.cybersource.authsdk.core.ConfigException

Retrieve payment credentials Retrieve tokenized payment credentials for a purchase intent to complete the transaction at a merchant. The agent calls this endpoint after a purchase intent has been created and approved, providing transaction-level details including order information, merchant details, payment options, and production information. Returns COMPLETED (HTTP 200) with a signed payload containing encrypted payment credentials (authorization token and JWS-signed payload), or PENDING (HTTP 202) with pendingEvents if additional cardholder authentication is required. The signed payload is used by the merchant's payment processor to complete the transaction.

Parameters:

instructionId - Unique identifier for the purchase intent instruction. (required)

agenticRetrievePaymentCredentialsRequest - (required)

Returns:

AgenticRetrievePaymentCredentialsResponse200

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

retrievePaymentCredentialsWithHttpInfo

public ApiResponse<AgenticRetrievePaymentCredentialsResponse200> retrievePaymentCredentialsWithHttpInfo(String instructionId,
                                                                                                        AgenticRetrievePaymentCredentialsRequest agenticRetrievePaymentCredentialsRequest)
                                                                                                 throws ApiException,
                                                                                                        com.cybersource.authsdk.core.ConfigException

Retrieve payment credentials Retrieve tokenized payment credentials for a purchase intent to complete the transaction at a merchant. The agent calls this endpoint after a purchase intent has been created and approved, providing transaction-level details including order information, merchant details, payment options, and production information. Returns COMPLETED (HTTP 200) with a signed payload containing encrypted payment credentials (authorization token and JWS-signed payload), or PENDING (HTTP 202) with pendingEvents if additional cardholder authentication is required. The signed payload is used by the merchant's payment processor to complete the transaction.

Parameters:

instructionId - Unique identifier for the purchase intent instruction. (required)

agenticRetrievePaymentCredentialsRequest - (required)

Returns:

ApiResponse<AgenticRetrievePaymentCredentialsResponse200>

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

retrievePaymentCredentialsAsync

public okhttp3.Call retrievePaymentCredentialsAsync(String instructionId,
                                                    AgenticRetrievePaymentCredentialsRequest agenticRetrievePaymentCredentialsRequest,
                                                    ApiCallback<AgenticRetrievePaymentCredentialsResponse200> callback)
                                             throws ApiException,
                                                    com.cybersource.authsdk.core.ConfigException

Retrieve payment credentials (asynchronously) Retrieve tokenized payment credentials for a purchase intent to complete the transaction at a merchant. The agent calls this endpoint after a purchase intent has been created and approved, providing transaction-level details including order information, merchant details, payment options, and production information. Returns COMPLETED (HTTP 200) with a signed payload containing encrypted payment credentials (authorization token and JWS-signed payload), or PENDING (HTTP 202) with pendingEvents if additional cardholder authentication is required. The signed payload is used by the merchant's payment processor to complete the transaction.

Parameters:

instructionId - Unique identifier for the purchase intent instruction. (required)

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

updatePurchaseIntentCall

public okhttp3.Call updatePurchaseIntentCall(String instructionId,
                                             AgenticUpdatePurchaseIntentRequest agenticUpdatePurchaseIntentRequest,
                                             ProgressResponseBody.ProgressListener progressListener,
                                             ProgressRequestBody.ProgressRequestListener progressRequestListener)
                                      throws ApiException,
                                             com.cybersource.authsdk.core.ConfigException

Build call for updatePurchaseIntent

Parameters:

instructionId - Unique identifier for the purchase intent instruction. (required)

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

updatePurchaseIntent

public AgenticCreatePurchaseIntentResponse200 updatePurchaseIntent(String instructionId,
                                                                   AgenticUpdatePurchaseIntentRequest agenticUpdatePurchaseIntentRequest)
                                                            throws ApiException,
                                                                   com.cybersource.authsdk.core.ConfigException

Update a purchase intent Update an existing purchase intent (instruction) identified by its instructionId. The agent calls this endpoint when the consumer modifies their order — for example, changing the quantity, updating mandates, switching payment instruments, or changing shipping details. The request body has the same structure as the initiate request. Returns the same instructionId (HTTP 200) on success, or PENDING (HTTP 202) with pendingEvents if additional cardholder authentication is required for the updated intent.

Parameters:

instructionId - Unique identifier for the purchase intent instruction. (required)

agenticUpdatePurchaseIntentRequest - (required)

Returns:

AgenticCreatePurchaseIntentResponse200

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

updatePurchaseIntentWithHttpInfo

public ApiResponse<AgenticCreatePurchaseIntentResponse200> updatePurchaseIntentWithHttpInfo(String instructionId,
                                                                                            AgenticUpdatePurchaseIntentRequest agenticUpdatePurchaseIntentRequest)
                                                                                     throws ApiException,
                                                                                            com.cybersource.authsdk.core.ConfigException

Update a purchase intent Update an existing purchase intent (instruction) identified by its instructionId. The agent calls this endpoint when the consumer modifies their order — for example, changing the quantity, updating mandates, switching payment instruments, or changing shipping details. The request body has the same structure as the initiate request. Returns the same instructionId (HTTP 200) on success, or PENDING (HTTP 202) with pendingEvents if additional cardholder authentication is required for the updated intent.

Parameters:

instructionId - Unique identifier for the purchase intent instruction. (required)

agenticUpdatePurchaseIntentRequest - (required)

Returns:

ApiResponse<AgenticCreatePurchaseIntentResponse200>

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

updatePurchaseIntentAsync

public okhttp3.Call updatePurchaseIntentAsync(String instructionId,
                                              AgenticUpdatePurchaseIntentRequest agenticUpdatePurchaseIntentRequest,
                                              ApiCallback<AgenticCreatePurchaseIntentResponse200> callback)
                                       throws ApiException,
                                              com.cybersource.authsdk.core.ConfigException

Update a purchase intent (asynchronously) Update an existing purchase intent (instruction) identified by its instructionId. The agent calls this endpoint when the consumer modifies their order — for example, changing the quantity, updating mandates, switching payment instruments, or changing shipping details. The request body has the same structure as the initiate request. Returns the same instructionId (HTTP 200) on success, or PENDING (HTTP 202) with pendingEvents if additional cardholder authentication is required for the updated intent.

Parameters:

instructionId - Unique identifier for the purchase intent instruction. (required)

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