API Reference¶

Levels and Repeats¶

Category	Description
Levels
Basic	The functions at these levels are absolutely necessary to use the SDK. Without calling these functions, the SDK is never in a correct state. Optional functions can be skipped, since they will take default values, if that is the requirement.
Usage	The functions at these levels can only be called once all basic level functions have successfully executed.
Repeats
Handle	The functions need to be called every time a new SDK Handle (object) needs to be created via a constructor or after garbage collection of any existing old handles.
User	The functions need to be called every time a new SDK user needs to be created.
Application	The functions can be called any time while using the SDK, however they may fail, if the certain dependencies are not fulfilled.

Usage infos and warnings¶

Warning

Viviswap and Postident KYC onboarding will not work if the user is already kyc verified.
KYC onboarding with another provider will not work if the user is already started kyc onboarding with one of the other providers.
Restoring a wallet backup may fail, if the wallet is already existing.
Initializing User and initializing wallet may fail, if the user and wallet are already initialized. Since, there is no de-init function, the SDK handle needs to be closed, or a new handle needs to be created to re init.
Multiple handles to the wallet may also fail, since only atomic access are allowed.
Deleting a user may fail if the backend cannot be reached.

JavaScript / TypeScript¶

The API reference for the JS/TS bindings are available here. Please consult the tables below for the dependencies between each function.

Java¶

The Javadoc API reference for the Java bindings is available here. Please consult the tables below for the dependencies between each function.

Rust¶

The Rustdoc API reference is available here. Please consult the tables below for the dependencies between each function.

SDK Initialization and Configuration¶

Instantiating the SDK¶

Method	Arguments	Returns	Dependencies	Level	Repeat
Constructor		Returns an `Error` if there is an issue in loading the dynamically or statically linked binary shared library, otherwise the handle to the SDK		Basic	Handle

RustJavaTypescriptSwift

constructor

Not available yet!

import ETOPaySdk
let sdk = ETOPaySdk()

Set configuration¶

Method	Arguments	Returns	Dependencies	Level	Repeat
Set the SDK configuration parameters.	`config` - The JSON formatted string containing the configuration parameters. See SDK Configuration for more information of the available options.		Constructor	Basic	Handle

RustJavaTypescriptSwift

set_config

setConfig

Not available yet!

public func setConfig(config: String) throws

Get supported networks¶

Method	Arguments	Returns	Dependencies	Level	Repeat
Get the supported networks.		Returns a list of ApiNetwork.		Constructor, Set Configuration, Refresh access token, User initialization	Basic

RustJavaTypescriptSwift

get_networks

getNetworks

Not available yet!

public func getNetworks() throws -> String

Set network¶

Method	Arguments	Returns	Dependencies	Level	Repeat
Sets the network	`network_key` - The key of the network as a string.		Constructor	Basic	Handle

RustJavaTypescriptSwift

set_network

setNetwork

Not available yet!

public func setNetwork(network_key: String) throws

Get build information¶

Method	Arguments	Returns	Dependencies	Level	Repeat
Get the SDK build information		Returns a multi-line String containing: `Branch name` (e.g. main), `Commit hash` (e.g. 92cedead), `Build time` (e.g. 2024-10-29 12:10:09 +00:00), `Rust version` (e.g. 1.80.1 3f5fd8dd4 2024-08-06), `Toolchain channel` (e.g. stable-x86_64-unknown-linux-gnu)	Usage	Application

RustJavaTypescriptSwift

get_build_info

getBuildInfo

Not available yet!

public func getBuildInfo() throws -> String

User functions¶

Creating a new user¶

Method	Arguments	Returns	Dependencies	Level	Repeat
Create a new user	`username` - The username of the new user.		Constructor, Set Configuration	Basic	User

RustJavaTypescriptSwift

create_new_user

createNewUser

Not available yet!

public func createNewUser(username: String) throws

Initializing a user¶

Method	Arguments	Returns	Dependencies	Level	Repeat
Initialize a user	`username` - The username of the user to initialize.		Constructor, Set Configuration, Refresh access token, Create new user	Usage	Application

RustJavaTypescriptSwift

init_user

initializeUser

Not available yet!

public func initUser(username: String) throws

Refreshing access token¶

Method	Arguments	Returns	Dependencies	Level	Repeat
Refresh access token	`access_token` - The new access token to be set.		Constructor, Set Configuration	Basic	Application

RustJavaTypescriptSwift

refresh_access_token

refreshAccessToken

Not available yet!

public func refreshAccessToken(access_token: String) throws

Checking KYC status¶

Method	Arguments	Returns	Dependencies	Level	Repeat
Check if the user's KYC status is verified	`username` - The username of the user to check KYC status for.	Returns `true` if the KYC status is verified, or `false` if it is not verified.	User initialization	Usage	Application

RustJavaTypescriptSwift

is_kyc_status_verified

isKycVerified

Not available yet!

public func isKycVerified(username: String) throws
-> Bool

Delete user¶

Method	Arguments	Returns	Dependencies	Level	Repeat
Delete the currently active user and their wallet	`pin` - The PIN of the user to be deleted. Required only if the user has created a wallet.		User initialization	Usage	Application

RustJavaTypescriptSwift

delete_user

deleteUser

Not available yet!

public func deleteUser(pin: String) throws

Wallet functions¶

Create new wallet¶

Method	Arguments	Returns	Dependencies	Level	Repeat
Creates a new wallet for the user with the specified PIN and password	`pin` - The PIN for the wallet	Returns the mnemonic phrase of the newly created wallet if successful.	User initialization	Usage	User

RustJavaTypescriptSwift

create_wallet_from_new_mnemonic

createNewWallet

Not available yet!

public func createNewWallet(pin: String) throws -> String

Create new wallet from mnemonic¶

Method	Arguments	Returns	Dependencies	Level	Repeat
Create a wallet from existing mnemonic	`pin` - The PIN for the wallet, `mnemonic` - The mnemonic to migrate from		User initialization	Usage	User

RustJavaTypescriptSwift

create_wallet_from_existing_mnemonic

createWalletFromMnemonic

Not available yet!

public func createWalletFromMnemonic(pin: String, mnemonic: String) throws

Create new wallet from backup¶

Method	Arguments	Returns	Dependencies	Level	Repeat
Create a wallet from existing backup	`pin` - The PIN for the wallet, `backup` - The bytes representing the backup file contents, `backup_password` - The password used when creating the backup		User initialization	Usage	Application

RustJavaTypescriptSwift

create_wallet_from_backup

createWalletFromBackup

Not available yet!

public func restoreWalletFromBackup(pin: String, backup: RustVec<UInt8>, backup_password: String) throws

Create a wallet backup¶

Method	Arguments	Returns	Dependencies	Level	Repeat
Create a wallet backup	`backup_password` - The password for the backup	Returns the bytes of the created backup file if successful.	User initialization	Usage	Application

RustJavaTypescriptSwift

create_wallet_backup

createWalletBackup

Not available yet!

public func createWalletBackup(backup_password: String) throws -> RustVec<UInt8>

Verify mnemonic¶

Method	Arguments	Returns	Dependencies	Level	Repeat
Verifies the mnemonic by checking if it matches the stored mnemonic	`pin` - The PIN for the wallet, `mnemonic` - The mnemonic to verify	Returns `true` or `false` whether the mnemonic is successfully verified.	User initialization	Usage	User

RustJavaTypescriptSwift

verify_mnemonic

verifyMnemonic

Not available yet!

public func verifyMnemonic(pin: String, mnemonic: String) throws -> Bool

Delete wallet¶

Warning

Deletes the currently active wallet, potentially resulting in loss of funds if the mnemonic or wallet is not backed up.

Method	Arguments	Returns	Dependencies	Level	Repeat
Delete the currently active wallet	`pin` - The PIN for the wallet		Wallet initialization	Usage	Application

RustJavaTypescriptSwift

delete_wallet

deleteWallet

Not available yet!

public func deleteWallet(pin: String) throws

Verify pin¶

Method	Arguments	Returns	Dependencies	Level	Repeat
Verifies the pin for the wallet	`pin` - The pin to verify		Wallet initialization	Usage	Application

RustJavaTypescriptSwift

verify_pin

pinVerify

verifyPin

Not available yet!

public func verifyPin(pin: String) throws

Reset pin¶

Method	Arguments	Returns	Dependencies	Level	Repeat
Resets the pin for the wallet with a new pin by using the existing pin	`pin` - The current pin for the wallet, `new_pin` - The new pin to set for the wallet		Wallet initialization	Usage	Application

RustJavaTypescriptSwift

change_pin

pinReset

resetPin

Not available yet!

public func resetPin(pin: String, new_pin: String) throws

Set wallet password¶

Method	Arguments	Returns	Dependencies	Level	Repeat
Set the password for the wallet using the provided pin and new password. If the password is already set, this changes it to the new password. Use `is_wallet_password_set` to check if the password is already set.	`pin` - The new or existing PIN for the wallet, `new_password` - The new password to set for the wallet	Wallet initialization	Usage	Application

RustJavaTypescriptSwift

set_wallet_password

setWalletPassword

Not available yet!

public func setWalletPassword(pin: String, new_password: String) throws

Is wallet password set¶

Method	Arguments	Returns	Dependencies	Level	Repeat
Check if the password is already set. Useful to prompt the user to setup one if it has not yet been done. See also `set_wallet_password` for how to set a new password and change an existing password.		Returns `true` or `false` whether or not the password is already set.	Wallet initialization	Usage	Application

RustJavaTypescriptSwift

is_wallet_password_set

isWalletPasswordSet

Not available yet!

public func isWalletPasswordSet() throws

Generate a new address¶

Method	Arguments	Returns	Dependencies	Level	Repeat
Generates a new receiver address for the wallet based on the selected network.	`pin` - The PIN for the wallet	Returns the generated address as a `String` if successful.	Wallet initialization, Set network	Usage	Application

RustJavaTypescriptSwift

generate_new_address

generateNewAddress

Not available yet!

public func generateNewAddress(pin: String) throws -> String

Get balance¶

Method	Arguments	Returns	Dependencies	Level	Repeat
Fetches the balance of the user from the wallet	`pin` - The PIN for the wallet	Returns the balance as a `f64` if successful.	Wallet initialization	Usage	Application

RustJavaTypescriptSwift

get_balance

getWalletBalance

Not available yet!

public func getBalance(pin: String) throws -> Float

Get wallet transactions¶

Method	Arguments	Returns	Dependencies	Level	Repeat
Wallet transaction list	`pin` - The PIN for the wallet, `start` - The starting page number for paginatation, `limit` - The page limit size for each page	Returns the list of transactions made on the wallet as an array of `WalletTxInfo` object or a serialized JSON of the same, if successful.	Wallet initialization	Usage	Application

RustJavaTypescriptSwift

get_wallet_tx_list

getWalletTransactionList

Not available yet!

public func getWalletTransactionList(pin: String, start: UInt64, limit: UInt64) throws -> Rustvec<WalletTxInfo>

WalletTxInfo¶

RustJSON

pub struct WalletTxInfo {
/// Transaction creation date
pub date: String,
/// Contains block id
pub block_id: Option<String>,
/// Transaction id for particular transaction
pub transaction_id: String,
/// Describes type of transaction
pub incoming: bool,
/// Amount of transfer
pub amount: f64,
/// Unique key representing a network
pub network_key: String,
/// Status of the transfer
pub status: String,
/// Url of network
pub explorer_url: Option<String>,
}

{
    "$schema": "<http://json-schema.org/draft-07/schema#>",
    "type": "object",
    "properties": {
        "date": {
            "type": "string",
            "description": "Transaction creation date"
        },
        "block_id": {
            "type": ["string", "null"],
            "description": "Contains block id"
        },
        "transaction_id": {
            "type": "string",
            "description": "Transaction id for particular transaction"
        },
        "incoming": {
            "type": "boolean",
            "description": "Describes type of transaction"
        },
        "amount": {
            "type": "number",
            "description": "Amount of transfer"
        },
        "network_key": {
            "type": "string",
            "description": "Unique key representing a network"
        },
        "status": {
            "type": "string",
            "description": "Status of the transfer"
        },
        "explorer_url": {
            "type": ["string", "null"],
            "description": "Url of network"
        }
    },
    "required": ["date", "transaction_id", "incoming", "amount", "network", "status"]
}

Get wallet transaction¶

Method	Arguments	Returns	Dependencies	Level	Repeat
Single wallet transaction	`pin` - The PIN for the wallet, `tx_id` - The transaction id on the network	Returns the transactions made on the wallet with the given id as `WalletTxInfo` object or a serialized JSON of the same, if successful.	Wallet initialization	Usage	Application

RustJavaTypescriptSwift

get_wallet_tx

getWalletTransaction

Not available yet!

public func getWalletTransaction(pin: String, transactionId: String) throws -> WalletTxInfo

Method	Arguments	Returns	Dependencies	Level	Repeat
Sets the recovery share for the users wallet.	`share` - The recovery share to upload.		User initialization	Usage	Application

RustJavaTypescriptSwift

set_recovery_share

setRecoveryShare

Not available yet!

public func setRecoveryShare(share: String) throws

Method	Arguments	Returns	Dependencies	Level	Repeat
Get the recovery share for the users wallet.			User initialization	Usage	Application

RustJavaTypescriptSwift

get_recovery_share

getRecoveryShare

Not available yet!

public func getRecoveryShare() throws -> String

Viviswap functions¶

Start KYC Verification for viviswap¶

Method	Arguments	Returns	Dependencies	Level	Repeat
Create a new viviswap user and initialize KYC verification	`mail` - The email address of the user, `terms_accepted` - A boolean indicating whether the terms have been accepted	Returns `NewViviswapUser` object if successful.	User initialization	Usage	Application

RustJavaTypescriptSwift

start_kyc_verification_for_viviswap

startViviswapKyc

startKycVerificationForViviswap

Not available yet!

public func startKycVerificationForViviswap(mail: String, termsAccepted: Bool) throws -> String

NewViviswapUser¶

RustJSON

pub struct NewViviswapUser {
/// Username of new viviswap user
pub username: String,
}

{
    "$schema": "<http://json-schema.org/draft-07/schema#>",
    "type": "object",
    "properties": {
        "username": {
            "type": "string",
            "description": "Username of new viviswap user"
        }
    },
    "required": ["username"]
}

Get KYC details for viviswap¶

Method	Arguments	Returns	Dependencies	Level	Repeat
Get current kyc status of viviswap		Returns `ViviswapKycStatus` object if successful.	User initialization	Usage	Application

RustJavaTypescriptSwift

get_kyc_details_for_viviswap

getViviswapKyc

getKycDetailsForViviswap

Not available yet!

public func getKycDetailsForViviswap() throws -> String

ViviswapKycStatus¶

RustJSON

pub struct ViviswapKycStatus {
    /// full name of the user
    pub full_name: String,
    /// the current submission step in the KYC onboarding process for the user
    pub submission_step: ViviswapVerificationStep,
    /// the current verified step in the KYC onboarding process for the user
    pub verified_step: ViviswapVerificationStep,
    /// the user verification status
    pub verification_status: ViviswapVerificationStatus,
    /// The monthly swap limit in euros
    pub monthly_limit_eur: f32,
}
pub enum ViviswapVerificationStep {
    /// no verification step (no next verification step available)
    Undefined,
    /// general verification step
    General,
    /// personal verification step
    Personal,
    /// residence verification step
    Residence,
    /// identity verification step
    Identity,
    /// amla general verification step
    Amla,
    /// document verification step
    Documents,
}
pub enum ViviswapVerificationStatus {
    /// The user is fully verified
    Verified,
    /// The user is not verified
    Unverified,
    /// The user is partially verified
    PartiallyVerified,
}

{
    "$schema": "http://json-schema.org/draft-07/schema#",
    "type": "object",
    "properties": {
        "full_name": {
            "type": "string",
            "description": "Full name of the user"
        },
        "submission_step": {
            "type": "string",
            "enum": ["Undefined", "General", "Personal", "Residence", "Identity", "Amla", "Documents"],
            "description": "The current submission step in the KYC onboarding process for the user"
        },
        "verified_step": {
            "type": "string",
            "enum": ["Undefined", "General", "Personal", "Residence", "Identity", "Amla", "Documents"],
            "description": "The current verified step in the KYC onboarding process for the user"
        },
        "verification_status": {
            "type": "string",
            "enum": ["Verified", "Unverified", "PartiallyVerified"],
            "description": "The user verification status"
        },
        "monthly_limit_eur": {
            "type": "number",
            "description": "The monthly swap limit in euros"
        }
    },
    "required": ["full_name", "submission_step", "verified_step", "verification_status", "monthly_limit_eur"]
}

Update partial KYC for viviswap¶

Method	Arguments	Returns	Dependencies	Level	Repeat
Update the kyc details for viviswap to be submitted	`is_individual` - Whether the user is an individual, `is_pep` - Whether the user is a politically exposed person, `is_us_citizen` - Whether the user is a US citizen, `is_regulatory_disclosure` - Whether the user has accepted the regulatory disclosure, `country_of_residence` - The country of residence of the user, `nationality` - The nationality of the user, `full_name` - The full name of the user, `date_of_birth` - The date of birth of the user	Returns `ViviswapPartiallyKycDetails` object containing the partially updated KYC details.	User initialization	Usage	Application

RustJavaTypescriptSwift

update_kyc_partially_status_for_viviswap

updateViviswapKycPartial

updateKycPartiallyStatusForViviswap

Not available yet!

public func updateKycPartiallyStatusForViviswap(
    isIndividual: Bool,
    isPep: Bool,
    isUsCitizen: Bool,
    isRegulatoryDisclosure: Bool,
    countryOfResidence: String,
    nationality: String,
    fullName: String,
    dateOfBirth: String
) throws -> String

ViviswapPartiallyKycDetails¶

RustJSON

pub struct ViviswapPartiallyKycDetails {
    /// Is the user an individual
    pub is_individual: Option<bool>,
    /// Is the user a politically exposed person
    pub is_pep: Option<bool>,
    /// Is the user a US citizen
    pub is_us_citizen: Option<bool>,
    /// Is the regulatory disclosure confirmed by user
    pub is_regulatory_disclosure: Option<bool>,
    /// The country of tax residence of the user
    pub country_of_residence: Option<String>,
    /// The user's nationality
    pub nationality: Option<String>,
    /// The full name of the user as per his legal documents
    pub full_name: Option<String>,
    /// The date of birth of the user as per his legal documents
    pub date_of_birth: Option<String>,
}

{
    "$schema": "http://json-schema.org/draft-07/schema#",
    "type": "object",
    "properties": {
        "is_individual": {
            "type": ["boolean", "null"],
            "description": "Is the user an individual"
        },
        "is_pep": {
            "type": ["boolean", "null"],
            "description": "Is the user a politically exposed person"
        },
        "is_us_citizen": {
            "type": ["boolean", "null"],
            "description": "Is the user a US citizen"
        },
        "is_regulatory_disclosure": {
            "type": ["boolean", "null"],
            "description": "Is the regulatory disclosure confirmed by user"
        },
        "country_of_residence": {
            "type": ["string", "null"],
            "description": "The country of tax residence of the user"
        },
        "nationality": {
            "type": ["string", "null"],
            "description": "The user's nationality"
        },
        "full_name": {
            "type": ["string", "null"],
            "description": "The full name of the user as per his legal documents"
        },
        "date_of_birth": {
            "type": ["string", "null"],
            "description": "The date of birth of the user as per his legal documents"
        }
    }
}

Submit partial KYC for viviswap¶

Method	Arguments	Returns	Dependencies	Level	Repeat
Submit the kyc details for viviswap			User initialization	Usage	Application

RustJavaTypescriptSwift

submit_kyc_partially_status_for_viviswap

submitViviswapKycPartial

submitKycPartiallyStatusForViviswap

Not available yet!

public func submitKycPartiallyStatusForViviswap() throws

Get IBAN for viviswap¶

Method	Arguments	Returns	Dependencies	Level	Repeat
Get current iban of viviswap user		Returns `ViviswapAddressDetail` object if successful.	Wallet initialization, Get KYC Details for viviswap	Usage	Application

RustJavaTypescriptSwift

get_iban_for_viviswap

getIbanViviswap

Not available yet!

public func getIbanViviswap() throws -> String

ViviswapAddressDetail¶

RustJSON

pub struct ViviswapAddressDetail {
    /// the unique id of the address detail
    pub id: String,
    /// the address used in the detail
    pub address: String,
    /// the status from viviswap, whether the address is verified
    pub is_verified: bool,
}

{
    "$schema": "http://json-schema.org/draft-07/schema#",
    "type": "object",
    "properties": {
        "id": {
            "type": "string",
            "description": "The unique id of the address detail"
        },
        "address": {
            "type": "string",
            "description": "The address used in the detail"
        },
        "is_verified": {
            "type": "boolean",
            "description": "The status from viviswap, whether the address is verified"
        }
    },
    "required": ["id", "address", "is_verified"]
}

Update IBAN for viviswap¶

Method	Arguments	Returns	Dependencies	Level	Repeat
Update IBAN of viviswap user	`pin` - The user's PIN, `address` - The new IBAN address	Returns `ViviswapAddressDetail` object if successful.	Wallet initialization, Get KYC Details for viviswap	Usage	Application

RustJavaTypescriptSwift

update_iban_for_viviswap

updateIbanViviswap

Not available yet!

public func updateIbanViviswap(pin: String, address: String) throws -> String

Create deposit with viviswap¶

Method	Arguments	Returns	Dependencies	Level	Repeat
Create deposit for viviswap user	`pin` - The PIN for the wallet	Returns `ViviswapDeposit` object if successful.	Wallet initialization, Get KYC Details for viviswap, Update IBAN	Usage	Application

RustJavaTypescriptSwift

create_deposit_with_viviswap

depositWithViviswap

createDepositWithViviswap

Not available yet!

public func depositWithViviswap(pin: String) throws -> String

ViviswapDeposit¶

RustJSON

pub struct ViviswapDeposit {
    /// The unique UUID of the contract
    pub contract_id: String,
    /// The deposit address (crypto) where the swap will put the funds from fiat
    pub deposit_address: String,
    /// The details of the deposit (for the user)
    pub details: ViviswapDepositDetails,
}
pub struct ViviswapDepositDetails {
    /// The reference to be entered by the user in his SEPA bank transfer
    pub reference: String,
    /// The name of the beneficiary receiving the SEPA transfer
    pub beneficiary: String,
    /// The name of the bank of the beneficiary
    pub name_of_bank: String,
    /// The address of the bank of the beneficiary
    pub address_of_bank: String,
    /// The IBAN of the beneficiary
    pub iban: String,
    /// The BIC/SWIFT code for the SEPA transfer
    pub bic: String,
}

{
    "$schema": "http://json-schema.org/draft-07/schema#",
    "type": "object",
    "properties": {
        "contract_id": {
            "type": "string",
            "description": "The unique UUID of the contract"
        },
        "deposit_address": {
            "type": "string",
            "description": "The deposit address (crypto) where the swap will put the funds from fiat"
        },
        "details": {
            "type": "object",
            "description": "The details of the deposit (for the user)",
            "properties": {
                "reference": {
                    "type": "string",
                    "description": "The reference to be entered by the user in his SEPA bank transfer"
                },
                "beneficiary": {
                    "type": "string",
                    "description": "The name of the beneficiary receiving the SEPA transfer"
                },
                "name_of_bank": {
                    "type": "string",
                    "description": "The name of the bank of the beneficiary"
                },
                "address_of_bank": {
                    "type": "string",
                    "description": "The address of the bank of the beneficiary"
                },
                "iban": {
                    "type": "string",
                    "description": "The IBAN of the beneficiary"
                },
                "bic": {
                    "type": "string",
                    "description": "The BIC/SWIFT code for the SEPA transfer"
                }
            },
            "required": ["reference", "beneficiary", "name_of_bank", "address_of_bank", "iban", "bic"]
        }
    },
    "required": ["contract_id", "deposit_address", "details"]
}

Create viviswap address detail¶

Method	Arguments	Returns	Dependencies	Level	Repeat
Create address detail for viviswap user	`pin` - The PIN for the wallet	Returns `ViviswapAddressDetail` object if successful.	Wallet initialization, Get KYC Details for viviswap	Usage	Application

RustJavaTypescriptSwift

create_detail_for_viviswap

createViviswapDetail

createDetailForViviswap

Not available yet!

public func createViviswapDetail(pin: String) throws -> String

Create withdrawal with viviswap¶

Method	Arguments	Returns	Dependencies	Level	Repeat
Create address detail for viviswap user	`amount` - The amount of the withdrawal, `pin` - The optional PIN for verification, `data` - Optional data which can be assigned to the transaction	Returns `ViviswapWithdrawal` object if successful.	Wallet initialization, Get KYC Details for viviswap, Update IBAN	Usage	Application

RustJavaTypescriptSwift

create_withdrawal_with_viviswap

withdrawWithViviswap

createWithdrawalWithViviswap

Not available yet!

public func withdrawWithViviswap(amount: Float, pin: String, data: [UInt8]) throws -> ViviswapWithdrawal

ViviswapWithdrawal¶

RustJSON

pub struct ViviswapWithdrawal {
    /// The unique UUID to track the withdrawal contract
    pub contract_id: String,
    /// The deposit address, in this case the IBAN of the user, where fiat will be deposited.
    pub deposit_address: String,
    /// The details of the withdrawal
    pub details: ViviswapWithdrawalDetails,
}
pub struct ViviswapWithdrawalDetails {
    /// The reference used by viviswap for the SEPA transfer
    pub reference: String,
    /// The id of the unique wallet internal to viviswap
    pub wallet_id: String,
    /// The crypto address of viviswap where the crypto swap is to be sent
    pub crypto_address: String,
}

{
    "$schema": "http://json-schema.org/draft-07/schema#",
    "type": "object",
    "properties": {
        "contract_id": {
            "type": "string",
            "description": "The unique UUID of the contract"
        },
        "withdrawal_address": {
            "type": "string",
            "description": "The withdrawal address (crypto) where the swap will put the funds from fiat"
        },
        "details": {
            "type": "object",
            "description": "The details of the withdrawal (for the user)",
            "properties": {
                "reference": {
                    "type": "string",
                    "description": "The reference used by viviswap for the SEPA transfer"
                },
                "wallet_id": {
                    "type": "string",
                    "description": "The id of the unique wallet internal to viviswap"
                },
                "crypto_address": {
                    "type": "string",
                    "description": "The crypto address of viviswap where the crypto swap is to be sent"
                }
            },
            "required": ["reference", "wallet_id", "crypto_address"]
        }
    },
    "required": ["contract_id", "withdrawal_address", "details"]
}

Get swap details¶

Method	Arguments	Returns	Dependencies	Level	Repeat
Get swap details	`order_id` - The ID of the swap order.	Returns `Order` object containing the swap order details.	Wallet initialization, Get KYC Details for viviswap	Usage	Application

RustJavaTypescriptSwift

get_swap_details

getSwapDetails

Not available yet!

public func getSwapDetails(order_id: String) throws -> String

Order¶

RustJSON

pub struct Order {
    pub id: String,
    pub is_payed_out: bool,
    pub is_approved: bool,
    pub is_canceled: bool,
    pub fees_amount_eur: f32,
    pub crypto_fees: f32,
    pub contract_id: String,
    pub incoming_payment_method_id: String,
    pub incoming_payment_method_currency: String,
    pub incoming_amount: f32,
    pub incoming_course: f32,
    pub outgoing_payment_method_id: String,
    pub outgoing_payment_method_currency: String,
    pub outgoing_amount: f32,
    pub outgoing_course: f32,
    pub refund_amount: Option<f32>,
    pub refund_course: Option<f32>,
    pub refund_payment_method_id: Option<String>,
    pub status: i32,
    pub creation_date: String,
    pub incoming_payment_detail: Option<PaymentDetail>,
    pub outgoing_payment_detail: Option<PaymentDetail>,
    pub refund_payment_detail: Option<PaymentDetail>,
}

pub struct PaymentDetail {
    pub id: String,
    pub address: String,
    pub is_verified: Option<bool>,
}

{
    "$schema": "http://json-schema.org/draft-07/schema#",
    "type": "object",
    "properties": {
        "id": {
            "type": "string",
            "description": "The unique id of the order"
        },
        "is_payed_out": {
            "type": "boolean",
            "description": "Whether the order is payed out"
        },
        "is_approved": {
            "type": "boolean",
            "description": "Whether the order is approved"
        },
        "is_canceled": {
            "type": "boolean",
            "description": "Whether the order is canceled"
        },
        "fees_amount_eur": {
            "type": "number",
            "description": "The amount of fees in EUR"
        },
        "crypto_fees": {
            "type": "number",
            "description": "The amount of crypto fees"
        },
        "contract_id": {
            "type": "string",
            "description": "The id of the contract"
        },
        "incoming_payment_method_id": {
            "type": "string",
            "description": "The id of the incoming payment method"
        },
        "incoming_payment_method_currency": {
            "type": "string",
            "description": "The currency of the incoming payment method"
        },
        "incoming_amount": {
            "type": "number",
            "description": "The amount of the incoming payment"
        },
        "incoming_course": {
            "type": "number",
            "description": "The course of the incoming payment"
        },
        "outgoing_payment_method_id": {
            "type": "string",
            "description": "The id of the outgoing payment method"
        },
        "outgoing_payment_method_currency": {
            "type": "string",
            "description": "The currency of the outgoing payment method"
        },
        "outgoing_amount": {
            "type": "number",
            "description": "The amount of the outgoing payment"
        },
        "outgoing_course": {
            "type": "number",
            "description": "The course of the outgoing payment"
        },
        "refund_amount": {
            "type": ["number", "null"],
            "description": "The amount of the refund"
        },
        "refund_course": {
            "type": ["number", "null"],
            "description": "The course of the refund"
        },
        "refund_payment_method_id": {
            "type": ["string", "null"],
            "description": "The id of the refund payment method"
        },
        "status": {
            "type": "integer",
            "description": "The status of the order"
        },
        "creation_date": {
            "type": "string",
            "description": "The creation date of the order"
        },
        "incoming_payment_detail": {
            "type": ["object", "null"],
            "description": "The details of the incoming payment",
            "properties": {
                "id": {
                    "type": "string",
                    "description": "The unique id of the payment detail"
                },
                "address": {
                    "type": "string",
                    "description": "The address of the payment detail"
                }
            },
            "required": ["id", "address"]
        },
        "outgoing_payment_detail": {
            "type": ["object", "null"],
            "description": "The details of the outgoing payment",
            "properties": {
                "id": {
                    "type": "string",
                    "description": "The unique id of the payment detail"
                },
                "address": {
                    "type": "string",
                    "description": "The address of the payment detail"
                }
            },
            "required": ["id", "address"]
        },
        "refund_payment_detail": {
            "type": ["object", "null"],
            "description": "The details of the refund payment",
            "properties": {
                "id": {
                    "type": "string",
                    "description": "The unique id of the payment detail"
                },
                "address": {
                    "type": "string",
                    "description": "The address of the payment detail"
                }
            },
            "required": ["id", "address"]
        }
    },
    "required": ["id", "is_payed_out", "is_approved", "is_canceled", "fees_amount_eur", "crypto_fees", "contract_id", "incoming_payment_method_id", "incoming_payment_method_currency", "incoming_amount", "incoming_course", "outgoing_payment_method_id", "outgoing_payment_method_currency", "outgoing_amount", "outgoing_course", "status", "creation_date"]
}

Get swap lists¶

Method	Arguments	Returns	Dependencies	Level	Repeat
Get swap list	`start` - The start page parameter, `limit` - The pagination limit parameter	Returns an array of `Order` object containing the swap order details for each swap.	Wallet initialization, Get KYC Details for viviswap	Usage	Application

RustJavaTypescriptSwift

get_swap_list

getSwapList

Not available yet!

public func getSwapList(page: UInt64, limit: UInt64) throws -> String

Get exchange rate¶

Method	Arguments	Returns	Dependencies	Level	Repeat
Get the exchange rate for the selected currency		Returns the latest exchange rate		Usage	Application

RustJavaTypescriptSwift

get_exchange_rate

getExchangeRate

Not available yet!

public func getExchangeRate() throws -> Float

Transaction functions¶

Create purchase request¶

Method	Arguments	Returns	Dependencies	Level	Repeat
Create purchase request	`receiver` - The receiver's username, `amount` - The amount of the purchase, `product_hash` - The hash of the product, `app_data` - The application data, `purchase_type` - The type of the purchase	Returns the purchase ID. This is an internal index used to reference the transaction in etopay	Wallet initialization	Usage	Application

RustJavaTypescriptSwift

create_purchase_request

purchaseRequestCreate

createPurchaseRequest

Not available yet!

public func createPurchaseRequest(
    receiver: String, amount: Double, product_hash: String, app_data: String, purchase_type: String
) throws -> String

Get purchase details¶

Method	Arguments	Returns	Dependencies	Level	Repeat
Get purchase details	`purchase_id` - The ID of the purchase.	Returns the purchase details as `PurchaseDetails` object	Wallet initialization	Usage	Application

RustJavaTypescriptSwift

get_purchase_details

purchaseDetails

getPurchaseDetails

Not available yet!

public func getPurchaseDetails(purchase_id: String) throws -> String

PurchaseDetails¶

RustJSON

    pub struct PurchaseDetails {
        /// The sender address where the fees goes to.
        pub system_address: String,
        /// The amount to be paid.
        pub amount: Decimal,
        /// The status of transaction
        pub status: ApiTxStatus,
    }

{
    "$schema": "http://json-schema.org/draft-07/schema#",
    "type": "object",
    "properties": {
        "system_address": {
            "type": "string",
            "description": "The sender address where the fees goes to."
        },
        "amount": {
            "type": "number",
            "description": "The amount to be paid"
        },
        "status": {
            "type": "object",
            "description": "Status of the transfer",
            "enum": ["Pending", "WaitingForVerification", "Valid", "Invalid", "ProcessingIncoming", "ProcessingOutgoing", "Completed", "Failed"]
        },
    },
    "required": ["system_address", "amount", "status"]
}

Confirm purchase request¶

Method	Arguments	Returns	Dependencies	Level	Repeat
Confirm purchase request	`pin` - The PIN of the user, `purchase_id` - The ID of the purchase.		Wallet initialization	Usage	Application

RustJavaTypescriptSwift

confirm_purchase_request

purchaseRequestConfirm

confirmPurchaseRequest

Not available yet!

public func confirmPurchaseRequest(pin: String, purchase_id: String) throws

Send amount¶

Method	Arguments	Returns	Dependencies	Level	Repeat
Send amount to the receiver address.	`pin` - The PIN of the user, `address` - The receiver's address, `amount` - The amount to send, `data` - Optional data which can be assigned to the transaction		Wallet initialization	Usage	Application

RustJavaTypescriptSwift

send_amount

sendAmount

Not available yet!

public func sendAmount(pin: String, address: String, amount: Double, data: [UInt8]) throws

Get Purchase list¶

Method	Arguments	Returns	Dependencies	Level	Repeat
Get purchase list	`start` - The starting page number, `limit` - The maximum number of transactions per page	Returns a list of purchases as `TxInfo` object, if successful.	User initialization	Usage	Application

RustJavaTypescriptSwift

get_tx_list

txList

getTransactionList

Not available yet!

public func getTxList(start: UInt64, limit: UInt64) throws -> String

TxInfo¶

RustJSON

pub struct TxInfo {
    /// Tx creation date, if available
    pub date: Option<String>,
    /// receiver of the transaction
    pub receiver: String,
    /// etopay reference id for the transaction
    pub reference_id: String,
    /// Application specific metadata attached to the tx
    pub application_metadata: Option<ApplicationMetadata>,
    /// Amount of transfer
    pub amount: f64,
    /// Currency of transfer
    pub currency: String,
    /// Status of the transfer
    pub status: TxStatus,
    /// The transaction hash on the network
    pub transaction_hash: Option<String>,
    /// Exchange rate
    pub course: f64,
}

pub struct ApplicationMetadata {
    pub product_hash: String,
    pub reason: String,
    pub purchase_model: String,
    pub app_data: String,
}

{
    "$schema": "http://json-schema.org/draft-07/schema#",
    "type": "object",
    "properties": {
        "date": {
            "type": ["string", "null"],
            "description": "Tx creation date, if available"
        },
        "receiver": {
            "type": "string",
            "description": "receiver of the transaction"
        },
        "reference_id": {
            "type": "string",
            "description": "etopay reference id for the transaction"
        },
        "application_metadata": {
            "type": ["object", "null"],
            "description": "Application specific metadata attached to the tx",
            "properties": {
                "product_hash": {
                    "type": "string",
                    "description": "The product hash"
                },
                "reason": {
                    "type": "string",
                    "description": "The reason for the transaction"
                },
                "purchase_model": {
                    "type": "string",
                    "description": "The purchase model"
                },
                "app_data": {
                    "type": "string",
                    "description": "The application data"
                }
            },
            "required": ["product_hash", "reason", "purchase_model", "app_data"]
        },
        "amount": {
            "type": "number",
            "description": "Amount of transfer"
        },
        "currency": {
            "type": "string",
            "description": "Currency of transfer"
        },
        "status": {
            "type": "string",
            "description": "Status of the transfer",
            "enum": ["Pending", "Valid", "Invalid", "ProcessingMain", "ProcessingAux", "Completed", "Failed"]
        },
        "transaction_hash": {
            "type": ["string", "null"],
            "description": "The transaction hash on the network"
        },
        "course": {
            "type": "number",
            "description": "Exchange rate"
        }
    },
    "required": ["receiver", "reference_id", "amount", "currency", "status", "course"]
}

Postident functions¶

Start kyc verification for postident¶

Method	Arguments	Returns	Dependencies	Level	Repeat
Start kyc verification for postident		Returns an object `NewCaseIdResponse` if successful.	User initialization	Usage	Application

RustJavaTypescriptSwift

start_kyc_verification_for_postident

startKycVerificationForPostident

Not available yet!

public func startKycVerificationForPostident() throws -> String

NewCaseIdResponse¶

RustJSON

pub struct NewCaseIdResponse {
    /// New Postident case id
    pub case_id: String,
    /// Case url
    pub case_url: String,
}

{
    "$schema": "http://json-schema.org/draft-07/schema#",
    "type": "object",
    "properties": {
        "case_id": {
            "type": "string",
            "description": "New Postident case id"
        },
        "case_url": {
            "type": "string",
            "description": "Case url"
        }
    },
    "required": ["case_id", "case_url"]
}

Get case details for postident¶

Method	Arguments	Returns	Dependencies	Level	Repeat
Get case details for postident		Returns an object `CaseDetailsResponse` if successful.	User initialization	Usage	Application

RustJavaTypescriptSwift

get_kyc_details_for_postident

getKycDetailsForPostident

Not available yet!

public func getKycDetailsForPostident() throws -> String

CaseDetailsResponse¶

RustJSON

pub struct CaseDetailsResponse {
    pub case_id: String,
    pub archived: bool,
    pub status: String,
}

    {
        "$schema": "http://json-schema.org/draft-07/schema#",
        "type": "object",
        "properties": {
            "case_id": {
                "type": "string",
                "description": "The Postident case id"
            },
            "archived": {
                "type": "boolean",
                "description": "Whether the case is archived"
            },
            "status": {
                "type": "string",
                "description": "The status of the case"
            }
        },
        "required": ["case_id", "archived", "status"]
    }

Update case status for postident¶

Method	Arguments	Returns	Dependencies	Level	Repeat
Update case status for postident	`case_id`: The ID of the case to update.		User initialization	Usage	Application

RustJavaTypescriptSwift

update_kyc_status_for_postident

updateKycStatusForPostident

Not available yet!

public func updateKycStatusForPostident(case_id: String) throws

Get user preferred network¶

Method	Arguments	Returns	Dependencies	Level	Repeat
Fetches the users preferred network		Returns the network if successful or an empty value if no preferred network has been set.	User initialization	Usage	Application

RustJavaTypescriptSwift

get_preferred_network

getPreferredNetwork

Not available yet!

public func getPreferredNetwork() throws -> PreferredNetwork

Set user preferred network¶

Method	Arguments	Returns	Dependencies	Level	Repeat
Sets the users preferred network, or resets it if an empty value is provided.	`network_key` - The preferred user network. Optional value.		User initialization	Usage	Application

RustJavaTypescriptSwift

set_preferred_network

setPreferredNetwork

Not available yet!

public func setPreferredNetwork(network_key: String) throws

API Reference¶

Levels and Repeats¶

Usage infos and warnings¶

JavaScript / TypeScript¶

Java¶

Rust¶

SDK Initialization and Configuration¶

Instantiating the SDK¶

Set configuration¶

Get supported networks¶

Set network¶

Get build information¶

User functions¶

Creating a new user¶

Initializing a user¶

Refreshing access token¶

Checking KYC status¶

Delete user¶

Wallet functions¶

Create new wallet¶

Create new wallet from mnemonic¶

Create new wallet from backup¶

Create a wallet backup¶

Verify mnemonic¶

Delete wallet¶

Verify pin¶

Reset pin¶

Set wallet password¶

Is wallet password set¶

Generate a new address¶

Get balance¶

Get wallet transactions¶

WalletTxInfo¶

Get wallet transaction¶

Set recovery share¶

Get recovery share¶

Viviswap functions¶

Start KYC Verification for viviswap¶

NewViviswapUser¶

Get KYC details for viviswap¶

ViviswapKycStatus¶

Update partial KYC for viviswap¶

ViviswapPartiallyKycDetails¶

Submit partial KYC for viviswap¶

Get IBAN for viviswap¶

ViviswapAddressDetail¶

Update IBAN for viviswap¶

Create deposit with viviswap¶

ViviswapDeposit¶

Create viviswap address detail¶

Create withdrawal with viviswap¶

ViviswapWithdrawal¶

Get swap details¶

Order¶

Get swap lists¶

Get exchange rate¶

Transaction functions¶

Create purchase request¶

Get purchase details¶

PurchaseDetails¶

Confirm purchase request¶

Send amount¶

Get Purchase list¶

TxInfo¶

Postident functions¶

Start kyc verification for postident¶

NewCaseIdResponse¶

Get case details for postident¶

CaseDetailsResponse¶

Update case status for postident¶

Get user preferred network¶

Set user preferred network¶