Enterprise Guide¶

Wallets¶

Wallets are accounts nominated in crypto. We provide flexible options to customize your wallets and notifications.

Key points:

Wallet currency is specified when the wallet is created and cannot be changed.
Active wallets can be used to deposit and withdraw funds.
You can create any number of wallets.
You can provide access to the wallet to other users and limit the access using permissions.
You can freeze and unfreeze funds on TRX wallets to restore Tron blockchain resources.

How to Grant Access to Your Wallet

How to Restrict Access to Your Wallet

How to Freeze and Unfreeze Funds on TRX Wallets

Wallet statuses

Not active — the wallet is available in a Read Only mode.
In progress — the wallet is now being registered in the system and currently unavailable.
Active — the wallet has been activated and can be used to create deposits and payouts.

Wallets list¶

ID: The system identifier of a wallet, generated automatically when the wallet is created.
Label: The name of the wallet.
Balance confirmed: The available balance that can currently be used for payouts.
Pending: The sum of all incoming and outgoing transactions that have not yet received a confirmation. The value is positive for deposits and negative for payouts. This balance cannot currently be used for transfers.
Currency: The wallet currency (including tokens and custom tokens).
Status: The current status of the wallet. For more information, refer to Wallet statuses.
Exchange: Click this button to switch to the Creating Exchange page of the Exchanges tab, where you can exchange currencies between your wallets. The From field is automatically filled in with the name of the selected wallet.
Settings: Click this button to view wallet details (such as public address) or change wallet settings. For more information, refer to Wallet settings.

Wallet settings¶

To access Wallet settings, click the wallet ID or the Settings button on the wallets list page.

The Wallet settings page includes two tabs: Info and Log.

The Info tab contains all the essential wallet info:

Currency
The wallet currency. This value cannot be changed.

Parent wallet
A wallet in coins to which a token wallet is linked. You can link only one token wallet to a parent coin wallet. For successful transactions of tokens in ETH, BNB and TRX blockchains, you need to have minimum required amount of funds on the parent wallet:

for TRX — 50 TRX

for BNB — 0.0009 BNB-BSC

for ETH — flexible amount from 0.01 to 0.05

Label
The name of the wallet.

Wallet address
The public wallet address that can be used to directly top up wallet balance. This value cannot be changed. To copy the address, click the Copy button in the right corner of the field.

The Advanced options section
Additional wallet settings. The section contains the following fields:

Minimal transfer amount
The system will not automatically accept payments below the specified amount (in wallet currency). This can be useful if the transaction fee exceeds the transaction amount. In this case, the callback will not be sent, you will see a new transfer with Cancelled status on the Transfers page (refer to Transfers for details). You will also receive a notification in the Events where you can confirm and accept such transfers manually.

Notification addresses
A comma-separated list of email addresses to which new transaction notifications are sent.

Duplication
This option allows you to copy your wallet blockchain address to another blockchain, meaning that you will have the same addresses for two different currencies. This way you can prevent sending assets to a wrong blockchain by a mistake on behalf of a sender. You can duplicate the address only once and only for ETH/BSC currencies.

Access Rights In this section you can manage permissions for users who have access to the wallet (refer to How to Grant Access to Your Wallet, How to Restrict Access to Your Wallet for details). Here you can grant users access to a specific wallet. For more information about managing user access to all your wallets, refer to Managing access.

Log

The wallet history:

Created at

The date and time of an action.

Initiator

The field can have one of the following values:

System — system actions, such as wallet creation or status change.
API — actions performed via the system API.
Email address — actions performed by a specific user via the system user interface.

Reason

A particular reason for the action. The field can have the following values:

Created — the wallet has been created.
Changed — the wallet has been changed.
Deleted — the wallet has been deleted.

Comment

The description of the action.

Old value

Previous state of the wallet.

Actual value

Current state of the wallet.

Transfers¶

Transfers are a summary of all deposits and payouts registered for all your wallets.

Key points:

In this section you cannot create a new transfer. To create a new transfer, refer to Deposits or Payouts.
The list shows all transfers, including cancelled, failed, and others.

Transfer types

Wallet activation — amount necessary for the activation of the wallet.
Deposit — deposit.
Payout — payout.
Direct deposit to wallet’s address — direct deposits using the wallet public address.
Wallet charge — customized withdrawal.
Exchange receive — crediting of the exchange amount.
Exchange send — withdrawal of the exchange amount.
Payment for a custom token — the commission for custom token processing.
Deposit contract creation — amount charged for creation of a deposit contract.
Transportation — amount charged for transportation of funds associated with a token payout.
Side collecting funds on wallet — the amount charged for a cancelled transfer debited to your wallet as part of another, valid transfer.

Transfer statuses

Cancelled — the transaction is cancelled due to security reasons or a transaction amount being to small.
Blocked — the transaction is rendered suspicious and temporarily blocked until further verification.
Failed — the transaction has failed in the blockchain.
Created — the transaction has been created and is in the queue for processing, the status will be changed soon.
Unconfirmed — the transaction has not yet received the required number of block confirmations or the transaction legal status has not yet been verified.
Confirmed — the required number of block confirmations is received and the transaction is completed.

Transfers list¶

ID: The transaction identifier. This is a link to deposit or payout details (depending on the transfer type).
Created: The date and time of transaction creation or detection.
Type: The transaction purpose; refer to Transfer types for more details.
Status: Current transfer status; refer to Transfer statuses for more details.
Wallet: The name of the wallet from/to which the transaction was made. This is a link to the wallet details.
TXID: The blockchain transaction identifier. This is a link to the explorer.
Currency: The transaction currency (including tokens and custom tokens).
Amount: The transaction total amount.
Commission: The transaction processing fee.
Blockchain fee: The blockchain commission for the transaction.
Confirmations: The current number of transaction confirmations in the blockchain.

Transfer details¶

To access Transfer details, click the transfer ID on the transfers list page.

Each transfer has a tag right under the tarnsfer ID. The tag indicates the status of the AML verification of the transfer:

Checked — the transfer has passed AML check.
Pending — AML check is pending.
Failed — AML check has failed, the transfer has been marked as red.
Unavailable — AML check is unavailable for this transfer.

The transfer details page includes the following fields:

Wallet

The name of the wallet from/to which the transaction was made.

Type

Transaction purpose; for more details, refer to Transfer types.

Created

The date and time of transaction creation.

Updated

The date and time of transaction update (if any).

TXID

The blockchain transaction identifier. This is a link to the explorer.

Amount

The transaction amount in a sender’s currency.

Amount target

The transaction amount in the wallet currency.

Commission

The transaction commission in a sender’s currency.

Commission target

The transaction commission in the wallet currency.

Blockchain fee

The blockchain commission for the transaction.

Confirmations

The current number of transaction confirmations in the blockchain.

Rate

Current exchange rate; for more details, refer to Rates.

Callback

Callback information. Possible values:

Not needed — the Confirmations needed field was not specified for an associated deposit or payout.
Sent — callback is sent.
Not sent — callback has not yet been sent (not enough confirmations received yet).

Currency

The transaction currency (may differ from wallet currency).

Operation ID

A link to deposit or payout details (depending on the transfer type).

Deposits¶

Deposits are top-ups and payments credited to your wallets. The deposit currency should be the same as the wallet currency.

Key points:

The system accepts payments only in crypto.
Each transaction requires a certain number of confirmations in the blockchain.
The processing speed of a transaction in the blockchain depends on the blockchain fee amount.
Information about new transfers associated with a deposit can be sent to your system via a callback.
Each transaction can be assigned a special identifier by which the transaction can be tracked in your system.
It is possible to generate a payment page in order to send payment details to your payers.

See also

How to Create a Deposit

Deposits list¶

ID: The deposit identifier, this is a link to detailed view of the deposit information.
Created: The date and time of deposit creation.
Label: The deposit name.
Wallet: The label of the wallet to which funds are credited. This is a link to the wallet details.
Address: Payment address of the deposit in the blockchain. This is a link to the explorer.
Currency: The deposit currency (including tokens and custom tokens).
Tracking ID: A special identifier of the payment in the client system.
Paid amount: Total amount paid to the deposit address.
Updated: The date and time of deposit update.

Deposit details¶

To access Deposit details, click the ID on the deposits list page.

The Deposit details page includes two tabs: Info and Log.

The Info tab contains the essential deposit information:

Address
Payment address of the deposit in the blockchain. This is a link to the explorer, it cannot be edited.

View payment page button
Click this button to view the payment page.

The Advanced options section
Additional deposit settings. The section contains the following fields:

Label
The deposit name.

Tracking ID
Payment identifier in the client system.

Callback URL
URL for callback notifications on deposits. Such notifications may contain templates. To find out more about the templates, refer to How to Create a Deposit.

Required block confirmations for callback
Number of confirmations needed to receive an additional callback. If this field is not blank, two callbacks are sent: upon receiving the number of confirmations specified here and upon receiving the number of confirmations specified in the system settings.

The Transactions section
A list of transactions. Transactions IDs are links to transfers details (refer to Transfer details for more details).

The Log tab contains the deposit history:

Created at
The date and time of an action.

Initiator
The field can have one of the following values:

System — system actions, such as deposit creation or status change.

API — actions performed via the system API.

Email address — actions performed by a specific user via the system user interface.

Reason
A particular reason for the action. The field can have the following values:

Created — the deposit has been created

Changed — the deposit has been changed

Deleted — the deposit has been deleted

Comment
The description of the action.

Old value
Previous state of the deposit.

Actual value
Current state of the deposit.

Payouts¶

Payouts are withdrawals of funds from your wallets.

Key points:

Each transaction requires a certain number of confirmations in the blockchain.
The processing speed of a transaction in the blockchain depends on the blockchain fee amount. You can choose the fee amount when creating a payout.
Information about new transfers associated with a deposit can be sent to your system via a callback.
Each transaction can be assigned a special identifier by which the transaction can be tracked in your system.

Payouts list¶

ID: The payout identifier. This is a link to the payout details.
Created: The date and time of payout creation.
Label: The payout name.
Wallet: Label of the wallet from which funds are withdrawn. This is a link to the wallet details.
Receiver: Destination address. This is a link to the explorer.
Currency: The payout currency (including tokens and custom tokens).
Tracking ID: Identifier of the payment in the client system.
Amount: The payment amount in the wallet currency.
Commission: The commission for the payment.
Charged amount: The total withdrawn amount, which is calculated as follows: amount + commission + blockchain fee (if it is not included in the amount).
Updated: The date and time of payout update.

Payout details¶

To access Payout details, click the payout ID on the payouts list page.

The Payout details page includes two tabs: Info and Log.

The Info tab contains the essential payout information:

Wallet
The wallet from which the funds are withdrawn.

Address
The wallet address of the receiver of the payment. This is a link to the explorer.

Currency
The payout currency.

Amount
The payout amount.

Charged
Total payout amount including commissions and fees.

Commission
The transaction processing fee.

The Advanced options section
Additional payout settings. The section contains the following fields:

Label
The payout name.

Tracking ID
Identifier of the payment in the client system.

Callback URL
URL for callback notifications on payouts. Such notifications may contain templates. To find out more about the templates, refer to How to Create a Payout if You are an Enterprise User.

Required block confirmations for callback
Number of confirmations needed to receive an additional callback. If this field is not blank, two callbacks are sent: upon receiving the number of confirmations specified here and upon receiving the number of confirmations specified in the system settings.

The Transactions section
A list of transactions. Transaction IDs are links to transfers details (refer to Transfer details for more details).

The Log tab contains the payout history:

Created at
The date and time of the action.

Initiator
The field can have one of the following values:

System — system actions.

API — actions performed via the system API.

email address — actions performed by a specific user via the system user interface.

Reason
A particular reason for the action. The field can have the following values:

Created — the payout has been created

Changed — the payout has been changed

Deleted — the payout has been deleted

Comment
The description of the action.

Old value
Previous state of the payout.

Actual value
Current state of the payout.

Events¶

Events feature a list of system notifications that require your actions.

Event types

Callback — resend callback that has not been sent by the system.
Payout approve — approve or cancel payouts created by users with the Withdrawals with approval role.
Insufficient funds on parent wallet — not enough funds on parent wallet for accepting tokens to your wallet address. To accept tokens, top up the parent wallet and click the Retry button.
Insufficient funds for payment for a custom token — not enough funds for the commission for processing customized tokens. To pay the commission, top up your wallet and click the Retry button.
Transfer amount is less than required minimum — approve payouts below the minimal transfer amount.

Note

Some actions can only be performed by users with the Owner and Admin roles.

Exchanges¶

Exchanges feature a list of currency transfers between your wallets nominated in different currencies.

Key points:

You can exchange currencies only between your own wallets.
Exchange operations can only be performed between wallets nominated in different currencies. To transfer currency between wallets nominated in the same currency, use Deposits.
When exchanging currencies, you can indicate the amount either in the debited currency or in the credited currency.
Exchange amount should be greater than or equal to the Minimal transfer amount set for the receiving wallet (refer to Wallet settings for details).
The speed of transaction processing in the blockchain depends on the blockchain fee amount. You can choose the amount of fee when creating an operation.
If the exchange operation takes more than 15 minutes, the rate is recalculated and the final amount is changed according to the current quote; a notification about the rate changes is displayed in the Notification section (refer to General Options for details).

Exchanges list¶

ID

An exchange operation identifier.

Status

Current status of the operation:

Created — the operation has been created and is in the queue for processing. The status will be changed soon.
Failed — the operation failed in the blockchain.
Success — the operation was successfully completed.
Pending — the operation is now being processed.

Wallet (from)

Debiting wallet.

Amount (from)

Amount in the currency of a debiting wallet (blockchain fees not included).

Wallet (to)

Crediting wallet.

Amount (to)

Amount in the currency of a crediting wallet.

Created

The date and time of exchange creation.

Exchange details¶

To access Exchange details, click the operation ID on the exchanges list page.

Wallet (from): Debiting wallet.
Wallet (to): Crediting wallet.
Exchange rate: Exchange rates. Refer to Rates for more details.
Amount (from): Amount in the currency of a debiting wallet (blockchain fees not included).
Included fee: Amount of the blockchain fee.
Amount (to): Amount in the currency of a crediting wallet.
Applicant: Email address of the user who created the exchange operation.
Created: The date and time of exchange creation.
Transactions: A list of transactions. Transaction IDs are links to transfers details (refer to Transfer details for more information).

Rates¶

Rates are the current exchange rates for any currency conversion. These rates are used for exchange operations between your wallets.