Deposit callbacks

Body

application/json

integer

required

Internal transaction ID, the same ID used in /v2/transactions/info.

type

enum<string>

required

Deposit type:

deposit: standard deposit
deposit_exchange: deposit with automatic conversion
deposit_wallet_client: deposit to a merchant top-up address. Sent only if business wallet transactions callbacks are enabled.

Available options:

deposit,

deposit_exchange,

deposit_wallet_client

crypto_address

object

required

Details of the address the funds were deposited to.

Hide child attributes

crypto_address.id

integer

required

Address ID.

crypto_address.currency

string

required

Code of the deposited currency. See API currency codes. For cross-currency deposits, this is the currency that was actually deposited, not the one assigned to the address.

crypto_address.address

string

required

Deposit address.

crypto_address.tag

string | null

required

Destination tag/memo. null for currencies that do not require tags.

crypto_address.convert_to

string

Code of the currency the deposit is converted to. See API currency codes. Present only for addresses with automatic conversion.

crypto_address.cross_currency

boolean

true for cross-currency deposits, where the deposited currency differs from the one assigned to the address. Absent otherwise. Cross-currency callbacks can be disabled, see Configure callbacks.

crypto_address.foreign_id

string

The foreign_id you provided when creating the address via the API. Use it to identify which customer made the deposit. Absent for addresses created in the portal, which have title instead.

crypto_address.title

string

The name you gave the address when creating it in the portal. Only present if business wallet transactions callbacks are enabled.

transactions

(blockchain · object | internal · object | exchange · object)[]

required

Transactions related to the deposit. Every deposit has one blockchain or internal entry, and deposits with automatic conversion have an additional exchange entry. The transaction_type field shows what each entry is:

blockchain: the incoming transaction on the blockchain
internal: the incoming transaction for an off-chain deposit, which is never sent to the blockchain
exchange: the conversion of the deposited currency, present only for deposits with automatic conversion

blockchain
internal
exchange

Hide child attributes

transactions.id

integer

required

Transaction ID.

transactions.currency

string

required

Code of the deposited currency. See API currency codes.

transactions.transaction_type

enum<string>

required

Available options:

blockchain

transactions.type

string

required

Transaction type, deposit or deposit_wallet_client.

transactions.address

string

required

Deposit address.

transactions.tag

string | null

required

Destination tag/memo. null for currencies that do not require tags.

transactions.amount

string

required

Amount deposited, in currency.

transactions.txid

string

required

Blockchain transaction hash.

transactions.confirmations

required

Number of blockchain confirmations.

transactions.riskscore

string | null

Risk score of the transaction. null while the deposit is processing. See Risk scoring.

transactions.sender

object

The sender of the deposit. Present only if Sender address is enabled in Callback parameters, and omitted if the deposit has multiple sender addresses.

Hide child attributes

transactions.sender.address

string

The sender's blockchain address.

fees

object[]

required

Fees charged for the deposit. Empty while the deposit is processing and for cancelled deposits.

Hide child attributes

fees.type

string

required

Fee type, for example deposit, exchange, transfer, fee_crypto_deposit_internal or fee_crypto_deposit_wallet_client_internal for off-chain deposits.

fees.currency

string

required

Code of the currency in which the fee was charged. See API currency codes.

fees.amount

string

required

Fee amount, deducted in the fee currency.

error

string

required

The reason the deposit was cancelled. Empty string for confirmed and processing deposits. Possible values:

Transaction amount less than minimum deposit: the deposited amount is lower than the minimum allowed for that currency
Double spend: conflicts with transaction <hash>: the deposit conflicts with another transaction, where <hash> identifies the conflicting transaction. You can look it up in your transaction history to see how it was processed

status

enum<string>

required

Deposit status:

confirmed: the deposit has been confirmed and can be treated as final on your side. At this stage, it is safe to perform business actions such as adding funds to the customer's balance
not_confirmed: the transaction has been detected but is still being processed. Wait for the confirmed callback before treating the deposit as final. Currencies that support instant confirmations may skip this status. See How deposits are confirmed
cancelled: the deposit was cancelled and will not be added to your balance. Sent when the deposited amount is lower than the minimum (no fees are charged), or when the deposit conflicts with another transaction sent to the same address in a double-spend scenario. For a double spend, the error field identifies the conflicting transaction, which you can look up in your transaction history to see how it was processed. Since this transaction is not considered valid, do not add funds to the customer's balance

Available options:

confirmed,

not_confirmed,

cancelled

end_user_reference

string

The end_user_reference you provided when creating the address via the API. Absent for addresses created in the portal.

expected_currency

string

For cross-currency deposits, the currency originally assigned to the address, that is, the one you expected to receive. See API currency codes. Absent for other deposits.

currency_sent

object

The currency and amount sent by the customer. Absent from cancelled deposits.

Hide child attributes

currency_sent.currency

string

required

Code of the currency sent by the customer. See API currency codes.

currency_sent.amount

string

required

Amount sent by the customer.

currency_received

object

The currency and amount received after processing or conversion. Absent from cancelled deposits. For deposits with conversion that are still processing, the amounts are 0.

Hide child attributes

currency_received.currency

string

required

Code of the currency received. See API currency codes. Differs from the sent currency for deposits with conversion.

currency_received.amount

string

required

Amount received.

currency_received.amount_minus_fee

string

required

Amount added to your merchant balance after fees.

origin

enum<string>

Present for deposits to addresses created in the portal and to merchant top-up addresses. Only present if business wallet transactions callbacks are enabled.

Available options:

business_wallet

Reference

Deposits & withdrawals

Payment requests

Currencies

Exchange

Transactions

Account balance

System Health

Body