کاستودی · روند یکپارچه‌سازی

API شما می‌نویسد.
داشبورد شما می‌خواند.

برای هر کاربر برنامه خود یک کاربر کاستودی بسازید. او آدرس‌های واریز دائمی می‌گیرد، هر واریز به موجودی او اضافه می‌شود و شما همه چیز را در داشبورد دنبال می‌کنید.

ایجاد فقط از طریق API · داشبورد فقط‌خواندنی

یک کاربر کاستودی برای هر کاربر برنامه شما

برنامه شما کاربران کاستودی را با شناسه کاربری خودش (external_id) می‌سازد و id برگشتی را نگه می‌دارد. هر کاربر کاستودی آدرس‌های واریز دائمی و موجودی جداگانه برای هر ارز در درگاه شما دارد. داشبورد آن‌ها را فهرست می‌کند، اما نمی‌تواند آن‌ها را بسازد: این کار از طریق API انجام می‌شود.

POST · /custody/users

۱. ساخت کاربر

شناسه کاربر خود و در صورت تمایل نام، ایمیل و metadata را بفرستید. فراخوانی دوباره با همان external_id همان کاربر را برمی‌گرداند، پس تکرار آن بی‌خطر است.

curl https://coino.live/api/v2/custody/users \
  -H "Authorization: Bearer ck_live_..." \
  -H "Content-Type: application/json" \
  -d '{"external_id": "customer_1001", "name": "Sara", "email": "[email protected]"}'
GET · /custody/users/{id}

۲. نمایش آدرس‌های واریز به کاربر

پاسخ شامل آدرس‌های کاربر، ارزها و شبکه‌هایی که هر آدرس می‌پذیرد و موجودی‌های اوست. آدرس‌ها هرگز تغییر نمی‌کنند، پس برنامه شما می‌تواند آن‌ها را برای همیشه نشان دهد، مثلاً در صفحه «واریز».

{"data": {
  "id": "01m6…", "external_id": "customer_1001", "status": "active",
  "addresses": [{"address": "TQ5x…", "networks": ["tron"], "assets": ["usdt-tron", "trx-tron"]}, …],
  "balances": [{"asset": "usdt-tron", "balance": "125.5"}]
}}
GET · /custody/users/{id}/deposits

۳. واریزها خودکار به حساب اضافه می‌شوند

وقتی کاربر به یکی از آدرس‌هایش ارز می‌فرستد، وب‌هوک custody.deposit.detected را می‌فرستیم و پس از تأیید و افزوده شدن به موجودی او، custody.deposit.credited را. همچنین هر زمان می‌توانید فهرست واریزهای اعمال‌شده را، از جدید به قدیم، دریافت کنید.

در برنامه خودتان، با رسیدن custody.deposit.credited حساب کاربر را شارژ کنید و از id واریز استفاده کنید تا هیچ واریزی دو بار اعمال نشود.

POST · /custody/users/{id}/transfers

۴. انتقال موجودی‌ها به موجودی اصلی

موجودی هر کاربر کاستودی در درگاه شما متعلق به همان کاربر است. آن را از طریق API (همه یا بخشی از آن)، با دکمه صفحه کاربر در داشبورد، یا به‌صورت خودکار برای هر واریز با تنظیم درگاه، به موجودی اصلی خود منتقل کنید. برداشت‌ها از موجودی اصلی شما پرداخت می‌شوند.

مدیریت وضعیت‌ها

وضعیت داشبوردمعنیموجودی قابل استفاده
در حال تأییدواریز روی بلاک‌چین دیده شده و در انتظار تأییدهاست.بدون تغییر
ثبت‌شدهواریز تأیید شده و (پس از کسر کارمزدها) به موجودی کاربر اضافه شده است.به اندازه مبلغ واریزشده افزایش می‌یابد
در انتظار بررسیتیم ما پیش از اعمال، واریز را بررسی می‌کند.بدون تغییر

هر واریز دقیقاً یک بار اعمال می‌شود، حتی اگر وب‌هوک دو بار برسد.

آشنایی با سرویس کاستودی