Documentation
/
リファレンス
/
HTTP / WebSocket API リファレンス
/
rippledのパブリックメソッド
/
PathおよびOrderBookのメソッド
/
deposit_authorized
最終更新:
編集

deposit_authorized

[ソース]

deposit_authorizedコマンドは、あるアカウントに別のアカウントへ支払を直接送金する権限があるかどうかを示します。アカウントへの送金に承認を義務付ける方法については、Deposit Authorizationをご覧ください。

リクエストのフォーマット

リクエストのフォーマットの例:

{
  "id": 1,
  "command": "deposit_authorized",
  "source_account": "rEhxGqkqPPSxQ3P25J66ft5TwpzV14k2de",
  "destination_account": "rsUiUMpnrgxQp24dJYZDhmV4bE3aBtQyt8",
  "credentials": [
    "A182EFBD154C9E80195082F86C1C8952FC0760A654B886F61BB0A59803B4387B",
    "383D269D6C7417D0A8716B09F5DB329FB17B45A5EFDBAFB82FF04BC420DCF7D5"
  ],
  "ledger_index": "validated"
}

リクエストには以下のパラメーターが含まれます。

フィールド型必須?説明
source_account文字列 - アドレスはい発生し得る支払いの送金元。
destination_account文字列 - アドレスはい発生し得る支払いの送金先。
ledger_hashハッシュいいえ使用するレジャーバージョンの32バイトの16進文字列。(レジャーの指定をご覧ください)
ledger_indexレジャーインデックスいいえ使用するレジャーのレジャーインデックス、またはレジャーを自動的に選択するためのショートカット文字列。(レジャーの指定をご覧ください)
credentials配列いいえ送金元が送金先に送金できるかどうかを確認する際に考慮する資格情報のセット。配列の各メンバは、レジャーのCredentialエントリの一意のIDでなければなりません。空の配列は許可されません。
注記

送金元が送金先に送金できるかどうかを確認する際に、送金先が事前承認した資格情報のセットと完全に一致しない資格情報のセットを提供した場合、送金は承認されません。この動作はトランザクション処理の動作と一致しています。

レスポンスのフォーマット

処理が成功したレスポンスの例:

{
  "id": 1,
  "result": {
    "credentials": [
      "A182EFBD154C9E80195082F86C1C8952FC0760A654B886F61BB0A59803B4387B",
      "383D269D6C7417D0A8716B09F5DB329FB17B45A5EFDBAFB82FF04BC420DCF7D5"
    ],
    "deposit_authorized": true,
    "destination_account": "rsUiUMpnrgxQp24dJYZDhmV4bE3aBtQyt8",
    "ledger_hash": "BD03A10653ED9D77DCA859B7A735BF0580088A8F287FA2C5403E0A19C58EF322",
    "ledger_index": 8,
    "source_account": "rEhxGqkqPPSxQ3P25J66ft5TwpzV14k2de",
    "validated": true
  },
  "status": "success",
  "type": "response"
}

このレスポンスは標準フォーマットに従っており、正常に完了した場合は結果に次のフィールドが含まれます。

フィールド型必須?説明
credentialsハッシュの配列Noリクエストに指定されている資格情報のセット。
deposit_authorized真偽値Yes指定の支払元アカウントが指定の支払先アカウントへの直接送金を承認されているかどうか。trueの場合、支払先アカウントでDeposit Authorizationを必要としていないか、または支払元アカウントが事前承認されています。
destination_account文字列 - アドレスYesリクエストに指定されている宛先アカウント。
ledger_hash文字列Noこのレスポンスの生成に使用されたレジャーの識別用ハッシュ。
ledger_index数値 - レジャーインデックスNoこのレスポンスの生成に使用されたレジャーバージョンのレジャーインデックス。
ledger_current_index数値 - レジャーインデックスNoこのレスポンスの生成に使用された現在処理中のレジャーバージョンのレジャーインデックス。
source_account文字列 - アドレスYesリクエストに指定されている支払元アカウント。
validated真偽値No検証済みレジャーバージョンからの情報が取り込まれます。
注記

deposit_authorizedステータスがtrueでも、指定の支払元から指定の支払先への送金が可能であるとは保証されません。たとえば、支払先アカウントに指定通貨のトラストラインがない場合や、送金に十分な流動性がない場合があります。

考えられるエラー

  • いずれかの汎用エラータイプ。
  • invalidParams - 1つ以上のフィールドの指定が正しくないか、1つ以上の必須フィールドが指定されていません。
  • actMalformed - リクエストのsource_accountフィールドまたはdestination_accountフィールドに指定されているアドレスのフォーマットが適切ではありません。（入力ミスが含まれていたり、長さが正しくない場合は、チェックサムは失敗します。）
  • badCredentials - 提供された資格情報の少なくとも1つが存在しない、期限切れである、または受け入れられていません。
  • dstActNotFound - リクエストのdestination_accountフィールドがレジャーのアカウントに対応していません。
  • lgrNotFound - ledger_hashまたはledger_indexで指定したレジャーが存在しないか、存在してはいるもののサーバが保有していません。
  • srcActNotFound - リクエストのsource_accountフィールドがレジャーのアカウントに対応していません。
前のページ
次のページ