Home Reference Source Test
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

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

public

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

Inherited Summary

From class TokenRequestBuilder
public
public
public

setActingAs(actingAs: ActingAs): TokenRequestBuilder

Sets acting as on the token.

public

Sets a default bank ID for the TokenRequestBuilder.

public

Sets the CSRF token.

public

Sets the callback state.

public

Sets customization ID for the TokenRequestBuilder.

public

Sets the description of the token.

public

setFromAlias(alias: Alias | string, value: string): TokenRequestBuilder

Sets the alias of the payer/grantor.

public

Sets the member ID of the payer/grantor.

public

Sets if a receipt should be sent to the payee/grantee's default receipt email/SMS/etc.

public

Sets the callback URL to the server that will initiate redemption of the token.

public

Sets a custom reference ID on the TokenRequestBuilder.

public

Sets the source account ID.

public

setToAlias(alias: Alias | string, value: string): TokenRequestBuilder

Sets the alias of the payee/grantee.

public

Sets the member ID of the payee/grantee.

public

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:

NameTypeAttributeDescription
payload Object

Public Methods

public addDestination(destination: TransferEndpoint): TransferTokenRequestBuilder source

Adds a transfer destination to a transfer token request.

Params:

NameTypeAttributeDescription
destination TransferEndpoint

destination

Return:

TransferTokenRequestBuilder

TransferTokenRequestBuilder

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

Adds multiple transfer destinations to a transfer token request.

Params:

NameTypeAttributeDescription
destinations Array<TransferEndpoint>

destinations

Return:

TransferTokenRequestBuilder

TransferTokenRequestBuilder

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

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

Params:

NameTypeAttributeDescription
amount number | string

amount

Return:

TransferTokenRequestBuilder

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:

NameTypeAttributeDescription
destinationCountry string

destinationCountry

Return:

TransferTokenRequestBuilder

TransferTokenRequestBuilder