Package com.orbipay.paymentsapi.client.wrappers

Class PaymentAuthorization

  • public class PaymentAuthorization
extends Base

    • Constructor Detail

      • PaymentAuthorization

        public PaymentAuthorization()

      • PaymentAuthorization

        public PaymentAuthorization​(java.lang.String ID_AUTHORIZATION)

    • Method Detail

      • getPaymentAuthReference

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

      • getId

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

      • getUrl

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

      • getAuthAmount

        public java.lang.String getAuthAmount()
        The amount being authorized.
        Returns:
        authAmount

      • 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 authorization.
        Returns:
        paymentMethod

      • 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

      • 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

      • getEntryTime

        public java.lang.String getEntryTime()
        The date on which the payment authorization created in UTC timestamp, with ISO8601 format. For e.g., 2019-08-13T09:21:34.359+0000.
        Returns:
        entryTime

      • getCapturedTime

        public java.lang.String getCapturedTime()
        The date on which the payment authorization is captured in UTC timestamp, with ISO8601 format. For e.g., 2019-08-13T09:21:34.359+0000..
        Returns:
        capturedTime

      • 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

      • 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. Only the custom fields enabled for the client, in EBPP, would be accepted in the requests.
        Returns:
        customFields

      • 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

      • getIDAUTHORIZATION

        public java.lang.String getIDAUTHORIZATION()
        The unique identifier assigned by EBPP to the payment authorization.
        Returns:
        ID_AUTHORIZATION

      • forClient

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

      • videChannel

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

      • withDetails

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

      • forCustomer

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

      • fromAccount

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

      • toAccount

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

      • withReference

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

      • withCustomFields

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

      • withMemo

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

      • cancelledBy

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

      • createdBy

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

      • cancel

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

      • cancel

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

      • create

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

      • create

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