Options
All
  • Public
  • Public/Protected
  • All
Menu

Interface TransferDispatch

7.7 Transfer Dispatch

Message number: 310

Actor: Originator VASP

Message Purpose: Notifies the beneficiary VASP that a virtual asset transaction has been committed to the blockchain.

Hierarchy

Index

Properties

Properties

beneficiary

beneficiary: BeneficiaryInformation

Beneficiary

Optional comment

comment: undefined | string

Comment

msg

msg: { code: "1"; msgid: string; session: string; type: TransferDispatch }

Message

Type declaration

  • code: "1"

    Message code. Currently not used, fixed value ‘1’

  • msgid: string

    Message identifier. Randomly set. Hex(128 bit)

  • session: string

    Session identifier. As set in message 110. Hex(128 bit)

  • type: TransferDispatch

    Message type. Fixed Value 310

originator

originator: OriginatorInformation

Originator

sig

sig: string

Message signed with actor’s private signing key

transfer

transfer: { amount: BigInt; destination?: undefined | string; ttype: TransferType; va: VirtualAssetType }

Transfer

Type declaration

  • amount: BigInt

    Amount. 18 digits

  • Optional destination?: undefined | string

    Destination Address

  • ttype: TransferType

    Transfer type

  • va: VirtualAssetType

    Virtual asset type

tx

tx: { datetime: string; sendingadr?: undefined | string; txid?: undefined | string }

Transaction

Type declaration

  • datetime: string

    Transaction datetime. ISO 8601 (YYYY-MM-DDThh:mm:ssZ)

  • Optional sendingadr?: undefined | string

    Sending address. Blockchain-specific format, sending address used for transaction (non-UTXO systems)

  • Optional txid?: undefined | string

    Transaction identifier. Format specific to virtual asset / transfer type

vasp

vasp: VASPInformation

VASP information incl. public signing key

Generated using TypeDoc