Stablecoin Wrapper API-Paket

Oracle Blockchain Platform Digital Assets Edition umfasst ein Wrapper-API-Package, mit dem die REST-API erweitert wird, um Vorgänge zu unterstützen, die für den Lebenszyklus eines Stablecoins spezifisch sind.

Das Wrapper-API-Package verwendet den API-Gateway-Service und OCI Functions, um API-Routen speziell für die Verwaltung des Stablecoin-Lebenszyklus bereitzustellen. Das Stablecoin-Wrapper-API-Package kann von der Oracle Blockchain Platform-Konsole heruntergeladen werden. Es enthält eine Archivdatei, die das Wrapper-API-Package einschließlich der für das Deployment erforderlichen Terraform-Skripte enthält. Sie stellen diese Datei in einem Resource Manager-Stack auf Oracle Cloud Infrastructure (OCI) bereit, um die erforderlichen Oracle-Ressourcen für die Wrapper-APIs zu erstellen. Es enthält auch eine Postman-Collection, mit der Sie die bereitgestellten Wrapper-APIs testen können. Die Sammlung umfasst vorkonfigurierte Anforderungen mit Endpunkten und Payloads, die den im Wrapper-API-Package definierten APIs entsprechen.

Wrapper-APIs

activateStablecoinAccount

Ursprünglicher Methodenname: activateAccount

Diese POST-Methode aktiviert ein fungibles Tokenkonto. Diese Methode kann nur von einem Token Admin oder Org Admin der angegebenen Organisation aufgerufen werden. Gelöschte Accounts können nicht aktiviert werden.

Payload:

{
    "tokenId": "{{bc-token-id}}",
    "orgId": "{{bc-org-id}}",
    "userId": "{{bc-user-id}}",
    "endorsers": {{endorsers}}
}

Parameter:

• tokenId: string: Die ID des Tokens.
• orgId: string: Die Mitgliedsdienstanbieter-(MSP-)ID des Benutzers in der aktuellen Organisation.
• userId: string: Der Benutzername oder die E-Mail-ID des Benutzers.
• endorsers: string[]: Ein Array der Peers (z.B. peer1, peer2), das die Transaktion freigeben muss.

Rückgabewert:

• Bei Erfolg eine JSON-Darstellung des Accountstatusobjekts für den angegebenen Tokenaccount.

Beispiel für Rückgabewert:

{
    "returnCode": "Success",
    "error": "",
    "result": {
        "txid": "6cea484aa4e311b3913e7706c668d1e7df1531b7561f4777ab8550542be18b5d",
        "payload": {
            "assetType": "oaccountStatus",
            "status_id": "oaccountStatus~cfe302f06bf732f248315725bb601d7906d7c1d4c167d04ac3a5283b8dbc7fc4",
            "account_id": "oaccount~374e4e762940fc185c7cd5b6528c7f94985b6c56acf46abb746de6381589edd2",
            "status": "active"
        },
        "encode": "JSON",
        "sourceURL": "cb-oabcs1-bom.blockchain.ocp.example.com:20010",
        "blockNumber": 294
    }
}

addOrgAdmin

Ursprünglicher Methodenname: addOrgAdmin

Diese Methode fügt dem Token-Chaincode Organisationsadministratoren hinzu. Diese Methode kann nur von einem Token Admin oder Org Admin der angegebenen Organisation aufgerufen werden.

Payload:

{
    "orgId": "{{bc-org-id}}",
    "userId": "{{bc-user-id}}",
    "sameOrgEndorser": true
}

Parameter:

• orgId: string: Die Mitgliedsdienstanbieter-(MSP-)ID des Benutzers in der aktuellen Organisation.
• userId: string: Der Benutzername oder die E-Mail-ID des Benutzers.
• sameOrgEndorser: boolean: Ein boolescher Wert, der angibt, ob Transaktionsbestätigungen von derselben Organisation wie der Anforderer stammen müssen.

Beispiel für Rückgabewert:

{
    "returnCode": "Success",
    "error": "",
    "result": {
        "txid": "96a84dffcb9156f7271dfb414e8c43b540595044cf9145f5fd56e9873797fc4a",
        "payload": {
            "msg": "Successfully added Org Admin (Org_Id: CB, User_Id: cb)"
        },
        "encode": "JSON",
        "sourceURL": "cb-oabcs1-bom.blockchain.ocp.example.com:20009",
        "blockNumber": 197
    }
}

addOrgAuditor

Ursprünglicher Methodenname: addOrgAuditor

Diese Methode fügt dem Token Chaincode Organisationsauditoren hinzu. Diese Methode kann nur von einem Token Admin oder Org Admin der angegebenen Organisation aufgerufen werden.

Payload:

{
    "orgId": "{{bc-org-id}}",
    "userId": "{{bc-user-id}}",
    "sameOrgEndorser": true
}

Parameter:

• orgId: string: Die Mitgliedsdienstanbieter-(MSP-)ID des Benutzers in der aktuellen Organisation.
• userId: string: Der Benutzername oder die E-Mail-ID des Benutzers.
• sameOrgEndorser: boolean: Ein boolescher Wert, der angibt, ob Transaktionsbestätigungen von derselben Organisation wie der Anforderer stammen müssen.

Beispiel für Rückgabewert:

{
    "returnCode": "Success",
    "error": "",
    "result": {
        "txid": "44bbad35a1478cb714e32f7cfd551897868a203520aab9cea5771d3aadc1cf03",
        "payload": {
            "msg": "Successfully added Org Auditor (Org_Id: CB, User_Id: cb)"
        },
        "encode": "JSON",
        "sourceURL": "cb-oabcs1-bom.blockchain.ocp.example.com:20009",
        "blockNumber": 198
    }
}

addRole

Ursprünglicher Methodenname: addRole

Diese Methode fügt die Rolle dem angegebenen Benutzer und Token hinzu. Konto-IDs werden gebildet, indem ein SHA-256-Hash der zusammengesetzten Token-ID, Organisations-ID und Benutzer-ID erstellt wird. Diese Methode kann nur von einem Token Admin oder Org Admin der angegebenen Organisation aufgerufen werden.

Payload:

{
    "tokenId": "{{bc-token-id}}",
    "role": "role value (for example minter / burner / notary)",
    "orgId": "{{bc-org-id}}",
    "userId": "{{bc-user-id}}",
    "endorsers": {{endorsers}}
}

Parameter:

• tokenId: string: Die ID des Tokens.
• role: string: Der Name der Rolle, die dem angegebenen Benutzer hinzugefügt werden soll. Die Eigenschaften mintable und burnable sind entsprechend an die Eigenschaften minter_role_name und burner_role_name in der Spezifikationsdatei gebunden. Ebenso ist das Notarverhalten an die Eigenschaft notary_role_name in der Spezifikationsdatei gebunden.
• orgId: string: Die Mitgliedsdienstanbieter-(MSP-)ID des Benutzers in der aktuellen Organisation.
• userId: string: Der Benutzername oder die E-Mail-ID des Benutzers.
• endorsers: string[]: Ein Array der Peers (z.B. peer1, peer2), das die Transaktion freigeben muss.

Beispiel für Rückgabewert:

{
    "returnCode": "Success",
    "error": "",
    "result": {
        "txid": "29ea766dee8e6d273eba3c40a9fea75a1aa85dc3c280d40695f6224c5c52d93c",
        "payload": {
            "msg": "Successfully added role 'notary' to Account Id: oaccount~2eb5f8a9bc561f8f41a4ea3be9511958cc6684ef14f2337ca396efc301b627d8 (Org-Id: CB, User-Id: manager_user_cb)"
        },
        "encode": "JSON",
        "sourceURL": "cb-oabcs1-bom.blockchain.ocp.example.com:20009",
        "blockNumber": 201
    }
}

addTokenAdmin

Ursprünglicher Methodenname: addTokenAdmin

Diese POST-Methode fügt einen Benutzer als Token Admin des Token-Chaincodes hinzu. Die Methode kann nur von einem Token Admin des Token-Chaincodes aufgerufen werden. Der erste Aufruf erfolgt vom Administrator, der den Chaincode instanziiert.

Payload:

{
    "orgId": "{{bc-org-id}}",
    "userId": "{{bc-user-id}}",
    "sameOrgEndorser": true
}

Parameter:

• orgId: string: Die Mitgliedsdienstanbieter-(MSP-)ID des Benutzers in der aktuellen Organisation.
• userId: string: Der Benutzername oder die E-Mail-ID des Benutzers.
• sameOrgEndorser: boolean: Ein boolescher Wert, der angibt, ob Transaktionsbestätigungen von derselben Organisation wie der Anforderer stammen müssen.

Beispiel für Rückgabewert:

{
    "returnCode": "Success",
    "error": "",
    "result": {
        "txid": "bd7416689b1acdace3c557faebbc0ad9a51671c10278ba6909350a6fe4b08eed",
        "payload": {
            "msg": "User (Org_Id: CB, User_Id: cb) is already Token Admin."
        },
        "encode": "JSON",
        "sourceURL": "cb-oabcs1-bom.blockchain.ocp.example.com:20009",
        "blockNumber": 193
    }
}

addTokenAuditor

Ursprünglicher Methodenname: addTokenAuditor

Diese POST-Methode fügt dem Token-Chaincode Token-Auditoren hinzu. Diese Methode kann nur von der Token Admin des Chaincodes aufgerufen werden.

Payload:

{
    "orgId": "{{bc-org-id}}",
    "userId": "{{bc-user-id}}",
    "sameOrgEndorser": true
}

Parameter:

• orgId: string: Die Mitgliedsdienstanbieter-(MSP-)ID des Benutzers in der aktuellen Organisation.
• userId: string: Der Benutzername oder die E-Mail-ID des Benutzers.
• sameOrgEndorser: boolean: Ein boolescher Wert, der angibt, ob Transaktionsbestätigungen von derselben Organisation wie der Anforderer stammen müssen.

Beispiel für Rückgabewert:

{
    "returnCode": "Success",
    "error": "",
    "result": {
        "txid": "cd81f6c4c9e7c18ece357dbf5c139ef66ef2d6566be3b14de5f6d0a3fd4bb2f0",
        "payload": {
            "msg": "Successfully added Token Auditor (Org_Id: CB, User_Id: cb)"
        },
        "encode": "JSON",
        "sourceURL": "cb-oabcs1-bom.blockchain.ocp.example.com:20009",
        "blockNumber": 196
    }
}

approveBurn

Ursprünglicher Methodenname: approveBurn

Notare können diese POST-Methode aufrufen, um eine Burn-Anforderung zu genehmigen.

Payload:

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

Parameter:

• tokenId: string: Die ID des Tokens.
• operationId: string: Die eindeutige Vorgangs-ID der zu genehmigenden Mint-Anforderung.
• sameOrgEndorser: boolean: Ein boolescher Wert, der angibt, ob Transaktionsbestätigungen von derselben Organisation wie der Anforderer stammen müssen.

Beispiel für Rückgabewert:

{
    "returnCode": "Success",
    "error": "",
    "result": {
        "txid": "8252371040e41753fd843bd086692f4e1ee7d89ffa3a50bfa121c5f1565f922f",
        "payload": {
            "msg": "Successfully burned 1 tokens from account id: oaccount~0d7b3f73aea28065017ce8b79c0bb19256dc0cb475a0b2a85192bd110f69535c (Org-Id: CB, User-Id: retirer_user_cb)"
        },
        "encode": "JSON",
        "sourceURL": "cb-oabcs1-bom.blockchain.ocp.example.com:20009",
        "blockNumber": 209
    }
}

approveMint

Ursprünglicher Methodenname: approveMint

Notare können diese POST-Methode aufrufen, um eine Mint-Anforderung zu genehmigen.

Payload:

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

Parameter:

• tokenId: string: Die ID des Tokens.
• operationId: string: Die eindeutige Vorgangs-ID der zu genehmigenden Mint-Anforderung.
• sameOrgEndorser: boolean: Ein boolescher Wert, der angibt, ob Transaktionsbestätigungen von derselben Organisation wie der Anforderer stammen müssen.

Beispiel für Rückgabewert:

{
    "returnCode": "Success",
    "error": "",
    "result": {
        "txid": "a4537ef34a955b023b7c205b9abf06a6c79e4fdd761fb24f41b8eb34126b66c0",
        "payload": {
            "msg": "Successfully minted 10 tokens to Account Id: oaccount~9d9806fa92aa0c4fdb34eaffac6e830181b5d47e64fbce752195e83024125ca0 (Org-Id: CB, User-Id: creator_user_cb)"
        },
        "encode": "JSON",
        "sourceURL": "cb-oabcs1-bom.blockchain.ocp.example.com:20009",
        "blockNumber": 204
    }
}

approveTransaction

Ursprünglicher Methodenname: approveTransaction

Genehmiger können diese POST-Methode aufrufen, um eine Sperrestransaktion zu genehmigen.

Payload:

{
    "tokenId": "{{bc-token-id}}",
    "orgId": "{{bc-org-id}}",
    "userId": "{{bc-user-id}}",
    "endorsers": {{endorsers}}
}

Parameter:

• tokenId: string: Die ID des Tokens.
• orgId: string: Die Mitgliedsdienstanbieter-(MSP-)ID des Benutzers.
• userId: string: Der Benutzername oder die E-Mail-ID des Benutzers.
• endorsers: string[]: Ein Array der Peers (z.B. peer1, peer2), das die Transaktion freigeben muss.

Beispiel für Rückgabewert:

{
    "returnCode": "Success",
    "error": "",
    "result": {
        "txid": "44685b0ff1b0ee72d57cb62900aae30638d65c82f264d5de7b28375732171702",
        "payload": {
            "assetType": "ApprovalTransactions",
            "approvalTransactionId": "hold1~oaccount~1cf5d40c7ea7b9dceedfc66292ab843c1583564c3ecaf9f5ceb11f834018b02f",
            "approvalOperationId": "hold1",
            "fromAccountId": "oaccount~374e4e762940fc185c7cd5b6528c7f94985b6c56acf46abb746de6381589edd2",
            "toAccountId": "oaccount~79c427e614530eacad6fb07cff6048f6b96283e65019301320c9684932846f64",
            "approverAccountId": "oaccount~1cf5d40c7ea7b9dceedfc66292ab843c1583564c3ecaf9f5ceb11f834018b02f",
            "totalApprovals": 1,
            "timestamp": "2025-11-21T12:32:43.000Z"
        },
        "encode": "JSON",
        "sourceURL": "centralbank-oabcs1-nrt.blockchain.ocp.example.com:20010",
        "blockNumber": 289
    }
}

associateTokenToAccount

Ursprünglicher Methodenname: associateTokenToAccount

Diese POST-Methode ordnet einem angegebenen Token eine angegebene Konto-ID zu. Diese Methode kann nur von einem Token Admin oder Org Admin der angegebenen Organisation aufgerufen werden.

Payload:

{
    "accountId": "account_id value",
    "tokenId": "{{bc-token-id}}",
    "endorsers": {{endorsers}}
}

Parameter:

• accountId: string: Die ID des Kontos.
• tokenId: string: Die ID des Tokens.
• endorsers: string[]: Ein Array der Peers (z.B. peer1, peer2), das die Transaktion freigeben muss.

Beispiel für Rückgabewert:

{
    "returnCode": "Success",
    "error": "",
    "result": {
        "txid": "efc7381fb6fc6174a40e83ff5f09d2bbf7f6f490365e3bbf19d5502c2cfec474",
        "payload": {
            "bapAccountVersion": 0,
            "assetType": "oaccount",
            "account_id": "oaccount~1c6aa60e220b8fc70caf4cea1ed723ddb193a00321e5e0004def062816b77090",
            "user_id": "cb12",
            "org_id": "CB",
            "token_type": "fungible",
            "token_id": "USD",
            "token_name": "Stablecoin",
            "balance": 0,
            "onhold_balance": 0,
            "max_daily_amount": 10000,
            "daily_amount": 0,
            "max_daily_transactions": 100,
            "daily_transactions": 0,
            "current_date": "2024-12-11T00:00:00.000Z"
        },
        "encode": "JSON",
        "sourceURL": "cb-oabcs1-bom.blockchain.ocp.example.com:20010",
        "blockNumber": 216
    }
}

bulkTransferTokens

Ursprünglicher Methodenname: bulkTransferTokens

Diese Methode überträgt Token im Massenverfahren vom aufrufenden Konto auf die Konten, die im Objekt flow angegeben sind. Die Mengen müssen innerhalb der Dezimalwerte liegen, die durch den Parameter decimal des Verhaltens divisible in der Spezifikationsdatei angegeben werden.

Payload:

{
    "tokenId": "{{bc-token-id}}",
    "flow": "[flow value]",
    "endorsers": {{endorsers}}
}

Parameter:

• token_id: string: Die ID des Tokens.
• flow : object[]: Ein Array von JSON-Objekten, das Empfänger und Mengen angibt.
  • to_orgId: string: Die MSP-ID (Member Service Provider) des Empfängers in der aktuellen Organisation.
  • userId: string: Der Benutzername oder die E-Mail-ID des Empfängers.
  • quantity: number: Die Anzahl der zu übertragenden Token.
  Sie geben den Parameter flow in einem anderen Format an, wenn Sie Visual Studio Code im Vergleich zur CLI oder Postman-Collection verwenden.
  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[]: Ein Array der Peers (z.B. peer1, peer2), das die Transaktion freigeben muss.

Beispiel für Rückgabewert:

{
    "returnCode": "Success",
    "error": "",
    "result": {
        "txid": "ad6a9555e6512ffe4bd3500d0942e171deadc1d724cd80da7179e39e1d05aa4e",
        "payload": {
            "msg": "Successfully transferred 10 tokens from Account Id 'oaccount~374e4e762940fc185c7cd5b6528c7f94985b6c56acf46abb746de6381589edd2' (Org-Id: CentralBank, User-Id: cb__creator_demo).",
            "from_account_id": "oaccount~374e4e762940fc185c7cd5b6528c7f94985b6c56acf46abb746de6381589edd2",
            "sub_transactions": [
                {
                    "to_account_id": "oaccount~79c427e614530eacad6fb07cff6048f6b96283e65019301320c9684932846f64",
                    "amount": 5
                },
                {
                    "to_account_id": "oaccount~09abdd306d4fcbc1b794e2e0b8fc4ce3d8282e11846ef35d675cc9540da4ad1b",
                    "amount": 5
                }
            ]
        },
        "encode": "JSON",
        "sourceURL": "cb-oabcs1-bom.blockchain.ocp.example.com:20009",
        "blockNumber": 302
    }
}

createAccount

Ursprünglicher Methodenname: createAccount

Mit dieser Methode wird ein Account für einen angegebenen Benutzer und ein bestimmtes Token erstellt. Ein Konto muss für jeden Benutzer erstellt werden, der zu einem beliebigen Zeitpunkt Token hat. Konten verfolgen Salden, einbehaltene Salden und die Transaktionshistorie. Eine Konto-ID wird gebildet, indem der Assettyp, die Token-ID und ein SHA-256-Hash der Benutzer-ID und der Organisations-ID (Mitgliedschaftsserviceanbieter) verkettet werden. Diese Methode kann nur durch eine Token Admin des Chaincodes oder durch eine Org Admin der angegebenen Organisation aufgerufen werden.

Payload:

{
    "orgId": "{{bc-org-id}}",
    "userId": "{{bc-user-id}}",
    "tokenType": "fungible",
    "dailyLimits": "{\"max_daily_amount\":10000,\"max_daily_transactions\":100}",
    "endorsers": {{endorsers}}
}

Parameter:

• orgId - Die Mitgliedsdienstanbieter-(MSP-)ID des Benutzers, für den das Konto erstellt werden soll. Die ID muss mit einem alphanumerischen Zeichen beginnen und kann Buchstaben, Zahlen und Sonderzeichen wie Unterstriche (_), Punkte (.), At-Zeichen (@) und Bindestriche (-) enthalten.
• userId: Der Benutzername oder die E-Mail-ID des Benutzers. Die ID muss mit einem alphanumerischen Zeichen beginnen und kann Buchstaben, Zahlen und Sonderzeichen wie Unterstriche (_), Punkte (.), At-Zeichen (@) und Bindestriche (-) enthalten.
• tokenType: TokenType: Der Tokentyp, der fungible sein muss.
• dailyLimits: JSON object: Ein JSON-Objekt des folgenden Typs.

  {
       "max_daily_amount": 100000
       "max_daily_transactions": 10000
   }

  Im Beispiel ist der Wert max_daily_amount die maximale Anzahl von Token, die täglich ausgeführt werden können, und der Wert max_daily_transactions ist die maximale Anzahl von Transaktionen, die täglich abgeschlossen werden können.
• endorsers: string[]: Ein Array der Peers (z.B. peer1, peer2), das die Transaktion freigeben muss.

Beispiel für Rückgabewert:

{
    "returnCode": "Success",
    "error": "",
    "result": {
        "txid": "453821c7ffd477987ef8ccbd836b893969531ab768098cd4a99e3b89cd38a391",
        "payload": {
            "bapAccountVersion": 0,
            "assetType": "oaccount",
            "account_id": "oaccount~28ac774001f374064029d51af4fb67e26ea1ea9ef62828b7a72dbf3beb8efd8d",
            "user_id": "admin_user_cb",
            "org_id": "CB",
            "token_type": "fungible",
            "token_id": "",
            "token_name": "",
            "balance": 0,
            "onhold_balance": 0,
            "max_daily_amount": 10000,
            "daily_amount": 0,
            "max_daily_transactions": 100,
            "daily_transactions": 0,
            "current_date": "2024-12-09T00:00:00.000Z"
        },
        "encode": "JSON",
        "sourceURL": "cb-oabcs1-bom.blockchain.ocp.example.com:20009",
        "blockNumber": 188
    }
}

createApprovalPolicyCheck

Ursprünglicher Methodenname: createApprovalPolicyCheck

Mit dieser Methode wird eine neue Genehmigungs-Policy erstellt, die Transaktionsschwellenwerte und die erforderlichen sequenziellen Genehmiger definiert. Diese Methode kann nur mit einem Token Admin aufgerufen werden.

Payload:

{
    "asset": "{\"approvalPolicyId\":\"approvalPolicyId value\",\"transactionLowerLimit\":\"transactionLowerLimit value\",\"transactionUpperLimit\":\"transactionUpperLimit value\",\"numberOfApprovalsRequired\":999,\"approverDetails\":[{\"approverOrgId\":\"approverOrgId value\",\"approverUserId\":\"approverUserId value\",\"approvalSequence\":999}]}",
    "endorsers": {{endorsers}}
}

Parameter:

• asset: ApprovalPolicyCheck class: Eine Klasse, die Genehmigungsregeln für eine Transaktion definiert, die folgende Felder enthält:
  • approvalPolicyId: Diese ID wird vom System generiert. Sie geben dieses Feld nicht manuell an.
  • transactionLowerLimit: Der Mindesttransaktionsbetrag, für den die Genehmigungs-Policy gilt.
  • transactionUpperLimit: Der maximale Transaktionsbetrag, für den die Genehmigungs-Policy gilt.
  • numberOfApprovalsRequired: Die Gesamtanzahl der Genehmigungen, die erforderlich sind, bevor die Transaktion abgeschlossen werden kann.
  • approverDetails: Eine Liste mit Genehmigern zusammen mit der zugewiesenen Genehmigungsreihenfolge, die den erforderlichen Auftrag für Genehmigungen definiert.
• endorsers: string[]: Ein Array der Peers (z.B. peer1, peer2), das die Transaktion freigeben muss.

Beispiel für Rückgabewert:

{
    "returnCode": "Success",
    "error": "",
    "result": {
        "txid": "3a5701ca90ffb98832421c7d5377eb9c0df9fdab30a0a3ce06216808bdea098e",
        "payload": {
            "status": "active",
            "assetType": "ApprovalPolicyCheck",
            "approvalPolicyId": "GPID~500~1000",
            "transactionLowerLimit": "500",
            "transactionUpperLimit": "1000",
            "numberOfApprovalsRequired": 2,
            "approverDetails": [
                {
                    "approverOrgId": "CentralBank",
                    "approverUserId": "manager",
                    "approvalSequence": 1
                },
                {
                    "approverOrgId": "CentralBank",
                    "approverUserId": "creator",
                    "approvalSequence": 2
                }
            ]
        },
        "encode": "JSON",
        "sourceURL": "cb-oabcs1-bom.blockchain.ocp.example.com:20010",
        "blockNumber": 284
    }
}

createStablecoinAccountPolicyCheck

Ursprünglicher Methodenname: createAccountPolicyCheck

Mit dieser Methode wird eine Policy für ein angegebenes Konto erstellt. Diese Methode kann nur von einem Token Admin oder Org Admin der angegebenen Organisation aufgerufen werden.

Payload:

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

Parameter:

• asset: AccountPolicyCheck class: Eine Klasse, die Account-Policy-Parameter definiert, die folgende Felder enthält:
  • accountPolicyId: Diese ID wird vom System aus den angegebenen Feldern orgId und userId generiert. Sie geben dieses Feld nicht manuell an.
  • orgId: Die Mitgliedsdienstanbieter-(MSP-)ID des Benutzers, für den die Policy erstellt werden soll.
  • userId: Der Benutzername oder die E-Mail-ID des Benutzers, für den die Policy erstellt werden soll.
  • kycCompliance: Ein boolescher Wert, der angibt, ob der Account die KYC-(Know Your Customer-)Anforderungen erfüllt.
  • amlCompliance: Ein boolescher Wert, der angibt, ob das Konto die Anforderungen an die Geldwäschebekämpfung erfüllt.
  • riskScore: Der dem Account zugeordnete Risikoscore, der für die Compliancebewertung verwendet wird.
  • restrictionFlag: Ein boolescher Wert, der angibt, ob das Konto eingeschränkten Transfers unterliegt. Wenn dieser Wert auf true gesetzt ist, sind nur Transfers innerhalb des niedrigsten Schwellenwertes für die Genehmigungs-Policy zulässig.
  • endorsers: string[]: Ein Array der Peers (z.B. peer1, peer2), das die Transaktion freigeben muss.

Beispiel für Rückgabewert:

{
    "returnCode": "Success",
    "error": "",
    "result": {
        "txid": "02875ca9c6a7408da3f81156214228b91b09c4bb2b8026d7a5733b53598c6635",
        "payload": {
            "assetType": "AccountPolicyCheck",
            "accountPolicyId": "APID~CentralBank~cb__creator_demo",
            "orgId": "CentralBank",
            "userId": "cb__creator_demo",
            "kycCompliance": "true",
            "amlCompliance": "true",
            "riskScore": 1000,
            "restrictionFlag": "false"
        },
        "encode": "JSON",
        "sourceURL": "cb-oabcs1-bom.blockchain.ocp.example.com:20010",
        "blockNumber": 272
    }
}

deleteApprovalPolicyCheck

Ursprünglicher Methodenname: deleteApprovalPolicyCheck

Mit dieser Methode wird die Genehmigungs-Policy für eine angegebene Policy-ID gelöscht. Diese Methode kann nur mit einem Token Admin aufgerufen werden.

Payload:

{
    "id": "id value",
    "endorsers": {{endorsers}}
}

Parameter:

• id: string: Die eindeutige ID der Genehmigungs-Policy.
• endorsers: string[]: Ein Array der Peers (z.B. peer1, peer2), das die Transaktion freigeben muss.

Beispiel für Rückgabewert:

{
    "returnCode": "Success",
    "error": "",
    "result": {
        "txid": "5ac54d3279a183022a00495aee3c25c2893388ff9aaaecd5c3b594edfa49ad8f",
        "payload": {
            "isValid": true,
            "message": "Successfully deleted asset with ID [GPID~500~1000] from ledger"
        },
        "encode": "JSON",
        "sourceURL": "cb-oabcs1-bom.blockchain.ocp.example.com:20009",
        "blockNumber": 286
    }
}

deleteStablecoinAccount

Ursprünglicher Methodenname: deleteAccount

Mit dieser Methode wird ein fungibles Tokenkonto gelöscht. Es wird ein Fehler zurückgegeben, wenn der Wert accountStatus für das Konto nicht im Buch gefunden wird. Diese Methode kann nur mit einem Token Admin aufgerufen werden.

Payload:

{
    "tokenId": "{{bc-token-id}}",
    "orgId": "{{bc-org-id}}",
    "userId": "{{bc-user-id}}",
    "endorsers": {{endorsers}}
}

Parameter:

• tokenId: string: Die ID des Tokens.
• orgId: string: Die Mitgliedsdienstanbieter-(MSP-)ID des Benutzers in der aktuellen Organisation.
• userId: string: Der Benutzername oder die E-Mail-ID des Benutzers.
• endorsers: string[]: Ein Array der Peers (z.B. peer1, peer2), das die Transaktion freigeben muss.

Beispiel für Rückgabewert:

{
    "returnCode": "Success",
    "error": "",
    "result": {
        "txid": "4bec8fc6cf31f86944b4e73334a03c55ad5630625e8320f5b9cf7cca30af929b",
        "payload": {
            "assetType": "oaccountStatus",
            "status_id": "oaccountStatus~e0a22965c400dd325e386b862b2552bbd26a281ebe4d1c29c08ccc465a26678d",
            "account_id": "oaccount~e888c90d38470956e3d98eccaa158f86a1bf0923900803b2b7cb7b4e0c10a18e",
            "status": "deleted"
        },
        "encode": "JSON",
        "sourceURL": "cb-oabcs1-bom.blockchain.ocp.example.com:20010",
        "blockNumber": 297
    }
}

deleteStablecoinAccountPolicyCheck

Ursprünglicher Methodenname: deleteAccountPolicyCheck

Mit dieser Methode wird die Policy für eine angegebene Policy-ID gelöscht. Diese Methode kann nur von einem Token Admin oder Org Admin der angegebenen Organisation aufgerufen werden.

Payload:

{
    "id": "id value",
    "endorsers": {{endorsers}}
}

Parameter:

• id: string: Die eindeutige ID der Accountrichtlinie.
• endorsers: string[]: Ein Array der Peers (z.B. peer1, peer2), das die Transaktion freigeben muss.

Beispiel für Rückgabewert:

{
    "returnCode": "Success",
    "error": "",
    "result": {
        "txid": "5ac54d3279a183022a00495aee3c25c2893388ff9aaaecd5c3b594edfa49ad8f",
        "payload": {
            "isValid": true,
            "message": "Successfully deleted asset with ID [GPID~500~1000] from ledger"
        },
        "encode": "JSON",
        "sourceURL": "cb-oabcs1-bom.blockchain.ocp.example.com:20009",
        "blockNumber": 286
    }
}

executeHoldTokens

Ursprünglicher Methodenname: executeHoldTokens

Diese Methode genehmigt eine Tokensperre, die den Transfer der Token vom Absender an den Empfänger auslöst. Die Menge der Token, die zuvor vom Tokenverantwortlichen zurückgestellt wurden, wird jetzt an den Empfänger übertragen. Wenn der Wert quantity kleiner als der tatsächliche Zurückstellungswert ist, ist der verbleibende Betrag wieder für den Eigentümer des Tokens verfügbar. Wenn das Verhalten roles im Abschnitt behaviors des Tokenmodells angegeben und der Wert notary_role_name festgelegt ist, muss der Aufruferaccount die Notarrolle aufweisen. Andernfalls kann jeder Aufrufer mit einem Konto als Notar fungieren.

Payload:

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

Parameter:

• tokenId: string: Die ID des Tokens.
• operationId: string: Die eindeutige Vorgangs-ID der zu genehmigenden Mint-Anforderung.
• quantity: number: Die Anzahl der zu übertragenden Token.
• endorsers: string[]: Ein Array der Peers (z.B. peer1, peer2), das die Transaktion freigeben muss.

Beispiel für Rückgabewert:

{
    "returnCode": "Success",
    "error": "",
    "result": {
        "txid": "c1149aaa486abc4931d9024c18dfcb230bb321723d1160b0bf981c0011c4856a",
        "payload": {
            "msg": "Account Id: oaccount~51e676d7182a02ea7418ef58a6d54ecfe3858ef40b4ffb3d859b320da3921594 (Org-Id: CB, User-Id: issuer_user_cb) is successfully executed '10' tokens from Operation Id '8e3145'."
        },
        "encode": "JSON",
        "sourceURL": "cb-oabcs1-bom.blockchain.ocp.example.com:20009",
        "blockNumber": 213
    }
}

getStablecoinAccountTransactionHistory

Ursprünglicher Methodenname: getAccountTransactionHistory

Diese Methode gibt ein Array von Kontotransaktionshistoriendetails für einen angegebenen Benutzer und ein bestimmtes Token zurück. Diese Methode kann nur von einer Token Admin oder Token Auditor des Chaincodes, einer Org Admin oder Org Auditor der angegebenen Organisation oder der AccountOwner des Accounts aufgerufen werden.

/getStablecoinAccountTransactionHistory?tokenId={{bc-token-id}}&orgId={{bc-org-id}}&userId={{bc-user-id}}

Parameter:

• tokenId: string: Die ID des Tokens.
• orgId: string: Die Mitgliedsdienstanbieter-(MSP-)ID des Benutzers in der aktuellen Organisation.
• userId: string: Der Benutzername oder die E-Mail-ID des Benutzers.

Beispiel für Rückgabewert:

{
    "returnCode": "Success",
    "error": "",
    "result": {
        "payload": [
            {
                "transaction_id": "otransaction~64c5a4830949eae1424600f3d4a438c6f603a7c3ea31a68e374b899803999e22",
                "transacted_amount": 10,
                "timestamp": "2024-12-11T13:37:28.000Z",
                "balance": 550,
                "onhold_balance": 10,
                "token_id": "USD",
                "category": "category value",
                "description": "description value",
                "transacted_account": "oaccount~9d9806fa92aa0c4fdb34eaffac6e830181b5d47e64fbce752195e83024125ca0",
                "transaction_type": "REJECT_MINT",
                "transacted_org_id": "CB",
                "transacted_user_id'": "creator_user_cb"
            },
            {
                "transaction_id": "otransaction~a4537ef34a955b023b7c205b9abf06a6c79e4fdd761fb24f41b8eb34126b66c0",
                "transacted_amount": 10,
                "timestamp": "2024-12-11T13:36:32.000Z",
                "balance": 550,
                "onhold_balance": 10,
                "token_id": "USD",
                "description": "description value",
                "transacted_account": "oaccount~9d9806fa92aa0c4fdb34eaffac6e830181b5d47e64fbce752195e83024125ca0",
                "transaction_type": "APPROVE_MINT",
                "transacted_org_id": "CB",
                "transacted_user_id'": "creator_user_cb"
            },
            {
                "transaction_id": "otransaction~6237a759422bd9fb112742e8cd7e6450df5a74a32236d9b1005571afed8904a4",
                "transacted_amount": 10,
                "timestamp": "2024-12-11T13:36:18.000Z",
                "balance": 540,
                "onhold_balance": 10,
                "token_id": "USD",
                "category": "category value",
                "description": "description value",
                "transacted_account": "oaccount~9d9806fa92aa0c4fdb34eaffac6e830181b5d47e64fbce752195e83024125ca0",
                "transaction_type": "REQUEST_MINT",
                "transacted_org_id": "CB",
                "transacted_user_id'": "creator_user_cb"
            },
            {
                "transaction_id": "otransaction~06b35071415d74aa1a7c18449149c937d886cae76a832c44cf8d98e84586e76e",
                "transacted_amount": 10,
                "timestamp": "2024-12-11T13:35:46.000Z",
                "balance": 540,
                "onhold_balance": 10,
                "token_id": "USD",
                "category": "category value",
                "description": "description value",
                "transacted_account": "oaccount~9d9806fa92aa0c4fdb34eaffac6e830181b5d47e64fbce752195e83024125ca0",
                "transaction_type": "REQUEST_MINT",
                "transacted_org_id": "CB",
                "transacted_user_id'": "creator_user_cb"
            }
        ],
        "encode": "JSON"
    }
}

getAllAccounts

Ursprünglicher Methodenname: getAllAccounts

Diese Methode gibt eine Liste aller Konten zurück. Diese Methode kann nur mit einer Token Admin oder Token Auditor aufgerufen werden.

Payload:

{{api-gateway-endpoint1}}/getAllAccounts

Parameter:

• Kein

Beispiel für Rückgabewert:

{
    "returnCode": "Success",
    "error": "",
    "result": {
        "payload": [
            {
                "key": "oaccount~374e4e762940fc185c7cd5b6528c7f94985b6c56acf46abb746de6381589edd2",
                "valueJson": {
                    "account_id": "oaccount~374e4e762940fc185c7cd5b6528c7f94985b6c56acf46abb746de6381589edd2",
                    "assetType": "oaccount",
                    "balance": 49390,
                    "bapAccountVersion": 7,
                    "current_date": "2025-11-21T00:00:00.000Z",
                    "daily_amount": 610,
                    "daily_transactions": 2,
                    "max_daily_amount": 10000,
                    "max_daily_transactions": 100,
                    "onhold_balance": 0,
                    "onhold_burn_balance": 0,
                    "org_id": "CentralBank",
                    "token_id": "t1",
                    "token_name": "stablecoin",
                    "token_type": "fungible",
                    "user_id": "cb__creator_demo"
                }
            },
            {
                "key": "oaccount~f44e4d75c0fec749392566e745cd39c453c3039aa7224ae417bc4379b645827c",
                "valueJson": {
                    "bapAccountVersion": 0,
                    "assetType": "oaccount",
                    "account_id": "oaccount~f44e4d75c0fec749392566e745cd39c453c3039aa7224ae417bc4379b645827c",
                    "user_id": "cb_manager_demo",
                    "org_id": "CentralBank",
                    "token_type": "fungible",
                    "token_id": "t1",
                    "token_name": "stablecoin",
                    "balance": 0,
                    "onhold_balance": 0,
                    "onhold_burn_balance": 0,
                    "max_daily_amount": 10000,
                    "daily_amount": 0,
                    "max_daily_transactions": 100,
                    "daily_transactions": 0,
                    "current_date": "2025-11-20T00:00:00.000Z"
                }
            },
            {
                "key": "oaccount~79c427e614530eacad6fb07cff6048f6b96283e65019301320c9684932846f64",
                "valueJson": {
                    "account_id": "oaccount~79c427e614530eacad6fb07cff6048f6b96283e65019301320c9684932846f64",
                    "assetType": "oaccount",
                    "balance": 610,
                    "bapAccountVersion": 2,
                    "current_date": "2025-11-20T00:00:00.000Z",
                    "daily_amount": 0,
                    "daily_transactions": 0,
                    "max_daily_amount": 10000,
                    "max_daily_transactions": 100,
                    "onhold_balance": 0,
                    "onhold_burn_balance": 0,
                    "org_id": "CentralBank",
                    "token_id": "t1",
                    "token_name": "stablecoin",
                    "token_type": "fungible",
                    "user_id": "cb_issuer_demo"
                }
            },
            {
                "key": "oaccount~1cf5d40c7ea7b9dceedfc66292ab843c1583564c3ecaf9f5ceb11f834018b02f",
                "valueJson": {
                    "account_id": "oaccount~1cf5d40c7ea7b9dceedfc66292ab843c1583564c3ecaf9f5ceb11f834018b02f",
                    "assetType": "oaccount",
                    "balance": 0,
                    "bapAccountVersion": 1,
                    "current_date": "2025-11-20T00:00:00.000Z",
                    "daily_amount": 0,
                    "daily_transactions": 0,
                    "max_daily_amount": 10000,
                    "max_daily_transactions": 100,
                    "onhold_balance": 0,
                    "onhold_burn_balance": 0,
                    "org_id": "CentralBank",
                    "token_id": "t1",
                    "token_name": "stablecoin",
                    "token_type": "fungible",
                    "user_id": "manager"
                }
            },
            {
                "key": "oaccount~09abdd306d4fcbc1b794e2e0b8fc4ce3d8282e11846ef35d675cc9540da4ad1b",
                "valueJson": {
                    "account_id": "oaccount~09abdd306d4fcbc1b794e2e0b8fc4ce3d8282e11846ef35d675cc9540da4ad1b",
                    "assetType": "oaccount",
                    "balance": 0,
                    "bapAccountVersion": 1,
                    "current_date": "2025-11-20T00:00:00.000Z",
                    "daily_amount": 0,
                    "daily_transactions": 0,
                    "max_daily_amount": 10000,
                    "max_daily_transactions": 100,
                    "onhold_balance": 0,
                    "onhold_burn_balance": 0,
                    "org_id": "CentralBank",
                    "token_id": "t1",
                    "token_name": "stablecoin",
                    "token_type": "fungible",
                    "user_id": "creator"
                }
            },
            {
                "key": "oaccount~e888c90d38470956e3d98eccaa158f86a1bf0923900803b2b7cb7b4e0c10a18e",
                "valueJson": {
                    "assetType": "oaccount",
                    "account_id": "oaccount~e888c90d38470956e3d98eccaa158f86a1bf0923900803b2b7cb7b4e0c10a18e",
                    "user_id": "user1",
                    "org_id": "CentralBank",
                    "token_type": "fungible",
                    "token_id": "t1",
                    "token_name": "stablecoin",
                    "balance": 0,
                    "onhold_balance": 0,
                    "onhold_burn_balance": 0,
                    "max_daily_amount": 10000,
                    "daily_amount": 0,
                    "max_daily_transactions": 100,
                    "daily_transactions": 0,
                    "current_date": "2025-11-24T00:00:00.000Z"
                }
            }
        ],
        "encode": "JSON"
    }
}

getAllOrgAccounts

Ursprünglicher Methodenname: getAllOrgAccounts

Diese Methode gibt eine Liste aller Token-Accounts zurück, die zu einer bestimmten Organisation gehören. Diese Methode kann nur von einer Token Admin, Token Auditor oder einer Org Admin oder Org Auditor der angegebenen Organisation aufgerufen werden.

Payload:

{{api-gateway-endpoint1}}/getAllOrgAccounts?orgId={{bc-org-id}}

Parameter:

• orgId: string: Die Mitgliedsdienstanbieter-(MSP-)ID der Organisation.

Beispiel für Rückgabewert:

{
    "returnCode": "Success",
    "error": "",
    "result": {
        "payload": [
            {
                "key": "oaccount~374e4e762940fc185c7cd5b6528c7f94985b6c56acf46abb746de6381589edd2",
                "valueJson": {
                    "account_id": "oaccount~374e4e762940fc185c7cd5b6528c7f94985b6c56acf46abb746de6381589edd2",
                    "assetType": "oaccount",
                    "balance": 49390,
                    "bapAccountVersion": 7,
                    "current_date": "2025-11-21T00:00:00.000Z",
                    "daily_amount": 610,
                    "daily_transactions": 2,
                    "max_daily_amount": 10000,
                    "max_daily_transactions": 100,
                    "onhold_balance": 0,
                    "onhold_burn_balance": 0,
                    "org_id": "CentralBank",
                    "token_id": "t1",
                    "token_name": "stablecoin",
                    "token_type": "fungible",
                    "user_id": "cb__creator_demo"
                }
            },
            {
                "key": "oaccount~f44e4d75c0fec749392566e745cd39c453c3039aa7224ae417bc4379b645827c",
                "valueJson": {
                    "bapAccountVersion": 0,
                    "assetType": "oaccount",
                    "account_id": "oaccount~f44e4d75c0fec749392566e745cd39c453c3039aa7224ae417bc4379b645827c",
                    "user_id": "cb_manager_demo",
                    "org_id": "CentralBank",
                    "token_type": "fungible",
                    "token_id": "t1",
                    "token_name": "stablecoin",
                    "balance": 0,
                    "onhold_balance": 0,
                    "onhold_burn_balance": 0,
                    "max_daily_amount": 10000,
                    "daily_amount": 0,
                    "max_daily_transactions": 100,
                    "daily_transactions": 0,
                    "current_date": "2025-11-20T00:00:00.000Z"
                }
            },
            {
                "key": "oaccount~79c427e614530eacad6fb07cff6048f6b96283e65019301320c9684932846f64",
                "valueJson": {
                    "account_id": "oaccount~79c427e614530eacad6fb07cff6048f6b96283e65019301320c9684932846f64",
                    "assetType": "oaccount",
                    "balance": 610,
                    "bapAccountVersion": 2,
                    "current_date": "2025-11-20T00:00:00.000Z",
                    "daily_amount": 0,
                    "daily_transactions": 0,
                    "max_daily_amount": 10000,
                    "max_daily_transactions": 100,
                    "onhold_balance": 0,
                    "onhold_burn_balance": 0,
                    "org_id": "CentralBank",
                    "token_id": "t1",
                    "token_name": "stablecoin",
                    "token_type": "fungible",
                    "user_id": "cb_issuer_demo"
                }
            },
            {
                "key": "oaccount~1cf5d40c7ea7b9dceedfc66292ab843c1583564c3ecaf9f5ceb11f834018b02f",
                "valueJson": {
                    "account_id": "oaccount~1cf5d40c7ea7b9dceedfc66292ab843c1583564c3ecaf9f5ceb11f834018b02f",
                    "assetType": "oaccount",
                    "balance": 0,
                    "bapAccountVersion": 1,
                    "current_date": "2025-11-20T00:00:00.000Z",
                    "daily_amount": 0,
                    "daily_transactions": 0,
                    "max_daily_amount": 10000,
                    "max_daily_transactions": 100,
                    "onhold_balance": 0,
                    "onhold_burn_balance": 0,
                    "org_id": "CentralBank",
                    "token_id": "t1",
                    "token_name": "stablecoin",
                    "token_type": "fungible",
                    "user_id": "manager"
                }
            },
            {
                "key": "oaccount~09abdd306d4fcbc1b794e2e0b8fc4ce3d8282e11846ef35d675cc9540da4ad1b",
                "valueJson": {
                    "account_id": "oaccount~09abdd306d4fcbc1b794e2e0b8fc4ce3d8282e11846ef35d675cc9540da4ad1b",
                    "assetType": "oaccount",
                    "balance": 0,
                    "bapAccountVersion": 1,
                    "current_date": "2025-11-20T00:00:00.000Z",
                    "daily_amount": 0,
                    "daily_transactions": 0,
                    "max_daily_amount": 10000,
                    "max_daily_transactions": 100,
                    "onhold_balance": 0,
                    "onhold_burn_balance": 0,
                    "org_id": "CentralBank",
                    "token_id": "t1",
                    "token_name": "stablecoin",
                    "token_type": "fungible",
                    "user_id": "creator"
                }
            },
            {
                "key": "oaccount~e888c90d38470956e3d98eccaa158f86a1bf0923900803b2b7cb7b4e0c10a18e",
                "valueJson": {
                    "assetType": "oaccount",
                    "account_id": "oaccount~e888c90d38470956e3d98eccaa158f86a1bf0923900803b2b7cb7b4e0c10a18e",
                    "user_id": "user1",
                    "org_id": "CentralBank",
                    "token_type": "fungible",
                    "token_id": "t1",
                    "token_name": "stablecoin",
                    "balance": 0,
                    "onhold_balance": 0,
                    "onhold_burn_balance": 0,
                    "max_daily_amount": 10000,
                    "daily_amount": 0,
                    "max_daily_transactions": 100,
                    "daily_transactions": 0,
                    "current_date": "2025-11-24T00:00:00.000Z"
                }
            }
        ],
        "encode": "JSON"
    }
}

getAllTokenAdmins

Ursprünglicher Methodenname: getAllTokenAdmins

Diese Methode gibt eine Liste aller Benutzer zurück, die ein Token Admin sind. Diese Methode kann nur mit Token Admin oder Token Auditor aufgerufen werden.

Payload:

{{api-gateway-endpoint1}}/getAllTokenAdmins

Parameter:

• Kein

Beispiel für Rückgabewert:

{
    "returnCode": "Success",
    "error": "",
    "result": {
        "payload": {
            "admins": [
                {
                    "org_id": "CentralBank",
                    "user_id": "cb_admin_demo"
                }
            ]
        },
        "encode": "JSON"
    }
}

getAllTokens

Ursprünglicher Methodenname: getAllTokens

Diese Methode gibt alle Token zurück, die in der Statusdatenbank gespeichert sind. Diese Methode kann nur mit Token Admin, Token Auditor, Org Admin oder Org Auditor aufgerufen werden. Diese Methode verwendet SQL-reiche Berkeley DB-Abfragen und kann nur aufgerufen werden, wenn eine Verbindung zum Remote-Oracle Blockchain Platform-Netzwerk besteht.

Payload:

{{api-gateway-endpoint1}}/getAllTokens

Parameter:

• Kein

Beispiel für Rückgabewert:

{
    "returnCode": "Success",
    "error": "",
    "result": {
        "payload": [
            {
                "key": "t1",
                "valueJson": {
                    "assetType": "otoken",
                    "events": false,
                    "token_id": "t1",
                    "token_name": "stablecoin",
                    "token_desc": "token_desc value",
                    "token_standard": "ttf+",
                    "token_type": "fungible",
                    "token_unit": "fractional",
                    "behaviors": [
                        "divisible",
                        "mintable",
                        "transferable",
                        "burnable",
                        "holdable",
                        "roles"
                    ],
                    "roles": {
                        "minter_role_name": "minter",
                        "burner_role_name": "burner",
                        "notary_role_name": "notary",
                        "mint_approver_role_name": "notary",
                        "burn_approver_role_name": "notary"
                    },
                    "mintable": {
                        "max_mint_quantity": 0,
                        "mint_approval_required": true
                    },
                    "burnable": {
                        "burn_approval_required": true
                    },
                    "divisible": {
                        "decimal": 2
                    },
                    "currencyName": "currencyName value",
                    "conversionRate": 999
                }
            }
        ],
        "encode": "JSON"
    }
}

getApprovalPolicyCheckById

Ursprünglicher Methodenname: getApprovalPolicyCheckById

Diese Methode ruft die Genehmigungs-Policy-Details für eine angegebene Policy-ID ab. Diese Methode kann nur mit einer Token Admin oder Token Auditor aufgerufen werden.

Payload:

{{api-gateway-endpoint1}}/getApprovalPolicyCheckById?id=id value

Parameter:

• id: string: Die eindeutige ID der Genehmigungs-Policy.

Beispiel für Rückgabewert:

{
    "returnCode": "Success",
    "error": "",
    "result": {
        "payload": {
            "assetType": "ApprovalPolicyCheck",
            "approvalPolicyId": "GPID~0~100",
            "transactionLowerLimit": "0",
            "transactionUpperLimit": "100",
            "numberOfApprovalsRequired": 0,
            "approverDetails": []
        },
        "encode": "JSON"
    }
}

getApprovalTransactionsById

Ursprünglicher Methodenname: getApprovalTransactionsById

Diese Methode ruft die Genehmigungstransaktion für eine angegebene Transaktions-ID ab. Diese Methode kann nur von einer Token Admin oder Org Admin der zugehörigen Organisation aufgerufen werden.

Payload:

{{api-gateway-endpoint1}}/getApprovalTransactionsById?id=id value

Parameter:

• id: string: Die vom System generierte ID der Genehmigungstransaktion.

Beispiel für Rückgabewert:

{
    "returnCode": "Success",
    "error": "",
    "result": {
        "payload": {
            "assetType": "ApprovalTransactions",
            "approvalTransactionId": "hold1~oaccount~1cf5d40c7ea7b9dceedfc66292ab843c1583564c3ecaf9f5ceb11f834018b02f",
            "approvalOperationId": "hold1",
            "fromAccountId": "oaccount~374e4e762940fc185c7cd5b6528c7f94985b6c56acf46abb746de6381589edd2",
            "toAccountId": "oaccount~79c427e614530eacad6fb07cff6048f6b96283e65019301320c9684932846f64",
            "approverAccountId": "oaccount~1cf5d40c7ea7b9dceedfc66292ab843c1583564c3ecaf9f5ceb11f834018b02f",
            "totalApprovals": 1,
            "timestamp": "2025-11-21T12:32:43.000Z"
        },
        "encode": "JSON"
    }
}

getApproverDetailsByTransferAmount

Ursprünglicher Methodenname: getApproverDetailsByTransferAmount

Diese Methode ruft die Details des Genehmigers ab, die für einen bestimmten Transferbetrag erforderlich sind. Diese Methode kann nur mit einer Token Admin oder Token Auditor aufgerufen werden.

Payload:

{
    "Amount": 1,
    "endorsers": {{endorsers}}
}

Parameter:

• amount: number: Der Überweisungsbetrag.
• endorsers: string[]: Ein Array der Peers (z.B. peer1, peer2), das die Transaktion freigeben muss.

Beispiel für Rückgabewert:

{
    "returnCode": "Success",
    "error": "",
    "result": {
        "txid": "5874105c14abd67e68cb4dacf82f2a2dca6cc9da4f5b27fcc91c83a60b7249e1",
        "payload": {
            "approverDetails": [
                {
                    "approverOrgId": "CentralBank",
                    "approverUserId": "manager",
                    "approvalSequence": 1
                },
                {
                    "approverOrgId": "CentralBank",
                    "approverUserId": "creator",
                    "approvalSequence": 2
                }
            ]
        },
        "encode": "JSON",
        "sourceURL": "cb-oabcs1-bom.blockchain.ocp.example.com:20010",
        "blockNumber": 292
    }
}

getMaxDailyAmount

Ursprünglicher Methodenname: getMaxDailyAmount

Diese Methode ruft den maximalen kumulativen Transaktionsbetrag pro Tag für ein bestimmtes Konto ab. Diese Methode kann nur von einer Token Admin oder Token Auditor des Chaincodes oder einer Org Admin oder Org Auditor der angegebenen Organisation aufgerufen werden.

Payload:

{{api-gateway-endpoint1}}/getMaxDailyAmount?OrgId={{bc-org-id}}&UserId={{bc-user-id}}&TokenId={{bc-token-id}}

Parameter:

• tokenId: string: Die ID des Tokens.
• orgId: string: Die Mitgliedsdienstanbieter-(MSP-)ID des Benutzers in der aktuellen Organisation.
• userId: string: Der Benutzername oder die E-Mail-ID des Benutzers.

Beispiel für Rückgabewert:

{
    "returnCode": "Success",
    "error": "",
    "result": {
        "payload": {
            "max_daily_amount": 10000
        },
        "encode": "JSON"
    }
}

getMaxDailyTransactionCount

Ursprünglicher Methodenname: getMaxDailyTransactionCount

Diese Methode ruft die maximale Anzahl täglicher Transaktionen für ein angegebenes Konto ab. Diese Methode kann nur von einer Token Admin oder Token Auditor des Chaincodes oder einer Org Admin oder Org Auditor der angegebenen Organisation aufgerufen werden.

Payload:

{{api-gateway-endpoint1}}/getMaxDailyTransactionCount?OrgId={{bc-org-id}}&UserId={{bc-user-id}}&TokenId={{bc-token-id}}

Parameter:

• tokenId: string: Die ID des Tokens.
• orgId: string: Die Mitgliedsdienstanbieter-(MSP-)ID des Benutzers in der aktuellen Organisation.
• userId: string: Der Benutzername oder die E-Mail-ID des Benutzers.

Beispiel für Rückgabewert:

{
    "returnCode": "Success",
    "error": "",
    "result": {
        "payload": {
            "max_daily_transactions": 100
        },
        "encode": "JSON"
    }
}

getNetTokens

Ursprünglicher Methodenname: getNetTokens

Diese GET-Methode gibt die Gesamtanzahl der Token zurück, die im System für ein angegebenes Token verfügbar sind. Die Nettotokensumme ist die Anzahl der verbleibenden Token, nachdem Token gebrannt wurden. Diese Methode kann nur mit Token Admin oder Token Auditor oder Org Admin oder Org Auditor aufgerufen werden.

/getNetStablecoinTokens?tokenId={{bc-token-id}}

Parameter:

• tokenId: string: Die ID des Tokens.

Beispiel für Rückgabewert:

{
    "returnCode": "Success",
    "error": "",
    "result": {
        "payload": {
            "msg": "Net supply of token for Token Id: USD is 878 tokens.",
            "quantity": 878
        },
        "encode": "JSON"
    }
}

getOnHoldBalanceWithOperationId

Ursprünglicher Methodenname: getOnHoldBalanceWithOperationId

Diese Methode gibt den Saldo für eine bestimmte Vorgangs-ID und ein bestimmtes Token zurück. Diese Methode kann nur von einer Token Admin oder Token Auditor oder vom Absender, Empfänger oder Notar aufgerufen werden, der dem Vorgang zugeordnet ist.

Payload:

{{api-gateway-endpoint1}}/getOnHoldBalanceWithOperationId?tokenId={{bc-token-id}}&operationId=operation_id value

Parameter:

• tokenId: string: Die ID des Tokens.
• operationId: string: Eine eindeutige ID zur Identifizierung des Sperrvorgangs. Normalerweise wird diese ID von der Clientanwendung übergeben.

Beispiel für Rückgabewert:

{
    "returnCode": "Success",
    "error": "",
    "result": {
        "payload": {
            "msg": "Current Holding Balance of Operation 'hold2' for token 't1' is: 600",
            "holding_balance": 600
        },
        "encode": "JSON"
    }
}

getOnHoldDetailsWithOperationId

Ursprünglicher Methodenname: getOnHoldDetailsWithOperationId

Diese Methode gibt die Details der zurückgestellten Transaktion für eine angegebene Vorgangs-ID und ein bestimmtes Token zurück. Diese Methode kann nur von einer Token Admin oder Token Auditor oder vom Absender, Empfänger oder Notar aufgerufen werden, der dem Vorgang zugeordnet ist.

Payload:

{{api-gateway-endpoint1}}/getOnHoldDetailsWithOperationId?tokenId={{bc-token-id}}&operationId=operation_id value

Parameter:

• tokenId: string: Die ID des Tokens.
• operationId: string: Eine eindeutige ID zur Identifizierung des Sperrvorgangs. Normalerweise wird diese ID von der Clientanwendung übergeben.

Beispiel für Rückgabewert:

{
    "returnCode": "Success",
    "error": "",
    "result": {
        "payload": {
            "bapHoldVersion": 1,
            "assetType": "ohold",
            "holding_id": "ohold~stablecoin~t1~hold2",
            "operation_id": "hold2",
            "token_id": "t1",
            "token_name": "stablecoin",
            "operation_type": "transfer",
            "status": "pending",
            "from_account_id": "oaccount~374e4e762940fc185c7cd5b6528c7f94985b6c56acf46abb746de6381589edd2",
            "to_account_id": "oaccount~79c427e614530eacad6fb07cff6048f6b96283e65019301320c9684932846f64",
            "notary_account_id": "oaccount~f44e4d75c0fec749392566e745cd39c453c3039aa7224ae417bc4379b645827c",
            "quantity": 600,
            "time_to_expiration": "0",
            "category": "category value",
            "description": "description value"
        },
        "encode": "JSON"
    }
}

getOnHoldIds

Ursprünglicher Methodenname: getOnHoldIds

Diese GET-Methode gibt eine Liste aller Halte-IDs für ein angegebenes Konto zurück. Diese Methode kann nur von einer Token Admin oder Token Auditor des Chaincodes, einer Org Admin oder Org Auditor der angegebenen Organisation oder der AccountOwner des Accounts aufgerufen werden.

/getOnHoldIds?tokenId={{bc-token-id}}&orgId={{bc-org-id}}&userId={{bc-user-id}}

Parameter:

• tokenId: string: Die ID des Tokens.
• orgId: string: Die Mitgliedsdienstanbieter-(MSP-)ID des Benutzers in der aktuellen Organisation.
• userId: string: Der Benutzername oder die E-Mail-ID des Benutzers.

Beispiel für Rückgabewert:

{
    "returnCode": "Success",
    "error": "",
    "result": {
        "payload": {
            "msg": "Holding Ids are: ohold~Stablecoin~USD~8e3147,ohold~Stablecoin~USD~8e315",
            "holding_ids": [
                "ohold~Stablecoin~USD~8e3147",
                "ohold~Stablecoin~USD~8e315"
            ]
        },
        "encode": "JSON"
    }
}

getOrgAccountsByRole

Ursprünglicher Methodenname: getOrgAccountsByRole

Diese Methode gibt Informationen zu allen Konten zurück, die eine bestimmte Rolle in einer bestimmten Organisation haben. Diese Methode kann nur von einer Token Admin oder Token Auditor oder von einer Org Admin oder Org Auditor der angegebenen Organisation aufgerufen werden.

Payload:

{{api-gateway-endpoint1}}/getOrgAccountsByRole?tokenId={{bc-token-id}}&role=role value (for example minter / burner / notary)&orgId={{bc-org-id}}

Parameter:

• tokenId: string: Die ID des Tokens.
• role: string: Der Name der Rolle, nach der gesucht werden soll.
• orgId: string: Die Mitgliedsdienstanbieter-(MSP-)ID des Benutzers in der aktuellen Organisation.

Beispiel für Rückgabewert:

{
    "returnCode": "Success",
    "error": "",
    "result": {
        "payload": {
            "accounts": [
                "oaccount~374e4e762940fc185c7cd5b6528c7f94985b6c56acf46abb746de6381589edd2"
            ]
        },
        "encode": "JSON"
    }
}

getOrgAdmins

Ursprünglicher Methodenname: getOrgAdmins

Diese Methode gibt eine Liste aller Benutzer zurück, die eine Org Admin einer Organisation sind. Diese Methode kann nur von einer Token Admin oder Token Auditor oder von einer Org Admin oder Org Auditor der zugehörigen Organisation aufgerufen werden.

Payload:

{{api-gateway-endpoint1}}/getOrgAdmins

Parameter:

• Kein

Beispiel für Rückgabewert:

{
    "returnCode": "Success",
    "error": "",
    "result": {
        "payload": {
            "admins": [
                {
                    "org_id": "CentralBank",
                    "user_id": "cb__creator_demo"
                }
            ]
        },
        "encode": "JSON"
    }
}

getOrgAuditors

Ursprünglicher Methodenname: getOrgAuditors

Diese Methode gibt eine Liste aller Benutzer zurück, die eine Org Auditor einer Organisation sind. Diese Methode kann nur von einer Token Admin oder Token Auditor oder von einer Org Admin oder Org Auditor der zugehörigen Organisation aufgerufen werden.

Payload:

{{api-gateway-endpoint1}}/getOrgAuditors

Parameter:

• Kein

Beispiel für Rückgabewert:

{
    "returnCode": "Success",
    "error": "",
    "result": {
        "payload": {
            "admins": [
                {
                    "org_id": "CentralBank",
                    "user_id": "cb_auditor_demo"
                }
            ]
        },
        "encode": "JSON"
    }
}

getOrgUsersByRole

Ursprünglicher Methodenname: getOrgUsersByRole

Diese Methode gibt Informationen zu allen Benutzern zurück, die eine bestimmte Rolle in einer bestimmten Organisation haben. Diese Methode kann nur von einer Token Admin oder Token Auditor oder von einer Org Admin oder Org Auditor der angegebenen Organisation aufgerufen werden.

Payload:

{{api-gateway-endpoint1}}/getOrgUsersByRole?tokenId={{bc-token-id}}&role=role value (for example minter / burner / notary)&orgId={{bc-org-id}}

Parameter:

• tokenId: string: Die ID des Tokens.
• role: string: Der Name der Rolle, nach der gesucht werden soll.
• orgId: string: Die Mitgliedsdienstanbieter-(MSP-)ID des Benutzers in der aktuellen Organisation.

Beispiel für Rückgabewert:

{
    "returnCode": "Success",
    "error": "",
    "result": {
        "payload": {
            "users": [
                {
                    "token_id": "t1",
                    "user_id": "cb__creator_demo",
                    "org_id": "CentralBank"
                }
            ]
        },
        "encode": "JSON"
    }
}

getStablecoinAccount

Ursprünglicher Methodenname: getAccount

Diese GET-Methode gibt Accountdetails für einen angegebenen Benutzer und ein bestimmtes Token zurück. Diese Methode kann nur von einer Token Admin oder Token Auditor des Chaincodes, einer Org Admin oder Org Auditor der angegebenen Organisation oder der AccountOwner des Accounts aufgerufen werden.

Abfrage:

/getStablecoinAccount?tokenId={{bc-token-id}}&orgId={{bc-org-id}}&userId={{bc-user-id}}

Parameter:

• tokenId: string: Die ID des Tokens.
• orgId: string: Die Mitgliedsdienstanbieter-(MSP-)ID des Benutzers in der aktuellen Organisation.
• userId: string: Der Benutzername oder die E-Mail-ID des Benutzers.

Beispiel für Rückgabewert:

{
    "returnCode": "Success",
    "error": "",
    "result": {
        "payload": {
            "bapAccountVersion": 0,
            "assetType": "oaccount",
            "status": "active",
            "account_id": "oaccount~cdc6fa5e64bc29f700f99da69f980d8cbb768c7e1a11dd17274e75651f6afafe",
            "user_id": "admin_user_cb",
            "org_id": "CB",
            "token_type": "fungible",
            "token_id": "USD",
            "token_name": "Stablecoin",
            "balance": 0,
            "onhold_balance": 0,
            "max_daily_amount": 10000,
            "daily_amount": 0,
            "max_daily_transactions": 1000,
            "daily_transactions": 0,
            "current_date": "2024-11-20T00:00:00.000Z"
        },
        "encode": "JSON"
    }
}

getStablecoinAccountBalance

Ursprünglicher Methodenname: getAccountBalance

Diese GET-Methode gibt den aktuellen Saldo für ein angegebenes Konto und Token zurück. Diese Methode kann nur von einer Token Admin oder Token Auditor des Chaincodes, einer Org Admin oder Org Auditor der angegebenen Organisation oder der AccountOwner des Accounts aufgerufen werden.

/getStablecoinAccountBalance?tokenId={{bc-token-id}}&orgId={{bc-org-id}}&userId={{bc-user-id}}

Parameter:

• tokenId: string: Die ID des Tokens.
• orgId: string: Die Mitgliedsdienstanbieter-(MSP-)ID des Benutzers in der aktuellen Organisation.
• userId: string: Der Benutzername oder die E-Mail-ID des Benutzers.

Beispiel für Rückgabewert:

{
    "returnCode": "Success",
    "error": "",
    "result": {
        "payload": {
            "msg": "Current Balance is: 100",
            "user_balance": 100
        },
        "encode": "JSON"
    }
}

getStablecoinAccountOnHoldBalance

Ursprünglicher Methodenname: getAccountOnHoldBalance

Diese Methode gibt den aktuellen Zurückstellungssaldo für ein angegebenes Konto und Token zurück. Diese Methode kann nur von einer Token Admin oder Token Auditor, einer Org Admin oder Org Auditor der angegebenen Organisation oder dem Eigentümer des Accounts aufgerufen werden.

Payload:

{{api-gateway-endpoint1}}/getStablecoinAccountOnHoldBalance?tokenId={{bc-token-id}}&orgId={{bc-org-id}}&userId={{bc-user-id}}

Parameter:

• tokenId: string: Die ID des Tokens.
• orgId: string: Die Mitgliedsdienstanbieter-(MSP-)ID des Benutzers in der aktuellen Organisation.
• userId: string: Der Benutzername oder die E-Mail-ID des Benutzers.

Beispiel für Rückgabewert:

{
    "returnCode": "Success",
    "error": "",
    "result": {
        "payload": {
            "msg": "Total Holding Balance is: 600",
            "holding_balance": 600
        },
        "encode": "JSON"
    }
}

getStablecoinAccountOnHoldBurnBalance

Ursprünglicher Methodenname: getAccountOnHoldBurnBalance

Diese Methode gibt den gesperrten Burn-Balance für einen angegebenen Benutzer zurück. Diese Methode kann nur von einer Token Admin oder Token Auditor, einer Org Admin oder Org Auditor der angegebenen Organisation oder dem Eigentümer des Accounts aufgerufen werden.

Payload:

{{api-gateway-endpoint1}}/getStablecoinAccountOnHoldBurnBalance?tokenId={{bc-token-id}}&orgId={{bc-org-id}}&userId={{bc-user-id}}

Parameter:

• tokenId: string: Die ID des Tokens.
• orgId: string: Die Mitgliedsdienstanbieter-(MSP-)ID des Benutzers in der aktuellen Organisation.
• userId: string: Der Benutzername oder die E-Mail-ID des Benutzers.

Beispiel für Rückgabewert:

{
    "returnCode": "Success",
    "error": "",
    "result": {
        "payload": {
            "msg": "Total On Hold Burning Balance is: 0",
            "onhold_burn_balance": 0
        },
        "encode": "JSON"
    }
}    

getStablecoinAccountPolicyCheckById

Ursprünglicher Methodenname: getAccountPolicyCheckById

Diese Methode ruft die Account-Policy-Details für eine angegebene Policy-ID ab. Diese Methode kann nur von Token Admin oder Token Auditor oder Org Admin oder Org Auditor der angegebenen Organisation aufgerufen werden.

Payload:

{{api-gateway-endpoint1}}/getStablecoinAccountPolicyCheckById?id=id value

Parameter:

• id: string: Die eindeutige ID der Accountrichtlinie.

Beispiel für Rückgabewert:

{
    "returnCode": "Success",
    "error": "",
    "result": {
        "txid": "02875ca9c6a7408da3f81156214228b91b09c4bb2b8026d7a5733b53598c6635",
        "payload": {
            "assetType": "AccountPolicyCheck",
            "accountPolicyId": "APID~CentralBank~cb__creator_demo",
            "orgId": "CentralBank",
            "userId": "cb__creator_demo",
            "kycCompliance": "true",
            "amlCompliance": "true",
            "riskScore": 1000,
            "restrictionFlag": "false"
        },
        "encode": "JSON",
        "sourceURL": "cb-oabcs1-bom.blockchain.ocp.example.com:20010",
        "blockNumber": 272
    }
}

getStablecoinAccountsByRole

Ursprünglicher Methodenname: getAccountsByRole

Diese Methode gibt eine Liste aller Konto-IDs für eine angegebene Rolle und ein bestimmtes Token zurück. Diese Methode kann nur mit einer Token Admin oder Token Auditor aufgerufen werden.

Payload:

{{api-gateway-endpoint1}}/getStablecoinAccountsByRole?tokenId={{bc-token-id}}&role=role value (for example minter / burner / notary)

Parameter:

• tokenId: string: Die ID des Tokens.
• role: string: Der Name der Rolle, nach der gesucht werden soll.

Beispiel für Rückgabewert:

{
    "returnCode": "Success",
    "error": "",
    "result": {
        "payload": {
            "accounts": [
                "oaccount~374e4e762940fc185c7cd5b6528c7f94985b6c56acf46abb746de6381589edd2"
            ]
        },
        "encode": "JSON"
    }
}

getStablecoinAccountsByUser

Ursprünglicher Methodenname: getAccountsByUser

Diese Methode gibt eine Liste aller Konto-IDs für eine angegebene Organisations-ID und Benutzer-ID zurück. Diese Methode kann nur von einer Token Admin oder Token Auditor des Chaincodes, einer Org Admin oder Org Auditor der angegebenen Organisation oder der AccountOwner des Accounts aufgerufen werden.

/getStablecoinAccountsByUser?orgId={{bc-org-id}}&userId={{bc-user-id}}

Parameter:

• orgId: string: Die Mitgliedsdienstanbieter-(MSP-)ID des Benutzers in der aktuellen Organisation.
• userId: string: Der Benutzername oder die E-Mail-ID des Benutzers.

Beispiel für Rückgabewert:

{
    "returnCode": "Success",
    "error": "",
    "result": {
        "payload": [
            {
                "bapAccountVersion": 0,
                "assetType": "oaccount",
                "account_id": "oaccount~8db15b42910eeec401e1bf22c69dfdd11c820ecc26539ea03a3426fa25cb8c28",
                "user_id": "admin_user_cb",
                "org_id": "CB",
                "token_type": "fungible",
                "token_id": "",
                "token_name": "",
                "balance": 0,
                "onhold_balance": 0,
                "max_daily_amount": 10000,
                "daily_amount": 0,
                "max_daily_transactions": 1000,
                "daily_transactions": 0,
                "current_date": "2024-11-20T00:00:00.000Z"
            },
            {
                "bapAccountVersion": 0,
                "assetType": "oaccount",
                "account_id": "oaccount~cdc6fa5e64bc29f700f99da69f980d8cbb768c7e1a11dd17274e75651f6afafe",
                "user_id": "admin_user_cb",
                "org_id": "CB",
                "token_type": "fungible",
                "token_id": "USD",
                "token_name": "Stablecoin",
                "balance": 0,
                "onhold_balance": 0,
                "max_daily_amount": 10000,
                "daily_amount": 0,
                "max_daily_transactions": 1000,
                "daily_transactions": 0,
                "current_date": "2024-11-20T00:00:00.000Z"
            },
            {
                "bapAccountVersion": 0,
                "assetType": "oaccount",
                "account_id": "oaccount~28ac774001f374064029d51af4fb67e26ea1ea9ef62828b7a72dbf3beb8efd8d",
                "user_id": "admin_user_cb",
                "org_id": "CB",
                "token_type": "fungible",
                "token_id": "",
                "token_name": "",
                "balance": 0,
                "onhold_balance": 0,
                "max_daily_amount": 10000,
                "daily_amount": 0,
                "max_daily_transactions": 100,
                "daily_transactions": 0,
                "current_date": "2024-12-09T00:00:00.000Z"
            }
        ],
        "encode": "JSON"
    }
}

getStablecoinAccountStatus

Ursprünglicher Methodenname: getAccountStatus

Diese Methode ruft den aktuellen Status des Token-Accounts ab. Diese Methode kann von Token Admin oder Token Auditor, einer Org Admin oder Org Auditor der angegebenen Organisation oder vom Tokenkontoinhaber aufgerufen werden. Wenn der Wert accountStatus nicht im Buch gefunden wird, gibt diese Methode ein Objekt accountStatus zurück, dessen Status auf "Aktiv" gesetzt ist.

Payload:

{{api-gateway-endpoint1}}/getStablecoinAccountStatus?tokenId={{bc-token-id}}&orgId={{bc-org-id}}&userId={{bc-user-id}}

Parameter:

• tokenId: string: Die ID des Tokens.
• orgId: string: Die Mitgliedsdienstanbieter-(MSP-)ID des Benutzers in der aktuellen Organisation.
• userId: string: Der Benutzername oder die E-Mail-ID des Benutzers.

Beispiel für Rückgabewert:

{
    "returnCode": "Success",
    "error": "",
    "result": {
        "payload": {
            "assetType": "oaccountStatus",
            "status_id": "oaccountStatus~cfe302f06bf732f248315725bb601d7906d7c1d4c167d04ac3a5283b8dbc7fc4",
            "account_id": "oaccount~374e4e762940fc185c7cd5b6528c7f94985b6c56acf46abb746de6381589edd2",
            "status": "active"
        },
        "encode": "JSON"
    }
}

getStablecoinAccountTransactionHistoryWithFilters

Ursprünglicher Methodenname: getAccountTransactionHistoryWithFiltersFromRichHistDB

Diese Methode gibt die Details der Kontotransaktionshistorie aus der Rich-History-Datenbank zurück. Diese Methode kann nur von einer Token Admin oder Token Auditor des Chaincodes, einer Org Admin oder Org Auditor der angegebenen Organisation oder der AccountOwner des Accounts aufgerufen werden.

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

Parameter:

• tokenId: string: Die ID des Tokens.
• orgId: string: Die Mitgliedsdienstanbieter-(MSP-)ID des Benutzers in der aktuellen Organisation.
• userId: string: Der Benutzername oder die E-Mail-ID des Benutzers.
• customEndpoint: Der RESTful-Serviceendpunkt der Rich History-Datenbank, aus der die Transaktionshistorie abgerufen werden soll.
• bearerToken: Das Token, mit dem der RESTful-Endpunkt aufgerufen wird, um sicherzustellen, dass die Anforderung autorisiert ist.
• filters: JSON object: Ein optionaler Parameter. Wenn leer, werden alle Datensätze zurückgegeben. Die Eigenschaft pageSize bestimmt die Anzahl der zurückzugebenden Datensätze. Wenn pageSize 0 ist, ist die Standardseitengröße 20. Die Eigenschaft bookmark bestimmt den Startindex der zurückzugebenden Datensätze. Die Eigenschaften startTime und endTime müssen im RFC-3339-Format angegeben werden.

Beispiel für Rückgabewert:

{
    "returnCode": "Success",
    "error": "",
    "result": {
        "payload": [
            {
                "transaction_id": "otransaction~64c5a4830949eae1424600f3d4a438c6f603a7c3ea31a68e374b899803999e22",
                "transacted_amount": 10,
                "timestamp": "2024-12-11T13:37:28.000Z",
                "balance": 550,
                "onhold_balance": 10,
                "token_id": "USD",
                "category": "category value",
                "description": "description value",
                "transacted_account": "oaccount~9d9806fa92aa0c4fdb34eaffac6e830181b5d47e64fbce752195e83024125ca0",
                "transaction_type": "REJECT_MINT",
                "transacted_org_id": "CB",
                "transacted_user_id'": "creator_user_cb"
            },
            {
                "transaction_id": "otransaction~a4537ef34a955b023b7c205b9abf06a6c79e4fdd761fb24f41b8eb34126b66c0",
                "transacted_amount": 10,
                "timestamp": "2024-12-11T13:36:32.000Z",
                "balance": 550,
                "onhold_balance": 10,
                "token_id": "USD",
                "description": "description value",
                "transacted_account": "oaccount~9d9806fa92aa0c4fdb34eaffac6e830181b5d47e64fbce752195e83024125ca0",
                "transaction_type": "APPROVE_MINT",
                "transacted_org_id": "CB",
                "transacted_user_id'": "creator_user_cb"
            },
            {
                "transaction_id": "otransaction~6237a759422bd9fb112742e8cd7e6450df5a74a32236d9b1005571afed8904a4",
                "transacted_amount": 10,
                "timestamp": "2024-12-11T13:36:18.000Z",
                "balance": 540,
                "onhold_balance": 10,
                "token_id": "USD",
                "category": "category value",
                "description": "description value",
                "transacted_account": "oaccount~9d9806fa92aa0c4fdb34eaffac6e830181b5d47e64fbce752195e83024125ca0",
                "transaction_type": "REQUEST_MINT",
                "transacted_org_id": "CB",
                "transacted_user_id'": "creator_user_cb"
            },
            {
                "transaction_id": "otransaction~06b35071415d74aa1a7c18449149c937d886cae76a832c44cf8d98e84586e76e",
                "transacted_amount": 10,
                "timestamp": "2024-12-11T13:35:46.000Z",
                "balance": 540,
                "onhold_balance": 10,
                "token_id": "USD",
                "category": "category value",
                "description": "description value",
                "transacted_account": "oaccount~9d9806fa92aa0c4fdb34eaffac6e830181b5d47e64fbce752195e83024125ca0",
                "transaction_type": "REQUEST_MINT",
                "transacted_org_id": "CB",
                "transacted_user_id'": "creator_user_cb"
            }
        ],
        "encode": "JSON"
    }
}

getTokenAuditors

Ursprünglicher Methodenname: getTokenAuditors

Diese Methode gibt alle Token Auditors des Chaincodes zurück. Diese Methode kann nur mit einer Token Admin oder Token Auditor aufgerufen werden.

Payload:

 	
{{api-gateway-endpoint1}}/getTokenAuditors

Parameter:

• Kein

Beispiel für Rückgabewert:

{
    "returnCode": "Success",
    "error": "",
    "result": {
        "payload": {
            "auditors": [
                {
                    "org_id": "CentralBank",
                    "user_id": "cb_auditor_demo"
                }
            ]
        },
        "encode": "JSON"
    }
}

getTokenById

Ursprünglicher Methodenname: getTokenById

Diese Methode gibt die Tokendetails für eine angegebene Token-ID zurück. Diese Methode kann nur von einer Token Admin oder Token Auditor oder Org Admin oder Org Auditor einer beliebigen Organisation aufgerufen werden.

Payload:

{{api-gateway-endpoint1}}/getTokenById?tokenId={{bc-token-id}}

Parameter:

• tokenId: string: Die ID des Tokens.

Beispiel für Rückgabewert:

{
    "returnCode": "Success",
    "error": "",
    "result": {
        "payload": {
            "assetType": "otoken",
            "events": false,
            "token_id": "t1",
            "token_name": "stablecoin",
            "token_desc": "token_desc value",
            "token_standard": "ttf+",
            "token_type": "fungible",
            "token_unit": "fractional",
            "behaviors": [
                "divisible",
                "mintable",
                "transferable",
                "burnable",
                "holdable",
                "roles"
            ],
            "roles": {
                "minter_role_name": "minter",
                "burner_role_name": "burner",
                "notary_role_name": "notary",
                "mint_approver_role_name": "notary",
                "burn_approver_role_name": "notary"
            },
            "mintable": {
                "max_mint_quantity": 0,
                "mint_approval_required": true
            },
            "burnable": {
                "burn_approval_required": true
            },
            "divisible": {
                "decimal": 2
            },
            "currencyName": "currencyName value",
            "conversionRate": 999
        },
        "encode": "JSON"
    }
}

getTokenHistory

Ursprünglicher Methodenname: getTokenHistory

Diese Methode gibt die Tokenhistorie für eine angegebene Token-ID zurück. Diese Methode kann nur von einer Token Admin oder Token Auditor oder Org Admin oder Org Auditor einer beliebigen Organisation aufgerufen werden.

Payload:

{{api-gateway-endpoint1}}/getTokenHistory?tokenId={{bc-token-id}}

Parameter:

• tokenId: string: Die ID des Tokens.

Beispiel für Rückgabewert:

{
    "returnCode": "Success",
    "error": "",
    "result": {
        "payload": [
            {
                "trxId": "28c205ee6f607d77490ab28aa99729a700c34e524efe805b213a526e58dd2b40",
                "timeStamp": "2025-11-20T21:30:16.000Z",
                "value": {
                    "assetType": "otoken",
                    "events": false,
                    "token_id": "t1",
                    "token_name": "stablecoin",
                    "token_desc": "token_desc value",
                    "token_standard": "ttf+",
                    "token_type": "fungible",
                    "token_unit": "fractional",
                    "behaviors": [
                        "divisible",
                        "mintable",
                        "transferable",
                        "burnable",
                        "holdable",
                        "roles"
                    ],
                    "roles": {
                        "minter_role_name": "minter",
                        "burner_role_name": "burner",
                        "notary_role_name": "notary",
                        "mint_approver_role_name": "notary",
                        "burn_approver_role_name": "notary"
                    },
                    "mintable": {
                        "max_mint_quantity": 0,
                        "mint_approval_required": true
                    },
                    "burnable": {
                        "burn_approval_required": true
                    },
                    "divisible": {
                        "decimal": 2
                    },
                    "currencyName": "currencyName value",
                    "conversionRate": 999
                }
            }
        ],
        "encode": "JSON"
    }
}

getTotalMintedTokens

Ursprünglicher Methodenname: getTotalMintedTokens

Diese Methode gibt die Gesamtanzahl der ausgeprägten Token für ein angegebenes Token zurück. Diese Methode kann nur mit Token Admin, Token Auditor, Org Admin oder Org Auditor aufgerufen werden.

Abfrage:

/getTotalCreatedStablecoinTokens?tokenId={{bc-token-id}}

Parameter:

• tokenId: string: Die ID des Tokens.

Beispiel für Rückgabewert:

{
    "returnCode": "Success",
    "error": "",
    "result": {
        "payload": {
            "msg": "Total minted token for Token Id: USD is 910 tokens.",
            "quantity": 910
        },
        "encode": "JSON"
    }
}

getTransactionById

Ursprünglicher Methodenname: getTransactionById

Diese Methode gibt den detaillierten Transaktionsdatensatz für eine angegebene Transaktions-ID zurück. Diese Methode kann nur von der Token Admin oder von jedem Konto aufgerufen werden, das von der Transaktion angegeben wird (Absender, Empfänger oder Notar).

Payload:

{{api-gateway-endpoint1}}/getTransactionById?transactionId=transaction_id value

Parameter:

• transaction_id string: Die ID der Transaktion.

Beispiel für Rückgabewert:

{
    "returnCode": "Success",
    "error": "",
    "result": {
        "payload": {
            "transaction_id": "otransaction~493a6cdcaac058ab6ae2bd001e8a761e378e99e283b06443041d286d46d077c4",
            "history": [
                {
                    "trxId": "493a6cdcaac058ab6ae2bd001e8a761e378e99e283b06443041d286d46d077c4",
                    "timeStamp": "2025-11-24T09:50:59.000Z",
                    "value": {
                        "assetType": "otransaction",
                        "transaction_id": "otransaction~493a6cdcaac058ab6ae2bd001e8a761e378e99e283b06443041d286d46d077c4",
                        "token_id": "t1",
                        "from_account_id": "oaccount~374e4e762940fc185c7cd5b6528c7f94985b6c56acf46abb746de6381589edd2",
                        "from_account_onhold_burn_balance": 0,
                        "to_account_id": "oaccount~79c427e614530eacad6fb07cff6048f6b96283e65019301320c9684932846f64",
                        "to_account_onhold_burn_balance": 0,
                        "transaction_type": "ONHOLD",
                        "amount": 600,
                        "timestamp": "2025-11-24T09:50:59.000Z",
                        "number_of_sub_transactions": 0,
                        "holding_id": "ohold~stablecoin~t1~hold2",
                        "sub_transaction": "false",
                        "category": "category value",
                        "description": "description value"
                    }
                }
            ],
            "sub_transactions": []
        },
        "encode": "JSON"
    }
}

getUserByStablecoinAccountId

Ursprünglicher Methodenname: getUserByAccountId

Diese Methode gibt Benutzerdetails (org_id, user_id und token_id) für einen angegebenen Account zurück. Diese Methode kann nur von einer Token Admin oder Token Auditor des Chaincodes oder einer Org Admin oder Org Auditor der angegebenen Organisation aufgerufen werden.

Abfrage:

/getUserByStablecoinAccountId?accountId=account_id value

Parameter:

• accountId: string: Die ID des Kontos.

Beispiel für Rückgabewert:

{
    "returnCode": "Success",
    "error": "",
    "result": {
        "payload": {
            "token_id": "USD",
            "user_id": "admin_user_cb",
            "org_id": "CB"
        },
        "encode": "JSON"
    }
}

getUsersByRole

Ursprünglicher Methodenname: getUsersByRole

Diese GET-Methode gibt eine Liste aller Benutzer für eine angegebene Rolle und ein bestimmtes Token zurück. Diese Methode kann nur mit einer Token Admin oder Token Auditor des Chaincodes aufgerufen werden.

Abfrage:

/getUsersByRole?tokenId={{bc-token-id}}&role=role value (for example minter / burner / notary)

Parameter:

• tokenId: string: Die ID des Tokens.
• role: string: Der Name der Rolle, nach der gesucht werden soll.

Beispiel für Rückgabewert:

{
    "returnCode": "Success",
    "error": "",
    "result": {
        "payload": {
            "users": [
                {
                    "token_id": "USD",
                    "user_id": "creator_user_cb",
                    "org_id": "CB"
                },
                {
                    "token_id": "USD",
                    "user_id": "cb4",
                    "org_id": "CB"
                }
            ]
        },
        "encode": "JSON"
    }
}

holdTokens

Ursprünglicher Methodenname: holdTokens

Mit dieser Methode wird eine Sperre im Namen des Eigentümers der Token mit dem Konto to_account_id erstellt. Es wird ein Notarkonto angegeben, das die Sperre entweder abschließen oder freigeben muss. Wenn die Sperre erstellt wird, wird der angegebene Tokensaldo des Zahlers gesperrt. Ein gesperrter Saldo kann erst übertragen werden, wenn die Sperre abgeschlossen oder freigegeben wurde. Für den Aufrufer dieser Methode muss bereits ein Konto erstellt sein.

Payload:

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

Parameter:

• tokenId: string: Die ID des Tokens.
• operationId: string: Eine eindeutige ID zur Identifizierung des Sperrvorgangs. Normalerweise wird diese ID von der Clientanwendung übergeben.
• toOrgId: string: Die MSP-ID (Member Service Provider) des Empfängers in der aktuellen Organisation.
• toUserId: string: Der Benutzername oder die E-Mail-ID des Empfängers.
• notaryOrgId: string: Die Mitgliedsdienstanbieter-ID (MSP) des Notars in der aktuellen Organisation.
• notaryUserId: string: Der Benutzername oder die E-Mail-ID des Notars.
• quantity: number: Die Anzahl der zurückzustellenden Token.
• timeToExpiration: Der Zeitpunkt, zu dem die Sperre abläuft. Geben Sie 0 für eine permanente Sperre an. Verwenden Sie andernfalls das RFC-3339-Format. Beispiel: 2021-06-02T12:46:06Z.
• infoDetails: JSON: Die Beschreibung und Kategorie, wie im folgenden Beispiel gezeigt.

  {
     "category" : "category input",
     "description" : "description input"
  }

• endorsers: string[]: Ein Array der Peers (z.B. peer1, peer2), das die Transaktion freigeben muss.

Beispiel für Rückgabewert:

{
    "returnCode": "Success",
    "error": "",
    "result": {
        "txid": "e575d339299bb98afe83207e749cd07654f209673c84c6973738b6094da33062",
        "payload": {
            "msg": "AccountId oaccount~51e676d7182a02ea7418ef58a6d54ecfe3858ef40b4ffb3d859b320da3921594 (Org-Id: CB , User-Id: issuer_user_cb) is successfully holding 10 tokens"
        },
        "encode": "JSON",
        "sourceURL": "cb-oabcs1-bom.blockchain.ocp.example.com:20009",
        "blockNumber": 211
    }
}

init

Ursprünglicher Methodenname: init

Diese Methode wird aufgerufen, wenn der Chaincode bereitgestellt wird. Die Benutzerinformationen werden als Token Admin des Chaincodes gespeichert.

Payload:

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

Parameter:

• adminList: TokenAdminAsset[]: Ein Array von JSON-Objekten, das eine Organisations-ID und eine Benutzer-ID enthält, die den Tokenadministrator mit dem folgenden Format angeben:

  {
     "org_id":"{{bc-org-id}}",
     "user_id":"{{bc-admin-user}
  }

Beispiel für Rückgabewert:

{
    "returnCode": "Success",
    "error": "",
    "result": {
        "txid": "fdb7dc89832c8045a333823b77fa24ae628178148dc93b3550040e070d7cd807",
        "payload": "",
        "encode": "UTF-8",
        "sourceURL": "cb-oabcs1-bom.blockchain.ocp.example.com:20009",
        "blockNumber": 263
    }
}

initializeStablecoinToken

Ursprünglicher Methodenname: initializeStablecoinToken

Diese Methode erstellt ein Token und initialisiert die Tokeneigenschaften. Das Asset und seine Eigenschaften werden in der Statusdatenbank gespeichert. Diese Methode kann nur von einem Token Admin des Chaincodes aufgerufen werden.

Payload:

{
    "tokenAsset": "{\"token_id\":\"{{bc-token-id}}\",\"token_desc\":\"token_desc value\",\"Currency_Name\":\"Currency_Name value\"}",
    "sameOrgEndorser": true
}

Parameter:

• tokenAsset: <Token Class>: Das Tokenasset wird als Parameter an diese Methode übergeben. Die Eigenschaften des Tokenassets werden in der Modelldatei beschrieben.
• sameOrgEndorser: boolean: Ein boolescher Wert, der angibt, ob Transaktionsbestätigungen von derselben Organisation wie der Anforderer stammen müssen.

Rückgabewert:

• Bei Erfolg eine JSON-Darstellung des erstellten Tokenassets.

Beispiel für Rückgabewert:

{
    "returnCode": "Success",
    "error": "",
    "result": {
        "txid": "aa7a4f4cc214e1a041a5a6fb7ca7530f08256559e538c9f9582e6fd12c9e65c8",
        "payload": {
            "assetType": "otoken",
            "events": false,
            "token_id": "t1",
            "token_name": "Stablecoin",
            "token_desc": "token_desc value",
            "token_standard": "ttf+",
            "token_type": "fungible",
            "token_unit": "fractional",
            "behaviors": [
                "divisible",
                "mintable",
                "transferable",
                "burnable",
                "holdable",
                "roles"
            ],
            "roles": {
                "minter_role_name": "minter",
                "burner_role_name": "burner",
                "notary_role_name": "notary",
                "mint_approver_role_name": "notary",
                "burn_approver_role_name": "notary"
            },
            "mintable": {
                "max_mint_quantity": 1000,
                "mint_approval_required": true
            },
            "burnable": {
                "burn_approval_required": true
            },
            "divisible": {
                "decimal": 2
            },
            "currency_name": "currency_name value",
            "token_to_currency_ratio": 999
        },
        "encode": "JSON",
        "sourceURL": "cb-oabcs1-bom.blockchain.ocp.example.com:20009",
        "blockNumber": 267
    }
}

isInRole

Ursprünglicher Methodenname: isInRole

Diese Methode gibt einen booleschen Wert zurück, um anzugeben, ob ein Benutzer und ein Token eine bestimmte Rolle haben. Diese Methode kann nur von einem Token Admin oder dem Eigentümer des Accounts aufgerufen werden.

Payload:

{{api-gateway-endpoint2}}/isInRole?tokenId={{bc-token-id}}&orgId={{bc-org-id}}&userId={{bc-user-id}}&role=role value (for example minter / burner / notary)

Parameter:

• tokenId: string: Die ID des Tokens.
• orgId: string: Die Mitgliedsdienstanbieter-(MSP-)ID des Benutzers.
• userId: string: Der Benutzername oder die E-Mail-ID des Benutzers.
• role: string: Der Name der Rolle.

Beispiel für Rückgabewert:

{
    "returnCode": "Success",
    "error": "",
    "result": {
        "payload": {
            "result": "true"
        },
        "encode": "JSON"
    }
}

isTokenAdmin

Ursprünglicher Methodenname: isTokenAdmin

Diese Methode gibt den booleschen Wert true zurück, wenn der angegebene Account ein Token Admin ist, andernfalls gibt sie false zurück. Die Methode THis kann nur mit einem Token Admin aufgerufen werden.

Payload:

{{api-gateway-endpoint2}}/isTokenAdmin?orgId={{bc-org-id}}&userId={{bc-user-id}}

Parameter:

• orgId: string: Die Mitgliedsdienstanbieter-(MSP-)ID des Benutzers in der aktuellen Organisation.
• userId: string: Der Benutzername oder die E-Mail-ID des Benutzers.

Beispiel für Rückgabewert:

{
    "returnCode": "Success",
    "error": "",
    "result": {
        "payload": {
            "result": false
        },
        "encode": "JSON"
    }
}

rejectBurn

Ursprünglicher Methodenname: rejectBurn

Diese Methode kann von einem Notar aufgerufen werden, um eine brennende Anfrage abzulehnen.

Payload:

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

Parameter:

• tokenId: string: Die ID des Tokens, das zum Brennen abgelehnt werden soll.
• operationId: string: Die eindeutige Vorgangs-ID, die für die Burn-Anforderung steht.
• sameOrgEndorser: boolean: Ein boolescher Wert, der angibt, ob Transaktionsbestätigungen von derselben Organisation wie der Anforderer stammen müssen.

Beispiel für Rückgabewert:

{
    "returnCode": "Success",
    "error": "",
    "result": {
        "txid": "474a08183986c84fe321aa925670539db3b1bc90b02fa65956ad8c771fff5bbe",
        "payload": {
            "msg": "Successfully rejected burn request with Operation Id 'burn1234' to burn 10 tokens of token id USD"
        },
        "encode": "JSON",
        "sourceURL": "cb-oabcs1-bom.blockchain.ocp.example.com:20009",
        "blockNumber": 210
    }
}

rejectMint

Ursprünglicher Methodenname: rejectMint

Diese Methode kann von einem Notar aufgerufen werden, um eine Prägeanforderung abzulehnen.

Payload:

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

Parameter:

• tokenId: string: Die ID des Tokens, das das Minting ablehnen soll.
• operationId: string: Die eindeutige Vorgangs-ID, die der Mint-Anforderung entspricht.
• sameOrgEndorser: boolean: Ein boolescher Wert, der angibt, ob Transaktionsbestätigungen von derselben Organisation wie der Anforderer stammen müssen.

Beispiel für Rückgabewert:

{
    "returnCode": "Success",
    "error": "",
    "result": {
        "txid": "64c5a4830949eae1424600f3d4a438c6f603a7c3ea31a68e374b899803999e22",
        "payload": {
            "msg": "Successfully rejected mint request with Operation Id 'op1234' to mint 10 tokens of token id USD"
        },
        "encode": "JSON",
        "sourceURL": "cb-oabcs1-bom.blockchain.ocp.example.com:20009",
        "blockNumber": 205
    }
}

releaseHoldTokens

Ursprünglicher Methodenname: releaseHoldTokens

Diese POST-Methode gibt eine Sperre für Token frei. Die Übertragung ist nicht abgeschlossen, und alle zurückgestellten Token stehen dem ursprünglichen Eigentümer erneut zur Verfügung. Diese Methode kann durch die AccountOwner-ID mit der Rolle notary innerhalb der angegebenen Frist oder durch den Zahler, Zahlungsempfänger oder Notar nach der angegebenen Frist aufgerufen werden.

Payload:

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

Parameter:

• tokenId: string: Die ID des Tokens.
• operationId: string: Eine eindeutige ID zur Identifizierung des Sperrvorgangs. Normalerweise wird diese ID von der Clientanwendung übergeben.
• endorsers: string[]: Ein Array der Peers (z.B. peer1, peer2), das die Transaktion freigeben muss.

Beispiel für Rückgabewert:

{
    "returnCode": "Success",
    "error": "",
    "result": {
        "txid": "f04ba8895d52bc636d843f88476002bc99d01480c36be87c8fa259cd47a29380",
        "payload": {
            "msg": "Successfully released '10' tokens from Operation Id '8e3144' to Account Id: oaccount~51e676d7182a02ea7418ef58a6d54ecfe3858ef40b4ffb3d859b320da3921594 (Org-Id: CB, User-Id: issuer_user_cb)."
        },
        "encode": "JSON",
        "sourceURL": "cb-oabcs1-bom.blockchain.ocp.example.com:20009",
        "blockNumber": 214
    }
}

removeOrgAdmin

Ursprünglicher Methodenname: removeOrgAdmin

Mit dieser POST-Methode wird ein Benutzer als Org Admin des Chaincodes entfernt. Diese Methode kann nur von einem Token Admin oder Org Admin der angegebenen Organisation aufgerufen werden.

Payload:

{
    "orgId": "{{bc-org-id}}",
    "userId": "{{bc-user-id}}",
    "sameOrgEndorser": true
}

Parameter:

• orgId: string: Die Mitgliedsdienstanbieter-(MSP-)ID des Benutzers in der aktuellen Organisation.
• userId: string: Der Benutzername oder die E-Mail-ID des Benutzers.
• sameOrgEndorser: boolean: Ein boolescher Wert, der angibt, ob Transaktionsbestätigungen von derselben Organisation wie der Anforderer stammen müssen.

Beispiel für Rückgabewert:

{
    "returnCode": "Success",
    "error": "",
    "result": {
        "txid": "e2a634f6093f89b1984e20ff86a513fabb7c3ade7cc9e27d9734b4aaf6c88597",
        "payload": {
            "msg": "Successfully removed Org Admin (Org_Id: CB, User_Id: cb)"
        },
        "encode": "JSON",
        "sourceURL": "cb-oabcs1-bom.blockchain.ocp.example.com:20010",
        "blockNumber": 220
    }
}

removeOrgAuditor

Ursprünglicher Methodenname: removeOrgAuditor

Mit dieser POST-Methode wird ein Benutzer als Org Auditor des Chaincodes entfernt. Diese Methode kann nur von einem Token Admin oder Org Admin der angegebenen Organisation aufgerufen werden.

Payload:

{
    "orgId": "{{bc-org-id}}",
    "userId": "{{bc-user-id}}",
    "sameOrgEndorser": true
}

Parameter:

• orgId: string: Die Mitgliedsdienstanbieter-(MSP-)ID des Benutzers in der aktuellen Organisation.
• userId: string: Der Benutzername oder die E-Mail-ID des Benutzers.
• sameOrgEndorser: boolean: Ein boolescher Wert, der angibt, ob Transaktionsbestätigungen von derselben Organisation wie der Anforderer stammen müssen.

Beispiel für Rückgabewert:

{
    "returnCode": "Success",
    "error": "",
    "result": {
        "txid": "c3bc720461004a53b37c68d4bb264858b88d980bc093a0a3ebb62a32974fb306",
        "payload": {
            "msg": "Successfully removed Org Auditor (Org_Id: CB, User_Id: cb)"
        },
        "encode": "JSON",
        "sourceURL": "cb-oabcs1-bom.blockchain.ocp.example.com:20010",
        "blockNumber": 221
    }
}

removeRole

Ursprünglicher Methodenname: removeRole

Diese Methode entfernt die af-Rolle aus einem angegebenen Benutzer und Token. Diese Methode kann nur durch eine Token Admin des Chaincodes oder durch eine Org Admin der angegebenen Organisation aufgerufen werden.

Payload:

{
    "tokenId": "{{bc-token-id}}",
    "role": "role value (for example minter / burner / notary)",
    "orgId": "{{bc-org-id}}",
    "userId": "{{bc-user-id}}",
    "endorsers": {{endorsers}}
}

Parameter:

• tokenId: string: Die ID des Tokens.
• role: string: Der Name der Rolle, die aus dem angegebenen Benutzer entfernt werden soll. Das Verhalten von mintable und burnable entspricht den Eigenschaften minter_role_name und burner_role_name der Spezifikationsdatei. Entsprechend entspricht die Rolle notary der Eigenschaft notary_role_name der Spezifikationsdatei.
• orgId: string: Die Mitgliedsdienstanbieter-(MSP-)ID des Benutzers in der aktuellen Organisation.
• userId: string: Der Benutzername oder die E-Mail-ID des Benutzers.
• endorsers: string[]: Ein Array der Peers (z.B. peer1, peer2), das die Transaktion freigeben muss.

Rückgabewert:

• Bei Erfolg eine Nachricht mit Accountdetails.

Beispiel für Rückgabewert:

{
    "returnCode": "Success",
    "error": "",
    "result": {
        "txid": "274f0d0a2c4c3929817fb85b2e857519695c3c238ccf9903b084b87e9be7ee12",
        "payload": {
            "msg": "Successfully removed role 'notary' from Account Id: oaccount~2eb5f8a9bc561f8f41a4ea3be9511958cc6684ef14f2337ca396efc301b627d8 (Org-Id: CB, User-Id: manager_user_cb)"
        },
        "encode": "JSON",
        "sourceURL": "cb-oabcs1-bom.blockchain.ocp.example.com:20009",
        "blockNumber": 200
    }
}

removeTokenAdmin

Ursprünglicher Methodenname: removeTokenAdmin

Mit dieser POST-Methode wird ein Benutzer als Token Admin des Chaincodes entfernt. Diese Methode kann nur von einem Token Admin des Chaincodes aufgerufen werden. Ein Administrator kann sich nicht selbst entfernen.

Payload:

{
    "orgId": "{{bc-org-id}}",
    "userId": "{{bc-user-id}}",
    "sameOrgEndorser": true
}

Parameter:

• orgId: string: Die Mitgliedsdienstanbieter-(MSP-)ID des Benutzers in der aktuellen Organisation.
• userId: string: Der Benutzername oder die E-Mail-ID des Benutzers.
• sameOrgEndorser: boolean: Ein boolescher Wert, der angibt, ob Transaktionsbestätigungen von derselben Organisation wie der Anforderer stammen müssen.

Beispiel für Rückgabewert:

{
    "returnCode": "Success",
    "error": "",
    "result": {
        "txid": "6a3b9b568d04b5beb29830f91efe4e8c6310b6cf36940cecfb4ab690fbfde739",
        "payload": {
            "msg": "Successfully removed Token Admin (Org_Id: CB, User_Id: cb)"
        },
        "encode": "JSON",
        "sourceURL": "cb-oabcs1-bom.blockchain.ocp.example.com:20010",
        "blockNumber": 218
    }
}

removeTokenAuditor

Ursprünglicher Methodenname: removeTokenAuditor

Mit dieser POST-Methode wird ein Benutzer als Token Auditor des Chaincodes entfernt. Diese Methode kann nur von einem Token Admin des Chaincodes aufgerufen werden.

Payload:

{
    "orgId": "{{bc-org-id}}",
    "userId": "{{bc-user-id}}",
    "sameOrgEndorser": true
}

Parameter:

• orgId: string: Die Mitgliedsdienstanbieter-(MSP-)ID des Benutzers in der aktuellen Organisation.
• userId: string: Der Benutzername oder die E-Mail-ID des Benutzers.
• sameOrgEndorser: boolean: Ein boolescher Wert, der angibt, ob Transaktionsbestätigungen von derselben Organisation wie der Anforderer stammen müssen.

Beispiel für Rückgabewert:

{
    "returnCode": "Success",
    "error": "",
    "result": {
        "txid": "a886a6040fbc76374a3c78c89ab0ffc9f7b8391cc5239b169bf3b878cf40c67b",
        "payload": {
            "msg": "Successfully removed Token Auditor (Org_Id: CB, User_Id: cb)"
        },
        "encode": "JSON",
        "sourceURL": "cb-oabcs1-bom.blockchain.ocp.example.com:20010",
        "blockNumber": 219
    }
}

requestBurn

Ursprünglicher Methodenname: requestBurn

Diese Methode kann von einem Brenner aufgerufen werden, um eine Anforderung an den Notar zu senden, um eine bestimmte Anzahl von Token zu zerstören.

Payload:

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

Parameter:

• tokenId: string: Die ID des zu brennenden Tokens.
• operationId: string: Die eindeutige Vorgangs-ID, die für die Burn-Anforderung steht.
• notaryOrgId: string: Die Mitgliedsdienstanbieter-(MSP-)ID des Brennernotars, der die Anfrage verarbeitet.
• notaryUserId: string: Der Benutzername oder die E-Mail-ID des Notars, der die Anforderung verarbeitet.
• quantity: number - Die Anzahl der zu brennenden Token.
• timeToExpiration: Die Zeit, nach der die Brennen-Anforderung abläuft und nicht mehr gültig ist.
• infoDetails: JSON: Ein Objekt, das die Kategorie (category) und die Beschreibung (description) der Anforderung angibt, wie im folgenden Beispiel dargestellt.

  {
       "category" : "category input",
       "description" : "description input"
  }

• sameOrgEndorser: boolean: Ein boolescher Wert, der angibt, ob Transaktionsbestätigungen von derselben Organisation wie der Anforderer stammen müssen.

Beispiel für Rückgabewert:

{
    "returnCode": "Success",
    "error": "",
    "result": {
        "txid": "0adb57ca9776c8760468c40465e0f0d37472f0b4b32fd02561ef28b3f7b28cf1",
        "payload": {
            "msg": "AccountId oaccount~0d7b3f73aea28065017ce8b79c0bb19256dc0cb475a0b2a85192bd110f69535c (Org-Id: CB , User-Id: retirer_user_cb) has successfully submitted request to burn 10 tokens"
        },
        "encode": "JSON",
        "sourceURL": "cb-oabcs1-bom.blockchain.ocp.example.com:20010",
        "blockNumber": 206
    }
}

requestMint

Ursprünglicher Methodenname: requestMint

Diese Methode kann von einem Minter aufgerufen werden, um eine Anforderung an den Minter Notar zu senden, um eine bestimmte Anzahl von Token zu erstellen.

Payload:

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

Parameter:

• tokenId: string: Die ID des zu prägenden Tokens.
• operationId: string: Die eindeutige Vorgangs-ID, die der Mint-Anforderung entspricht.
• notaryOrgId: string – Die Mitgliedsdienstleister-ID (MSP) des Notars, der die Anfrage bearbeitet.
• notaryUserId: string: Der Benutzername oder die E-Mail-ID des Notars, der die Anforderung verarbeitet.
• quantity: number - Die Anzahl der Token für Mint.
• timeToExpiration – Die Zeit, nach der die Minting-Anforderung abläuft und nicht mehr gültig ist.
• infoDetails: JSON: Ein Objekt, das die Kategorie (category) und die Beschreibung (description) der Anforderung angibt, wie im folgenden Beispiel dargestellt.

  {
       "category" : "category input",
       "description" : "description input"
  }

• sameOrgEndorser: boolean: Ein boolescher Wert, der angibt, ob Transaktionsbestätigungen von derselben Organisation wie der Anforderer stammen müssen.

Beispiel für Rückgabewert:

{
    "returnCode": "Success",
    "error": "",
    "result": {
        "txid": "06b35071415d74aa1a7c18449149c937d886cae76a832c44cf8d98e84586e76e",
        "payload": {
            "msg": "AccountId oaccount~9d9806fa92aa0c4fdb34eaffac6e830181b5d47e64fbce752195e83024125ca0 (Org-Id: CB , User-Id: creator_user_cb) has successfully submitted request to mint 10 tokens"
        },
        "encode": "JSON",
        "sourceURL": "cb-oabcs1-bom.blockchain.ocp.example.com:20010",
        "blockNumber": 202
    }
}

setMaxDailyAmount

Ursprünglicher Methodenname: setMaxDailyAmount

Mit dieser POST-Methode wird der Parameter maxDailyAmount in den Kontodetails für den angegebenen Betrag festgelegt. Diese Methode kann nur durch eine Token Admin des Chaincodes oder durch eine Org Admin der angegebenen Organisation aufgerufen werden.

Payload:

{
    "orgId": "{{bc-org-id}}",
    "userId": "{{bc-user-id}}",
    "tokenId": "{{bc-token-id}}",
    "maxDailyAmount": 1,
    "endorsers": {{endorsers}}
}

Parameter:

• orgId: string: Die Mitgliedsdienstanbieter-(MSP-)ID des Benutzers in der aktuellen Organisation.
• userId: string: Der Benutzername oder die E-Mail-ID des Benutzers.
• tokenId: string: Die ID des Tokens.
• maxDailyAmount: number: Der maximale Wert für den täglichen Betrag für das angegebene Konto, der den maximalen Betrag definiert, der täglich ausgeführt werden kann.
• endorsers: string[]: Ein Array der Peers (z.B. peer1, peer2), das die Transaktion freigeben muss.

Beispiel für Rückgabewert:

{
    "returnCode": "Success",
    "error": "",
    "result": {
        "txid": "28682e0564e4721b6c1a8ec106f8c5c98319e9439959dbb9f83d8e6f111d9975",
        "payload": {
            "bapAccountVersion": 0,
            "assetType": "oaccount",
            "account_id": "oaccount~cdc6fa5e64bc29f700f99da69f980d8cbb768c7e1a11dd17274e75651f6afafe",
            "user_id": "admin_user_cb",
            "org_id": "CB",
            "token_type": "fungible",
            "token_id": "USD",
            "token_name": "Stablecoin",
            "balance": 0,
            "onhold_balance": 0,
            "max_daily_amount": 10000,
            "daily_amount": 0,
            "max_daily_transactions": 1000,
            "daily_transactions": 0,
            "current_date": "2024-11-20T00:00:00.000Z"
        },
        "encode": "JSON",
        "sourceURL": "cb-oabcs1-bom.blockchain.ocp.example.com:20010",
        "blockNumber": 222
    }
}

setMaxDailyTransactionCount

Ursprünglicher Methodenname: setMaxDailyTransactionCount

Mit dieser POST-Methode wird der Parameter maxDailyTransactions in den Kontodetails für den angegebenen Betrag festgelegt. Diese Methode kann nur durch eine Token Admin des Chaincodes oder durch eine Org Admin der angegebenen Organisation aufgerufen werden.

Payload:

{
    "orgId": "{{bc-org-id}}",
    "userId": "{{bc-user-id}}",
    "tokenId": "{{bc-token-id}}",
    "maxDailyTransactions": 1,
    "endorsers": {{endorsers}}
}

Parameter:

• orgId: string: Die Mitgliedsdienstanbieter-(MSP-)ID des Benutzers in der aktuellen Organisation.
• userId: string: Der Benutzername oder die E-Mail-ID des Benutzers.
• tokenId: string: Die ID des Tokens.
• maxDailyTransactions: number: Der maximale Wert für den täglichen Betrag für das angegebene Konto, der die maximale Anzahl von Transaktionen definiert, die pro Tag zulässig sind.
• endorsers: string[]: Ein Array der Peers (z.B. peer1, peer2), das die Transaktion freigeben muss.

Beispiel für Rückgabewert:

{
    "returnCode": "Success",
    "error": "",
    "result": {
        "txid": "8b6fb01de697562ee098110054f05d4a314933bd11ef471991cb43e25b68bad9",
        "payload": {
            "bapAccountVersion": 0,
            "assetType": "oaccount",
            "account_id": "oaccount~cdc6fa5e64bc29f700f99da69f980d8cbb768c7e1a11dd17274e75651f6afafe",
            "user_id": "admin_user_cb",
            "org_id": "CB",
            "token_type": "fungible",
            "token_id": "USD",
            "token_name": "Stablecoin",
            "balance": 0,
            "onhold_balance": 0,
            "max_daily_amount": 10000,
            "daily_amount": 0,
            "max_daily_transactions": 1000,
            "daily_transactions": 0,
            "current_date": "2024-11-20T00:00:00.000Z"
        },
        "encode": "JSON",
        "sourceURL": "cb-oabcs1-bom.blockchain.ocp.example.com:20010",
        "blockNumber": 223
    }
}

suspendStablecoinAccount

Ursprünglicher Methodenname: suspendAccount

Diese Methode unterbricht ein fungibles Tokenkonto. Es wird ein Fehler ausgelöst, wenn kein accountStatus-Wert im Buch gefunden wird. Diese Methode kann nur durch eine Token Admin des Chaincodes oder durch eine Org Admin der angegebenen Organisation aufgerufen werden.

Payload:

{
    "tokenId": "{{bc-token-id}}",
    "orgId": "{{bc-org-id}}",
    "userId": "{{bc-user-id}}",
    "endorsers": {{endorsers}}
}

Parameter:

• tokenId: string: Die ID des Tokens.
• orgId: string: Die Mitgliedsdienstanbieter-(MSP-)ID des Benutzers in der aktuellen Organisation.
• userId: string: Der Benutzername oder die E-Mail-ID des Benutzers.
• endorsers: string[]: Ein Array der Peers (z.B. peer1, peer2), das die Transaktion freigeben muss.

Beispiel für Rückgabewert:

{
    "returnCode": "Success",
    "error": "",
    "result": {
        "txid": "e21d91d98091df77f90105d84074c0b802b01fc97a6b1304247774397fed1294",
        "payload": {
            "assetType": "oaccountStatus",
            "status_id": "oaccountStatus~d5814d96d8517ac31727d60aace0519c58a425892ab0d378fcfb0a35771f65ae",
            "account_id": "oaccount~802bf8da5579c6103b2dddaa6c4385df8e722d639a18029e0e93d7a5d6f826d6",
            "status": "suspended"
        },
        "encode": "JSON",
        "sourceURL": "cb-oabcs1-bom.blockchain.ocp.example.com:20009",
        "blockNumber": 195
    }
}

transferStablecoinTokens

Ursprünglicher Methodenname: transferTokens

Mit dieser Methode werden Token vom Aufrufer an ein bestimmtes Konto übertragen. Der Aufrufer der Methode muss ein Konto haben. Die Menge muss innerhalb der Dezimalwerte liegen, die durch den Parameter decimal des Verhaltens divisible in der Spezifikationsdatei angegeben werden.

Payload:

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

Parameter:

• tokenId: string: Die ID des Tokens.
• toOrgId: string – Die Mitgliedsdienstleister-ID (MSP) des Empfängers (Zahlungsempfängers) in der aktuellen Organisation.
• toUserId: string: Der Benutzername oder die E-Mail-ID des Empfängers.
• quantity: number: Die Anzahl der zu übertragenden Token.
• infoDetails: JSON: Ein Objekt, das die Kategorie (category) und die Beschreibung (description) der Anforderung angibt, wie im folgenden Beispiel dargestellt.

  {
       "category" : "category input",
       "description" : "description input"
  }

• endorsers: string[]: Ein Array der Peers (z.B. peer1, peer2), das die Transaktion freigeben muss.

Beispiel für Rückgabewert:

{
    "returnCode": "Success",
    "error": "",
    "result": {
        "txid": "d613b2494b965811b2fa2106152b7085f2d6d7d43e949b10b8668722d3636fe7",
        "payload": {
            "msg": "Successfully transferred 10 tokens from account id: oaccount~9d9806fa92aa0c4fdb34eaffac6e830181b5d47e64fbce752195e83024125ca0 (Org-Id: CB, User-Id: creator_user_cb) to account id: oaccount~51e676d7182a02ea7418ef58a6d54ecfe3858ef40b4ffb3d859b320da3921594 (Org-Id: CB, User-Id: issuer_user_cb). Only 999 number of transactions and 1990 amount transfer left for today: 12/11/2024"
        },
        "encode": "JSON",
        "sourceURL": "cb-oabcs1-bom.blockchain.ocp.example.com:20009",
        "blockNumber": 224
    }
    }

updateAccountPolicyCheck

Ursprünglicher Methodenname: updateAccountPolicyCheck

Mit dieser Methode wird die Policy für einen angegebenen Account aktualisiert. Diese Methode kann nur von einem Token Admin oder Org Admin der angegebenen Organisation aufgerufen werden.

Payload:

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

Parameter:

• asset: AccountPolicyCheck object: Ein Objekt, das Account-Policy-Parameter definiert, die folgende Felder enthalten:
  • accountPolicyId: Die eindeutige ID der Accountrichtlinie.
  • orgId: Die Mitgliedsdienstanbieter-(MSP-)ID des Benutzers, für den die Policy erstellt werden soll.
  • userId: Der Benutzername oder die E-Mail-ID des Benutzers, für den die Policy erstellt werden soll.
  • kycCompliance: Ein boolescher Wert, der angibt, ob der Account die KYC-(Know Your Customer-)Anforderungen erfüllt.
  • amlCompliance: Ein boolescher Wert, der angibt, ob das Konto die Anforderungen an die Geldwäschebekämpfung erfüllt.
  • riskScore: Der dem Account zugeordnete Risikoscore, der für die Compliancebewertung verwendet wird.
  • restrictionFlag: Ein boolescher Wert, der angibt, ob das Konto eingeschränkten Transfers unterliegt. Wenn dieser Wert auf true gesetzt ist, sind nur Transfers innerhalb des niedrigsten Schwellenwertes für die Genehmigungs-Policy zulässig.
• endorsers: string[]: Ein Array der Peers (z.B. peer1, peer2), das die Transaktion freigeben muss.

Beispiel für Rückgabewert:

{
    "returnCode": "Success",
    "error": "",
    "result": {
        "txid": "02875ca9c6a7408da3f81156214228b91b09c4bb2b8026d7a5733b53598c6635",
        "payload": {
            "assetType": "AccountPolicyCheck",
            "accountPolicyId": "APID~CentralBank~cb__creator_demo",
            "orgId": "CentralBank",
            "userId": "cb__creator_demo",
            "kycCompliance": "true",
            "amlCompliance": "true",
            "riskScore": 1000,
            "restrictionFlag": "true"
        },
        "encode": "JSON",
        "sourceURL": "cb-oabcs1-bom.blockchain.ocp.example.com:20010",
        "blockNumber": 272
    }
}

updateApprovalPolicyCheck

Ursprünglicher Methodenname: updateApprovalPolicyCheck

Mit dieser Methode wird die Genehmigungs-Policy aktualisiert. Diese Methode kann nur mit einem Token Admin aufgerufen werden.

Payload:

{
    "asset": "{\"approvalPolicyId\":\"approvalPolicyId value\",\"transactionLowerLimit\":\"transactionLowerLimit value\",\"transactionUpperLimit\":\"transactionUpperLimit value\",\"numberOfApprovalsRequired\":999,\"approverDetails\":[{\"approverOrgId\":\"approverOrgId value\",\"approverUserId\":\"approverUserId value\",\"approvalSequence\":999}]}",
    "endorsers": {{endorsers}}
}

Parameter:

• asset: ApprovalPolicyCheck class: Eine Klasse, die Genehmigungsregeln für eine Transaktion definiert, die folgende Felder enthält:
  • approvalPolicyId: Die eindeutige ID der Genehmigungs-Policy.
  • transactionLowerLimit: Der Mindesttransaktionsbetrag, für den die Genehmigungs-Policy gilt.
  • transactionUpperLimit: Der maximale Transaktionsbetrag, für den die Genehmigungs-Policy gilt.
  • numberOfApprovalsRequired: Die Gesamtanzahl der Genehmigungen, die erforderlich sind, bevor die Transaktion abgeschlossen werden kann.
  • approverDetails: Eine Liste mit Genehmigern zusammen mit der zugewiesenen Genehmigungsreihenfolge, die den erforderlichen Auftrag für Genehmigungen definiert.
• endorsers: string[]: Ein Array der Peers (z.B. peer1, peer2), das die Transaktion freigeben muss.

Beispiel für Rückgabewert:

{
    "returnCode": "Success",
    "error": "",
    "result": {
        "txid": "ed1e1950fe02dbab74fa3aa7630b8dc6096e30aae5c81bab0dd22d5232c44fc9",
        "payload": {
            "status": "active",
            "assetType": "ApprovalPolicyCheck",
            "approvalPolicyId": "GPID~500~1000",
            "transactionLowerLimit": "500",
            "transactionUpperLimit": "1000",
            "numberOfApprovalsRequired": 1,
            "approverDetails": [
                {
                    "approverOrgId": "CentralBank",
                    "approverUserId": "manager",
                    "approvalSequence": 1
                }
            ]
        },
        "encode": "JSON",
        "sourceURL": "cb-oabcs1-bom.blockchain.ocp.example.com:20009",
        "blockNumber": 285
    }
}

updateStablecoinToken

Ursprünglicher Methodenname: updateStablecoinToken

Diese Methode aktualisiert ein Stablecoin-Token. Diese Methode kann nur mit einem Token Admin aufgerufen werden.

Payload:

{
    "tokenAsset": "{\"token_id\":\"{{bc-token-id}}\",\"token_desc\":\"token_desc value\",\"currencyName\":\"currencyName value\",\"conversionRate\":999}",
    "endorsers": {{endorsers}}
}

Parameter:

• asset <Token Class>: Das Tokenasset wird als Parameter an diese Methode übergeben. Die Eigenschaften des Tokenassets können variieren und werden in der Tokenspezifikationsdatei beschrieben. Nehmen Sie keine Parameter auf, die in der Spezifikationsdatei als schreibgeschützt markiert sind.

  Sie geben den Parameter asset in einem anderen Format an, wenn Sie Visual Studio Code im Vergleich zur CLI oder Postman-Collection verwenden.

  Visual Studio Code: Verwenden Sie die GUI, um einzelne Parameter zu übergeben, die den Tokenklassenfeldern entsprechen.

  CLI/Postman: Übergeben Sie eine serialisierte JSON-Zeichenfolge, die die Token-Spezifikationsfelder enthält, wie im folgenden Beispiel dargestellt.

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

• endorsers: string[]: Ein Array der Peers (z.B. peer1, peer2), das die Transaktion freigeben muss.

Beispiel für Rückgabewert:

{
    "returnCode": "Success",
    "error": "",
    "result": {
        "txid": "aa7a4f4cc214e1a041a5a6fb7ca7530f08256559e538c9f9582e6fd12c9e65c8",
        "payload": {
            "assetType": "otoken",
            "events": false,
            "token_id": "t1",
            "token_name": "Stablecoin",
            "token_desc": "token_desc value",
            "token_standard": "ttf+",
            "token_type": "fungible",
            "token_unit": "fractional",
            "behaviors": [
                "divisible",
                "mintable",
                "transferable",
                "burnable",
                "holdable",
                "roles"
            ],
            "roles": {
                "minter_role_name": "minter",
                "burner_role_name": "burner",
                "notary_role_name": "notary",
                "mint_approver_role_name": "notary",
                "burn_approver_role_name": "notary"
            },
            "mintable": {
                "max_mint_quantity": 1000,
                "mint_approval_required": true
            },
            "burnable": {
                "burn_approval_required": true
            },
            "divisible": {
                "decimal": 2
            },
            "currency_name": "currency_name value",
            "token_to_currency_ratio": 999
        },
        "encode": "JSON",
        "sourceURL": "cb-oabcs1-bom.blockchain.ocp.example.com:20009",
        "blockNumber": 267
    }
}

createStablecoinAccount

Ursprünglicher Methodenname: createStablecoinAccount

Diese benutzerdefinierte Wrapper-API kombiniert Chaincode-APIs und Oracle Blockchain Platform-Konsolen-APIs zu einem Endpunkt. Mit dieser Methode werden die folgenden Schritte nacheinander ausgeführt.

1. Erstellt eine Anmeldungs-ID für einen Benutzer im REST-Proxy der Instanz. Wenn bereits eine Anmeldung für die Benutzer-ID vorhanden ist, wird die Anmeldung nicht erneut erstellt. Die Anmeldungs-ID ist mit der Benutzer-ID identisch. Die Anmeldungs-ID darf nur alphanumerische Zeichen, Bindestriche (-) und Unterstriche (_) enthalten. Wenn die Benutzer-ID andere Sonderzeichen enthält, werden diese durch Unterstriche (_) ersetzt.
2. Erstellt ein Konto im Buch.
3. Ordnet den neuen Account dem angegebenen Token zu.
4. Weist dem Benutzer die angegebene Rolle zu.

Wenn einer der Schritte nicht erfolgreich verläuft, wird die Anmeldung automatisch gelöscht.

Payload:

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

Parameter:

• orgId - Die Mitgliedsdienstanbieter-(MSP-)ID des Benutzers, für den das Konto erstellt werden soll. Die ID muss mit einem alphanumerischen Zeichen beginnen und kann Buchstaben, Zahlen und Sonderzeichen wie Unterstriche (_), Punkte (.), At-Zeichen (@) und Bindestriche (-) enthalten.
• userId: Der Benutzername oder die E-Mail-ID des Benutzers. Die ID muss mit einem alphanumerischen Zeichen beginnen und kann Buchstaben, Zahlen und Sonderzeichen wie Unterstriche (_), Punkte (.), At-Zeichen (@) und Bindestriche (-) enthalten.
• tokenId: string: Die Token-ID, die mit einem alphanumerischen Zeichen beginnen muss und Buchstaben, Zahlen und die Sonderzeichen Unterstrich (_) und Bindestriche (-) enthalten kann. Die Länge darf maximal 16 Zeichen umfassen.
• role: string: Der Name der Rolle, die dem angegebenen Benutzer hinzugefügt werden soll. Dieser Wert muss einer der folgenden Werte sein: minter, burner, notary, tokenAdmin, tokenAuditor, orgAdmin oder orgAuditor.
• dailyLimits: JSON object: Ein JSON-Objekt des folgenden Typs.

  {
       "max_daily_amount": 100000
       "max_daily_transactions": 10000
   }

  Im Beispiel ist der Wert max_daily_amount die maximale Anzahl von Token, die täglich ausgeführt werden können, und der Wert max_daily_transactions ist die maximale Anzahl von Transaktionen, die täglich abgeschlossen werden können.

Rückgabewert:

• Bei Erfolg ein JSON-Objekt des Accounts, der erstellt wurde.

Beispiel für Rückgabewert:

"payload": {
 "msg": "Account created successfully and 'minter' role added to Account Id: oaccount~4a86f2843c2b0105c97a77202bd9aba519c81dcef27eccc1d89125ae32770700 (Org-Id: CB, User-Id: creator_user_cb)"
 "accountDetails": 
      {            
            "bapAccountVersion": 0,
            "assetType": "oaccount",
            "account_id": "oaccount~ce5c56d2068ce31b82136c8eea110a80b9251595d361db70924c4e989032a1be",
            "user_id": "creator_user_cb",
            "org_id": "CB",
            "token_type": "fungible",
            "token_id": "USD",
            "token_name": "",
            "balance": 0,
            "onhold_balance": 0,
            "max_daily_amount": 1000,
            "daily_amount": 0,
            "max_daily_transactions": 100,
            "daily_transactions": 0,
            "current_date": "2024-10-06T00:00:00.000Z"
     }
 }

createIDCSUser

Ursprünglicher Methodenname: createIDCSUser

Mit dieser POST-Methode wird ein Identity Cloud Service-Benutzer im Mandanten erstellt, der durch die URL in der Datei terraform.tfvars angegeben wird, und der Benutzer wird der angegebenen Benutzergruppe zugewiesen.

Payload:

{
 "userName": "userName value",
 "firstName": "firstName value",
 "lastName": "lastName value",
 "email": "email value",
 "groupName": "groupName value"
}

Parameter:

• userName: string: Die ID des Benutzers.
• firstName: string: Der Vorname des Benutzers.
• lastName: string: Der Nachname des Benutzers.
• email: string: Die E-Mail-Adresse des Benutzers.
• groupName: string: Der Name der Identity Cloud Service-Gruppe, die dem Benutzer zugewiesen werden soll.

Beispiel für Rückgabewert:

{
 "status": "Success",
 "msg": "User user1 is created and assigned to the group BOND_ADMIN"
}