Interface DepositAuthorizedResponse

Expected response from a DepositAuthorizedRequest.

interface DepositAuthorizedResponse {
    api_version?: number;
    forwarded?: boolean;
    id: string | number;
    result: {
        credentials?: string[];
        deposit_authorized: boolean;
        destination_account: string;
        ledger_current_index?: number;
        ledger_hash?: string;
        ledger_index?: number;
        source_account: string;
        validated?: boolean;
    };
    status?: string;
    type: string;
    warning?: "load";
    warnings?: ResponseWarning[];
}

Hierarchy (View Summary)

Properties

api_version? forwarded? id result status? type warning? warnings?

Properties

Optionalapi_version

api_version?: number

Optionalforwarded

forwarded?: boolean

id

id: string | number

result

result: {
    credentials?: string[];
    deposit_authorized: boolean;
    destination_account: string;
    ledger_current_index?: number;
    ledger_hash?: string;
    ledger_index?: number;
    source_account: string;
    validated?: boolean;
}

Type declaration

  • Optionalcredentials?: 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.

  • deposit_authorized: boolean

    Whether the specified source account is authorized to send payments directly to the destination account. If true, either the destination account does not require Deposit Authorization or the source account is preauthorized.

  • destination_account: string

    The destination account specified in the request.

  • Optionalledger_current_index?: number

    The ledger index of the current in-progress ledger version, which was used to generate this response.

  • Optionalledger_hash?: string

    The identifying hash of the ledger that was used to generate this Response.

  • Optionalledger_index?: number

    The ledger index of the ledger version that was used to generate this Response.

  • source_account: string

    The source account specified in the request.

  • Optionalvalidated?: boolean

    If true, the information comes from a validated ledger version.

Optionalstatus

status?: string

type

type: string

Optionalwarning

warning?: "load"

Optionalwarnings

warnings?: ResponseWarning[]

Settings

Member Visibility

On This Page

Properties