StablecoinラッパーAPIパッケージ

この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
    }
}

このメソッドは、トークン・チェーンコードに組織管理者を追加します。このメソッドは、指定した組織の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
    }
}

このメソッドは、組織監査者をトークン・チェーンコードに追加します。このメソッドは、指定した組織の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
    }
}

このメソッドは、指定されたユーザーおよびトークンにロールを追加します。アカウント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
    }
}

この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
    }
}

この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
    }
}

Notariesは、このPOSTメソッドを呼び出して書き込みリクエストを承認できます。

ペイロード:

{
    "tokenId": "{{bc-token-id}}",
    "operationId": "operation_id value",
    "sameOrgEndorser": true
}

パラメータ:

tokenId: string – トークンのID。
operationId: string– 承認するミント・リクエストの一意の操作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
    }
}

Notariesは、このPOSTメソッドをコールしてmintリクエストを承認できます。

ペイロード:

{
    "tokenId": "{{bc-token-id}}",
    "operationId": "operation_id value",
    "sameOrgEndorser": true
}

パラメータ:

tokenId: string – トークンのID。
operationId: string– 承認するミント・リクエストの一意の操作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
    }
}

承認者は、この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
    }
}

この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
    }
}

このメソッドは、トークンを呼出し元アカウントからflowオブジェクトで指定されたアカウントに一括で転送します。数量は、仕様ファイルのdivisible動作のdecimalパラメータで指定された10進数値内にする必要があります。

ペイロード:

{
    "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 Code:
```
[
  { "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
    }
}

このメソッドは、指定されたユーザーおよびトークンのアカウントを作成します。任意の時点でトークンを持つすべてのユーザーに対してアカウントを作成する必要があります。アカウントは、残高、保留残高およびトランザクション履歴を追跡します。アカウント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
    }
}

このメソッドは、トランザクションしきい値および必要な順次承認者を定義する新しい承認ポリシーを作成します。このメソッドは、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
    }
}

このメソッドは、指定されたアカウントのポリシーを作成します。このメソッドは、指定した組織の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– このIDは、指定されたorgIdおよびuserIdフィールドから生成されます。このフィールドは手動で指定しません。
- orgId– ポリシーを作成するユーザーのメンバーシップ・サービス・プロバイダ(MSP) ID。
- userId– ポリシーを作成するユーザーのユーザー名または電子メールID。
- kycCompliance– アカウントがKYC (Know Your Customer)要件を満たしているかどうかを示すブール値。
- 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
    }
}

このメソッドは、指定されたポリシー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
    }
}

このメソッドは、わかりやすいトークン・アカウントを削除します。元帳で勘定科目の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
    }
}

このメソッドは、指定されたポリシー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
    }
}

このメソッドはトークンの保留を承認します。これにより、送信者から受信者へのトークンの転送がトリガーされます。トークン所有者が以前に保留したトークンの数量が受信者に転送されるようになりました。quantity値が実際の保留値より小さい場合、残りはトークンの所有者が再度使用できます。トークン・モデルのbehaviorsセクションでroles動作が指定され、notary_role_name値が設定されている場合、呼出し側アカウントには公証人ロールが必要です。そうしないと、アカウントを持つすべての発信者が公証人として機能します。

ペイロード:

{
    "tokenId": "{{bc-token-id}}",
    "operationId": "operation_id value",
    "quantity": 1,
    "endorsers": {{endorsers}}
}

パラメータ:

tokenId: string – トークンのID。
operationId: string– 承認するミント・リクエストの一意の操作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
    }
}

このメソッドは、指定されたユーザーおよびトークンのアカウント・トランザクション履歴詳細の配列を返します。このメソッドは、チェーンコードの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"
    }
}

このメソッドは、すべてのアカウントのリストを返します。このメソッドは、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"
    }
}

このメソッドは、指定された組織に属するすべてのトークン・アカウントのリストを返します。このメソッドは、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"
    }
}

このメソッドは、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"
    }
}

このメソッドは、状態データベースに格納されているすべてのトークンを返します。このメソッドは、Token Admin、Token Auditor、Org AdminまたはOrg Auditorのみがコールできます。このメソッドでは、Berkeley DB SQLリッチ問合せが使用され、リモート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"
    }
}

このメソッドは、指定されたポリシー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"
    }
}

このメソッドは、指定されたトランザクション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"
    }
}

この方法では、指定された振替金額に必要な承認者詳細を取得します。このメソッドは、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
    }
}

この方法では、指定された勘定科目の日次累積最大トランザクション金額を取得します。このメソッドは、チェーンコードの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"
    }
}

このメソッドは、指定された勘定科目の日次トランザクションの最大数を取得します。このメソッドは、チェーンコードの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"
    }
}

この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"
    }
}

このメソッドは、指定された操作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"
    }
}

このメソッドは、指定された操作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"
    }
}

この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"
    }
}

このメソッドは、指定された組織内の指定されたロールを持つすべてのアカウントに関する情報を返します。このメソッドは、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"
    }
}

このメソッドは、組織の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"
    }
}

このメソッドは、組織の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"
    }
}

このメソッドは、指定された組織内の指定されたロールを持つすべてのユーザーに関する情報を返します。このメソッドは、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"
    }
}

この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"
    }
}

この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"
    }
}

このメソッドは、指定されたアカウントおよびトークンの現在の保留残高を返します。このメソッドは、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"
    }
}

このメソッドは、指定されたユーザーの保留バーン・バランスを返します。このメソッドは、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"
    }
}

このメソッドは、指定されたポリシー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
    }
}

このメソッドは、指定されたロールおよびトークンのすべてのアカウント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"
    }
}

このメソッドは、指定された組織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"
    }
}

このメソッドは、トークン・アカウントの現在のステータスを取得します。このメソッドは、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"
    }
}

このメソッドは、リッチ履歴データベースから勘定科目トランザクション履歴詳細を返します。このメソッドは、チェーンコードの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– トランザクション履歴のフェッチ元となるリッチ履歴データベースのRESTfulサービス・エンドポイント。
bearerToken– リクエストが認可されていることを確認するためにRESTfulエンドポイントをコールするために使用するトークン。
filters: JSON object– オプションのパラメータ。空の場合は、すべてのレコードが返されます。pageSizeプロパティは、返すレコード数を決定します。pageSizeが0の場合、デフォルトのページ・サイズは20です。bookmarkプロパティは、返すレコードの開始索引を決定します。startTimeおよびendTimeプロパティは、RFC-3339形式で指定する必要があります。

戻り値の例:

{
    "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"
    }
}

このメソッドは、チェーンコードのすべての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"
    }
}

このメソッドは、指定されたトークン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"
    }
}

このメソッドは、指定されたトークン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"
    }
}

このメソッドは、指定されたトークンのミントされたトークンの合計数を返します。このメソッドは、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"
    }
}

このメソッドは、指定されたトランザクション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"
    }
}

このメソッドは、指定されたアカウントのユーザー詳細(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"
    }
}

この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"
    }
}

このメソッドは、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
    }
}

このメソッドは、チェーンコードがデプロイされるときにコールされます。ユーザー情報は、チェーンコードのToken Adminとして保存されます。

ペイロード:

{
    "adminList": "[{\"org_id\":\"{{bc-org-id}}\",\"user_id\":\"{{bc-admin-user}}\"}]"
}

パラメータ:

adminList: TokenAdminAsset[]– トークン管理者を指定する組織IDおよびユーザーIDを含むJSONオブジェクトの配列で、次の形式を使用します。
```
{
   "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
    }
}

このメソッドはトークンを作成し、トークン・プロパティを初期化します。アセットとそのプロパティは、状態データベースに保存されます。このメソッドは、チェーンコードの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
    }
}

このメソッドは、ユーザーとトークンに指定したロールがあるかどうかを示すブール値を返します。このメソッドは、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"
    }
}

このメソッドは、指定されたアカウントが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"
    }
}

このメソッドは、書き込み要求を拒否するために公証人が呼び出すことができます。

ペイロード:

{
    "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
    }
}

このメソッドは、ミント要求を拒否するために公証人が呼び出すことができます。

ペイロード:

{
    "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
    }
}

この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
    }
}

この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
    }
}

この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
    }
}

このメソッドは、指定されたユーザーおよびトークンから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
    }
}

この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
    }
}

この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
    }
}

このメソッドは、バーナーがコールして、指定された量のトークンを破棄するリクエストを公証書に送信できます。

ペイロード:

{
    "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
    }
}

このメソッドは、指定された量のトークンを作成するために、ミニター公証書にリクエストを送信するためにミニターから呼び出すことができます。

ペイロード:

{
    "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
    }
}

この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
    }
}

この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– 指定された勘定科目の日次最大金額値。1日当たりに許可されるトランザクションの最大数を定義します。
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
    }
}

このメソッドは、わかりやすいトークン・アカウントを一時停止します。元帳に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
    }
}

このメソッドは、トークンをコール元から指定されたアカウントに転送します。メソッドのコール元にはアカウントが必要です。数量は、仕様ファイルのdivisible動作のdecimalパラメータで指定された10進数値内にする必要があります。

ペイロード:

{
    "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
    }
    }

このメソッドは、指定されたアカウントのポリシーを更新します。このメソッドは、指定した組織の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 (Know Your Customer)要件を満たしているかどうかを示すブール値。
- 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
    }
}

このメソッドは、承認ポリシーを更新します。このメソッドは、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
    }
}

このメソッドはstablecoinトークンを更新します。このメソッドは、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 Code: 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
    }
}

このカスタム・ラッパーAPIは、チェーンコードAPIとOracle Blockchain PlatformコンソールAPIを1つのエンドポイントに結合します。この方法では、次のステップが順番に完了します。

インスタンスのRESTプロキシでユーザーの登録IDを作成します。ユーザーIDの登録がすでに存在する場合、登録は再作成されません。登録IDはユーザーIDと同じです。登録IDに使用できるのは、英数字、ハイフン(-)およびアンダースコア(_)のみです。ユーザーIDにその他の特殊文字が含まれている場合は、アンダースコア(_)に置き換えられます。
元帳に勘定科目を作成します。
新しいアカウントを指定されたトークンに関連付けます。
指定されたロールをユーザーに割り当てます。

いずれかのステップが失敗した場合、登録は自動的に削除されます。

ペイロード:

{
    "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"
     }
 }

この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"
}