Package io.token.tokenrequest

Class TokenRequest.TransferBuilder

java.lang.Object

io.token.tokenrequest.TokenRequest.Builder<TokenRequest.TransferBuilder>

io.token.tokenrequest.TokenRequest.TransferBuilder

Enclosing class:

TokenRequest

public static class TokenRequest.TransferBuilder
extends TokenRequest.Builder<TokenRequest.TransferBuilder>

Field Summary

Fields inherited from class io.token.tokenrequest.TokenRequest.Builder

csrfToken, oauthState, requestOptions, requestPayload

Method Summary

Modifier and Type	Method	Description
TokenRequest.TransferBuilder	addDestination(io.token.proto.common.transferinstructions.TransferInstructionsProtos.TransferDestination destination)	Adds a transfer destination to a transfer token request.
TokenRequest.TransferBuilder	setChargeAmount(double chargeAmount)	Optional.
TokenRequest.TransferBuilder	setChargeBearer(io.token.proto.common.transferinstructions.TransferInstructionsProtos.ChargeBearer chargeBearer)	Optional.
TokenRequest.TransferBuilder	setConfirmFunds(boolean confirmFunds)	Optional.
TokenRequest.TransferBuilder	setDestinationCountry(java.lang.String destinationCountry)	Optional.
TokenRequest.TransferBuilder	setExecutionDate(java.time.LocalDate executionDate)	Sets the execution date of the transfer.
TokenRequest.TransferBuilder	setProviderTransferMetadata(io.token.proto.common.providerspecific.ProviderSpecific.ProviderTransferMetadata metadata)	Optional.
TokenRequest.TransferBuilder	setPurposeCode(java.lang.String purposeCode)	Optional.
TokenRequest.TransferBuilder	setRemittanceReference(java.lang.String remittanceReference)	Optional.
TokenRequest.TransferBuilder	setReturnRefundAccount(boolean returnRefundAccount)	Optional.
TokenRequest.TransferBuilder	setSetTransferDestinationsUrl(java.lang.String url)	Optional.
TokenRequest.TransferBuilder	setSource(io.token.proto.common.transferinstructions.TransferInstructionsProtos.TransferEndpoint source)	Optional.
TokenRequest.TransferBuilder	setUltimateCreditor(java.lang.String ultimateCreditor)	Optional.
TokenRequest.TransferBuilder	setUltimateDebtor(java.lang.String ultimateDebtor)	Optional.

Methods inherited from class io.token.tokenrequest.TokenRequest.Builder

build, setActingAs, setBankId, setCsrfToken, setCustomizationId, setDescription, setFromAlias, setFromMemberId, setPsuId, setReceiptRequested, setRedirectUrl, setRefId, setSourceAccount, setState, setToAlias, setTokenExpiration, setToMemberId, setUserRefId

Methods inherited from class java.lang.Object

clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait

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.

Overrides:

setSource in class TokenRequest.Builder<TokenRequest.TransferBuilder>

Parameters:

source - source

Returns:

builder

setRemittanceReference

public TokenRequest.TransferBuilder setRemittanceReference(java.lang.String remittanceReference)

Optional. Sets the remittance reference of the transfer.

Parameters:

remittanceReference - remittance reference

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

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

setReturnRefundAccount

public TokenRequest.TransferBuilder setReturnRefundAccount(boolean returnRefundAccount)

Optional. Sets whether the refund account should be returned.

Parameters:

returnRefundAccount - whether the refund account should be returned

Returns:

builder