Sign in

v3

latestOpenAPI 3.0.02026-07-311784111.3 MB
Wallet
Private

Sets originator of the deposit

Scope: wallet:read_write

Try in API console

get/private/set_clearance_originator

Query parameters

deposit_idstring required

JSON string containing: currency, user_id, address, tx_hash

Id of the deposit

originatorstring required

JSON string containing: is_personal, company_name, first_name, last_name, address

Information about the originator of the deposit

Response

Success response

currency'BTC' | 'ETH' | 'USDC' | 'USDT' | 'EURR' required

Currency, i.e "BTC", "ETH", "USDC"

addressstring required

Address in proper format for currency

amountnumber required

Amount of funds in given currency

state'pending' | 'completed' | 'rejected' | 'replaced' required

Deposit state. Allowed values: <li><code>pending</code>: deposit detected on blockchain/system, compliance not yet finished</li> <li><code>completed</code>: compliance check finished successfully</li> <li><code>rejected</code>: deposit failed compliance and must be handled manually</li> <li><code>replaced</code>: deposit transaction was replaced on the blockchain and should have a new transaction hash</li>

transaction_idstring nullable required

Transaction id in proper format for currency, null if id is not available

source_addressstring

Address in proper format for currency

received_timestampinteger required

The timestamp (milliseconds since the Unix epoch)

updated_timestampinteger required

The timestamp (milliseconds since the Unix epoch)

notestring
clearance_state'in_progress' | 'pending_admin_decision' | 'pending_user_input' | 'success' | 'failed' | 'cancelled' | 'refund_initiated' | 'refunded'

Clearance state indicating the current status of the transaction clearance process. Allowed values: <li><code>in_progress</code>: clearance process is in progress</li> <li><code>pending_admin_decision</code>: transaction is under manual review by Deribit admin</li> <li><code>pending_user_input</code>: user should provide additional information regarding the transaction</li> <li><code>success</code>: clearance process completed successfully</li> <li><code>failed</code>: clearance process failed, transaction is rejected</li> <li><code>cancelled</code>: transaction is cancelled (currently used only for withdrawals, meaning the withdrawal is cancelled)</li> <li><code>refund_initiated</code>: clearance process failed, transaction refund is initiated, funds are removed from Deribit balance (valid for deposits only)</li> <li><code>refunded</code>: clearance process failed, deposit amount is refunded back to the client (valid for deposits only)</li>

refund_transaction_idstring nullable

Transaction id in proper format for currency, null if id is not available

Example response

{
  "address": "1A1zP1eP5QGefi2DMPTfTL5SLmv7DivfNa",
  "amount": 1,
  "transaction_id": "1b1fb5568515e2b79503501e3d3680b2d0838d5dfc2d15a04eb8cd9fbbe0b572",
  "source_address": "1A1zP1eP5QGefi2DMPTfTL5SLmv7DivfNa",
  "received_timestamp": 1536569522277,
  "updated_timestamp": 1536569522277,
  "refund_transaction_id": "1b1fb5568515e2b79503501e3d3680b2d0838d5dfc2d15a04eb8cd9fbbe0b572"
}