Polymesh SDK API Reference
v6.0.0
v6.0.0
  • Introduction
  • Globals
  • Classes
    • Account
    • AuthorizationRequest
    • Authorizations
    • Checkpoint
    • CheckpointSchedule
    • Checkpoints
    • Claims
    • Compliance
    • Context
    • CorporateAction
    • CorporateActions
    • Count
    • CurrentAccount
    • CurrentIdentity
    • DefaultPortfolio
    • DefaultTrustedClaimIssuer
    • Distributions
    • DividendDistribution
    • Documents
    • Entity
    • Identity
    • IdentityAuthorizations
    • Instruction
    • Issuance
    • Middleware
    • NumberedPortfolio
    • Offerings
    • Percentage
    • Polymesh
    • PolymeshError
    • PolymeshTransaction
    • PolymeshTransactionBase
    • PolymeshTransactionBatch
    • Portfolio
    • Portfolios
    • Requirements
    • Schedules
    • SecurityToken
    • Settlements
    • Sto
    • TickerReservation
    • TokenHolders
    • TransactionQueue
    • TransferRestrictionBase
    • TransferRestrictions
    • TrustedClaimIssuers
    • Venue
  • Enums
    • AffirmationStatus
    • AuthorizationType
    • CalendarUnit
    • ClaimType
    • ConditionTarget
    • ConditionType
    • CorporateActionKind
    • CountryCode
    • ErrorCode
    • InstructionStatus
    • InstructionType
    • KnownTokenType
    • ProposalStage
    • RoleType
    • ScopeType
    • StoBalanceStatus
    • StoSaleStatus
    • StoTimingStatus
    • TargetTreatment
    • TickerReservationStatus
    • TokenIdentifierType
    • TransactionArgumentType
    • TransactionQueueStatus
    • TransactionStatus
    • TransferError
    • TransferRestrictionType
    • TransferStatus
    • TxGroup
    • VenueType
  • Interfaces
    • AccountData
    • ActiveTransferRestrictions
    • AddBatchTransactionOpts
    • AddClaimsParams
    • AddInstructionParams
    • AddInstructionsParams
    • AddInvestorUniquenessClaimParams
    • AddTransactionOpts
    • AddTransactionOptsBase
    • ArrayTransactionArgument
    • Balance
    • CalendarPeriod
    • CddProviderRole
    • CheckpointWithData
    • ClaimClassicTickerParams
    • ClaimData
    • ClaimScope
    • ClaimTarget
    • ComplexTransactionArgument
    • ConditionCompliance
    • ConnectParamsBase
    • ConstructorParams
    • ConsumeParams
    • ControllerTransferParams
    • CorporateActionDefaults
    • CorporateActionTargets
    • CountTransferRestriction
    • CountTransferRestrictionInput
    • CreateCheckpointScheduleParams
    • CreateSecurityTokenParams
    • CreateVenueParams
    • DeletePortfolioParams
    • DistributionParticipant
    • DistributionPayment
    • DistributionWithDetails
    • DividendDistributionDetails
    • DividendDistributionParams
    • EditClaimsParams
    • EventIdentifier
    • ExtrinsicData
    • Fees
    • HistoricSettlement
    • IdentityBalance
    • IdentityWithClaims
    • InstructionAffirmation
    • InvestInStoParams
    • Investment
    • InviteAccountParams
    • IssueTokensParams
    • KeyringPair
    • LeaveIdentityParams
    • Leg
    • LinkCaDocsParams
    • MiddlewareConfig
    • ModifyCorporateActionsAgentParams
    • ModifyInstructionAffirmationParams
    • ModifyPrimaryIssuanceAgentParams
    • ModifySignerPermissionsParams
    • ModifyTokenTrustedClaimIssuersAddSetParams
    • ModifyTokenTrustedClaimIssuersRemoveParams
    • MoveFundsParams
    • NetworkProperties
    • PaginationOptions
    • PayDividendsParams
    • PercentageTransferRestriction
    • PercentageTransferRestrictionInput
    • Permissions
    • PermissionsLike
    • PlainTransactionArgument
    • PortfolioBalance
    • PortfolioCustodianRole
    • PortfolioMovement
    • ProcedureAuthorizationStatus
    • ProcedureMethod
    • ProposalDetails
    • ProposalTimeFrames
    • ProposalVote
    • RedeemTokenParams
    • RegisterIdentityParams
    • RemoveCheckpointScheduleParams
    • RemoveCorporateActionParams
    • RemoveSecondaryKeysParams
    • RenamePortfolioParams
    • Requirement
    • RequirementCompliance
    • ReserveTickerParams
    • ResultSet
    • RevokeClaimsParams
    • ScheduleDetails
    • ScheduleWithDetails
    • Scope
    • SecondaryKey
    • SecurityTokenDetails
    • SetAssetRequirementsParams
    • SetCountTransferRestrictionsParams
    • SetCustodianParams
    • SetPercentageTransferRestrictionsParams
    • SetTokenDocumentsParams
    • SettlementLeg
    • SimpleEnumTransactionArgument
    • StoDetails
    • StoStatus
    • StoTier
    • StoWithDetails
    • TaxWithholding
    • TickerOwnerRole
    • TickerReservationDetails
    • Tier
    • ToggleFreezeSecondaryKeysParams
    • ToggleFreezeStoParams
    • ToggleFreezeTransfersParams
    • TogglePauseRequirementsParams
    • TokenCaaRole
    • TokenDocument
    • TokenIdentifier
    • TokenOwnerRole
    • TokenPiaRole
    • TransferBreakdown
    • TransferPolyxParams
    • TransferRestriction
    • TransferRestrictionInputBase
    • TransferRestrictionResult
    • TransferTickerOwnershipParams
    • TransferTokenOwnershipParams
    • TrustedClaimIssuer
    • UiKeyring
    • UniqueIdentifiers
    • VenueDetails
    • VenueOwnerRole
Powered by GitBook
On this page
  • Hierarchy
  • Index
  • Properties
  • Methods
  • Properties
  • Protected context
  • currency
  • declarationDate
  • defaultTaxWithholding
  • description
  • expiryDate
  • id
  • Protected kind
  • maxAmount
  • origin
  • paymentDate
  • perShare
  • targets
  • taxWithholdings
  • ticker
  • uuid
  • Methods
  • checkpoint
  • claim
  • details
  • exists
  • getParticipant
  • getParticipants
  • getPaymentHistory
  • getWithheldTax
  • isEqual
  • linkDocuments
  • modifyCheckpoint
  • pay
  • reclaimFunds
  • Static generateUuid
  • Static unserialize

Was this helpful?

  1. Classes

DividendDistribution

PreviousDistributionsNextDocuments

Last updated 3 years ago

Was this helpful?

Represents a Corporate Action via which a Security Token issuer wishes to distribute dividends between a subset of the Tokenholders (targets)

Hierarchy

↳

↳ DividendDistribution

Index

Properties

Methods

Properties

Protected context

currency

• currency: string

ticker of the currency in which dividends are being distibuted

declarationDate

• declarationDate: Date

date at which the Corporate Action was created

defaultTaxWithholding

• defaultTaxWithholding: BigNumber

default percentage of tax withholding for this Corporate Action

description

• description: string

brief text description of the Corporate Action

expiryDate

• expiryDate: null | Date

date after which dividends can no longer be paid/reclaimed. A null value means the distribution never expires

id

• id: BigNumber

internal Corporate Action ID

Protected kind

maxAmount

• maxAmount: BigNumber

maximum amount of currency to be distributed. Distributions are "first come, first served", so funds can be depleted before every Tokenholder receives their corresponding amount

origin

Portfolio from which the dividends will be distributed

paymentDate

• paymentDate: Date

date starting from which dividends can be paid/reclaimed

perShare

• perShare: BigNumber

amount of currency to pay for each share the Tokenholder holds

targets

tokenholder identities related to this Corporate action. If the treatment is Exclude, the identities are not targeted by the Action, and any identities left out of the array will be targeted, and vice versa

taxWithholdings

percentage of tax withholding per Identity. Any Identity not present in this array uses the default tax withholding percentage

ticker

• ticker: string

ticker of the Security Token

uuid

• uuid: string

Methods

checkpoint

Retrieve the Checkpoint associated with this Dividend Distribution. If the Checkpoint is scheduled and has not been created yet, the corresponding CheckpointSchedule is returned instead

claim

Claim the dividends corresponding to the current Identity

Parameters:

Name

Type

args

void

details

Retrieve details associated with this Dividend Distribution

exists

▸ exists(): Promise‹boolean›

Retrieve whether the Distribution exists

Returns: Promise‹boolean›

getParticipant

Retrieve an Identity that is entitled to dividends in this Distribution (participant), the amount it is entitled to and whether it has been paid or not

note if the Distribution Checkpoint hasn't been created yet, the result will be null. This is because the Distribution participant's corresponding payment cannot be determined without a Checkpoint

Parameters:

Name

Type

args?

undefined | object

getParticipants

Retrieve a comprehensive list of all Identities that are entitled to dividends in this Distribution (participants), the amount they are entitled to and whether they have been paid or not

note this request can take a lot of time with large amounts of Tokenholders

note if the Distribution Checkpoint hasn't been created yet, the result will be an empty array. This is because the Distribution participants cannot be determined without a Checkpoint

getPaymentHistory

Retrieve the payment history for this Distribution

note uses the middleware

note supports pagination

Parameters:

â–ªDefault value opts: object= {}

Name

Type

size?

undefined | number

start?

undefined | number

getWithheldTax

▸ getWithheldTax(): Promise‹BigNumber›

Retrieve the amount of taxes that have been withheld up to this point in this Distribution

note uses the middleware

Returns: Promise‹BigNumber›

isEqual

Whether this Entity is the same as another one

Parameters:

Name

Type

entity

Returns: boolean

linkDocuments

Link a list of documents to this corporate action

note any previous links are removed in favor of the new list

note required role:

  • Corporate Actions Agent

Parameters:

Name

Type

args

modifyCheckpoint

Modify the Distribution's checkpoint

Parameters:

Name

Type

args

ModifyDistributionCheckpointParams

pay

Transfer the corresponding share of the dividends to a list of Identities

note due to performance issues, we do not validate that the distribution has enough remaining funds to pay the corresponding amount to the supplied Identities

Parameters:

Name

Type

args

reclaimFunds

Reclaim any remaining funds back to the origin Portfolio. This can only be done after the Distribution has expired

note withheld taxes are also reclaimed in the same transaction

note required roles:

  • Origin Portfolio Custodian

Parameters:

Name

Type

args

void

Static generateUuid

▸ generateUuid‹Identifiers›(identifiers: Identifiers): string

Generate the Entity's UUID from its identifying properties

Type parameters:

â–ª Identifiers

Parameters:

Name

Type

Description

identifiers

Identifiers

Returns: string

Static unserialize

▸ unserialize‹Identifiers›(serialized: string): Identifiers

Unserialize a UUID into its Unique Identifiers

Type parameters:

â–ª Identifiers

Parameters:

Name

Type

Description

serialized

string

UUID to unserialize

Returns: Identifiers

• context:

Inherited from .

Defined in

Defined in

Inherited from .

Defined in

Inherited from .

Defined in

Inherited from .

Defined in

Defined in

Inherited from .

Defined in

• kind:

Overrides .

Defined in

Defined in

• origin: |

Defined in

Defined in

Defined in

• targets:

Inherited from .

Defined in

• taxWithholdings: []

Inherited from .

Defined in

Inherited from .

Defined in

Inherited from .

Defined in

▸ checkpoint(): Promise‹ | ›

Overrides .

Defined in

Returns: Promise‹ | ›

▸ claim(args: void): Promise‹‹void››

Defined in

note this method is of type , which means you can call claim.checkAuthorization on it to see whether the Current Account has the required permissions to run it

Returns: Promise‹‹void››

▸ details(): Promise‹›

Defined in

Returns: Promise‹›

Overrides .

Defined in

▸ getParticipant(args?: undefined | object): Promise‹ | null›

Defined in

Returns: Promise‹ | null›

▸ getParticipants(): Promise‹[]›

Defined in

Returns: Promise‹[]›

▸ getPaymentHistory(opts: object): Promise‹‹››

Defined in

Returns: Promise‹‹››

Defined in

▸ isEqual(entity: ‹unknown›): boolean

Inherited from .

Defined in

‹unknown›

▸ linkDocuments(args: ): Promise‹‹void››

Inherited from .

Defined in

note this method is of type , which means you can call linkDocuments.checkAuthorization on it to see whether the Current Account has the required permissions to run it

Returns: Promise‹‹void››

▸ modifyCheckpoint(args: ModifyDistributionCheckpointParams): Promise‹‹void››

Overrides .

Defined in

note this method is of type , which means you can call modifyCheckpoint.checkAuthorization on it to see whether the Current Account has the required permissions to run it

Returns: Promise‹‹void››

▸ pay(args: ): Promise‹‹void››

Defined in

note this method is of type , which means you can call pay.checkAuthorization on it to see whether the Current Account has the required permissions to run it

Returns: Promise‹‹void››

▸ reclaimFunds(args: void): Promise‹‹void››

Defined in

note this method is of type , which means you can call reclaimFunds.checkAuthorization on it to see whether the Current Account has the required permissions to run it

Returns: Promise‹‹void››

Inherited from .

Defined in

Inherited from .

Defined in

Context
src/api/entities/Entity.ts:48
src/api/entities/DividendDistribution/index.ts:74
src/api/entities/CorporateAction/index.ts:70
src/api/entities/CorporateAction/index.ts:86
src/api/entities/CorporateAction/index.ts:75
src/api/entities/DividendDistribution/index.ts:90
src/api/entities/CorporateAction/index.ts:60
src/api/entities/DividendDistribution/index.ts:97
src/api/entities/DividendDistribution/index.ts:85
DefaultPortfolio
NumberedPortfolio
src/api/entities/DividendDistribution/index.ts:69
src/api/entities/DividendDistribution/index.ts:95
src/api/entities/DividendDistribution/index.ts:79
CorporateActionTargets
src/api/entities/CorporateAction/index.ts:81
TaxWithholding
src/api/entities/CorporateAction/index.ts:92
src/api/entities/CorporateAction/index.ts:65
src/api/entities/Entity.ts:46
Checkpoint
CheckpointSchedule
src/api/entities/DividendDistribution/index.ts:206
Checkpoint
CheckpointSchedule
TransactionQueue
src/api/entities/DividendDistribution/index.ts:161
ProcedureMethod
TransactionQueue
DividendDistributionDetails
src/api/entities/DividendDistribution/index.ts:225
DividendDistributionDetails
src/api/entities/DividendDistribution/index.ts:216
DistributionParticipant
src/api/entities/DividendDistribution/index.ts:311
DistributionParticipant
DistributionParticipant
src/api/entities/DividendDistribution/index.ts:251
DistributionParticipant
ResultSet
DistributionPayment
src/api/entities/DividendDistribution/index.ts:406
ResultSet
DistributionPayment
src/api/entities/DividendDistribution/index.ts:384
Entity
src/api/entities/Entity.ts:61
LinkCaDocsParams
TransactionQueue
src/api/entities/CorporateAction/index.ts:149
ProcedureMethod
TransactionQueue
TransactionQueue
src/api/entities/DividendDistribution/index.ts:171
ProcedureMethod
TransactionQueue
PayDividendsParams
TransactionQueue
src/api/entities/DividendDistribution/index.ts:183
ProcedureMethod
TransactionQueue
TransactionQueue
src/api/entities/DividendDistribution/index.ts:198
ProcedureMethod
TransactionQueue
src/api/entities/Entity.ts:14
src/api/entities/Entity.ts:23
CorporateAction
context
currency
declarationDate
defaultTaxWithholding
description
expiryDate
id
kind
maxAmount
origin
paymentDate
perShare
targets
taxWithholdings
ticker
uuid
checkpoint
claim
details
exists
getParticipant
getParticipants
getPaymentHistory
getWithheldTax
isEqual
linkDocuments
modifyCheckpoint
pay
reclaimFunds
generateUuid
unserialize
Entity
LinkCaDocsParams
PayDividendsParams
CheckpointSchedule
context
CheckpointSchedule
uuid
CheckpointSchedule
isEqual
CheckpointSchedule
generateUuid
CheckpointSchedule
unserialize
UnpredictableBenefit
CorporateAction
declarationDate
CorporateAction
defaultTaxWithholding
CorporateAction
description
CorporateAction
id
CorporateAction
kind
CorporateAction
targets
CorporateAction
taxWithholdings
CorporateAction
ticker
CorporateAction
checkpoint
CorporateAction
exists
CorporateAction
linkDocuments
CorporateAction
modifyCheckpoint