1. Oracle Blockchain Platform Digital Assets Edition
  2. Structures de jetons génériques
  3. Structure de jetons fongibles
  4. Package API de wrapper de structure de jetons fongibles

Package API de wrapper de structure de jetons fongibles

Oracle Blockchain Platform Digital Assets Edition inclut un package d'API de wrapper qui étend l'API REST pour prendre en charge les opérations propres à un scénario de jeton de dépôt.

Le package d'API wrapper utilise le service API Gateway et OCI Functions pour déployer des routages d'API spécialement conçus pour l'application de jeton de dépôt. Le package d'API de wrapper de structure de jetons fongible peut être téléchargé à partir de la console Oracle Blockchain Platform et inclut les composants suivants.
  • DepositTokenWrapperAPI.zip, fichier d'archive contenant le package d'API de wrapper, y compris les scripts Terraform requis pour le déploiement. Vous déployez ce fichier vers une pile Resource Manager sur Oracle Cloud Infrastructure (OCI) afin de créer les ressources Oracle nécessaires pour les API de wrapper.
  • DepositToken_WrapperAPI.postman_collection.json, une collection Postman qui vous permet de tester les API de wrapper déployées. La collection inclut des demandes préconfigurées avec des adresses et des charges utiles qui correspondent aux API définies dans le package d'API de wrapper.

API de wrapper

activateAccount
Nom de la méthode d'origine : activateAccount
Cette méthode POST active un compte de jeton. Cette méthode peut uniquement être appelée par Token Admin ou Org Admin de l'organisation indiquée. Pour tous les comptes créés avant la fonctionnalité de statut de compte, vous devez appeler cette méthode pour voir le statut du compte actif.
Charge utile:
{
    "tokenId": "{{bc-token-id}}",
    "orgId": "{{bc-org-id}}",
    "userId": "{{bc-user-id}}",
    "endorsers": {{endorsers}}
}
Paramètres :
  • tokenId: string : ID du jeton.
  • orgId: string : ID du fournisseur de services d'adhésion de l'utilisateur dans l'organisation actuelle.
  • userId: string : nom d'utilisateur ou adresse électronique de l'utilisateur.
  • endorsers: string[] : tableau des homologues (par exemple, peer1, peer2) qui doit approuver la transaction.
Renvoie :
  • En cas de succès, 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": "db0738d4a44f6d9c80b24fce7c518c07023f7be19edaa69b272eaf7886b4b925",
        "payload": {
            "assetType": "oaccountStatus",
            "status_id": "oaccountStatus~d5814d96d8517ac31727d60aace0519c58a425892ab0d378fcfb0a35771f65ae",
            "account_id": "oaccount~802bf8da5579c6103b2dddaa6c4385df8e722d639a18029e0e93d7a5d6f826d6",
            "status": "active"
        },
        "encode": "JSON",
        "sourceURL": "cb-oabcs1-bom.blockchain.ocp.example.com:20009",
        "blockNumber": 194
    }
}
addTokenAdmin
Nom de la méthode d'origine : addTokenAdmin
Cette méthode POST ajoute un utilisateur en tant que Token Admin du code chaîne. Cette méthode ne peut être appelée que par un Token Admin du code chaîne.
Charge utile:
{
    "orgId": "{{bc-org-id}}",
    "userId": "{{bc-user-id}}",
    "sameOrgEndorser": true
}
Paramètres :
  • orgId: string : ID du fournisseur de services d'adhésion de l'utilisateur dans l'organisation actuelle.
  • userId: string : nom d'utilisateur ou adresse électronique de l'utilisateur.
  • sameOrgEndorser: boolean : valeur booléenne qui indique si les approbations de transaction doivent provenir de la même organisation que le demandeur.
Renvoie :
  • En cas de succès, message qui inclut les détails de l'utilisateur ajouté en tant que Token Admin du code chaîne.
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
Cette méthode POST ajoute un utilisateur en tant que Token Auditor du code chaîne. Cette méthode ne peut être appelée que par un Token Admin du code chaîne.
Charge utile:
{
    "orgId": "{{bc-org-id}}",
    "userId": "{{bc-user-id}}",
    "sameOrgEndorser": true
}
Paramètres :
  • orgId: string : ID du fournisseur de services d'adhésion de l'utilisateur dans l'organisation actuelle.
  • userId: string : nom d'utilisateur ou adresse électronique de l'utilisateur.
  • sameOrgEndorser: boolean : valeur booléenne qui indique si les approbations de transaction doivent provenir de la même organisation que le demandeur.
Renvoie :
  • En cas de succès, message qui inclut les détails de l'utilisateur ajouté en tant que Token Auditor du code chaîne.
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
    }
}
addOrgAdmin
Nom de la méthode d'origine : addOrgAdmin
Cette méthode POST ajoute un utilisateur en tant que Token Admin du code chaîne. Cette méthode peut être appelée uniquement par un Token Admin du code chaîne ou par un Org Admin de l'organisation indiquée.
Charge utile:
{
    "orgId": "{{bc-org-id}}",
    "userId": "{{bc-user-id}}",
    "sameOrgEndorser": true
}
Paramètres :
  • orgId: string : ID du fournisseur de services d'adhésion de l'utilisateur dans l'organisation actuelle.
  • userId: string : nom d'utilisateur ou adresse électronique de l'utilisateur.
  • sameOrgEndorser: boolean : valeur booléenne qui indique si les approbations de transaction doivent provenir de la même organisation que le demandeur.
Renvoie :
  • En cas de succès, message qui inclut les détails de l'utilisateur ajouté en tant que Org Admin du code chaîne.
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
Cette méthode POST ajoute un utilisateur en tant que Org Auditor du code chaîne. Cette méthode peut uniquement être appelée par Token Admin du code chaîne ou par Org Admin de l'organisation indiquée.
Charge utile:
{
    "orgId": "{{bc-org-id}}",
    "userId": "{{bc-user-id}}",
    "sameOrgEndorser": true
}
Paramètres :
  • orgId: string : ID du fournisseur de services d'adhésion de l'utilisateur dans l'organisation actuelle.
  • userId: string : nom d'utilisateur ou adresse électronique de l'utilisateur.
  • sameOrgEndorser: boolean : valeur booléenne qui indique si les approbations de transaction doivent provenir de la même organisation que le demandeur.
Renvoie :
  • En cas de succès, message qui inclut les détails de l'utilisateur ajouté en tant que Org Auditor du code chaîne.
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 d'origine : addRole
Cette méthode ajoute le rôle à l'utilisateur et au jeton spécifiés.
Charge utile:
{
    "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é.
  • orgId: string : ID du fournisseur de services d'adhésion de l'utilisateur dans l'organisation actuelle.
  • userId: string : nom d'utilisateur ou adresse électronique de l'utilisateur.
  • endorsers: string[] : tableau des homologues (par exemple, peer1, peer2) qui doit approuver 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
    }
}
approveMint
Nom de la méthode d'origine : approveMint
Les notaires peuvent appeler cette méthode POST pour approuver une demande de menthe.
Charge utile:
{
    "tokenId": "{{bc-token-id}}",
    "operationId": "operation_id value",
    "sameOrgEndorser": true
}
Paramètres :
  • tokenId: string : ID du jeton.
  • operationId: string : ID d'opération unique de la demande de menthe à approuver.
  • sameOrgEndorser: boolean : valeur booléenne qui indique si les approbations 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
    }
}
executeHoldTokens
Nom de la méthode d'origine : executeHoldTokens
Les notaires appellent cette méthode pour approuver un blocage sur les jetons. La quantité de jetons bloqués précédemment par le propriétaire du jeton est désormais transférée au destinataire. Si la valeur quantity est inférieure à la valeur de blocage réelle, le montant restant est à nouveau disponible pour le propriétaire du jeton. Si le comportement roles est indiqué 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 un rôle de notaire. Sinon, tout appelant ayant un compte peut fonctionner comme notaire.
Charge utile:
{
    "tokenId": "{{bc-token-id}}",
    "operationId": "operation_id value",
    "quantity": 1,
    "endorsers": {{endorsers}}
}
Paramètres :
  • tokenId: string : ID du jeton.
  • operationId: string : ID d'opération unique de la demande de menthe à approuver.
  • quantity: number : nombre de jetons détenus à transférer.
  • endorsers: string[] : tableau des homologues (par exemple, peer1, peer2) qui doit approuver 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
    }
}
associateTokenToAccount
Nom de la méthode d'origine : associateTokenToAccount
Cette méthode POST associe un ID de compte spécifié à un jeton spécifié. Elle peut être appelée par Token Admin ou Org Admin.
Charge utile:
{
    "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 homologues (par exemple, peer1, peer2) qui doit approuver 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": "cbdc",
            "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
    }
}
createAccount
Nom de la méthode d'origine : 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 ID de compte sont formés en concaténant le type de ressource et l'ID de jeton, puis en créant un hachage SHA-256 sur une concaténation de l'ID d'organisation et de l'ID d'utilisateur. Cette méthode peut uniquement être appelée par Token Admin du code chaîne ou par Org Admin de l'organisation indiquée.
Charge utile:
{
    "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 du fournisseur de services d'adhésion 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 arobase (@) et des tirets (-).
  • userId : nom d'utilisateur ou adresse électronique 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 arobase (@) et des tirets (-).
  • tokenType: TokenType : type de jeton, qui doit être fungible.
  • daily_limits: DailyLimits : objet JSON du type suivant.
    {
     "max_daily_amount": 100000
     "max_daily_transactions": 10000
 }
    Dans l'exemple, la valeur max_daily_amount est la quantité maximale 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 homologues (par exemple, peer1, peer2) qui doit approuver 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
    }
}
getAccount
Nom de la méthode d'origine : getAccount
Cette méthode renvoie les détails de compte pour un utilisateur spécifié. Cette méthode peut uniquement être appelée par Token Admin du code chaîne ou par Account Owner du compte.
Interroger :
/getAccount?tokenId={{bc-token-id}}&orgId={{bc-org-id}}&userId={{bc-user-id}}
Paramètres :
  • tokenId: string : ID du jeton.
  • orgId: string : ID du fournisseur de services d'adhésion de l'utilisateur dans l'organisation actuelle.
  • userId: string : nom d'utilisateur ou adresse électronique 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": "cbdc",
            "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"
    }
}
getAccountBalance
Nom de la méthode d'origine : getAccountBalance
Cette méthode GET renvoie le solde actuel pour un compte et un jeton spécifiés. Cette méthode ne peut être appelée que par Token Admin ou AccountOwner du compte. 
/getAccountBalance?tokenId={{bc-token-id}}&orgId={{bc-org-id}}&userId={{bc-user-id}}
Paramètres :
  • tokenId: string : ID du jeton.
  • orgId: string : ID du fournisseur de services d'adhésion de l'utilisateur dans l'organisation actuelle.
  • userId: string : nom d'utilisateur ou adresse électronique de l'utilisateur.
Exemple de valeur renvoyée :
{
    "returnCode": "Success",
    "error": "",
    "result": {
        "payload": {
            "msg": "Current Balance is: 100",
            "user_balance": 100
        },
        "encode": "JSON"
    }
}
getAccountsByUser
Nom de la méthode d'origine : getAccountsByUser
Cette méthode renvoie la liste de tous les comptes pour un utilisateur spécifié. Cette méthode peut uniquement être appelée par Token Admin du code chaîne ou par Account Owner du compte.
Interroger :
/getAccountsByUser?orgId={{bc-org-id}}&userId={{bc-user-id}}
Paramètres :
  • orgId: string : ID du fournisseur de services d'adhésion de l'utilisateur dans l'organisation actuelle.
  • userId: string : nom d'utilisateur ou adresse électronique 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": "cbdc",
                "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"
    }
}
getAccountTransactionHistory
Nom de la méthode d'origine : getAccountTransactionHistory
Cette méthode GET renvoie l'historique des transactions du compte. Cette méthode peut être appelée uniquement par un élément Token Admin du code chaîne ou par le propriétaire du compte. 
/getAccountTransactionHistory?tokenId={{bc-token-id}}&orgId={{bc-org-id}}&userId={{bc-user-id}}
Paramètres :
  • tokenId: string : ID du jeton.
  • orgId: string : ID du fournisseur de services d'adhésion de l'utilisateur dans l'organisation actuelle.
  • userId: string : nom d'utilisateur ou adresse électronique 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"
    }
}
getAccountTransactionHistoryWithFiltersFromRichHistDB
Nom de la méthode d'origine : getAccountTransactionHistoryWithFiltersFromRichHistDB
Cette méthode renvoie les détails de l'historique des transactions de compte à partir de la base de données d'historique enrichi. Cette méthode ne peut être appelée que par Token Admin ou AccountOwner du compte. Pour pouvoir utiliser cette méthode, vous devez exécuter Oracle Autonomous Database avec Oracle REST Data Services (ORDS) et OAuth activés, comme décrit dans Définitions de vue Oracle Database pour Wholesale CBDC. 
/getAccountTransactionHistoryWithFiltersFromRichHistDB?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 du fournisseur de services d'adhésion de l'utilisateur dans l'organisation actuelle.
  • userId: string : nom d'utilisateur ou adresse électronique de l'utilisateur.
  • customEndpoint : adresse de service RESTful de la base de données d'historique enrichi à partir de laquelle extraire l'historique des transactions.
  • bearerToken : jeton à utiliser pour appeler l'adresse RESTful afin de s'assurer que la demande est autorisée.
  • filters: string : paramètre facultatif. Si ce champ est vide, tous les enregistrements sont renvoyés. La propriété PageSize détermine le nombre d'enregistrements à renvoyer. Si PageSize est égal à 0, la taille de page par défaut est de 20. La propriété Bookmark détermine l'index de début des enregistrements à renvoyer. 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"
    }
}
getNetTokens
Nom de la méthode d'origine : getNetTokens
Cette méthode GET renvoie le nombre total net de jetons disponibles dans le système pour un jeton spécifié. Le total du jeton net correspond à la quantité de jetons restants après la gravure des jetons. Cette méthode peut être appelée uniquement par Token Admin du code chaîne ou par Org Admin de l'organisation indiquée. 
/getNetCBDCTokens?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"
    }
}
getOnHoldIds
Nom de la méthode d'origine : getOnHoldIds
Cette méthode GET renvoie la liste de tous les ID de conservation pour un utilisateur et un jeton spécifiés. Cette méthode ne peut être appelée que par Token Admin, Org Admin ou 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 du fournisseur de services d'adhésion de l'utilisateur dans l'organisation actuelle.
  • userId: string : nom d'utilisateur ou adresse électronique de l'utilisateur.
Exemple de valeur renvoyée :
{
    "returnCode": "Success",
    "error": "",
    "result": {
        "payload": {
            "msg": "Holding Ids are: ohold~cbdc~USD~8e3147,ohold~cbdc~USD~8e315",
            "holding_ids": [
                "ohold~cbdc~USD~8e3147",
                "ohold~cbdc~USD~8e315"
            ]
        },
        "encode": "JSON"
    }
}
getTotalMintedTokens
Nom de la méthode d'origine : getTotalMintedTokens
Cette méthode GET renvoie le nombre total de jetons extraits pour un jeton spécifié. Cette méthode ne peut être appelée que par Token Admin ou Org Admin.
Interroger :
/getTotalMintedTokens?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"
    }
}
getUserByAccountId
Nom de la méthode d'origine : getUserByAccountId
Cette méthode GET renvoie les détails de l'utilisateur pour un compte spécifié. Cette méthode peut être appelée par Token Admin, Token Auditor ou Org Auditor.
Interroger :
/getUserByAccountId?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 d'origine : getUsersByRole
Cette méthode renvoie la 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. 
/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 d'origine : holdTokens
Cette méthode crée un blocage pour le compte du propriétaire des jetons avec le compte to_account_id. Un compte de notaire est spécifié, qui est chargé de terminer ou de lever le blocage. Lorsque le blocage est créé, le solde de jetons 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 levé. L'appelant de cette méthode doit avoir un compte déjà créé.
Charge utile:
{
    "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. Cet ID est généralement transmis par l'application client.
  • toOrgId: string : ID du fournisseur de services d'adhésion du destinataire dans l'organisation actuelle.
  • toUserId: string : nom d'utilisateur ou ID courriel du destinataire.
  • notaryOrgId: string : ID du fournisseur de services d'adhésion 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 la mise en attente 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, comme indiqué dans l'exemple suivant.
    {
   "category" : "category input",
   "description" : "description input"
}
  • endorsers: string[] : tableau des homologues (par exemple, peer1, peer2) qui doit approuver 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 d'origine : init
Cette méthode est appelée lorsque le code chaîne est déployé. Les informations utilisateur sont enregistrées en tant que Token Admin du code chaîne.
Charge utile:
{
    "adminList": "[{\"org_id\":\"{{bc-org-id}}\",\"user_id\":\"{{bc-admin-user}}\"}]"
}
Paramètres :
  • adminList array : tableau d'informations {user_id, org_id} qui indique la liste des administrateurs de jeton. Le tableau adminList est un paramètre obligatoire.
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
    }
}
initializeDepositToken
Nom de la méthode d'origine : initializeDepositToken
Cette méthode crée un jeton et initialise ses propriétés. 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 chaîne.
Charge utile:
{
    "tokenAsset": "{\"token_id\":\"{{bc-token-id}}\",\"token_desc\":\"token_desc 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 approbations de transaction doivent provenir de la même organisation que le demandeur.
Renvoie :
  • En cas de succès, 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": "cbdc",
            "token_desc": "token_desc value",
            "token_standard": "ttf+",
            "token_type": "fungible",
            "token_unit": "fractional",
            "behaviors": [
                "divisible",
                "mintable",
                "transferable",
                "burnable",
                "holdable",
                "roles"
            ],
            "roles": {
                "minter_role_name": "minter",
                "burner_role_name": "burner",
                "notary_role_name": "notary",
                "mint_approver_role_name": "notary",
                "burn_approver_role_name": "notary"
            },
            "mintable": {
                "max_mint_quantity": 1000,
                "mint_approval_required": true
            },
            "burnable": {
                "burn_approval_required": true
            },
            "divisible": {
                "decimal": 2
            },
            "token_to_currency_ratio": 999
        },
        "encode": "JSON",
        "sourceURL": "cb-oabcs1-bom.blockchain.ocp.example.com:20009",
        "blockNumber": 267
    }
}
getAccountHistory
Nom de la méthode d'origine : getAccountHistory
Cette méthode GET renvoie les détails de l'historique du compte pour un utilisateur et un jeton spécifiés.
Interroger :
/getAccountHistory?tokenId={{bc-token-id}}&orgId={{bc-org-id}}&userId={{bc-user-id}}
Paramètres :
  • tokenId: string : ID du jeton.
  • orgId: string : ID du fournisseur de services d'adhésion de l'utilisateur dans l'organisation actuelle.
  • userId: string : nom d'utilisateur ou adresse électronique de l'utilisateur.
Exemple de valeur renvoyée :
{
    "returnCode": "Success",
    "error": "",
    "result": {
        "payload": [
            {
              "trxId":"2gsdh17fff222467e5667be042e33ce18e804b3e065cca15de306f837e416d7c3e",
              "timeStamp":1629718288,
              "value":{
                 "assetType":"oaccount",
                 "account_id":"oaccount~digicur~b4f45440aa2a7942db64443d047027e9d714d62cba5c3d546d64f368642f622f",
                 "user_id":"user1",
                 "org_id":"Org1MSP",
                 "token_id":"digiCurr101",
                 "token_name":"digicur",
                 "balance":100,
                 "onhold_balance":0,
                 "bapAccountVersion": 1
           },
           {
              "trxId":"9fd07fff222467e5667be042e33ce18e804b3e065cca15de306f837e416d7c3e",
              "timeStamp":1629718288,
              "value":{
                 "assetType":"oaccount",
                 "account_id":"oaccount~digicur~b4f45440aa2a7942db64443d047027e9d714d62cba5c3d546d64f368642f622f",
                 "user_id":"user1",
                 "org_id":"Org1MSP",
                 "token_id":"digiCurr101",
                 "token_name":"digicur",
                 "balance":0,
                 "onhold_balance":0,
                 "bapAccountVersion": 0
              }
           }
        ],
        "encode": "JSON"
    }
}
rejectMint
Nom de la méthode d'origine : rejectMint
Cette méthode peut être appelée par un notaire pour rejeter une demande de frappe.
Charge utile:
{
    "tokenId": "{{bc-token-id}}",
    "operationId": "operation_id value",
    "sameOrgEndorser": true
}
Paramètres :
  • token_id: string : ID du jeton à rejeter.
  • operation_id: string : ID d'opération unique qui représente la demande menthe.
  • sameOrgEndorser: boolean : valeur booléenne qui indique si les approbations 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 d'origine : 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 d'origine.
Charge utile:
{
    "tokenId": "{{bc-token-id}}",
    "operationId": "operation_id value",
    "endorsers": {{endorsers}}
}
Paramètres :
  • token_id: string : ID du jeton.
  • operation_id: string : ID unique permettant d'identifier l'opération de blocage. Cet ID est généralement transmis par l'application client.
  • endorsers: string[] : tableau des homologues (par exemple, peer1, peer2) qui doit approuver 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
    }
}
removeTokenAdmin
Nom de la méthode d'origine : removeTokenAdmin
Cette méthode POST supprime un utilisateur en tant que Token Admin du code chaîne. Cette méthode ne peut être appelée que par un Token Admin du code chaîne. Un administrateur ne peut pas se retirer lui-même.
Charge utile:
{
    "orgId": "{{bc-org-id}}",
    "userId": "{{bc-user-id}}",
    "sameOrgEndorser": true
}
Paramètres :
  • org_id: string : ID du fournisseur de services d'adhésion de l'utilisateur dans l'organisation actuelle.
  • user_id: string : nom d'utilisateur ou ID de courriel de l'utilisateur.
  • sameOrgEndorser: boolean : valeur booléenne qui indique si les approbations 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 d'origine : removeTokenAuditor
Cette méthode POST supprime un utilisateur en tant que Token Auditor du code chaîne. Cette méthode ne peut être appelée que par un Token Admin du code chaîne.
Charge utile:
{
    "orgId": "{{bc-org-id}}",
    "userId": "{{bc-user-id}}",
    "sameOrgEndorser": true
}
Paramètres :
  • org_id: string : ID du fournisseur de services d'adhésion de l'utilisateur dans l'organisation actuelle.
  • user_id: string : nom d'utilisateur ou ID de courriel de l'utilisateur.
  • sameOrgEndorser: boolean : valeur booléenne qui indique si les approbations 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
    }
}
removeOrgAdmin
Nom de la méthode d'origine : removeOrgAdmin
Cette méthode POST supprime un utilisateur en tant que Org Admin du code chaîne. Cette méthode ne peut être appelée que par Token Admin ou Org Admin de l'organisation indiquée.
Charge utile:
{
    "orgId": "{{bc-org-id}}",
    "userId": "{{bc-user-id}}",
    "sameOrgEndorser": true
}
Paramètres :
  • org_id: string : ID du fournisseur de services d'adhésion de l'utilisateur dans l'organisation actuelle.
  • user_id: string : nom d'utilisateur ou ID de courriel de l'utilisateur.
  • sameOrgEndorser: boolean : valeur booléenne qui indique si les approbations 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 d'origine : removeOrgAuditor
Cette méthode POST supprime un utilisateur en tant que Org Auditor du code chaîne. Cette méthode ne peut être appelée que par Token Admin ou Org Admin de l'organisation indiquée.
Charge utile:
{
    "orgId": "{{bc-org-id}}",
    "userId": "{{bc-user-id}}",
    "sameOrgEndorser": true
}
Paramètres :
  • org_id: string : ID du fournisseur de services d'adhésion de l'utilisateur dans l'organisation actuelle.
  • user_id: string : nom d'utilisateur ou ID de courriel de l'utilisateur.
  • sameOrgEndorser: boolean : valeur booléenne qui indique si les approbations 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 d'origine : removeRole
Cette méthode supprime un rôle d'un utilisateur spécifié. Cette méthode peut uniquement être appelée par Token Admin du code chaîne ou par Org Admin de l'organisation indiquée.
Charge utile:
{
    "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 à enlever 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.
  • orgId: string : ID du fournisseur de services d'adhésion de l'utilisateur dans l'organisation actuelle.
  • userId: string : nom d'utilisateur ou adresse électronique de l'utilisateur.
  • endorsers: string[] : tableau des homologues (par exemple, peer1, peer2) qui doit approuver la transaction.
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
    }
}
requestMint
Nom de la méthode d'origine : requestMint
Cette méthode peut être appelée par un minter pour envoyer une demande au notaire afin de créer une quantité spécifiée de jetons.
Charge utile:
{
    "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 à frapper.
  • operationId: string : ID d'opération unique qui représente la demande menthe.
  • notaryOrgId: string – ID du fournisseur de services d'adhésion (MSP) du notaire mineur qui traitera la demande.
  • notaryUserId: string : nom d'utilisateur ou ID courriel du notaire mineur qui traitera la demande.
  • quantity: number – La quantité de jetons à la menthe.
  • timeToExpiration : délai après lequel la demande de frappe expire et n'est plus valide.
  • infoDetails: JSON : objet indiquant la catégorie (category) et la description (description) de la demande, comme indiqué dans l'exemple suivant.
    {
     "category" : "category input",
     "description" : "description input"
}
  • sameOrgEndorser: boolean : valeur booléenne qui indique si les approbations 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
    }
}
burnTokens
Nom de la méthode d'origine : burnTokens
Cette méthode POST désactive ou brûle les jetons du compte de l'appelant de la transaction. L'appelant de cette méthode doit avoir un compte et le rôle de brûleur. La quantité doit être comprise dans les valeurs décimales indiquées par le paramètre decimal du comportement divisible dans le fichier de spécification. Cette méthode peut être appelée par AccountOwner du compte avec le rôle de brûleur.
Charge utile:
{
    "tokenId": "{{bc-token-id}}",
    "quantity": 1,
    "infoDetails": "{\"category\":\"category value\",\"description\":\"description value\"}",
    "sameOrgEndorser": true
}
Paramètres :
  • tokenId: string : ID du jeton.
  • quantity : nombre de jetons à brûler.
  • infoDetails: JSON : objet indiquant la catégorie (category) et la description (description) de la demande, comme indiqué dans l'exemple suivant.
    {
     "category" : "category input",
     "description" : "description input"
}
  • sameOrgEndorser: boolean : valeur booléenne qui indique si les approbations de transaction doivent provenir de la même organisation que le demandeur.
Renvoie :
  • En cas de succès, message de succès indiquant la quantité de jetons consommés et l'ID de compte.
Exemple de valeur renvoyée :
{
    "returnCode": "Success",
    "error": "",
    "result": {
        "txid": "aff0b2dbb163ec8076747525db81fbe8f678ac88a277c5f234337f0747eb1a8d",
        "payload": {
            "msg": "Successfully burned 10 tokens from account id: oaccount~9d9806fa92aa0c4fdb34eaffac6e830181b5d47e64fbce752195e83024125ca0 (Org-Id: CB, User-Id: creator_user_cb)"
        },
        "encode": "JSON",
        "sourceURL": "cb-oabcs1-bom.blockchain.ocp.example.com:20010",
        "blockNumber": 96
    }
}
setMaxDailyAmount
Nom de la méthode d'origine : 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 peut être appelée uniquement par Token Admin du code chaîne ou par Org Admin de l'organisation indiquée.
Charge utile:
{
    "orgId": "{{bc-org-id}}",
    "userId": "{{bc-user-id}}",
    "tokenId": "{{bc-token-id}}",
    "maxDailyAmount": 1,
    "endorsers": {{endorsers}}
}
Paramètres :
  • orgId: string : ID du fournisseur de services d'adhésion de l'utilisateur dans l'organisation actuelle.
  • userId: string : nom d'utilisateur ou adresse électronique de l'utilisateur.
  • tokenId: string : ID du jeton.
  • maxDailyAmount: number – Valeur du montant journalier maximum pour le compte spécifié, qui définit le montant maximum pouvant être traité quotidiennement.
  • endorsers: string[] : tableau des homologues (par exemple, peer1, peer2) qui doit approuver 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": "cbdc",
            "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 d'origine : 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 peut être appelée uniquement par Token Admin du code chaîne ou par Org Admin de l'organisation indiquée.
Charge utile:
{
    "orgId": "{{bc-org-id}}",
    "userId": "{{bc-user-id}}",
    "tokenId": "{{bc-token-id}}",
    "maxDailyTransactions": 1,
    "endorsers": {{endorsers}}
}
Paramètres :
  • orgId: string : ID du fournisseur de services d'adhésion de l'utilisateur dans l'organisation actuelle.
  • userId: string : nom d'utilisateur ou adresse électronique de l'utilisateur.
  • tokenId: string : ID du jeton.
  • maxDailyTransactions: number – Valeur du montant journalier maximum pour le compte spécifié, qui définit le nombre maximum de transactions autorisées par jour.
  • endorsers: string[] : tableau des homologues (par exemple, peer1, peer2) qui doit approuver 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": "cbdc",
            "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
    }
}
suspendAccount
Nom de la méthode d'origine : suspendAccount
Cette méthode suspend un compte de jeton fongible. Il génère une erreur si aucune valeur accountStatus n'est trouvée dans le livre. Cette méthode peut être appelée uniquement par Token Admin du code chaîne ou par Org Admin de l'organisation indiquée.
Charge utile:
{
    "tokenId": "{{bc-token-id}}",
    "orgId": "{{bc-org-id}}",
    "userId": "{{bc-user-id}}",
    "endorsers": {{endorsers}}
}
Paramètres :
  • tokenId: string : ID du jeton.
  • orgId: string : ID du fournisseur de services d'adhésion de l'utilisateur dans l'organisation actuelle.
  • userId: string : nom d'utilisateur ou adresse électronique de l'utilisateur.
  • endorsers: string[] : tableau des homologues (par exemple, peer1, peer2) qui doit approuver 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
    }
}
transferTokens
Nom de la méthode d'origine : 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 indiquées par le paramètre decimal du comportement divisible dans le fichier de spécification.
Charge utile:
{
    "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 du fournisseur de services d'adhésion du bénéficiaire (bénéficiaire) dans l'organisation actuelle.
  • toUserId: string : nom d'utilisateur ou ID courriel du destinataire.
  • quantity: number : nombre de jetons à transférer.
  • infoDetails: JSON : objet indiquant la catégorie (category) et la description (description) de la demande, comme indiqué dans l'exemple suivant.
    {
     "category" : "category input",
     "description" : "description input"
}
  • endorsers: string[] : tableau des homologues (par exemple, peer1, peer2) qui doit approuver 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
    }
}
initializeExchangePoolUser
Nom de la méthode d'origine : initializeExchangePoolUser
Cette méthode initialise l'utilisateur du pool d'échange, qui est une activité ponctuelle. Cette méthode ne peut être appelée que par Token Admin.
Charge utile:
{
    "orgId": "{{bc-org-id}}",
    "userId": "{{bc-user-id}}",
    "sameOrgEndorser": true
}
Paramètres :
  • orgId: string : ID du fournisseur de services d'adhésion de l'utilisateur dans l'organisation actuelle.
  • userId: string : nom d'utilisateur ou adresse électronique de l'utilisateur.
  • sameOrgEndorser: boolean : valeur booléenne qui indique si les approbations de transaction doivent provenir de la même organisation que le demandeur.
Exemple de valeur renvoyée :
{
    "returnCode": "Success",
    "error": "",
    "result": {
        "txid": "e21d91d98091df77f90105d84074c0b802b01fc97a6b1304247774397fed1294",
        "payload": {
            "assetType": "oconversion",
            "convertor_id": "bcb1f3b1442c625d3ce205660c5e717c5858a1fe1e12c325df799a851ceaa09b",
            "org_id": "Org1MSP",
            "user_id": "exchangepooluser"
        },
        "encode": "JSON",
        "sourceURL": "cb-oabcs1-bom.blockchain.ocp.example.com:20009",
        "blockNumber": 196
    }
}
createExchangePoolAccounts
Nom de la méthode d'origine : createExchangePoolAccounts
Cette méthode crée des comptes de jeton de pool d'échange pour un tableau donné d'ID de jeton. Cette méthode ne peut être appelée que par un Token Admin du code chaîne.
Charge utile:
{
    "tokenIds": "[{{bc-token-id}}]",
    "sameOrgEndorser": true
}
Paramètres :
  • token_ids: string [] : tableau d'ID de jeton.
  • sameOrgEndorser: boolean : valeur booléenne qui indique si les approbations de transaction doivent provenir de la même organisation que le demandeur.
Exemple de valeur renvoyée :
{
    "returnCode": "Success",
    "error": "",
    "result": {
        "txid": "e21d91d98091df77f90105d84074c0b802b01fc97a6b1304247774397fed1294",
        "payload": [
            {
                "account_id": "oaccount~cc9d84f6d4a5976532493ef5200c9603e138adc35166ffd5fd1aad9c1647f034",
                "token_id": "USD",
                "status": "created"
            },
            {
                "account_id": "oaccount~3d4933111ec8bd6cc1ebb43f2b2c390deb929cfa534f9c6ada8e63bac04a13c0",
                "token_id": "INR",
                "status": "created"
            }
        ],
        "encode": "JSON",
        "sourceURL": "cb-oabcs1-bom.blockchain.ocp.example.com:20009",
        "blockNumber": 197
    }
}
addConversionRate
Nom de la méthode d'origine : addConversionRate
Cette méthode ajoute un taux de conversion pour une paire de jetons. Le taux de conversion de jeton peut être spécifié jusqu'à huit décimales. Cette méthode ne peut être appelée que par un Token Admin du code chaîne.
Charge utile:
{
    "fromTokenId": "from_token_id value",
    "toTokenId": "to_token_id value",
    "tokenConversionRate": 10,
    "sameOrgEndorser": true
}
Paramètres :
  • fromTokenId: string : ID du jeton à convertir.
  • toTokenId: string : ID du jeton vers lequel effectuer la conversion.
  • tokenConversionRate: number : vitesse à laquelle convertir le jeton fromTokenId en jeton toTokenId.
  • sameOrgEndorser: boolean : valeur booléenne qui indique si les approbations de transaction doivent provenir de la même organisation que le demandeur.
Exemple de valeur renvoyée :
{
    "returnCode": "Success",
    "error": "",
    "result": {
        "txid": "e21d91d98091df77f90105d84074c0b802b01fc97a6b1304247774397fed1294",
        "payload": {
          "assetType": "oconversionRate",
          "conversion_rate_id": "oconversionRate~91c7eeb0614e7a50b1d5ecad559fcbc80b94034648bf405c9491dacf8d57873b",
          "from_token_id": "USD",
          "to_token_id": "INR",
          "conversion_rate": 10
        },
        "encode": "JSON",
        "sourceURL": "cb-oabcs1-bom.blockchain.ocp.example.com:20009",
        "blockNumber": 189
    }
}
updateConversionRate
Nom de la méthode d'origine : updateConversionRate
Cette méthode met à jour le taux de conversion actuel pour une paire de jetons. Le taux de conversion de jeton peut être spécifié jusqu'à huit décimales. Cette méthode ne peut être appelée que par un Token Admin du code chaîne.
Charge utile:
{
    "fromTokenId": "from_token_id value",
    "toTokenId": "to_token_id value",
    "tokenConversionRate": 20,
    "sameOrgEndorser": true
}
Paramètres :
  • fromTokenId: string : ID du jeton à convertir.
  • toTokenId: string : ID du jeton vers lequel effectuer la conversion.
  • tokenConversionRate: number : vitesse à laquelle convertir le jeton fromTokenId en jeton toTokenId.
  • sameOrgEndorser: boolean : valeur booléenne qui indique si les approbations de transaction doivent provenir de la même organisation que le demandeur.
Exemple de valeur renvoyée :
{
    "returnCode": "Success",
    "error": "",
    "result": {
        "txid": "e21d91d98091df77f90105d84074c0b802b01fc97a6b1304247774397fed1294",
        "payload": {
          "assetType": "oconversionRate",
          "conversion_rate_id": "oconversionRate~91c7eeb0614e7a50b1d5ecad559fcbc80b94034648bf405c9491dacf8d57873b",
          "from_token_id": "USD",
          "to_token_id": "INR",
          "conversion_rate": 20
        },
        "encode": "JSON",
        "sourceURL": "cb-oabcs1-bom.blockchain.ocp.example.com:20009",
        "blockNumber": 208
    }
}
mintWithFundingExchangePool
Nom de la méthode d'origine : mintWithFundingExchangePool
Cette méthode extrait les jetons dans le compte de l'appelant en fonction de l'ID de jeton et de la quantité spécifiés. Un pourcentage de jetons provenant de la quantité frappée est ensuite transféré vers le compte de jetons du pool d'échange.
{
    "tokenId": "{{bc-token-id}}",
    "tokenQuantity": 100,
    "percentageTokenToExchangePool": 20,
    "sameOrgEndorser": true
}
Paramètres :
  • tokenId: string : ID du jeton à frapper.
  • tokenQuantity: number : nombre total de jetons à menthe.
  • percentageTokenToExchangePool: number : pourcentage de jetons extraits à transférer vers le compte de jeton du pool d'échange.
  • sameOrgEndorser: boolean : valeur booléenne qui indique si les approbations de transaction doivent provenir de la même organisation que le demandeur.
Exemple de valeur renvoyée :
{
    "returnCode": "Success",
    "error": "",
    "result": {
        "txid": "e21d91d98091df77f90105d84074c0b802b01fc97a6b1304247774397fed1294",
        "payload": {
            "msg": "Successfully minted 100 tokens to Account Id: oaccount~abc74791148b761352b98df58035601b6f5480448ac2b4a3a7eb54bdbebf48eb (Org-Id: Org1MSP, User-Id: admin) and Successfully transfered 20 tokens to exchange pool Account with Account Id: oaccount~cc9d84f6d4a5976532493ef5200c9603e138adc35166ffd5fd1aad9c1647f034 (Org-Id: Org1MSP, User-Id: exchangepooluser) "
        },
        "encode": "JSON",
        "sourceURL": "cb-oabcs1-bom.blockchain.ocp.example.com:20009",
        "blockNumber": 209
    }
}
tokenConversion
Nom de la méthode d'origine : tokenConversion
Cette méthode convertit les jetons du compte de l'appelant vers le compte indiqué par les valeurs to_token_id, to_org_id et to_user_id. Cette méthode peut être appelée par Token Admin du code chaîne et par n'importe quel propriétaire de compte de jeton. Un utilisateur du pool d'échange ne peut pas appeler cette méthode. 
{
    "fromTokenId": "from_token_id value",
    "toTokenId": "to_token_id value",
    "toOrgId": "to_org_id value",
    "toUserId": "to_user_id value",
    "tokenQuantity": 5,
    "endorsers": {{endorsers}}
}
Paramètres :
  • fromTokenId: string : ID du jeton à convertir.
  • toTokenId: string : ID du jeton vers lequel effectuer la conversion.
  • toOrgId: string : ID du fournisseur de services d'adhésion de l'utilisateur dans l'organisation actuelle pour recevoir les jetons.
  • toUserId: string : nom d'utilisateur ou ID de courriel de l'utilisateur devant recevoir les jetons.
  • tokenQuantity: number : nombre total de jetons à transférer.
  • endorsers: string[] : tableau des homologues (par exemple, peer1, peer2) qui doit approuver la transaction.
Exemple de valeur renvoyée :
{
    "returnCode": "Success",
    "error": "",
    "result": {
        "txid": "e21d91d98091df77f90105d84074c0b802b01fc97a6b1304247774397fed1294",
        "payload": {
            "msg": "Succesfully converted 5 of tokens with tokenId: [USD] from AccountId: oaccount~abc74791148b761352b98df58035601b6f5480448ac2b4a3a7eb54bdbebf48eb (Org-Id: Org1MSP, User-Id: admin) to 100 of tokens with tokenId: [INR] to AccountId: oaccount~25e2e66718b6dbb59aea9c32acebec60e09d912b2578d4933d377ae5d0628f1e (Org-Id: Org1MSP, User-Id: user) as per the conversion rate of 20"
        },
        "encode": "JSON",
        "sourceURL": "cb-oabcs1-bom.blockchain.ocp.example.com:20009",
        "blockNumber": 213
    }
}
getConversionRate
Nom de la méthode d'origine : getConversionRate
Cette méthode GET obtient le taux de conversion actuel pour une paire de jetons. Cette méthode peut être appelée par Token Admin, Token Auditor, Org Admin ou Org Auditor.
Interroger :
/getConversionRate?fromTokenId=from_token_id value&toTokenId=to_token_id value
Paramètres :
  • fromTokenId: string : ID du jeton à convertir.
  • toTokenId: string : ID du jeton vers lequel effectuer la conversion.
Exemple de valeur renvoyée :
{
    "returnCode": "Success",
    "error": "",
    "result": {
        "payload": {
          "assetType": "oconversionRate",
          "conversion_rate_id": "oconversionRate~91c7eeb0614e7a50b1d5ecad559fcbc80b94034648bf405c9491dacf8d57873b",
          "from_token_id": "USD",
          "to_token_id": "INR",
          "conversion_rate": 20
        },
        "encode": "JSON"
    }
}
getConversionHistory
Nom de la méthode d'origine : getConversionRate
Cette méthode GET renvoie l'historique de conversion de jeton pour un compte de jeton spécifié. Cette méthode peut être appelée par Token Admin, Token Auditor, Org Admin, Org Auditor ou le propriétaire du compte de jeton.
Interroger :
/getConversionHistory?tokenId={{bc-token-id}}&orgId={{bc-org-id}}&userId={{bc-user-id}}
Paramètres :
  • tokenId: string : ID du jeton.
  • orgId: string : ID du fournisseur de services d'adhésion de l'utilisateur dans l'organisation actuelle.
  • userId: string : nom d'utilisateur ou adresse électronique de l'utilisateur.
Exemple de valeur renvoyée :
{
    "returnCode": "Success",
    "error": "",
    "result": {
        "payload": [
          {
            "transaction_id": "otransaction~34edd19e03ec8bbbc77bc3372081410a824a5c10f9aa522b3a6390d7e8cb11cf",
            "from_account_id": "oaccount~abc74791148b761352b98df58035601b6f5480448ac2b4a3a7eb54bdbebf48eb",
            "to_account_id": "oaccount~25e2e66718b6dbb59aea9c32acebec60e09d912b2578d4933d377ae5d0628f1e",
            "transacted_amount": 5,
            "converted_amount": 100,
            "conversion_rate": "20",
            "from_token_id": "USD",
            "to_token_id": "INR",
            "balance": 75,
            "onhold_balance": 0,
            "timestamp": "2022-11-30T11:03:20.000Z",
            "transaction_type": "TOKEN_CONVERSION_DEBIT"
          }
        ],
        "encode": "JSON"
    }
}
getConversionRateHistory
Nom de la méthode d'origine : getConversionRate
Cette méthode renvoie l'historique du taux de conversion des jetons pour une paire de jetons. Cette méthode peut être appelée par Token Admin, Token Auditor, Org Admin, Org Auditor et par n'importe quel propriétaire de compte de jeton. 
/getConversionRateHistory?fromTokenId=from_token_id value&toTokenId=to_token_id value
Paramètres :
  • fromTokenId: string : ID du jeton à convertir pour le calcul du taux de conversion.
  • toTokenId: string : ID du jeton vers lequel effectuer la conversion, aux fins du calcul du taux de conversion.
Renvoie :
  • En cas de succès, objet JSON avec détails de l'historique des taux de conversion.
Exemple de valeur renvoyée :
{
    "returnCode": "Success",
    "error": "",
    "result": {
        "payload":  [
          {
            "trxId": "0b1ba7bc2620e1438b6580365e5c0ab852247ccfa5a3eb2157d3baca02c0e521",
            "timeStamp": "2022-11-30T10:23:38.000Z",
            "value": {
              "assetType": "oconversionRate",
              "conversion_rate_id": "oconversionRate~91c7eeb0614e7a50b1d5ecad559fcbc80b94034648bf405c9491dacf8d57873b",
              "from_token_id": "USD",
              "to_token_id": "INR",
              "conversion_rate": 20
            }
          },
          {
            "trxId": "36fc40ddb3d8308ee7e156af700da131d78d941fe390fc57985b7589e7035d5c",
            "timeStamp": "2022-11-30T10:13:18.000Z",
            "value": {
              "assetType": "oconversionRate",
              "conversion_rate_id": "oconversionRate~91c7eeb0614e7a50b1d5ecad559fcbc80b94034648bf405c9491dacf8d57873b",
              "from_token_id": "USD",
              "to_token_id": "INR",
              "conversion_rate": 10
            }
          }
        ],
        "encode": "JSON"
    }
}
getExchangePoolUser
Nom de la méthode d'origine : getExchangePoolUser
Cette méthode GET renvoie les valeurs d'ID organisation et d'ID utilisateur pour l'utilisateur du pool d'échange. Cette méthode ne peut être appelée que par Token Admin ou Token Auditor du code chaîne.
Interroger :
/getExchangePoolUser
Paramètres :
  • Aucun élément
Exemple de valeur renvoyée :
{
    "returnCode": "Success",
    "error": "",
    "result": {
        "payload":  {
           "assetType": "oconversion",
           "convertor_id": "bcb1f3b1442c625d3ce205660c5e717c5858a1fe1e12c325df799a851ceaa09b",
           "org_id": "Org1MSP",
           "user_id": "exchangepooluser"
        },
        "encode": "JSON"
    }
}
getAccountOnHoldBalance
Nom de la méthode d'origine : getAccountOnHoldBalance
Cette méthode GET renvoie le solde en attente actuel pour un compte et un jeton spécifiés. Cette méthode peut uniquement être appelée par Token Admin, Token Auditor, Org Admin, Org Auditor ou par AccountOwner du compte.
Interroger :
/getAccountOnHoldBalance?tokenId={{bc-token-id}}&orgId={{bc-org-id}}&userId={{bc-user-id}}
Paramètres :
  • tokenId: string : ID du jeton.
  • orgId: string : ID du fournisseur de services d'adhésion de l'utilisateur dans l'organisation actuelle.
  • userId: string : nom d'utilisateur ou adresse électronique de l'utilisateur.
Exemple de valeur renvoyée :
{
    "returnCode": "Success",
    "error": "",
    "result": {
        "payload":  {
            "msg":"Total Holding Balance is: 0","holding_balance":0
        },
        "encode": "JSON"
    }
}
getAccountStatus
Nom de la méthode d'origine : getAccountStatus
Cette méthode GET extrait l'état actuel du compte de jeton. Cette méthode peut être appelée par Token Admin, Token Auditor, Org Admin, Org Auditor ou par le propriétaire du compte de jeton.
Interroger :
/getAccountStatus?tokenId={{bc-token-id}}&orgId={{bc-org-id}}&userId={{bc-user-id}}
Paramètres :
  • tokenId: string : ID du jeton.
  • orgId: string : ID du fournisseur de services d'adhésion de l'utilisateur dans l'organisation actuelle.
  • userId: string : nom d'utilisateur ou ID de courriel de l'utilisateur.
Exemple de valeur renvoyée :
{
    "returnCode": "Success",
    "error": "",
    "result": {
        "payload":  {
            "assetType": "oaccountStatus",
            "status_id": "oaccountStatus~5a0b0d8b1c6433af9fedfe0d9e6580e7cf6b6bb62a0de6267aaf79f79d5e96d7",
            "account_id": "oaccount~1c568151c4acbcd1bd265c766c677145760a61c47fc8a3ba681a4cfbe287f9c1",
            "status": "active"
        },
        "encode": "JSON"
    }
}
getAccountsByRole
Nom de la méthode d'origine : getAccountsByRole
Cette méthode renvoie la liste de tous les ID de compte pour un rôle donné. Cette méthode ne peut être appelée que par un Token Admin du code chaîne.
Interroger :
/getAccountsByRole?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~digicur~b4f45440aa2a7942db64443d047027e9d714d62cba5c3d546d64f368642f622f"]
        },
        "encode": "JSON"
    }
}