Api

Class MicroformIntegrationApi

java.lang.Object

Api.MicroformIntegrationApi

public class MicroformIntegrationApi
extends Object

Constructor Summary

Constructors

Constructor	Description
MicroformIntegrationApi()
MicroformIntegrationApi(ApiClient apiClient)

Method Summary

Modifier and Type	Method	Description
String	generateCaptureContext(GenerateCaptureContextRequest generateCaptureContextRequest)	Generate Capture Context This API is used to generate the Capture Context data structure for the Microform Integration.
okhttp3.Call	generateCaptureContextAsync(GenerateCaptureContextRequest generateCaptureContextRequest, ApiCallback<String> callback)	Generate Capture Context (asynchronously) This API is used to generate the Capture Context data structure for the Microform Integration.
okhttp3.Call	generateCaptureContextCall(GenerateCaptureContextRequest generateCaptureContextRequest, ProgressResponseBody.ProgressListener progressListener, ProgressRequestBody.ProgressRequestListener progressRequestListener)	Build call for generateCaptureContext
ApiResponse<String>	generateCaptureContextWithHttpInfo(GenerateCaptureContextRequest generateCaptureContextRequest)	Generate Capture Context This API is used to generate the Capture Context data structure for the Microform Integration.
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

MicroformIntegrationApi

public MicroformIntegrationApi()

MicroformIntegrationApi

public MicroformIntegrationApi(ApiClient apiClient)

Method Detail

getApiClient

public ApiClient getApiClient()

setApiClient

public void setApiClient(ApiClient apiClient)

generateCaptureContextCall

public okhttp3.Call generateCaptureContextCall(GenerateCaptureContextRequest generateCaptureContextRequest,
                                               ProgressResponseBody.ProgressListener progressListener,
                                               ProgressRequestBody.ProgressRequestListener progressRequestListener)
                                        throws ApiException,
                                               com.cybersource.authsdk.core.ConfigException

Build call for generateCaptureContext

Parameters:

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

generateCaptureContext

public String generateCaptureContext(GenerateCaptureContextRequest generateCaptureContextRequest)
                              throws ApiException,
                                     com.cybersource.authsdk.core.ConfigException

Generate Capture Context This API is used to generate the Capture Context data structure for the Microform Integration. Microform is a browser-based acceptance solution that allows a seller to capture payment information is a secure manner from their website. For more information about Flex Microform transactions, see the [Flex Developer Guides Page](https://developer.cybersource.com/api/developer-guides/dita-flex/SAFlexibleToken.html). For examples on how to integrate Flex Microform within your webpage please see our [GitHub Flex Samples](https://github.com/CyberSource?q=flex&type=&language=) This API is a server-to-server API to generate the capture context that can be used to initiate instance of microform on a acceptance page. The capture context is a digitally signed JWT that provides authentication, one-time keys, and the target origin to the Microform Integration application. The availability of API features for a merchant may depend on the portfolio configuration and may need to be enabled at the portfolio level before they can be added to merchant accounts.

Parameters:

generateCaptureContextRequest - (required)

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

generateCaptureContextWithHttpInfo

public ApiResponse<String> generateCaptureContextWithHttpInfo(GenerateCaptureContextRequest generateCaptureContextRequest)
                                                       throws ApiException,
                                                              com.cybersource.authsdk.core.ConfigException

Generate Capture Context This API is used to generate the Capture Context data structure for the Microform Integration. Microform is a browser-based acceptance solution that allows a seller to capture payment information is a secure manner from their website. For more information about Flex Microform transactions, see the [Flex Developer Guides Page](https://developer.cybersource.com/api/developer-guides/dita-flex/SAFlexibleToken.html). For examples on how to integrate Flex Microform within your webpage please see our [GitHub Flex Samples](https://github.com/CyberSource?q=flex&type=&language=) This API is a server-to-server API to generate the capture context that can be used to initiate instance of microform on a acceptance page. The capture context is a digitally signed JWT that provides authentication, one-time keys, and the target origin to the Microform Integration application. The availability of API features for a merchant may depend on the portfolio configuration and may need to be enabled at the portfolio level before they can be added to merchant accounts.

Parameters:

generateCaptureContextRequest - (required)

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

generateCaptureContextAsync

public okhttp3.Call generateCaptureContextAsync(GenerateCaptureContextRequest generateCaptureContextRequest,
                                                ApiCallback<String> callback)
                                         throws ApiException,
                                                com.cybersource.authsdk.core.ConfigException

Generate Capture Context (asynchronously) This API is used to generate the Capture Context data structure for the Microform Integration. Microform is a browser-based acceptance solution that allows a seller to capture payment information is a secure manner from their website. For more information about Flex Microform transactions, see the [Flex Developer Guides Page](https://developer.cybersource.com/api/developer-guides/dita-flex/SAFlexibleToken.html). For examples on how to integrate Flex Microform within your webpage please see our [GitHub Flex Samples](https://github.com/CyberSource?q=flex&type=&language=) This API is a server-to-server API to generate the capture context that can be used to initiate instance of microform on a acceptance page. The capture context is a digitally signed JWT that provides authentication, one-time keys, and the target origin to the Microform Integration application. The availability of API features for a merchant may depend on the portfolio configuration and may need to be enabled at the portfolio level before they can be added to merchant accounts.

Parameters:

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