Skip to content

distributions-api

Endpoints for Distributions


Exceptions list



Exceptions - Distribution

httpStatus See here name message
400 DISTRIBUTION_TYPE_ERROR Distribution should be $typeRequired type
400 DISTRIBUTION_CYCLE_ERROR Distribution cylcle should be one of $cycles
400 REDEMPTION_ALREADY_EXISTS Redemption already exists at that date range $startDate - $endDate
400 INVALID_REDEMPTION_WALLET Redemption wallet is invalid. Please check the wallet and try again
400 DISTRIBUTION_STATUS_ERROR Distribution status should be $statusRequired
400 DISTRIBUTION_DELETE_STATUS_ERROR Distribution id $distributionId is in $status so shouldn't be closed
400 DISTRIBUTION_DONT_SUPPORT_CASH_ACCOUNT Distribution don't support Cash Account
400 DISTRIBUTION_DELETE_TYPE_ERROR Distribution type $requiredType can't be deleted
400 DISTRIBUTION_NOT_POPULATED Distribution status should be ready to confirm
400 EVERGREEN_NOT_WAITING_REDEMPTIONS Evergree status should be waiting redemptions
400 DISTRIBUTION_CONFIRMED Can't edit investors when distribution is $status
400 DISTRIBUTION_PROCESSING Can't edit investors when distribution is $status
400 ISSUER_SEC_ID_REQUIRED issuerSecId is required
400 ISSUER_REDEMPTION_WALLET_NOT_FOUND Issuer doesn't have redemption wallet
400 INVESTOR_PAID_STATUS_ERROR Investor paid status can not be $status
400 INVESTOR_UPDATE_PAYMENT_METHOD_ERROR Investor payment method should be changed to cash-account,bank-transfer, check,reinvest,other
400 INVESTOR_UPDATE_INVALID_BANK_TRANSFER Investor payment method bank transfer is invalid
400 PAYOUT_INVESTOR_STATUS_ERROR Investor payout is not pending
400 AUTHORIZED_SECURITIES_EXCEEDED Authorized securities exceeded
404 DISTRIBUTION_NOT_FOUND Distribution ($distributionId) not found
404 DISTRIBUTION_EMPTY_ERROR Distribution is empty
404 ISSUER_NOT_FOUND Issuer Id ($issuerId) not found
404 ISSUER_CURRENCY_NOT_FOUND Issuer Id ($issuerId) currencies not found
404 ISSUER_SEC_ID_ERROR Issuer SecuritizeId ($issuerSecId) not have created CashAccount
404 INVESTOR_NOT_FOUND Investor ($distributionInvestorId) not found
404 INVESTOR_SEC_ID_NOT_FOUND Investor SecId not found
404 INVESTOR_CP_ID_NOT_FOUND Investor ControlPanelId not found
404 GET_SNAPSHOT_RECORDS_ERROR The SnapshotId ($snapshotId) was not found
404 GET_SNAPSHOT_ERROR The SnapshotId ($snapshotId) was not found
404 SNAPSHOT_EMPTY_ERROR The SnapshotId ($snapshotId) is empty
404 SUPER_SHEET_NOT_FOUND Supersheet ($id) not found
406 START_DATE_REQUIRED Start date is required
406 END_DATE_REQUIRED End date is required
406 END_DATE_MUST_BE_GREATER_THAN_OR_EQUAL_TO_TODAY End date should be greater or equal than start date
406 START_DATE_MUST_BE_GREATER_THAN_OR_EQUAL_TO_TODAY Start date should be greater or equal than today
406 DISTRIBUTION_START_DATE_INTEREST_NOT_ABLE_ERROR Distribution start date should be later than today and before 3 PM tomorrow, New York time.
500 ISSUER_DEPLOYMENT_SERVICE_UNREACHED Deployment service is unavailable or has an error. Try again later
500 PAYOUT_FREEZE_ERROR Issuer have insufficient funds or unable to transfer
500 INSUFFICIENT_FUNDS_ERROR Issuer have insufficient funds. At least $fundsNeeded more are needed
500 NO_USD_BALANCE Issuer do not have USD balance funds. $fundsNeeded are needed
500 PAYOUT_TRANSFER_ERROR Error to transfer payout
500 PAYOUT_TRANSFER_ERROR Investor payout amount is zero
500 GET_TOKEN_ERROR Error getting tokens data
500 GET_TOKEN_NOT_FOUND_ERROR The TokenId ($tokenId) was not found
500 TOKENS_TO_ISSUE_ERROR Issuer have insufficient tokens or unable to issue
500 BULK_ISSUANCE_ERROR Error Calling bulk issuance service
500 GET_NAV_PRICE_ERROR Error getting token nav price for period: $period
500 NOT_STOPPABLE This distribution $requiredType type can't be stopped



Exceptions - DistributionCsv

httpStatus See here name message
400 DISTRIBUTION_START_CSV_VALIDATION_STATUS_ERROR Distribution status should be populated
400 DISTRIBUTION_START_CSV_VALIDATION_TYPE_ERROR Distribution type should be redemption
400 EVERGREEN_START_CSV_VALIDATION_STATUS_ERROR Distribution status should be waiting redemptions
400 DISTRIBUTION_CSV_VALIDATION_MISSING_REQUIRED_HEADER Missing required header
400 DISTRIBUTION_CSV_VALIDATION_EMPTY Csv file should not be empty
400 DISTRIBUTION_CSV_VALIDATION_CAN_NOT_REMOVE_ALL Cannot remove all holders of a distribution.
400 AWS_FILE_NOT_FOUND Uploaded file was not found
404 DISTRIBUTION_NOT_FOUND Distribution Id not found
404 INVESTOR_CP_ID_NOT_FOUND Investor ControlPanelId not found
500 DISTRIBUTION_START_CSV_VALIDATION_ERROR Internal server error at start csv validation process
500 DISTRIBUTION_CSV_VALIDATION_INVALID_TOKENS_NUMBER Tokens must be a valid number
500 DISTRIBUTION_CSV_VALIDATION_INVALID_CONTROL_PANEL_ID Tokens must be a control panel id
500 DISTRIBUTION_CSV_VALIDATION_INVALID_TOKENS_AMOUNT Sum of give back and redeem tokens must be equal than investor holding tokens
500 DISTRIBUTION_CSV_VALIDATION_INVALID_PAYOUT_METHOD Payout method is invalid
500 DISTRIBUTION_CSV_VALIDATION_INVALID_CP_ID Control panel profile ID should be a valid integer
500 DISTRIBUTION_CSV_VALIDATION_SAVE_ERROR Error at saving distribution updated by csv. Data could be corrupted.
500 AWS_UPLOAD_ERROR AWS_UPLOAD_ERROR
500 AWS_PRESIGNED_GET_ERROR AWS_PRESIGNED_GET_ERROR
500 CSV_MAKEBUFFER_ERROR CSV_MAKEBUFFER_ERROR

Endpoints (26)

Method Path Summary Tags
GET /health No description Health
POST /api/v2/distributions Create a distribution Distribution
GET /api/v2/distributions Get distributions list Distribution
PUT /api/v2/distributions/{id} Edit a distribution by id Distribution
GET /api/v2/distributions/{id} Get a distribution Distribution
DELETE /api/v2/distributions/{id} Delete a distribution Distribution
GET /api/v2/distributions/{id}/pending-payouts Get distribution pending payout amounts grouped by payout method Distribution
GET /api/v2/distributions/{id}/investors Get investor list by distribution id Distribution
GET /api/v2/distributions/{id}/investors/yields Get investor with yields list by distribution id Distribution
GET /api/v2/distributions/{id}/invalid-investors Get investors with invalid reinvest wallets Distribution
POST /api/v2/distributions/{id}/confirm Confirm and pay distribution Distribution
PATCH /api/v2/distributions/{id}/stop stop distribution - redemption evergreen Distribution
GET /api/v2/distributions/issuers/{id}/info Return info from issuer Distribution
GET /api/v2/distributions/investors/{id} Get distributions by investor id Distribution
PATCH /api/v2/distributions/investors/{id} Update investor by investor id Distribution
GET /api/v2/distributions/{distributionId}/investors/{investorId} Get investor dto by distribution and investor id Distribution
GET /api/v2/distributions/redemptions/custom-wallets Get all redemption custom wallets Distribution
GET /api/v2/investors/{investorId}/history Get a distributions history by investor Distribution Investor
GET /api/v2/distributions/distribution-calendar/holidays Return holidays Distribution Calendar
GET /api/v2/distributions/{id}/download Return distribution csv presigned url Distribution Csv
POST /api/v2/distributions/{id}/upload/confirm Confirm and update distribution by csv Distribution Csv
GET /api/v2/distributions/{id}/upload Return distribution csv upload presigned url Distribution Csv
GET /api/v2/investors/{investorId}/yields/tokens Get tokens & validate wether an investor have yields to download Distribution, Investors, CSV
GET /api/v2/investors/{investorId}/yields/download Return yields csv presigned url filter by tokens Distribution, Investors, CSV
GET /api/v1/funds/summary Get fund summary Accrued Dividend Funds
GET /api/v1/funds/payout-rates/average Get average payout rates by tokens Accrued Dividend Funds