Options
All
  • Public
  • Public/Protected
  • All
Menu

Interface DepositAuthorizedResponse

Expected response from a DepositAuthorizedRequest.

Hierarchy

  • BaseResponse
    • DepositAuthorizedResponse

Index

Properties

api_version?: number
forwarded?: boolean
id: string | number
result: { deposit_authorized: boolean; destination_account: string; ledger_current_index?: number; ledger_hash?: string; ledger_index?: number; source_account: string; validated?: boolean }

Type declaration

  • 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.

  • Optional ledger_current_index?: number

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

  • Optional ledger_hash?: string

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

  • Optional ledger_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.

  • Optional validated?: boolean

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

status?: string
type: string
warning?: "load"
warnings?: Warning[]

Generated using TypeDoc