Api

Class CredentialsApi

java.lang.Object

Api.CredentialsApi

public class CredentialsApi
extends Object

Constructor Summary

Constructors

Constructor	Description
CredentialsApi()
CredentialsApi(ApiClient apiClient)

Method Summary

Modifier and Type	Method	Description
ApiClient	getApiClient()
MppCredentialsResponse200	provisionMppCredentials(MppCredentialsRequest mppCredentialsRequest)	Provision MPP credentials Provisions an encrypted MPP credential for use as the credential payload in an Authorization: Payment header (MPP spec Section 8.2).
okhttp3.Call	provisionMppCredentialsAsync(MppCredentialsRequest mppCredentialsRequest, ApiCallback<MppCredentialsResponse200> callback)	Provision MPP credentials (asynchronously) Provisions an encrypted MPP credential for use as the credential payload in an Authorization: Payment header (MPP spec Section 8.2).
okhttp3.Call	provisionMppCredentialsCall(MppCredentialsRequest mppCredentialsRequest, ProgressResponseBody.ProgressListener progressListener, ProgressRequestBody.ProgressRequestListener progressRequestListener)	Build call for provisionMppCredentials
ApiResponse<MppCredentialsResponse200>	provisionMppCredentialsWithHttpInfo(MppCredentialsRequest mppCredentialsRequest)	Provision MPP credentials Provisions an encrypted MPP credential for use as the credential payload in an Authorization: Payment header (MPP spec Section 8.2).
void	setApiClient(ApiClient apiClient)

Methods inherited from class java.lang.Object

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

Constructor Detail

CredentialsApi

public CredentialsApi()

CredentialsApi

public CredentialsApi(ApiClient apiClient)

Method Detail

getApiClient

public ApiClient getApiClient()

setApiClient

public void setApiClient(ApiClient apiClient)

provisionMppCredentialsCall

public okhttp3.Call provisionMppCredentialsCall(MppCredentialsRequest mppCredentialsRequest,
                                                ProgressResponseBody.ProgressListener progressListener,
                                                ProgressRequestBody.ProgressRequestListener progressRequestListener)
                                         throws ApiException,
                                                com.cybersource.authsdk.core.ConfigException

Build call for provisionMppCredentials

Parameters:

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

provisionMppCredentials

public MppCredentialsResponse200 provisionMppCredentials(MppCredentialsRequest mppCredentialsRequest)
                                                  throws ApiException,
                                                         com.cybersource.authsdk.core.ConfigException

Provision MPP credentials Provisions an encrypted MPP credential for use as the credential payload in an Authorization: Payment header (MPP spec Section 8.2). The caller provides an instrument identifier (referencing a stored card in TMS) and the challenge context from the merchant's 402 response, including the merchant's RSA public encryption key. This service: 1. Calls TMS to retrieve the network token and cryptogram for the instrument. 2. Builds the token plaintext (MPP spec Section 8.3, type: network_token). 3. Encrypts the plaintext using RSA-OAEP with SHA-256 and the merchant's public key. 4. Returns the MPP credential payload fields (MPP spec Section 8.2, Table 4).

Parameters:

mppCredentialsRequest - (required)

Returns:

MppCredentialsResponse200

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

provisionMppCredentialsWithHttpInfo

public ApiResponse<MppCredentialsResponse200> provisionMppCredentialsWithHttpInfo(MppCredentialsRequest mppCredentialsRequest)
                                                                           throws ApiException,
                                                                                  com.cybersource.authsdk.core.ConfigException

Provision MPP credentials Provisions an encrypted MPP credential for use as the credential payload in an Authorization: Payment header (MPP spec Section 8.2). The caller provides an instrument identifier (referencing a stored card in TMS) and the challenge context from the merchant's 402 response, including the merchant's RSA public encryption key. This service: 1. Calls TMS to retrieve the network token and cryptogram for the instrument. 2. Builds the token plaintext (MPP spec Section 8.3, type: network_token). 3. Encrypts the plaintext using RSA-OAEP with SHA-256 and the merchant's public key. 4. Returns the MPP credential payload fields (MPP spec Section 8.2, Table 4).

Parameters:

mppCredentialsRequest - (required)

Returns:

ApiResponse<MppCredentialsResponse200>

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

provisionMppCredentialsAsync

public okhttp3.Call provisionMppCredentialsAsync(MppCredentialsRequest mppCredentialsRequest,
                                                 ApiCallback<MppCredentialsResponse200> callback)
                                          throws ApiException,
                                                 com.cybersource.authsdk.core.ConfigException

Provision MPP credentials (asynchronously) Provisions an encrypted MPP credential for use as the credential payload in an Authorization: Payment header (MPP spec Section 8.2). The caller provides an instrument identifier (referencing a stored card in TMS) and the challenge context from the merchant's 402 response, including the merchant's RSA public encryption key. This service: 1. Calls TMS to retrieve the network token and cryptogram for the instrument. 2. Builds the token plaintext (MPP spec Section 8.3, type: network_token). 3. Encrypts the plaintext using RSA-OAEP with SHA-256 and the merchant's public key. 4. Returns the MPP credential payload fields (MPP spec Section 8.2, Table 4).

Parameters:

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