Interface DepositAuthorizedRequest

The deposit_authorized command indicates whether one account is authorized to send payments directly to another. Expects a response in the form of a DepositAuthorizedResponse.

interface DepositAuthorizedRequest {
    api_version?: number;
    command: "deposit_authorized";
    credentials?: string[];
    destination_account: string;
    id?: string | number;
    ledger_hash?: string;
    ledger_index?: LedgerIndex;
    source_account: string;
    [x: string]: unknown;
}

Hierarchy (View Summary)

  • BaseRequest
  • LookupByLedgerRequest
    • DepositAuthorizedRequest

Indexable

  • [x: string]: unknown

Properties

api_version? command credentials? destination_account id? ledger_hash? ledger_index? source_account

Properties

Optionalapi_version

api_version?: number

The API version to use. If omitted, use version 1.

command

command: "deposit_authorized"

The name of the API method.

Optionalcredentials

credentials?: string[]

The object IDs of Credential objects. If this field is included, then the credential will be taken into account when analyzing whether the sender can send funds to the destination.

destination_account

destination_account: string

The recipient of a possible payment.

Optionalid

id?: string | number

A unique value to identify this request. The response to this request uses the same id field. This way, even if responses arrive out of order, you know which request prompted which response.

Optionalledger_hash

ledger_hash?: string

A 20-byte hex string for the ledger version to use.

Optionalledger_index

ledger_index?: LedgerIndex

The ledger index of the ledger to use, or a shortcut string.

source_account

source_account: string

The sender of a possible payment.

Settings

Member Visibility

On This Page

Properties