Package com.orbipay.paymentsapi.internal.api

Class PaymentSetupApi

java.lang.Object

com.orbipay.paymentsapi.internal.api.PaymentSetupApi

public class PaymentSetupApi
extends java.lang.Object

This class subject to change without prior notice, Please dont use this class directly.

Constructor Summary

Constructors

Constructor	Description
PaymentSetupApi(ApiClient apiClient)

Method Summary

Modifier and Type	Method	Description
ApiResponse<PaymentSetupResponse>	createRecurringPaymentSetup(java.lang.String channel, java.lang.String clientKey, java.lang.String product, java.lang.String timestamp, java.lang.String idempotentRequestKey, java.lang.String requestorType, java.lang.String ID_CUSTOMER, CreatePaymentSetupRequest createPaymentSetupRequest, java.lang.String requestor, java.lang.String xOPAYHeaders, java.lang.String traceId)	Create Payment Setup The API is used to set up recurring payments to service a customer account.
com.squareup.okhttp.Call	createRecurringPaymentSetupAsync(java.lang.String channel, java.lang.String clientKey, java.lang.String product, java.lang.String timestamp, java.lang.String idempotentRequestKey, java.lang.String requestorType, java.lang.String ID_CUSTOMER, CreatePaymentSetupRequest createPaymentSetupRequest, java.lang.String requestor, java.lang.String xOPAYHeaders, java.lang.String traceId, ApiCallback<PaymentSetupResponse> callback)	Create Payment Setup (asynchronously) The API is used to set up recurring payments to service a customer account.
com.squareup.okhttp.Call	createRecurringPaymentSetupCall(java.lang.String channel, java.lang.String clientKey, java.lang.String product, java.lang.String timestamp, java.lang.String idempotentRequestKey, java.lang.String requestorType, java.lang.String ID_CUSTOMER, CreatePaymentSetupRequest createPaymentSetupRequest, java.lang.String requestor, java.lang.String xOPAYHeaders, java.lang.String traceId, ProgressResponseBody.ProgressListener progressListener, ProgressRequestBody.ProgressRequestListener progressRequestListener)	Build call for createRecurringPaymentSetup
ApiResponse<PaymentSetupResponse>	createRecurringPaymentSetupWithHttpInfo(java.lang.String channel, java.lang.String clientKey, java.lang.String product, java.lang.String timestamp, java.lang.String idempotentRequestKey, java.lang.String requestorType, java.lang.String ID_CUSTOMER, CreatePaymentSetupRequest createPaymentSetupRequest, java.lang.String requestor, java.lang.String xOPAYHeaders, java.lang.String traceId)	Create Payment Setup The API is used to set up recurring payments to service a customer account.
ApiResponse<DeleteResponse>	deletePaymentSetup(java.lang.String channel, java.lang.String clientKey, java.lang.String product, java.lang.String timestamp, java.lang.String idempotentRequestKey, java.lang.String requestorType, java.lang.String ID_PAYMENT_SETUP, java.lang.String ID_CUSTOMER, DeletePaymentSetupRequest deletePaymentSetupRequest, java.lang.String requestor, java.lang.String xOPAYHeaders, java.lang.String traceId)	Delete Payment Setup The API is used to delete or cancel a recurring payment setup.
com.squareup.okhttp.Call	deletePaymentSetupAsync(java.lang.String channel, java.lang.String clientKey, java.lang.String product, java.lang.String timestamp, java.lang.String idempotentRequestKey, java.lang.String requestorType, java.lang.String ID_PAYMENT_SETUP, java.lang.String ID_CUSTOMER, DeletePaymentSetupRequest deletePaymentSetupRequest, java.lang.String requestor, java.lang.String xOPAYHeaders, java.lang.String traceId, ApiCallback<DeleteResponse> callback)	Delete Payment Setup (asynchronously) The API is used to delete or cancel a recurring payment setup.
com.squareup.okhttp.Call	deletePaymentSetupCall(java.lang.String channel, java.lang.String clientKey, java.lang.String product, java.lang.String timestamp, java.lang.String idempotentRequestKey, java.lang.String requestorType, java.lang.String ID_PAYMENT_SETUP, java.lang.String ID_CUSTOMER, DeletePaymentSetupRequest deletePaymentSetupRequest, java.lang.String requestor, java.lang.String xOPAYHeaders, java.lang.String traceId, ProgressResponseBody.ProgressListener progressListener, ProgressRequestBody.ProgressRequestListener progressRequestListener)	Build call for deletePaymentSetup
ApiResponse<DeleteResponse>	deletePaymentSetupWithHttpInfo(java.lang.String channel, java.lang.String clientKey, java.lang.String product, java.lang.String timestamp, java.lang.String idempotentRequestKey, java.lang.String requestorType, java.lang.String ID_PAYMENT_SETUP, java.lang.String ID_CUSTOMER, DeletePaymentSetupRequest deletePaymentSetupRequest, java.lang.String requestor, java.lang.String xOPAYHeaders, java.lang.String traceId)	Delete Payment Setup The API is used to delete or cancel a recurring payment setup.
ApiClient	getApiClient()
ApiResponse<PaymentSetupResponse>	getPaymentSetup(java.lang.String channel, java.lang.String clientKey, java.lang.String product, java.lang.String timestamp, java.lang.String idempotentRequestKey, java.lang.String requestorType, java.lang.String ID_PAYMENT_SETUP, java.lang.String ID_CUSTOMER, java.lang.String requestor, java.lang.String xOPAYHeaders, java.lang.String traceId)	Get Payment Setup The API is used to retrieve the details of a recurring payment setup by id.
com.squareup.okhttp.Call	getPaymentSetupAsync(java.lang.String channel, java.lang.String clientKey, java.lang.String product, java.lang.String timestamp, java.lang.String idempotentRequestKey, java.lang.String requestorType, java.lang.String ID_PAYMENT_SETUP, java.lang.String ID_CUSTOMER, java.lang.String requestor, java.lang.String xOPAYHeaders, java.lang.String traceId, ApiCallback<PaymentSetupResponse> callback)	Get Payment Setup (asynchronously) The API is used to retrieve the details of a recurring payment setup by id.
com.squareup.okhttp.Call	getPaymentSetupCall(java.lang.String channel, java.lang.String clientKey, java.lang.String product, java.lang.String timestamp, java.lang.String idempotentRequestKey, java.lang.String requestorType, java.lang.String ID_PAYMENT_SETUP, java.lang.String ID_CUSTOMER, java.lang.String requestor, java.lang.String xOPAYHeaders, java.lang.String traceId, ProgressResponseBody.ProgressListener progressListener, ProgressRequestBody.ProgressRequestListener progressRequestListener)	Build call for getPaymentSetup
ApiResponse<PaymentSetupResponse>	getPaymentSetupWithHttpInfo(java.lang.String channel, java.lang.String clientKey, java.lang.String product, java.lang.String timestamp, java.lang.String idempotentRequestKey, java.lang.String requestorType, java.lang.String ID_PAYMENT_SETUP, java.lang.String ID_CUSTOMER, java.lang.String requestor, java.lang.String xOPAYHeaders, java.lang.String traceId)	Get Payment Setup The API is used to retrieve the details of a recurring payment setup by id.
ApiResponse<PaymentSetupsResponse>	retrievePaymentSetups(java.lang.String channel, java.lang.String clientKey, java.lang.String product, java.lang.String timestamp, java.lang.String idempotentRequestKey, java.lang.String requestorType, java.lang.String requestor, java.lang.String xOPAYHeaders, java.lang.String traceId, java.lang.String idCustomer, java.lang.String idFundingAccount, java.lang.String idCustomerAccount, java.lang.String confirmationNumber, java.util.List<java.lang.String> status, java.util.List<java.lang.String> paymentSetupScheduleType, java.lang.String fromDate, java.lang.String toDate, java.lang.String pageSize, java.lang.String queryId, java.lang.String fromIndex, java.lang.String toIndex)	Retrieve Payment Setups The API is used to retrieve the recurring and autopay payments setup made against a customer account.
com.squareup.okhttp.Call	retrievePaymentSetupsAsync(java.lang.String channel, java.lang.String clientKey, java.lang.String product, java.lang.String timestamp, java.lang.String idempotentRequestKey, java.lang.String requestorType, java.lang.String requestor, java.lang.String xOPAYHeaders, java.lang.String traceId, java.lang.String idCustomer, java.lang.String idFundingAccount, java.lang.String idCustomerAccount, java.lang.String confirmationNumber, java.util.List<java.lang.String> status, java.util.List<java.lang.String> paymentSetupScheduleType, java.lang.String fromDate, java.lang.String toDate, java.lang.String pageSize, java.lang.String queryId, java.lang.String fromIndex, java.lang.String toIndex, ApiCallback<PaymentSetupsResponse> callback)	Retrieve Payment Setups (asynchronously) The API is used to retrieve the recurring and autopay payments setup made against a customer account.
com.squareup.okhttp.Call	retrievePaymentSetupsCall(java.lang.String channel, java.lang.String clientKey, java.lang.String product, java.lang.String timestamp, java.lang.String idempotentRequestKey, java.lang.String requestorType, java.lang.String requestor, java.lang.String xOPAYHeaders, java.lang.String traceId, java.lang.String idCustomer, java.lang.String idFundingAccount, java.lang.String idCustomerAccount, java.lang.String confirmationNumber, java.util.List<java.lang.String> status, java.util.List<java.lang.String> paymentSetupScheduleType, java.lang.String fromDate, java.lang.String toDate, java.lang.String pageSize, java.lang.String queryId, java.lang.String fromIndex, java.lang.String toIndex, ProgressResponseBody.ProgressListener progressListener, ProgressRequestBody.ProgressRequestListener progressRequestListener)	Build call for retrievePaymentSetups
ApiResponse<PaymentSetupsResponse>	retrievePaymentSetupsWithHttpInfo(java.lang.String channel, java.lang.String clientKey, java.lang.String product, java.lang.String timestamp, java.lang.String idempotentRequestKey, java.lang.String requestorType, java.lang.String requestor, java.lang.String xOPAYHeaders, java.lang.String traceId, java.lang.String idCustomer, java.lang.String idFundingAccount, java.lang.String idCustomerAccount, java.lang.String confirmationNumber, java.util.List<java.lang.String> status, java.util.List<java.lang.String> paymentSetupScheduleType, java.lang.String fromDate, java.lang.String toDate, java.lang.String pageSize, java.lang.String queryId, java.lang.String fromIndex, java.lang.String toIndex)	Retrieve Payment Setups The API is used to retrieve the recurring and autopay payments setup made against a customer account.
void	setApiClient(ApiClient apiClient)
ApiResponse<PaymentSetupResponse>	updatePaymentSetup(java.lang.String channel, java.lang.String clientKey, java.lang.String product, java.lang.String timestamp, java.lang.String idempotentRequestKey, java.lang.String requestorType, java.lang.String ID_PAYMENT_SETUP, java.lang.String ID_CUSTOMER, UpdatePaymentSetupRequest updatePaymentSetupRequest, java.lang.String requestor, java.lang.String xOPAYHeaders, java.lang.String traceId)	Update Payment Setup The API is used to edit a payment Setup.
com.squareup.okhttp.Call	updatePaymentSetupAsync(java.lang.String channel, java.lang.String clientKey, java.lang.String product, java.lang.String timestamp, java.lang.String idempotentRequestKey, java.lang.String requestorType, java.lang.String ID_PAYMENT_SETUP, java.lang.String ID_CUSTOMER, UpdatePaymentSetupRequest updatePaymentSetupRequest, java.lang.String requestor, java.lang.String xOPAYHeaders, java.lang.String traceId, ApiCallback<PaymentSetupResponse> callback)	Update Payment Setup (asynchronously) The API is used to edit a payment Setup.
com.squareup.okhttp.Call	updatePaymentSetupCall(java.lang.String channel, java.lang.String clientKey, java.lang.String product, java.lang.String timestamp, java.lang.String idempotentRequestKey, java.lang.String requestorType, java.lang.String ID_PAYMENT_SETUP, java.lang.String ID_CUSTOMER, UpdatePaymentSetupRequest updatePaymentSetupRequest, java.lang.String requestor, java.lang.String xOPAYHeaders, java.lang.String traceId, ProgressResponseBody.ProgressListener progressListener, ProgressRequestBody.ProgressRequestListener progressRequestListener)	Build call for updatePaymentSetup
ApiResponse<PaymentSetupResponse>	updatePaymentSetupWithHttpInfo(java.lang.String channel, java.lang.String clientKey, java.lang.String product, java.lang.String timestamp, java.lang.String idempotentRequestKey, java.lang.String requestorType, java.lang.String ID_PAYMENT_SETUP, java.lang.String ID_CUSTOMER, UpdatePaymentSetupRequest updatePaymentSetupRequest, java.lang.String requestor, java.lang.String xOPAYHeaders, java.lang.String traceId)	Update Payment Setup The API is used to edit a payment Setup.

Methods inherited from class java.lang.Object

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

Constructor Detail

PaymentSetupApi

public PaymentSetupApi(ApiClient apiClient)

Method Detail

getApiClient

public ApiClient getApiClient()

setApiClient

public void setApiClient(ApiClient apiClient)

createRecurringPaymentSetupCall

public com.squareup.okhttp.Call createRecurringPaymentSetupCall(java.lang.String channel,
                                                                java.lang.String clientKey,
                                                                java.lang.String product,
                                                                java.lang.String timestamp,
                                                                java.lang.String idempotentRequestKey,
                                                                java.lang.String requestorType,
                                                                java.lang.String ID_CUSTOMER,
                                                                CreatePaymentSetupRequest createPaymentSetupRequest,
                                                                java.lang.String requestor,
                                                                java.lang.String xOPAYHeaders,
                                                                java.lang.String traceId,
                                                                ProgressResponseBody.ProgressListener progressListener,
                                                                ProgressRequestBody.ProgressRequestListener progressRequestListener)
                                                         throws ApiException

Build call for createRecurringPaymentSetup

Parameters:

channel - The channel through which the API is invoked. (required)

clientKey - The unique identifier assigned by EBPP to the client. (required)

product - The product identifier corresponding to the API. (required)

timestamp - The timestamp for the moment when the API request is created. (required)

idempotentRequestKey - The unique token that clients can generate and maintain in order to identify an API request. (required)

requestorType - Type of the requestor of the API. (required)

ID_CUSTOMER - The unique identifier assigned by EBPP to the customer. (required)

createPaymentSetupRequest - JSON containing all the fields required to create a recurring payment setup. (required)

requestor - The identifier for the requestor of the API. (optional)

xOPAYHeaders - Intended for the future use. (optional)

traceId - The unique reference that can be used for tracing and debugging an API call. (optional)

progressListener - Progress listener

progressRequestListener - Progress request listener

Returns:

Call to execute

Throws:

ApiException - If fail to serialize the request body object

createRecurringPaymentSetup

public ApiResponse<PaymentSetupResponse> createRecurringPaymentSetup(java.lang.String channel,
                                                                     java.lang.String clientKey,
                                                                     java.lang.String product,
                                                                     java.lang.String timestamp,
                                                                     java.lang.String idempotentRequestKey,
                                                                     java.lang.String requestorType,
                                                                     java.lang.String ID_CUSTOMER,
                                                                     CreatePaymentSetupRequest createPaymentSetupRequest,
                                                                     java.lang.String requestor,
                                                                     java.lang.String xOPAYHeaders,
                                                                     java.lang.String traceId)
                                                              throws ApiException

Create Payment Setup The API is used to set up recurring payments to service a customer account.

Parameters:

channel - The channel through which the API is invoked. (required)

clientKey - The unique identifier assigned by EBPP to the client. (required)

product - The product identifier corresponding to the API. (required)

timestamp - The timestamp for the moment when the API request is created. (required)

idempotentRequestKey - The unique token that clients can generate and maintain in order to identify an API request. (required)

requestorType - Type of the requestor of the API. (required)

ID_CUSTOMER - The unique identifier assigned by EBPP to the customer. (required)

createPaymentSetupRequest - JSON containing all the fields required to create a recurring payment setup. (required)

requestor - The identifier for the requestor of the API. (optional)

xOPAYHeaders - Intended for the future use. (optional)

traceId - The unique reference that can be used for tracing and debugging an API call. (optional)

Returns:

PaymentSetupResponse

Throws:

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

createRecurringPaymentSetupWithHttpInfo

public ApiResponse<PaymentSetupResponse> createRecurringPaymentSetupWithHttpInfo(java.lang.String channel,
                                                                                 java.lang.String clientKey,
                                                                                 java.lang.String product,
                                                                                 java.lang.String timestamp,
                                                                                 java.lang.String idempotentRequestKey,
                                                                                 java.lang.String requestorType,
                                                                                 java.lang.String ID_CUSTOMER,
                                                                                 CreatePaymentSetupRequest createPaymentSetupRequest,
                                                                                 java.lang.String requestor,
                                                                                 java.lang.String xOPAYHeaders,
                                                                                 java.lang.String traceId)
                                                                          throws ApiException

Create Payment Setup The API is used to set up recurring payments to service a customer account.

Parameters:

channel - The channel through which the API is invoked. (required)

clientKey - The unique identifier assigned by EBPP to the client. (required)

product - The product identifier corresponding to the API. (required)

timestamp - The timestamp for the moment when the API request is created. (required)

idempotentRequestKey - The unique token that clients can generate and maintain in order to identify an API request. (required)

requestorType - Type of the requestor of the API. (required)

ID_CUSTOMER - The unique identifier assigned by EBPP to the customer. (required)

createPaymentSetupRequest - JSON containing all the fields required to create a recurring payment setup. (required)

requestor - The identifier for the requestor of the API. (optional)

xOPAYHeaders - Intended for the future use. (optional)

traceId - The unique reference that can be used for tracing and debugging an API call. (optional)

Returns:

ApiResponse<PaymentSetupResponse>

Throws:

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

createRecurringPaymentSetupAsync

public com.squareup.okhttp.Call createRecurringPaymentSetupAsync(java.lang.String channel,
                                                                 java.lang.String clientKey,
                                                                 java.lang.String product,
                                                                 java.lang.String timestamp,
                                                                 java.lang.String idempotentRequestKey,
                                                                 java.lang.String requestorType,
                                                                 java.lang.String ID_CUSTOMER,
                                                                 CreatePaymentSetupRequest createPaymentSetupRequest,
                                                                 java.lang.String requestor,
                                                                 java.lang.String xOPAYHeaders,
                                                                 java.lang.String traceId,
                                                                 ApiCallback<PaymentSetupResponse> callback)
                                                          throws ApiException

Create Payment Setup (asynchronously) The API is used to set up recurring payments to service a customer account.

Parameters:

channel - The channel through which the API is invoked. (required)

clientKey - The unique identifier assigned by EBPP to the client. (required)

product - The product identifier corresponding to the API. (required)

timestamp - The timestamp for the moment when the API request is created. (required)

idempotentRequestKey - The unique token that clients can generate and maintain in order to identify an API request. (required)

requestorType - Type of the requestor of the API. (required)

ID_CUSTOMER - The unique identifier assigned by EBPP to the customer. (required)

createPaymentSetupRequest - JSON containing all the fields required to create a recurring payment setup. (required)

requestor - The identifier for the requestor of the API. (optional)

xOPAYHeaders - Intended for the future use. (optional)

traceId - The unique reference that can be used for tracing and debugging an API call. (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

deletePaymentSetupCall

public com.squareup.okhttp.Call deletePaymentSetupCall(java.lang.String channel,
                                                       java.lang.String clientKey,
                                                       java.lang.String product,
                                                       java.lang.String timestamp,
                                                       java.lang.String idempotentRequestKey,
                                                       java.lang.String requestorType,
                                                       java.lang.String ID_PAYMENT_SETUP,
                                                       java.lang.String ID_CUSTOMER,
                                                       DeletePaymentSetupRequest deletePaymentSetupRequest,
                                                       java.lang.String requestor,
                                                       java.lang.String xOPAYHeaders,
                                                       java.lang.String traceId,
                                                       ProgressResponseBody.ProgressListener progressListener,
                                                       ProgressRequestBody.ProgressRequestListener progressRequestListener)
                                                throws ApiException

Build call for deletePaymentSetup

Parameters:

channel - The channel through which the API is invoked. (required)

clientKey - The unique identifier assigned by EBPP to the client. (required)

product - The product identifier corresponding to the API. (required)

timestamp - The timestamp for the moment when the API request is created. (required)

idempotentRequestKey - The unique token that clients can generate and maintain in order to identify an API request. (required)

requestorType - Type of the requestor of the API. (required)

ID_PAYMENT_SETUP - The unique identifier assigned by EBPP to the payment setup. (required)

ID_CUSTOMER - The unique identifier assigned by EBPP to the customer. (required)

deletePaymentSetupRequest - JSON containing all the fields required to delete a payment. Setup. (required)

requestor - The identifier for the requestor of the API. (optional)

xOPAYHeaders - Intended for the future use. (optional)

traceId - The unique reference that can be used for tracing and debugging an API call. (optional)

progressListener - Progress listener

progressRequestListener - Progress request listener

Returns:

Call to execute

Throws:

ApiException - If fail to serialize the request body object

deletePaymentSetup

public ApiResponse<DeleteResponse> deletePaymentSetup(java.lang.String channel,
                                                      java.lang.String clientKey,
                                                      java.lang.String product,
                                                      java.lang.String timestamp,
                                                      java.lang.String idempotentRequestKey,
                                                      java.lang.String requestorType,
                                                      java.lang.String ID_PAYMENT_SETUP,
                                                      java.lang.String ID_CUSTOMER,
                                                      DeletePaymentSetupRequest deletePaymentSetupRequest,
                                                      java.lang.String requestor,
                                                      java.lang.String xOPAYHeaders,
                                                      java.lang.String traceId)
                                               throws ApiException

Delete Payment Setup The API is used to delete or cancel a recurring payment setup. Cancelling a payment setup will also cancel all the pending and future payments under the setup.

Parameters:

channel - The channel through which the API is invoked. (required)

clientKey - The unique identifier assigned by EBPP to the client. (required)

product - The product identifier corresponding to the API. (required)

timestamp - The timestamp for the moment when the API request is created. (required)

idempotentRequestKey - The unique token that clients can generate and maintain in order to identify an API request. (required)

requestorType - Type of the requestor of the API. (required)

ID_PAYMENT_SETUP - The unique identifier assigned by EBPP to the payment setup. (required)

ID_CUSTOMER - The unique identifier assigned by EBPP to the customer. (required)

deletePaymentSetupRequest - JSON containing all the fields required to delete a payment. Setup. (required)

requestor - The identifier for the requestor of the API. (optional)

xOPAYHeaders - Intended for the future use. (optional)

traceId - The unique reference that can be used for tracing and debugging an API call. (optional)

Returns:

DeleteResponse

Throws:

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

deletePaymentSetupWithHttpInfo

public ApiResponse<DeleteResponse> deletePaymentSetupWithHttpInfo(java.lang.String channel,
                                                                  java.lang.String clientKey,
                                                                  java.lang.String product,
                                                                  java.lang.String timestamp,
                                                                  java.lang.String idempotentRequestKey,
                                                                  java.lang.String requestorType,
                                                                  java.lang.String ID_PAYMENT_SETUP,
                                                                  java.lang.String ID_CUSTOMER,
                                                                  DeletePaymentSetupRequest deletePaymentSetupRequest,
                                                                  java.lang.String requestor,
                                                                  java.lang.String xOPAYHeaders,
                                                                  java.lang.String traceId)
                                                           throws ApiException

Delete Payment Setup The API is used to delete or cancel a recurring payment setup. Cancelling a payment setup will also cancel all the pending and future payments under the setup.

Parameters:

channel - The channel through which the API is invoked. (required)

clientKey - The unique identifier assigned by EBPP to the client. (required)

product - The product identifier corresponding to the API. (required)

timestamp - The timestamp for the moment when the API request is created. (required)

idempotentRequestKey - The unique token that clients can generate and maintain in order to identify an API request. (required)

requestorType - Type of the requestor of the API. (required)

ID_PAYMENT_SETUP - The unique identifier assigned by EBPP to the payment setup. (required)

ID_CUSTOMER - The unique identifier assigned by EBPP to the customer. (required)

deletePaymentSetupRequest - JSON containing all the fields required to delete a payment. Setup. (required)

requestor - The identifier for the requestor of the API. (optional)

xOPAYHeaders - Intended for the future use. (optional)

traceId - The unique reference that can be used for tracing and debugging an API call. (optional)

Returns:

ApiResponse<DeleteResponse>

Throws:

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

deletePaymentSetupAsync

public com.squareup.okhttp.Call deletePaymentSetupAsync(java.lang.String channel,
                                                        java.lang.String clientKey,
                                                        java.lang.String product,
                                                        java.lang.String timestamp,
                                                        java.lang.String idempotentRequestKey,
                                                        java.lang.String requestorType,
                                                        java.lang.String ID_PAYMENT_SETUP,
                                                        java.lang.String ID_CUSTOMER,
                                                        DeletePaymentSetupRequest deletePaymentSetupRequest,
                                                        java.lang.String requestor,
                                                        java.lang.String xOPAYHeaders,
                                                        java.lang.String traceId,
                                                        ApiCallback<DeleteResponse> callback)
                                                 throws ApiException

Delete Payment Setup (asynchronously) The API is used to delete or cancel a recurring payment setup. Cancelling a payment setup will also cancel all the pending and future payments under the setup.

Parameters:

channel - The channel through which the API is invoked. (required)

clientKey - The unique identifier assigned by EBPP to the client. (required)

product - The product identifier corresponding to the API. (required)

timestamp - The timestamp for the moment when the API request is created. (required)

idempotentRequestKey - The unique token that clients can generate and maintain in order to identify an API request. (required)

requestorType - Type of the requestor of the API. (required)

ID_PAYMENT_SETUP - The unique identifier assigned by EBPP to the payment setup. (required)

ID_CUSTOMER - The unique identifier assigned by EBPP to the customer. (required)

deletePaymentSetupRequest - JSON containing all the fields required to delete a payment. Setup. (required)

requestor - The identifier for the requestor of the API. (optional)

xOPAYHeaders - Intended for the future use. (optional)

traceId - The unique reference that can be used for tracing and debugging an API call. (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

getPaymentSetupCall

public com.squareup.okhttp.Call getPaymentSetupCall(java.lang.String channel,
                                                    java.lang.String clientKey,
                                                    java.lang.String product,
                                                    java.lang.String timestamp,
                                                    java.lang.String idempotentRequestKey,
                                                    java.lang.String requestorType,
                                                    java.lang.String ID_PAYMENT_SETUP,
                                                    java.lang.String ID_CUSTOMER,
                                                    java.lang.String requestor,
                                                    java.lang.String xOPAYHeaders,
                                                    java.lang.String traceId,
                                                    ProgressResponseBody.ProgressListener progressListener,
                                                    ProgressRequestBody.ProgressRequestListener progressRequestListener)
                                             throws ApiException

Build call for getPaymentSetup

Parameters:

channel - The channel through which the API is invoked. (required)

clientKey - The unique identifier assigned by EBPP to the client. (required)

product - The product identifier corresponding to the API. (required)

timestamp - The timestamp for the moment when the API request is created. (required)

idempotentRequestKey - The unique token that clients can generate and maintain in order to identify an API request. (required)

requestorType - Type of the requestor of the API. (required)

ID_PAYMENT_SETUP - The unique identifier assigned by EBPP to the payment setup. (required)

ID_CUSTOMER - The unique identifier assigned by EBPP to the customer. (required)

requestor - The identifier for the requestor of the API. (optional)

xOPAYHeaders - Intended for the future use. (optional)

traceId - The unique reference that can be used for tracing and debugging an API call. (optional)

progressListener - Progress listener

progressRequestListener - Progress request listener

Returns:

Call to execute

Throws:

ApiException - If fail to serialize the request body object

getPaymentSetup

public ApiResponse<PaymentSetupResponse> getPaymentSetup(java.lang.String channel,
                                                         java.lang.String clientKey,
                                                         java.lang.String product,
                                                         java.lang.String timestamp,
                                                         java.lang.String idempotentRequestKey,
                                                         java.lang.String requestorType,
                                                         java.lang.String ID_PAYMENT_SETUP,
                                                         java.lang.String ID_CUSTOMER,
                                                         java.lang.String requestor,
                                                         java.lang.String xOPAYHeaders,
                                                         java.lang.String traceId)
                                                  throws ApiException

Get Payment Setup The API is used to retrieve the details of a recurring payment setup by id.

Parameters:

channel - The channel through which the API is invoked. (required)

clientKey - The unique identifier assigned by EBPP to the client. (required)

product - The product identifier corresponding to the API. (required)

timestamp - The timestamp for the moment when the API request is created. (required)

idempotentRequestKey - The unique token that clients can generate and maintain in order to identify an API request. (required)

requestorType - Type of the requestor of the API. (required)

ID_PAYMENT_SETUP - The unique identifier assigned by EBPP to the payment setup. (required)

ID_CUSTOMER - The unique identifier assigned by EBPP to the customer. (required)

requestor - The identifier for the requestor of the API. (optional)

xOPAYHeaders - Intended for the future use. (optional)

traceId - The unique reference that can be used for tracing and debugging an API call. (optional)

Returns:

PaymentSetupResponse

Throws:

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

getPaymentSetupWithHttpInfo

public ApiResponse<PaymentSetupResponse> getPaymentSetupWithHttpInfo(java.lang.String channel,
                                                                     java.lang.String clientKey,
                                                                     java.lang.String product,
                                                                     java.lang.String timestamp,
                                                                     java.lang.String idempotentRequestKey,
                                                                     java.lang.String requestorType,
                                                                     java.lang.String ID_PAYMENT_SETUP,
                                                                     java.lang.String ID_CUSTOMER,
                                                                     java.lang.String requestor,
                                                                     java.lang.String xOPAYHeaders,
                                                                     java.lang.String traceId)
                                                              throws ApiException

Get Payment Setup The API is used to retrieve the details of a recurring payment setup by id.

Parameters:

channel - The channel through which the API is invoked. (required)

clientKey - The unique identifier assigned by EBPP to the client. (required)

product - The product identifier corresponding to the API. (required)

timestamp - The timestamp for the moment when the API request is created. (required)

idempotentRequestKey - The unique token that clients can generate and maintain in order to identify an API request. (required)

requestorType - Type of the requestor of the API. (required)

ID_PAYMENT_SETUP - The unique identifier assigned by EBPP to the payment setup. (required)

ID_CUSTOMER - The unique identifier assigned by EBPP to the customer. (required)

requestor - The identifier for the requestor of the API. (optional)

xOPAYHeaders - Intended for the future use. (optional)

traceId - The unique reference that can be used for tracing and debugging an API call. (optional)

Returns:

ApiResponse<PaymentSetupResponse>

Throws:

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

getPaymentSetupAsync

public com.squareup.okhttp.Call getPaymentSetupAsync(java.lang.String channel,
                                                     java.lang.String clientKey,
                                                     java.lang.String product,
                                                     java.lang.String timestamp,
                                                     java.lang.String idempotentRequestKey,
                                                     java.lang.String requestorType,
                                                     java.lang.String ID_PAYMENT_SETUP,
                                                     java.lang.String ID_CUSTOMER,
                                                     java.lang.String requestor,
                                                     java.lang.String xOPAYHeaders,
                                                     java.lang.String traceId,
                                                     ApiCallback<PaymentSetupResponse> callback)
                                              throws ApiException

Get Payment Setup (asynchronously) The API is used to retrieve the details of a recurring payment setup by id.

Parameters:

channel - The channel through which the API is invoked. (required)

clientKey - The unique identifier assigned by EBPP to the client. (required)

product - The product identifier corresponding to the API. (required)

timestamp - The timestamp for the moment when the API request is created. (required)

idempotentRequestKey - The unique token that clients can generate and maintain in order to identify an API request. (required)

requestorType - Type of the requestor of the API. (required)

ID_PAYMENT_SETUP - The unique identifier assigned by EBPP to the payment setup. (required)

ID_CUSTOMER - The unique identifier assigned by EBPP to the customer. (required)

requestor - The identifier for the requestor of the API. (optional)

xOPAYHeaders - Intended for the future use. (optional)

traceId - The unique reference that can be used for tracing and debugging an API call. (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

retrievePaymentSetupsCall

public com.squareup.okhttp.Call retrievePaymentSetupsCall(java.lang.String channel,
                                                          java.lang.String clientKey,
                                                          java.lang.String product,
                                                          java.lang.String timestamp,
                                                          java.lang.String idempotentRequestKey,
                                                          java.lang.String requestorType,
                                                          java.lang.String requestor,
                                                          java.lang.String xOPAYHeaders,
                                                          java.lang.String traceId,
                                                          java.lang.String idCustomer,
                                                          java.lang.String idFundingAccount,
                                                          java.lang.String idCustomerAccount,
                                                          java.lang.String confirmationNumber,
                                                          java.util.List<java.lang.String> status,
                                                          java.util.List<java.lang.String> paymentSetupScheduleType,
                                                          java.lang.String fromDate,
                                                          java.lang.String toDate,
                                                          java.lang.String pageSize,
                                                          java.lang.String queryId,
                                                          java.lang.String fromIndex,
                                                          java.lang.String toIndex,
                                                          ProgressResponseBody.ProgressListener progressListener,
                                                          ProgressRequestBody.ProgressRequestListener progressRequestListener)
                                                   throws ApiException

Build call for retrievePaymentSetups

Parameters:

channel - The channel through which the API is invoked. (required)

clientKey - The unique identifier assigned by EBPP to the client. (required)

product - The product identifier corresponding to the API. (required)

timestamp - The timestamp for the moment when the API request is created. (required)

idempotentRequestKey - The unique token that clients can generate and maintain in order to identify an API request. (required)

requestorType - Type of the requestor of the API. (required)

requestor - The identifier for the requestor of the API. (optional)

xOPAYHeaders - Intended for the future use. (optional)

traceId - The unique reference that can be used for tracing and debugging an API call. (optional)

idCustomer - The unique identifier assigned by EBPP to the customer. (optional)

idFundingAccount - The unique identifier assigned by EBPP to the funding account (optional)

idCustomerAccount - The unique identifier assigned by EBPP to the customer account (optional)

confirmationNumber - The confirmation number or reference provided to the customer for the successful payment. (optional)

status - The status of the payment. This can take multiple values in the format key=value1&key=value2.... (optional)

paymentSetupScheduleType - The schedule type for the payment setup. This can take multiple values in the format key=value1&key=value2.... (optional)

fromDate - The date from which recurring payments setup, matching the criteria specified, need to be retrieved. (optional)

toDate - The date upto which recurring payments setup, matching the criteria specified, need to be retrieved. (optional)

pageSize - The maximum number of objects returned in the query. (optional)

queryId - query id of the Retrieve/Search Customers lookup. (optional)

fromIndex - To fetch the next set of objects that start after this object (optional)

toIndex - To fetch the previous set of objects that end at this object (optional)

progressListener - Progress listener

progressRequestListener - Progress request listener

Returns:

Call to execute

Throws:

ApiException - If fail to serialize the request body object

retrievePaymentSetups

public ApiResponse<PaymentSetupsResponse> retrievePaymentSetups(java.lang.String channel,
                                                                java.lang.String clientKey,
                                                                java.lang.String product,
                                                                java.lang.String timestamp,
                                                                java.lang.String idempotentRequestKey,
                                                                java.lang.String requestorType,
                                                                java.lang.String requestor,
                                                                java.lang.String xOPAYHeaders,
                                                                java.lang.String traceId,
                                                                java.lang.String idCustomer,
                                                                java.lang.String idFundingAccount,
                                                                java.lang.String idCustomerAccount,
                                                                java.lang.String confirmationNumber,
                                                                java.util.List<java.lang.String> status,
                                                                java.util.List<java.lang.String> paymentSetupScheduleType,
                                                                java.lang.String fromDate,
                                                                java.lang.String toDate,
                                                                java.lang.String pageSize,
                                                                java.lang.String queryId,
                                                                java.lang.String fromIndex,
                                                                java.lang.String toIndex)
                                                         throws ApiException

Retrieve Payment Setups The API is used to retrieve the recurring and autopay payments setup made against a customer account. The setup can be filtered using the confirmation number, customer account, funding account, status and payment setup schedule type, by date range and others mentioned below. If no dates are provided for retrieval, recurring payments set up in the last six months and all the ones in future are returned. The results are sorted in descending order of the payment_start_date followed by the last_modified_time.

Parameters:

channel - The channel through which the API is invoked. (required)

clientKey - The unique identifier assigned by EBPP to the client. (required)

product - The product identifier corresponding to the API. (required)

timestamp - The timestamp for the moment when the API request is created. (required)

idempotentRequestKey - The unique token that clients can generate and maintain in order to identify an API request. (required)

requestorType - Type of the requestor of the API. (required)

requestor - The identifier for the requestor of the API. (optional)

xOPAYHeaders - Intended for the future use. (optional)

traceId - The unique reference that can be used for tracing and debugging an API call. (optional)

idCustomer - The unique identifier assigned by EBPP to the customer. (optional)

idFundingAccount - The unique identifier assigned by EBPP to the funding account (optional)

idCustomerAccount - The unique identifier assigned by EBPP to the customer account (optional)

confirmationNumber - The confirmation number or reference provided to the customer for the successful payment. (optional)

status - The status of the payment. This can take multiple values in the format key=value1&key=value2.... (optional)

paymentSetupScheduleType - The schedule type for the payment setup. This can take multiple values in the format key=value1&key=value2.... (optional)

fromDate - The date from which recurring payments setup, matching the criteria specified, need to be retrieved. (optional)

toDate - The date upto which recurring payments setup, matching the criteria specified, need to be retrieved. (optional)

pageSize - The maximum number of objects returned in the query. (optional)

queryId - query id of the Retrieve/Search Customers lookup. (optional)

fromIndex - To fetch the next set of objects that start after this object (optional)

toIndex - To fetch the previous set of objects that end at this object (optional)

Returns:

PaymentSetupsResponse

Throws:

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

retrievePaymentSetupsWithHttpInfo

public ApiResponse<PaymentSetupsResponse> retrievePaymentSetupsWithHttpInfo(java.lang.String channel,
                                                                            java.lang.String clientKey,
                                                                            java.lang.String product,
                                                                            java.lang.String timestamp,
                                                                            java.lang.String idempotentRequestKey,
                                                                            java.lang.String requestorType,
                                                                            java.lang.String requestor,
                                                                            java.lang.String xOPAYHeaders,
                                                                            java.lang.String traceId,
                                                                            java.lang.String idCustomer,
                                                                            java.lang.String idFundingAccount,
                                                                            java.lang.String idCustomerAccount,
                                                                            java.lang.String confirmationNumber,
                                                                            java.util.List<java.lang.String> status,
                                                                            java.util.List<java.lang.String> paymentSetupScheduleType,
                                                                            java.lang.String fromDate,
                                                                            java.lang.String toDate,
                                                                            java.lang.String pageSize,
                                                                            java.lang.String queryId,
                                                                            java.lang.String fromIndex,
                                                                            java.lang.String toIndex)
                                                                     throws ApiException

Retrieve Payment Setups The API is used to retrieve the recurring and autopay payments setup made against a customer account. The setup can be filtered using the confirmation number, customer account, funding account, status and payment setup schedule type, by date range and others mentioned below. If no dates are provided for retrieval, recurring payments set up in the last six months and all the ones in future are returned. The results are sorted in descending order of the payment_start_date followed by the last_modified_time.

Parameters:

channel - The channel through which the API is invoked. (required)

clientKey - The unique identifier assigned by EBPP to the client. (required)

product - The product identifier corresponding to the API. (required)

timestamp - The timestamp for the moment when the API request is created. (required)

idempotentRequestKey - The unique token that clients can generate and maintain in order to identify an API request. (required)

requestorType - Type of the requestor of the API. (required)

requestor - The identifier for the requestor of the API. (optional)

xOPAYHeaders - Intended for the future use. (optional)

traceId - The unique reference that can be used for tracing and debugging an API call. (optional)

idCustomer - The unique identifier assigned by EBPP to the customer. (optional)

idFundingAccount - The unique identifier assigned by EBPP to the funding account (optional)

idCustomerAccount - The unique identifier assigned by EBPP to the customer account (optional)

confirmationNumber - The confirmation number or reference provided to the customer for the successful payment. (optional)

status - The status of the payment. This can take multiple values in the format key=value1&key=value2.... (optional)

paymentSetupScheduleType - The schedule type for the payment setup. This can take multiple values in the format key=value1&key=value2.... (optional)

fromDate - The date from which recurring payments setup, matching the criteria specified, need to be retrieved. (optional)

toDate - The date upto which recurring payments setup, matching the criteria specified, need to be retrieved. (optional)

pageSize - The maximum number of objects returned in the query. (optional)

queryId - query id of the Retrieve/Search Customers lookup. (optional)

fromIndex - To fetch the next set of objects that start after this object (optional)

toIndex - To fetch the previous set of objects that end at this object (optional)

Returns:

ApiResponse<PaymentSetupsResponse>

Throws:

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

retrievePaymentSetupsAsync

public com.squareup.okhttp.Call retrievePaymentSetupsAsync(java.lang.String channel,
                                                           java.lang.String clientKey,
                                                           java.lang.String product,
                                                           java.lang.String timestamp,
                                                           java.lang.String idempotentRequestKey,
                                                           java.lang.String requestorType,
                                                           java.lang.String requestor,
                                                           java.lang.String xOPAYHeaders,
                                                           java.lang.String traceId,
                                                           java.lang.String idCustomer,
                                                           java.lang.String idFundingAccount,
                                                           java.lang.String idCustomerAccount,
                                                           java.lang.String confirmationNumber,
                                                           java.util.List<java.lang.String> status,
                                                           java.util.List<java.lang.String> paymentSetupScheduleType,
                                                           java.lang.String fromDate,
                                                           java.lang.String toDate,
                                                           java.lang.String pageSize,
                                                           java.lang.String queryId,
                                                           java.lang.String fromIndex,
                                                           java.lang.String toIndex,
                                                           ApiCallback<PaymentSetupsResponse> callback)
                                                    throws ApiException

Retrieve Payment Setups (asynchronously) The API is used to retrieve the recurring and autopay payments setup made against a customer account. The setup can be filtered using the confirmation number, customer account, funding account, status and payment setup schedule type, by date range and others mentioned below. If no dates are provided for retrieval, recurring payments set up in the last six months and all the ones in future are returned. The results are sorted in descending order of the payment_start_date followed by the last_modified_time.

Parameters:

channel - The channel through which the API is invoked. (required)

clientKey - The unique identifier assigned by EBPP to the client. (required)

product - The product identifier corresponding to the API. (required)

timestamp - The timestamp for the moment when the API request is created. (required)

idempotentRequestKey - The unique token that clients can generate and maintain in order to identify an API request. (required)

requestorType - Type of the requestor of the API. (required)

requestor - The identifier for the requestor of the API. (optional)

xOPAYHeaders - Intended for the future use. (optional)

traceId - The unique reference that can be used for tracing and debugging an API call. (optional)

idCustomer - The unique identifier assigned by EBPP to the customer. (optional)

idFundingAccount - The unique identifier assigned by EBPP to the funding account (optional)

idCustomerAccount - The unique identifier assigned by EBPP to the customer account (optional)

confirmationNumber - The confirmation number or reference provided to the customer for the successful payment. (optional)

status - The status of the payment. This can take multiple values in the format key=value1&key=value2.... (optional)

paymentSetupScheduleType - The schedule type for the payment setup. This can take multiple values in the format key=value1&key=value2.... (optional)

fromDate - The date from which recurring payments setup, matching the criteria specified, need to be retrieved. (optional)

toDate - The date upto which recurring payments setup, matching the criteria specified, need to be retrieved. (optional)

pageSize - The maximum number of objects returned in the query. (optional)

queryId - query id of the Retrieve/Search Customers lookup. (optional)

fromIndex - To fetch the next set of objects that start after this object (optional)

toIndex - To fetch the previous set of objects that end at this object (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

updatePaymentSetupCall

public com.squareup.okhttp.Call updatePaymentSetupCall(java.lang.String channel,
                                                       java.lang.String clientKey,
                                                       java.lang.String product,
                                                       java.lang.String timestamp,
                                                       java.lang.String idempotentRequestKey,
                                                       java.lang.String requestorType,
                                                       java.lang.String ID_PAYMENT_SETUP,
                                                       java.lang.String ID_CUSTOMER,
                                                       UpdatePaymentSetupRequest updatePaymentSetupRequest,
                                                       java.lang.String requestor,
                                                       java.lang.String xOPAYHeaders,
                                                       java.lang.String traceId,
                                                       ProgressResponseBody.ProgressListener progressListener,
                                                       ProgressRequestBody.ProgressRequestListener progressRequestListener)
                                                throws ApiException

Build call for updatePaymentSetup

Parameters:

channel - The channel through which the API is invoked. (required)

clientKey - The unique identifier assigned by EBPP to the client. (required)

product - The product identifier corresponding to the API. (required)

timestamp - The timestamp for the moment when the API request is created. (required)

idempotentRequestKey - The unique token that clients can generate and maintain in order to identify an API request. (required)

requestorType - Type of the requestor of the API. (required)

ID_PAYMENT_SETUP - The unique identifier assigned by EBPP to the payment setup. (required)

ID_CUSTOMER - The unique identifier assigned by EBPP to the customer. (required)

updatePaymentSetupRequest - Details of the Payment Setup to be updated. (required)

requestor - The identifier for the requestor of the API. (optional)

xOPAYHeaders - Intended for the future use. (optional)

traceId - The unique reference that can be used for tracing and debugging an API call. (optional)

progressListener - Progress listener

progressRequestListener - Progress request listener

Returns:

Call to execute

Throws:

ApiException - If fail to serialize the request body object

updatePaymentSetup

public ApiResponse<PaymentSetupResponse> updatePaymentSetup(java.lang.String channel,
                                                            java.lang.String clientKey,
                                                            java.lang.String product,
                                                            java.lang.String timestamp,
                                                            java.lang.String idempotentRequestKey,
                                                            java.lang.String requestorType,
                                                            java.lang.String ID_PAYMENT_SETUP,
                                                            java.lang.String ID_CUSTOMER,
                                                            UpdatePaymentSetupRequest updatePaymentSetupRequest,
                                                            java.lang.String requestor,
                                                            java.lang.String xOPAYHeaders,
                                                            java.lang.String traceId)
                                                     throws ApiException

Update Payment Setup The API is used to edit a payment Setup. Only autopay payment setup is allowed to edit.

Parameters:

channel - The channel through which the API is invoked. (required)

clientKey - The unique identifier assigned by EBPP to the client. (required)

product - The product identifier corresponding to the API. (required)

timestamp - The timestamp for the moment when the API request is created. (required)

idempotentRequestKey - The unique token that clients can generate and maintain in order to identify an API request. (required)

requestorType - Type of the requestor of the API. (required)

ID_PAYMENT_SETUP - The unique identifier assigned by EBPP to the payment setup. (required)

ID_CUSTOMER - The unique identifier assigned by EBPP to the customer. (required)

updatePaymentSetupRequest - Details of the Payment Setup to be updated. (required)

requestor - The identifier for the requestor of the API. (optional)

xOPAYHeaders - Intended for the future use. (optional)

traceId - The unique reference that can be used for tracing and debugging an API call. (optional)

Returns:

PaymentSetupResponse

Throws:

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

updatePaymentSetupWithHttpInfo

public ApiResponse<PaymentSetupResponse> updatePaymentSetupWithHttpInfo(java.lang.String channel,
                                                                        java.lang.String clientKey,
                                                                        java.lang.String product,
                                                                        java.lang.String timestamp,
                                                                        java.lang.String idempotentRequestKey,
                                                                        java.lang.String requestorType,
                                                                        java.lang.String ID_PAYMENT_SETUP,
                                                                        java.lang.String ID_CUSTOMER,
                                                                        UpdatePaymentSetupRequest updatePaymentSetupRequest,
                                                                        java.lang.String requestor,
                                                                        java.lang.String xOPAYHeaders,
                                                                        java.lang.String traceId)
                                                                 throws ApiException

Update Payment Setup The API is used to edit a payment Setup. Only autopay payment setup is allowed to edit.

Parameters:

channel - The channel through which the API is invoked. (required)

clientKey - The unique identifier assigned by EBPP to the client. (required)

product - The product identifier corresponding to the API. (required)

timestamp - The timestamp for the moment when the API request is created. (required)

idempotentRequestKey - The unique token that clients can generate and maintain in order to identify an API request. (required)

requestorType - Type of the requestor of the API. (required)

ID_PAYMENT_SETUP - The unique identifier assigned by EBPP to the payment setup. (required)

ID_CUSTOMER - The unique identifier assigned by EBPP to the customer. (required)

updatePaymentSetupRequest - Details of the Payment Setup to be updated. (required)

requestor - The identifier for the requestor of the API. (optional)

xOPAYHeaders - Intended for the future use. (optional)

traceId - The unique reference that can be used for tracing and debugging an API call. (optional)

Returns:

ApiResponse<PaymentSetupResponse>

Throws:

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

updatePaymentSetupAsync

public com.squareup.okhttp.Call updatePaymentSetupAsync(java.lang.String channel,
                                                        java.lang.String clientKey,
                                                        java.lang.String product,
                                                        java.lang.String timestamp,
                                                        java.lang.String idempotentRequestKey,
                                                        java.lang.String requestorType,
                                                        java.lang.String ID_PAYMENT_SETUP,
                                                        java.lang.String ID_CUSTOMER,
                                                        UpdatePaymentSetupRequest updatePaymentSetupRequest,
                                                        java.lang.String requestor,
                                                        java.lang.String xOPAYHeaders,
                                                        java.lang.String traceId,
                                                        ApiCallback<PaymentSetupResponse> callback)
                                                 throws ApiException

Update Payment Setup (asynchronously) The API is used to edit a payment Setup. Only autopay payment setup is allowed to edit.

Parameters:

channel - The channel through which the API is invoked. (required)

clientKey - The unique identifier assigned by EBPP to the client. (required)

product - The product identifier corresponding to the API. (required)

timestamp - The timestamp for the moment when the API request is created. (required)

idempotentRequestKey - The unique token that clients can generate and maintain in order to identify an API request. (required)

requestorType - Type of the requestor of the API. (required)

ID_PAYMENT_SETUP - The unique identifier assigned by EBPP to the payment setup. (required)

ID_CUSTOMER - The unique identifier assigned by EBPP to the customer. (required)

updatePaymentSetupRequest - Details of the Payment Setup to be updated. (required)

requestor - The identifier for the requestor of the API. (optional)

xOPAYHeaders - Intended for the future use. (optional)

traceId - The unique reference that can be used for tracing and debugging an API call. (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