Pacote de API Stablecoin Wrapper

O Oracle Blockchain Platform Digital Assets Edition inclui um pacote de API wrapper que estende a API REST para oferecer suporte a operações específicas do ciclo de vida de uma stablecoin.

O pacote de API wrapper usa o serviço API Gateway e o OCI Functions para implementar rotas de API especificamente para gerenciar o ciclo de vida da stablecoin. O pacote de API wrapper stablecoin pode ser baixado no console do Oracle Blockchain Platform e inclui um arquivo compactado que contém o pacote de API wrapper, incluindo os scripts Terraform necessários para implantação. Você implanta esse arquivo em uma pilha do Resource Manager no OCI (Oracle Cloud Infrastructure) para criar os recursos necessários da Oracle para as APIs do encapsulador. Ele também inclui uma coleção Postman que permite testar as APIs do wrapper implantadas. A coleta inclui solicitações pré-configuradas com pontos finais e payloads que correspondem às APIs definidas no pacote de API do wrapper.

APIs do Encapsulador

activateStablecoinAccount

Nome do método original: activateAccount

Este método POST ativa uma conta de token fungível. Esse método só pode ser chamado por uma Token Admin ou Org Admin da organização especificada. Não é possível ativar contas excluídas.

Payload:

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

Parâmetros:

tokenId: string – O ID do token.
orgId: string – O ID do provedor de serviços de associação (MSP) do usuário na organização atual.
userId: string – O nome de usuário ou ID de e-mail do usuário.
endorsers: string[] – Um array dos pares (por exemplo, peer1, peer2) que deve endossar a transação.

Retorna:

Em caso de sucesso, uma representação JSON do objeto de status da conta do token especificado.

Exemplo de Valor de Retorno:

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

Nome do método original: addOrgAdmin

Este método adiciona administradores da organização ao chaincode do token. Esse método só pode ser chamado por uma Token Admin ou Org Admin da organização especificada.

Payload:

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

Parâmetros:

orgId: string – O ID do provedor de serviços de associação (MSP) do usuário na organização atual.
userId: string – O nome de usuário ou ID de e-mail do usuário.
sameOrgEndorser: boolean – Um valor booliano que indica se os endossos da transação devem ser da mesma organização que o solicitante.

Exemplo de Valor de Retorno:


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

Nome do método original: addOrgAuditor

Este método adiciona auditores da organização ao chaincode do token. Esse método só pode ser chamado por uma Token Admin ou Org Admin da organização especificada.

Payload:

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

Parâmetros:

orgId: string – O ID do provedor de serviços de associação (MSP) do usuário na organização atual.
userId: string – O nome de usuário ou ID de e-mail do usuário.
sameOrgEndorser: boolean – Um valor booliano que indica se os endossos da transação devem ser da mesma organização que o solicitante.

Exemplo de Valor de Retorno:

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

Nome do método original: addRole

Este método adiciona a atribuição ao usuário e token especificados. Os IDs da conta são formados pela criação de um hash SHA-256 do ID do token concatenado, ID da organização e ID do usuário. Esse método só pode ser chamado por uma Token Admin ou Org Admin da organização especificada.

Payload:

{
    "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 – O ID do token.
role: string – O nome da função a ser adicionada ao usuário especificado. Os comportamentos mintable e burnable são vinculados correspondentemente às propriedades minter_role_name e burner_role_name no arquivo de especificação. Da mesma forma, o comportamento do notário é vinculado à propriedade notary_role_name no arquivo de especificação.
orgId: string – O ID do provedor de serviços de associação (MSP) do usuário na organização atual.
userId: string – O nome de usuário ou ID de e-mail do usuário.
endorsers: string[] – Um array dos pares (por exemplo, peer1, peer2) que deve endossar a transação.

Exemplo de Valor de Retorno:

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

Nome do método original: addTokenAdmin

Esse método POST adiciona um usuário como Token Admin do código de cadeia do token. O método só pode ser chamado por um Token Admin do chaincode do token. A primeira chamada é do administrador que instancia o chaincode.

Payload:

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

Parâmetros:

orgId: string – O ID do provedor de serviços de associação (MSP) do usuário na organização atual.
userId: string – O nome de usuário ou ID de e-mail do usuário.
sameOrgEndorser: boolean – Um valor booliano que indica se os endossos da transação devem ser da mesma organização que o solicitante.

Exemplo de Valor de Retorno:

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

Nome do método original: addTokenAuditor

Este método POST adiciona auditores de token ao chaincode de token. Esse método só pode ser chamado pelo Token Admin do chaincode.

Payload:

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

Parâmetros:

orgId: string – O ID do provedor de serviços de associação (MSP) do usuário na organização atual.
userId: string – O nome de usuário ou ID de e-mail do usuário.
sameOrgEndorser: boolean – Um valor booliano que indica se os endossos da transação devem ser da mesma organização que o solicitante.

Exemplo de Valor de Retorno:

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

Nome do método original: approveBurn

Os notários podem chamar esse método POST para aprovar uma solicitação de gravação.

Payload:

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

Parâmetros:

tokenId: string – O ID do token.
operationId: string – O ID de operação exclusivo da solicitação de mint a ser aprovada.
sameOrgEndorser: boolean – Um valor booliano que indica se os endossos da transação devem ser da mesma organização que o solicitante.

Exemplo de Valor de Retorno:

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

Nome do método original: approveMint

Notários podem chamar este método POST para aprovar uma solicitação de hortelã.

Payload:

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

Parâmetros:

tokenId: string – O ID do token.
operationId: string – O ID de operação exclusivo da solicitação de mint a ser aprovada.
sameOrgEndorser: boolean – Um valor booliano que indica se os endossos da transação devem ser da mesma organização que o solicitante.

Exemplo de Valor de Retorno:

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

Nome do método original: approveTransaction

Os aprovadores podem chamar esse método POST para aprovar uma transação de retenção.

Payload:

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

Parâmetros:

tokenId: string – O ID do token.
orgId: string – O ID do provedor de serviços de associação (MSP) do usuário.
userId: string – O nome de usuário ou ID de e-mail do usuário.
endorsers: string[] – Um array dos pares (por exemplo, peer1, peer2) que deve endossar a transação.

Exemplo de Valor de Retorno:

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

Nome do método original: associateTokenToAccount

Este método POST associa um ID de conta especificado a um token especificado. Esse método só pode ser chamado por uma Token Admin ou Org Admin da organização especificada.

Payload:

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

Parâmetros:

accountId: string – O ID da conta.
tokenId: string – O ID do token.
endorsers: string[] – Um array dos pares (por exemplo, peer1, peer2) que deve endossar a transação.

Exemplo de Valor de Retorno:

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

Nome do método original: bulkTransferTokens

Esse método transfere tokens em massa da conta do chamador para as contas especificadas no objeto flow. As quantidades devem estar dentro dos valores decimais especificados pelo parâmetro decimal do comportamento divisible no arquivo de especificação.

Payload:

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

Parâmetros:

token_id: string – O ID do token.
flow : object[] – Um array de objetos JSON que especificam receptores e quantidades.
- to_orgId: string – O ID do provedor de serviços de associação (MSP) do destinatário na organização atual.
- userId: string – O nome de usuário ou ID de e-mail do destinatário.
- quantity: number – O número de tokens a serem transferidos.
Você especifica o parâmetro flow em outro formato se estiver usando o Visual Studio Code versus a CLI ou uma coleção Postman.
Visual Studio Code:
```
[
  { "to_org_id": "Org1MSP", "to_user_id": "user1", "quantity": 10 },
  { "to_org_id": "Org1MSP", "to_user_id": "user2", "quantity": 10 }
]
```
CLI/Postman:
```
"[{ \"to_org_id\": \"Org1MSP\", \"to_user_id\": \"user1\", \"quantity\": 10 }, { \"to_org_id\": \"Org1MSP\", \"to_user_id\": \"user2\", \"quantity\": 10 }]"
```
endorsers: string[] – Um array dos pares (por exemplo, peer1, peer2) que deve endossar a transação.

Exemplo de Valor de Retorno:

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

Nome do método original: createAccount

Este método cria uma conta para um usuário e token especificados. É necessário criar uma conta para qualquer usuário que tenha tokens a qualquer momento. As contas rastreiam saldos, saldos em retenção e histórico de transações. Um ID de conta é formado pela concatenação do tipo de ativo, do ID do token e de um hash SHA-256 do ID do usuário e do ID da organização (provedor de serviço de associação). Esse método só pode ser chamado por uma Token Admin do chaincode ou por uma Org Admin da organização especificada.

Payload:

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

Parâmetros:

orgId – O ID do provedor de serviços de associação (MSP) do usuário para o qual a conta será criada. O ID deve começar com um caractere alfanumérico e pode incluir letras, números e caracteres especiais, como sublinhados (_), pontos (.), sinais (@) e hifens (-).
userId – O nome de usuário ou ID de e-mail do usuário. O ID deve começar com um caractere alfanumérico e pode incluir letras, números e caracteres especiais, como sublinhados (_), pontos (.), sinais (@) e hifens (-).
tokenType: TokenType – O tipo de token, que deve ser fungible.
dailyLimits: JSON object – Um objeto JSON do tipo a seguir.
```
{
     "max_daily_amount": 100000
     "max_daily_transactions": 10000
 }
```
No exemplo, o valor max_daily_amount é a quantidade máxima de tokens que podem ser transacionados diariamente e o valor max_daily_transactions é o número máximo de transações que podem ser concluídas diariamente.
endorsers: string[] – Um array dos pares (por exemplo, peer1, peer2) que deve endossar a transação.

Exemplo de Valor de Retorno:

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

Nome do método original: createApprovalPolicyCheck

Esse método cria uma nova política de aprovação, que define limites de transação e os aprovadores sequenciais necessários. Esse método só pode ser chamado por um Token Admin.

Payload:

{
    "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 – Uma classe que define regras de aprovação para uma transação, que inclui os seguintes campos:
- approvalPolicyId – O sistema gera esse ID. Você não fornece este campo manualmente.
- transactionLowerLimit – O valor mínimo da transação ao qual a política de aprovação se aplica.
- transactionUpperLimit – O valor máximo da transação ao qual a política de aprovação se aplica.
- numberOfApprovalsRequired – O número total de aprovações necessárias para que a transação possa ser concluída.
- approverDetails – Uma lista de aprovadores junto com sua sequência de aprovação atribuída, que define a ordem obrigatória para aprovações.
endorsers: string[] – Um array dos pares (por exemplo, peer1, peer2) que deve endossar a transação.

Exemplo de Valor de Retorno:

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

Nome do método original: createAccountPolicyCheck

Este método cria uma política para uma conta especificada. Esse método só pode ser chamado por uma Token Admin ou Org Admin da organização especificada.

Payload:

{
    "asset": "{\"accountPolicyId\":\"accountPolicyId value\",\"orgId\":\"{{bc-org-id}}\",\"userId\":\"{{bc-user-id}}\",\"kycCompliance\":\"kycCompliance value\",\"amlCompliance\":\"amlCompliance value\",\"riskScore\":999,\"restrictionFlag\":\"restrictionFlag value\"}",
    "endorsers": {{endorsers}}
}

Parâmetros:

asset: AccountPolicyCheck class – Uma classe que define parâmetros de política de conta, que inclui os seguintes campos:
- accountPolicyId – O sistema gera esse ID a partir dos campos orgId e userId especificados. Você não fornece este campo manualmente.
- orgId – O ID do provedor de serviços de associação (MSP) do usuário para o qual a política será criada.
- userId – O nome de usuário ou o ID de e-mail do usuário para o qual a política será criada.
- kycCompliance – Um valor booliano que indica se a conta atende aos requisitos de KYC (Know Your Customer).
- amlCompliance – Um valor booliano que indica se a conta atende aos requisitos de AML (Anti-Money Laundering).
- riskScore – A pontuação de risco associada à conta, que é usada para avaliação de conformidade.
- restrictionFlag – Um valor booliano que indica se a conta está sujeita a transferências restritas. Se definido como true, somente transferências dentro do limite de política de aprovação mais baixo serão permitidas.
- endorsers: string[] – Um array dos pares (por exemplo, peer1, peer2) que deve endossar a transação.

Exemplo de Valor de Retorno:

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

Nome do método original: deleteApprovalPolicyCheck

Este método exclui a política de aprovação de um ID de política especificado. Esse método só pode ser chamado por um Token Admin.

Payload:

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

Parâmetros:

id: string – O ID da política de aprovação exclusivo.
endorsers: string[] – Um array dos pares (por exemplo, peer1, peer2) que deve endossar a transação.

Exemplo de Valor de Retorno:

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

Nome do método original: deleteAccount

Este método exclui uma conta de token fungível. Ele retornará um erro se o valor accountStatus da conta não for encontrado no razão. Esse método só pode ser chamado por um Token Admin.

Payload:

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

Parâmetros:

tokenId: string – O ID do token.
orgId: string – O ID do provedor de serviços de associação (MSP) do usuário na organização atual.
userId: string – O nome de usuário ou ID de e-mail do usuário.
endorsers: string[] – Um array dos pares (por exemplo, peer1, peer2) que deve endossar a transação.

Exemplo de Valor de Retorno:

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

Nome do método original: deleteAccountPolicyCheck

Este método exclui a política de um ID de política especificado. Esse método só pode ser chamado por uma Token Admin ou Org Admin da organização especificada.

Payload:

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

Parâmetros:

id: string – O ID exclusivo da política da conta.
endorsers: string[] – Um array dos pares (por exemplo, peer1, peer2) que deve endossar a transação.

Exemplo de Valor de Retorno:

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

Nome do método original: executeHoldTokens

Este método aprova uma retenção de tokens, o que aciona a transferência dos tokens do remetente para o destinatário. A quantidade de tokens colocados em espera anteriormente pelo proprietário do token agora é transferida para o destinatário. Se o valor quantity for menor que o valor de retenção real, o valor restante será disponibilizado novamente para o proprietário do token. Se o comportamento roles for especificado na seção behaviors do modelo de token e o valor notary_role_name estiver definido, a conta do chamador deverá ter a atribuição de notário. Caso contrário, qualquer chamador com uma conta pode funcionar como um notário.

Payload:

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

Parâmetros:

tokenId: string – O ID do token.
operationId: string – O ID de operação exclusivo da solicitação de mint a ser aprovada.
quantity: number – O número de tokens retidos a serem transferidos.
endorsers: string[] – Um array dos pares (por exemplo, peer1, peer2) que deve endossar a transação.

Exemplo de Valor de Retorno:

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

Nome do método original: getAccountTransactionHistory

Este método retorna um array de detalhes do histórico de transações da conta para um usuário e token especificados. Esse método só pode ser chamado por uma Token Admin ou Token Auditor do chaincode, uma Org Admin ou Org Auditor da organização especificada ou a AccountOwner da conta.

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

Parâmetros:

tokenId: string – O ID do token.
orgId: string – O ID do provedor de serviços de associação (MSP) do usuário na organização atual.
userId: string – O nome de usuário ou ID de e-mail do usuário.

Exemplo de Valor de Retorno:

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

Nome do método original: getAllAccounts

Esse método retorna uma lista de todas as contas. Esse método só pode ser chamado por uma Token Admin ou Token Auditor.

Payload:

{{api-gateway-endpoint1}}/getAllAccounts

Parâmetros:

nenhuma

Exemplo de Valor de Retorno:

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

Nome do método original: getAllOrgAccounts

Este método retorna uma lista de todas as contas de token que pertencem a uma organização especificada. Esse método só pode ser chamado por uma Token Admin, Token Auditor ou por uma Org Admin ou Org Auditor da organização especificada.

Payload:

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

Parâmetros:

orgId: string – O ID do provedor de serviços de associação (MSP) da organização.

Exemplo de Valor de Retorno:

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

Nome do método original: getAllTokenAdmins

Esse método retorna uma lista de todos os usuários que são um Token Admin. Esse método só pode ser chamado pelo Token Admin ou pelo Token Auditor.

Payload:

{{api-gateway-endpoint1}}/getAllTokenAdmins

Parâmetros:

nenhuma

Exemplo de Valor de Retorno:

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

getAllTokens

Nome do método original: getAllTokens

Este método retorna todos os tokens que são armazenados no banco de dados de estado. Esse método só pode ser chamado por uma Token Admin, Token Auditor, Org Admin ou Org Auditor. Este método usa consultas ricas em SQL do Berkeley DB e só pode ser chamado quando conectado à rede remota do Oracle Blockchain Platform.

Payload:

{{api-gateway-endpoint1}}/getAllTokens

Parâmetros:

nenhuma

Exemplo de Valor de Retorno:

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

Nome do método original: getApprovalPolicyCheckById

Este método obtém os detalhes da política de aprovação para um ID de política especificado. Esse método só pode ser chamado por uma Token Admin ou Token Auditor.

Payload:

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

Parâmetros:

id: string – O ID da política de aprovação exclusivo.

Exemplo de Valor de Retorno:

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

getApprovalTransactionsById

Nome do método original: getApprovalTransactionsById

Este método obtém a transação de aprovação de um ID de transação especificado. Esse método só pode ser chamado por uma Token Admin ou Org Admin da organização associada.

Payload:

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

Parâmetros:

id: string – O ID gerado pelo sistema da transação de aprovação.

Exemplo de Valor de Retorno:

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

Nome do método original: getApproverDetailsByTransferAmount

Este método obtém os detalhes do aprovador que são necessários para um determinado valor de transferência. Esse método só pode ser chamado por uma Token Admin ou Token Auditor.

Payload:

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

Parâmetros:

amount: number – O valor da transferência.
endorsers: string[] – Um array dos pares (por exemplo, peer1, peer2) que deve endossar a transação.

Exemplo de Valor de Retorno:

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

Nome do método original: getMaxDailyAmount

Este método obtém o valor máximo de transação cumulativa diária para uma conta especificada. Esse método só pode ser chamado por um Token Admin ou Token Auditor do chaincode ou por um Org Admin ou Org Auditor da organização especificada.

Payload:

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

Parâmetros:

tokenId: string – O ID do token.
orgId: string – O ID do provedor de serviços de associação (MSP) do usuário na organização atual.
userId: string – O nome de usuário ou ID de e-mail do usuário.

Exemplo de Valor de Retorno:

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

getMaxDailyTransactionCount

Nome do método original: getMaxDailyTransactionCount

Este método obtém o número máximo de transações diárias para uma conta especificada. Esse método só pode ser chamado por um Token Admin ou Token Auditor do chaincode ou por um Org Admin ou Org Auditor da organização especificada.

Payload:

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

Parâmetros:

tokenId: string – O ID do token.
orgId: string – O ID do provedor de serviços de associação (MSP) do usuário na organização atual.
userId: string – O nome de usuário ou ID de e-mail do usuário.

Exemplo de Valor de Retorno:

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

getNetTokens

Nome do método original: getNetTokens

Este método GET retorna o número líquido total de tokens disponíveis no sistema para um token especificado. O total de tokens líquidos é a quantidade de tokens restantes após os tokens serem gravados. Esse método só pode ser chamado por Token Admin ou Token Auditor, ou por Org Admin ou Org Auditor.

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

Parâmetros:

tokenId: string – O ID do token.

Exemplo de Valor de Retorno:

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

getOnHoldBalanceWithOperationId

Nome do método original: getOnHoldBalanceWithOperationId

Este método retorna o saldo em retenção para um ID e token de operação especificados. Este método só pode ser chamado por um Token Admin ou Token Auditor, ou pelo remetente, receptor ou notário associado à operação.

Payload:

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

Parâmetros:

tokenId: string – O ID do token.
operationId: string – Um ID exclusivo para identificar a operação de retenção. Geralmente, esse ID é passado pelo aplicativo cliente.

Exemplo de Valor de Retorno:

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

getOnHoldDetailsWithOperationId

Nome do método original: getOnHoldDetailsWithOperationId

Este método retorna os detalhes da transação em retenção para um ID e token de operação especificados. Este método só pode ser chamado por um Token Admin ou Token Auditor, ou pelo remetente, receptor ou notário associado à operação.

Payload:

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

Parâmetros:

tokenId: string – O ID do token.
operationId: string – Um ID exclusivo para identificar a operação de retenção. Geralmente, esse ID é passado pelo aplicativo cliente.

Exemplo de Valor de Retorno:

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

Nome do método original: getOnHoldIds

Este método GET retorna uma lista de todos os IDs de retenção de uma conta especificada. Esse método só pode ser chamado por uma Token Admin ou Token Auditor do chaincode, uma Org Admin ou Org Auditor da organização especificada ou a AccountOwner da conta.

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

Parâmetros:

tokenId: string – O ID do token.
orgId: string – O ID do provedor de serviços de associação (MSP) do usuário na organização atual.
userId: string – O nome de usuário ou ID de e-mail do usuário.

Exemplo de Valor de Retorno:

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

Nome do método original: getOrgAccountsByRole

Este método retorna informações sobre todas as contas que têm uma função especificada em uma organização especificada. Esse método só pode ser chamado por uma Token Admin ou Token Auditor, ou por uma Org Admin ou Org Auditor da organização especificada.

Payload:

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

Parâmetros:

tokenId: string – O ID do token.
role: string – O nome da atribuição a ser verificada.
orgId: string – O ID do provedor de serviços de associação (MSP) do usuário na organização atual.

Exemplo de Valor de Retorno:

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

getOrgAdmins

Nome do método original: getOrgAdmins

Esse método retorna uma lista de todos os usuários que são um Org Admin de uma organização. Esse método só pode ser chamado por uma Token Admin ou Token Auditor, ou por uma Org Admin ou Org Auditor da organização associada.

Payload:

{{api-gateway-endpoint1}}/getOrgAdmins

Parâmetros:

nenhuma

Exemplo de Valor de Retorno:

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

getOrgAuditors

Nome do método original: getOrgAuditors

Esse método retorna uma lista de todos os usuários que são um Org Auditor de uma organização. Esse método só pode ser chamado por uma Token Admin ou Token Auditor, ou por uma Org Admin ou Org Auditor da organização associada.

Payload:

{{api-gateway-endpoint1}}/getOrgAuditors

Parâmetros:

nenhuma

Exemplo de Valor de Retorno:

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

getOrgUsersByRole

Nome do método original: getOrgUsersByRole

Este método retorna informações sobre todos os usuários que têm uma função especificada em uma organização especificada. Esse método só pode ser chamado por uma Token Admin ou Token Auditor, ou por uma Org Admin ou Org Auditor da organização especificada.

Payload:

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

Parâmetros:

tokenId: string – O ID do token.
role: string – O nome da atribuição a ser verificada.
orgId: string – O ID do provedor de serviços de associação (MSP) do usuário na organização atual.

Exemplo de Valor de Retorno:

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

getStablecoinAccount

Nome do método original: getAccount

Este método GET retorna detalhes da conta para um usuário e token especificados. Esse método só pode ser chamado por uma Token Admin ou Token Auditor do chaincode, uma Org Admin ou Org Auditor da organização especificada ou a AccountOwner da conta.

Consulta:

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

Parâmetros:

tokenId: string – O ID do token.
orgId: string – O ID do provedor de serviços de associação (MSP) do usuário na organização atual.
userId: string – O nome de usuário ou ID de e-mail do usuário.

Exemplo de Valor de Retorno:

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

Nome do método original: getAccountBalance

Este método GET retorna o saldo atual de uma conta e token especificados. Esse método só pode ser chamado por uma Token Admin ou Token Auditor do chaincode, uma Org Admin ou Org Auditor da organização especificada ou a AccountOwner da conta.

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

Parâmetros:

tokenId: string – O ID do token.
orgId: string – O ID do provedor de serviços de associação (MSP) do usuário na organização atual.
userId: string – O nome de usuário ou ID de e-mail do usuário.

Exemplo de Valor de Retorno:

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

getStablecoinAccountOnHoldBalance

Nome do método original: getAccountOnHoldBalance

Este método retorna o saldo atual em retenção para uma conta e um token especificados. Esse método só pode ser chamado por uma Token Admin ou Token Auditor, uma Org Admin ou Org Auditor da organização especificada ou pelo proprietário da conta.

Payload:

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

Parâmetros:

tokenId: string – O ID do token.
orgId: string – O ID do provedor de serviços de associação (MSP) do usuário na organização atual.
userId: string – O nome de usuário ou ID de e-mail do usuário.

Exemplo de Valor de Retorno:

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

getStablecoinAccountOnHoldBurnBalance

Nome do método original: getAccountOnHoldBurnBalance

Este método retorna o saldo de gravação em espera para um usuário especificado. Esse método só pode ser chamado por uma Token Admin ou Token Auditor, uma Org Admin ou Org Auditor da organização especificada ou pelo proprietário da conta.

Payload:

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

Parâmetros:

tokenId: string – O ID do token.
orgId: string – O ID do provedor de serviços de associação (MSP) do usuário na organização atual.
userId: string – O nome de usuário ou ID de e-mail do usuário.

Exemplo de Valor de Retorno:

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

getStablecoinAccountPolicyCheckById

Nome do método original: getAccountPolicyCheckById

Este método obtém os detalhes da política de conta para um ID de política especificado. Esse método só pode ser chamado por uma Token Admin ou Token Auditor, ou por uma Org Admin ou Org Auditor da organização especificada.

Payload:

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

Parâmetros:

id: string – O ID exclusivo da política da conta.

Exemplo de Valor de Retorno:

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

Nome do método original: getAccountsByRole

Este método retorna uma lista de todos os IDs de conta para uma função e token especificados. Esse método só pode ser chamado por uma Token Admin ou Token Auditor.

Payload:

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

Parâmetros:

tokenId: string – O ID do token.
role: string – O nome da atribuição a ser verificada.

Exemplo de Valor de Retorno:

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

getStablecoinAccountsByUser

Nome do método original: getAccountsByUser

Este método retorna uma lista de todos os IDs de conta para um ID organização e ID usuário especificados. Esse método só pode ser chamado por uma Token Admin ou Token Auditor do chaincode, uma Org Admin ou Org Auditor da organização especificada ou a AccountOwner da conta.

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

Parâmetros:

orgId: string – O ID do provedor de serviços de associação (MSP) do usuário na organização atual.
userId: string – O nome de usuário ou ID de e-mail do usuário.

Exemplo de Valor de Retorno:

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

Nome do método original: getAccountStatus

Este método obtém o status atual da conta de token. Esse método pode ser chamado pelo Token Admin ou Token Auditor, por um Org Admin ou Org Auditor da organização especificada ou pelo proprietário da conta de token. Se o valor accountStatus não for encontrado no razão, esse método retornará um objeto accountStatus com o status definido como ativo.

Payload:

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

Parâmetros:

tokenId: string – O ID do token.
orgId: string – O ID do provedor de serviços de associação (MSP) do usuário na organização atual.
userId: string – O nome de usuário ou ID de e-mail do usuário.

Exemplo de Valor de Retorno:

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

getStablecoinAccountTransactionHistoryWithFilters

Nome do método original: getAccountTransactionHistoryWithFiltersFromRichHistDB

Este método retorna os detalhes do histórico de transações da conta do banco de dados do histórico avançado. Esse método só pode ser chamado por uma Token Admin ou Token Auditor do chaincode, uma Org Admin ou Org Auditor da organização especificada ou a AccountOwner da conta.

/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 – O ID do token.
orgId: string – O ID do provedor de serviços de associação (MSP) do usuário na organização atual.
userId: string – O nome de usuário ou ID de e-mail do usuário.
customEndpoint – O ponto final do serviço RESTful do banco de dados de histórico avançado do qual extrair o histórico de transações.
bearerToken – O token a ser usado para chamar o ponto final RESTful para garantir que a solicitação seja autorizada.
filters: JSON object – Um parâmetro opcional. Se estiver vazio, todos os registros serão retornados. A propriedade pageSize determina o número de registros a serem retornados. Se pageSize for 0, o tamanho padrão da página será 20. A propriedade bookmark determina o índice inicial dos registros a serem retornados. As propriedades startTime e endTime devem ser especificadas no formato RFC-3339.

Exemplo de Valor de Retorno:

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

Nome do método original: getTokenAuditors

Este método retorna todos os Token Auditors do chaincode. Esse método só pode ser chamado por uma Token Admin ou Token Auditor.

Payload:

 	
{{api-gateway-endpoint1}}/getTokenAuditors

Parâmetros:

nenhuma

Exemplo de Valor de Retorno:

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

getTokenById

Nome do método original: getTokenById

Este método retorna os detalhes do token para um ID de token especificado. Esse método só pode ser chamado por uma Token Admin ou Token Auditor, ou por uma Org Admin ou Org Auditor de qualquer organização.

Payload:

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

Parâmetros:

tokenId: string – O ID do token.

Exemplo de Valor de Retorno:

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

Nome do método original: getTokenHistory

Este método retorna o histórico de token para um ID de token especificado. Esse método só pode ser chamado por uma Token Admin ou Token Auditor, ou por uma Org Admin ou Org Auditor de qualquer organização.

Payload:

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

Parâmetros:

tokenId: string – O ID do token.

Exemplo de Valor de Retorno:

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

Nome do método original: getTotalMintedTokens

Este método retorna o número total de tokens cunhados para um token especificado. Esse método só pode ser chamado por uma Token Admin, Token Auditor, Org Admin ou Org Auditor.

Consulta:

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

Parâmetros:

tokenId: string – O ID do token.

Exemplo de Valor de Retorno:

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

getTransactionById

Nome do método original: getTransactionById

Este método retorna o registro de transação detalhado de um ID de transação especificado. Este método só pode ser chamado pelo Token Admin ou por qualquer conta especificada pela transação (remetente, destinatário ou notário).

Payload:

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

Parâmetros:

transaction_id string – O ID da transação.

Exemplo de Valor de Retorno:

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

Nome do método original: getUserByAccountId

Esse método retorna detalhes do usuário (org_id, user_id e token_id) para uma conta especificada. Esse método só pode ser chamado por um Token Admin ou Token Auditor do chaincode, ou um Org Admin ou Org Auditor da organização especificada.

Consulta:

/getUserByStablecoinAccountId?accountId=account_id value

Parâmetros:

accountId: string – O ID da conta.

Exemplo de Valor de Retorno:

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

getUsersByRole

Nome do método original: getUsersByRole

Este método GET retorna uma lista de todos os usuários para uma atribuição e um token especificados. Esse método só pode ser chamado por uma Token Admin ou Token Auditor do chaincode.

Consulta:

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

Parâmetros:

tokenId: string – O ID do token.
role: string – O nome da função a ser pesquisada.

Exemplo de Valor de Retorno:

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

Nome do método original: holdTokens

Esse método cria uma retenção em nome do proprietário dos tokens com a conta to_account_id. Uma conta do notário é especificada, que é responsável por concluir ou liberar a retenção. Quando a retenção é criada, o saldo de token especificado do pagador é colocado em retenção. Um saldo retido não pode ser transferido até que a retenção seja concluída ou liberada. O chamador desse método deve ter uma conta já criada.

Payload:

{
    "tokenId": "{{bc-token-id}}",
    "operationId": "operation_id value",
    "toOrgId": "to_org_id value",
    "toUserId": "to_user_id value",
    "notaryOrgId": "notary_org_id value",
    "notaryUserId": "notary_user_id value",
    "quantity": 1,
    "timeToExpiration": "time_to_expiration value",
    "infoDetails": "{\"category\":\"category value\",\"description\":\"description value\"}",
    "endorsers": {{endorsers}}
}

Parâmetros:

tokenId: string – O ID do token.
operationId: string – Um ID exclusivo para identificar a operação de retenção. Geralmente, esse ID é passado pelo aplicativo cliente.
toOrgId: string – O ID do provedor de serviços de associação (MSP) do destinatário na organização atual.
toUserId: string – O nome de usuário ou ID de e-mail do destinatário.
notaryOrgId: string – O ID do notário do provedor de serviços de associação (MSP) na organização atual.
notaryUserId: string – O nome de usuário ou ID de e-mail do notário.
quantity: number – O número de tokens a serem colocados em espera.
timeToExpiration – O horário em que a retenção expira. Especifique 0 para uma retenção permanente. Caso contrário, use o formato RFC-3339. Por exemplo, 2021-06-02T12:46:06Z.
infoDetails: JSON – A descrição e a categoria, conforme mostrado no exemplo a seguir.
```
{
   "category" : "category input",
   "description" : "description input"
}
```
endorsers: string[] – Um array dos pares (por exemplo, peer1, peer2) que deve endossar a transação.

Exemplo de Valor de Retorno:

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

Nome do método original: init

Este método é chamado quando o chaincode é implantado. As informações do usuário são salvas como o Token Admin do chaincode.

Payload:

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

Parâmetros:

adminList: TokenAdminAsset[] – Um array de objetos JSON que contêm um ID de organização e um ID de usuário que especifica o administrador de token, com o seguinte formato:
```
{
   "org_id":"{{bc-org-id}}",
   "user_id":"{{bc-admin-user}
}
```

Exemplo de Valor de Retorno:

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

initializeStablecoinToken

Nome do método original: initializeStablecoinToken

Esse método cria um token e inicializa as propriedades do token. O ativo e suas propriedades são salvos no banco de dados de estado. Esse método só pode ser chamado por um Token Admin do chaincode.

Payload:

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

Parâmetros:

tokenAsset: <Token Class> – O ativo de token é passado como parâmetro para esse método. As propriedades do ativo de token são descritas no arquivo de modelo.
sameOrgEndorser: boolean – Um valor booliano que indica se os endossos da transação devem ser da mesma organização que o solicitante.

Retorna:

No caso de sucesso, uma representação JSON do ativo de token que foi criado.

Exemplo de Valor de Retorno:

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

Nome do método original: isInRole

Este método retorna um valor Booliano para indicar se um usuário e um token têm uma função especificada. Esse método só pode ser chamado por um Token Admin ou pelo proprietário da conta.

Payload:

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

Parâmetros:

tokenId: string – O ID do token.
orgId: string – O ID do provedor de serviços de associação (MSP) do usuário.
userId: string – O nome de usuário ou ID de e-mail do usuário.
role: string – O nome da função.

Exemplo de Valor de Retorno:

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

isTokenAdmin

Nome do método original: isTokenAdmin

Esse método retornará o valor Booliano true se a conta especificada for uma Token Admin; caso contrário, retornará false. O método THis só pode ser chamado por um Token Admin.

Payload:

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

Parâmetros:

orgId: string – O ID do provedor de serviços de associação (MSP) do usuário na organização atual.
userId: string – O nome de usuário ou ID de e-mail do usuário.

Exemplo de Valor de Retorno:

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

rejectBurn

Nome do método original: rejectBurn

Este método pode ser chamado por um notário para rejeitar uma solicitação de gravação.

Payload:

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

Parâmetros:

tokenId: string – O ID do token a ser rejeitado para gravação.
operationId: string – O ID de operação exclusivo que representa a solicitação de gravação.
sameOrgEndorser: boolean – Um valor booliano que indica se os endossos da transação devem ser da mesma organização que o solicitante.

Exemplo de Valor de Retorno:

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

Nome do método original: rejectMint

Este método pode ser chamado por um notário para rejeitar uma solicitação de cunhagem.

Payload:

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

Parâmetros:

tokenId: string – O ID do token para rejeitar a cunhagem.
operationId: string – O ID de operação exclusivo que representa a solicitação de hortelã.
sameOrgEndorser: boolean – Um valor booliano que indica se os endossos da transação devem ser da mesma organização que o solicitante.

Exemplo de Valor de Retorno:

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

Nome do método original: releaseHoldTokens

Este método POST libera uma retenção de tokens. A transferência não foi concluída e todos os tokens retidos estão disponíveis novamente para o proprietário original. Esse método pode ser chamado pelo ID AccountOwner com a função notary dentro do limite de tempo especificado ou pelo pagador, favorecido ou notário após o limite de tempo especificado.

Payload:

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

Parâmetros:

tokenId: string – O ID do token.
operationId: string – Um ID exclusivo para identificar a operação de retenção. Geralmente, esse ID é passado pelo aplicativo cliente.
endorsers: string[] – Um array dos pares (por exemplo, peer1, peer2) que deve endossar a transação.

Exemplo de Valor de Retorno:

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

Nome do método original: removeOrgAdmin

Este método POST remove um usuário como um Org Admin do chaincode. Esse método só pode ser chamado por uma Token Admin ou Org Admin da organização especificada.

Payload:

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

Parâmetros:

orgId: string – O ID do provedor de serviços de associação (MSP) do usuário na organização atual.
userId: string – O nome de usuário ou ID de e-mail do usuário.
sameOrgEndorser: boolean – Um valor booliano que indica se os endossos da transação devem ser da mesma organização que o solicitante.

Exemplo de Valor de Retorno:

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

Nome do método original: removeOrgAuditor

Este método POST remove um usuário como um Org Auditor do chaincode. Esse método só pode ser chamado por uma Token Admin ou Org Admin da organização especificada.

Payload:

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

Parâmetros:

orgId: string – O ID do provedor de serviços de associação (MSP) do usuário na organização atual.
userId: string – O nome de usuário ou ID de e-mail do usuário.
sameOrgEndorser: boolean – Um valor booliano que indica se os endossos da transação devem ser da mesma organização que o solicitante.

Exemplo de Valor de Retorno:

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

Nome do método original: removeRole

Este método remove uma atribuição de um usuário e token especificados. Esse método só pode ser chamado por uma Token Admin do chaincode ou por uma Org Admin da organização especificada.

Payload:

{
    "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 – O ID do token.
role: string – O nome da atribuição a ser removida do usuário especificado. Os comportamentos mintable e burnable correspondem às propriedades minter_role_name e burner_role_name do arquivo de especificação. Da mesma forma, a atribuição notary corresponde à propriedade notary_role_name do arquivo de especificação.
orgId: string – O ID do provedor de serviços de associação (MSP) do usuário na organização atual.
userId: string – O nome de usuário ou ID de e-mail do usuário.
endorsers: string[] – Um array dos pares (por exemplo, peer1, peer2) que deve endossar a transação.

Retorna:

No caso de êxito, uma mensagem com detalhes da conta.

Exemplo de Valor de Retorno:

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

Nome do método original: removeTokenAdmin

Este método POST remove um usuário como um Token Admin do chaincode. Esse método só pode ser chamado por um Token Admin do chaincode. Um administrador não pode remover a si mesmo.

Payload:

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

Parâmetros:

orgId: string – O ID do provedor de serviços de associação (MSP) do usuário na organização atual.
userId: string – O nome de usuário ou ID de e-mail do usuário.
sameOrgEndorser: boolean – Um valor booliano que indica se os endossos da transação devem ser da mesma organização que o solicitante.

Exemplo de Valor de Retorno:

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

Nome do método original: removeTokenAuditor

Este método POST remove um usuário como um Token Auditor do chaincode. Esse método só pode ser chamado por um Token Admin do chaincode.

Payload:

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

Parâmetros:

orgId: string – O ID do provedor de serviços de associação (MSP) do usuário na organização atual.
userId: string – O nome de usuário ou ID de e-mail do usuário.
sameOrgEndorser: boolean – Um valor booliano que indica se os endossos da transação devem ser da mesma organização que o solicitante.

Exemplo de Valor de Retorno:

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

Nome do método original: requestBurn

Este método pode ser chamado por um queimador para enviar uma solicitação ao notário para destruir uma quantidade especificada de tokens.

Payload:

{
    "tokenId": "{{bc-token-id}}",
    "operationId": "operation_id value",
    "notaryOrgId": "notary_org_id value",
    "notaryUserId": "notary_user_id value",
    "quantity": 1,
    "timeToExpiration": "time_to_expiration value",
    "infoDetails": "{\"category\":\"category value\",\"description\":\"description value\"}",
    "sameOrgEndorser": true
}

Parâmetros:

tokenId: string – O ID do token a ser gravado.
operationId: string – O ID de operação exclusivo que representa a solicitação de gravação.
notaryOrgId: string – O ID do provedor de serviços de associação (MSP) do notário do queimador que processará a solicitação.
notaryUserId: string – O nome de usuário ou ID de email do notário do queimador que processará a solicitação.
quantity: number – A quantidade de tokens a serem gravados.
timeToExpiration – O tempo após o qual a solicitação de gravação expira e não é mais válida.
infoDetails: JSON – Um objeto que especifica a categoria (category) e a descrição (description) da solicitação, conforme mostrado no exemplo a seguir.
```
{
     "category" : "category input",
     "description" : "description input"
}
```
sameOrgEndorser: boolean – Um valor booliano que indica se os endossos da transação devem ser da mesma organização que o solicitante.

Exemplo de Valor de Retorno:

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

Nome do método original: requestMint

Este método pode ser chamado por um mineiro para enviar uma solicitação ao notário do mineiro para criar uma quantidade especificada de tokens.

Payload:

{
    "tokenId": "{{bc-token-id}}",
    "operationId": "operation_id value",
    "notaryOrgId": "notary_org_id value",
    "notaryUserId": "notary_user_id value",
    "quantity": 1,
    "timeToExpiration": "time_to_expiration value",
    "infoDetails": "{\"category\":\"category value\",\"description\":\"description value\"}",
    "sameOrgEndorser": true
}

Parâmetros:

tokenId: string – O ID do token para mint.
operationId: string – O ID de operação exclusivo que representa a solicitação de hortelã.
notaryOrgId: string – O ID do MSP (Membership Service Provider) do notário do mineiro que processará a solicitação.
notaryUserId: string – O nome de usuário ou o ID de email do notário do mineiro que processará a solicitação.
quantity: number – A quantidade de tokens para hortelã.
timeToExpiration – O tempo após o qual a solicitação de cunhagem expira e não é mais válida.
infoDetails: JSON – Um objeto que especifica a categoria (category) e a descrição (description) da solicitação, conforme mostrado no exemplo a seguir.
```
{
     "category" : "category input",
     "description" : "description input"
}
```
sameOrgEndorser: boolean – Um valor booliano que indica se os endossos da transação devem ser da mesma organização que o solicitante.

Exemplo de Valor de Retorno:

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

Nome do método original: setMaxDailyAmount

Este método POST é usado para definir o parâmetro maxDailyAmount nos detalhes da conta para o valor especificado. Esse método só pode ser chamado por uma Token Admin do chaincode ou por uma Org Admin da organização especificada.

Payload:

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

Parâmetros:

orgId: string – O ID do provedor de serviços de associação (MSP) do usuário na organização atual.
userId: string – O nome de usuário ou ID de e-mail do usuário.
tokenId: string – O ID do token.
maxDailyAmount: number – O valor máximo diário da conta especificada, que define o valor máximo que pode ser transacionado diariamente.
endorsers: string[] – Um array dos pares (por exemplo, peer1, peer2) que deve endossar a transação.

Exemplo de Valor de Retorno:

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

Nome do método original: setMaxDailyTransactionCount

Este método POST é usado para definir o parâmetro maxDailyTransactions nos detalhes da conta para o valor especificado. Esse método só pode ser chamado por uma Token Admin do chaincode ou por uma Org Admin da organização especificada.

Payload:

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

Parâmetros:

orgId: string – O ID do provedor de serviços de associação (MSP) do usuário na organização atual.
userId: string – O nome de usuário ou ID de e-mail do usuário.
tokenId: string – O ID do token.
maxDailyTransactions: number – O valor máximo diário da conta especificada, que define o número máximo de transações permitidas por dia.
endorsers: string[] – Um array dos pares (por exemplo, peer1, peer2) que deve endossar a transação.

Exemplo de Valor de Retorno:

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

Nome do método original: suspendAccount

Este método suspende uma conta de token fungível. Ele gerará um erro se um valor accountStatus não for encontrado no razão. Esse método só pode ser chamado por uma Token Admin do chaincode ou por uma Org Admin da organização especificada.

Payload:

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

Parâmetros:

tokenId: string – O ID do token.
orgId: string – O ID do provedor de serviços de associação (MSP) do usuário na organização atual.
userId: string – O nome de usuário ou ID de e-mail do usuário.
endorsers: string[] – Um array dos pares (por exemplo, peer1, peer2) que deve endossar a transação.

Exemplo de Valor de Retorno:

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

Nome do método original: transferTokens

Este método transfere tokens do chamador para uma conta especificada. O chamador do método deve ter uma conta. A quantidade deve estar dentro dos valores decimais especificados pelo parâmetro decimal do comportamento divisible no arquivo de especificação.

Payload:

{
    "tokenId": "{{bc-token-id}}",
    "toOrgId": "to_org_id value",
    "toUserId": "to_user_id value",
    "quantity": 1,
    "infoDetails": "{\"category\":\"category value\",\"description\":\"description value\"}",
    "endorsers": {{endorsers}}
}

Parâmetros:

tokenId: string – O ID do token.
toOrgId: string – O ID do provedor de serviços de associação (MSP) do destinatário (favorecido) na organização atual.
toUserId: string – O nome de usuário ou ID de e-mail do destinatário.
quantity: number – O número de tokens a serem transferidos.
infoDetails: JSON – Um objeto que especifica a categoria (category) e a descrição (description) da solicitação, conforme mostrado no exemplo a seguir.
```
{
     "category" : "category input",
     "description" : "description input"
}
```
endorsers: string[] – Um array dos pares (por exemplo, peer1, peer2) que deve endossar a transação.

Exemplo de Valor de Retorno:

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

Nome do método original: updateAccountPolicyCheck

Este método atualiza a política de uma conta especificada. Esse método só pode ser chamado por uma Token Admin ou Org Admin da organização especificada.

Payload:

{
    "asset": "{\"accountPolicyId\":\"accountPolicyId value\",\"orgId\":\"{{bc-org-id}}\",\"userId\":\"{{bc-user-id}}\",\"kycCompliance\":\"kycCompliance value\",\"amlCompliance\":\"amlCompliance value\",\"riskScore\":999,\"restrictionFlag\":\"restrictionFlag value\"}",
    "endorsers": {{endorsers}}
}

Parâmetros:

asset: AccountPolicyCheck object – Um objeto que define parâmetros de política de conta, que inclui os seguintes campos:
- accountPolicyId – O ID exclusivo da política da conta.
- orgId – O ID do provedor de serviços de associação (MSP) do usuário para o qual a política será criada.
- userId – O nome de usuário ou o ID de e-mail do usuário para o qual a política será criada.
- kycCompliance – Um valor booliano que indica se a conta atende aos requisitos de KYC (Know Your Customer).
- amlCompliance – Um valor booliano que indica se a conta atende aos requisitos de AML (Anti-Money Laundering).
- riskScore – A pontuação de risco associada à conta, que é usada para avaliação de conformidade.
- restrictionFlag – Um valor booliano que indica se a conta está sujeita a transferências restritas. Se definido como true, somente transferências dentro do limite de política de aprovação mais baixo serão permitidas.
endorsers: string[] – Um array dos pares (por exemplo, peer1, peer2) que deve endossar a transação.

Exemplo de Valor de Retorno:

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

Nome do método original: updateApprovalPolicyCheck

Este método atualiza a política de aprovação. Esse método só pode ser chamado por um Token Admin.

Payload:

{
    "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 – Uma classe que define regras de aprovação para uma transação, que inclui os seguintes campos:
- approvalPolicyId – O ID da política de aprovação exclusivo.
- transactionLowerLimit – O valor mínimo da transação ao qual a política de aprovação se aplica.
- transactionUpperLimit – O valor máximo da transação ao qual a política de aprovação se aplica.
- numberOfApprovalsRequired – O número total de aprovações necessárias para que a transação possa ser concluída.
- approverDetails – Uma lista de aprovadores junto com sua sequência de aprovação atribuída, que define a ordem obrigatória para aprovações.
endorsers: string[] – Um array dos pares (por exemplo, peer1, peer2) que deve endossar a transação.

Exemplo de Valor de Retorno:

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

Nome do método original: updateStablecoinToken

Este método atualiza um token stablecoin. Esse método só pode ser chamado por um Token Admin.

Payload:

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

Parâmetros:

asset <Token Class> – O ativo de token é passado como parâmetro para esse método. As propriedades do ativo de token podem variar e são descritas no arquivo de especificação de token. Não inclua parâmetros marcados como somente leitura no arquivo de especificação.
Você especifica o parâmetro asset em outro formato se estiver usando o Visual Studio Code versus a CLI ou uma coleção Postman.

Visual Studio Code: Use a GUI para passar parâmetros individuais que correspondem aos campos de classe de token.

CLI / Postman: Informe uma string JSON serializada que inclua os campos de especificação de token, conforme mostrado no exemplo a seguir.

"{\"token_id\":\"USD\",\"token_desc\":\"token_desc value\",\"Currency_Name\":\"Currency_Name value\"}"
endorsers: string[] – Um array dos pares (por exemplo, peer1, peer2) que deve endossar a transação.

Exemplo de Valor de Retorno:

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

Nome do método original: createStablecoinAccount

Essa API wrapper personalizada combina APIs chaincode e APIs de console do Oracle Blockchain Platform em um ponto final. Este método conclui as seguintes etapas em sequência.

Cria um ID de inscrição para um usuário no proxy REST da instância. Se já existir uma matrícula para o ID usuário, a matrícula não será criada novamente. O ID da inscrição é igual ao ID usuário. O ID da inscrição pode conter somente caracteres alfanuméricos, hifens (-) e sublinhados (_). Se o ID usuário contiver outros caracteres especiais, eles serão substituídos por sublinhados (_).
Cria uma conta no razão.
Associa a nova conta ao token especificado.
Atribui a atribuição especificada ao usuário.

Se qualquer uma das etapas falhar, a inscrição será excluída automaticamente.

Payload:

{
    "orgId": "{{bc-org-id}}",
    "userId": "{{bc-user-id}}",
    "tokenId": "{{bc-token-id}}",
    "role": "role value (for example minter / burner / notary / tokenAdmin / tokenAuditor / orgAdmin / orgAuditor)",
    "dailyLimits": "{\"max_daily_amount\":1000, \"max_daily_transactions\":100}"
}

Parâmetros:

orgId – O ID do provedor de serviços de associação (MSP) do usuário para o qual a conta será criada. O ID deve começar com um caractere alfanumérico e pode incluir letras, números e caracteres especiais, como sublinhados (_), pontos (.), sinais (@) e hifens (-).
userId – O nome de usuário ou ID de e-mail do usuário. O ID deve começar com um caractere alfanumérico e pode incluir letras, números e caracteres especiais, como sublinhados (_), pontos (.), sinais (@) e hifens (-).
tokenId: string – O ID do token, que deve começar com um caractere alfanumérico e pode incluir letras, números e os caracteres especiais sublinhado (_) e hífen (-). Não pode exceder 16 caracteres de comprimento.
role: string – O nome da função a ser adicionada ao usuário especificado, que deve ser um dos seguintes valores: minter, burner, notary, tokenAdmin, tokenAuditor, orgAdmin ou orgAuditor.
dailyLimits: JSON object – Um objeto JSON do tipo a seguir.
```
{
     "max_daily_amount": 100000
     "max_daily_transactions": 10000
 }
```
No exemplo, o valor max_daily_amount é a quantidade máxima de tokens que podem ser transacionados diariamente e o valor max_daily_transactions é o número máximo de transações que podem ser concluídas diariamente.

Retorna:

No caso de sucesso, um objeto JSON da conta que foi criada.

Exemplo de Valor de Retorno:

"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

Nome do método original: createIDCSUser

Esse método POST cria um usuário do Identity Cloud Service na tenancy especificada pelo URL no arquivo terraform.tfvars e designa o usuário ao grupo de usuários especificado.

Payload:

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

Parâmetros:

userName: string – O ID do usuário.
firstName: string – O primeiro nome do usuário.
lastName: string – O último nome do usuário.
email: string – O endereço de e-mail do usuário.
groupName: string – O nome do grupo do Identity Cloud Service a ser designado ao usuário.

Exemplo de Valor de Retorno:

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