Wholesale CBDC Application Wrapper APIs

All REST Endpoints

Account Contract Endpoints

Activate Account: Method: post
Path: {baseUrl}/v1/{accountWithErc5982UupsContractAddress}/activateAccount
Add Organization Admin: Method: post
Path: {baseUrl}/v1/{accountWithErc5982UupsContractAddress}/addOrgAdmin
Add Organization Auditor: Method: post
Path: {baseUrl}/v1/{accountWithErc5982UupsContractAddress}/addOrgAuditor
Add Role: Method: post
Path: {baseUrl}/v1/{accountWithErc5982UupsContractAddress}/addRole
Add Token Admin: Method: post
Path: {baseUrl}/v1/{accountWithErc5982UupsContractAddress}/addTokenAdmin
Add Token Auditor: Method: post
Path: {baseUrl}/v1/{accountWithErc5982UupsContractAddress}/addTokenAuditor
Check Account Active: Method: get
Path: {baseUrl}/v1/{accountWithErc5982UupsContractAddress}/isActive
Check Account Deployment: Method: get
Path: {baseUrl}/v1/{accountWithErc5982UupsContractAddress}/isDeploymentActive
Check Account Role: Method: get
Path: {baseUrl}/v1/{accountWithErc5982UupsContractAddress}/isInRole
Check Organization Admin: Method: get
Path: {baseUrl}/v1/{accountWithErc5982UupsContractAddress}/isOrgAdmin
Check Organization Auditor: Method: get
Path: {baseUrl}/v1/{accountWithErc5982UupsContractAddress}/isOrgAuditor
Check Token Admin: Method: get
Path: {baseUrl}/v1/{accountWithErc5982UupsContractAddress}/isTokenAdmin
Check Token Auditor: Method: get
Path: {baseUrl}/v1/{accountWithErc5982UupsContractAddress}/isTokenAuditor
Create Account: Method: post
Path: {baseUrl}/v1/{accountWithErc5982UupsContractAddress}/createAccount
Delete Account: Method: post
Path: {baseUrl}/v1/{accountWithErc5982UupsContractAddress}/deleteAccount
Get Account by Address: Method: get
Path: {baseUrl}/v1/{accountWithErc5982UupsContractAddress}/getAccountByAddress
Get Account Governance Context: Method: get
Path: {baseUrl}/v1/{accountWithErc5982UupsContractAddress}/getGovernanceContext
Get Account Status: Method: get
Path: {baseUrl}/v1/{accountWithErc5982UupsContractAddress}/getAccountStatus
Get Account Version: Method: get
Path: {baseUrl}/v1/{accountWithErc5982UupsContractAddress}/version
Get Accounts: Method: get
Path: {baseUrl}/v1/{accountWithErc5982UupsContractAddress}/getAllAccounts
Get Context: Method: get
Path: {baseUrl}/v1/{accountWithErc5982UupsContractAddress}/getContext
Get Group ID: Method: get
Path: {baseUrl}/v1/{accountWithErc5982UupsContractAddress}/getGroupId
Get Identity: Method: get
Path: {baseUrl}/v1/{accountWithErc5982UupsContractAddress}/getIdentity
Get Organization Admins: Method: get
Path: {baseUrl}/v1/{accountWithErc5982UupsContractAddress}/getAllOrgAdmins
Get Organization Auditors: Method: get
Path: {baseUrl}/v1/{accountWithErc5982UupsContractAddress}/getAllOrgAuditors
Get Token Admins: Method: get
Path: {baseUrl}/v1/{accountWithErc5982UupsContractAddress}/getAllTokenAdmins
Get Token Auditors: Method: get
Path: {baseUrl}/v1/{accountWithErc5982UupsContractAddress}/getAllTokenAuditors
Remove Organization Admin: Method: post
Path: {baseUrl}/v1/{accountWithErc5982UupsContractAddress}/removeOrgAdmin
Remove Organization Auditor: Method: post
Path: {baseUrl}/v1/{accountWithErc5982UupsContractAddress}/removeOrgAuditor
Remove Role: Method: post
Path: {baseUrl}/v1/{accountWithErc5982UupsContractAddress}/removeRole
Remove Token Admin: Method: post
Path: {baseUrl}/v1/{accountWithErc5982UupsContractAddress}/removeTokenAdmin
Remove Token Auditor: Method: post
Path: {baseUrl}/v1/{accountWithErc5982UupsContractAddress}/removeTokenAuditor
Renounce Named Role: Method: post
Path: {baseUrl}/v1/{accountWithErc5982UupsContractAddress}/renounceNamedRole
Set Account Governance Context: Method: post
Path: {baseUrl}/v1/{accountWithErc5982UupsContractAddress}/setGovernanceContext
Set Context: Method: post
Path: {baseUrl}/v1/{accountWithErc5982UupsContractAddress}/setContext
Set Daily Amount Limit: Method: post
Path: {baseUrl}/v1/{accountWithErc5982UupsContractAddress}/setMaxDailyAmount
Set Daily Transaction Limit: Method: post
Path: {baseUrl}/v1/{accountWithErc5982UupsContractAddress}/setMaxDailyTransactionCount
Suspend Account: Method: post
Path: {baseUrl}/v1/{accountWithErc5982UupsContractAddress}/suspendAccount

Combined APIs

Create Account With Role: Method: post
Path: {baseUrl}/v1/{accountWithErc5982UupsContractAddress}/createAccountWithRole

ORDS Endpoints

Get Account Transactions Using Filters: Method: get
Path: {baseUrl}/v1/{contractAddress}/{ordsPathPrefix}/getCBDCAccountTransactionHistoryWithFilters
Get Active CBDC Accounts: Method: get
Path: {baseUrl}/v1/{contractAddress}/{ordsPathPrefix}/getAllActiveCBDCAccounts
Get Approver Actions: Method: get
Path: {baseUrl}/v1/{contractAddress}/{ordsPathPrefix}/getApproverActionHistory
Get CBDC Account History: Method: get
Path: {baseUrl}/v1/{contractAddress}/{ordsPathPrefix}/getCBDCAccountHistory
Get CBDC Accounts: Method: get
Path: {baseUrl}/v1/{contractAddress}/{ordsPathPrefix}/getAllCBDCAccounts
Get CBDC Metadata: Method: get
Path: {baseUrl}/v1/{contractAddress}/{ordsPathPrefix}/getCBDCMetadata
Get CBDC Role Accounts Using Filters: Method: get
Path: {baseUrl}/v1/{contractAddress}/{ordsPathPrefix}/getCBDCAccountsByRole
Get CBDC Status History: Method: get
Path: {baseUrl}/v1/{contractAddress}/{ordsPathPrefix}/getCBDCAccountStatusHistory
Get CBDC Transaction by ID: Method: get
Path: {baseUrl}/v1/{contractAddress}/{ordsPathPrefix}/getCBDCTransactionById
Get CBDC Transaction History Using Filters: Method: get
Path: {baseUrl}/v1/{contractAddress}/{ordsPathPrefix}/getAllCBDCAccountTransactionHistoryWithFilters
Get Organization Accounts: Method: get
Path: {baseUrl}/v1/{contractAddress}/{ordsPathPrefix}/getAllOrgAccounts
Get Organization Accounts by Role: Method: get
Path: {baseUrl}/v1/{contractAddress}/{ordsPathPrefix}/getOrgAccountsByRole
Get Pending CBDC Issuance: Method: get
Path: {baseUrl}/v1/{contractAddress}/{ordsPathPrefix}/getPendingCBDCIssuance
Get Pending CBDC Requests: Method: get
Path: {baseUrl}/v1/{contractAddress}/{ordsPathPrefix}/getPendingCBDCRequest
Get Pending Requests: Method: get
Path: {baseUrl}/v1/{contractAddress}/{ordsPathPrefix}/getPendingRequest
Get Registered Organizations: Method: get
Path: {baseUrl}/v1/{contractAddress}/{ordsPathPrefix}/getAllRegisteredOrgs
Get Retired CBDC Quantity: Method: get
Path: {baseUrl}/v1/{contractAddress}/{ordsPathPrefix}/getCBDCRetiredQuantity
Get Roles by Account: Method: get
Path: {baseUrl}/v1/{contractAddress}/{ordsPathPrefix}/getRolesByAccount
Get Suspended CBDC Accounts: Method: get
Path: {baseUrl}/v1/{contractAddress}/{ordsPathPrefix}/getAllSuspendedCBDCAccounts
Get Token History: Method: get
Path: {baseUrl}/v1/{contractAddress}/{ordsPathPrefix}/getTokenHistory
Get User CBDC Accounts: Method: get
Path: {baseUrl}/v1/{contractAddress}/{ordsPathPrefix}/getCBDCAccountsByUser
Get Users by Role: Method: get
Path: {baseUrl}/v1/{contractAddress}/{ordsPathPrefix}/getUsersByRole
getCBDCAccountStatus: Method: get
Path: {baseUrl}/v1/{contractAddress}/{ordsPathPrefix}/getCBDCAccountStatus

Schema Registration

Get Registered Endpoints: Method: get
Path: {baseUrl}/v1/register
Register Contract Endpoints: Method: post
Path: {baseUrl}/v1/register
Update Account Endpoint Template: Method: patch
Path: {baseUrl}/v1/register/{accountWithErc5982UupsContractAddress}
Update Token Endpoint Template: Method: patch
Path: {baseUrl}/v1/register/{wholesaleCbdctokenHoldableContractAddress}

Token Contract Endpoints

Approve Burn Request: Method: post
Path: {baseUrl}/v1/{wholesaleCbdctokenHoldableContractAddress}/approveBurn
Approve Mint Request: Method: post
Path: {baseUrl}/v1/{wholesaleCbdctokenHoldableContractAddress}/approveMint
Approve Token Spending: Method: post
Path: {baseUrl}/v1/{wholesaleCbdctokenHoldableContractAddress}/approve
Burn Approved Tokens: Method: post
Path: {baseUrl}/v1/{wholesaleCbdctokenHoldableContractAddress}/burnFrom
Burn Tokens: Method: post
Path: {baseUrl}/v1/{wholesaleCbdctokenHoldableContractAddress}/burn
Check Token Deployment: Method: get
Path: {baseUrl}/v1/{wholesaleCbdctokenHoldableContractAddress}/isDeploymentActive
Check Token Paused: Method: get
Path: {baseUrl}/v1/{wholesaleCbdctokenHoldableContractAddress}/paused
Execute Token Hold: Method: post
Path: {baseUrl}/v1/{wholesaleCbdctokenHoldableContractAddress}/executeHold
Get Account Hold Balance: Method: get
Path: {baseUrl}/v1/{wholesaleCbdctokenHoldableContractAddress}/getAccountOnHoldBalance
Get Hold Balance: Method: get
Path: {baseUrl}/v1/{wholesaleCbdctokenHoldableContractAddress}/getOnHoldBalanceWithOperationId
Get Hold Details: Method: get
Path: {baseUrl}/v1/{wholesaleCbdctokenHoldableContractAddress}/getOnHoldDetailsWithOperationId
Get Token: Method: get
Path: {baseUrl}/v1/{wholesaleCbdctokenHoldableContractAddress}/getToken
Get Token Allowance: Method: get
Path: {baseUrl}/v1/{wholesaleCbdctokenHoldableContractAddress}/allowance
Get Token Balance: Method: get
Path: {baseUrl}/v1/{wholesaleCbdctokenHoldableContractAddress}/balanceOf
Get Token Cap: Method: get
Path: {baseUrl}/v1/{wholesaleCbdctokenHoldableContractAddress}/cap
Get Token Context: Method: get
Path: {baseUrl}/v1/{wholesaleCbdctokenHoldableContractAddress}/getTokenContext
Get Token Decimals: Method: get
Path: {baseUrl}/v1/{wholesaleCbdctokenHoldableContractAddress}/decimals
Get Token Governance Context: Method: get
Path: {baseUrl}/v1/{wholesaleCbdctokenHoldableContractAddress}/getGovernanceContext
Get Token Name: Method: get
Path: {baseUrl}/v1/{wholesaleCbdctokenHoldableContractAddress}/name
Get Token Supply: Method: get
Path: {baseUrl}/v1/{wholesaleCbdctokenHoldableContractAddress}/totalSupply
Get Token Symbol: Method: get
Path: {baseUrl}/v1/{wholesaleCbdctokenHoldableContractAddress}/symbol
Get Token Version: Method: get
Path: {baseUrl}/v1/{wholesaleCbdctokenHoldableContractAddress}/version
Initialize CBDC Token: Method: post
Path: {baseUrl}/v1/{wholesaleCbdctokenHoldableContractAddress}/initializeCBDCToken
Mint Tokens: Method: post
Path: {baseUrl}/v1/{wholesaleCbdctokenHoldableContractAddress}/mint
Pause Token: Method: post
Path: {baseUrl}/v1/{wholesaleCbdctokenHoldableContractAddress}/pause
Place Approved Token Hold: Method: post
Path: {baseUrl}/v1/{wholesaleCbdctokenHoldableContractAddress}/holdFrom
Place Token Hold: Method: post
Path: {baseUrl}/v1/{wholesaleCbdctokenHoldableContractAddress}/hold
Reject Burn Request: Method: post
Path: {baseUrl}/v1/{wholesaleCbdctokenHoldableContractAddress}/rejectBurn
Reject Mint Request: Method: post
Path: {baseUrl}/v1/{wholesaleCbdctokenHoldableContractAddress}/rejectMint
Release Token Hold: Method: post
Path: {baseUrl}/v1/{wholesaleCbdctokenHoldableContractAddress}/releaseHold
Request Token Burn: Method: post
Path: {baseUrl}/v1/{wholesaleCbdctokenHoldableContractAddress}/requestBurn
Request Token Mint: Method: post
Path: {baseUrl}/v1/{wholesaleCbdctokenHoldableContractAddress}/requestMint
Resume Token: Method: post
Path: {baseUrl}/v1/{wholesaleCbdctokenHoldableContractAddress}/unpause
Set Token Context: Method: post
Path: {baseUrl}/v1/{wholesaleCbdctokenHoldableContractAddress}/setTokenContext
Set Token Governance Context: Method: post
Path: {baseUrl}/v1/{wholesaleCbdctokenHoldableContractAddress}/setGovernanceContext
Transfer Approved Tokens: Method: post
Path: {baseUrl}/v1/{wholesaleCbdctokenHoldableContractAddress}/transferFrom
Transfer Tokens: Method: post
Path: {baseUrl}/v1/{wholesaleCbdctokenHoldableContractAddress}/transfer
Transfer Tokens in Batch: Method: post
Path: {baseUrl}/v1/{wholesaleCbdctokenHoldableContractAddress}/batchTransfer
Update Token Notary: Method: post
Path: {baseUrl}/v1/{wholesaleCbdctokenHoldableContractAddress}/updateNotary

UWaaS

Create Organization: Method: post
Path: {baseUrl}/v1/uwaas/orgs
Create Wallet: Method: post
Path: {baseUrl}/v1/uwaas/wallets/provision
createOrganizationNetworks: Method: post
Path: {baseUrl}/v1/uwaas/orgs/{orgId}/organization-networks
Get Organizations: Method: get
Path: {baseUrl}/v1/uwaas/orgs
Get Wallets: Method: get
Path: {baseUrl}/v1/uwaas/wallets
Update Organization: Method: put
Path: {baseUrl}/v1/uwaas/orgs/{orgId}