Paquete de API de Stablecoin Wrapper

Oracle Blockchain Platform Digital Assets Edition incluye un paquete de API de envoltorio que amplía la API de REST para admitir operaciones específicas del ciclo de vida de un stablecoin.

El paquete de API de envoltorio utiliza el servicio API Gateway y OCI Functions para desplegar rutas de API específicamente para gestionar el ciclo de vida de stablecoin. El paquete de API de envoltorio de stablecoin se puede descargar desde la consola de Oracle Blockchain Platform e incluye un archivo de almacenamiento que contiene el paquete de API de envoltorio que incluye los scripts de Terraform necesarios para el despliegue. Este archivo se despliega en una pila de Resource Manager en Oracle Cloud Infrastructure (OCI) para crear los recursos de Oracle necesarios para las API de envoltorio. También incluye una recopilación de Postman que le permite probar las API de envoltorio desplegadas. La recopilación incluye solicitudes preconfiguradas con puntos finales y cargas útiles que corresponden a las API definidas en el paquete de API de envoltorio.

API de envoltorio

activateStablecoinAccount
Nombre del método original: activateAccount
Este método POST activa una cuenta de token fungible. Este método solo puede ser llamado por un Token Admin o Org Admin de la organización especificada. Las cuentas eliminadas no se pueden activar.
Carga Útil:
{
    "tokenId": "{{bc-token-id}}",
    "orgId": "{{bc-org-id}}",
    "userId": "{{bc-user-id}}",
    "endorsers": {{endorsers}}
}
Parámetros:
  • tokenId: string: ID del token.
  • orgId: string: ID del proveedor de servicios de afiliación (MSP) del usuario de la organización actual.
  • userId: string: nombre de usuario o ID de correo electrónico del usuario.
  • endorsers: string[]: matriz de los pares (por ejemplo, peer1, peer2) que deben respaldar la transacción.
Devuelve:
  • Una vez realizado correctamente, una representación JSON del objeto de estado de cuenta para la cuenta de token especificada.
Ejemplo de valor devuelto:
{
    "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
Nombre del método original: addOrgAdmin
Este método agrega administradores de organización al código de cadena de token. Este método solo puede ser llamado por un Token Admin o Org Admin de la organización especificada.
Carga Útil:
{
    "orgId": "{{bc-org-id}}",
    "userId": "{{bc-user-id}}",
    "sameOrgEndorser": true
}
Parámetros:
  • orgId: string: ID del proveedor de servicios de afiliación (MSP) del usuario de la organización actual.
  • userId: string: nombre de usuario o ID de correo electrónico del usuario.
  • sameOrgEndorser: boolean: valor booleano que indica si los endosos de transacción deben ser de la misma organización que el solicitante.
Ejemplo de valor devuelto:

{
    "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
Nombre del método original: addOrgAuditor
Este método agrega auditores de organización al código de cadena de token. Este método solo puede ser llamado por un Token Admin o Org Admin de la organización especificada.
Carga Útil:
{
    "orgId": "{{bc-org-id}}",
    "userId": "{{bc-user-id}}",
    "sameOrgEndorser": true
}
Parámetros:
  • orgId: string: ID del proveedor de servicios de afiliación (MSP) del usuario de la organización actual.
  • userId: string: nombre de usuario o ID de correo electrónico del usuario.
  • sameOrgEndorser: boolean: valor booleano que indica si los endosos de transacción deben ser de la misma organización que el solicitante.
Ejemplo de valor devuelto:
{
    "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
Nombre del método original: addRole
Este método agrega el rol al usuario y al token especificados. Los ID de cuenta se forman mediante la creación de un hash SHA-256 del ID de token concatenado, el ID de organización y el ID de usuario. Este método solo puede ser llamado por un Token Admin o Org Admin de la organización especificada.
Carga Útil:
{
    "tokenId": "{{bc-token-id}}",
    "role": "role value (for example minter / burner / notary)",
    "orgId": "{{bc-org-id}}",
    "userId": "{{bc-user-id}}",
    "endorsers": {{endorsers}}
}
Parámetros:
  • tokenId: string: ID del token.
  • role: string: nombre del rol que se va a agregar al usuario especificado. Los comportamientos que se pueden extraer y grabar están vinculados a las propiedades minter_role_name y burner_role_name en el archivo de especificación. Del mismo modo, el comportamiento del notario está vinculado a la propiedad notary_role_name en el archivo de especificación.
  • orgId: string: ID del proveedor de servicios de afiliación (MSP) del usuario de la organización actual.
  • userId: string: nombre de usuario o ID de correo electrónico del usuario.
  • endorsers: string[]: matriz de los pares (por ejemplo, peer1, peer2) que deben respaldar la transacción.
Ejemplo de valor devuelto:
{
    "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
Nombre del método original: addTokenAdmin
Este método POST agrega un usuario como Token Admin del código de cadena de token. El método solo puede ser llamado por un Token Admin del código de cadena de token. La primera llamada es del administrador que instancia el código de cadena.
Carga Útil:
{
    "orgId": "{{bc-org-id}}",
    "userId": "{{bc-user-id}}",
    "sameOrgEndorser": true
}
Parámetros:
  • orgId: string: ID del proveedor de servicios de afiliación (MSP) del usuario de la organización actual.
  • userId: string: nombre de usuario o ID de correo electrónico del usuario.
  • sameOrgEndorser: boolean: valor booleano que indica si los endosos de transacción deben ser de la misma organización que el solicitante.
Ejemplo de valor devuelto:
{
    "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
Nombre del método original: addTokenAuditor
Este método POST agrega auditores de token al código de cadena de token. Este método solo puede ser llamado por el Token Admin del código de cadena.
Carga Útil:
{
    "orgId": "{{bc-org-id}}",
    "userId": "{{bc-user-id}}",
    "sameOrgEndorser": true
}
Parámetros:
  • orgId: string: ID del proveedor de servicios de afiliación (MSP) del usuario de la organización actual.
  • userId: string: nombre de usuario o ID de correo electrónico del usuario.
  • sameOrgEndorser: boolean: valor booleano que indica si los endosos de transacción deben ser de la misma organización que el solicitante.
Ejemplo de valor devuelto:
{
    "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
Nombre del método original: approveBurn
Los notarios pueden llamar a este método POST para aprobar una solicitud de grabación.
Carga Útil:
{
    "tokenId": "{{bc-token-id}}",
    "operationId": "operation_id value",
    "sameOrgEndorser": true
}
Parámetros:
  • tokenId: string: ID del token.
  • operationId: string: ID de operación único de la solicitud de moneda que se debe aprobar.
  • sameOrgEndorser: boolean: valor booleano que indica si los endosos de transacción deben ser de la misma organización que el solicitante.
Ejemplo de valor devuelto:
{
    "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
Nombre del método original: approveMint
Los notarios pueden llamar a este método POST para aprobar una solicitud de menta.
Carga Útil:
{
    "tokenId": "{{bc-token-id}}",
    "operationId": "operation_id value",
    "sameOrgEndorser": true
}
Parámetros:
  • tokenId: string: ID del token.
  • operationId: string: ID de operación único de la solicitud de moneda que se debe aprobar.
  • sameOrgEndorser: boolean: valor booleano que indica si los endosos de transacción deben ser de la misma organización que el solicitante.
Ejemplo de valor devuelto:
{
    "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
Nombre del método original: approveTransaction
Los aprobadores pueden llamar a este método POST para aprobar una transacción de retención.
Carga Útil:
{
    "tokenId": "{{bc-token-id}}",
    "orgId": "{{bc-org-id}}",
    "userId": "{{bc-user-id}}",
    "endorsers": {{endorsers}}
}
Parámetros:
  • tokenId: string: ID del token.
  • orgId: string: ID del proveedor de servicios de membresía (MSP) del usuario.
  • userId: string: nombre de usuario o ID de correo electrónico del usuario.
  • endorsers: string[]: matriz de los pares (por ejemplo, peer1, peer2) que deben respaldar la transacción.
Ejemplo de valor devuelto:
{
    "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
Nombre del método original: associateTokenToAccount
Este método POST asocia un ID de cuenta especificado a un token especificado. Este método solo puede ser llamado por un Token Admin o Org Admin de la organización especificada.
Carga Útil:
{
    "accountId": "account_id value",
    "tokenId": "{{bc-token-id}}",
    "endorsers": {{endorsers}}
}
Parámetros:
  • accountId: string: ID de la cuenta.
  • tokenId: string: ID del token.
  • endorsers: string[]: matriz de los pares (por ejemplo, peer1, peer2) que deben respaldar la transacción.
Ejemplo de valor devuelto:
{
    "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
Nombre del método original: bulkTransferTokens
Este método transfiere tokens de forma masiva desde la cuenta del emisor de llamada a las cuentas especificadas en el objeto flow. Las cantidades deben estar dentro de los valores decimales especificados por el parámetro decimal del comportamiento divisible en el archivo de especificación.
Carga Útil:
{
    "tokenId": "{{bc-token-id}}",
    "flow": "[flow value]",
    "endorsers": {{endorsers}}
}
Parámetros:
  • token_id: string: ID del token.
  • flow : object[]: matriz de objetos JSON que especifica receptores y cantidades.
    • to_orgId: string: ID del proveedor de servicios de membresía (MSP) del receptor en la organización actual.
    • userId: string: nombre de usuario o ID de correo electrónico del receptor.
    • quantity: number: número de tokens que se van a transferir.
    Puede especificar el parámetro flow en un formato diferente si utiliza Visual Studio Code frente a la CLI o una recopilación Postman.
    Código de Visual Studio:
    [
  { "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[]: matriz de los pares (por ejemplo, peer1, peer2) que deben respaldar la transacción.
Ejemplo de valor devuelto:
{
    "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
Nombre del método original: createAccount
Este método crea una cuenta para un usuario y token especificados. Se debe crear una cuenta para cualquier usuario que tenga tokens en cualquier momento. Las cuentas realizan un seguimiento de los saldos, los saldos retenidos y el historial de transacciones. Un ID de cuenta se forma concatenando el tipo de activo, el ID de token y un hash SHA-256 del ID de usuario y el ID de organización (proveedor de servicios de membresía). Este método solo puede ser llamado por un Token Admin del código de cadena o por un Org Admin de la organización especificada.
Carga Útil:
{
    "orgId": "{{bc-org-id}}",
    "userId": "{{bc-user-id}}",
    "tokenType": "fungible",
    "dailyLimits": "{\"max_daily_amount\":10000,\"max_daily_transactions\":100}",
    "endorsers": {{endorsers}}
}
Parámetros:
  • orgId: ID del proveedor de servicios de afiliación (MSP) del usuario para el que se creará la cuenta. El ID debe empezar por un carácter alfanumérico y puede incluir letras, números y caracteres especiales, como guiones bajos (_), puntos (.), signos at (@) y guiones (-).
  • userId: nombre de usuario o ID de correo electrónico del usuario. El ID debe empezar por un carácter alfanumérico y puede incluir letras, números y caracteres especiales, como guiones bajos (_), puntos (.), signos at (@) y guiones (-).
  • tokenType: TokenType: tipo de token, que debe ser fungible.
  • dailyLimits: JSON object: objeto JSON del siguiente tipo.
    {
     "max_daily_amount": 100000
     "max_daily_transactions": 10000
 }
    En el ejemplo, el valor max_daily_amount es la cantidad máxima de tokens que se pueden realizar diariamente y el valor max_daily_transactions es el número máximo de transacciones que se pueden completar diariamente.
  • endorsers: string[]: matriz de los pares (por ejemplo, peer1, peer2) que deben respaldar la transacción.
Ejemplo de valor devuelto:
{
    "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
Nombre del método original: createApprovalPolicyCheck
Este método crea una nueva política de aprobación, que define los umbrales de transacción y los aprobadores secuenciales necesarios. Este método solo se puede llamar mediante Token Admin.
Carga Útil:
{
    "asset": "{\"approvalPolicyId\":\"approvalPolicyId value\",\"transactionLowerLimit\":\"transactionLowerLimit value\",\"transactionUpperLimit\":\"transactionUpperLimit value\",\"numberOfApprovalsRequired\":999,\"approverDetails\":[{\"approverOrgId\":\"approverOrgId value\",\"approverUserId\":\"approverUserId value\",\"approvalSequence\":999}]}",
    "endorsers": {{endorsers}}
}
Parámetros:
  • asset: ApprovalPolicyCheck class: clase que define reglas de aprobación para una transacción, que incluye los siguientes campos:
    • approvalPolicyId: el sistema genera este ID. Este campo no se proporciona manualmente.
    • transactionLowerLimit: importe mínimo de transacción al que se aplica la política de aprobación.
    • transactionUpperLimit: importe máximo de transacción al que se aplica la política de aprobación.
    • numberOfApprovalsRequired: número total de aprobaciones necesarias antes de que se pueda completar la transacción.
    • approverDetails: lista de aprobadores junto con la secuencia de aprobación asignada, que define el orden obligatorio para las aprobaciones.
  • endorsers: string[]: matriz de los pares (por ejemplo, peer1, peer2) que deben respaldar la transacción.
Ejemplo de valor devuelto:
{
    "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
Nombre del método original: createAccountPolicyCheck
Este método crea una política para una cuenta especificada. Este método solo puede ser llamado por un Token Admin o Org Admin de la organización especificada.
Carga Útil:
{
    "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}}
}
Parámetros:
  • asset: AccountPolicyCheck class: clase que define los parámetros de política de cuenta, que incluye los siguientes campos:
    • accountPolicyId: el sistema genera este ID a partir de los campos orgId y userId especificados. Este campo no se proporciona manualmente.
    • orgId: ID del proveedor de servicios de afiliación (MSP) del usuario para el que se va a crear la política.
    • userId: nombre de usuario o ID de correo electrónico del usuario para el que se va a crear la política.
    • kycCompliance: valor booleano que indica si la cuenta cumple los requisitos de KYC (Know Your Customer).
    • amlCompliance: valor booleano que indica si la cuenta cumple con los requisitos de prevención de blanqueo de dinero (AML).
    • riskScore: puntuación de riesgo asociada a la cuenta, que se utiliza para la evaluación de conformidad.
    • restrictionFlag: valor booleano que indica si la cuenta está sujeta a transferencias restringidas. Si se define en true, solo se permiten transferencias dentro del umbral de política de aprobación más bajo.
    • endorsers: string[]: matriz de los pares (por ejemplo, peer1, peer2) que deben respaldar la transacción.
Ejemplo de valor devuelto:
{
    "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
Nombre del método original: deleteApprovalPolicyCheck
Este método suprime la política de aprobación para un ID de política especificado. Este método solo se puede llamar mediante Token Admin.
Carga Útil:
{
    "id": "id value",
    "endorsers": {{endorsers}}
}
Parámetros:
  • id: string: ID de política de aprobación único.
  • endorsers: string[]: matriz de los pares (por ejemplo, peer1, peer2) que deben respaldar la transacción.
Ejemplo de valor devuelto:
{
    "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
Nombre del método original: deleteAccount
Este método suprime una cuenta de token fungible. Devuelve un error si el valor accountStatus de la cuenta no se encuentra en el libro mayor. Este método solo se puede llamar mediante Token Admin.
Carga Útil:
{
    "tokenId": "{{bc-token-id}}",
    "orgId": "{{bc-org-id}}",
    "userId": "{{bc-user-id}}",
    "endorsers": {{endorsers}}
}
Parámetros:
  • tokenId: string: ID del token.
  • orgId: string: ID del proveedor de servicios de afiliación (MSP) del usuario de la organización actual.
  • userId: string: nombre de usuario o ID de correo electrónico del usuario.
  • endorsers: string[]: matriz de los pares (por ejemplo, peer1, peer2) que deben respaldar la transacción.
Ejemplo de valor devuelto:
{
    "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
Nombre del método original: deleteAccountPolicyCheck
Este método suprime la política para un ID de política especificado. Este método solo puede ser llamado por un Token Admin o Org Admin de la organización especificada.
Carga Útil:
{
    "id": "id value",
    "endorsers": {{endorsers}}
}
Parámetros:
  • id: string: ID de política de cuenta único.
  • endorsers: string[]: matriz de los pares (por ejemplo, peer1, peer2) que deben respaldar la transacción.
Ejemplo de valor devuelto:
{
    "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
Nombre del método original: executeHoldTokens
Este método aprueba una retención de tokens, que dispara la transferencia de los tokens del remitente al receptor. La cantidad de tokens retenidos anteriormente por el propietario del token ahora se transfiere al destinatario. Si el valor quantity es menor que el valor de retención real, el importe restante vuelve a estar disponible para el propietario del token. Si el comportamiento roles se especifica en la sección behaviors del modelo de token y se define el valor notary_role_name, la cuenta del emisor de llamada debe tener el rol de notario. De lo contrario, cualquier persona que llame con una cuenta puede funcionar como notario.
Carga Útil:
{
    "tokenId": "{{bc-token-id}}",
    "operationId": "operation_id value",
    "quantity": 1,
    "endorsers": {{endorsers}}
}
Parámetros:
  • tokenId: string: ID del token.
  • operationId: string: ID de operación único de la solicitud de moneda que se debe aprobar.
  • quantity: number: número de tokens retenidos para transferir.
  • endorsers: string[]: matriz de los pares (por ejemplo, peer1, peer2) que deben respaldar la transacción.
Ejemplo de valor devuelto:
{
    "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
Nombre del método original: getAccountTransactionHistory
Este método devuelve una matriz de detalles de historial de transacciones de cuenta para un usuario y token especificados. Este método solo puede ser llamado por un Token Admin o Token Auditor del código de cadena, un Org Admin o Org Auditor de la organización especificada o el AccountOwner de la cuenta. 
/getStablecoinAccountTransactionHistory?tokenId={{bc-token-id}}&orgId={{bc-org-id}}&userId={{bc-user-id}}
Parámetros:
  • tokenId: string: ID del token.
  • orgId: string: ID del proveedor de servicios de afiliación (MSP) del usuario de la organización actual.
  • userId: string: nombre de usuario o ID de correo electrónico del usuario.
Ejemplo de valor devuelto:
{
    "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
Nombre del método original: getAllAccounts
Este método devuelve una lista de todas las cuentas. Este método solo se puede llamar mediante Token Admin o Token Auditor.
Carga Útil:
{{api-gateway-endpoint1}}/getAllAccounts
Parámetros:
  • ninguno
Ejemplo de valor devuelto:
{
    "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
Nombre del método original: getAllOrgAccounts
Este método devuelve una lista de todas las cuentas de token que pertenecen a una organización especificada. Este método solo se puede llamar mediante Token Admin, Token Auditor o mediante Org Admin o Org Auditor de la organización especificada.
Carga Útil:
{{api-gateway-endpoint1}}/getAllOrgAccounts?orgId={{bc-org-id}}
Parámetros:
  • orgId: string: ID del proveedor de servicios de membresía (MSP) de la organización.
Ejemplo de valor devuelto:
{
    "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
Nombre del método original: getAllTokenAdmins
Este método devuelve una lista de todos los usuarios que son Token Admin. Este método solo puede ser llamado por Token Admin o Token Auditor.
Carga Útil:
{{api-gateway-endpoint1}}/getAllTokenAdmins
Parámetros:
  • ninguno
Ejemplo de valor devuelto:
{
    "returnCode": "Success",
    "error": "",
    "result": {
        "payload": {
            "admins": [
                {
                    "org_id": "CentralBank",
                    "user_id": "cb_admin_demo"
                }
            ]
        },
        "encode": "JSON"
    }
}
getAllTokens
Nombre del método original: getAllTokens
Este método devuelve todos los tokens que se almacenan en la base de datos de estado. Este método solo se puede llamar mediante Token Admin, Token Auditor, Org Admin o Org Auditor. Este método utiliza consultas enriquecidas de Berkeley DB SQL y solo se puede llamar cuando se conecta a la red remota de Oracle Blockchain Platform.
Carga Útil:
{{api-gateway-endpoint1}}/getAllTokens
Parámetros:
  • ninguno
Ejemplo de valor devuelto:
{
    "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
Nombre del método original: getApprovalPolicyCheckById
Este método obtiene los detalles de la política de aprobación para un ID de política especificado. Este método solo se puede llamar mediante Token Admin o Token Auditor.
Carga Útil:
{{api-gateway-endpoint1}}/getApprovalPolicyCheckById?id=id value
Parámetros:
  • id: string: ID de política de aprobación único.
Ejemplo de valor devuelto:
{
    "returnCode": "Success",
    "error": "",
    "result": {
        "payload": {
            "assetType": "ApprovalPolicyCheck",
            "approvalPolicyId": "GPID~0~100",
            "transactionLowerLimit": "0",
            "transactionUpperLimit": "100",
            "numberOfApprovalsRequired": 0,
            "approverDetails": []
        },
        "encode": "JSON"
    }
}
getApprovalTransactionsById
Nombre del método original: getApprovalTransactionsById
Este método obtiene la transacción de aprobación para un ID de transacción especificado. Este método solo puede ser llamado por un Token Admin o Org Admin de la organización asociada.
Carga Útil:
{{api-gateway-endpoint1}}/getApprovalTransactionsById?id=id value
Parámetros:
  • id: string: ID generado por el sistema de la transacción de aprobación.
Ejemplo de valor devuelto:
{
    "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
Nombre del método original: getApproverDetailsByTransferAmount
Este método obtiene los detalles del aprobador que son necesarios para un importe de transferencia determinado. Este método solo se puede llamar mediante Token Admin o Token Auditor.
Carga Útil:
{
    "Amount": 1,
    "endorsers": {{endorsers}}
}
Parámetros:
  • amount: number: importe de la transferencia.
  • endorsers: string[]: matriz de los pares (por ejemplo, peer1, peer2) que deben respaldar la transacción.
Ejemplo de valor devuelto:
{
    "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
Nombre del método original: getMaxDailyAmount
Este método obtiene el importe máximo acumulado diario de la transacción para una cuenta especificada. Este método solo puede ser llamado por un Token Admin o Token Auditor del código de cadena o un Org Admin o Org Auditor de la organización especificada.
Carga Útil:
{{api-gateway-endpoint1}}/getMaxDailyAmount?OrgId={{bc-org-id}}&UserId={{bc-user-id}}&TokenId={{bc-token-id}}
Parámetros:
  • tokenId: string: ID del token.
  • orgId: string: ID del proveedor de servicios de afiliación (MSP) del usuario de la organización actual.
  • userId: string: nombre de usuario o ID de correo electrónico del usuario.
Ejemplo de valor devuelto:
{
    "returnCode": "Success",
    "error": "",
    "result": {
        "payload": {
            "max_daily_amount": 10000
        },
        "encode": "JSON"
    }
}
getMaxDailyTransactionCount
Nombre del método original: getMaxDailyTransactionCount
Este método obtiene el número máximo de transacciones diarias para una cuenta especificada. Este método solo puede ser llamado por un Token Admin o Token Auditor del código de cadena o un Org Admin o Org Auditor de la organización especificada.
Carga Útil:
{{api-gateway-endpoint1}}/getMaxDailyTransactionCount?OrgId={{bc-org-id}}&UserId={{bc-user-id}}&TokenId={{bc-token-id}}
Parámetros:
  • tokenId: string: ID del token.
  • orgId: string: ID del proveedor de servicios de afiliación (MSP) del usuario de la organización actual.
  • userId: string: nombre de usuario o ID de correo electrónico del usuario.
Ejemplo de valor devuelto:
{
    "returnCode": "Success",
    "error": "",
    "result": {
        "payload": {
            "max_daily_transactions": 100
        },
        "encode": "JSON"
    }
}
getNetTokens
Nombre del método original: getNetTokens
Este método GET devuelve el número neto total de tokens disponibles en el sistema para un token especificado. El total neto de tokens es la cantidad de tokens que quedan después de que los tokens se queman. Este método solo puede ser llamado por Token Admin o Token Auditor, o por Org Admin o Org Auditor. 
/getNetStablecoinTokens?tokenId={{bc-token-id}}
Parámetros:
  • tokenId: string: ID del token.
Ejemplo de valor devuelto:
{
    "returnCode": "Success",
    "error": "",
    "result": {
        "payload": {
            "msg": "Net supply of token for Token Id: USD is 878 tokens.",
            "quantity": 878
        },
        "encode": "JSON"
    }
}
getOnHoldBalanceWithOperationId
Nombre del método original: getOnHoldBalanceWithOperationId
Este método devuelve el saldo retenido para un token e ID de operación especificados. Este método solo puede ser llamado por Token Admin o Token Auditor, o por el remitente, el receptor o el notario asociado a la operación.
Carga Útil:
{{api-gateway-endpoint1}}/getOnHoldBalanceWithOperationId?tokenId={{bc-token-id}}&operationId=operation_id value
Parámetros:
  • tokenId: string: ID del token.
  • operationId: string: ID único para identificar la operación de retención. Normalmente, la aplicación cliente transfiere este ID.
Ejemplo de valor devuelto:
{
    "returnCode": "Success",
    "error": "",
    "result": {
        "payload": {
            "msg": "Current Holding Balance of Operation 'hold2' for token 't1' is: 600",
            "holding_balance": 600
        },
        "encode": "JSON"
    }
}
getOnHoldDetailsWithOperationId
Nombre del método original: getOnHoldDetailsWithOperationId
Este método devuelve los detalles de la transacción retenida para un token e ID de operación especificados. Este método solo puede ser llamado por Token Admin o Token Auditor, o por el remitente, el receptor o el notario asociado a la operación.
Carga Útil:
{{api-gateway-endpoint1}}/getOnHoldDetailsWithOperationId?tokenId={{bc-token-id}}&operationId=operation_id value
Parámetros:
  • tokenId: string: ID del token.
  • operationId: string: ID único para identificar la operación de retención. Normalmente, la aplicación cliente transfiere este ID.
Ejemplo de valor devuelto:
{
    "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
Nombre del método original: getOnHoldIds
Este método GET devuelve una lista de todos los ID de retención de una cuenta especificada. Este método solo puede ser llamado por un Token Admin o Token Auditor del código de cadena, un Org Admin o Org Auditor de la organización especificada o el AccountOwner de la cuenta. 
/getOnHoldIds?tokenId={{bc-token-id}}&orgId={{bc-org-id}}&userId={{bc-user-id}}
Parámetros:
  • tokenId: string: ID del token.
  • orgId: string: ID del proveedor de servicios de afiliación (MSP) del usuario de la organización actual.
  • userId: string: nombre de usuario o ID de correo electrónico del usuario.
Ejemplo de valor devuelto:
{
    "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
Nombre del método original: getOrgAccountsByRole
Este método devuelve información sobre todas las cuentas que tienen un rol especificado en una organización especificada. Este método solo puede ser llamado por Token Admin o Token Auditor, o por un Org Admin o Org Auditor de la organización especificada.
Carga Útil:
{{api-gateway-endpoint1}}/getOrgAccountsByRole?tokenId={{bc-token-id}}&role=role value (for example minter / burner / notary)&orgId={{bc-org-id}}
Parámetros:
  • tokenId: string: ID del token.
  • role: string: nombre del rol que se va a comprobar.
  • orgId: string: ID del proveedor de servicios de afiliación (MSP) del usuario de la organización actual.
Ejemplo de valor devuelto:
{
    "returnCode": "Success",
    "error": "",
    "result": {
        "payload": {
            "accounts": [
                "oaccount~374e4e762940fc185c7cd5b6528c7f94985b6c56acf46abb746de6381589edd2"
            ]
        },
        "encode": "JSON"
    }
}
getOrgAdmins
Nombre del método original: getOrgAdmins
Este método devuelve una lista de todos los usuarios que son Org Admin de una organización. Este método solo puede ser llamado por Token Admin o Token Auditor, o por un Org Admin o Org Auditor de la organización asociada.
Carga Útil:
{{api-gateway-endpoint1}}/getOrgAdmins
Parámetros:
  • ninguno
Ejemplo de valor devuelto:
{
    "returnCode": "Success",
    "error": "",
    "result": {
        "payload": {
            "admins": [
                {
                    "org_id": "CentralBank",
                    "user_id": "cb__creator_demo"
                }
            ]
        },
        "encode": "JSON"
    }
}
getOrgAuditors
Nombre del método original: getOrgAuditors
Este método devuelve una lista de todos los usuarios que son Org Auditor de una organización. Este método solo puede ser llamado por Token Admin o Token Auditor, o por un Org Admin o Org Auditor de la organización asociada.
Carga Útil:
{{api-gateway-endpoint1}}/getOrgAuditors
Parámetros:
  • ninguno
Ejemplo de valor devuelto:
{
    "returnCode": "Success",
    "error": "",
    "result": {
        "payload": {
            "admins": [
                {
                    "org_id": "CentralBank",
                    "user_id": "cb_auditor_demo"
                }
            ]
        },
        "encode": "JSON"
    }
}
getOrgUsersByRole
Nombre del método original: getOrgUsersByRole
Este método devuelve información sobre todos los usuarios que tienen un rol especificado en una organización especificada. Este método solo puede ser llamado por Token Admin o Token Auditor, o por un Org Admin o Org Auditor de la organización especificada.
Carga Útil:
{{api-gateway-endpoint1}}/getOrgUsersByRole?tokenId={{bc-token-id}}&role=role value (for example minter / burner / notary)&orgId={{bc-org-id}}
Parámetros:
  • tokenId: string: ID del token.
  • role: string: nombre del rol que se va a comprobar.
  • orgId: string: ID del proveedor de servicios de afiliación (MSP) del usuario de la organización actual.
Ejemplo de valor devuelto:
{
    "returnCode": "Success",
    "error": "",
    "result": {
        "payload": {
            "users": [
                {
                    "token_id": "t1",
                    "user_id": "cb__creator_demo",
                    "org_id": "CentralBank"
                }
            ]
        },
        "encode": "JSON"
    }
}
getStablecoinAccount
Nombre del método original: getAccount
Este método GET devuelve los detalles de la cuenta para un usuario y token especificados. Este método solo puede ser llamado por un Token Admin o Token Auditor del código de cadena, un Org Admin o Org Auditor de la organización especificada o el AccountOwner de la cuenta.
Consulta:
/getStablecoinAccount?tokenId={{bc-token-id}}&orgId={{bc-org-id}}&userId={{bc-user-id}}
Parámetros:
  • tokenId: string: ID del token.
  • orgId: string: ID del proveedor de servicios de afiliación (MSP) del usuario de la organización actual.
  • userId: string: nombre de usuario o ID de correo electrónico del usuario.
Ejemplo de valor devuelto:
{
    "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
Nombre del método original: getAccountBalance
Este método GET devuelve el saldo actual de una cuenta y un token especificados. Este método solo puede ser llamado por un Token Admin o Token Auditor del código de cadena, un Org Admin o Org Auditor de la organización especificada o el AccountOwner de la cuenta. 
/getStablecoinAccountBalance?tokenId={{bc-token-id}}&orgId={{bc-org-id}}&userId={{bc-user-id}}
Parámetros:
  • tokenId: string: ID del token.
  • orgId: string: ID del proveedor de servicios de afiliación (MSP) del usuario de la organización actual.
  • userId: string: nombre de usuario o ID de correo electrónico del usuario.
Ejemplo de valor devuelto:
{
    "returnCode": "Success",
    "error": "",
    "result": {
        "payload": {
            "msg": "Current Balance is: 100",
            "user_balance": 100
        },
        "encode": "JSON"
    }
}
getStablecoinAccountOnHoldBalance
Nombre del método original: getAccountOnHoldBalance
Este método devuelve el saldo actual retenido para una cuenta y un token especificados. Este método solo puede ser llamado por Token Admin o Token Auditor, Org Admin o Org Auditor de la organización especificada, o el propietario de la cuenta.
Carga Útil:
{{api-gateway-endpoint1}}/getStablecoinAccountOnHoldBalance?tokenId={{bc-token-id}}&orgId={{bc-org-id}}&userId={{bc-user-id}}
Parámetros:
  • tokenId: string: ID del token.
  • orgId: string: ID del proveedor de servicios de afiliación (MSP) del usuario de la organización actual.
  • userId: string: nombre de usuario o ID de correo electrónico del usuario.
Ejemplo de valor devuelto:
{
    "returnCode": "Success",
    "error": "",
    "result": {
        "payload": {
            "msg": "Total Holding Balance is: 600",
            "holding_balance": 600
        },
        "encode": "JSON"
    }
}
getStablecoinAccountOnHoldBurnBalance
Nombre del método original: getAccountOnHoldBurnBalance
Este método devuelve el balance de consumo retenido para un usuario especificado. Este método solo puede ser llamado por Token Admin o Token Auditor, Org Admin o Org Auditor de la organización especificada, o el propietario de la cuenta.
Carga Útil:
{{api-gateway-endpoint1}}/getStablecoinAccountOnHoldBurnBalance?tokenId={{bc-token-id}}&orgId={{bc-org-id}}&userId={{bc-user-id}}
Parámetros:
  • tokenId: string: ID del token.
  • orgId: string: ID del proveedor de servicios de afiliación (MSP) del usuario de la organización actual.
  • userId: string: nombre de usuario o ID de correo electrónico del usuario.
Ejemplo de valor devuelto:
{
    "returnCode": "Success",
    "error": "",
    "result": {
        "payload": {
            "msg": "Total On Hold Burning Balance is: 0",
            "onhold_burn_balance": 0
        },
        "encode": "JSON"
    }
}
getStablecoinAccountPolicyCheckById
Nombre del método original: getAccountPolicyCheckById
Este método obtiene los detalles de la política de cuenta para un ID de política especificado. Este método solo puede ser llamado por Token Admin o Token Auditor, o por Org Admin o Org Auditor de la organización especificada.
Carga Útil:
{{api-gateway-endpoint1}}/getStablecoinAccountPolicyCheckById?id=id value
Parámetros:
  • id: string: ID de política de cuenta único.
Ejemplo de valor devuelto:
{
    "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
Nombre del método original: getAccountsByRole
Este método devuelve una lista de todos los ID de cuenta para un rol y token especificados. Este método solo se puede llamar mediante Token Admin o Token Auditor.
Carga Útil:
{{api-gateway-endpoint1}}/getStablecoinAccountsByRole?tokenId={{bc-token-id}}&role=role value (for example minter / burner / notary)
Parámetros:
  • tokenId: string: ID del token.
  • role: string: nombre del rol que se va a comprobar.
Ejemplo de valor devuelto:
{
    "returnCode": "Success",
    "error": "",
    "result": {
        "payload": {
            "accounts": [
                "oaccount~374e4e762940fc185c7cd5b6528c7f94985b6c56acf46abb746de6381589edd2"
            ]
        },
        "encode": "JSON"
    }
}
getStablecoinAccountsByUser
Nombre del método original: getAccountsByUser
Este método devuelve una lista de todos los IDs de cuenta para un ID de organización y un ID de usuario especificados. Este método solo puede ser llamado por un Token Admin o Token Auditor del código de cadena, un Org Admin o Org Auditor de la organización especificada o el AccountOwner de la cuenta. 
/getStablecoinAccountsByUser?orgId={{bc-org-id}}&userId={{bc-user-id}}
Parámetros:
  • orgId: string: ID del proveedor de servicios de afiliación (MSP) del usuario de la organización actual.
  • userId: string: nombre de usuario o ID de correo electrónico del usuario.
Ejemplo de valor devuelto:
{
    "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
Nombre del método original: getAccountStatus
Este método obtiene el estado actual de la cuenta de token. Este método puede ser llamado por Token Admin o Token Auditor, o un Org Admin o Org Auditor de la organización especificada, o por el propietario de la cuenta de token. Si el valor accountStatus no se encuentra en la contabilidad, este método devuelve un objeto accountStatus con el estado definido como activo.
Carga Útil:
{{api-gateway-endpoint1}}/getStablecoinAccountStatus?tokenId={{bc-token-id}}&orgId={{bc-org-id}}&userId={{bc-user-id}}
Parámetros:
  • tokenId: string: ID del token.
  • orgId: string: ID del proveedor de servicios de afiliación (MSP) del usuario de la organización actual.
  • userId: string: nombre de usuario o ID de correo electrónico del usuario.
Ejemplo de valor devuelto:
{
    "returnCode": "Success",
    "error": "",
    "result": {
        "payload": {
            "assetType": "oaccountStatus",
            "status_id": "oaccountStatus~cfe302f06bf732f248315725bb601d7906d7c1d4c167d04ac3a5283b8dbc7fc4",
            "account_id": "oaccount~374e4e762940fc185c7cd5b6528c7f94985b6c56acf46abb746de6381589edd2",
            "status": "active"
        },
        "encode": "JSON"
    }
}
getStablecoinAccountTransactionHistoryWithFilters
Nombre del método original: getAccountTransactionHistoryWithFiltersFromRichHistDB
Este método devuelve los detalles del historial de transacciones de la cuenta de la base de datos de historial enriquecido. Este método solo puede ser llamado por un Token Admin o Token Auditor del código de cadena, un Org Admin o Org Auditor de la organización especificada o el AccountOwner de la cuenta. 
/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"}
Parámetros:
  • tokenId: string: ID del token.
  • orgId: string: ID del proveedor de servicios de afiliación (MSP) del usuario de la organización actual.
  • userId: string: nombre de usuario o ID de correo electrónico del usuario.
  • customEndpoint: punto final de servicio RESTful de la base de datos de historial enriquecido desde la que se recuperará el historial de transacciones.
  • bearerToken: token que se va a utilizar para llamar al punto final RESTful para asegurarse de que la solicitud está autorizada.
  • filters: JSON object: parámetro opcional. Si está vacío, se devuelven todos los registros. La propiedad pageSize determina el número de registros que se devolverán. Si pageSize es 0, el tamaño de página por defecto es 20. La propiedad bookmark determina el índice inicial de los registros que se van a devolver. Las propiedades startTime y endTime se deben especificar en formato RFC-3339.
Ejemplo de valor devuelto:
{
    "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
Nombre del método original: getTokenAuditors
Este método devuelve todos los Token Auditors del código de cadena. Este método solo se puede llamar mediante Token Admin o Token Auditor.
Carga Útil:
 	
{{api-gateway-endpoint1}}/getTokenAuditors
Parámetros:
  • ninguno
Ejemplo de valor devuelto:
{
    "returnCode": "Success",
    "error": "",
    "result": {
        "payload": {
            "auditors": [
                {
                    "org_id": "CentralBank",
                    "user_id": "cb_auditor_demo"
                }
            ]
        },
        "encode": "JSON"
    }
}
getTokenById
Nombre del método original: getTokenById
Este método devuelve los detalles del token para un ID de token especificado. Este método solo se puede llamar mediante Token Admin o Token Auditor, o mediante Org Admin o Org Auditor de cualquier organización.
Carga Útil:
{{api-gateway-endpoint1}}/getTokenById?tokenId={{bc-token-id}}
Parámetros:
  • tokenId: string: ID del token.
Ejemplo de valor devuelto:
{
    "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
Nombre del método original: getTokenHistory
Este método devuelve el historial de tokens para un ID de token especificado. Este método solo se puede llamar mediante Token Admin o Token Auditor, o mediante Org Admin o Org Auditor de cualquier organización.
Carga Útil:
{{api-gateway-endpoint1}}/getTokenHistory?tokenId={{bc-token-id}}
Parámetros:
  • tokenId: string: ID del token.
Ejemplo de valor devuelto:
{
    "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
Nombre del método original: getTotalMintedTokens
Este método devuelve el número total de tokens acuñados para un token especificado. Este método solo se puede llamar mediante Token Admin, Token Auditor, Org Admin o Org Auditor.
Consulta:
/getTotalCreatedStablecoinTokens?tokenId={{bc-token-id}}
Parámetros:
  • tokenId: string: ID del token.
Ejemplo de valor devuelto:
{
    "returnCode": "Success",
    "error": "",
    "result": {
        "payload": {
            "msg": "Total minted token for Token Id: USD is 910 tokens.",
            "quantity": 910
        },
        "encode": "JSON"
    }
}
getTransactionById
Nombre del método original: getTransactionById
Este método devuelve el registro de transacción detallado para un ID de transacción especificado. Este método solo puede ser llamado por Token Admin o por cualquier cuenta especificada por la transacción (emisor, receptor o notario).
Carga Útil:
{{api-gateway-endpoint1}}/getTransactionById?transactionId=transaction_id value
Parámetros:
  • transaction_id string: ID de la transacción.
Ejemplo de valor devuelto:
{
    "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
Nombre del método original: getUserByAccountId
Este método devuelve los detalles del usuario (org_id, user_id y token_id) para una cuenta especificada. Este método solo puede ser llamado por un Token Admin o Token Auditor del código de cadena, o por un Org Admin o Org Auditor de la organización especificada.
Consulta:
/getUserByStablecoinAccountId?accountId=account_id value
Parámetros:
  • accountId: string: ID de la cuenta.
Ejemplo de valor devuelto:
{
    "returnCode": "Success",
    "error": "",
    "result": {
        "payload": {
            "token_id": "USD",
            "user_id": "admin_user_cb",
            "org_id": "CB"
        },
        "encode": "JSON"
    }
}
getUsersByRole
Nombre del método original: getUsersByRole
Este método GET devuelve una lista de todos los usuarios para un token y rol especificados. Este método solo puede ser llamado por un Token Admin o Token Auditor del código de cadena.
Consulta:
/getUsersByRole?tokenId={{bc-token-id}}&role=role value (for example minter / burner / notary)
Parámetros:
  • tokenId: string: ID del token.
  • role: string: nombre del rol que se va a buscar.
Ejemplo de valor devuelto:
{
    "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
Nombre del método original: holdTokens
Este método crea una retención en nombre del propietario de los tokens con la cuenta to_account_id. Se especifica una cuenta de notario, que es responsable de completar o liberar la retención. Cuando se crea la retención, el saldo de token especificado del pagador se retiene. Un saldo retenido no se puede transferir hasta que la retención se haya completado o liberado. El emisor de la llamada de este método debe tener una cuenta ya creada.
Carga Útil:
{
    "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}}
}
Parámetros:
  • tokenId: string: ID del token.
  • operationId: string: ID único para identificar la operación de retención. Normalmente, la aplicación cliente transfiere este ID.
  • toOrgId: string: ID del proveedor de servicios de membresía (MSP) del receptor en la organización actual.
  • toUserId: string: nombre de usuario o ID de correo electrónico del receptor.
  • notaryOrgId: string: ID del proveedor de servicios de membresía (MSP) del notario en la organización actual.
  • notaryUserId: string: nombre de usuario o ID de correo electrónico del notario.
  • quantity: number: número de tokens que se deben retener.
  • timeToExpiration: hora a la que caduca la retención. Especifique 0 para una retención permanente. De lo contrario, utilice el formato RFC-3339. Por ejemplo, 2021-06-02T12:46:06Z.
  • infoDetails: JSON: descripción y categoría, como se muestra en el siguiente ejemplo.
    {
   "category" : "category input",
   "description" : "description input"
}
  • endorsers: string[]: matriz de los pares (por ejemplo, peer1, peer2) que deben respaldar la transacción.
Ejemplo de valor devuelto:
{
    "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
Nombre del método original: init
Este método se llama cuando se despliega el código de cadena. La información de usuario se guarda como el Token Admin del código de cadena.
Carga Útil:
{
    "adminList": "[{\"org_id\":\"{{bc-org-id}}\",\"user_id\":\"{{bc-admin-user}}\"}]"
}
Parámetros:
  • adminList: TokenAdminAsset[]: matriz de objetos JSON que contiene un ID de organización y un ID de usuario que especifica el administrador de token, con el siguiente formato:
    {
   "org_id":"{{bc-org-id}}",
   "user_id":"{{bc-admin-user}
}
Ejemplo de valor devuelto:
{
    "returnCode": "Success",
    "error": "",
    "result": {
        "txid": "fdb7dc89832c8045a333823b77fa24ae628178148dc93b3550040e070d7cd807",
        "payload": "",
        "encode": "UTF-8",
        "sourceURL": "cb-oabcs1-bom.blockchain.ocp.example.com:20009",
        "blockNumber": 263
    }
}
initializeStablecoinToken
Nombre del método original: initializeStablecoinToken
Este método crea un token e inicializa las propiedades del token. El activo y sus propiedades se guardan en la base de datos de estado. Este método solo puede ser llamado por un Token Admin del código de cadena.
Carga Útil:
{
    "tokenAsset": "{\"token_id\":\"{{bc-token-id}}\",\"token_desc\":\"token_desc value\",\"Currency_Name\":\"Currency_Name value\"}",
    "sameOrgEndorser": true
}
Parámetros:
  • tokenAsset: <Token Class>: el activo de token se transfiere como parámetro a este método. Las propiedades del activo de token se describen en el archivo de modelo.
  • sameOrgEndorser: boolean: valor booleano que indica si los endosos de transacción deben ser de la misma organización que el solicitante.
Devuelve:
  • En caso de éxito, una representación JSON del activo de token que se creó.
Ejemplo de valor devuelto:
{
    "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
Nombre del método original: isInRole
Este método devuelve un valor booleano para indicar si un usuario y un token tienen un rol especificado. Este método solo lo puede llamar un Token Admin o el propietario de la cuenta.
Carga Útil:
{{api-gateway-endpoint2}}/isInRole?tokenId={{bc-token-id}}&orgId={{bc-org-id}}&userId={{bc-user-id}}&role=role value (for example minter / burner / notary)
Parámetros:
  • tokenId: string: ID del token.
  • orgId: string: ID del proveedor de servicios de membresía (MSP) del usuario.
  • userId: string: nombre de usuario o ID de correo electrónico del usuario.
  • role: string: nombre del rol.
Ejemplo de valor devuelto:
{
    "returnCode": "Success",
    "error": "",
    "result": {
        "payload": {
            "result": "true"
        },
        "encode": "JSON"
    }
}
isTokenAdmin
Nombre del método original: isTokenAdmin
Este método devuelve el valor booleano true si la cuenta especificada es Token Admin; de lo contrario, devuelve false. El método THis solo se puede llamar mediante Token Admin.
Carga Útil:
{{api-gateway-endpoint2}}/isTokenAdmin?orgId={{bc-org-id}}&userId={{bc-user-id}}
Parámetros:
  • orgId: string: ID del proveedor de servicios de afiliación (MSP) del usuario de la organización actual.
  • userId: string: nombre de usuario o ID de correo electrónico del usuario.
Ejemplo de valor devuelto:
{
    "returnCode": "Success",
    "error": "",
    "result": {
        "payload": {
            "result": false
        },
        "encode": "JSON"
    }
}
rejectBurn
Nombre del método original: rejectBurn
Este método puede ser llamado por un notario para rechazar una solicitud de grabación.
Carga Útil:
{
    "tokenId": "{{bc-token-id}}",
    "operationId": "operation_id value",
    "sameOrgEndorser": true
}
Parámetros:
  • tokenId: string: ID del token que se va a rechazar para la quema.
  • operationId: string: el ID de operación único que representa la solicitud de grabación.
  • sameOrgEndorser: boolean: valor booleano que indica si los endosos de transacción deben ser de la misma organización que el solicitante.
Ejemplo de valor devuelto:
{
    "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
Nombre del método original: rejectMint
Este método puede ser llamado por un notario para rechazar una solicitud de acuñación.
Carga Útil:
{
    "tokenId": "{{bc-token-id}}",
    "operationId": "operation_id value",
    "sameOrgEndorser": true
}
Parámetros:
  • tokenId: string: ID del token para rechazar la extracción.
  • operationId: string: ID de operación único que representa la solicitud de moneda.
  • sameOrgEndorser: boolean: valor booleano que indica si los endosos de transacción deben ser de la misma organización que el solicitante.
Ejemplo de valor devuelto:
{
    "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
Nombre del método original: releaseHoldTokens
Este método POST libera una retención de tokens. La transferencia no se ha completado y todos los tokens retenidos están disponibles de nuevo para el propietario original. Este método puede ser llamado por el ID AccountOwner con el rol notary dentro del límite de tiempo especificado o por el pagador, el beneficiario o el notario después del límite de tiempo especificado.
Carga Útil:
{
    "tokenId": "{{bc-token-id}}",
    "operationId": "operation_id value",
    "endorsers": {{endorsers}}
}
Parámetros:
  • tokenId: string: ID del token.
  • operationId: string: ID único para identificar la operación de retención. Normalmente, la aplicación cliente transfiere este ID.
  • endorsers: string[]: matriz de los pares (por ejemplo, peer1, peer2) que deben respaldar la transacción.
Ejemplo de valor devuelto:
{
    "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
Nombre del método original: removeOrgAdmin
Este método POST elimina un usuario como Org Admin del código de cadena. Este método solo puede ser llamado por un Token Admin o Org Admin de la organización especificada.
Carga Útil:
{
    "orgId": "{{bc-org-id}}",
    "userId": "{{bc-user-id}}",
    "sameOrgEndorser": true
}
Parámetros:
  • orgId: string: ID del proveedor de servicios de afiliación (MSP) del usuario de la organización actual.
  • userId: string: nombre de usuario o ID de correo electrónico del usuario.
  • sameOrgEndorser: boolean: valor booleano que indica si los endosos de transacción deben ser de la misma organización que el solicitante.
Ejemplo de valor devuelto:
{
    "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
Nombre del método original: removeOrgAuditor
Este método POST elimina un usuario como Org Auditor del código de cadena. Este método solo puede ser llamado por un Token Admin o Org Admin de la organización especificada.
Carga Útil:
{
    "orgId": "{{bc-org-id}}",
    "userId": "{{bc-user-id}}",
    "sameOrgEndorser": true
}
Parámetros:
  • orgId: string: ID del proveedor de servicios de afiliación (MSP) del usuario de la organización actual.
  • userId: string: nombre de usuario o ID de correo electrónico del usuario.
  • sameOrgEndorser: boolean: valor booleano que indica si los endosos de transacción deben ser de la misma organización que el solicitante.
Ejemplo de valor devuelto:
{
    "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
Nombre del método original: removeRole
Este método elimina el rol af de un usuario y token especificados. Este método solo puede ser llamado por un Token Admin del código de cadena o por un Org Admin de la organización especificada.
Carga Útil:
{
    "tokenId": "{{bc-token-id}}",
    "role": "role value (for example minter / burner / notary)",
    "orgId": "{{bc-org-id}}",
    "userId": "{{bc-user-id}}",
    "endorsers": {{endorsers}}
}
Parámetros:
  • tokenId: string: ID del token.
  • role: string: nombre del rol que se va a eliminar del usuario especificado. Los comportamientos mintable y burnable corresponden a las propiedades minter_role_name y burner_role_name del archivo de especificación. Del mismo modo, el rol notary corresponde a la propiedad notary_role_name del archivo de especificación.
  • orgId: string: ID del proveedor de servicios de afiliación (MSP) del usuario de la organización actual.
  • userId: string: nombre de usuario o ID de correo electrónico del usuario.
  • endorsers: string[]: matriz de los pares (por ejemplo, peer1, peer2) que deben respaldar la transacción.
Devuelve:
  • En caso de éxito, se mostrará un mensaje con los detalles de la cuenta.
Ejemplo de valor devuelto:
{
    "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
Nombre del método original: removeTokenAdmin
Este método POST elimina un usuario como Token Admin del código de cadena. Este método solo puede ser llamado por un Token Admin del código de cadena. Un administrador no puede eliminarse a sí mismo.
Carga Útil:
{
    "orgId": "{{bc-org-id}}",
    "userId": "{{bc-user-id}}",
    "sameOrgEndorser": true
}
Parámetros:
  • orgId: string: ID del proveedor de servicios de afiliación (MSP) del usuario de la organización actual.
  • userId: string: nombre de usuario o ID de correo electrónico del usuario.
  • sameOrgEndorser: boolean: valor booleano que indica si los endosos de transacción deben ser de la misma organización que el solicitante.
Ejemplo de valor devuelto:
{
    "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
Nombre del método original: removeTokenAuditor
Este método POST elimina un usuario como Token Auditor del código de cadena. Este método solo puede ser llamado por un Token Admin del código de cadena.
Carga Útil:
{
    "orgId": "{{bc-org-id}}",
    "userId": "{{bc-user-id}}",
    "sameOrgEndorser": true
}
Parámetros:
  • orgId: string: ID del proveedor de servicios de afiliación (MSP) del usuario de la organización actual.
  • userId: string: nombre de usuario o ID de correo electrónico del usuario.
  • sameOrgEndorser: boolean: valor booleano que indica si los endosos de transacción deben ser de la misma organización que el solicitante.
Ejemplo de valor devuelto:
{
    "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
Nombre del método original: requestBurn
Este método puede ser llamado por un quemador para enviar una solicitud al notario para destruir una cantidad especificada de tokens.
Carga Útil:
{
    "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
}
Parámetros:
  • tokenId: string: ID del token que se va a grabar.
  • operationId: string: el ID de operación único que representa la solicitud de grabación.
  • notaryOrgId: string – El ID del proveedor de servicios de membresía (MSP) del notario del quemador que procesará la solicitud.
  • notaryUserId: string: nombre de usuario o ID de correo electrónico del notario del quemador que procesará la solicitud.
  • quantity: number: cantidad de tokens que se queman.
  • timeToExpiration: el tiempo después del cual caduca la solicitud de grabación y ya no es válida.
  • infoDetails: JSON: objeto que especifica la categoría (category) y la descripción (description) de la solicitud, como se muestra en el siguiente ejemplo.
    {
     "category" : "category input",
     "description" : "description input"
}
  • sameOrgEndorser: boolean: valor booleano que indica si los endosos de transacción deben ser de la misma organización que el solicitante.
Ejemplo de valor devuelto:
{
    "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
Nombre del método original: requestMint
Este método puede ser llamado por un minter para enviar una solicitud al notario minter para crear una cantidad especificada de tokens.
Carga Útil:
{
    "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
}
Parámetros:
  • tokenId: string: ID del token que se debe acuñar.
  • operationId: string: ID de operación único que representa la solicitud de moneda.
  • notaryOrgId: string – El ID del proveedor de servicios de membresía (MSP) del notario menor que procesará la solicitud.
  • notaryUserId: string: nombre de usuario o ID de correo electrónico del notario menor que procesará la solicitud.
  • quantity: number: cantidad de tokens que se deben acuñar.
  • timeToExpiration: el tiempo después del cual caduca la solicitud de extracción y ya no es válida.
  • infoDetails: JSON: objeto que especifica la categoría (category) y la descripción (description) de la solicitud, como se muestra en el siguiente ejemplo.
    {
     "category" : "category input",
     "description" : "description input"
}
  • sameOrgEndorser: boolean: valor booleano que indica si los endosos de transacción deben ser de la misma organización que el solicitante.
Ejemplo de valor devuelto:
{
    "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
Nombre del método original: setMaxDailyAmount
Este método POST se utiliza para definir el parámetro maxDailyAmount en los detalles de la cuenta para el importe especificado. Este método solo puede ser llamado por un Token Admin del código de cadena o por un Org Admin de la organización especificada.
Carga Útil:
{
    "orgId": "{{bc-org-id}}",
    "userId": "{{bc-user-id}}",
    "tokenId": "{{bc-token-id}}",
    "maxDailyAmount": 1,
    "endorsers": {{endorsers}}
}
Parámetros:
  • orgId: string: ID del proveedor de servicios de afiliación (MSP) del usuario de la organización actual.
  • userId: string: nombre de usuario o ID de correo electrónico del usuario.
  • tokenId: string: ID del token.
  • maxDailyAmount: number: valor de importe diario máximo para la cuenta especificada, que define el importe máximo que se puede realizar a diario.
  • endorsers: string[]: matriz de los pares (por ejemplo, peer1, peer2) que deben respaldar la transacción.
Ejemplo de valor devuelto:
{
    "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
Nombre del método original: setMaxDailyTransactionCount
Este método POST se utiliza para definir el parámetro maxDailyTransactions en los detalles de la cuenta para el importe especificado. Este método solo puede ser llamado por un Token Admin del código de cadena o por un Org Admin de la organización especificada.
Carga Útil:
{
    "orgId": "{{bc-org-id}}",
    "userId": "{{bc-user-id}}",
    "tokenId": "{{bc-token-id}}",
    "maxDailyTransactions": 1,
    "endorsers": {{endorsers}}
}
Parámetros:
  • orgId: string: ID del proveedor de servicios de afiliación (MSP) del usuario de la organización actual.
  • userId: string: nombre de usuario o ID de correo electrónico del usuario.
  • tokenId: string: ID del token.
  • maxDailyTransactions: number: valor de importe máximo diario para la cuenta especificada, que define el número máximo de transacciones permitidas por día.
  • endorsers: string[]: matriz de los pares (por ejemplo, peer1, peer2) que deben respaldar la transacción.
Ejemplo de valor devuelto:
{
    "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
Nombre del método original: suspendAccount
Este método suspende una cuenta de token fungible. Devuelve un error si no se encuentra un valor accountStatus en la contabilidad. Este método solo puede ser llamado por un Token Admin del código de cadena o por un Org Admin de la organización especificada.
Carga Útil:
{
    "tokenId": "{{bc-token-id}}",
    "orgId": "{{bc-org-id}}",
    "userId": "{{bc-user-id}}",
    "endorsers": {{endorsers}}
}
Parámetros:
  • tokenId: string: ID del token.
  • orgId: string: ID del proveedor de servicios de afiliación (MSP) del usuario de la organización actual.
  • userId: string: nombre de usuario o ID de correo electrónico del usuario.
  • endorsers: string[]: matriz de los pares (por ejemplo, peer1, peer2) que deben respaldar la transacción.
Ejemplo de valor devuelto:
{
    "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
Nombre del método original: transferTokens
Este método transfiere tokens del emisor de llamada a una cuenta especificada. El emisor de llamada del método debe tener una cuenta. La cantidad debe estar dentro de los valores decimales especificados por el parámetro decimal del comportamiento divisible en el archivo de especificación.
Carga Útil:
{
    "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}}
}
Parámetros:
  • tokenId: string: ID del token.
  • toOrgId: string: ID del proveedor de servicios de membresía (MSP) del receptor (beneficiario) de la organización actual.
  • toUserId: string: nombre de usuario o ID de correo electrónico del receptor.
  • quantity: number: número de tokens que se van a transferir.
  • infoDetails: JSON: objeto que especifica la categoría (category) y la descripción (description) de la solicitud, como se muestra en el siguiente ejemplo.
    {
     "category" : "category input",
     "description" : "description input"
}
  • endorsers: string[]: matriz de los pares (por ejemplo, peer1, peer2) que deben respaldar la transacción.
Ejemplo de valor devuelto:
{
    "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
Nombre del método original: updateAccountPolicyCheck
Este método actualiza la política para una cuenta especificada. Este método solo puede ser llamado por un Token Admin o Org Admin de la organización especificada.
Carga Útil:
{
    "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}}
}
Parámetros:
  • asset: AccountPolicyCheck object: objeto que define los parámetros de política de cuenta, que incluye los siguientes campos:
    • accountPolicyId: ID de política de cuenta único.
    • orgId: ID del proveedor de servicios de afiliación (MSP) del usuario para el que se va a crear la política.
    • userId: nombre de usuario o ID de correo electrónico del usuario para el que se va a crear la política.
    • kycCompliance: valor booleano que indica si la cuenta cumple los requisitos de KYC (Know Your Customer).
    • amlCompliance: valor booleano que indica si la cuenta cumple con los requisitos de prevención de blanqueo de dinero (AML).
    • riskScore: puntuación de riesgo asociada a la cuenta, que se utiliza para la evaluación de conformidad.
    • restrictionFlag: valor booleano que indica si la cuenta está sujeta a transferencias restringidas. Si se define en true, solo se permiten transferencias dentro del umbral de política de aprobación más bajo.
  • endorsers: string[]: matriz de los pares (por ejemplo, peer1, peer2) que deben respaldar la transacción.
Ejemplo de valor devuelto:
{
    "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
Nombre del método original: updateApprovalPolicyCheck
Este método actualiza la política de aprobación. Este método solo se puede llamar mediante Token Admin.
Carga Útil:
{
    "asset": "{\"approvalPolicyId\":\"approvalPolicyId value\",\"transactionLowerLimit\":\"transactionLowerLimit value\",\"transactionUpperLimit\":\"transactionUpperLimit value\",\"numberOfApprovalsRequired\":999,\"approverDetails\":[{\"approverOrgId\":\"approverOrgId value\",\"approverUserId\":\"approverUserId value\",\"approvalSequence\":999}]}",
    "endorsers": {{endorsers}}
}
Parámetros:
  • asset: ApprovalPolicyCheck class: clase que define reglas de aprobación para una transacción, que incluye los siguientes campos:
    • approvalPolicyId: ID de política de aprobación único.
    • transactionLowerLimit: importe mínimo de transacción al que se aplica la política de aprobación.
    • transactionUpperLimit: importe máximo de transacción al que se aplica la política de aprobación.
    • numberOfApprovalsRequired: número total de aprobaciones necesarias antes de que se pueda completar la transacción.
    • approverDetails: lista de aprobadores junto con la secuencia de aprobación asignada, que define el orden obligatorio para las aprobaciones.
  • endorsers: string[]: matriz de los pares (por ejemplo, peer1, peer2) que deben respaldar la transacción.
Ejemplo de valor devuelto:
{
    "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
Nombre del método original: updateStablecoinToken
Este método actualiza un token de stablecoin. Este método solo se puede llamar mediante Token Admin.
Carga Útil:
{
    "tokenAsset": "{\"token_id\":\"{{bc-token-id}}\",\"token_desc\":\"token_desc value\",\"currencyName\":\"currencyName value\",\"conversionRate\":999}",
    "endorsers": {{endorsers}}
}
Parámetros:
  • asset <Token Class>: el activo de token se transfiere como parámetro a este método. Las propiedades del activo de token pueden variar y se describen en el archivo de especificación de token. No incluya parámetros que estén marcados como de solo lectura en el archivo de especificación.

    Puede especificar el parámetro asset en un formato diferente si utiliza Visual Studio Code frente a la CLI o una recopilación Postman.

    Visual Studio Code: utilice la GUI para transferir parámetros individuales que corresponden a los campos de clase de token.

    CLI/Postman: transfiera una cadena JSON serializada que incluya los campos de especificación de token, como se muestra en el siguiente ejemplo.

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

  • endorsers: string[]: matriz de los pares (por ejemplo, peer1, peer2) que deben respaldar la transacción.
Ejemplo de valor devuelto:
{
    "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
Nombre del método original: createStablecoinAccount
Esta API de envoltorio personalizada combina API de código de cadenas y API de consola de Oracle Blockchain Platform en un único punto final. Este método completa los siguientes pasos en secuencia.
  1. Crea un ID de inscripción para un usuario en el proxy REST de la instancia. Si ya existe una inscripción para el ID de usuario, la inscripción no se vuelve a crear. El ID de inscripción es el mismo que el de usuario. El ID de inscripción solo puede contener caracteres alfanuméricos, guiones (-) y guiones bajos (_). Si el ID de usuario contiene otros caracteres especiales, se sustituyen por guiones bajos (_).
  2. Crea una cuenta en el libro mayor.
  3. Asocia la nueva cuenta con el token especificado.
  4. Asigna el rol especificado al usuario.
Si alguno de los pasos falla, la inscripción se elimina automáticamente.
Carga Útil:
{
    "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}"
}
Parámetros:
  • orgId: ID del proveedor de servicios de afiliación (MSP) del usuario para el que se creará la cuenta. El ID debe empezar por un carácter alfanumérico y puede incluir letras, números y caracteres especiales, como guiones bajos (_), puntos (.), signos at (@) y guiones (-).
  • userId: nombre de usuario o ID de correo electrónico del usuario. El ID debe empezar por un carácter alfanumérico y puede incluir letras, números y caracteres especiales, como guiones bajos (_), puntos (.), signos at (@) y guiones (-).
  • tokenId: string: el ID de token, que debe comenzar con un carácter alfanumérico y puede incluir letras, números y los caracteres especiales de subrayado (_) y guion (-). No puede superar los 16 caracteres de longitud.
  • role: string: nombre del rol que se va a agregar al usuario especificado, que debe ser uno de los siguientes valores: minter, burner, notary, tokenAdmin, tokenAuditor, orgAdmin o orgAuditor.
  • dailyLimits: JSON object: objeto JSON del siguiente tipo.
    {
     "max_daily_amount": 100000
     "max_daily_transactions": 10000
 }
    En el ejemplo, el valor max_daily_amount es la cantidad máxima de tokens que se pueden realizar diariamente y el valor max_daily_transactions es el número máximo de transacciones que se pueden completar diariamente.
Devuelve:
  • En caso de éxito, un objeto JSON de la cuenta que se creó.
Ejemplo de valor devuelto:
"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
Nombre del método original: createIDCSUser
Este método POST crea un usuario de Identity Cloud Service en el arrendamiento especificado por la URL en el archivo terraform.tfvars y asigna el usuario al grupo de usuarios especificado.
Carga Útil:
{
 "userName": "userName value",
 "firstName": "firstName value",
 "lastName": "lastName value",
 "email": "email value",
 "groupName": "groupName value"
}
Parámetros:
  • userName: string: ID del usuario.
  • firstName: string: nombre del usuario.
  • lastName: string: apellido del usuario.
  • email: string: dirección de correo electrónico del usuario.
  • groupName: string: nombre del grupo de Identity Cloud Service que se asignará al usuario.
Ejemplo de valor devuelto:
{
 "status": "Success",
 "msg": "User user1 is created and assigned to the group BOND_ADMIN"
}