User accounts.
Indicator if user has wallet.
User identifier.
User integrator identifier.
Listen to all account data changes.
interface to listen to user changes
Compose custody withdraw transaction from custody account. Refer to Send Transactions guide for usage details.
custody or fiat Account identifier
destination address or non-custodial account identifier
amount in source account currency
send maximum possible funds to destination (defaults to false)
Compose exchange. Refer to Make Exchanges guide for usage details.
Account identifier
Account identifier
amount in deposit account currency
exchange maximum possible funds (defaults to false)
Compose transaction from user fiat account to user's nominated account. Refer to Send Transactions guide for usage details.
Account identifier
amount in source account currency
send maximum possible funds to destination (defaults to false)
Compose transaction between custody or fiat accounts in Zumo ecosystem. Refer to Send Transactions guide for usage details.
custody or fiat Account identifier
custody or fiat Account identifier
amount in source account currency
send maximum possible funds to destination (defaults to false)
Create custody or fiat account for specified currency. When creating a fiat account, user must already be fiat customer.
country code, e.g. 'GBP', 'BTC', 'ETH'
Create card for a fiat account.
At least one Knowledge-Based Authentication (KBA) answers should be defined, answers are limited to 256 characters and cannot be null or empty and only one answer per question type should be provided.
fiat account identifier
'VIRTUAL' or 'PHYSICAL'
card holder mobile number, starting with a '+', followed by the country code and then the mobile number, or null
list of KBA answers
Create user wallet seeded by provided mnemonic and encrypted with user's password.
Mnemonic can be generated by Utils.generateMnemonic utility method.
mnemonic seed phrase
user provided password
Fetch Strong Customer Authentication (SCA) config.
Fetch trading pairs that are currently supported.
Get account in specific currency, on specific network, with specific type.
currency code, e.g. 'BTC', 'ETH' or 'GBP'
network type, e.g. 'MAINNET', 'TESTNET' or 'RINKEBY'
account type, e.g. 'STANDARD', 'COMPATIBILITY' or 'SEGWIT'
custody type, e.g. 'CUSTODY' or 'NON-CUSTODY'
Get nominated account details for specified account if it exists. Refer to Create Fiat Account for explanation about nominated account.
Account identifier
Check if user is a registered fiat customer.
Check if mnemonic seed phrase corresponds to user's wallet. This is useful for validating seed phrase before trying to recover wallet.
mnemonic seed phrase
Make user fiat customer by providing user's personal details.
first name
middle name or null
last name
date of birth in ISO 8601 format, e.g '2020-08-12'
phone number
home address
Recover user wallet with mnemonic seed phrase corresponding to user's wallet. This can be used if user forgets his password or wants to change his wallet password.
mnemonic seed phrase corresponding to user's wallet
user provided password
Remove listener to state changes.
interface to listen to state changes
Reveals sensitive card details.
card identifier
Reveal mnemonic seed phrase used to seed user wallet.
user provided password
Reveal card PIN.
card identifier
Add KBA answers to a card without SCA.
This endpoint is used to set Knowledge-Based Authentication (KBA) answers to a card without Strong Customer Authentication (SCA). Once it is set SCA flag on corresponding card is set to true.
At least one answer should be defined, answers are limited to 256 characters and cannot be null or empty and only one answer per question type should be provided.
card id
list of KBA answers
Set card status to 'ACTIVE', 'BLOCKED' or 'CANCELLED'.
card identifier
new card status
PAN when activating a physical card, null otherwise (defaults to null)
CVV2 when activating a physical card, null otherwise (defaults to null)
Submit an exchange. Refer to Make Exchanges guide for usage details.
Composed exchange retrieved as the result of composeExchange method
Submit a transaction. Refer to Send Transactions guide for usage details.
Composed transaction retrieved as a result of one of the compose transaction methods
Debit account id override, only applicable to direct custody deposits. In case no account id is specified senders custody account will be debited.
Optional metadata that will be attached to transaction
Unblock card PIN.
card identifier
Unlock user wallet with user's password.
user provided password
Generated using TypeDoc
User instance, obtained via ZumoKit.signIn method, provides methods for managing user wallet and accounts.
Refer to Manage User Wallet, Create Fiat Account, View User Accounts and Get Account Data guides for usage details.