Package com.orbipay.paymentsapi.internal.api

Class CustomerApi

  • public class CustomerApi
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
      ApiResponse<CustomerResponse> createCustomer​(java.lang.String channel, java.lang.String clientKey, java.lang.String product, java.lang.String timestamp, java.lang.String idempotentRequestKey, java.lang.String requestorType, CreateCustomerRequest createCustomerRequest, java.lang.String requestor, java.lang.String xOPAYHeaders, java.lang.String traceId)
      Create Customer The Create Customer API is used to register a customer with a biller in EBPP.
      com.squareup.okhttp.Call createCustomerAsync​(java.lang.String channel, java.lang.String clientKey, java.lang.String product, java.lang.String timestamp, java.lang.String idempotentRequestKey, java.lang.String requestorType, CreateCustomerRequest createCustomerRequest, java.lang.String requestor, java.lang.String xOPAYHeaders, java.lang.String traceId, ApiCallback<CustomerResponse> callback)
      Create Customer (asynchronously) The Create Customer API is used to register a customer with a biller in EBPP.
      com.squareup.okhttp.Call createCustomerCall​(java.lang.String channel, java.lang.String clientKey, java.lang.String product, java.lang.String timestamp, java.lang.String idempotentRequestKey, java.lang.String requestorType, CreateCustomerRequest createCustomerRequest, java.lang.String requestor, java.lang.String xOPAYHeaders, java.lang.String traceId, ProgressResponseBody.ProgressListener progressListener, ProgressRequestBody.ProgressRequestListener progressRequestListener)
      Build call for createCustomer
      ApiResponse<CustomerResponse> createCustomerWithHttpInfo​(java.lang.String channel, java.lang.String clientKey, java.lang.String product, java.lang.String timestamp, java.lang.String idempotentRequestKey, java.lang.String requestorType, CreateCustomerRequest createCustomerRequest, java.lang.String requestor, java.lang.String xOPAYHeaders, java.lang.String traceId)
      Create Customer The Create Customer API is used to register a customer with a biller in EBPP.
      ApiClient getApiClient()  
      ApiResponse<CustomerResponse> getCustomer​(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)
      Get Customer The Get Customer API is used to retrieve the details of the customer based on the id.
      com.squareup.okhttp.Call getCustomerAsync​(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, ApiCallback<CustomerResponse> callback)
      Get Customer (asynchronously) The Get Customer API is used to retrieve the details of the customer based on the id.
      com.squareup.okhttp.Call getCustomerCall​(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, ProgressResponseBody.ProgressListener progressListener, ProgressRequestBody.ProgressRequestListener progressRequestListener)
      Build call for getCustomer
      ApiResponse<CustomerResponse> getCustomerWithHttpInfo​(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)
      Get Customer The Get Customer API is used to retrieve the details of the customer based on the id.
      ApiResponse<CustomersResponse> retrieveCustomers​(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 pageSize, java.lang.String customerReference, java.lang.String ssn, java.lang.String email, java.lang.String accountNumber)
      Retrieve Customers This API is used to retrieve/lookup customers from EBPP.
      com.squareup.okhttp.Call retrieveCustomersAsync​(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 pageSize, java.lang.String customerReference, java.lang.String ssn, java.lang.String email, java.lang.String accountNumber, ApiCallback<CustomersResponse> callback)
      Retrieve Customers (asynchronously) This API is used to retrieve/lookup customers from EBPP.
      com.squareup.okhttp.Call retrieveCustomersCall​(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 pageSize, java.lang.String customerReference, java.lang.String ssn, java.lang.String email, java.lang.String accountNumber, ProgressResponseBody.ProgressListener progressListener, ProgressRequestBody.ProgressRequestListener progressRequestListener)
      Build call for retrieveCustomers
      ApiResponse<CustomersResponse> retrieveCustomersPage​(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 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 Customers Pagination This API is used to paginate through the list of customers returned in the Retrieve Customers API.
      com.squareup.okhttp.Call retrieveCustomersPageAsync​(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 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<CustomersResponse> callback)
      Retrieve Customers Pagination (asynchronously) This API is used to paginate through the list of customers returned in the Retrieve Customers API.
      com.squareup.okhttp.Call retrieveCustomersPageCall​(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 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 retrieveCustomersPage
      ApiResponse<CustomersResponse> retrieveCustomersPageWithHttpInfo​(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 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 Customers Pagination This API is used to paginate through the list of customers returned in the Retrieve Customers API.
      ApiResponse<CustomersResponse> retrieveCustomersWithHttpInfo​(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 pageSize, java.lang.String customerReference, java.lang.String ssn, java.lang.String email, java.lang.String accountNumber)
      Retrieve Customers This API is used to retrieve/lookup customers from EBPP.
      void setApiClient​(ApiClient apiClient)  
      ApiResponse<CustomerResponse> updateCustomer​(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, UpdateCustomerRequest updateCustomerRequest, java.lang.String requestor, java.lang.String xOPAYHeaders, java.lang.String traceId)
      Update Customer The Update Customer API is used to edit the customer''s personal details, accounts or the customer''s status.
      com.squareup.okhttp.Call updateCustomerAsync​(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, UpdateCustomerRequest updateCustomerRequest, java.lang.String requestor, java.lang.String xOPAYHeaders, java.lang.String traceId, ApiCallback<CustomerResponse> callback)
      Update Customer (asynchronously) The Update Customer API is used to edit the customer''s personal details, accounts or the customer''s status.
      com.squareup.okhttp.Call updateCustomerCall​(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, UpdateCustomerRequest updateCustomerRequest, java.lang.String requestor, java.lang.String xOPAYHeaders, java.lang.String traceId, ProgressResponseBody.ProgressListener progressListener, ProgressRequestBody.ProgressRequestListener progressRequestListener)
      Build call for updateCustomer
      ApiResponse<CustomerResponse> updateCustomerWithHttpInfo​(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, UpdateCustomerRequest updateCustomerRequest, java.lang.String requestor, java.lang.String xOPAYHeaders, java.lang.String traceId)
      Update Customer The Update Customer API is used to edit the customer''s personal details, accounts or the customer''s status.

      • Methods inherited from class java.lang.Object

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

    • Constructor Detail

      • CustomerApi

        public CustomerApi​(ApiClient apiClient)

    • Method Detail

      • getApiClient

        public ApiClient getApiClient()

      • setApiClient

        public void setApiClient​(ApiClient apiClient)

      • createCustomerCall

        public com.squareup.okhttp.Call createCustomerCall​(java.lang.String channel,
                                                   java.lang.String clientKey,
                                                   java.lang.String product,
                                                   java.lang.String timestamp,
                                                   java.lang.String idempotentRequestKey,
                                                   java.lang.String requestorType,
                                                   CreateCustomerRequest createCustomerRequest,
                                                   java.lang.String requestor,
                                                   java.lang.String xOPAYHeaders,
                                                   java.lang.String traceId,
                                                   ProgressResponseBody.ProgressListener progressListener,
                                                   ProgressRequestBody.ProgressRequestListener progressRequestListener)
                                            throws ApiException
        Build call for createCustomer
        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)
        createCustomerRequest - The JSON that contains all the attributes of customer to be created. (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

      • createCustomer

        public ApiResponse<CustomerResponse> createCustomer​(java.lang.String channel,
                                                    java.lang.String clientKey,
                                                    java.lang.String product,
                                                    java.lang.String timestamp,
                                                    java.lang.String idempotentRequestKey,
                                                    java.lang.String requestorType,
                                                    CreateCustomerRequest createCustomerRequest,
                                                    java.lang.String requestor,
                                                    java.lang.String xOPAYHeaders,
                                                    java.lang.String traceId)
                                             throws ApiException
        Create Customer The Create Customer API is used to register a customer with a biller in EBPP. It is also mandatory to create a customer account for the customer. So, at least one customer account should be provided in order to register a customer. There is no limit on the number of accounts that can be associated with the customer. Either first_name or last_name is required to create a customer.
        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)
        createCustomerRequest - The JSON that contains all the attributes of customer to be created. (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:
        CustomerResponse
        Throws:
        ApiException - If fail to call the API, e.g. server error or cannot deserialize the response body

      • createCustomerWithHttpInfo

        public ApiResponse<CustomerResponse> createCustomerWithHttpInfo​(java.lang.String channel,
                                                                java.lang.String clientKey,
                                                                java.lang.String product,
                                                                java.lang.String timestamp,
                                                                java.lang.String idempotentRequestKey,
                                                                java.lang.String requestorType,
                                                                CreateCustomerRequest createCustomerRequest,
                                                                java.lang.String requestor,
                                                                java.lang.String xOPAYHeaders,
                                                                java.lang.String traceId)
                                                         throws ApiException
        Create Customer The Create Customer API is used to register a customer with a biller in EBPP. It is also mandatory to create a customer account for the customer. So, at least one customer account should be provided in order to register a customer. There is no limit on the number of accounts that can be associated with the customer. Either first_name or last_name is required to create a customer.
        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)
        createCustomerRequest - The JSON that contains all the attributes of customer to be created. (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<CustomerResponse>
        Throws:
        ApiException - If fail to call the API, e.g. server error or cannot deserialize the response body

      • createCustomerAsync

        public com.squareup.okhttp.Call createCustomerAsync​(java.lang.String channel,
                                                    java.lang.String clientKey,
                                                    java.lang.String product,
                                                    java.lang.String timestamp,
                                                    java.lang.String idempotentRequestKey,
                                                    java.lang.String requestorType,
                                                    CreateCustomerRequest createCustomerRequest,
                                                    java.lang.String requestor,
                                                    java.lang.String xOPAYHeaders,
                                                    java.lang.String traceId,
                                                    ApiCallback<CustomerResponse> callback)
                                             throws ApiException
        Create Customer (asynchronously) The Create Customer API is used to register a customer with a biller in EBPP. It is also mandatory to create a customer account for the customer. So, at least one customer account should be provided in order to register a customer. There is no limit on the number of accounts that can be associated with the customer. Either first_name or last_name is required to create a customer.
        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)
        createCustomerRequest - The JSON that contains all the attributes of customer to be created. (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

      • getCustomerCall

        public com.squareup.okhttp.Call getCustomerCall​(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,
                                                ProgressResponseBody.ProgressListener progressListener,
                                                ProgressRequestBody.ProgressRequestListener progressRequestListener)
                                         throws ApiException
        Build call for getCustomer
        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)
        progressListener - Progress listener
        progressRequestListener - Progress request listener
        Returns:
        Call to execute
        Throws:
        ApiException - If fail to serialize the request body object

      • getCustomer

        public ApiResponse<CustomerResponse> getCustomer​(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)
                                          throws ApiException
        Get Customer The Get Customer API is used to retrieve the details of the customer 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 - 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:
        CustomerResponse
        Throws:
        ApiException - If fail to call the API, e.g. server error or cannot deserialize the response body

      • getCustomerWithHttpInfo

        public ApiResponse<CustomerResponse> getCustomerWithHttpInfo​(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)
                                                      throws ApiException
        Get Customer The Get Customer API is used to retrieve the details of the customer 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 - 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<CustomerResponse>
        Throws:
        ApiException - If fail to call the API, e.g. server error or cannot deserialize the response body

      • getCustomerAsync

        public com.squareup.okhttp.Call getCustomerAsync​(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,
                                                 ApiCallback<CustomerResponse> callback)
                                          throws ApiException
        Get Customer (asynchronously) The Get Customer API is used to retrieve the details of the customer 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 - 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

      • retrieveCustomersCall

        public com.squareup.okhttp.Call retrieveCustomersCall​(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 pageSize,
                                                      java.lang.String customerReference,
                                                      java.lang.String ssn,
                                                      java.lang.String email,
                                                      java.lang.String accountNumber,
                                                      ProgressResponseBody.ProgressListener progressListener,
                                                      ProgressRequestBody.ProgressRequestListener progressRequestListener)
                                               throws ApiException
        Build call for retrieveCustomers
        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)
        pageSize - The maximum number of objects returned in the query. (optional)
        customerReference - Unique ID assigned by the biller/client system for a given customer. (optional)
        ssn - The SSN of the customer if the account holder is an individual or the tax ID, if the customer is a business. (optional)
        email - This field contains the customer’s email address within EBPP. (optional)
        accountNumber - Customer Account Number of the customer to get details of. (optional)
        progressListener - Progress listener
        progressRequestListener - Progress request listener
        Returns:
        Call to execute
        Throws:
        ApiException - If fail to serialize the request body object

      • retrieveCustomers

        public ApiResponse<CustomersResponse> retrieveCustomers​(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 pageSize,
                                                        java.lang.String customerReference,
                                                        java.lang.String ssn,
                                                        java.lang.String email,
                                                        java.lang.String accountNumber)
                                                 throws ApiException
        Retrieve Customers This API is used to retrieve/lookup customers from EBPP. Customers can be retrieved matching criteria that includes the customer_reference, the ssn, the email or the customer account number. A unique customer can be retrieved by using search criteria as per the customer uniqueness parameters opted by the client/biller. If the requestor_type is customer, the Retrieve Customers API will return an error if it cannot retrieve a unique customer.
        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)
        pageSize - The maximum number of objects returned in the query. (optional)
        customerReference - Unique ID assigned by the biller/client system for a given customer. (optional)
        ssn - The SSN of the customer if the account holder is an individual or the tax ID, if the customer is a business. (optional)
        email - This field contains the customer’s email address within EBPP. (optional)
        accountNumber - Customer Account Number of the customer to get details of. (optional)
        Returns:
        CustomersResponse
        Throws:
        ApiException - If fail to call the API, e.g. server error or cannot deserialize the response body

      • retrieveCustomersWithHttpInfo

        public ApiResponse<CustomersResponse> retrieveCustomersWithHttpInfo​(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 pageSize,
                                                                    java.lang.String customerReference,
                                                                    java.lang.String ssn,
                                                                    java.lang.String email,
                                                                    java.lang.String accountNumber)
                                                             throws ApiException
        Retrieve Customers This API is used to retrieve/lookup customers from EBPP. Customers can be retrieved matching criteria that includes the customer_reference, the ssn, the email or the customer account number. A unique customer can be retrieved by using search criteria as per the customer uniqueness parameters opted by the client/biller. If the requestor_type is customer, the Retrieve Customers API will return an error if it cannot retrieve a unique customer.
        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)
        pageSize - The maximum number of objects returned in the query. (optional)
        customerReference - Unique ID assigned by the biller/client system for a given customer. (optional)
        ssn - The SSN of the customer if the account holder is an individual or the tax ID, if the customer is a business. (optional)
        email - This field contains the customer’s email address within EBPP. (optional)
        accountNumber - Customer Account Number of the customer to get details of. (optional)
        Returns:
        ApiResponse<CustomersResponse>
        Throws:
        ApiException - If fail to call the API, e.g. server error or cannot deserialize the response body

      • retrieveCustomersAsync

        public com.squareup.okhttp.Call retrieveCustomersAsync​(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 pageSize,
                                                       java.lang.String customerReference,
                                                       java.lang.String ssn,
                                                       java.lang.String email,
                                                       java.lang.String accountNumber,
                                                       ApiCallback<CustomersResponse> callback)
                                                throws ApiException
        Retrieve Customers (asynchronously) This API is used to retrieve/lookup customers from EBPP. Customers can be retrieved matching criteria that includes the customer_reference, the ssn, the email or the customer account number. A unique customer can be retrieved by using search criteria as per the customer uniqueness parameters opted by the client/biller. If the requestor_type is customer, the Retrieve Customers API will return an error if it cannot retrieve a unique customer.
        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)
        pageSize - The maximum number of objects returned in the query. (optional)
        customerReference - Unique ID assigned by the biller/client system for a given customer. (optional)
        ssn - The SSN of the customer if the account holder is an individual or the tax ID, if the customer is a business. (optional)
        email - This field contains the customer’s email address within EBPP. (optional)
        accountNumber - Customer Account Number of the customer to get details of. (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

      • retrieveCustomersPageCall

        public com.squareup.okhttp.Call retrieveCustomersPageCall​(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 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 retrieveCustomersPage
        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)
        queryId - query id of the Retrieve/Search Customers 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

      • retrieveCustomersPage

        public ApiResponse<CustomersResponse> retrieveCustomersPage​(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 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 Customers Pagination This API is used to paginate through the list of customers returned in the Retrieve Customers 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)
        queryId - query id of the Retrieve/Search Customers 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:
        CustomersResponse
        Throws:
        ApiException - If fail to call the API, e.g. server error or cannot deserialize the response body

      • retrieveCustomersPageWithHttpInfo

        public ApiResponse<CustomersResponse> retrieveCustomersPageWithHttpInfo​(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 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 Customers Pagination This API is used to paginate through the list of customers returned in the Retrieve Customers 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)
        queryId - query id of the Retrieve/Search Customers 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<CustomersResponse>
        Throws:
        ApiException - If fail to call the API, e.g. server error or cannot deserialize the response body

      • retrieveCustomersPageAsync

        public com.squareup.okhttp.Call retrieveCustomersPageAsync​(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 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<CustomersResponse> callback)
                                                    throws ApiException
        Retrieve Customers Pagination (asynchronously) This API is used to paginate through the list of customers returned in the Retrieve Customers 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)
        queryId - query id of the Retrieve/Search Customers 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

      • updateCustomerCall

        public com.squareup.okhttp.Call updateCustomerCall​(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,
                                                   UpdateCustomerRequest updateCustomerRequest,
                                                   java.lang.String requestor,
                                                   java.lang.String xOPAYHeaders,
                                                   java.lang.String traceId,
                                                   ProgressResponseBody.ProgressListener progressListener,
                                                   ProgressRequestBody.ProgressRequestListener progressRequestListener)
                                            throws ApiException
        Build call for updateCustomer
        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)
        updateCustomerRequest - JSON containing all the attributes of the customer 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

      • updateCustomer

        public ApiResponse<CustomerResponse> updateCustomer​(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,
                                                    UpdateCustomerRequest updateCustomerRequest,
                                                    java.lang.String requestor,
                                                    java.lang.String xOPAYHeaders,
                                                    java.lang.String traceId)
                                             throws ApiException
        Update Customer The Update Customer API is used to edit the customer''s personal details, accounts or the customer''s status. Only the information being updated needs to be sent in the request, along with the id of the customer being updated. A customer can also be associated with new customer accounts using the API. <br><br> Along with Customer details , Customer and Customer Account statuses also can be updated using the Update Customer API. Below are the possible customer state transformations. | from_status | to_status | allowed requestor_type | | ------------ | ------------ | ------------ | | active | suspended| <ul> <li>external_user</li> <li> client_agent</li> <li> system</li></ul> | | active | revoked | <ul> <li>external_user</li> <li> client_agent</li> <li> system</li></ul> </ul> | | suspended | active | <ul> <li>external_user</li> <li> client_agent</li> <li> system</li></ul> </ul> | | suspended | revoked | <ul> <li>external_user</li> <li> client_agent</li> <li> system</li></ul> </ul> | | revoked | active | <ul> <li>external_user</li> <li> client_agent</li></ul> </ul> | Below are the possible customer account state transformation. | from_status | to_status | allowed requestor_type | | ------------ | ------------ | ------------ | | active | inactive| <ul> <li>external_user</li> <li> client_agent</li> <li> system</li></ul> | | inactive | active | <ul> <li>external_user</li> <li> client_agent</li> <li> system</li></ul> </ul> | | active | incollections | <ul> <li>external_user</li> <li> client_agent</li> <li> system</li></ul> </ul> | | incollections | active | <ul> <li>external_user</li> <li> client_agent</li> <li> system</li></ul> </ul> | | inactive | incollections | <ul> <li>external_user</li> <li> client_agent</li> <li> system</li></ul> </ul> | | incollections | inactive | <ul> <li>external_user</li> <li> client_agent</li> <li> system</li></ul> </ul> | | active | inbankruptcy | <ul> <li>external_user</li> <li> client_agent</li> <li> system</li></ul> </ul> | | incollections | inbankruptcy | <ul> <li>external_user</li> <li> client_agent</li> <li> system</li></ul> </ul> | | inbankruptcy | active | <ul> <li>external_user</li> <li> client_agent</li> <li> system</li></ul> </ul> | | inbankruptcy | closed | <ul> <li>external_user</li> <li> client_agent</li> <li> system</li></ul> </ul> |
        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)
        updateCustomerRequest - JSON containing all the attributes of the customer 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:
        CustomerResponse
        Throws:
        ApiException - If fail to call the API, e.g. server error or cannot deserialize the response body

      • updateCustomerWithHttpInfo

        public ApiResponse<CustomerResponse> updateCustomerWithHttpInfo​(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,
                                                                UpdateCustomerRequest updateCustomerRequest,
                                                                java.lang.String requestor,
                                                                java.lang.String xOPAYHeaders,
                                                                java.lang.String traceId)
                                                         throws ApiException
        Update Customer The Update Customer API is used to edit the customer''s personal details, accounts or the customer''s status. Only the information being updated needs to be sent in the request, along with the id of the customer being updated. A customer can also be associated with new customer accounts using the API. <br><br> Along with Customer details , Customer and Customer Account statuses also can be updated using the Update Customer API. Below are the possible customer state transformations. | from_status | to_status | allowed requestor_type | | ------------ | ------------ | ------------ | | active | suspended| <ul> <li>external_user</li> <li> client_agent</li> <li> system</li></ul> | | active | revoked | <ul> <li>external_user</li> <li> client_agent</li> <li> system</li></ul> </ul> | | suspended | active | <ul> <li>external_user</li> <li> client_agent</li> <li> system</li></ul> </ul> | | suspended | revoked | <ul> <li>external_user</li> <li> client_agent</li> <li> system</li></ul> </ul> | | revoked | active | <ul> <li>external_user</li> <li> client_agent</li></ul> </ul> | Below are the possible customer account state transformation. | from_status | to_status | allowed requestor_type | | ------------ | ------------ | ------------ | | active | inactive| <ul> <li>external_user</li> <li> client_agent</li> <li> system</li></ul> | | inactive | active | <ul> <li>external_user</li> <li> client_agent</li> <li> system</li></ul> </ul> | | active | incollections | <ul> <li>external_user</li> <li> client_agent</li> <li> system</li></ul> </ul> | | incollections | active | <ul> <li>external_user</li> <li> client_agent</li> <li> system</li></ul> </ul> | | inactive | incollections | <ul> <li>external_user</li> <li> client_agent</li> <li> system</li></ul> </ul> | | incollections | inactive | <ul> <li>external_user</li> <li> client_agent</li> <li> system</li></ul> </ul> | | active | inbankruptcy | <ul> <li>external_user</li> <li> client_agent</li> <li> system</li></ul> </ul> | | incollections | inbankruptcy | <ul> <li>external_user</li> <li> client_agent</li> <li> system</li></ul> </ul> | | inbankruptcy | active | <ul> <li>external_user</li> <li> client_agent</li> <li> system</li></ul> </ul> | | inbankruptcy | closed | <ul> <li>external_user</li> <li> client_agent</li> <li> system</li></ul> </ul> |
        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)
        updateCustomerRequest - JSON containing all the attributes of the customer 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<CustomerResponse>
        Throws:
        ApiException - If fail to call the API, e.g. server error or cannot deserialize the response body

      • updateCustomerAsync

        public com.squareup.okhttp.Call updateCustomerAsync​(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,
                                                    UpdateCustomerRequest updateCustomerRequest,
                                                    java.lang.String requestor,
                                                    java.lang.String xOPAYHeaders,
                                                    java.lang.String traceId,
                                                    ApiCallback<CustomerResponse> callback)
                                             throws ApiException
        Update Customer (asynchronously) The Update Customer API is used to edit the customer''s personal details, accounts or the customer''s status. Only the information being updated needs to be sent in the request, along with the id of the customer being updated. A customer can also be associated with new customer accounts using the API. <br><br> Along with Customer details , Customer and Customer Account statuses also can be updated using the Update Customer API. Below are the possible customer state transformations. | from_status | to_status | allowed requestor_type | | ------------ | ------------ | ------------ | | active | suspended| <ul> <li>external_user</li> <li> client_agent</li> <li> system</li></ul> | | active | revoked | <ul> <li>external_user</li> <li> client_agent</li> <li> system</li></ul> </ul> | | suspended | active | <ul> <li>external_user</li> <li> client_agent</li> <li> system</li></ul> </ul> | | suspended | revoked | <ul> <li>external_user</li> <li> client_agent</li> <li> system</li></ul> </ul> | | revoked | active | <ul> <li>external_user</li> <li> client_agent</li></ul> </ul> | Below are the possible customer account state transformation. | from_status | to_status | allowed requestor_type | | ------------ | ------------ | ------------ | | active | inactive| <ul> <li>external_user</li> <li> client_agent</li> <li> system</li></ul> | | inactive | active | <ul> <li>external_user</li> <li> client_agent</li> <li> system</li></ul> </ul> | | active | incollections | <ul> <li>external_user</li> <li> client_agent</li> <li> system</li></ul> </ul> | | incollections | active | <ul> <li>external_user</li> <li> client_agent</li> <li> system</li></ul> </ul> | | inactive | incollections | <ul> <li>external_user</li> <li> client_agent</li> <li> system</li></ul> </ul> | | incollections | inactive | <ul> <li>external_user</li> <li> client_agent</li> <li> system</li></ul> </ul> | | active | inbankruptcy | <ul> <li>external_user</li> <li> client_agent</li> <li> system</li></ul> </ul> | | incollections | inbankruptcy | <ul> <li>external_user</li> <li> client_agent</li> <li> system</li></ul> </ul> | | inbankruptcy | active | <ul> <li>external_user</li> <li> client_agent</li> <li> system</li></ul> </ul> | | inbankruptcy | closed | <ul> <li>external_user</li> <li> client_agent</li> <li> system</li></ul> </ul> |
        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)
        updateCustomerRequest - JSON containing all the attributes of the customer 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