Skip to main content

How to register a transfer attempt

To register a transfer attempt using POST /v1/transfers/register-attempt/, you must provide the following fields:

  • client_id (optional) — external client ID the transfer attempt will be associated with.
  • attempt_id (optional) — unique external ID of the attempt.
  • direction — transfer direction.
  • network — network code.
  • input_address — sender address (required when direction is incoming).
  • output_address — recipient address (required when direction is outgoing).
  • token_id (optional) — token identifier within the network.
  • amount (optional) — transfer amount.

Request​

curl -X POST "https://kyt-api.bitok.org/v1/transfers/register-attempt/"   --header "Content-Type: application/json"   --header "Accept: application/json"   --header "API-KEY-ID:{KEY_ID}"   --header "API-TIMESTAMP:{TIMESTAMP}"   --header "API-SIGNATURE:{SIGNATURE}"   --data '{
    "client_id": "id0001",
    "attempt_id": "0a805206bab649a68b3408032a7352e6",
    "direction": "outgoing",
    "network": "ETH",
    "token_id": "0xdac17f958d2ee523a2206206994597c13d831ec7",
    "output_address": "0x92a5B444907902dAa39dE28A82EF66AF12e7f170",
    "amount": 500
  }'

Response​

{
  "id": "3c6b874e-f76c-42b4-8a08-e13fc50fa6a5",
  "client_id": "id0001",
  "attempt_id": "0a805206bab649a68b3408032a7352e6",
  "registered_at": "2023-12-18T14:15:02.266520+03:00",
  "occurred_at": "2023-12-18T14:15:02.258132+03:00",
  "direction": "outgoing",
  "risk_level": "undefined",
  "network": "ETH",
  "token_id": "0xdac17f958d2ee523a2206206994597c13d831ec7",
  "token_symbol": "USDT",
  "tx_hash": null,
  "tx_status": "none",
  "input_address": null,
  "output_address": "0x92a5b444907902daa39de28a82ef66af12e7f170",
  "amount": 500,
  "fiat_currency": "USD",
  "value_in_fiat": 499.66889865320763,
  "check_state": {
    "exposure": "none",
    "exposure_checked_at": null,
    "counterparty": "checking",
    "counterparty_checked_at": null,
    "sanctions": "none",
    "sanctions_checked_at": null
  }
}