Package com.orbipay.paymentsapi.client.wrappers

Class RecordedPayment

  • public class RecordedPayment
extends Base

    • Constructor Detail

      • RecordedPayment

        public RecordedPayment()

      • RecordedPayment

        public RecordedPayment​(java.lang.String ID_PAYMENT)

    • 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 non fulfillment method for the payment.
        Returns:
        paymentMethod

      • getToken

        public java.lang.String getToken()
        The token is used to uniquely identify the payment, such as the POS token.
        Returns:
        token

      • 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 'other', the amount needs to be specified. In other cases, this is derived from the payment_amount_type.
        Returns:
        amount

      • 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

      • 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

      • 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

      • getComments

        public java.lang.String getComments()
        Comments that can be used to recollect the operation performed on the resource object.
        Returns:
        comments

      • 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

      • getCustomer

        public Customer getCustomer()
        Get customer
        Returns:
        customer

      • getFundingAccount

        public FundingAccount getFundingAccount()
        Get fundingAccount
        Returns:
        fundingAccount

      • getCustomerAccount

        public CustomerAccount getCustomerAccount()
        Get customerAccount
        Returns:
        customerAccount

      • getAuditInfo

        public AuditInfo getAuditInfo()
        Get auditInfo
        Returns:
        auditInfo

      • getIDPAYMENT

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

      • forClient

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

      • videChannel

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

      • withDetails

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

      • fromAccount

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

      • withToken

        public RecordedPayment withToken​(java.lang.String token)
        Parameters:
        token - : The token is of type String.
        Returns:
        RecordedPayment: The Instance of RecordedPayment.

      • toAccount

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

      • withReference

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

      • withCustomFields

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

      • withMemo

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

      • withFee

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

      • withCustomer

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

      • deletedBy

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

      • createdBy

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

      • delete

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

      • delete

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

      • create

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

      • create

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