Stablecoin 包裝程式 API 套件

Oracle Blockchain Platform Digital Assets Edition 包含一個包裝函式 API 套件，可延伸 REST API 以支援穩定貨幣生命週期特定的作業。

包裝程式 API 套裝程式使用 API 閘道服務和 OCI Functions 來部署專門用於管理穩定幣生命週期的 API 路由。可從 Oracle Blockchain Platform 主控台下載 stablecoin 包裝函式 API 套裝程式，並包含包含包裝函式 API 套裝程式的封存檔案，包括部署所需的 Terraform 命令檔。您可以將此檔案部署到 Oracle Cloud Infrastructure (OCI) 上的資源管理程式堆疊，為包裝函式 API 建立必要的 Oracle 資源。它也包含一個 Postman 集合，可讓您測試部署的包裝函式 API。此集合包括端點和有效負載 (與包裝程式 API 套裝程式中定義的 API 對應) 的預先設定要求。

包裝函式 API

activateStablecoinAccount
原始方法名稱：activateAccount
此 POST 方法會啟用有趣的記號帳戶。只有指定的組織之 Token Admin 或 Org Admin 才能呼叫此方法。無法啟用已刪除的帳戶。
有效負載：
{
    "tokenId": "{{bc-token-id}}",
    "orgId": "{{bc-org-id}}",
    "userId": "{{bc-user-id}}",
    "endorsers": {{endorsers}}
}
參數：
  • tokenId: string – 記號的 ID。
  • orgId: string – 目前組織中使用者的會員服務提供者 (MSP) ID。
  • userId: string – 使用者的使用者名稱或電子郵件 ID。
  • endorsers: string[] – 必須為交易背書的對等體陣列 (例如 peer1、peer2)。
傳回值：
  • 成功時，指定權杖帳戶之帳戶狀態物件的 JSON 表示法。
傳回值範例：
{
    "returnCode": "Success",
    "error": "",
    "result": {
        "txid": "6cea484aa4e311b3913e7706c668d1e7df1531b7561f4777ab8550542be18b5d",
        "payload": {
            "assetType": "oaccountStatus",
            "status_id": "oaccountStatus~cfe302f06bf732f248315725bb601d7906d7c1d4c167d04ac3a5283b8dbc7fc4",
            "account_id": "oaccount~374e4e762940fc185c7cd5b6528c7f94985b6c56acf46abb746de6381589edd2",
            "status": "active"
        },
        "encode": "JSON",
        "sourceURL": "cb-oabcs1-bom.blockchain.ocp.example.com:20010",
        "blockNumber": 294
    }
}
addOrgAdmin
原始方法名稱：addOrgAdmin
此方法會將組織管理員新增至權杖鏈碼。只有指定的組織之 Token Admin 或 Org Admin 才能呼叫此方法。
有效負載：
{
    "orgId": "{{bc-org-id}}",
    "userId": "{{bc-user-id}}",
    "sameOrgEndorser": true
}
參數：
  • orgId: string – 目前組織中使用者的會員服務提供者 (MSP) ID。
  • userId: string – 使用者的使用者名稱或電子郵件 ID。
  • sameOrgEndorser: boolean - 表示交易背書是否必須來自與要求者相同的組織布林值。
傳回值範例：

{
    "returnCode": "Success",
    "error": "",
    "result": {
        "txid": "96a84dffcb9156f7271dfb414e8c43b540595044cf9145f5fd56e9873797fc4a",
        "payload": {
            "msg": "Successfully added Org Admin (Org_Id: CB, User_Id: cb)"
        },
        "encode": "JSON",
        "sourceURL": "cb-oabcs1-bom.blockchain.ocp.example.com:20009",
        "blockNumber": 197
    }
}
addOrgAuditor
原始方法名稱：addOrgAuditor
此方法會將組織稽核者新增至記號鏈碼。只有指定的組織之 Token Admin 或 Org Admin 才能呼叫此方法。
有效負載：
{
    "orgId": "{{bc-org-id}}",
    "userId": "{{bc-user-id}}",
    "sameOrgEndorser": true
}
參數：
  • orgId: string – 目前組織中使用者的會員服務提供者 (MSP) ID。
  • userId: string – 使用者的使用者名稱或電子郵件 ID。
  • sameOrgEndorser: boolean - 表示交易背書是否必須來自與要求者相同的組織布林值。
傳回值範例：
{
    "returnCode": "Success",
    "error": "",
    "result": {
        "txid": "44bbad35a1478cb714e32f7cfd551897868a203520aab9cea5771d3aadc1cf03",
        "payload": {
            "msg": "Successfully added Org Auditor (Org_Id: CB, User_Id: cb)"
        },
        "encode": "JSON",
        "sourceURL": "cb-oabcs1-bom.blockchain.ocp.example.com:20009",
        "blockNumber": 198
    }
}
addRole
原始方法名稱：addRole
此方法會將角色新增至指定的使用者和記號。帳戶 ID 是透過建立鏈結權杖 ID、組織 ID 和使用者 ID 的 SHA-256 雜湊來形成。只有指定的組織之 Token Admin 或 Org Admin 才能呼叫此方法。
有效負載：
{
    "tokenId": "{{bc-token-id}}",
    "role": "role value (for example minter / burner / notary)",
    "orgId": "{{bc-org-id}}",
    "userId": "{{bc-user-id}}",
    "endorsers": {{endorsers}}
}
參數：
  • tokenId: string – 記號的 ID。
  • role: string – 要新增至指定使用者的角色名稱。薄弱且可燒錄的行為對應於規格檔案中的 minter_role_name 和 burner_role_name 特性。同樣地，公證行為與規格檔案中的 notary_role_name 特性連結。
  • orgId: string – 目前組織中使用者的會員服務提供者 (MSP) ID。
  • userId: string – 使用者的使用者名稱或電子郵件 ID。
  • endorsers: string[] – 必須為交易背書的對等體陣列 (例如 peer1、peer2)。
傳回值範例：
{
    "returnCode": "Success",
    "error": "",
    "result": {
        "txid": "29ea766dee8e6d273eba3c40a9fea75a1aa85dc3c280d40695f6224c5c52d93c",
        "payload": {
            "msg": "Successfully added role 'notary' to Account Id: oaccount~2eb5f8a9bc561f8f41a4ea3be9511958cc6684ef14f2337ca396efc301b627d8 (Org-Id: CB, User-Id: manager_user_cb)"
        },
        "encode": "JSON",
        "sourceURL": "cb-oabcs1-bom.blockchain.ocp.example.com:20009",
        "blockNumber": 201
    }
}
addTokenAdmin
原始方法名稱：addTokenAdmin
此 POST 方法會將使用者新增為記號鏈碼的 Token Admin。此方法只能由記號鏈碼的 Token Admin 呼叫。第一次呼叫是來自建立鏈碼的管理員。
有效負載：
{
    "orgId": "{{bc-org-id}}",
    "userId": "{{bc-user-id}}",
    "sameOrgEndorser": true
}
參數：
  • orgId: string – 目前組織中使用者的會員服務提供者 (MSP) ID。
  • userId: string – 使用者的使用者名稱或電子郵件 ID。
  • sameOrgEndorser: boolean - 表示交易背書是否必須來自與要求者相同的組織布林值。
傳回值範例：
{
    "returnCode": "Success",
    "error": "",
    "result": {
        "txid": "bd7416689b1acdace3c557faebbc0ad9a51671c10278ba6909350a6fe4b08eed",
        "payload": {
            "msg": "User (Org_Id: CB, User_Id: cb) is already Token Admin."
        },
        "encode": "JSON",
        "sourceURL": "cb-oabcs1-bom.blockchain.ocp.example.com:20009",
        "blockNumber": 193
    }
}
addTokenAuditor
原始方法名稱：addTokenAuditor
此 POST 方法會將記號稽核者新增至記號鏈碼。只有鏈碼的 Token Admin 才能呼叫此方法。
有效負載：
{
    "orgId": "{{bc-org-id}}",
    "userId": "{{bc-user-id}}",
    "sameOrgEndorser": true
}
參數：
  • orgId: string – 目前組織中使用者的會員服務提供者 (MSP) ID。
  • userId: string – 使用者的使用者名稱或電子郵件 ID。
  • sameOrgEndorser: boolean - 表示交易背書是否必須來自與要求者相同的組織布林值。
傳回值範例：
{
    "returnCode": "Success",
    "error": "",
    "result": {
        "txid": "cd81f6c4c9e7c18ece357dbf5c139ef66ef2d6566be3b14de5f6d0a3fd4bb2f0",
        "payload": {
            "msg": "Successfully added Token Auditor (Org_Id: CB, User_Id: cb)"
        },
        "encode": "JSON",
        "sourceURL": "cb-oabcs1-bom.blockchain.ocp.example.com:20009",
        "blockNumber": 196
    }
}
approveBurn
原始方法名稱：approveBurn
Notaries 可以呼叫此 POST 方法來核准燒錄要求。
有效負載：
{
    "tokenId": "{{bc-token-id}}",
    "operationId": "operation_id value",
    "sameOrgEndorser": true
}
參數：
  • tokenId: string – 記號的 ID。
  • operationId: string – 要核准之 Mint 要求的唯一作業 ID。
  • sameOrgEndorser: boolean - 表示交易背書是否必須來自與要求者相同的組織布林值。
傳回值範例：
{
    "returnCode": "Success",
    "error": "",
    "result": {
        "txid": "8252371040e41753fd843bd086692f4e1ee7d89ffa3a50bfa121c5f1565f922f",
        "payload": {
            "msg": "Successfully burned 1 tokens from account id: oaccount~0d7b3f73aea28065017ce8b79c0bb19256dc0cb475a0b2a85192bd110f69535c (Org-Id: CB, User-Id: retirer_user_cb)"
        },
        "encode": "JSON",
        "sourceURL": "cb-oabcs1-bom.blockchain.ocp.example.com:20009",
        "blockNumber": 209
    }
}
approveMint
原始方法名稱：approveMint
Notaries 可以呼叫此 POST 方法來核准 Mint 要求。
有效負載：
{
    "tokenId": "{{bc-token-id}}",
    "operationId": "operation_id value",
    "sameOrgEndorser": true
}
參數：
  • tokenId: string – 記號的 ID。
  • operationId: string – 要核准之 Mint 要求的唯一作業 ID。
  • sameOrgEndorser: boolean - 表示交易背書是否必須來自與要求者相同的組織布林值。
傳回值範例：
{
    "returnCode": "Success",
    "error": "",
    "result": {
        "txid": "a4537ef34a955b023b7c205b9abf06a6c79e4fdd761fb24f41b8eb34126b66c0",
        "payload": {
            "msg": "Successfully minted 10 tokens to Account Id: oaccount~9d9806fa92aa0c4fdb34eaffac6e830181b5d47e64fbce752195e83024125ca0 (Org-Id: CB, User-Id: creator_user_cb)"
        },
        "encode": "JSON",
        "sourceURL": "cb-oabcs1-bom.blockchain.ocp.example.com:20009",
        "blockNumber": 204
    }
}
approveTransaction
原始方法名稱：approveTransaction
核准者可以呼叫此 POST 方法，以核准保留異動。
有效負載：
{
    "tokenId": "{{bc-token-id}}",
    "orgId": "{{bc-org-id}}",
    "userId": "{{bc-user-id}}",
    "endorsers": {{endorsers}}
}
參數：
  • tokenId: string – 記號的 ID。
  • orgId: string – 使用者的成員服務提供者 (MSP) ID。
  • userId: string – 使用者的使用者名稱或電子郵件 ID。
  • endorsers: string[] – 必須為交易背書的對等體陣列 (例如 peer1、peer2)。
傳回值範例：
{
    "returnCode": "Success",
    "error": "",
    "result": {
        "txid": "44685b0ff1b0ee72d57cb62900aae30638d65c82f264d5de7b28375732171702",
        "payload": {
            "assetType": "ApprovalTransactions",
            "approvalTransactionId": "hold1~oaccount~1cf5d40c7ea7b9dceedfc66292ab843c1583564c3ecaf9f5ceb11f834018b02f",
            "approvalOperationId": "hold1",
            "fromAccountId": "oaccount~374e4e762940fc185c7cd5b6528c7f94985b6c56acf46abb746de6381589edd2",
            "toAccountId": "oaccount~79c427e614530eacad6fb07cff6048f6b96283e65019301320c9684932846f64",
            "approverAccountId": "oaccount~1cf5d40c7ea7b9dceedfc66292ab843c1583564c3ecaf9f5ceb11f834018b02f",
            "totalApprovals": 1,
            "timestamp": "2025-11-21T12:32:43.000Z"
        },
        "encode": "JSON",
        "sourceURL": "centralbank-oabcs1-nrt.blockchain.ocp.example.com:20010",
        "blockNumber": 289
    }
}
associateTokenToAccount
原始方法名稱：associateTokenToAccount
此 POST 方法會將指定的帳號 ID 關聯到指定的記號。只有指定的組織之 Token Admin 或 Org Admin 才能呼叫此方法。
有效負載：
{
    "accountId": "account_id value",
    "tokenId": "{{bc-token-id}}",
    "endorsers": {{endorsers}}
}
參數：
  • accountId: string – 帳戶的 ID。
  • tokenId: string – 記號的 ID。
  • endorsers: string[] – 必須為交易背書的對等體陣列 (例如 peer1、peer2)。
傳回值範例：
{
    "returnCode": "Success",
    "error": "",
    "result": {
        "txid": "efc7381fb6fc6174a40e83ff5f09d2bbf7f6f490365e3bbf19d5502c2cfec474",
        "payload": {
            "bapAccountVersion": 0,
            "assetType": "oaccount",
            "account_id": "oaccount~1c6aa60e220b8fc70caf4cea1ed723ddb193a00321e5e0004def062816b77090",
            "user_id": "cb12",
            "org_id": "CB",
            "token_type": "fungible",
            "token_id": "USD",
            "token_name": "Stablecoin",
            "balance": 0,
            "onhold_balance": 0,
            "max_daily_amount": 10000,
            "daily_amount": 0,
            "max_daily_transactions": 100,
            "daily_transactions": 0,
            "current_date": "2024-12-11T00:00:00.000Z"
        },
        "encode": "JSON",
        "sourceURL": "cb-oabcs1-bom.blockchain.ocp.example.com:20010",
        "blockNumber": 216
    }
}
bulkTransferTokens
原始方法名稱：bulkTransferTokens
此方法會將變數替代字從呼叫者帳戶大量傳輸至 flow 物件中指定的帳戶。數量必須在規格檔案中 divisible 行為的 decimal 參數所指定的小數值內。
有效負載：
{
    "tokenId": "{{bc-token-id}}",
    "flow": "[flow value]",
    "endorsers": {{endorsers}}
}
參數：
  • token_id: string – 記號的 ID。
  • flow : object[] – 指定接收者與數量的 JSON 物件陣列。
    • to_orgId: string – 目前組織中接收者的成員服務提供者 (MSP) ID。
    • userId: string – 接收者的使用者名稱或電子郵件 ID。
    • quantity: number – 要傳輸的記號數目。
    如果您使用 Visual Studio Code 與 CLI 或 Postman 集合，請以不同的格式指定 flow 參數。
    Visual Studio 程式碼：
    [
  { "to_org_id": "Org1MSP", "to_user_id": "user1", "quantity": 10 },
  { "to_org_id": "Org1MSP", "to_user_id": "user2", "quantity": 10 }
]
    CLI / Postman:
    "[{ \"to_org_id\": \"Org1MSP\", \"to_user_id\": \"user1\", \"quantity\": 10 }, { \"to_org_id\": \"Org1MSP\", \"to_user_id\": \"user2\", \"quantity\": 10 }]"
  • endorsers: string[] – 必須為交易背書的對等體陣列 (例如 peer1、peer2)。
傳回值範例：
{
    "returnCode": "Success",
    "error": "",
    "result": {
        "txid": "ad6a9555e6512ffe4bd3500d0942e171deadc1d724cd80da7179e39e1d05aa4e",
        "payload": {
            "msg": "Successfully transferred 10 tokens from Account Id 'oaccount~374e4e762940fc185c7cd5b6528c7f94985b6c56acf46abb746de6381589edd2' (Org-Id: CentralBank, User-Id: cb__creator_demo).",
            "from_account_id": "oaccount~374e4e762940fc185c7cd5b6528c7f94985b6c56acf46abb746de6381589edd2",
            "sub_transactions": [
                {
                    "to_account_id": "oaccount~79c427e614530eacad6fb07cff6048f6b96283e65019301320c9684932846f64",
                    "amount": 5
                },
                {
                    "to_account_id": "oaccount~09abdd306d4fcbc1b794e2e0b8fc4ce3d8282e11846ef35d675cc9540da4ad1b",
                    "amount": 5
                }
            ]
        },
        "encode": "JSON",
        "sourceURL": "cb-oabcs1-bom.blockchain.ocp.example.com:20009",
        "blockNumber": 302
    }
}
createAccount
原始方法名稱：createAccount
這個方法會為指定的使用者與記號建立帳號。必須為任何需要記號的使用者建立帳戶。科目可追蹤餘額、保留餘額及交易歷史記錄。帳戶 ID 是透過串連使用者 ID 和組織 (會員服務提供者) ID 的資產類型、記號 ID 和 SHA-256 雜湊來形成。只有鏈碼的 Token Admin 或指定的組織 Org Admin 才能呼叫此方法。
有效負載：
{
    "orgId": "{{bc-org-id}}",
    "userId": "{{bc-user-id}}",
    "tokenType": "fungible",
    "dailyLimits": "{\"max_daily_amount\":10000,\"max_daily_transactions\":100}",
    "endorsers": {{endorsers}}
}
參數：
  • orgId – 要為其建立帳戶之使用者的會員服務提供者 (MSP) ID。ID 必須以數字或英文字母字元為開頭，而且可以包含英文字母、數字以及特殊字元，例如底線 (_)、句號 (.)、@ 符號以及連字號 (-)。
  • userId – 使用者的使用者名稱或電子郵件 ID。ID 必須以數字或英文字母字元為開頭，而且可以包含英文字母、數字以及特殊字元，例如底線 (_)、句號 (.)、@ 符號以及連字號 (-)。
  • tokenType: TokenType – 記號的類型，必須是 fungible。
  • dailyLimits: JSON object – 下列類型的 JSON 物件。
    {
     "max_daily_amount": 100000
     "max_daily_transactions": 10000
 }
    在範例中，max_daily_amount 值是每日可交易的記號數量上限，而 max_daily_transactions 值是每日可完成的交易數上限。
  • endorsers: string[] – 必須為交易背書的對等體陣列 (例如 peer1、peer2)。
傳回值範例：
{
    "returnCode": "Success",
    "error": "",
    "result": {
        "txid": "453821c7ffd477987ef8ccbd836b893969531ab768098cd4a99e3b89cd38a391",
        "payload": {
            "bapAccountVersion": 0,
            "assetType": "oaccount",
            "account_id": "oaccount~28ac774001f374064029d51af4fb67e26ea1ea9ef62828b7a72dbf3beb8efd8d",
            "user_id": "admin_user_cb",
            "org_id": "CB",
            "token_type": "fungible",
            "token_id": "",
            "token_name": "",
            "balance": 0,
            "onhold_balance": 0,
            "max_daily_amount": 10000,
            "daily_amount": 0,
            "max_daily_transactions": 100,
            "daily_transactions": 0,
            "current_date": "2024-12-09T00:00:00.000Z"
        },
        "encode": "JSON",
        "sourceURL": "cb-oabcs1-bom.blockchain.ocp.example.com:20009",
        "blockNumber": 188
    }
}
createApprovalPolicyCheck
原始方法名稱：createApprovalPolicyCheck
此方法會建立新的核准原則，定義異動臨界值與必要的循序核准者。只有 Token Admin 才能呼叫此方法。
有效負載：
{
    "asset": "{\"approvalPolicyId\":\"approvalPolicyId value\",\"transactionLowerLimit\":\"transactionLowerLimit value\",\"transactionUpperLimit\":\"transactionUpperLimit value\",\"numberOfApprovalsRequired\":999,\"approverDetails\":[{\"approverOrgId\":\"approverOrgId value\",\"approverUserId\":\"approverUserId value\",\"approvalSequence\":999}]}",
    "endorsers": {{endorsers}}
}
參數：
  • asset: ApprovalPolicyCheck class – 定義交易核准規則的類別，包含下列欄位：
    • approvalPolicyId – 系統會產生此 ID。您並未手動提供此欄位。
    • transactionLowerLimit – 適用核准策略的最低交易金額。
    • transactionUpperLimit – 套用核准原則的交易金額上限。
    • numberOfApprovalsRequired – 完成交易前所需的核准總數。
    • approverDetails – 核准者清單及其指派的核准順序，定義核准的必要順序。
  • endorsers: string[] – 必須為交易背書的對等體陣列 (例如 peer1、peer2)。
傳回值範例：
{
    "returnCode": "Success",
    "error": "",
    "result": {
        "txid": "3a5701ca90ffb98832421c7d5377eb9c0df9fdab30a0a3ce06216808bdea098e",
        "payload": {
            "status": "active",
            "assetType": "ApprovalPolicyCheck",
            "approvalPolicyId": "GPID~500~1000",
            "transactionLowerLimit": "500",
            "transactionUpperLimit": "1000",
            "numberOfApprovalsRequired": 2,
            "approverDetails": [
                {
                    "approverOrgId": "CentralBank",
                    "approverUserId": "manager",
                    "approvalSequence": 1
                },
                {
                    "approverOrgId": "CentralBank",
                    "approverUserId": "creator",
                    "approvalSequence": 2
                }
            ]
        },
        "encode": "JSON",
        "sourceURL": "cb-oabcs1-bom.blockchain.ocp.example.com:20010",
        "blockNumber": 284
    }
}
createStablecoinAccountPolicyCheck
原始方法名稱：createAccountPolicyCheck
此方法會為指定的帳戶建立原則。只有指定的組織之 Token Admin 或 Org Admin 才能呼叫此方法。
有效負載：
{
    "asset": "{\"accountPolicyId\":\"accountPolicyId value\",\"orgId\":\"{{bc-org-id}}\",\"userId\":\"{{bc-user-id}}\",\"kycCompliance\":\"kycCompliance value\",\"amlCompliance\":\"amlCompliance value\",\"riskScore\":999,\"restrictionFlag\":\"restrictionFlag value\"}",
    "endorsers": {{endorsers}}
}
參數：
  • asset: AccountPolicyCheck class – 定義帳號策略參數的類別，其中包含下列欄位：
    • accountPolicyId – 系統會從指定的 orgId 和 userId 欄位產生此 ID。您並未手動提供此欄位。
    • orgId – 要為其建立原則之使用者的成員服務提供者 (MSP) ID。
    • userId – 要為其建立策略的使用者名稱或電子郵件 ID。
    • kycCompliance - 表示帳戶是否滿足 KYC (瞭解您的客戶) 需求的布林值。
    • amlCompliance – 表示帳戶是否滿足 AML (反洗錢) 需求的布林值。
    • riskScore – 與帳戶相關聯的風險分數，用於規範評估。
    • restrictionFlag – 表示帳戶是否受限制轉帳的布林值。如果設為 true，則只允許在最低核准原則臨界值內的傳輸。
    • endorsers: string[] – 必須為交易背書的對等體陣列 (例如 peer1、peer2)。
傳回值範例：
{
    "returnCode": "Success",
    "error": "",
    "result": {
        "txid": "02875ca9c6a7408da3f81156214228b91b09c4bb2b8026d7a5733b53598c6635",
        "payload": {
            "assetType": "AccountPolicyCheck",
            "accountPolicyId": "APID~CentralBank~cb__creator_demo",
            "orgId": "CentralBank",
            "userId": "cb__creator_demo",
            "kycCompliance": "true",
            "amlCompliance": "true",
            "riskScore": 1000,
            "restrictionFlag": "false"
        },
        "encode": "JSON",
        "sourceURL": "cb-oabcs1-bom.blockchain.ocp.example.com:20010",
        "blockNumber": 272
    }
}
deleteApprovalPolicyCheck
原始方法名稱：deleteApprovalPolicyCheck
此方法會刪除指定原則 ID 的核准原則。只有 Token Admin 才能呼叫此方法。
有效負載：
{
    "id": "id value",
    "endorsers": {{endorsers}}
}
參數：
  • id: string – 唯一核准原則 ID。
  • endorsers: string[] – 必須為交易背書的對等體陣列 (例如 peer1、peer2)。
傳回值範例：
{
    "returnCode": "Success",
    "error": "",
    "result": {
        "txid": "5ac54d3279a183022a00495aee3c25c2893388ff9aaaecd5c3b594edfa49ad8f",
        "payload": {
            "isValid": true,
            "message": "Successfully deleted asset with ID [GPID~500~1000] from ledger"
        },
        "encode": "JSON",
        "sourceURL": "cb-oabcs1-bom.blockchain.ocp.example.com:20009",
        "blockNumber": 286
    }
}
deleteStablecoinAccount
原始方法名稱：deleteAccount
這個方法會刪除一個有趣的記號帳號。如果在分類帳中找不到帳戶的 accountStatus 值，則會傳回錯誤。只有 Token Admin 才能呼叫此方法。
有效負載：
{
    "tokenId": "{{bc-token-id}}",
    "orgId": "{{bc-org-id}}",
    "userId": "{{bc-user-id}}",
    "endorsers": {{endorsers}}
}
參數：
  • tokenId: string – 記號的 ID。
  • orgId: string – 目前組織中使用者的會員服務提供者 (MSP) ID。
  • userId: string – 使用者的使用者名稱或電子郵件 ID。
  • endorsers: string[] – 必須為交易背書的對等體陣列 (例如 peer1、peer2)。
傳回值範例：
{
    "returnCode": "Success",
    "error": "",
    "result": {
        "txid": "4bec8fc6cf31f86944b4e73334a03c55ad5630625e8320f5b9cf7cca30af929b",
        "payload": {
            "assetType": "oaccountStatus",
            "status_id": "oaccountStatus~e0a22965c400dd325e386b862b2552bbd26a281ebe4d1c29c08ccc465a26678d",
            "account_id": "oaccount~e888c90d38470956e3d98eccaa158f86a1bf0923900803b2b7cb7b4e0c10a18e",
            "status": "deleted"
        },
        "encode": "JSON",
        "sourceURL": "cb-oabcs1-bom.blockchain.ocp.example.com:20010",
        "blockNumber": 297
    }
}
deleteStablecoinAccountPolicyCheck
原始方法名稱：deleteAccountPolicyCheck
此方法會刪除指定之原則 ID 的原則。只有指定的組織之 Token Admin 或 Org Admin 才能呼叫此方法。
有效負載：
{
    "id": "id value",
    "endorsers": {{endorsers}}
}
參數：
  • id: string – 唯一的帳戶原則 ID。
  • endorsers: string[] – 必須為交易背書的對等體陣列 (例如 peer1、peer2)。
傳回值範例：
{
    "returnCode": "Success",
    "error": "",
    "result": {
        "txid": "5ac54d3279a183022a00495aee3c25c2893388ff9aaaecd5c3b594edfa49ad8f",
        "payload": {
            "isValid": true,
            "message": "Successfully deleted asset with ID [GPID~500~1000] from ledger"
        },
        "encode": "JSON",
        "sourceURL": "cb-oabcs1-bom.blockchain.ocp.example.com:20009",
        "blockNumber": 286
    }
}
executeHoldTokens
原始方法名稱：executeHoldTokens
此方法會核准保留記號，這會觸發將記號從寄件者轉移給接收者的動作。記號擁有者先前保留的記號數量，現在會移轉給收件者。如果 quantity 值小於實際保留值，則剩餘的金額會再度提供給記號的擁有者。如果在記號模型的 behaviors 區段中指定 roles 行為，且已設定 notary_role_name 值，則呼叫者帳戶必須具有公證角色。否則，任何具有帳戶的來電者都可以作為公證人。
有效負載：
{
    "tokenId": "{{bc-token-id}}",
    "operationId": "operation_id value",
    "quantity": 1,
    "endorsers": {{endorsers}}
}
參數：
  • tokenId: string – 記號的 ID。
  • operationId: string – 要核准之 Mint 要求的唯一作業 ID。
  • quantity: number – 要轉移的保留記號數目。
  • endorsers: string[] – 必須為交易背書的對等體陣列 (例如 peer1、peer2)。
傳回值範例：
{
    "returnCode": "Success",
    "error": "",
    "result": {
        "txid": "c1149aaa486abc4931d9024c18dfcb230bb321723d1160b0bf981c0011c4856a",
        "payload": {
            "msg": "Account Id: oaccount~51e676d7182a02ea7418ef58a6d54ecfe3858ef40b4ffb3d859b320da3921594 (Org-Id: CB, User-Id: issuer_user_cb) is successfully executed '10' tokens from Operation Id '8e3145'."
        },
        "encode": "JSON",
        "sourceURL": "cb-oabcs1-bom.blockchain.ocp.example.com:20009",
        "blockNumber": 213
    }
}
getStablecoinAccountTransactionHistory
原始方法名稱：getAccountTransactionHistory
此方法會傳回指定使用者與變數替代字的帳戶交易歷史記錄明細陣列。只有鏈碼的 Token Admin 或 Token Auditor、指定組織的 Org Admin 或 Org Auditor 或帳戶的 AccountOwner 才能呼叫此方法。 
/getStablecoinAccountTransactionHistory?tokenId={{bc-token-id}}&orgId={{bc-org-id}}&userId={{bc-user-id}}
參數：
  • tokenId: string – 記號的 ID。
  • orgId: string – 目前組織中使用者的會員服務提供者 (MSP) ID。
  • userId: string – 使用者的使用者名稱或電子郵件 ID。
傳回值範例：
{
    "returnCode": "Success",
    "error": "",
    "result": {
        "payload": [
            {
                "transaction_id": "otransaction~64c5a4830949eae1424600f3d4a438c6f603a7c3ea31a68e374b899803999e22",
                "transacted_amount": 10,
                "timestamp": "2024-12-11T13:37:28.000Z",
                "balance": 550,
                "onhold_balance": 10,
                "token_id": "USD",
                "category": "category value",
                "description": "description value",
                "transacted_account": "oaccount~9d9806fa92aa0c4fdb34eaffac6e830181b5d47e64fbce752195e83024125ca0",
                "transaction_type": "REJECT_MINT",
                "transacted_org_id": "CB",
                "transacted_user_id'": "creator_user_cb"
            },
            {
                "transaction_id": "otransaction~a4537ef34a955b023b7c205b9abf06a6c79e4fdd761fb24f41b8eb34126b66c0",
                "transacted_amount": 10,
                "timestamp": "2024-12-11T13:36:32.000Z",
                "balance": 550,
                "onhold_balance": 10,
                "token_id": "USD",
                "description": "description value",
                "transacted_account": "oaccount~9d9806fa92aa0c4fdb34eaffac6e830181b5d47e64fbce752195e83024125ca0",
                "transaction_type": "APPROVE_MINT",
                "transacted_org_id": "CB",
                "transacted_user_id'": "creator_user_cb"
            },
            {
                "transaction_id": "otransaction~6237a759422bd9fb112742e8cd7e6450df5a74a32236d9b1005571afed8904a4",
                "transacted_amount": 10,
                "timestamp": "2024-12-11T13:36:18.000Z",
                "balance": 540,
                "onhold_balance": 10,
                "token_id": "USD",
                "category": "category value",
                "description": "description value",
                "transacted_account": "oaccount~9d9806fa92aa0c4fdb34eaffac6e830181b5d47e64fbce752195e83024125ca0",
                "transaction_type": "REQUEST_MINT",
                "transacted_org_id": "CB",
                "transacted_user_id'": "creator_user_cb"
            },
            {
                "transaction_id": "otransaction~06b35071415d74aa1a7c18449149c937d886cae76a832c44cf8d98e84586e76e",
                "transacted_amount": 10,
                "timestamp": "2024-12-11T13:35:46.000Z",
                "balance": 540,
                "onhold_balance": 10,
                "token_id": "USD",
                "category": "category value",
                "description": "description value",
                "transacted_account": "oaccount~9d9806fa92aa0c4fdb34eaffac6e830181b5d47e64fbce752195e83024125ca0",
                "transaction_type": "REQUEST_MINT",
                "transacted_org_id": "CB",
                "transacted_user_id'": "creator_user_cb"
            }
        ],
        "encode": "JSON"
    }
}
getAllAccounts
原始方法名稱：getAllAccounts
這個方法會傳回所有帳號的清單。只有 Token Admin 或 Token Auditor 才能呼叫此方法。
有效負載：
{{api-gateway-endpoint1}}/getAllAccounts
參數：
  • 無
傳回值範例：
{
    "returnCode": "Success",
    "error": "",
    "result": {
        "payload": [
            {
                "key": "oaccount~374e4e762940fc185c7cd5b6528c7f94985b6c56acf46abb746de6381589edd2",
                "valueJson": {
                    "account_id": "oaccount~374e4e762940fc185c7cd5b6528c7f94985b6c56acf46abb746de6381589edd2",
                    "assetType": "oaccount",
                    "balance": 49390,
                    "bapAccountVersion": 7,
                    "current_date": "2025-11-21T00:00:00.000Z",
                    "daily_amount": 610,
                    "daily_transactions": 2,
                    "max_daily_amount": 10000,
                    "max_daily_transactions": 100,
                    "onhold_balance": 0,
                    "onhold_burn_balance": 0,
                    "org_id": "CentralBank",
                    "token_id": "t1",
                    "token_name": "stablecoin",
                    "token_type": "fungible",
                    "user_id": "cb__creator_demo"
                }
            },
            {
                "key": "oaccount~f44e4d75c0fec749392566e745cd39c453c3039aa7224ae417bc4379b645827c",
                "valueJson": {
                    "bapAccountVersion": 0,
                    "assetType": "oaccount",
                    "account_id": "oaccount~f44e4d75c0fec749392566e745cd39c453c3039aa7224ae417bc4379b645827c",
                    "user_id": "cb_manager_demo",
                    "org_id": "CentralBank",
                    "token_type": "fungible",
                    "token_id": "t1",
                    "token_name": "stablecoin",
                    "balance": 0,
                    "onhold_balance": 0,
                    "onhold_burn_balance": 0,
                    "max_daily_amount": 10000,
                    "daily_amount": 0,
                    "max_daily_transactions": 100,
                    "daily_transactions": 0,
                    "current_date": "2025-11-20T00:00:00.000Z"
                }
            },
            {
                "key": "oaccount~79c427e614530eacad6fb07cff6048f6b96283e65019301320c9684932846f64",
                "valueJson": {
                    "account_id": "oaccount~79c427e614530eacad6fb07cff6048f6b96283e65019301320c9684932846f64",
                    "assetType": "oaccount",
                    "balance": 610,
                    "bapAccountVersion": 2,
                    "current_date": "2025-11-20T00:00:00.000Z",
                    "daily_amount": 0,
                    "daily_transactions": 0,
                    "max_daily_amount": 10000,
                    "max_daily_transactions": 100,
                    "onhold_balance": 0,
                    "onhold_burn_balance": 0,
                    "org_id": "CentralBank",
                    "token_id": "t1",
                    "token_name": "stablecoin",
                    "token_type": "fungible",
                    "user_id": "cb_issuer_demo"
                }
            },
            {
                "key": "oaccount~1cf5d40c7ea7b9dceedfc66292ab843c1583564c3ecaf9f5ceb11f834018b02f",
                "valueJson": {
                    "account_id": "oaccount~1cf5d40c7ea7b9dceedfc66292ab843c1583564c3ecaf9f5ceb11f834018b02f",
                    "assetType": "oaccount",
                    "balance": 0,
                    "bapAccountVersion": 1,
                    "current_date": "2025-11-20T00:00:00.000Z",
                    "daily_amount": 0,
                    "daily_transactions": 0,
                    "max_daily_amount": 10000,
                    "max_daily_transactions": 100,
                    "onhold_balance": 0,
                    "onhold_burn_balance": 0,
                    "org_id": "CentralBank",
                    "token_id": "t1",
                    "token_name": "stablecoin",
                    "token_type": "fungible",
                    "user_id": "manager"
                }
            },
            {
                "key": "oaccount~09abdd306d4fcbc1b794e2e0b8fc4ce3d8282e11846ef35d675cc9540da4ad1b",
                "valueJson": {
                    "account_id": "oaccount~09abdd306d4fcbc1b794e2e0b8fc4ce3d8282e11846ef35d675cc9540da4ad1b",
                    "assetType": "oaccount",
                    "balance": 0,
                    "bapAccountVersion": 1,
                    "current_date": "2025-11-20T00:00:00.000Z",
                    "daily_amount": 0,
                    "daily_transactions": 0,
                    "max_daily_amount": 10000,
                    "max_daily_transactions": 100,
                    "onhold_balance": 0,
                    "onhold_burn_balance": 0,
                    "org_id": "CentralBank",
                    "token_id": "t1",
                    "token_name": "stablecoin",
                    "token_type": "fungible",
                    "user_id": "creator"
                }
            },
            {
                "key": "oaccount~e888c90d38470956e3d98eccaa158f86a1bf0923900803b2b7cb7b4e0c10a18e",
                "valueJson": {
                    "assetType": "oaccount",
                    "account_id": "oaccount~e888c90d38470956e3d98eccaa158f86a1bf0923900803b2b7cb7b4e0c10a18e",
                    "user_id": "user1",
                    "org_id": "CentralBank",
                    "token_type": "fungible",
                    "token_id": "t1",
                    "token_name": "stablecoin",
                    "balance": 0,
                    "onhold_balance": 0,
                    "onhold_burn_balance": 0,
                    "max_daily_amount": 10000,
                    "daily_amount": 0,
                    "max_daily_transactions": 100,
                    "daily_transactions": 0,
                    "current_date": "2025-11-24T00:00:00.000Z"
                }
            }
        ],
        "encode": "JSON"
    }
}
getAllOrgAccounts
原始方法名稱：getAllOrgAccounts
此方法會傳回屬於指定組織的所有記號帳戶清單。只有 Token Admin、Token Auditor 或指定的組織 Org Admin 或 Org Auditor 才能呼叫此方法。
有效負載：
{{api-gateway-endpoint1}}/getAllOrgAccounts?orgId={{bc-org-id}}
參數：
  • orgId: string – 組織的成員服務提供者 (MSP) ID。
傳回值範例：
{
    "returnCode": "Success",
    "error": "",
    "result": {
        "payload": [
            {
                "key": "oaccount~374e4e762940fc185c7cd5b6528c7f94985b6c56acf46abb746de6381589edd2",
                "valueJson": {
                    "account_id": "oaccount~374e4e762940fc185c7cd5b6528c7f94985b6c56acf46abb746de6381589edd2",
                    "assetType": "oaccount",
                    "balance": 49390,
                    "bapAccountVersion": 7,
                    "current_date": "2025-11-21T00:00:00.000Z",
                    "daily_amount": 610,
                    "daily_transactions": 2,
                    "max_daily_amount": 10000,
                    "max_daily_transactions": 100,
                    "onhold_balance": 0,
                    "onhold_burn_balance": 0,
                    "org_id": "CentralBank",
                    "token_id": "t1",
                    "token_name": "stablecoin",
                    "token_type": "fungible",
                    "user_id": "cb__creator_demo"
                }
            },
            {
                "key": "oaccount~f44e4d75c0fec749392566e745cd39c453c3039aa7224ae417bc4379b645827c",
                "valueJson": {
                    "bapAccountVersion": 0,
                    "assetType": "oaccount",
                    "account_id": "oaccount~f44e4d75c0fec749392566e745cd39c453c3039aa7224ae417bc4379b645827c",
                    "user_id": "cb_manager_demo",
                    "org_id": "CentralBank",
                    "token_type": "fungible",
                    "token_id": "t1",
                    "token_name": "stablecoin",
                    "balance": 0,
                    "onhold_balance": 0,
                    "onhold_burn_balance": 0,
                    "max_daily_amount": 10000,
                    "daily_amount": 0,
                    "max_daily_transactions": 100,
                    "daily_transactions": 0,
                    "current_date": "2025-11-20T00:00:00.000Z"
                }
            },
            {
                "key": "oaccount~79c427e614530eacad6fb07cff6048f6b96283e65019301320c9684932846f64",
                "valueJson": {
                    "account_id": "oaccount~79c427e614530eacad6fb07cff6048f6b96283e65019301320c9684932846f64",
                    "assetType": "oaccount",
                    "balance": 610,
                    "bapAccountVersion": 2,
                    "current_date": "2025-11-20T00:00:00.000Z",
                    "daily_amount": 0,
                    "daily_transactions": 0,
                    "max_daily_amount": 10000,
                    "max_daily_transactions": 100,
                    "onhold_balance": 0,
                    "onhold_burn_balance": 0,
                    "org_id": "CentralBank",
                    "token_id": "t1",
                    "token_name": "stablecoin",
                    "token_type": "fungible",
                    "user_id": "cb_issuer_demo"
                }
            },
            {
                "key": "oaccount~1cf5d40c7ea7b9dceedfc66292ab843c1583564c3ecaf9f5ceb11f834018b02f",
                "valueJson": {
                    "account_id": "oaccount~1cf5d40c7ea7b9dceedfc66292ab843c1583564c3ecaf9f5ceb11f834018b02f",
                    "assetType": "oaccount",
                    "balance": 0,
                    "bapAccountVersion": 1,
                    "current_date": "2025-11-20T00:00:00.000Z",
                    "daily_amount": 0,
                    "daily_transactions": 0,
                    "max_daily_amount": 10000,
                    "max_daily_transactions": 100,
                    "onhold_balance": 0,
                    "onhold_burn_balance": 0,
                    "org_id": "CentralBank",
                    "token_id": "t1",
                    "token_name": "stablecoin",
                    "token_type": "fungible",
                    "user_id": "manager"
                }
            },
            {
                "key": "oaccount~09abdd306d4fcbc1b794e2e0b8fc4ce3d8282e11846ef35d675cc9540da4ad1b",
                "valueJson": {
                    "account_id": "oaccount~09abdd306d4fcbc1b794e2e0b8fc4ce3d8282e11846ef35d675cc9540da4ad1b",
                    "assetType": "oaccount",
                    "balance": 0,
                    "bapAccountVersion": 1,
                    "current_date": "2025-11-20T00:00:00.000Z",
                    "daily_amount": 0,
                    "daily_transactions": 0,
                    "max_daily_amount": 10000,
                    "max_daily_transactions": 100,
                    "onhold_balance": 0,
                    "onhold_burn_balance": 0,
                    "org_id": "CentralBank",
                    "token_id": "t1",
                    "token_name": "stablecoin",
                    "token_type": "fungible",
                    "user_id": "creator"
                }
            },
            {
                "key": "oaccount~e888c90d38470956e3d98eccaa158f86a1bf0923900803b2b7cb7b4e0c10a18e",
                "valueJson": {
                    "assetType": "oaccount",
                    "account_id": "oaccount~e888c90d38470956e3d98eccaa158f86a1bf0923900803b2b7cb7b4e0c10a18e",
                    "user_id": "user1",
                    "org_id": "CentralBank",
                    "token_type": "fungible",
                    "token_id": "t1",
                    "token_name": "stablecoin",
                    "balance": 0,
                    "onhold_balance": 0,
                    "onhold_burn_balance": 0,
                    "max_daily_amount": 10000,
                    "daily_amount": 0,
                    "max_daily_transactions": 100,
                    "daily_transactions": 0,
                    "current_date": "2025-11-24T00:00:00.000Z"
                }
            }
        ],
        "encode": "JSON"
    }
}
getAllTokenAdmins
原始方法名稱：getAllTokenAdmins
此方法會傳回所有 Token Admin 使用者的清單。只有 Token Admin 或 Token Auditor 才能呼叫此方法。
有效負載：
{{api-gateway-endpoint1}}/getAllTokenAdmins
參數：
  • 無
傳回值範例：
{
    "returnCode": "Success",
    "error": "",
    "result": {
        "payload": {
            "admins": [
                {
                    "org_id": "CentralBank",
                    "user_id": "cb_admin_demo"
                }
            ]
        },
        "encode": "JSON"
    }
}
getAllTokens
原始方法名稱：getAllTokens
這個方法會傳回狀態資料庫中儲存的所有記號。只有 Token Admin、Token Auditor、Org Admin 或 Org Auditor 才能呼叫此方法。此方法使用 Berkeley DB SQL RTF 查詢，而且只能在連線至遠端 Oracle Blockchain Platform 網路時呼叫。
有效負載：
{{api-gateway-endpoint1}}/getAllTokens
參數：
  • 無
傳回值範例：
{
    "returnCode": "Success",
    "error": "",
    "result": {
        "payload": [
            {
                "key": "t1",
                "valueJson": {
                    "assetType": "otoken",
                    "events": false,
                    "token_id": "t1",
                    "token_name": "stablecoin",
                    "token_desc": "token_desc value",
                    "token_standard": "ttf+",
                    "token_type": "fungible",
                    "token_unit": "fractional",
                    "behaviors": [
                        "divisible",
                        "mintable",
                        "transferable",
                        "burnable",
                        "holdable",
                        "roles"
                    ],
                    "roles": {
                        "minter_role_name": "minter",
                        "burner_role_name": "burner",
                        "notary_role_name": "notary",
                        "mint_approver_role_name": "notary",
                        "burn_approver_role_name": "notary"
                    },
                    "mintable": {
                        "max_mint_quantity": 0,
                        "mint_approval_required": true
                    },
                    "burnable": {
                        "burn_approval_required": true
                    },
                    "divisible": {
                        "decimal": 2
                    },
                    "currencyName": "currencyName value",
                    "conversionRate": 999
                }
            }
        ],
        "encode": "JSON"
    }
}
getApprovalPolicyCheckById
原始方法名稱：getApprovalPolicyCheckById
此方法會取得指定之原則 ID 的核准原則詳細資訊。只有 Token Admin 或 Token Auditor 才能呼叫此方法。
有效負載：
{{api-gateway-endpoint1}}/getApprovalPolicyCheckById?id=id value
參數：
  • id: string – 唯一核准原則 ID。
傳回值範例：
{
    "returnCode": "Success",
    "error": "",
    "result": {
        "payload": {
            "assetType": "ApprovalPolicyCheck",
            "approvalPolicyId": "GPID~0~100",
            "transactionLowerLimit": "0",
            "transactionUpperLimit": "100",
            "numberOfApprovalsRequired": 0,
            "approverDetails": []
        },
        "encode": "JSON"
    }
}
getApprovalTransactionsById
原始方法名稱：getApprovalTransactionsById
此方法會取得指定異動 ID 的核准異動。只有相關組織的 Token Admin 或 Org Admin 才能呼叫此方法。
有效負載：
{{api-gateway-endpoint1}}/getApprovalTransactionsById?id=id value
參數：
  • id: string – 系統產生的核准異動 ID。
傳回值範例：
{
    "returnCode": "Success",
    "error": "",
    "result": {
        "payload": {
            "assetType": "ApprovalTransactions",
            "approvalTransactionId": "hold1~oaccount~1cf5d40c7ea7b9dceedfc66292ab843c1583564c3ecaf9f5ceb11f834018b02f",
            "approvalOperationId": "hold1",
            "fromAccountId": "oaccount~374e4e762940fc185c7cd5b6528c7f94985b6c56acf46abb746de6381589edd2",
            "toAccountId": "oaccount~79c427e614530eacad6fb07cff6048f6b96283e65019301320c9684932846f64",
            "approverAccountId": "oaccount~1cf5d40c7ea7b9dceedfc66292ab843c1583564c3ecaf9f5ceb11f834018b02f",
            "totalApprovals": 1,
            "timestamp": "2025-11-21T12:32:43.000Z"
        },
        "encode": "JSON"
    }
}
getApproverDetailsByTransferAmount
原始方法名稱：getApproverDetailsByTransferAmount
此方式會取得指定移轉金額所需的核准者明細。只有 Token Admin 或 Token Auditor 才能呼叫此方法。
有效負載：
{
    "Amount": 1,
    "endorsers": {{endorsers}}
}
參數：
  • amount: number – 轉移金額。
  • endorsers: string[] – 必須為交易背書的對等體陣列 (例如 peer1、peer2)。
傳回值範例：
{
    "returnCode": "Success",
    "error": "",
    "result": {
        "txid": "5874105c14abd67e68cb4dacf82f2a2dca6cc9da4f5b27fcc91c83a60b7249e1",
        "payload": {
            "approverDetails": [
                {
                    "approverOrgId": "CentralBank",
                    "approverUserId": "manager",
                    "approvalSequence": 1
                },
                {
                    "approverOrgId": "CentralBank",
                    "approverUserId": "creator",
                    "approvalSequence": 2
                }
            ]
        },
        "encode": "JSON",
        "sourceURL": "cb-oabcs1-bom.blockchain.ocp.example.com:20010",
        "blockNumber": 292
    }
}
getMaxDailyAmount
原始方法名稱：getMaxDailyAmount
此方法會取得指定科目的每日累積交易金額上限。只有鏈碼的 Token Admin 或 Token Auditor 或指定組織的 Org Admin 或 Org Auditor 才能呼叫此方法。
有效負載：
{{api-gateway-endpoint1}}/getMaxDailyAmount?OrgId={{bc-org-id}}&UserId={{bc-user-id}}&TokenId={{bc-token-id}}
參數：
  • tokenId: string – 記號的 ID。
  • orgId: string – 目前組織中使用者的會員服務提供者 (MSP) ID。
  • userId: string – 使用者的使用者名稱或電子郵件 ID。
傳回值範例：
{
    "returnCode": "Success",
    "error": "",
    "result": {
        "payload": {
            "max_daily_amount": 10000
        },
        "encode": "JSON"
    }
}
getMaxDailyTransactionCount
原始方法名稱：getMaxDailyTransactionCount
此方法會取得指定科目的每日交易數上限。只有鏈碼的 Token Admin 或 Token Auditor 或指定組織的 Org Admin 或 Org Auditor 才能呼叫此方法。
有效負載：
{{api-gateway-endpoint1}}/getMaxDailyTransactionCount?OrgId={{bc-org-id}}&UserId={{bc-user-id}}&TokenId={{bc-token-id}}
參數：
  • tokenId: string – 記號的 ID。
  • orgId: string – 目前組織中使用者的會員服務提供者 (MSP) ID。
  • userId: string – 使用者的使用者名稱或電子郵件 ID。
傳回值範例：
{
    "returnCode": "Success",
    "error": "",
    "result": {
        "payload": {
            "max_daily_transactions": 100
        },
        "encode": "JSON"
    }
}
getNetTokens
原始方法名稱：getNetTokens
此 GET 方法會針對指定的記號，傳回系統中可用的記號總數。網路記號總計是記號燒錄後剩餘的記號數量。只有 Token Admin、Token Auditor 或 Org Admin 或 Org Auditor 才能呼叫此方法。 
/getNetStablecoinTokens?tokenId={{bc-token-id}}
參數：
  • tokenId: string – 記號的 ID。
傳回值範例：
{
    "returnCode": "Success",
    "error": "",
    "result": {
        "payload": {
            "msg": "Net supply of token for Token Id: USD is 878 tokens.",
            "quantity": 878
        },
        "encode": "JSON"
    }
}
getOnHoldBalanceWithOperationId
原始方法名稱：getOnHoldBalanceWithOperationId
此方法會傳回指定作業 ID 與變數替代字的保留餘額。此方法只能由 Token Admin 或 Token Auditor 呼叫，或由與作業關聯的寄件者、接收者或公證呼叫。
有效負載：
{{api-gateway-endpoint1}}/getOnHoldBalanceWithOperationId?tokenId={{bc-token-id}}&operationId=operation_id value
參數：
  • tokenId: string – 記號的 ID。
  • operationId: string – 識別保留作業的唯一 ID。通常此 ID 會由用戶端應用程式傳送。
傳回值範例：
{
    "returnCode": "Success",
    "error": "",
    "result": {
        "payload": {
            "msg": "Current Holding Balance of Operation 'hold2' for token 't1' is: 600",
            "holding_balance": 600
        },
        "encode": "JSON"
    }
}
getOnHoldDetailsWithOperationId
原始方法名稱：getOnHoldDetailsWithOperationId
此方法會傳回指定作業 ID 與變數替代字的保留異動明細。此方法只能由 Token Admin 或 Token Auditor 呼叫，或由與作業關聯的寄件者、接收者或公證呼叫。
有效負載：
{{api-gateway-endpoint1}}/getOnHoldDetailsWithOperationId?tokenId={{bc-token-id}}&operationId=operation_id value
參數：
  • tokenId: string – 記號的 ID。
  • operationId: string – 識別保留作業的唯一 ID。通常此 ID 會由用戶端應用程式傳送。
傳回值範例：
{
    "returnCode": "Success",
    "error": "",
    "result": {
        "payload": {
            "bapHoldVersion": 1,
            "assetType": "ohold",
            "holding_id": "ohold~stablecoin~t1~hold2",
            "operation_id": "hold2",
            "token_id": "t1",
            "token_name": "stablecoin",
            "operation_type": "transfer",
            "status": "pending",
            "from_account_id": "oaccount~374e4e762940fc185c7cd5b6528c7f94985b6c56acf46abb746de6381589edd2",
            "to_account_id": "oaccount~79c427e614530eacad6fb07cff6048f6b96283e65019301320c9684932846f64",
            "notary_account_id": "oaccount~f44e4d75c0fec749392566e745cd39c453c3039aa7224ae417bc4379b645827c",
            "quantity": 600,
            "time_to_expiration": "0",
            "category": "category value",
            "description": "description value"
        },
        "encode": "JSON"
    }
}
getOnHoldIds
原始方法名稱：getOnHoldIds
此 GET 方法會傳回指定帳戶之所有持有 ID 的清單。只有鏈碼的 Token Admin 或 Token Auditor、指定組織的 Org Admin 或 Org Auditor 或帳戶的 AccountOwner 才能呼叫此方法。 
/getOnHoldIds?tokenId={{bc-token-id}}&orgId={{bc-org-id}}&userId={{bc-user-id}}
參數：
  • tokenId: string – 記號的 ID。
  • orgId: string – 目前組織中使用者的會員服務提供者 (MSP) ID。
  • userId: string – 使用者的使用者名稱或電子郵件 ID。
傳回值範例：
{
    "returnCode": "Success",
    "error": "",
    "result": {
        "payload": {
            "msg": "Holding Ids are: ohold~Stablecoin~USD~8e3147,ohold~Stablecoin~USD~8e315",
            "holding_ids": [
                "ohold~Stablecoin~USD~8e3147",
                "ohold~Stablecoin~USD~8e315"
            ]
        },
        "encode": "JSON"
    }
}
getOrgAccountsByRole
原始方法名稱：getOrgAccountsByRole
此方法會傳回指定組織中具有指定角色之所有帳戶的相關資訊。此方法只能由 Token Admin 或 Token Auditor 呼叫，或由指定組織的 Org Admin 或 Org Auditor 呼叫。
有效負載：
{{api-gateway-endpoint1}}/getOrgAccountsByRole?tokenId={{bc-token-id}}&role=role value (for example minter / burner / notary)&orgId={{bc-org-id}}
參數：
  • tokenId: string – 記號的 ID。
  • role: string – 要檢查的角色名稱。
  • orgId: string – 目前組織中使用者的會員服務提供者 (MSP) ID。
傳回值範例：
{
    "returnCode": "Success",
    "error": "",
    "result": {
        "payload": {
            "accounts": [
                "oaccount~374e4e762940fc185c7cd5b6528c7f94985b6c56acf46abb746de6381589edd2"
            ]
        },
        "encode": "JSON"
    }
}
getOrgAdmins
原始方法名稱：getOrgAdmins
此方法會傳回屬於組織 Org Admin 的所有使用者清單。此方法只能由 Token Admin 或 Token Auditor 呼叫，或由相關組織的 Org Admin 或 Org Auditor 呼叫。
有效負載：
{{api-gateway-endpoint1}}/getOrgAdmins
參數：
  • 無
傳回值範例：
{
    "returnCode": "Success",
    "error": "",
    "result": {
        "payload": {
            "admins": [
                {
                    "org_id": "CentralBank",
                    "user_id": "cb__creator_demo"
                }
            ]
        },
        "encode": "JSON"
    }
}
getOrgAuditors
原始方法名稱：getOrgAuditors
此方法會傳回屬於組織 Org Auditor 的所有使用者清單。此方法只能由 Token Admin 或 Token Auditor 呼叫，或由相關組織的 Org Admin 或 Org Auditor 呼叫。
有效負載：
{{api-gateway-endpoint1}}/getOrgAuditors
參數：
  • 無
傳回值範例：
{
    "returnCode": "Success",
    "error": "",
    "result": {
        "payload": {
            "admins": [
                {
                    "org_id": "CentralBank",
                    "user_id": "cb_auditor_demo"
                }
            ]
        },
        "encode": "JSON"
    }
}
getOrgUsersByRole
原始方法名稱：getOrgUsersByRole
此方法會傳回指定組織中具有指定角色之所有使用者的相關資訊。此方法只能由 Token Admin 或 Token Auditor 呼叫，或由指定組織的 Org Admin 或 Org Auditor 呼叫。
有效負載：
{{api-gateway-endpoint1}}/getOrgUsersByRole?tokenId={{bc-token-id}}&role=role value (for example minter / burner / notary)&orgId={{bc-org-id}}
參數：
  • tokenId: string – 記號的 ID。
  • role: string – 要檢查的角色名稱。
  • orgId: string – 目前組織中使用者的會員服務提供者 (MSP) ID。
傳回值範例：
{
    "returnCode": "Success",
    "error": "",
    "result": {
        "payload": {
            "users": [
                {
                    "token_id": "t1",
                    "user_id": "cb__creator_demo",
                    "org_id": "CentralBank"
                }
            ]
        },
        "encode": "JSON"
    }
}
getStablecoinAccount
原始方法名稱：getAccount
此 GET 方法會傳回指定使用者和記號的帳戶詳細資訊。只有鏈碼的 Token Admin 或 Token Auditor、指定組織的 Org Admin 或 Org Auditor 或帳戶的 AccountOwner 才能呼叫此方法。
查詢：
/getStablecoinAccount?tokenId={{bc-token-id}}&orgId={{bc-org-id}}&userId={{bc-user-id}}
參數：
  • tokenId: string – 記號的 ID。
  • orgId: string – 目前組織中使用者的會員服務提供者 (MSP) ID。
  • userId: string – 使用者的使用者名稱或電子郵件 ID。
傳回值範例：
{
    "returnCode": "Success",
    "error": "",
    "result": {
        "payload": {
            "bapAccountVersion": 0,
            "assetType": "oaccount",
            "status": "active",
            "account_id": "oaccount~cdc6fa5e64bc29f700f99da69f980d8cbb768c7e1a11dd17274e75651f6afafe",
            "user_id": "admin_user_cb",
            "org_id": "CB",
            "token_type": "fungible",
            "token_id": "USD",
            "token_name": "Stablecoin",
            "balance": 0,
            "onhold_balance": 0,
            "max_daily_amount": 10000,
            "daily_amount": 0,
            "max_daily_transactions": 1000,
            "daily_transactions": 0,
            "current_date": "2024-11-20T00:00:00.000Z"
        },
        "encode": "JSON"
    }
}
getStablecoinAccountBalance
原始方法名稱：getAccountBalance
此 GET 方法會傳回指定帳戶和權杖的目前餘額。只有鏈碼的 Token Admin 或 Token Auditor、指定組織的 Org Admin 或 Org Auditor 或帳戶的 AccountOwner 才能呼叫此方法。 
/getStablecoinAccountBalance?tokenId={{bc-token-id}}&orgId={{bc-org-id}}&userId={{bc-user-id}}
參數：
  • tokenId: string – 記號的 ID。
  • orgId: string – 目前組織中使用者的會員服務提供者 (MSP) ID。
  • userId: string – 使用者的使用者名稱或電子郵件 ID。
傳回值範例：
{
    "returnCode": "Success",
    "error": "",
    "result": {
        "payload": {
            "msg": "Current Balance is: 100",
            "user_balance": 100
        },
        "encode": "JSON"
    }
}
getStablecoinAccountOnHoldBalance
原始方法名稱：getAccountOnHoldBalance
此方法會傳回指定帳戶與變數替代字的目前保留餘額。此方法只能由指定組織的 Token Admin 或 Token Auditor、Org Admin 或 Org Auditor 或帳戶的擁有者呼叫。
有效負載：
{{api-gateway-endpoint1}}/getStablecoinAccountOnHoldBalance?tokenId={{bc-token-id}}&orgId={{bc-org-id}}&userId={{bc-user-id}}
參數：
  • tokenId: string – 記號的 ID。
  • orgId: string – 目前組織中使用者的會員服務提供者 (MSP) ID。
  • userId: string – 使用者的使用者名稱或電子郵件 ID。
傳回值範例：
{
    "returnCode": "Success",
    "error": "",
    "result": {
        "payload": {
            "msg": "Total Holding Balance is: 600",
            "holding_balance": 600
        },
        "encode": "JSON"
    }
}
getStablecoinAccountOnHoldBurnBalance
原始方法名稱：getAccountOnHoldBurnBalance
此方法會傳回指定使用者的暫停燒錄餘額。此方法只能由指定組織的 Token Admin 或 Token Auditor、Org Admin 或 Org Auditor 或帳戶的擁有者呼叫。
有效負載：
{{api-gateway-endpoint1}}/getStablecoinAccountOnHoldBurnBalance?tokenId={{bc-token-id}}&orgId={{bc-org-id}}&userId={{bc-user-id}}
參數：
  • tokenId: string – 記號的 ID。
  • orgId: string – 目前組織中使用者的會員服務提供者 (MSP) ID。
  • userId: string – 使用者的使用者名稱或電子郵件 ID。
傳回值範例：
{
    "returnCode": "Success",
    "error": "",
    "result": {
        "payload": {
            "msg": "Total On Hold Burning Balance is: 0",
            "onhold_burn_balance": 0
        },
        "encode": "JSON"
    }
}
getStablecoinAccountPolicyCheckById
原始方法名稱：getAccountPolicyCheckById
此方法會取得指定保單 ID 的帳戶保單詳細資料。此方法只能由指定組織的 Token Admin、Token Auditor 或 Org Admin 或 Org Auditor 呼叫。
有效負載：
{{api-gateway-endpoint1}}/getStablecoinAccountPolicyCheckById?id=id value
參數：
  • id: string – 唯一的帳戶原則 ID。
傳回值範例：
{
    "returnCode": "Success",
    "error": "",
    "result": {
        "txid": "02875ca9c6a7408da3f81156214228b91b09c4bb2b8026d7a5733b53598c6635",
        "payload": {
            "assetType": "AccountPolicyCheck",
            "accountPolicyId": "APID~CentralBank~cb__creator_demo",
            "orgId": "CentralBank",
            "userId": "cb__creator_demo",
            "kycCompliance": "true",
            "amlCompliance": "true",
            "riskScore": 1000,
            "restrictionFlag": "false"
        },
        "encode": "JSON",
        "sourceURL": "cb-oabcs1-bom.blockchain.ocp.example.com:20010",
        "blockNumber": 272
    }
}
getStablecoinAccountsByRole
原始方法名稱：getAccountsByRole
此方法會傳回指定角色和記號的所有帳戶 ID 清單。只有 Token Admin 或 Token Auditor 才能呼叫此方法。
有效負載：
{{api-gateway-endpoint1}}/getStablecoinAccountsByRole?tokenId={{bc-token-id}}&role=role value (for example minter / burner / notary)
參數：
  • tokenId: string – 記號的 ID。
  • role: string – 要檢查的角色名稱。
傳回值範例：
{
    "returnCode": "Success",
    "error": "",
    "result": {
        "payload": {
            "accounts": [
                "oaccount~374e4e762940fc185c7cd5b6528c7f94985b6c56acf46abb746de6381589edd2"
            ]
        },
        "encode": "JSON"
    }
}
getStablecoinAccountsByUser
原始方法名稱：getAccountsByUser
此方法會傳回指定組織 ID 與使用者 ID 之所有帳戶 ID 的清單。只有鏈碼的 Token Admin 或 Token Auditor、指定組織的 Org Admin 或 Org Auditor 或帳戶的 AccountOwner 才能呼叫此方法。 
/getStablecoinAccountsByUser?orgId={{bc-org-id}}&userId={{bc-user-id}}
參數：
  • orgId: string – 目前組織中使用者的會員服務提供者 (MSP) ID。
  • userId: string – 使用者的使用者名稱或電子郵件 ID。
傳回值範例：
{
    "returnCode": "Success",
    "error": "",
    "result": {
        "payload": [
            {
                "bapAccountVersion": 0,
                "assetType": "oaccount",
                "account_id": "oaccount~8db15b42910eeec401e1bf22c69dfdd11c820ecc26539ea03a3426fa25cb8c28",
                "user_id": "admin_user_cb",
                "org_id": "CB",
                "token_type": "fungible",
                "token_id": "",
                "token_name": "",
                "balance": 0,
                "onhold_balance": 0,
                "max_daily_amount": 10000,
                "daily_amount": 0,
                "max_daily_transactions": 1000,
                "daily_transactions": 0,
                "current_date": "2024-11-20T00:00:00.000Z"
            },
            {
                "bapAccountVersion": 0,
                "assetType": "oaccount",
                "account_id": "oaccount~cdc6fa5e64bc29f700f99da69f980d8cbb768c7e1a11dd17274e75651f6afafe",
                "user_id": "admin_user_cb",
                "org_id": "CB",
                "token_type": "fungible",
                "token_id": "USD",
                "token_name": "Stablecoin",
                "balance": 0,
                "onhold_balance": 0,
                "max_daily_amount": 10000,
                "daily_amount": 0,
                "max_daily_transactions": 1000,
                "daily_transactions": 0,
                "current_date": "2024-11-20T00:00:00.000Z"
            },
            {
                "bapAccountVersion": 0,
                "assetType": "oaccount",
                "account_id": "oaccount~28ac774001f374064029d51af4fb67e26ea1ea9ef62828b7a72dbf3beb8efd8d",
                "user_id": "admin_user_cb",
                "org_id": "CB",
                "token_type": "fungible",
                "token_id": "",
                "token_name": "",
                "balance": 0,
                "onhold_balance": 0,
                "max_daily_amount": 10000,
                "daily_amount": 0,
                "max_daily_transactions": 100,
                "daily_transactions": 0,
                "current_date": "2024-12-09T00:00:00.000Z"
            }
        ],
        "encode": "JSON"
    }
}
getStablecoinAccountStatus
原始方法名稱：getAccountStatus
此方法會取得權杖帳戶的目前狀態。Token Admin、Token Auditor、指定組織的 Org Admin 或 Org Auditor，或記號帳戶擁有者可呼叫此方法。如果在分類帳中找不到 accountStatus 值，此方法會傳回狀態設為有效的 accountStatus 物件。
有效負載：
{{api-gateway-endpoint1}}/getStablecoinAccountStatus?tokenId={{bc-token-id}}&orgId={{bc-org-id}}&userId={{bc-user-id}}
參數：
  • tokenId: string – 記號的 ID。
  • orgId: string – 目前組織中使用者的會員服務提供者 (MSP) ID。
  • userId: string – 使用者的使用者名稱或電子郵件 ID。
傳回值範例：
{
    "returnCode": "Success",
    "error": "",
    "result": {
        "payload": {
            "assetType": "oaccountStatus",
            "status_id": "oaccountStatus~cfe302f06bf732f248315725bb601d7906d7c1d4c167d04ac3a5283b8dbc7fc4",
            "account_id": "oaccount~374e4e762940fc185c7cd5b6528c7f94985b6c56acf46abb746de6381589edd2",
            "status": "active"
        },
        "encode": "JSON"
    }
}
getStablecoinAccountTransactionHistoryWithFilters
原始方法名稱：getAccountTransactionHistoryWithFiltersFromRichHistDB
此方法會從 RTF 歷史記錄資料庫傳回帳戶交易歷史記錄明細。只有鏈碼的 Token Admin 或 Token Auditor、指定組織的 Org Admin 或 Org Auditor 或帳戶的 AccountOwner 才能呼叫此方法。 
/getStablecoinAccountTransactionHistoryWithFilters?tokenId={{bc-token-id}}&orgId={{bc-org-id}}&userId={{bc-user-id}}&customEndpoint=custom_endpoint value&bearerToken=bearer_token value&filters={"pageSize":20,"bookmark":"","startTime":"2022-01-16T15:16:36+00:00","endTime":"2022-01-17T15:16:36+00:00"}
參數：
  • tokenId: string – 記號的 ID。
  • orgId: string – 目前組織中使用者的會員服務提供者 (MSP) ID。
  • userId: string – 使用者的使用者名稱或電子郵件 ID。
  • customEndpoint – RTF 歷史記錄資料庫的 RESTful 服務端點，用於擷取交易歷史記錄。
  • bearerToken – 用來呼叫 RESTful 端點以確保要求獲得授權的記號。
  • filters: JSON object – 選擇性參數。如果空白，則會傳回所有記錄。pageSize 特性決定要傳回的記錄數目。如果 pageSize 為 0，則預設頁面大小為 20。bookmark 特性決定要傳回之記錄的開始索引。必須以 RFC-3339 格式指定 startTime 和 endTime 特性。
傳回值範例：
{
    "returnCode": "Success",
    "error": "",
    "result": {
        "payload": [
            {
                "transaction_id": "otransaction~64c5a4830949eae1424600f3d4a438c6f603a7c3ea31a68e374b899803999e22",
                "transacted_amount": 10,
                "timestamp": "2024-12-11T13:37:28.000Z",
                "balance": 550,
                "onhold_balance": 10,
                "token_id": "USD",
                "category": "category value",
                "description": "description value",
                "transacted_account": "oaccount~9d9806fa92aa0c4fdb34eaffac6e830181b5d47e64fbce752195e83024125ca0",
                "transaction_type": "REJECT_MINT",
                "transacted_org_id": "CB",
                "transacted_user_id'": "creator_user_cb"
            },
            {
                "transaction_id": "otransaction~a4537ef34a955b023b7c205b9abf06a6c79e4fdd761fb24f41b8eb34126b66c0",
                "transacted_amount": 10,
                "timestamp": "2024-12-11T13:36:32.000Z",
                "balance": 550,
                "onhold_balance": 10,
                "token_id": "USD",
                "description": "description value",
                "transacted_account": "oaccount~9d9806fa92aa0c4fdb34eaffac6e830181b5d47e64fbce752195e83024125ca0",
                "transaction_type": "APPROVE_MINT",
                "transacted_org_id": "CB",
                "transacted_user_id'": "creator_user_cb"
            },
            {
                "transaction_id": "otransaction~6237a759422bd9fb112742e8cd7e6450df5a74a32236d9b1005571afed8904a4",
                "transacted_amount": 10,
                "timestamp": "2024-12-11T13:36:18.000Z",
                "balance": 540,
                "onhold_balance": 10,
                "token_id": "USD",
                "category": "category value",
                "description": "description value",
                "transacted_account": "oaccount~9d9806fa92aa0c4fdb34eaffac6e830181b5d47e64fbce752195e83024125ca0",
                "transaction_type": "REQUEST_MINT",
                "transacted_org_id": "CB",
                "transacted_user_id'": "creator_user_cb"
            },
            {
                "transaction_id": "otransaction~06b35071415d74aa1a7c18449149c937d886cae76a832c44cf8d98e84586e76e",
                "transacted_amount": 10,
                "timestamp": "2024-12-11T13:35:46.000Z",
                "balance": 540,
                "onhold_balance": 10,
                "token_id": "USD",
                "category": "category value",
                "description": "description value",
                "transacted_account": "oaccount~9d9806fa92aa0c4fdb34eaffac6e830181b5d47e64fbce752195e83024125ca0",
                "transaction_type": "REQUEST_MINT",
                "transacted_org_id": "CB",
                "transacted_user_id'": "creator_user_cb"
            }
        ],
        "encode": "JSON"
    }
}
getTokenAuditors
原始方法名稱：getTokenAuditors
此方法會傳回鏈碼的所有 Token Auditors。只有 Token Admin 或 Token Auditor 才能呼叫此方法。
有效負載：
 	
{{api-gateway-endpoint1}}/getTokenAuditors
參數：
  • 無
傳回值範例：
{
    "returnCode": "Success",
    "error": "",
    "result": {
        "payload": {
            "auditors": [
                {
                    "org_id": "CentralBank",
                    "user_id": "cb_auditor_demo"
                }
            ]
        },
        "encode": "JSON"
    }
}
getTokenById
原始方法名稱：getTokenById
此方法會傳回指定記號 ID 的記號詳細資訊。只有 Token Admin、Token Auditor 或任何組織的 Org Admin 或 Org Auditor 才能呼叫此方法。
有效負載：
{{api-gateway-endpoint1}}/getTokenById?tokenId={{bc-token-id}}
參數：
  • tokenId: string – 記號的 ID。
傳回值範例：
{
    "returnCode": "Success",
    "error": "",
    "result": {
        "payload": {
            "assetType": "otoken",
            "events": false,
            "token_id": "t1",
            "token_name": "stablecoin",
            "token_desc": "token_desc value",
            "token_standard": "ttf+",
            "token_type": "fungible",
            "token_unit": "fractional",
            "behaviors": [
                "divisible",
                "mintable",
                "transferable",
                "burnable",
                "holdable",
                "roles"
            ],
            "roles": {
                "minter_role_name": "minter",
                "burner_role_name": "burner",
                "notary_role_name": "notary",
                "mint_approver_role_name": "notary",
                "burn_approver_role_name": "notary"
            },
            "mintable": {
                "max_mint_quantity": 0,
                "mint_approval_required": true
            },
            "burnable": {
                "burn_approval_required": true
            },
            "divisible": {
                "decimal": 2
            },
            "currencyName": "currencyName value",
            "conversionRate": 999
        },
        "encode": "JSON"
    }
}
getTokenHistory
原始方法名稱：getTokenHistory
此方法會傳回所指定記號 ID 的記號歷史記錄。只有 Token Admin、Token Auditor 或任何組織的 Org Admin 或 Org Auditor 才能呼叫此方法。
有效負載：
{{api-gateway-endpoint1}}/getTokenHistory?tokenId={{bc-token-id}}
參數：
  • tokenId: string – 記號的 ID。
傳回值範例：
{
    "returnCode": "Success",
    "error": "",
    "result": {
        "payload": [
            {
                "trxId": "28c205ee6f607d77490ab28aa99729a700c34e524efe805b213a526e58dd2b40",
                "timeStamp": "2025-11-20T21:30:16.000Z",
                "value": {
                    "assetType": "otoken",
                    "events": false,
                    "token_id": "t1",
                    "token_name": "stablecoin",
                    "token_desc": "token_desc value",
                    "token_standard": "ttf+",
                    "token_type": "fungible",
                    "token_unit": "fractional",
                    "behaviors": [
                        "divisible",
                        "mintable",
                        "transferable",
                        "burnable",
                        "holdable",
                        "roles"
                    ],
                    "roles": {
                        "minter_role_name": "minter",
                        "burner_role_name": "burner",
                        "notary_role_name": "notary",
                        "mint_approver_role_name": "notary",
                        "burn_approver_role_name": "notary"
                    },
                    "mintable": {
                        "max_mint_quantity": 0,
                        "mint_approval_required": true
                    },
                    "burnable": {
                        "burn_approval_required": true
                    },
                    "divisible": {
                        "decimal": 2
                    },
                    "currencyName": "currencyName value",
                    "conversionRate": 999
                }
            }
        ],
        "encode": "JSON"
    }
}
getTotalMintedTokens
原始方法名稱：getTotalMintedTokens
此方法會傳回指定記號的預期記號總數。只有 Token Admin、Token Auditor、Org Admin 或 Org Auditor 才能呼叫此方法。
查詢：
/getTotalCreatedStablecoinTokens?tokenId={{bc-token-id}}
參數：
  • tokenId: string – 記號的 ID。
傳回值範例：
{
    "returnCode": "Success",
    "error": "",
    "result": {
        "payload": {
            "msg": "Total minted token for Token Id: USD is 910 tokens.",
            "quantity": 910
        },
        "encode": "JSON"
    }
}
getTransactionById
原始方法名稱：getTransactionById
此方法會傳回指定交易 ID 的詳細交易記錄。只有 Token Admin 或由交易指定的任何帳戶 (寄件者、接收者或公證人) 才能呼叫此方法。
有效負載：
{{api-gateway-endpoint1}}/getTransactionById?transactionId=transaction_id value
參數：
  • transaction_id string – 交易的 ID。
傳回值範例：
{
    "returnCode": "Success",
    "error": "",
    "result": {
        "payload": {
            "transaction_id": "otransaction~493a6cdcaac058ab6ae2bd001e8a761e378e99e283b06443041d286d46d077c4",
            "history": [
                {
                    "trxId": "493a6cdcaac058ab6ae2bd001e8a761e378e99e283b06443041d286d46d077c4",
                    "timeStamp": "2025-11-24T09:50:59.000Z",
                    "value": {
                        "assetType": "otransaction",
                        "transaction_id": "otransaction~493a6cdcaac058ab6ae2bd001e8a761e378e99e283b06443041d286d46d077c4",
                        "token_id": "t1",
                        "from_account_id": "oaccount~374e4e762940fc185c7cd5b6528c7f94985b6c56acf46abb746de6381589edd2",
                        "from_account_onhold_burn_balance": 0,
                        "to_account_id": "oaccount~79c427e614530eacad6fb07cff6048f6b96283e65019301320c9684932846f64",
                        "to_account_onhold_burn_balance": 0,
                        "transaction_type": "ONHOLD",
                        "amount": 600,
                        "timestamp": "2025-11-24T09:50:59.000Z",
                        "number_of_sub_transactions": 0,
                        "holding_id": "ohold~stablecoin~t1~hold2",
                        "sub_transaction": "false",
                        "category": "category value",
                        "description": "description value"
                    }
                }
            ],
            "sub_transactions": []
        },
        "encode": "JSON"
    }
}
getUserByStablecoinAccountId
原始方法名稱：getUserByAccountId
此方法會傳回指定帳戶的使用者詳細資訊 (org_id、user_id 和 token_id)。只有鏈碼的 Token Admin 或 Token Auditor，或指定組織的 Org Admin 或 Org Auditor 才能呼叫此方法。
查詢：
/getUserByStablecoinAccountId?accountId=account_id value
參數：
  • accountId: string – 帳戶的 ID。
傳回值範例：
{
    "returnCode": "Success",
    "error": "",
    "result": {
        "payload": {
            "token_id": "USD",
            "user_id": "admin_user_cb",
            "org_id": "CB"
        },
        "encode": "JSON"
    }
}
getUsersByRole
原始方法名稱：getUsersByRole
此 GET 方法會傳回指定角色和記號之所有使用者的清單。只有鏈碼的 Token Admin 或 Token Auditor 才能呼叫此方法。
查詢：
/getUsersByRole?tokenId={{bc-token-id}}&role=role value (for example minter / burner / notary)
參數：
  • tokenId: string – 記號的 ID。
  • role: string – 要搜尋的角色名稱。
傳回值範例：
{
    "returnCode": "Success",
    "error": "",
    "result": {
        "payload": {
            "users": [
                {
                    "token_id": "USD",
                    "user_id": "creator_user_cb",
                    "org_id": "CB"
                },
                {
                    "token_id": "USD",
                    "user_id": "cb4",
                    "org_id": "CB"
                }
            ]
        },
        "encode": "JSON"
    }
}
holdTokens
原始方法名稱：holdTokens
此方法使用 to_account_id 帳戶代表權杖的擁有者建立保留。已指定公證人帳戶，該帳戶負責完成或解除保留。建立保留時，系統會保留付款人的指定變數替代字餘額。保留完成或解除之前，無法移轉保留餘額。此方法的來電者必須已建立帳戶。
有效負載：
{
    "tokenId": "{{bc-token-id}}",
    "operationId": "operation_id value",
    "toOrgId": "to_org_id value",
    "toUserId": "to_user_id value",
    "notaryOrgId": "notary_org_id value",
    "notaryUserId": "notary_user_id value",
    "quantity": 1,
    "timeToExpiration": "time_to_expiration value",
    "infoDetails": "{\"category\":\"category value\",\"description\":\"description value\"}",
    "endorsers": {{endorsers}}
}
參數：
  • tokenId: string – 記號的 ID。
  • operationId: string – 識別保留作業的唯一 ID。通常此 ID 會由用戶端應用程式傳送。
  • toOrgId: string – 目前組織中接收者的成員服務提供者 (MSP) ID。
  • toUserId: string – 接收者的使用者名稱或電子郵件 ID。
  • notaryOrgId: string – 目前組織中公證人的會員服務提供者 (MSP) ID。
  • notaryUserId: string – 公證人的使用者名稱或電子郵件 ID。
  • quantity: number – 保留的記號數目。
  • timeToExpiration – 保留到期的時間。為永久保留指定 0 。否則，請使用 RFC-3339 格式。例如，2021-06-02T12：46：06Z 。
  • infoDetails: JSON – 說明與類別，如下列範例所示。
    {
   "category" : "category input",
   "description" : "description input"
}
  • endorsers: string[] – 必須為交易背書的對等體陣列 (例如 peer1、peer2)。
傳回值範例：
{
    "returnCode": "Success",
    "error": "",
    "result": {
        "txid": "e575d339299bb98afe83207e749cd07654f209673c84c6973738b6094da33062",
        "payload": {
            "msg": "AccountId oaccount~51e676d7182a02ea7418ef58a6d54ecfe3858ef40b4ffb3d859b320da3921594 (Org-Id: CB , User-Id: issuer_user_cb) is successfully holding 10 tokens"
        },
        "encode": "JSON",
        "sourceURL": "cb-oabcs1-bom.blockchain.ocp.example.com:20009",
        "blockNumber": 211
    }
}
init
原始方法名稱：init
部署鏈碼時會呼叫此方法。使用者資訊會儲存為鏈碼的 Token Admin。
有效負載：
{
    "adminList": "[{\"org_id\":\"{{bc-org-id}}\",\"user_id\":\"{{bc-admin-user}}\"}]"
}
參數：
  • adminList: TokenAdminAsset[] – JSON 物件陣列，其中包含指定權杖管理員的組織 ID 和使用者 ID，格式如下：
    {
   "org_id":"{{bc-org-id}}",
   "user_id":"{{bc-admin-user}
}
傳回值範例：
{
    "returnCode": "Success",
    "error": "",
    "result": {
        "txid": "fdb7dc89832c8045a333823b77fa24ae628178148dc93b3550040e070d7cd807",
        "payload": "",
        "encode": "UTF-8",
        "sourceURL": "cb-oabcs1-bom.blockchain.ocp.example.com:20009",
        "blockNumber": 263
    }
}
initializeStablecoinToken
原始方法名稱：initializeStablecoinToken
此方法會建立記號並初始化記號特性。資產及其特性會儲存在狀態資料庫中。只有鏈碼的 Token Admin 才能呼叫此方法。
有效負載：
{
    "tokenAsset": "{\"token_id\":\"{{bc-token-id}}\",\"token_desc\":\"token_desc value\",\"Currency_Name\":\"Currency_Name value\"}",
    "sameOrgEndorser": true
}
參數：
  • tokenAsset: <Token Class> – 將記號資產當作參數傳遞給此方法。模型檔案中描述記號資產的特性。
  • sameOrgEndorser: boolean - 表示交易背書是否必須來自與要求者相同的組織布林值。
傳回值：
  • 成功時，所建立權杖資產的 JSON 表示法。
傳回值範例：
{
    "returnCode": "Success",
    "error": "",
    "result": {
        "txid": "aa7a4f4cc214e1a041a5a6fb7ca7530f08256559e538c9f9582e6fd12c9e65c8",
        "payload": {
            "assetType": "otoken",
            "events": false,
            "token_id": "t1",
            "token_name": "Stablecoin",
            "token_desc": "token_desc value",
            "token_standard": "ttf+",
            "token_type": "fungible",
            "token_unit": "fractional",
            "behaviors": [
                "divisible",
                "mintable",
                "transferable",
                "burnable",
                "holdable",
                "roles"
            ],
            "roles": {
                "minter_role_name": "minter",
                "burner_role_name": "burner",
                "notary_role_name": "notary",
                "mint_approver_role_name": "notary",
                "burn_approver_role_name": "notary"
            },
            "mintable": {
                "max_mint_quantity": 1000,
                "mint_approval_required": true
            },
            "burnable": {
                "burn_approval_required": true
            },
            "divisible": {
                "decimal": 2
            },
            "currency_name": "currency_name value",
            "token_to_currency_ratio": 999
        },
        "encode": "JSON",
        "sourceURL": "cb-oabcs1-bom.blockchain.ocp.example.com:20009",
        "blockNumber": 267
    }
}
isInRole
原始方法名稱：isInRole
此方法會傳回布林值，指示使用者和記號是否具有指定的角色。此方法只能由帳戶的 Token Admin 或擁有者呼叫。
有效負載：
{{api-gateway-endpoint2}}/isInRole?tokenId={{bc-token-id}}&orgId={{bc-org-id}}&userId={{bc-user-id}}&role=role value (for example minter / burner / notary)
參數：
  • tokenId: string – 記號的 ID。
  • orgId: string – 使用者的成員服務提供者 (MSP) ID。
  • userId: string – 使用者的使用者名稱或電子郵件 ID。
  • role: string – 角色名稱。
傳回值範例：
{
    "returnCode": "Success",
    "error": "",
    "result": {
        "payload": {
            "result": "true"
        },
        "encode": "JSON"
    }
}
isTokenAdmin
原始方法名稱：isTokenAdmin
如果指定的帳戶是 Token Admin，此方法會傳回布林值 true，否則會傳回 false。THis 方法只能由 Token Admin 呼叫。
有效負載：
{{api-gateway-endpoint2}}/isTokenAdmin?orgId={{bc-org-id}}&userId={{bc-user-id}}
參數：
  • orgId: string – 目前組織中使用者的會員服務提供者 (MSP) ID。
  • userId: string – 使用者的使用者名稱或電子郵件 ID。
傳回值範例：
{
    "returnCode": "Success",
    "error": "",
    "result": {
        "payload": {
            "result": false
        },
        "encode": "JSON"
    }
}
rejectBurn
原始方法名稱：rejectBurn
公證人可呼叫此方法以拒絕燒錄要求。
有效負載：
{
    "tokenId": "{{bc-token-id}}",
    "operationId": "operation_id value",
    "sameOrgEndorser": true
}
參數：
  • tokenId: string – 要拒絕燒錄的記號 ID。
  • operationId: string – 代表燒錄要求的唯一作業 ID。
  • sameOrgEndorser: boolean - 表示交易背書是否必須來自與要求者相同的組織布林值。
傳回值範例：
{
    "returnCode": "Success",
    "error": "",
    "result": {
        "txid": "474a08183986c84fe321aa925670539db3b1bc90b02fa65956ad8c771fff5bbe",
        "payload": {
            "msg": "Successfully rejected burn request with Operation Id 'burn1234' to burn 10 tokens of token id USD"
        },
        "encode": "JSON",
        "sourceURL": "cb-oabcs1-bom.blockchain.ocp.example.com:20009",
        "blockNumber": 210
    }
}
rejectMint
原始方法名稱：rejectMint
公證人可以呼叫此方法來拒絕 Minting 要求。
有效負載：
{
    "tokenId": "{{bc-token-id}}",
    "operationId": "operation_id value",
    "sameOrgEndorser": true
}
參數：
  • tokenId: string – 要拒絕採礦的記號 ID。
  • operationId: string – 代表提示要求的唯一作業 ID。
  • sameOrgEndorser: boolean - 表示交易背書是否必須來自與要求者相同的組織布林值。
傳回值範例：
{
    "returnCode": "Success",
    "error": "",
    "result": {
        "txid": "64c5a4830949eae1424600f3d4a438c6f603a7c3ea31a68e374b899803999e22",
        "payload": {
            "msg": "Successfully rejected mint request with Operation Id 'op1234' to mint 10 tokens of token id USD"
        },
        "encode": "JSON",
        "sourceURL": "cb-oabcs1-bom.blockchain.ocp.example.com:20009",
        "blockNumber": 205
    }
}
releaseHoldTokens
原始方法名稱：releaseHoldTokens
此 POST 方法會解除保留記號。轉帳未完成，所有保留的權杖都會再次提供給原始擁有者使用。具有 notary 角色的 AccountOwner ID 可在指定的時間限制內呼叫此方法，或由付款人、受款人或公證人在指定的時間限制之後呼叫。
有效負載：
{
    "tokenId": "{{bc-token-id}}",
    "operationId": "operation_id value",
    "endorsers": {{endorsers}}
}
參數：
  • tokenId: string – 記號的 ID。
  • operationId: string – 識別保留作業的唯一 ID。通常此 ID 會由用戶端應用程式傳送。
  • endorsers: string[] – 必須為交易背書的對等體陣列 (例如 peer1、peer2)。
傳回值範例：
{
    "returnCode": "Success",
    "error": "",
    "result": {
        "txid": "f04ba8895d52bc636d843f88476002bc99d01480c36be87c8fa259cd47a29380",
        "payload": {
            "msg": "Successfully released '10' tokens from Operation Id '8e3144' to Account Id: oaccount~51e676d7182a02ea7418ef58a6d54ecfe3858ef40b4ffb3d859b320da3921594 (Org-Id: CB, User-Id: issuer_user_cb)."
        },
        "encode": "JSON",
        "sourceURL": "cb-oabcs1-bom.blockchain.ocp.example.com:20009",
        "blockNumber": 214
    }
}
removeOrgAdmin
原始方法名稱：removeOrgAdmin
此 POST 方法會移除使用者作為鏈碼的 Org Admin。只有指定的組織之 Token Admin 或 Org Admin 才能呼叫此方法。
有效負載：
{
    "orgId": "{{bc-org-id}}",
    "userId": "{{bc-user-id}}",
    "sameOrgEndorser": true
}
參數：
  • orgId: string – 目前組織中使用者的會員服務提供者 (MSP) ID。
  • userId: string – 使用者的使用者名稱或電子郵件 ID。
  • sameOrgEndorser: boolean - 表示交易背書是否必須來自與要求者相同的組織布林值。
傳回值範例：
{
    "returnCode": "Success",
    "error": "",
    "result": {
        "txid": "e2a634f6093f89b1984e20ff86a513fabb7c3ade7cc9e27d9734b4aaf6c88597",
        "payload": {
            "msg": "Successfully removed Org Admin (Org_Id: CB, User_Id: cb)"
        },
        "encode": "JSON",
        "sourceURL": "cb-oabcs1-bom.blockchain.ocp.example.com:20010",
        "blockNumber": 220
    }
}
removeOrgAuditor
原始方法名稱：removeOrgAuditor
此 POST 方法會移除使用者作為鏈碼的 Org Auditor。只有指定的組織之 Token Admin 或 Org Admin 才能呼叫此方法。
有效負載：
{
    "orgId": "{{bc-org-id}}",
    "userId": "{{bc-user-id}}",
    "sameOrgEndorser": true
}
參數：
  • orgId: string – 目前組織中使用者的會員服務提供者 (MSP) ID。
  • userId: string – 使用者的使用者名稱或電子郵件 ID。
  • sameOrgEndorser: boolean - 表示交易背書是否必須來自與要求者相同的組織布林值。
傳回值範例：
{
    "returnCode": "Success",
    "error": "",
    "result": {
        "txid": "c3bc720461004a53b37c68d4bb264858b88d980bc093a0a3ebb62a32974fb306",
        "payload": {
            "msg": "Successfully removed Org Auditor (Org_Id: CB, User_Id: cb)"
        },
        "encode": "JSON",
        "sourceURL": "cb-oabcs1-bom.blockchain.ocp.example.com:20010",
        "blockNumber": 221
    }
}
removeRole
原始方法名稱：removeRole
此方法會移除指定使用者和記號中的 af 角色。只有鏈碼的 Token Admin 或指定的組織 Org Admin 才能呼叫此方法。
有效負載：
{
    "tokenId": "{{bc-token-id}}",
    "role": "role value (for example minter / burner / notary)",
    "orgId": "{{bc-org-id}}",
    "userId": "{{bc-user-id}}",
    "endorsers": {{endorsers}}
}
參數：
  • tokenId: string – 記號的 ID。
  • role: string – 要從指定使用者移除的角色名稱。mintable 和 burnable 行為對應至規格檔案的 minter_role_name 和 burner_role_name 特性。同樣地，notary 角色對應至規格檔案的 notary_role_name 特性。
  • orgId: string – 目前組織中使用者的會員服務提供者 (MSP) ID。
  • userId: string – 使用者的使用者名稱或電子郵件 ID。
  • endorsers: string[] – 必須為交易背書的對等體陣列 (例如 peer1、peer2)。
傳回值：
  • 成功時，包含帳戶詳細資訊的訊息。
傳回值範例：
{
    "returnCode": "Success",
    "error": "",
    "result": {
        "txid": "274f0d0a2c4c3929817fb85b2e857519695c3c238ccf9903b084b87e9be7ee12",
        "payload": {
            "msg": "Successfully removed role 'notary' from Account Id: oaccount~2eb5f8a9bc561f8f41a4ea3be9511958cc6684ef14f2337ca396efc301b627d8 (Org-Id: CB, User-Id: manager_user_cb)"
        },
        "encode": "JSON",
        "sourceURL": "cb-oabcs1-bom.blockchain.ocp.example.com:20009",
        "blockNumber": 200
    }
}
removeTokenAdmin
原始方法名稱：removeTokenAdmin
此 POST 方法會移除使用者作為鏈碼的 Token Admin。只有鏈碼的 Token Admin 才能呼叫此方法。管理員無法自行移除。
有效負載：
{
    "orgId": "{{bc-org-id}}",
    "userId": "{{bc-user-id}}",
    "sameOrgEndorser": true
}
參數：
  • orgId: string – 目前組織中使用者的會員服務提供者 (MSP) ID。
  • userId: string – 使用者的使用者名稱或電子郵件 ID。
  • sameOrgEndorser: boolean - 表示交易背書是否必須來自與要求者相同的組織布林值。
傳回值範例：
{
    "returnCode": "Success",
    "error": "",
    "result": {
        "txid": "6a3b9b568d04b5beb29830f91efe4e8c6310b6cf36940cecfb4ab690fbfde739",
        "payload": {
            "msg": "Successfully removed Token Admin (Org_Id: CB, User_Id: cb)"
        },
        "encode": "JSON",
        "sourceURL": "cb-oabcs1-bom.blockchain.ocp.example.com:20010",
        "blockNumber": 218
    }
}
removeTokenAuditor
原始方法名稱： removeTokenAuditor
此 POST 方法會移除使用者作為鏈碼的 Token Auditor。只有鏈碼的 Token Admin 才能呼叫此方法。
有效負載：
{
    "orgId": "{{bc-org-id}}",
    "userId": "{{bc-user-id}}",
    "sameOrgEndorser": true
}
參數：
  • orgId: string – 目前組織中使用者的會員服務提供者 (MSP) ID。
  • userId: string – 使用者的使用者名稱或電子郵件 ID。
  • sameOrgEndorser: boolean - 表示交易背書是否必須來自與要求者相同的組織布林值。
傳回值範例：
{
    "returnCode": "Success",
    "error": "",
    "result": {
        "txid": "a886a6040fbc76374a3c78c89ab0ffc9f7b8391cc5239b169bf3b878cf40c67b",
        "payload": {
            "msg": "Successfully removed Token Auditor (Org_Id: CB, User_Id: cb)"
        },
        "encode": "JSON",
        "sourceURL": "cb-oabcs1-bom.blockchain.ocp.example.com:20010",
        "blockNumber": 219
    }
}
requestBurn
原始方法名稱：requestBurn
燒錄機可以呼叫此方法，以傳送要求給公證人以銷毀指定數量的記號。
有效負載：
{
    "tokenId": "{{bc-token-id}}",
    "operationId": "operation_id value",
    "notaryOrgId": "notary_org_id value",
    "notaryUserId": "notary_user_id value",
    "quantity": 1,
    "timeToExpiration": "time_to_expiration value",
    "infoDetails": "{\"category\":\"category value\",\"description\":\"description value\"}",
    "sameOrgEndorser": true
}
參數：
  • tokenId: string – 要燒錄的記號 ID。
  • operationId: string – 代表燒錄要求的唯一作業 ID。
  • notaryOrgId: string – 將處理要求的燒錄公證人會員服務提供者 (MSP) ID。
  • notaryUserId: string – 將處理要求之燒錄者公證人的使用者名稱或電子郵件 ID。
  • quantity: number – 要燒錄的記號數量。
  • timeToExpiration – 燒錄要求到期且不再有效的時間。
  • infoDetails: JSON – 指定要求之類別 (category) 和描述 (description) 的物件，如下列範例所示。
    {
     "category" : "category input",
     "description" : "description input"
}
  • sameOrgEndorser: boolean - 表示交易背書是否必須來自與要求者相同的組織布林值。
傳回值範例：
{
    "returnCode": "Success",
    "error": "",
    "result": {
        "txid": "0adb57ca9776c8760468c40465e0f0d37472f0b4b32fd02561ef28b3f7b28cf1",
        "payload": {
            "msg": "AccountId oaccount~0d7b3f73aea28065017ce8b79c0bb19256dc0cb475a0b2a85192bd110f69535c (Org-Id: CB , User-Id: retirer_user_cb) has successfully submitted request to burn 10 tokens"
        },
        "encode": "JSON",
        "sourceURL": "cb-oabcs1-bom.blockchain.ocp.example.com:20010",
        "blockNumber": 206
    }
}
requestMint
原始方法名稱：requestMint
礦工可以呼叫此方法，以傳送要求給礦工公證人以建立指定數量的權杖。
有效負載：
{
    "tokenId": "{{bc-token-id}}",
    "operationId": "operation_id value",
    "notaryOrgId": "notary_org_id value",
    "notaryUserId": "notary_user_id value",
    "quantity": 1,
    "timeToExpiration": "time_to_expiration value",
    "infoDetails": "{\"category\":\"category value\",\"description\":\"description value\"}",
    "sameOrgEndorser": true
}
參數：
  • tokenId: string – 要提示的記號 ID。
  • operationId: string – 代表提示要求的唯一作業 ID。
  • notaryOrgId: string – 將處理要求之礦產公證人的會員服務提供者 (MSP) ID。
  • notaryUserId: string – 將處理要求之礦產公證人的使用者名稱或電子郵件 ID。
  • quantity: number – 要提示的記號數量。
  • timeToExpiration – 採礦要求到期且不再有效的時間。
  • infoDetails: JSON – 指定要求之類別 (category) 和描述 (description) 的物件，如下列範例所示。
    {
     "category" : "category input",
     "description" : "description input"
}
  • sameOrgEndorser: boolean - 表示交易背書是否必須來自與要求者相同的組織布林值。
傳回值範例：
{
    "returnCode": "Success",
    "error": "",
    "result": {
        "txid": "06b35071415d74aa1a7c18449149c937d886cae76a832c44cf8d98e84586e76e",
        "payload": {
            "msg": "AccountId oaccount~9d9806fa92aa0c4fdb34eaffac6e830181b5d47e64fbce752195e83024125ca0 (Org-Id: CB , User-Id: creator_user_cb) has successfully submitted request to mint 10 tokens"
        },
        "encode": "JSON",
        "sourceURL": "cb-oabcs1-bom.blockchain.ocp.example.com:20010",
        "blockNumber": 202
    }
}
setMaxDailyAmount
原始方法名稱：setMaxDailyAmount
此 POST 方法是用來在帳戶詳細資訊中設定指定金額的 maxDailyAmount 參數。只有鏈碼的 Token Admin 或指定的組織 Org Admin 才能呼叫此方法。
有效負載：
{
    "orgId": "{{bc-org-id}}",
    "userId": "{{bc-user-id}}",
    "tokenId": "{{bc-token-id}}",
    "maxDailyAmount": 1,
    "endorsers": {{endorsers}}
}
參數：
  • orgId: string – 目前組織中使用者的會員服務提供者 (MSP) ID。
  • userId: string – 使用者的使用者名稱或電子郵件 ID。
  • tokenId: string – 記號的 ID。
  • maxDailyAmount: number – 指定帳戶的每日金額上限值，定義每日可交易的金額上限。
  • endorsers: string[] – 必須為交易背書的對等體陣列 (例如 peer1、peer2)。
傳回值範例：
{
    "returnCode": "Success",
    "error": "",
    "result": {
        "txid": "28682e0564e4721b6c1a8ec106f8c5c98319e9439959dbb9f83d8e6f111d9975",
        "payload": {
            "bapAccountVersion": 0,
            "assetType": "oaccount",
            "account_id": "oaccount~cdc6fa5e64bc29f700f99da69f980d8cbb768c7e1a11dd17274e75651f6afafe",
            "user_id": "admin_user_cb",
            "org_id": "CB",
            "token_type": "fungible",
            "token_id": "USD",
            "token_name": "Stablecoin",
            "balance": 0,
            "onhold_balance": 0,
            "max_daily_amount": 10000,
            "daily_amount": 0,
            "max_daily_transactions": 1000,
            "daily_transactions": 0,
            "current_date": "2024-11-20T00:00:00.000Z"
        },
        "encode": "JSON",
        "sourceURL": "cb-oabcs1-bom.blockchain.ocp.example.com:20010",
        "blockNumber": 222
    }
}
setMaxDailyTransactionCount
原始方法名稱：setMaxDailyTransactionCount
此 POST 方法是用來在帳戶詳細資訊中設定指定金額的 maxDailyTransactions 參數。只有鏈碼的 Token Admin 或指定的組織 Org Admin 才能呼叫此方法。
有效負載：
{
    "orgId": "{{bc-org-id}}",
    "userId": "{{bc-user-id}}",
    "tokenId": "{{bc-token-id}}",
    "maxDailyTransactions": 1,
    "endorsers": {{endorsers}}
}
參數：
  • orgId: string – 目前組織中使用者的會員服務提供者 (MSP) ID。
  • userId: string – 使用者的使用者名稱或電子郵件 ID。
  • tokenId: string – 記號的 ID。
  • maxDailyTransactions: number – 指定科目的每日金額上限值，定義每日允許的交易數上限。
  • endorsers: string[] – 必須為交易背書的對等體陣列 (例如 peer1、peer2)。
傳回值範例：
{
    "returnCode": "Success",
    "error": "",
    "result": {
        "txid": "8b6fb01de697562ee098110054f05d4a314933bd11ef471991cb43e25b68bad9",
        "payload": {
            "bapAccountVersion": 0,
            "assetType": "oaccount",
            "account_id": "oaccount~cdc6fa5e64bc29f700f99da69f980d8cbb768c7e1a11dd17274e75651f6afafe",
            "user_id": "admin_user_cb",
            "org_id": "CB",
            "token_type": "fungible",
            "token_id": "USD",
            "token_name": "Stablecoin",
            "balance": 0,
            "onhold_balance": 0,
            "max_daily_amount": 10000,
            "daily_amount": 0,
            "max_daily_transactions": 1000,
            "daily_transactions": 0,
            "current_date": "2024-11-20T00:00:00.000Z"
        },
        "encode": "JSON",
        "sourceURL": "cb-oabcs1-bom.blockchain.ocp.example.com:20010",
        "blockNumber": 223
    }
}
suspendStablecoinAccount
原始方法名稱：suspendAccount
這個方法會暫停一個有趣的記號帳號。如果在分類帳中找不到 accountStatus 值，就會發出錯誤。只有鏈碼的 Token Admin 或指定的組織 Org Admin 才能呼叫此方法。
有效負載：
{
    "tokenId": "{{bc-token-id}}",
    "orgId": "{{bc-org-id}}",
    "userId": "{{bc-user-id}}",
    "endorsers": {{endorsers}}
}
參數：
  • tokenId: string – 記號的 ID。
  • orgId: string – 目前組織中使用者的會員服務提供者 (MSP) ID。
  • userId: string – 使用者的使用者名稱或電子郵件 ID。
  • endorsers: string[] – 必須為交易背書的對等體陣列 (例如 peer1、peer2)。
傳回值範例：
{
    "returnCode": "Success",
    "error": "",
    "result": {
        "txid": "e21d91d98091df77f90105d84074c0b802b01fc97a6b1304247774397fed1294",
        "payload": {
            "assetType": "oaccountStatus",
            "status_id": "oaccountStatus~d5814d96d8517ac31727d60aace0519c58a425892ab0d378fcfb0a35771f65ae",
            "account_id": "oaccount~802bf8da5579c6103b2dddaa6c4385df8e722d639a18029e0e93d7a5d6f826d6",
            "status": "suspended"
        },
        "encode": "JSON",
        "sourceURL": "cb-oabcs1-bom.blockchain.ocp.example.com:20009",
        "blockNumber": 195
    }
}
transferStablecoinTokens
原始方法名稱：transferTokens
此方法會將記號從呼叫程式轉移至指定的帳戶。方法的呼叫程式必須要有帳戶。數量必須在規格檔案中 divisible 行為的 decimal 參數所指定的小數值內。
有效負載：
{
    "tokenId": "{{bc-token-id}}",
    "toOrgId": "to_org_id value",
    "toUserId": "to_user_id value",
    "quantity": 1,
    "infoDetails": "{\"category\":\"category value\",\"description\":\"description value\"}",
    "endorsers": {{endorsers}}
}
參數：
  • tokenId: string – 記號的 ID。
  • toOrgId: string – 目前組織中接收者 (受款人) 的成員服務提供者 (MSP) ID。
  • toUserId: string – 接收者的使用者名稱或電子郵件 ID。
  • quantity: number – 要傳輸的記號數目。
  • infoDetails: JSON – 指定要求之類別 (category) 和描述 (description) 的物件，如下列範例所示。
    {
     "category" : "category input",
     "description" : "description input"
}
  • endorsers: string[] – 必須為交易背書的對等體陣列 (例如 peer1、peer2)。
傳回值範例：
{
    "returnCode": "Success",
    "error": "",
    "result": {
        "txid": "d613b2494b965811b2fa2106152b7085f2d6d7d43e949b10b8668722d3636fe7",
        "payload": {
            "msg": "Successfully transferred 10 tokens from account id: oaccount~9d9806fa92aa0c4fdb34eaffac6e830181b5d47e64fbce752195e83024125ca0 (Org-Id: CB, User-Id: creator_user_cb) to account id: oaccount~51e676d7182a02ea7418ef58a6d54ecfe3858ef40b4ffb3d859b320da3921594 (Org-Id: CB, User-Id: issuer_user_cb). Only 999 number of transactions and 1990 amount transfer left for today: 12/11/2024"
        },
        "encode": "JSON",
        "sourceURL": "cb-oabcs1-bom.blockchain.ocp.example.com:20009",
        "blockNumber": 224
    }
    }
updateAccountPolicyCheck
原始方法名稱：updateAccountPolicyCheck
此方法會更新指定帳戶的原則。只有指定的組織之 Token Admin 或 Org Admin 才能呼叫此方法。
有效負載：
{
    "asset": "{\"accountPolicyId\":\"accountPolicyId value\",\"orgId\":\"{{bc-org-id}}\",\"userId\":\"{{bc-user-id}}\",\"kycCompliance\":\"kycCompliance value\",\"amlCompliance\":\"amlCompliance value\",\"riskScore\":999,\"restrictionFlag\":\"restrictionFlag value\"}",
    "endorsers": {{endorsers}}
}
參數：
  • asset: AccountPolicyCheck object – 定義帳號策略參數的物件，包含下列欄位：
    • accountPolicyId – 唯一的帳戶原則 ID。
    • orgId – 要為其建立原則之使用者的成員服務提供者 (MSP) ID。
    • userId – 要為其建立策略的使用者名稱或電子郵件 ID。
    • kycCompliance - 表示帳戶是否滿足 KYC (瞭解您的客戶) 需求的布林值。
    • amlCompliance – 表示帳戶是否滿足 AML (反洗錢) 需求的布林值。
    • riskScore – 與帳戶相關聯的風險分數，用於規範評估。
    • restrictionFlag – 表示帳戶是否受限制轉帳的布林值。如果設為 true，則只允許在最低核准原則臨界值內的傳輸。
  • endorsers: string[] – 必須為交易背書的對等體陣列 (例如 peer1、peer2)。
傳回值範例：
{
    "returnCode": "Success",
    "error": "",
    "result": {
        "txid": "02875ca9c6a7408da3f81156214228b91b09c4bb2b8026d7a5733b53598c6635",
        "payload": {
            "assetType": "AccountPolicyCheck",
            "accountPolicyId": "APID~CentralBank~cb__creator_demo",
            "orgId": "CentralBank",
            "userId": "cb__creator_demo",
            "kycCompliance": "true",
            "amlCompliance": "true",
            "riskScore": 1000,
            "restrictionFlag": "true"
        },
        "encode": "JSON",
        "sourceURL": "cb-oabcs1-bom.blockchain.ocp.example.com:20010",
        "blockNumber": 272
    }
}
updateApprovalPolicyCheck
原始方法名稱：updateApprovalPolicyCheck
此方法會更新核准原則。只有 Token Admin 才能呼叫此方法。
有效負載：
{
    "asset": "{\"approvalPolicyId\":\"approvalPolicyId value\",\"transactionLowerLimit\":\"transactionLowerLimit value\",\"transactionUpperLimit\":\"transactionUpperLimit value\",\"numberOfApprovalsRequired\":999,\"approverDetails\":[{\"approverOrgId\":\"approverOrgId value\",\"approverUserId\":\"approverUserId value\",\"approvalSequence\":999}]}",
    "endorsers": {{endorsers}}
}
參數：
  • asset: ApprovalPolicyCheck class – 定義交易核准規則的類別，包含下列欄位：
    • approvalPolicyId – 唯一核准原則 ID。
    • transactionLowerLimit – 適用核准策略的最低交易金額。
    • transactionUpperLimit – 套用核准原則的交易金額上限。
    • numberOfApprovalsRequired – 完成交易前所需的核准總數。
    • approverDetails – 核准者清單及其指派的核准順序，定義核准的必要順序。
  • endorsers: string[] – 必須為交易背書的對等體陣列 (例如 peer1、peer2)。
傳回值範例：
{
    "returnCode": "Success",
    "error": "",
    "result": {
        "txid": "ed1e1950fe02dbab74fa3aa7630b8dc6096e30aae5c81bab0dd22d5232c44fc9",
        "payload": {
            "status": "active",
            "assetType": "ApprovalPolicyCheck",
            "approvalPolicyId": "GPID~500~1000",
            "transactionLowerLimit": "500",
            "transactionUpperLimit": "1000",
            "numberOfApprovalsRequired": 1,
            "approverDetails": [
                {
                    "approverOrgId": "CentralBank",
                    "approverUserId": "manager",
                    "approvalSequence": 1
                }
            ]
        },
        "encode": "JSON",
        "sourceURL": "cb-oabcs1-bom.blockchain.ocp.example.com:20009",
        "blockNumber": 285
    }
}
updateStablecoinToken
原始方法名稱：updateStablecoinToken
此方法會更新穩定的記號。只有 Token Admin 才能呼叫此方法。
有效負載：
{
    "tokenAsset": "{\"token_id\":\"{{bc-token-id}}\",\"token_desc\":\"token_desc value\",\"currencyName\":\"currencyName value\",\"conversionRate\":999}",
    "endorsers": {{endorsers}}
}
參數：
  • asset <Token Class> – 將記號資產當作參數傳遞給此方法。記號資產的特性會有所不同，並在記號規格檔案中說明。請勿在規格檔案中包含標示為唯讀的參數。

    如果您使用 Visual Studio Code 與 CLI 或 Postman 集合，請以不同的格式指定 asset 參數。

    Visual Studio 程式碼：使用 GUI 傳送對應至權杖類別欄位的個別參數。

    CLI / Postman：傳送包含記號規格欄位的序列化 JSON 字串，如下列範例所示。

    "{\"token_id\":\"USD\",\"token_desc\":\"token_desc value\",\"Currency_Name\":\"Currency_Name value\"}"

  • endorsers: string[] – 必須為交易背書的對等體陣列 (例如 peer1、peer2)。
傳回值範例：
{
    "returnCode": "Success",
    "error": "",
    "result": {
        "txid": "aa7a4f4cc214e1a041a5a6fb7ca7530f08256559e538c9f9582e6fd12c9e65c8",
        "payload": {
            "assetType": "otoken",
            "events": false,
            "token_id": "t1",
            "token_name": "Stablecoin",
            "token_desc": "token_desc value",
            "token_standard": "ttf+",
            "token_type": "fungible",
            "token_unit": "fractional",
            "behaviors": [
                "divisible",
                "mintable",
                "transferable",
                "burnable",
                "holdable",
                "roles"
            ],
            "roles": {
                "minter_role_name": "minter",
                "burner_role_name": "burner",
                "notary_role_name": "notary",
                "mint_approver_role_name": "notary",
                "burn_approver_role_name": "notary"
            },
            "mintable": {
                "max_mint_quantity": 1000,
                "mint_approval_required": true
            },
            "burnable": {
                "burn_approval_required": true
            },
            "divisible": {
                "decimal": 2
            },
            "currency_name": "currency_name value",
            "token_to_currency_ratio": 999
        },
        "encode": "JSON",
        "sourceURL": "cb-oabcs1-bom.blockchain.ocp.example.com:20009",
        "blockNumber": 267
    }
}
createStablecoinAccount
原始方法名稱：createStablecoinAccount
此自訂包裝程式 API 將鏈碼 API 和 Oracle Blockchain Platform 主控台 API 結合成一個端點。此方法會依序完成下列步驟。
  1. 在執行處理的 REST 代理主機中建立使用者的註冊 ID。若該使用者 ID 已有註冊存在，則不會再次建立註冊。註冊 ID 與使用者 ID 相同。註冊 ID 只能包含文數字字元、連字號 (-) 和底線 (_)。若使用者 ID 包含任何其他特殊字元，則會以底線 (_) 取代這些字元。
  2. 在分類帳中建立科目。
  3. 將新帳戶與指定的權杖建立關聯。
  4. 指定指定的角色給使用者。
如果任一步驟失敗，則會自動刪除登記。
有效負載：
{
    "orgId": "{{bc-org-id}}",
    "userId": "{{bc-user-id}}",
    "tokenId": "{{bc-token-id}}",
    "role": "role value (for example minter / burner / notary / tokenAdmin / tokenAuditor / orgAdmin / orgAuditor)",
    "dailyLimits": "{\"max_daily_amount\":1000, \"max_daily_transactions\":100}"
}
參數：
  • orgId – 要為其建立帳戶之使用者的會員服務提供者 (MSP) ID。ID 必須以數字或英文字母字元為開頭，而且可以包含英文字母、數字以及特殊字元，例如底線 (_)、句號 (.)、@ 符號以及連字號 (-)。
  • userId – 使用者的使用者名稱或電子郵件 ID。ID 必須以數字或英文字母字元為開頭，而且可以包含英文字母、數字以及特殊字元，例如底線 (_)、句號 (.)、@ 符號以及連字號 (-)。
  • tokenId: string – 記號 ID，必須以數字或英文字母字元為開頭，且可包含字母、數字和底線 (_) 和連字號 (-) 等特殊字元。不得超過 16 個字元的長度。
  • role: string – 要新增至指定使用者的角色名稱，必須為下列其中一個值：minter、burner、notary、tokenAdmin、tokenAuditor、orgAdmin 或 orgAuditor。
  • dailyLimits: JSON object – 下列類型的 JSON 物件。
    {
     "max_daily_amount": 100000
     "max_daily_transactions": 10000
 }
    在範例中，max_daily_amount 值是每日可交易的記號數量上限，而 max_daily_transactions 值是每日可完成的交易數上限。
傳回值：
  • 成功時，所建立帳戶的 JSON 物件。
傳回值範例：
"payload": {
 "msg": "Account created successfully and 'minter' role added to Account Id: oaccount~4a86f2843c2b0105c97a77202bd9aba519c81dcef27eccc1d89125ae32770700 (Org-Id: CB, User-Id: creator_user_cb)"
 "accountDetails": 
      {            
            "bapAccountVersion": 0,
            "assetType": "oaccount",
            "account_id": "oaccount~ce5c56d2068ce31b82136c8eea110a80b9251595d361db70924c4e989032a1be",
            "user_id": "creator_user_cb",
            "org_id": "CB",
            "token_type": "fungible",
            "token_id": "USD",
            "token_name": "",
            "balance": 0,
            "onhold_balance": 0,
            "max_daily_amount": 1000,
            "daily_amount": 0,
            "max_daily_transactions": 100,
            "daily_transactions": 0,
            "current_date": "2024-10-06T00:00:00.000Z"
     }
 }
createIDCSUser
原始方法名稱：createIDCSUser
此 POST 方法會在 terraform.tfvars 檔案中由 URL 指定的租用戶中建立 Identity Cloud Service 使用者，並將該使用者指派給指定的使用者群組。
有效負載：
{
 "userName": "userName value",
 "firstName": "firstName value",
 "lastName": "lastName value",
 "email": "email value",
 "groupName": "groupName value"
}
參數：
  • userName: string – 使用者的 ID。
  • firstName: string - 使用者的名字。
  • lastName: string – 使用者的姓。
  • email: string – 使用者的電子郵件地址。
  • groupName: string – 要指派給使用者的 Identity Cloud Service 群組名稱。
傳回值範例：
{
 "status": "Success",
 "msg": "User user1 is created and assigned to the group BOND_ADMIN"
}