تغییر برچسب یا بایگانی آدرس

PATCH/v1/addresses

برچسب تازه می‌گذارد یا آدرس را برای همیشه بایگانی می‌کند. واریز به آدرس بایگانی‌شده تا 30 روز دیگر هم دیده می‌شود. نوع آدرس هرگز عوض نمی‌شود.

دسترسی لازم: addresses
سقف نرخ در دقیقه: 60 برای هر کلید

درخواست

curl -X PATCH 'https://api.romu.ir/v1/addresses?id=0192f1b2-3333-7f3b-8a4e-6b7c8d9e0f01' \
  -H "X-Custody-Key-Id: $KEY_ID" \
  -H "X-Custody-Timestamp: $TIMESTAMP" \
  -H "X-Custody-Nonce: $NONCE" \
  -H "X-Custody-Signature: $SIGNATURE" \
  -H "Content-Type: application/json" \
  -d '{
    "label": "gold-customers"
  }'

import { romu } from "./romu.ts";

const res = await romu.patch("/v1/addresses", {
  query: "id=0192f1b2-3333-7f3b-8a4e-6b7c8d9e0f01",
  json: {
    "label": "gold-customers"
  },
});
console.log(res.status, res.body);

status, body, err := client.Do("PATCH", "/v1/addresses", "id=0192f1b2-3333-7f3b-8a4e-6b7c8d9e0f01", []byte(`{"label":"gold-customers"}`), "")

import romu

status, body = romu.patch(
    "/v1/addresses",
    query="id=0192f1b2-3333-7f3b-8a4e-6b7c8d9e0f01",
    json={
      "label": "gold-customers"
    },
)
print(status, body)

امضای درخواست را کتابخانه انجام می‌دهد؛ جزئیات: صفحه‌ی امضا

پارامترهای query

idUUIDلازم

شناسه‌ی آدرس.

بدنه

labelstring

archiveboolean

true آدرس را برای همیشه بایگانی می‌کند.

فیلد ناشناخته در بدنه 400 می‌گیرد.

پاسخ

200آدرس به‌روز شد.

فیلدها با id

addressobjectلازم

address.idUUIDلازم

address.wallet_idUUIDلازم

address.group_idstring

address.groupstring

address.kindstringلازم

maindepositsweepfee

address.labelstring

address.statusstringلازم

activearchived

address.addressesobject[]لازم

یک آدرس روی یک شبکه همه‌ی دارایی‌های آن شبکه را می‌گیرد. فهرست دارایی‌ها در GET /v1/assets است.

address.addresses[].networkstringلازم

TRONBSC

address.addresses[].addressstring | nullلازم

روی شبکه‌های EVM به شکل EIP-55. تا وقتی watch آدرس pending است null است: آدرس را تا ثبت شدنش در فهرست پایش نشان ندهید و پول به آن نفرستید.

address.created_atRFC 3339

address.archived_atRFC 3339 | null

address.watchstring

pending⁠: هنوز در فهرست پایش شبکه ثبت نشده (معمولاً چند ثانیه؛ رومو خودش دوباره تلاش می‌کند) و متن آدرس تا آن وقت null است. واریزی که در این فاصله برسد، پس از ثبت پیدا و ثبت می‌شود. watched⁠: پایش می‌شود.pendingwatched

خطاها

400invalid request یا malformed request body⁠؛ یا label_taken⁠: برچسب labels[index] (در ساخت تکی و تغییر برچسب، index برابر 0⁠) در این کیف پول هست یا در همین درخواست دو بار آمده. هیچ آدرسی ساخته یا عوض نشد. برچسب دیگری بفرستید، با Idempotency-Key تازه.

401unauthenticated⁠: هر شکست احراز هویت همین پاسخ را دارد.

403permission denied⁠: کلید دسترسی این مسیر را ندارد.

404not found⁠: مسیر یا شیء پیدا نشد. خواندن کیف پولی بیرون از فهرست کلید هم همین است.

429too many requests⁠: بیش از سقف نرخ. پس از Retry-After ثانیه دوباره بفرستید.

500internal error⁠: آدرس نشان داده نشد. به رومو خبر دهید.

503try again later⁠، org_paused (سازمان موقتاً متوقف شده، با Retry-After: 60⁠)، یا در ثبت برداشت suspension_unknown (با Retry-After: 5⁠). همان درخواست را با همان Idempotency-Key دوباره بفرستید.

بدنه‌ی خطا همیشه {"error":"..."} است. راهنمای خطاها می‌گوید برای هر کد چه باید کرد.