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

StandingOrderTokenRequestBuilder

Extends:

TokenRequestBuilder → StandingOrderTokenRequestBuilder

Constructor Summary

Public Constructor
public

constructor(payload: Object)

Use TokenClient::createStandingOrderTokenRequest.

Method Summary

Public Methods
public

addTransferDestination(destination: TransferDestination): StandingOrderTokenRequestBuilder

Adds a transfer destination to a standing order token request.

public

Sets the maximum amount per charge on a standing order token request.

public

Sets the currency for each charge in the standing order token request.

public

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

public

Sets the end date of the standing order token request.

public

Sets the frequency of the standing order token request.

public

Sets the meta data for a specific provider

public

Sets the start date of the standing order token request.

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::createStandingOrderTokenRequest.

Override:

TokenRequestBuilder#constructor

Params:

NameTypeAttributeDescription
payload Object

Public Methods

public addTransferDestination(destination: TransferDestination): StandingOrderTokenRequestBuilder source

Adds a transfer destination to a standing order token request.

Params:

NameTypeAttributeDescription
destination TransferDestination

destination

Return:

StandingOrderTokenRequestBuilder

StandingOrderTokenRequestBuilder

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

Sets the maximum amount per charge on a standing order token request.

Params:

NameTypeAttributeDescription
amount number | string

amount

Return:

StandingOrderTokenRequestBuilder

StandingOrderTokenRequestBuilder

public setCurrency(currency: string): StandingOrderTokenRequestBuilder source

Sets the currency for each charge in the standing order token request.

Params:

NameTypeAttributeDescription
currency string

currency

Return:

StandingOrderTokenRequestBuilder

StandingOrderTokenRequestBuilder

public setDestinationCountry(destinationCountry: string): StandingOrderTokenRequestBuilder source

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

Params:

NameTypeAttributeDescription
destinationCountry string

destinationCountry

Return:

StandingOrderTokenRequestBuilder

StandingOrderTokenRequestBuilder

public setEndDate(endDate: string): StandingOrderTokenRequestBuilder source

Sets the end date of the standing order token request. ISO 8601: YYYY-MM-DD or YYYYMMDD. If not specified, the standing order will occur indefinitely.

Params:

NameTypeAttributeDescription
endDate string

endDate

Return:

StandingOrderTokenRequestBuilder

StandingOrderTokenRequestBuilder

public setFrequency(frequency: string): StandingOrderTokenRequestBuilder source

Sets the frequency of the standing order token request.

Params:

NameTypeAttributeDescription
frequency string

frequency

Return:

StandingOrderTokenRequestBuilder

StandingOrderTokenRequestBuilder

public setProviderTransferMetadata(metadata: Object): StandingOrderTokenRequestBuilder source

Sets the meta data for a specific provider

Params:

NameTypeAttributeDescription
metadata Object

metadata

Return:

StandingOrderTokenRequestBuilder

StandingOrderTokenRequestBuilder

public setStartDate(startDate: string): StandingOrderTokenRequestBuilder source

Sets the start date of the standing order token request. ISO 8601: YYYY-MM-DD or YYYYMMDD.

Params:

NameTypeAttributeDescription
startDate string

startDate

Return:

StandingOrderTokenRequestBuilder

StandingOrderTokenRequestBuilder