Package com.orbipay.paymentsapi.internal.api

Class PaymentApi

  • public class PaymentApi
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<PaymentResponse> createPayment​(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, CreatePaymentRequest createPaymentRequest, java.lang.String requestor, java.lang.String xOPAYHeaders, java.lang.String traceId)
      Create Payment The API is used to make payments to service a customer account.
      com.squareup.okhttp.Call createPaymentAsync​(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, CreatePaymentRequest createPaymentRequest, java.lang.String requestor, java.lang.String xOPAYHeaders, java.lang.String traceId, ApiCallback<PaymentResponse> callback)
      Create Payment (asynchronously) The API is used to make payments to service a customer account.
      com.squareup.okhttp.Call createPaymentCall​(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, CreatePaymentRequest createPaymentRequest, java.lang.String requestor, java.lang.String xOPAYHeaders, java.lang.String traceId, ProgressResponseBody.ProgressListener progressListener, ProgressRequestBody.ProgressRequestListener progressRequestListener)
      Build call for createPayment
      ApiResponse<PaymentResponse> createPaymentWithHttpInfo​(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, CreatePaymentRequest createPaymentRequest, java.lang.String requestor, java.lang.String xOPAYHeaders, java.lang.String traceId)
      Create Payment The API is used to make payments to service a customer account.
      ApiResponse<DeleteResponse> deletePayment​(java.lang.String channel, java.lang.String clientKey, java.lang.String product, java.lang.String timestamp, java.lang.String idempotentRequestKey, java.lang.String requestorType, java.lang.String ID_PAYMENT, java.lang.String ID_CUSTOMER, DeletePaymentRequest deletePaymentRequest, java.lang.String requestor, java.lang.String xOPAYHeaders, java.lang.String traceId)
      Delete Payment The API is used to delete or cancel a payment.
      com.squareup.okhttp.Call deletePaymentAsync​(java.lang.String channel, java.lang.String clientKey, java.lang.String product, java.lang.String timestamp, java.lang.String idempotentRequestKey, java.lang.String requestorType, java.lang.String ID_PAYMENT, java.lang.String ID_CUSTOMER, DeletePaymentRequest deletePaymentRequest, java.lang.String requestor, java.lang.String xOPAYHeaders, java.lang.String traceId, ApiCallback<DeleteResponse> callback)
      Delete Payment (asynchronously) The API is used to delete or cancel a payment.
      com.squareup.okhttp.Call deletePaymentCall​(java.lang.String channel, java.lang.String clientKey, java.lang.String product, java.lang.String timestamp, java.lang.String idempotentRequestKey, java.lang.String requestorType, java.lang.String ID_PAYMENT, java.lang.String ID_CUSTOMER, DeletePaymentRequest deletePaymentRequest, java.lang.String requestor, java.lang.String xOPAYHeaders, java.lang.String traceId, ProgressResponseBody.ProgressListener progressListener, ProgressRequestBody.ProgressRequestListener progressRequestListener)
      Build call for deletePayment
      ApiResponse<DeleteResponse> deletePaymentWithHttpInfo​(java.lang.String channel, java.lang.String clientKey, java.lang.String product, java.lang.String timestamp, java.lang.String idempotentRequestKey, java.lang.String requestorType, java.lang.String ID_PAYMENT, java.lang.String ID_CUSTOMER, DeletePaymentRequest deletePaymentRequest, java.lang.String requestor, java.lang.String xOPAYHeaders, java.lang.String traceId)
      Delete Payment The API is used to delete or cancel a payment.
      ApiResponse<java.lang.Void> deleteRecordPayment​(java.lang.String channel, java.lang.String clientKey, java.lang.String product, java.lang.String timestamp, java.lang.String idempotentRequestKey, java.lang.String requestorType, java.lang.String ID_PAYMENT, DeleteRecordedPaymentRequest deleteRecordedPaymentRequest, java.lang.String requestor, java.lang.String xOPAYHeaders, java.lang.String traceId)
      Delete Recorded Payment The API is used to delete the recorded payment.
      com.squareup.okhttp.Call deleteRecordPaymentAsync​(java.lang.String channel, java.lang.String clientKey, java.lang.String product, java.lang.String timestamp, java.lang.String idempotentRequestKey, java.lang.String requestorType, java.lang.String ID_PAYMENT, DeleteRecordedPaymentRequest deleteRecordedPaymentRequest, java.lang.String requestor, java.lang.String xOPAYHeaders, java.lang.String traceId, ApiCallback<java.lang.Void> callback)
      Delete Recorded Payment (asynchronously) The API is used to delete the recorded payment.
      com.squareup.okhttp.Call deleteRecordPaymentCall​(java.lang.String channel, java.lang.String clientKey, java.lang.String product, java.lang.String timestamp, java.lang.String idempotentRequestKey, java.lang.String requestorType, java.lang.String ID_PAYMENT, DeleteRecordedPaymentRequest deleteRecordedPaymentRequest, java.lang.String requestor, java.lang.String xOPAYHeaders, java.lang.String traceId, ProgressResponseBody.ProgressListener progressListener, ProgressRequestBody.ProgressRequestListener progressRequestListener)
      Build call for deleteRecordPayment
      ApiResponse<java.lang.Void> deleteRecordPaymentWithHttpInfo​(java.lang.String channel, java.lang.String clientKey, java.lang.String product, java.lang.String timestamp, java.lang.String idempotentRequestKey, java.lang.String requestorType, java.lang.String ID_PAYMENT, DeleteRecordedPaymentRequest deleteRecordedPaymentRequest, java.lang.String requestor, java.lang.String xOPAYHeaders, java.lang.String traceId)
      Delete Recorded Payment The API is used to delete the recorded payment.
      ApiClient getApiClient()  
      ApiResponse<PaymentResponse> getPayment​(java.lang.String channel, java.lang.String clientKey, java.lang.String product, java.lang.String timestamp, java.lang.String idempotentRequestKey, java.lang.String requestorType, java.lang.String ID_PAYMENT, java.lang.String ID_CUSTOMER, java.lang.String requestor, java.lang.String xOPAYHeaders, java.lang.String traceId)
      Get Payment The API is used to retrieve the details of a payment or a recorded payment by id.
      com.squareup.okhttp.Call getPaymentAsync​(java.lang.String channel, java.lang.String clientKey, java.lang.String product, java.lang.String timestamp, java.lang.String idempotentRequestKey, java.lang.String requestorType, java.lang.String ID_PAYMENT, java.lang.String ID_CUSTOMER, java.lang.String requestor, java.lang.String xOPAYHeaders, java.lang.String traceId, ApiCallback<PaymentResponse> callback)
      Get Payment (asynchronously) The API is used to retrieve the details of a payment or a recorded payment by id.
      com.squareup.okhttp.Call getPaymentCall​(java.lang.String channel, java.lang.String clientKey, java.lang.String product, java.lang.String timestamp, java.lang.String idempotentRequestKey, java.lang.String requestorType, java.lang.String ID_PAYMENT, 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 getPayment
      ApiResponse<PaymentResponse> getPaymentWithHttpInfo​(java.lang.String channel, java.lang.String clientKey, java.lang.String product, java.lang.String timestamp, java.lang.String idempotentRequestKey, java.lang.String requestorType, java.lang.String ID_PAYMENT, java.lang.String ID_CUSTOMER, java.lang.String requestor, java.lang.String xOPAYHeaders, java.lang.String traceId)
      Get Payment The API is used to retrieve the details of a payment or a recorded payment by id.
      ApiResponse<RecordedPaymentResponse> recordPayment​(java.lang.String channel, java.lang.String clientKey, java.lang.String product, java.lang.String timestamp, java.lang.String idempotentRequestKey, java.lang.String requestorType, RecordPaymentRequest recordPaymentRequest, java.lang.String requestor, java.lang.String xOPAYHeaders, java.lang.String traceId)
      Record Payment The API is used to record payments in EBPP those are made and fulfilled outside EBPP.
      com.squareup.okhttp.Call recordPaymentAsync​(java.lang.String channel, java.lang.String clientKey, java.lang.String product, java.lang.String timestamp, java.lang.String idempotentRequestKey, java.lang.String requestorType, RecordPaymentRequest recordPaymentRequest, java.lang.String requestor, java.lang.String xOPAYHeaders, java.lang.String traceId, ApiCallback<RecordedPaymentResponse> callback)
      Record Payment (asynchronously) The API is used to record payments in EBPP those are made and fulfilled outside EBPP.
      com.squareup.okhttp.Call recordPaymentCall​(java.lang.String channel, java.lang.String clientKey, java.lang.String product, java.lang.String timestamp, java.lang.String idempotentRequestKey, java.lang.String requestorType, RecordPaymentRequest recordPaymentRequest, java.lang.String requestor, java.lang.String xOPAYHeaders, java.lang.String traceId, ProgressResponseBody.ProgressListener progressListener, ProgressRequestBody.ProgressRequestListener progressRequestListener)
      Build call for recordPayment
      ApiResponse<RecordedPaymentResponse> recordPaymentWithHttpInfo​(java.lang.String channel, java.lang.String clientKey, java.lang.String product, java.lang.String timestamp, java.lang.String idempotentRequestKey, java.lang.String requestorType, RecordPaymentRequest recordPaymentRequest, java.lang.String requestor, java.lang.String xOPAYHeaders, java.lang.String traceId)
      Record Payment The API is used to record payments in EBPP those are made and fulfilled outside EBPP.
      ApiResponse<PaymentResponse> retrieveFeePayment​(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_FEE, java.lang.String ID_CUSTOMER, java.lang.String requestor, java.lang.String xOPAYHeaders, java.lang.String traceId)
      Get Fee Payment The API is used to retrieve the details of a fee payment by id.
      com.squareup.okhttp.Call retrieveFeePaymentAsync​(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_FEE, java.lang.String ID_CUSTOMER, java.lang.String requestor, java.lang.String xOPAYHeaders, java.lang.String traceId, ApiCallback<PaymentResponse> callback)
      Get Fee Payment (asynchronously) The API is used to retrieve the details of a fee payment by id.
      com.squareup.okhttp.Call retrieveFeePaymentCall​(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_FEE, 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 retrieveFeePayment
      ApiResponse<PaymentResponse> retrieveFeePaymentWithHttpInfo​(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_FEE, java.lang.String ID_CUSTOMER, java.lang.String requestor, java.lang.String xOPAYHeaders, java.lang.String traceId)
      Get Fee Payment The API is used to retrieve the details of a fee payment by id.
      ApiResponse<PaymentsResponse> retrievePayments​(java.lang.String channel, java.lang.String clientKey, java.lang.String product, java.lang.String timestamp, java.lang.String idempotentRequestKey, java.lang.String requestorType, java.lang.String requestor, java.lang.String xOPAYHeaders, java.lang.String traceId, java.lang.String idCustomer, java.lang.String idFundingAccount, java.lang.String idCustomerAccount, java.lang.String confirmationNumber, java.util.List<java.lang.String> status, java.util.List<java.lang.String> paymentScheduleType, java.util.List<java.lang.String> paymentMethod, java.lang.String fromDate, java.lang.String toDate, java.lang.String pageSize, java.lang.String queryId, java.lang.String fromIndex, java.lang.String toIndex)
      Retrieve Payments The API is used to retrieve the payments and recorded payments made by a customer.
      com.squareup.okhttp.Call retrievePaymentsAsync​(java.lang.String channel, java.lang.String clientKey, java.lang.String product, java.lang.String timestamp, java.lang.String idempotentRequestKey, java.lang.String requestorType, java.lang.String requestor, java.lang.String xOPAYHeaders, java.lang.String traceId, java.lang.String idCustomer, java.lang.String idFundingAccount, java.lang.String idCustomerAccount, java.lang.String confirmationNumber, java.util.List<java.lang.String> status, java.util.List<java.lang.String> paymentScheduleType, java.util.List<java.lang.String> paymentMethod, java.lang.String fromDate, java.lang.String toDate, java.lang.String pageSize, java.lang.String queryId, java.lang.String fromIndex, java.lang.String toIndex, ApiCallback<PaymentsResponse> callback)
      Retrieve Payments (asynchronously) The API is used to retrieve the payments and recorded payments made by a customer.
      com.squareup.okhttp.Call retrievePaymentsCall​(java.lang.String channel, java.lang.String clientKey, java.lang.String product, java.lang.String timestamp, java.lang.String idempotentRequestKey, java.lang.String requestorType, java.lang.String requestor, java.lang.String xOPAYHeaders, java.lang.String traceId, java.lang.String idCustomer, java.lang.String idFundingAccount, java.lang.String idCustomerAccount, java.lang.String confirmationNumber, java.util.List<java.lang.String> status, java.util.List<java.lang.String> paymentScheduleType, java.util.List<java.lang.String> paymentMethod, java.lang.String fromDate, java.lang.String toDate, java.lang.String pageSize, java.lang.String queryId, java.lang.String fromIndex, java.lang.String toIndex, ProgressResponseBody.ProgressListener progressListener, ProgressRequestBody.ProgressRequestListener progressRequestListener)
      Build call for retrievePayments
      ApiResponse<PaymentsResponse> retrievePaymentsWithHttpInfo​(java.lang.String channel, java.lang.String clientKey, java.lang.String product, java.lang.String timestamp, java.lang.String idempotentRequestKey, java.lang.String requestorType, java.lang.String requestor, java.lang.String xOPAYHeaders, java.lang.String traceId, java.lang.String idCustomer, java.lang.String idFundingAccount, java.lang.String idCustomerAccount, java.lang.String confirmationNumber, java.util.List<java.lang.String> status, java.util.List<java.lang.String> paymentScheduleType, java.util.List<java.lang.String> paymentMethod, java.lang.String fromDate, java.lang.String toDate, java.lang.String pageSize, java.lang.String queryId, java.lang.String fromIndex, java.lang.String toIndex)
      Retrieve Payments The API is used to retrieve the payments and recorded payments made by a customer.
      void setApiClient​(ApiClient apiClient)  
      ApiResponse<SimplePaymentResponse> simplePayment​(java.lang.String channel, java.lang.String clientKey, java.lang.String product, java.lang.String timestamp, java.lang.String idempotentRequestKey, java.lang.String requestorType, SimplePaymentRequest simplePaymentRequest, java.lang.String requestor, java.lang.String xOPAYHeaders, java.lang.String traceId, java.lang.String saveFundingAccount)
      Simple Payment The API is used to make payments to service a customer account.
      com.squareup.okhttp.Call simplePaymentAsync​(java.lang.String channel, java.lang.String clientKey, java.lang.String product, java.lang.String timestamp, java.lang.String idempotentRequestKey, java.lang.String requestorType, SimplePaymentRequest simplePaymentRequest, java.lang.String requestor, java.lang.String xOPAYHeaders, java.lang.String traceId, java.lang.String saveFundingAccount, ApiCallback<SimplePaymentResponse> callback)
      Simple Payment (asynchronously) The API is used to make payments to service a customer account.
      com.squareup.okhttp.Call simplePaymentCall​(java.lang.String channel, java.lang.String clientKey, java.lang.String product, java.lang.String timestamp, java.lang.String idempotentRequestKey, java.lang.String requestorType, SimplePaymentRequest simplePaymentRequest, java.lang.String requestor, java.lang.String xOPAYHeaders, java.lang.String traceId, java.lang.String saveFundingAccount, ProgressResponseBody.ProgressListener progressListener, ProgressRequestBody.ProgressRequestListener progressRequestListener)
      Build call for simplePayment
      ApiResponse<SimplePaymentResponse> simplePaymentWithHttpInfo​(java.lang.String channel, java.lang.String clientKey, java.lang.String product, java.lang.String timestamp, java.lang.String idempotentRequestKey, java.lang.String requestorType, SimplePaymentRequest simplePaymentRequest, java.lang.String requestor, java.lang.String xOPAYHeaders, java.lang.String traceId, java.lang.String saveFundingAccount)
      Simple Payment The API is used to make payments to service a customer account.
      ApiResponse<PaymentResponse> updatePayment​(java.lang.String channel, java.lang.String clientKey, java.lang.String product, java.lang.String timestamp, java.lang.String idempotentRequestKey, java.lang.String requestorType, java.lang.String ID_PAYMENT, java.lang.String ID_CUSTOMER, UpdatePaymentRequest updatePaymentRequest, java.lang.String requestor, java.lang.String xOPAYHeaders, java.lang.String traceId)
      Update Payment The API is used to edit a payment.
      com.squareup.okhttp.Call updatePaymentAsync​(java.lang.String channel, java.lang.String clientKey, java.lang.String product, java.lang.String timestamp, java.lang.String idempotentRequestKey, java.lang.String requestorType, java.lang.String ID_PAYMENT, java.lang.String ID_CUSTOMER, UpdatePaymentRequest updatePaymentRequest, java.lang.String requestor, java.lang.String xOPAYHeaders, java.lang.String traceId, ApiCallback<PaymentResponse> callback)
      Update Payment (asynchronously) The API is used to edit a payment.
      com.squareup.okhttp.Call updatePaymentCall​(java.lang.String channel, java.lang.String clientKey, java.lang.String product, java.lang.String timestamp, java.lang.String idempotentRequestKey, java.lang.String requestorType, java.lang.String ID_PAYMENT, java.lang.String ID_CUSTOMER, UpdatePaymentRequest updatePaymentRequest, java.lang.String requestor, java.lang.String xOPAYHeaders, java.lang.String traceId, ProgressResponseBody.ProgressListener progressListener, ProgressRequestBody.ProgressRequestListener progressRequestListener)
      Build call for updatePayment
      ApiResponse<PaymentResponse> updatePaymentWithHttpInfo​(java.lang.String channel, java.lang.String clientKey, java.lang.String product, java.lang.String timestamp, java.lang.String idempotentRequestKey, java.lang.String requestorType, java.lang.String ID_PAYMENT, java.lang.String ID_CUSTOMER, UpdatePaymentRequest updatePaymentRequest, java.lang.String requestor, java.lang.String xOPAYHeaders, java.lang.String traceId)
      Update Payment The API is used to edit a payment.

      • Methods inherited from class java.lang.Object

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

    • Constructor Detail

      • PaymentApi

        public PaymentApi​(ApiClient apiClient)

    • Method Detail

      • getApiClient

        public ApiClient getApiClient()

      • setApiClient

        public void setApiClient​(ApiClient apiClient)

      • createPaymentCall

        public com.squareup.okhttp.Call createPaymentCall​(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,
                                                  CreatePaymentRequest createPaymentRequest,
                                                  java.lang.String requestor,
                                                  java.lang.String xOPAYHeaders,
                                                  java.lang.String traceId,
                                                  ProgressResponseBody.ProgressListener progressListener,
                                                  ProgressRequestBody.ProgressRequestListener progressRequestListener)
                                           throws ApiException
        Build call for createPayment
        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)
        createPaymentRequest - JSON containing all the fields required to make a payment. (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

      • createPayment

        public ApiResponse<PaymentResponse> createPayment​(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,
                                                  CreatePaymentRequest createPaymentRequest,
                                                  java.lang.String requestor,
                                                  java.lang.String xOPAYHeaders,
                                                  java.lang.String traceId)
                                           throws ApiException
        Create Payment The API is used to make payments to service a customer account. Client systems can provide the unique identifier for the payment in their system as payment_reference.<p>Fee amount and fee type are conditional and should be provided if the details of the fee to be charged are maintained in the client system. The fee types that are supported in EBPP are add_to_principal and bill_separately. Alternatively, the fee information can be setup in EBPP, in which case, these fields are ignored. If fee information is setup in the system, the details of the fee are returned in the response.
        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)
        createPaymentRequest - JSON containing all the fields required to make a payment. (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:
        PaymentResponse
        Throws:
        ApiException - If fail to call the API, e.g. server error or cannot deserialize the response body

      • createPaymentWithHttpInfo

        public ApiResponse<PaymentResponse> createPaymentWithHttpInfo​(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,
                                                              CreatePaymentRequest createPaymentRequest,
                                                              java.lang.String requestor,
                                                              java.lang.String xOPAYHeaders,
                                                              java.lang.String traceId)
                                                       throws ApiException
        Create Payment The API is used to make payments to service a customer account. Client systems can provide the unique identifier for the payment in their system as payment_reference.<p>Fee amount and fee type are conditional and should be provided if the details of the fee to be charged are maintained in the client system. The fee types that are supported in EBPP are add_to_principal and bill_separately. Alternatively, the fee information can be setup in EBPP, in which case, these fields are ignored. If fee information is setup in the system, the details of the fee are returned in the response.
        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)
        createPaymentRequest - JSON containing all the fields required to make a payment. (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<PaymentResponse>
        Throws:
        ApiException - If fail to call the API, e.g. server error or cannot deserialize the response body

      • createPaymentAsync

        public com.squareup.okhttp.Call createPaymentAsync​(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,
                                                   CreatePaymentRequest createPaymentRequest,
                                                   java.lang.String requestor,
                                                   java.lang.String xOPAYHeaders,
                                                   java.lang.String traceId,
                                                   ApiCallback<PaymentResponse> callback)
                                            throws ApiException
        Create Payment (asynchronously) The API is used to make payments to service a customer account. Client systems can provide the unique identifier for the payment in their system as payment_reference.<p>Fee amount and fee type are conditional and should be provided if the details of the fee to be charged are maintained in the client system. The fee types that are supported in EBPP are add_to_principal and bill_separately. Alternatively, the fee information can be setup in EBPP, in which case, these fields are ignored. If fee information is setup in the system, the details of the fee are returned in the response.
        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)
        createPaymentRequest - JSON containing all the fields required to make a payment. (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

      • deletePaymentCall

        public com.squareup.okhttp.Call deletePaymentCall​(java.lang.String channel,
                                                  java.lang.String clientKey,
                                                  java.lang.String product,
                                                  java.lang.String timestamp,
                                                  java.lang.String idempotentRequestKey,
                                                  java.lang.String requestorType,
                                                  java.lang.String ID_PAYMENT,
                                                  java.lang.String ID_CUSTOMER,
                                                  DeletePaymentRequest deletePaymentRequest,
                                                  java.lang.String requestor,
                                                  java.lang.String xOPAYHeaders,
                                                  java.lang.String traceId,
                                                  ProgressResponseBody.ProgressListener progressListener,
                                                  ProgressRequestBody.ProgressRequestListener progressRequestListener)
                                           throws ApiException
        Build call for deletePayment
        Parameters:
        channel - The channel through which the API is invoked. (required)
        clientKey - The unique identifier assigned by EBPP to the client. (required)
        product - The product identifier corresponding to the API. (required)
        timestamp - The timestamp for the moment when the API request is created. (required)
        idempotentRequestKey - The unique token that clients can generate and maintain in order to identify an API request. (required)
        requestorType - Type of the requestor of the API. (required)
        ID_PAYMENT - The unique identifier assigned by EBPP to the payment. (required)
        ID_CUSTOMER - The unique identifier assigned by EBPP to the customer. (required)
        deletePaymentRequest - Details of payment to be deleted/cancelled (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

      • deletePayment

        public ApiResponse<DeleteResponse> deletePayment​(java.lang.String channel,
                                                 java.lang.String clientKey,
                                                 java.lang.String product,
                                                 java.lang.String timestamp,
                                                 java.lang.String idempotentRequestKey,
                                                 java.lang.String requestorType,
                                                 java.lang.String ID_PAYMENT,
                                                 java.lang.String ID_CUSTOMER,
                                                 DeletePaymentRequest deletePaymentRequest,
                                                 java.lang.String requestor,
                                                 java.lang.String xOPAYHeaders,
                                                 java.lang.String traceId)
                                          throws ApiException
        Delete Payment The API is used to delete or cancel a payment. Payments that are under processing or have already been processed cannot be deleted.
        Parameters:
        channel - The channel through which the API is invoked. (required)
        clientKey - The unique identifier assigned by EBPP to the client. (required)
        product - The product identifier corresponding to the API. (required)
        timestamp - The timestamp for the moment when the API request is created. (required)
        idempotentRequestKey - The unique token that clients can generate and maintain in order to identify an API request. (required)
        requestorType - Type of the requestor of the API. (required)
        ID_PAYMENT - The unique identifier assigned by EBPP to the payment. (required)
        ID_CUSTOMER - The unique identifier assigned by EBPP to the customer. (required)
        deletePaymentRequest - Details of payment to be deleted/cancelled (required)
        requestor - The identifier for the requestor of the API. (optional)
        xOPAYHeaders - Intended for the future use. (optional)
        traceId - The unique reference that can be used for tracing and debugging an API call. (optional)
        Returns:
        DeleteResponse
        Throws:
        ApiException - If fail to call the API, e.g. server error or cannot deserialize the response body

      • deletePaymentWithHttpInfo

        public ApiResponse<DeleteResponse> deletePaymentWithHttpInfo​(java.lang.String channel,
                                                             java.lang.String clientKey,
                                                             java.lang.String product,
                                                             java.lang.String timestamp,
                                                             java.lang.String idempotentRequestKey,
                                                             java.lang.String requestorType,
                                                             java.lang.String ID_PAYMENT,
                                                             java.lang.String ID_CUSTOMER,
                                                             DeletePaymentRequest deletePaymentRequest,
                                                             java.lang.String requestor,
                                                             java.lang.String xOPAYHeaders,
                                                             java.lang.String traceId)
                                                      throws ApiException
        Delete Payment The API is used to delete or cancel a payment. Payments that are under processing or have already been processed cannot be deleted.
        Parameters:
        channel - The channel through which the API is invoked. (required)
        clientKey - The unique identifier assigned by EBPP to the client. (required)
        product - The product identifier corresponding to the API. (required)
        timestamp - The timestamp for the moment when the API request is created. (required)
        idempotentRequestKey - The unique token that clients can generate and maintain in order to identify an API request. (required)
        requestorType - Type of the requestor of the API. (required)
        ID_PAYMENT - The unique identifier assigned by EBPP to the payment. (required)
        ID_CUSTOMER - The unique identifier assigned by EBPP to the customer. (required)
        deletePaymentRequest - Details of payment to be deleted/cancelled (required)
        requestor - The identifier for the requestor of the API. (optional)
        xOPAYHeaders - Intended for the future use. (optional)
        traceId - The unique reference that can be used for tracing and debugging an API call. (optional)
        Returns:
        ApiResponse<DeleteResponse>
        Throws:
        ApiException - If fail to call the API, e.g. server error or cannot deserialize the response body

      • deletePaymentAsync

        public com.squareup.okhttp.Call deletePaymentAsync​(java.lang.String channel,
                                                   java.lang.String clientKey,
                                                   java.lang.String product,
                                                   java.lang.String timestamp,
                                                   java.lang.String idempotentRequestKey,
                                                   java.lang.String requestorType,
                                                   java.lang.String ID_PAYMENT,
                                                   java.lang.String ID_CUSTOMER,
                                                   DeletePaymentRequest deletePaymentRequest,
                                                   java.lang.String requestor,
                                                   java.lang.String xOPAYHeaders,
                                                   java.lang.String traceId,
                                                   ApiCallback<DeleteResponse> callback)
                                            throws ApiException
        Delete Payment (asynchronously) The API is used to delete or cancel a payment. Payments that are under processing or have already been processed cannot be deleted.
        Parameters:
        channel - The channel through which the API is invoked. (required)
        clientKey - The unique identifier assigned by EBPP to the client. (required)
        product - The product identifier corresponding to the API. (required)
        timestamp - The timestamp for the moment when the API request is created. (required)
        idempotentRequestKey - The unique token that clients can generate and maintain in order to identify an API request. (required)
        requestorType - Type of the requestor of the API. (required)
        ID_PAYMENT - The unique identifier assigned by EBPP to the payment. (required)
        ID_CUSTOMER - The unique identifier assigned by EBPP to the customer. (required)
        deletePaymentRequest - Details of payment to be deleted/cancelled (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

      • deleteRecordPaymentCall

        public com.squareup.okhttp.Call deleteRecordPaymentCall​(java.lang.String channel,
                                                        java.lang.String clientKey,
                                                        java.lang.String product,
                                                        java.lang.String timestamp,
                                                        java.lang.String idempotentRequestKey,
                                                        java.lang.String requestorType,
                                                        java.lang.String ID_PAYMENT,
                                                        DeleteRecordedPaymentRequest deleteRecordedPaymentRequest,
                                                        java.lang.String requestor,
                                                        java.lang.String xOPAYHeaders,
                                                        java.lang.String traceId,
                                                        ProgressResponseBody.ProgressListener progressListener,
                                                        ProgressRequestBody.ProgressRequestListener progressRequestListener)
                                                 throws ApiException
        Build call for deleteRecordPayment
        Parameters:
        channel - The channel through which the API is invoked. (required)
        clientKey - The unique identifier assigned by EBPP to the client. (required)
        product - The product identifier corresponding to the API. (required)
        timestamp - The timestamp for the moment when the API request is created. (required)
        idempotentRequestKey - The unique token that clients can generate and maintain in order to identify an API request. (required)
        requestorType - Type of the requestor of the API. (required)
        ID_PAYMENT - The unique identifier assigned by EBPP to the payment. (required)
        deleteRecordedPaymentRequest - Details of payment to be deleted/cancelled (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

      • deleteRecordPayment

        public ApiResponse<java.lang.Void> deleteRecordPayment​(java.lang.String channel,
                                                       java.lang.String clientKey,
                                                       java.lang.String product,
                                                       java.lang.String timestamp,
                                                       java.lang.String idempotentRequestKey,
                                                       java.lang.String requestorType,
                                                       java.lang.String ID_PAYMENT,
                                                       DeleteRecordedPaymentRequest deleteRecordedPaymentRequest,
                                                       java.lang.String requestor,
                                                       java.lang.String xOPAYHeaders,
                                                       java.lang.String traceId)
                                                throws ApiException
        Delete Recorded Payment The API is used to delete the recorded payment. It returns 204 http status code with empty body in successful case
        Parameters:
        channel - The channel through which the API is invoked. (required)
        clientKey - The unique identifier assigned by EBPP to the client. (required)
        product - The product identifier corresponding to the API. (required)
        timestamp - The timestamp for the moment when the API request is created. (required)
        idempotentRequestKey - The unique token that clients can generate and maintain in order to identify an API request. (required)
        requestorType - Type of the requestor of the API. (required)
        ID_PAYMENT - The unique identifier assigned by EBPP to the payment. (required)
        deleteRecordedPaymentRequest - Details of payment to be deleted/cancelled (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)
        Throws:
        ApiException - If fail to call the API, e.g. server error or cannot deserialize the response body

      • deleteRecordPaymentWithHttpInfo

        public ApiResponse<java.lang.Void> deleteRecordPaymentWithHttpInfo​(java.lang.String channel,
                                                                   java.lang.String clientKey,
                                                                   java.lang.String product,
                                                                   java.lang.String timestamp,
                                                                   java.lang.String idempotentRequestKey,
                                                                   java.lang.String requestorType,
                                                                   java.lang.String ID_PAYMENT,
                                                                   DeleteRecordedPaymentRequest deleteRecordedPaymentRequest,
                                                                   java.lang.String requestor,
                                                                   java.lang.String xOPAYHeaders,
                                                                   java.lang.String traceId)
                                                            throws ApiException
        Delete Recorded Payment The API is used to delete the recorded payment. It returns 204 http status code with empty body in successful case
        Parameters:
        channel - The channel through which the API is invoked. (required)
        clientKey - The unique identifier assigned by EBPP to the client. (required)
        product - The product identifier corresponding to the API. (required)
        timestamp - The timestamp for the moment when the API request is created. (required)
        idempotentRequestKey - The unique token that clients can generate and maintain in order to identify an API request. (required)
        requestorType - Type of the requestor of the API. (required)
        ID_PAYMENT - The unique identifier assigned by EBPP to the payment. (required)
        deleteRecordedPaymentRequest - Details of payment to be deleted/cancelled (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<Void>
        Throws:
        ApiException - If fail to call the API, e.g. server error or cannot deserialize the response body

      • deleteRecordPaymentAsync

        public com.squareup.okhttp.Call deleteRecordPaymentAsync​(java.lang.String channel,
                                                         java.lang.String clientKey,
                                                         java.lang.String product,
                                                         java.lang.String timestamp,
                                                         java.lang.String idempotentRequestKey,
                                                         java.lang.String requestorType,
                                                         java.lang.String ID_PAYMENT,
                                                         DeleteRecordedPaymentRequest deleteRecordedPaymentRequest,
                                                         java.lang.String requestor,
                                                         java.lang.String xOPAYHeaders,
                                                         java.lang.String traceId,
                                                         ApiCallback<java.lang.Void> callback)
                                                  throws ApiException
        Delete Recorded Payment (asynchronously) The API is used to delete the recorded payment. It returns 204 http status code with empty body in successful case
        Parameters:
        channel - The channel through which the API is invoked. (required)
        clientKey - The unique identifier assigned by EBPP to the client. (required)
        product - The product identifier corresponding to the API. (required)
        timestamp - The timestamp for the moment when the API request is created. (required)
        idempotentRequestKey - The unique token that clients can generate and maintain in order to identify an API request. (required)
        requestorType - Type of the requestor of the API. (required)
        ID_PAYMENT - The unique identifier assigned by EBPP to the payment. (required)
        deleteRecordedPaymentRequest - Details of payment to be deleted/cancelled (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

      • getPaymentCall

        public com.squareup.okhttp.Call getPaymentCall​(java.lang.String channel,
                                               java.lang.String clientKey,
                                               java.lang.String product,
                                               java.lang.String timestamp,
                                               java.lang.String idempotentRequestKey,
                                               java.lang.String requestorType,
                                               java.lang.String ID_PAYMENT,
                                               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 getPayment
        Parameters:
        channel - The channel through which the API is invoked. (required)
        clientKey - The unique identifier assigned by EBPP to the client. (required)
        product - The product identifier corresponding to the API. (required)
        timestamp - The timestamp for the moment when the API request is created. (required)
        idempotentRequestKey - The unique token that clients can generate and maintain in order to identify an API request. (required)
        requestorType - Type of the requestor of the API. (required)
        ID_PAYMENT - The unique identifier assigned by EBPP to the payment. (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

      • getPayment

        public ApiResponse<PaymentResponse> getPayment​(java.lang.String channel,
                                               java.lang.String clientKey,
                                               java.lang.String product,
                                               java.lang.String timestamp,
                                               java.lang.String idempotentRequestKey,
                                               java.lang.String requestorType,
                                               java.lang.String ID_PAYMENT,
                                               java.lang.String ID_CUSTOMER,
                                               java.lang.String requestor,
                                               java.lang.String xOPAYHeaders,
                                               java.lang.String traceId)
                                        throws ApiException
        Get Payment The API is used to retrieve the details of a payment or a recorded payment by id.
        Parameters:
        channel - The channel through which the API is invoked. (required)
        clientKey - The unique identifier assigned by EBPP to the client. (required)
        product - The product identifier corresponding to the API. (required)
        timestamp - The timestamp for the moment when the API request is created. (required)
        idempotentRequestKey - The unique token that clients can generate and maintain in order to identify an API request. (required)
        requestorType - Type of the requestor of the API. (required)
        ID_PAYMENT - The unique identifier assigned by EBPP to the payment. (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:
        PaymentResponse
        Throws:
        ApiException - If fail to call the API, e.g. server error or cannot deserialize the response body

      • getPaymentWithHttpInfo

        public ApiResponse<PaymentResponse> getPaymentWithHttpInfo​(java.lang.String channel,
                                                           java.lang.String clientKey,
                                                           java.lang.String product,
                                                           java.lang.String timestamp,
                                                           java.lang.String idempotentRequestKey,
                                                           java.lang.String requestorType,
                                                           java.lang.String ID_PAYMENT,
                                                           java.lang.String ID_CUSTOMER,
                                                           java.lang.String requestor,
                                                           java.lang.String xOPAYHeaders,
                                                           java.lang.String traceId)
                                                    throws ApiException
        Get Payment The API is used to retrieve the details of a payment or a recorded payment by id.
        Parameters:
        channel - The channel through which the API is invoked. (required)
        clientKey - The unique identifier assigned by EBPP to the client. (required)
        product - The product identifier corresponding to the API. (required)
        timestamp - The timestamp for the moment when the API request is created. (required)
        idempotentRequestKey - The unique token that clients can generate and maintain in order to identify an API request. (required)
        requestorType - Type of the requestor of the API. (required)
        ID_PAYMENT - The unique identifier assigned by EBPP to the payment. (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<PaymentResponse>
        Throws:
        ApiException - If fail to call the API, e.g. server error or cannot deserialize the response body

      • getPaymentAsync

        public com.squareup.okhttp.Call getPaymentAsync​(java.lang.String channel,
                                                java.lang.String clientKey,
                                                java.lang.String product,
                                                java.lang.String timestamp,
                                                java.lang.String idempotentRequestKey,
                                                java.lang.String requestorType,
                                                java.lang.String ID_PAYMENT,
                                                java.lang.String ID_CUSTOMER,
                                                java.lang.String requestor,
                                                java.lang.String xOPAYHeaders,
                                                java.lang.String traceId,
                                                ApiCallback<PaymentResponse> callback)
                                         throws ApiException
        Get Payment (asynchronously) The API is used to retrieve the details of a payment or a recorded payment by id.
        Parameters:
        channel - The channel through which the API is invoked. (required)
        clientKey - The unique identifier assigned by EBPP to the client. (required)
        product - The product identifier corresponding to the API. (required)
        timestamp - The timestamp for the moment when the API request is created. (required)
        idempotentRequestKey - The unique token that clients can generate and maintain in order to identify an API request. (required)
        requestorType - Type of the requestor of the API. (required)
        ID_PAYMENT - The unique identifier assigned by EBPP to the payment. (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

      • recordPaymentCall

        public com.squareup.okhttp.Call recordPaymentCall​(java.lang.String channel,
                                                  java.lang.String clientKey,
                                                  java.lang.String product,
                                                  java.lang.String timestamp,
                                                  java.lang.String idempotentRequestKey,
                                                  java.lang.String requestorType,
                                                  RecordPaymentRequest recordPaymentRequest,
                                                  java.lang.String requestor,
                                                  java.lang.String xOPAYHeaders,
                                                  java.lang.String traceId,
                                                  ProgressResponseBody.ProgressListener progressListener,
                                                  ProgressRequestBody.ProgressRequestListener progressRequestListener)
                                           throws ApiException
        Build call for recordPayment
        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)
        recordPaymentRequest - JSON containing all the fields required to record a payment. (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

      • recordPayment

        public ApiResponse<RecordedPaymentResponse> recordPayment​(java.lang.String channel,
                                                          java.lang.String clientKey,
                                                          java.lang.String product,
                                                          java.lang.String timestamp,
                                                          java.lang.String idempotentRequestKey,
                                                          java.lang.String requestorType,
                                                          RecordPaymentRequest recordPaymentRequest,
                                                          java.lang.String requestor,
                                                          java.lang.String xOPAYHeaders,
                                                          java.lang.String traceId)
                                                   throws ApiException
        Record Payment The API is used to record payments in EBPP those are made and fulfilled outside EBPP.
        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)
        recordPaymentRequest - JSON containing all the fields required to record a payment. (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:
        RecordedPaymentResponse
        Throws:
        ApiException - If fail to call the API, e.g. server error or cannot deserialize the response body

      • recordPaymentWithHttpInfo

        public ApiResponse<RecordedPaymentResponse> recordPaymentWithHttpInfo​(java.lang.String channel,
                                                                      java.lang.String clientKey,
                                                                      java.lang.String product,
                                                                      java.lang.String timestamp,
                                                                      java.lang.String idempotentRequestKey,
                                                                      java.lang.String requestorType,
                                                                      RecordPaymentRequest recordPaymentRequest,
                                                                      java.lang.String requestor,
                                                                      java.lang.String xOPAYHeaders,
                                                                      java.lang.String traceId)
                                                               throws ApiException
        Record Payment The API is used to record payments in EBPP those are made and fulfilled outside EBPP.
        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)
        recordPaymentRequest - JSON containing all the fields required to record a payment. (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<RecordedPaymentResponse>
        Throws:
        ApiException - If fail to call the API, e.g. server error or cannot deserialize the response body

      • recordPaymentAsync

        public com.squareup.okhttp.Call recordPaymentAsync​(java.lang.String channel,
                                                   java.lang.String clientKey,
                                                   java.lang.String product,
                                                   java.lang.String timestamp,
                                                   java.lang.String idempotentRequestKey,
                                                   java.lang.String requestorType,
                                                   RecordPaymentRequest recordPaymentRequest,
                                                   java.lang.String requestor,
                                                   java.lang.String xOPAYHeaders,
                                                   java.lang.String traceId,
                                                   ApiCallback<RecordedPaymentResponse> callback)
                                            throws ApiException
        Record Payment (asynchronously) The API is used to record payments in EBPP those are made and fulfilled outside EBPP.
        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)
        recordPaymentRequest - JSON containing all the fields required to record a payment. (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

      • retrieveFeePaymentCall

        public com.squareup.okhttp.Call retrieveFeePaymentCall​(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_FEE,
                                                       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 retrieveFeePayment
        Parameters:
        channel - The channel through which the API is invoked. (required)
        clientKey - The unique identifier assigned by OrbiPay 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_FEE - The unique identifier assigned by OrbiPay to the FeePayment. (required)
        ID_CUSTOMER - The unique identifier assigned by OrbiPay 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

      • retrieveFeePayment

        public ApiResponse<PaymentResponse> retrieveFeePayment​(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_FEE,
                                                       java.lang.String ID_CUSTOMER,
                                                       java.lang.String requestor,
                                                       java.lang.String xOPAYHeaders,
                                                       java.lang.String traceId)
                                                throws ApiException
        Get Fee Payment The API is used to retrieve the details of a fee payment by id.
        Parameters:
        channel - The channel through which the API is invoked. (required)
        clientKey - The unique identifier assigned by OrbiPay 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_FEE - The unique identifier assigned by OrbiPay to the FeePayment. (required)
        ID_CUSTOMER - The unique identifier assigned by OrbiPay 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:
        PaymentResponse
        Throws:
        ApiException - If fail to call the API, e.g. server error or cannot deserialize the response body

      • retrieveFeePaymentWithHttpInfo

        public ApiResponse<PaymentResponse> retrieveFeePaymentWithHttpInfo​(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_FEE,
                                                                   java.lang.String ID_CUSTOMER,
                                                                   java.lang.String requestor,
                                                                   java.lang.String xOPAYHeaders,
                                                                   java.lang.String traceId)
                                                            throws ApiException
        Get Fee Payment The API is used to retrieve the details of a fee payment by id.
        Parameters:
        channel - The channel through which the API is invoked. (required)
        clientKey - The unique identifier assigned by OrbiPay 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_FEE - The unique identifier assigned by OrbiPay to the FeePayment. (required)
        ID_CUSTOMER - The unique identifier assigned by OrbiPay 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<PaymentResponse>
        Throws:
        ApiException - If fail to call the API, e.g. server error or cannot deserialize the response body

      • retrieveFeePaymentAsync

        public com.squareup.okhttp.Call retrieveFeePaymentAsync​(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_FEE,
                                                        java.lang.String ID_CUSTOMER,
                                                        java.lang.String requestor,
                                                        java.lang.String xOPAYHeaders,
                                                        java.lang.String traceId,
                                                        ApiCallback<PaymentResponse> callback)
                                                 throws ApiException
        Get Fee Payment (asynchronously) The API is used to retrieve the details of a fee payment by id.
        Parameters:
        channel - The channel through which the API is invoked. (required)
        clientKey - The unique identifier assigned by OrbiPay 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_FEE - The unique identifier assigned by OrbiPay to the FeePayment. (required)
        ID_CUSTOMER - The unique identifier assigned by OrbiPay 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

      • retrievePaymentsCall

        public com.squareup.okhttp.Call retrievePaymentsCall​(java.lang.String channel,
                                                     java.lang.String clientKey,
                                                     java.lang.String product,
                                                     java.lang.String timestamp,
                                                     java.lang.String idempotentRequestKey,
                                                     java.lang.String requestorType,
                                                     java.lang.String requestor,
                                                     java.lang.String xOPAYHeaders,
                                                     java.lang.String traceId,
                                                     java.lang.String idCustomer,
                                                     java.lang.String idFundingAccount,
                                                     java.lang.String idCustomerAccount,
                                                     java.lang.String confirmationNumber,
                                                     java.util.List<java.lang.String> status,
                                                     java.util.List<java.lang.String> paymentScheduleType,
                                                     java.util.List<java.lang.String> paymentMethod,
                                                     java.lang.String fromDate,
                                                     java.lang.String toDate,
                                                     java.lang.String pageSize,
                                                     java.lang.String queryId,
                                                     java.lang.String fromIndex,
                                                     java.lang.String toIndex,
                                                     ProgressResponseBody.ProgressListener progressListener,
                                                     ProgressRequestBody.ProgressRequestListener progressRequestListener)
                                              throws ApiException
        Build call for retrievePayments
        Parameters:
        channel - The channel through which the API is invoked. (required)
        clientKey - The unique identifier assigned by EBPP to the client. (required)
        product - The product identifier corresponding to the API. (required)
        timestamp - The timestamp for the moment when the API request is created. (required)
        idempotentRequestKey - The unique token that clients can generate and maintain in order to identify an API request. (required)
        requestorType - Type of the requestor of the API. (required)
        requestor - The identifier for the requestor of the API. (optional)
        xOPAYHeaders - Intended for the future use. (optional)
        traceId - The unique reference that can be used for tracing and debugging an API call. (optional)
        idCustomer - The unique identifier assigned by EBPP to the customer. (optional)
        idFundingAccount - The unique identifier assigned by EBPP to the funding account (optional)
        idCustomerAccount - The unique identifier assigned by EBPP to the customer account (optional)
        confirmationNumber - The confirmation number or reference provided to the customer for the successful payment. (optional)
        status - The status of the payment. This can take multiple values in the format key=value1&key=value2.... (optional)
        paymentScheduleType - The schedule type for the payment setup. This can take multiple values in the format key=value1&key=value2.... (optional)
        paymentMethod - The fulfillment method for the payment. (optional)
        fromDate - The date from which payments, matching the criteria specified, need to be retrieved. (optional)
        toDate - The date upto which payments, matching the criteria specified, need to be retrieved. (optional)
        pageSize - The maximum number of objects returned in the query. (optional)
        queryId - query id of the Retrieve/Search Customers lookup. (optional)
        fromIndex - To fetch the next set of objects that start after this object (optional)
        toIndex - To fetch the previous set of objects that end at this object (optional)
        progressListener - Progress listener
        progressRequestListener - Progress request listener
        Returns:
        Call to execute
        Throws:
        ApiException - If fail to serialize the request body object

      • retrievePayments

        public ApiResponse<PaymentsResponse> retrievePayments​(java.lang.String channel,
                                                      java.lang.String clientKey,
                                                      java.lang.String product,
                                                      java.lang.String timestamp,
                                                      java.lang.String idempotentRequestKey,
                                                      java.lang.String requestorType,
                                                      java.lang.String requestor,
                                                      java.lang.String xOPAYHeaders,
                                                      java.lang.String traceId,
                                                      java.lang.String idCustomer,
                                                      java.lang.String idFundingAccount,
                                                      java.lang.String idCustomerAccount,
                                                      java.lang.String confirmationNumber,
                                                      java.util.List<java.lang.String> status,
                                                      java.util.List<java.lang.String> paymentScheduleType,
                                                      java.util.List<java.lang.String> paymentMethod,
                                                      java.lang.String fromDate,
                                                      java.lang.String toDate,
                                                      java.lang.String pageSize,
                                                      java.lang.String queryId,
                                                      java.lang.String fromIndex,
                                                      java.lang.String toIndex)
                                               throws ApiException
        Retrieve Payments The API is used to retrieve the payments and recorded payments made by a customer. Payments can be filtered using the confirmation number, customer account, funding account, status and payment schedule type, payment method, by date range and others mentioned below. If no dates are provided for retrieval, payments in the last six months and all the payments scheduled for a future date are returned. In case a payment has failed due to ACH returns, then the payment return date and the return code will be available in the response. The results are sorted in descending order of the payment_date followed by the last_modified_time.
        Parameters:
        channel - The channel through which the API is invoked. (required)
        clientKey - The unique identifier assigned by EBPP to the client. (required)
        product - The product identifier corresponding to the API. (required)
        timestamp - The timestamp for the moment when the API request is created. (required)
        idempotentRequestKey - The unique token that clients can generate and maintain in order to identify an API request. (required)
        requestorType - Type of the requestor of the API. (required)
        requestor - The identifier for the requestor of the API. (optional)
        xOPAYHeaders - Intended for the future use. (optional)
        traceId - The unique reference that can be used for tracing and debugging an API call. (optional)
        idCustomer - The unique identifier assigned by EBPP to the customer. (optional)
        idFundingAccount - The unique identifier assigned by EBPP to the funding account (optional)
        idCustomerAccount - The unique identifier assigned by EBPP to the customer account (optional)
        confirmationNumber - The confirmation number or reference provided to the customer for the successful payment. (optional)
        status - The status of the payment. This can take multiple values in the format key=value1&key=value2.... (optional)
        paymentScheduleType - The schedule type for the payment setup. This can take multiple values in the format key=value1&key=value2.... (optional)
        paymentMethod - The fulfillment method for the payment. (optional)
        fromDate - The date from which payments, matching the criteria specified, need to be retrieved. (optional)
        toDate - The date upto which payments, matching the criteria specified, need to be retrieved. (optional)
        pageSize - The maximum number of objects returned in the query. (optional)
        queryId - query id of the Retrieve/Search Customers lookup. (optional)
        fromIndex - To fetch the next set of objects that start after this object (optional)
        toIndex - To fetch the previous set of objects that end at this object (optional)
        Returns:
        PaymentsResponse
        Throws:
        ApiException - If fail to call the API, e.g. server error or cannot deserialize the response body

      • retrievePaymentsWithHttpInfo

        public ApiResponse<PaymentsResponse> retrievePaymentsWithHttpInfo​(java.lang.String channel,
                                                                  java.lang.String clientKey,
                                                                  java.lang.String product,
                                                                  java.lang.String timestamp,
                                                                  java.lang.String idempotentRequestKey,
                                                                  java.lang.String requestorType,
                                                                  java.lang.String requestor,
                                                                  java.lang.String xOPAYHeaders,
                                                                  java.lang.String traceId,
                                                                  java.lang.String idCustomer,
                                                                  java.lang.String idFundingAccount,
                                                                  java.lang.String idCustomerAccount,
                                                                  java.lang.String confirmationNumber,
                                                                  java.util.List<java.lang.String> status,
                                                                  java.util.List<java.lang.String> paymentScheduleType,
                                                                  java.util.List<java.lang.String> paymentMethod,
                                                                  java.lang.String fromDate,
                                                                  java.lang.String toDate,
                                                                  java.lang.String pageSize,
                                                                  java.lang.String queryId,
                                                                  java.lang.String fromIndex,
                                                                  java.lang.String toIndex)
                                                           throws ApiException
        Retrieve Payments The API is used to retrieve the payments and recorded payments made by a customer. Payments can be filtered using the confirmation number, customer account, funding account, status and payment schedule type, payment method, by date range and others mentioned below. If no dates are provided for retrieval, payments in the last six months and all the payments scheduled for a future date are returned. In case a payment has failed due to ACH returns, then the payment return date and the return code will be available in the response. The results are sorted in descending order of the payment_date followed by the last_modified_time.
        Parameters:
        channel - The channel through which the API is invoked. (required)
        clientKey - The unique identifier assigned by EBPP to the client. (required)
        product - The product identifier corresponding to the API. (required)
        timestamp - The timestamp for the moment when the API request is created. (required)
        idempotentRequestKey - The unique token that clients can generate and maintain in order to identify an API request. (required)
        requestorType - Type of the requestor of the API. (required)
        requestor - The identifier for the requestor of the API. (optional)
        xOPAYHeaders - Intended for the future use. (optional)
        traceId - The unique reference that can be used for tracing and debugging an API call. (optional)
        idCustomer - The unique identifier assigned by EBPP to the customer. (optional)
        idFundingAccount - The unique identifier assigned by EBPP to the funding account (optional)
        idCustomerAccount - The unique identifier assigned by EBPP to the customer account (optional)
        confirmationNumber - The confirmation number or reference provided to the customer for the successful payment. (optional)
        status - The status of the payment. This can take multiple values in the format key=value1&key=value2.... (optional)
        paymentScheduleType - The schedule type for the payment setup. This can take multiple values in the format key=value1&key=value2.... (optional)
        paymentMethod - The fulfillment method for the payment. (optional)
        fromDate - The date from which payments, matching the criteria specified, need to be retrieved. (optional)
        toDate - The date upto which payments, matching the criteria specified, need to be retrieved. (optional)
        pageSize - The maximum number of objects returned in the query. (optional)
        queryId - query id of the Retrieve/Search Customers lookup. (optional)
        fromIndex - To fetch the next set of objects that start after this object (optional)
        toIndex - To fetch the previous set of objects that end at this object (optional)
        Returns:
        ApiResponse<PaymentsResponse>
        Throws:
        ApiException - If fail to call the API, e.g. server error or cannot deserialize the response body

      • retrievePaymentsAsync

        public com.squareup.okhttp.Call retrievePaymentsAsync​(java.lang.String channel,
                                                      java.lang.String clientKey,
                                                      java.lang.String product,
                                                      java.lang.String timestamp,
                                                      java.lang.String idempotentRequestKey,
                                                      java.lang.String requestorType,
                                                      java.lang.String requestor,
                                                      java.lang.String xOPAYHeaders,
                                                      java.lang.String traceId,
                                                      java.lang.String idCustomer,
                                                      java.lang.String idFundingAccount,
                                                      java.lang.String idCustomerAccount,
                                                      java.lang.String confirmationNumber,
                                                      java.util.List<java.lang.String> status,
                                                      java.util.List<java.lang.String> paymentScheduleType,
                                                      java.util.List<java.lang.String> paymentMethod,
                                                      java.lang.String fromDate,
                                                      java.lang.String toDate,
                                                      java.lang.String pageSize,
                                                      java.lang.String queryId,
                                                      java.lang.String fromIndex,
                                                      java.lang.String toIndex,
                                                      ApiCallback<PaymentsResponse> callback)
                                               throws ApiException
        Retrieve Payments (asynchronously) The API is used to retrieve the payments and recorded payments made by a customer. Payments can be filtered using the confirmation number, customer account, funding account, status and payment schedule type, payment method, by date range and others mentioned below. If no dates are provided for retrieval, payments in the last six months and all the payments scheduled for a future date are returned. In case a payment has failed due to ACH returns, then the payment return date and the return code will be available in the response. The results are sorted in descending order of the payment_date followed by the last_modified_time.
        Parameters:
        channel - The channel through which the API is invoked. (required)
        clientKey - The unique identifier assigned by EBPP to the client. (required)
        product - The product identifier corresponding to the API. (required)
        timestamp - The timestamp for the moment when the API request is created. (required)
        idempotentRequestKey - The unique token that clients can generate and maintain in order to identify an API request. (required)
        requestorType - Type of the requestor of the API. (required)
        requestor - The identifier for the requestor of the API. (optional)
        xOPAYHeaders - Intended for the future use. (optional)
        traceId - The unique reference that can be used for tracing and debugging an API call. (optional)
        idCustomer - The unique identifier assigned by EBPP to the customer. (optional)
        idFundingAccount - The unique identifier assigned by EBPP to the funding account (optional)
        idCustomerAccount - The unique identifier assigned by EBPP to the customer account (optional)
        confirmationNumber - The confirmation number or reference provided to the customer for the successful payment. (optional)
        status - The status of the payment. This can take multiple values in the format key=value1&key=value2.... (optional)
        paymentScheduleType - The schedule type for the payment setup. This can take multiple values in the format key=value1&key=value2.... (optional)
        paymentMethod - The fulfillment method for the payment. (optional)
        fromDate - The date from which payments, matching the criteria specified, need to be retrieved. (optional)
        toDate - The date upto which payments, matching the criteria specified, need to be retrieved. (optional)
        pageSize - The maximum number of objects returned in the query. (optional)
        queryId - query id of the Retrieve/Search Customers lookup. (optional)
        fromIndex - To fetch the next set of objects that start after this object (optional)
        toIndex - To fetch the previous set of objects that end at this object (optional)
        callback - The callback to be executed when the API call finishes
        Returns:
        The request call
        Throws:
        ApiException - If fail to process the API call, e.g. serializing the request body object

      • simplePaymentCall

        public com.squareup.okhttp.Call simplePaymentCall​(java.lang.String channel,
                                                  java.lang.String clientKey,
                                                  java.lang.String product,
                                                  java.lang.String timestamp,
                                                  java.lang.String idempotentRequestKey,
                                                  java.lang.String requestorType,
                                                  SimplePaymentRequest simplePaymentRequest,
                                                  java.lang.String requestor,
                                                  java.lang.String xOPAYHeaders,
                                                  java.lang.String traceId,
                                                  java.lang.String saveFundingAccount,
                                                  ProgressResponseBody.ProgressListener progressListener,
                                                  ProgressRequestBody.ProgressRequestListener progressRequestListener)
                                           throws ApiException
        Build call for simplePayment
        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)
        simplePaymentRequest - JSON containing all the fields required to make a payment. (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)
        saveFundingAccount - query param (optional)
        progressListener - Progress listener
        progressRequestListener - Progress request listener
        Returns:
        Call to execute
        Throws:
        ApiException - If fail to serialize the request body object

      • simplePayment

        public ApiResponse<SimplePaymentResponse> simplePayment​(java.lang.String channel,
                                                        java.lang.String clientKey,
                                                        java.lang.String product,
                                                        java.lang.String timestamp,
                                                        java.lang.String idempotentRequestKey,
                                                        java.lang.String requestorType,
                                                        SimplePaymentRequest simplePaymentRequest,
                                                        java.lang.String requestor,
                                                        java.lang.String xOPAYHeaders,
                                                        java.lang.String traceId,
                                                        java.lang.String saveFundingAccount)
                                                 throws ApiException
        Simple Payment The API is used to make payments to service a customer account. Client systems can provide the unique identifier for the payment in their system as payment_reference. Fee amount and fee type are conditional and should be provided if the details of the fee to be charged are maintained in the client system. The fee types that are supported in EBPP are add_to_principal and bill_separately. Alternatively, the fee information can be setup in EBPP, in which case, these fields are ignored. If fee information is setup in the system, the details of the fee are returned in the response. This API updates the details of the customer, customer account and the funding account if those exist in EBPP or creates them otherwise.
        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)
        simplePaymentRequest - JSON containing all the fields required to make a payment. (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)
        saveFundingAccount - query param (optional)
        Returns:
        SimplePaymentResponse
        Throws:
        ApiException - If fail to call the API, e.g. server error or cannot deserialize the response body

      • simplePaymentWithHttpInfo

        public ApiResponse<SimplePaymentResponse> simplePaymentWithHttpInfo​(java.lang.String channel,
                                                                    java.lang.String clientKey,
                                                                    java.lang.String product,
                                                                    java.lang.String timestamp,
                                                                    java.lang.String idempotentRequestKey,
                                                                    java.lang.String requestorType,
                                                                    SimplePaymentRequest simplePaymentRequest,
                                                                    java.lang.String requestor,
                                                                    java.lang.String xOPAYHeaders,
                                                                    java.lang.String traceId,
                                                                    java.lang.String saveFundingAccount)
                                                             throws ApiException
        Simple Payment The API is used to make payments to service a customer account. Client systems can provide the unique identifier for the payment in their system as payment_reference. Fee amount and fee type are conditional and should be provided if the details of the fee to be charged are maintained in the client system. The fee types that are supported in EBPP are add_to_principal and bill_separately. Alternatively, the fee information can be setup in EBPP, in which case, these fields are ignored. If fee information is setup in the system, the details of the fee are returned in the response. This API updates the details of the customer, customer account and the funding account if those exist in EBPP or creates them otherwise.
        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)
        simplePaymentRequest - JSON containing all the fields required to make a payment. (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)
        saveFundingAccount - query param (optional)
        Returns:
        ApiResponse<SimplePaymentResponse>
        Throws:
        ApiException - If fail to call the API, e.g. server error or cannot deserialize the response body

      • simplePaymentAsync

        public com.squareup.okhttp.Call simplePaymentAsync​(java.lang.String channel,
                                                   java.lang.String clientKey,
                                                   java.lang.String product,
                                                   java.lang.String timestamp,
                                                   java.lang.String idempotentRequestKey,
                                                   java.lang.String requestorType,
                                                   SimplePaymentRequest simplePaymentRequest,
                                                   java.lang.String requestor,
                                                   java.lang.String xOPAYHeaders,
                                                   java.lang.String traceId,
                                                   java.lang.String saveFundingAccount,
                                                   ApiCallback<SimplePaymentResponse> callback)
                                            throws ApiException
        Simple Payment (asynchronously) The API is used to make payments to service a customer account. Client systems can provide the unique identifier for the payment in their system as payment_reference. Fee amount and fee type are conditional and should be provided if the details of the fee to be charged are maintained in the client system. The fee types that are supported in EBPP are add_to_principal and bill_separately. Alternatively, the fee information can be setup in EBPP, in which case, these fields are ignored. If fee information is setup in the system, the details of the fee are returned in the response. This API updates the details of the customer, customer account and the funding account if those exist in EBPP or creates them otherwise.
        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)
        simplePaymentRequest - JSON containing all the fields required to make a payment. (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)
        saveFundingAccount - query param (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

      • updatePaymentCall

        public com.squareup.okhttp.Call updatePaymentCall​(java.lang.String channel,
                                                  java.lang.String clientKey,
                                                  java.lang.String product,
                                                  java.lang.String timestamp,
                                                  java.lang.String idempotentRequestKey,
                                                  java.lang.String requestorType,
                                                  java.lang.String ID_PAYMENT,
                                                  java.lang.String ID_CUSTOMER,
                                                  UpdatePaymentRequest updatePaymentRequest,
                                                  java.lang.String requestor,
                                                  java.lang.String xOPAYHeaders,
                                                  java.lang.String traceId,
                                                  ProgressResponseBody.ProgressListener progressListener,
                                                  ProgressRequestBody.ProgressRequestListener progressRequestListener)
                                           throws ApiException
        Build call for updatePayment
        Parameters:
        channel - The channel through which the API is invoked. (required)
        clientKey - The unique identifier assigned by EBPP to the client. (required)
        product - The product identifier corresponding to the API. (required)
        timestamp - The timestamp for the moment when the API request is created. (required)
        idempotentRequestKey - The unique token that clients can generate and maintain in order to identify an API request. (required)
        requestorType - Type of the requestor of the API. (required)
        ID_PAYMENT - The unique identifier assigned by EBPP to the payment. (required)
        ID_CUSTOMER - The unique identifier assigned by EBPP to the customer. (required)
        updatePaymentRequest - Details of the Payment 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

      • updatePayment

        public ApiResponse<PaymentResponse> updatePayment​(java.lang.String channel,
                                                  java.lang.String clientKey,
                                                  java.lang.String product,
                                                  java.lang.String timestamp,
                                                  java.lang.String idempotentRequestKey,
                                                  java.lang.String requestorType,
                                                  java.lang.String ID_PAYMENT,
                                                  java.lang.String ID_CUSTOMER,
                                                  UpdatePaymentRequest updatePaymentRequest,
                                                  java.lang.String requestor,
                                                  java.lang.String xOPAYHeaders,
                                                  java.lang.String traceId)
                                           throws ApiException
        Update Payment The API is used to edit a payment. Only payments in scheduled status can be edited.
        Parameters:
        channel - The channel through which the API is invoked. (required)
        clientKey - The unique identifier assigned by EBPP to the client. (required)
        product - The product identifier corresponding to the API. (required)
        timestamp - The timestamp for the moment when the API request is created. (required)
        idempotentRequestKey - The unique token that clients can generate and maintain in order to identify an API request. (required)
        requestorType - Type of the requestor of the API. (required)
        ID_PAYMENT - The unique identifier assigned by EBPP to the payment. (required)
        ID_CUSTOMER - The unique identifier assigned by EBPP to the customer. (required)
        updatePaymentRequest - Details of the Payment 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:
        PaymentResponse
        Throws:
        ApiException - If fail to call the API, e.g. server error or cannot deserialize the response body

      • updatePaymentWithHttpInfo

        public ApiResponse<PaymentResponse> updatePaymentWithHttpInfo​(java.lang.String channel,
                                                              java.lang.String clientKey,
                                                              java.lang.String product,
                                                              java.lang.String timestamp,
                                                              java.lang.String idempotentRequestKey,
                                                              java.lang.String requestorType,
                                                              java.lang.String ID_PAYMENT,
                                                              java.lang.String ID_CUSTOMER,
                                                              UpdatePaymentRequest updatePaymentRequest,
                                                              java.lang.String requestor,
                                                              java.lang.String xOPAYHeaders,
                                                              java.lang.String traceId)
                                                       throws ApiException
        Update Payment The API is used to edit a payment. Only payments in scheduled status can be edited.
        Parameters:
        channel - The channel through which the API is invoked. (required)
        clientKey - The unique identifier assigned by EBPP to the client. (required)
        product - The product identifier corresponding to the API. (required)
        timestamp - The timestamp for the moment when the API request is created. (required)
        idempotentRequestKey - The unique token that clients can generate and maintain in order to identify an API request. (required)
        requestorType - Type of the requestor of the API. (required)
        ID_PAYMENT - The unique identifier assigned by EBPP to the payment. (required)
        ID_CUSTOMER - The unique identifier assigned by EBPP to the customer. (required)
        updatePaymentRequest - Details of the Payment 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<PaymentResponse>
        Throws:
        ApiException - If fail to call the API, e.g. server error or cannot deserialize the response body

      • updatePaymentAsync

        public com.squareup.okhttp.Call updatePaymentAsync​(java.lang.String channel,
                                                   java.lang.String clientKey,
                                                   java.lang.String product,
                                                   java.lang.String timestamp,
                                                   java.lang.String idempotentRequestKey,
                                                   java.lang.String requestorType,
                                                   java.lang.String ID_PAYMENT,
                                                   java.lang.String ID_CUSTOMER,
                                                   UpdatePaymentRequest updatePaymentRequest,
                                                   java.lang.String requestor,
                                                   java.lang.String xOPAYHeaders,
                                                   java.lang.String traceId,
                                                   ApiCallback<PaymentResponse> callback)
                                            throws ApiException
        Update Payment (asynchronously) The API is used to edit a payment. Only payments in scheduled status can be edited.
        Parameters:
        channel - The channel through which the API is invoked. (required)
        clientKey - The unique identifier assigned by EBPP to the client. (required)
        product - The product identifier corresponding to the API. (required)
        timestamp - The timestamp for the moment when the API request is created. (required)
        idempotentRequestKey - The unique token that clients can generate and maintain in order to identify an API request. (required)
        requestorType - Type of the requestor of the API. (required)
        ID_PAYMENT - The unique identifier assigned by EBPP to the payment. (required)
        ID_CUSTOMER - The unique identifier assigned by EBPP to the customer. (required)
        updatePaymentRequest - Details of the Payment 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