.Net SDK
Tokenio.TransferTokenBuilder Class Reference

Public Member Functions

 TransferTokenBuilder (MemberAsync member, double amount, string currency)
 Creates the builder object. More...
 
TransferTokenBuilder SetAccountId (string accountId)
 Adds a source accountId to the token. More...
 
TransferTokenBuilder SetCustomAuthoriaztion (string bankId, string authorization)
 Sets the source custom authorization. More...
 
TransferTokenBuilder SetExpiresAtMs (long expiresAtMs)
 Sets the expiration date. More...
 
TransferTokenBuilder SetEffectiveAtMs (long effectiveAtMs)
 Sets the effective date. More...
 
TransferTokenBuilder SetEndorseUntilMs (long endorseUntilMs)
 Sets the time after which endorse is no longer possible. More...
 
TransferTokenBuilder SetChargeAmount (double chargeAmount)
 Sets the maximum amount per charge. More...
 
TransferTokenBuilder SetDescription (string description)
 Sets the description. More...
 
TransferTokenBuilder SetSource (TransferEndpoint source)
 Adds a transfer source. More...
 
TransferTokenBuilder AddDestination (TransferEndpoint destination)
 Adds a transfer destination. More...
 
TransferTokenBuilder AddAttachment (Attachment attachment)
 Adds an attachment to the token. More...
 
TransferTokenBuilder AddAttachment (string ownerId, string type, string name, byte[] data)
 Adds an attachment by filename (reads file, uploads it, and attaches it). More...
 
TransferTokenBuilder SetToAlias (Alias toAlias)
 Sets the alias of the payee. More...
 
TransferTokenBuilder SetToMemberId (string toMemberId)
 Sets the member Id of the payee. More...
 
TransferTokenBuilder SetRefId (string refId)
 Sets the reference Id of the token. More...
 
TransferTokenBuilder SetPricing (Pricing pricing)
 Sets the pricing (fees/fx) on the token. More...
 
TransferTokenBuilder SetPurposeOfPayment (PurposeOfPayment purposeOfPayment)
 Sets the purpose of payment. More...
 
TransferTokenBuilder SetActingAs (ActingAs actingAs)
 Sets acting as on the token More...
 
TokenPayload BuildPayload ()
 Builds a token payload, without uploading blobs or attachments. More...
 
Token Execute ()
 Executes the request, creating a token. More...
 
Task< Token > ExecuteAsync ()
 Executes the request asynchronously. More...
 

Constructor & Destructor Documentation

◆ TransferTokenBuilder()

Tokenio.TransferTokenBuilder.TransferTokenBuilder ( MemberAsync  member,
double  amount,
string  currency 
)
inline

Creates the builder object.

Parameters
memberthe payer of the token
amountthe lifetime amount of the token
currencythe currency of the token

Member Function Documentation

◆ AddAttachment() [1/2]

TransferTokenBuilder Tokenio.TransferTokenBuilder.AddAttachment ( Attachment  attachment)
inline

Adds an attachment to the token.

Parameters
attachmentthe attachment
Returns
the builder

◆ AddAttachment() [2/2]

TransferTokenBuilder Tokenio.TransferTokenBuilder.AddAttachment ( string  ownerId,
string  type,
string  name,
byte []  data 
)
inline

Adds an attachment by filename (reads file, uploads it, and attaches it).

Parameters
ownerIdthe owner id
typethe MIME type of file
namethe name of the file
datafile binary data
Returns
the builder

◆ AddDestination()

TransferTokenBuilder Tokenio.TransferTokenBuilder.AddDestination ( TransferEndpoint  destination)
inline

Adds a transfer destination.

Parameters
destinationthe destination
Returns
the builder

◆ BuildPayload()

TokenPayload Tokenio.TransferTokenBuilder.BuildPayload ( )
inline

Builds a token payload, without uploading blobs or attachments.

Returns
the token payload
Exceptions
TokenArgumentsException

◆ Execute()

Token Tokenio.TransferTokenBuilder.Execute ( )
inline

Executes the request, creating a token.

Returns
the token

◆ ExecuteAsync()

Task<Token> Tokenio.TransferTokenBuilder.ExecuteAsync ( )
inline

Executes the request asynchronously.

Returns
the token
Exceptions
TokenArgumentsException

◆ SetAccountId()

TransferTokenBuilder Tokenio.TransferTokenBuilder.SetAccountId ( string  accountId)
inline

Adds a source accountId to the token.

Parameters
accountIdthe source accountId
Returns
the builder

◆ SetActingAs()

TransferTokenBuilder Tokenio.TransferTokenBuilder.SetActingAs ( ActingAs  actingAs)
inline

Sets acting as on the token

Parameters
actingAsentity the redeemer is acting on behalf of
Returns
the builder

◆ SetChargeAmount()

TransferTokenBuilder Tokenio.TransferTokenBuilder.SetChargeAmount ( double  chargeAmount)
inline

Sets the maximum amount per charge.

Parameters
chargeAmountthe charge amount
Returns
the builder

◆ SetCustomAuthoriaztion()

TransferTokenBuilder Tokenio.TransferTokenBuilder.SetCustomAuthoriaztion ( string  bankId,
string  authorization 
)
inline

Sets the source custom authorization.

Parameters
bankIdsource bank ID
authorizationsource custom authorization
Returns
the builder

◆ SetDescription()

TransferTokenBuilder Tokenio.TransferTokenBuilder.SetDescription ( string  description)
inline

Sets the description.

Parameters
descriptionthe description
Returns
the builder

◆ SetEffectiveAtMs()

TransferTokenBuilder Tokenio.TransferTokenBuilder.SetEffectiveAtMs ( long  effectiveAtMs)
inline

Sets the effective date.

Parameters
effectiveAtMsthe effective date in ms.
Returns
the builder

◆ SetEndorseUntilMs()

TransferTokenBuilder Tokenio.TransferTokenBuilder.SetEndorseUntilMs ( long  endorseUntilMs)
inline

Sets the time after which endorse is no longer possible.

Parameters
endorseUntilMsendorse until, in milliseconds.
Returns
the builder

◆ SetExpiresAtMs()

TransferTokenBuilder Tokenio.TransferTokenBuilder.SetExpiresAtMs ( long  expiresAtMs)
inline

Sets the expiration date.

Parameters
expiresAtMsthe expiration date in ms.
Returns
the builder

◆ SetPricing()

TransferTokenBuilder Tokenio.TransferTokenBuilder.SetPricing ( Pricing  pricing)
inline

Sets the pricing (fees/fx) on the token.

Parameters
pricingthe pricing
Returns
the builder

◆ SetPurposeOfPayment()

TransferTokenBuilder Tokenio.TransferTokenBuilder.SetPurposeOfPayment ( PurposeOfPayment  purposeOfPayment)
inline

Sets the purpose of payment.

Parameters
purposeOfPaymentthe purpose of payment
Returns
the builder

◆ SetRefId()

TransferTokenBuilder Tokenio.TransferTokenBuilder.SetRefId ( string  refId)
inline

Sets the reference Id of the token.

Parameters
refIdthe reference ID, at most 18 characters long
Returns
the builder

◆ SetSource()

TransferTokenBuilder Tokenio.TransferTokenBuilder.SetSource ( TransferEndpoint  source)
inline

Adds a transfer source.

Parameters
sourcethe source
Returns
the builder

◆ SetToAlias()

TransferTokenBuilder Tokenio.TransferTokenBuilder.SetToAlias ( Alias  toAlias)
inline

Sets the alias of the payee.

Parameters
toAliasthe alias
Returns
the builder

◆ SetToMemberId()

TransferTokenBuilder Tokenio.TransferTokenBuilder.SetToMemberId ( string  toMemberId)
inline

Sets the member Id of the payee.

Parameters
toMemberIdthe member id
Returns
the builder

The documentation for this class was generated from the following file: