Stablecoin Wrapper API Package

Oracle Blockchain Platform Digital Assets Edition comprend un package d'API wrapper qui étend l'API REST pour prendre en charge les opérations spécifiques au cycle de vie d'un stablecoin.

L'ensemble d'API wrapper utilise le service de passerelle d'API et le service des fonctions pour OCI pour déployer des routes d'API spécifiquement pour gérer le cycle de vie de stablecoin. L'ensemble d'API d'encapsulation stablecoin est téléchargeable à partir de la console Oracle Blockchain Platform et comprend un fichier d'archive qui contient l'ensemble d'API d'encapsulation, y compris les scripts Terraform requis pour le déploiement. Vous déployez ce fichier dans une pile du gestionnaire de ressources sur Oracle Cloud Infrastructure (OCI) pour créer les ressources Oracle nécessaires pour les API d'encapsuleur. Il comprend également une collection Postman qui vous permet de tester les API de wrapper déployées. La collection comprend des demandes préconfigurées avec des points d'extrémité et des données utiles qui correspondent aux API définies dans l'ensemble d'API wrapper.

API d'encapsuleur

activateStablecoinAccount

Nom de la méthode initiale : activateAccount

Cette méthode POST active un compte de jeton fongible. Cette méthode ne peut être appelée que par Token Admin ou Org Admin de l'organisation spécifiée. Les comptes supprimés ne peuvent pas être activés.

Données utiles :

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

Paramètres :

tokenId: string – ID du jeton.
orgId: string – ID fournisseur de services d'adhésion (MSP) de l'utilisateur dans l'organisation courante.
userId: string – Nom d'utilisateur ou ID courriel de l'utilisateur.
endorsers: string[] – Tableau des pairs (par exemple, peer1, peer2) qui doivent endosser la transaction.

Retourne :

En cas de succès, une représentation JSON de l'objet de statut de compte pour le compte de jeton spécifié.

Exemple de valeur renvoyée :

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

Nom de la méthode initiale : addOrgAdmin

Cette méthode ajoute des administrateurs d'organisation au code de chaîne de jeton. Cette méthode ne peut être appelée que par Token Admin ou Org Admin de l'organisation spécifiée.

Données utiles :

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

Paramètres :

orgId: string – ID fournisseur de services d'adhésion (MSP) de l'utilisateur dans l'organisation courante.
userId: string – Nom d'utilisateur ou ID courriel de l'utilisateur.
sameOrgEndorser: boolean – Valeur booléenne qui indique si les endossements de transaction doivent provenir de la même organisation que le demandeur.

Exemple de valeur renvoyée :


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

Nom de la méthode initiale : addOrgAuditor

Cette méthode ajoute des auditeurs d'organisation au code de chaîne de jeton. Cette méthode ne peut être appelée que par Token Admin ou Org Admin de l'organisation spécifiée.

Données utiles :

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

Paramètres :

orgId: string – ID fournisseur de services d'adhésion (MSP) de l'utilisateur dans l'organisation courante.
userId: string – Nom d'utilisateur ou ID courriel de l'utilisateur.
sameOrgEndorser: boolean – Valeur booléenne qui indique si les endossements de transaction doivent provenir de la même organisation que le demandeur.

Exemple de valeur renvoyée :

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

Nom de la méthode initiale : addRole

Cette méthode ajoute le rôle à l'utilisateur et au jeton spécifiés. Les ID compte sont formés en créant un code de hachage SHA-256 de l'ID jeton concaténé, de l'ID organisation et de l'ID utilisateur. Cette méthode ne peut être appelée que par Token Admin ou Org Admin de l'organisation spécifiée.

Données utiles :

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

Paramètres :

tokenId: string – ID du jeton.
role: string – Nom du rôle à ajouter à l'utilisateur spécifié. Les comportements mintable et Burnable sont liés aux propriétés minter_role_name et burner_role_name dans le fichier de spécification. De même, le comportement du notaire est lié à la propriété notary_role_name dans le fichier de spécification.
orgId: string – ID fournisseur de services d'adhésion (MSP) de l'utilisateur dans l'organisation courante.
userId: string – Nom d'utilisateur ou ID courriel de l'utilisateur.
endorsers: string[] – Tableau des pairs (par exemple, peer1, peer2) qui doivent endosser la transaction.

Exemple de valeur renvoyée :

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

Nom de la méthode initiale : addTokenAdmin

Cette méthode POST ajoute un utilisateur en tant que Token Admin du code de chaîne de jeton. La méthode ne peut être appelée que par Token Admin du code de chaîne de jeton. Le premier appel provient de l'administrateur qui instancie le code de chaîne.

Données utiles :

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

Paramètres :

orgId: string – ID fournisseur de services d'adhésion (MSP) de l'utilisateur dans l'organisation courante.
userId: string – Nom d'utilisateur ou ID courriel de l'utilisateur.
sameOrgEndorser: boolean – Valeur booléenne qui indique si les endossements de transaction doivent provenir de la même organisation que le demandeur.

Exemple de valeur renvoyée :

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

Nom de la méthode initiale : addTokenAuditor

Cette méthode POST ajoute des auditeurs de jeton au code de chaîne de jeton. Cette méthode ne peut être appelée que par Token Admin du code de chaîne.

Données utiles :

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

Paramètres :

orgId: string – ID fournisseur de services d'adhésion (MSP) de l'utilisateur dans l'organisation courante.
userId: string – Nom d'utilisateur ou ID courriel de l'utilisateur.
sameOrgEndorser: boolean – Valeur booléenne qui indique si les endossements de transaction doivent provenir de la même organisation que le demandeur.

Exemple de valeur renvoyée :

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

Nom de la méthode initiale : approveBurn

Les notaires peuvent appeler cette méthode POST pour approuver une demande de gravure.

Données utiles :

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

Paramètres :

tokenId: string – ID du jeton.
operationId: string – ID opération unique de la demande de menthe à approuver.
sameOrgEndorser: boolean – Valeur booléenne qui indique si les endossements de transaction doivent provenir de la même organisation que le demandeur.

Exemple de valeur renvoyée :

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

Nom de la méthode initiale : approveMint

Les notaires peuvent appeler cette méthode POST pour approuver une demande de mint.

Données utiles :

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

Paramètres :

tokenId: string – ID du jeton.
operationId: string – ID opération unique de la demande de menthe à approuver.
sameOrgEndorser: boolean – Valeur booléenne qui indique si les endossements de transaction doivent provenir de la même organisation que le demandeur.

Exemple de valeur renvoyée :

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

Nom de la méthode initiale : approveTransaction

Les approbateurs peuvent appeler cette méthode POST pour approuver une transaction de blocage.

Données utiles :

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

Paramètres :

tokenId: string – ID du jeton.
orgId: string – ID fournisseur de services d'adhésion (MSP) de l'utilisateur.
userId: string – Nom d'utilisateur ou ID courriel de l'utilisateur.
endorsers: string[] – Tableau des pairs (par exemple, peer1, peer2) qui doivent endosser la transaction.

Exemple de valeur renvoyée :

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

Nom de la méthode initiale : associateTokenToAccount

Cette méthode POST associe un ID compte spécifié à un jeton spécifié. Cette méthode ne peut être appelée que par Token Admin ou Org Admin de l'organisation spécifiée.

Données utiles :

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

Paramètres :

accountId: string – ID du compte.
tokenId: string – ID du jeton.
endorsers: string[] – Tableau des pairs (par exemple, peer1, peer2) qui doivent endosser la transaction.

Exemple de valeur renvoyée :

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

Nom de la méthode initiale : bulkTransferTokens

Cette méthode transfère en masse les jetons du compte de l'appelant aux comptes spécifiés dans l'objet flow. Les quantités doivent être comprises dans les valeurs décimales spécifiées par le paramètre decimal du comportement divisible dans le fichier de spécification.

Données utiles :

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

Paramètres :

token_id: string – ID du jeton.
flow : object[] – Tableau d'objets JSON qui spécifient les destinataires et les quantités.
- to_orgId: string – ID fournisseur de services d'adhésion (MSP) du destinataire dans l'organisation courante.
- userId: string – Nom d'utilisateur ou ID courriel du destinataire.
- quantity: number – Le nombre de jetons à transférer.
Vous spécifiez le paramètre flow dans un format différent si vous utilisez Visual Studio Code par rapport à l'interface de ligne de commande ou à une collection Postman.
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[] – Tableau des pairs (par exemple, peer1, peer2) qui doivent endosser la transaction.

Exemple de valeur renvoyée :

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

Nom de la méthode initiale : createAccount

Cette méthode crée un compte pour un utilisateur et un jeton spécifiés. Un compte doit être créé pour tout utilisateur qui aura des jetons à tout moment. Les comptes assurent le suivi des soldes, des soldes bloqués et de l'historique des transactions. Un ID compte est formé par la concaténation du type d'immobilisation, de l'ID jeton et d'un code de hachage SHA-256 de l'ID utilisateur et de l'ID organisation (fournisseur de services d'adhésion). Cette méthode ne peut être appelée que par un Token Admin du code de chaîne ou par un Org Admin de l'organisation spécifiée.

Données utiles :

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

Paramètres :

orgId – ID fournisseur de services d'adhésion (MSP) de l'utilisateur pour lequel créer le compte. L'ID doit commencer par un caractère alphanumérique et peut inclure des lettres, des chiffres et des caractères spéciaux tels que des traits de soulignement (_), des points (.), des signes at (@) et des tirets (-).
userId – Nom d'utilisateur ou ID courriel de l'utilisateur. L'ID doit commencer par un caractère alphanumérique et peut inclure des lettres, des chiffres et des caractères spéciaux tels que des traits de soulignement (_), des points (.), des signes at (@) et des tirets (-).
tokenType: TokenType – Type de jeton, qui doit être fungible.
dailyLimits: JSON object – Objet JSON du type suivant.
```
{
     "max_daily_amount": 100000
     "max_daily_transactions": 10000
 }
```
Dans l'exemple, la valeur max_daily_amount est le nombre maximal de jetons pouvant être traités quotidiennement et la valeur max_daily_transactions est le nombre maximal de transactions pouvant être effectuées quotidiennement.
endorsers: string[] – Tableau des pairs (par exemple, peer1, peer2) qui doivent endosser la transaction.

Exemple de valeur renvoyée :

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

Nom de la méthode initiale : createApprovalPolicyCheck

Cette méthode crée une nouvelle politique d'approbation, qui définit les seuils de transaction et les approbateurs séquentiels requis. Cette méthode ne peut être appelée que par Token Admin.

Données utiles :

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

Paramètres :

asset: ApprovalPolicyCheck class – Classe qui définit les règles d'approbation pour une transaction, qui inclut les champs suivants :
- approvalPolicyId – Le système génère cet ID. Vous ne fournissez pas ce champ manuellement.
- transactionLowerLimit – Montant minimal de transaction auquel s'applique la politique d'approbation.
- transactionUpperLimit – Montant de transaction maximal auquel s'applique la politique d'approbation.
- numberOfApprovalsRequired – Nombre total d'approbations nécessaires avant que la transaction puisse être terminée.
- approverDetails – Liste des approbateurs ainsi que la séquence d'approbation qui leur est affectée, qui définit l'ordre obligatoire pour les approbations.
endorsers: string[] – Tableau des pairs (par exemple, peer1, peer2) qui doivent endosser la transaction.

Exemple de valeur renvoyée :

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

Nom de la méthode initiale : createAccountPolicyCheck

Cette méthode crée une politique pour un compte spécifié. Cette méthode ne peut être appelée que par Token Admin ou Org Admin de l'organisation spécifiée.

Données utiles :

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

Paramètres :

asset: AccountPolicyCheck class – Classe qui définit les paramètres de politique de compte, qui inclut les champs suivants :
- accountPolicyId – Le système génère cet ID à partir des champs orgId et userId spécifiés. Vous ne fournissez pas ce champ manuellement.
- orgId - ID fournisseur de services d'adhésion (MSP) de l'utilisateur pour lequel créer la politique.
- userId – Nom d'utilisateur ou ID courriel de l'utilisateur pour lequel créer la politique.
- kycCompliance – Valeur booléenne qui indique si le compte satisfait aux exigences de connaissance du client.
- amlCompliance – Valeur booléenne indiquant si le compte répond aux exigences de lutte contre le blanchiment d'argent.
- riskScore – Note de risque associée au compte, qui est utilisée pour l'évaluation de la conformité.
- restrictionFlag – Valeur booléenne indiquant si le compte fait l'objet de transferts restreints. Si la valeur est réglée à true, seuls les transferts au seuil d'approbation-politique le plus bas sont autorisés.
- endorsers: string[] – Tableau des pairs (par exemple, peer1, peer2) qui doivent endosser la transaction.

Exemple de valeur renvoyée :

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

Nom de la méthode initiale : deleteApprovalPolicyCheck

Cette méthode supprime la politique d'approbation pour un ID politique spécifié. Cette méthode ne peut être appelée que par Token Admin.

Données utiles :

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

Paramètres :

id: string – ID politique d'approbation unique.
endorsers: string[] – Tableau des pairs (par exemple, peer1, peer2) qui doivent endosser la transaction.

Exemple de valeur renvoyée :

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

Nom de la méthode initiale : deleteAccount

Cette méthode supprime un compte de jeton fongible. Retourne une erreur si la valeur accountStatus pour le compte est introuvable dans le livre. Cette méthode ne peut être appelée que par Token Admin.

Données utiles :

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

Paramètres :

tokenId: string – ID du jeton.
orgId: string – ID fournisseur de services d'adhésion (MSP) de l'utilisateur dans l'organisation courante.
userId: string – Nom d'utilisateur ou ID courriel de l'utilisateur.
endorsers: string[] – Tableau des pairs (par exemple, peer1, peer2) qui doivent endosser la transaction.

Exemple de valeur renvoyée :

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

Nom de la méthode initiale : deleteAccountPolicyCheck

Cette méthode supprime la politique pour un ID politique spécifié. Cette méthode ne peut être appelée que par Token Admin ou Org Admin de l'organisation spécifiée.

Données utiles :

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

Paramètres :

id: string – ID politique de compte unique.
endorsers: string[] – Tableau des pairs (par exemple, peer1, peer2) qui doivent endosser la transaction.

Exemple de valeur renvoyée :

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

Nom de la méthode initiale : executeHoldTokens

Cette méthode approuve un blocage des jetons, qui déclenche le transfert des jetons de l'expéditeur vers le récepteur. La quantité de jetons précédemment bloqués par le propriétaire du jeton est maintenant transférée au destinataire. Si la valeur quantity est inférieure à la valeur de blocage réelle, le montant restant est de nouveau disponible pour le responsable du jeton. Si le comportement roles est spécifié dans la section behaviors du modèle de jeton et que la valeur notary_role_name est définie, le compte de l'appelant doit avoir le rôle de notaire. Sinon, tout appelant avec un compte peut fonctionner comme un notaire.

Données utiles :

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

Paramètres :

tokenId: string – ID du jeton.
operationId: string – ID opération unique de la demande de menthe à approuver.
quantity: number – Le nombre de jetons détenus à transférer.
endorsers: string[] – Tableau des pairs (par exemple, peer1, peer2) qui doivent endosser la transaction.

Exemple de valeur renvoyée :

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

Nom de la méthode initiale : getAccountTransactionHistory

Cette méthode retourne un tableau des détails de l'historique des transactions de compte pour un utilisateur et un jeton spécifiés. Cette méthode ne peut être appelée que par Token Admin ou Token Auditor du code de chaîne, un Org Admin ou Org Auditor de l'organisation spécifiée ou le AccountOwner du compte.

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

Paramètres :

tokenId: string – ID du jeton.
orgId: string – ID fournisseur de services d'adhésion (MSP) de l'utilisateur dans l'organisation courante.
userId: string – Nom d'utilisateur ou ID courriel de l'utilisateur.

Exemple de valeur renvoyée :

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

Nom de la méthode initiale : getAllAccounts

Cette méthode retourne une liste de tous les comptes. Cette méthode ne peut être appelée que par Token Admin ou Token Auditor.

Données utiles :

{{api-gateway-endpoint1}}/getAllAccounts

Paramètres :

aucune

Exemple de valeur renvoyée :

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

Nom de la méthode initiale : getAllOrgAccounts

Cette méthode retourne une liste de tous les comptes de jeton appartenant à une organisation spécifiée. Cette méthode ne peut être appelée que par Token Admin, Token Auditor ou par Org Admin ou Org Auditor de l'organisation spécifiée.

Données utiles :

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

Paramètres :

orgId: string – ID fournisseur de services d'adhésion (MSP) de l'organisation.

Exemple de valeur renvoyée :

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

Nom de la méthode initiale : getAllTokenAdmins

Cette méthode retourne la liste de tous les utilisateurs qui sont un Token Admin. Cette méthode ne peut être appelée que par Token Admin ou Token Auditor.

Données utiles :

{{api-gateway-endpoint1}}/getAllTokenAdmins

Paramètres :

aucune

Exemple de valeur renvoyée :

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

getAllTokens

Nom de la méthode initiale : getAllTokens

Cette méthode renvoie tous les jetons stockés dans la base de données d'état. Cette méthode ne peut être appelée que par Token Admin, Token Auditor, Org Admin ou Org Auditor. Cette méthode utilise des interrogations Berkeley DB SQL riches et ne peut être appelée qu'en cas de connexion au réseau distant Oracle Blockchain Platform.

Données utiles :

{{api-gateway-endpoint1}}/getAllTokens

Paramètres :

aucune

Exemple de valeur renvoyée :

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

Nom de la méthode initiale : getApprovalPolicyCheckById

Cette méthode obtient les détails de la politique d'approbation pour un ID politique spécifié. Cette méthode ne peut être appelée que par Token Admin ou Token Auditor.

Données utiles :

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

Paramètres :

id: string – ID politique d'approbation unique.

Exemple de valeur renvoyée :

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

getApprovalTransactionsById

Nom de la méthode initiale : getApprovalTransactionsById

Cette méthode permet d'obtenir la transaction d'approbation pour un code de transaction précisé. Cette méthode ne peut être appelée que par Token Admin ou Org Admin de l'organisation associée.

Données utiles :

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

Paramètres :

id: string – ID généré par le système de la transaction d'approbation.

Exemple de valeur renvoyée :

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

Nom de la méthode initiale : getApproverDetailsByTransferAmount

Cette méthode permet d'obtenir les détails de l'approbateur requis pour un montant de transfert donné. Cette méthode ne peut être appelée que par Token Admin ou Token Auditor.

Données utiles :

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

Paramètres :

amount: number – Montant du transfert.
endorsers: string[] – Tableau des pairs (par exemple, peer1, peer2) qui doivent endosser la transaction.

Exemple de valeur renvoyée :

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

Nom de la méthode initiale : getMaxDailyAmount

Cette méthode obtient le montant de transaction cumulé quotidien maximal pour un compte spécifié. Cette méthode ne peut être appelée que par Token Admin ou Token Auditor du code de chaîne ou par Org Admin ou Org Auditor de l'organisation spécifiée.

Données utiles :

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

Paramètres :

tokenId: string – ID du jeton.
orgId: string – ID fournisseur de services d'adhésion (MSP) de l'utilisateur dans l'organisation courante.
userId: string – Nom d'utilisateur ou ID courriel de l'utilisateur.

Exemple de valeur renvoyée :

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

getMaxDailyTransactionCount

Nom de la méthode initiale : getMaxDailyTransactionCount

Cette méthode obtient le nombre maximal de transactions quotidiennes pour un compte spécifié. Cette méthode ne peut être appelée que par Token Admin ou Token Auditor du code de chaîne ou par Org Admin ou Org Auditor de l'organisation spécifiée.

Données utiles :

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

Paramètres :

tokenId: string – ID du jeton.
orgId: string – ID fournisseur de services d'adhésion (MSP) de l'utilisateur dans l'organisation courante.
userId: string – Nom d'utilisateur ou ID courriel de l'utilisateur.

Exemple de valeur renvoyée :

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

getNetTokens

Nom de la méthode initiale : getNetTokens

Cette méthode GET retourne le nombre total net de jetons disponibles dans le système pour un jeton spécifié. Le total net des jetons correspond à la quantité de jetons restants après la gravure des jetons. Cette méthode ne peut être appelée que par Token Admin ou Token Auditor, ou par Org Admin ou Org Auditor.

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

Paramètres :

tokenId: string – ID du jeton.

Exemple de valeur renvoyée :

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

getOnHoldBalanceWithOperationId

Nom de la méthode initiale : getOnHoldBalanceWithOperationId

Cette méthode retourne le solde bloqué pour un ID opération et un jeton spécifiés. Cette méthode ne peut être appelée que par Token Admin ou Token Auditor, ou par l'expéditeur, le destinataire ou le notaire associé à l'opération.

Données utiles :

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

Paramètres :

tokenId: string – ID du jeton.
operationId: string – ID unique permettant d'identifier l'opération de blocage. En général, cet ID est transmis par l'application client.

Exemple de valeur renvoyée :

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

getOnHoldDetailsWithOperationId

Nom de la méthode initiale : getOnHoldDetailsWithOperationId

Cette méthode retourne les détails de transaction bloquée pour un ID opération et un jeton spécifiés. Cette méthode ne peut être appelée que par Token Admin ou Token Auditor, ou par l'expéditeur, le destinataire ou le notaire associé à l'opération.

Données utiles :

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

Paramètres :

tokenId: string – ID du jeton.
operationId: string – ID unique permettant d'identifier l'opération de blocage. En général, cet ID est transmis par l'application client.

Exemple de valeur renvoyée :

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

Nom de la méthode initiale : getOnHoldIds

Cette méthode GET retourne une liste de tous les ID portefeuille pour un compte spécifié. Cette méthode ne peut être appelée que par Token Admin ou Token Auditor du code de chaîne, un Org Admin ou Org Auditor de l'organisation spécifiée ou le AccountOwner du compte.

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

Paramètres :

tokenId: string – ID du jeton.
orgId: string – ID fournisseur de services d'adhésion (MSP) de l'utilisateur dans l'organisation courante.
userId: string – Nom d'utilisateur ou ID courriel de l'utilisateur.

Exemple de valeur renvoyée :

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

Nom de la méthode initiale : getOrgAccountsByRole

Cette méthode retourne des informations sur tous les comptes ayant un rôle spécifié dans une organisation spécifiée. Cette méthode ne peut être appelée que par Token Admin ou Token Auditor, ou par Org Admin ou Org Auditor de l'organisation spécifiée.

Données utiles :

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

Paramètres :

tokenId: string – ID du jeton.
role: string – Nom du rôle à rechercher.
orgId: string – ID fournisseur de services d'adhésion (MSP) de l'utilisateur dans l'organisation courante.

Exemple de valeur renvoyée :

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

getOrgAdmins

Nom de la méthode initiale : getOrgAdmins

Cette méthode retourne la liste de tous les utilisateurs qui sont des Org Admin d'une organisation. Cette méthode ne peut être appelée que par Token Admin ou Token Auditor, ou par Org Admin ou Org Auditor de l'organisation associée.

Données utiles :

{{api-gateway-endpoint1}}/getOrgAdmins

Paramètres :

aucune

Exemple de valeur renvoyée :

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

getOrgAuditors

Nom de la méthode initiale : getOrgAuditors

Cette méthode retourne la liste de tous les utilisateurs qui sont des Org Auditor d'une organisation. Cette méthode ne peut être appelée que par Token Admin ou Token Auditor, ou par Org Admin ou Org Auditor de l'organisation associée.

Données utiles :

{{api-gateway-endpoint1}}/getOrgAuditors

Paramètres :

aucune

Exemple de valeur renvoyée :

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

getOrgUsersByRole

Nom de la méthode initiale : getOrgUsersByRole

Cette méthode retourne des informations sur tous les utilisateurs ayant un rôle spécifié dans une organisation spécifiée. Cette méthode ne peut être appelée que par Token Admin ou Token Auditor, ou par Org Admin ou Org Auditor de l'organisation spécifiée.

Données utiles :

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

Paramètres :

tokenId: string – ID du jeton.
role: string – Nom du rôle à rechercher.
orgId: string – ID fournisseur de services d'adhésion (MSP) de l'utilisateur dans l'organisation courante.

Exemple de valeur renvoyée :

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

getStablecoinAccount

Nom de la méthode initiale : getAccount

Cette méthode GET retourne les détails du compte pour un utilisateur et un jeton spécifiés. Cette méthode ne peut être appelée que par Token Admin ou Token Auditor du code de chaîne, un Org Admin ou Org Auditor de l'organisation spécifiée ou le AccountOwner du compte.

Interrogation :

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

Paramètres :

tokenId: string – ID du jeton.
orgId: string – ID fournisseur de services d'adhésion (MSP) de l'utilisateur dans l'organisation courante.
userId: string – Nom d'utilisateur ou ID courriel de l'utilisateur.

Exemple de valeur renvoyée :

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

Nom de la méthode initiale : getAccountBalance

Cette méthode GET retourne le solde courant pour un compte et un jeton spécifiés. Cette méthode ne peut être appelée que par Token Admin ou Token Auditor du code de chaîne, un Org Admin ou Org Auditor de l'organisation spécifiée ou le AccountOwner du compte.

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

Paramètres :

tokenId: string – ID du jeton.
orgId: string – ID fournisseur de services d'adhésion (MSP) de l'utilisateur dans l'organisation courante.
userId: string – Nom d'utilisateur ou ID courriel de l'utilisateur.

Exemple de valeur renvoyée :

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

getStablecoinAccountOnHoldBalance

Nom de la méthode initiale : getAccountOnHoldBalance

Cette méthode retourne le solde bloqué courant pour un compte et un jeton spécifiés. Cette méthode ne peut être appelée que par Token Admin ou Token Auditor, un Org Admin ou Org Auditor de l'organisation spécifiée ou le responsable du compte.

Données utiles :

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

Paramètres :

tokenId: string – ID du jeton.
orgId: string – ID fournisseur de services d'adhésion (MSP) de l'utilisateur dans l'organisation courante.
userId: string – Nom d'utilisateur ou ID courriel de l'utilisateur.

Exemple de valeur renvoyée :

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

getStablecoinAccountOnHoldBurnBalance

Nom de la méthode initiale : getAccountOnHoldBurnBalance

Cette méthode retourne le solde de consommation bloqué pour un utilisateur spécifié. Cette méthode ne peut être appelée que par Token Admin ou Token Auditor, un Org Admin ou Org Auditor de l'organisation spécifiée ou le responsable du compte.

Données utiles :

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

Paramètres :

tokenId: string – ID du jeton.
orgId: string – ID fournisseur de services d'adhésion (MSP) de l'utilisateur dans l'organisation courante.
userId: string – Nom d'utilisateur ou ID courriel de l'utilisateur.

Exemple de valeur renvoyée :

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

getStablecoinAccountPolicyCheckById

Nom de la méthode initiale : getAccountPolicyCheckById

Cette méthode obtient les détails de la politique de compte pour un ID politique spécifié. Cette méthode ne peut être appelée que par Token Admin ou Token Auditor, ou par Org Admin ou Org Auditor de l'organisation spécifiée.

Données utiles :

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

Paramètres :

id: string – ID politique de compte unique.

Exemple de valeur renvoyée :

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

Nom de la méthode initiale : getAccountsByRole

Cette méthode retourne une liste de tous les ID compte pour un rôle et un jeton spécifiés. Cette méthode ne peut être appelée que par Token Admin ou Token Auditor.

Données utiles :

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

Paramètres :

tokenId: string – ID du jeton.
role: string – Nom du rôle à rechercher.

Exemple de valeur renvoyée :

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

getStablecoinAccountsByUser

Nom de la méthode initiale : getAccountsByUser

Cette méthode retourne une liste de tous les ID compte pour un ID organisation et un ID utilisateur spécifiés. Cette méthode ne peut être appelée que par Token Admin ou Token Auditor du code de chaîne, un Org Admin ou Org Auditor de l'organisation spécifiée ou le AccountOwner du compte.

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

Paramètres :

orgId: string – ID fournisseur de services d'adhésion (MSP) de l'utilisateur dans l'organisation courante.
userId: string – Nom d'utilisateur ou ID courriel de l'utilisateur.

Exemple de valeur renvoyée :

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

Nom de la méthode initiale : getAccountStatus

Cette méthode obtient le statut courant du compte de jeton. Cette méthode peut être appelée par Token Admin ou Token Auditor, ou par Org Admin ou Org Auditor de l'organisation spécifiée, ou par le responsable du compte de jeton. Si la valeur accountStatus est introuvable dans le livre, cette méthode retourne un objet accountStatus dont le statut est réglé à Actif.

Données utiles :

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

Paramètres :

tokenId: string – ID du jeton.
orgId: string – ID fournisseur de services d'adhésion (MSP) de l'utilisateur dans l'organisation courante.
userId: string – Nom d'utilisateur ou ID courriel de l'utilisateur.

Exemple de valeur renvoyée :

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

getStablecoinAccountTransactionHistoryWithFilters

Nom de la méthode initiale : getAccountTransactionHistoryWithFiltersFromRichHistDB

Cette méthode retourne les détails de l'historique des transactions de compte à partir de la base de données de l'historique complet. Cette méthode ne peut être appelée que par Token Admin ou Token Auditor du code de chaîne, un Org Admin ou Org Auditor de l'organisation spécifiée ou le AccountOwner du compte.

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

Paramètres :

tokenId: string – ID du jeton.
orgId: string – ID fournisseur de services d'adhésion (MSP) de l'utilisateur dans l'organisation courante.
userId: string – Nom d'utilisateur ou ID courriel de l'utilisateur.
customEndpoint – Point d'extrémité du service RESTful de la base de données d'historique enrichi à partir duquel extraire l'historique des transactions.
bearerToken – Jeton à utiliser pour appeler le point d'extrémité RESTful afin de s'assurer que la demande est autorisée.
filters: JSON object – Paramètre facultatif. Si vide, tous les enregistrements sont retournés. La propriété pageSize détermine le nombre d'enregistrements à retourner. Si pageSize a la valeur 0, la taille de page par défaut est 20. La propriété bookmark détermine l'index de début des enregistrements à retourner. Les propriétés startTime et endTime doivent être spécifiées au format RFC-3339.

Exemple de valeur renvoyée :

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

Nom de la méthode initiale : getTokenAuditors

Cette méthode retourne toutes les Token Auditors du code de chaîne. Cette méthode ne peut être appelée que par Token Admin ou Token Auditor.

Données utiles :

 	
{{api-gateway-endpoint1}}/getTokenAuditors

Paramètres :

aucune

Exemple de valeur renvoyée :

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

getTokenById

Nom de la méthode initiale : getTokenById

Cette méthode retourne les détails du jeton pour un ID jeton spécifié. Cette méthode ne peut être appelée que par Token Admin ou Token Auditor, ou par Org Admin ou Org Auditor de toute organisation.

Données utiles :

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

Paramètres :

tokenId: string – ID du jeton.

Exemple de valeur renvoyée :

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

Nom de la méthode initiale : getTokenHistory

Cette méthode retourne l'historique du jeton pour un ID jeton spécifié. Cette méthode ne peut être appelée que par Token Admin ou Token Auditor, ou par Org Admin ou Org Auditor de toute organisation.

Données utiles :

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

Paramètres :

tokenId: string – ID du jeton.

Exemple de valeur renvoyée :

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

Nom de la méthode initiale : getTotalMintedTokens

Cette méthode retourne le nombre total de jetons frappés pour un jeton spécifié. Cette méthode ne peut être appelée que par Token Admin, Token Auditor, Org Admin ou Org Auditor.

Interrogation :

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

Paramètres :

tokenId: string – ID du jeton.

Exemple de valeur renvoyée :

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

getTransactionById

Nom de la méthode initiale : getTransactionById

Cette méthode retourne l'enregistrement de transaction détaillé pour un code de transaction spécifié. Cette méthode ne peut être appelée que par Token Admin ou par n'importe quel compte spécifié par la transaction (expéditeur, destinataire ou notaire).

Données utiles :

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

Paramètres :

transaction_id string – ID de la transaction.

Exemple de valeur renvoyée :

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

Nom de la méthode initiale : getUserByAccountId

Cette méthode retourne les détails de l'utilisateur (org_id, user_id et token_id) pour un compte spécifié. Cette méthode ne peut être appelée que par Token Admin ou Token Auditor du code de chaîne, ou par Org Admin ou Org Auditor de l'organisation spécifiée.

Interrogation :

/getUserByStablecoinAccountId?accountId=account_id value

Paramètres :

accountId: string – ID du compte.

Exemple de valeur renvoyée :

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

getUsersByRole

Nom de la méthode initiale : getUsersByRole

Cette méthode GET retourne une liste de tous les utilisateurs pour un rôle et un jeton spécifiés. Cette méthode ne peut être appelée que par Token Admin ou Token Auditor du code de chaîne.

Interrogation :

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

Paramètres :

tokenId: string – ID du jeton.
role: string – Nom du rôle à rechercher.

Exemple de valeur renvoyée :

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

Nom de la méthode initiale : holdTokens

Cette méthode crée un blocage au nom du responsable des jetons avec le compte to_account_id. Un compte de notaire est spécifié, qui est responsable de terminer ou de débloquer le blocage. Lorsque le blocage est créé, le solde de jeton spécifié par le payeur est bloqué. Un solde bloqué ne peut pas être transféré tant que le blocage n'est pas terminé ou annulé. Un compte doit déjà être créé pour l'appelant de cette méthode.

Données utiles :

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

Paramètres :

tokenId: string – ID du jeton.
operationId: string – ID unique permettant d'identifier l'opération de blocage. En général, cet ID est transmis par l'application client.
toOrgId: string – ID fournisseur de services d'adhésion (MSP) du destinataire dans l'organisation courante.
toUserId: string – Nom d'utilisateur ou ID courriel du destinataire.
notaryOrgId: string – ID fournisseur de services d'adhésion (MSP) du notaire dans l'organisation actuelle.
notaryUserId: string – Nom d'utilisateur ou ID courriel du notaire.
quantity: number – Nombre de jetons à mettre en attente.
timeToExpiration – Heure à laquelle le blocage expire. Spécifiez 0 pour un blocage permanent. Sinon, utilisez le format RFC-3339. Par exemple, 2021-06-02T12 :46 :06Z.
infoDetails: JSON – Description et catégorie telles qu'illustrées dans l'exemple suivant.
```
{
   "category" : "category input",
   "description" : "description input"
}
```
endorsers: string[] – Tableau des pairs (par exemple, peer1, peer2) qui doivent endosser la transaction.

Exemple de valeur renvoyée :

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

Nom de la méthode initiale : init

Cette méthode est appelée lorsque le code de chaîne est déployé. Les informations de l'utilisateur sont enregistrées en tant que Token Admin du code de chaîne.

Données utiles :

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

Paramètres :

adminList: TokenAdminAsset[] – Tableau d'objets JSON contenant un ID organisation et un ID utilisateur spécifiant l'administrateur de jeton, dans le format suivant :
```
{
   "org_id":"{{bc-org-id}}",
   "user_id":"{{bc-admin-user}
}
```

Exemple de valeur renvoyée :

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

initializeStablecoinToken

Nom de la méthode initiale : initializeStablecoinToken

Cette méthode crée un jeton et initialise les propriétés du jeton. La ressource et ses propriétés sont enregistrées dans la base de données d'état. Cette méthode ne peut être appelée que par un Token Admin du code de chaîne.

Données utiles :

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

Paramètres :

tokenAsset: <Token Class> – La ressource de jeton est transmise en tant que paramètre à cette méthode. Les propriétés de la ressource de jeton sont décrites dans le fichier de modèle.
sameOrgEndorser: boolean – Valeur booléenne qui indique si les endossements de transaction doivent provenir de la même organisation que le demandeur.

Retourne :

En cas de succès, une représentation JSON de la ressource de jeton créée.

Exemple de valeur renvoyée :

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

Nom de la méthode initiale : isInRole

Cette méthode retourne une valeur booléenne pour indiquer si un utilisateur et un jeton ont un rôle spécifié. Cette méthode ne peut être appelée que par Token Admin ou le responsable du compte.

Données utiles :

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

Paramètres :

tokenId: string – ID du jeton.
orgId: string – ID fournisseur de services d'adhésion (MSP) de l'utilisateur.
userId: string – Nom d'utilisateur ou ID courriel de l'utilisateur.
role: string – Nom du rôle.

Exemple de valeur renvoyée :

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

isTokenAdmin

Nom de la méthode initiale : isTokenAdmin

Cette méthode retourne la valeur booléenne true si le compte spécifié est Token Admin, sinon elle retourne false. La méthode THis ne peut être appelée que par Token Admin.

Données utiles :

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

Paramètres :

orgId: string – ID fournisseur de services d'adhésion (MSP) de l'utilisateur dans l'organisation courante.
userId: string – Nom d'utilisateur ou ID courriel de l'utilisateur.

Exemple de valeur renvoyée :

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

rejectBurn

Nom de la méthode initiale : rejectBurn

Cette méthode peut être appelée par un notaire pour rejeter une demande de gravure.

Données utiles :

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

Paramètres :

tokenId: string - ID du jeton à rejeter pour gravure.
operationId: string – ID opération unique qui représente la demande de gravure.
sameOrgEndorser: boolean – Valeur booléenne qui indique si les endossements de transaction doivent provenir de la même organisation que le demandeur.

Exemple de valeur renvoyée :

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

Nom de la méthode initiale : rejectMint

Cette méthode peut être appelée par un notaire pour rejeter une demande de frappe.

Données utiles :

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

Paramètres :

tokenId: string - ID du jeton pour le rejet de la frappe.
operationId: string – ID opération unique qui représente la demande de menthe.
sameOrgEndorser: boolean – Valeur booléenne qui indique si les endossements de transaction doivent provenir de la même organisation que le demandeur.

Exemple de valeur renvoyée :

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

Nom de la méthode initiale : releaseHoldTokens

Cette méthode POST libère un blocage sur les jetons. Le transfert n'est pas terminé et tous les jetons détenus sont à nouveau disponibles pour le propriétaire initial. Cette méthode peut être appelée par l'ID AccountOwner avec le rôle notary dans la limite de temps spécifiée ou par le payeur, le bénéficiaire ou le notaire après la limite de temps spécifiée.

Données utiles :

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

Paramètres :

tokenId: string – ID du jeton.
operationId: string – ID unique permettant d'identifier l'opération de blocage. En général, cet ID est transmis par l'application client.
endorsers: string[] – Tableau des pairs (par exemple, peer1, peer2) qui doivent endosser la transaction.

Exemple de valeur renvoyée :

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

Nom de la méthode initiale : removeOrgAdmin

Cette méthode POST supprime un utilisateur en tant que Org Admin du code de chaîne. Cette méthode ne peut être appelée que par Token Admin ou Org Admin de l'organisation spécifiée.

Données utiles :

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

Paramètres :

orgId: string – ID fournisseur de services d'adhésion (MSP) de l'utilisateur dans l'organisation courante.
userId: string – Nom d'utilisateur ou ID courriel de l'utilisateur.
sameOrgEndorser: boolean – Valeur booléenne qui indique si les endossements de transaction doivent provenir de la même organisation que le demandeur.

Exemple de valeur renvoyée :

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

Nom de la méthode initiale : removeOrgAuditor

Cette méthode POST supprime un utilisateur en tant que Org Auditor du code de chaîne. Cette méthode ne peut être appelée que par Token Admin ou Org Admin de l'organisation spécifiée.

Données utiles :

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

Paramètres :

orgId: string – ID fournisseur de services d'adhésion (MSP) de l'utilisateur dans l'organisation courante.
userId: string – Nom d'utilisateur ou ID courriel de l'utilisateur.
sameOrgEndorser: boolean – Valeur booléenne qui indique si les endossements de transaction doivent provenir de la même organisation que le demandeur.

Exemple de valeur renvoyée :

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

Nom de la méthode initiale : removeRole

Cette méthode supprime le rôle af d'un utilisateur et d'un jeton spécifiés. Cette méthode ne peut être appelée que par un Token Admin du code de chaîne ou par un Org Admin de l'organisation spécifiée.

Données utiles :

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

Paramètres :

tokenId: string – ID du jeton.
role: string – Nom du rôle à supprimer de l'utilisateur spécifié. Les comportements mintable et burnable correspondent aux propriétés minter_role_name et burner_role_name du fichier de spécification. De même, le rôle notary correspond à la propriété notary_role_name du fichier de spécification.
orgId: string – ID fournisseur de services d'adhésion (MSP) de l'utilisateur dans l'organisation courante.
userId: string – Nom d'utilisateur ou ID courriel de l'utilisateur.
endorsers: string[] – Tableau des pairs (par exemple, peer1, peer2) qui doivent endosser la transaction.

Retourne :

En cas de succès, un message avec les détails du compte.

Exemple de valeur renvoyée :

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

Nom de la méthode initiale : removeTokenAdmin

Cette méthode POST supprime un utilisateur en tant que Token Admin du code de chaîne. Cette méthode ne peut être appelée que par un Token Admin du code de chaîne. Un administrateur ne peut pas se supprimer lui-même.

Données utiles :

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

Paramètres :

orgId: string – ID fournisseur de services d'adhésion (MSP) de l'utilisateur dans l'organisation courante.
userId: string – Nom d'utilisateur ou ID courriel de l'utilisateur.
sameOrgEndorser: boolean – Valeur booléenne qui indique si les endossements de transaction doivent provenir de la même organisation que le demandeur.

Exemple de valeur renvoyée :

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

Nom de la méthode initiale : removeTokenAuditor

Cette méthode POST supprime un utilisateur en tant que Token Auditor du code de chaîne. Cette méthode ne peut être appelée que par un Token Admin du code de chaîne.

Données utiles :

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

Paramètres :

orgId: string – ID fournisseur de services d'adhésion (MSP) de l'utilisateur dans l'organisation courante.
userId: string – Nom d'utilisateur ou ID courriel de l'utilisateur.
sameOrgEndorser: boolean – Valeur booléenne qui indique si les endossements de transaction doivent provenir de la même organisation que le demandeur.

Exemple de valeur renvoyée :

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

Nom de la méthode initiale : requestBurn

Cette méthode peut être appelée par un brûleur pour envoyer une demande au notaire de détruire une quantité spécifiée de jetons.

Données utiles :

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

Paramètres :

tokenId: string - ID du jeton à graver.
operationId: string – ID opération unique qui représente la demande de gravure.
notaryOrgId: string – ID du fournisseur de services d'adhésion (MSP) du notaire du brûleur qui traitera la demande.
notaryUserId: string – Nom d'utilisateur ou ID courriel du notaire du brûleur qui traitera la demande.
quantity: number – La quantité de jetons à brûler.
timeToExpiration – Heure après laquelle la demande de gravure expire et n'est plus valide.
infoDetails: JSON – Objet spécifiant la catégorie (category) et la description (description) de la demande, comme illustré dans l'exemple suivant.
```
{
     "category" : "category input",
     "description" : "description input"
}
```
sameOrgEndorser: boolean – Valeur booléenne qui indique si les endossements de transaction doivent provenir de la même organisation que le demandeur.

Exemple de valeur renvoyée :

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

Nom de la méthode initiale : requestMint

Cette méthode peut être appelée par un minter pour envoyer une demande au notaire minter de créer une quantité spécifiée de jetons.

Données utiles :

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

Paramètres :

tokenId: string - ID du jeton à extraire.
operationId: string – ID opération unique qui représente la demande de menthe.
notaryOrgId: string – ID du fournisseur de services d'adhésion (MSP) du notaire qui traitera la demande.
notaryUserId: string – Nom d'utilisateur ou ID courriel du notaire qui traitera la demande.
quantity: number – La quantité de jetons à la menthe.
timeToExpiration – Heure après laquelle la demande de frappe expire et n'est plus valide.
infoDetails: JSON – Objet spécifiant la catégorie (category) et la description (description) de la demande, comme illustré dans l'exemple suivant.
```
{
     "category" : "category input",
     "description" : "description input"
}
```
sameOrgEndorser: boolean – Valeur booléenne qui indique si les endossements de transaction doivent provenir de la même organisation que le demandeur.

Exemple de valeur renvoyée :

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

Nom de la méthode initiale : setMaxDailyAmount

Cette méthode POST est utilisée pour définir le paramètre maxDailyAmount dans les détails du compte pour le montant spécifié. Cette méthode ne peut être appelée que par un Token Admin du code de chaîne ou par un Org Admin de l'organisation spécifiée.

Données utiles :

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

Paramètres :

orgId: string – ID fournisseur de services d'adhésion (MSP) de l'utilisateur dans l'organisation courante.
userId: string – Nom d'utilisateur ou ID courriel de l'utilisateur.
tokenId: string – ID du jeton.
maxDailyAmount: number – Valeur du montant quotidien maximal pour le compte spécifié, qui définit le montant maximal pouvant être traité quotidiennement.
endorsers: string[] – Tableau des pairs (par exemple, peer1, peer2) qui doivent endosser la transaction.

Exemple de valeur renvoyée :

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

Nom de la méthode initiale : setMaxDailyTransactionCount

Cette méthode POST est utilisée pour définir le paramètre maxDailyTransactions dans les détails du compte pour le montant spécifié. Cette méthode ne peut être appelée que par un Token Admin du code de chaîne ou par un Org Admin de l'organisation spécifiée.

Données utiles :

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

Paramètres :

orgId: string – ID fournisseur de services d'adhésion (MSP) de l'utilisateur dans l'organisation courante.
userId: string – Nom d'utilisateur ou ID courriel de l'utilisateur.
tokenId: string – ID du jeton.
maxDailyTransactions: number – Valeur du montant quotidien maximal pour le compte spécifié, qui définit le nombre maximal de transactions autorisées par jour.
endorsers: string[] – Tableau des pairs (par exemple, peer1, peer2) qui doivent endosser la transaction.

Exemple de valeur renvoyée :

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

Nom de la méthode initiale : suspendAccount

Cette méthode suspend un compte de jeton fongible. Une erreur est générée si aucune valeur accountStatus n'est trouvée dans le livre. Cette méthode ne peut être appelée que par un Token Admin du code de chaîne ou par un Org Admin de l'organisation spécifiée.

Données utiles :

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

Paramètres :

tokenId: string – ID du jeton.
orgId: string – ID fournisseur de services d'adhésion (MSP) de l'utilisateur dans l'organisation courante.
userId: string – Nom d'utilisateur ou ID courriel de l'utilisateur.
endorsers: string[] – Tableau des pairs (par exemple, peer1, peer2) qui doivent endosser la transaction.

Exemple de valeur renvoyée :

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

Nom de la méthode initiale : transferTokens

Cette méthode transfère les jetons de l'appelant vers un compte spécifié. L'appelant de la méthode doit avoir un compte. La quantité doit être comprise dans les valeurs décimales spécifiées par le paramètre decimal du comportement divisible dans le fichier de spécification.

Données utiles :

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

Paramètres :

tokenId: string – ID du jeton.
toOrgId: string – ID fournisseur de services d'adhésion (MSP) du destinataire (bénéficiaire) dans l'organisation courante.
toUserId: string – Nom d'utilisateur ou ID courriel du destinataire.
quantity: number – Le nombre de jetons à transférer.
infoDetails: JSON – Objet spécifiant la catégorie (category) et la description (description) de la demande, comme illustré dans l'exemple suivant.
```
{
     "category" : "category input",
     "description" : "description input"
}
```
endorsers: string[] – Tableau des pairs (par exemple, peer1, peer2) qui doivent endosser la transaction.

Exemple de valeur renvoyée :

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

Nom de la méthode initiale : updateAccountPolicyCheck

Cette méthode met à jour la politique pour un compte spécifié. Cette méthode ne peut être appelée que par Token Admin ou Org Admin de l'organisation spécifiée.

Données utiles :

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

Paramètres :

asset: AccountPolicyCheck object – Objet qui définit les paramètres de politique de compte, qui inclut les champs suivants :
- accountPolicyId – ID politique de compte unique.
- orgId - ID fournisseur de services d'adhésion (MSP) de l'utilisateur pour lequel créer la politique.
- userId – Nom d'utilisateur ou ID courriel de l'utilisateur pour lequel créer la politique.
- kycCompliance – Valeur booléenne qui indique si le compte satisfait aux exigences de connaissance du client.
- amlCompliance – Valeur booléenne indiquant si le compte répond aux exigences de lutte contre le blanchiment d'argent.
- riskScore – Note de risque associée au compte, qui est utilisée pour l'évaluation de la conformité.
- restrictionFlag – Valeur booléenne indiquant si le compte fait l'objet de transferts restreints. Si la valeur est réglée à true, seuls les transferts au seuil d'approbation-politique le plus bas sont autorisés.
endorsers: string[] – Tableau des pairs (par exemple, peer1, peer2) qui doivent endosser la transaction.

Exemple de valeur renvoyée :

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

Nom de la méthode initiale : updateApprovalPolicyCheck

Cette méthode met à jour la politique d'approbation. Cette méthode ne peut être appelée que par Token Admin.

Données utiles :

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

Paramètres :

asset: ApprovalPolicyCheck class – Classe qui définit les règles d'approbation pour une transaction, qui inclut les champs suivants :
- approvalPolicyId – ID politique d'approbation unique.
- transactionLowerLimit – Montant minimal de transaction auquel s'applique la politique d'approbation.
- transactionUpperLimit – Montant de transaction maximal auquel s'applique la politique d'approbation.
- numberOfApprovalsRequired – Nombre total d'approbations nécessaires avant que la transaction puisse être terminée.
- approverDetails – Liste des approbateurs ainsi que la séquence d'approbation qui leur est affectée, qui définit l'ordre obligatoire pour les approbations.
endorsers: string[] – Tableau des pairs (par exemple, peer1, peer2) qui doivent endosser la transaction.

Exemple de valeur renvoyée :

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

Nom de la méthode initiale : updateStablecoinToken

Cette méthode met à jour un jeton stablecoin. Cette méthode ne peut être appelée que par Token Admin.

Données utiles :

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

Paramètres :

asset <Token Class> – La ressource de jeton est transmise en tant que paramètre à cette méthode. Les propriétés de la ressource de jeton peuvent varier et sont décrites dans le fichier de spécification de jeton. N'incluez pas de paramètres marqués en lecture seule dans le fichier de spécification.
Vous spécifiez le paramètre asset dans un format différent si vous utilisez Visual Studio Code par rapport à l'interface de ligne de commande ou à une collection Postman.

Visual Studio Code : Utilisez l'interface graphique pour transmettre des paramètres individuels qui correspondent aux champs de classe de jeton.

Interface de ligne de commande / Postman : Transmettez une chaîne JSON sérialisée qui inclut les champs de spécification de jeton, comme illustré dans l'exemple suivant.

"{\"token_id\":\"USD\",\"token_desc\":\"token_desc value\",\"Currency_Name\":\"Currency_Name value\"}"
endorsers: string[] – Tableau des pairs (par exemple, peer1, peer2) qui doivent endosser la transaction.

Exemple de valeur renvoyée :

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

Nom de la méthode initiale : createStablecoinAccount

Cette API d'encapsulation personnalisée combine les API de code de chaîne et les API de la console Oracle Blockchain Platform en un seul point d'extrémité. Cette méthode effectue les étapes suivantes dans l'ordre.

Crée un ID inscription pour un utilisateur dans le mandataire REST de l'instance. Si une inscription existe déjà pour le code d'utilisateur, l'inscription ne sera pas créée de nouveau. Le code d'inscription est le même que celui de l'utilisateur. L'ID inscription ne peut contenir que des caractères alphanumériques, des tirets (-) et des traits de soulignement (_). Si l'ID utilisateur contient d'autres caractères spéciaux, ils sont remplacés par des traits de soulignement (_).
Crée un compte dans le livre.
Associe le nouveau compte au jeton spécifié.
Affecte le rôle spécifié à l'utilisateur.

Si l'une des étapes échoue, l'inscription est automatiquement supprimée.

Données utiles :

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

Paramètres :

orgId – ID fournisseur de services d'adhésion (MSP) de l'utilisateur pour lequel créer le compte. L'ID doit commencer par un caractère alphanumérique et peut inclure des lettres, des chiffres et des caractères spéciaux tels que des traits de soulignement (_), des points (.), des signes at (@) et des tirets (-).
userId – Nom d'utilisateur ou ID courriel de l'utilisateur. L'ID doit commencer par un caractère alphanumérique et peut inclure des lettres, des chiffres et des caractères spéciaux tels que des traits de soulignement (_), des points (.), des signes at (@) et des tirets (-).
tokenId: string – ID jeton, qui doit commencer par un caractère alphanumérique et peut inclure des lettres, des chiffres et le trait de soulignement des caractères spéciaux (_) et le tiret (-). Il ne doit pas dépasser 16 caractères.
role: string – Nom du rôle à ajouter à l'utilisateur spécifié, qui doit être l'une des valeurs suivantes : minter, burner, notary, tokenAdmin, tokenAuditor, orgAdmin ou orgAuditor.
dailyLimits: JSON object – Objet JSON du type suivant.
```
{
     "max_daily_amount": 100000
     "max_daily_transactions": 10000
 }
```
Dans l'exemple, la valeur max_daily_amount est le nombre maximal de jetons pouvant être traités quotidiennement et la valeur max_daily_transactions est le nombre maximal de transactions pouvant être effectuées quotidiennement.

Retourne :

En cas de succès, un objet JSON du compte qui a été créé.

Exemple de valeur renvoyée :

"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

Nom de la méthode initiale : createIDCSUser

Cette méthode POST crée un utilisateur Identity Cloud Service dans la location spécifiée par l'URL dans le fichier terraform.tfvars et affecte l'utilisateur au groupe d'utilisateurs spécifié.

Données utiles :

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

Paramètres :

userName: string – ID de l'utilisateur.
firstName: string – Prénom de l'utilisateur.
lastName: string – Nom de l'utilisateur.
email: string – Adresse de courriel de l'utilisateur.
groupName: string – Nom du groupe Identity Cloud Service à affecter à l'utilisateur.

Exemple de valeur renvoyée :

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