Confidential Transactions Model

The enhanced version of Blockchain App Builder includes a model attribute that generates additional methods for confidential mode.

If you include the confidential: true parameter in the specification file for tokens that use the extended Token Taxonomy Framework standard, Blockchain App Builder generates chaincode for use in confidential mode, including the following modified versions of the standard automatically generated and SDK methods (TypeScript only).

For more information about confidential transactions and the confidential wholesale central bank digital currency (CBDC) scenario, see Wholesale Central Bank Digital Currency with Confidential Transactions.

The following table summarizes the methods that are generated when you scaffold a Token Taxonomy Framework project in confidential mode.

Method Category Auto-generated Method SDK Method Description
Access Control Management isTokenAdmin isUserTokenAdmin Returns true if the caller is an Admin
addTokenAdmin addTokenAdmin Adds an Admin
removeTokenAdmin removeTokenAdmin Removes an Admin
getAllTokenAdmins Returns all Admins
addOrgAdmin addOrgAdmin Adds an Org Admin
removeOrgAdmin removeOrgAdmin Removes an Org Admin
getAllOrgAdmins Returns all Org Admins
addTokenAuditor addTokenAuditor Adds an Auditor
removeTokenAuditor removeTokenAuditor Removes an Auditor
getAllTokenAuditors Returns all Auditors
addOrgAuditor addOrgAuditor Adds an Org Auditor
removeOrgAuditor removeOrgAuditor Removes an Org Auditor
getAllOrgAuditors Returns all Org Auditors
Token Management getAllTokens Returns all token assets
getDecimals Returns the number of decimal places for a specified token
history Returns the history of a token
getTokensByName Returns all token assets for a specified token name
Account Management createAccount createAccount Creates a user account
associateTokenToAccount associateToken Associates an account with a token
getAllAccounts getAllAccounts Returns details for all user accounts
getAllOrgAccounts getAllOrgAccounts Returns details for all user accounts in an organization
getAccountsByUser getAccountsByUser Returns all account IDs for a user
getUserByAccountId getUserByAccountId Returns user details for an account ID
getAccount getAccountWithStatus Returns details for a token account
getAccountDetailsByCustomAccountId getAccountDetailsByCustomAccountId Returns account details for a custom account ID
getAccountBalance getAccountBalance Returns the current balance of an account
getAccountStatus getAccountStatus Returns the status of an account
getAccountStatusHistory history Returns history for a token account
activateAccount activateAccount Activates a token account
suspendAccount suspendAccount Suspends a token account
deleteAccount deleteAccount Deletes a token account
setMaxDailyAmount setMaxDailyAmount Sets the maximum amount of tokens a user can transfer daily
setMaxDailyTransactionCount setMaxDailyTransactionCount Sets the maximum number of transactions a user can complete daily
getMaxDailyAmount getMaxDailyAmount Returns the maximum amount of tokens a user can transfer daily
getMaxDailyTransactionCount getMaxDailyTransactionCount Returns the maximum number of transactions a user can complete daily
getAccountOnHoldBalance getAccountOnHoldBalance Returns the current on-hold balance for an account
Role Management addRole addRoleMember Adds a role to a user
removeRole removeRoleMember Removes a role from a user
getAccountsByRole getAccountsByRole Returns account IDs for a specified role
getOrgAccountsByRole getOrgAccountsByRole Returns account IDs for a specified role in an organization
getUsersByRole getUsersByRole Returns a list of users for a specified role
getOrgUsersByRole getOrgUsersByRole Returns a list of users for a specified role in an organization
isInRole isInRole Returns whether a user has a specified role
Transaction Management getAccountTransactionHistory getAccountTransactionHistory Returns transaction history for an account
getAccountTransactionHistoryWithFilters getAccountTransactionHistoryWithFilters Returns filtered transaction history for an account
getAccountTransactionHistoryWithFiltersFromRichHistDB getAccountTrxHistoryWithFiltersFromRichHistDB Returns filtered transaction history from the rich history database for an account
getOrgAccountsTransactionHistoryWithFiltersFromRichHistDB getOrgAccountsTrxHistoryWithFiltersFromRichHistDB Returns filtered transaction history from the rich history database for an organization
getAllAccountsTransactionHistoryWithFiltersFromRichHistDB getAllAccountsTrxHistoryWithFiltersFromRichHistDB Returns filtered transaction history from the rich history database for all accounts
consolidateRunningBalanceInTransactions consolidateRunningBalanceInTransactions Updates running account balances for pending transactions
processSendersAndReceivers processSendersAndReceivers Updates account balances during inter-organization transfers
deleteHistoricalTransactions deleteTransactions Deletes older transactions
getTransactionById getTransactionById Returns the history of a transaction asset
Mintable Behavior requestMint Requests that tokens be issued
approveMint Approves a mint request
rejectMint Rejects a mint request
issueTokens issueTokens Mints tokens
getTotalMintedTokens getTotalMintedTokens Returns the total number of minted tokens
getNetTokens getNetTokens Returns the net quantity of available tokens
Transferable Behavior transferTokens transferTokens Transfers tokens
Holdable Behavior holdTokens hold Puts a token balance on hold
executeHoldTokens executeHold Completes a token hold
releaseHoldTokens releaseHold Releases a token hold
getOnHoldIds getOnHoldIds Returns all holding IDs for an account
getOnHoldDetailsWithOperationId getOnHoldDetailsWithOperationId Returns the on-hold transaction details for an operation ID
getOnHoldBalanceWithOperationId getOnHoldBalanceWithOperationId Returns the on-hold balance for an operation ID
Burnable Behavior requestBurn Requests that tokens be destroyed
approveBurn Approves a burn request
rejectBurn Rejects a burn request
Inter-Organization Transfers executeHoldTokensSender executeHoldTokensSender Deducts tokens from a sender's account
executeHoldTokensReceiver executeHoldTokensReceiver Credits tokens to a receiver's account

Modified TypeScript Methods for Confidential Chaincode

If you include the confidential: true parameter in the specification file for tokens that use the extended Token Taxonomy Framework standard, Blockchain App Builder generates modified versions of the standard automatically generated methods as well as additional methods.

isTokenAdmin
This method returns the Boolean value true if the caller of the function is a Token Admin, otherwise it returns false. A Token Admin, Token Auditor, any Org Admin, or any Org Auditor can call this function on any other user in the blockchain network. Other users can call this method only on their own accounts. 
@GetMethod()
 @Validator(yup.string(), yup.string())
 public async isTokenAdmin(org_id: string, user_id: string) {
    await this.Ctx.Auth.checkAuthorization("ADMIN.isUserTokenAdmin", "TOKEN", { org_id });
    return await this.Ctx.Auth.isUserTokenAdmin(org_id, user_id);
 }
Parameters:
  • org_id: string – The membership service provider (MSP) ID of the user in the current organization.
  • user_id: string – The user name or email ID of the user.
Returns:
  • The method returns true if the caller is a Token Admin, otherwise it returns false.
addTokenAdmin
This method adds a user as a Token Admin of the chaincode. This method can be called only by a Token Admin of the chaincode. Because the user_id value is stored on the public ledger, do not use any personally identifiable information (PII) for the user_id value. 
@Validator(yup.string(), yup.string())
  public async addTokenAdmin(org_id: string, user_id: string) {
    await this.Ctx.Auth.checkAuthorization("ADMIN.addTokenAdmin", "TOKEN");
    await this.Ctx.Model.createEvent(EVENT_NAME.ADD_TOKEN_ADMIN, { org_id, user_id });
    return await this.Ctx.Admin.addTokenAdmin(org_id, user_id);
  }
Parameters:
  • org_id: string – The membership service provider (MSP) ID of the user in the current organization.
  • user_id: string – The user name or email ID of the user.
Returns:
  • On success, a message that includes details of the user who was added as a Token Admin of the chaincode.
Return Value Example:
{
  "msg": "Successfully added Token Admin (Org_Id: CentralBank, User_Id: cb1)"
}
removeTokenAdmin
This method removes a user as a Token Admin of the chaincode. This method can be called only by a Token Admin of the chaincode. 
@Validator(yup.string(), yup.string())
  public async removeTokenAdmin(org_id: string, user_id: string) {
    await this.Ctx.Auth.checkAuthorization("ADMIN.removeTokenAdmin", "TOKEN");
    await this.Ctx.Model.createEvent(EVENT_NAME.REMOVE_TOKEN_ADMIN, { org_id, user_id });
    return await this.Ctx.Admin.removeTokenAdmin(org_id, user_id);
  }
Parameters:
  • org_id: string – The membership service provider (MSP) ID of the user in the current organization.
  • user_id: string – The user name or email ID of the user.
Returns:
  • On success, a message that includes details of the user who was removed as a Token Admin of the chaincode.
Return Value Example:
{"msg": "Successfully removed Admin (Org_Id: Org1MSP, User_Id: User1)"}
addOrgAdmin
This method adds a user as an Org Admin of the organization. This method can be called only by a Token Admin of the chaincode or an Org Admin of the specified organization. Because the user_id value is stored on the public ledger, do not use any personally identifiable information (PII) for the user_id value. 
@Validator(yup.string(), yup.string())
  public async addOrgAdmin(org_id: string, user_id: string) {
    await this.Ctx.Auth.checkAuthorization("ADMIN.addOrgAdmin", "TOKEN", { org_id });
    await this.Ctx.Model.createEvent(EVENT_NAME.ADD_ORG_ADMIN, { org_id, user_id });
    return await this.Ctx.Admin.addOrgAdmin(org_id, user_id);
  }
Parameters:
  • org_id: string – The membership service provider (MSP) ID of the user in the current organization.
  • user_id: string – The user name or email ID of the user.
Returns:
  • On success, a message that includes details of the user who was added as an Org Admin of the organization.
Return Value Example:
{
    "msg": "Successfully added Org Admin (Org_Id: Org1MSP, User_Id: orgAdmin)"
}
removeOrgAdmin
This method removes a user as an Org Admin of the organization. This method can be called only by a Token Admin of the chaincode or by an Org Admin of the specified organization. 
@Validator(yup.string(), yup.string())
  public async removeOrgAdmin(org_id: string, user_id: string) {
    await this.Ctx.Auth.checkAuthorization("ADMIN.removeOrgAdmin", "TOKEN", { org_id });
    await this.Ctx.Model.createEvent(EVENT_NAME.REMOVE_ORG_ADMIN, { org_id, user_id });
    return await this.Ctx.Admin.removeOrgAdmin(org_id, user_id);
  }
Parameters:
  • org_id: string – The membership service provider (MSP) ID of the user in the current organization.
  • user_id: string – The user name or email ID of the user.
Returns:
  • On success, a message that includes details of the user who was removed as an Org Admin of the organization.
Return Value Example:
{
  "msg": "Successfully removed Org Admin (Org_Id Org1MSP User_Id orgAdmin)"
}
addTokenAuditor
This method adds a user as a Token Auditor of the chaincode. This method can be called only by a Token Admin of the chaincode. Because the user_id value is stored on the public ledger, do not use any personally identifiable information (PII) for the user_id value. 
@Validator(yup.string(), yup.string())
  public async addTokenAuditor(org_id: string, user_id: string) {
    await this.Ctx.Auth.checkAuthorization("ADMIN.addTokenAuditor", "TOKEN");
    await this.Ctx.Model.createEvent(EVENT_NAME.ADD_TOKEN_AUDITOR, { org_id, user_id });
    return await this.Ctx.Admin.addTokenAuditor(org_id, user_id);
  }
Parameters:
  • org_id: string – The membership service provider (MSP) ID of the user in the current organization.
  • user_id: string – The user name or email ID of the user.
Return Value Example:
{
  "msg": "Successfully added Token Auditor (Org_Id: CentralBank, User_Id: cb_admin_demo)"
}
removeTokenAuditor
This method removes a user as a Token Auditor of the chaincode. This method can be called only by a Token Admin of the chaincode. 
@Validator(yup.string(), yup.string())
  public async removeTokenAuditor(org_id: string, user_id: string) {
    await this.Ctx.Auth.checkAuthorization("ADMIN.removeTokenAuditor", "TOKEN");
    await this.Ctx.Model.createEvent(EVENT_NAME.REMOVE_TOKEN_AUDITOR, { org_id, user_id });
    return await this.Ctx.Admin.removeTokenAuditor(org_id, user_id);
  }
Parameters:
  • org_id: string – The membership service provider (MSP) ID of the user in the current organization.
  • user_id: string – The user name or email ID of the user.
Return Value Example:
{
           "msg": "Successfully removed Token Auditor (Org_Id: CB, User_Id: cb)"
       }
addOrgAuditor
This method adds a user as a Org Auditor of the chaincode. This method can be called only by a Token Admin or Org Admin of the chaincode. Because the user_id value is stored on the public ledger, do not use any personally identifiable information (PII) for the user_id value. 
@Validator(yup.string(), yup.string())
  public async addOrgAuditor(org_id: string, user_id: string) {
    await this.Ctx.Auth.checkAuthorization("ADMIN.addOrgAuditor", "TOKEN", { org_id });
    await this.Ctx.Model.createEvent(EVENT_NAME.ADD_ORG_AUDITOR, { org_id, user_id });
    return await this.Ctx.Admin.addOrgAuditor(org_id, user_id);
  }
Parameters:
  • org_id: string – The membership service provider (MSP) ID of the user in the current organization.
  • user_id: string – The user name or email ID of the user.
Returns:
  • On success, a message that includes details of the user who was added as a Org Auditor of the chaincode.
Return Value Example:
{
           "msg": "Successfully added Org Auditor (Org_Id: CentralBank, User_Id: cb_admin_demo)"
       }
removeOrgAuditor
This method removes a user as a Org Auditor of the chaincode. This method can be called only by a Token Admin or Org Admin of the chaincode. 
@Validator(yup.string(), yup.string())
  public async removeOrgAuditor(org_id: string, user_id: string) {
    await this.Ctx.Auth.checkAuthorization("ADMIN.removeOrgAuditor", "TOKEN", { org_id });
    await this.Ctx.Model.createEvent(EVENT_NAME.REMOVE_ORG_AUDITOR, { org_id, user_id });
    return await this.Ctx.Admin.removeOrgAuditor(org_id, user_id);
  }
Parameters:
  • org_id: string – The membership service provider (MSP) ID of the user in the current organization.
  • user_id: string – The user name or email ID of the user.
Return Value Example:
{
           "msg": "Successfully removed Org Auditor (Org_Id: CB, User_Id: cb)"
       }
createAccount
This method creates an account for a specified user and token. An account must be created for any user who will have tokens at any point. Accounts track balances, on-hold balances, and transaction history. An account ID is formed by concatenating the asset type and token ID and then creating a SHA-256 hash over a concatenation of the organization ID and user ID. This method can be called only by a Token Admin or by an Org Admin of the specified organization. 
@Validator(yup.string(),yup.string(), yup.string(), yup.object().nullable())
  public async createAccount(org_id: string, user_id: string, token_type: string, dailyLimits?: DailyLimits) {
    await this.Ctx.Auth.checkAuthorization("ACCOUNT.createAccount", "TOKEN", { org_id });
    await this.Ctx.Model.createEvent(EVENT_NAME.CREATE_ACCOUNT, { org_id, user_id, token_type, dailyLimits });
    return await this.Ctx.Account.createAccount(org_id, user_id, token_type, dailyLimits);
  }
Parameters:
  • org_id – The membership service provider (MSP) ID of the user to create the account for. The ID must begin with an alphanumeric character and can include letters, numbers, and special characters such as underscores (_), periods (.), at signs (@), and hyphens (-).
  • user_id – The user name or email ID of the user. The ID must begin with an alphanumeric character and can include letters, numbers, and special characters such as underscores (_), periods (.), at signs (@), and hyphens (-).
  • token_type: string – The type of token, which must be fungible.
  • daily_limits: DailyLimits – A JSON object of the following type.
    {
     "max_daily_amount": 100000
     "max_daily_transactions": 10000
 }
    In the example, the max_daily_amount value is the maximum amount of tokens that can be transacted daily and max_daily_transactions value is the maximum number of transactions that can be completed daily.
Return Value Example:
{
    "bapAccountVersion": 0,
    "assetType": "oaccount",
    "account_id": "oaccount~b53cb2c19c92d1d5c8cb9f6e988e7761c34e03e014e6c4b889565fc0abf46c8a",
    "org_id": "CentralBank",
    "token_type": "fungible",
    "token_id": "",
    "token_name": "",
    "balance": "028b72742c8aa9a0395c828fe4f0e46226a3e40d4e731d0b994c8028c8b7bd4df6",
    "onhold_balance": "028b72742c8aa9a0395c828fe4f0e46226a3e40d4e731d0b994c8028c8b7bd4df6",
    "onhold_burn_balance": "028b72742c8aa9a0395c828fe4f0e46226a3e40d4e731d0b994c8028c8b7bd4df6",
}
associateTokenToAccount
This method associates a fungible token with an account. This method can be called only by a Token Admin of the chaincode or by an Org Admin of the relevant organization. 
@Validator(yup.string(), yup.string(), yup.string().optional())
  public async associateTokenToAccount(account_id: string, token_id: string, custom_account_id?: string) {
    await this.Ctx.Auth.checkAuthorization("ACCOUNT.associateToken", "TOKEN", { account_id });
    const token_asset = await this.getTokenObject(token_id);
    await this.Ctx.Model.createEvent(EVENT_NAME.ASSOCIATE_TOKEN_TO_ACCOUNT, { account_id, token_asset }, token_asset);
    return await this.Ctx.Account.associateToken(account_id, token_id, custom_account_id);
  }
Parameters:
  • account_id: string – The ID of the account.
  • token_id: string – The ID of the token.
  • custom_account_id: string – For confidential mode, the bank account ID of the account, a unique random alphanumeric identifier. By default, 14 characters long.
Returns:
  • On success, a JSON object of the updated account. The bapAccountVersion parameter is defined in the account object for internal use.
Return Value Example:
{
    "bapAccountVersion": 0,
    "assetType": "oaccount",
    "account_id": "oaccount~b53cb2c19c92d1d5c8cb9f6e988e7761c34e03e014e6c4b889565fc0abf46c8a",
    "org_id": "CentralBank",
    "token_type": "fungible",
    "token_id": "USD",
    "token_name": "cbdc",
    "balance": "028b72742c8aa9a0395c828fe4f0e46226a3e40d4e731d0b994c8028c8b7bd4df6",
    "onhold_balance": "028b72742c8aa9a0395c828fe4f0e46226a3e40d4e731d0b994c8028c8b7bd4df6",
    "onhold_burn_balance": "028b72742c8aa9a0395c828fe4f0e46226a3e40d4e731d0b994c8028c8b7bd4df6",
    "application_groups": [
        "CENTRAL_BANK_USERS"
    ]
}
getAllAccounts
This method returns a list of all accounts. This method can be called only by a Token Admin or Token Auditor. This method uses Berkeley DB SQL rich queries and can only be called when connected to the remote Oracle Blockchain Platform network. 
@GetMethod()
  @Validator()
  public async getAllAccounts() {
    await this.Ctx.Auth.checkAuthorization("ACCOUNT.getAllAccounts", "TOKEN");
    return await this.Ctx.Account.getAllAccounts();
  }
Parameters:
  • none
Return Value Example:
[
    {
        "key": "oaccount~5abb4155f4b245bb1732321e3174ac81999b03495b5c74f8e1f270bafbadef75",
        "valueJson": {
            "bapAccountVersion": 3,
            "assetType": "oaccount",
            "account_id": "oaccount~5abb4155f4b245bb1732321e3174ac81999b03495b5c74f8e1f270bafbadef75",
            "org_id": "CentralBank",
            "token_type": "fungible",
            "token_id": "token",
            "token_name": "cbdc",
            "balance": "028a27c752e9b518d156e61da6589e723b179b6d7351dc34ec92bbb27b783ed1dc",
            "onhold_balance": "02d53a7eda9484bda7252212714f647b70d32663cfa416f93f488ef6b6bc8fb2eb",
            "onhold_burn_balance": "02d53a7eda9484bda7252212714f647b70d32663cfa416f93f488ef6b6bc8fb2eb",
            "application_groups": [
                "application_groups value"
            ]
        }
    },
    {
        "key": "oaccount~1da238c1491c919b151f777a615fb5779032c34b3ef3adeca6afe591bac10aaf",
        "valueJson": {
            "bapAccountVersion": 0,
            "assetType": "oaccount",
            "account_id": "oaccount~1da238c1491c919b151f777a615fb5779032c34b3ef3adeca6afe591bac10aaf",
            "org_id": "CentralBank",
            "token_type": "fungible",
            "token_id": "token",
            "token_name": "cbdc",
            "balance": "020da01cd57249c6470b6dd03c2ee4c49de58c71ccc64f2de1203e835967a0846d",
            "onhold_balance": "020da01cd57249c6470b6dd03c2ee4c49de58c71ccc64f2de1203e835967a0846d",
            "onhold_burn_balance": "020da01cd57249c6470b6dd03c2ee4c49de58c71ccc64f2de1203e835967a0846d",
            "application_groups": [
                "application_groups value"
            ]
        }
    }
]
getAllOrgAccounts
This method returns a list of all token accounts that belong to a specified organization. This method can be called only by a Token Admin or Token Auditor, or by an Org Admin or Org Auditor of the specified organization. 
@GetMethod()
  @Validator(yup.string())
  public async getAllOrgAccounts(org_id: string) {
    await this.Ctx.Auth.checkAuthorization("ACCOUNT.getAllOrgAccounts", "TOKEN", { org_id });
    return await this.Ctx.Account.getAllOrgAccounts(org_id);
  }
Parameters:
  • org_id: string – The membership service provider (MSP) ID of the organization.
Returns:
  • On success, a list of all accounts for the specified organization.
Return Value Example:
[
    {
        "key": "oaccount~22776ada3efff6aaf4c68c204c1f063b139adfa1bca79ed53199117c34036cfc",
        "valueJson": {
            "bapAccountVersion": 2,
            "assetType": "oaccount",
            "account_id": "oaccount~22776ada3efff6aaf4c68c204c1f063b139adfa1bca79ed53199117c34036cfc",
            "org_id": "CentralBank",
            "token_type": "fungible",
            "token_id": "token",
            "token_name": "cbdc",
            "balance": "18",
            "onhold_balance": "0",
            "onhold_burn_balance": "0",
            "application_groups": [
                "application_groups value"
            ],
            "user_id": "cb",
            "custom_account_id": "1234567jh"
        }
    },
    {
        "key": "oaccount~5e3b5a3306d7ca3f3e3fe7cc27b6ae547e94dba1c5af58a69a771d7a619b6a66",
        "valueJson": {
            "bapAccountVersion": 1,
            "assetType": "oaccount",
            "account_id": "oaccount~5e3b5a3306d7ca3f3e3fe7cc27b6ae547e94dba1c5af58a69a771d7a619b6a66",
            "org_id": "CentralBank",
            "token_type": "fungible",
            "token_id": "token",
            "token_name": "cbdc",
            "balance": "22",
            "onhold_balance": "0",
            "onhold_burn_balance": "0",
            "application_groups": [
                "application_groups value"
            ],
            "user_id": "cb1",
            "custom_account_id": "1234567jh"
        }
    }
]
getAccountsByUser
This method returns a list of all account IDs for a specified organization ID and user ID. This method can be called only by the Token Admin or Token Auditor, by the Org Admin or Org Auditor of the specified organization, or by the Account Owner specified in the parameters. 
@GetMethod()
  @Validator(yup.string(), yup.string())
  public async getAccountsByUser(org_id: string, user_id: string) {
    await this.Ctx.Auth.checkAuthorization("ACCOUNT.getAccountsByUser", "TOKEN", { org_id, user_id });
    return await this.Ctx.Account.getAccountsByUser(org_id, user_id);
  }
Parameters:
  • org_id string – The membership service provider (MSP) ID of the user in the current organization.
  • user_id string – The user name or email ID of the user.
Returns:
  • On success, a JSON array of account IDs.
Return Value Example:
[
    {
        "bapAccountVersion": 2,
        "assetType": "oaccount",
        "user_id": "cb",
        "custom_account_id": "1234567jh",
        "account_id": "oaccount~22776ada3efff6aaf4c68c204c1f063b139adfa1bca79ed53199117c34036cfc",
        "org_id": "CentralBank",
        "token_type": "fungible",
        "token_id": "token",
        "token_name": "cbdc",
        "balance": "18",
        "onhold_balance": "0",
        "onhold_burn_balance": "0",
        "application_groups": [
            "application_groups value"
        ]
    }
]
getUserByAccountId
This method returns user details (org_id and user_id) for a specified account. This method can be called by a Token Admin or Token Auditor, or by an Org Admin or Org Auditor of the specified organization. 
@GetMethod()
  @Validator(yup.string())
  public async getUserByAccountId(account_id: string) {
    await this.Ctx.Auth.checkAuthorization("ACCOUNT.getUserByAccountId", "TOKEN", { account_id });
    return await this.Ctx.Account.getUserByAccountId(account_id);
  }
Parameters:
  • account_id: string – The ID of the account.
Returns:
  • On success, a JSON object of the user details (org_id, token_id, and user_id).
Return Value Example:
{
    "token_id": "USD",
    "org_id": "CentralBank",
    "user_id": "cb_admin_demo",
    "custom_account_id": "10101234000123"
}
getAccount
This method returns details for a specified account. This method can be called only by a Token Admin or Token Auditor, an Org Admin or Org Auditor of the specified organization, or the AccountOwner of the account. 
@GetMethod()
  @Validator(yup.string())
  public async getAccount(account_id: string) {
    await this.Ctx.Account.getAccountWithTokenIdValidation(account_id);
    await this.Ctx.Auth.checkAuthorization("ACCOUNT.getAccount", "TOKEN", { account_id });
    return await this.Ctx.Account.getAccountWithStatus(account_id);
  }
Parameters:
  • account_id: string – The unique ID of the token account.
Return Value Example:
{
    "bapAccountVersion": 2,
    "assetType": "oaccount",
    "user_id": "cb",
    "custom_account_id": "1234567jh",
    "status": "active",
    "account_id": "oaccount~22776ada3efff6aaf4c68c204c1f063b139adfa1bca79ed53199117c34036cfc",
    "org_id": "CentralBank",
    "token_type": "fungible",
    "token_id": "token",
    "token_name": "cbdc",
    "balance": "18",
    "onhold_balance": "0",
    "onhold_burn_balance": "0",
    "application_groups": [
        "application_groups value"
    ]
}
getAccountDetailsByCustomAccountId
This method returns details for a specified custom account ID. This method can be called only by a Token Admin or Token Auditor, or an Org Admin or Org Auditor of the specified organization. 
@GetMethod()
  @Validator(yup.string(), yup.string())
  public async getAccountDetailsByCustomAccountId(custom_account_id: string, org_id: string) {
    await this.Ctx.Auth.checkAuthorization("ACCOUNT.getAccountDetailsByCustomAccountId", "TOKEN", { org_id });
    return await this.Ctx.Account.getAccountDetailsByCustomAccountId(custom_account_id, org_id);
  }
Parameters:
  • custom_account_id: string – The bank account ID of the account, a unique random alphanumeric identifier.
  • org_id: string – The membership service provider (MSP) ID of the organization.
Return Value Example:
[
    {
        "bapAccountVersion": 0,
        "assetType": "oaccount",
        "account_id": "oaccount~c44ffac4c46718e9744cb0aae2016d26a87a5bef5e2d1c0d1abc7d8782f0ba61",
        "org_id": "CentralBank",
        "token_type": "fungible",
        "token_id": "USD",
        "token_name": "cbdc",
        "balance": "0",
        "onhold_balance": "0",
        "onhold_burn_balance": "0",
        "application_groups": [
            "SYSTEM_ADMINS"
        ],
        "user_id": "cb_admin_demo",
        "custom_account_id": "10101234000123"
    }
]
getAccountBalance
This method returns the current balance for a specified account. This method can be called only by a Token Admin or Token Auditor, an Org Admin or Org Auditor of the specified organization, or the AccountOwner of the account. 
@GetMethod()
  @Validator(yup.string())
  public async getAccountBalance(account_id: string) {
    await this.Ctx.Account.getAccountWithTokenIdValidation(account_id);
    await this.Ctx.Auth.checkAuthorization("ACCOUNT.getAccountBalance", "TOKEN", { account_id });
    return await this.Ctx.Account.getAccountBalance(account_id);
  }
Parameters:
  • account_id: string – The unique ID of the token account.
Returns:
  • On success, a JSON representation of the current account balance.
Return Value Example:
{
    "msg": "Current Balance is: 100",
    "user_balance": 100
}
getAccountStatus
This method gets the current status of the token account. This method can be called by the Token Admin of the chaincode, an Org Admin of the specified organization, or by the token account owner. 
@GetMethod()
  @Validator(yup.string())
  public async getAccountStatus(account_id: string) {
    await this.Ctx.Account.getAccountWithTokenIdValidation(account_id);
    await this.Ctx.Auth.checkAuthorization("ACCOUNT_STATUS.get", "TOKEN", { account_id });
    try {
      return await this.Ctx.AccountStatus.getAccountStatus(account_id);
    } catch (err) {
      return await this.Ctx.AccountStatus.getDefaultAccountStatus(account_id);
    }
  }
Parameters:
  • account_id: string – The unique ID of the token account.
Returns:
  • On success, a message that includes details of the token account status.
Return Value Example:
{
    "assetType": "oaccountStatus",
    "status_id": "oaccountStatus~5a0b0d8b1c6433af9fedfe0d9e6580e7cf6b6bb62a0de6267aaf79f79d5e96d7",
    "account_id": "oaccount~1c568151c4acbcd1bd265c766c677145760a61c47fc8a3ba681a4cfbe287f9c1",
    "status": "active"
}
getAccountStatusHistory
This method gets the history of the account status. This method can be called by the Token Admin of the chaincode, an Org Admin of the specified organization, or by the token account owner. 
@GetMethod()
  @Validator(yup.string())
  public async getAccountStatusHistory(account_id: string) {
    await this.Ctx.Account.getAccountWithTokenIdValidation(account_id);
    await this.Ctx.Auth.checkAuthorization("ACCOUNT_STATUS.history", "TOKEN", { account_id });
    const status_id = await this.Ctx.AccountStatus.generateAccountStatusId(account_id);
    let account_status_history: any;
    try {
      account_status_history = await this.Ctx.AccountStatus.history(status_id);
    } catch (err) {
      return [];
    }
    return account_status_history;
  }
Parameters:
  • account_id: string – The unique ID of the token account.
Returns:
  • On success, a message that includes details of the account status history.
Return Value Example:
[
  {
    "trxId": "d5c6d6f601257ba9b6edaf5b7660f00adc13c37d5321b8f7d3a35afab2e93e63",
    "timeStamp": "2025-12-02T10:39:14.000Z",
    "value": {
      "assetType": "oaccountStatus",
      "status_id": "oaccountStatus~5a0b0d8b1c6433af9fedfe0d9e6580e7cf6b6bb62a0de6267aaf79f79d5e96d7",
      "account_id": "oaccount~1c568151c4acbcd1bd265c766c677145760a61c47fc8a3ba681a4cfbe287f9c1",
      "status": "suspended"
    }
  },
  {
    "trxId": "e6c850cfa084dc20ad95fb2bb8165eef3a3bd62a0ac867cccee57c2003125183",
    "timeStamp": "2025-12-02T10:37:50.000Z",
    "value": {
      "assetType": "oaccountStatus",
      "status_id": "oaccountStatus~5a0b0d8b1c6433af9fedfe0d9e6580e7cf6b6bb62a0de6267aaf79f79d5e96d7",
      "account_id": "oaccount~1c568151c4acbcd1bd265c766c677145760a61c47fc8a3ba681a4cfbe287f9c1",
      "status": "active"
    }
  }
]
activateAccount
This method activates a token account. This method can be called only by a Token Admin of the chaincode or an Org Admin of the specified organization. Deleted accounts cannot be activated. 
@Validator(yup.string())
  public async activateAccount(account_id: string) {
    const account: FungibleAccount = await this.Ctx.Account.getAccountWithTokenIdValidation(account_id);
    await this.Ctx.Auth.checkAuthorization("ACCOUNT_STATUS.activateAccount", "TOKEN", { org_id: account.org_id });
    const token_asset = await this.getTokenObject(account.token_id);
    await this.Ctx.Model.createEvent(EVENT_NAME.ACTIVATE_ACCOUNT, { account_id }, token_asset);
    return await this.Ctx.Account.activateAccount(account_id);
  }
Parameters:
  • account_id: string – The unique ID of the token account.
Returns:
  • On success, a JSON representation of the account status object for the specified token account.
Return Value Example:
{
  "assetType": "oaccountStatus",
  "status_id": "oaccountStatus~5a0b0d8b1c6433af9fedfe0d9e6580e7cf6b6bb62a0de6267aaf79f79d5e96d7",
  "account_id": "oaccount~1c568151c4acbcd1bd265c766c677145760a61c47fc8a3ba681a4cfbe287f9c1",
  "status": "active"
}
suspendAccount
This method suspends a token account. This method can be called only by a Token Admin of the chaincode or an Org Admin of the specified organization. After an account is suspended, you cannot complete any operations that update the account. A deleted account cannot be suspended. 
@Validator(yup.string())
  public async suspendAccount(account_id: string) {
    const account: FungibleAccount = await this.Ctx.Account.getAccountWithTokenIdValidation(account_id);
    await this.Ctx.Auth.checkAuthorization("ACCOUNT_STATUS.suspendAccount", "TOKEN", { org_id: account.org_id });
    const token_asset = await this.getTokenObject(account.token_id);
    await this.Ctx.Model.createEvent(EVENT_NAME.SUSPEND_ACCOUNT, { account }, token_asset);
    return await this.Ctx.Account.suspendAccount(account_id);
  }
Parameters:
  • account_id: string – The unique ID of the token account.
Returns:
  • On success, a JSON representation of the account status object for the specified token account.
Return Value Example:
{
    "assetType": "oaccountStatus",
    "status_id": "oaccountStatus~5a0b0d8b1c6433af9fedfe0d9e6580e7cf6b6bb62a0de6267aaf79f79d5e96d7",
    "account_id": "oaccount~1c568151c4acbcd1bd265c766c677145760a61c47fc8a3ba681a4cfbe287f9c1",
    "status": "suspended"
}
deleteAccount
This method deletes a token account. This method can be called only by a Token Admin of the chaincode or an Org Admin of the specified organization. After an account is deleted, you cannot complete any operations that update the account. The deleted account is in a final state and cannot be changed to any other state. To delete an account, the account balance and the on-hold balance must be zero. 
@Validator(yup.string())
  public async deleteAccount(account_id: string) {
    const account: FungibleAccount = await this.Ctx.Account.getAccountWithTokenIdValidation(account_id);
    await this.Ctx.Auth.checkAuthorization("ACCOUNT_STATUS.deleteAccount", "TOKEN", { org_id: account.org_id });
    const token_asset = await this.getTokenObject(account.token_id);
    await this.Ctx.Model.createEvent(EVENT_NAME.DELETE_ACCOUNT, { account_id }, token_asset);
    return await this.Ctx.Account.deleteAccount(account_id);
  }
Parameters:
  • account_id: string – The unique ID of the token account.
Returns:
  • On success, a JSON representation of the account status object for the specified token account.
Return Value Example:
{
  "assetType": "oaccountStatus",
  "status_id": "oaccountStatus~5a0b0d8b1c6433af9fedfe0d9e6580e7cf6b6bb62a0de6267aaf79f79d5e96d7",
  "account_id": "oaccount~1c568151c4acbcd1bd265c766c677145760a61c47fc8a3ba681a4cfbe287f9c1",
  "status": "deleted"
}
setMaxDailyAmount
This method sets the max_daily_amount value for a specified account. This method can be called only by a Token Admin of the chaincode or an Org Admin of the specified organization. 
@Validator(yup.string(), yup.string().optional())
  public async setMaxDailyAmount (account_id: string, max_daily_amount?: string) {
    const account: FungibleAccount = await this.Ctx.Account.getAccountWithTokenIdValidation(account_id);
    await this.Ctx.Auth.checkAuthorization('ACCOUNT.setMaxDailyAmount', 'TOKEN', { org_id: account.org_id });
    const token_asset = await this.getTokenObject(account.token_id);
    await this.Ctx.Model.createEvent(EVENT_NAME.SET_MAX_DAILY_AMOUNT, { account_id, max_daily_amount }, token_asset);
    return this.Ctx.Account.setMaxDailyAmount (account_id, max_daily_amount);
  }
Parameters:
  • account_id: string – The unique ID of the token account.
  • max_daily_amount?: string – (Optional) The maximum amount of tokens the user can transfer daily. If not specified, the user can transfer any amount of tokens daily.
Return Value Example:
{
           "msg": "Successfully set max daily amount for account id oaccount~68d67712f500e9dac8c314c19744003a993250271d960e9b0d25267bb18dfe9a to 1000000"
       }
setMaxDailyTransactionCount
This method sets the max_daily_transactions value for a specified account. This method can be called only by a Token Admin of the chaincode or an Org Admin of the specified organization. 
@Validator(yup.string(), yup.string().optional())
  public async setMaxDailyTransactionCount (account_id: string, max_daily_transactions?: string) {
    const account: FungibleAccount = await this.Ctx.Account.getAccountWithTokenIdValidation(account_id);
    await this.Ctx.Auth.checkAuthorization('ACCOUNT.setMaxDailyTransactionCount', 'TOKEN', { org_id: account.org_id });
    const token_asset = await this.getTokenObject(account.token_id);
    await this.Ctx.Model.createEvent(EVENT_NAME.SET_MAX_DAILY_TRANSACTION_COUNT, { account_id, max_daily_transactions}, token_asset);
    return this.Ctx.Account.setMaxDailyTransactionCount (account_id, max_daily_transactions);
  }
Parameters:
  • account_id: string – The unique ID of the token account.
  • max_daily_transactions?: string – (Optional) The maximum number of transactions the user can complete daily. If not specified, the user can complete any number of transactions daily.
Return Value Example:
{
            "msg": "Successfully set max daily transactions for account id oaccount~68d67712f500e9dac8c314c19744003a993250271d960e9b0d25267bb18dfe9a to 100000"
        }
getMaxDailyAmount
This method gets the max_daily_amount value for a specified account. This method can be called only by a Token Admin or Token Auditor of the chaincode or an Org Admin or Org Auditor of the specified organization. 
@GetMethod()
  @Validator(yup.string())
  public async getMaxDailyAmount (account_id: string) {
    await this.Ctx.Account.getAccountWithTokenIdValidation(account_id);
    await this.Ctx.Auth.checkAuthorization('ACCOUNT.getMaxDailyAmount', 'TOKEN', { account_id });
    return this.Ctx.Account.getMaxDailyAmount (account_id);
  }
Parameters:
  • account_id: string – The unique ID of the token account.
Return Value Example:
{
           "max_daily_amount": "10000"
       }
getMaxDailyTransactionCount
This method gets the max_daily_transactions value for a specified account. This method can be called only by a Token Admin or Token Auditor of the chaincode or an Org Admin or Org Auditor of the specified organization. 
@GetMethod()
  @Validator(yup.string())
  public async getMaxDailyTransactionCount (account_id: string) {
    await this.Ctx.Account.getAccountWithTokenIdValidation(account_id);
    await this.Ctx.Auth.checkAuthorization('ACCOUNT.getMaxDailyTransactionCount', 'TOKEN', { account_id });
    return this.Ctx.Account.getMaxDailyTransactionCount (account_id);
  }
Parameters:
  • account_id: string – The unique ID of the token account.
Return Value Example:
{
           "max_daily_transactions": "100"
       }
getAccountOnHoldBalance
This method returns the current on-hold balance for a specified account. This method can be called only by a Token Admin or Token Auditor, an Org Admin or Org Auditor of the specified organization, or the AccountOwner of the account. 
@GetMethod()
  @Validator(yup.string())
  public async getAccountOnHoldBalance(account_id: string) {
    await this.Ctx.Account.getAccountWithTokenIdValidation(account_id);
    await this.Ctx.Auth.checkAuthorization("ACCOUNT.getAccountOnHoldBalance", "TOKEN", { account_id });
    return await this.Ctx.Account.getAccountOnHoldBalance(account_id);
  }
Parameters:
  • account_id: string – The unique ID of the token account.
Returns:
  • On success, a JSON representation of the current on-hold balance.
Return Value Example:
{
           "msg": "Total Holding Balance is: 0",
           "holding_balance": 0
       }
addRole
This method adds a role to a specified user and token. This method can be called only by a Token Admin of the chaincode or by an Org Admin of the specified organization who also holds the specified role. 
@Validator(yup.string(), yup.string())
  public async addRole(account_id: string, role: string) {
    const account: FungibleAccount = await this.Ctx.Account.getAccountWithTokenIdValidation(account_id);
    const token_asset = await this.getTokenObject(account.token_id);
    await this.Ctx.Auth.checkAuthorization("TOKEN.addRoleMember", "TOKEN", { token_id: account.token_id, org_id: account.org_id, role });
    await this.Ctx.Model.createEvent(EVENT_NAME.ADD_ROLE, { role, account_id }, token_asset);
    return await this.Ctx.Token.addRoleMember(role, account_id, token_asset);
  }
Parameters:
  • account_id: string – The unique ID of the token account.
  • role: string – The name of the role to add to the specified user. The mintable and burnable behaviors correspond to the minter_role_name and burner_role_name properties of the specification file. Similarly, the notary role corresponds to the notary_role_name property of the specification file.
Returns:
  • On success, a message with account details.
Return Value Example:
{
     "msg": "Successfully added role 'notary' to Account Id: oaccount~2eb5f8a9bc561f8f41a4ea3be9511958cc6684ef14f2337ca396efc301b627d8"
}
removeRole
This method removes a role from a specified user and token. This method can be called only by a Token Admin of the chaincode or by an Org Admin of the specified organization who also holds the specified role. 
@Validator(yup.string(), yup.string())
  public async removeRole(account_id: string, role: string) {
    const account: FungibleAccount = await this.Ctx.Account.getAccountWithTokenIdValidation(account_id);
    const token_asset = await this.getTokenObject(account.token_id);
    await this.Ctx.Auth.checkAuthorization("TOKEN.removeRoleMember", "TOKEN", { token_id: account.token_id, org_id: account.org_id, role });
    await this.Ctx.Model.createEvent(EVENT_NAME.REMOVE_ROLE, { role, account_id }, token_asset);
    return await this.Ctx.Token.removeRoleMember(role, account_id, token_asset);
  }
Parameters:
  • account_id: string – The unique ID of the token account.
  • role: string – The name of the role to remove from the specified user. The mintable and burnable behaviors correspond to the minter_role_name and burner_role_name properties of the specification file. Similarly, the notary role corresponds to the notary_role_name property of the specification file.
Returns:
  • On success, a message with account details.
Return Value Example:
{
   "msg": "Successfully removed role 'notary' from Account Id: oaccount~2eb5f8a9bc561f8f41a4ea3be9511958cc6684ef14f2337ca396efc301b627d8"
}
getAccountsByRole
This method returns a list of all account IDs for a specified role and token. This method can be called only by a Token Admin or Token Auditor. 
@GetMethod()
  @Validator(yup.string(), yup.string())
  public async getAccountsByRole(token_id: string, role: string) {
    await this.Ctx.Auth.checkAuthorization("ROLE.getAccountsByRole", "TOKEN");
    return await this.Ctx.Role.getAccountsByRole(token_id, role);
  }
Parameters:
  • token_id: string – The ID of the token.
  • role: string – The name of the role to search for.
Returns:
  • On success, a JSON array of account IDs.
Return Value Example:
{
           "accounts": [
               "oaccount~5abb4155f4b245bb1732321e3174ac81999b03495b5c74f8e1f270bafbadef75"
           ]
       }
getOrgAccountsByRole
This method returns a list of all account IDs for a specified role, token, and organization. This method can be called only by a Token Admin or Token Auditor, or by an Org Admin or Org Auditor of the specified organization. 
@GetMethod()
  @Validator(yup.string(), yup.string(), yup.string())
  public async getOrgAccountsByRole(token_id: string, role: string, org_id: string) {
    await this.Ctx.Auth.checkAuthorization("ROLE.getOrgAccountsByRole", "TOKEN", { org_id });
    return await this.Ctx.Role.getOrgAccountsByRole(token_id, role, org_id);
  }
Parameters:
  • token_id: string – The ID of the token.
  • role: string – The name of the role to search for.
  • org_id: string – The membership service provider (MSP) ID of the organization.
Returns:
  • On success, a JSON array of account IDs.
Return Value Example:
{
           "accounts": [
               "oaccount~5abb4155f4b245bb1732321e3174ac81999b03495b5c74f8e1f270bafbadef75"
           ]
       }
getUsersByRole
This method returns a list of all users for a specified role and token. This method can be called only by a Token Admin or Token Auditor. 
@GetMethod()
  @Validator(yup.string(), yup.string())
  public async getUsersByRole(token_id: string, role: string) {
    await this.Ctx.Auth.checkAuthorization("ROLE.getUsersByRole", "TOKEN");
    return await this.Ctx.Role.getUsersByRole(token_id, role);
  }
Parameters:
  • token_id: string – The ID of the token.
  • role: string – The name of the role to search for.
Return Value Example:
{
          "users": [
              {
                  "token_id": "token",
                  "org_id": "CentralBank"
              }
          ]
      }
getOrgUsersByRole
This method returns a list of all users for a specified role, token, and organization. This method can be called only by a Token Admin or Token Auditor, or by an Org Admin or Org Auditor of the specified organization. 
@GetMethod()
  @Validator(yup.string(), yup.string(), yup.string())
  public async getOrgUsersByRole(token_id: string, role: string, org_id: string) {
    await this.Ctx.Auth.checkAuthorization("ROLE.getOrgUsersByRole", "TOKEN", { org_id });
    return await this.Ctx.Role.getOrgUsersByRole(token_id, role, org_id);
  }
Parameters:
  • token_id: string – The ID of the token.
  • role: string – The name of the role to search for.
  • org_id: string – The membership service provider (MSP) ID of the organization.
Return Value Example:
{
           "users": [
               {
                   "token_id": "token",
                   "org_id": "CentralBank",
                   "user_id": "cb1",
                   "custom_account_id": "1234567jh"
               }
           ]
       }
isInRole
This method returns a Boolean value to indicate if a user has a specified role. This method can be called only by a Token Admin or Token Auditor, the AccountOwner of the account, or an Org Admin or Org Auditor of the specified organization. 
@GetMethod()
  @Validator(yup.string(), yup.string())
  public async isInRole(account_id: string, role: string) {
    const account: FungibleAccount = await this.Ctx.Account.getAccountWithTokenIdValidation(account_id);
    const token_asset = await this.getTokenObject(account.token_id);
    await this.Ctx.Auth.checkAuthorization("TOKEN.isInRole", "TOKEN", { account_id });
    return { result: await this.Ctx.Token.isInRole(role, account_id, token_asset) };
  }
Parameters:
  • account_id: string – The unique ID of the token account.
  • role: string – The name of the role to search for.
Returns:
  • On success, a JSON string of the Boolean result.
Return Value Example:
{
           "result": "true"
       }
getAccountTransactionHistory
This method returns an array of account transaction history details for a specified account. This method can be called only by the Token Admin or Token Auditor, an Org Admin or Org Auditor of the specified organization, or the AccountOwner of the account. 
@GetMethod()
  @Validator(yup.string())
  public async getAccountTransactionHistory(account_id: string) {
    const account: FungibleAccount = await this.Ctx.Account.getAccountWithTokenIdValidation(account_id);
    await this.Ctx.Auth.checkAuthorization("ACCOUNT.getAccountTransactionHistory", "TOKEN", { account_id });
    return await this.Ctx.Account.getAccountTransactionHistory(account_id, account.org_id);
  }
Parameters:
  • account_id: string – The unique ID of the account.
Return Value Example:
[
    {
        "transaction_id": "otransaction~4514aa229ebcc4d2fedcaa47c4301615e30c4a9bae45cf0256a5b80d75b3697a",
        "transacted_amount": 1000,
        "timestamp": "2025-08-25T13:20:50.000Z",
        "token_id": "USD",
        "transacted_account": "oaccount~da6e14466a0ba9b48ebc18fa672addb92dffc371bf953c3229a95b2ff2d9cd41",
        "transaction_type": "APPROVE_MINT",
        "balance": 21000,
        "onhold_balance": 0
    },
    {
        "transaction_id": "otransaction~1982f73495060e0eef4d78282a91c41e27e8c95572739b0677a1e404a0d20aa9",
        "transacted_amount": 200,
        "timestamp": "2025-08-25T13:12:43.000Z",
        "token_id": "USD",
        "transacted_account": "oaccount~da6e14466a0ba9b48ebc18fa672addb92dffc371bf953c3229a95b2ff2d9cd41",
        "transaction_type": "REQUEST_MINT",
        "balance": 20000,
        "onhold_balance": 0
    },
    .
    .
    .  
    .
    {
        "transaction_id": "otransaction~396e6ca5a11a9609632d0864026409d46a708fb95e3e21b39fa5f3fb78f90872",
        "transacted_amount": 0,
        "timestamp": "2025-08-12T20:43:20.000Z",
        "token_id": "",
        "transacted_account": "oaccount~da6e14466a0ba9b48ebc18fa672addb92dffc371bf953c3229a95b2ff2d9cd41",
        "transaction_type": "CREATE_ACCOUNT",
        "balance": 0,
        "onhold_balance": 0
    }
]
getAccountTransactionHistoryWithFilters
This method returns a filtered array of account transaction history details for a specified user and token. This method can be called only by the Token Admin or Token Auditor, an Org Admin or Org Auditor of the specified organization, or the AccountOwner of the account. This method can be called only when connected to a remote Oracle Blockchain Platform network. 
@GetMethod()
  @Validator(yup.string(), yup.object().nullable())
  public async getAccountTransactionHistoryWithFilters(account_id: string, filters?: Filters) {
    const account: FungibleAccount = await this.Ctx.Account.getAccountWithTokenIdValidation(account_id);
    await this.Ctx.Auth.checkAuthorization("ACCOUNT.getAccountTransactionHistoryWithFilters", "TOKEN", { account_id });
    return await this.Ctx.Account.getAccountTransactionHistoryWithFilters(account_id, account.org_id, filters);
  }
Parameters:
  • account_id: string – The unique ID of the account.
  • filters: string – An optional parameter. If empty, all records are returned. The PageSize property determines the number of records to return. If PageSize is 0, the default page size is 20. The Bookmark property determines the starting index of the records to return. For more information, see the Hyperledger Fabric documentation. The StartTime and EndTime properties must be specified in RFC-3339 format, as shown in the following example.
    {
     "pageSize": 20,
     "bookmark": "",
     "startTime": "1900-01-01T00:00:00+00:00",
     "endTime": "2100-01-01T00:00:00+00:00"
 }
Example Postman Request Body:
curl --location 'https://centralbank-oabcs1-bom.blockchain.ocp.oraclecloud.com:7443/restproxy/api/v2/channels/default/chaincode-queries' \
--header 'Content-Type: application/json' \
--header 'Authorization: Basic Y2I6MTIzNDVAQXBwQnVpbGRlcg==' \
--data '{
    "chaincode": "confDev",
    "args": [
        "getAccountTransactionHistoryWithFilters"
    ],
    "timeout": 12000,
    "sync": true,
    "peer": "centralbank-oabcs1-bom.blockchain.ocp.oraclecloud.com:20010",
    "transientMap": {
        "args": "[\"oaccount~3a1b1c307883c0f74473fedfa62894d510b68959c4a21c7abb9d0224151aa573\",\"{\\\"pageSize\\\":20,\\\"bookmark\\\":\\\"\\\",\\\"startTime\\\":\\\"1900-01-01T00:00:00+00:00\\\",\\\"endTime\\\":\\\"2100-01-01T00:00:00+00:00\\\"}\"]"
    }
}'
Return Value Example:
[
            {
                "transaction_id": "otransaction~ccc2c2e89ab7887af4fdad3dc9918ea057a8aa834a0ed8d0f23271049f084952",
                "transacted_amount": 8,
                "timestamp": "2025-08-20T23:22:53.000Z",
                "token_id": "token",
                "category": "category value",
                "description": "description value",
                "holding_id": "ohold~cbdc~token~hold1",
                "to_account_id": "oaccount~22776ada3efff6aaf4c68c204c1f063b139adfa1bca79ed53199117c34036cfc",
                "to_org_id": "Org1",
                "to_user_id": "cb",
                "to_custom_account_id": "1234567jh",
                "from_account_id": "oaccount~5abb4155f4b245bb1732321e3174ac81999b03495b5c74f8e1f270bafbadef75",
                "from_org_id": "CentralBank",
                "from_user_id": "Not Available",
                "from_custom_account_id": "Not Available",
                "transacted_account": "oaccount~5abb4155f4b245bb1732321e3174ac81999b03495b5c74f8e1f270bafbadef75",
                "transaction_type": "CREDIT",
                "balance": 18,
                "onhold_balance": 0,
                "transacted_org_id": "CentralBank",
                "transacted_user_id": "Not Available",
                "transacted_custom_account_id": "Not Available"
            },
            {
                "transaction_id": "otransaction~6c0452a58f13db93f1c308d60eab1fde6c911921b350c0bbbe0ce7dab394721d",
                "transacted_amount": 10,
                "timestamp": "2025-08-20T23:04:53.000Z",
                "token_id": "token",
                "category": "category value",
                "description": "description value",
                "holding_id": "ohold~cbdc~token~hold1",
                "to_account_id": "oaccount~22776ada3efff6aaf4c68c204c1f063b139adfa1bca79ed53199117c34036cfc",
                "to_org_id": "Org1",
                "to_user_id": "cb",
                "to_custom_account_id": "1234567jh",
                "from_account_id": "oaccount~5abb4155f4b245bb1732321e3174ac81999b03495b5c74f8e1f270bafbadef75",
                "from_org_id": "CentralBank",
                "from_user_id": "Not Available",
                "from_custom_account_id": "Not Available",
                "transacted_account": "oaccount~5abb4155f4b245bb1732321e3174ac81999b03495b5c74f8e1f270bafbadef75",
                "transaction_type": "CREDIT",
                "balance": 10,
                "onhold_balance": 0,
                "transacted_org_id": "CentralBank",
                "transacted_user_id": "Not Available",
                "transacted_custom_account_id": "Not Available"
            },
            .
            .
            .
            .
            {
                "transaction_id": "otransaction~df98e24a3b90661b54b54289b600b13a1051c922db0a4d20e3705a9820ae9c20",
                "transacted_amount": 0,
                "timestamp": "2025-08-20T22:55:09.000Z",
                "category": "",
                "description": "",
                "from_account_id": "oaccount~22776ada3efff6aaf4c68c204c1f063b139adfa1bca79ed53199117c34036cfc",
                "from_org_id": "Org1",
                "from_user_id": "cb",
                "from_custom_account_id": "1234567jh",
                "transacted_account": "oaccount~22776ada3efff6aaf4c68c204c1f063b139adfa1bca79ed53199117c34036cfc",
                "transaction_type": "CREATE_ACCOUNT",
                "balance": 0,
                "onhold_balance": 0,
                "transacted_org_id": "Org1",
                "transacted_user_id": "cb",
                "transacted_custom_account_id": "1234567jh"
            }
        ]
getAccountTransactionHistoryWithFiltersFromRichHistDB
This method fetches transaction history from the rich history database. This method can be called only by the Token Admin or Token Auditor, an Org Admin or Org Auditor of the specified organization, or the AccountOwner of the account. 
@GetMethod()
  @Validator(yup.string(), yup.string(), yup.string(), yup.object().nullable())
  public async getAccountTransactionHistoryWithFiltersFromRichHistDB(account_id: string, custom_endpoint: string, bearer_token: string, filters?: Filters) {
    const account: FungibleAccount = await this.Ctx.Account.getAccountWithTokenIdValidation(account_id);
    await this.Ctx.Auth.checkAuthorization("ACCOUNT.getAccountTransactionHistoryWithFiltersFromRichHistDB", "TOKEN", { account_id });
    return await this.Ctx.Account.getAccountTrxHistoryWithFiltersFromRichHistDB(account_id, account.org_id, custom_endpoint, bearer_token, filters);
  }
Parameters:
  • account_id: string – The unique ID of the account.
  • custom_endpoint – The RESTful service endpoint of the rich history database.
  • bearer_token – The access authorization token for the RESTful service endpoint.
  • filters: string – An optional parameter. If empty, all records are returned. The PageSize property determines the number of records to return. If PageSize is 0, the default page size is 20. The Bookmark property determines the starting index of the records to return. For more information, see the Hyperledger Fabric documentation. The StartTime and EndTime properties must be specified in RFC-3339 format, as shown in the following example.
    {
     "pageSize": 20,
     "bookmark": "",
     "startTime": "1900-01-01T00:00:00+00:00",
     "endTime": "2100-01-01T00:00:00+00:00"
 }
Example Postman Request Body:
curl --location 'https://centralbank-oabcs1-bom.blockchain.ocp.oraclecloud.com:7443/restproxy/api/v2/channels/default/chaincode-queries' \
--header 'Content-Type: application/json' \
--header 'Authorization: Basic Y2I6MTIzNDVAQXBwQnVpbGRlcg==' \
--data '{
    "chaincode": "confDev",
    "args": [
        "getAccountTransactionHistoryWithFiltersFromRichHistDB"
    ],
    "timeout": 12000,
    "sync": true,
    "peer": "centralbank-oabcs1-bom.blockchain.ocp.oraclecloud.com:20010",
    "transientMap": {
        "args": "[\"oaccount~22776ada3efff6aaf4c68c204c1f063b139adfa1bca79ed53199117c34036cfc\",\"https://g5363dsasdade33f4-sampledb.adb.ap-sydney-1.oraclecloudapps.com/ords/obp2/conf_cc2/conf_cc2\",\"Dtbw-ehx7QjXfw2VbZsMzQ\",\"{\\\"pageSize\\\":20,\\\"bookmark\\\":\\\"\\\",\\\"startTime\\\":\\\"1900-01-01T00:00:00+00:00\\\",\\\"endTime\\\":\\\"2100-01-01T00:00:00+00:00\\\"}\"]"
    }
}'
Return Value Example:
[
    {
        "transaction_id": "otransaction~3140569a4ecb3c3f141cc2468fe21276640b7fd79013d951d9104b79072d8f9c",
        "transacted_amount": 200,
        "timestamp": "2025-08-25T13:16:55.000Z",
        "token_id": "USD",
        "transacted_account": "oaccount~76687c724ddbc2d6e6664d9618b2bf1c2a9fe10f84887462447e4caba6aaaff3",
        "transacted_org_id": "Org1",
        "transacted_user_id": "fi1_org_officer_demo",
        "transacted_custom_account_id": "20200222221111",
        "to_account": "oaccount~76687c724ddbc2d6e6664d9618b2bf1c2a9fe10f84887462447e4caba6aaaff3",
        "to_org_id": "Org1",
        "to_user_id": "fi1_org_officer_demo",
        "to_custom_account_id": "20200222221111",
        "from_account": "oaccount~68d67712f500e9dac8c314c19744003a993250271d960e9b0d25267bb18dfe9a",
        "from_org_id": "CentralBank",
        "from_user_id": "cb_issuer_demo",
        "from_custom_account_id": "10109999001234",
        "transaction_type": "EXECUTEHOLD",
        "category": "transfer",
        "balance": 26800,
        "onhold_balance": 300
    },
    {
        "transaction_id": "otransaction~5112f576c94c2d23c342479bfa37e34612414b3258a64b43cf51b920f4ff5868",
        "transacted_amount": 5000,
        "timestamp": "2025-08-12T21:05:02.000Z",
        "token_id": "USD",
        "transacted_account": "oaccount~cea6080858337b1575d6a76ed0bd07a0eacd8871e3f2f7f793729a0e4b0e8e98",
        "transacted_org_id": "CentralBank",
        "transacted_user_id": "cb_retirer_demo",
        "transacted_custom_account_id": "10109999006543",
        "to_account": "oaccount~cea6080858337b1575d6a76ed0bd07a0eacd8871e3f2f7f793729a0e4b0e8e98",
        "to_org_id": "CentralBank",
        "to_user_id": "cb_retirer_demo",
        "to_custom_account_id": "10109999006543",
        "from_account": "oaccount~68d67712f500e9dac8c314c19744003a993250271d960e9b0d25267bb18dfe9a",
        "from_org_id": "CentralBank",
        "from_user_id": "cb_issuer_demo",
        "from_custom_account_id": "10109999001234",
        "transaction_type": "DEBIT",
        "category": "burn",
        "balance": 45000,
        "onhold_balance": 0
    },
    .  
    .
    .
    .
    {
        "transaction_id": "otransaction~862aa9d9e877d3ea209b87299ab5b12c13ed5ce43d1cf1b934043c1dd02f58f6",
        "transacted_amount": 50000,
        "timestamp": "2025-08-12T21:04:22.000Z",
        "token_id": "USD",
        "transacted_account": "oaccount~da6e14466a0ba9b48ebc18fa672addb92dffc371bf953c3229a95b2ff2d9cd41",
        "transacted_org_id": "CentralBank",
        "transacted_user_id": "cb__creator_demo",
        "transacted_custom_account_id": "10105678004567",
        "to_account": "oaccount~68d67712f500e9dac8c314c19744003a993250271d960e9b0d25267bb18dfe9a",
        "to_org_id": "CentralBank",
        "to_user_id": "cb_issuer_demo",
        "to_custom_account_id": "10109999001234",
        "from_account": "oaccount~da6e14466a0ba9b48ebc18fa672addb92dffc371bf953c3229a95b2ff2d9cd41",
        "from_org_id": "CentralBank",
        "from_user_id": "cb__creator_demo",
        "from_custom_account_id": "10105678004567",
        "transaction_type": "CREDIT",
        "category": "transfer",
        "balance": 50000,
        "onhold_balance": 0
    }
]
getOrgAccountsTransactionHistoryWithFiltersFromRichHistDB
This method fetches transaction history from the rich history database for the specified organization. This method can be called only by the Token Admin or Token Auditor, an Org Admin or Org Auditor of the specified organization, or the AccountOwner of the account. 
@GetMethod()
  @Validator(yup.string(), yup.string(), yup.string(), yup.object().nullable())
  public async getOrgAccountsTransactionHistoryWithFiltersFromRichHistDB(org_id: string, custom_endpoint: string, bearer_token: string, filters?: Filters) {
    await this.Ctx.Auth.checkAuthorization("ACCOUNT.getOrgAccountsTransactionHistoryWithFiltersFromRichHistDB", "TOKEN", { org_id });
    return await this.Ctx.Account.getOrgAccountsTrxHistoryWithFiltersFromRichHistDB(org_id, custom_endpoint, bearer_token, filters);
  }
Parameters:
  • org_id: string – The membership service provider (MSP) ID of the organization.
  • custom_endpoint – The RESTful service endpoint of the rich history database.
  • bearer_token – The access authorization token for the RESTful service endpoint.
  • filters: string – An optional parameter. If empty, all records are returned. The PageSize property determines the number of records to return. If PageSize is 0, the default page size is 20. The Bookmark property determines the starting index of the records to return. For more information, see the Hyperledger Fabric documentation. The StartTime and EndTime properties must be specified in RFC-3339 format, as shown in the following example.
    {
     "pageSize": 20,
     "bookmark": "",
     "startTime": "1900-01-01T00:00:00+00:00",
     "endTime": "2100-01-01T00:00:00+00:00"
 }
Example Postman Request Body:
curl --location 'https://org1-oabcs1-bom.blockchain.ocp.oraclecloud.com:7443/restproxy/api/v2/channels/default/chaincode-queries' \
--header 'Content-Type: application/json' \
--header 'Authorization: Basic Y2I6MTIzNDVAQXBwQnVpbGRlcg==' \
--data '{
    "chaincode": "confDev",
    "args": [
        "getOrgAccountsTransactionHistoryWithFiltersFromRichHistDB"
    ],
    "timeout": 12000,
    "sync": true,
    "peer": "org1-oabcs1-bom.blockchain.ocp.oraclecloud.com:20010",
    "transientMap": {
        "args": "[\"Org1\",\"https://g5363dsasdade33f4-sampledb.adb.ap-sydney-1.oraclecloudapps.com/ords/obp2/conf_cc2/conf_cc2AllOrgAccounts\",\"Dtbw-ehx7QjXfw2VbZsMzQ\",\"{\\\"pageSize\\\":20,\\\"bookmark\\\":\\\"\\\",\\\"startTime\\\":\\\"1900-01-01T00:00:00+00:00\\\",\\\"endTime\\\":\\\"2100-01-01T00:00:00+00:00\\\"}\"]"
    }
}'
Return Value Example:
[
    {
        "transaction_id": "otransaction~4793f3907eefce2f9fca7ef107405b0f116efb3afbf83fa0e61fe763690c8235",
        "transacted_amount": 100,
        "timestamp": "2025-08-25T13:47:56.000Z",
        "token_id": "USD",
        "transacted_account": "oaccount~76687c724ddbc2d6e6664d9618b2bf1c2a9fe10f84887462447e4caba6aaaff3",
        "transacted_org_id": "Org1",
        "transacted_user_id": "fi1_org_officer_demo",
        "transacted_custom_account_id": "20200222221111",
        "to_account": "oaccount~68d67712f500e9dac8c314c19744003a993250271d960e9b0d25267bb18dfe9a",
        "to_org_id": "CentralBank",
        "from_account": "oaccount~76687c724ddbc2d6e6664d9618b2bf1c2a9fe10f84887462447e4caba6aaaff3",
        "from_org_id": "Org1",
        "from_user_id": "fi1_org_officer_demo",
        "from_custom_account_id": "20200222221111",
        "transaction_type": "ONHOLD",
        "holding_id": "ohold~cbdc~USD~2ac01689",
        "category": "issuance"
    },
    {
        "transaction_id": "otransaction~5177f7560d32838242a26ac74f2a90c6ff9b47aae0d0988f28d9b4cf7e27c097",
        "transacted_amount": 10,
        "timestamp": "2025-08-25T13:22:23.000Z",
        "token_id": "USD",
        "transacted_account": "oaccount~1e31495a0c149b08cb9d02bdcac5e83d88c0f1557d954dda12bb807d7f6fc111",
        "transacted_org_id": "Org1",
        "transacted_user_id": "fi1_org_user1_demo",
        "transacted_custom_account_id": "20200198765432",
        "to_account": "oaccount~d08ff55a040d5e5dcf406009bab1b3398e06c374356efb1bddbf2f17fc37f949",
        "to_org_id": "Org1",
        "to_user_id": "fi1_org_user2_demo",
        "to_custom_account_id": "20200211112222",
        "from_account": "oaccount~1e31495a0c149b08cb9d02bdcac5e83d88c0f1557d954dda12bb807d7f6fc111",
        "from_org_id": "Org1",
        "from_user_id": "fi1_org_user1_demo",
        "from_custom_account_id": "20200198765432",
        "transaction_type": "CREDIT",
        "holding_id": "ohold~cbdc~USD~454f4bf6",
        "category": "transfer"
    },
    .
    .
    .
    .
    {
        "transaction_id": "otransaction~b7c97d737fb978651c9132276ab677c0bcf795b9db13d0d39cba5243615c7389",
        "transacted_amount": 10,
        "timestamp": "2025-08-21T08:46:09.000Z",
        "token_id": "USD",
        "transacted_account": "oaccount~76687c724ddbc2d6e6664d9618b2bf1c2a9fe10f84887462447e4caba6aaaff3",
        "transacted_org_id": "Org1",
        "transacted_user_id": "fi1_org_officer_demo",
        "transacted_custom_account_id": "20200222221111",
        "to_account": "oaccount~1e31495a0c149b08cb9d02bdcac5e83d88c0f1557d954dda12bb807d7f6fc111",
        "to_org_id": "Org1",
        "to_user_id": "fi1_org_user1_demo",
        "to_custom_account_id": "20200198765432",
        "from_account": "oaccount~76687c724ddbc2d6e6664d9618b2bf1c2a9fe10f84887462447e4caba6aaaff3",
        "from_org_id": "Org1",
        "from_user_id": "fi1_org_officer_demo",
        "from_custom_account_id": "20200222221111",
        "transaction_type": "ONHOLD",
        "holding_id": "ohold~cbdc~USD~4fbbb846",
        "category": "transfer"
    }
]
getAllAccountsTransactionHistoryWithFiltersFromRichHistDB
This method fetches transaction history from the rich history database for all organizations. This method can be called only by the Token Admin or Token Auditor. 
@GetMethod()
  @Validator(yup.string(), yup.string(), yup.object().nullable())
  public async getAllAccountsTransactionHistoryWithFiltersFromRichHistDB(custom_endpoint: string, bearer_token: string, filters?: Filters) {
    await this.Ctx.Auth.checkAuthorization("ACCOUNT.getAllAccountsTransactionHistoryWithFiltersFromRichHistDB", "TOKEN");
    return await this.Ctx.Account.getAllAccountsTrxHistoryWithFiltersFromRichHistDB(custom_endpoint, bearer_token, filters);
  }
Parameters:
  • custom_endpoint – The RESTful service endpoint of the rich history database.
  • bearer_token – The access authorization token for the RESTful service endpoint.
  • filters: string – An optional parameter. If empty, all records are returned. The PageSize property determines the number of records to return. If PageSize is 0, the default page size is 20. The Bookmark property determines the starting index of the records to return. For more information, see the Hyperledger Fabric documentation. The StartTime and EndTime properties must be specified in RFC-3339 format, as shown in the following example.
    {
     "pageSize": 20,
     "bookmark": "",
     "startTime": "1900-01-01T00:00:00+00:00",
     "endTime": "2100-01-01T00:00:00+00:00"
 }
Example Postman Request Body:
curl --location 'https://centralbank-oabcs1-bom.blockchain.ocp.oraclecloud.com:7443/restproxy/api/v2/channels/default/chaincode-queries' \
--header 'Content-Type: application/json' \
--header 'Authorization: Basic Y2I6MTIzNDVAQXBwQnVpbGRlcg==' \
--data '{
    "chaincode": "confDev",
    "args": [
        "getAllAccountsTransactionHistoryWithFiltersFromRichHistDB"
    ],
    "timeout": 12000,
    "sync": true,
    "peer": "centralbank-oabcs1-bom.blockchain.ocp.oraclecloud.com:20010",
    "transientMap": {
        "args": "[\"https://g5363dsasdade33f4-sampledb.adb.ap-sydney-1.oraclecloudapps.com/ords/obp2/conf_cc2/conf_cc2AllAccounts\",\"Dtbw-ehx7QjXfw2VbZsMzQ\",\"{\\\"pageSize\\\":20,\\\"bookmark\\\":\\\"\\\",\\\"startTime\\\":\\\"1900-01-01T00:00:00+00:00\\\",\\\"endTime\\\":\\\"2100-01-01T00:00:00+00:00\\\"}\"]"
    }
}'
Return Value Example:
[
    {
        "transaction_id": "otransaction~62eb436be7c29fc2ed9cae221e874d9a31b163fa10374e7da09bf5e09a96c3ff",
        "transacted_amount": 10000,
        "timestamp": "2025-08-25T13:57:58.000Z",
        "token_id": "USD",
        "transacted_account": "oaccount~68d67712f500e9dac8c314c19744003a993250271d960e9b0d25267bb18dfe9a",
        "transacted_org_id": "CentralBank",
        "transacted_user_id": "cb_issuer_demo",
        "transacted_custom_account_id": "10109999001234",
        "to_account": "oaccount~68d67712f500e9dac8c314c19744003a993250271d960e9b0d25267bb18dfe9a",
        "to_org_id": "CentralBank",
        "to_user_id": "cb_issuer_demo",
        "to_custom_account_id": "10109999001234",
        "from_account": "oaccount~da6e14466a0ba9b48ebc18fa672addb92dffc371bf953c3229a95b2ff2d9cd41",
        "from_org_id": "CentralBank",
        "from_user_id": "cb__creator_demo",
        "from_custom_account_id": "10105678004567",
        "transaction_type": "DEBIT",
        "category": "issuance"
    },
    {
        "transaction_id": "otransaction~4793f3907eefce2f9fca7ef107405b0f116efb3afbf83fa0e61fe763690c8235",
        "transacted_amount": 100,
        "timestamp": "2025-08-25T13:47:56.000Z",
        "token_id": "USD",
        "transacted_account": "oaccount~76687c724ddbc2d6e6664d9618b2bf1c2a9fe10f84887462447e4caba6aaaff3",
        "transacted_org_id": "Org1",
        "transacted_user_id": "fi1_org_officer_demo",
        "transacted_custom_account_id": "20200222221111",
        "to_account": "oaccount~68d67712f500e9dac8c314c19744003a993250271d960e9b0d25267bb18dfe9a",
        "to_org_id": "CentralBank",
        "to_user_id": "cb_issuer_demo",
        "to_custom_account_id": "10109999001234",
        "from_account": "oaccount~76687c724ddbc2d6e6664d9618b2bf1c2a9fe10f84887462447e4caba6aaaff3",
        "from_org_id": "Org1",
        "from_user_id": "fi1_org_officer_demo",
        "from_custom_account_id": "20200222221111",
        "transaction_type": "ONHOLD",
        "holding_id": "ohold~cbdc~USD~2ac01689",
        "category": "issuance"
    },
    .
    .
    .
    .
    {
        "transaction_id": "otransaction~5177f7560d32838242a26ac74f2a90c6ff9b47aae0d0988f28d9b4cf7e27c097",
        "transacted_amount": 10,
        "timestamp": "2025-08-25T13:22:23.000Z",
        "token_id": "USD",
        "transacted_account": "oaccount~d08ff55a040d5e5dcf406009bab1b3398e06c374356efb1bddbf2f17fc37f949",
        "transacted_org_id": "Org1",
        "transacted_user_id": "fi1_org_user2_demo",
        "transacted_custom_account_id": "20200211112222",
        "to_account": "oaccount~d08ff55a040d5e5dcf406009bab1b3398e06c374356efb1bddbf2f17fc37f949",
        "to_org_id": "Org1",
        "to_user_id": "fi1_org_user2_demo",
        "to_custom_account_id": "20200211112222",
        "from_account": "oaccount~1e31495a0c149b08cb9d02bdcac5e83d88c0f1557d954dda12bb807d7f6fc111",
        "from_org_id": "Org1",
        "from_user_id": "fi1_org_user1_demo",
        "from_custom_account_id": "20200198765432",
        "transaction_type": "EXECUTEHOLD",
        "holding_id": "ohold~cbdc~USD~454f4bf6",
        "category": "transfer"
    }
]
deleteHistoricalTransactions
This method deletes older transactions from the state database. This method can be called only by a Token Admin. 
@Validator(yup.date())
  public async deleteHistoricalTransactions(time_to_expiration: Date) {
    await this.Ctx.Auth.checkAuthorization("TRANSACTION.deleteTransactions", "TOKEN");
    await this.Ctx.Model.createEvent(EVENT_NAME.DELETE_HISTORICAL_TRANSACTIONS, { time_to_expiration });
    return await this.Ctx.Transaction.deleteTransactions(time_to_expiration);
  }
Parameters:
  • time_to_expiration Date – A time stamp that indicates when to delete transactions. Transaction assets that are older than the specified time will be deleted.
Return Value Example:
{
    "msg": "Successfully deleted transaction older than date: Thu Aug 19 2025 11:19:36 GMT+0000 (Coordinated Universal Time).",
    "transactions": [
           "otransaction~ec3366dd48b4ce2838f820f2f138648e6e55a07226713e59b411ff31b0d21058"
     ]
}
getTransactionById
This method returns the history of a Transaction asset. This method can be called only by a Token Admin or Token Auditor, by an Org Admin or Org Auditor of the specified organization, or by a transaction participant (sender, recipient, or notary). 
@GetMethod()
  @Validator(yup.string())
  public async getTransactionById(transaction_id: string) {
    await this.Ctx.Auth.checkAuthorization("TRANSACTION.getTransactionById", "TOKEN", { transaction_id });
    return await this.Ctx.Transaction.getTransactionById(transaction_id);
  }
Parameters:
  • transaction_id string – The ID of the transaction asset.
Returns:
  • On success, an JSON array of the history for the transaction.
Return Value Example:
{
    "transaction_id": "otransaction~6523597253e45b3c976aecdc54e2c6316d0a4f88ad5d7f3fff48c69213e4375a",
    "history": [
        {
            "trxId": "6523597253e45b3c976aecdc54e2c6316d0a4f88ad5d7f3fff48c69213e4375a",
            "timeStamp": "2025-08-20T23:21:45.000Z",
            "value": {
                "assetType": "otransaction",
                "transaction_id": "otransaction~6523597253e45b3c976aecdc54e2c6316d0a4f88ad5d7f3fff48c69213e4375a",
                "token_id": "token",
                "from_account_id": "oaccount~22776ada3efff6aaf4c68c204c1f063b139adfa1bca79ed53199117c34036cfc",
                "to_account_id": "oaccount~5e3b5a3306d7ca3f3e3fe7cc27b6ae547e94dba1c5af58a69a771d7a619b6a66",
                "transaction_type": "TRANSFER",
                "amount": 22,
                "timestamp": "2025-08-20T23:21:45.000Z",
                "number_of_sub_transactions": 0,
                "holding_id": "",
                "sub_transaction": "false",
                "category": "category value",
                "description": "description value"
            }
        }
    ],
    "sub_transactions": []
}
consolidateRunningBalanceInTransactions
This method calculates the running account balances and saves the updated values in the transaction key/value pairs. Typically the system administrators call this method by using a REST proxy scheduler. This method can be called only by a Token Admin or Org Admin. 
@Validator(yup.string())
  public async consolidateRunningBalanceInTransactions() {
    await this.Ctx.Auth.checkAuthorization("TRANSACTION.consolidateRunningBalanceInTransactions", "TOKEN");
    return this.Ctx.Transaction.consolidateRunningBalanceInTransactions(true);
  }
Return Value Example:
{ msg: "Successfully updated account running balance for pending transactions."}
processSendersAndReceivers
This method calculates and update the token account balances that are spread in the sender and receiver key/value pairs that were created during inter-organization transfers, and then deletes the sender and receiver key/value pairs, which are no longer of use. Typically the system administrators call this method by using a REST proxy scheduler. This method can be called only by a Token Admin or Org Admin. 
@Validator(yup.string())
  public async processSendersAndReceivers() {
    await this.Ctx.Auth.checkAuthorization("ACCOUNT.processSendersAndReceivers", "TOKEN");
    return this.Ctx.Account.processSendersAndReceivers(true);
  }
Return Value Example:
{ msg: "Successfully updated balance for accounts from pending receivers."}
requestMint
This method can be called by a minter to send a request to the minter notary to create a specified amount of tokens. 
@Validator(
    yup.string(),
    yup.string(),
    yup.number().positive(),
    yup.date(),
    yup.object().nullable()
  )
  public async requestMint(
      operation_id: string,
      notary_account_id: string,
      quantity:number,
      time_to_expiration: Date,
      info_details ?: InfoDetails
  ) {
    const notary_account: FungibleAccount = await this.Ctx.Account.getAccountWithTokenIdValidation(notary_account_id);
    const token_asset = await this.getTokenObject(notary_account.token_id);
    await this.Ctx.Model.createEvent(EVENT_NAME.REQUEST_MINT, { operation_id, notary_account_id, quantity, time_to_expiration, info_details }, token_asset);
    return await this.Ctx.Hold.hold(operation_id, null, notary_account_id, quantity, time_to_expiration, token_asset, HoldOperationType.MINT, info_details);
  }
Parameters:
  • operation_id: string – The unique operation ID that represents the mint request.
  • notary_account_id: string – The unique account ID of the minter notary who will process the request.
  • quantity: number – The amount of tokens to mint.
  • time_to_expiration – The time after which the minting request expires and is no longer valid.
  • info_details: JSON – An object specifying the category (category) and description (description) of the request.

    You specify the info_details parameter in a different format if you are using Visual Studio Code versus the CLI or a Postman collection.

    Visual Studio Code: { "category": "category value", "description": "description value" }

    CLI / Postman: "{\"category\":\"category value\",\"description\":\"description value\"}"

Return Value Example:
{
           "msg": "AccountId oaccount~da6e14466a0ba9b48ebc18fa672addb92dffc371bf953c3229a95b2ff2d9cd41 has successfully submitted request to mint 200 tokens"
       }
approveMint
This method can be called by a minter notary to approve a minting request. 
@Validator(yup.string(), yup.string())
  public async approveMint(token_id: string, operation_id: string) {
    const token_asset = await this.getTokenObject(token_id);
    await this.Ctx.Model.createEvent(EVENT_NAME.APPROVE_MINT, { token_asset, operation_id }, token_asset);
    return await this.Ctx.Hold.executeHold(operation_id, token_asset, HoldOperationType.MINT);
  }
Parameters:
  • token_id: string – The ID of the token to mint.
  • operation_id: string – The unique operation ID that represents the mint request.
Return Value Example:
{
           "msg": "Successfully minted 1000 tokens to Account Id: oaccount~da6e14466a0ba9b48ebc18fa672addb92dffc371bf953c3229a95b2ff2d9cd41"
       }
rejectMint
This method can be called by a minter notary to reject a minting request. 
@Validator(yup.string(), yup.string())
  public async rejectMint(token_id: string, operation_id: string) {
    const token_asset = await this.getTokenObject(token_id);
    await this.Ctx.Model.createEvent(EVENT_NAME.REJECT_MINT, { token_asset, operation_id }, token_asset);
    return await this.Ctx.Hold.releaseHold(operation_id, token_asset, HoldOperationType.MINT);
  }
Parameters:
  • token_id: string – The ID of the token to mint.
  • operation_id: string – The unique operation ID that represents the mint request.
Return Value Example:
{
           "msg": "Successfully rejected mint request with Operation Id '89ce' to mint 2000 tokens of token id USD"
       }
issueTokens
This method mints tokens, which are then owned by the caller of the method.
@Validator(yup.string(), yup.number().positive(), yup.object().nullable())
  public async issueTokens(token_id: string, quantity: number, info_details?: InfoDetails) {
    const token_asset = await this.getTokenObject(token_id);
    await this.Ctx.Model.createEvent(EVENT_NAME.ISSUE_TOKENS, { quantity, token_asset, info_details }, token_asset);
    return await this.Ctx.Token.mint(quantity, token_asset, info_details);
  }
Parameters:
  • token_id: string – The ID of the token.
  • quantity – The number of tokens to mint.
  • info_details: JSON – An object specifying the category (category) and description (description) of the request.

    You specify the info_details parameter in a different format if you are using Visual Studio Code versus the CLI or a Postman collection.

    Visual Studio Code: { "category": "category value", "description": "description value" }

    CLI / Postman: "{\"category\":\"category value\",\"description\":\"description value\"}"

Return Value Example:
{
          "msg": "Successfully minted 1000 tokens to Account Id: oaccount~da6e14466a0ba9b48ebc18fa672addb92dffc371bf953c3229a95b2ff2d9cd41"
      }
getTotalMintedTokens
This method returns the total number of minted tokens for a specified token. This method can be called only by a Token Admin, Token Auditor, Org Admin or Org Auditor. 
@GetMethod()
  @Validator(yup.string())
  public async getTotalMintedTokens(token_id: string) {
    const token_asset = await this.getTokenObject(token_id);
    await this.Ctx.Auth.checkAuthorization("TOKEN.getTotalMintedTokens", "TOKEN");
    const totalMintedTokens = await this.Ctx.Token.getTotalMintedTokens(token_asset);
    return {
      msg: `Total minted token for Token Id: ${token_id} is ${totalMintedTokens} tokens.`,
      quantity: totalMintedTokens,
    };
  }
Parameters:
  • token_id: string – The ID of the token.
Returns:
  • On success, a JSON string indicating the total number of tokens.
Return Value Example:
{
    "msg": "Total minted token for Token Id: USD is 910 tokens.",
    "quantity": 910
}
getNetTokens
This method returns the total net number of tokens available in the system for a specified token. The net token total is the amount of tokens remaining after tokens are burned. In equation form: net tokens = total minted tokens - total burned tokens. If no tokens are burned, then the number of net tokens is equal to the total minted tokens. This method can be called only by a Token Admin, Token Auditor, Org Admin or Org Auditor. 
@GetMethod()
  @Validator(yup.string())
  public async getNetTokens(token_id: string) {
    const token_asset = await this.getTokenObject(token_id);
    await this.Ctx.Auth.checkAuthorization("TOKEN.getNetTokens", "TOKEN");
    const netTokens = await this.Ctx.Token.getNetTokens(token_asset);
    return {
      msg: `Net supply of token for Token Id: ${token_id} is ${netTokens} tokens.`,
      quantity: netTokens,
    };
  }
Parameters:
  • token_id: string – The ID of the token.
Returns:
  • On success, a JSON string indicating the net number of tokens.
Return Value Example:
{
    "msg": "Net supply of token for Token Id: USD is 878 tokens.",
    "quantity": 878
}
transferTokens
This method transfers tokens from the caller to a specified account.
@Validator(yup.string(), yup.number(), yup.object().nullable())
  public async transferTokens(to_account_id: string, quantity: number, info_details ?: InfoDetails) {
    if (quantity <= 0) {
      throw new Error("The quantity should be a positive number.")
    }
    const to_account: FungibleAccount = await this.Ctx.Account.getAccountWithTokenIdValidation(to_account_id);
    const token_asset = await this.getTokenObject(to_account.token_id);
    await this.Ctx.Model.createEvent(EVENT_NAME.TRANSFER_TOKENS, { to_account_id, quantity, info_details }, token_asset);
    let isNotary = await this.Ctx.Token.checkNotary(to_account_id, token_asset);
    if(isNotary) {
      throw new Error(`To Account Id '${to_account_id}' can not have a notary role!`);
    }
    return await this.Ctx.Token.transfer(to_account_id, quantity, token_asset, info_details);
  }
Parameters:
  • to_account_id: string – The unique account ID of the receiver (payee).
  • quantity: number – The number of tokens to transfer.
  • info_details: JSON – An object specifying the category (category) and description (description) of the request.

    You specify the info_details parameter in a different format if you are using Visual Studio Code versus the CLI or a Postman collection.

    Visual Studio Code: { "category": "category value", "description": "description value" }

    CLI / Postman: "{\"category\":\"category value\",\"description\":\"description value\"}"

Return Value Example:
{
          "msg": "Successfully transferred 10000 tokens from account id: oaccount~da6e14466a0ba9b48ebc18fa672addb92dffc371bf953c3229a95b2ff2d9cd41  to account id: oaccount~68d67712f500e9dac8c314c19744003a993250271d960e9b0d25267bb18dfe9a."
      }
holdTokens
This method creates a hold on behalf of the caller (the owner of the tokens) with the to_account_id account. The specified notary account is responsible for either completing or releasing the hold. When the hold is created, the specified token balance from the payer is put on hold. A held balance cannot be transferred until the hold is either completed or released. 
@Validator(
    yup.string(),
    yup.string(),
    yup.string(),
    yup.number().positive(),
    yup.date(),
    yup.object().nullable()
  )
  public async holdTokens(
    operation_id: string,
    to_account_id: string,
    notary_account_id: string,
    quantity: number,
    time_to_expiration: Date,
    info_details ?: InfoDetails,
  ) {
    const to_account: FungibleAccount = await this.Ctx.Account.getAccountWithTokenIdValidation(to_account_id);
    await this.Ctx.Account.getAccountWithTokenIdValidation(notary_account_id);
    const token_asset = await this.getTokenObject(to_account.token_id);
    await this.Ctx.Model.createEvent(EVENT_NAME.HOLD_TOKENS, {
      operation_id,
      to_account_id,
      notary_account_id,
      quantity,
      time_to_expiration,
      info_details
    }, token_asset);
    return await this.Ctx.Hold.hold(operation_id, to_account_id, notary_account_id, quantity, time_to_expiration, token_asset, HoldOperationType.TRANSFER, info_details);
  }
Parameters:
  • operation_id: string – A unique ID to identify the hold operation. Typically this ID is passed by the client application.
  • to_account_id: string – The unique account ID of the receiver.
  • notary_account_id: string – The unique account ID of the notary.
  • quantity: number – The number of tokens to put on hold.
  • time_to_expiration – The time when the hold expires. Specify 0 for a permanent hold. Otherwise use the RFC-3339 format. For example, 2021-06-02T12:46:06Z.
  • info_details: JSON – An object specifying the category (category) and description (description) of the request.

    You specify the info_details parameter in a different format if you are using Visual Studio Code versus the CLI or a Postman collection.

    Visual Studio Code: { "category": "category value", "description": "description value" }

    CLI / Postman: "{\"category\":\"category value\",\"description\":\"description value\"}"

Return Value Example:
{
           "msg": "AccountId oaccount~76687c724ddbc2d6e6664d9618b2bf1c2a9fe10f84887462447e4caba6aaaff3 is successfully holding 100 tokens"
       }
executeHoldTokens
This method completes a hold on a token. A quantity of tokens previously held by a token owner is transferred to a receiver. If the quantity value is less than the actual hold value, then the remaining amount is available again to the original owner of the tokens. This method can be called only by the AccountOwner ID with the notary role for the specified operation ID. The hold can only be completed by the notary. 
@Validator(yup.string(), yup.string(), yup.number().positive())
  public async executeHoldTokens(token_id: string, operation_id: string, quantity: number) {
    const token_asset = await this.getTokenObject(token_id);
    await this.Ctx.Model.createEvent(EVENT_NAME.EXECUTE_HOLD_TOKENS, { token_asset, operation_id, quantity }, token_asset);
    return await this.Ctx.Hold.executeHold(operation_id, token_asset, HoldOperationType.TRANSFER, quantity);
  }
Parameters:
  • token_id: string – The ID of the token.
  • operation_id: string – A unique ID to identify the hold operation. Typically this ID is passed by the client application.
  • quantity: number – The number of on-hold tokens to transfer.
Returns:
  • On success, a message with the caller's account ID and the quantity of the transaction.
Return Value Example:
{
           "msg": "Account Id: oaccount~1e31495a0c149b08cb9d02bdcac5e83d88c0f1557d954dda12bb807d7f6fc111 is successfully executed '10' tokens from Operation Id '454f4bf6'."
       }
releaseHoldTokens
This method releases a hold on tokens. The transfer is not completed and all held tokens are available again to the original owner. This method can be called by the AccountOwner ID with the notary role within the specified time limit or by the payer, payee, or notary after the specified time limit. 
@Validator(yup.string(), yup.string())
  public async releaseHoldTokens(token_id: string, operation_id: string) {
    const token_asset = await this.getTokenObject(token_id);
    await this.Ctx.Model.createEvent(EVENT_NAME.RELEASE_HOLD_TOKENS, { token_asset, operation_id }, token_asset);
    return await this.Ctx.Hold.releaseHold(operation_id, token_asset, HoldOperationType.TRANSFER);
  }
Parameters:
  • token_id: string – The ID of the token.
  • operation_id: string – A unique ID to identify the hold operation. Typically this ID is passed by the client application.
Returns:
  • On success, a message indicating that the hold was released.
Return Value Example:
{
           "msg": "Successfully released '200' tokens from Operation Id '77b75873' to Account Id: oaccount~68d67712f500e9dac8c314c19744003a993250271d960e9b0d25267bb18dfe9a."
       }
getOnHoldIds
This method returns a list of all of the holding IDs for a specified account. This method can be called by a Token Admin or Token Auditor of the chaincode, an Org Admin or Org Auditor of the specified organization, or the AccountOwner of the account. 
@GetMethod()
  @Validator(yup.string())
  public async getOnHoldIds(account_id: string) {
    await this.Ctx.Account.getAccountWithTokenIdValidation(account_id);
    await this.Ctx.Auth.checkAuthorization("ACCOUNT.getOnHoldIds", "TOKEN", { account_id });
    return await this.Ctx.Account.getOnHoldIds(account_id);
  }
Parameters:
  • account_id: string – The unique ID of the token account.
Returns:
  • On success, a JSON list of holding IDs.
Return Value Example:
{
           "msg": "Holding Ids are: ",
           "holding_ids": ["ohold~cbdc~token~hold1"]
       }
getOnHoldDetailsWithOperationId
This method returns the on-hold transaction details for a specified operation ID and token. This method can be called by a Token Admin or Token Auditor of the chaincode, or by a transaction participant (sender, recipient, notary). 
@GetMethod()
  @Validator(yup.string(), yup.string())
  public async getOnHoldDetailsWithOperationId(token_id: string, operation_id: string) {
    await this.Ctx.Auth.checkAuthorization("ACCOUNT.getOnHoldDetailsWithOperationId", "TOKEN", { token_id, operation_id });
    return await this.Ctx.Hold.getOnHoldDetailsWithOperationId(token_id, operation_id);
  }
Parameters:
  • token_id: string – The ID of the token.
  • operation_id: string – A unique ID to identify the hold operation. Typically this ID is passed by the client application.
Return Value Example:
{
          "assetType": "ohold",
          "holding_id": "ohold~cbdc~token~hold1",
          "operation_id": "hold1",
          "token_name": "cbdc",
          "from_org_id": "CentralBank",
          "operation_type": "transfer",
          "status": "approved",
          "from_account_id": "oaccount~5abb4155f4b245bb1732321e3174ac81999b03495b5c74f8e1f270bafbadef75",
          "to_account_id": "oaccount~22776ada3efff6aaf4c68c204c1f063b139adfa1bca79ed53199117c34036cfc",
          "notary_account_id": "oaccount~1da238c1491c919b151f777a615fb5779032c34b3ef3adeca6afe591bac10aaf",
          "token_id": "token",
          "quantity": "0",
          "time_to_expiration": "2029-01-04T00:00:00.000Z",
          "category": "category value",
          "description": "description value"
      }
getOnHoldBalanceWithOperationId
This method returns the on-hold balance for a specified operation ID and token. This method can be called by a Token Admin or Token Auditor of the chaincode, or by a transaction participant (sender, recipient, notary). 
@GetMethod()
  @Validator(yup.string(), yup.string())
  public async getOnHoldBalanceWithOperationId(token_id: string, operation_id: string) {
    await this.Ctx.Auth.checkAuthorization("ACCOUNT.getOnHoldBalanceWithOperationId", "TOKEN", { token_id, operation_id });
    return await this.Ctx.Hold.getOnHoldBalanceWithOperationId(token_id, operation_id);
  }
Parameters:
  • token_id: string – The ID of the token.
  • operation_id: string – A unique ID to identify the hold operation. Typically this ID is passed by the client application.
Returns:
  • On success, a JSON string indicating the holding balance.
Return Value Example:
{
           "msg": "Current Holding Balance of Operation 'hold1' for token 'token' is: 0",
           "holding_balance": 0
       }
requestBurn
This method can be called by a burner to send a request to the burner notary to destroy a specified amount of tokens.
@Validator(
    yup.string(),
    yup.string(),
    yup.number().positive(),
    yup.date(),
    yup.object().nullable()
  )
  public async requestBurn(
      operation_id: string,
      notary_account_id: string,
      quantity:number,
      time_to_expiration: Date,
      info_details ?: InfoDetails,
  ) {
    const notary_account: FungibleAccount = await this.Ctx.Account.getAccountWithTokenIdValidation(notary_account_id);
    const token_asset = await this.getTokenObject(notary_account.token_id);
    await this.Ctx.Model.createEvent(EVENT_NAME.REQUEST_BURN, { operation_id, notary_account_id, quantity, time_to_expiration, info_details }, token_asset);
    return await this.Ctx.Hold.hold(operation_id, null, notary_account_id, quantity, time_to_expiration, token_asset, HoldOperationType.BURN, info_details);
  }
Parameters:
  • operation_id: string – The unique operation ID that represents the burn request.
  • notary_account_id: string – The unique account ID of the burner notary who will process the request.
  • quantity: number – The amount of tokens to burn.
  • time_to_expiration – The time after which the burning request expires and is no longer valid.
  • info_details: JSON – An object specifying the category (category) and description (description) of the request.

    You specify the info_details parameter in a different format if you are using Visual Studio Code versus the CLI or a Postman collection.

    Visual Studio Code: { "category": "category value", "description": "description value" }

    CLI / Postman: "{\"category\":\"category value\",\"description\":\"description value\"}"

Return Value Example:
{
           "msg": "AccountId oaccount~cea6080858337b1575d6a76ed0bd07a0eacd8871e3f2f7f793729a0e4b0e8e98 has successfully submitted request to burn 100 tokens"
       }
approveBurn
This method can be called by a burner notary to approve a burning request. 
@Validator(yup.string(), yup.string())
  public async approveBurn(token_id: string, operation_id: string) {
    const token_asset = await this.getTokenObject(token_id);
    await this.Ctx.Model.createEvent(EVENT_NAME.APPROVE_BURN, { token_asset, operation_id }, token_asset);
    return await this.Ctx.Hold.executeHold(operation_id, token_asset, HoldOperationType.BURN);
  }
Parameters:
  • token_id: string – The ID of the token to burn.
  • operation_id: string – The unique operation ID that represents the burn request.
Return Value Example:
{
           "msg": "Successfully burned 200 tokens from account id: oaccount~cea6080858337b1575d6a76ed0bd07a0eacd8871e3f2f7f793729a0e4b0e8e98"
       }
rejectBurn
This method can be called by a burner notary to reject a burning request. 
@Validator(yup.string(), yup.string())
  public async rejectBurn(token_id: string, operation_id: string) {
    const token_asset = await this.getTokenObject(token_id);
    await this.Ctx.Model.createEvent(EVENT_NAME.REJECT_BURN, { token_asset, operation_id }, token_asset);
    return await this.Ctx.Hold.releaseHold(operation_id, token_asset, HoldOperationType.BURN);
  }
Parameters:
  • token_id: string – The ID of the token to burn.
  • operation_id: string – The unique operation ID that represents the burn request.
Return Value Example:
{
           "msg": "Successfully rejected burn request with Operation Id '8d34' to burn 100 tokens of token id USD"
       }

TypeScript Methods for Inter-Organizational Transfers

Inter-organization transfers have two parts: first the amount is debited from the sender and then the amount is credited to the receiver. The following two APIs are called together as an atomic transaction using the two-phase commit API of the Oracle Blockchain Platform REST proxy. Confidential transfers are done in this manner because the private data collections of the two organizations are distinct and cannot be accessed in a single transaction.

Both transactions are sent using the two-phase commit API of the REST proxy. For more information, see Invoke Atomic Transaction.

You can create a POST request in the Postman collection where the URL is similar to: https://test-xyz-abc.blockchain.ocp.oraclecloud.com:7443/restproxy/api/v2/atomicTransactions. You must send all essential headers including the following ones.
- Content-Type: application/json
- Confidential-Transaction: true
In the request body, include the executeHoldTokensSenderand executeHoldTokensReceiver methods as shown in the following request.
{
 "transactions": [
   {
        "chaincode": "<chaincode>",
        "args": [
            "executeHoldTokensSender"
        ],
        "timeout": 6000,
        "sync": true,
        "transientMap": {
            "args": "[ \"bc-token-id value\",\"operation_id value\",\"quantity value\"]"
        },
        "endorsers" : <Sender's endorsers List>,
        "channel":"<channel name>"
   },
   {
        "chaincode": "<chaincode name>",
        "args": [
            "executeHoldTokensReceiver"
        ],
        "timeout": 6000,
        "sync": true,
        "transientMap": {
            "args": "[ \"bc-token-id value\",\"operation_id value\",\"quantity value\"]"
        },
        "endorsers" : <Recipient endorsers List>,
        "channel":"<channelName>"
    }
 ],
 "isolationLevel": "readCommitted",
 "prepareTimeout": 10000,
 "copyInputsToTransientMap": true,
 "sync": true,
 "parallelPrepare": true
}
The following example shows a request body.
{
 "transactions": [
   {
        "chaincode": "WholesaleCBDCConfidential",
        "args": [
            "executeHoldTokensSender"
        ],
        "timeout": 6000,
        "sync": true,
        "transientMap": {
            "args": "[ \"bc-token-id value\",\"operation_id value\",\"quantity value\"]"
        },
        "endorsers" : ["org1-xyz-abc.blockchain.ocp.oraclecloud.com:20009", "org1-xyz-abc.blockchain.ocp.oraclecloud.com:20009"],
        "channel":"default"
   },
   {
        "chaincode": "WholesaleCBDCConfidential",
        "args": [
            "executeHoldTokensReceiver"
        ],
        "timeout": 6000,
        "sync": true,
        "transientMap": {
            "args": "[ \"bc-token-id value\",\"operation_id value\",\"quantity value\"]"
        },
        "endorsers" : ["org2-xyz-abc.blockchain.ocp.oraclecloud.com:20009", "org2-xyz-abc.blockchain.ocp.oraclecloud.com:20009"],
        "channel":"default"
    }
 ],
 "isolationLevel": "readCommitted",
 "prepareTimeout": 10000,
 "copyInputsToTransientMap": true,
 "sync": true,
 "parallelPrepare": true
}
executeHoldTokensSender
This method can be called only by the user with the notary role for the specified operation ID. This method is the first part of an approval of an transfer between organizations. The specified amount is deducted from the sender's account.
@ExcludeFromPostmanCollection()
  @Validator(yup.string(), yup.string(), yup.number().positive(), yup.string(), yup.string())
  public async executeHoldTokensSender(token_id: string, operation_id: string, quantity: number,  isolationLevel: string, globalIdInput:string) {
    if (!this.Ctx.Utils.isValidInterOrgTransferRequest()) {
      throw new Error("The request for the inter-org transfer is invalid.")
    }
    const globalTxId =  this.Ctx.Utils.extractGlobalTransactionId(globalIdInput);
    const token_asset = await this.getTokenObject(token_id);
    return await this.Ctx.Hold.executeHoldSender(operation_id, quantity, globalTxId, token_asset);
  }
Parameters:
  • token_id: string – The ID of the token to burn.
  • operation_id: string – The unique operation ID that represents the hold request to approve.
  • quantity: number – The amount of held tokens to transfer.
  • isolationLevel: string – The isolation level of the atomic transaction, either serializable or readCommitted.
  • globalIdInput: string
Return Value Example:
{
      "msg":
        "Account Id: oaccount~68d67712f500e9dac8c314c19744003a993250271d960e9b0d25267bb18dfe9a is successfully executed '10' tokens from Operation Id 'hold1'."
    }
executeHoldTokensReceiver
This method can be called only by the user with the notary role for the specified operation ID. This method is the second part of an approval of an transfer between organizations. The specified amount is credited to the receiver's account.
@ExcludeFromPostmanCollection()
  @Validator(yup.string(), yup.string(), yup.number().positive(), yup.string(), yup.string())
  public async executeHoldTokensReceiver(token_id: string, operation_id: string, quantity: number,  isolationLevel: string, globalIdInput:string) {
    if (!this.Ctx.Utils.isValidInterOrgTransferRequest()) {
      throw new Error("The request for the inter-org transfer is invalid.")
    }
    const globalTxId =  this.Ctx.Utils.extractGlobalTransactionId(globalIdInput);
    const token_asset = await this.getTokenObject(token_id);
    return await this.Ctx.Hold.executeHoldReceiver(operation_id, quantity, globalTxId, token_asset);
  }
Parameters:
  • token_id: string – The ID of the token to burn.
  • operation_id: string – The unique operation ID that represents the hold request to approve.
  • quantity: number – The amount of held tokens to transfer.
  • isolationLevel: string – The isolation level of the atomic transaction, either serializable or readCommitted.
  • globalIdInput: string
Return Value Example:
{
      "msg":
        "Account Id: oaccount~68d67712f500e9dac8c314c19744003a993250271d960e9b0d25267bb18dfe9a is successfully executed '10' tokens from Operation Id 'hold1, receiverId oreceiver~72d9bfcf-2c68-4c33-b8c3-fe3374983bf2'."
    }

Modified TypeScript SDK Methods for Confidential Chaincode

If you include the confidential: true parameter in the specification file for tokens that use the extended Token Taxonomy Framework standard, Blockchain App Builder generates modified versions of the standard SDK methods as well as additional methods.

isUserTokenAdmin
This method returns the Boolean value true if the caller of the function is a Token Admin. Otherwise the method returns false. 
Ctx.Auth.isUserTokenAdmin(org_id: string, user_id: string);
Parameters:
  • org_id – The membership service provider (MSP) ID of the user in the current network organization.
  • user_id – The user name or email ID of the user.
Return Value Example:
{
    "result": true
}
addTokenAdmin
This method adds a user as a Token Admin of the token chaincode. Because the user_id value is stored on the public ledger, do not use any personally identifiable information (PII) for the user_id value. 
Ctx.Admin.addTokenAdmin(org_id: string, user_id: string);
Parameters:
  • user_id – The user name or email ID of the user.
  • org_id – The membership service provider (MSP) ID of the user in the current network organization.
Return Value Example:
{
  "msg": "Successfully added Token Admin (Org_Id: CentralBank, User_Id: cb1)"
}
removeTokenAdmin
This method removes a user as a Token Admin of the token chaincode. 
Ctx.Admin.removeTokenAdmin(org_id: string, user_id: string);
Parameters:
  • user_id – The user name or email ID of the user.
  • org_id – The membership service provider (MSP) ID of the user in the current network organization.
Return Value Example:
{"msg": "Successfully removed Admin (Org_Id: Org1MSP, User_Id: User1)"}
getAllTokenAdmins
This method returns a list of all users who are a Token Admin of the chaincode. 
Ctx.Admin.getAllTokenAdmins();
Parameters:
  • none
Return Value Example:
{"admins":[{"org_id":"Org1MSP","user_id":"admin"}]}
addOrgAdmin
This method adds a user as an Org Admin of the organization. Because the user_id value is stored on the public ledger, do not use any personally identifiable information (PII) for the user_id value. 
 Ctx.Admin.addOrgAdmin(org_id: string, user_id: string);
Parameters:
  • org_id: string – The membership service provider (MSP) ID of the user in the current organization.
  • user_id: string – The user name or email ID of the user.
Return Value Example:
{
    "msg": "Successfully added Org Admin (Org_Id: Org1MSP, User_Id: orgAdmin)"
}
removeOrgAdmin
This method removes a user as an Org Admin of the organization. 
Ctx.Admin.removeOrgAdmin(org_id: string, user_id: string);
Parameters:
  • org_id: string – The membership service provider (MSP) ID of the user in the current organization.
  • user_id: string – The user name or email ID of the user.
Return Value Example:
{
  "msg": "Successfully removed Org Admin (Org_Id Org1MSP User_Id orgAdmin)"
}
getAllOrgAdmins
This method returns a list of all users who are an Org Admin of an organization. 
Ctx.Admin.getAllOrgAdmins();
Parameters:
  • none
Return Value Example:
{
    "admins": [
        {
            "org_id": "Org1MSP",
            "user_id": "orgadmin"
        },
        {
            "org_id": "Org1MSP",
            "user_id": "orgadmin1"
        },
        {
            "org_id": "Org1MSP",
            "user_id": "orgadmin2"
        }
    ]
}
addTokenAuditor
This method adds a user as a Token Auditor of the chaincode. Because the user_id value is stored on the public ledger, do not use any personally identifiable information (PII) for the user_id value. 
Ctx.Admin.addTokenAuditor(org_id: string, user_id: string);
Parameters:
  • org_id: string – The membership service provider (MSP) ID of the user in the current organization.
  • user_id: string – The user name or email ID of the user.
Returns:
  • On success, a message that includes details of the user who was added as a Token Auditor of the chaincode.
Return Value Example:
{
  "msg": "Successfully added Token Auditor (Org_Id: CentralBank, User_Id: cb_admin_demo)"
}
removeTokenAuditor
This method removes a user as a Token Auditor of the chaincode. 
Ctx.Admin.removeTokenAuditor(org_id: string, user_id: string);
Parameters:
  • org_id: string – The membership service provider (MSP) ID of the user in the current organization.
  • user_id: string – The user name or email ID of the user.
Return Value Example:
{
           "msg": "Successfully removed Token Auditor (Org_Id: CB, User_Id: cb)"
       }
getAllTokenAuditors
This method returns all Token Auditors of the chaincode. 
this.Ctx.Admin.getAllTokenAuditors();
addOrgAuditor
This method adds a user as a Org Auditor of the chaincode. 
Ctx.Admin.addOrgAuditor(org_id: string, user_id: string);
Parameters:
  • org_id: string – The membership service provider (MSP) ID of the user in the current organization.
  • user_id: string – The user name or email ID of the user.
Return Value Example:
{
           "msg": "Successfully added Org Auditor (Org_Id: CentralBank, User_Id: cb_admin_demo)"
       }
removeOrgAuditor
This method removes a user as a Org Auditor of the chaincode. 
this.Ctx.Admin.removeOrgAuditor(org_id: string, user_id: string);
Parameters:
  • org_id: string – The membership service provider (MSP) ID of the user in the current organization.
  • user_id: string – The user name or email ID of the user.
Return Value Example:
{
           "msg": "Successfully removed Org Auditor (Org_Id: CB, User_Id: cb)"
       }
getAllOrgAuditors
This method returns all Org Auditors of the chaincode. 
this.Ctx.Admin.getAllOrgAuditors()
getAllTokens
This method returns all the token assets saved in the state database. This method uses Berkeley DB SQL rich queries and can only be called when connected to the remote Oracle Blockchain Platform network.
this.Ctx.Token.getAllTokens();
Parameters:
  • none
Returns:
  • On success, it returns a promise with all the token assets. On error, it returns an error message.
getDecimals
This method returns the number of decimal places available for a fractional token. If the divisible behavior is not specified, then the default value is 0. 
this.Ctx.Token.getDecimals(token_asset)
Parameters:
  • token_id: string – The ID of the token.
Return Value Example:
1
history
This method returns history for the specified token.
Ctx.Token.history(tokenId: string);
Parameters:
  • token_id: string – The ID of the token.
Return Value Example:
[
    {
        "trxId": "0d75f09446a60088afb948c6aca046e261fddcd43df416076201cdc5565f1a35",
        "timeStamp": "2023-09-01T16:48:41.000Z",
        "value": {
            "assetType": "otoken",
            "token_id": "token",
            "token_name": "fiatmoneytok",
            "token_desc": "updatedDesc",
            "token_standard": "ttf+",
            "token_type": "fungible",
            "token_unit": "fractional",
            "behaviors": [
                "divisible",
                "mintable",
                "transferable",
                "burnable",
                "roles"
            ],
            "roles": {
                "minter_role_name": "minter"
            },
            "mintable": {
                "max_mint_quantity": 1000
            },
            "divisible": {
                "decimal": 2
            }
        }
    },
    {
        "trxId": "3666344878b043b65d5b821cc79c042ba52aec467618800df5cf14eac69f72fa",
        "timeStamp": "2023-08-31T20:24:55.000Z",
        "value": {
            "assetType": "otoken",
            "token_id": "token",
            "token_name": "fiatmoneytok",
            "token_standard": "ttf+",
            "token_type": "fungible",
            "token_unit": "fractional",
            "behaviors": [
                "divisible",
                "mintable",
                "transferable",
                "burnable",
                "roles"
            ],
            "roles": {
                "minter_role_name": "minter"
            },
            "mintable": {
                "max_mint_quantity": 1000
            },
            "divisible": {
                "decimal": 2
            }
        }
    }
]
getTokensByName
This method returns all the token assets with the specified name. This method uses Berkeley DB SQL rich queries and can only be called when connected to the remote Oracle Blockchain Platform network.
Ctx.Token.getTokensByName(token_name: string);
Parameters:
  • token_name: string – The name of the token, which corresponds to the Token_name property of the model. The value is the class name of the token.
Return Value Example:
[
 {
    "assetType": "otoken",
    "token_id": "digiCurr101",
    "token_name": "digicur",
    "token_desc": "Digital Currency equiv of dollar",
    "token_type": "fungible",
    "behaviors": [
        "divisible",
        "mintable",
        "transferable",
        "burnable",
        "roles"
    ],
    "roles": {
        "minter_role_name": "minter"
        "burner_role_name": "burner",
        "notary_role_name": "notary"
    },
    "mintable": {
        "max_mint_quantity": 2000
    },
    "divisible": {
        "decimal": 1
    },
    "currency_name": "DOLLAR",
    "token_to_currency_ratio": 1
 }
]
createAccount
This method creates an account for a specified user and token. Every user who has tokens at any point must have an account.
Ctx.Account.createAccount(org_id: string, user_id: string, token_type: string, dailyLimits);
Parameters:
  • org_id: string – The membership service provider (MSP) ID of the user in the current organization. The ID must begin with an alphanumeric character and can include letters, numbers, and special characters such as underscores (_), periods (.), at signs (@), and hyphens (-).
  • user_id: string – The user name or email ID of the user. The ID must begin with an alphanumeric character and can include letters, numbers, and special characters such as underscores (_), periods (.), at signs (@), and hyphens (-).
  • token_type: string – The type of the token, which must be fungible.
  • daily_limits: DailyLimits – A JSON object of the following type.
    {
     "max_daily_amount": 100000
     "max_daily_transactions": 10000
 }
    In the example, the max_daily_amount value is the maximum amount of tokens that can be transacted daily and max_daily_transactions value is the maximum number of transactions that can be completed daily.
Return Value Example:
{
    "bapAccountVersion": 0,
    "assetType": "oaccount",
    "account_id": "oaccount~b53cb2c19c92d1d5c8cb9f6e988e7761c34e03e014e6c4b889565fc0abf46c8a",
    "org_id": "CentralBank",
    "token_type": "fungible",
    "token_id": "",
    "token_name": "",
    "balance": "028b72742c8aa9a0395c828fe4f0e46226a3e40d4e731d0b994c8028c8b7bd4df6",
    "onhold_balance": "028b72742c8aa9a0395c828fe4f0e46226a3e40d4e731d0b994c8028c8b7bd4df6",
    "onhold_burn_balance": "028b72742c8aa9a0395c828fe4f0e46226a3e40d4e731d0b994c8028c8b7bd4df6"
}
associateToken
This method associates a fungible token with an account. 
Ctx.Account.associateToken(account_id: string, token_id: string, custom_account_id?: string);
Parameters:
  • account_id: string – The ID of the account.
  • token_id: string – The ID of the token.
  • custom_account_id: string – For confidential mode, the bank account ID of the account, a unique random alphanumeric identifier. By default, 14 characters long.
Return Value Example:
{
    "bapAccountVersion": 0,
    "assetType": "oaccount",
    "account_id": "oaccount~b53cb2c19c92d1d5c8cb9f6e988e7761c34e03e014e6c4b889565fc0abf46c8a",
    "org_id": "CentralBank",
    "token_type": "fungible",
    "token_id": "USD",
    "token_name": "cbdc",
    "balance": "028b72742c8aa9a0395c828fe4f0e46226a3e40d4e731d0b994c8028c8b7bd4df6",
    "onhold_balance": "028b72742c8aa9a0395c828fe4f0e46226a3e40d4e731d0b994c8028c8b7bd4df6",
    "onhold_burn_balance": "028b72742c8aa9a0395c828fe4f0e46226a3e40d4e731d0b994c8028c8b7bd4df6",
    "application_groups": [
        "CENTRAL_BANK_USERS"
    ]
}
getAllAccounts
This method returns a list of all accounts. This method uses Berkeley DB SQL rich queries and can only be called when connected to the remote Oracle Blockchain Platform network.
this.Ctx.Account.getAllAccounts();
Parameters:
  • none
Return Value Example:
[
    {
        "key": "oaccount~5abb4155f4b245bb1732321e3174ac81999b03495b5c74f8e1f270bafbadef75",
        "valueJson": {
            "bapAccountVersion": 3,
            "assetType": "oaccount",
            "account_id": "oaccount~5abb4155f4b245bb1732321e3174ac81999b03495b5c74f8e1f270bafbadef75",
            "org_id": "CentralBank",
            "token_type": "fungible",
            "token_id": "token",
            "token_name": "cbdc",
            "balance": "028a27c752e9b518d156e61da6589e723b179b6d7351dc34ec92bbb27b783ed1dc",
            "onhold_balance": "02d53a7eda9484bda7252212714f647b70d32663cfa416f93f488ef6b6bc8fb2eb",
            "onhold_burn_balance": "02d53a7eda9484bda7252212714f647b70d32663cfa416f93f488ef6b6bc8fb2eb",
            "application_groups": [
                "application_groups value"
            ]
        }
    },
    {
        "key": "oaccount~1da238c1491c919b151f777a615fb5779032c34b3ef3adeca6afe591bac10aaf",
        "valueJson": {
            "bapAccountVersion": 0,
            "assetType": "oaccount",
            "account_id": "oaccount~1da238c1491c919b151f777a615fb5779032c34b3ef3adeca6afe591bac10aaf",
            "org_id": "CentralBank",
            "token_type": "fungible",
            "token_id": "token",
            "token_name": "cbdc",
            "balance": "020da01cd57249c6470b6dd03c2ee4c49de58c71ccc64f2de1203e835967a0846d",
            "onhold_balance": "020da01cd57249c6470b6dd03c2ee4c49de58c71ccc64f2de1203e835967a0846d",
            "onhold_burn_balance": "020da01cd57249c6470b6dd03c2ee4c49de58c71ccc64f2de1203e835967a0846d",
            "application_groups": [
                "application_groups value"
            ]
        }
    }
]
getAllOrgAccounts
This method returns a list of all token accounts that belong to a specified organization.
Ctx.Account.getAllOrgAccounts(org_id: string);
Parameters:
  • org_id: string – The membership service provider (MSP) ID of the organization.
Return Value Example:
[
    {
        "key": "oaccount~22776ada3efff6aaf4c68c204c1f063b139adfa1bca79ed53199117c34036cfc",
        "valueJson": {
            "bapAccountVersion": 2,
            "assetType": "oaccount",
            "account_id": "oaccount~22776ada3efff6aaf4c68c204c1f063b139adfa1bca79ed53199117c34036cfc",
            "org_id": "CentralBank",
            "token_type": "fungible",
            "token_id": "token",
            "token_name": "cbdc",
            "balance": "18",
            "onhold_balance": "0",
            "onhold_burn_balance": "0",
            "application_groups": [
                "application_groups value"
            ],
            "user_id": "cb",
            "custom_account_id": "1234567jh"
        }
    },
    {
        "key": "oaccount~5e3b5a3306d7ca3f3e3fe7cc27b6ae547e94dba1c5af58a69a771d7a619b6a66",
        "valueJson": {
            "bapAccountVersion": 1,
            "assetType": "oaccount",
            "account_id": "oaccount~5e3b5a3306d7ca3f3e3fe7cc27b6ae547e94dba1c5af58a69a771d7a619b6a66",
            "org_id": "CentralBank",
            "token_type": "fungible",
            "token_id": "token",
            "token_name": "cbdc",
            "balance": "22",
            "onhold_balance": "0",
            "onhold_burn_balance": "0",
            "application_groups": [
                "application_groups value"
            ],
            "user_id": "cb1",
            "custom_account_id": "1234567jh"
        }
    }
]
getAccountsByUser
This method returns a list of all account IDs for a specified user and organization.
Ctx.Account.getAccountsByUser(org_id: string, user_id: string);
Parameters:
  • org_id string – The membership service provider (MSP) ID of the organization.
  • user_id string – The user name or email ID of the user.
Return Value Example:
[
    {
        "bapAccountVersion": 2,
        "assetType": "oaccount",
        "user_id": "cb",
        "custom_account_id": "1234567jh",
        "account_id": "oaccount~22776ada3efff6aaf4c68c204c1f063b139adfa1bca79ed53199117c34036cfc",
        "org_id": "CentralBank",
        "token_type": "fungible",
        "token_id": "token",
        "token_name": "cbdc",
        "balance": "18",
        "onhold_balance": "0",
        "onhold_burn_balance": "0",
        "application_groups": [
            "application_groups value"
        ]
    }
]
getUserByAccountId
This method returns the user details for a specified account.
this.Ctx.Account.getUserByAccountId(account_id: string);
Parameters:
  • account_id: string – The unique ID of the token account.
Return Value Example:
{
    "token_id": "USD",
    "org_id": "CentralBank",
    "user_id": "cb_admin_demo",
    "custom_account_id": "10101234000123"
}
getAccountWithStatus
This method returns account details for a specified user and token.
Ctx.Account.getAccountWithStatus(account_id: string);
Parameters:
  • account_id: string – The unique ID of the token account.
Return Value Example:
{
    "bapAccountVersion": 2,
    "assetType": "oaccount",
    "user_id": "cb",
    "custom_account_id": "1234567jh",
    "status": "active",
    "account_id": "oaccount~22776ada3efff6aaf4c68c204c1f063b139adfa1bca79ed53199117c34036cfc",
    "org_id": "CentralBank",
    "token_type": "fungible",
    "token_id": "token",
    "token_name": "cbdc",
    "balance": "18",
    "onhold_balance": "0",
    "onhold_burn_balance": "0",
    "application_groups": [
        "application_groups value"
    ]
}
getAccountDetailsByCustomAccountId
This method returns all token account details for a specified organization and account ID.
Ctx.Account.getAccountDetailsByCustomAccountId(custom_account_id: string, org_id: string)
Parameters:
  • custom_account_id: string – The bank account ID of the account, a unique random alphanumeric identifier.
  • org_id string – The membership service provider (MSP) ID of the organization.
Return Value Example:
[
    {
        "bapAccountVersion": 0,
        "assetType": "oaccount",
        "account_id": "oaccount~c44ffac4c46718e9744cb0aae2016d26a87a5bef5e2d1c0d1abc7d8782f0ba61",
        "org_id": "CentralBank",
        "token_type": "fungible",
        "token_id": "USD",
        "token_name": "cbdc",
        "balance": "0",
        "onhold_balance": "0",
        "onhold_burn_balance": "0",
        "application_groups": [
            "SYSTEM_ADMINS"
        ],
        "user_id": "cb_admin_demo",
        "custom_account_id": "10101234000123"
    }
]
getAccountBalance
This method returns the account balance for a specified account.
Ctx.Account.getAccountBalance(account_id: string);
Parameters:
  • account_id: string – The unique ID of the token account.
Return Value Example:
{
    "msg": "Current Balance is: 100",
    "user_balance": 100
}
getAccountStatus
This method gets the current status of the token account.
Ctx.AccountStatus.getAccountStatus(account_id: string);
Parameters:
  • account_id: string – The unique ID of the token account.
Return Value Example:
{
    "assetType": "oaccountStatus",
    "status_id": "oaccountStatus~5a0b0d8b1c6433af9fedfe0d9e6580e7cf6b6bb62a0de6267aaf79f79d5e96d7",
    "account_id": "oaccount~1c568151c4acbcd1bd265c766c677145760a61c47fc8a3ba681a4cfbe287f9c1",
    "status": "active"
}
history (Account Status)
This method gets the history of the account status.
Ctx.AccountStatus.history(status_id: string);
Parameters:
  • account_id: string – The unique ID of the token account.
Return Value Example:
[
  {
    "trxId": "d5c6d6f601257ba9b6edaf5b7660f00adc13c37d5321b8f7d3a35afab2e93e63",
    "timeStamp": "2025-12-02T10:39:14.000Z",
    "value": {
      "assetType": "oaccountStatus",
      "status_id": "oaccountStatus~5a0b0d8b1c6433af9fedfe0d9e6580e7cf6b6bb62a0de6267aaf79f79d5e96d7",
      "account_id": "oaccount~1c568151c4acbcd1bd265c766c677145760a61c47fc8a3ba681a4cfbe287f9c1",
      "status": "suspended"
    }
  },
  {
    "trxId": "e6c850cfa084dc20ad95fb2bb8165eef3a3bd62a0ac867cccee57c2003125183",
    "timeStamp": "2025-12-02T10:37:50.000Z",
    "value": {
      "assetType": "oaccountStatus",
      "status_id": "oaccountStatus~5a0b0d8b1c6433af9fedfe0d9e6580e7cf6b6bb62a0de6267aaf79f79d5e96d7",
      "account_id": "oaccount~1c568151c4acbcd1bd265c766c677145760a61c47fc8a3ba681a4cfbe287f9c1",
      "status": "active"
    }
  }
]
activateAccount
This method activates a token account. Deleted accounts cannot be activated.
Ctx.Account.activateAccount(account_id: string);
Parameters:
  • account_id: string – The unique ID of the token account.
Return Value Example:
{
  "assetType": "oaccountStatus",
  "status_id": "oaccountStatus~5a0b0d8b1c6433af9fedfe0d9e6580e7cf6b6bb62a0de6267aaf79f79d5e96d7",
  "account_id": "oaccount~1c568151c4acbcd1bd265c766c677145760a61c47fc8a3ba681a4cfbe287f9c1",
  "status": "active"
}
suspendAccount
This method suspends a token account. After an account is suspended, you cannot complete any operations that update the account. A deleted account cannot be suspended.
Ctx.Account.suspendAccount(account_id: string);
Parameters:
  • account_id: string – The unique ID of the token account.
Return Value Example:
{
    "assetType": "oaccountStatus",
    "status_id": "oaccountStatus~5a0b0d8b1c6433af9fedfe0d9e6580e7cf6b6bb62a0de6267aaf79f79d5e96d7",
    "account_id": "oaccount~1c568151c4acbcd1bd265c766c677145760a61c47fc8a3ba681a4cfbe287f9c1",
    "status": "suspended"
}
deleteAccount
This method deletes a token account. After an account is deleted, you cannot complete any operations that update the account. The deleted account is in a final state and cannot be changed to any other state. To delete an account, the account balance and the on-hold balance must be zero.
Ctx.Account.deleteAccount(account_id: string);
Parameters:
  • account_id: string – The unique ID of the token account.
Return Value Example:
{
  "assetType": "oaccountStatus",
  "status_id": "oaccountStatus~5a0b0d8b1c6433af9fedfe0d9e6580e7cf6b6bb62a0de6267aaf79f79d5e96d7",
  "account_id": "oaccount~1c568151c4acbcd1bd265c766c677145760a61c47fc8a3ba681a4cfbe287f9c1",
  "status": "deleted"
}
setMaxDailyAmount
This method sets the max_daily_amount value for a specified account. 
Ctx.Account.setMaxDailyAmount(account_id: string, max_daily_amount?: string);
Parameters:
  • account_id: string – The unique ID of the token account.
  • max_daily_amount?: string – (Optional) The maximum amount of tokens the user can transfer daily. If not specified, the user can transfer any amount of tokens daily.
Return Value Example:
{
           "msg": "Successfully set max daily amount for account id oaccount~68d67712f500e9dac8c314c19744003a993250271d960e9b0d25267bb18dfe9a to 1000000"
       }
setMaxDailyTransactionCount
This method sets the max_daily_transactions value for a specified account. 
Ctx.Account.setMaxDailyTransactionCount(account_id: string, max_daily_transactions?: string);
Parameters:
  • account_id: string – The unique ID of the token account.
  • max_daily_transactions?: string – (Optional) The maximum number of transactions the user can complete daily. If not specified, the user can complete any number of transactions daily.
Return Value Example:
{
            "msg": "Successfully set max daily transactions for account id oaccount~68d67712f500e9dac8c314c19744003a993250271d960e9b0d25267bb18dfe9a to 100000"
        }
getMaxDailyAmount
This method gets the max_daily_amount value (the maximum amount that can be transferred daily) for a specified account. 
Ctx.Account.getMaxDailyAmount(account_id: string);
Parameters:
  • account_id: string – The unique ID of the token account.
Return Value Example:
{
           "max_daily_amount": "10000"
       }
getMaxDailyTransactionCount
This method gets the max_daily_transactions value (the maximum number of transactions allowed per day) for a specified account. 
Ctx.Account.getMaxDailyTransactionCount(account_id: string);
Parameters:
  • account_id: string – The unique ID of the token account.
Return Value Example:
{
           "max_daily_transactions": "100"
       }
getAccountOnHoldBalance
This method returns the on-hold balance for a specified account.
Ctx.Account.getAccountOnHoldBalance(account_id: string);
Parameters:
  • account_id: string – The unique ID of the token account.
Return Value Example:
{
           "msg": "Total Holding Balance is: 0",
           "holding_balance": 0
       }
addRoleMember
This method adds a role to a specified account.
Ctx.Token.addRoleMember(role: string, account_id: string, token_asset);
Parameters:
  • account_id: number – The account ID to add the role to.
  • role: string – The name of the role to add to the specified user.
  • token_asset: any – The token asset, passed as a parameter. The properties of the token asset are described in the model file.
Return Value Example:
{
     "msg": "Successfully added role 'notary' to Account Id: oaccount~2eb5f8a9bc561f8f41a4ea3be9511958cc6684ef14f2337ca396efc301b627d8"
}
removeRoleMember
This method removes a role from a specified account.
Ctx.Token.removeRoleMember(role: string, account_id: string, token_asset);
Parameters:
  • account_id: number – The account ID to remove the role from.
  • role: string – The name of the role to remove from to the specified user.
  • token_asset: any – The token asset, passed as a parameter. The properties of the token asset are described in the model file.
Return Value Example:
{
   "msg": "Successfully removed role 'notary' from Account Id: oaccount~2eb5f8a9bc561f8f41a4ea3be9511958cc6684ef14f2337ca396efc301b627d8"
}
getAccountsByRole
This method returns a list of all accounts for a specified role and token.
Ctx.Role.getAccountsByRole(token_id: string, role: string);
Parameters:
  • token_id: string – The ID of the token.
  • role: string – The name of the role to search for.
Return Value Example:
{
           "accounts": [
               "oaccount~5abb4155f4b245bb1732321e3174ac81999b03495b5c74f8e1f270bafbadef75"
           ]
       }
getOrgAccountsByRole
This method returns information about all accounts that have a specified role in a specified organization.
Ctx.Role.getOrgAccountsByRole(token_id: string, role: string, org_id: string);
Parameters:
  • token_id: string – The ID of the token.
  • role: string – The name of the role to check for.
  • org_id: string – The membership service provider (MSP) ID of the organization.
Return Value Example:
{
           "accounts": [
               "oaccount~5abb4155f4b245bb1732321e3174ac81999b03495b5c74f8e1f270bafbadef75"
           ]
       }
getUsersByRole
This method returns a list of all users for a specified role and token.
Ctx.Role.getUsersByRole(token_id: string, role: string);
Parameters:
  • token_id: string – The ID of the token.
  • role: string – The name of the role to search for.
Return Value Example:
{
          "users": [
              {
                  "token_id": "token",
                  "org_id": "CentralBank"
              }
          ]
      }
getOrgUsersByRole
This method returns information about all users that have a specified role in a specified organization. 
 Ctx.Role.getOrgUsersByRole(token_id: string, role: string, org_id: string);
Parameters:
  • token_id: string – The ID of the token.
  • role: string – The name of the role to check for.
  • org_id: string – The membership service provider (MSP) ID of the organization.
Return Value Example:
{
           "users": [
               {
                   "token_id": "token",
                   "org_id": "CentralBank",
                   "user_id": "cb1",
                   "custom_account_id": "1234567jh"
               }
           ]
       }
isInRole
This method indicates whether a user has a specified role.
Ctx.Token.isInRole(role: string, account_id: string, token_asset)
Parameters:
  • account_id: number – The unique ID of the token account.
  • role: string – The name of the role to check.
  • token_asset: any – The token asset, passed as a parameter. The properties of the token asset are described in the model file.
Return Value Example:
{
           "result": "true"
       }
getAccountTransactionHistory
This method returns an array of the transaction history details for a specified account.
Ctx.Account.getAccountTransactionHistory(account_id: string)
Parameters:
  • account_id: string – The unique ID of the token account.
Return Value Example:
[
    {
        "transaction_id": "otransaction~4514aa229ebcc4d2fedcaa47c4301615e30c4a9bae45cf0256a5b80d75b3697a",
        "transacted_amount": 1000,
        "timestamp": "2025-08-25T13:20:50.000Z",
        "token_id": "USD",
        "transacted_account": "oaccount~da6e14466a0ba9b48ebc18fa672addb92dffc371bf953c3229a95b2ff2d9cd41",
        "transaction_type": "APPROVE_MINT",
        "balance": 21000,
        "onhold_balance": 0
    },
    {
        "transaction_id": "otransaction~1982f73495060e0eef4d78282a91c41e27e8c95572739b0677a1e404a0d20aa9",
        "transacted_amount": 200,
        "timestamp": "2025-08-25T13:12:43.000Z",
        "token_id": "USD",
        "transacted_account": "oaccount~da6e14466a0ba9b48ebc18fa672addb92dffc371bf953c3229a95b2ff2d9cd41",
        "transaction_type": "REQUEST_MINT",
        "balance": 20000,
        "onhold_balance": 0
    },
    {
        "transaction_id": "otransaction~fedd714cf1509f7517819d7cd4c0921d0b2f5d1ff6a25dcb08ab411defd6b5f3",
        "transacted_amount": 2000,
        "timestamp": "2025-08-21T05:23:25.000Z",
        "token_id": "USD",
        "transacted_account": "oaccount~da6e14466a0ba9b48ebc18fa672addb92dffc371bf953c3229a95b2ff2d9cd41",
        "transaction_type": "REQUEST_MINT",
        "balance": 20000,
        "onhold_balance": 0
    },
    {
        "transaction_id": "otransaction~f33b47234f3ee0b636962c8c31c01d06523b789ca16b3b342d5080b71268bcc3",
        "transacted_amount": 1000,
        "timestamp": "2025-08-21T05:23:07.000Z",
        "token_id": "USD",
        "transacted_account": "oaccount~da6e14466a0ba9b48ebc18fa672addb92dffc371bf953c3229a95b2ff2d9cd41",
        "transaction_type": "REQUEST_MINT",
        "balance": 20000,
        "onhold_balance": 0
    },
    {
        "transaction_id": "otransaction~cf934527149bc24f62a8ddeeea7f74a19a0f84d8f161535a771be49d2520d5b3",
        "transacted_amount": 10000,
        "timestamp": "2025-08-13T06:12:41.000Z",
        "token_id": "USD",
        "transacted_account": "oaccount~da6e14466a0ba9b48ebc18fa672addb92dffc371bf953c3229a95b2ff2d9cd41",
        "transaction_type": "APPROVE_MINT",
        "balance": 20000,
        "onhold_balance": 0
    },
    {
        "transaction_id": "otransaction~f5c0e11ca61d9adc843658929e6de2a738ad586304f9e020f75bf4aac5e42a2c",
        "transacted_amount": 10000,
        "timestamp": "2025-08-13T06:12:04.000Z",
        "token_id": "USD",
        "transacted_account": "oaccount~da6e14466a0ba9b48ebc18fa672addb92dffc371bf953c3229a95b2ff2d9cd41",
        "transaction_type": "REQUEST_MINT",
        "balance": 10000,
        "onhold_balance": 0
    },
    {
        "transaction_id": "otransaction~862aa9d9e877d3ea209b87299ab5b12c13ed5ce43d1cf1b934043c1dd02f58f6",
        "transacted_amount": 50000,
        "timestamp": "2025-08-12T21:04:22.000Z",
        "token_id": "USD",
        "category": "transfer",
        "transacted_account": "oaccount~68d67712f500e9dac8c314c19744003a993250271d960e9b0d25267bb18dfe9a",
        "transaction_type": "DEBIT",
        "balance": 10000,
        "onhold_balance": 0
    },
    {
        "transaction_id": "otransaction~8a74c6d87ca74a613aab9db5d40386f8d5b534f9800503af8ca27e8946d7616d",
        "transacted_amount": 40000,
        "timestamp": "2025-08-12T21:01:27.000Z",
        "token_id": "USD",
        "transacted_account": "oaccount~da6e14466a0ba9b48ebc18fa672addb92dffc371bf953c3229a95b2ff2d9cd41",
        "transaction_type": "REJECT_MINT",
        "balance": 60000,
        "onhold_balance": 0
    },
    {
        "transaction_id": "otransaction~28ac66ba33f7ad0648448964b2b74525c9e3f0c9908c7a0484690b9baa56c2db",
        "transacted_amount": 30000,
        "timestamp": "2025-08-12T21:01:16.000Z",
        "token_id": "USD",
        "transacted_account": "oaccount~da6e14466a0ba9b48ebc18fa672addb92dffc371bf953c3229a95b2ff2d9cd41",
        "transaction_type": "APPROVE_MINT",
        "balance": 60000,
        "onhold_balance": 0
    },
    {
        "transaction_id": "otransaction~7e32ad8f365ff59814e112f27602f30ab599fb9c1638784496c66a61a6277c22",
        "transacted_amount": 20000,
        "timestamp": "2025-08-12T21:01:05.000Z",
        "token_id": "USD",
        "transacted_account": "oaccount~da6e14466a0ba9b48ebc18fa672addb92dffc371bf953c3229a95b2ff2d9cd41",
        "transaction_type": "APPROVE_MINT",
        "balance": 30000,
        "onhold_balance": 0
    },
    {
        "transaction_id": "otransaction~1477050bb9e55f4f471872b31fce0d2097f5d5e57d89a842070df5e36d7ab0da",
        "transacted_amount": 10000,
        "timestamp": "2025-08-12T21:01:03.000Z",
        "token_id": "USD",
        "transacted_account": "oaccount~da6e14466a0ba9b48ebc18fa672addb92dffc371bf953c3229a95b2ff2d9cd41",
        "transaction_type": "APPROVE_MINT",
        "balance": 10000,
        "onhold_balance": 0
    },
    {
        "transaction_id": "otransaction~0e76c6931b7ee134e967e847d9730b867a0fd191d39697d83d36dd15745c02e3",
        "transacted_amount": 40000,
        "timestamp": "2025-08-12T21:00:20.000Z",
        "token_id": "USD",
        "transacted_account": "oaccount~da6e14466a0ba9b48ebc18fa672addb92dffc371bf953c3229a95b2ff2d9cd41",
        "transaction_type": "REQUEST_MINT",
        "balance": 0,
        "onhold_balance": 0
    },
    {
        "transaction_id": "otransaction~07bbf9c190694371626da59ded5d87434d26f612891e13bb15bdd28f6086e760",
        "transacted_amount": 30000,
        "timestamp": "2025-08-12T21:00:01.000Z",
        "token_id": "USD",
        "transacted_account": "oaccount~da6e14466a0ba9b48ebc18fa672addb92dffc371bf953c3229a95b2ff2d9cd41",
        "transaction_type": "REQUEST_MINT",
        "balance": 0,
        "onhold_balance": 0
    },
    {
        "transaction_id": "otransaction~8721175c6cbbce17b6c4bb6a444e475d07f52352dfd0d990679f342215153513",
        "transacted_amount": 20000,
        "timestamp": "2025-08-12T20:59:41.000Z",
        "token_id": "USD",
        "transacted_account": "oaccount~da6e14466a0ba9b48ebc18fa672addb92dffc371bf953c3229a95b2ff2d9cd41",
        "transaction_type": "REQUEST_MINT",
        "balance": 0,
        "onhold_balance": 0
    },
    {
        "transaction_id": "otransaction~dc24c24d43a6525e807a39edcf8c6a2b6ccb81f0d755958f509509687eacee84",
        "transacted_amount": 10000,
        "timestamp": "2025-08-12T20:59:13.000Z",
        "token_id": "USD",
        "transacted_account": "oaccount~da6e14466a0ba9b48ebc18fa672addb92dffc371bf953c3229a95b2ff2d9cd41",
        "transaction_type": "REQUEST_MINT",
        "balance": 0,
        "onhold_balance": 0
    },
    {
        "transaction_id": "otransaction~396e6ca5a11a9609632d0864026409d46a708fb95e3e21b39fa5f3fb78f90872",
        "transacted_amount": 0,
        "timestamp": "2025-08-12T20:43:20.000Z",
        "token_id": "",
        "transacted_account": "oaccount~da6e14466a0ba9b48ebc18fa672addb92dffc371bf953c3229a95b2ff2d9cd41",
        "transaction_type": "CREATE_ACCOUNT",
        "balance": 0,
        "onhold_balance": 0
    }
]
getAccountTransactionHistoryWithFilters
This method returns an array of the transaction history details for a specified account. This method can only be called when connected to the remote Oracle Blockchain Platform network.
Ctx.Account.getAccountTransactionHistoryWithFilters(account_id: string, org_id: string, filters);
Parameters:
  • account_id: string – The ID of the account.
  • org_id: string – The membership service provider (MSP) ID of the organization.
  • filters: string – An optional parameter. If empty, all records are returned. The PageSize property determines the number of records to return. If PageSize is 0, the default page size is 20. The Bookmark property determines the starting index of the records to return. For more information, see the Hyperledger Fabric documentation. The StartTime and EndTime properties must be specified in RFC-3339 format.
Return Value Example:
[
             {
                "transaction_id": "otransaction~ccc2c2e89ab7887af4fdad3dc9918ea057a8aa834a0ed8d0f23271049f084952",
                "transacted_amount": 8,
                "timestamp": "2025-08-20T23:22:53.000Z",
                "token_id": "token",
                "category": "category value",
                "description": "description value",
                "holding_id": "ohold~cbdc~token~hold1",
                "to_account_id": "oaccount~22776ada3efff6aaf4c68c204c1f063b139adfa1bca79ed53199117c34036cfc",
                "to_org_id": "Org1",
                "to_user_id": "cb",
                "to_custom_account_id": "1234567jh",
                "from_account_id": "oaccount~5abb4155f4b245bb1732321e3174ac81999b03495b5c74f8e1f270bafbadef75",
                "from_org_id": "CentralBank",
                "from_user_id": "Not Available",
                "from_custom_account_id": "Not Available",
                "transacted_account": "oaccount~5abb4155f4b245bb1732321e3174ac81999b03495b5c74f8e1f270bafbadef75",
                "transaction_type": "CREDIT",
                "balance": 18,
                "onhold_balance": 0,
                "transacted_org_id": "CentralBank",
                "transacted_user_id": "Not Available",
                "transacted_custom_account_id": "Not Available"
            },
            {
                "transaction_id": "otransaction~6c0452a58f13db93f1c308d60eab1fde6c911921b350c0bbbe0ce7dab394721d",
                "transacted_amount": 10,
                "timestamp": "2025-08-20T23:04:53.000Z",
                "token_id": "token",
                "category": "category value",
                "description": "description value",
                "holding_id": "ohold~cbdc~token~hold1",
                "to_account_id": "oaccount~22776ada3efff6aaf4c68c204c1f063b139adfa1bca79ed53199117c34036cfc",
                "to_org_id": "Org1",
                "to_user_id": "cb",
                "to_custom_account_id": "1234567jh",
                "from_account_id": "oaccount~5abb4155f4b245bb1732321e3174ac81999b03495b5c74f8e1f270bafbadef75",
                "from_org_id": "CentralBank",
                "from_user_id": "Not Available",
                "from_custom_account_id": "Not Available",
                "transacted_account": "oaccount~5abb4155f4b245bb1732321e3174ac81999b03495b5c74f8e1f270bafbadef75",
                "transaction_type": "CREDIT",
                "balance": 10,
                "onhold_balance": 0,
                "transacted_org_id": "CentralBank",
                "transacted_user_id": "Not Available",
                "transacted_custom_account_id": "Not Available"
            },
            .
            .
            .
            .
            {
                "transaction_id": "otransaction~df98e24a3b90661b54b54289b600b13a1051c922db0a4d20e3705a9820ae9c20",
                "transacted_amount": 0,
                "timestamp": "2025-08-20T22:55:09.000Z",
                "category": "",
                "description": "",
                "from_account_id": "oaccount~22776ada3efff6aaf4c68c204c1f063b139adfa1bca79ed53199117c34036cfc",
                "from_org_id": "Org1",
                "from_user_id": "cb",
                "from_custom_account_id": "1234567jh",
                "transacted_account": "oaccount~22776ada3efff6aaf4c68c204c1f063b139adfa1bca79ed53199117c34036cfc",
                "transaction_type": "CREATE_ACCOUNT",
                "balance": 0,
                "onhold_balance": 0,
                "transacted_org_id": "Org1",
                "transacted_user_id": "cb",
                "transacted_custom_account_id": "1234567jh"
            }
 ]
getAccountTrxHistoryWithFiltersFromRichHistDB
This method returns an array of the transaction history details from the rich history database.
Ctx.Account.getAccountTrxHistoryWithFiltersFromRichHistDB(account_id: string, org_id: string, custom_endpoint: string, bearer_token: string, filters);
Parameters:
  • account_id: string – The unique ID of the token account.
  • org_id: string – The membership service provider (MSP) ID of the organization.
  • custom_endpoint – The RESTful service endpoint of the rich history database.
  • bearer_token – The access authorization token for the RESTful service endpoint.
  • filters: string – An optional parameter. If empty, all records are returned. The PageSize property determines the number of records to return. If PageSize is 0, the default page size is 20. The Bookmark property determines the starting index of the records to return. For more information, see the Hyperledger Fabric documentation. The StartTime and EndTime properties must be specified in RFC-3339 format.
Return Value Example:
[
    {
        "transaction_id": "otransaction~3140569a4ecb3c3f141cc2468fe21276640b7fd79013d951d9104b79072d8f9c",
        "transacted_amount": 200,
        "timestamp": "2025-08-25T13:16:55.000Z",
        "token_id": "USD",
        "transacted_account": "oaccount~76687c724ddbc2d6e6664d9618b2bf1c2a9fe10f84887462447e4caba6aaaff3",
        "transacted_org_id": "Org1",
        "transacted_user_id": "fi1_org_officer_demo",
        "transacted_custom_account_id": "20200222221111",
        "to_account": "oaccount~76687c724ddbc2d6e6664d9618b2bf1c2a9fe10f84887462447e4caba6aaaff3",
        "to_org_id": "Org1",
        "to_user_id": "fi1_org_officer_demo",
        "to_custom_account_id": "20200222221111",
        "from_account": "oaccount~68d67712f500e9dac8c314c19744003a993250271d960e9b0d25267bb18dfe9a",
        "from_org_id": "CentralBank",
        "from_user_id": "cb_issuer_demo",
        "from_custom_account_id": "10109999001234",
        "transaction_type": "EXECUTEHOLD",
        "category": "transfer",
        "balance": 26800,
        "onhold_balance": 300
    },
    {
        "transaction_id": "otransaction~5112f576c94c2d23c342479bfa37e34612414b3258a64b43cf51b920f4ff5868",
        "transacted_amount": 5000,
        "timestamp": "2025-08-12T21:05:02.000Z",
        "token_id": "USD",
        "transacted_account": "oaccount~cea6080858337b1575d6a76ed0bd07a0eacd8871e3f2f7f793729a0e4b0e8e98",
        "transacted_org_id": "CentralBank",
        "transacted_user_id": "cb_retirer_demo",
        "transacted_custom_account_id": "10109999006543",
        "to_account": "oaccount~cea6080858337b1575d6a76ed0bd07a0eacd8871e3f2f7f793729a0e4b0e8e98",
        "to_org_id": "CentralBank",
        "to_user_id": "cb_retirer_demo",
        "to_custom_account_id": "10109999006543",
        "from_account": "oaccount~68d67712f500e9dac8c314c19744003a993250271d960e9b0d25267bb18dfe9a",
        "from_org_id": "CentralBank",
        "from_user_id": "cb_issuer_demo",
        "from_custom_account_id": "10109999001234",
        "transaction_type": "DEBIT",
        "category": "burn",
        "balance": 45000,
        "onhold_balance": 0
    },
    .  
    .
    .
    .
    {
        "transaction_id": "otransaction~862aa9d9e877d3ea209b87299ab5b12c13ed5ce43d1cf1b934043c1dd02f58f6",
        "transacted_amount": 50000,
        "timestamp": "2025-08-12T21:04:22.000Z",
        "token_id": "USD",
        "transacted_account": "oaccount~da6e14466a0ba9b48ebc18fa672addb92dffc371bf953c3229a95b2ff2d9cd41",
        "transacted_org_id": "CentralBank",
        "transacted_user_id": "cb__creator_demo",
        "transacted_custom_account_id": "10105678004567",
        "to_account": "oaccount~68d67712f500e9dac8c314c19744003a993250271d960e9b0d25267bb18dfe9a",
        "to_org_id": "CentralBank",
        "to_user_id": "cb_issuer_demo",
        "to_custom_account_id": "10109999001234",
        "from_account": "oaccount~da6e14466a0ba9b48ebc18fa672addb92dffc371bf953c3229a95b2ff2d9cd41",
        "from_org_id": "CentralBank",
        "from_user_id": "cb__creator_demo",
        "from_custom_account_id": "10105678004567",
        "transaction_type": "CREDIT",
        "category": "transfer",
        "balance": 50000,
        "onhold_balance": 0
    }
]
getOrgAccountsTrxHistoryWithFiltersFromRichHistDB
This method returns an array of the transaction history details for a specified organization from the rich history database.
Ctx.Account.getOrgAccountsTrxHistoryWithFiltersFromRichHistDB(org_id: string, custom_endpoint: string, bearer_token: string, filters);
Parameters:
  • org_id string – The membership service provider (MSP) ID of the organization.
  • custom_endpoint – The RESTful service endpoint of the rich history database.
  • bearer_token – The access authorization token for the RESTful service endpoint.
  • filters: string – An optional parameter. If empty, all records are returned. The PageSize property determines the number of records to return. If PageSize is 0, the default page size is 20. The Bookmark property determines the starting index of the records to return. For more information, see the Hyperledger Fabric documentation. The StartTime and EndTime properties must be specified in RFC-3339 format.
Return Value Example:
[
    {
        "transaction_id": "otransaction~4793f3907eefce2f9fca7ef107405b0f116efb3afbf83fa0e61fe763690c8235",
        "transacted_amount": 100,
        "timestamp": "2025-08-25T13:47:56.000Z",
        "token_id": "USD",
        "transacted_account": "oaccount~76687c724ddbc2d6e6664d9618b2bf1c2a9fe10f84887462447e4caba6aaaff3",
        "transacted_org_id": "Org1",
        "transacted_user_id": "fi1_org_officer_demo",
        "transacted_custom_account_id": "20200222221111",
        "to_account": "oaccount~68d67712f500e9dac8c314c19744003a993250271d960e9b0d25267bb18dfe9a",
        "to_org_id": "CentralBank",
        "from_account": "oaccount~76687c724ddbc2d6e6664d9618b2bf1c2a9fe10f84887462447e4caba6aaaff3",
        "from_org_id": "Org1",
        "from_user_id": "fi1_org_officer_demo",
        "from_custom_account_id": "20200222221111",
        "transaction_type": "ONHOLD",
        "holding_id": "ohold~cbdc~USD~2ac01689",
        "category": "issuance"
    },
    {
        "transaction_id": "otransaction~5177f7560d32838242a26ac74f2a90c6ff9b47aae0d0988f28d9b4cf7e27c097",
        "transacted_amount": 10,
        "timestamp": "2025-08-25T13:22:23.000Z",
        "token_id": "USD",
        "transacted_account": "oaccount~1e31495a0c149b08cb9d02bdcac5e83d88c0f1557d954dda12bb807d7f6fc111",
        "transacted_org_id": "Org1",
        "transacted_user_id": "fi1_org_user1_demo",
        "transacted_custom_account_id": "20200198765432",
        "to_account": "oaccount~d08ff55a040d5e5dcf406009bab1b3398e06c374356efb1bddbf2f17fc37f949",
        "to_org_id": "Org1",
        "to_user_id": "fi1_org_user2_demo",
        "to_custom_account_id": "20200211112222",
        "from_account": "oaccount~1e31495a0c149b08cb9d02bdcac5e83d88c0f1557d954dda12bb807d7f6fc111",
        "from_org_id": "Org1",
        "from_user_id": "fi1_org_user1_demo",
        "from_custom_account_id": "20200198765432",
        "transaction_type": "CREDIT",
        "holding_id": "ohold~cbdc~USD~454f4bf6",
        "category": "transfer"
    },
    .
    .
    .
    .
    {
        "transaction_id": "otransaction~b7c97d737fb978651c9132276ab677c0bcf795b9db13d0d39cba5243615c7389",
        "transacted_amount": 10,
        "timestamp": "2025-08-21T08:46:09.000Z",
        "token_id": "USD",
        "transacted_account": "oaccount~76687c724ddbc2d6e6664d9618b2bf1c2a9fe10f84887462447e4caba6aaaff3",
        "transacted_org_id": "Org1",
        "transacted_user_id": "fi1_org_officer_demo",
        "transacted_custom_account_id": "20200222221111",
        "to_account": "oaccount~1e31495a0c149b08cb9d02bdcac5e83d88c0f1557d954dda12bb807d7f6fc111",
        "to_org_id": "Org1",
        "to_user_id": "fi1_org_user1_demo",
        "to_custom_account_id": "20200198765432",
        "from_account": "oaccount~76687c724ddbc2d6e6664d9618b2bf1c2a9fe10f84887462447e4caba6aaaff3",
        "from_org_id": "Org1",
        "from_user_id": "fi1_org_officer_demo",
        "from_custom_account_id": "20200222221111",
        "transaction_type": "ONHOLD",
        "holding_id": "ohold~cbdc~USD~4fbbb846",
        "category": "transfer"
    }
]
getAllAccountsTrxHistoryWithFiltersFromRichHistDB
This method returns an array of the transaction history details for all organizations from the rich history database.
Ctx.Account.getAllAccountsTrxHistoryWithFiltersFromRichHistDB(custom_endpoint: string, bearer_token: string, filters);
Parameters:
  • org_id string – The membership service provider (MSP) ID of the organization.
  • custom_endpoint – The RESTful service endpoint of the rich history database.
  • bearer_token – The access authorization token for the RESTful service endpoint.
  • filters: string – An optional parameter. If empty, all records are returned. The PageSize property determines the number of records to return. If PageSize is 0, the default page size is 20. The Bookmark property determines the starting index of the records to return. For more information, see the Hyperledger Fabric documentation. The StartTime and EndTime properties must be specified in RFC-3339 format.
Return Value Example:
[
    {
        "transaction_id": "otransaction~62eb436be7c29fc2ed9cae221e874d9a31b163fa10374e7da09bf5e09a96c3ff",
        "transacted_amount": 10000,
        "timestamp": "2025-08-25T13:57:58.000Z",
        "token_id": "USD",
        "transacted_account": "oaccount~68d67712f500e9dac8c314c19744003a993250271d960e9b0d25267bb18dfe9a",
        "transacted_org_id": "CentralBank",
        "transacted_user_id": "cb_issuer_demo",
        "transacted_custom_account_id": "10109999001234",
        "to_account": "oaccount~68d67712f500e9dac8c314c19744003a993250271d960e9b0d25267bb18dfe9a",
        "to_org_id": "CentralBank",
        "to_user_id": "cb_issuer_demo",
        "to_custom_account_id": "10109999001234",
        "from_account": "oaccount~da6e14466a0ba9b48ebc18fa672addb92dffc371bf953c3229a95b2ff2d9cd41",
        "from_org_id": "CentralBank",
        "from_user_id": "cb__creator_demo",
        "from_custom_account_id": "10105678004567",
        "transaction_type": "DEBIT",
        "category": "issuance"
    },
    {
        "transaction_id": "otransaction~4793f3907eefce2f9fca7ef107405b0f116efb3afbf83fa0e61fe763690c8235",
        "transacted_amount": 100,
        "timestamp": "2025-08-25T13:47:56.000Z",
        "token_id": "USD",
        "transacted_account": "oaccount~76687c724ddbc2d6e6664d9618b2bf1c2a9fe10f84887462447e4caba6aaaff3",
        "transacted_org_id": "Org1",
        "transacted_user_id": "fi1_org_officer_demo",
        "transacted_custom_account_id": "20200222221111",
        "to_account": "oaccount~68d67712f500e9dac8c314c19744003a993250271d960e9b0d25267bb18dfe9a",
        "to_org_id": "CentralBank",
        "to_user_id": "cb_issuer_demo",
        "to_custom_account_id": "10109999001234",
        "from_account": "oaccount~76687c724ddbc2d6e6664d9618b2bf1c2a9fe10f84887462447e4caba6aaaff3",
        "from_org_id": "Org1",
        "from_user_id": "fi1_org_officer_demo",
        "from_custom_account_id": "20200222221111",
        "transaction_type": "ONHOLD",
        "holding_id": "ohold~cbdc~USD~2ac01689",
        "category": "issuance"
    },
    .
    .
    .
    .
    {
        "transaction_id": "otransaction~5177f7560d32838242a26ac74f2a90c6ff9b47aae0d0988f28d9b4cf7e27c097",
        "transacted_amount": 10,
        "timestamp": "2025-08-25T13:22:23.000Z",
        "token_id": "USD",
        "transacted_account": "oaccount~d08ff55a040d5e5dcf406009bab1b3398e06c374356efb1bddbf2f17fc37f949",
        "transacted_org_id": "Org1",
        "transacted_user_id": "fi1_org_user2_demo",
        "transacted_custom_account_id": "20200211112222",
        "to_account": "oaccount~d08ff55a040d5e5dcf406009bab1b3398e06c374356efb1bddbf2f17fc37f949",
        "to_org_id": "Org1",
        "to_user_id": "fi1_org_user2_demo",
        "to_custom_account_id": "20200211112222",
        "from_account": "oaccount~1e31495a0c149b08cb9d02bdcac5e83d88c0f1557d954dda12bb807d7f6fc111",
        "from_org_id": "Org1",
        "from_user_id": "fi1_org_user1_demo",
        "from_custom_account_id": "20200198765432",
        "transaction_type": "EXECUTEHOLD",
        "holding_id": "ohold~cbdc~USD~454f4bf6",
        "category": "transfer"
    }
]
consolidateRunningBalanceInTransactions
This method calculates the running account balances and saves the updated values in the transaction key/value pairs. Typically the system administrators call this method by using a REST proxy scheduler.
Ctx.Transaction.consolidateRunningBalanceInTransactions(save: boolean);
Return Value Example:
{ msg: "Successfully updated account running balance for pending transactions."}
processSendersAndReceivers
This method calculates and update the token account balances that are spread in the sender and receiver key/value pairs that were created during inter-organization transfers, and then deletes the sender and receiver key/value pairs, which are no longer of use. Typically the system administrators call this method by using a REST proxy scheduler. 
Ctx.Account.processSendersAndReceivers(save: boolean);
Return Value Example:
{ msg: "Successfully updated balance for accounts from pending receivers."}
deleteTransactions
This method deletes older transactions from the state database.
Ctx.Transaction.deleteTransactions(time_to_expiration: Date);
Parameters:
  • time_to_expiration: Date – A time stamp that indicates when to delete transactions. Transaction assets that are older than the specified time will be deleted..
Return Value Example:
{
    "msg": "Successfully deleted transaction older than date: Thu Aug 19 2025 11:19:36 GMT+0000 (Coordinated Universal Time).",
    "transactions": [
           "otransaction~ec3366dd48b4ce2838f820f2f138648e6e55a07226713e59b411ff31b0d21058"
     ]
}
getTransactionById
This method returns the history of a Transaction asset. 
Ctx.Transaction.getTransactionById(transaction_id: string);
Parameters:
  • transaction_id string – The ID of the transaction asset.
Return Value Example:
{
    "transaction_id": "otransaction~6523597253e45b3c976aecdc54e2c6316d0a4f88ad5d7f3fff48c69213e4375a",
    "history": [
        {
            "trxId": "6523597253e45b3c976aecdc54e2c6316d0a4f88ad5d7f3fff48c69213e4375a",
            "timeStamp": "2025-08-20T23:21:45.000Z",
            "value": {
                "assetType": "otransaction",
                "transaction_id": "otransaction~6523597253e45b3c976aecdc54e2c6316d0a4f88ad5d7f3fff48c69213e4375a",
                "token_id": "token",
                "from_account_id": "oaccount~22776ada3efff6aaf4c68c204c1f063b139adfa1bca79ed53199117c34036cfc",
                "to_account_id": "oaccount~5e3b5a3306d7ca3f3e3fe7cc27b6ae547e94dba1c5af58a69a771d7a619b6a66",
                "transaction_type": "TRANSFER",
                "amount": 22,
                "timestamp": "2025-08-20T23:21:45.000Z",
                "number_of_sub_transactions": 0,
                "holding_id": "",
                "sub_transaction": "false",
                "category": "category value",
                "description": "description value"
            }
        }
    ],
    "sub_transactions": []
}
issueTokens
Minters can call this method to create a specified amount of tokens.
this.Ctx.Token.mint(quantity, token_asset, info_details)
Parameters:
  • token_id: string – The ID of the token.
  • quantity – The number of tokens to mint.
  • info_details: JSON – An object specifying the category (category) and description (description) of the request.

    You specify the info_details parameter in a different format if you are using Visual Studio Code versus the CLI or a Postman collection.

    Visual Studio Code: { "category": "category value", "description": "description value" }

    CLI / Postman: "{\"category\":\"category value\",\"description\":\"description value\"}"

Return Value Example:
{
          "msg": "Successfully minted 1000 tokens to Account Id: oaccount~da6e14466a0ba9b48ebc18fa672addb92dffc371bf953c3229a95b2ff2d9cd41"
      }
getTotalMintedTokens
This method returns the total number of tokens minted.
Ctx.Token.getTotalMintedTokens(token_asset);
Parameters:
  • token_asset: any – The token asset, passed as a parameter. The properties of the token asset are described in the model file.
Return Value Example:
{
    "msg": "Total minted token for Token Id: USD is 910 tokens.",
    "quantity": 910
}
getNetTokens
This method returns the net quantity of tokens that are available in the system. The net tokens are the amount of tokens remaining after tokens are burned. In equation form: net tokens = total minted tokens - total burned tokens. If no tokens are burned, then the number of net tokens is equal to the total minted tokens.
Ctx.Token.getNetTokens(token_asset);
Parameters:
  • token_asset: any – The token asset, passed as a parameter. The properties of the token asset are described in the model file.
Return Value Example:
{
    "msg": "Net supply of token for Token Id: USD is 878 tokens.",
    "quantity": 878
}
transferTokens
This method transfers tokens from the caller to a specified account. The caller of the method must have an account. The quantity must be within the decimal values specified by the decimal parameter of the divisible behavior in the specification file. 
this.Ctx.Token.transfer(to_account_id: string, quantity, token_asset, info_details);
Parameters:
  • to_account_id: string – The account ID of the receiver (payee).
  • quantity: number – The number of tokens to transfer.
  • info_details: JSON – An object specifying the category (category) and description (description) of the request.

    You specify the info_details parameter in a different format if you are using Visual Studio Code versus the CLI or a Postman collection.

    Visual Studio Code: { "category": "category value", "description": "description value" }

    CLI / Postman: "{\"category\":\"category value\",\"description\":\"description value\"}"

Return Value Example:
{
          "msg": "Successfully transferred 10000 tokens from account id: oaccount~da6e14466a0ba9b48ebc18fa672addb92dffc371bf953c3229a95b2ff2d9cd41  to account id: oaccount~68d67712f500e9dac8c314c19744003a993250271d960e9b0d25267bb18dfe9a."
      }
hold
This method is used by the minter to send a request to the minter notary to create a specified amount of tokens. The specified notary account is responsible for either completing or releasing the hold.
Ctx.Hold.hold(operation_id: string, to_account_id: string, notary_account_id: string, quantity: number, time_to_expiration: Date, token, type: HoldOperationType, info_details?: InfoDetails)
Parameters:
  • operation_id: string – A unique ID to identify the hold operation. Typically this ID is passed by the client application.
  • to_account_id: string – The ID of the recipient account.
  • notary__account_id: string – The ID of the notary account.
  • quantity: number – The total number of tokens to put on hold.
  • time_to_expiration: Date – The duration until the hold expires. Specify 0 for a permanent hold. Otherwise use the RFC-3339 format. For example, 2021-06-02T12.
  • token: any – The token asset, passed as a parameter. The properties of the token asset are described in the model file.
  • type: HoldOperationType – The type of hold operation to request. It must be one of three possible values, MINT, BURN, or TRANSFER.
  • info_details: JSON – An object specifying the category (category) and description (description) of the request.

    You specify the info_details parameter in a different format if you are using Visual Studio Code versus the CLI or a Postman collection.

    Visual Studio Code: { "category": "category value", "description": "description value" }

    CLI / Postman: "{\"category\":\"category value\",\"description\":\"description value\"}"

Return Value Example:
{
           "msg": "AccountId oaccount~da6e14466a0ba9b48ebc18fa672addb92dffc371bf953c3229a95b2ff2d9cd41 has successfully submitted request to mint 200 tokens"
       }
executeHold
Notaries can call this method to approve a hold operation, which can be one of three types: mint, burn, or transfer.
Ctx.Hold. executeHold(operation_id: string, token, operation_type: HoldOperationType, quantity? :number)
Parameters:
  • operation_type: HoldOperationType – The type of hold operation to approve. It must be one of three possible values, MINT, BURN, or TRANSFER.
  • quantity: number – (Optional) For transfer operations only, the amount that is approved to be transferred to the recipient.
  • token: any – The token asset, passed as a parameter. The properties of the token asset are described in the model file.
  • operation_id: string – A unique ID of the request.
Return Value Example:
{
           "msg": "Successfully minted 1000 tokens to Account Id: oaccount~da6e14466a0ba9b48ebc18fa672addb92dffc371bf953c3229a95b2ff2d9cd41"
       }
releaseHold
Notaries can call this method to reject a hold operation, which can be one of three types: mint, burn, or transfer.
Ctx.Hold.releaseHold(operation_id: string, token, operation_type: HoldOperationType)
Parameters:
  • operation_type: HoldOperationType – The type of hold operation to reject. It must be one of three possible values, MINT, BURN, or TRANSFER.
  • token: any – The token asset, passed as a parameter. The properties of the token asset are described in the model file.
  • operation_id: string – A unique ID of the request.
Return Value Example:
{
           "msg": "Successfully rejected mint request with Operation Id '89ce' to mint 2000 tokens of token id USD"
       }
getOnHoldIds
This method returns a list of all of the holding IDs for a specified account.
Ctx.Account.getOnHoldIds(account_id: string);
Parameters:
  • account_id: string – The unique ID of the token account.
Return Value Example:
{
           "msg": "Holding Ids are: ",
           "holding_ids": ["ohold~cbdc~token~hold1"]
       }
getOnHoldDetailsWithOperationId
This method returns the on-hold transaction details for a specified operation ID and token.
Ctx.Hold.getOnHoldDetailsWithOperationId(token_id: string, operation_id: string);
Parameters:
  • token_id: string – The ID of the token.
  • operation_id: string – A unique ID that identifies the hold operation.
Return Value Example:
{
          "assetType": "ohold",
          "holding_id": "ohold~cbdc~token~hold1",
          "operation_id": "hold1",
          "token_name": "cbdc",
          "from_org_id": "CentralBank",
          "operation_type": "transfer",
          "status": "approved",
          "from_account_id": "oaccount~5abb4155f4b245bb1732321e3174ac81999b03495b5c74f8e1f270bafbadef75",
          "to_account_id": "oaccount~22776ada3efff6aaf4c68c204c1f063b139adfa1bca79ed53199117c34036cfc",
          "notary_account_id": "oaccount~1da238c1491c919b151f777a615fb5779032c34b3ef3adeca6afe591bac10aaf",
          "token_id": "token",
          "quantity": "0",
          "time_to_expiration": "2029-01-04T00:00:00.000Z",
          "category": "category value",
          "description": "description value"
      }
getOnHoldBalanceWithOperationId
This method returns the on-hold balance for a specified operation ID and token. This method can be called by anyone.
Ctx.Hold.getOnHoldBalanceWithOperationId(token_id: string, operation_id: string);
Parameters:
  • token_id: string – The ID of the token.
  • operation_id: string – A unique ID that identifies the hold operation.
Return Value Example:
{
           "msg": "Current Holding Balance of Operation 'hold1' for token 'token' is: 0",
           "holding_balance": 0
       }

TypeScript SDK Methods for Inter-Organizational Transfers

Inter-organization transfers have two parts: first the amount is debited from the sender and then the amount is credited to the receiver. The following two APIs are called together as an atomic transaction using the two-phase commit API of the Oracle Blockchain Platform REST proxy. Confidential transfers are done in this manner because the private data collections of the two organizations are distinct and cannot be accessed in a single transaction.

executeHoldTokensSender
This method can be called only by the user with the notary role for the specified operation ID. This method is the first part of an approval of an transfer between organizations. The specified amount is deducted from the sender's account.
Ctx.Hold.executeHoldSender(operation_id: string, quantity, globalTxId: string, token: any);
Parameters:
  • token: any – The token asset, passed as a parameter. The properties of the token asset are described in the model file.
  • operation_id: string – The unique operation ID that represents the hold request to approve.
  • quantity: number – The amount of held tokens to transfer.
  • globalTxid: string – The global transactin ID generated by the REST proxy for a two-phase commit request, which in this case is used as the common reference that binds the debit and credit operations in an inter-organization transfer.
Return Value Example:
{
      "msg":
        "Account Id: oaccount~68d67712f500e9dac8c314c19744003a993250271d960e9b0d25267bb18dfe9a is successfully executed '10' tokens from Operation Id 'hold1'."
    }
executeHoldTokensReceiver
This method can be called only by the user with the notary role for the specified operation ID. This method is the second part of an approval of an transfer between organizations. The specified amount is credited to the receiver's account.
Ctx.Hold.executeHoldReceiver(operation_id: string, quantity, globalTxId: string, token: any);
Parameters:
  • token: any – The token asset, passed as a parameter. The properties of the token asset are described in the model file.
  • operation_id: string – The unique operation ID that represents the hold request to approve.
  • quantity: number – The amount of held tokens to transfer.
  • globalTxid: string – The global transactin ID generated by the REST proxy for a two-phase commit request, which in this case is used as the common reference that binds the debit and credit operations in an inter-organization transfer.
Return Value Example:
{
      "msg":
        "Account Id: oaccount~68d67712f500e9dac8c314c19744003a993250271d960e9b0d25267bb18dfe9a is successfully executed '10' tokens from Operation Id 'hold1, receiverId oreceiver~72d9bfcf-2c68-4c33-b8c3-fe3374983bf2'."
    }