Inheritance diagram for Tokenio.TokenIOAsync:

Public Member Functions
TokenIO	Sync ()
	Returns a synchronous version of the API. More...

Task< Boolean >	AliasExists (Alias alias)
	Checks if a given alias already exists. More...

Task< string >	GetMemberId (Alias alias)
	Looks up member id for a given alias. More...

Task< MemberAsync >	CreateMember (Alias alias, CreateMemberType createMemberType)
	Creates a new Token member with a set of auto-generated keys, an alias, and member type. More...

Task< MemberAsync >	CreateMember ()
	Creates a new personal-use Token member with a set of auto generated keys and no alias. More...

Task< MemberAsync >	CreateMember (Alias alias)
	Creates a new personal-use Token member with a set of auto generated keys and the given alias. More...

Task< MemberAsync >	CreateBusinessMember (Alias alias)
	Creates a new business-use Token member with a set of auto-generated keys and alias. More...

Task< DeviceInfo >	ProvisionDevice (Alias alias)
	Provisions a new device for an existing user. The call generates a set of keys that are returned back. The keys need to be approved by an existing device/keys. More...

Task< MemberAsync >	GetMember (string memberId)
	Return a MemberAsync set up to use some Token member's keys (assuming we have them). More...

Task< Proto.Common.TokenProtos.TokenRequest >	RetrieveTokenRequest (string requestId)
	Returns a token request for a specified token request id. More...

Task< NotifyStatus >	NotifyAddKey (Alias alias, IList< Key > keys, DeviceMetadata deviceMetadata)
	Notifies to add a key. More...

Task< NotifyStatus >	NotifyPaymentRequest (TokenPayload tokenPayload)
	Sends a notification to request a payment. More...

Task< string >	BeginRecovery (Alias alias)
	Begins account recovery. More...

Task< MemberRecoveryOperation.Types.Authorization >	CreateRecoveryAuthorization (string memberId, Key privilegedKey)
	Create a recovery authorization for some agent to sign. More...

Task< MemberRecoveryOperation >	GetRecoveryAuthorization (string verificationId, string code, Key key)
	Gets recovery authorization from Token. More...

Task< MemberAsync >	CompleteRecovery (string memberId, IList< MemberRecoveryOperation > recoveryOperations, Key privilegedKey, ICryptoEngine cryptoEngine)
	Completes account recovery. More...

Task< MemberAsync >	CompleteRecoveryWithDefaultRule (string memberId, string verificationId, string code)
	Completes account recovery if the default recovery rule was set. More...

Task< PagedBanks >	GetBanks ()
	Returns the first 200 available banks for linking. More...

Task< PagedBanks >	GetBanks (IList< string > ids)
	Returns banks from a given list of bank IDs (case-insensitive). More...

Task< PagedBanks >	GetBanks (string search)
	Return banks whose 'name' or 'identifier' contains the given search string (case-insensitive). More...

Task< PagedBanks >	GetBanks (int page, int perPage)
	Returns banks with specified paging information. More...

Task< PagedBanks >	GetBanks (string country, int page, int perPage)
	Return banks whose 'country' matches the given country code (case-insensitive). More...

Task< PagedBanks >	GetBanks (IList< string > ids, string search, string country, int? page, int? perPage, string sort)
	Return banks that satisfy given filtering requirements. More...

Task< string >	GenerateTokenRequestUrl (string requestId)
	Generates a Token request URL from a request ID, and state. This does not set a CSRF token or pass in a state. More...

Task< string >	GenerateTokenRequestUrl (string requestId, string state)
	Generates a Token request URL from a request ID, and state. This does not set a CSRF token. More...

Task< string >	GenerateTokenRequestUrl (string requestId, string state, string csrfToken)
	Generates a Token request URL from a request ID, an original state and a CSRF token. More...

Task< TokenRequestCallback >	ParseTokenRequestCallbackUrl (string callbackUrl)
	Parse the token request callback URL to extract the state and the token ID. This assumes that no CSRF token was set. More...

Task< TokenRequestCallback >	ParseTokenRequestCallbackUrl (string callbackUrl, string csrfToken)
	Parse the token request callback URL to extract the state and the token ID. Verify that the state contains the CSRF token hash and that the signature on the state and CSRF token is valid. More...

Task< TokenRequestResult >	GetTokenRequestResult (string tokenRequestId)
	Get the token request result based on a token's tokenRequestId. More...

void	Dispose ()

Member Function Documentation

◆ AliasExists()

Task<Boolean> Tokenio.TokenIOAsync.AliasExists ( Alias alias )

inline

Checks if a given alias already exists.

Parameters

alias the alias to check

Returns: true if alias exists, false otherwise

◆ BeginRecovery()

Task<string> Tokenio.TokenIOAsync.BeginRecovery ( Alias alias )

inline

Begins account recovery.

Parameters

alias the used to recover

Returns: the verification id

◆ CompleteRecovery()

Task<MemberAsync> Tokenio.TokenIOAsync.CompleteRecovery	(	string	memberId,
		IList< MemberRecoveryOperation >	recoveryOperations,
		Key	privilegedKey,
		ICryptoEngine	cryptoEngine
	)

inline

Completes account recovery.

Parameters

memberId	the member id
recoveryOperations	the member recovery operations
privilegedKey	the privileged public key in the member recovery operations
cryptoEngine	the new crypto engine

Returns: the new member

◆ CompleteRecoveryWithDefaultRule()

Task<MemberAsync> Tokenio.TokenIOAsync.CompleteRecoveryWithDefaultRule	(	string	memberId,
		string	verificationId,
		string	code
	)

inline

Completes account recovery if the default recovery rule was set.

Parameters

memberId	the member id
verificationId	the verification id
code	the code

Returns: the new member

◆ CreateBusinessMember()

Task<MemberAsync> Tokenio.TokenIOAsync.CreateBusinessMember ( Alias alias )

inline

Creates a new business-use Token member with a set of auto-generated keys and alias.

Parameters

alias the alias to be associated with member

Returns: the created member

◆ CreateMember() [1/3]

Task<MemberAsync> Tokenio.TokenIOAsync.CreateMember	(	Alias	alias,
		CreateMemberType	createMemberType
	)

inline

Creates a new Token member with a set of auto-generated keys, an alias, and member type.

Parameters

alias	nullable member alias to use, must be unique. If null, then no alias will be created with the member
createMemberType	the type of member to register

Returns: the created member

◆ CreateMember() [2/3]

Task<MemberAsync> Tokenio.TokenIOAsync.CreateMember ( )

inline

Creates a new personal-use Token member with a set of auto generated keys and no alias.

Returns: the created member

◆ CreateMember() [3/3]

Task<MemberAsync> Tokenio.TokenIOAsync.CreateMember ( Alias alias )

inline

Creates a new personal-use Token member with a set of auto generated keys and the given alias.

Parameters

alias the member alias to use, must be unique

Returns: the created member

◆ CreateRecoveryAuthorization()

Task<MemberRecoveryOperation.Types.Authorization> Tokenio.TokenIOAsync.CreateRecoveryAuthorization	(	string	memberId,
		Key	privilegedKey
	)

inline

Create a recovery authorization for some agent to sign.

Parameters

memberId	the ID of the member we claim to be.
privilegedKey	the new privileged key we want to use.

Returns: the authorization

◆ GenerateTokenRequestUrl() [1/3]

Task<string> Tokenio.TokenIOAsync.GenerateTokenRequestUrl ( string requestId )

inline

Generates a Token request URL from a request ID, and state. This does not set a CSRF token or pass in a state.

Parameters

requestId the request id

Returns: the token request url

◆ GenerateTokenRequestUrl() [2/3]

Task<string> Tokenio.TokenIOAsync.GenerateTokenRequestUrl	(	string	requestId,
		string	state
	)

inline

Generates a Token request URL from a request ID, and state. This does not set a CSRF token.

Parameters

requestId	the request id
state	the state

Returns: the token request url

◆ GenerateTokenRequestUrl() [3/3]

Task<string> Tokenio.TokenIOAsync.GenerateTokenRequestUrl	(	string	requestId,
		string	state,
		string	csrfToken
	)

inline

Generates a Token request URL from a request ID, an original state and a CSRF token.

Parameters

requestId	the request id
state	the state
csrfToken	the csrf token

Returns: the token request url

◆ GetBanks() [1/6]

Task<PagedBanks> Tokenio.TokenIOAsync.GetBanks ( )

inline

Returns the first 200 available banks for linking.

Returns: banks with paging information

◆ GetBanks() [2/6]

Task<PagedBanks> Tokenio.TokenIOAsync.GetBanks ( IList< string > ids )

inline

Returns banks from a given list of bank IDs (case-insensitive).

Parameters

ids	the bank IDs

Returns: banks with paging information

◆ GetBanks() [3/6]

Task<PagedBanks> Tokenio.TokenIOAsync.GetBanks ( string search )

inline

Return banks whose 'name' or 'identifier' contains the given search string (case-insensitive).

Parameters

search the keyword to search for

Returns: banks with paging information

◆ GetBanks() [4/6]

Task<PagedBanks> Tokenio.TokenIOAsync.GetBanks	(	int	page,
		int	perPage
	)

inline

Returns banks with specified paging information.

Parameters

page	the result page to retrieve
perPage	max number of records per page, can be at most 200

Returns: banks with paging information

◆ GetBanks() [5/6]

Task<PagedBanks> Tokenio.TokenIOAsync.GetBanks	(	string	country,
		int	page,
		int	perPage
	)

inline

Return banks whose 'country' matches the given country code (case-insensitive).

Parameters

country	the ISO 3166-1 alpha-2 country code
page	the result page to retrieve
perPage	max number of records per page, can be at most 200

Returns: banks with paging information

◆ GetBanks() [6/6]

Task<PagedBanks> Tokenio.TokenIOAsync.GetBanks	(	IList< string >	ids,
		string	search,
		string	country,
		int?	page,
		int?	perPage,
		string	sort
	)

inline

Return banks that satisfy given filtering requirements.

Parameters

ids	the bank IDs to fetch
search	the keyword to search the fields 'name' and 'identifier' for
country	ISO 3166-1 alpha-2 country code of the banks
page	the result page to retrieve
perPage	max number of records per page, can be at most 200
sort	the key to sort the results, one of: name, provider and country

Returns: banks with paging information

All fields are optional. Set to null if absent. The default value for page is 1; the default value for perPage is 200. Values set out of range will be treated as default value.

◆ GetMember()

Task<MemberAsync> Tokenio.TokenIOAsync.GetMember ( string memberId )

inline

Return a MemberAsync set up to use some Token member's keys (assuming we have them).

Parameters

memberId the member ID

Returns: the member

◆ GetMemberId()

Task<string> Tokenio.TokenIOAsync.GetMemberId ( Alias alias )

inline

Looks up member id for a given alias.

Parameters

alias the alias to check

Returns: member id if alias already exists, null otherwise

◆ GetRecoveryAuthorization()

Task<MemberRecoveryOperation> Tokenio.TokenIOAsync.GetRecoveryAuthorization	(	string	verificationId,
		string	code,
		Key	key
	)

inline

Gets recovery authorization from Token.

Parameters

verificationId	the verification id
code	the verification code
key	the privileged key

Returns: the member recovery operation

◆ GetTokenRequestResult()

Task<TokenRequestResult> Tokenio.TokenIOAsync.GetTokenRequestResult ( string tokenRequestId )

inline

Get the token request result based on a token's tokenRequestId.

Parameters

tokenRequestId the token request id

Returns: the token request result

◆ NotifyAddKey()

Task<NotifyStatus> Tokenio.TokenIOAsync.NotifyAddKey	(	Alias	alias,
		IList< Key >	keys,
		DeviceMetadata	deviceMetadata
	)

inline

Notifies to add a key.

Parameters

alias	alias to notify
keys	keys that need approval
deviceMetadata	device metadata of the keys

Returns: status of the notification

◆ NotifyPaymentRequest()

Task<NotifyStatus> Tokenio.TokenIOAsync.NotifyPaymentRequest ( TokenPayload tokenPayload )

inline

Sends a notification to request a payment.

Parameters

tokenPayload the payload of a token to be sent

Returns: status of the notification request

◆ ParseTokenRequestCallbackUrl() [1/2]

Task<TokenRequestCallback> Tokenio.TokenIOAsync.ParseTokenRequestCallbackUrl ( string callbackUrl )

inline

Parse the token request callback URL to extract the state and the token ID. This assumes that no CSRF token was set.

Parameters

callbackUrl the token request callback url

Returns: an instance of TokenRequestCallback

◆ ParseTokenRequestCallbackUrl() [2/2]

Task<TokenRequestCallback> Tokenio.TokenIOAsync.ParseTokenRequestCallbackUrl	(	string	callbackUrl,
		string	csrfToken
	)

inline

Parse the token request callback URL to extract the state and the token ID. Verify that the state contains the CSRF token hash and that the signature on the state and CSRF token is valid.

Parameters

callbackUrl	the token request callback url
csrfToken	the csrf token

Returns: an instance of TokenRequestCallback

◆ ProvisionDevice()

Task<DeviceInfo> Tokenio.TokenIOAsync.ProvisionDevice ( Alias alias )

inline

Provisions a new device for an existing user. The call generates a set of keys that are returned back. The keys need to be approved by an existing device/keys.

Parameters

alias the alias to provision the device for

Returns: information of the device

◆ RetrieveTokenRequest()

Task<Proto.Common.TokenProtos.TokenRequest> Tokenio.TokenIOAsync.RetrieveTokenRequest ( string requestId )

inline

Returns a token request for a specified token request id.

Parameters

requestId the request id

Returns: the token request

◆ Sync()

TokenIO Tokenio.TokenIOAsync.Sync ( )

inline

Returns a synchronous version of the API.

Returns: the synchronous API

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

TokenIOAsync.cs

Public Member Functions

Member Function Documentation

◆ AliasExists()

◆ BeginRecovery()

◆ CompleteRecovery()

◆ CompleteRecoveryWithDefaultRule()

◆ CreateBusinessMember()

◆ CreateMember() [1/3]

◆ CreateMember() [2/3]

◆ CreateMember() [3/3]

◆ CreateRecoveryAuthorization()

◆ GenerateTokenRequestUrl() [1/3]

◆ GenerateTokenRequestUrl() [2/3]

◆ GenerateTokenRequestUrl() [3/3]

◆ GetBanks() [1/6]

◆ GetBanks() [2/6]

◆ GetBanks() [3/6]

◆ GetBanks() [4/6]

◆ GetBanks() [5/6]

◆ GetBanks() [6/6]

◆ GetMember()

◆ GetMemberId()

◆ GetRecoveryAuthorization()

◆ GetTokenRequestResult()

◆ NotifyAddKey()

◆ NotifyPaymentRequest()

◆ ParseTokenRequestCallbackUrl() [1/2]

◆ ParseTokenRequestCallbackUrl() [2/2]

◆ ProvisionDevice()

◆ RetrieveTokenRequest()

◆ Sync()