Class PaymentSetups
- java.lang.Object
-
- com.orbipay.paymentsapi.client.wrappers.Base
-
- com.orbipay.paymentsapi.client.wrappers.PaymentSetups
-
public class PaymentSetups extends Base
-
-
Constructor Summary
Constructors Constructor Description PaymentSetups()
-
Method Summary
All Methods Static Methods Instance Methods Concrete Methods Modifier and Type Method Description PaymentSetups
findBy(MultiMap<java.lang.String> PaymentSetupsFilterMap)
PaymentSetups
forClient(java.lang.String clientKey)
PaymentSetups
forCustomer(java.lang.String idCustomer)
static PaymentSetups
fromJson(java.lang.String json)
PaymentSetups
get(InvocationContext invocationContext, java.lang.String liveMode)
PaymentSetups
get(InvocationContext invocationContext, java.lang.String liveMode, java.lang.String apiEndPoint)
java.lang.String
getConfirmationNumber()
The confirmation number or reference provided to the customer for the successful payment.java.lang.String
getFromDate()
The date from which recurring payments setup, matching the criteria specified, need to be retrieved.java.lang.String
getFromIndex()
The id of the object before which the previous set of objects are to be retrieved.java.lang.String
getHasMoreResults()
true if there are more results or pagesjava.lang.String
getIdCustomer()
The unique identifier assigned by EBPP to the customer.java.lang.String
getIdCustomerAccount()
The unique identifier assigned by EBPP to the customer accountjava.lang.String
getIdFundingAccount()
The unique identifier assigned by EBPP to the funding accountjava.util.List<PaymentSetup>
getList()
Get listjava.lang.String
getPageSize()
The maximum number of objects returned in the query.java.util.List<java.lang.String>
getPaymentSetupScheduleType()
The schedule type for the payment setup.java.lang.String
getQueryId()
The query id of the object.java.util.List<java.lang.String>
getStatus()
The status of the payment.java.lang.String
getToDate()
The date upto which recurring payments setup, matching the criteria specified, need to be retrieved.java.lang.String
getToIndex()
The id of the object after which the next set of objects are to be retrieved.java.lang.String
getTotalResultsCount()
The total number of payment setup available matching the search criteria.java.lang.String
getUrl()
This URL fetches the next or previous set of payment setups, based on the presence of after_object or before_object parameter.PaymentSetups
retrievedBy(java.lang.String requestor, java.lang.String requestorType)
java.lang.String
toJson()
PaymentSetups
videChannel(java.lang.String channel)
-
Methods inherited from class com.orbipay.paymentsapi.client.wrappers.Base
getApiEndPoint, getHttpStatusCode, getInvocationContext, getLiveMode, requestedBy, withContext
-
-
-
-
Method Detail
-
getList
public java.util.List<PaymentSetup> getList()
Get list- Returns:
- list
-
getTotalResultsCount
public java.lang.String getTotalResultsCount()
The total number of payment setup available matching the search criteria.- Returns:
- totalResultsCount
-
getHasMoreResults
public java.lang.String getHasMoreResults()
true if there are more results or pages- Returns:
- hasMoreResults
-
getUrl
public java.lang.String getUrl()
This URL fetches the next or previous set of payment setups, based on the presence of after_object or before_object parameter.- Returns:
- url
-
getFromIndex
public java.lang.String getFromIndex()
The id of the object before which the previous set of objects are to be retrieved.- Returns:
- fromIndex
-
getToIndex
public java.lang.String getToIndex()
The id of the object after which the next set of objects are to be retrieved.- Returns:
- toIndex
-
getQueryId
public java.lang.String getQueryId()
The query id of the object.- Returns:
- queryId
-
getIdCustomer
public java.lang.String getIdCustomer()
The unique identifier assigned by EBPP to the customer.- Returns:
- idCustomer
-
getIdFundingAccount
public java.lang.String getIdFundingAccount()
The unique identifier assigned by EBPP to the funding account- Returns:
- idFundingAccount
-
getIdCustomerAccount
public java.lang.String getIdCustomerAccount()
The unique identifier assigned by EBPP to the customer account- Returns:
- idCustomerAccount
-
getConfirmationNumber
public java.lang.String getConfirmationNumber()
The confirmation number or reference provided to the customer for the successful payment.- Returns:
- confirmationNumber
-
getStatus
public java.util.List<java.lang.String> getStatus()
The status of the payment. This can take multiple values in the format key=value1&key=value2....- Returns:
- status
-
getPaymentSetupScheduleType
public java.util.List<java.lang.String> getPaymentSetupScheduleType()
The schedule type for the payment setup. This can take multiple values in the format key=value1&key=value2....- Returns:
- paymentSetupScheduleType
-
getFromDate
public java.lang.String getFromDate()
The date from which recurring payments setup, matching the criteria specified, need to be retrieved.- Returns:
- fromDate
-
getToDate
public java.lang.String getToDate()
The date upto which recurring payments setup, matching the criteria specified, need to be retrieved.- Returns:
- toDate
-
getPageSize
public java.lang.String getPageSize()
The maximum number of objects returned in the query.- Returns:
- pageSize
-
forClient
public PaymentSetups forClient(java.lang.String clientKey)
-
videChannel
public PaymentSetups videChannel(java.lang.String channel)
- Overrides:
videChannel
in classBase
- Parameters:
channel
- : The channel is of type String.- Returns:
- PaymentSetups: The Instance of PaymentSetups.
-
findBy
public PaymentSetups findBy(MultiMap<java.lang.String> PaymentSetupsFilterMap)
- Parameters:
PaymentSetupsFilterMap
- : The PaymentSetupsFilterMap is of type com.orbipay.paymentsapi.client.MultiMap.- Returns:
- PaymentSetups: The Instance of PaymentSetups.
-
forCustomer
public PaymentSetups forCustomer(java.lang.String idCustomer)
- Parameters:
idCustomer
- : The idCustomer is of type String.- Returns:
- PaymentSetups: The Instance of PaymentSetups.
-
retrievedBy
public PaymentSetups retrievedBy(java.lang.String requestor, java.lang.String requestorType)
- Parameters:
requestor
- : The requestor is of type String.requestorType
- : The requestorType is of type String.- Returns:
- PaymentSetups: The Instance of PaymentSetups.
-
get
public PaymentSetups get(InvocationContext invocationContext, java.lang.String liveMode) throws OrbipayApiException
- Parameters:
invocationContext
- : The invocationContext is of type InvocationContext.liveMode
- : The liveMode is of type String- Returns:
- PaymentSetups: The Instance of PaymentSetups.
- Throws:
OrbipayApiException
- The only Exception that is thrown in Exceptional case
-
get
public PaymentSetups get(InvocationContext invocationContext, java.lang.String liveMode, java.lang.String apiEndPoint) throws OrbipayApiException
- Parameters:
invocationContext
- : The invocationContext is of type InvocationContext.liveMode
- : The liveMode is of type StringapiEndPoint
- : The apiEndPoint is of type String.- Returns:
- PaymentSetups: The Instance of PaymentSetups.
- Throws:
OrbipayApiException
- The only Exception that is thrown in Exceptional case
-
fromJson
public static PaymentSetups fromJson(java.lang.String json) throws OrbipayApiException
- Throws:
OrbipayApiException
-
toJson
public java.lang.String toJson() throws OrbipayApiException
- Throws:
OrbipayApiException
-
-