رفتن به محتوا

درخواست‌های تغییر

GET/v1/change-requests

درخواست‌های تغییر یک کیف پول، تازه‌ترین اول، یا یک درخواست. دقیقاً یکی از id و wallet_id را بفرستید.

دسترسی لازم
approve-read
سقف نرخ در دقیقه
120 برای هر کلید

درخواست

پنجره‌ی ترمینال
curl 'https://api.romu.ir/v1/change-requests?wallet_id=0192f19f-1d2c-7f3b-8a4e-6b7c8d9e0f12' \
-H "X-Custody-Key-Id: $KEY_ID" \
-H "X-Custody-Timestamp: $TIMESTAMP" \
-H "X-Custody-Nonce: $NONCE" \
-H "X-Custody-Signature: $SIGNATURE"

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

پارامترهای query

idUUID
شناسه‌ی درخواست تغییر.
wallet_idUUID
شناسه‌ی کیف پول، مثل 0192f19f-1d2c-7f3b-8a4e-6b7c8d9e0f12⁠.

پاسخ

200یک درخواست (با id⁠) یا فهرست.

فیلدها با id

change_requestobjectلازم
change_request.idstring
change_request.wallet_idstring
change_request.kindstring
نوع تغییر با حروف کوچک، مثل webhook_set یا api_key_add⁠.
change_request.fieldsstring[]
change_request.statusstring
pending_approvalappliedrejectedexpired
change_request.close_reasonstring
change_request.required_approvalsinteger
change_request.approvalsinteger
change_request.rejectionsinteger
change_request.created_atRFC 3339
change_request.expires_atRFC 3339

فیلدها با wallet_id

change_requestsobject[]لازم
change_requests[].idstring
change_requests[].wallet_idstring
change_requests[].kindstring
نوع تغییر با حروف کوچک، مثل webhook_set یا api_key_add⁠.
change_requests[].fieldsstring[]
change_requests[].statusstring
pending_approvalappliedrejectedexpired
change_requests[].close_reasonstring
change_requests[].required_approvalsinteger
change_requests[].approvalsinteger
change_requests[].rejectionsinteger
change_requests[].created_atRFC 3339
change_requests[].expires_atRFC 3339

خطاها

400invalid request یا malformed request body⁠: بدنه، پارامتر یا فیلد نادرست است، یا فیلد ناشناخته دارد.
401unauthenticated⁠: هر شکست احراز هویت همین پاسخ را دارد.
403permission denied⁠: کلید دسترسی این مسیر را ندارد.
404not found⁠: مسیر یا شیء پیدا نشد. خواندن کیف پولی بیرون از فهرست کلید هم همین است.
429too many requests⁠: بیش از سقف نرخ. پس از Retry-After ثانیه دوباره بفرستید.
503try again later⁠: سرویس موقتاً در دسترس نیست.

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