Home Reference Source Test
import TokenRequest from 'token-io/src/main/TokenRequest.js'
public class | source

TokenRequest

Direct Subclass:

TransferTokenRequest

Static Method Summary

Static Public Methods
public static

Creates a TokenRequest object

Constructor Summary

Public Constructor
public

constructor(payload: Object)

Constructs a TokenRequest.

Member Summary

Public Members
public
public

options: {}

public

payload: *

public
public
public

Method Summary

Public Methods
public

Sets acting as on the token.

public

Sets a default bank ID for the TokenRequest

public

Sets the CSRF token

public

Sets the callback state

public

Sets customization id for the TokenRequest

public

Sets the description of the token.

public

setDestinationCountry(destinationCountry: string): TokenRequest

Sets a destination country for the TokenRequest

public
this method was deprecated. use setFromAlias instead

Sets a default email for the TokenRequest

public

Sets the alias of the payer/grantor

public

setFromMemberId(fromMemberId: *): TokenRequest

Sets the member ID of the payer/grantor.

public

Sets the receiptRequested flag on the TokenRequest.

public

Sets a redirect URL for the TokenRequest

public

Sets the source account ID.

public

Sets the alias of the payee/grantee.

public

setToMemberId(toMemberId: *): TokenRequest

Sets the member ID of the payee/grantee.

public

Sets a user ref ID for the TokenRequest

Static Public Methods

public static create(payload: Object): TokenRequest source

Creates a TokenRequest object

Params:

NameTypeAttributeDescription
payload Object

token request payload

Return:

TokenRequest

TokenRequest object

Public Constructors

public constructor(payload: Object) source

Constructs a TokenRequest.

Params:

NameTypeAttributeDescription
payload Object

token request payload

Public Members

public customizationId: * source

public options: {} source

public payload: * source

public requestOptions: {} source

public requestPayload: * source

public userRefId: * source

Public Methods

public setActingAs(actingAs: Object): TokenRequest source

Sets acting as on the token.

Params:

NameTypeAttributeDescription
actingAs Object

entity the redeemer is acting on behalf of

Return:

TokenRequest

token request

public setBankId(bankId: string): TokenRequest source

Sets a default bank ID for the TokenRequest

Params:

NameTypeAttributeDescription
bankId string

bank ID

Return:

TokenRequest

token request

public setCSRFToken(csrf: string): TokenRequest source

Sets the CSRF token

Params:

NameTypeAttributeDescription
csrf string

CSRF token

Return:

TokenRequest

token request

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

Sets the callback state

Params:

NameTypeAttributeDescription
state Object | string

arbitrary JS object or string

Return:

TokenRequest

token request

public setCustomizationId(customizationId: object): TokenRequest source

Sets customization id for the TokenRequest

Params:

NameTypeAttributeDescription
customizationId object

customization id

Return:

TokenRequest

token request

public setDescription(description: string): TokenRequest source

Sets the description of the token.

Params:

NameTypeAttributeDescription
description string

description

Return:

TokenRequest

token request

public setDestinationCountry(destinationCountry: string): TokenRequest source

Sets a destination country for the TokenRequest

Params:

NameTypeAttributeDescription
destinationCountry string

destination country

Return:

TokenRequest

token request

public setEmail(email: string): TokenRequest source

this method was deprecated. use setFromAlias instead

Sets a default email for the TokenRequest

Params:

NameTypeAttributeDescription
email string

default email

Return:

TokenRequest

token request

public setFromAlias(type: string | Object, value: string): TokenRequest source

Sets the alias of the payer/grantor

Params:

NameTypeAttributeDescription
type string | Object

type of alias or alias object

value string

value of alias

Return:

TokenRequest

token request

public setFromMemberId(fromMemberId: *): TokenRequest source

Sets the member ID of the payer/grantor.

Params:

NameTypeAttributeDescription
fromMemberId *

member ID of the payer/grantor

Return:

TokenRequest

token request

public setReceiptRequested(receiptRequested: boolean): TokenRequest source

Sets the receiptRequested flag on the TokenRequest.

Params:

NameTypeAttributeDescription
receiptRequested boolean

true if a receipt is requested

Return:

TokenRequest

token request

public setRedirectUrl(redirectUrl: string): TokenRequest source

Sets a redirect URL for the TokenRequest

Params:

NameTypeAttributeDescription
redirectUrl string

redirect URL

Return:

TokenRequest

token request

public setSourceAccount(accountId: *): TokenRequest source

Sets the source account ID.

Params:

NameTypeAttributeDescription
accountId *

source account ID

Return:

TokenRequest

token request

public setToAlias(type: string | Object, value: string): TokenRequest source

Sets the alias of the payee/grantee.

Params:

NameTypeAttributeDescription
type string | Object

type of alias or alias object

value string

value of alias

Return:

TokenRequest

token request

public setToMemberId(toMemberId: *): TokenRequest source

Sets the member ID of the payee/grantee.

Params:

NameTypeAttributeDescription
toMemberId *

member ID of the payee/grantee

Return:

TokenRequest

token request

public setUserRefId(userRefId: string): TokenRequest source

Sets a user ref ID for the TokenRequest

Params:

NameTypeAttributeDescription
userRefId string

user ref id

Return:

TokenRequest

token request