Package com.orbipay.paymentsapi.internal.api

Class CustomerAccountApi

  • public class CustomerAccountApi
extends java.lang.Object

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

    • Method Summary

      All Methods Instance Methods Concrete Methods 
      Modifier and Type Method Description
      ApiClient getApiClient()  
      ApiResponse<CustomerAccountResponse> getCustomerAccount​(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_ACCOUNT, java.lang.String ID_CUSTOMER, java.lang.String requestor, java.lang.String xOPAYHeaders, java.lang.String traceId)
      Get Customer Account The Get Customer Account API is used to retrieve the details of a customer account based on the id.
      com.squareup.okhttp.Call getCustomerAccountAsync​(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_ACCOUNT, java.lang.String ID_CUSTOMER, java.lang.String requestor, java.lang.String xOPAYHeaders, java.lang.String traceId, ApiCallback<CustomerAccountResponse> callback)
      Get Customer Account (asynchronously) The Get Customer Account API is used to retrieve the details of a customer account based on the id.
      com.squareup.okhttp.Call getCustomerAccountCall​(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_ACCOUNT, 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 getCustomerAccount
      ApiResponse<CustomerAccountResponse> getCustomerAccountWithHttpInfo​(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_ACCOUNT, java.lang.String ID_CUSTOMER, java.lang.String requestor, java.lang.String xOPAYHeaders, java.lang.String traceId)
      Get Customer Account The Get Customer Account API is used to retrieve the details of a customer account based on the id.
      ApiResponse<CustomerAccountResponse> renewCustomerAccount​(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_ACCOUNT, java.lang.String ID_CUSTOMER, RenewCustomerAccountRequest renewCustomerAccountRequest, java.lang.String requestor, java.lang.String xOPAYHeaders, java.lang.String traceId)
      Renew Customer Account This API is used to renew a customer account.
      com.squareup.okhttp.Call renewCustomerAccountAsync​(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_ACCOUNT, java.lang.String ID_CUSTOMER, RenewCustomerAccountRequest renewCustomerAccountRequest, java.lang.String requestor, java.lang.String xOPAYHeaders, java.lang.String traceId, ApiCallback<CustomerAccountResponse> callback)
      Renew Customer Account (asynchronously) This API is used to renew a customer account.
      com.squareup.okhttp.Call renewCustomerAccountCall​(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_ACCOUNT, java.lang.String ID_CUSTOMER, RenewCustomerAccountRequest renewCustomerAccountRequest, java.lang.String requestor, java.lang.String xOPAYHeaders, java.lang.String traceId, ProgressResponseBody.ProgressListener progressListener, ProgressRequestBody.ProgressRequestListener progressRequestListener)
      Build call for renewCustomerAccount
      ApiResponse<CustomerAccountResponse> renewCustomerAccountWithHttpInfo​(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_ACCOUNT, java.lang.String ID_CUSTOMER, RenewCustomerAccountRequest renewCustomerAccountRequest, java.lang.String requestor, java.lang.String xOPAYHeaders, java.lang.String traceId)
      Renew Customer Account This API is used to renew a customer account.
      ApiResponse<CustomerAccountsResponse> retrieveCustomerAccounts​(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, java.lang.String requestor, java.lang.String xOPAYHeaders, java.lang.String traceId, java.lang.String pageSize, java.lang.String accountNumber, java.util.List<java.lang.String> status)
      Retrieve Customer Accounts The API is used to retrieve all the customer accounts associated with a customer.
      com.squareup.okhttp.Call retrieveCustomerAccountsAsync​(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, java.lang.String requestor, java.lang.String xOPAYHeaders, java.lang.String traceId, java.lang.String pageSize, java.lang.String accountNumber, java.util.List<java.lang.String> status, ApiCallback<CustomerAccountsResponse> callback)
      Retrieve Customer Accounts (asynchronously) The API is used to retrieve all the customer accounts associated with a customer.
      com.squareup.okhttp.Call retrieveCustomerAccountsCall​(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, java.lang.String requestor, java.lang.String xOPAYHeaders, java.lang.String traceId, java.lang.String pageSize, java.lang.String accountNumber, java.util.List<java.lang.String> status, ProgressResponseBody.ProgressListener progressListener, ProgressRequestBody.ProgressRequestListener progressRequestListener)
      Build call for retrieveCustomerAccounts
      ApiResponse<CustomerAccountsResponse> retrieveCustomerAccountsPage​(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, java.lang.String queryId, java.lang.String requestor, java.lang.String xOPAYHeaders, java.lang.String traceId, java.lang.String pageSize, java.lang.String fromIndex, java.lang.String toIndex)
      Retrieve Customer Accounts Pagination This API is used to paginate through the list of customer Accounts returned in the Retrieve Customer Accounts API.
      com.squareup.okhttp.Call retrieveCustomerAccountsPageAsync​(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, java.lang.String queryId, java.lang.String requestor, java.lang.String xOPAYHeaders, java.lang.String traceId, java.lang.String pageSize, java.lang.String fromIndex, java.lang.String toIndex, ApiCallback<CustomerAccountsResponse> callback)
      Retrieve Customer Accounts Pagination (asynchronously) This API is used to paginate through the list of customer Accounts returned in the Retrieve Customer Accounts API.
      com.squareup.okhttp.Call retrieveCustomerAccountsPageCall​(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, java.lang.String queryId, java.lang.String requestor, java.lang.String xOPAYHeaders, java.lang.String traceId, java.lang.String pageSize, java.lang.String fromIndex, java.lang.String toIndex, ProgressResponseBody.ProgressListener progressListener, ProgressRequestBody.ProgressRequestListener progressRequestListener)
      Build call for retrieveCustomerAccountsPage
      ApiResponse<CustomerAccountsResponse> retrieveCustomerAccountsPageWithHttpInfo​(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, java.lang.String queryId, java.lang.String requestor, java.lang.String xOPAYHeaders, java.lang.String traceId, java.lang.String pageSize, java.lang.String fromIndex, java.lang.String toIndex)
      Retrieve Customer Accounts Pagination This API is used to paginate through the list of customer Accounts returned in the Retrieve Customer Accounts API.
      ApiResponse<CustomerAccountsResponse> retrieveCustomerAccountsWithHttpInfo​(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, java.lang.String requestor, java.lang.String xOPAYHeaders, java.lang.String traceId, java.lang.String pageSize, java.lang.String accountNumber, java.util.List<java.lang.String> status)
      Retrieve Customer Accounts The API is used to retrieve all the customer accounts associated with a customer.
      void setApiClient​(ApiClient apiClient)  

      • Methods inherited from class java.lang.Object

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

    • Constructor Detail

      • CustomerAccountApi

        public CustomerAccountApi​(ApiClient apiClient)

    • Method Detail

      • getApiClient

        public ApiClient getApiClient()

      • setApiClient

        public void setApiClient​(ApiClient apiClient)

      • getCustomerAccountCall

        public com.squareup.okhttp.Call getCustomerAccountCall​(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_ACCOUNT,
                                                       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 getCustomerAccount
        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_ACCOUNT - The unique identifier assigned by EBPP to the Customer Account. (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

      • getCustomerAccount

        public ApiResponse<CustomerAccountResponse> getCustomerAccount​(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_ACCOUNT,
                                                               java.lang.String ID_CUSTOMER,
                                                               java.lang.String requestor,
                                                               java.lang.String xOPAYHeaders,
                                                               java.lang.String traceId)
                                                        throws ApiException
        Get Customer Account The Get Customer Account API is used to retrieve the details of a customer account based on the 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_CUSTOMER_ACCOUNT - The unique identifier assigned by EBPP to the Customer Account. (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:
        CustomerAccountResponse
        Throws:
        ApiException - If fail to call the API, e.g. server error or cannot deserialize the response body

      • getCustomerAccountWithHttpInfo

        public ApiResponse<CustomerAccountResponse> getCustomerAccountWithHttpInfo​(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_ACCOUNT,
                                                                           java.lang.String ID_CUSTOMER,
                                                                           java.lang.String requestor,
                                                                           java.lang.String xOPAYHeaders,
                                                                           java.lang.String traceId)
                                                                    throws ApiException
        Get Customer Account The Get Customer Account API is used to retrieve the details of a customer account based on the 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_CUSTOMER_ACCOUNT - The unique identifier assigned by EBPP to the Customer Account. (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<CustomerAccountResponse>
        Throws:
        ApiException - If fail to call the API, e.g. server error or cannot deserialize the response body

      • getCustomerAccountAsync

        public com.squareup.okhttp.Call getCustomerAccountAsync​(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_ACCOUNT,
                                                        java.lang.String ID_CUSTOMER,
                                                        java.lang.String requestor,
                                                        java.lang.String xOPAYHeaders,
                                                        java.lang.String traceId,
                                                        ApiCallback<CustomerAccountResponse> callback)
                                                 throws ApiException
        Get Customer Account (asynchronously) The Get Customer Account API is used to retrieve the details of a customer account based on the 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_CUSTOMER_ACCOUNT - The unique identifier assigned by EBPP to the Customer Account. (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

      • renewCustomerAccountCall

        public com.squareup.okhttp.Call renewCustomerAccountCall​(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_ACCOUNT,
                                                         java.lang.String ID_CUSTOMER,
                                                         RenewCustomerAccountRequest renewCustomerAccountRequest,
                                                         java.lang.String requestor,
                                                         java.lang.String xOPAYHeaders,
                                                         java.lang.String traceId,
                                                         ProgressResponseBody.ProgressListener progressListener,
                                                         ProgressRequestBody.ProgressRequestListener progressRequestListener)
                                                  throws ApiException
        Build call for renewCustomerAccount
        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_ACCOUNT - The unique identifier assigned by EBPP to the Customer Account. (required)
        ID_CUSTOMER - The unique identifier assigned by EBPP to the customer. (required)
        renewCustomerAccountRequest - JSON containing all the attributes of the Customer account to be renewed. (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

      • renewCustomerAccount

        public ApiResponse<CustomerAccountResponse> renewCustomerAccount​(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_ACCOUNT,
                                                                 java.lang.String ID_CUSTOMER,
                                                                 RenewCustomerAccountRequest renewCustomerAccountRequest,
                                                                 java.lang.String requestor,
                                                                 java.lang.String xOPAYHeaders,
                                                                 java.lang.String traceId)
                                                          throws ApiException
        Renew Customer Account This API is used to renew a customer account. The API migrates all the pending payments and active payment setups from the original customer account to the new one.
        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_ACCOUNT - The unique identifier assigned by EBPP to the Customer Account. (required)
        ID_CUSTOMER - The unique identifier assigned by EBPP to the customer. (required)
        renewCustomerAccountRequest - JSON containing all the attributes of the Customer account to be renewed. (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:
        CustomerAccountResponse
        Throws:
        ApiException - If fail to call the API, e.g. server error or cannot deserialize the response body

      • renewCustomerAccountWithHttpInfo

        public ApiResponse<CustomerAccountResponse> renewCustomerAccountWithHttpInfo​(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_ACCOUNT,
                                                                             java.lang.String ID_CUSTOMER,
                                                                             RenewCustomerAccountRequest renewCustomerAccountRequest,
                                                                             java.lang.String requestor,
                                                                             java.lang.String xOPAYHeaders,
                                                                             java.lang.String traceId)
                                                                      throws ApiException
        Renew Customer Account This API is used to renew a customer account. The API migrates all the pending payments and active payment setups from the original customer account to the new one.
        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_ACCOUNT - The unique identifier assigned by EBPP to the Customer Account. (required)
        ID_CUSTOMER - The unique identifier assigned by EBPP to the customer. (required)
        renewCustomerAccountRequest - JSON containing all the attributes of the Customer account to be renewed. (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<CustomerAccountResponse>
        Throws:
        ApiException - If fail to call the API, e.g. server error or cannot deserialize the response body

      • renewCustomerAccountAsync

        public com.squareup.okhttp.Call renewCustomerAccountAsync​(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_ACCOUNT,
                                                          java.lang.String ID_CUSTOMER,
                                                          RenewCustomerAccountRequest renewCustomerAccountRequest,
                                                          java.lang.String requestor,
                                                          java.lang.String xOPAYHeaders,
                                                          java.lang.String traceId,
                                                          ApiCallback<CustomerAccountResponse> callback)
                                                   throws ApiException
        Renew Customer Account (asynchronously) This API is used to renew a customer account. The API migrates all the pending payments and active payment setups from the original customer account to the new one.
        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_ACCOUNT - The unique identifier assigned by EBPP to the Customer Account. (required)
        ID_CUSTOMER - The unique identifier assigned by EBPP to the customer. (required)
        renewCustomerAccountRequest - JSON containing all the attributes of the Customer account to be renewed. (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

      • retrieveCustomerAccountsCall

        public com.squareup.okhttp.Call retrieveCustomerAccountsCall​(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,
                                                             java.lang.String requestor,
                                                             java.lang.String xOPAYHeaders,
                                                             java.lang.String traceId,
                                                             java.lang.String pageSize,
                                                             java.lang.String accountNumber,
                                                             java.util.List<java.lang.String> status,
                                                             ProgressResponseBody.ProgressListener progressListener,
                                                             ProgressRequestBody.ProgressRequestListener progressRequestListener)
                                                      throws ApiException
        Build call for retrieveCustomerAccounts
        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)
        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)
        pageSize - The maximum number of objects returned in the query. (optional)
        accountNumber - The Account Number to get details of. (optional)
        status - The status of the customer's account in EBPP. This can take multiple values in the format key=value1&key=value2.... (optional)
        progressListener - Progress listener
        progressRequestListener - Progress request listener
        Returns:
        Call to execute
        Throws:
        ApiException - If fail to serialize the request body object

      • retrieveCustomerAccounts

        public ApiResponse<CustomerAccountsResponse> retrieveCustomerAccounts​(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,
                                                                      java.lang.String requestor,
                                                                      java.lang.String xOPAYHeaders,
                                                                      java.lang.String traceId,
                                                                      java.lang.String pageSize,
                                                                      java.lang.String accountNumber,
                                                                      java.util.List<java.lang.String> status)
                                                               throws ApiException
        Retrieve Customer Accounts The API is used to retrieve all the customer accounts associated with a customer. The accounts can be filtered using the account number, status. The API responds with the first page of the list of customerAccounts matching the criteria. The results are sorted in descending order of 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)
        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)
        pageSize - The maximum number of objects returned in the query. (optional)
        accountNumber - The Account Number to get details of. (optional)
        status - The status of the customer's account in EBPP. This can take multiple values in the format key=value1&key=value2.... (optional)
        Returns:
        CustomerAccountsResponse
        Throws:
        ApiException - If fail to call the API, e.g. server error or cannot deserialize the response body

      • retrieveCustomerAccountsWithHttpInfo

        public ApiResponse<CustomerAccountsResponse> retrieveCustomerAccountsWithHttpInfo​(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,
                                                                                  java.lang.String requestor,
                                                                                  java.lang.String xOPAYHeaders,
                                                                                  java.lang.String traceId,
                                                                                  java.lang.String pageSize,
                                                                                  java.lang.String accountNumber,
                                                                                  java.util.List<java.lang.String> status)
                                                                           throws ApiException
        Retrieve Customer Accounts The API is used to retrieve all the customer accounts associated with a customer. The accounts can be filtered using the account number, status. The API responds with the first page of the list of customerAccounts matching the criteria. The results are sorted in descending order of 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)
        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)
        pageSize - The maximum number of objects returned in the query. (optional)
        accountNumber - The Account Number to get details of. (optional)
        status - The status of the customer's account in EBPP. This can take multiple values in the format key=value1&key=value2.... (optional)
        Returns:
        ApiResponse<CustomerAccountsResponse>
        Throws:
        ApiException - If fail to call the API, e.g. server error or cannot deserialize the response body

      • retrieveCustomerAccountsAsync

        public com.squareup.okhttp.Call retrieveCustomerAccountsAsync​(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,
                                                              java.lang.String requestor,
                                                              java.lang.String xOPAYHeaders,
                                                              java.lang.String traceId,
                                                              java.lang.String pageSize,
                                                              java.lang.String accountNumber,
                                                              java.util.List<java.lang.String> status,
                                                              ApiCallback<CustomerAccountsResponse> callback)
                                                       throws ApiException
        Retrieve Customer Accounts (asynchronously) The API is used to retrieve all the customer accounts associated with a customer. The accounts can be filtered using the account number, status. The API responds with the first page of the list of customerAccounts matching the criteria. The results are sorted in descending order of 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)
        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)
        pageSize - The maximum number of objects returned in the query. (optional)
        accountNumber - The Account Number to get details of. (optional)
        status - The status of the customer's account in EBPP. This can take multiple values in the format key=value1&key=value2.... (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

      • retrieveCustomerAccountsPageCall

        public com.squareup.okhttp.Call retrieveCustomerAccountsPageCall​(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,
                                                                 java.lang.String queryId,
                                                                 java.lang.String requestor,
                                                                 java.lang.String xOPAYHeaders,
                                                                 java.lang.String traceId,
                                                                 java.lang.String pageSize,
                                                                 java.lang.String fromIndex,
                                                                 java.lang.String toIndex,
                                                                 ProgressResponseBody.ProgressListener progressListener,
                                                                 ProgressRequestBody.ProgressRequestListener progressRequestListener)
                                                          throws ApiException
        Build call for retrieveCustomerAccountsPage
        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)
        queryId - query id of the Retrieve/Search Accounts lookup. (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)
        pageSize - The maximum number of objects returned in the query. (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

      • retrieveCustomerAccountsPage

        public ApiResponse<CustomerAccountsResponse> retrieveCustomerAccountsPage​(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,
                                                                          java.lang.String queryId,
                                                                          java.lang.String requestor,
                                                                          java.lang.String xOPAYHeaders,
                                                                          java.lang.String traceId,
                                                                          java.lang.String pageSize,
                                                                          java.lang.String fromIndex,
                                                                          java.lang.String toIndex)
                                                                   throws ApiException
        Retrieve Customer Accounts Pagination This API is used to paginate through the list of customer Accounts returned in the Retrieve Customer Accounts API.
        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)
        queryId - query id of the Retrieve/Search Accounts lookup. (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)
        pageSize - The maximum number of objects returned in the query. (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:
        CustomerAccountsResponse
        Throws:
        ApiException - If fail to call the API, e.g. server error or cannot deserialize the response body

      • retrieveCustomerAccountsPageWithHttpInfo

        public ApiResponse<CustomerAccountsResponse> retrieveCustomerAccountsPageWithHttpInfo​(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,
                                                                                      java.lang.String queryId,
                                                                                      java.lang.String requestor,
                                                                                      java.lang.String xOPAYHeaders,
                                                                                      java.lang.String traceId,
                                                                                      java.lang.String pageSize,
                                                                                      java.lang.String fromIndex,
                                                                                      java.lang.String toIndex)
                                                                               throws ApiException
        Retrieve Customer Accounts Pagination This API is used to paginate through the list of customer Accounts returned in the Retrieve Customer Accounts API.
        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)
        queryId - query id of the Retrieve/Search Accounts lookup. (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)
        pageSize - The maximum number of objects returned in the query. (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<CustomerAccountsResponse>
        Throws:
        ApiException - If fail to call the API, e.g. server error or cannot deserialize the response body

      • retrieveCustomerAccountsPageAsync

        public com.squareup.okhttp.Call retrieveCustomerAccountsPageAsync​(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,
                                                                  java.lang.String queryId,
                                                                  java.lang.String requestor,
                                                                  java.lang.String xOPAYHeaders,
                                                                  java.lang.String traceId,
                                                                  java.lang.String pageSize,
                                                                  java.lang.String fromIndex,
                                                                  java.lang.String toIndex,
                                                                  ApiCallback<CustomerAccountsResponse> callback)
                                                           throws ApiException
        Retrieve Customer Accounts Pagination (asynchronously) This API is used to paginate through the list of customer Accounts returned in the Retrieve Customer Accounts API.
        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)
        queryId - query id of the Retrieve/Search Accounts lookup. (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)
        pageSize - The maximum number of objects returned in the query. (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