io.token

Class MemberAsync

java.lang.Object

io.token.MemberAsync

All Implemented Interfaces:

RepresentableAsync

public class MemberAsync
extends java.lang.Object
implements RepresentableAsync

Represents a Member in the Token system. Each member has an active secret and public key pair that is used to perform authentication.

Method Summary

Modifier and Type	Method and Description
io.reactivex.Observable<io.token.proto.common.member.MemberProtos.AddressRecord>	addAddress(java.lang.String name, io.token.proto.common.address.AddressProtos.Address address) Creates a new member address.
io.reactivex.Completable	addAlias(io.token.proto.common.alias.AliasProtos.Alias alias) Adds a new alias for the member.
io.reactivex.Completable	addAliases(java.util.List<io.token.proto.common.alias.AliasProtos.Alias> aliasList) Adds new aliases for the member.
io.reactivex.Observable<io.token.proto.common.member.MemberProtos.Member>	addRecoveryRule(io.token.proto.common.member.MemberProtos.RecoveryRule recoveryRule) Adds the recovery rule.
io.reactivex.Completable	addTrustedBeneficiary(java.lang.String memberId) Adds a trusted beneficiary for whom the SCA will be skipped.
io.reactivex.Observable<java.util.List<io.token.proto.common.alias.AliasProtos.Alias>>	aliases() Gets all aliases owned by the member.
io.reactivex.Completable	applySca(java.util.List<java.lang.String> accountIds) Apply SCA for the given list of account IDs.
io.reactivex.Completable	approveKey(io.token.security.keystore.SecretKeyPair key, io.token.proto.common.security.SecurityProtos.Key.Level level) Approves a key owned by this member.
io.reactivex.Completable	approveKey(io.token.proto.common.security.SecurityProtos.Key key) Approves a public key owned by this member.
io.reactivex.Completable	approveKeys(java.util.List<io.token.proto.common.security.SecurityProtos.Key> keys) Approves public keys owned by this member.
io.reactivex.Observable<io.token.proto.common.security.SecurityProtos.Signature>	authorizeRecovery(io.token.proto.common.member.MemberProtos.MemberRecoveryOperation.Authorization authorization) Authorizes recovery as a trusted agent.
io.reactivex.Observable<io.token.proto.common.token.TokenProtos.TokenOperationResult>	cancelToken(io.token.proto.common.token.TokenProtos.Token token) Cancels the token by signing it.
void	clearAccessToken() Deprecated.
void	clearSecurityMetadata() Clears security metadata.
io.reactivex.Observable<io.token.proto.common.token.TokenProtos.Token>	createAccessToken(AccessTokenBuilder accessTokenBuilder) Creates an access token built from a given AccessTokenBuilder.
io.reactivex.Observable<io.token.proto.common.token.TokenProtos.Token>	createAccessToken(AccessTokenBuilder accessTokenBuilder, java.lang.String tokenRequestId) Creates an access token built from a given AccessTokenBuilder.
io.reactivex.Observable<AccountAsync>	createAndLinkTestBankAccount(double balance, java.lang.String currency) Creates a test bank account in a fake bank and links the account.
io.reactivex.Observable<io.token.proto.common.blob.BlobProtos.Attachment>	createBlob(java.lang.String ownerId, java.lang.String type, java.lang.String name, byte[] data) Creates and uploads a blob.
io.reactivex.Observable<io.token.proto.common.blob.BlobProtos.Attachment>	createBlob(java.lang.String ownerId, java.lang.String type, java.lang.String name, byte[] data, io.token.proto.common.blob.BlobProtos.Blob.AccessMode accessMode) Creates and uploads a blob.
io.reactivex.Observable<java.lang.String>	createCustomization(io.token.proto.common.blob.BlobProtos.Blob.Payload logo, java.util.Map<java.lang.String,java.lang.String> colors, java.lang.String consentText, java.lang.String name, java.lang.String appName) Creates a customization.
io.reactivex.Observable<io.token.proto.banklink.Banklink.OauthBankAuthorization>	createTestBankAccount(double balance, java.lang.String currency) Creates a test bank account in a fake bank.
TransferTokenBuilder	createTransferToken(double amount, java.lang.String currency) Creates a new transfer token builder.
io.reactivex.Observable<io.token.proto.common.token.TokenProtos.Token>	createTransferToken(io.token.proto.common.token.TokenProtos.TokenPayload payload) Creates a new transfer token from a token payload.
io.reactivex.Observable<io.token.proto.common.token.TokenProtos.Token>	createTransferToken(io.token.proto.common.token.TokenProtos.TokenPayload payload, java.lang.String tokenRequestId) Creates a new transfer token from a token payload.
io.reactivex.Completable	deleteAddress(java.lang.String addressId) Deletes a member address by its id.
io.reactivex.Completable	deleteMember() Delete the member.
io.reactivex.Observable<io.token.proto.common.token.TokenProtos.TokenOperationResult>	endorseToken(io.token.proto.common.token.TokenProtos.Token token, io.token.proto.common.security.SecurityProtos.Key.Level keyLevel) Endorses the token by signing it.
boolean	equals(java.lang.Object obj)
io.reactivex.Observable<io.token.proto.common.alias.AliasProtos.Alias>	firstAlias() Gets the first alias owner by the user.
RepresentableAsync	forAccessToken(java.lang.String tokenId) Creates a RepresentableAsync that acts as another member using the access token that was granted by that member.
RepresentableAsync	forAccessToken(java.lang.String tokenId, boolean customerInitiated) Creates a RepresentableAsync that acts as another member using the access token that was granted by that member.
io.reactivex.Observable<io.token.proto.PagedList<io.token.proto.common.token.TokenProtos.Token,java.lang.String>>	getAccessTokens(java.lang.String offset, int limit) Looks up access tokens owned by the member.
io.reactivex.Observable<AccountAsync>	getAccount(java.lang.String accountId) Looks up a funding bank account linked to Token.
io.reactivex.Observable<java.util.List<AccountAsync>>	getAccounts() Links a funding bank account to Token and returns it to the caller.
io.reactivex.Observable<io.token.proto.common.token.TokenProtos.Token>	getActiveAccessToken(java.lang.String toMemberId) Looks up a existing access token where the calling member is the grantor and given member is the grantee.
io.reactivex.Observable<io.token.proto.common.member.MemberProtos.AddressRecord>	getAddress(java.lang.String addressId) Looks up an address by id.
io.reactivex.Observable<java.util.List<io.token.proto.common.member.MemberProtos.AddressRecord>>	getAddresses() Looks up member addresses.
io.reactivex.Observable<io.token.proto.common.money.MoneyProtos.Money>	getAvailableBalance(java.lang.String accountId, io.token.proto.common.security.SecurityProtos.Key.Level keyLevel) Looks up available account balance.
io.reactivex.Observable<io.token.proto.common.transaction.TransactionProtos.Balance>	getBalance(java.lang.String accountId, io.token.proto.common.security.SecurityProtos.Key.Level keyLevel) Looks up account balance.
io.reactivex.Observable<java.util.List<io.token.proto.common.transaction.TransactionProtos.Balance>>	getBalances(java.util.List<java.lang.String> accountIds, io.token.proto.common.security.SecurityProtos.Key.Level keyLevel) Looks up balances for a list of accounts.
io.reactivex.Observable<io.token.proto.common.bank.BankProtos.BankInfo>	getBankInfo(java.lang.String bankId) Returns linking information for the specified bank id.
io.reactivex.Observable<io.token.proto.common.blob.BlobProtos.Blob>	getBlob(java.lang.String blobId) Retrieves a blob from the server.
io.reactivex.Observable<io.token.proto.common.money.MoneyProtos.Money>	getCurrentBalance(java.lang.String accountId, io.token.proto.common.security.SecurityProtos.Key.Level keyLevel) Looks up current account balance.
io.reactivex.Observable<AccountAsync>	getDefaultAccount(java.lang.String memberId) Get the default bank account for this member.
io.reactivex.Observable<java.lang.String>	getDefaultAgent() Gets the member id of the default recovery agent.
io.reactivex.Observable<java.util.List<io.token.proto.common.security.SecurityProtos.Key>>	getKeys() Gets all public keys for this member.
io.reactivex.Observable<io.token.proto.common.notification.NotificationProtos.Notification>	getNotification(java.lang.String notificationId) Gets a notification by id.
io.reactivex.Observable<io.token.proto.PagedList<io.token.proto.common.notification.NotificationProtos.Notification,java.lang.String>>	getNotifications(java.lang.String offset, int limit) Gets a list of the member's notifications.
io.reactivex.Observable<java.util.List<io.token.proto.common.member.MemberProtos.Device>>	getPairedDevices() Get list of paired devices.
io.reactivex.Observable<io.token.proto.common.member.MemberProtos.Profile>	getProfile(java.lang.String memberId) Gets a member's public profile.
io.reactivex.Observable<io.token.proto.common.blob.BlobProtos.Blob>	getProfilePicture(java.lang.String memberId, io.token.proto.common.member.MemberProtos.ProfilePictureSize size) Gets a member's public profile picture.
io.reactivex.Observable<io.token.proto.common.member.MemberProtos.ReceiptContact>	getReceiptContact() Gets the member's receipt email address.
io.reactivex.Observable<io.token.proto.common.subscriber.SubscriberProtos.Subscriber>	getSubscriber(java.lang.String subscriberId) Gets a subscriber by id.
io.reactivex.Observable<java.util.List<io.token.proto.common.subscriber.SubscriberProtos.Subscriber>>	getSubscribers() Gets subscribers.
io.reactivex.Observable<io.token.proto.common.token.TokenProtos.Token>	getToken(java.lang.String tokenId) Looks up a existing token.
io.reactivex.Observable<io.token.proto.common.blob.BlobProtos.Blob>	getTokenBlob(java.lang.String tokenId, java.lang.String blobId) Retrieves a blob that is attached to a transfer token.
TokenIO.TokenCluster	getTokenCluster() Get the Token cluster, e.g.
io.reactivex.Observable<io.token.proto.common.transaction.TransactionProtos.Transaction>	getTransaction(java.lang.String accountId, java.lang.String transactionId, io.token.proto.common.security.SecurityProtos.Key.Level keyLevel) Looks up an existing transaction for a given account.
io.reactivex.Observable<io.token.proto.PagedList<io.token.proto.common.transaction.TransactionProtos.Transaction,java.lang.String>>	getTransactions(java.lang.String accountId, java.lang.String offset, int limit, io.token.proto.common.security.SecurityProtos.Key.Level keyLevel) Looks up transactions for a given account.
io.reactivex.Observable<io.token.proto.common.transfer.TransferProtos.Transfer>	getTransfer(java.lang.String transferId) Looks up an existing token transfer.
io.reactivex.Observable<io.token.proto.PagedList<io.token.proto.common.transfer.TransferProtos.Transfer,java.lang.String>>	getTransfers(java.lang.String offset, int limit, java.lang.String tokenId) Looks up existing token transfers.
io.reactivex.Observable<io.token.proto.PagedList<io.token.proto.common.token.TokenProtos.Token,java.lang.String>>	getTransferTokens(java.lang.String offset, int limit) Looks up transfer tokens owned by the member.
io.reactivex.Observable<java.util.List<io.token.proto.common.member.MemberProtos.TrustedBeneficiary>>	getTrustedBeneficiaries() Gets a list of all trusted beneficiaries.
int	hashCode()
io.reactivex.Observable<java.util.List<Account>>	initiateAccountLinking(java.lang.String bankId) Links accounts by navigating browser through bank authorization pages.
java.util.List<io.token.proto.common.security.SecurityProtos.Key>	keys() Deprecated.
io.reactivex.Observable<java.lang.String>	lastHash() Gets the last hash.
io.reactivex.Observable<java.util.List<AccountAsync>>	linkAccounts(io.token.proto.banklink.Banklink.BankAuthorization authorization) Links a funding bank accounts to Token and returns it to the caller.
io.reactivex.Observable<java.util.List<AccountAsync>>	linkAccounts(java.lang.String bankId, java.lang.String accessToken) Links funding bank accounts to Token and returns them to the caller.
java.lang.String	memberId() Gets member ID.
io.reactivex.Observable<io.token.proto.common.transfer.TransferProtos.Transfer>	redeemToken(io.token.proto.common.token.TokenProtos.Token token) Redeems a transfer token.
io.reactivex.Observable<io.token.proto.common.transfer.TransferProtos.Transfer>	redeemToken(io.token.proto.common.token.TokenProtos.Token token, java.lang.Double amount, java.lang.String currency, java.lang.String description, io.token.proto.common.transferinstructions.TransferInstructionsProtos.TransferEndpoint destination, java.lang.String refId) Redeems a transfer token.
io.reactivex.Observable<io.token.proto.common.transfer.TransferProtos.Transfer>	redeemToken(io.token.proto.common.token.TokenProtos.Token token, java.lang.String refId) Redeems a transfer token.
io.reactivex.Observable<io.token.proto.common.transfer.TransferProtos.Transfer>	redeemToken(io.token.proto.common.token.TokenProtos.Token token, io.token.proto.common.transferinstructions.TransferInstructionsProtos.TransferEndpoint destination) Redeems a transfer token.
io.reactivex.Observable<io.token.proto.common.transfer.TransferProtos.Transfer>	redeemToken(io.token.proto.common.token.TokenProtos.Token token, io.token.proto.common.transferinstructions.TransferInstructionsProtos.TransferEndpoint destination, java.lang.String refId) Redeems a transfer token.
io.reactivex.Completable	removeAlias(io.token.proto.common.alias.AliasProtos.Alias alias) Removes an alias for the member.
io.reactivex.Completable	removeAliases(java.util.List<io.token.proto.common.alias.AliasProtos.Alias> aliasList) Removes aliases for the member.
io.reactivex.Completable	removeKey(java.lang.String keyId) Removes a public key owned by this member.
io.reactivex.Completable	removeKeys(java.util.List<java.lang.String> keyIds) Removes public keys owned by this member.
io.reactivex.Completable	removeNonStoredKeys() Removes all public keys that do not have a corresponding private key stored on the current device from tke member.
io.reactivex.Completable	removeTrustedBeneficiary(java.lang.String memberId) Removes a trusted beneficiary.
io.reactivex.Observable<io.token.proto.common.token.TokenProtos.TokenOperationResult>	replaceAccessToken(io.token.proto.common.token.TokenProtos.Token tokenToCancel, AccessTokenBuilder tokenToCreate) Cancels the existing access token and creates a replacement for it.
io.reactivex.Observable<io.token.proto.common.token.TokenProtos.TokenOperationResult>	replaceAndEndorseAccessToken(io.token.proto.common.token.TokenProtos.Token tokenToCancel, AccessTokenBuilder tokenToCreate) Deprecated. use replaceAccessToken(io.token.proto.common.token.TokenProtos.Token, io.token.AccessTokenBuilder) and endorseToken(io.token.proto.common.token.TokenProtos.Token, io.token.proto.common.security.SecurityProtos.Key.Level) instead
io.reactivex.Observable<java.util.List<io.token.proto.common.transferinstructions.TransferInstructionsProtos.TransferEndpoint>>	resolveTransferDestinations(java.lang.String accountId) Resolves transfer destinations for the given account ID.
io.reactivex.Observable<java.lang.String>	retryVerification(io.token.proto.common.alias.AliasProtos.Alias alias) Retries alias verification.
io.reactivex.Observable<io.token.proto.common.member.MemberProtos.Profile>	setProfile(io.token.proto.common.member.MemberProtos.Profile profile) Replaces auth'd member's public profile.
io.reactivex.Completable	setProfilePicture(java.lang.String type, byte[] data) Replaces auth'd member's public profile picture.
io.reactivex.Completable	setReceiptContact(io.token.proto.common.member.MemberProtos.ReceiptContact contact) Replaces the member's receipt contact.
void	setSecurityMetadata(io.token.proto.common.security.SecurityProtos.SecurityMetadata securityMetadata) Sets security metadata included in all requests.
io.reactivex.Observable<io.token.proto.common.security.SecurityProtos.Signature>	signTokenRequestState(java.lang.String tokenRequestId, java.lang.String tokenId, java.lang.String state) Sign with a Token signature a token request state payload.
io.reactivex.Observable<java.lang.String>	storeTokenRequest(TokenRequest tokenRequest) Stores a token request.
io.reactivex.Observable<io.token.proto.common.subscriber.SubscriberProtos.Subscriber>	subscribeToNotifications(java.lang.String handler, java.util.Map<java.lang.String,java.lang.String> handlerInstructions) Creates a subscriber to push notifications.
Member	sync() Gets a sync version of the account API.
java.lang.String	toString()
io.reactivex.Observable<io.token.proto.common.notification.NotificationProtos.NotifyStatus>	triggerBalanceStepUpNotification(java.util.List<java.lang.String> accountIds) Trigger a step up notification for balance requests.
io.reactivex.Observable<io.token.proto.common.notification.NotificationProtos.NotifyStatus>	triggerTokenStepUpNotification(java.lang.String tokenId) Trigger a step up notification for tokens.
io.reactivex.Observable<io.token.proto.common.notification.NotificationProtos.NotifyStatus>	triggerTransactionStepUpNotification(java.lang.String accountId) Trigger a step up notification for transaction requests.
io.reactivex.Completable	unlinkAccounts(java.util.List<java.lang.String> accountIds) Unlinks bank accounts previously linked via linkAccounts call.
io.reactivex.Completable	unsubscribeFromNotifications(java.lang.String subscriberId) Removes a subscriber.
void	useAccessToken(java.lang.String accessTokenId) Deprecated.
void	useAccessToken(java.lang.String accessTokenId, boolean customerInitiated) Deprecated.
io.reactivex.Completable	useDefaultRecoveryRule() Set Token as the recovery agent.
io.reactivex.Completable	verifyAffiliate(java.lang.String memberId) Verifies an affiliated TPP.
io.reactivex.Completable	verifyAlias(java.lang.String verificationId, java.lang.String code) Verifies a given alias.

Methods inherited from class java.lang.Object

clone, finalize, getClass, notify, notifyAll, wait, wait, wait

Method Detail

sync

public Member sync()

Gets a sync version of the account API.

Returns:

synchronous version of the account API

memberId

public java.lang.String memberId()

Gets member ID.

Returns:

a unique ID that identifies the member in the Token system

lastHash

public io.reactivex.Observable<java.lang.String> lastHash()

Gets the last hash.

Returns:

an observable of the last hash

firstAlias

public io.reactivex.Observable<io.token.proto.common.alias.AliasProtos.Alias> firstAlias()

Gets the first alias owner by the user.

Returns:

first alias owned by the user, or throws exception if no aliases are found

aliases

public io.reactivex.Observable<java.util.List<io.token.proto.common.alias.AliasProtos.Alias>> aliases()

Gets all aliases owned by the member.

Returns:

list of aliases owned by the member

keys

@Deprecated
public java.util.List<io.token.proto.common.security.SecurityProtos.Key> keys()

Deprecated.

Gets all public keys for this member.

Returns:

list of public keys that are approved for this member

getKeys

public io.reactivex.Observable<java.util.List<io.token.proto.common.security.SecurityProtos.Key>> getKeys()

Gets all public keys for this member.

Returns:

list of public keys that are approved for this member

useAccessToken

@Deprecated
public void useAccessToken(java.lang.String accessTokenId)

Deprecated.

Sets the On-Behalf-Of authentication value to be used with this client. The value must correspond to an existing Access Token ID issued for the client member.

Parameters:

accessTokenId - the access token id

useAccessToken

@Deprecated
public void useAccessToken(java.lang.String accessTokenId,
                                       boolean customerInitiated)

Deprecated.

Sets the On-Behalf-Of authentication value to be used with this client. The value must correspond to an existing Access Token ID issued for the client member.

Parameters:

accessTokenId - the access token id

customerInitiated - whether the request is customer initiated

clearAccessToken

@Deprecated
public void clearAccessToken()

Deprecated.

Clears the access token id from the authentication context used with this client.

forAccessToken

public RepresentableAsync forAccessToken(java.lang.String tokenId)

Creates a RepresentableAsync that acts as another member using the access token that was granted by that member.

Parameters:

tokenId - the token id

Returns:

the RepresentableAsync

forAccessToken

public RepresentableAsync forAccessToken(java.lang.String tokenId,
                                         boolean customerInitiated)

Creates a RepresentableAsync that acts as another member using the access token that was granted by that member.

Parameters:

tokenId - the token id

customerInitiated - whether the call is initiated by the customer

Returns:

the RepresentableAsync

addAlias

public io.reactivex.Completable addAlias(io.token.proto.common.alias.AliasProtos.Alias alias)

Adds a new alias for the member.

Parameters:

alias - alias, e.g. 'john', must be unique

Returns:

completable that indicates whether the operation finished or had an error

addAliases

public io.reactivex.Completable addAliases(java.util.List<io.token.proto.common.alias.AliasProtos.Alias> aliasList)

Adds new aliases for the member.

Parameters:

aliasList - aliases, e.g. 'john', must be unique

Returns:

completable that indicates whether the operation finished or had an error

retryVerification

public io.reactivex.Observable<java.lang.String> retryVerification(io.token.proto.common.alias.AliasProtos.Alias alias)

Retries alias verification.

Parameters:

alias - the alias to be verified

Returns:

the verification id

addRecoveryRule

public io.reactivex.Observable<io.token.proto.common.member.MemberProtos.Member> addRecoveryRule(io.token.proto.common.member.MemberProtos.RecoveryRule recoveryRule)

Adds the recovery rule.

Parameters:

recoveryRule - the recovery rule

Returns:

an observable of updated member

useDefaultRecoveryRule

public io.reactivex.Completable useDefaultRecoveryRule()

Set Token as the recovery agent.

Returns:

a completable

authorizeRecovery

public io.reactivex.Observable<io.token.proto.common.security.SecurityProtos.Signature> authorizeRecovery(io.token.proto.common.member.MemberProtos.MemberRecoveryOperation.Authorization authorization)

Authorizes recovery as a trusted agent.

Parameters:

authorization - the authorization

Returns:

the signature

getDefaultAgent

public io.reactivex.Observable<java.lang.String> getDefaultAgent()

Gets the member id of the default recovery agent.

Returns:

the member id

verifyAlias

public io.reactivex.Completable verifyAlias(java.lang.String verificationId,
                                            java.lang.String code)

Verifies a given alias.

Parameters:

verificationId - the verification id

code - the code

Returns:

a completable

removeAlias

public io.reactivex.Completable removeAlias(io.token.proto.common.alias.AliasProtos.Alias alias)

Removes an alias for the member.

Parameters:

alias - alias, e.g. 'john'

Returns:

completable that indicates whether the operation finished or had an error

removeAliases

public io.reactivex.Completable removeAliases(java.util.List<io.token.proto.common.alias.AliasProtos.Alias> aliasList)

Removes aliases for the member.

Parameters:

aliasList - aliases, e.g. 'john'

Returns:

completable that indicates whether the operation finished or had an error

approveKey

public io.reactivex.Completable approveKey(io.token.security.keystore.SecretKeyPair key,
                                           io.token.proto.common.security.SecurityProtos.Key.Level level)

Approves a key owned by this member. The key is added to the list of valid keys for the member.

Parameters:

key - key to add to the approved list

level - key privilege level

Returns:

completable that indicates whether the operation finished or had an error

approveKey

public io.reactivex.Completable approveKey(io.token.proto.common.security.SecurityProtos.Key key)

Approves a public key owned by this member. The key is added to the list of valid keys for the member.

Parameters:

key - key to add to the approved list

Returns:

completable that indicates whether the operation finished or had an error

approveKeys

public io.reactivex.Completable approveKeys(java.util.List<io.token.proto.common.security.SecurityProtos.Key> keys)

Approves public keys owned by this member. The keys are added to the list of valid keys for the member.

Parameters:

keys - keys to add to the approved list

Returns:

completable that indicates whether the operation finished or had an error

removeKey

public io.reactivex.Completable removeKey(java.lang.String keyId)

Removes a public key owned by this member.

Parameters:

keyId - key ID of the key to remove

Returns:

completable that indicates whether the operation finished or had an error

removeKeys

public io.reactivex.Completable removeKeys(java.util.List<java.lang.String> keyIds)

Removes public keys owned by this member.

Parameters:

keyIds - key IDs of the keys to remove

Returns:

completable that indicates whether the operation finished or had an error

removeNonStoredKeys

public io.reactivex.Completable removeNonStoredKeys()

Removes all public keys that do not have a corresponding private key stored on the current device from tke member.

Returns:

completable that indicates whether the operation finished or had an error

subscribeToNotifications

public io.reactivex.Observable<io.token.proto.common.subscriber.SubscriberProtos.Subscriber> subscribeToNotifications(java.lang.String handler,
                                                                                                                      java.util.Map<java.lang.String,java.lang.String> handlerInstructions)

Creates a subscriber to push notifications.

Parameters:

handler - specify the handler of the notifications

handlerInstructions - map of instructions for the handler

Returns:

subscriber Subscriber

getSubscribers

public io.reactivex.Observable<java.util.List<io.token.proto.common.subscriber.SubscriberProtos.Subscriber>> getSubscribers()

Gets subscribers.

Returns:

subscribers

getSubscriber

public io.reactivex.Observable<io.token.proto.common.subscriber.SubscriberProtos.Subscriber> getSubscriber(java.lang.String subscriberId)

Gets a subscriber by id.

Parameters:

subscriberId - Id of the subscriber

Returns:

subscriber

unsubscribeFromNotifications

public io.reactivex.Completable unsubscribeFromNotifications(java.lang.String subscriberId)

Removes a subscriber.

Parameters:

subscriberId - subscriberId

Returns:

completable that indicates whether the operation finished or had an error

getNotifications

public io.reactivex.Observable<io.token.proto.PagedList<io.token.proto.common.notification.NotificationProtos.Notification,java.lang.String>> getNotifications(@Nullable
                                                                                                                                                               java.lang.String offset,
                                                                                                                                                               int limit)

Gets a list of the member's notifications.

Parameters:

offset - offset to start

limit - how many notifications to get

Returns:

list of notifications

getNotification

public io.reactivex.Observable<io.token.proto.common.notification.NotificationProtos.Notification> getNotification(java.lang.String notificationId)

Gets a notification by id.

Parameters:

notificationId - Id of the notification

Returns:

notification

initiateAccountLinking

public io.reactivex.Observable<java.util.List<Account>> initiateAccountLinking(java.lang.String bankId)
                                                                        throws BankAuthorizationRequiredException

Links accounts by navigating browser through bank authorization pages. Returns empty list if the linking process is cancelled from the browser.

Parameters:

bankId - the bank id

Returns:

observable list of linked accounts

Throws:

BankAuthorizationRequiredException - if bank authorization payload is required to link accounts

linkAccounts

public io.reactivex.Observable<java.util.List<AccountAsync>> linkAccounts(io.token.proto.banklink.Banklink.BankAuthorization authorization)

Links a funding bank accounts to Token and returns it to the caller.

Parameters:

authorization - an authorization to accounts, from the bank

Returns:

list of linked accounts

linkAccounts

public io.reactivex.Observable<java.util.List<AccountAsync>> linkAccounts(java.lang.String bankId,
                                                                          java.lang.String accessToken)
                                                                   throws BankAuthorizationRequiredException

Links funding bank accounts to Token and returns them to the caller.

Parameters:

bankId - bank id

accessToken - OAuth access token

Returns:

list of linked accounts

Throws:

BankAuthorizationRequiredException - if bank authorization payload is required to link accounts

unlinkAccounts

public io.reactivex.Completable unlinkAccounts(java.util.List<java.lang.String> accountIds)

Unlinks bank accounts previously linked via linkAccounts call.

Parameters:

accountIds - account ids to unlink

Returns:

nothing

getAccounts

public io.reactivex.Observable<java.util.List<AccountAsync>> getAccounts()

Links a funding bank account to Token and returns it to the caller.

Specified by:

getAccounts in interface RepresentableAsync

Returns:

list of accounts

getAccount

public io.reactivex.Observable<AccountAsync> getAccount(java.lang.String accountId)

Looks up a funding bank account linked to Token.

Specified by:

getAccount in interface RepresentableAsync

Parameters:

accountId - account id

Returns:

looked up account

getTransfer

public io.reactivex.Observable<io.token.proto.common.transfer.TransferProtos.Transfer> getTransfer(java.lang.String transferId)

Looks up an existing token transfer.

Parameters:

transferId - ID of the transfer record

Returns:

transfer record

getTransfers

public io.reactivex.Observable<io.token.proto.PagedList<io.token.proto.common.transfer.TransferProtos.Transfer,java.lang.String>> getTransfers(@Nullable
                                                                                                                                               java.lang.String offset,
                                                                                                                                               int limit,
                                                                                                                                               @Nullable
                                                                                                                                               java.lang.String tokenId)

Looks up existing token transfers.

Parameters:

offset - optional offset to start at

limit - max number of records to return

tokenId - optional token id to restrict the search

Returns:

transfer record

createBlob

public io.reactivex.Observable<io.token.proto.common.blob.BlobProtos.Attachment> createBlob(java.lang.String ownerId,
                                                                                            java.lang.String type,
                                                                                            java.lang.String name,
                                                                                            byte[] data)

Creates and uploads a blob.

Parameters:

ownerId - id of the owner of the blob

type - MIME type of the file

name - name

data - file data

Returns:

attachment

createBlob

public io.reactivex.Observable<io.token.proto.common.blob.BlobProtos.Attachment> createBlob(java.lang.String ownerId,
                                                                                            java.lang.String type,
                                                                                            java.lang.String name,
                                                                                            byte[] data,
                                                                                            io.token.proto.common.blob.BlobProtos.Blob.AccessMode accessMode)

Creates and uploads a blob.

Parameters:

ownerId - id of the owner of the blob

type - MIME type of the file

name - name

data - file data

accessMode - Normal access or public

Returns:

attachment

getBlob

public io.reactivex.Observable<io.token.proto.common.blob.BlobProtos.Blob> getBlob(java.lang.String blobId)

Retrieves a blob from the server.

Parameters:

blobId - id of the blob

Returns:

Blob

getTokenBlob

public io.reactivex.Observable<io.token.proto.common.blob.BlobProtos.Blob> getTokenBlob(java.lang.String tokenId,
                                                                                        java.lang.String blobId)

Retrieves a blob that is attached to a transfer token.

Parameters:

tokenId - id of the token

blobId - id of the blob

Returns:

Blob

addAddress

public io.reactivex.Observable<io.token.proto.common.member.MemberProtos.AddressRecord> addAddress(java.lang.String name,
                                                                                                   io.token.proto.common.address.AddressProtos.Address address)

Creates a new member address.

Parameters:

name - the name of the address

address - the address

Returns:

an address record created

getAddress

public io.reactivex.Observable<io.token.proto.common.member.MemberProtos.AddressRecord> getAddress(java.lang.String addressId)

Looks up an address by id.

Specified by:

getAddress in interface RepresentableAsync

Parameters:

addressId - the address id

Returns:

an address record

getAddresses

public io.reactivex.Observable<java.util.List<io.token.proto.common.member.MemberProtos.AddressRecord>> getAddresses()

Looks up member addresses.

Specified by:

getAddresses in interface RepresentableAsync

Returns:

a list of addresses

deleteAddress

public io.reactivex.Completable deleteAddress(java.lang.String addressId)

Deletes a member address by its id.

Parameters:

addressId - the id of the address

Returns:

completable that indicates whether the operation finished or had an error

setProfile

public io.reactivex.Observable<io.token.proto.common.member.MemberProtos.Profile> setProfile(io.token.proto.common.member.MemberProtos.Profile profile)

Replaces auth'd member's public profile.

Parameters:

profile - profile to set

Returns:

updated profile

getProfile

public io.reactivex.Observable<io.token.proto.common.member.MemberProtos.Profile> getProfile(java.lang.String memberId)

Gets a member's public profile. Unlike setProfile, you can get another member's profile.

Parameters:

memberId - member ID of member whose profile we want

Returns:

their profile

setProfilePicture

public io.reactivex.Completable setProfilePicture(java.lang.String type,
                                                  byte[] data)

Replaces auth'd member's public profile picture.

Parameters:

type - MIME type of picture

data - image data

Returns:

completable that indicates whether the operation finished or had an error

getProfilePicture

public io.reactivex.Observable<io.token.proto.common.blob.BlobProtos.Blob> getProfilePicture(java.lang.String memberId,
                                                                                             io.token.proto.common.member.MemberProtos.ProfilePictureSize size)

Gets a member's public profile picture. Unlike set, you can get another member's picture.

Parameters:

memberId - member ID of member whose profile we want

size - desired size category (small, medium, large, original)

Returns:

blob with picture; empty blob (no fields set) if has no picture

setReceiptContact

public io.reactivex.Completable setReceiptContact(io.token.proto.common.member.MemberProtos.ReceiptContact contact)

Replaces the member's receipt contact.

Parameters:

contact - receipt contact to set

Returns:

completable that indicates whether the operation finished or had an error

getReceiptContact

public io.reactivex.Observable<io.token.proto.common.member.MemberProtos.ReceiptContact> getReceiptContact()

Gets the member's receipt email address.

Returns:

receipt contact

storeTokenRequest

public io.reactivex.Observable<java.lang.String> storeTokenRequest(TokenRequest tokenRequest)

Stores a token request. This can be retrieved later by the token request id.

Parameters:

tokenRequest - token request

Returns:

token request id

createTransferToken

public TransferTokenBuilder createTransferToken(double amount,
                                                java.lang.String currency)

Creates a new transfer token builder.

Parameters:

amount - transfer amount

currency - currency code, e.g. "USD"

Returns:

transfer token returned by the server

createTransferToken

public io.reactivex.Observable<io.token.proto.common.token.TokenProtos.Token> createTransferToken(io.token.proto.common.token.TokenProtos.TokenPayload payload)

Creates a new transfer token from a token payload.

Parameters:

payload - transfer token payload

Returns:

transfer token returned by the server

createTransferToken

public io.reactivex.Observable<io.token.proto.common.token.TokenProtos.Token> createTransferToken(io.token.proto.common.token.TokenProtos.TokenPayload payload,
                                                                                                  java.lang.String tokenRequestId)

Creates a new transfer token from a token payload.

Parameters:

payload - transfer token payload

tokenRequestId - token request id

Returns:

transfer token returned by the server

createAccessToken

public io.reactivex.Observable<io.token.proto.common.token.TokenProtos.Token> createAccessToken(AccessTokenBuilder accessTokenBuilder)

Creates an access token built from a given AccessTokenBuilder.

Parameters:

accessTokenBuilder - an AccessTokenBuilder to create access token from

Returns:

the access token created

createAccessToken

public io.reactivex.Observable<io.token.proto.common.token.TokenProtos.Token> createAccessToken(AccessTokenBuilder accessTokenBuilder,
                                                                                                java.lang.String tokenRequestId)

Creates an access token built from a given AccessTokenBuilder.

Parameters:

accessTokenBuilder - an AccessTokenBuilder to create access token from

tokenRequestId - token request id

Returns:

the access token created

getToken

public io.reactivex.Observable<io.token.proto.common.token.TokenProtos.Token> getToken(java.lang.String tokenId)

Looks up a existing token.

Parameters:

tokenId - token id

Returns:

token returned by the server

getActiveAccessToken

public io.reactivex.Observable<io.token.proto.common.token.TokenProtos.Token> getActiveAccessToken(java.lang.String toMemberId)

Looks up a existing access token where the calling member is the grantor and given member is the grantee.

Parameters:

toMemberId - beneficiary of the active access token

Returns:

access token returned by the server

getTransferTokens

public io.reactivex.Observable<io.token.proto.PagedList<io.token.proto.common.token.TokenProtos.Token,java.lang.String>> getTransferTokens(@Nullable
                                                                                                                                           java.lang.String offset,
                                                                                                                                           int limit)

Looks up transfer tokens owned by the member.

Parameters:

offset - optional offset to start at

limit - max number of records to return

Returns:

transfer tokens owned by the member

getAccessTokens

public io.reactivex.Observable<io.token.proto.PagedList<io.token.proto.common.token.TokenProtos.Token,java.lang.String>> getAccessTokens(@Nullable
                                                                                                                                         java.lang.String offset,
                                                                                                                                         int limit)

Looks up access tokens owned by the member.

Parameters:

offset - optional offset to start at

limit - max number of records to return

Returns:

transfer tokens owned by the member

endorseToken

public io.reactivex.Observable<io.token.proto.common.token.TokenProtos.TokenOperationResult> endorseToken(io.token.proto.common.token.TokenProtos.Token token,
                                                                                                          io.token.proto.common.security.SecurityProtos.Key.Level keyLevel)

Endorses the token by signing it. The signature is persisted along with the token.

If the key's level is too low, the result's status is MORE_SIGNATURES_NEEDED and the system pushes a notification to the member prompting them to use a higher-privilege key.

Parameters:

token - token to endorse

keyLevel - key level to be used to endorse the token

Returns:

result of endorse token

cancelToken

public io.reactivex.Observable<io.token.proto.common.token.TokenProtos.TokenOperationResult> cancelToken(io.token.proto.common.token.TokenProtos.Token token)

Cancels the token by signing it. The signature is persisted along with the token.

Parameters:

token - token to cancel

Returns:

result of cancel token

replaceAccessToken

public io.reactivex.Observable<io.token.proto.common.token.TokenProtos.TokenOperationResult> replaceAccessToken(io.token.proto.common.token.TokenProtos.Token tokenToCancel,
                                                                                                                AccessTokenBuilder tokenToCreate)

Cancels the existing access token and creates a replacement for it.

Parameters:

tokenToCancel - old token to cancel

tokenToCreate - an AccessTokenBuilder to create new token from

Returns:

result of the replacement operation

replaceAndEndorseAccessToken

@Deprecated
public io.reactivex.Observable<io.token.proto.common.token.TokenProtos.TokenOperationResult> replaceAndEndorseAccessToken(io.token.proto.common.token.TokenProtos.Token tokenToCancel,
                                                                                                                                      AccessTokenBuilder tokenToCreate)

Deprecated. use replaceAccessToken(io.token.proto.common.token.TokenProtos.Token, io.token.AccessTokenBuilder) and endorseToken(io.token.proto.common.token.TokenProtos.Token, io.token.proto.common.security.SecurityProtos.Key.Level) instead

Cancels the existing access token, creates a replacement and endorses it.

Parameters:

tokenToCancel - old token to cancel

tokenToCreate - an AccessTokenBuilder to create new token from

Returns:

result of the replacement operation

redeemToken

public io.reactivex.Observable<io.token.proto.common.transfer.TransferProtos.Transfer> redeemToken(io.token.proto.common.token.TokenProtos.Token token)

Redeems a transfer token.

Parameters:

token - transfer token to redeem

Returns:

transfer record

redeemToken

public io.reactivex.Observable<io.token.proto.common.transfer.TransferProtos.Transfer> redeemToken(io.token.proto.common.token.TokenProtos.Token token,
                                                                                                   java.lang.String refId)

Redeems a transfer token.

Parameters:

token - transfer token to redeem

refId - transfer reference id

Returns:

transfer record

redeemToken

public io.reactivex.Observable<io.token.proto.common.transfer.TransferProtos.Transfer> redeemToken(io.token.proto.common.token.TokenProtos.Token token,
                                                                                                   io.token.proto.common.transferinstructions.TransferInstructionsProtos.TransferEndpoint destination)

Redeems a transfer token.

Parameters:

token - transfer token to redeem

destination - transfer instruction destination

Returns:

transfer record

redeemToken

public io.reactivex.Observable<io.token.proto.common.transfer.TransferProtos.Transfer> redeemToken(io.token.proto.common.token.TokenProtos.Token token,
                                                                                                   io.token.proto.common.transferinstructions.TransferInstructionsProtos.TransferEndpoint destination,
                                                                                                   java.lang.String refId)

Redeems a transfer token.

Parameters:

token - transfer token to redeem

destination - transfer instruction destination

refId - transfer reference id

Returns:

transfer record

redeemToken

public io.reactivex.Observable<io.token.proto.common.transfer.TransferProtos.Transfer> redeemToken(io.token.proto.common.token.TokenProtos.Token token,
                                                                                                   @Nullable
                                                                                                   java.lang.Double amount,
                                                                                                   @Nullable
                                                                                                   java.lang.String currency,
                                                                                                   @Nullable
                                                                                                   java.lang.String description,
                                                                                                   @Nullable
                                                                                                   io.token.proto.common.transferinstructions.TransferInstructionsProtos.TransferEndpoint destination,
                                                                                                   @Nullable
                                                                                                   java.lang.String refId)

Redeems a transfer token.

Parameters:

token - transfer token to redeem

amount - transfer amount

currency - transfer currency code, e.g. "EUR"

description - transfer description

destination - the transfer instruction destination

refId - transfer reference id

Returns:

transfer record

getTransaction

public io.reactivex.Observable<io.token.proto.common.transaction.TransactionProtos.Transaction> getTransaction(java.lang.String accountId,
                                                                                                               java.lang.String transactionId,
                                                                                                               io.token.proto.common.security.SecurityProtos.Key.Level keyLevel)

Looks up an existing transaction for a given account.

Specified by:

getTransaction in interface RepresentableAsync

Parameters:

accountId - the account id

transactionId - ID of the transaction

keyLevel - key level

Returns:

transaction record

getTransactions

public io.reactivex.Observable<io.token.proto.PagedList<io.token.proto.common.transaction.TransactionProtos.Transaction,java.lang.String>> getTransactions(java.lang.String accountId,
                                                                                                                                                           @Nullable
                                                                                                                                                           java.lang.String offset,
                                                                                                                                                           int limit,
                                                                                                                                                           io.token.proto.common.security.SecurityProtos.Key.Level keyLevel)

Looks up transactions for a given account.

Specified by:

getTransactions in interface RepresentableAsync

Parameters:

accountId - the account id

offset - optional offset to start at

limit - max number of records to return

keyLevel - key level

Returns:

a paged list of transaction records

getDefaultAccount

public io.reactivex.Observable<AccountAsync> getDefaultAccount(java.lang.String memberId)

Get the default bank account for this member.

Parameters:

memberId - the member's id

Returns:

observable string

getBalance

public io.reactivex.Observable<io.token.proto.common.transaction.TransactionProtos.Balance> getBalance(java.lang.String accountId,
                                                                                                       io.token.proto.common.security.SecurityProtos.Key.Level keyLevel)

Looks up account balance.

Specified by:

getBalance in interface RepresentableAsync

Parameters:

accountId - the account id

keyLevel - key level

Returns:

balance

getCurrentBalance

public io.reactivex.Observable<io.token.proto.common.money.MoneyProtos.Money> getCurrentBalance(java.lang.String accountId,
                                                                                                io.token.proto.common.security.SecurityProtos.Key.Level keyLevel)

Looks up current account balance.

Parameters:

accountId - the account id

keyLevel - key level

Returns:

current balance

getAvailableBalance

public io.reactivex.Observable<io.token.proto.common.money.MoneyProtos.Money> getAvailableBalance(java.lang.String accountId,
                                                                                                  io.token.proto.common.security.SecurityProtos.Key.Level keyLevel)

Looks up available account balance.

Parameters:

accountId - the account id

keyLevel - key level

Returns:

available balance

getBalances

public io.reactivex.Observable<java.util.List<io.token.proto.common.transaction.TransactionProtos.Balance>> getBalances(java.util.List<java.lang.String> accountIds,
                                                                                                                        io.token.proto.common.security.SecurityProtos.Key.Level keyLevel)

Looks up balances for a list of accounts.

Specified by:

getBalances in interface RepresentableAsync

Parameters:

accountIds - list of account ids

keyLevel - key level

Returns:

list of balances

getBankInfo

public io.reactivex.Observable<io.token.proto.common.bank.BankProtos.BankInfo> getBankInfo(java.lang.String bankId)

Returns linking information for the specified bank id.

Parameters:

bankId - the bank id

Returns:

bank linking information

createAndLinkTestBankAccount

public io.reactivex.Observable<AccountAsync> createAndLinkTestBankAccount(double balance,
                                                                          java.lang.String currency)

Creates a test bank account in a fake bank and links the account.

Parameters:

balance - account balance to set

currency - currency code, e.g. "EUR"

Returns:

the linked account

createTestBankAccount

public io.reactivex.Observable<io.token.proto.banklink.Banklink.OauthBankAuthorization> createTestBankAccount(double balance,
                                                                                                              java.lang.String currency)

Creates a test bank account in a fake bank.

Parameters:

balance - account balance to set

currency - currency code, e.g. "EUR"

Returns:

OAuth bank authorization

triggerTokenStepUpNotification

public io.reactivex.Observable<io.token.proto.common.notification.NotificationProtos.NotifyStatus> triggerTokenStepUpNotification(java.lang.String tokenId)

Trigger a step up notification for tokens.

Parameters:

tokenId - token id

Returns:

notification status

triggerBalanceStepUpNotification

public io.reactivex.Observable<io.token.proto.common.notification.NotificationProtos.NotifyStatus> triggerBalanceStepUpNotification(java.util.List<java.lang.String> accountIds)

Trigger a step up notification for balance requests.

Parameters:

accountIds - list of account ids

Returns:

notification status

triggerTransactionStepUpNotification

public io.reactivex.Observable<io.token.proto.common.notification.NotificationProtos.NotifyStatus> triggerTransactionStepUpNotification(java.lang.String accountId)

Trigger a step up notification for transaction requests.

Parameters:

accountId - account id

Returns:

notification status

applySca

public io.reactivex.Completable applySca(java.util.List<java.lang.String> accountIds)

Apply SCA for the given list of account IDs.

Parameters:

accountIds - list of account ids

Returns:

completable

signTokenRequestState

public io.reactivex.Observable<io.token.proto.common.security.SecurityProtos.Signature> signTokenRequestState(java.lang.String tokenRequestId,
                                                                                                              java.lang.String tokenId,
                                                                                                              java.lang.String state)

Sign with a Token signature a token request state payload.

Parameters:

tokenRequestId - token request id

tokenId - token id

state - state

Returns:

signature

getPairedDevices

public io.reactivex.Observable<java.util.List<io.token.proto.common.member.MemberProtos.Device>> getPairedDevices()

Get list of paired devices.

Returns:

list of devices

deleteMember

public io.reactivex.Completable deleteMember()

Delete the member.

Returns:

completable

verifyAffiliate

public io.reactivex.Completable verifyAffiliate(java.lang.String memberId)

Verifies an affiliated TPP.

Parameters:

memberId - member ID of the TPP to verify

Returns:

completable

resolveTransferDestinations

public io.reactivex.Observable<java.util.List<io.token.proto.common.transferinstructions.TransferInstructionsProtos.TransferEndpoint>> resolveTransferDestinations(java.lang.String accountId)

Resolves transfer destinations for the given account ID.

Specified by:

resolveTransferDestinations in interface RepresentableAsync

Parameters:

accountId - account ID

Returns:

transfer endpoints

addTrustedBeneficiary

public io.reactivex.Completable addTrustedBeneficiary(java.lang.String memberId)

Adds a trusted beneficiary for whom the SCA will be skipped.

Parameters:

memberId - the member id of the beneficiary

Returns:

a completable

removeTrustedBeneficiary

public io.reactivex.Completable removeTrustedBeneficiary(java.lang.String memberId)

Removes a trusted beneficiary.

Parameters:

memberId - the member id of the beneficiary

Returns:

a completable

getTrustedBeneficiaries

public io.reactivex.Observable<java.util.List<io.token.proto.common.member.MemberProtos.TrustedBeneficiary>> getTrustedBeneficiaries()

Gets a list of all trusted beneficiaries.

Returns:

the list

createCustomization

public io.reactivex.Observable<java.lang.String> createCustomization(io.token.proto.common.blob.BlobProtos.Blob.Payload logo,
                                                                     java.util.Map<java.lang.String,java.lang.String> colors,
                                                                     java.lang.String consentText,
                                                                     java.lang.String name,
                                                                     java.lang.String appName)

Creates a customization.

Parameters:

logo - logo

colors - map of ARGB colors #AARRGGBB

consentText - consent text

name - display name

appName - corresponding app name

Returns:

customization id

getTokenCluster

public TokenIO.TokenCluster getTokenCluster()

Get the Token cluster, e.g. sandbox, production.

Returns:

Token cluster

setSecurityMetadata

public void setSecurityMetadata(io.token.proto.common.security.SecurityProtos.SecurityMetadata securityMetadata)

Sets security metadata included in all requests.

Parameters:

securityMetadata - security metadata

clearSecurityMetadata

public void clearSecurityMetadata()

Clears security metadata.

hashCode

public int hashCode()

Overrides:

hashCode in class java.lang.Object

equals

public boolean equals(java.lang.Object obj)

Overrides:

equals in class java.lang.Object

toString

public java.lang.String toString()

Overrides:

toString in class java.lang.Object