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
  • Index
  • Enumeration members
  • Enumeration members
  • InsufficientBalance
  • InsufficientPortfolioBalance
  • InvalidGranularity
  • InvalidReceiverCdd
  • InvalidReceiverPortfolio
  • InvalidSenderCdd
  • InvalidSenderPortfolio
  • ScopeClaimMissing
  • SelfTransfer
  • TransfersFrozen

Was this helpful?

  1. Enums

TransferError

Akin to TransferStatus, these are a bit more granular and specific. Every TransferError translates to a TransferStatus, but two or more TransferErrors can represent the same TransferStatus, and not all Transfer Statuses are represented by a TransferError

Index

Enumeration members

  • InsufficientBalance

  • InsufficientPortfolioBalance

  • InvalidGranularity

  • InvalidReceiverCdd

  • InvalidReceiverPortfolio

  • InvalidSenderCdd

  • InvalidSenderPortfolio

  • ScopeClaimMissing

  • SelfTransfer

  • TransfersFrozen

Enumeration members

InsufficientBalance

• InsufficientBalance: = "InsufficientBalance"

Defined in src/types/index.ts:530

translates to TransferStatus.InsufficientBalance

occurs if the sender Identity does not have enough balance to cover the amount

InsufficientPortfolioBalance

• InsufficientPortfolioBalance: = "InsufficientPortfolioBalance"

Defined in src/types/index.ts:554

translates to TransferStatus.PortfolioFailure

occurs if the sender Portfolio does not have enough balance to cover the amount

InvalidGranularity

• InvalidGranularity: = "InvalidGranularity"

Defined in src/types/index.ts:499

translates to TransferStatus.InvalidGranularity

occurs if attempting to transfer decimal amounts of a non-divisible token

InvalidReceiverCdd

• InvalidReceiverCdd: = "InvalidReceiverCdd"

Defined in src/types/index.ts:511

translates to TransferStatus.InvalidReceiverIdentity

occurs if the receiver Identity doesn't have a valid CDD claim

InvalidReceiverPortfolio

• InvalidReceiverPortfolio: = "InvalidReceiverPortfolio"

Defined in src/types/index.ts:548

translates to TransferStatus.PortfolioFailure

occurs if the receiver Portfolio doesn't exist

InvalidSenderCdd

• InvalidSenderCdd: = "InvalidSenderCdd"

Defined in src/types/index.ts:517

translates to TransferStatus.InvalidSenderIdentity

occurs if the receiver Identity doesn't have a valid CDD claim

InvalidSenderPortfolio

• InvalidSenderPortfolio: = "InvalidSenderPortfolio"

Defined in src/types/index.ts:542

translates to TransferStatus.PortfolioFailure

occurs if the sender Portfolio doesn't exist

ScopeClaimMissing

• ScopeClaimMissing: = "ScopeClaimMissing"

Defined in src/types/index.ts:524

translates to TransferStatus.ScopeClaimMissing

occurs if one of the participants doesn't have a valid Investor Uniqueness Claim for the Security Token

SelfTransfer

• SelfTransfer: = "SelfTransfer"

Defined in src/types/index.ts:505

translates to TransferStatus.InvalidReceiverIdentity

occurs if the origin and destination Identities are the same

TransfersFrozen

• TransfersFrozen: = "TransfersFrozen"

Defined in src/types/index.ts:536

translates to TransferStatus.TransfersHalted

occurs if the Security Token's transfers are frozen

PreviousTransactionStatusNextTransferRestrictionType

Last updated 4 years ago

Was this helpful?