Api

Class MerchantBoardingApi

java.lang.Object

Api.MerchantBoardingApi

public class MerchantBoardingApi
extends Object

Constructor Summary

Constructors

Constructor	Description
MerchantBoardingApi()
MerchantBoardingApi(ApiClient apiClient)

Method Summary

Modifier and Type	Method	Description
ApiClient	getApiClient()
InlineResponse2005	getRegistration(String registrationId)	Gets all the information on a boarding registration This end point will get all information of a boarding registration
okhttp3.Call	getRegistrationAsync(String registrationId, ApiCallback<InlineResponse2005> callback)	Gets all the information on a boarding registration (asynchronously) This end point will get all information of a boarding registration
okhttp3.Call	getRegistrationCall(String registrationId, ProgressResponseBody.ProgressListener progressListener, ProgressRequestBody.ProgressRequestListener progressRequestListener)	Build call for getRegistration
ApiResponse<InlineResponse2005>	getRegistrationWithHttpInfo(String registrationId)	Gets all the information on a boarding registration This end point will get all information of a boarding registration
InlineResponse2014	postRegistration(PostRegistrationBody postRegistrationBody, String vCIdempotencyId)	Create a boarding registration Boarding Product is specifically for resellers who onboard merchants to resell their services to merchants and help integrate REST API into their systems.
okhttp3.Call	postRegistrationAsync(PostRegistrationBody postRegistrationBody, String vCIdempotencyId, ApiCallback<InlineResponse2014> callback)	Create a boarding registration (asynchronously) Boarding Product is specifically for resellers who onboard merchants to resell their services to merchants and help integrate REST API into their systems.
okhttp3.Call	postRegistrationCall(PostRegistrationBody postRegistrationBody, String vCIdempotencyId, ProgressResponseBody.ProgressListener progressListener, ProgressRequestBody.ProgressRequestListener progressRequestListener)	Build call for postRegistration
ApiResponse<InlineResponse2014>	postRegistrationWithHttpInfo(PostRegistrationBody postRegistrationBody, String vCIdempotencyId)	Create a boarding registration Boarding Product is specifically for resellers who onboard merchants to resell their services to merchants and help integrate REST API into their systems.
void	setApiClient(ApiClient apiClient)

Methods inherited from class java.lang.Object

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

Constructor Detail

MerchantBoardingApi

public MerchantBoardingApi()

MerchantBoardingApi

public MerchantBoardingApi(ApiClient apiClient)

Method Detail

getApiClient

public ApiClient getApiClient()

setApiClient

public void setApiClient(ApiClient apiClient)

getRegistrationCall

public okhttp3.Call getRegistrationCall(String registrationId,
                                        ProgressResponseBody.ProgressListener progressListener,
                                        ProgressRequestBody.ProgressRequestListener progressRequestListener)
                                 throws ApiException,
                                        com.cybersource.authsdk.core.ConfigException

Build call for getRegistration

Parameters:

registrationId - Identifies the boarding registration to be updated (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

getRegistration

public InlineResponse2005 getRegistration(String registrationId)
                                   throws ApiException,
                                          com.cybersource.authsdk.core.ConfigException

Gets all the information on a boarding registration This end point will get all information of a boarding registration

Parameters:

registrationId - Identifies the boarding registration to be updated (required)

Returns:

InlineResponse2005

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

getRegistrationWithHttpInfo

public ApiResponse<InlineResponse2005> getRegistrationWithHttpInfo(String registrationId)
                                                            throws ApiException,
                                                                   com.cybersource.authsdk.core.ConfigException

Gets all the information on a boarding registration This end point will get all information of a boarding registration

Parameters:

registrationId - Identifies the boarding registration to be updated (required)

Returns:

ApiResponse<InlineResponse2005>

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

getRegistrationAsync

public okhttp3.Call getRegistrationAsync(String registrationId,
                                         ApiCallback<InlineResponse2005> callback)
                                  throws ApiException,
                                         com.cybersource.authsdk.core.ConfigException

Gets all the information on a boarding registration (asynchronously) This end point will get all information of a boarding registration

Parameters:

registrationId - Identifies the boarding registration to be updated (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

postRegistrationCall

public okhttp3.Call postRegistrationCall(PostRegistrationBody postRegistrationBody,
                                         String vCIdempotencyId,
                                         ProgressResponseBody.ProgressListener progressListener,
                                         ProgressRequestBody.ProgressRequestListener progressRequestListener)
                                  throws ApiException,
                                         com.cybersource.authsdk.core.ConfigException

Build call for postRegistration

Parameters:

postRegistrationBody - Boarding registration data (required)

vCIdempotencyId - defines idempotency of the request (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

postRegistration

public InlineResponse2014 postRegistration(PostRegistrationBody postRegistrationBody,
                                           String vCIdempotencyId)
                                    throws ApiException,
                                           com.cybersource.authsdk.core.ConfigException

Create a boarding registration Boarding Product is specifically for resellers who onboard merchants to resell their services to merchants and help integrate REST API into their systems. The Boarding API is designed to simplify and streamline the onboarding process of merchants by enabling administrators and developers to: 1. Enable and Configure Products: The API helps in adding new products to an existing organization and configuring them to suit specific needs. 2. Update Merchant Information: The API allows for updating an organization's information efficiently. 3. Manage Payment Integration: It provides templates for secure payment integration and management.

Parameters:

postRegistrationBody - Boarding registration data (required)

vCIdempotencyId - defines idempotency of the request (optional)

Returns:

InlineResponse2014

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

postRegistrationWithHttpInfo

public ApiResponse<InlineResponse2014> postRegistrationWithHttpInfo(PostRegistrationBody postRegistrationBody,
                                                                    String vCIdempotencyId)
                                                             throws ApiException,
                                                                    com.cybersource.authsdk.core.ConfigException

Create a boarding registration Boarding Product is specifically for resellers who onboard merchants to resell their services to merchants and help integrate REST API into their systems. The Boarding API is designed to simplify and streamline the onboarding process of merchants by enabling administrators and developers to: 1. Enable and Configure Products: The API helps in adding new products to an existing organization and configuring them to suit specific needs. 2. Update Merchant Information: The API allows for updating an organization's information efficiently. 3. Manage Payment Integration: It provides templates for secure payment integration and management.

Parameters:

postRegistrationBody - Boarding registration data (required)

vCIdempotencyId - defines idempotency of the request (optional)

Returns:

ApiResponse<InlineResponse2014>

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

postRegistrationAsync

public okhttp3.Call postRegistrationAsync(PostRegistrationBody postRegistrationBody,
                                          String vCIdempotencyId,
                                          ApiCallback<InlineResponse2014> callback)
                                   throws ApiException,
                                          com.cybersource.authsdk.core.ConfigException

Create a boarding registration (asynchronously) Boarding Product is specifically for resellers who onboard merchants to resell their services to merchants and help integrate REST API into their systems. The Boarding API is designed to simplify and streamline the onboarding process of merchants by enabling administrators and developers to: 1. Enable and Configure Products: The API helps in adding new products to an existing organization and configuring them to suit specific needs. 2. Update Merchant Information: The API allows for updating an organization's information efficiently. 3. Manage Payment Integration: It provides templates for secure payment integration and management.

Parameters:

postRegistrationBody - Boarding registration data (required)

vCIdempotencyId - defines idempotency of the request (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