Type alias Payment

Payment: {
    amount: Amount;
    assetAccountId: EntityId;
    assetSymbol: AssetSymbol;
    blockHeight?: number;
    dateBroadcasted?: IsoDatetime;
    dateConfirmed?: IsoDatetime;
    dateCreated: IsoDatetime;
    dateExecuted?: IsoDatetime;
    dateFirstConfirmed?: IsoDatetime;
    dateSettled?: IsoDatetime;
    dateUpdated: IsoDatetime;
    direction: PaymentDirection;
    externalId?: string;
    fee?: Amount;
    id: EntityId;
    initiator: Initiator;
    narrative?: string;
    note?: string;
    orgId: EntityId;
    policyCertificate?: DfnsCertificate;
    receiver: PaymentInstrument;
    receiverAddress: string;
    sender: PaymentInstrument;
    status: PaymentStatus;
    tags?: Tag[];
    txHash?: string;
}

Type declaration

  • amount: Amount
  • assetAccountId: EntityId
  • assetSymbol: AssetSymbol
  • Optional blockHeight?: number
  • Optional dateBroadcasted?: IsoDatetime
  • Optional dateConfirmed?: IsoDatetime
  • dateCreated: IsoDatetime
  • Optional dateExecuted?: IsoDatetime
  • Optional dateFirstConfirmed?: IsoDatetime
  • Optional dateSettled?: IsoDatetime
  • dateUpdated: IsoDatetime
  • direction: PaymentDirection
  • Optional externalId?: string

    Field can be used if entity is created in external (customer’s) system first. This way the external id can be attached to identify entity from Dfns’s data store.

  • Optional fee?: Amount
  • id: EntityId
  • initiator: Initiator
  • Optional narrative?: string

    SWIFT (MT, ISO15022) field. Represents additional information about payment.

  • Optional note?: string
  • orgId: EntityId

    Indicates id of the Organisation, such as usually a customer, or sub-devision, sub-tenant, and others.

  • Optional policyCertificate?: DfnsCertificate
  • receiver: PaymentInstrument
  • receiverAddress: string
  • sender: PaymentInstrument
  • status: PaymentStatus
  • Optional tags?: Tag[]

    Multiple tags can be attached to an entity to categorise or otherwise mark it. For example tags could indicate risk (High, Medium, Low), departments (Trading, Sales, IT), purpose (Treasury, Hot, Deposits), and jurisdictions (US, EU, DE).

    Multiple tags can be attached to same entity.

  • Optional txHash?: string

Settings

Member Visibility

Theme

Generated using TypeDoc