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

public class | source

TokenRequestBuilder

Direct Subclass:

AccessTokenRequestBuilder, TransferTokenRequestBuilder

Constructor Summary

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

Member Summary

Public Members
public	requestOptions: Object
public	requestPayload: Object

Method Summary

Public Methods
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 or TokenClient::createAccessTokenRequest.

Params:

Name	Type	Attribute	Description
payload	Object

Public Members

public requestOptions: Object source

public requestPayload: Object source

Public Methods

public setActingAs(actingAs: ActingAs): TokenRequestBuilder source

Sets acting as on the token.

Params:

Name	Type	Attribute	Description
actingAs	ActingAs		entity the TPP is acting on behalf of

Return:

TokenRequestBuilder

public setBankId(bankId: string): TokenRequestBuilder source

Sets a default bank ID for the TokenRequestBuilder.

Params:

Name	Type	Attribute	Description
bankId	string		the default bank ID

Return:

TokenRequestBuilder

public setCSRFToken(csrf: string): TokenRequestBuilder source

Sets the CSRF token.

Params:

Name	Type	Attribute	Description
csrf	string		CSRF token

Return:

TokenRequestBuilder

public setCallbackState(state: Object | string): TokenRequestBuilder source

Sets the callback state.

Params:

Name	Type	Attribute	Description
state	Object \| string		arbitrary JS object or string

Return:

TokenRequestBuilder

public setCustomizationId(customizationId: string): TokenRequestBuilder source

Sets customization ID for the TokenRequestBuilder.

Params:

Name	Type	Attribute	Description
customizationId	string		result of Member::createCustomization

Return:

TokenRequestBuilder

public setDescription(description: string): TokenRequestBuilder source

Sets the description of the token.

Params:

Name	Type	Attribute	Description
description	string		description

Return:

TokenRequestBuilder

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

Sets the alias of the payer/grantor.

Params:

Name	Type	Attribute	Description
alias	Alias \| string		alias object, or type of alias as a string
value	string		optional value of the alias if first param is type

Return:

TokenRequestBuilder

public setFromMemberId(fromMemberId: string): TokenRequestBuilder source

Sets the member ID of the payer/grantor.

Params:

Name	Type	Attribute	Description
fromMemberId	string		member ID of the payer/grantor

Return:

TokenRequestBuilder

public setReceiptRequested(receiptRequested: boolean): TokenRequestBuilder source

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

Params:

Name	Type	Attribute	Description
receiptRequested	boolean		true if a receipt is requested

Return:

TokenRequestBuilder

public setRedirectUrl(redirectUrl: string): TokenRequestBuilder source

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

Params:

Name	Type	Attribute	Description
redirectUrl	string		redirectUrl

Return:

TokenRequestBuilder

public setRefId(refId: string): TokenRequestBuilder source

Sets a custom reference ID on the TokenRequestBuilder.

Params:

Name	Type	Attribute	Description
refId	string		refId

Return:

TokenRequestBuilder

public setSourceAccount(accountId: string): TokenRequestBuilder source

Sets the source account ID.

Params:

Name	Type	Attribute	Description
accountId	string		source account ID

Return:

TokenRequestBuilder

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

Sets the alias of the payee/grantee.

Params:

Name	Type	Attribute	Description
alias	Alias \| string		alias of the payee/grantee
value	string		optional value of the alias if first param is type

Return:

TokenRequestBuilder

public setToMemberId(toMemberId: string): TokenRequestBuilder source

Sets the member ID of the payee/grantee.

Params:

Name	Type	Attribute	Description
toMemberId	string		member ID of the payee/grantee

Return:

TokenRequestBuilder

public setUserRefId(userRefId: string): TokenRequestBuilder source

Sets the ID used to track a member claimed by a TPP.

Params:

Name	Type	Attribute	Description
userRefId	string		userRefId

Return:

TokenRequestBuilder