Package com.orbipay.paymentsapi.client.wrappers

Class Payment

  • public class Payment
extends Base

    • Constructor Detail

      • Payment

        public Payment()

      • Payment

        public Payment​(java.lang.String ID_PAYMENT)

    • Method Detail

      • getId

        public java.lang.String getId()
        The unique identifier assigned by Orbipay 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 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 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 Orbipay. 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 Orbipay.
        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

      • 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

      • getPaymentAuthorization

        public PaymentAuthorization getPaymentAuthorization()
        Get paymentAuthorization
        Returns:
        paymentAuthorization

      • 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

      • getIDPAYMENT

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

      • forClient

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

      • videChannel

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

      • withDetails

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

      • fromAccount

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

      • toAccount

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

      • withPaymentAuthorization

        public Payment withPaymentAuthorization​(PaymentAuthorization paymentAuthorization)
        Parameters:
        paymentAuthorization - : The paymentAuthorization is of type PaymentAuthorization.
        Returns:
        Payment: The Instance of Payment.

      • withReference

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

      • withPaymentNotificationEmail

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

      • withStatus

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

      • withCustomFields

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

      • withMemo

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

      • withFee

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

      • forCustomer

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

      • createdBy

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

      • deletedBy

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

      • retrievedBy

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

      • updatedBy

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

      • create

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

      • create

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

      • delete

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

      • delete

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

      • get

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

      • get

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

      • update

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

      • update

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