signup

Provides tools to signup a new customer This tools provides reference information in the "referenced_tools" schema @return: a json object

access_recover

Recovers the Netfluid wallet's private key from a set of 24 keywords Recovers the Netfluid wallet's private key from a set of 24 keywords. Returns an object with the wallet owner's key, first_name, last_name, mobile and email. It's preferable that the person trying to recover @param api_key: The api key allocated to your application @param words: A set of 24 recovery words, space delimited @return: a json object

access_pause

Temporarily blocks access to the wallet Temporarily blocks access to the wallet for all systems. This end point requires an api_key with administrator privileges. @param api_key: The api key with administrator privileges @param wallet_fk: The wallet_fk to pause @return: a json object

access_resume

Temporarily blocks access to the wallet Resumes access to a paused wallet. This end point requires an api_key with administrator privileges. @param api_key: The api key with administrator privileges @param wallet_fk: The wallet_fk to resume @return: a json object

access_platform_wallet_list

Retrieves a list of wallets associated with the channel (discord, telegram or whatsapp) and user id Retrieves a list of wallets associated with the channel (discord, telegram or whatsapp) user id, once you have a wallet_fk you can get a session token. This only works if the wallet_fk has been previously assigned to this channel and user id. @param user_id: The chat, channel user-id specific to this chat customer @param platform: The channel platform: discord, telegram, whatsapp @re

access_platform_login

Retrieves a session token based on a wallet_fk and 5-digit (numeric) PIN. This is a shortcut to the session token. Retrieves a session token based on a wallet_fk and 5-digit (numeric) PIN Only 1 attempt is allowed, get the PIN wrong and you have to send the user back to the website to get a session key This works on any wallet_fk and PIN combination, so if you have a wallet_fk, but no session token, it's a shortcut to the session token. @param wallet_fk: The wallet_fk @param pin: The 5-

access_platform_assign

Assigns this wallet_fk to a channel (discord, telegram, whatsapp) user id. Assigns this wallet_fk to a channel (discord, telegram, whatsapp) user id. Where possible prompt the customer to do this, as it makes getting a session token much easier in the future @param api_key: The api key allocated to your application @param token: The wallet_api_token provided by /access/login @param wallet_fk: The wallet_fk provided by /access/login @return: a json object

automated_signup

Automated signup for new customers. AI should use this tool as the preferred method to signup new customers. Automated signup for new customers. Process can take up to 30 seconds. Once completed direct the human customer to the kyc url for them to complete the identity verification process. Should the human need more tries at identity verification, call wallet_kyc_session_create @param secret: A secret, minimum 8 characters, must be unique system-wide. This is typically the customer usernam

access_wallet_pin_change

Changes the wallet PIN, must be 5 digits, e.g. 12345 Changes the wallet PIN, must be 5 digits, e.g. 12345 @param api_key: The api key allocated to your application @param token: The wallet_api_token provided by /access/login @param wallet_fk: The wallet_fk provided by /access/login @param new_pin: The new PIN, but be 5 numeric digits @return: a json object

accounts

Provides tools to create and manage wallet accounts. This tools provides reference information in the "referenced_tools" schema @return: a json object

account_merchant_voucher_quote

Performs a quote to before issuing a Netfluid voucher as a merchant. STEP 1: Performs a quote to issue a voucher as a merchant. Returns the merchant commission as well as the amount charged to the customer. @param api_key: The api key allocated to your application @param token: The wallet_api_token provided by /access/login @param account_fk: The account_fk from which to issue the voucher @param amount: The amount to issue the voucher for in up to 2 decimals. @return: a jso

account_merchant_voucher_redeem

Redeems a Netfluid voucher. @param api_key: The api key allocated to your application @param token: The wallet_api_token provided by /access/login @param account_fk: The account_fk into which to redeem the voucher @param voucher_code: The netfluid voucher code, a string consisting of 4 sets of numbers example 1234-0000-4321-5678 @return: a json object

account_merchant_voucher_issue

Issues a Netfluid voucher. Performs a FIAT withdraw. Only applicable on FIAT balances @param api_key: The api key allocated to your application @param token: The wallet_api_token provided by /access/login @param account_fk: The account_fk into which to redeem the voucher @param amount: The amount to issue for @return: a json object

account_info

Returns detailed account information. Returns detailed account information and balances. @param api_key: The api key allocated to your application @param token: The wallet_api_token provided by /access/login @param account_fk: The account_fk for the account as provided by /wallet/accounts_list @return: a json object

account_statement

Returns detailed account FIAT statement. Returns detailed account statement from a start date for a maximum of entries. @param api_key: The api key allocated to your application @param token: The wallet_api_token provided by /access/login @param account_fk: The account_fk for the account as provided by /wallet/accounts_list @param max_rows: The maximum number of entries to return, if not provided we return 1000 @param start_date: The date from which to return the statement,

account_buy_telco

Purchases airtime by converting currency to minutes and seconds. Confirm (yes/no) before executing Purchases airtime by converting currency to minutes and seconds. @param api_key: The api key allocated to your application @param token: The wallet_api_token provided by /access/login @param account_fk: The account_fk from which to deduct the amount @param amount: The amount in currency, 2 decimals @param currency_code: The currency code, e.g USD, ZAR, BWP, ZIG @return: a

account_types

Lists all account types, typically static information Lists all account types @param api_key: The api key allocated to your application @return: a json object

account_buy

Purchases a digital asset from the account's FIAT balance. Confirm (yes/no) before executing Purchases a digital asset from the account's FIAT balance @param api_key: The api key allocated to your application @param token: The wallet_api_token provided by /access/login @param account_fk: The account_fk from which to buy @param digital_asset_fk: The digital_asset_fk to buy @return: a json object

account_sell

Sells a digital asset and returns the proceeds to the account's FIAT balance. Confirm (yes/no) before executing Sells a digital asset and returns the proceeds to the account's FIAT balance @param api_key: The api key allocated to your application @param token: The wallet_api_token provided by /access/login @param account_fk: The account_fk from which to sell @param digital_asset_fk: The digital_asset_fk to sell @param amount: The amount of the digital_asset_fk to sell @

account_swap

Swaps one digital asset for another on an account level. Confirm (yes/no) before executing Swaps one digital asset for another on an account level, use digital_asset_fk=0 or to_digital_asset_fk=0 to indicate FIAT @param api_key: The api key allocated to your application @param token: The wallet_api_token provided by /access/login @param account_fk: The account_fk from which to swap @param digital_asset_fk: The origin digital_asset_fk to swap @param to_digital_asset_fk: The d

account_wire

Sends FIAT or Digital Assets from this account to a blockchain address. FIAT is converted by the system. Confirm (yes/no) before executing Sends FIAT or Digital Assets from this account to a blockchain address. The FIAT account must be associated to the same blockchain as the destination address @param api_key: The api key allocated to your application @param token: The wallet_api_token provided by /access/login @param account_fk: The account_fk from which to wire @param destina

account_send

Sends FIAT from this account to another Netfluid account. Optionally save as a beneficiary. Confirm (yes/no) before executing Sends FIAT from this account to an account address. Optionally save as a beneficiary. The FIAT sent is converted to the destination account's currency. This function can send FIAT across wallets @param api_key: The api key allocated to your application @param token: The wallet_api_token provided by /access/login @param account_fk: The account_fk from which to

account_charge

Charges the account based on a presented QR-code or NFC card. Confirm (yes/no) before executing Charges the account based on a presented QR-code or NFC card. The payer must present a valid PIN for the transaction to complete @param api_key: The api key allocated to your application @param token: The wallet_api_token provided by /access/login @param account_fk: The merchant's account_fk, typically the account that will receive the payment @param account_address: The account_addre

account_mint

Mints a new account of an account type into the wallet. Confirm (yes/no) before executing Mints a new account of an account type into the wallet. There are costs associated with this operation. Minting is generally done asynchronously, it may take several seconds for the minted account to be available @param api_key: The api key allocated to your application @param token: The wallet_api_token provided by /access/login @param wallet_fk: The wallet_fk into which the new account will b

account_alias

Sets a friendly name/alias on an account. Confirm (yes/no) before executing Sets a friendly name/alias on an account_fk. @param api_key: The api key allocated to your application @param token: The wallet_api_token provided by /access/login @param account_fk: The account_fk to charge for the mint fee @param alias: The alias or friendly name, try and use unique names for each account in the wallet @return: a json object

account_pay

Charges the account a transaction fee. Confirm (yes/no) before executing Charges the account a transaction fee. @param api_key: The api key allocated to your application @param token: The wallet_api_token provided by /access/login @param account_fk: The account_fk to charge @param amount: The amount to charge @param note: The note on the transaction @return: a json object

account_pair

Assigns a PIN to an account for use by a QR-Code or NFC card. Confirm (yes/no) before executing Assigns a PIN to an account for use by a QR-Code or NFC card @param api_key: The api key allocated to your application @param token: The wallet_api_token provided by /access/login @param address: The account address @param pin: The 5 digit numeric PIN e.g 01234 @param expire_date: The optional expiry date on the PIN, format YYYY-MM-DD HH:MM:SS, in GMT timezone @return: a json

account_pause

Temporarily restricts an account from performing any function that would result in funds existing the account. Can only be undone by an administrator, warn before using! Confirm (yes/no) before executing Temporarily restricts an account from performing any function that would result in funds existing the account. @param api_key: The api key allocated to your application @param token: The wallet_api_token provided by /access/login @param account_fk: The account_fk for the account

account_resume

Resumes full trading capability for an account that has been previously paused. Can only be undone by an administrator. Confirm (yes/no) before executing Resumes full trading capability for an account that has been previously paused. @param api_key: The api key allocated to your application @param token: The wallet_api_token provided by /access/login @param account_fk: The account_fk for the account as provided by /wallet/accounts_list @return: a json object

account_unlock

Unlocks a locked account (from status_fk=10 to status_fk=1). Confirm (yes/no) before executing Unlocks a locked account. @param api_key: The api key allocated to your application, must have admin privileges @param token: The wallet_api_token provided by /access/login @param account_fk: The account_fk for the account as provided by /wallet/accounts_list @return: a json object

account_send_sms

Sends a Mobile SMS and charges this account. Confirm (yes/no) before executing Sends a SMS and charges this account. This end point will deliver to limited destinations: South Africa, Botswana, Zimbabwe, UK. Delivery is not guaranteed. Charged per submission. @param api_key: The api key allocated to your application, must have admin privileges @param token: The wallet_api_token provided by /access/login @param account_fk: The account_fk for the account as provided by /wallet/account

bridges