deposit_authorized

[ソース]

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

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

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

{
  "id": 1,
  "command": "deposit_authorized",
  "source_account": "rEhxGqkqPPSxQ3P25J66ft5TwpzV14k2de",
  "destination_account": "rsUiUMpnrgxQp24dJYZDhmV4bE3aBtQyt8",
  "ledger_index": "validated"
}

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

`Field`	型	説明
`source_account`	文字列 - アドレス	発生し得る支払の送金元。
`destination_account`	文字列 - アドレス	発生し得る支払の送金先。
`ledger_hash`	文字列	（省略可）使用するレジャーバージョンの32バイトの16進文字列。（レジャーの指定をご覧ください）
`ledger_index`	文字列または符号なし整数	（省略可）使用するレジャーのレジャーインデックス、またはレジャーを自動的に選択するためのショートカット文字列。（レジャーの指定をご覧ください）

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

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

{
  "id": 1,
  "result": {
    "deposit_authorized": true,
    "destination_account": "rsUiUMpnrgxQp24dJYZDhmV4bE3aBtQyt8",
    "ledger_hash": "BD03A10653ED9D77DCA859B7A735BF0580088A8F287FA2C5403E0A19C58EF322",
    "ledger_index": 8,
    "source_account": "rEhxGqkqPPSxQ3P25J66ft5TwpzV14k2de",
    "validated": true
  },
  "status": "success",
  "type": "response"
}

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

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

注記

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

考えられるエラー

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

deposit_authorized

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

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

考えられるエラー

参考になりましたか?