機密卸売CBDCラッパーAPIパッケージ
Oracle Blockchain Platform Digital Assets Editionには、卸売CBDCシナリオの機密モード・バージョンに固有の操作をサポートするようにREST APIを拡張するラッパーAPIパッケージが含まれています。
ラッパーAPIパッケージでは、Oracle Cloud Infrastructure (OCI)上のリソース・マネージャ・スタックを使用して作成されたAPIゲートウェイ・サービスとOCI Functionsを使用して、卸売CBDCアプリケーション用に特別に設計されたAPIルートをデプロイします。卸売CBDCラッパーAPIパッケージは、Oracle Blockchain Platformコンソールからダウンロード可能で、次のコンポーネントが含まれています。
WholesaleCBDCWithConfidentialPaymentWrapperAPI.zip
。デプロイメントに必要なTerraformスクリプトを含むラッパーAPIパッケージを含むアーカイブ・ファイル。このファイルをOCI上のリソース・マネージャ・スタックにデプロイして、ラッパーAPIに必要なOracleリソースを作成します。WholesaleCBDCWithConfidentialPayment_WrapperAPI.postman_collection
は、デプロイされたラッパーAPIをテストできるPostmanコレクションです。コレクションには、ラッパーAPIパッケージで定義されたAPIに対応するエンドポイントおよびペイロードを含む事前構成済リクエストが含まれます。
ラッパーAPI
-
activateCBDCAccount
- 元のメソッド名:
activateAccount
- このPOSTメソッドは、トークン・アカウントをアクティブ化します。このメソッドは、指定した組織の
Token Admin
またはOrg Admin
のみがコールできます。削除したアカウントはアクティブ化できません。 - ペイロード:
{ "accountId": "account_id value", "endorsers": {{endorsers}}, "transientMapArgsFlag": true }
- パラメータ:
accountId: string
– アカウントのID。endorsers: string[]
– トランザクションを承認する必要があるピアの配列(peer1
、peer2
など)。transientMapArgsFlag
– ブール値です。trueの場合、引数は機密性のために一時マップを介して送信されます。falseの場合、引数は標準ペイロードを介して送信されます。
- 戻り値:
- 成功の場合、指定されたトークン・アカウントのアカウント・ステータス・オブジェクトのJSON表現。
- 戻り値の例:
{ "returnCode": "Success", "error": "", "result": { "txid": "864cdbc5b4ee1a6f2238301e75ee2ddff0ecfa490ddf490da33365cae92cb4ad", "payload": { "assetType": "oaccountStatus", "status_id": "oaccountStatus~4c900b07f6136f36854064c0c0ba97aa09c9734cbe11966cc83865f156ced2c6", "account_id": "oaccount~214ad54a30703412b195f36429607b08627dea893303870bf3372f944fe0c088", "status": "active" }, "encode": "JSON", "sourceURL": "centralbank-oabcs1-nrt.blockchain.ocp.example.com:20010", "blockNumber": 58 } }
-
addCBAdmin
- 元のメソッド名:
addTokenAdmin
- このPOSTメソッドは、トークン・チェーンコードの
Token Admin
としてユーザーを追加します。このメソッドは、トークン・チェーンコードのToken Admin
のみがコールできます。最初の起動は、チェーンコードをインスタンス化する管理者からのものです。 - ペイロード:
{ "orgId": "{{bc-org-id}}", "userId": "{{bc-user-id}}", "endorsers": {{endorsers}}, "transientMapArgsFlag": true }
- パラメータ:
orgId: string
– 現在の組織内のユーザーのメンバーシップ・サービス・プロバイダ(MSP) ID。userId: string
– ユーザーのユーザー名または電子メールID。endorsers: string[]
– トランザクションを承認する必要があるピアの配列(peer1
、peer2
など)。transientMapArgsFlag
– ブール値です。trueの場合、引数は機密性のために一時マップを介して送信されます。falseの場合、引数は標準ペイロードを介して送信されます。
- 戻り値の例:
{ "returnCode": "Success", "error": "", "result": { "txid": "a988dc3e9aab162508fd0555fec254f248e27fd0c5440d94e1f49fc65643cafa", "payload": { "msg": "Successfully added Token Admin (Org_Id: CentralBank, User_Id: user1)" }, "encode": "JSON", "sourceURL": "centralbank-oabcs1-nrt.blockchain.ocp.example.com:20010", "blockNumber": 69 } }
-
addCBAuditor
- 元のメソッド名:
addTokenAuditor
- このPOSTメソッドは、トークン・チェーンコードにトークン監査者を追加します。このメソッドは、チェーンコードの
Token Admin
のみがコールできます。 - ペイロード:
{ "orgId": "{{bc-org-id}}", "userId": "{{bc-user-id}}", "endorsers": {{endorsers}}, "transientMapArgsFlag": true }
- パラメータ:
orgId: string
– 現在の組織内のユーザーのメンバーシップ・サービス・プロバイダ(MSP) ID。userId: string
– ユーザーのユーザー名または電子メールID。endorsers: string[]
– トランザクションを承認する必要があるピアの配列(peer1
、peer2
など)。transientMapArgsFlag
– ブール値です。trueの場合、引数は機密性のために一時マップを介して送信されます。falseの場合、引数は標準ペイロードを介して送信されます。
- 戻り値の例:
{ "returnCode": "Success", "error": "", "result": { "txid": "864cdbc5b4ee1a6f2238301e75ee2ddff0ecfa490ddf490da33365cae92cb4ad", "payload": { "assetType": "oaccountStatus", "status_id": "oaccountStatus~4c900b07f6136f36854064c0c0ba97aa09c9734cbe11966cc83865f156ced2c6", "account_id": "oaccount~214ad54a30703412b195f36429607b08627dea893303870bf3372f944fe0c088", "status": "active" }, "encode": "JSON", "sourceURL": "centralbank-oabcs1-nrt.blockchain.ocp.example.com:20010", "blockNumber": 58 } }
-
addFIAdmin
- 元のメソッド名:
addOrgAdmin
- このメソッドは、トークン・チェーンコードに組織管理者を追加します。このメソッドは、指定した組織の
Token Admin
またはOrg Admin
のみがコールできます。 - ペイロード:
{ "orgId": "{{bc-org-id}}", "userId": "{{bc-user-id}}", "endorsers": {{endorsers}}, "transientMapArgsFlag": true }
- パラメータ:
orgId: string
– 現在の組織内のユーザーのメンバーシップ・サービス・プロバイダ(MSP) ID。userId: string
– ユーザーのユーザー名または電子メールID。endorsers: string[]
– トランザクションを承認する必要があるピアの配列(peer1
、peer2
など)。transientMapArgsFlag
– ブール値です。trueの場合、引数は機密性のために一時マップを介して送信されます。falseの場合、引数は標準ペイロードを介して送信されます。
- 戻り値の例:
{ "returnCode": "Success", "error": "", "result": { "txid": "ab1544c0d23d930253e6e6020c7c9584f03d324fb1123cc96fe7e0573b232792", "payload": { "msg": "Successfully added Org Admin (Org_Id: CentralBank, User_Id: cb_admin_demo)" }, "encode": "JSON", "sourceURL": "centralbank-oabcs1-nrt.blockchain.ocp.example.com:20010", "blockNumber": 61 } }
-
addFIAuditor
- 元のメソッド名:
addOrgAuditor
- このメソッドは、組織監査者をトークン・チェーンコードに追加します。このメソッドは、指定した組織の
Token Admin
またはOrg Admin
のみがコールできます。 - ペイロード:
{ "orgId": "{{bc-org-id}}", "userId": "{{bc-user-id}}", "endorsers": {{endorsers}}, "transientMapArgsFlag": true }
- パラメータ:
orgId: string
– 現在の組織内のユーザーのメンバーシップ・サービス・プロバイダ(MSP) ID。userId: string
– ユーザーのユーザー名または電子メールID。endorsers: string[]
– トランザクションを承認する必要があるピアの配列(peer1
、peer2
など)。transientMapArgsFlag
– ブール値です。trueの場合、引数は機密性のために一時マップを介して送信されます。falseの場合、引数は標準ペイロードを介して送信されます。
- 戻り値の例:
{ "returnCode": "Success", "error": "", "result": { "txid": "c0acbadfa461963a5d085bb12335dcf6d8ec566acf72a88a1f168b3a0435db89", "payload": { "msg": "Successfully added Org Auditor (Org_Id: CentralBank, User_Id: cb_admin_demo)" }, "encode": "JSON", "sourceURL": "centralbank-oabcs1-nrt.blockchain.ocp.example.com:20010", "blockNumber": 62 } }
-
addRole
- 元のメソッド名:
addRole
- このメソッドは、指定されたユーザーおよびトークンにロールを追加します。アカウントIDは、連結トークンID、組織IDおよびユーザーIDのSHA-256ハッシュを作成することで形成されます。このメソッドは、指定した組織の
Token Admin
またはOrg Admin
のみがコールできます。 - ペイロード:
{ "accountId": "account_id value", "role": "role value (for example minter / burner / notary)", "endorsers": {{endorsers}}, "transientMapArgsFlag": true }
- パラメータ:
accountId: string
– アカウントのID。role: string
– 指定したユーザーに追加するロールの名前。endorsers: string[]
– トランザクションを承認する必要があるピアの配列(peer1
、peer2
など)。transientMapArgsFlag
– ブール値です。trueの場合、引数は機密性のために一時マップを介して送信されます。falseの場合、引数は標準ペイロードを介して送信されます。
- 戻り値の例:
{ "returnCode": "Success", "error": "", "result": { "txid": "c44931d2227305914db21564301775f8a4edc2aa7fef434d063be7e207b4fd20", "payload": { "msg": "Successfully added role 'minter' to Account Id: oaccount~214ad54a30703412b195f36429607b08627dea893303870bf3372f944fe0c088" }, "encode": "JSON", "sourceURL": "centralbank-oabcs1-nrt.blockchain.ocp.example.com:20009", "blockNumber": 63 } }
-
approveCBDCCreation
- 元のメソッド名:
approveMint
- Notariesは、このPOSTメソッドをコールしてmintリクエストを承認できます。
- ペイロード:
{ "tokenId": "{{bc-token-id}}", "operationId": "operation_id value", "endorsers": {{endorsers}}, "transientMapArgsFlag": true }
- パラメータ:
tokenId: string
– トークンのID。operationId: string
– 承認するミント・リクエストの一意の操作ID。endorsers: string[]
– トランザクションを承認する必要があるピアの配列(peer1
、peer2
など)。transientMapArgsFlag
– ブール値です。trueの場合、引数は機密性のために一時マップを介して送信されます。falseの場合、引数は標準ペイロードを介して送信されます。
- 戻り値の例:
{ "returnCode": "Success", "error": "", "result": { "txid": "4514aa229ebcc4d2fedcaa47c4301615e30c4a9bae45cf0256a5b80d75b3697a", "payload": { "msg": "Successfully minted 1000 tokens to Account Id: oaccount~da6e14466a0ba9b48ebc18fa672addb92dffc371bf953c3229a95b2ff2d9cd41" }, "encode": "JSON", "sourceURL": "centralbank-oabcs1-nrt.blockchain.ocp.example.com:20011", "blockNumber": 337 } }
-
approveCBDCRetirement
- 元のメソッド名:
approveBurn
- Notariesは、このPOSTメソッドを呼び出して書き込みリクエストを承認できます。
- ペイロード:
{ "tokenId": "{{bc-token-id}}", "operationId": "operation_id value", "endorsers": {{endorsers}}, "transientMapArgsFlag": true }
- パラメータ:
tokenId: string
– トークンのID。operationId: string
– 承認するミント・リクエストの一意の操作ID。endorsers: string[]
– トランザクションを承認する必要があるピアの配列(peer1
、peer2
など)。transientMapArgsFlag
– ブール値です。trueの場合、引数は機密性のために一時マップを介して送信されます。falseの場合、引数は標準ペイロードを介して送信されます。
- 戻り値の例:
{ "returnCode": "Success", "error": "", "result": { "txid": "8c7b013765917ebade60c6e6e122ec9b94282349e630fa1f2a446c79cb9ef29c", "payload": { "msg": "Successfully burned 200 tokens from account id: oaccount~cea6080858337b1575d6a76ed0bd07a0eacd8871e3f2f7f793729a0e4b0e8e98 (Org-Id: CentralBank, User-Id: cb_retirer_demo)" }, "encode": "JSON", "sourceURL": "centralbank-oabcs1-nrt.blockchain.ocp.example.com:20011", "blockNumber": 338 } }
-
approveHoldCBDCTokens
- 元のメソッド名:
executeHoldTokens
- Notariesはこのメソッドを呼び出してトークンの保留を承認します。これにより、このビジネス・シナリオで支払者から受取人へのトークンの転送がトリガーされます。トークン所有者が以前に保留したトークンの数量が受信者に転送されるようになりました。
quantity
値が実際の保留値より小さい場合、残りはトークンの所有者が再度使用できます。roles
動作がトークン・モデルのbehaviors
セクションで指定され、notary_role_name
値が設定されている場合、呼出し側アカウントには公証人ロールが必要です。そうしないと、アカウントを持つすべての発信者が公証人として機能します。 - ペイロード:
{ "tokenId": "{{bc-token-id}}", "operationId": "operation_id value", "quantity": 1, "endorsers": {{endorsers}}, "transientMapArgsFlag": true }
- パラメータ:
tokenId: string
– トークンのID。operationId: string
– 承認するミント・リクエストの一意の操作ID。quantity: number
– 転送する保留中のトークンの数。endorsers: string[]
– トランザクションを承認する必要があるピアの配列(peer1
、peer2
など)。transientMapArgsFlag
– ブール値です。trueの場合、引数は機密性のために一時マップを介して送信されます。falseの場合、引数は標準ペイロードを介して送信されます。
- 戻り値の例:
{ "returnCode": "Success", "error": "", "result": { "txid": "5177f7560d32838242a26ac74f2a90c6ff9b47aae0d0988f28d9b4cf7e27c097", "payload": { "msg": "Account Id: oaccount~1e31495a0c149b08cb9d02bdcac5e83d88c0f1557d954dda12bb807d7f6fc111 (Org-Id: Org1, User-Id: fi1_org_user1_demo) is successfully executed '10' tokens from Operation Id '454f4bf6'." }, "encode": "JSON", "sourceURL": "org1-oabcs1-nrt.blockchain.ocp.example.com:20009", "blockNumber": 339 } }
-
consolidateRunningBalanceInTransactions
- 元のメソッド名:
consolidateRunningBalanceInTransactions
- この方法では、コール元の組織内の勘定科目の残高が連結されます。このメソッドは、
Token Admin
またはOrg Admin
のみがコールできます。 - ペイロード:
{ "endorsers": {{endorsers}} }
- パラメータ:
endorsers: string[]
– トランザクションを承認する必要があるピアの配列(peer1
、peer2
など)。
- 戻り値の例:
{ "returnCode": "Success", "error": "", "result": { "txid": "f3c019974cd93eaa8f3171a36ec25009fa6925b5880cae8c9a49a141944039c0", "payload": { "msg": "Successfully updated account running balance for pending transactions." }, "encode": "JSON", "sourceURL": "centralbank-oabcs1-nrt.blockchain.ocp.example.com:20009", "blockNumber": 340 } }
-
associateTokenToAccount
- 元のメソッド名:
associateTokenToAccount
- このPOSTメソッドは、指定されたアカウントIDを指定されたトークンに関連付けます。このメソッドは、指定した組織の
Token Admin
またはOrg Admin
のみがコールできます。 - ペイロード:
{ "accountId": "account_id value", "tokenId": "{{bc-token-id}}", "customAccountId": "custom_account_id value", "endorsers": {{endorsers}}, "transientMapArgsFlag": true }
- パラメータ:
accountId: string
– アカウントのID。tokenId: string
– トークンのID。customAccountId: string
– 機密モードのアカウントの一意のランダムID。endorsers: string[]
– トランザクションを承認する必要があるピアの配列(peer1
、peer2
など)。transientMapArgsFlag
– ブール値です。trueの場合、引数は機密性のために一時マップを介して送信されます。falseの場合、引数は標準ペイロードを介して送信されます。
- 戻り値の例:
{ "returnCode": "Success", "error": "", "result": { "txid": "fc7e9297d1d7beef5567fbef873955f5a9759d031811198e24f67f064e0e80b0", "payload": { "bapAccountVersion": 0, "assetType": "oaccount", "account_id": "oaccount~b53cb2c19c92d1d5c8cb9f6e988e7761c34e03e014e6c4b889565fc0abf46c8a", "org_id": "CentralBank", "token_type": "fungible", "token_id": "USD", "token_name": "cbdc", "balance": "028b72742c8aa9a0395c828fe4f0e46226a3e40d4e731d0b994c8028c8b7bd4df6", "onhold_balance": "028b72742c8aa9a0395c828fe4f0e46226a3e40d4e731d0b994c8028c8b7bd4df6", "onhold_burn_balance": "028b72742c8aa9a0395c828fe4f0e46226a3e40d4e731d0b994c8028c8b7bd4df6", "application_groups": [ "CENTRAL_BANK_USERS" ] }, "encode": "JSON", "sourceURL": "centralbank-oabcs1-nrt.blockchain.ocp.example.com:20009", "blockNumber": 71 } }
-
createAccount
- 元のメソッド名:
createAccount
- このメソッドは、指定されたユーザーおよびトークンのアカウントを作成します。任意の時点でトークンを持つすべてのユーザーに対してアカウントを作成する必要があります。アカウントは、残高、保留残高およびトランザクション履歴を追跡します。アカウントIDは英数字のセットであり、
oaccount~<token asset name>~
が先頭に付き、インスタンス所有者およびインスタンスにログインしているユーザーのユーザー名または電子メールID (userId
)と現在のネットワーク組織内のユーザーの会員サービス・プロバイダID (orgId
)のハッシュが続きます。このメソッドは、チェーンコードのToken Admin
または指定された組織のOrg Admin
のみがコールできます。 - ペイロード:
{ "orgId": "{{bc-org-id}}", "userId": "{{bc-user-id}}", "tokenType": "fungible", "applicationGroups": "[\"application_groups value\"]", "dailyLimits": "{\"max_daily_amount\":10000,\"max_daily_transactions\":100}", "endorsers": {{endorsers}}, "transientMapArgsFlag": true }
- パラメータ:
orgId
– アカウントを作成するユーザーのメンバーシップ・サービス・プロバイダ(MSP) ID。IDは英数字で始める必要があり、アンダースコア(_)、ピリオド(.)、アットマーク(@)、ハイフン(-)などの文字、数字および特殊文字を含めることができます。userId
– ユーザーのユーザー名または電子メールID。IDは英数字で始める必要があり、アンダースコア(_)、ピリオド(.)、アットマーク(@)、ハイフン(-)などの文字、数字および特殊文字を含めることができます。tokenType: TokenType
– トークンのタイプ。fungible
である必要があります。applicationGroups: string[]
– ユーザーIDが属するアプリケーション・グループのリストで、CBDCアプリケーションでのユーザーのアソシエーションを定義します。dailyLimits: JSON object
– 次の型のJSONオブジェクト。
この例では、{ "max_daily_amount": 100000 "max_daily_transactions": 10000 }
max_daily_amount
値は毎日取引できるトークンの最大量であり、max_daily_transactions
値は毎日完了できるトランザクションの最大数です。endorsers: string[]
– トランザクションを承認する必要があるピアの配列(peer1
、peer2
など)。transientMapArgsFlag
– ブール値です。trueの場合、引数は機密性のために一時マップを介して送信されます。falseの場合、引数は標準ペイロードを介して送信されます。
- 戻り値の例:
{ "returnCode": "Success", "error": "", "result": { "txid": "dc167f95bdcc246c9ecb20e56126c705f522cff30c94798f21a82de111367ab8", "payload": { "bapAccountVersion": 0, "assetType": "oaccount", "account_id": "oaccount~b53cb2c19c92d1d5c8cb9f6e988e7761c34e03e014e6c4b889565fc0abf46c8a", "org_id": "CentralBank", "token_type": "fungible", "token_id": "", "token_name": "", "balance": "028b72742c8aa9a0395c828fe4f0e46226a3e40d4e731d0b994c8028c8b7bd4df6", "onhold_balance": "028b72742c8aa9a0395c828fe4f0e46226a3e40d4e731d0b994c8028c8b7bd4df6", "onhold_burn_balance": "028b72742c8aa9a0395c828fe4f0e46226a3e40d4e731d0b994c8028c8b7bd4df6", "application_groups": [ "CENTRAL_BANK_USERS" ] }, "encode": "JSON", "sourceURL": "centralbank-oabcs1-nrt.blockchain.ocp.example.com:20010", "blockNumber": 70 } }
-
getAccountDetailsByCustomAccountId
- 元のメソッド名:
getAccountDetailsByCustomAccountId
- このGETメソッドは、指定されたカスタム・アカウントIDのアカウント詳細を返します。このメソッドは、
Token Admin
、Token Auditor
、または指定された組織のOrg Admin
またはOrg Auditor
によってコールできます。 - 問合せ:
getAccountDetailsByCustomAccountId?customAccountId=customAccountId value&orgId={{bc-org-id}}&peer={{peer}}
- パラメータ:
customAccountId: string
– 機密モードのアカウントの一意のランダムID。orgId: string
– 現在の組織内のユーザーのメンバーシップ・サービス・プロバイダ(MSP) ID。peer: string
– 問合せを実行するピア・ノードの名前。
- 戻り値の例:
{ "returnCode": "Success", "error": "", "result": { "txid": "cf46211c670f7d21feb000a0161baaced91be314ea53981e26dc1482924055c9", "payload": [ { "bapAccountVersion": 0, "assetType": "oaccount", "account_id": "oaccount~c44ffac4c46718e9744cb0aae2016d26a87a5bef5e2d1c0d1abc7d8782f0ba61", "org_id": "CentralBank", "token_type": "fungible", "token_id": "USD", "token_name": "cbdc", "balance": "0", "onhold_balance": "0", "onhold_burn_balance": "0", "application_groups": [ "SYSTEM_ADMINS" ], "user_id": "cb_admin_demo", "custom_account_id": "10101234000123" } ], "encode": "JSON", "sourceURL": "centralbank-oabcs1-nrt.blockchain.ocp.example.com:20012", "blockNumber": 341 } }
-
getAllActiveCBDCAccounts
- 元のメソッド名:
getAllActiveAccounts
- このGETメソッドは、指定されたトークンIDに関連付けられているすべてのアクティブ・アカウントを返します。
- 問合せ:
getAllActiveCBDCAccounts?orgId={{bc-org-id}}&tokenId={{bc-token-id}}&peer={{peer}}
- パラメータ:
tokenId: string
– トークンのID。orgId: string
– 現在の組織内のユーザーのメンバーシップ・サービス・プロバイダ(MSP) ID。peer: string
– 問合せを実行するピア・ノードの名前。
- 戻り値:
- 成功の場合、ユーザーの詳細が含まれるメッセージ。次の例に示すように、出力はユーザーの役割によって異なります。
- 戻り値の例(トークン管理、トークン監査者、組織管理、組織監査者):
{ "returnCode": "Success", "error": "", "result": { "payload": [ { "key": "oaccount~c44ffac4c46718e9744cb0aae2016d26a87a5bef5e2d1c0d1abc7d8782f0ba61", "role_name": null, "valueJson": { "account_id": "oaccount~c44ffac4c46718e9744cb0aae2016d26a87a5bef5e2d1c0d1abc7d8782f0ba61", "org_id": "CentralBank", "token_id": "USD", "application_groups": [ "SYSTEM_ADMINS" ], "max_daily_amount": "10000", "max_daily_transactions": "1000" }, "non_account_role_name": [ "token_admin" ] }, { "key": "oaccount~1a6ea9aaa59c9ae8385bfdc870bf02616995c881ffeb111f526c8b31dbbdd43c", "role_name": null, "valueJson": { "account_id": "oaccount~1a6ea9aaa59c9ae8385bfdc870bf02616995c881ffeb111f526c8b31dbbdd43c", "org_id": "CentralBank", "token_id": "USD", "application_groups": [ "SYSTEM_AUDITORS" ], "max_daily_amount": "10000", "max_daily_transactions": "1000" }, "non_account_role_name": [ "token_auditor" ] }, { "key": "oaccount~da6e14466a0ba9b48ebc18fa672addb92dffc371bf953c3229a95b2ff2d9cd41", "role_name": "minter", "valueJson": { "account_id": "oaccount~da6e14466a0ba9b48ebc18fa672addb92dffc371bf953c3229a95b2ff2d9cd41", "org_id": "CentralBank", "token_id": "USD", "application_groups": [ "SYSTEM_CREATORS" ], "max_daily_amount": "1000000", "max_daily_transactions": "100000" }, "non_account_role_name": [] }, { "key": "oaccount~9b136ef4a60230846a8c14761683851a386d306b79493bc4d00433020c96cfa7", "role_name": "notary", "valueJson": { "account_id": "oaccount~9b136ef4a60230846a8c14761683851a386d306b79493bc4d00433020c96cfa7", "org_id": "CentralBank", "token_id": "USD", "application_groups": [ "SYSTEM_MANAGERS" ], "max_daily_amount": "10000", "max_daily_transactions": "1000" }, "non_account_role_name": [] }, { "key": "oaccount~68d67712f500e9dac8c314c19744003a993250271d960e9b0d25267bb18dfe9a", "role_name": null, "valueJson": { "account_id": "oaccount~68d67712f500e9dac8c314c19744003a993250271d960e9b0d25267bb18dfe9a", "org_id": "CentralBank", "token_id": "USD", "application_groups": [ "SYSTEM_ISSUERS" ], "max_daily_amount": "100000", "max_daily_transactions": "10000" }, "non_account_role_name": [] }, { "key": "oaccount~cea6080858337b1575d6a76ed0bd07a0eacd8871e3f2f7f793729a0e4b0e8e98", "role_name": "burner", "valueJson": { "account_id": "oaccount~cea6080858337b1575d6a76ed0bd07a0eacd8871e3f2f7f793729a0e4b0e8e98", "org_id": "CentralBank", "token_id": "USD", "application_groups": [ "SYSTEM_RETIRERS" ], "max_daily_amount": "10000", "max_daily_transactions": "1000" }, "non_account_role_name": [] } ], "encode": "JSON" } }
- 戻り値の例(他のすべてのユーザー):
{ "returnCode": "Success", "error": "", "result": { "payload": [ { "key": "oaccount~c44ffac4c46718e9744cb0aae2016d26a87a5bef5e2d1c0d1abc7d8782f0ba61", "role_name": null, "valueJson": { "account_id": "oaccount~c44ffac4c46718e9744cb0aae2016d26a87a5bef5e2d1c0d1abc7d8782f0ba61", "org_id": "CentralBank", "token_id": "USD", "application_groups": [ "SYSTEM_ADMINS" ] } }, { "key": "oaccount~1a6ea9aaa59c9ae8385bfdc870bf02616995c881ffeb111f526c8b31dbbdd43c", "role_name": null, "valueJson": { "account_id": "oaccount~1a6ea9aaa59c9ae8385bfdc870bf02616995c881ffeb111f526c8b31dbbdd43c", "org_id": "CentralBank", "token_id": "USD", "application_groups": [ "SYSTEM_AUDITORS" ] } }, { "key": "oaccount~da6e14466a0ba9b48ebc18fa672addb92dffc371bf953c3229a95b2ff2d9cd41", "role_name": "minter", "valueJson": { "account_id": "oaccount~da6e14466a0ba9b48ebc18fa672addb92dffc371bf953c3229a95b2ff2d9cd41", "org_id": "CentralBank", "token_id": "USD", "application_groups": [ "SYSTEM_CREATORS" ] } }, { "key": "oaccount~9b136ef4a60230846a8c14761683851a386d306b79493bc4d00433020c96cfa7", "role_name": "notary", "valueJson": { "account_id": "oaccount~9b136ef4a60230846a8c14761683851a386d306b79493bc4d00433020c96cfa7", "org_id": "CentralBank", "token_id": "USD", "application_groups": [ "SYSTEM_MANAGERS" ] } }, { "key": "oaccount~68d67712f500e9dac8c314c19744003a993250271d960e9b0d25267bb18dfe9a", "role_name": null, "valueJson": { "account_id": "oaccount~68d67712f500e9dac8c314c19744003a993250271d960e9b0d25267bb18dfe9a", "org_id": "CentralBank", "token_id": "USD", "application_groups": [ "SYSTEM_ISSUERS" ] } }, { "key": "oaccount~cea6080858337b1575d6a76ed0bd07a0eacd8871e3f2f7f793729a0e4b0e8e98", "role_name": "burner", "valueJson": { "account_id": "oaccount~cea6080858337b1575d6a76ed0bd07a0eacd8871e3f2f7f793729a0e4b0e8e98", "org_id": "CentralBank", "token_id": "USD", "application_groups": [ "SYSTEM_RETIRERS" ] } } ], "encode": "JSON" } }
-
getAllSuspendedCBDCAccounts
- 元のメソッド名:
getAllSuspendedAccounts
- このGETメソッドは、指定されたトークンIDに関連付けられている中断されたアカウントをすべて返します。
- 問合せ:
/getAllSuspendedCBDCAccounts?orgId={{bc-org-id}}&tokenId={{bc-token-id}}&peer={{peer}}
- パラメータ:
tokenId: string
– トークンのID。orgId: string
– 現在の組織内のユーザーのメンバーシップ・サービス・プロバイダ(MSP) ID。peer: string
– 問合せを実行するピア・ノードの名前。
- 戻り値:
- 成功の場合、ユーザーの詳細が含まれるメッセージ。次の例に示すように、出力はユーザーの役割によって異なります。
- 戻り値の例(トークン管理、トークン監査者、組織管理、組織監査者):
{ "returnCode": "Success", "error": "", "result": { "payload": [ { "key": "oaccount~c44ffac4c46718e9744cb0aae2016d26a87a5bef5e2d1c0d1abc7d8782f0ba61", "role_name": null, "valueJson": { "account_id": "oaccount~c44ffac4c46718e9744cb0aae2016d26a87a5bef5e2d1c0d1abc7d8782f0ba61", "org_id": "CentralBank", "token_id": "USD", "application_groups": [ "SYSTEM_ADMINS" ], "max_daily_amount": "10000", "max_daily_transactions": "1000" }, "non_account_role_name": [ "token_admin" ] } ], "encode": "JSON" } }
- 戻り値の例(他のすべてのユーザー):
{ "returnCode": "Success", "error": "", "result": { "payload": [ { "key": "oaccount~c44ffac4c46718e9744cb0aae2016d26a87a5bef5e2d1c0d1abc7d8782f0ba61", "role_name": null, "valueJson": { "account_id": "oaccount~c44ffac4c46718e9744cb0aae2016d26a87a5bef5e2d1c0d1abc7d8782f0ba61", "org_id": "CentralBank", "token_id": "USD", "application_groups": [ "SYSTEM_ADMINS" ] } } ], "encode": "JSON" } }
-
getApproverActionHistory
- 元のメソッド名:
getActionHistory
- このGETメソッドは、ミント、バーンおよび転送(発行)操作のためにコール元によって行われた承認または拒否の履歴を取得します。これには、組織の詳細、関係するアカウントのユーザーID(送信者、受信者および公証人)が含まれます。このメソッドは、
Token Admin
、Token Auditor
、Org Admin
、Org Auditor
または公証書によってのみコールできます。 - 問合せ:
getApproverActionHistory?tokenId={{bc-token-id}}&peer={{peer}}
- パラメータ:
tokenId: string
– トークンのID。peer: string
– 問合せを実行するピア・ノードの名前。
- 戻り値の例:
{ "returnCode": "Success", "error": "", "result": { "payload": [ { "from_account_id": "oaccount~cea6080858337b1575d6a76ed0bd07a0eacd8871e3f2f7f793729a0e4b0e8e98", "from_org_id": "CentralBank", "holding_id": "ohold~cbdc~USD~b770", "holding_status": "APPROVE_BURN", "last_updated_time": "2025-08-25T13:21:24.000Z", "notary_account_id": "oaccount~9b136ef4a60230846a8c14761683851a386d306b79493bc4d00433020c96cfa7", "notary_org_id": "CentralBank", "operation_id": null, "timetoexpiration": null, "to_account_id": null, "to_org_id": null, "token_name": null, "quantity": 200 }, { "from_account_id": null, "from_org_id": null, "holding_id": "ohold~cbdc~USD~e7b6", "holding_status": "APPROVE_MINT", "last_updated_time": "2025-08-25T13:20:50.000Z", "notary_account_id": "oaccount~9b136ef4a60230846a8c14761683851a386d306b79493bc4d00433020c96cfa7", "notary_org_id": "CentralBank", "operation_id": null, "timetoexpiration": null, "to_account_id": "oaccount~da6e14466a0ba9b48ebc18fa672addb92dffc371bf953c3229a95b2ff2d9cd41", "to_org_id": "CentralBank", "token_name": null, "quantity": 1000 }, { "from_account_id": "oaccount~68d67712f500e9dac8c314c19744003a993250271d960e9b0d25267bb18dfe9a", "from_org_id": "CentralBank", "holding_id": "ohold~cbdc~USD~81d7c4ac", "holding_status": "EXECUTEHOLD", "last_updated_time": "2025-08-25T13:16:55.000Z", "notary_account_id": "oaccount~9b136ef4a60230846a8c14761683851a386d306b79493bc4d00433020c96cfa7", "notary_org_id": "CentralBank", "operation_id": null, "timetoexpiration": null, "to_account_id": "oaccount~76687c724ddbc2d6e6664d9618b2bf1c2a9fe10f84887462447e4caba6aaaff3", "to_org_id": "Org1", "token_name": null, "quantity": 200 }, { "from_account_id": null, "from_org_id": null, "holding_id": "ohold~cbdc~USD~1e19", "holding_status": "APPROVE_MINT", "last_updated_time": "2025-08-13T06:12:41.000Z", "notary_account_id": "oaccount~9b136ef4a60230846a8c14761683851a386d306b79493bc4d00433020c96cfa7", "notary_org_id": "CentralBank", "operation_id": null, "timetoexpiration": null, "to_account_id": "oaccount~da6e14466a0ba9b48ebc18fa672addb92dffc371bf953c3229a95b2ff2d9cd41", "to_org_id": "CentralBank", "token_name": null, "quantity": 10000 }, { "from_account_id": "oaccount~cea6080858337b1575d6a76ed0bd07a0eacd8871e3f2f7f793729a0e4b0e8e98", "from_org_id": "CentralBank", "holding_id": "ohold~cbdc~USD~1f74", "holding_status": "REJECT_BURN", "last_updated_time": "2025-08-12T21:09:53.000Z", "notary_account_id": "oaccount~9b136ef4a60230846a8c14761683851a386d306b79493bc4d00433020c96cfa7", "notary_org_id": "CentralBank", "operation_id": null, "timetoexpiration": null, "to_account_id": "", "to_org_id": null, "token_name": null, "quantity": 1000 }, { "from_account_id": "oaccount~cea6080858337b1575d6a76ed0bd07a0eacd8871e3f2f7f793729a0e4b0e8e98", "from_org_id": "CentralBank", "holding_id": "ohold~cbdc~USD~d67c", "holding_status": "REJECT_BURN", "last_updated_time": "2025-08-12T21:09:47.000Z", "notary_account_id": "oaccount~9b136ef4a60230846a8c14761683851a386d306b79493bc4d00433020c96cfa7", "notary_org_id": "CentralBank", "operation_id": null, "timetoexpiration": null, "to_account_id": "", "to_org_id": null, "token_name": null, "quantity": 2000 }, { "from_account_id": "oaccount~cea6080858337b1575d6a76ed0bd07a0eacd8871e3f2f7f793729a0e4b0e8e98", "from_org_id": "CentralBank", "holding_id": "ohold~cbdc~USD~911b", "holding_status": "APPROVE_BURN", "last_updated_time": "2025-08-12T21:09:40.000Z", "notary_account_id": "oaccount~9b136ef4a60230846a8c14761683851a386d306b79493bc4d00433020c96cfa7", "notary_org_id": "CentralBank", "operation_id": null, "timetoexpiration": null, "to_account_id": null, "to_org_id": null, "token_name": null, "quantity": 1000 }, { "from_account_id": "oaccount~68d67712f500e9dac8c314c19744003a993250271d960e9b0d25267bb18dfe9a", "from_org_id": "CentralBank", "holding_id": "ohold~cbdc~USD~ed815e20", "holding_status": "EXECUTEHOLD", "last_updated_time": "2025-08-12T21:09:25.000Z", "notary_account_id": "oaccount~9b136ef4a60230846a8c14761683851a386d306b79493bc4d00433020c96cfa7", "notary_org_id": "CentralBank", "operation_id": null, "timetoexpiration": null, "to_account_id": "oaccount~3954f54a8bc7acdd0c3d0960104240f60d56c26c8a179430267359cd80ce3709", "to_org_id": "org2", "token_name": null, "quantity": 10000 }, { "from_account_id": "oaccount~68d67712f500e9dac8c314c19744003a993250271d960e9b0d25267bb18dfe9a", "from_org_id": "CentralBank", "holding_id": "ohold~cbdc~USD~12d87129", "holding_status": "EXECUTEHOLD", "last_updated_time": "2025-08-12T21:09:17.000Z", "notary_account_id": "oaccount~9b136ef4a60230846a8c14761683851a386d306b79493bc4d00433020c96cfa7", "notary_org_id": "CentralBank", "operation_id": null, "timetoexpiration": null, "to_account_id": "oaccount~76687c724ddbc2d6e6664d9618b2bf1c2a9fe10f84887462447e4caba6aaaff3", "to_org_id": "Org1", "token_name": null, "quantity": 10000 }, { "from_account_id": "", "from_org_id": null, "holding_id": "ohold~cbdc~USD~54a4", "holding_status": "REJECT_MINT", "last_updated_time": "2025-08-12T21:01:27.000Z", "notary_account_id": "oaccount~9b136ef4a60230846a8c14761683851a386d306b79493bc4d00433020c96cfa7", "notary_org_id": "CentralBank", "operation_id": null, "timetoexpiration": null, "to_account_id": "oaccount~da6e14466a0ba9b48ebc18fa672addb92dffc371bf953c3229a95b2ff2d9cd41", "to_org_id": "CentralBank", "token_name": null, "quantity": 40000 }, { "from_account_id": null, "from_org_id": null, "holding_id": "ohold~cbdc~USD~9b27", "holding_status": "APPROVE_MINT", "last_updated_time": "2025-08-12T21:01:16.000Z", "notary_account_id": "oaccount~9b136ef4a60230846a8c14761683851a386d306b79493bc4d00433020c96cfa7", "notary_org_id": "CentralBank", "operation_id": null, "timetoexpiration": null, "to_account_id": "oaccount~da6e14466a0ba9b48ebc18fa672addb92dffc371bf953c3229a95b2ff2d9cd41", "to_org_id": "CentralBank", "token_name": null, "quantity": 30000 }, { "from_account_id": null, "from_org_id": null, "holding_id": "ohold~cbdc~USD~eda0", "holding_status": "APPROVE_MINT", "last_updated_time": "2025-08-12T21:01:05.000Z", "notary_account_id": "oaccount~9b136ef4a60230846a8c14761683851a386d306b79493bc4d00433020c96cfa7", "notary_org_id": "CentralBank", "operation_id": null, "timetoexpiration": null, "to_account_id": "oaccount~da6e14466a0ba9b48ebc18fa672addb92dffc371bf953c3229a95b2ff2d9cd41", "to_org_id": "CentralBank", "token_name": null, "quantity": 20000 }, { "from_account_id": null, "from_org_id": null, "holding_id": "ohold~cbdc~USD~1baa", "holding_status": "APPROVE_MINT", "last_updated_time": "2025-08-12T21:01:03.000Z", "notary_account_id": "oaccount~9b136ef4a60230846a8c14761683851a386d306b79493bc4d00433020c96cfa7", "notary_org_id": "CentralBank", "operation_id": null, "timetoexpiration": null, "to_account_id": "oaccount~da6e14466a0ba9b48ebc18fa672addb92dffc371bf953c3229a95b2ff2d9cd41", "to_org_id": "CentralBank", "token_name": null, "quantity": 10000 } ], "encode": "JSON" } }
-
getCBDCAccount
- 元のメソッド名:
getCBDCAccount
- このGETメソッドは、指定されたユーザーおよびトークンのアカウント詳細を返します。このメソッドは、チェーンコードの
Token Admin
またはToken Auditor
、指定された組織のOrg Admin
またはOrg Auditor
、またはアカウントのAccountOwner
のみがコールできます。 - 問合せ:
/getCBDCAccount?accountId=account_id value&peer={{peer}}
- パラメータ:
accountId: string
– アカウントのID。peer: string
– 問合せを実行するピア・ノードの名前。
- 戻り値の例:
{ "returnCode": "Success", "error": "", "result": { "payload": { "bapAccountVersion": 0, "assetType": "oaccount", "user_id": "cb_manager_demo", "custom_account_id": "10105678007891", "status": "active", "account_id": "oaccount~9b136ef4a60230846a8c14761683851a386d306b79493bc4d00433020c96cfa7", "org_id": "CentralBank", "token_type": "fungible", "token_id": "USD", "token_name": "cbdc", "balance": "0", "onhold_balance": "0", "onhold_burn_balance": "0", "application_groups": [ "SYSTEM_MANAGERS" ] }, "encode": "JSON" } }
-
getCBDCAccountBalance
- 元のメソッド名:
getAccountBalance
- このGETメソッドは、指定されたアカウントおよびトークンの現在の残高を返します。このメソッドは、チェーンコードの
Token Admin
またはToken Auditor
、指定された組織のOrg Admin
またはOrg Auditor
、またはアカウントのAccountOwner
のみがコールできます。 /getCBDCAccountBalance?accountId=account_id value&peer={{peer}}
- パラメータ:
accountId: string
– アカウントのID。peer: string
– 問合せを実行するピア・ノードの名前。
- 戻り値の例:
{ "returnCode": "Success", "error": "", "result": { "payload": { "msg": "Current Balance is: 100", "user_balance": 100 }, "encode": "JSON" } }
-
getCBDCAccountsByUser
- 元のメソッド名:
getAccountsByUser
- このメソッドは、指定された組織IDとユーザーIDのすべてのアカウントIDのリストを返します。このメソッドは、チェーンコードの
Token Admin
またはToken Auditor
、指定された組織のOrg Admin
またはOrg Auditor
、またはアカウントのAccountOwner
のみがコールできます。 /getCBDCAccountsByUser?orgId={{bc-org-id}}&userId={{bc-user-id}}&peer={{peer}}
- パラメータ:
orgId string
– 現在の組織内のユーザーのメンバーシップ・サービス・プロバイダ(MSP) ID。userId string
– ユーザーのユーザー名または電子メールID。peer: string
– 問合せを実行するピア・ノードの名前。
- 戻り値の例:
{ "returnCode": "Success", "error": "", "result": { "payload": [ { "bapAccountVersion": 15, "assetType": "oaccount", "user_id": "cb__creator_demo", "custom_account_id": "10105678004567", "account_id": "oaccount~da6e14466a0ba9b48ebc18fa672addb92dffc371bf953c3229a95b2ff2d9cd41", "org_id": "CentralBank", "token_type": "fungible", "token_id": "USD", "token_name": "cbdc", "balance": "21000", "onhold_balance": "0", "onhold_burn_balance": "0", "application_groups": [ "SYSTEM_CREATORS" ] }, { "bapAccountVersion": 0, "assetType": "oaccount", "user_id": "cb__creator_demo", "custom_account_id": "Not Available", "account_id": "oaccount~388fb87df59c6a4fbf0400c58b61aa85f975a8c4209942006b0c0d6334fcf887", "org_id": "CentralBank", "token_type": "fungible", "token_id": "", "token_name": "", "balance": "0", "onhold_balance": "0", "onhold_burn_balance": "0", "application_groups": [ "application_groups value" ] } ], "encode": "JSON" } }
-
getCBDCAccountTransactionHistory
- 元のメソッド名:
getAccountTransactionHistory
- このメソッドは、指定されたユーザーおよびトークンのアカウント・トランザクション履歴詳細の配列を返します。このメソッドは、チェーンコードの
Token Admin
またはToken Auditor
、指定された組織のOrg Admin
またはOrg Auditor
、またはアカウントのAccountOwner
のみがコールできます。 /getCBDCAccountTransactionHistory?accountId=account_id value&peer={{peer}}
- パラメータ:
accountId: string
– アカウントのID。peer: string
– 問合せを実行するピア・ノードの名前。
- 戻り値の例:
{ "returnCode": "Success", "error": "", "result": { "payload": [ { "transaction_id": "otransaction~4514aa229ebcc4d2fedcaa47c4301615e30c4a9bae45cf0256a5b80d75b3697a", "transacted_amount": 1000, "timestamp": "2025-08-25T13:20:50.000Z", "token_id": "USD", "transacted_account": "oaccount~da6e14466a0ba9b48ebc18fa672addb92dffc371bf953c3229a95b2ff2d9cd41", "transaction_type": "APPROVE_MINT", "balance": 21000, "onhold_balance": 0 }, { "transaction_id": "otransaction~1982f73495060e0eef4d78282a91c41e27e8c95572739b0677a1e404a0d20aa9", "transacted_amount": 200, "timestamp": "2025-08-25T13:12:43.000Z", "token_id": "USD", "transacted_account": "oaccount~da6e14466a0ba9b48ebc18fa672addb92dffc371bf953c3229a95b2ff2d9cd41", "transaction_type": "REQUEST_MINT", "balance": 20000, "onhold_balance": 0 }, { "transaction_id": "otransaction~fedd714cf1509f7517819d7cd4c0921d0b2f5d1ff6a25dcb08ab411defd6b5f3", "transacted_amount": 2000, "timestamp": "2025-08-21T05:23:25.000Z", "token_id": "USD", "transacted_account": "oaccount~da6e14466a0ba9b48ebc18fa672addb92dffc371bf953c3229a95b2ff2d9cd41", "transaction_type": "REQUEST_MINT", "balance": 20000, "onhold_balance": 0 }, { "transaction_id": "otransaction~f33b47234f3ee0b636962c8c31c01d06523b789ca16b3b342d5080b71268bcc3", "transacted_amount": 1000, "timestamp": "2025-08-21T05:23:07.000Z", "token_id": "USD", "transacted_account": "oaccount~da6e14466a0ba9b48ebc18fa672addb92dffc371bf953c3229a95b2ff2d9cd41", "transaction_type": "REQUEST_MINT", "balance": 20000, "onhold_balance": 0 }, { "transaction_id": "otransaction~cf934527149bc24f62a8ddeeea7f74a19a0f84d8f161535a771be49d2520d5b3", "transacted_amount": 10000, "timestamp": "2025-08-13T06:12:41.000Z", "token_id": "USD", "transacted_account": "oaccount~da6e14466a0ba9b48ebc18fa672addb92dffc371bf953c3229a95b2ff2d9cd41", "transaction_type": "APPROVE_MINT", "balance": 20000, "onhold_balance": 0 }, { "transaction_id": "otransaction~f5c0e11ca61d9adc843658929e6de2a738ad586304f9e020f75bf4aac5e42a2c", "transacted_amount": 10000, "timestamp": "2025-08-13T06:12:04.000Z", "token_id": "USD", "transacted_account": "oaccount~da6e14466a0ba9b48ebc18fa672addb92dffc371bf953c3229a95b2ff2d9cd41", "transaction_type": "REQUEST_MINT", "balance": 10000, "onhold_balance": 0 }, { "transaction_id": "otransaction~862aa9d9e877d3ea209b87299ab5b12c13ed5ce43d1cf1b934043c1dd02f58f6", "transacted_amount": 50000, "timestamp": "2025-08-12T21:04:22.000Z", "token_id": "USD", "category": "transfer", "transacted_account": "oaccount~68d67712f500e9dac8c314c19744003a993250271d960e9b0d25267bb18dfe9a", "transaction_type": "DEBIT", "balance": 10000, "onhold_balance": 0 }, { "transaction_id": "otransaction~8a74c6d87ca74a613aab9db5d40386f8d5b534f9800503af8ca27e8946d7616d", "transacted_amount": 40000, "timestamp": "2025-08-12T21:01:27.000Z", "token_id": "USD", "transacted_account": "oaccount~da6e14466a0ba9b48ebc18fa672addb92dffc371bf953c3229a95b2ff2d9cd41", "transaction_type": "REJECT_MINT", "balance": 60000, "onhold_balance": 0 }, { "transaction_id": "otransaction~28ac66ba33f7ad0648448964b2b74525c9e3f0c9908c7a0484690b9baa56c2db", "transacted_amount": 30000, "timestamp": "2025-08-12T21:01:16.000Z", "token_id": "USD", "transacted_account": "oaccount~da6e14466a0ba9b48ebc18fa672addb92dffc371bf953c3229a95b2ff2d9cd41", "transaction_type": "APPROVE_MINT", "balance": 60000, "onhold_balance": 0 }, { "transaction_id": "otransaction~7e32ad8f365ff59814e112f27602f30ab599fb9c1638784496c66a61a6277c22", "transacted_amount": 20000, "timestamp": "2025-08-12T21:01:05.000Z", "token_id": "USD", "transacted_account": "oaccount~da6e14466a0ba9b48ebc18fa672addb92dffc371bf953c3229a95b2ff2d9cd41", "transaction_type": "APPROVE_MINT", "balance": 30000, "onhold_balance": 0 }, { "transaction_id": "otransaction~1477050bb9e55f4f471872b31fce0d2097f5d5e57d89a842070df5e36d7ab0da", "transacted_amount": 10000, "timestamp": "2025-08-12T21:01:03.000Z", "token_id": "USD", "transacted_account": "oaccount~da6e14466a0ba9b48ebc18fa672addb92dffc371bf953c3229a95b2ff2d9cd41", "transaction_type": "APPROVE_MINT", "balance": 10000, "onhold_balance": 0 }, { "transaction_id": "otransaction~0e76c6931b7ee134e967e847d9730b867a0fd191d39697d83d36dd15745c02e3", "transacted_amount": 40000, "timestamp": "2025-08-12T21:00:20.000Z", "token_id": "USD", "transacted_account": "oaccount~da6e14466a0ba9b48ebc18fa672addb92dffc371bf953c3229a95b2ff2d9cd41", "transaction_type": "REQUEST_MINT", "balance": 0, "onhold_balance": 0 }, { "transaction_id": "otransaction~07bbf9c190694371626da59ded5d87434d26f612891e13bb15bdd28f6086e760", "transacted_amount": 30000, "timestamp": "2025-08-12T21:00:01.000Z", "token_id": "USD", "transacted_account": "oaccount~da6e14466a0ba9b48ebc18fa672addb92dffc371bf953c3229a95b2ff2d9cd41", "transaction_type": "REQUEST_MINT", "balance": 0, "onhold_balance": 0 }, { "transaction_id": "otransaction~8721175c6cbbce17b6c4bb6a444e475d07f52352dfd0d990679f342215153513", "transacted_amount": 20000, "timestamp": "2025-08-12T20:59:41.000Z", "token_id": "USD", "transacted_account": "oaccount~da6e14466a0ba9b48ebc18fa672addb92dffc371bf953c3229a95b2ff2d9cd41", "transaction_type": "REQUEST_MINT", "balance": 0, "onhold_balance": 0 }, { "transaction_id": "otransaction~dc24c24d43a6525e807a39edcf8c6a2b6ccb81f0d755958f509509687eacee84", "transacted_amount": 10000, "timestamp": "2025-08-12T20:59:13.000Z", "token_id": "USD", "transacted_account": "oaccount~da6e14466a0ba9b48ebc18fa672addb92dffc371bf953c3229a95b2ff2d9cd41", "transaction_type": "REQUEST_MINT", "balance": 0, "onhold_balance": 0 }, { "transaction_id": "otransaction~396e6ca5a11a9609632d0864026409d46a708fb95e3e21b39fa5f3fb78f90872", "transacted_amount": 0, "timestamp": "2025-08-12T20:43:20.000Z", "token_id": "", "transacted_account": "oaccount~da6e14466a0ba9b48ebc18fa672addb92dffc371bf953c3229a95b2ff2d9cd41", "transaction_type": "CREATE_ACCOUNT", "balance": 0, "onhold_balance": 0 } ], "encode": "JSON" } }
-
getCBDCAccountTransactionHistoryWithFilters
- 元のメソッド名:
getAccountTransactionHistoryWithFiltersFromRichHistDB
- このメソッドは、リッチ履歴データベースから勘定科目トランザクション履歴詳細を返します。このメソッドは、チェーンコードの
Token Admin
またはToken Auditor
、指定された組織のOrg Admin
またはOrg Auditor
、またはアカウントのAccountOwner
のみがコールできます。 /getCBDCAccountTransactionHistoryWithFilters?accountId=account_id value&customEndpoint=custom_endpoint value&bearerToken=bearer_token value&filters={"pageSize":20,"bookmark":"","startTime":"1900-01-01T00:00:00+00:00","endTime":"2100-01-01T00:00:00+00:00"}&peer={{peer}}
- パラメータ:
accountId: string
– アカウントのID。customEndpoint
– トランザクション履歴のフェッチ元となるリッチ履歴データベースのRESTfulサービス・エンドポイント。bearerToken
– リクエストが認可されていることを確認するためにRESTfulエンドポイントをコールするために使用するトークン。filters: JSON object
– オプションのパラメータ。空の場合は、すべてのレコードが返されます。pageSize
プロパティは、返すレコード数を決定します。pageSize
が0の場合、デフォルトのページ・サイズは20です。bookmark
プロパティは、返すレコードの開始索引を決定します。startTime
およびendTime
プロパティは、RFC-3339形式で指定する必要があります。peer: string
– 問合せを実行するピア・ノードの名前。
- 戻り値の例:
{ "returnCode": "Success", "error": "", "result": { "payload": [ { "transaction_id": "otransaction~3140569a4ecb3c3f141cc2468fe21276640b7fd79013d951d9104b79072d8f9c", "transacted_amount": 200, "timestamp": "2025-08-25T13:16:55.000Z", "token_id": "USD", "transacted_account": "oaccount~76687c724ddbc2d6e6664d9618b2bf1c2a9fe10f84887462447e4caba6aaaff3", "transacted_org_id": "Org1", "transacted_user_id": "fi1_org_officer_demo", "transacted_custom_account_id": "20200222221111", "to_account": "oaccount~76687c724ddbc2d6e6664d9618b2bf1c2a9fe10f84887462447e4caba6aaaff3", "to_org_id": "Org1", "to_user_id": "fi1_org_officer_demo", "to_custom_account_id": "20200222221111", "from_account": "oaccount~68d67712f500e9dac8c314c19744003a993250271d960e9b0d25267bb18dfe9a", "from_org_id": "CentralBank", "from_user_id": "cb_issuer_demo", "from_custom_account_id": "10109999001234", "transaction_type": "EXECUTEHOLD", "category": "transfer", "balance": 26800, "onhold_balance": 300 }, { "transaction_id": "otransaction~2b75b3e8531a651f07c2d048d8546ad70ac49c66f0b82ed7626c1739090842ce", "transacted_amount": 100, "timestamp": "2025-08-25T13:16:06.000Z", "token_id": "USD", "transacted_account": "oaccount~68d67712f500e9dac8c314c19744003a993250271d960e9b0d25267bb18dfe9a", "transacted_org_id": "CentralBank", "transacted_user_id": "cb_issuer_demo", "transacted_custom_account_id": "10109999001234", "to_account": "oaccount~76687c724ddbc2d6e6664d9618b2bf1c2a9fe10f84887462447e4caba6aaaff3", "to_org_id": "Org1", "to_user_id": "fi1_org_officer_demo", "to_custom_account_id": "20200222221111", "from_account": "oaccount~68d67712f500e9dac8c314c19744003a993250271d960e9b0d25267bb18dfe9a", "from_org_id": "CentralBank", "from_user_id": "cb_issuer_demo", "from_custom_account_id": "10109999001234", "transaction_type": "ONHOLD", "holding_id": "ohold~cbdc~USD~e26f11da", "category": "transfer", "balance": 26800, "onhold_balance": 500 }, { "transaction_id": "otransaction~9e7bf14cf96c5f90170da9455b1318687785e936192f60b7cbeb1c8bfabc41d2", "transacted_amount": 100, "timestamp": "2025-08-21T06:57:19.000Z", "token_id": "USD", "transacted_account": "oaccount~cea6080858337b1575d6a76ed0bd07a0eacd8871e3f2f7f793729a0e4b0e8e98", "transacted_org_id": "CentralBank", "transacted_user_id": "cb_retirer_demo", "transacted_custom_account_id": "10109999006543", "to_account": "oaccount~68d67712f500e9dac8c314c19744003a993250271d960e9b0d25267bb18dfe9a", "to_org_id": "CentralBank", "to_user_id": "cb_issuer_demo", "to_custom_account_id": "10109999001234", "from_account": "oaccount~cea6080858337b1575d6a76ed0bd07a0eacd8871e3f2f7f793729a0e4b0e8e98", "from_org_id": "CentralBank", "from_user_id": "cb_retirer_demo", "from_custom_account_id": "10109999006543", "transaction_type": "CREDIT", "category": "transfer", "balance": 26900, "onhold_balance": 400 }, { "transaction_id": "otransaction~b3901b4754920a9c75e36069dc55024ad505e4c127f334eedf65ef6703dc6b86", "transacted_amount": 200, "timestamp": "2025-08-21T05:39:25.000Z", "token_id": "USD", "transacted_account": "oaccount~68d67712f500e9dac8c314c19744003a993250271d960e9b0d25267bb18dfe9a", "transacted_org_id": "CentralBank", "transacted_user_id": "cb_issuer_demo", "transacted_custom_account_id": "10109999001234", "to_account": "oaccount~3954f54a8bc7acdd0c3d0960104240f60d56c26c8a179430267359cd80ce3709", "to_org_id": "org2", "to_user_id": "fi2_org_officer_demo", "to_custom_account_id": "30300617202404", "from_account": "oaccount~68d67712f500e9dac8c314c19744003a993250271d960e9b0d25267bb18dfe9a", "from_org_id": "CentralBank", "from_user_id": "cb_issuer_demo", "from_custom_account_id": "10109999001234", "transaction_type": "ONHOLD", "holding_id": "ohold~cbdc~USD~77b75873", "category": "issuance", "balance": 26800, "onhold_balance": 400 }, { "transaction_id": "otransaction~d55c9dfc9feacb353544b5d8b2ae694162ade3890bcaaf715503fd1d6a73cd1a", "transacted_amount": 200, "timestamp": "2025-08-21T05:39:01.000Z", "token_id": "USD", "transacted_account": "oaccount~68d67712f500e9dac8c314c19744003a993250271d960e9b0d25267bb18dfe9a", "transacted_org_id": "CentralBank", "transacted_user_id": "cb_issuer_demo", "transacted_custom_account_id": "10109999001234", "to_account": "oaccount~76687c724ddbc2d6e6664d9618b2bf1c2a9fe10f84887462447e4caba6aaaff3", "to_org_id": "Org1", "to_user_id": "fi1_org_officer_demo", "to_custom_account_id": "20200222221111", "from_account": "oaccount~68d67712f500e9dac8c314c19744003a993250271d960e9b0d25267bb18dfe9a", "from_org_id": "CentralBank", "from_user_id": "cb_issuer_demo", "from_custom_account_id": "10109999001234", "transaction_type": "ONHOLD", "holding_id": "ohold~cbdc~USD~81d7c4ac", "category": "transfer", "balance": 27000, "onhold_balance": 200 }, { "transaction_id": "otransaction~751eaedbe4311edd5d17cae53d283caf397d0cb09f18d57a5e3fe61266875ff9", "transacted_amount": 200, "timestamp": "2025-08-13T09:59:22.000Z", "token_id": "USD", "transacted_account": "oaccount~3954f54a8bc7acdd0c3d0960104240f60d56c26c8a179430267359cd80ce3709", "transacted_org_id": "org2", "transacted_user_id": "fi2_org_officer_demo", "transacted_custom_account_id": "30300617202404", "to_account": "oaccount~68d67712f500e9dac8c314c19744003a993250271d960e9b0d25267bb18dfe9a", "to_org_id": "CentralBank", "to_user_id": "cb_issuer_demo", "to_custom_account_id": "10109999001234", "from_account": "oaccount~3954f54a8bc7acdd0c3d0960104240f60d56c26c8a179430267359cd80ce3709", "from_org_id": "org2", "from_user_id": "fi2_org_officer_demo", "from_custom_account_id": "30300617202404", "transaction_type": "CREDIT", "category": "transfer", "balance": 27200, "onhold_balance": 0 }, { "transaction_id": "otransaction~70155a8f4e388cc9395dbd03bedaf5a878705f5ad02302c8e9163218a5c3875a", "transacted_amount": 1000, "timestamp": "2025-08-13T06:22:56.000Z", "token_id": "USD", "transacted_account": "oaccount~76687c724ddbc2d6e6664d9618b2bf1c2a9fe10f84887462447e4caba6aaaff3", "transacted_org_id": "Org1", "transacted_user_id": "fi1_org_officer_demo", "transacted_custom_account_id": "20200222221111", "to_account": "oaccount~68d67712f500e9dac8c314c19744003a993250271d960e9b0d25267bb18dfe9a", "to_org_id": "CentralBank", "to_user_id": "cb_issuer_demo", "to_custom_account_id": "10109999001234", "from_account": "oaccount~76687c724ddbc2d6e6664d9618b2bf1c2a9fe10f84887462447e4caba6aaaff3", "from_org_id": "Org1", "from_user_id": "fi1_org_officer_demo", "from_custom_account_id": "20200222221111", "transaction_type": "CREDIT", "category": "transfer", "balance": 27000, "onhold_balance": 0 }, { "transaction_id": "otransaction~e595f3f0cc03fa5f58a546b8abbfaf155592e492f850581db2b8fed9a529c9e2", "transacted_amount": 10000, "timestamp": "2025-08-12T21:09:25.000Z", "token_id": "USD", "transacted_account": "oaccount~3954f54a8bc7acdd0c3d0960104240f60d56c26c8a179430267359cd80ce3709", "transacted_org_id": "org2", "transacted_user_id": "fi2_org_officer_demo", "transacted_custom_account_id": "30300617202404", "to_account": "oaccount~3954f54a8bc7acdd0c3d0960104240f60d56c26c8a179430267359cd80ce3709", "to_org_id": "org2", "to_user_id": "fi2_org_officer_demo", "to_custom_account_id": "30300617202404", "from_account": "oaccount~68d67712f500e9dac8c314c19744003a993250271d960e9b0d25267bb18dfe9a", "from_org_id": "CentralBank", "from_user_id": "cb_issuer_demo", "from_custom_account_id": "10109999001234", "transaction_type": "EXECUTEHOLD", "category": "issuance", "balance": 26000, "onhold_balance": 0 }, { "transaction_id": "otransaction~da92402859d87ae3069722d8e39cb0da448e9a5f67468233ee9b1fe7a4ebeef8", "transacted_amount": 10000, "timestamp": "2025-08-12T21:09:17.000Z", "token_id": "USD", "transacted_account": "oaccount~76687c724ddbc2d6e6664d9618b2bf1c2a9fe10f84887462447e4caba6aaaff3", "transacted_org_id": "Org1", "transacted_user_id": "fi1_org_officer_demo", "transacted_custom_account_id": "20200222221111", "to_account": "oaccount~76687c724ddbc2d6e6664d9618b2bf1c2a9fe10f84887462447e4caba6aaaff3", "to_org_id": "Org1", "to_user_id": "fi1_org_officer_demo", "to_custom_account_id": "20200222221111", "from_account": "oaccount~68d67712f500e9dac8c314c19744003a993250271d960e9b0d25267bb18dfe9a", "from_org_id": "CentralBank", "from_user_id": "cb_issuer_demo", "from_custom_account_id": "10109999001234", "transaction_type": "EXECUTEHOLD", "category": "issuance", "balance": 26000, "onhold_balance": 10000 }, { "transaction_id": "otransaction~6915145aaf09fbf4d96456febddc2aa87b48c08ddd8ff17a6bab5d310f67bb36", "transacted_amount": 1000, "timestamp": "2025-08-12T21:07:11.000Z", "token_id": "USD", "transacted_account": "oaccount~cea6080858337b1575d6a76ed0bd07a0eacd8871e3f2f7f793729a0e4b0e8e98", "transacted_org_id": "CentralBank", "transacted_user_id": "cb_retirer_demo", "transacted_custom_account_id": "10109999006543", "to_account": "oaccount~68d67712f500e9dac8c314c19744003a993250271d960e9b0d25267bb18dfe9a", "to_org_id": "CentralBank", "to_user_id": "cb_issuer_demo", "to_custom_account_id": "10109999001234", "from_account": "oaccount~cea6080858337b1575d6a76ed0bd07a0eacd8871e3f2f7f793729a0e4b0e8e98", "from_org_id": "CentralBank", "from_user_id": "cb_retirer_demo", "from_custom_account_id": "10109999006543", "transaction_type": "CREDIT", "category": "transfer", "balance": 26000, "onhold_balance": 20000 }, { "transaction_id": "otransaction~244d7172d1dc90a142e1f22204c76614c7eea814b3d61f33016b786f1b347784", "transacted_amount": 10000, "timestamp": "2025-08-12T21:05:39.000Z", "token_id": "USD", "transacted_account": "oaccount~68d67712f500e9dac8c314c19744003a993250271d960e9b0d25267bb18dfe9a", "transacted_org_id": "CentralBank", "transacted_user_id": "cb_issuer_demo", "transacted_custom_account_id": "10109999001234", "to_account": "oaccount~3954f54a8bc7acdd0c3d0960104240f60d56c26c8a179430267359cd80ce3709", "to_org_id": "org2", "to_user_id": "fi2_org_officer_demo", "to_custom_account_id": "30300617202404", "from_account": "oaccount~68d67712f500e9dac8c314c19744003a993250271d960e9b0d25267bb18dfe9a", "from_org_id": "CentralBank", "from_user_id": "cb_issuer_demo", "from_custom_account_id": "10109999001234", "transaction_type": "ONHOLD", "holding_id": "ohold~cbdc~USD~ed815e20", "category": "issuance", "balance": 25000, "onhold_balance": 20000 }, { "transaction_id": "otransaction~c63ec37966264493bde6fa666527b9cca11695c15611c32e89af49a2246f13f6", "transacted_amount": 10000, "timestamp": "2025-08-12T21:05:20.000Z", "token_id": "USD", "transacted_account": "oaccount~68d67712f500e9dac8c314c19744003a993250271d960e9b0d25267bb18dfe9a", "transacted_org_id": "CentralBank", "transacted_user_id": "cb_issuer_demo", "transacted_custom_account_id": "10109999001234", "to_account": "oaccount~76687c724ddbc2d6e6664d9618b2bf1c2a9fe10f84887462447e4caba6aaaff3", "to_org_id": "Org1", "to_user_id": "fi1_org_officer_demo", "to_custom_account_id": "20200222221111", "from_account": "oaccount~68d67712f500e9dac8c314c19744003a993250271d960e9b0d25267bb18dfe9a", "from_org_id": "CentralBank", "from_user_id": "cb_issuer_demo", "from_custom_account_id": "10109999001234", "transaction_type": "ONHOLD", "holding_id": "ohold~cbdc~USD~12d87129", "category": "issuance", "balance": 35000, "onhold_balance": 10000 }, { "transaction_id": "otransaction~5112f576c94c2d23c342479bfa37e34612414b3258a64b43cf51b920f4ff5868", "transacted_amount": 5000, "timestamp": "2025-08-12T21:05:02.000Z", "token_id": "USD", "transacted_account": "oaccount~cea6080858337b1575d6a76ed0bd07a0eacd8871e3f2f7f793729a0e4b0e8e98", "transacted_org_id": "CentralBank", "transacted_user_id": "cb_retirer_demo", "transacted_custom_account_id": "10109999006543", "to_account": "oaccount~cea6080858337b1575d6a76ed0bd07a0eacd8871e3f2f7f793729a0e4b0e8e98", "to_org_id": "CentralBank", "to_user_id": "cb_retirer_demo", "to_custom_account_id": "10109999006543", "from_account": "oaccount~68d67712f500e9dac8c314c19744003a993250271d960e9b0d25267bb18dfe9a", "from_org_id": "CentralBank", "from_user_id": "cb_issuer_demo", "from_custom_account_id": "10109999001234", "transaction_type": "DEBIT", "category": "burn", "balance": 45000, "onhold_balance": 0 }, { "transaction_id": "otransaction~862aa9d9e877d3ea209b87299ab5b12c13ed5ce43d1cf1b934043c1dd02f58f6", "transacted_amount": 50000, "timestamp": "2025-08-12T21:04:22.000Z", "token_id": "USD", "transacted_account": "oaccount~da6e14466a0ba9b48ebc18fa672addb92dffc371bf953c3229a95b2ff2d9cd41", "transacted_org_id": "CentralBank", "transacted_user_id": "cb__creator_demo", "transacted_custom_account_id": "10105678004567", "to_account": "oaccount~68d67712f500e9dac8c314c19744003a993250271d960e9b0d25267bb18dfe9a", "to_org_id": "CentralBank", "to_user_id": "cb_issuer_demo", "to_custom_account_id": "10109999001234", "from_account": "oaccount~da6e14466a0ba9b48ebc18fa672addb92dffc371bf953c3229a95b2ff2d9cd41", "from_org_id": "CentralBank", "from_user_id": "cb__creator_demo", "from_custom_account_id": "10105678004567", "transaction_type": "CREDIT", "category": "transfer", "balance": 50000, "onhold_balance": 0 } ], "encode": "JSON" } }
-
getCBDCRetiredQuantity
- 元のメソッド名:
getBurnQuantity
- このGETメソッドは、指定した組織のバーン・トークンの合計数量を返します。このメソッドは、
Token Admin
、Token Auditor
またはバーナー・ロールを持つユーザーのみがコールできます。 /getCBDCRetiredQuantity?tokenId={{bc-token-id}}&peer={{peer}}
- パラメータ:
tokenId: string
– トークンのID。peer: string
– 問合せを実行するピア・ノードの名前。
- 戻り値の例:
{ "returnCode": "Success", "error": "", "result": { "payload": { "burnt_quantity": 1200 }, "encode": "JSON" } }
-
getOnHoldIds
- 元のメソッド名:
getOnHoldIds
- このGETメソッドは、指定されたアカウントのすべての保留IDのリストを返します。このメソッドは、チェーンコードの
Token Admin
またはToken Auditor
、指定された組織のOrg Admin
またはOrg Auditor
、またはアカウントのAccountOwner
のみがコールできます。 /getOnHoldIds?accountId=account_id value&peer={{peer}}
- パラメータ:
accountId: string
– アカウントのID。peer: string
– 問合せを実行するピア・ノードの名前。
- 戻り値の例:
{ "returnCode": "Success", "error": "", "result": { "payload": { "msg": "Holding Ids are: ohold~cbdc~USD~8e3147,ohold~cbdc~USD~8e315", "holding_ids": [ "ohold~cbdc~USD~8e3147", "ohold~cbdc~USD~8e315" ] }, "encode": "JSON" } }
-
getPendingCBDCIssuance
- 元のメソッド名:
getPendingIssuance
- このメソッドは、組織の詳細、関係するアカウントのユーザーID (送信者、受信者および公証人)など、コール元が承認者として割り当てられているすべての保留発行(転送)トランザクションを取得します。このメソッドは、チェーンコードの
Token Admin
またはToken Auditor
、Org Admin
またはOrg Auditor
、またはNotary
のみがコールできます。 /getPendingCBDCIssuance?tokenId={{bc-token-id}}&orgId={{bc-org-id}}&peer={{peer}}
- パラメータ:
tokenId: string
– トークンのID。orgId: string
– 現在の組織内のユーザーのメンバーシップ・サービス・プロバイダ(MSP) ID。peer: string
– 問合せを実行するピア・ノードの名前。
- 戻り値の例:
{ "returnCode": "Success", "error": "", "result": { "payload": [ { "asset_type": "ONHOLD", "category": "issuance", "from_account_id": "oaccount~68d67712f500e9dac8c314c19744003a993250271d960e9b0d25267bb18dfe9a", "from_org_id": "CentralBank", "holding_id": "ohold~cbdc~USD~77b75873", "notary_account_id": "oaccount~9b136ef4a60230846a8c14761683851a386d306b79493bc4d00433020c96cfa7", "notary_org_id": "CentralBank", "operation_id": "77b75873", "timetoexpiration": "0", "to_account_id": "oaccount~3954f54a8bc7acdd0c3d0960104240f60d56c26c8a179430267359cd80ce3709", "to_org_id": "org2", "token_id": "USD", "token_name": "cbdc", "quantity": 200 }, { "asset_type": "ONHOLD", "category": "transfer", "from_account_id": "oaccount~68d67712f500e9dac8c314c19744003a993250271d960e9b0d25267bb18dfe9a", "from_org_id": "CentralBank", "holding_id": "ohold~cbdc~USD~e26f11da", "notary_account_id": "oaccount~9b136ef4a60230846a8c14761683851a386d306b79493bc4d00433020c96cfa7", "notary_org_id": "CentralBank", "operation_id": "e26f11da", "timetoexpiration": "0", "to_account_id": "oaccount~76687c724ddbc2d6e6664d9618b2bf1c2a9fe10f84887462447e4caba6aaaff3", "to_org_id": "Org1", "token_id": "USD", "token_name": "cbdc", "quantity": 100 } ], "encode": "JSON" } }
-
getPendingCBDCRequest
- 元のメソッド名:
getPendingRequest
- このメソッドは、コール元が承認者として割り当てられている指定されたタイプの保留中リクエストをすべて取得します。このメソッドは、チェーンコードの
Token Admin
またはToken Auditor
のみがコールできます。または、Notary
。 /getPendingCBDCRequest?tokenId={{bc-token-id}}&requestType=request_type value&orgId={{bc-org-id}}&peer={{peer}}
- パラメータ:
tokenId: string
– トークンのID。requestType: string
– トランザクション・タイプ。たとえば、mint
またはburn
です。orgId: string
– 現在の組織内のユーザーのメンバーシップ・サービス・プロバイダ(MSP) ID。peer: string
– 問合せを実行するピア・ノードの名前。
- 戻り値の例:
{ "returnCode": "Success", "error": "", "result": { "payload": [ { "valueJson": { "assetType": "ohold", "holding_id": "ohold~cbdc~USD~89ce", "operation_id": "89ce", "token_name": "cbdc", "from_org_id": "CentralBank", "operation_type": "mint", "status": "pending", "from_account_id": "oaccount~da6e14466a0ba9b48ebc18fa672addb92dffc371bf953c3229a95b2ff2d9cd41", "to_account_id": "", "notary_account_id": "oaccount~9b136ef4a60230846a8c14761683851a386d306b79493bc4d00433020c96cfa7", "token_id": "USD", "quantity": 2000, "time_to_expiration": "0", "description": "Minting 2000 tokens" } }, { "valueJson": { "assetType": "ohold", "holding_id": "ohold~cbdc~USD~cf73", "operation_id": "cf73", "token_name": "cbdc", "from_org_id": "CentralBank", "operation_type": "mint", "status": "pending", "from_account_id": "oaccount~da6e14466a0ba9b48ebc18fa672addb92dffc371bf953c3229a95b2ff2d9cd41", "to_account_id": "", "notary_account_id": "oaccount~9b136ef4a60230846a8c14761683851a386d306b79493bc4d00433020c96cfa7", "token_id": "USD", "quantity": 200, "time_to_expiration": "0", "description": "Minting 200" } } ], "encode": "JSON" } }
-
getTotalCBDCBalanceByCallerOrgId
- 元のメソッド名:
getTotalBalanceByCallerOrgId
- このメソッドは、呼出し側の組織の合計残高を取得します。このメソッドは、
Token Admin
、Token Auditor
、Org Admin
、Org Auditor
または任意のアカウント所有者によってのみコールできます。 /getTotalCBDCBalanceByCallerOrgId?peer={{peer}}
- パラメータ:
peer: string
– 問合せを実行するピア・ノードの名前。
- 戻り値の例:
{ "returnCode": "Success", "error": "", "result": { "payload": { "totalBalance": 50500 }, "encode": "JSON" } }
-
getTotalCreatedCBDCTokens
- 元のメソッド名:
getTotalMintedTokens
- このメソッドは、指定されたトークンのミントされたトークンの合計数を返します。このメソッドは、
Token Admin
、Token Auditor
、Org Admin
またはOrg Auditor
のみがコールできます。 - 問合せ:
/getTotalCreatedCBDCTokens?tokenId={{bc-token-id}}&peer={{peer}}
- パラメータ:
tokenId: string
– トークンのID。peer: string
– 問合せを実行するピア・ノードの名前。
- 戻り値の例:
{ "returnCode": "Success", "error": "", "result": { "payload": { "msg": "Total minted token for Token Id: USD is 71000 tokens.", "quantity": 71000 }, "encode": "JSON" } }
-
getTransactionWithBlockNumber
- 元のメソッド名:
getTransactionWithBlockNumber
- このGETメソッドは、指定されたトランザクションのIDに対するトランザクションの詳細を返します。
- 問合せ:
/getTransactionWithBlockNumber?tokenId={{bc-token-id}}&transactionId=transaction_id value&peer={{peer}}
- パラメータ:
tokenId: string
– トークンのID。transactionId: string
– トランザクションのID。peer: string
– 問合せを実行するピア・ノードの名前。
- 戻り値の例:
{ "returnCode": "Success", "error": "", "result": { "payload": [ { "blockNo": 340, "key": "otransaction~3140569a4ecb3c3f141cc2468fe21276640b7fd79013d951d9104b79072d8f9c", "metadata": null, "txnNo": 0, "value": null, "valueJson": { "assetType": "otransaction", "blockNo": 336, "txnNo": 1, "transaction_id": "otransaction~3140569a4ecb3c3f141cc2468fe21276640b7fd79013d951d9104b79072d8f9c", "token_id": "USD", "from_account_id": "oaccount~68d67712f500e9dac8c314c19744003a993250271d960e9b0d25267bb18dfe9a", "from_account_balance": 26800, "from_account_onhold_balance": 300, "to_account_id": "oaccount~76687c724ddbc2d6e6664d9618b2bf1c2a9fe10f84887462447e4caba6aaaff3", "transaction_type": "EXECUTE_HOLD_SENDER", "amount": 200, "timestamp": "2025-08-25T13:16:55.000Z", "number_of_sub_transactions": 0, "holding_id": "ohold~cbdc~USD~81d7c4ac", "sub_transaction": "false", "category": "transfer", "global_transaction_id": "b54d4333-f4bb-4ca4-a7b7-cc75b659d912" } } ], "encode": "JSON" } }
-
getUserByCBDCAccountId
- 元のメソッド名:
getUserByAccountId
- このメソッドは、指定されたアカウントのユーザー詳細(
orgId
、userId
およびtokenId
)を返します。このメソッドは、チェーンコードのToken Admin
またはToken Auditor
、あるいは指定された組織のOrg Admin
またはOrg Auditor
のみがコールできます。 - 問合せ:
/getUserByCBDCAccountId?accountId=account_id value&peer={{peer}}
- パラメータ:
accountId: string
– アカウントのID。peer: string
– 問合せを実行するピア・ノードの名前。
- 戻り値の例:
{ "returnCode": "Success", "error": "", "result": { "payload": { "token_id": "USD", "org_id": "CentralBank", "user_id": "cb_admin_demo", "custom_account_id": "10101234000123" }, "encode": "JSON" } }
-
getUsersByRole
- 元のメソッド名:
getUsersByRole
- このGETメソッドは、指定されたロールおよびトークンのすべてのユーザーのリストを戻します。このメソッドは、チェーンコードの
Token Admin
またはToken Auditor
のみがコールできます。 - 問合せ:
/getUsersByRole?tokenId={{bc-token-id}}&role=role value (for example minter / burner / notary)&peer={{peer}}
- パラメータ:
tokenId: string
– トークンのID。role: string
– 検索するロールの名前。peer: string
– 問合せを実行するピア・ノードの名前。
- 戻り値の例:
{ "returnCode": "Success", "error": "", "result": { "payload": { "users": [ { "token_id": "USD", "org_id": "CentralBank" } ] }, "encode": "JSON" } }
-
holdCBDCTokens
- 元のメソッド名:
holdTokens
- このメソッドは、
to_account_id
アカウントを持つトークンの所有者のかわりに保留を作成します。保留の完了または解除を担当する公証人アカウントが指定されます。保留が作成されると、支払者から指定されたトークン残高が保留になります。保留残高は、保留が完了または解除されるまで転送できません。このメソッドのコール元には、すでにアカウントが作成されている必要があります。 - ペイロード:
{ "operationId": "operation_id value", "toAccountId": "to_account_id value", "notaryAccountId": "notary_account_id value", "quantity": 1, "timeToExpiration": "time_to_expiration value", "infoDetails": "{\"category\":\"category value\",\"description\":\"description value\"}", "endorsers": {{endorsers}}, "transientMapArgsFlag": true }
- パラメータ:
operationId: string
– 保留操作を識別する一意のID。通常、このIDはクライアント・アプリケーションによって渡されます。toAccountId: string
– 受信者のアカウントID。notaryAccountId: 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
など)。transientMapArgsFlag
– ブール値です。trueの場合、引数は機密性のために一時マップを介して送信されます。falseの場合、引数は標準ペイロードを介して送信されます。
- 戻り値の例:
{ "returnCode": "Success", "error": "", "result": { "txid": "4793f3907eefce2f9fca7ef107405b0f116efb3afbf83fa0e61fe763690c8235", "payload": { "msg": "AccountId oaccount~76687c724ddbc2d6e6664d9618b2bf1c2a9fe10f84887462447e4caba6aaaff3 is successfully holding 100 tokens" }, "encode": "JSON", "sourceURL": "org1-oabcs1-nrt.blockchain.ocp.example.com:20012", "blockNumber": 343 } }
-
init
- 元のメソッド名:
init
- このメソッドは、チェーンコードがデプロイされるときにコールされます。ユーザー情報は、チェーンコードの
Token Admin
として保存されます。 - ペイロード:
{ "adminList": "[{\"org_id\":\"{{bc-org-id}}\",\"user_id\":\"{{bc-admin-user}}\"}]", "transientMapArgsFlag": true }
- パラメータ:
adminList array
– トークン管理者のリストを指定する{user_id, org_id}
情報の配列。adminList
配列は必須パラメータです。transientMapArgsFlag
– ブール値です。trueの場合、引数は機密性のために一時マップを介して送信されます。falseの場合、引数は標準ペイロードを介して送信されます。
- 戻り値の例:
{ "returnCode": "Success", "error": "", "result": { "txid": "fdb7dc89832c8045a333823b77fa24ae628178148dc93b3550040e070d7cd807", "payload": "", "encode": "UTF-8", "sourceURL": "cb-oabcs1-bom.blockchain.ocp.example.com:20009", "blockNumber": 263 } }
-
initializeCBDCToken
- 元のメソッド名:
initializeCBDCToken
- このメソッドはトークンを作成し、トークン・プロパティを初期化します。アセットとそのプロパティは、状態データベースに保存されます。このメソッドは、チェーンコードの
Token Admin
のみがコールできます。 - ペイロード:
{ "tokenAsset": "{\"token_id\":\"{{bc-token-id}}\",\"token_desc\":\"USD dollar\",\"Currency_Name\":\"US currency\"}", "endorsers": {{endorsers}}, "transientMapArgsFlag": true }
- パラメータ:
tokenAsset: <Token Class>
– トークン・アセットがこのメソッドにパラメータとして渡されます。トークン・アセットのプロパティは、モデル・ファイルに記述されています。endorsers: string[]
– トランザクションを承認する必要があるピアの配列(peer1
、peer2
など)。transientMapArgsFlag
– ブール値です。trueの場合、引数は機密性のために一時マップを介して送信されます。falseの場合、引数は標準ペイロードを介して送信されます。
- 戻り値:
- 成功の場合、作成されたトークン・アセットのJSON表現。
- 戻り値の例:
{ "returnCode": "Success", "error": "", "result": { "txid": "524be506f53ddf27c42db2be2d7d7ed7f8746880c3bf7990605a4b50fe62a616", "payload": { "assetType": "otoken", "events": true, "token_id": "PHP", "token_name": "cbdc", "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 }, "Currency_Name": "Currency_Name value" }, "encode": "JSON", "sourceURL": "centralbank-oabcs1-nrt.blockchain.ocp.example.com:20011", "blockNumber": 344 } }
-
rejectCBDCCreation
- 元のメソッド名:
rejectMint
- このメソッドは、ミント・リクエストを拒否するためにミニター公証人によってコールできます。
- ペイロード:
{ "tokenId": "{{bc-token-id}}", "operationId": "operation_id value", "endorsers": {{endorsers}}, "transientMapArgsFlag": true }
- パラメータ:
tokenId: string
– ミンティングを拒否するトークンのID。operationId: string
– ミント・リクエストを表す一意の操作ID。endorsers: string[]
– トランザクションを承認する必要があるピアの配列(peer1
、peer2
など)。transientMapArgsFlag
– ブール値です。trueの場合、引数は機密性のために一時マップを介して送信されます。falseの場合、引数は標準ペイロードを介して送信されます。
- 戻り値の例:
{ "returnCode": "Success", "error": "", "result": { "txid": "182b99bb2ed753994a8c638ab9b08c3a4e73ac8159a3173a2a1f56b651d2eeac", "payload": { "msg": "Successfully rejected mint request with Operation Id '89ce' to mint 2000 tokens of token id USD" }, "encode": "JSON", "sourceURL": "centralbank-oabcs1-nrt.blockchain.ocp.example.com:20011", "blockNumber": 345 } }
-
rejectCBDCRetirement
- 元のメソッド名:
rejectBurn
- このメソッドは、書き込み要求を拒否するために公証人が呼び出すことができます。
- ペイロード:
{ "tokenId": "{{bc-token-id}}", "operationId": "operation_id value", "endorsers": {{endorsers}}, "transientMapArgsFlag": true }
- パラメータ:
tokenId: string
– 書き込みを拒否するトークンのID。operationId: string
– バーン・リクエストを表す一意の操作ID。endorsers: string[]
– トランザクションを承認する必要があるピアの配列(peer1
、peer2
など)。transientMapArgsFlag
– ブール値。trueの場合、引数は機密性のために一時マップを介して送信されます。falseの場合、引数は標準ペイロードを介して送信されます。
- 戻り値の例:
{ "returnCode": "Success", "error": "", "result": { "txid": "af2cc8e43ecb4c5520d90a8d7955b5a47623a29b13eef47e31c16eb48cc0adec", "payload": { "msg": "Successfully rejected burn request with Operation Id '8d34' to burn 100 tokens of token id USD" }, "encode": "JSON", "sourceURL": "centralbank-oabcs1-nrt.blockchain.ocp.example.com:20011", "blockNumber": 346 } }
-
rejectHoldCBDCTokens
- 元のメソッド名:
releaseHoldTokens
- このPOSTメソッドは、トークンの保留を解除します。転送は行われず、すべての保留トークンは元の所有者が再度使用できます。このメソッドは、指定された時間制限内は
notary
ロールを持つAccountOwner
IDが、指定された時間制限後は支払者、受取人または公証員がコールできます。 - ペイロード:
{ "tokenId": "{{bc-token-id}}", "operationId": "operation_id value", "endorsers": {{endorsers}}, "transientMapArgsFlag": true }
- パラメータ:
tokenId: string
– トークンのID。operationId: string
– 保留操作を識別する一意のID。通常、このIDはクライアント・アプリケーションによって渡されます。endorsers: string[]
– トランザクションを承認する必要があるピアの配列(peer1
、peer2
など)。transientMapArgsFlag
– ブール値です。trueの場合、引数は機密性のために一時マップを介して送信されます。falseの場合、引数は標準ペイロードを介して送信されます。
- 戻り値の例:
{ "returnCode": "Success", "error": "", "result": { "txid": "c628fb7738222ed969295ccc8d21b4be95d96e3aada4f14570f7820a7051b5f7", "payload": { "msg": "Successfully released '200' tokens from Operation Id '77b75873' to Account Id: oaccount~68d67712f500e9dac8c314c19744003a993250271d960e9b0d25267bb18dfe9a (Org-Id: CentralBank, User-Id: cb_issuer_demo)." }, "encode": "JSON", "sourceURL": "centralbank-oabcs1-nrt.blockchain.ocp.example.com:20009", "blockNumber": 347 } }
-
removeCBAdmin
- 元のメソッド名:
removeTokenAdmin
- このPOSTメソッドは、チェーンコードの
Token Admin
であるユーザーを削除します。このメソッドは、チェーンコードのToken Admin
のみがコールできます。管理者は自分自身を削除できません。 - ペイロード:
{ "orgId": "{{bc-org-id}}", "userId": "{{bc-user-id}}", "endorsers": {{endorsers}}, "transientMapArgsFlag": true }
- パラメータ:
orgId: string
– 現在の組織内のユーザーのメンバーシップ・サービス・プロバイダ(MSP) ID。userId: string
– ユーザーのユーザー名または電子メールID。endorsers: string[]
– トランザクションを承認する必要があるピアの配列(peer1
、peer2
など)。transientMapArgsFlag
– ブール値です。trueの場合、引数は機密性のために一時マップを介して送信されます。falseの場合、引数は標準ペイロードを介して送信されます。
- 戻り値の例:
{ "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 } }
-
removeCBAuditor
- 元のメソッド名:
removeTokenAuditor
- このPOSTメソッドは、チェーンコードの
Token Auditor
としてユーザーを削除します。このメソッドは、チェーンコードのToken Admin
のみがコールできます。 - ペイロード:
{ "orgId": "{{bc-org-id}}", "userId": "{{bc-user-id}}", "endorsers": {{endorsers}}, "transientMapArgsFlag": true }
- パラメータ:
orgId: string
– 現在の組織内のユーザーのメンバーシップ・サービス・プロバイダ(MSP) ID。userId: string
– ユーザーのユーザー名または電子メールID。endorsers: string[]
– トランザクションを承認する必要があるピアの配列(peer1
、peer2
など)。transientMapArgsFlag
– ブール値です。trueの場合、引数は機密性のために一時マップを介して送信されます。falseの場合、引数は標準ペイロードを介して送信されます。
- 戻り値の例:
{ "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 } }
-
removeFIAdmin
- 元のメソッド名:
removeOrgAdmin
- このPOSTメソッドは、チェーンコードの
Org Admin
であるユーザーを削除します。このメソッドは、指定した組織のToken Admin
またはOrg Admin
のみがコールできます。Org Admin
自体は削除できません。 - ペイロード:
{ "orgId": "{{bc-org-id}}", "userId": "{{bc-user-id}}", "endorsers": {{endorsers}}, "transientMapArgsFlag": true }
- パラメータ:
orgId: string
– 現在の組織内のユーザーのメンバーシップ・サービス・プロバイダ(MSP) ID。userId: string
– ユーザーのユーザー名または電子メールID。endorsers: string[]
– トランザクションを承認する必要があるピアの配列(peer1
、peer2
など)。transientMapArgsFlag
– ブール値です。trueの場合、引数は機密性のために一時マップを介して送信されます。falseの場合、引数は標準ペイロードを介して送信されます。
- 戻り値の例:
{ "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 } }
-
removeFIAuditor
- 元のメソッド名:
removeOrgAuditor
- このPOSTメソッドは、チェーンコードの
Org Auditor
としてユーザーを削除します。このメソッドは、指定した組織のToken Admin
またはOrg Admin
のみがコールできます。 - ペイロード:
{ "orgId": "{{bc-org-id}}", "userId": "{{bc-user-id}}", "endorsers": {{endorsers}}, "transientMapArgsFlag": true }
- パラメータ:
orgId: string
– 現在の組織内のユーザーのメンバーシップ・サービス・プロバイダ(MSP) ID。userId: string
– ユーザーのユーザー名または電子メールID。endorsers: string[]
– トランザクションを承認する必要があるピアの配列(peer1
、peer2
など)。transientMapArgsFlag
– ブール値です。trueの場合、引数は機密性のために一時マップを介して送信されます。falseの場合、引数は標準ペイロードを介して送信されます。
- 戻り値の例:
{ "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
- このメソッドは、指定されたユーザーおよびトークンからロールを削除します。このメソッドは、チェーンコードの
Token Admin
または指定された組織のOrg Admin
のみがコールできます。 - ペイロード:
{ "accountId": "account_id value", "role": "role value (for example minter / burner / notary)", "endorsers": {{endorsers}}, "transientMapArgsFlag": true }
- パラメータ:
accountId: string
– アカウントのID。role: string
– 指定したユーザーから削除するロールの名前。mintable
およびburnable
の動作は、仕様ファイルのminter_role_name
およびburner_role_name
プロパティに対応します。同様に、notary
ロールは、仕様ファイルのnotary_role_name
プロパティに対応します。endorsers: string[]
– トランザクションを承認する必要があるピアの配列(peer1
、peer2
など)。transientMapArgsFlag
– ブール値です。trueの場合、引数は機密性のために一時マップを介して送信されます。falseの場合、引数は標準ペイロードを介して送信されます。
- 戻り値の例:
{ "returnCode": "Success", "error": "", "result": { "txid": "d92538a8f9cf2d45a0c14307ce192c399230cbf4022cec5dd6ce560cca527bf3", "payload": { "msg": "Successfully removed role 'notary' from Account Id: oaccount~e8450f7a1f320658169315fb4148ad7cb4c47c31435420fd459665f41238221b" }, "encode": "JSON", "sourceURL": "centralbank-oabcs1-nrt.blockchain.ocp.example.com:20010", "blockNumber": 72 } }
-
requestCBDCCreation
- 元のメソッド名:
requestMint
- このメソッドは、指定された量のトークンを作成するために、ミニター公証書にリクエストを送信するためにミニターから呼び出すことができます。
- ペイロード:
{ "operationId": "operation_id value", "notaryAccountId": "notary_account_id value", "quantity": 1, "timeToExpiration": "time_to_expiration value", "infoDetails": "{\"category\":\"category value\",\"description\":\"description value\"}", "endorsers": {{endorsers}}, "transientMapArgsFlag": true }
- パラメータ:
operationId: string
– ミント・リクエストを表す一意の操作ID。notaryAccountId: string
– リクエストを処理するミネータ公証人のアカウントID。quantity: number
– ミントするトークンの量。timeToExpiration
– ミント・リクエストが期限切れになり、有効でなくなるまでの時間。infoDetails: JSON
– 次の例に示すように、リクエストのカテゴリ(category
)および説明(description
)を指定するオブジェクト。{ "category" : "category input", "description" : "description input" }
endorsers: string[]
– トランザクションを承認する必要があるピアの配列(peer1
、peer2
など)。transientMapArgsFlag
– ブール値。trueの場合、引数は機密性のために一時マップを介して送信されます。falseの場合、引数は標準ペイロードを介して送信されます。
- 戻り値の例:
{ "returnCode": "Success", "error": "", "result": { "txid": "1982f73495060e0eef4d78282a91c41e27e8c95572739b0677a1e404a0d20aa9", "payload": { "msg": "AccountId oaccount~da6e14466a0ba9b48ebc18fa672addb92dffc371bf953c3229a95b2ff2d9cd41 has successfully submitted request to mint 200 tokens" }, "encode": "JSON", "sourceURL": "centralbank-oabcs1-nrt.blockchain.ocp.example.com:20009", "blockNumber": 332 } }
-
requestCBDCRetirement
- 元のメソッド名:
requestBurn
- このメソッドは、バーナーがコールして、指定された量のトークンを破棄するリクエストを公証書に送信できます。
- ペイロード:
{ "operationId": "operation_id value", "notaryAccountId": "notary_account_id value", "quantity": 1, "timeToExpiration": "time_to_expiration value", "infoDetails": "{\"category\":\"category value\",\"description\":\"description value\"}", "endorsers": {{endorsers}}, "transientMapArgsFlag": true }
- パラメータ:
operationId: string
– バーン・リクエストを表す一意の操作ID。notaryAccountId: string
– リクエストを処理する公証人のアカウントID。quantity: number
– 書き込むトークンの量。timeToExpiration
– 書き込み要求が期限切れになり、有効でなくなるまでの時間。infoDetails: JSON
– 次の例に示すように、リクエストのカテゴリ(category
)および説明(description
)を指定するオブジェクト。{ "category" : "category input", "description" : "description input" }
endorsers: string[]
– トランザクションを承認する必要があるピアの配列(peer1
、peer2
など)。transientMapArgsFlag
– ブール値です。trueの場合、引数は機密性のために一時マップを介して送信されます。falseの場合、引数は標準ペイロードを介して送信されます。
- 戻り値の例:
{ "returnCode": "Success", "error": "", "result": { "txid": "3b1ba40490dea9bcc4df6ad22ffc7651fbbea5d1889e42a1841ee48d6ae653c6", "payload": { "msg": "AccountId oaccount~cea6080858337b1575d6a76ed0bd07a0eacd8871e3f2f7f793729a0e4b0e8e98 has successfully submitted request to burn 100 tokens" }, "encode": "JSON", "sourceURL": "centralbank-oabcs1-nrt.blockchain.ocp.example.com:20011", "blockNumber": 333 } }
-
setApplicationGroups
- 元のメソッド名:
setApplicationGroups
- このPOSTメソッドは、指定されたアプリケーション・グループのアカウント詳細の
application_groups
パラメータを設定するために使用します。このメソッドは、チェーンコードのToken Admin
または指定された組織のOrg Admin
のみがコールできます。 - ペイロード:
{ "accountId": "account_id value", "applicationGroups": "[\"application_groups value\"]", "endorsers": {{endorsers}}, "transientMapArgsFlag": true }
- パラメータ:
accountId: string
- トークン・アカウントのアカウントID。applicationGroups: string[]
– ユーザーIDが属するアプリケーション・グループのリストで、CBDCアプリケーションでユーザーのアソシエーションを定義します。endorsers: string[]
– トランザクションを承認する必要があるピアの配列(peer1
、peer2
など)。transientMapArgsFlag
– ブール値です。trueの場合、引数は機密性のために一時マップを介して送信されます。falseの場合、引数は標準ペイロードを介して送信されます。
- 戻り値の例:
{ "returnCode": "Success", "error": "", "result": { "txid": "828fd2ece518fcf266868c840b3b1fc6b967c5c64d7591c42eb18c0c7850dc32", "payload": { "bapAccountVersion": 10, "assetType": "oaccount", "account_id": "oaccount~68d67712f500e9dac8c314c19744003a993250271d960e9b0d25267bb18dfe9a", "org_id": "CentralBank", "token_type": "fungible", "token_id": "USD", "token_name": "cbdc", "balance": "02c4601262fa7ece1ffc909811f829ad973d4133ca27c9c0fa82972d441400ad3e", "onhold_balance": "028954d23bfabee1a10d9f5a07793dec08ab0f93fd506079b0fa33f525d527595f", "onhold_burn_balance": "028954d23bfabee1a10d9f5a07793dec08ab0f93fd506079b0fa33f525d527595f", "application_groups": [ "SYSTEM_RETIRERS" ] }, "encode": "JSON", "sourceURL": "centralbank-oabcs1-nrt.blockchain.ocp.example.com:20010", "blockNumber": 348 } }
-
setMaxDailyAmount
- 元のメソッド名:
setMaxDailyAmount
- このPOSTメソッドは、指定された金額のアカウント詳細の
maxDailyAmount
パラメータを設定するために使用します。このメソッドは、チェーンコードのToken Admin
または指定された組織のOrg Admin
のみがコールできます。 - ペイロード:
{ "accountId": "account_id value", "maxDailyAmount": "max_daily_amount value", "endorsers": {{endorsers}}, "transientMapArgsFlag": true }
- パラメータ:
accountId: string
- トークン・アカウントのアカウントID。maxDailyAmount: number
– 指定したアカウントの最大日次金額値。日次取引可能な最大金額を定義します。endorsers: string[]
– トランザクションを承認する必要があるピアの配列(peer1
、peer2
など)。transientMapArgsFlag
– ブール値です。trueの場合、引数は機密性のために一時マップを介して送信されます。falseの場合、引数は標準ペイロードを介して送信されます。
- 戻り値の例:
{ "returnCode": "Success", "error": "", "result": { "txid": "d6a8c26602c2a9cef5d6d563dbc50044af6380c96f7295e2c8e1bbf576cef36f", "payload": { "msg": "Successfully set max daily amount for account id oaccount~68d67712f500e9dac8c314c19744003a993250271d960e9b0d25267bb18dfe9a to 1000000" }, "encode": "JSON", "sourceURL": "centralbank-oabcs1-nrt.blockchain.ocp.example.com:20010", "blockNumber": 351 } }
-
setMaxDailyTransactionCount
- 元のメソッド名:
setMaxDailyTransactionCount
- このPOSTメソッドは、指定された金額のアカウント詳細の
maxDailyTransactions
パラメータを設定するために使用します。このメソッドは、チェーンコードのToken Admin
または指定された組織のOrg Admin
のみがコールできます。 - ペイロード:
{ "accountId": "account_id value", "maxDailyTransactions": "max_daily_transactions value", "endorsers": {{endorsers}}, "transientMapArgsFlag": true }
- パラメータ:
accountId: string
- トークン・アカウントのアカウントID。maxDailyTransactions: number
– 指定された勘定科目の日次最大金額値。1日当たりに許可されるトランザクションの最大数を定義します。endorsers: string[]
– トランザクションを承認する必要があるピアの配列(peer1
、peer2
など)。transientMapArgsFlag
– ブール値です。trueの場合、引数は機密性のために一時マップを介して送信されます。falseの場合、引数は標準ペイロードを介して送信されます。
- 戻り値の例:
{ "returnCode": "Success", "error": "", "result": { "txid": "c819da688bbe9cd4ef6fae79af014c66438b5f9d17f771d3ffc5878288097614", "payload": { "msg": "Successfully set max daily transactions for account id oaccount~68d67712f500e9dac8c314c19744003a993250271d960e9b0d25267bb18dfe9a to 100000" }, "encode": "JSON", "sourceURL": "centralbank-oabcs1-nrt.blockchain.ocp.example.com:20010", "blockNumber": 350 } }
-
suspendCBDCAccount
- 元のメソッド名:
suspendAccount
- このメソッドは、わかりやすいトークン・アカウントを一時停止します。元帳に
accountStatus
値が見つからない場合は、エラーがスローされます。このメソッドは、チェーンコードのToken Admin
または指定された組織のOrg Admin
のみがコールできます。 - ペイロード:
{ "accountId": "account_id value", "endorsers": {{endorsers}}, "transientMapArgsFlag": true }
- パラメータ:
accountId: string
- トークン・アカウントのアカウントID。endorsers: string[]
– トランザクションを承認する必要があるピアの配列(peer1
、peer2
など)。transientMapArgsFlag
– ブール値です。trueの場合、引数は機密性のために一時マップを介して送信されます。falseの場合、引数は標準ペイロードを介して送信されます。
- 戻り値の例:
{ "returnCode": "Success", "error": "", "result": { "txid": "1fa66e75ba2ab9376944a8b4e362d5fe54e167f8ada989bd9653ea54f7557aea", "payload": { "assetType": "oaccountStatus", "status_id": "oaccountStatus~d0b8ba4d154d19fd7e61e7793795a5a5b65e2266102aafdd6d01cec1a3336c71", "account_id": "oaccount~c44ffac4c46718e9744cb0aae2016d26a87a5bef5e2d1c0d1abc7d8782f0ba61", "status": "suspended" }, "encode": "JSON", "sourceURL": "centralbank-oabcs1-nrt.blockchain.ocp.example.com:20011", "blockNumber": 342 } }
-
transferCBDCTokens
- 元のメソッド名:
transferTokens
- このメソッドは、トークンをコール元から指定されたアカウントに転送します。メソッドのコール元にはアカウントが必要です。数量は、仕様ファイルの
divisible
動作のdecimal
パラメータで指定された10進数値内にする必要があります。 - ペイロード:
{ "toAccountId": "to_account_id value", "quantity": 1, "infoDetails": "{\"category\":\"category value\",\"description\":\"description value\"}", "endorsers": {{endorsers}}, "transientMapArgsFlag": true }
- パラメータ:
toAccountId: string
– 受信者のアカウントID。quantity: number
– 転送するトークンの数。infoDetails: JSON
– 次の例に示すように、リクエストのカテゴリ(category
)および説明(description
)を指定するオブジェクト。{ "category" : "category input", "description" : "description input" }
endorsers: string[]
– トランザクションを承認する必要があるピアの配列(peer1
、peer2
など)。transientMapArgsFlag
– ブール値です。trueの場合、引数は機密性のために一時マップを介して送信されます。falseの場合、引数は標準ペイロードを介して送信されます。
- 戻り値の例:
{ "returnCode": "Success", "error": "", "result": { "txid": "62eb436be7c29fc2ed9cae221e874d9a31b163fa10374e7da09bf5e09a96c3ff", "payload": { "msg": "Successfully transferred 10000 tokens from account id: oaccount~da6e14466a0ba9b48ebc18fa672addb92dffc371bf953c3229a95b2ff2d9cd41 to account id: oaccount~68d67712f500e9dac8c314c19744003a993250271d960e9b0d25267bb18dfe9a." }, "encode": "JSON", "sourceURL": "centralbank-oabcs1-nrt.blockchain.ocp.example.com:20010", "blockNumber": 352 } }
ラッパーAPIパッケージには、チェーンコードAPIとOracle Blockchain PlatformコンソールAPIをアカウント作成用の単一のエンドポイントに結合するapproveHoldCBDCTokensInterOrg
およびcreateCBDCAccount
APIも含まれています。
-
approveHoldCBDCTokensInterOrg
- このメソッドは、組織間でトークンを安全に転送します。内部的には、このメソッドはOracle Blockchain Platformの2フェーズ・コミットAPIを使用します。
- ペイロード:
{ "tokenId": "{{bc-token-id}}", "operationId": "operation_id value", "quantity": 1, "senderEndorsers": ["Sender Endorsers values"], "receiverEndorsers": ["Receiver Endorsers values"], "transientMapArgsFlag": true }
- ペイロード・パラメータ:
tokenId: string
– 転送するCBDCトークンのID。トークンIDが元帳に存在する必要があります。operationId: string
– 承認する転送(保留)リクエストの一意の操作ID。quantity: number
– 転送するトークンの数。senderEndorsers: string[]
– トランザクションを承認する必要がある送信者組織内のピアの配列(たとえば、["peer0.senderorg", "peer1.senderorg"]
)。receiverEndorsers: string[]
– トランザクションを承認する必要がある受信者組織内のピアの配列(たとえば、["peer0.receiverorg", "peer1.receiverorg"
)。transientMapArgsFlag
– ブール値です。trueの場合、引数は機密性のために一時マップを介して送信されます。falseの場合、引数は標準ペイロードを介して送信されます。
- 戻り値の例:
{ "returnCode": "Success", "error": "", "result": { "transactions": [ { "channel": "buildtest", "chaincode": "WCBDCConfAug13", "txstatus": "Committed", "prepare": { "txid": "3140569a4ecb3c3f141cc2468fe21276640b7fd79013d951d9104b79072d8f9c", "blockNumber": 335 }, "commit": { "txid": "9cfa020acc13c1de911e8a53eae799f47c1947d88a608753edb4b97fe45d00cc", "blockNumber": 336 }, "rollback": {} }, { "channel": "buildtest", "chaincode": "WCBDCConfAug13", "txstatus": "Committed", "prepare": { "txid": "32137cd7e16c560f4d96d0f8999f6a267c1e95be2f5b11ef0541e574a6cd7275", "blockNumber": 335 }, "commit": { "txid": "ac55bd7648680ff6b795e4a99026d7c538f68167683e1e622e55778a2930614d", "blockNumber": 336 }, "rollback": {} } ], "lrc": {}, "globalStatus": "Success", "globalTxid": "b54d4333-f4bb-4ca4-a7b7-cc75b659d912", "txStartTime": "2025-08-25T13:16:55.825578503Z" } }
-
createCBDCAccount
-
createCBDCAccount
APIは、次の操作を順番に完了します。- Oracle Blockchain Platformにユーザーの登録IDを作成します。作成される登録IDはユーザーIDと同じですが、いくつかの制限があります。IDに使用できるのは、英数字、ハイフン(-)、およびアンダースコア(_)のみです。ユーザーIDにその他の特殊文字が含まれている場合は、アンダースコア(_)に置き換えられます。たとえば、ユーザーIDがadam.fripp@example.comの場合、作成される登録IDはadam_fripp_example_comです。指定したユーザーIDの登録がすでに存在する場合、別の登録は作成されません。
- ペイロードで指定された詳細を使用して元帳に勘定科目を作成します。
- 新しいアカウントをペイロードで指定されたトークンに関連付けます。
- ペイロードで指定されたロールをユーザーに割り当てます。
一貫性を確保し、不完全なデータを回避するために、後続のステップのいずれかが失敗した場合は、最初のステップで作成された登録IDが削除されます。
- ペイロード:
{ "orgId": "{{bc-org-id}}", "userId": "{{bc-user-id}}", "applicationGroups": "[\"applicationGroups value\"]", "customAccountId": "custom_account_id value", "tokenId": "{{bc-token-id}}", "role": "role value (for example minter / burner / notary / tokenAdmin / tokenAuditor / orgAdmin / orgAuditor/ No)", "dailyLimits": "{\"max_daily_amount\":1000, \"max_daily_transactions\":100}", "endorsers": {{endorsers}}, "transientMapArgsFlag": true }
- ペイロード・パラメータ:
orgId
– アカウントを作成するユーザーのメンバーシップ・サービス・プロバイダ(MSP) ID。IDは英数字で始める必要があり、アンダースコア(_)、ピリオド(.)、アットマーク(@)、ハイフン(-)などの文字、数字および特殊文字を含めることができます。userId
– ユーザーのユーザー名または電子メールID。IDは英数字で始める必要があり、アンダースコア(_)、ピリオド(.)、アットマーク(@)、ハイフン(-)などの文字、数字および特殊文字を含めることができます。applicationGroups
– アカウントが属するアプリケーション・グループ。たとえば、System_Admins
です。customAccountId
– 機密モードのチェーンコードを使用するアカウントの一意のランダムID。tokenId
– アカウントに関連付けられたトークンのID。IDは英数字で始める必要があり、文字、数字、特殊文字のアンダースコア(_)およびハイフン(-)を含めることができます。16文字の長さを超えることはできません。role
– ロールは、minter
、burner
、notary
、tokenAdmin
、tokenAuditor
、orgAdmin
またはorgAuditor
のいずれかの値である必要があります。dailyLimits
– 日次トランザクション制限を定義する2つの数値フィールド、max_daily_amount
およびmax_daily_transactions
。endorsers: string[]
– トランザクションを承認する必要があるピアの配列(peer1
、peer2
など)。transientMapArgsFlag
– ブール値です。trueの場合、引数は機密性のために一時マップを介して送信されます。falseの場合、引数は標準ペイロードを介して送信されます。
- 戻り値の例:
"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, "application_groups": [ "CBDC_CREATORS" ], "max_daily_amount": 1000, "daily_amount": 0, "max_daily_transactions": 100, "daily_transactions": 0, "current_date": "2024-10-06T00:00:00.000Z" } }