Important announcement: API v3 launch! Review the changes and update your integrations by Dec 1, 2025 before old API shutdown
API guide v3
Release notes

Deposits

Deposits are invoices that you create to receive payments to your wallets.

Key points

  • The system accepts payments only in cryptocurrencies.

  • For Enterprise wallets, the payment currency must always match the wallet currency. For Merchant wallets, the payment currency may differ from the wallet currency.

  • Each on-chain transaction requires a certain number of blockchain confirmations. This number is specified for each currency in the Coinsbuy Back Office. Until the required number of confirmations is received, the transfer is assigned the Unconfirmed status. When creating a deposit, you can overwrite this setting by specifying the Required block confirmations value. In this case, the payment is assigned the Confirmed status once the specified number is achieved.

  • The processing speed of a transaction on the blockchain depends on the blockchain fee amount. The fee amount is selected by a payer.

  • Information about new transfers associated with a deposit can be sent to your system via a callback.

  • Each deposit can be assigned a special identifier by which the related transactions can be tracked in an external system.

  • For each deposit, a payment page is automatically generated. It can be useful to send payment details to your payers. The exchange rate on the payment page is frozen for 15 minutes after its creation.

  • For Merchant wallets, it’s possible to set time limits to specify the sum or expiration time for a deposit as well as payment limits to address possible payment amount variations due to rate changes.

Deposit list

On this page, you can view a list of all deposits to your wallets.

The following information is provided about each deposit:

ID

The unique system identifier of a deposit. This is a link to deposit details.

This value is generated automatically at the moment of deposit creation and can’t be changed.

Created

The date and time when a deposit was created.

Updated

The date and time when the deposit status was last updated or payment received.

Wallet type

The type of a wallet to which deposit-related payments are made.

Wallet

The label or system identifier of a wallet to which deposit-related payments are made. This is a link to wallet details.

Address

The deposit address. This is a link to the explorer.

For deposits to Merchant wallets, if the payment currency wasn’t specified, this field is empty until a payer selects the payment currency. After that, this field is filled in with the address generated depending on the payment currency selected by the payer and can’t be changed.

Currency

The payment currency.

For Enterprise wallets, always the same as the wallet currency. For Merchant wallets, may differ from the wallet currency.

For deposits to Merchant wallets, if the payment currency wasn’t specified, this field is empty until a payer selects the payment currency. After that, this field is filled in with the payment currency selected by the payer and can’t be changed.

Label

The tag or name assigned to a deposit for easier locating it in the system.

This value is set when creating a deposit and can be changed anytime.

Tracking ID

The user-provided identifier assigned to a deposit for easier locating related payments in external systems.

This value is set when creating a deposit and can be changed anytime.

Status

Available only for deposits to Merchant wallets. The deposits to Enterprise wallets are always assigned the Invoice status.

The current deposit status. Possible values:

  • Invoice: The deposit has just been created or hasn’t yet been paid in full (for deposits with indicated amounts).

  • Paid: The deposit with the indicated amount was paid in full.

  • Canceled: The deposit was canceled by a user or expired with no payments received. A deposit in any status can be canceled by a user.

  • Unresolved: The deposit requires actions from the user. This status is possible in the following cases:

    • If the amount of an incoming transfer is greater than the deposit amount.

    • If a payment is received after the specified expiration date.

    • If a payment is received for a deposit assigned the Paid or Canceled status.

Requested amount

The requested amount, in the wallet currency (only for deposits with indicated amounts).

This value is set when creating a deposit and can be changed anytime.

Requested rate

If the payment currency differs from the wallet currency, this is the current exchange rate of a payment currency to the wallet currency. This value is updated with each payment received or the deposit status updated.

If the deposit currency wasn’t specified, this field is empty until a payer selects the payment currency.

Paid amount

The total amount of funds that have already been received to the deposit address, in the wallet currency.

Enrolled amount

The total amount credited, in the wallet currency.

This value is calculated as Paid amount – Total commission amount.

Expired at

The date and time of deposit expiration (only for Merchant deposit with indicated expiration time).

Deposit details

To access deposit details, click a deposit ID in the deposit list.

In the upper part of the page, you can find essential information about the deposit — click the chevron icon to expand it:

  • The deposit identifier, label (if set), and current status.

  • The information about your wallet: the wallet identifier, label (if set), type (E for Enterprise and M for Merchant), and current balance.

  • The deposit currency (if defined).

  • The deposit address (if the payment currency is specified).

  • The link to a payment page.

  • The paid amount in the wallet currency.

  • The enrolled amount in the wallet currency (Paid amount – Total commission amount).

The information below is divided into tabs:

On this tab, you can access and change deposit settings. The content on this tab differs for Enterprise and Merchant deposits.

Currency

The payment currency.

Available only for deposits to Merchant wallets, if the payment currency wasn’t specified.

Status

The current deposit status. Available only for deposits to Merchant wallets.

Possible values:

  • Invoice: The deposit has just been created or hasn’t yet been paid in full (for deposits with indicated amounts).

  • Paid: The deposit with the indicated amount was paid in full.

  • Canceled: The deposit was canceled by a user or expired with no payments received. A deposit in any status can be canceled by a user.

  • Unresolved: The deposit requires actions from the user. This status is possible in the following cases:

    • If the amount of an incoming transfer is greater than the deposit amount.

    • If a payment is received after the specified expiration date.

    • If a payment is received for a deposit assigned the Paid or Canceled status.

Limits

Available for deposits to Merchant wallets only.

The time and payment limits.

Expand fields

Requested amount in wallet currency

The deposit amount, in the wallet currency.

Delta

Applicable for deposits to Merchant wallets with indicated amounts.

The payment delta, in the wallet currency.

The delta can be useful to address possible rate changes. For example, you create a deposit for 100 USDT with the expiration time of 10 minutes without specifying the payment currency. This means that the payer can pay in any currency within 10 minutes. But the rate of the currency pair may change within the specified time. In order to minimize your risks, you can set the delta value, for example of 5 USDT, which means that you expect payment from 95 USDT to 105 USDT (depending on the rate) within 10 minutes.

The delta can be also useful when the payment currency is the same as the wallet currency. For example, you create a deposit with the indicated amount of 0.1 BTC, and the payer sends 0.1 BTC minus the commission, and thus you don’t receive the full amount of the deposit and the deposit can’t be transferred to the Paid status. To avoid such situations, enter the delta value.

Mind that the delta must be less than the requested amount.

Requested amount in payment currency

The deposit amount, in the payment currency.

If the deposit currency wasn’t specified, this field is unavailable until a payer selects the payment currency.

Expired at

The date and time of the deposit expiration.

Rate

If the payment currency differs from the wallet currency, this is the exchange rate of a payment currency to the wallet currency.

If the deposit currency wasn’t specified, this is the exchange rate to a base currency (USD).

The exchange rates are automatically updated. Click the refresh icon to see the current value.

Advanced options

Additional deposit settings.

Expand fields

Label

The tag or name assigned to a deposit for easier locating it in the system.

Tracking ID

The user-provided identifier assigned to a deposit for easier locating related payments in external systems.

Callback URL

The URL for callback notifications on new payments.

Required block confirmations for callback

The number of confirmations needed to receive an additional callback.

If this field is not empty, 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 corresponding transaction is assigned the Confirmed status as soon as the number of confirmations specified in this field received.

Payment page URL

The link that is displayed as a button on the payment page.

Payment page button name

The custom name of a button displayed on the payment page.

See also:

PreviousTransfersNextPayouts

Last updated

Was this helpful?