import TransferTokenRequestBuilder from '@token-io/tpp/src/main/TransferTokenRequestBuilder.js'

public class | source

TransferTokenRequestBuilder

Extends:

TokenRequestBuilder → TransferTokenRequestBuilder

Constructor Summary

Public Constructor
public	constructor(payload: Object) Use TokenClient::createTransferTokenRequest.

Method Summary

Public Methods
public	addDestination(destination: TransferEndpoint): TransferTokenRequestBuilder Adds a transfer destination to a transfer token request.
public	addDestinations(destinations: Array<TransferEndpoint>): TransferTokenRequestBuilder Adds multiple transfer destinations to a transfer token request.
public	setChargeAmount(amount: number \| string): TransferTokenRequestBuilder Sets the maximum amount per charge on a transfer token request.
public	setDestinationCountry(destinationCountry: string): TransferTokenRequestBuilder Sets the destination country in order to narrow down the country selection in the web-app UI.

Inherited Summary

From class TokenRequestBuilder
public	requestOptions: Object
public	requestPayload: Object
public	setActingAs(actingAs: ActingAs): TokenRequestBuilder Sets acting as on the token.
public	setBankId(bankId: string): TokenRequestBuilder Sets a default bank ID for the TokenRequestBuilder.
public	setCSRFToken(csrf: string): TokenRequestBuilder Sets the CSRF token.
public	setCallbackState(state: Object \| string): TokenRequestBuilder Sets the callback state.
public	setCustomizationId(customizationId: string): TokenRequestBuilder Sets customization ID for the TokenRequestBuilder.
public	setDescription(description: string): TokenRequestBuilder Sets the description of the token.
public	setFromAlias(alias: Alias \| string, value: string): TokenRequestBuilder Sets the alias of the payer/grantor.
public	setFromMemberId(fromMemberId: string): TokenRequestBuilder Sets the member ID of the payer/grantor.
public	setReceiptRequested(receiptRequested: boolean): TokenRequestBuilder Sets if a receipt should be sent to the payee/grantee's default receipt email/SMS/etc.
public	setRedirectUrl(redirectUrl: string): TokenRequestBuilder Sets the callback URL to the server that will initiate redemption of the token.
public	setRefId(refId: string): TokenRequestBuilder Sets a custom reference ID on the TokenRequestBuilder.
public	setSourceAccount(accountId: string): TokenRequestBuilder Sets the source account ID.
public	setToAlias(alias: Alias \| string, value: string): TokenRequestBuilder Sets the alias of the payee/grantee.
public	setToMemberId(toMemberId: string): TokenRequestBuilder Sets the member ID of the payee/grantee.
public	setUserRefId(userRefId: string): TokenRequestBuilder Sets the ID used to track a member claimed by a TPP.

Public Constructors

public constructor(payload: Object) source

Use TokenClient::createTransferTokenRequest.

Override:

TokenRequestBuilder#constructor

Params:

Name	Type	Attribute	Description
payload	Object

Public Methods

public addDestination(destination: TransferEndpoint): TransferTokenRequestBuilder source

Adds a transfer destination to a transfer token request.

Params:

Name	Type	Attribute	Description
destination	TransferEndpoint		destination

Return:

TransferTokenRequestBuilder

public addDestinations(destinations: Array<TransferEndpoint>): TransferTokenRequestBuilder source

Adds multiple transfer destinations to a transfer token request.

Params:

Name	Type	Attribute	Description
destinations	Array<TransferEndpoint>		destinations

Return:

TransferTokenRequestBuilder

public setChargeAmount(amount: number | string): TransferTokenRequestBuilder source

Sets the maximum amount per charge on a transfer token request.

Params:

Name	Type	Attribute	Description
amount	number \| string		amount

Return:

TransferTokenRequestBuilder

public setDestinationCountry(destinationCountry: string): TransferTokenRequestBuilder source

Sets the destination country in order to narrow down the country selection in the web-app UI.

Params:

Name	Type	Attribute	Description
destinationCountry	string		destinationCountry

Return:

TransferTokenRequestBuilder