Package com.orbipay.paymentsapi.client.wrappers

Class FundingAccount

  • public class FundingAccount
extends Base

    • Constructor Detail

      • FundingAccount

        public FundingAccount()

      • FundingAccount

        public FundingAccount​(java.lang.String ID_FUNDING_ACCOUNT)

    • Method Detail

      • getAccountHolderName

        public java.lang.String getAccountHolderName()
        The name as specified on the account.
        Returns:
        accountHolderName

      • getNickname

        public java.lang.String getNickname()
        The nickname by which a customer might want to identify the account.
        Returns:
        nickname

      • getAddress

        public Address getAddress()
        Get address
        Returns:
        address

      • getAccountNumber

        public java.lang.String getAccountNumber()
        The number or reference that a customer uses to identify the funding account. In case of Apple Pay, this is the device-specific account number of the card.
        Returns:
        accountNumber

      • getAbaRoutingNumber

        public java.lang.String getAbaRoutingNumber()
        The ABA/Routing number for the bank account.
        Returns:
        abaRoutingNumber

      • getIssuerName

        public java.lang.String getIssuerName()
        The name of the authority that has issued the account. This is relevant only in the case of bank accounts.
        Returns:
        issuerName

      • 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

      • getExpiryDate

        public java.lang.String getExpiryDate()
        The expiry date for the card. This is to be in the format MM/YY.
        Returns:
        expiryDate

      • getAccountHolderType

        public java.lang.String getAccountHolderType()
        The type of ownership for the funding account. This is applicable only in the case of bank accounts and it is defaults to personal.
        Returns:
        accountHolderType

      • 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

      • getAccountSubtype

        public java.lang.String getAccountSubtype()
        The sub type of the funding account. This is derived by Orbipay in the case of card funding accounts. It needs to be passed when adding or editing a DDA/Bank/ApplePay account. For e.g., a savings account, a checking account.
        Returns:
        accountSubtype

      • getId

        public java.lang.String getId()
        Id is a unique identifier assigned to the funding account in Orbipay. A new Id is generated for the funding account when the account number is updated.
        Returns:
        id

      • getUrl

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

      • getAchEligibleFlag

        public java.lang.String getAchEligibleFlag()
        Indicates if the funding account can be debited vide ACH, in case the funding account is a Demand Deposit Account (DDA).
        Returns:
        achEligibleFlag

      • getAtmEligibleFlag

        public java.lang.String getAtmEligibleFlag()
        Indicates if the funding account can be debited vide the ATM Rail network, in case the funding account is a Debit Card.
        Returns:
        atmEligibleFlag

      • getCardCvvNumber

        public java.lang.String getCardCvvNumber()
        This is never returned by Orbipay. This needs to be passed to Orbipay when adding or editing a card funding account.
        Returns:
        cardCvvNumber

      • getAccountType

        public java.lang.String getAccountType()
        The type of the funding account.
        Returns:
        accountType

      • getStatus

        public java.lang.String getStatus()
        The status of the funding account in Orbipay.
        Returns:
        status

      • getDeviceManufacturerId

        public java.lang.String getDeviceManufacturerId()
        This is applicable only for Apple Pay transactions. Hex-encoded device manufacturer identifier.
        Returns:
        deviceManufacturerId

      • getDisplayText

        public java.lang.String getDisplayText()
        UI representation of the account.
        Returns:
        displayText

      • 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 funding account which says whether the funding account is deleted or not
        Returns:
        deleted

      • 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

      • getIDFUNDINGACCOUNT

        public java.lang.String getIDFUNDINGACCOUNT()
        The unique identifier assigned by EBPP to the Funding Account.
        Returns:
        ID_FUNDING_ACCOUNT

      • forClient

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

      • videChannel

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

      • withDetails

        public FundingAccount withDetails​(java.lang.String accountHolderName,
                                  java.lang.String nickname,
                                  java.lang.String accountNumber,
                                  java.lang.String accountSubtype,
                                  java.lang.String abaRoutingNumber,
                                  java.lang.String cardCvvNumber,
                                  java.lang.String expiryDate,
                                  java.lang.String accountHolderType)
        Parameters:
        accountHolderName - : The accountHolderName is of type String.
        nickname - : The nickname is of type String.
        accountNumber - : The accountNumber is of type String.
        accountSubtype - : The accountSubtype is of type String.
        abaRoutingNumber - : The abaRoutingNumber is of type String.
        cardCvvNumber - : The cardCvvNumber is of type String.
        expiryDate - : The expiryDate is of type String.
        accountHolderType - : The accountHolderType is of type String.
        Returns:
        FundingAccount: The Instance of FundingAccount.

      • withRecordedDetails

        public FundingAccount withRecordedDetails​(java.lang.String accountNumber,
                                          java.lang.String issuerName)
        Parameters:
        accountNumber - : The accountNumber is of type String.
        issuerName - : The issuerName is of type String.
        Returns:
        FundingAccount: The Instance of FundingAccount.

      • withStatus

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

      • withAddress

        public FundingAccount withAddress​(Address address)
        Parameters:
        address - : The address is of type Address.
        Returns:
        FundingAccount: The Instance of FundingAccount.

      • withCustomFields

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

      • withMemo

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

      • forCustomer

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

      • withDeviceManufacturerId

        public FundingAccount withDeviceManufacturerId​(java.lang.String deviceManufacturerId)
        Parameters:
        deviceManufacturerId - : The deviceManufacturerId is of type String.
        Returns:
        FundingAccount: The Instance of FundingAccount.

      • withDisplayText

        public FundingAccount withDisplayText​(java.lang.String displayText)
        Parameters:
        displayText - : The displayText is of type String.
        Returns:
        FundingAccount: The Instance of FundingAccount.

      • createdBy

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

      • deletedBy

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

      • retrievedBy

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

      • replacedBy

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

      • updatedBy

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

      • create

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

      • create

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

      • delete

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

      • delete

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

      • get

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

      • get

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

      • replace

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

      • replace

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

      • update

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

      • update

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