Package com.orbipay.paymentsapi.client.wrappers

Class Refund

  • public class Refund
extends Base

    • Constructor Detail

      • Refund

        public Refund()

      • Refund

        public Refund​(java.lang.String ID_REFUND)

    • Method Detail

      • getRefundReference

        public java.lang.String getRefundReference()
        The unique identifier in the client system for the refund.
        Returns:
        refundReference

      • getId

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

      • getUrl

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

      • getRefundType

        public java.lang.String getRefundType()
        The portion of the payment amount that is to be or has been refunded. The original payment can be refunded fully including the amount and the fee components, or partially, for just the amount or the fee component. Refund can also be initiated for an arbitrary amount limited by the original payment amount.
        Returns:
        refundType

      • getRefundAmount

        public java.lang.String getRefundAmount()
        The refund amount upto 2 decimal places.
        Returns:
        refundAmount

      • getFeeRefund

        public FeeRefund getFeeRefund()
        Get feeRefund
        Returns:
        feeRefund

      • getStatus

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

      • getConfirmationNumber

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

      • getRefundDate

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

      • getRefundEntryDate

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

      • getExpectedRefundSettlementDate

        public java.lang.String getExpectedRefundSettlementDate()
        The date by which the credits would be posted to the original funding account. ISO8601 full-date format, YYYY-MM-DD
        Returns:
        expectedRefundSettlementDate

      • 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

      • 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

      • getSourcePayment

        public SourcePayment getSourcePayment()
        Get sourcePayment
        Returns:
        sourcePayment

      • getPaymentNetworkResponse

        public PaymentNetworkResponse getPaymentNetworkResponse()
        Get paymentNetworkResponse
        Returns:
        paymentNetworkResponse

      • 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

      • getIDCUSTOMER

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

      • getIDREFUND

        public java.lang.String getIDREFUND()
        The unique identifier assigned by EBPP to the refund.
        Returns:
        ID_REFUND

      • forClient

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

      • videChannel

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

      • withDetails

        public Refund withDetails​(java.lang.String refundAmount)
        Parameters:
        refundAmount - : The refundAmount is of type String.
        Returns:
        Refund: The Instance of Refund.

      • withReference

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

      • withMemo

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

      • withStatus

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

      • forCustomer

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

      • forPayment

        public Refund forPayment​(java.lang.String ID_PAYMENT)
        Parameters:
        ID_PAYMENT - : The ID_PAYMENT is of type String.
        Returns:
        Refund: The Instance of Refund.

      • withCustomFields

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

      • withFeeRefund

        public Refund withFeeRefund​(FeeRefund feeRefund)
        Parameters:
        feeRefund - : The feeRefund is of type FeeRefund.
        Returns:
        Refund: The Instance of Refund.

      • createdBy

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

      • retrievedBy

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

      • create

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

      • create

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

      • get

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

      • get

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