Package com.orbipay.paymentsapi.client.wrappers

Class PaymentSetup

  • public class PaymentSetup
extends Base

    • Constructor Detail

      • PaymentSetup

        public PaymentSetup()

      • PaymentSetup

        public PaymentSetup​(java.lang.String ID_PAYMENT_SETUP)

    • Method Detail

      • getId

        public java.lang.String getId()
        The unique identifier assigned by Orbipay to the payment setup.
        Returns:
        id

      • getUrl

        public java.lang.String getUrl()
        This URL fetches the details of payment setup.
        Returns:
        url

      • getFee

        public Fee getFee()
        Get fee
        Returns:
        fee

      • getStatus

        public java.lang.String getStatus()
        The status of the payment.
        Returns:
        status

      • getPaymentMethod

        public java.lang.String getPaymentMethod()
        The fulfillment method for the payment.
        Returns:
        paymentMethod

      • getPaymentSetupScheduleType

        public java.lang.String getPaymentSetupScheduleType()
        The schedule type for the payment setup.
        Returns:
        paymentSetupScheduleType

      • getConfirmationNumber

        public java.lang.String getConfirmationNumber()
        The confirmation number or reference provided to the customer for the payment setup.
        Returns:
        confirmationNumber

      • getCustomFields

        public java.util.Map<java.lang.String,​java.lang.String> getCustomFields()
        The additional information or meta-information that Orbipay can accept, maintain and transmit back to the client. The custom fields need to be configured with Orbipay before they can be accepted. Orbipay would reject custom fields that are not pre-configured. Please contact <a href = \"mailto: support@billerpayments.com\">support@billerpayments.com</a> for more information on configuring and using custom fields. Only the custom fields enabled for the client, in Orbipay, would be accepted in the requests.
        Returns:
        customFields

      • getCurrencyCode3d

        public java.lang.String getCurrencyCode3d()
        The three-letter currency code in the ISO4217 format, in uppercase, for the card account. It must be a currency supported by Orbipay. This defaults to USD.
        Returns:
        currencyCode3d

      • getAmount

        public java.lang.String getAmount()
        The amount being paid. In case the payment_amount_type is 'discounted_amount', 'penalty_amount' or 'other', the amount needs to be specified. In other cases, this is derived from the payment_amount_type.
        Returns:
        amount

      • getCardCvvNumber

        public java.lang.String getCardCvvNumber()
        This is never returned by Orbipay. This needs to be passed to Orbipay when making or editing a payment setup with a card funding account.
        Returns:
        cardCvvNumber

      • getNextPaymentDate

        public java.lang.String getNextPaymentDate()
        The date on which the payment is scheduled to be made. It must be in ISO8601 full-date format, namely, YYYY-MM-DD.
        Returns:
        nextPaymentDate

      • getPaymentSetupReference

        public java.lang.String getPaymentSetupReference()
        The unique identifier in the client system for the payment setup.
        Returns:
        paymentSetupReference

      • getPaymentSchedule

        public PaymentSchedule getPaymentSchedule()
        Get paymentSchedule
        Returns:
        paymentSchedule

      • getPaymentSetupEntryDate

        public java.lang.String getPaymentSetupEntryDate()
        The date on which the payment setup is captured in Orbipay. It must be in ISO8601 full-date format, namely, YYYY-MM-DD.
        Returns:
        paymentSetupEntryDate

      • getComments

        public java.lang.String getComments()
        Comments that can be used to recollect the operation performed on the resource object. API clients need to ensure that no sensitive information is passed in the memo. Alacriti (Orbipay) is not responsible for the security of any sensitive information that may be passed as part of the memo.
        Returns:
        comments

      • getDeleted

        public java.lang.String getDeleted()
        The status of payment which says whether the payment is deleted or not
        Returns:
        deleted

      • getCustomer

        public Customer getCustomer()
        Get customer
        Returns:
        customer

      • getFundingAccount

        public FundingAccount getFundingAccount()
        Get fundingAccount
        Returns:
        fundingAccount

      • getCustomerAccount

        public CustomerAccount getCustomerAccount()
        Get customerAccount
        Returns:
        customerAccount

      • getPaymentNetworkResponse

        public PaymentNetworkResponse getPaymentNetworkResponse()
        Get paymentNetworkResponse
        Returns:
        paymentNetworkResponse

      • getAuditInfo

        public AuditInfo getAuditInfo()
        Get auditInfo
        Returns:
        auditInfo

      • getIDCUSTOMER

        public java.lang.String getIDCUSTOMER()
        The unique identifier assigned by EBPP to the customer.
        Returns:
        ID_CUSTOMER

      • getIDPAYMENTSETUP

        public java.lang.String getIDPAYMENTSETUP()
        The unique identifier assigned by EBPP to the payment setup.
        Returns:
        ID_PAYMENT_SETUP

      • forClient

        public PaymentSetup forClient​(java.lang.String clientKey)
        Overrides:
        forClient in class Base
        Parameters:
        clientKey - : The clientKey is of type String.
        Returns:
        PaymentSetup: The Instance of PaymentSetup.

      • videChannel

        public PaymentSetup videChannel​(java.lang.String channel)
        Overrides:
        videChannel in class Base
        Parameters:
        channel - : The channel is of type String.
        Returns:
        PaymentSetup: The Instance of PaymentSetup.

      • withDetails

        public PaymentSetup withDetails​(java.lang.String amount,
                                java.lang.String cardCvvNumber,
                                java.lang.String paymentSetupScheduleType)
        Parameters:
        amount - : The amount is of type String.
        cardCvvNumber - : The cardCvvNumber is of type String.
        paymentSetupScheduleType - : The paymentSetupScheduleType is of type String.
        Returns:
        PaymentSetup: The Instance of PaymentSetup.

      • fromAccount

        public PaymentSetup fromAccount​(FundingAccount fundingAccount)
        Parameters:
        fundingAccount - : The fundingAccount is of type FundingAccount.
        Returns:
        PaymentSetup: The Instance of PaymentSetup.

      • toAccount

        public PaymentSetup toAccount​(CustomerAccount customerAccount)
        Parameters:
        customerAccount - : The customerAccount is of type CustomerAccount.
        Returns:
        PaymentSetup: The Instance of PaymentSetup.

      • withReference

        public PaymentSetup withReference​(java.lang.String paymentSetupReference)
        Parameters:
        paymentSetupReference - : The paymentSetupReference is of type String.
        Returns:
        PaymentSetup: The Instance of PaymentSetup.

      • withPaymentSchedule

        public PaymentSetup withPaymentSchedule​(PaymentSchedule paymentSchedule)
        Parameters:
        paymentSchedule - : The paymentSchedule is of type PaymentSchedule.
        Returns:
        PaymentSetup: The Instance of PaymentSetup.

      • withStatus

        public PaymentSetup withStatus​(java.lang.String status)
        Parameters:
        status - : The status is of type String.
        Returns:
        PaymentSetup: The Instance of PaymentSetup.

      • withCustomFields

        public PaymentSetup withCustomFields​(java.util.Map<java.lang.String,​java.lang.String> customFields)
        Parameters:
        customFields - : The customFields is of type Map<String, String>.
        Returns:
        PaymentSetup: The Instance of PaymentSetup.

      • withMemo

        public PaymentSetup withMemo​(java.lang.String comments)
        Parameters:
        comments - : The comments is of type String.
        Returns:
        PaymentSetup: The Instance of PaymentSetup.

      • withFee

        public PaymentSetup withFee​(Fee fee)
        Parameters:
        fee - : The fee is of type Fee.
        Returns:
        PaymentSetup: The Instance of PaymentSetup.

      • forCustomer

        public PaymentSetup forCustomer​(java.lang.String ID_CUSTOMER)
        Parameters:
        ID_CUSTOMER - : The ID_CUSTOMER is of type String.
        Returns:
        PaymentSetup: The Instance of PaymentSetup.

      • createdBy

        public PaymentSetup createdBy​(java.lang.String requestor,
                              java.lang.String requestorType)
        Parameters:
        requestor - : The requestor is of type String.
        requestorType - : The requestorType is of type String.
        Returns:
        PaymentSetup: The Instance of PaymentSetup.

      • deletedBy

        public PaymentSetup deletedBy​(java.lang.String requestor,
                              java.lang.String requestorType)
        Parameters:
        requestor - : The requestor is of type String.
        requestorType - : The requestorType is of type String.
        Returns:
        PaymentSetup: The Instance of PaymentSetup.

      • retrievedBy

        public PaymentSetup 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:
        PaymentSetup: The Instance of PaymentSetup.

      • updatedBy

        public PaymentSetup updatedBy​(java.lang.String requestor,
                              java.lang.String requestorType)
        Parameters:
        requestor - : The requestor is of type String.
        requestorType - : The requestorType is of type String.
        Returns:
        PaymentSetup: The Instance of PaymentSetup.

      • create

        public PaymentSetup create​(InvocationContext invocationContext,
                           java.lang.String liveMode)
                    throws OrbipayApiException
        Parameters:
        invocationContext - : The invocationContext is of type InvocationContext.
        liveMode - : The liveMode is of type String
        Returns:
        PaymentSetup: The Instance of PaymentSetup.
        Throws:
        OrbipayApiException - The only Exception that is thrown in Exceptional case

      • create

        public PaymentSetup create​(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 String
        apiEndPoint - : The apiEndPoint is of type String.
        Returns:
        PaymentSetup: The Instance of PaymentSetup.
        Throws:
        OrbipayApiException - The only Exception that is thrown in Exceptional case

      • delete

        public PaymentSetup delete​(InvocationContext invocationContext,
                           java.lang.String liveMode)
                    throws OrbipayApiException
        Parameters:
        invocationContext - : The invocationContext is of type InvocationContext.
        liveMode - : The liveMode is of type String
        Returns:
        PaymentSetup: The Instance of PaymentSetup.
        Throws:
        OrbipayApiException - The only Exception that is thrown in Exceptional case

      • delete

        public PaymentSetup delete​(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 String
        apiEndPoint - : The apiEndPoint is of type String.
        Returns:
        PaymentSetup: The Instance of PaymentSetup.
        Throws:
        OrbipayApiException - The only Exception that is thrown in Exceptional case

      • get

        public PaymentSetup 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:
        PaymentSetup: The Instance of PaymentSetup.
        Throws:
        OrbipayApiException - The only Exception that is thrown in Exceptional case

      • get

        public PaymentSetup 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 String
        apiEndPoint - : The apiEndPoint is of type String.
        Returns:
        PaymentSetup: The Instance of PaymentSetup.
        Throws:
        OrbipayApiException - The only Exception that is thrown in Exceptional case

      • update

        public PaymentSetup update​(InvocationContext invocationContext,
                           java.lang.String liveMode)
                    throws OrbipayApiException
        Parameters:
        invocationContext - : The invocationContext is of type InvocationContext.
        liveMode - : The liveMode is of type String
        Returns:
        PaymentSetup: The Instance of PaymentSetup.
        Throws:
        OrbipayApiException - The only Exception that is thrown in Exceptional case

      • update

        public PaymentSetup update​(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 String
        apiEndPoint - : The apiEndPoint is of type String.
        Returns:
        PaymentSetup: The Instance of PaymentSetup.
        Throws:
        OrbipayApiException - The only Exception that is thrown in Exceptional case