Class TokenRequest.TransferBuilder

    • Method Detail

      • setSource

        public TokenRequest.TransferBuilder setSource​(io.token.proto.common.transferinstructions.TransferInstructionsProtos.TransferEndpoint source)
        Optional. Sets the source account to bypass account selection. May be required for some banks.
        Parameters:
        source - source
        Returns:
        builder
      • setDestinationCountry

        public TokenRequest.TransferBuilder setDestinationCountry​(java.lang.String destinationCountry)
        Optional. Sets the destination country in order to narrow down the country selection in the web-app UI.
        Parameters:
        destinationCountry - destination country
        Returns:
        builder
      • addDestination

        public TokenRequest.TransferBuilder addDestination​(io.token.proto.common.transferinstructions.TransferInstructionsProtos.TransferDestination destination)
        Adds a transfer destination to a transfer token request.
        Parameters:
        destination - destination
        Returns:
        builder
      • addDestination

        @Deprecated
        public TokenRequest.TransferBuilder addDestination​(io.token.proto.common.transferinstructions.TransferInstructionsProtos.TransferEndpoint destination)
        Deprecated.
        Adds a transfer destination to a transfer token request.
        Parameters:
        destination - destination
        Returns:
        builder
      • setChargeAmount

        public TokenRequest.TransferBuilder setChargeAmount​(double chargeAmount)
        Optional. Sets the maximum amount per charge on a transfer token request.
        Parameters:
        chargeAmount - amount
        Returns:
        builder
      • setExecutionDate

        public TokenRequest.TransferBuilder setExecutionDate​(java.time.LocalDate executionDate)
        Sets the execution date of the transfer. Used for future-dated payments.
        Parameters:
        executionDate - execution date
        Returns:
        builder
      • setProviderTransferMetadata

        public TokenRequest.TransferBuilder setProviderTransferMetadata​(io.token.proto.common.providerspecific.ProviderSpecific.ProviderTransferMetadata metadata)
        Optional. Adds metadata for a specific provider.
        Parameters:
        metadata - provider-specific metadata
        Returns:
        builder
      • setChargeBearer

        public TokenRequest.TransferBuilder setChargeBearer​(io.token.proto.common.transferinstructions.TransferInstructionsProtos.ChargeBearer chargeBearer)
        Optional. Set the bearer for any Foreign Exchange fees incurred on the transfer.
        Parameters:
        chargeBearer - Bearer of the charges for any Fees related to the transfer.
        Returns:
        builder
      • setSetTransferDestinationsUrl

        public TokenRequest.TransferBuilder setSetTransferDestinationsUrl​(java.lang.String url)
        Optional. In the scenario where TPP wishes to know the user's selection of country and bank, TPP should provide this url so that Token can make a call with relevant information as parameters. TPP can use that information to set transfer destination.
        Parameters:
        url - URL
        Returns:
        builder
      • setUltimateCreditor

        public TokenRequest.TransferBuilder setUltimateCreditor​(java.lang.String ultimateCreditor)
        Optional. Sets the ultimate party to which the money is due.
        Parameters:
        ultimateCreditor - the ultimate creditor
        Returns:
        builder
      • setUltimateDebtor

        public TokenRequest.TransferBuilder setUltimateDebtor​(java.lang.String ultimateDebtor)
        Optional. Sets ultimate party that owes the money to the (ultimate) creditor.
        Parameters:
        ultimateDebtor - the ultimate debtor
        Returns:
        builder
      • setPurposeCode

        public TokenRequest.TransferBuilder setPurposeCode​(java.lang.String purposeCode)
        Optional. Sets the purpose code. Refer to ISO 20022 external code sets.
        Parameters:
        purposeCode - the purpose code
        Returns:
        builder
      • setConfirmFunds

        public TokenRequest.TransferBuilder setConfirmFunds​(boolean confirmFunds)
        Optional. Sets whether CAF should be attempted before transfer.
        Parameters:
        confirmFunds - whether to attempt CAF before transfer
        Returns:
        builder