Api

Class InvoiceSettingsApi

java.lang.Object

Api.InvoiceSettingsApi

public class InvoiceSettingsApi
extends Object

Constructor Summary

Constructors

Constructor	Description
InvoiceSettingsApi()
InvoiceSettingsApi(ApiClient apiClient)

Method Summary

Modifier and Type	Method	Description
ApiClient	getApiClient()
InvoicingV2InvoiceSettingsGet200Response	getInvoiceSettings(String productType)	Get Invoice Settings Allows you to retrieve the invoice settings for the payment page.
okhttp3.Call	getInvoiceSettingsAsync(String productType, ApiCallback<InvoicingV2InvoiceSettingsGet200Response> callback)	Get Invoice Settings (asynchronously) Allows you to retrieve the invoice settings for the payment page.
okhttp3.Call	getInvoiceSettingsCall(String productType, ProgressResponseBody.ProgressListener progressListener, ProgressRequestBody.ProgressRequestListener progressRequestListener)	Build call for getInvoiceSettings
ApiResponse<InvoicingV2InvoiceSettingsGet200Response>	getInvoiceSettingsWithHttpInfo(String productType)	Get Invoice Settings Allows you to retrieve the invoice settings for the payment page.
void	setApiClient(ApiClient apiClient)
InvoicingV2InvoiceSettingsGet200Response	updateInvoiceSettings(InvoiceSettingsRequest invoiceSettingsRequest, String productType)	Update Invoice Settings Allows you to customize the payment page, the checkout experience, email communication and payer authentication.
okhttp3.Call	updateInvoiceSettingsAsync(InvoiceSettingsRequest invoiceSettingsRequest, String productType, ApiCallback<InvoicingV2InvoiceSettingsGet200Response> callback)	Update Invoice Settings (asynchronously) Allows you to customize the payment page, the checkout experience, email communication and payer authentication.
okhttp3.Call	updateInvoiceSettingsCall(InvoiceSettingsRequest invoiceSettingsRequest, String productType, ProgressResponseBody.ProgressListener progressListener, ProgressRequestBody.ProgressRequestListener progressRequestListener)	Build call for updateInvoiceSettings
ApiResponse<InvoicingV2InvoiceSettingsGet200Response>	updateInvoiceSettingsWithHttpInfo(InvoiceSettingsRequest invoiceSettingsRequest, String productType)	Update Invoice Settings Allows you to customize the payment page, the checkout experience, email communication and payer authentication.

Methods inherited from class java.lang.Object

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

Constructor Detail

InvoiceSettingsApi

public InvoiceSettingsApi()

InvoiceSettingsApi

public InvoiceSettingsApi(ApiClient apiClient)

Method Detail

getApiClient

public ApiClient getApiClient()

setApiClient

public void setApiClient(ApiClient apiClient)

getInvoiceSettingsCall

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

Build call for getInvoiceSettings

Parameters:

productType - Allows you to choose which product type settings you want to update. (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

getInvoiceSettings

public InvoicingV2InvoiceSettingsGet200Response getInvoiceSettings(String productType)
                                                            throws ApiException,
                                                                   com.cybersource.authsdk.core.ConfigException

Get Invoice Settings Allows you to retrieve the invoice settings for the payment page.

Parameters:

productType - Allows you to choose which product type settings you want to update. (optional)

Returns:

InvoicingV2InvoiceSettingsGet200Response

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

getInvoiceSettingsWithHttpInfo

public ApiResponse<InvoicingV2InvoiceSettingsGet200Response> getInvoiceSettingsWithHttpInfo(String productType)
                                                                                     throws ApiException,
                                                                                            com.cybersource.authsdk.core.ConfigException

Get Invoice Settings Allows you to retrieve the invoice settings for the payment page.

Parameters:

productType - Allows you to choose which product type settings you want to update. (optional)

Returns:

ApiResponse<InvoicingV2InvoiceSettingsGet200Response>

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

getInvoiceSettingsAsync

public okhttp3.Call getInvoiceSettingsAsync(String productType,
                                            ApiCallback<InvoicingV2InvoiceSettingsGet200Response> callback)
                                     throws ApiException,
                                            com.cybersource.authsdk.core.ConfigException

Get Invoice Settings (asynchronously) Allows you to retrieve the invoice settings for the payment page.

Parameters:

productType - Allows you to choose which product type settings you want to update. (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

updateInvoiceSettingsCall

public okhttp3.Call updateInvoiceSettingsCall(InvoiceSettingsRequest invoiceSettingsRequest,
                                              String productType,
                                              ProgressResponseBody.ProgressListener progressListener,
                                              ProgressRequestBody.ProgressRequestListener progressRequestListener)
                                       throws ApiException,
                                              com.cybersource.authsdk.core.ConfigException

Build call for updateInvoiceSettings

Parameters:

invoiceSettingsRequest - (required)

productType - Allows you to choose which product type settings you want to update. (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

updateInvoiceSettings

public InvoicingV2InvoiceSettingsGet200Response updateInvoiceSettings(InvoiceSettingsRequest invoiceSettingsRequest,
                                                                      String productType)
                                                               throws ApiException,
                                                                      com.cybersource.authsdk.core.ConfigException

Update Invoice Settings Allows you to customize the payment page, the checkout experience, email communication and payer authentication. You can customize the invoice to match your brand with your business name, logo and brand colors, and a VAT Tax number. You can choose to capture the payers shipping details, phone number and email during the checkout process. You can add a custom message to all invoice emails and enable or disable payer authentication for invoice payments.

Parameters:

invoiceSettingsRequest - (required)

productType - Allows you to choose which product type settings you want to update. (optional)

Returns:

InvoicingV2InvoiceSettingsGet200Response

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

updateInvoiceSettingsWithHttpInfo

public ApiResponse<InvoicingV2InvoiceSettingsGet200Response> updateInvoiceSettingsWithHttpInfo(InvoiceSettingsRequest invoiceSettingsRequest,
                                                                                               String productType)
                                                                                        throws ApiException,
                                                                                               com.cybersource.authsdk.core.ConfigException

Update Invoice Settings Allows you to customize the payment page, the checkout experience, email communication and payer authentication. You can customize the invoice to match your brand with your business name, logo and brand colors, and a VAT Tax number. You can choose to capture the payers shipping details, phone number and email during the checkout process. You can add a custom message to all invoice emails and enable or disable payer authentication for invoice payments.

Parameters:

invoiceSettingsRequest - (required)

productType - Allows you to choose which product type settings you want to update. (optional)

Returns:

ApiResponse<InvoicingV2InvoiceSettingsGet200Response>

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

updateInvoiceSettingsAsync

public okhttp3.Call updateInvoiceSettingsAsync(InvoiceSettingsRequest invoiceSettingsRequest,
                                               String productType,
                                               ApiCallback<InvoicingV2InvoiceSettingsGet200Response> callback)
                                        throws ApiException,
                                               com.cybersource.authsdk.core.ConfigException

Update Invoice Settings (asynchronously) Allows you to customize the payment page, the checkout experience, email communication and payer authentication. You can customize the invoice to match your brand with your business name, logo and brand colors, and a VAT Tax number. You can choose to capture the payers shipping details, phone number and email during the checkout process. You can add a custom message to all invoice emails and enable or disable payer authentication for invoice payments.

Parameters:

invoiceSettingsRequest - (required)

productType - Allows you to choose which product type settings you want to update. (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