Api

Class MerchantBoardingApi

java.lang.Object

Api.MerchantBoardingApi

public class MerchantBoardingApi
extends Object

Constructor Summary

Constructors

Constructor and Description
MerchantBoardingApi()
MerchantBoardingApi(ApiClient apiClient)

Method Summary

Modifier and Type	Method and Description
ApiClient	getApiClient()
InlineResponse2002	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<InlineResponse2002> 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<InlineResponse2002>	getRegistrationWithHttpInfo(String registrationId) Gets all the information on a boarding registration This end point will get all information of a boarding registration
InlineResponse2011	postRegistration(PostRegistrationBody postRegistrationBody, String vCIdempotencyId) Create a boarding registration Create a registration to board merchant If you have Card Processing product enabled in your boarding request, select payment processor from Configuration -> Sample Request.
okhttp3.Call	postRegistrationAsync(PostRegistrationBody postRegistrationBody, String vCIdempotencyId, ApiCallback<InlineResponse2011> callback) Create a boarding registration (asynchronously) Create a registration to board merchant If you have Card Processing product enabled in your boarding request, select payment processor from Configuration -> Sample Request.
okhttp3.Call	postRegistrationCall(PostRegistrationBody postRegistrationBody, String vCIdempotencyId, ProgressResponseBody.ProgressListener progressListener, ProgressRequestBody.ProgressRequestListener progressRequestListener) Build call for postRegistration
ApiResponse<InlineResponse2011>	postRegistrationWithHttpInfo(PostRegistrationBody postRegistrationBody, String vCIdempotencyId) Create a boarding registration Create a registration to board merchant If you have Card Processing product enabled in your boarding request, select payment processor from Configuration -> Sample Request.
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

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

getRegistration

public InlineResponse2002 getRegistration(String registrationId)
                                   throws ApiException

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

DISCLAIMER : Cybersource may allow Customer to access, use, and/or test a Cybersource product or service that may still be in development or has not been market-tested ("Beta Product") solely for the purpose of evaluating the functionality or marketability of the Beta Product (a "Beta Evaluation"). Notwithstanding any language to the contrary, the following terms shall apply with respect to Customer's participation in any Beta Evaluation (and the Beta Product(s)) accessed thereunder): The Parties will enter into a separate form agreement detailing the scope of the Beta Evaluation, requirements, pricing, the length of the beta evaluation period ("Beta Product Form"). Beta Products are not, and may not become, Transaction Services and have not yet been publicly released and are offered for the sole purpose of internal testing and non-commercial evaluation. Customer's use of the Beta Product shall be solely for the purpose of conducting the Beta Evaluation. Customer accepts all risks arising out of the access and use of the Beta Products. Cybersource may, in its sole discretion, at any time, terminate or discontinue the Beta Evaluation. Customer acknowledges and agrees that any Beta Product may still be in development and that Beta Product is provided "AS IS" and may not perform at the level of a commercially available service, may not operate as expected and may be modified prior to release. CYBERSOURCE SHALL NOT BE RESPONSIBLE OR LIABLE UNDER ANY CONTRACT, TORT (INCLUDING NEGLIGENCE), OR OTHERWISE RELATING TO A BETA PRODUCT OR THE BETA EVALUATION (A) FOR LOSS OR INACCURACY OF DATA OR COST OF PROCUREMENT OF SUBSTITUTE GOODS, SERVICES OR TECHNOLOGY, (B) ANY CLAIM, LOSSES, DAMAGES, OR CAUSE OF ACTION ARISING IN CONNECTION WITH THE BETA PRODUCT; OR (C) FOR ANY INDIRECT, INCIDENTAL OR CONSEQUENTIAL DAMAGES INCLUDING, BUT NOT LIMITED TO, LOSS OF REVENUES AND LOSS OF PROFITS.

Parameters:

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

Returns:

InlineResponse2002

Throws:

ApiException - If fail to call the API, e.g. server error or cannot deserialize the response body

getRegistrationWithHttpInfo

public ApiResponse<InlineResponse2002> getRegistrationWithHttpInfo(String registrationId)
                                                            throws ApiException

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<InlineResponse2002>

Throws:

ApiException - If fail to call the API, e.g. server error or cannot deserialize the response body

getRegistrationAsync

public okhttp3.Call getRegistrationAsync(String registrationId,
                                         ApiCallback<InlineResponse2002> callback)
                                  throws ApiException

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

postRegistrationCall

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

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

postRegistration

public InlineResponse2011 postRegistration(PostRegistrationBody postRegistrationBody,
                                           String vCIdempotencyId)
                                    throws ApiException

Create a boarding registration Create a registration to board merchant If you have Card Processing product enabled in your boarding request, select payment processor from Configuration -> Sample Request. You may unselect attributes from the Request Builder tree which you do not need in the request. For VPC, CUP and EFTPOS processors, replace the processor name from VPC or CUP or EFTPOS to the actual processor name in the sample request. e.g. replace VPC with &lt;your vpc processor&gt;

DISCLAIMER : Cybersource may allow Customer to access, use, and/or test a Cybersource product or service that may still be in development or has not been market-tested ("Beta Product") solely for the purpose of evaluating the functionality or marketability of the Beta Product (a "Beta Evaluation"). Notwithstanding any language to the contrary, the following terms shall apply with respect to Customer's participation in any Beta Evaluation (and the Beta Product(s)) accessed thereunder): The Parties will enter into a separate form agreement detailing the scope of the Beta Evaluation, requirements, pricing, the length of the beta evaluation period ("Beta Product Form"). Beta Products are not, and may not become, Transaction Services and have not yet been publicly released and are offered for the sole purpose of internal testing and non-commercial evaluation. Customer's use of the Beta Product shall be solely for the purpose of conducting the Beta Evaluation. Customer accepts all risks arising out of the access and use of the Beta Products. Cybersource may, in its sole discretion, at any time, terminate or discontinue the Beta Evaluation. Customer acknowledges and agrees that any Beta Product may still be in development and that Beta Product is provided "AS IS" and may not perform at the level of a commercially available service, may not operate as expected and may be modified prior to release. CYBERSOURCE SHALL NOT BE RESPONSIBLE OR LIABLE UNDER ANY CONTRACT, TORT (INCLUDING NEGLIGENCE), OR OTHERWISE RELATING TO A BETA PRODUCT OR THE BETA EVALUATION (A) FOR LOSS OR INACCURACY OF DATA OR COST OF PROCUREMENT OF SUBSTITUTE GOODS, SERVICES OR TECHNOLOGY, (B) ANY CLAIM, LOSSES, DAMAGES, OR CAUSE OF ACTION ARISING IN CONNECTION WITH THE BETA PRODUCT; OR (C) FOR ANY INDIRECT, INCIDENTAL OR CONSEQUENTIAL DAMAGES INCLUDING, BUT NOT LIMITED TO, LOSS OF REVENUES AND LOSS OF PROFITS.

Parameters:

postRegistrationBody - Boarding registration data (required)

vCIdempotencyId - defines idempotency of the request (optional)

Returns:

InlineResponse2011

Throws:

ApiException - If fail to call the API, e.g. server error or cannot deserialize the response body

postRegistrationWithHttpInfo

public ApiResponse<InlineResponse2011> postRegistrationWithHttpInfo(PostRegistrationBody postRegistrationBody,
                                                                    String vCIdempotencyId)
                                                             throws ApiException

Create a boarding registration Create a registration to board merchant If you have Card Processing product enabled in your boarding request, select payment processor from Configuration -> Sample Request. You may unselect attributes from the Request Builder tree which you do not need in the request. For VPC, CUP and EFTPOS processors, replace the processor name from VPC or CUP or EFTPOS to the actual processor name in the sample request. e.g. replace VPC with &lt;your vpc processor&gt;

Parameters:

postRegistrationBody - Boarding registration data (required)

vCIdempotencyId - defines idempotency of the request (optional)

Returns:

ApiResponse<InlineResponse2011>

Throws:

ApiException - If fail to call the API, e.g. server error or cannot deserialize the response body

postRegistrationAsync

public okhttp3.Call postRegistrationAsync(PostRegistrationBody postRegistrationBody,
                                          String vCIdempotencyId,
                                          ApiCallback<InlineResponse2011> callback)
                                   throws ApiException

Create a boarding registration (asynchronously) Create a registration to board merchant If you have Card Processing product enabled in your boarding request, select payment processor from Configuration -> Sample Request. You may unselect attributes from the Request Builder tree which you do not need in the request. For VPC, CUP and EFTPOS processors, replace the processor name from VPC or CUP or EFTPOS to the actual processor name in the sample request. e.g. replace VPC with &lt;your vpc processor&gt;

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