Stablecoin 래퍼 API 패키지
Oracle Blockchain Platform Digital Assets Edition에는 REST API를 확장하여 Stablecoin의 라이프 사이클과 관련된 작업을 지원하는 래퍼 API 패키지가 포함되어 있습니다.
래퍼 API 패키지는 API 게이트웨이 서비스와 OCI 함수를 사용하여 안정적인 코인 라이프 사이클을 관리하기 위한 API 라우트를 배포합니다. Stablecoin 래퍼 API 패키지는 Oracle Blockchain Platform 콘솔에서 다운로드할 수 있으며 배치에 필요한 Terraform 스크립트를 포함하여 래퍼 API 패키지가 포함된 아카이브 파일을 포함합니다. 이 파일을 OCI(Oracle Cloud Infrastructure)의 리소스 관리자 스택에 배치하여 래퍼 API에 필요한 Oracle 리소스를 생성합니다. 또한 배치된 래퍼 API를 테스트할 수 있는 Postman 컬렉션이 포함되어 있습니다. 컬렉션에는 래퍼 API 패키지에 정의된 API에 해당하는 끝점 및 페이로드가 포함된 미리 구성된 요청이 포함됩니다.
래퍼 API
-
activateStablecoinAccount - 원래 메소드 이름:
activateAccount - 이 POST 메소드는 대체 가능한 토큰 계정을 활성화합니다. 이 메소드는 지정된 조직의
Token Admin또는Org Admin에 의해서만 호출될 수 있습니다. 삭제된 계정은 활성화할 수 없습니다. - 페이로드:
{ "tokenId": "{{bc-token-id}}", "orgId": "{{bc-org-id}}", "userId": "{{bc-user-id}}", "endorsers": {{endorsers}} } - 매개변수:
tokenId: string– 토큰 ID입니다.orgId: string– 현재 조직에 있는 사용자의 멤버쉽 서비스 공급자(MSP) ID입니다.userId: string– 사용자의 사용자 이름 또는 전자메일 ID입니다.endorsers: string[]– 트랜잭션을 보증해야 하는 피어의 배열(예:peer1,peer2)입니다.
- 반환값:
- 성공 시 지정된 토큰 계정에 대한 계정 상태 객체의 JSON 표현입니다.
- 반환 값 예제:
{ "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 - 원래 메소드 이름:
addOrgAdmin - 이 메소드는 토큰 체인 코드에 조직 관리자를 추가합니다. 이 메소드는 지정된 조직의
Token Admin또는Org Admin에 의해서만 호출될 수 있습니다. - 페이로드:
{ "orgId": "{{bc-org-id}}", "userId": "{{bc-user-id}}", "sameOrgEndorser": true } - 매개변수:
orgId: string– 현재 조직에 있는 사용자의 멤버쉽 서비스 공급자(MSP) ID입니다.userId: string– 사용자의 사용자 이름 또는 전자메일 ID입니다.sameOrgEndorser: boolean– 트랜잭션 보증이 요청자와 동일한 조직에서 온 것인지 여부를 나타내는 부울 값입니다.
- 반환 값 예제:
{ "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 - 원래 메소드 이름:
addOrgAuditor - 이 방법은 조직 감사자를 토큰 체인 코드에 추가합니다. 이 메소드는 지정된 조직의
Token Admin또는Org Admin에 의해서만 호출될 수 있습니다. - 페이로드:
{ "orgId": "{{bc-org-id}}", "userId": "{{bc-user-id}}", "sameOrgEndorser": true } - 매개변수:
orgId: string– 현재 조직에 있는 사용자의 멤버쉽 서비스 공급자(MSP) ID입니다.userId: string– 사용자의 사용자 이름 또는 전자메일 ID입니다.sameOrgEndorser: boolean– 트랜잭션 보증이 요청자와 동일한 조직에서 온 것인지 여부를 나타내는 부울 값입니다.
- 반환 값 예제:
{ "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 - 원래 메소드 이름:
addRole - 이 메소드는 지정된 사용자 및 토큰에 롤을 추가합니다. 계정 ID는 연결된 토큰 ID, 조직 ID 및 사용자 ID의 SHA-256 해시를 생성하여 구성됩니다. 이 메소드는 지정된 조직의
Token Admin또는Org Admin에 의해서만 호출될 수 있습니다. - 페이로드:
{ "tokenId": "{{bc-token-id}}", "role": "role value (for example minter / burner / notary)", "orgId": "{{bc-org-id}}", "userId": "{{bc-user-id}}", "endorsers": {{endorsers}} } - 매개변수:
tokenId: string– 토큰 ID입니다.role: string– 지정된 사용자에 추가할 역할의 이름입니다. 민트 가능 및 레코딩 가능 동작은 사양 파일의minter_role_name및burner_role_name속성에 해당합니다. 마찬가지로 공증 동작은 사양 파일의notary_role_name등록 정보에 연결됩니다.orgId: string– 현재 조직에 있는 사용자의 멤버쉽 서비스 공급자(MSP) ID입니다.userId: string– 사용자의 사용자 이름 또는 전자메일 ID입니다.endorsers: string[]– 트랜잭션을 보증해야 하는 피어의 배열(예:peer1,peer2)입니다.
- 반환 값 예제:
{ "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 - 원래 메소드 이름:
addTokenAdmin - 이 POST 메소드는 사용자를 토큰 체인코드의
Token Admin로 추가합니다. 이 메소드는 토큰 체인 코드의Token Admin에 의해서만 호출될 수 있습니다. 첫번째 호출은 체인 코드를 인스턴스화하는 관리자 호출입니다. - 페이로드:
{ "orgId": "{{bc-org-id}}", "userId": "{{bc-user-id}}", "sameOrgEndorser": true } - 매개변수:
orgId: string– 현재 조직에 있는 사용자의 멤버쉽 서비스 공급자(MSP) ID입니다.userId: string– 사용자의 사용자 이름 또는 전자메일 ID입니다.sameOrgEndorser: boolean– 트랜잭션 보증이 요청자와 동일한 조직에서 온 것인지 여부를 나타내는 부울 값입니다.
- 반환 값 예제:
{ "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 - 원래 메소드 이름:
addTokenAuditor - 이 POST 메소드는 토큰 체인 코드에 토큰 감사자를 추가합니다. 이 메소드는 체인 코드의
Token Admin에 의해서만 호출될 수 있습니다. - 페이로드:
{ "orgId": "{{bc-org-id}}", "userId": "{{bc-user-id}}", "sameOrgEndorser": true } - 매개변수:
orgId: string– 현재 조직에 있는 사용자의 멤버쉽 서비스 공급자(MSP) ID입니다.userId: string– 사용자의 사용자 이름 또는 전자메일 ID입니다.sameOrgEndorser: boolean– 트랜잭션 보증이 요청자와 동일한 조직에서 온 것인지 여부를 나타내는 부울 값입니다.
- 반환 값 예제:
{ "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 - 원래 메소드 이름:
approveBurn - Notaries는 이 POST 메소드를 호출하여 레코딩 요청을 승인할 수 있습니다.
- 페이로드:
{ "tokenId": "{{bc-token-id}}", "operationId": "operation_id value", "sameOrgEndorser": true } - 매개변수:
tokenId: string– 토큰 ID입니다.operationId: string– 승인할 민트 요청의 고유한 작업 ID입니다.sameOrgEndorser: boolean– 트랜잭션 보증이 요청자와 동일한 조직에서 온 것인지 여부를 나타내는 부울 값입니다.
- 반환 값 예제:
{ "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 - 원래 메소드 이름:
approveMint - Notaries는 이 POST 메소드를 호출하여 민트 요청을 승인할 수 있습니다.
- 페이로드:
{ "tokenId": "{{bc-token-id}}", "operationId": "operation_id value", "sameOrgEndorser": true } - 매개변수:
tokenId: string– 토큰 ID입니다.operationId: string– 승인할 민트 요청의 고유한 작업 ID입니다.sameOrgEndorser: boolean– 트랜잭션 보증이 요청자와 동일한 조직에서 온 것인지 여부를 나타내는 부울 값입니다.
- 반환 값 예제:
{ "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 - 원래 메소드 이름:
approveTransaction - 승인자는 이 POST 메소드를 호출하여 보류 트랜잭션을 승인할 수 있습니다.
- 페이로드:
{ "tokenId": "{{bc-token-id}}", "orgId": "{{bc-org-id}}", "userId": "{{bc-user-id}}", "endorsers": {{endorsers}} } - 매개변수:
tokenId: string– 토큰 ID입니다.orgId: string– 사용자의 멤버쉽 서비스 공급자(MSP) ID입니다.userId: string– 사용자의 사용자 이름 또는 전자메일 ID입니다.endorsers: string[]– 트랜잭션을 보증해야 하는 피어의 배열(예:peer1,peer2)입니다.
- 반환 값 예제:
{ "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 - 원래 메소드 이름:
associateTokenToAccount - 이 POST 메소드는 지정된 계정 ID를 지정된 토큰에 연관시킵니다. 이 메소드는 지정된 조직의
Token Admin또는Org Admin에 의해서만 호출될 수 있습니다. - 페이로드:
{ "accountId": "account_id value", "tokenId": "{{bc-token-id}}", "endorsers": {{endorsers}} } - 매개변수:
accountId: string– 계정의 ID입니다.tokenId: string– 토큰 ID입니다.endorsers: string[]– 트랜잭션을 보증해야 하는 피어의 배열(예:peer1,peer2)입니다.
- 반환 값 예제:
{ "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 - 원래 메소드 이름:
bulkTransferTokens - 이 메소드는 호출자 계정에서
flow객체에 지정된 계정으로 토큰을 대량으로 전송합니다. 수량은 사양 파일에서divisible동작의decimal매개변수로 지정된 십진수 값 내에 있어야 합니다. - 페이로드:
{ "tokenId": "{{bc-token-id}}", "flow": "[flow value]", "endorsers": {{endorsers}} } - 매개변수:
token_id: string– 토큰 ID입니다.flow : object[]– 수신기 및 수량을 지정하는 JSON 객체의 배열입니다.to_orgId: string– 현재 조직에서 수신자의 MSP(멤버쉽 서비스 제공자) ID입니다.userId: string– 수신자의 사용자 이름 또는 전자 메일 ID입니다.quantity: number– 전송할 토큰 수입니다.
flow매개변수를 다른 형식으로 지정합니다.Visual Studio 코드:[ { "to_org_id": "Org1MSP", "to_user_id": "user1", "quantity": 10 }, { "to_org_id": "Org1MSP", "to_user_id": "user2", "quantity": 10 } ]CLI/Postman:"[{ \"to_org_id\": \"Org1MSP\", \"to_user_id\": \"user1\", \"quantity\": 10 }, { \"to_org_id\": \"Org1MSP\", \"to_user_id\": \"user2\", \"quantity\": 10 }]"endorsers: string[]– 트랜잭션을 보증해야 하는 피어의 배열(예:peer1,peer2)입니다.
- 반환 값 예제:
{ "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 - 원래 메소드 이름:
createAccount - 이 메소드는 지정된 사용자 및 토큰의 계정을 만듭니다. 언제든지 토큰을 가질 사용자에 대해 계정을 만들어야 합니다. 계정은 잔액, 보류 중인 잔액 및 트랜잭션 기록을 추적합니다. 계정 ID는 자산 유형, 토큰 ID 및 사용자 ID와 조직(멤버십 서비스 제공자) ID의 SHA-256 해시를 연결하여 구성됩니다. 이 메소드는 체인 코드의
Token Admin또는 지정된 조직의Org Admin에 의해서만 호출될 수 있습니다. - 페이로드:
{ "orgId": "{{bc-org-id}}", "userId": "{{bc-user-id}}", "tokenType": "fungible", "dailyLimits": "{\"max_daily_amount\":10000,\"max_daily_transactions\":100}", "endorsers": {{endorsers}} } - 매개변수:
orgId– 계정을 만들 사용자의 멤버쉽 서비스 공급자(MSP) ID입니다. ID는 영숫자로 시작해야 하며 문자, 숫자 및 밑줄(_), 마침표(.), @ 기호 및 하이픈(-)과 같은 특수 문자를 포함할 수 있습니다.userId– 사용자의 사용자 이름 또는 전자메일 ID입니다. ID는 영숫자로 시작해야 하며 문자, 숫자 및 밑줄(_), 마침표(.), @ 기호 및 하이픈(-)과 같은 특수 문자를 포함할 수 있습니다.tokenType: TokenType– 토큰의 유형으로,fungible여야 합니다.dailyLimits: JSON object– 다음 유형의 JSON 객체입니다.
예제에서{ "max_daily_amount": 100000 "max_daily_transactions": 10000 }max_daily_amount값은 매일 트랜잭션할 수 있는 최대 토큰 수이고max_daily_transactions값은 매일 완료할 수 있는 최대 트랜잭션 수입니다.endorsers: string[]– 트랜잭션을 보증해야 하는 피어의 배열(예:peer1,peer2)입니다.
- 반환 값 예제:
{ "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 - 원래 메소드 이름:
createApprovalPolicyCheck - 이 방법은 트랜잭션 임계값 및 필수 순차 승인자를 정의하는 새 승인 정책을 생성합니다. 이 메소드는
Token Admin에 의해서만 호출될 수 있습니다. - 페이로드:
{ "asset": "{\"approvalPolicyId\":\"approvalPolicyId value\",\"transactionLowerLimit\":\"transactionLowerLimit value\",\"transactionUpperLimit\":\"transactionUpperLimit value\",\"numberOfApprovalsRequired\":999,\"approverDetails\":[{\"approverOrgId\":\"approverOrgId value\",\"approverUserId\":\"approverUserId value\",\"approvalSequence\":999}]}", "endorsers": {{endorsers}} } - 매개변수:
asset: ApprovalPolicyCheck class– 다음 필드를 포함하는 트랜잭션에 대한 승인 규칙을 정의하는 클래스입니다.approvalPolicyId– 시스템에서 이 ID를 생성합니다. 이 필드는 수동으로 제공하지 않습니다.transactionLowerLimit– 승인 정책이 적용되는 최소 거래 금액입니다.transactionUpperLimit– 승인 정책이 적용되는 최대 트랜잭션 금액입니다.numberOfApprovalsRequired– 트랜잭션을 완료하기 전에 필요한 총 승인 수입니다.approverDetails– 승인에 대한 필수 순서를 정의하는 지정된 승인 순서와 함께 승인자 목록입니다.
endorsers: string[]– 트랜잭션을 보증해야 하는 피어의 배열(예:peer1,peer2)입니다.
- 반환 값 예제:
{ "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 - 원래 메소드 이름:
createAccountPolicyCheck - 이 방법은 지정된 계정에 대한 정책을 만듭니다. 이 메소드는 지정된 조직의
Token Admin또는Org Admin에 의해서만 호출될 수 있습니다. - 페이로드:
{ "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}} } - 매개변수:
asset: AccountPolicyCheck class– 다음 필드를 포함하는 계정 정책 매개변수를 정의하는 클래스입니다.accountPolicyId– 시스템에서 지정된 orgId 및 userId 필드에서 이 ID를 생성합니다. 이 필드는 수동으로 제공하지 않습니다.orgId– 정책을 만들 사용자의 멤버쉽 서비스 공급자(MSP) ID입니다.userId– 정책을 만들 사용자의 사용자 이름 또는 전자 메일 ID입니다.kycCompliance– 계정이 KYC(Know Your Customer) 요구 사항을 충족하는지 여부를 나타내는 부울 값입니다.amlCompliance– 계정이 AML(Anti-Money Laundering) 요구 사항을 충족하는지 여부를 나타내는 부울 값입니다.riskScore– 준수 평가에 사용되는 계정과 연관된 위험 점수입니다.restrictionFlag– 계정에 제한된 이전이 적용되는지 여부를 나타내는 부울 값입니다.true로 설정된 경우 최저 승인 정책 임계값 내 전송만 허용됩니다.endorsers: string[]– 트랜잭션을 보증해야 하는 피어의 배열(예:peer1,peer2)입니다.
- 반환 값 예제:
{ "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 - 원래 메소드 이름:
deleteApprovalPolicyCheck - 이 방법은 지정된 정책 ID에 대한 승인 정책을 삭제합니다. 이 메소드는
Token Admin에 의해서만 호출될 수 있습니다. - 페이로드:
{ "id": "id value", "endorsers": {{endorsers}} } - 매개변수:
id: string– 고유한 승인 정책 ID입니다.endorsers: string[]– 트랜잭션을 보증해야 하는 피어의 배열(예:peer1,peer2)입니다.
- 반환 값 예제:
{ "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 - 원래 메소드 이름:
deleteAccount - 이 방법은 대체 가능한 토큰 계정을 삭제합니다. 원장에서 계정에 대한
accountStatus값을 찾을 수 없는 경우 오류를 반환합니다. 이 메소드는Token Admin에 의해서만 호출될 수 있습니다. - 페이로드:
{ "tokenId": "{{bc-token-id}}", "orgId": "{{bc-org-id}}", "userId": "{{bc-user-id}}", "endorsers": {{endorsers}} } - 매개변수:
tokenId: string– 토큰 ID입니다.orgId: string– 현재 조직에 있는 사용자의 멤버쉽 서비스 공급자(MSP) ID입니다.userId: string– 사용자의 사용자 이름 또는 전자메일 ID입니다.endorsers: string[]– 트랜잭션을 보증해야 하는 피어의 배열(예:peer1,peer2)입니다.
- 반환 값 예제:
{ "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 - 원래 메소드 이름:
deleteAccountPolicyCheck - 이 방법은 지정된 정책 ID에 대한 정책을 삭제합니다. 이 메소드는 지정된 조직의
Token Admin또는Org Admin에 의해서만 호출될 수 있습니다. - 페이로드:
{ "id": "id value", "endorsers": {{endorsers}} } - 매개변수:
id: string– 고유한 계정 정책 ID입니다.endorsers: string[]– 트랜잭션을 보증해야 하는 피어의 배열(예:peer1,peer2)입니다.
- 반환 값 예제:
{ "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 - 원래 메소드 이름:
executeHoldTokens - 이 방법은 토큰 보류를 승인하여 발신자에서 수신자로 토큰 전송을 트리거합니다. 토큰 소유자가 이전에 보류한 토큰의 수량이 이제 수신자에게 이전됩니다.
quantity값이 실제 보류 값보다 작은 경우 나머지 금액은 토큰 소유자가 다시 사용할 수 있습니다.roles동작이 토큰 모델의behaviors섹션에 지정되고notary_role_name값이 설정된 경우 호출자 계정에 공증 역할이 있어야 합니다. 그렇지 않으면 계정이 있는 호출자가 공증으로 작동할 수 있습니다. - 페이로드:
{ "tokenId": "{{bc-token-id}}", "operationId": "operation_id value", "quantity": 1, "endorsers": {{endorsers}} } - 매개변수:
tokenId: string– 토큰 ID입니다.operationId: string– 승인할 민트 요청의 고유한 작업 ID입니다.quantity: number– 전송할 보류된 토큰 수입니다.endorsers: string[]– 트랜잭션을 보증해야 하는 피어의 배열(예:peer1,peer2)입니다.
- 반환 값 예제:
{ "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 - 원래 메소드 이름:
getAccountTransactionHistory - 이 메소드는 지정된 사용자 및 토큰에 대한 계정 트랜잭션 내역 세부정보 배열을 반환합니다. 이 메소드는 체인 코드의
Token Admin또는Token Auditor, 지정된 조직의Org Admin또는Org Auditor또는 계정의AccountOwner에 의해서만 호출될 수 있습니다. /getStablecoinAccountTransactionHistory?tokenId={{bc-token-id}}&orgId={{bc-org-id}}&userId={{bc-user-id}}- 매개변수:
tokenId: string– 토큰 ID입니다.orgId: string– 현재 조직에 있는 사용자의 멤버쉽 서비스 공급자(MSP) ID입니다.userId: string– 사용자의 사용자 이름 또는 전자메일 ID입니다.
- 반환 값 예제:
{ "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 - 원래 메소드 이름:
getAllAccounts - 이 방법은 모든 계정 목록을 반환합니다. 이 메소드는
Token Admin또는Token Auditor에 의해서만 호출될 수 있습니다. - 페이로드:
{{api-gateway-endpoint1}}/getAllAccounts - 매개변수:
- 없음
- 반환 값 예제:
{ "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 - 원래 메소드 이름:
getAllOrgAccounts - 이 메소드는 지정된 조직에 속하는 모든 토큰 계정 목록을 반환합니다. 이 메소드는 지정된 조직의
Token Admin,Token Auditor또는Org Admin또는Org Auditor에 의해서만 호출될 수 있습니다. - 페이로드:
{{api-gateway-endpoint1}}/getAllOrgAccounts?orgId={{bc-org-id}} - 매개변수:
orgId: string– 조직의 멤버쉽 서비스 제공자(MSP) ID입니다.
- 반환 값 예제:
{ "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 - 원래 메소드 이름:
getAllTokenAdmins - 이 메소드는
Token Admin인 모든 사용자 목록을 반환합니다. 이 메소드는Token Admin또는Token Auditor를 통해서만 호출할 수 있습니다. - 페이로드:
{{api-gateway-endpoint1}}/getAllTokenAdmins - 매개변수:
- 없음
- 반환 값 예제:
{ "returnCode": "Success", "error": "", "result": { "payload": { "admins": [ { "org_id": "CentralBank", "user_id": "cb_admin_demo" } ] }, "encode": "JSON" } } -
getAllTokens - 원래 메소드 이름:
getAllTokens - 이 메소드는 상태 데이터베이스에 저장된 모든 토큰을 반환합니다. 이 메소드는
Token Admin,Token Auditor,Org Admin또는Org Auditor를 통해서만 호출할 수 있습니다. 이 방법은 Berkeley DB SQL 리치 쿼리를 사용하며 원격 Oracle Blockchain Platform 네트워크에 연결된 경우에만 호출할 수 있습니다. - 페이로드:
{{api-gateway-endpoint1}}/getAllTokens - 매개변수:
- 없음
- 반환 값 예제:
{ "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 - 원래 메소드 이름:
getApprovalPolicyCheckById - 이 메소드는 지정된 정책 ID에 대한 승인 정책 세부정보를 가져옵니다. 이 메소드는
Token Admin또는Token Auditor에 의해서만 호출될 수 있습니다. - 페이로드:
{{api-gateway-endpoint1}}/getApprovalPolicyCheckById?id=id value - 매개변수:
id: string– 고유한 승인 정책 ID입니다.
- 반환 값 예제:
{ "returnCode": "Success", "error": "", "result": { "payload": { "assetType": "ApprovalPolicyCheck", "approvalPolicyId": "GPID~0~100", "transactionLowerLimit": "0", "transactionUpperLimit": "100", "numberOfApprovalsRequired": 0, "approverDetails": [] }, "encode": "JSON" } } -
getApprovalTransactionsById - 원래 메소드 이름:
getApprovalTransactionsById - 이 방법은 지정된 트랜잭션 ID에 대한 승인 트랜잭션을 가져옵니다. 이 메소드는 연관된 조직의
Token Admin또는Org Admin에 의해서만 호출될 수 있습니다. - 페이로드:
{{api-gateway-endpoint1}}/getApprovalTransactionsById?id=id value - 매개변수:
id: string– 승인 트랜잭션의 시스템 생성 ID입니다.
- 반환 값 예제:
{ "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 - 원래 메소드 이름:
getApproverDetailsByTransferAmount - 이 방법은 지정된 이체 금액에 필요한 승인자 세부정보를 가져옵니다. 이 메소드는
Token Admin또는Token Auditor에 의해서만 호출될 수 있습니다. - 페이로드:
{ "Amount": 1, "endorsers": {{endorsers}} } - 매개변수:
amount: number– 이전 금액입니다.endorsers: string[]– 트랜잭션을 보증해야 하는 피어의 배열(예:peer1,peer2)입니다.
- 반환 값 예제:
{ "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 - 원래 메소드 이름:
getMaxDailyAmount - 이 방법은 지정된 계정에 대한 최대 일별 누적 트랜잭션 금액을 가져옵니다. 이 메소드는 체인 코드의
Token Admin또는Token Auditor또는 지정된 조직의Org Admin또는Org Auditor에 의해서만 호출될 수 있습니다. - 페이로드:
{{api-gateway-endpoint1}}/getMaxDailyAmount?OrgId={{bc-org-id}}&UserId={{bc-user-id}}&TokenId={{bc-token-id}} - 매개변수:
tokenId: string– 토큰 ID입니다.orgId: string– 현재 조직에 있는 사용자의 멤버쉽 서비스 공급자(MSP) ID입니다.userId: string– 사용자의 사용자 이름 또는 전자메일 ID입니다.
- 반환 값 예제:
{ "returnCode": "Success", "error": "", "result": { "payload": { "max_daily_amount": 10000 }, "encode": "JSON" } } -
getMaxDailyTransactionCount - 원래 메소드 이름:
getMaxDailyTransactionCount - 이 방법은 지정된 계정에 대한 최대 일일 트랜잭션 수를 가져옵니다. 이 메소드는 체인 코드의
Token Admin또는Token Auditor또는 지정된 조직의Org Admin또는Org Auditor에 의해서만 호출될 수 있습니다. - 페이로드:
{{api-gateway-endpoint1}}/getMaxDailyTransactionCount?OrgId={{bc-org-id}}&UserId={{bc-user-id}}&TokenId={{bc-token-id}} - 매개변수:
tokenId: string– 토큰 ID입니다.orgId: string– 현재 조직에 있는 사용자의 멤버쉽 서비스 공급자(MSP) ID입니다.userId: string– 사용자의 사용자 이름 또는 전자메일 ID입니다.
- 반환 값 예제:
{ "returnCode": "Success", "error": "", "result": { "payload": { "max_daily_transactions": 100 }, "encode": "JSON" } } -
getNetTokens - 원래 메소드 이름:
getNetTokens - 이 GET 메소드는 지정된 토큰에 대해 시스템에서 사용 가능한 총 순 토큰 수를 반환합니다. 순 토큰 합계는 토큰이 레코딩된 후 남은 토큰의 양입니다. 이 메소드는
Token Admin또는Token Auditor또는Org Admin또는Org Auditor를 통해서만 호출할 수 있습니다. /getNetStablecoinTokens?tokenId={{bc-token-id}}- 매개변수:
tokenId: string– 토큰 ID입니다.
- 반환 값 예제:
{ "returnCode": "Success", "error": "", "result": { "payload": { "msg": "Net supply of token for Token Id: USD is 878 tokens.", "quantity": 878 }, "encode": "JSON" } } -
getOnHoldBalanceWithOperationId - 원래 메소드 이름:
getOnHoldBalanceWithOperationId - 이 메소드는 지정된 작업 ID 및 토큰에 대해 보류 중인 잔액을 반환합니다. 이 메소드는
Token Admin또는Token Auditor또는 작업과 연관된 발신자, 수신자 또는 공증인에 의해서만 호출될 수 있습니다. - 페이로드:
{{api-gateway-endpoint1}}/getOnHoldBalanceWithOperationId?tokenId={{bc-token-id}}&operationId=operation_id value - 매개변수:
tokenId: string– 토큰 ID입니다.operationId: string– 보류 작업을 식별하는 고유 ID입니다. 일반적으로 이 ID는 클라이언트 응용 프로그램에서 전달합니다.
- 반환 값 예제:
{ "returnCode": "Success", "error": "", "result": { "payload": { "msg": "Current Holding Balance of Operation 'hold2' for token 't1' is: 600", "holding_balance": 600 }, "encode": "JSON" } } -
getOnHoldDetailsWithOperationId - 원래 메소드 이름:
getOnHoldDetailsWithOperationId - 이 메소드는 지정된 작업 ID 및 토큰에 대해 보류 중인 트랜잭션 세부정보를 반환합니다. 이 메소드는
Token Admin또는Token Auditor또는 작업과 연관된 발신자, 수신자 또는 공증인에 의해서만 호출될 수 있습니다. - 페이로드:
{{api-gateway-endpoint1}}/getOnHoldDetailsWithOperationId?tokenId={{bc-token-id}}&operationId=operation_id value - 매개변수:
tokenId: string– 토큰 ID입니다.operationId: string– 보류 작업을 식별하는 고유 ID입니다. 일반적으로 이 ID는 클라이언트 응용 프로그램에서 전달합니다.
- 반환 값 예제:
{ "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 - 원래 메소드 이름:
getOnHoldIds - 이 GET 메소드는 지정된 계정에 대한 모든 보유 ID 목록을 반환합니다. 이 메소드는 체인 코드의
Token Admin또는Token Auditor, 지정된 조직의Org Admin또는Org Auditor또는 계정의AccountOwner에 의해서만 호출될 수 있습니다. /getOnHoldIds?tokenId={{bc-token-id}}&orgId={{bc-org-id}}&userId={{bc-user-id}}- 매개변수:
tokenId: string– 토큰 ID입니다.orgId: string– 현재 조직에 있는 사용자의 멤버쉽 서비스 공급자(MSP) ID입니다.userId: string– 사용자의 사용자 이름 또는 전자메일 ID입니다.
- 반환 값 예제:
{ "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 - 원래 메소드 이름:
getOrgAccountsByRole - 이 방법은 지정된 조직에서 지정된 역할을 가진 모든 고객사에 대한 정보를 반환합니다. 이 메소드는
Token Admin또는Token Auditor또는 지정된 조직의Org Admin또는Org Auditor에 의해서만 호출될 수 있습니다. - 페이로드:
{{api-gateway-endpoint1}}/getOrgAccountsByRole?tokenId={{bc-token-id}}&role=role value (for example minter / burner / notary)&orgId={{bc-org-id}} - 매개변수:
tokenId: string– 토큰 ID입니다.role: string– 확인할 역할의 이름입니다.orgId: string– 현재 조직에 있는 사용자의 멤버쉽 서비스 공급자(MSP) ID입니다.
- 반환 값 예제:
{ "returnCode": "Success", "error": "", "result": { "payload": { "accounts": [ "oaccount~374e4e762940fc185c7cd5b6528c7f94985b6c56acf46abb746de6381589edd2" ] }, "encode": "JSON" } } -
getOrgAdmins - 원래 메소드 이름:
getOrgAdmins - 이 메소드는 조직의
Org Admin인 모든 사용자 목록을 반환합니다. 이 메소드는Token Admin또는Token Auditor또는 연관된 조직의Org Admin또는Org Auditor에 의해서만 호출될 수 있습니다. - 페이로드:
{{api-gateway-endpoint1}}/getOrgAdmins - 매개변수:
- 없음
- 반환 값 예제:
{ "returnCode": "Success", "error": "", "result": { "payload": { "admins": [ { "org_id": "CentralBank", "user_id": "cb__creator_demo" } ] }, "encode": "JSON" } } -
getOrgAuditors - 원래 메소드 이름:
getOrgAuditors - 이 메소드는 조직의
Org Auditor인 모든 사용자 목록을 반환합니다. 이 메소드는Token Admin또는Token Auditor또는 연관된 조직의Org Admin또는Org Auditor에 의해서만 호출될 수 있습니다. - 페이로드:
{{api-gateway-endpoint1}}/getOrgAuditors - 매개변수:
- 없음
- 반환 값 예제:
{ "returnCode": "Success", "error": "", "result": { "payload": { "admins": [ { "org_id": "CentralBank", "user_id": "cb_auditor_demo" } ] }, "encode": "JSON" } } -
getOrgUsersByRole - 원래 메소드 이름:
getOrgUsersByRole - 이 메소드는 지정된 조직에서 지정된 롤을 가진 모든 사용자에 대한 정보를 반환합니다. 이 메소드는
Token Admin또는Token Auditor또는 지정된 조직의Org Admin또는Org Auditor에 의해서만 호출될 수 있습니다. - 페이로드:
{{api-gateway-endpoint1}}/getOrgUsersByRole?tokenId={{bc-token-id}}&role=role value (for example minter / burner / notary)&orgId={{bc-org-id}} - 매개변수:
tokenId: string– 토큰 ID입니다.role: string– 확인할 역할의 이름입니다.orgId: string– 현재 조직에 있는 사용자의 멤버쉽 서비스 공급자(MSP) ID입니다.
- 반환 값 예제:
{ "returnCode": "Success", "error": "", "result": { "payload": { "users": [ { "token_id": "t1", "user_id": "cb__creator_demo", "org_id": "CentralBank" } ] }, "encode": "JSON" } } -
getStablecoinAccount - 원래 메소드 이름:
getAccount - 이 GET 메소드는 지정된 사용자 및 토큰에 대한 계정 세부정보를 반환합니다. 이 메소드는 체인 코드의
Token Admin또는Token Auditor, 지정된 조직의Org Admin또는Org Auditor또는 계정의AccountOwner에 의해서만 호출될 수 있습니다. - 질의:
/getStablecoinAccount?tokenId={{bc-token-id}}&orgId={{bc-org-id}}&userId={{bc-user-id}} - 매개변수:
tokenId: string– 토큰 ID입니다.orgId: string– 현재 조직에 있는 사용자의 멤버쉽 서비스 공급자(MSP) ID입니다.userId: string– 사용자의 사용자 이름 또는 전자메일 ID입니다.
- 반환 값 예제:
{ "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 - 원래 메소드 이름:
getAccountBalance - 이 GET 메소드는 지정된 계정 및 토큰에 대한 현재 잔액을 반환합니다. 이 메소드는 체인 코드의
Token Admin또는Token Auditor, 지정된 조직의Org Admin또는Org Auditor또는 계정의AccountOwner에 의해서만 호출될 수 있습니다. /getStablecoinAccountBalance?tokenId={{bc-token-id}}&orgId={{bc-org-id}}&userId={{bc-user-id}}- 매개변수:
tokenId: string– 토큰 ID입니다.orgId: string– 현재 조직에 있는 사용자의 멤버쉽 서비스 공급자(MSP) ID입니다.userId: string– 사용자의 사용자 이름 또는 전자메일 ID입니다.
- 반환 값 예제:
{ "returnCode": "Success", "error": "", "result": { "payload": { "msg": "Current Balance is: 100", "user_balance": 100 }, "encode": "JSON" } } -
getStablecoinAccountOnHoldBalance - 원래 메소드 이름:
getAccountOnHoldBalance - 이 방법은 지정된 계정 및 토큰에 대한 현재 보류 잔액을 반환합니다. 이 메소드는 지정된 조직의
Token Admin또는Token Auditor,Org Admin또는Org Auditor또는 계정 소유자에 의해서만 호출될 수 있습니다. - 페이로드:
{{api-gateway-endpoint1}}/getStablecoinAccountOnHoldBalance?tokenId={{bc-token-id}}&orgId={{bc-org-id}}&userId={{bc-user-id}} - 매개변수:
tokenId: string– 토큰 ID입니다.orgId: string– 현재 조직에 있는 사용자의 멤버쉽 서비스 공급자(MSP) ID입니다.userId: string– 사용자의 사용자 이름 또는 전자메일 ID입니다.
- 반환 값 예제:
{ "returnCode": "Success", "error": "", "result": { "payload": { "msg": "Total Holding Balance is: 600", "holding_balance": 600 }, "encode": "JSON" } } -
getStablecoinAccountOnHoldBurnBalance - 원래 메소드 이름:
getAccountOnHoldBurnBalance - 이 방법은 지정된 사용자에 대한 보류 중인 레코딩 잔액을 반환합니다. 이 메소드는 지정된 조직의
Token Admin또는Token Auditor,Org Admin또는Org Auditor또는 계정 소유자에 의해서만 호출될 수 있습니다. - 페이로드:
{{api-gateway-endpoint1}}/getStablecoinAccountOnHoldBurnBalance?tokenId={{bc-token-id}}&orgId={{bc-org-id}}&userId={{bc-user-id}} - 매개변수:
tokenId: string– 토큰 ID입니다.orgId: string– 현재 조직에 있는 사용자의 멤버쉽 서비스 공급자(MSP) ID입니다.userId: string– 사용자의 사용자 이름 또는 전자메일 ID입니다.
- 반환 값 예제:
{ "returnCode": "Success", "error": "", "result": { "payload": { "msg": "Total On Hold Burning Balance is: 0", "onhold_burn_balance": 0 }, "encode": "JSON" } } -
getStablecoinAccountPolicyCheckById - 원래 메소드 이름:
getAccountPolicyCheckById - 이 방법은 지정된 정책 ID에 대한 계정 정책 세부정보를 가져옵니다. 이 메소드는 지정된 조직의
Token Admin또는Token Auditor또는Org Admin또는Org Auditor에 의해서만 호출될 수 있습니다. - 페이로드:
{{api-gateway-endpoint1}}/getStablecoinAccountPolicyCheckById?id=id value - 매개변수:
id: string– 고유한 계정 정책 ID입니다.
- 반환 값 예제:
{ "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 - 원래 메소드 이름:
getAccountsByRole - 이 메소드는 지정된 롤과 토큰에 대한 모든 계정 ID 목록을 반환합니다. 이 메소드는
Token Admin또는Token Auditor에 의해서만 호출될 수 있습니다. - 페이로드:
{{api-gateway-endpoint1}}/getStablecoinAccountsByRole?tokenId={{bc-token-id}}&role=role value (for example minter / burner / notary) - 매개변수:
tokenId: string– 토큰 ID입니다.role: string– 확인할 역할의 이름입니다.
- 반환 값 예제:
{ "returnCode": "Success", "error": "", "result": { "payload": { "accounts": [ "oaccount~374e4e762940fc185c7cd5b6528c7f94985b6c56acf46abb746de6381589edd2" ] }, "encode": "JSON" } } -
getStablecoinAccountsByUser - 원래 메소드 이름:
getAccountsByUser - 이 메소드는 지정된 조직 ID 및 사용자 ID에 대한 모든 계정 ID 목록을 반환합니다. 이 메소드는 체인 코드의
Token Admin또는Token Auditor, 지정된 조직의Org Admin또는Org Auditor또는 계정의AccountOwner에 의해서만 호출될 수 있습니다. /getStablecoinAccountsByUser?orgId={{bc-org-id}}&userId={{bc-user-id}}- 매개변수:
orgId: string– 현재 조직에 있는 사용자의 멤버쉽 서비스 공급자(MSP) ID입니다.userId: string– 사용자의 사용자 이름 또는 전자메일 ID입니다.
- 반환 값 예제:
{ "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 - 원래 메소드 이름:
getAccountStatus - 이 메소드는 토큰 계정의 현재 상태를 가져옵니다. 이 메소드는 지정된 조직의
Token Admin또는Token Auditor,Org Admin또는Org Auditor또는 토큰 계정 소유자가 호출할 수 있습니다. 원장에서accountStatus값을 찾을 수 없는 경우 이 메소드는 상태가 활성으로 설정된accountStatus객체를 반환합니다. - 페이로드:
{{api-gateway-endpoint1}}/getStablecoinAccountStatus?tokenId={{bc-token-id}}&orgId={{bc-org-id}}&userId={{bc-user-id}} - 매개변수:
tokenId: string– 토큰 ID입니다.orgId: string– 현재 조직에 있는 사용자의 멤버쉽 서비스 공급자(MSP) ID입니다.userId: string– 사용자의 사용자 이름 또는 전자메일 ID입니다.
- 반환 값 예제:
{ "returnCode": "Success", "error": "", "result": { "payload": { "assetType": "oaccountStatus", "status_id": "oaccountStatus~cfe302f06bf732f248315725bb601d7906d7c1d4c167d04ac3a5283b8dbc7fc4", "account_id": "oaccount~374e4e762940fc185c7cd5b6528c7f94985b6c56acf46abb746de6381589edd2", "status": "active" }, "encode": "JSON" } } -
getStablecoinAccountTransactionHistoryWithFilters - 원래 메소드 이름:
getAccountTransactionHistoryWithFiltersFromRichHistDB - 이 방법은 풍부한 기록 데이터베이스의 계정 트랜잭션 기록 세부정보를 반환합니다. 이 메소드는 체인 코드의
Token Admin또는Token Auditor, 지정된 조직의Org Admin또는Org Auditor또는 계정의AccountOwner에 의해서만 호출될 수 있습니다. /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"}- 매개변수:
tokenId: string– 토큰 ID입니다.orgId: string– 현재 조직에 있는 사용자의 멤버쉽 서비스 공급자(MSP) ID입니다.userId: string– 사용자의 사용자 이름 또는 전자메일 ID입니다.customEndpoint– 트랜잭션 내역을 인출할 서식 있는 내역 데이터베이스의 RESTful 서비스 끝점입니다.bearerToken– 요청에 권한이 부여되었는지 확인하기 위해 RESTful 끝점을 호출하는 데 사용할 토큰입니다.filters: JSON object– 선택적 매개변수입니다. 비어 있으면 모든 레코드가 반환됩니다.pageSize속성은 반환할 레코드 수를 결정합니다.pageSize가 0이면 기본 페이지 크기는 20입니다.bookmark속성은 반환할 레코드의 시작 인덱스를 결정합니다.startTime및endTime등록 정보는 RFC-3339 형식으로 지정해야 합니다.
- 반환 값 예제:
{ "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 - 원래 메소드 이름:
getTokenAuditors - 이 메소드는 체인 코드의 모든
Token Auditors를 반환합니다. 이 메소드는Token Admin또는Token Auditor에 의해서만 호출될 수 있습니다. - 페이로드:
{{api-gateway-endpoint1}}/getTokenAuditors - 매개변수:
- 없음
- 반환 값 예제:
{ "returnCode": "Success", "error": "", "result": { "payload": { "auditors": [ { "org_id": "CentralBank", "user_id": "cb_auditor_demo" } ] }, "encode": "JSON" } } -
getTokenById - 원래 메소드 이름:
getTokenById - 이 메소드는 지정된 토큰 ID에 대한 토큰 세부정보를 반환합니다. 이 메소드는 조직의
Token Admin또는Token Auditor또는Org Admin또는Org Auditor에 의해서만 호출될 수 있습니다. - 페이로드:
{{api-gateway-endpoint1}}/getTokenById?tokenId={{bc-token-id}} - 매개변수:
tokenId: string– 토큰 ID입니다.
- 반환 값 예제:
{ "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 - 원래 메소드 이름:
getTokenHistory - 이 메소드는 지정된 토큰 ID에 대한 토큰 기록을 반환합니다. 이 메소드는 조직의
Token Admin또는Token Auditor또는Org Admin또는Org Auditor에 의해서만 호출될 수 있습니다. - 페이로드:
{{api-gateway-endpoint1}}/getTokenHistory?tokenId={{bc-token-id}} - 매개변수:
tokenId: string– 토큰 ID입니다.
- 반환 값 예제:
{ "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 - 원래 메소드 이름:
getTotalMintedTokens - 이 메소드는 지정된 토큰에 대해 민트된 토큰의 총 수를 반환합니다. 이 메소드는
Token Admin,Token Auditor,Org Admin또는Org Auditor를 통해서만 호출할 수 있습니다. - 질의:
/getTotalCreatedStablecoinTokens?tokenId={{bc-token-id}} - 매개변수:
tokenId: string– 토큰 ID입니다.
- 반환 값 예제:
{ "returnCode": "Success", "error": "", "result": { "payload": { "msg": "Total minted token for Token Id: USD is 910 tokens.", "quantity": 910 }, "encode": "JSON" } } -
getTransactionById - 원래 메소드 이름:
getTransactionById - 이 메소드는 지정된 트랜잭션 ID에 대한 상세 트랜잭션 레코드를 반환합니다. 이 방법은
Token Admin또는 트랜잭션(발신자, 수령인 또는 공증인)에 의해 지정된 모든 계정에 의해서만 호출될 수 있습니다. - 페이로드:
{{api-gateway-endpoint1}}/getTransactionById?transactionId=transaction_id value - 매개변수:
transaction_id string– 트랜잭션의 ID입니다.
- 반환 값 예제:
{ "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 - 원래 메소드 이름:
getUserByAccountId - 이 메소드는 지정된 계정에 대한 사용자 세부정보(
org_id,user_id및token_id)를 반환합니다. 이 메소드는 체인 코드의Token Admin또는Token Auditor또는 지정된 조직의Org Admin또는Org Auditor에 의해서만 호출될 수 있습니다. - 질의:
/getUserByStablecoinAccountId?accountId=account_id value - 매개변수:
accountId: string– 계정의 ID입니다.
- 반환 값 예제:
{ "returnCode": "Success", "error": "", "result": { "payload": { "token_id": "USD", "user_id": "admin_user_cb", "org_id": "CB" }, "encode": "JSON" } } -
getUsersByRole - 원래 메소드 이름:
getUsersByRole - 이 GET 메소드는 지정된 롤 및 토큰에 대한 모든 사용자 목록을 반환합니다. 이 메소드는 체인코드의
Token Admin또는Token Auditor에 의해서만 호출될 수 있습니다. - 질의:
/getUsersByRole?tokenId={{bc-token-id}}&role=role value (for example minter / burner / notary) - 매개변수:
tokenId: string– 토큰 ID입니다.role: string– 검색할 역할의 이름입니다.
- 반환 값 예제:
{ "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 - 원래 메소드 이름:
holdTokens - 이 방법은
to_account_id계정을 사용하여 토큰 소유자를 대신하여 보류를 생성합니다. 공증 계정이 지정되어 보류를 완료하거나 해제합니다. 보류가 생성되면 지급인의 지정된 토큰 잔액이 보류됩니다. 보류가 완료되거나 해제될 때까지 보류 잔액을 이전할 수 없습니다. 이 메소드의 호출자는 이미 생성된 계정을 가져야 합니다. - 페이로드:
{ "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}} } - 매개변수:
tokenId: string– 토큰 ID입니다.operationId: string– 보류 작업을 식별하는 고유 ID입니다. 일반적으로 이 ID는 클라이언트 응용 프로그램에서 전달합니다.toOrgId: string– 현재 조직에서 수신자의 MSP(멤버쉽 서비스 제공자) ID입니다.toUserId: string– 수신자의 사용자 이름 또는 전자 메일 ID입니다.notaryOrgId: string– 현재 조직에서 공증인의 멤버쉽 서비스 제공자(MSP) ID입니다.notaryUserId: string– 공증인의 사용자 이름 또는 전자 메일 ID입니다.quantity: number– 보류할 토큰 수입니다.timeToExpiration– 보류가 만료되는 시간입니다. 영구 보류의 경우 0을 지정합니다. 그렇지 않으면 RFC-3339 형식을 사용합니다. 2021-06-02T12:46:06Z를 예를 들 수 있습니다.infoDetails: JSON– 다음 예에 표시된 설명 및 범주입니다.{ "category" : "category input", "description" : "description input" }endorsers: string[]– 트랜잭션을 보증해야 하는 피어의 배열(예:peer1,peer2)입니다.
- 반환 값 예제:
{ "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 - 원래 메소드 이름:
init - 이 메소드는 체인 코드가 배치될 때 호출됩니다. 사용자 정보는 체인 코드의
Token Admin로 저장됩니다. - 페이로드:
{ "adminList": "[{\"org_id\":\"{{bc-org-id}}\",\"user_id\":\"{{bc-admin-user}}\"}]" } - 매개변수:
adminList: TokenAdminAsset[]– 다음 형식으로 토큰 관리자를 지정하는 조직 ID 및 사용자 ID를 포함하는 JSON 객체의 배열입니다.{ "org_id":"{{bc-org-id}}", "user_id":"{{bc-admin-user} }
- 반환 값 예제:
{ "returnCode": "Success", "error": "", "result": { "txid": "fdb7dc89832c8045a333823b77fa24ae628178148dc93b3550040e070d7cd807", "payload": "", "encode": "UTF-8", "sourceURL": "cb-oabcs1-bom.blockchain.ocp.example.com:20009", "blockNumber": 263 } } -
initializeStablecoinToken - 원래 메소드 이름:
initializeStablecoinToken - 이 메소드는 토큰을 생성하고 토큰 속성을 초기화합니다. 자산 및 해당 속성이 상태 데이터베이스에 저장됩니다. 이 메소드는 체인 코드의
Token Admin에 의해서만 호출될 수 있습니다. - 페이로드:
{ "tokenAsset": "{\"token_id\":\"{{bc-token-id}}\",\"token_desc\":\"token_desc value\",\"Currency_Name\":\"Currency_Name value\"}", "sameOrgEndorser": true } - 매개변수:
tokenAsset: <Token Class>– 토큰 자산이 이 메소드에 매개변수로 전달됩니다. 토큰 자산의 속성은 모델 파일에 설명되어 있습니다.sameOrgEndorser: boolean– 트랜잭션 보증이 요청자와 동일한 조직에서 온 것인지 여부를 나타내는 부울 값입니다.
- 반환값:
- 성공 시 생성된 토큰 자산의 JSON 표현입니다.
- 반환 값 예제:
{ "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 - 원래 메소드 이름:
isInRole - 이 메소드는 사용자 및 토큰이 지정된 롤을 가지는지 여부를 나타내는 부울 값을 반환합니다. 이 메소드는
Token Admin또는 계정 소유자에 의해서만 호출될 수 있습니다. - 페이로드:
{{api-gateway-endpoint2}}/isInRole?tokenId={{bc-token-id}}&orgId={{bc-org-id}}&userId={{bc-user-id}}&role=role value (for example minter / burner / notary) - 매개변수:
tokenId: string– 토큰 ID입니다.orgId: string– 사용자의 멤버쉽 서비스 공급자(MSP) ID입니다.userId: string– 사용자의 사용자 이름 또는 전자메일 ID입니다.role: string– 역할의 이름입니다.
- 반환 값 예제:
{ "returnCode": "Success", "error": "", "result": { "payload": { "result": "true" }, "encode": "JSON" } } -
isTokenAdmin - 원래 메소드 이름:
isTokenAdmin - 이 메소드는 지정된 계정이
Token Admin인 경우 부울 값true를 반환하고, 그렇지 않은 경우false를 반환합니다. THis 메소드는Token Admin에 의해서만 호출될 수 있습니다. - 페이로드:
{{api-gateway-endpoint2}}/isTokenAdmin?orgId={{bc-org-id}}&userId={{bc-user-id}} - 매개변수:
orgId: string– 현재 조직에 있는 사용자의 멤버쉽 서비스 공급자(MSP) ID입니다.userId: string– 사용자의 사용자 이름 또는 전자메일 ID입니다.
- 반환 값 예제:
{ "returnCode": "Success", "error": "", "result": { "payload": { "result": false }, "encode": "JSON" } } -
rejectBurn - 원래 메소드 이름:
rejectBurn - 이 메서드는 불타는 요청을 거부하기 위해 공증인이 호출 할 수 있습니다.
- 페이로드:
{ "tokenId": "{{bc-token-id}}", "operationId": "operation_id value", "sameOrgEndorser": true } - 매개변수:
tokenId: string– 레코딩을 거부할 토큰의 ID입니다.operationId: string– 레코딩 요청을 나타내는 고유한 작업 ID입니다.sameOrgEndorser: boolean– 트랜잭션 보증이 요청자와 동일한 조직에서 온 것인지 여부를 나타내는 부울 값입니다.
- 반환 값 예제:
{ "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 - 원래 메소드 이름:
rejectMint - 이 메서드는 minting 요청을 거부하는 공증인이 호출할 수 있습니다.
- 페이로드:
{ "tokenId": "{{bc-token-id}}", "operationId": "operation_id value", "sameOrgEndorser": true } - 매개변수:
tokenId: string– 민팅을 거부할 토큰의 ID입니다.operationId: string– 민트 요청을 나타내는 고유한 작업 ID입니다.sameOrgEndorser: boolean– 트랜잭션 보증이 요청자와 동일한 조직에서 온 것인지 여부를 나타내는 부울 값입니다.
- 반환 값 예제:
{ "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 - 원래 메소드 이름:
releaseHoldTokens - 이 POST 메소드는 토큰 보류를 해제합니다. 전송이 완료되지 않았으며 모든 보유 토큰을 원래 소유자가 다시 사용할 수 있습니다. 이 메소드는 지정된 시간 제한 내에
notary롤이 있는AccountOwnerID 또는 지정된 시간 제한 이후 지급인, 수취인 또는 공증인이 호출할 수 있습니다. - 페이로드:
{ "tokenId": "{{bc-token-id}}", "operationId": "operation_id value", "endorsers": {{endorsers}} } - 매개변수:
tokenId: string– 토큰 ID입니다.operationId: string– 보류 작업을 식별하는 고유 ID입니다. 일반적으로 이 ID는 클라이언트 응용 프로그램에서 전달합니다.endorsers: string[]– 트랜잭션을 보증해야 하는 피어의 배열(예:peer1,peer2)입니다.
- 반환 값 예제:
{ "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 - 원래 메소드 이름:
removeOrgAdmin - 이 POST 메소드는 사용자를 체인 코드의
Org Admin로 제거합니다. 이 메소드는 지정된 조직의Token Admin또는Org Admin에 의해서만 호출될 수 있습니다. - 페이로드:
{ "orgId": "{{bc-org-id}}", "userId": "{{bc-user-id}}", "sameOrgEndorser": true } - 매개변수:
orgId: string– 현재 조직에 있는 사용자의 멤버쉽 서비스 공급자(MSP) ID입니다.userId: string– 사용자의 사용자 이름 또는 전자메일 ID입니다.sameOrgEndorser: boolean– 트랜잭션 보증이 요청자와 동일한 조직에서 온 것인지 여부를 나타내는 부울 값입니다.
- 반환 값 예제:
{ "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 - 원래 메소드 이름:
removeOrgAuditor - 이 POST 메소드는 사용자를 체인 코드의
Org Auditor로 제거합니다. 이 메소드는 지정된 조직의Token Admin또는Org Admin에 의해서만 호출될 수 있습니다. - 페이로드:
{ "orgId": "{{bc-org-id}}", "userId": "{{bc-user-id}}", "sameOrgEndorser": true } - 매개변수:
orgId: string– 현재 조직에 있는 사용자의 멤버쉽 서비스 공급자(MSP) ID입니다.userId: string– 사용자의 사용자 이름 또는 전자메일 ID입니다.sameOrgEndorser: boolean– 트랜잭션 보증이 요청자와 동일한 조직에서 온 것인지 여부를 나타내는 부울 값입니다.
- 반환 값 예제:
{ "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 - 원래 메소드 이름:
removeRole - 이 방법은 지정된 사용자 및 토큰에서 af 역할을 제거합니다. 이 메소드는 체인 코드의
Token Admin또는 지정된 조직의Org Admin에 의해서만 호출될 수 있습니다. - 페이로드:
{ "tokenId": "{{bc-token-id}}", "role": "role value (for example minter / burner / notary)", "orgId": "{{bc-org-id}}", "userId": "{{bc-user-id}}", "endorsers": {{endorsers}} } - 매개변수:
tokenId: string– 토큰 ID입니다.role: string– 지정된 사용자로부터 제거할 역할의 이름입니다.mintable및burnable동작은 사양 파일의minter_role_name및burner_role_name속성에 해당합니다. 마찬가지로notary역할은 사양 파일의notary_role_name속성에 해당합니다.orgId: string– 현재 조직에 있는 사용자의 멤버쉽 서비스 공급자(MSP) ID입니다.userId: string– 사용자의 사용자 이름 또는 전자메일 ID입니다.endorsers: string[]– 트랜잭션을 보증해야 하는 피어의 배열(예:peer1,peer2)입니다.
- 반환값:
- 성공하면 계정 세부정보가 포함된 메시지가 표시됩니다.
- 반환 값 예제:
{ "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 - 원래 메소드 이름:
removeTokenAdmin - 이 POST 메소드는 사용자를 체인 코드의
Token Admin로 제거합니다. 이 메소드는 체인 코드의Token Admin에 의해서만 호출될 수 있습니다. 관리자는 자신을 제거할 수 없습니다. - 페이로드:
{ "orgId": "{{bc-org-id}}", "userId": "{{bc-user-id}}", "sameOrgEndorser": true } - 매개변수:
orgId: string– 현재 조직에 있는 사용자의 멤버쉽 서비스 공급자(MSP) ID입니다.userId: string– 사용자의 사용자 이름 또는 전자메일 ID입니다.sameOrgEndorser: boolean– 트랜잭션 보증이 요청자와 동일한 조직에서 온 것인지 여부를 나타내는 부울 값입니다.
- 반환 값 예제:
{ "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 - 원래 메소드 이름:
removeTokenAuditor - 이 POST 메소드는 사용자를 체인 코드의
Token Auditor로 제거합니다. 이 메소드는 체인 코드의Token Admin에 의해서만 호출될 수 있습니다. - 페이로드:
{ "orgId": "{{bc-org-id}}", "userId": "{{bc-user-id}}", "sameOrgEndorser": true } - 매개변수:
orgId: string– 현재 조직에 있는 사용자의 멤버쉽 서비스 공급자(MSP) ID입니다.userId: string– 사용자의 사용자 이름 또는 전자메일 ID입니다.sameOrgEndorser: boolean– 트랜잭션 보증이 요청자와 동일한 조직에서 온 것인지 여부를 나타내는 부울 값입니다.
- 반환 값 예제:
{ "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 - 원래 메소드 이름:
requestBurn - 이 메서드는 버너에 의해 호출되어 지정된 양의 토큰을 파괴하는 공증인에게 요청을 보낼 수 있습니다.
- 페이로드:
{ "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 } - 매개변수:
tokenId: string– 레코딩할 토큰의 ID입니다.operationId: string– 레코딩 요청을 나타내는 고유한 작업 ID입니다.notaryOrgId: string– 요청을 처리할 버너 공증인의 멤버쉽 서비스 공급자(MSP) ID입니다.notaryUserId: string– 요청을 처리할 버너 공증인의 사용자 이름 또는 전자메일 ID입니다.quantity: number– 레코딩할 토큰의 양입니다.timeToExpiration– 레코딩 요청이 만료되고 더 이상 유효하지 않은 시간입니다.infoDetails: JSON– 다음 예와 같이 요청의 범주(category) 및 설명(description)을 지정하는 객체입니다.{ "category" : "category input", "description" : "description input" }sameOrgEndorser: boolean– 트랜잭션 보증이 요청자와 동일한 조직에서 온 것인지 여부를 나타내는 부울 값입니다.
- 반환 값 예제:
{ "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 - 원래 메소드 이름:
requestMint - 이 메서드는 광부가 지정된 양의 토큰을 만들기 위해 광부 공증에 요청을 보내기 위해 호출할 수 있습니다.
- 페이로드:
{ "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 } - 매개변수:
tokenId: string– 민트할 토큰의 ID입니다.operationId: string– 민트 요청을 나타내는 고유한 작업 ID입니다.notaryOrgId: string– 요청을 처리할 광부 공증인의 멤버쉽 서비스 제공자(MSP) ID입니다.notaryUserId: string– 요청을 처리할 광부 공증인의 사용자 이름 또는 전자메일 ID입니다.quantity: number– 민트할 토큰의 양입니다.timeToExpiration– 민팅 요청이 만료되어 더 이상 유효하지 않은 시간입니다.infoDetails: JSON– 다음 예와 같이 요청의 범주(category) 및 설명(description)을 지정하는 객체입니다.{ "category" : "category input", "description" : "description input" }sameOrgEndorser: boolean– 트랜잭션 보증이 요청자와 동일한 조직에서 온 것인지 여부를 나타내는 부울 값입니다.
- 반환 값 예제:
{ "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 - 원래 메소드 이름:
setMaxDailyAmount - 이 POST 메소드는 지정된 금액에 대한 계정 세부정보에서
maxDailyAmount매개변수를 설정하는 데 사용됩니다. 이 메소드는 체인 코드의Token Admin또는 지정된 조직의Org Admin에 의해서만 호출될 수 있습니다. - 페이로드:
{ "orgId": "{{bc-org-id}}", "userId": "{{bc-user-id}}", "tokenId": "{{bc-token-id}}", "maxDailyAmount": 1, "endorsers": {{endorsers}} } - 매개변수:
orgId: string– 현재 조직에 있는 사용자의 멤버쉽 서비스 공급자(MSP) ID입니다.userId: string– 사용자의 사용자 이름 또는 전자메일 ID입니다.tokenId: string– 토큰 ID입니다.maxDailyAmount: number– 지정된 계정에 대한 최대 일별 금액 값으로, 일별로 처리할 수 있는 최대 금액을 정의합니다.endorsers: string[]– 트랜잭션을 보증해야 하는 피어의 배열(예:peer1,peer2)입니다.
- 반환 값 예제:
{ "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 - 원래 메소드 이름:
setMaxDailyTransactionCount - 이 POST 메소드는 지정된 금액에 대한 계정 세부정보에서
maxDailyTransactions매개변수를 설정하는 데 사용됩니다. 이 메소드는 체인 코드의Token Admin또는 지정된 조직의Org Admin에 의해서만 호출될 수 있습니다. - 페이로드:
{ "orgId": "{{bc-org-id}}", "userId": "{{bc-user-id}}", "tokenId": "{{bc-token-id}}", "maxDailyTransactions": 1, "endorsers": {{endorsers}} } - 매개변수:
orgId: string– 현재 조직에 있는 사용자의 멤버쉽 서비스 공급자(MSP) ID입니다.userId: string– 사용자의 사용자 이름 또는 전자메일 ID입니다.tokenId: string– 토큰 ID입니다.maxDailyTransactions: number– 지정된 계정에 대한 최대 일별 금액 값으로, 일별 허용되는 최대 트랜잭션 수를 정의합니다.endorsers: string[]– 트랜잭션을 보증해야 하는 피어의 배열(예:peer1,peer2)입니다.
- 반환 값 예제:
{ "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 - 원래 메소드 이름:
suspendAccount - 이 방법은 대체 가능한 토큰 계정을 일시 중지합니다. 원장에서
accountStatus값을 찾을 수 없는 경우 오류가 발생합니다. 이 메소드는 체인 코드의Token Admin또는 지정된 조직의Org Admin에 의해서만 호출될 수 있습니다. - 페이로드:
{ "tokenId": "{{bc-token-id}}", "orgId": "{{bc-org-id}}", "userId": "{{bc-user-id}}", "endorsers": {{endorsers}} } - 매개변수:
tokenId: string– 토큰 ID입니다.orgId: string– 현재 조직에 있는 사용자의 멤버쉽 서비스 공급자(MSP) ID입니다.userId: string– 사용자의 사용자 이름 또는 전자메일 ID입니다.endorsers: string[]– 트랜잭션을 보증해야 하는 피어의 배열(예:peer1,peer2)입니다.
- 반환 값 예제:
{ "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 - 원래 메소드 이름:
transferTokens - 이 방법은 호출자의 토큰을 지정된 계정으로 전송합니다. 메소드 호출자는 계정을 가져야 합니다. 수량은 사양 파일에서
divisible동작의decimal매개변수에 의해 지정된 십진수 값 내에 있어야 합니다. - 페이로드:
{ "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}} } - 매개변수:
tokenId: string– 토큰 ID입니다.toOrgId: string– 현재 조직에서 수신자(수취인)의 멤버쉽 서비스 제공자(MSP) ID입니다.toUserId: string– 수신자의 사용자 이름 또는 전자 메일 ID입니다.quantity: number– 전송할 토큰 수입니다.infoDetails: JSON– 다음 예와 같이 요청의 범주(category) 및 설명(description)을 지정하는 객체입니다.{ "category" : "category input", "description" : "description input" }endorsers: string[]– 트랜잭션을 보증해야 하는 피어의 배열(예:peer1,peer2)입니다.
- 반환 값 예제:
{ "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 - 원래 메소드 이름:
updateAccountPolicyCheck - 이 방법은 지정된 계정에 대한 정책을 업데이트합니다. 이 메소드는 지정된 조직의
Token Admin또는Org Admin에 의해서만 호출될 수 있습니다. - 페이로드:
{ "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}} } - 매개변수:
asset: AccountPolicyCheck object– 다음 필드를 포함하는 계정 정책 매개변수를 정의하는 객체입니다.accountPolicyId– 고유한 계정 정책 ID입니다.orgId– 정책을 만들 사용자의 멤버쉽 서비스 공급자(MSP) ID입니다.userId– 정책을 만들 사용자의 사용자 이름 또는 전자 메일 ID입니다.kycCompliance– 계정이 KYC(Know Your Customer) 요구 사항을 충족하는지 여부를 나타내는 부울 값입니다.amlCompliance– 계정이 AML(Anti-Money Laundering) 요구 사항을 충족하는지 여부를 나타내는 부울 값입니다.riskScore– 준수 평가에 사용되는 계정과 연관된 위험 점수입니다.restrictionFlag– 계정에 제한된 이전이 적용되는지 여부를 나타내는 부울 값입니다.true로 설정된 경우 최저 승인 정책 임계값 내 전송만 허용됩니다.
endorsers: string[]– 트랜잭션을 보증해야 하는 피어의 배열(예:peer1,peer2)입니다.
- 반환 값 예제:
{ "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 - 원래 메소드 이름:
updateApprovalPolicyCheck - 이 방법은 승인 정책을 업데이트합니다. 이 메소드는
Token Admin에 의해서만 호출될 수 있습니다. - 페이로드:
{ "asset": "{\"approvalPolicyId\":\"approvalPolicyId value\",\"transactionLowerLimit\":\"transactionLowerLimit value\",\"transactionUpperLimit\":\"transactionUpperLimit value\",\"numberOfApprovalsRequired\":999,\"approverDetails\":[{\"approverOrgId\":\"approverOrgId value\",\"approverUserId\":\"approverUserId value\",\"approvalSequence\":999}]}", "endorsers": {{endorsers}} } - 매개변수:
asset: ApprovalPolicyCheck class– 다음 필드를 포함하는 트랜잭션에 대한 승인 규칙을 정의하는 클래스입니다.approvalPolicyId– 고유한 승인 정책 ID입니다.transactionLowerLimit– 승인 정책이 적용되는 최소 거래 금액입니다.transactionUpperLimit– 승인 정책이 적용되는 최대 트랜잭션 금액입니다.numberOfApprovalsRequired– 트랜잭션을 완료하기 전에 필요한 총 승인 수입니다.approverDetails– 승인에 대한 필수 순서를 정의하는 지정된 승인 순서와 함께 승인자 목록입니다.
endorsers: string[]– 트랜잭션을 보증해야 하는 피어의 배열(예:peer1,peer2)입니다.
- 반환 값 예제:
{ "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 - 원래 메소드 이름:
updateStablecoinToken - 이 방법은 stablecoin 토큰을 업데이트합니다. 이 메소드는
Token Admin에 의해서만 호출될 수 있습니다. - 페이로드:
{ "tokenAsset": "{\"token_id\":\"{{bc-token-id}}\",\"token_desc\":\"token_desc value\",\"currencyName\":\"currencyName value\",\"conversionRate\":999}", "endorsers": {{endorsers}} } - 매개변수:
asset <Token Class>– 토큰 자산이 이 메소드에 매개변수로 전달됩니다. 토큰 자산의 속성은 다를 수 있으며 토큰 사양 파일에 설명되어 있습니다. 사양 파일에 읽기 전용으로 표시된 매개변수는 포함하지 마십시오.Visual Studio Code와 CLI 또는 Postman 컬렉션을 사용하는 경우
asset매개변수를 다른 형식으로 지정합니다.Visual Studio 코드: GUI를 사용하여 토큰 클래스 필드에 해당하는 개별 매개변수를 전달합니다.
CLI / Postman: 다음 예와 같이 토큰 사양 필드를 포함하는 직렬화된 JSON 문자열을 전달합니다.
"{\"token_id\":\"USD\",\"token_desc\":\"token_desc value\",\"Currency_Name\":\"Currency_Name value\"}"endorsers: string[]– 트랜잭션을 보증해야 하는 피어의 배열(예:peer1,peer2)입니다.
- 반환 값 예제:
{ "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 - 원래 메소드 이름:
createStablecoinAccount - 이 커스텀 래퍼 API는 체인코드 API와 Oracle Blockchain Platform 콘솔 API를 하나의 엔드포인트로 결합합니다. 이 방법은 다음 단계를 순서대로 완료합니다.
- 인스턴스의 REST 프록시에서 사용자에 대한 등록 ID를 생성합니다. 사용자 ID에 대한 등록이 이미 있는 경우 등록이 다시 생성되지 않습니다. 등록 ID는 사용자 ID와 동일합니다. 등록 ID에는 영숫자, 하이픈(-) 및 밑줄(_)만 포함될 수 있습니다. 사용자 ID에 다른 특수 문자가 포함되어 있으면 밑줄(_)로 바뀝니다.
- 원장에서 계정을 생성합니다.
- 새 계정을 지정된 토큰과 연관시킵니다.
- 지정된 역할을 사용자에게 지정합니다.
- 페이로드:
{ "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}" } - 매개변수:
orgId– 계정을 만들 사용자의 멤버쉽 서비스 공급자(MSP) ID입니다. ID는 영숫자로 시작해야 하며 문자, 숫자 및 밑줄(_), 마침표(.), @ 기호 및 하이픈(-)과 같은 특수 문자를 포함할 수 있습니다.userId– 사용자의 사용자 이름 또는 전자메일 ID입니다. ID는 영숫자로 시작해야 하며 문자, 숫자 및 밑줄(_), 마침표(.), @ 기호 및 하이픈(-)과 같은 특수 문자를 포함할 수 있습니다.tokenId: string– 토큰 ID로, 영숫자로 시작해야 하며 문자, 숫자 및 특수 문자 밑줄(_)과 하이픈(-)을 포함할 수 있습니다. 설명은 길이가 16자를 초과할 수 없습니다.role: string– 지정된 사용자에게 추가할 역할의 이름으로,minter,burner,notary,tokenAdmin,tokenAuditor,orgAdmin또는orgAuditor값 중 하나여야 합니다.dailyLimits: JSON object– 다음 유형의 JSON 객체입니다.
예제에서{ "max_daily_amount": 100000 "max_daily_transactions": 10000 }max_daily_amount값은 매일 트랜잭션할 수 있는 최대 토큰 수이고max_daily_transactions값은 매일 완료할 수 있는 최대 트랜잭션 수입니다.
- 반환값:
- 성공 시 생성된 계정의 JSON 객체입니다.
- 반환 값 예제:
"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 - 원래 메소드 이름:
createIDCSUser - 이 POST 메소드는
terraform.tfvars파일의 URL로 지정된 테넌시에 Identity Cloud Service 사용자를 생성하고 지정된 사용자 그룹에 사용자를 지정합니다. - 페이로드:
{ "userName": "userName value", "firstName": "firstName value", "lastName": "lastName value", "email": "email value", "groupName": "groupName value" } - 매개변수:
userName: string– 사용자의 ID입니다.firstName: string– 사용자의 이름입니다.lastName: string– 사용자의 성입니다.email: string– 사용자의 전자메일 주소입니다.groupName: string– 사용자에게 지정할 Identity Cloud Service 그룹의 이름입니다.
- 반환 값 예제:
{ "status": "Success", "msg": "User user1 is created and assigned to the group BOND_ADMIN" }