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
| Endpoint | Description | Method |
|---|---|---|
| IssueCurrency | Issue new currency | POST |
| DeleteCurrency | Delete currency | POST |
| CanDeleteCurrency | Check deletion eligibility | GET |
| AdjustCurrencyLimits | Adjust transaction/daily limits | POST |
Currency Queries
| Endpoint | Description | Method |
|---|---|---|
| GetCurrency | Get currency details | GET |
| GetCurrencies | Get multiple currencies | GET |
| GetAllCurrencies | Get all currencies | GET |
| GetCurrenciesByIssuer | Get currencies by issuer | GET |
| GetCurrencyIds | Get all currency IDs | GET |
| GetCurrencyAccounts | Get currency accounts | GET |
| GetAccountCurrencyCount | Get account currency count | GET |
Currency Transfers & Payments
| Endpoint | Description | Method |
|---|---|---|
| TransferCurrency | Transfer currency | POST |
| CurrencyPayment | Make currency payment | POST |
| CurrencyBulkPayment | Bulk currency payment | POST |
| GetCurrencyTransfers | Get currency transfers | GET |
| GetCurrencyPayments | Get currency payments | GET |
| GetCurrencyBulkPayments | Get bulk payments | GET |
| GetExpectedCurrencyTransfers | Get expected transfers | GET |
| GetExpectedCurrencyPayments | Get expected payments | GET |
Currency Exchange & Trading
| Endpoint | Description | Method |
|---|---|---|
| CurrencyBuy | Buy currency | POST |
| CurrencySell | Sell currency | POST |
| CurrencyMint | Mint new units | POST |
| PublishExchangeOffer | Publish exchange offer | POST |
| GetBuyOffers | Get buy offers | GET |
| GetSellOffers | Get sell offers | GET |
| GetAvailableToBuy | Get available to buy | GET |
| GetAvailableToSell | Get available to sell | GET |
| GetExchanges | Get exchanges | GET |
| GetAllExchanges | Get all exchanges | GET |
| GetExchangesByOffer | Get exchanges by offer | GET |
| GetExchangesByExchangeRequest | Get by exchange request | GET |
| GetLastExchanges | Get last exchanges | GET |
| GetExpectedExchangeRequests | Get expected exchange requests | GET |
| GetAccountExchangeRequests | Get account exchange requests | GET |
Savings & Vaults
| Endpoint | Description | Method |
|---|---|---|
| CurrencySavings | Set savings plan | POST |
| CurrencyVault | Lock currency in vault | POST |
| GetAccountCurrencySavings | Get savings plans | GET |
| GetAccountCurrencyVaults | Get vaults | GET |
Lending & Loans
| Endpoint | Description | Method |
|---|---|---|
| LendCurrency | Lend currency | POST |
| LoanApplication | Apply for loan | POST |
| LoanRepayment | Repay loan | POST |
| RescueLoan | Rescue loan | POST |
| GetLoan | Get loan details | GET |
| GetLoanApplications | Get loan applications | GET |
| GetActiveLoans | Get active loans | GET |
| GetPaidLoans | Get paid loans | GET |
| GetOverdueLoans | Get overdue loans | GET |
| GetAccountCurrencyLoans | Get account loans | GET |
Phasing & Taxes
| Endpoint | Description | Method |
|---|---|---|
| GetCurrencyPhasedTransactions | Get phased transactions | GET |
| GetCurrencyTaxRecords | Get tax records | GET |
Base Configuration
| Configuration | Value |
|---|---|
| Default Port | 22024 |
| SSL Port | 22024 |
| API Endpoint | /nxt |
| Testnet Port | 23023 |
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 infoJSONData.accountCurrency()— Account-currency holding relationshipsJSONData.currencyTransfer()— Currency transfer records with tax infoJSONData.currencyPayment()— Currency payment recordsJSONData.currencyBulkPayment()— Bulk payment recordsJSONData.loan()— Loan details with lender informationJSONData.currencyLending()— Lending recordsJSONData.loanRepayment()— Repayment recordsJSONData.currencyTaxRecord()— Tax recordsJSONData.availableOffers()— Exchange offer availabilityJSONData.exchange()— Exchange execution recordsJSONData.exchangeRequest()— Exchange request recordsJSONData.accountCurrencySavings()— Savings plan detailsJSONData.accountCurrencyVault()— Vault lock detailsJSONData.accountCurrencyLoan()— Account loan details
Tags
MS, ACCOUNTS, CREATE_TRANSACTION, PHASING, LOANS, PAYMENTS, SUBSCRIPTIONS