Package com.orbipay.paymentsapi.client.wrappers

Class SimplePayment

  • public class SimplePayment
extends Base

    • Constructor Detail

      • SimplePayment

        public SimplePayment()

    • Method Detail

      • getId

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

      • getUrl

        public java.lang.String getUrl()
        This URL fetches the details of payment.
        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

      • getConfirmationNumber

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

      • getCustomFields

        public java.util.Map<java.lang.String,​java.lang.String> getCustomFields()
        The additional information or meta-information that EBPP can accept, maintain and transmit back to the client. The custom fields need to be configured with EBPP before they can be accepted. EBPP 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.
        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 EBPP. 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 EBPP. This needs to be passed to EBPP when making or editing a payment with a card funding account.
        Returns:
        cardCvvNumber

      • getPaymentDate

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

      • getPaymentScheduleType

        public java.lang.String getPaymentScheduleType()
        The schedule type for the payment. This defaults to one_time_payment.
        Returns:
        paymentScheduleType

      • getPaymentRequestDate

        public java.lang.String getPaymentRequestDate()
        The date on which the biller wants the payment to be settled. It must be in ISO8601 full-date format, namely, YYYY-MM-DD. This is applicable only if the client has opted for it.
        Returns:
        paymentRequestDate

      • getPaymentAmountType

        public java.lang.String getPaymentAmountType()
        The type of amount, as per the bill/statement, that is being paid. The payment amount is derived from the amount type selected for the payment. This defaults to other.
        Returns:
        paymentAmountType

      • getPaymentReference

        public java.lang.String getPaymentReference()
        The unique identifier in the client system for the payment.
        Returns:
        paymentReference

      • getExpectedPaymentSettlementDate

        public java.lang.String getExpectedPaymentSettlementDate()
        The date on which the payment is expected to be settled with the biller. It must be in ISO8601 full-date format, namely, YYYY-MM-DD.
        Returns:
        expectedPaymentSettlementDate

      • getPaymentEntryDate

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

      • getPaymentReturnDate

        public java.lang.String getPaymentReturnDate()
        The date on which the ACH returns is received by EBPP.
        Returns:
        paymentReturnDate

      • getReturnCode

        public java.lang.String getReturnCode()
        The ACH return code or the chargeback code received from Visa/Mastercard, in the event of returned payments.
        Returns:
        returnCode

      • getPaymentNotificationEmail

        public java.lang.String getPaymentNotificationEmail()
        The email address to which notifications for the payment will be sent. The notifications will be sent to the customer's email in case this is not provided.
        Returns:
        paymentNotificationEmail

      • getCryptogram

        public java.lang.String getCryptogram()
        This is applicable only for Apple Pay transactions. Online Payment Cryptogram, as defined by 3-D secure.
        Returns:
        cryptogram

      • getEci

        public java.lang.String getEci()
        This is applicable only for Apple Pay transactions. ECI Indicator, as defined by 3-D secure. The card network may add an ECI indicator to the card data. This indicator is then included in the payment token. if you receive an ECI indicator, you must pass it on to your payment processor, otherwise, the transaction fails.
        Returns:
        eci

      • 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 (EBPP) is not responsible for the security of any sensitive information that may be passed as part of the memo.
        Returns:
        comments

      • 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

      • getSaveFundingAccount

        public java.lang.String getSaveFundingAccount()
        query param
        Returns:
        saveFundingAccount

      • forClient

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

      • videChannel

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

      • withDetails

        public SimplePayment withDetails​(java.lang.String paymentAmountType,
                                 java.lang.String amount,
                                 java.lang.String paymentDate,
                                 java.lang.String paymentRequestDate,
                                 java.lang.String cardCvvNumber)
        Parameters:
        paymentAmountType - : The paymentAmountType is of type String.
        amount - : The amount is of type String.
        paymentDate - : The paymentDate is of type String.
        paymentRequestDate - : The paymentRequestDate is of type String.
        cardCvvNumber - : The cardCvvNumber is of type String.
        Returns:
        SimplePayment: The Instance of SimplePayment.

      • fromAccount

        public SimplePayment fromAccount​(FundingAccount fundingAccount,
                                 java.lang.String saveFundingAccount)
        Parameters:
        fundingAccount - : The fundingAccount is of type FundingAccount.
        saveFundingAccount - : The saveFundingAccount is of type String.
        Returns:
        SimplePayment: The Instance of SimplePayment.

      • toAccount

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

      • withReference

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

      • withPaymentNotificationEmail

        public SimplePayment withPaymentNotificationEmail​(java.lang.String paymentNotificationEmail)
        Parameters:
        paymentNotificationEmail - : The paymentNotificationEmail is of type String.
        Returns:
        SimplePayment: The Instance of SimplePayment.

      • withCustomFields

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

      • withMemo

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

      • withFee

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

      • forCustomer

        public SimplePayment forCustomer​(Customer customer)
        Parameters:
        customer - : The customer is of type Customer.
        Returns:
        SimplePayment: The Instance of SimplePayment.

      • withCryptogram

        public SimplePayment withCryptogram​(java.lang.String cryptogram)
        Parameters:
        cryptogram - : The cryptogram is of type String.
        Returns:
        SimplePayment: The Instance of SimplePayment.

      • withEci

        public SimplePayment withEci​(java.lang.String eci)
        Parameters:
        eci - : The eci is of type String.
        Returns:
        SimplePayment: The Instance of SimplePayment.

      • createdBy

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

      • create

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

      • create

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