Skip to main content

Monetary System API

Endpoints for the Shamwari Monetary System (MS) for creating, managing, and transacting currencies. All endpoints use port 22024 by default.

Currency Creation & Administration

EndpointDescriptionMethod
IssueCurrencyIssue new currencyPOST
DeleteCurrencyDelete currencyPOST
CanDeleteCurrencyCheck deletion eligibilityGET
AdjustCurrencyLimitsAdjust transaction/daily limitsPOST

Currency Queries

EndpointDescriptionMethod
GetCurrencyGet currency detailsGET
GetCurrenciesGet multiple currenciesGET
GetAllCurrenciesGet all currenciesGET
GetCurrenciesByIssuerGet currencies by issuerGET
GetCurrencyIdsGet all currency IDsGET
GetCurrencyAccountsGet currency accountsGET
GetAccountCurrencyCountGet account currency countGET

Currency Transfers & Payments

EndpointDescriptionMethod
TransferCurrencyTransfer currencyPOST
CurrencyPaymentMake currency paymentPOST
CurrencyBulkPaymentBulk currency paymentPOST
GetCurrencyTransfersGet currency transfersGET
GetCurrencyPaymentsGet currency paymentsGET
GetCurrencyBulkPaymentsGet bulk paymentsGET
GetExpectedCurrencyTransfersGet expected transfersGET
GetExpectedCurrencyPaymentsGet expected paymentsGET

Currency Exchange & Trading

EndpointDescriptionMethod
CurrencyBuyBuy currencyPOST
CurrencySellSell currencyPOST
CurrencyMintMint new unitsPOST
PublishExchangeOfferPublish exchange offerPOST
GetBuyOffersGet buy offersGET
GetSellOffersGet sell offersGET
GetAvailableToBuyGet available to buyGET
GetAvailableToSellGet available to sellGET
GetExchangesGet exchangesGET
GetAllExchangesGet all exchangesGET
GetExchangesByOfferGet exchanges by offerGET
GetExchangesByExchangeRequestGet by exchange requestGET
GetLastExchangesGet last exchangesGET
GetExpectedExchangeRequestsGet expected exchange requestsGET
GetAccountExchangeRequestsGet account exchange requestsGET

Savings & Vaults

EndpointDescriptionMethod
CurrencySavingsSet savings planPOST
CurrencyVaultLock currency in vaultPOST
GetAccountCurrencySavingsGet savings plansGET
GetAccountCurrencyVaultsGet vaultsGET

Lending & Loans

EndpointDescriptionMethod
LendCurrencyLend currencyPOST
LoanApplicationApply for loanPOST
LoanRepaymentRepay loanPOST
RescueLoanRescue loanPOST
GetLoanGet loan detailsGET
GetLoanApplicationsGet loan applicationsGET
GetActiveLoansGet active loansGET
GetPaidLoansGet paid loansGET
GetOverdueLoansGet overdue loansGET
GetAccountCurrencyLoansGet account loansGET

Phasing & Taxes

EndpointDescriptionMethod
GetCurrencyPhasedTransactionsGet phased transactionsGET
GetCurrencyTaxRecordsGet tax recordsGET

Base Configuration

ConfigurationValue
Default Port22024
SSL Port22024
API Endpoint/nxt
Testnet Port23023

Response Models

All currency endpoints return responses conforming to the JSONData models defined in JSONData.java:

  • JSONData.currency() — Full currency details with supply, type, and issuer info
  • JSONData.accountCurrency() — Account-currency holding relationships
  • JSONData.currencyTransfer() — Currency transfer records with tax info
  • JSONData.currencyPayment() — Currency payment records
  • JSONData.currencyBulkPayment() — Bulk payment records
  • JSONData.loan() — Loan details with lender information
  • JSONData.currencyLending() — Lending records
  • JSONData.loanRepayment() — Repayment records
  • JSONData.currencyTaxRecord() — Tax records
  • JSONData.availableOffers() — Exchange offer availability
  • JSONData.exchange() — Exchange execution records
  • JSONData.exchangeRequest() — Exchange request records
  • JSONData.accountCurrencySavings() — Savings plan details
  • JSONData.accountCurrencyVault() — Vault lock details
  • JSONData.accountCurrencyLoan() — Account loan details

Tags

MS, ACCOUNTS, CREATE_TRANSACTION, PHASING, LOANS, PAYMENTS, SUBSCRIPTIONS