{ "openapi":"3.1.0", "info":{ "title":"Wholesale CBDC Application Wrapper APIs", "version":"2026.10.23", "description":"Wholesale CBDC Application Wrapper APIs", "x-source-postman-collection":"OBP DA Besu - wcbdc-wrapper-api.postman.collection", "x-source-postman-schema":"https://schema.getpostman.com/json/collection/v2.1.0/collection.json", "x-postman-oauth2":{ "grant_type":"password_credentials", "accessTokenUrl":"{{accessTokenUrl}}", "clientId":"{{clientId}}", "clientSecret":"{{clientSecret}}", "username":"{{username}}", "password":"{{password}}", "scope":"openid profile email", "tokenType":"Bearer", "headerPrefix":"Bearer", "client_authentication":"header" }, "x-sources":[ "UWAAS OpenAPI 3.0.3 supplied by user; responses merged for wrapper UWAAS operations." ], "x-summary":"Wholesale CBDC Application Wrapper APIs" }, "servers":[ { "url":"{baseUrl}/v1", "description":"Postman baseUrl", "variables":{ "baseUrl":{ "default":"http://localhost:7171" } } } ], "tags":[ { "name":"Account Contract Endpoints" }, { "name":"Combined APIs" }, { "name":"ORDS Endpoints" }, { "name":"Schema Registration" }, { "name":"Token Contract Endpoints" }, { "name":"UWaaS" } ], "paths":{ "/uwaas/wallets/provision":{ "post":{ "summary":"Create Wallet", "description":"Creates a wallet and its required UWaaS dependencies.", "operationId":"createWallet", "tags":[ "UWaaS" ], "responses":{ "201":{ "description":"Dependencies were created or reused and the wallet was created\nsuccessfully.", "content":{ "application/json":{ "schema":{ "$ref":"#/components/schemas/UWAAS_ProvisionWalletResponse" }, "example":{ "org":{ "orgId":"default_org", "status":"ACTIVE", "created":false }, "network":{ "orgNetworkId":4, "instanceId":"instance-uuid1", "blockchainType":"BESU", "chainId":"1337", "created":false }, "user":{ "userId":"8e7f524d-8169-4906-8935-e5cac5a7a12a", "created":false }, "wallet":{ "walletId":"f3f0716b-2bb3-4be8-ad14-f5d3a7f472aa", "orgId":"default_org", "orgNetworkId":4, "instanceId":"instance-uuid1", "blockchainType":"BESU", "userId":"8e7f524d-8169-4906-8935-e5cac5a7a12a", "status":"ACTIVE", "label":"UWaaS-auxiliary", "type":"1", "typeLabel":"Custodial", "address":"892559096986040148078983319356094749533173882025", "createdDate":"2026-07-28T12:41:36Z", "updatedDate":"2026-07-28T12:41:36Z", "createdBy":"117eacd9-387e-4505-baa1-78782fb9c123", "walletTags":[ "a:erc20", "e:dev" ], "created":true } } } } }, "400":{ "description":"Missing required field, malformed JSON, or invalid request\nvalue.", "content":{ "application/json":{ "schema":{ "$ref":"#/components/schemas/Wrapper_Error" } } } }, "405":{ "description":"Only POST is supported.", "content":{ "application/json":{ "schema":{ "$ref":"#/components/schemas/Wrapper_Error" } } } }, "415":{ "description":"Content-Type must be application/json.", "content":{ "application/json":{ "schema":{ "$ref":"#/components/schemas/Wrapper_Error" } } } }, "502":{ "$ref":"#/components/responses/Wrapper_BadGateway" } }, "x-postman-request-name":"createWallet", "requestBody":{ "required":true, "content":{ "application/json":{ "schema":{ "$ref":"#/components/schemas/CreateWalletRequest" }, "example":{ "org":{ "orgId":"{{orgId}}", "organizationName":"Acme Corp", "status":"ACTIVE", "description":"wrapper-test-description" }, "instanceId":"{{instanceId}}", "wallet":{ "user":{ "userId":"{{userId}}", "displayName":"Example User", "email":"user@example.com", "roleId":1, "status":"ACTIVE" }, "walletLabel":"UWaaS-auxiliary", "walletType":"1", "status":"ACTIVE", "walletTags":[ "e:dev", "a:erc20" ] } } } } }, "x-contract-endpoint-name":"provision", "x-internal-id":"uwaas-wallets-provision-post", "x-filename-id":"uwaas-wallets-provision-post" } }, "/uwaas/wallets":{ "get":{ "summary":"Get Wallets", "description":"Retrieves wallets that match the specified organization, user, and instance criteria.", "operationId":"getWallets", "tags":[ "UWaaS" ], "responses":{ "200":{ "description":"Wallets retrieved successfully.", "content":{ "application/json":{ "schema":{ "$ref":"#/components/schemas/UWAAS_ListWalletsEnvelope" }, "example":{ "status":"success", "payload":{ "items":[ { "walletId":"ba73f0d0-93f7-483c-93df-1d46705bd379", "orgId":"default_org", "orgNetworkId":4, "instanceId":"instance-uuid1", "blockchainType":"BESU", "userId":"8e7f524d-8169-4906-8935-e5cac5a7a12a", "status":"ACTIVE", "label":"UWaaS-auxiliary", "type":"1", "typeLabel":"Custodial", "address":"892559096986040148078983319356094749533173882025", "createdDate":"2026-07-28T12:41:36Z", "updatedDate":"2026-07-28T12:41:36Z", "createdBy":"117eacd9-387e-4505-baa1-78782fb9c123", "walletTags":[ "a:erc20", "e:dev" ] } ] } } } } }, "400":{ "$ref":"#/components/responses/UWAAS_BadRequest" }, "502":{ "$ref":"#/components/responses/Wrapper_BadGateway" } }, "x-postman-request-name":"getWallets", "parameters":[ { "name":"orgId", "in":"query", "required":false, "schema":{ "type":"string", "default":"acmeCorp" } }, { "name":"userId", "in":"query", "required":false, "schema":{ "type":"string" } }, { "name":"instanceId", "in":"query", "required":false, "schema":{ "type":"string" } }, { "name":"pageSize", "in":"query", "required":false, "schema":{ "type":"integer", "format":"int64", "default":"5" } } ], "x-contract-endpoint-name":"wallets", "x-internal-id":"uwaas-wallets-get", "x-filename-id":"uwaas-wallets-get" } }, "/uwaas/orgs":{ "post":{ "summary":"Create Organization", "description":"Creates an organization in UWaaS.", "operationId":"createOrg", "tags":[ "UWaaS" ], "responses":{ "200":{ "description":"Organization created successfully.", "content":{ "application/json":{ "schema":{ "$ref":"#/components/schemas/UWAAS_OrganizationEnvelope" }, "example":{ "status":"success", "payload":{ "orgId":"org-99762dae-9962-4523-ad30-d2b51fd3b06c", "organizationName":"Cummings - Streich", "description":"This is a company.", "tags":[ "jurisdiction:us" ], "status":"ACTIVE", "isDeleted":false, "createdAt":"2026-07-13T17:55:06.936218622Z", "createdBy":"08819d29-de56-48ea-a140-bc4ac73952ed", "updatedAt":"2026-07-13T17:55:06.936218622Z" } } } } }, "400":{ "$ref":"#/components/responses/UWAAS_BadRequest" }, "502":{ "$ref":"#/components/responses/Wrapper_BadGateway" } }, "x-postman-request-name":"createOrg", "requestBody":{ "required":true, "content":{ "application/json":{ "schema":{ "$ref":"#/components/schemas/CreateOrgRequest" }, "example":{ "orgId":"{{orgId}}", "organizationName":"Test org", "tags":[ "seq:1", "isFounder:false" ], "description":"This is a test company.", "status":"ACTIVE" } } } }, "x-contract-endpoint-name":"orgs", "x-internal-id":"uwaas-orgs-post", "x-filename-id":"uwaas-orgs-post" }, "get":{ "summary":"Get Organizations", "description":"Retrieves the organizations configured in UWaaS.", "operationId":"getOrgs", "tags":[ "UWaaS" ], "responses":{ "200":{ "description":"Organizations retrieved successfully.", "content":{ "application/json":{ "schema":{ "$ref":"#/components/schemas/UWAAS_ListOrganizationsEnvelope" }, "example":{ "status":"success", "payload":{ "items":[ { "orgId":"org-99762dae-9962-4523-ad30-d2b51fd3b06c", "organizationName":"Cummings - Streich", "description":"This is a company.", "tags":[ "jurisdiction:us" ], "status":"ACTIVE", "isDeleted":false, "createdAt":"2026-07-13T17:55:07Z", "createdBy":"08819d29-de56-48ea-a140-bc4ac73952ed", "updatedAt":"2026-07-13T17:55:07Z" } ], "nextPageToken":"djF8VTJOb2FXMXRaV3dnU1c1anw4" } } } } }, "400":{ "$ref":"#/components/responses/UWAAS_BadRequest" }, "502":{ "$ref":"#/components/responses/Wrapper_BadGateway" } }, "x-postman-request-name":"getOrgs", "x-contract-endpoint-name":"orgs", "parameters":[ { "name":"chainId", "in":"query", "required":false, "schema":{ "type":"string" }, "description":"Optional blockchain chain identifier." }, { "name":"pageSize", "in":"query", "required":false, "schema":{ "type":"integer", "default":50 }, "description":"Maximum organizations to return." }, { "name":"nextPageToken", "in":"query", "required":false, "schema":{ "type":"string" }, "description":"Opaque cursor returned by the previous page." } ], "x-internal-id":"uwaas-orgs-get", "x-filename-id":"uwaas-orgs-get" } }, "/uwaas/orgs/{orgId}":{ "put":{ "summary":"Update Organization", "description":"Updates the specified UWaaS organization.", "operationId":"updateOrg", "tags":[ "UWaaS" ], "responses":{ "200":{ "description":"Organization updated successfully.", "content":{ "application/json":{ "schema":{ "$ref":"#/components/schemas/UWAAS_OrganizationEnvelope" } } } }, "400":{ "$ref":"#/components/responses/UWAAS_BadRequest" }, "401":{ "$ref":"#/components/responses/UWAAS_Unauthorized" }, "404":{ "$ref":"#/components/responses/UWAAS_NotFound" }, "405":{ "description":"Only PUT is supported.", "content":{ "application/json":{ "schema":{ "$ref":"#/components/schemas/Wrapper_Error" } } } }, "415":{ "description":"Content-Type must be application/json.", "content":{ "application/json":{ "schema":{ "$ref":"#/components/schemas/Wrapper_Error" } } } }, "502":{ "$ref":"#/components/responses/Wrapper_BadGateway" } }, "x-postman-request-name":"updateOrg", "parameters":[ { "name":"orgId", "in":"path", "required":true, "schema":{ "type":"string" }, "description":"Path parameter" } ], "requestBody":{ "required":true, "content":{ "application/json":{ "schema":{ "$ref":"#/components/schemas/UpdateOrgRequest" }, "example":{ "organizationName":"Test org", "tags":[ "seq:2", "isFounder:false" ], "description":"This is a test company.", "status":"ACTIVE" } } } }, "x-contract-endpoint-name":"{orgId}", "x-internal-id":"uwaas-orgs-{orgId}-put", "x-filename-id":"uwaas-orgs-orgid-put" } }, "/register":{ "post":{ "summary":"Register Contract Endpoints", "operationId":"register_wholesale_cbdctoken_holdable_endpoints", "tags":[ "Schema Registration" ], "responses":{ "200":{ "description":"Contract template registered successfully.", "content":{ "application/json":{ "schema":{ "$ref":"#/components/schemas/Register_SuccessResponse" } } } }, "400":{ "$ref":"#/components/responses/Wrapper_BadRequest" }, "401":{ "$ref":"#/components/responses/Wrapper_Unauthorized" }, "415":{ "$ref":"#/components/responses/Wrapper_UnsupportedMediaType" }, "502":{ "$ref":"#/components/responses/Wrapper_BadGateway" } }, "x-postman-request-name":"POST register - wholesale-cbdctoken-holdable-endpoints", "requestBody":{ "required":true, "content":{ "application/json":{ "schema":{ "$ref":"#/components/schemas/RegisterRequest" }, "examples":{ "wholesaleCbdcTokenHoldable":{ "summary":"Wholesale CBDC token / holdable contract registration", "value":{ "contractAddress":"", "writeConfigs":{ "type":2, "gasLimit":2500000, "waitForReceipt":true, "receiptWaitMs":1000, "receiptMaxTries":60, "decode":{ "inputs":true, "events":true, "errors":true } }, "readConfigs":{ "blockTag":"latest", "decode":{ "outputs":true, "errors":true } }, "endpoints":[ { "path":"allowance", "httpMethod":"GET", "contractMethod":{ "name":"allowance", "signature":"allowance(address,address)" }, "args":[ "owner", "spender" ], "generatePostmanApi":true }, { "path":"approve", "httpMethod":"POST", "contractMethod":{ "name":"approve", "signature":"approve(address,uint256)" }, "args":[ "spender", "value" ], "generatePostmanApi":true }, { "path":"approveBurn", "httpMethod":"POST", "contractMethod":{ "name":"approveBurn", "signature":"approveBurn(string)" }, "args":[ "opId" ], "generatePostmanApi":true }, { "path":"approveMint", "httpMethod":"POST", "contractMethod":{ "name":"approveMint", "signature":"approveMint(string)" }, "args":[ "opId" ], "generatePostmanApi":true }, { "path":"balanceOf", "httpMethod":"GET", "contractMethod":{ "name":"balanceOf", "signature":"balanceOf(address)" }, "args":[ "account" ], "generatePostmanApi":true }, { "path":"batchTransfer", "httpMethod":"POST", "contractMethod":{ "name":"batchTransfer", "signature":"batchTransfer(address[],uint256[])" }, "args":[ "toList", "amounts" ], "generatePostmanApi":true }, { "path":"burn", "httpMethod":"POST", "contractMethod":{ "name":"burn", "signature":"burn(uint256)" }, "args":[ "value" ], "generatePostmanApi":true }, { "path":"burnFrom", "httpMethod":"POST", "contractMethod":{ "name":"burnFrom", "signature":"burnFrom(address,uint256)" }, "args":[ "account", "value" ], "generatePostmanApi":true }, { "path":"cap", "httpMethod":"GET", "contractMethod":{ "name":"cap", "signature":"cap()" }, "args":[ ], "generatePostmanApi":true }, { "path":"decimals", "httpMethod":"GET", "contractMethod":{ "name":"decimals", "signature":"decimals()" }, "args":[ ], "generatePostmanApi":true }, { "path":"executeHold", "httpMethod":"POST", "contractMethod":{ "name":"executeHold", "signature":"executeHold(string,uint256)" }, "args":[ "opId", "amount" ], "generatePostmanApi":true }, { "path":"getAccountOnHoldBalance", "httpMethod":"GET", "contractMethod":{ "name":"getAccountOnHoldBalance", "signature":"getAccountOnHoldBalance(address)" }, "args":[ "account" ], "generatePostmanApi":true }, { "path":"getGovernanceContext", "httpMethod":"GET", "contractMethod":{ "name":"getGovernanceContext", "signature":"getGovernanceContext()" }, "args":[ ], "generatePostmanApi":true }, { "path":"getOnHoldBalanceWithOperationId", "httpMethod":"GET", "contractMethod":{ "name":"getOnHoldBalanceWithOperationId", "signature":"getOnHoldBalanceWithOperationId(string)" }, "args":[ "opId" ], "generatePostmanApi":true }, { "path":"getOnHoldDetailsWithOperationId", "httpMethod":"GET", "contractMethod":{ "name":"getOnHoldDetailsWithOperationId", "signature":"getOnHoldDetailsWithOperationId(string)" }, "args":[ "opId" ], "generatePostmanApi":true }, { "path":"getToken", "httpMethod":"GET", "contractMethod":{ "name":"getToken", "signature":"getToken()" }, "args":[ ], "generatePostmanApi":true }, { "path":"getTokenContext", "httpMethod":"GET", "contractMethod":{ "name":"getTokenContext", "signature":"getTokenContext()" }, "args":[ ], "generatePostmanApi":true }, { "path":"hold", "httpMethod":"POST", "contractMethod":{ "name":"hold", "signature":"hold(address,address,uint256,uint256,string,string,(string,string))" }, "args":[ "to", "notary", "amount", "expiration", "opId", "holdType", "info" ], "argDefinitions":{ "info":{ "kind":"tuple", "fields":[ { "name":"category" }, { "name":"description" } ] } }, "generatePostmanApi":true }, { "path":"holdFrom", "httpMethod":"POST", "contractMethod":{ "name":"holdFrom", "signature":"holdFrom(address,address,address,uint256,uint256,string,string,(string,string))" }, "args":[ "fromAccount", "to", "notary", "amount", "expiration", "opId", "holdType", "info" ], "argDefinitions":{ "info":{ "kind":"tuple", "fields":[ { "name":"category" }, { "name":"description" } ] } }, "generatePostmanApi":true }, { "path":"initializeCBDCToken", "httpMethod":"POST", "contractMethod":{ "name":"initializeCBDCToken", "signature":"initializeCBDCToken((string,string,string,string,string,string,string[],uint8,(uint256,bool),(bool)))" }, "args":[ "token" ], "argDefinitions":{ "token":{ "kind":"tuple", "fields":[ { "name":"tokenId" }, { "name":"tokenName" }, { "name":"tokenDesc" }, { "name":"tokenStandard" }, { "name":"tokenType" }, { "name":"tokenUnit" }, { "name":"behaviors", "kind":"array", "items":{ "kind":"scalar" } }, { "name":"decimals" }, { "name":"mintable", "kind":"tuple", "fields":[ { "name":"maxMintQuantity" }, { "name":"mintApprovalRequired" } ] }, { "name":"burnable", "kind":"tuple", "fields":[ { "name":"burnApprovalRequired" } ] } ] } }, "generatePostmanApi":true }, { "path":"isDeploymentActive", "httpMethod":"GET", "contractMethod":{ "name":"isDeploymentActive", "signature":"isDeploymentActive()" }, "args":[ ], "generatePostmanApi":true }, { "path":"mint", "httpMethod":"POST", "contractMethod":{ "name":"mint", "signature":"mint(address,uint256)" }, "args":[ "to", "value" ], "generatePostmanApi":true }, { "path":"name", "httpMethod":"GET", "contractMethod":{ "name":"name", "signature":"name()" }, "args":[ ], "generatePostmanApi":true }, { "path":"pause", "httpMethod":"POST", "contractMethod":{ "name":"pause", "signature":"pause()" }, "args":[ ], "generatePostmanApi":true }, { "path":"paused", "httpMethod":"GET", "contractMethod":{ "name":"paused", "signature":"paused()" }, "args":[ ], "generatePostmanApi":true }, { "path":"rejectBurn", "httpMethod":"POST", "contractMethod":{ "name":"rejectBurn", "signature":"rejectBurn(string)" }, "args":[ "opId" ], "generatePostmanApi":true }, { "path":"rejectMint", "httpMethod":"POST", "contractMethod":{ "name":"rejectMint", "signature":"rejectMint(string)" }, "args":[ "opId" ], "generatePostmanApi":true }, { "path":"releaseHold", "httpMethod":"POST", "contractMethod":{ "name":"releaseHold", "signature":"releaseHold(string)" }, "args":[ "opId" ], "generatePostmanApi":true }, { "path":"requestBurn", "httpMethod":"POST", "contractMethod":{ "name":"requestBurn", "signature":"requestBurn(address,uint256,uint256,string,(string,string))" }, "args":[ "notary", "amount", "expiration", "opId", "info" ], "argDefinitions":{ "info":{ "kind":"tuple", "fields":[ { "name":"category" }, { "name":"description" } ] } }, "generatePostmanApi":true }, { "path":"requestMint", "httpMethod":"POST", "contractMethod":{ "name":"requestMint", "signature":"requestMint(address,uint256,uint256,string,(string,string))" }, "args":[ "notary", "amount", "expiration", "opId", "info" ], "argDefinitions":{ "info":{ "kind":"tuple", "fields":[ { "name":"category" }, { "name":"description" } ] } }, "generatePostmanApi":true }, { "path":"setGovernanceContext", "httpMethod":"POST", "contractMethod":{ "name":"setGovernanceContext", "signature":"setGovernanceContext(string,address)" }, "args":[ "uuid", "governance" ], "generatePostmanApi":true }, { "path":"setTokenContext", "httpMethod":"POST", "contractMethod":{ "name":"setTokenContext", "signature":"setTokenContext(address,address)" }, "args":[ "identityGateway", "policyGateway" ], "generatePostmanApi":true }, { "path":"symbol", "httpMethod":"GET", "contractMethod":{ "name":"symbol", "signature":"symbol()" }, "args":[ ], "generatePostmanApi":true }, { "path":"totalSupply", "httpMethod":"GET", "contractMethod":{ "name":"totalSupply", "signature":"totalSupply()" }, "args":[ ], "generatePostmanApi":true }, { "path":"transfer", "httpMethod":"POST", "contractMethod":{ "name":"transfer", "signature":"transfer(address,uint256)" }, "args":[ "to", "value" ], "generatePostmanApi":true }, { "path":"transferFrom", "httpMethod":"POST", "contractMethod":{ "name":"transferFrom", "signature":"transferFrom(address,address,uint256)" }, "args":[ "from", "to", "value" ], "generatePostmanApi":true }, { "path":"unpause", "httpMethod":"POST", "contractMethod":{ "name":"unpause", "signature":"unpause()" }, "args":[ ], "generatePostmanApi":true }, { "path":"updateNotary", "httpMethod":"POST", "contractMethod":{ "name":"updateNotary", "signature":"updateNotary(string,address)" }, "args":[ "opId", "newNotary" ], "generatePostmanApi":true }, { "path":"version", "httpMethod":"GET", "contractMethod":{ "name":"version", "signature":"version()" }, "args":[ ], "generatePostmanApi":true }, { "backendOverrideOrds":"true", "ordsBaseUrl":"{{ordsHost}}", "path":"/{{ordsPathPrefix}}/getAllActiveCBDCAccounts", "httpMethod":"GET", "contractMethod":{ "name":"getAllActiveCBDCAccounts", "signature":"getAllActiveCBDCAccounts(string)" }, "args":[ "token_id" ] }, { "backendOverrideOrds":"true", "ordsBaseUrl":"{{ordsHost}}", "path":"/{{ordsPathPrefix}}/getAllCBDCAccountTransactionHistoryWithFilters", "httpMethod":"GET", "contractMethod":{ "name":"getAllCBDCAccountTransactionHistoryWithFilters", "signature":"getAllCBDCAccountTransactionHistoryWithFilters(string,string,string,string,string)" }, "args":[ "bookmark", "endTime", "pageSize", "startTime", "token_id" ] }, { "backendOverrideOrds":"true", "ordsBaseUrl":"{{ordsHost}}", "path":"/{{ordsPathPrefix}}/getAllCBDCAccounts", "httpMethod":"GET", "contractMethod":{ "name":"getAllCBDCAccounts", "signature":"getAllCBDCAccounts(string)" }, "args":[ "token_id" ] }, { "backendOverrideOrds":"true", "ordsBaseUrl":"{{ordsHost}}", "path":"/{{ordsPathPrefix}}/getAllOrgAccounts", "httpMethod":"GET", "contractMethod":{ "name":"getAllOrgAccounts", "signature":"getAllOrgAccounts(string)" }, "args":[ "org_id" ] }, { "backendOverrideOrds":"true", "ordsBaseUrl":"{{ordsHost}}", "path":"/{{ordsPathPrefix}}/getAllRegisteredOrgs", "httpMethod":"GET", "contractMethod":{ "name":"getAllRegisteredOrgs", "signature":"getAllRegisteredOrgs(string)" }, "args":[ "token_id" ] }, { "backendOverrideOrds":"true", "ordsBaseUrl":"{{ordsHost}}", "path":"/{{ordsPathPrefix}}/getAllSuspendedCBDCAccounts", "httpMethod":"GET", "contractMethod":{ "name":"getAllSuspendedCBDCAccounts", "signature":"getAllSuspendedCBDCAccounts(string)" }, "args":[ "token_id" ] }, { "backendOverrideOrds":"true", "ordsBaseUrl":"{{ordsHost}}", "path":"/{{ordsPathPrefix}}/getApproverActionHistory", "httpMethod":"GET", "contractMethod":{ "name":"getApproverActionHistory", "signature":"getApproverActionHistory(string,string)" }, "args":[ "caller_account_id", "token_id" ] }, { "backendOverrideOrds":"true", "ordsBaseUrl":"{{ordsHost}}", "path":"/{{ordsPathPrefix}}/getCBDCAccountHistory", "httpMethod":"GET", "contractMethod":{ "name":"getCBDCAccountHistory", "signature":"getCBDCAccountHistory(string,string,string)" }, "args":[ "account_address", "limit", "offset" ] }, { "backendOverrideOrds":"true", "ordsBaseUrl":"{{ordsHost}}", "path":"/{{ordsPathPrefix}}/getCBDCAccountStatus", "httpMethod":"GET", "contractMethod":{ "name":"getCBDCAccountStatus", "signature":"getCBDCAccountStatus(string,string,string)" }, "args":[ "org_id", "token_id", "user_id" ] }, { "backendOverrideOrds":"true", "ordsBaseUrl":"{{ordsHost}}", "path":"/{{ordsPathPrefix}}/getCBDCAccountStatusHistory", "httpMethod":"GET", "contractMethod":{ "name":"getCBDCAccountStatusHistory", "signature":"getCBDCAccountStatusHistory(string,string,string)" }, "args":[ "org_id", "token_id", "user_id" ] }, { "backendOverrideOrds":"true", "ordsBaseUrl":"{{ordsHost}}", "path":"/{{ordsPathPrefix}}/getCBDCAccountTransactionHistoryWithFilters", "httpMethod":"GET", "contractMethod":{ "name":"getCBDCAccountTransactionHistoryWithFilters", "signature":"getCBDCAccountTransactionHistoryWithFilters(string,string,string,string,string,string,string)" }, "args":[ "bookmark", "endTime", "org_id", "pageSize", "startTime", "token_id", "user_id" ] }, { "backendOverrideOrds":"true", "ordsBaseUrl":"{{ordsHost}}", "path":"/{{ordsPathPrefix}}/getCBDCAccountsByRole", "httpMethod":"GET", "contractMethod":{ "name":"getCBDCAccountsByRole", "signature":"getCBDCAccountsByRole(string)" }, "args":[ "role" ] }, { "backendOverrideOrds":"true", "ordsBaseUrl":"{{ordsHost}}", "path":"/{{ordsPathPrefix}}/getCBDCAccountsByUser", "httpMethod":"GET", "contractMethod":{ "name":"getCBDCAccountsByUser", "signature":"getCBDCAccountsByUser(string,string,string)" }, "args":[ "org_id", "token_id", "user_id" ] }, { "backendOverrideOrds":"true", "ordsBaseUrl":"{{ordsHost}}", "path":"/{{ordsPathPrefix}}/getCBDCMetadata", "httpMethod":"GET", "contractMethod":{ "name":"getCBDCMetadata", "signature":"getCBDCMetadata(string)" }, "args":[ "token_id" ] }, { "backendOverrideOrds":"true", "ordsBaseUrl":"{{ordsHost}}", "path":"/{{ordsPathPrefix}}/getCBDCRetiredQuantity", "httpMethod":"GET", "contractMethod":{ "name":"getCBDCRetiredQuantity", "signature":"getCBDCRetiredQuantity(string)" }, "args":[ "token_id" ] }, { "backendOverrideOrds":"true", "ordsBaseUrl":"{{ordsHost}}", "path":"/{{ordsPathPrefix}}/getCBDCTransactionById", "httpMethod":"GET", "contractMethod":{ "name":"getCBDCTransactionById", "signature":"getCBDCTransactionById(string,string)" }, "args":[ "token_id", "transaction_id" ] }, { "backendOverrideOrds":"true", "ordsBaseUrl":"{{ordsHost}}", "path":"/{{ordsPathPrefix}}/getOrgAccountsByRole", "httpMethod":"GET", "contractMethod":{ "name":"getOrgAccountsByRole", "signature":"getOrgAccountsByRole(string,string)" }, "args":[ "org_id", "role" ] }, { "backendOverrideOrds":"true", "ordsBaseUrl":"{{ordsHost}}", "path":"/{{ordsPathPrefix}}/getPendingCBDCIssuance", "httpMethod":"GET", "contractMethod":{ "name":"getPendingCBDCIssuance", "signature":"getPendingCBDCIssuance(string,string)" }, "args":[ "caller_account_id", "token_id" ] }, { "backendOverrideOrds":"true", "ordsBaseUrl":"{{ordsHost}}", "path":"/{{ordsPathPrefix}}/getPendingCBDCRequest", "httpMethod":"GET", "contractMethod":{ "name":"getPendingCBDCRequest", "signature":"getPendingCBDCRequest(string,string)" }, "args":[ "request_type", "token_id" ] }, { "backendOverrideOrds":"true", "ordsBaseUrl":"{{ordsHost}}", "path":"/{{ordsPathPrefix}}/getPendingRequest", "httpMethod":"GET", "contractMethod":{ "name":"getPendingRequest", "signature":"getPendingRequest(string,string)" }, "args":[ "request_type", "token_id" ] }, { "backendOverrideOrds":"true", "ordsBaseUrl":"{{ordsHost}}", "path":"/{{ordsPathPrefix}}/getRolesByAccount", "httpMethod":"GET", "contractMethod":{ "name":"getRolesByAccount", "signature":"getRolesByAccount(string,string,string,string)" }, "args":[ "account_address", "org_id", "token_id", "user_id" ] }, { "backendOverrideOrds":"true", "ordsBaseUrl":"{{ordsHost}}", "path":"/{{ordsPathPrefix}}/getTokenHistory", "httpMethod":"GET", "contractMethod":{ "name":"getTokenHistory", "signature":"getTokenHistory(string)" }, "args":[ "token_id" ] }, { "backendOverrideOrds":"true", "ordsBaseUrl":"{{ordsHost}}", "path":"/{{ordsPathPrefix}}/getUsersByRole", "httpMethod":"GET", "contractMethod":{ "name":"getUsersByRole", "signature":"getUsersByRole(string)" }, "args":[ "role" ] } ] } }, "accountWithErc5982Uups":{ "summary":"Account / ERC-5982 UUPS contract registration", "value":{ "contractAddress":"", "writeConfigs":{ "type":2, "gasLimit":2500000, "waitForReceipt":true, "receiptWaitMs":1000, "receiptMaxTries":60, "decode":{ "inputs":true, "events":true, "errors":true } }, "readConfigs":{ "blockTag":"latest", "decode":{ "outputs":true, "errors":true } }, "endpoints":[ { "path":"activateAccount", "httpMethod":"POST", "contractMethod":{ "name":"activateAccount", "signature":"activateAccount(address)" }, "args":[ "userAddress" ], "generatePostmanApi":true }, { "path":"addOrgAdmin", "httpMethod":"POST", "contractMethod":{ "name":"addOrgAdmin", "signature":"addOrgAdmin((string,string,address))" }, "args":[ "adminDetails" ], "argDefinitions":{ "adminDetails":{ "kind":"tuple", "fields":[ { "name":"userId" }, { "name":"orgId" }, { "name":"accountAddress" } ] } }, "generatePostmanApi":true }, { "path":"addOrgAuditor", "httpMethod":"POST", "contractMethod":{ "name":"addOrgAuditor", "signature":"addOrgAuditor((string,string,address))" }, "args":[ "auditorDetails" ], "argDefinitions":{ "auditorDetails":{ "kind":"tuple", "fields":[ { "name":"userId" }, { "name":"orgId" }, { "name":"accountAddress" } ] } }, "generatePostmanApi":true }, { "path":"addRole", "httpMethod":"POST", "contractMethod":{ "name":"addRole", "signature":"addRole(address,string)" }, "args":[ "account", "role" ], "generatePostmanApi":true }, { "path":"addTokenAdmin", "httpMethod":"POST", "contractMethod":{ "name":"addTokenAdmin", "signature":"addTokenAdmin((string,string,address))" }, "args":[ "adminDetails" ], "argDefinitions":{ "adminDetails":{ "kind":"tuple", "fields":[ { "name":"userId" }, { "name":"orgId" }, { "name":"accountAddress" } ] } }, "generatePostmanApi":true }, { "path":"addTokenAuditor", "httpMethod":"POST", "contractMethod":{ "name":"addTokenAuditor", "signature":"addTokenAuditor((string,string,address))" }, "args":[ "auditorDetails" ], "argDefinitions":{ "auditorDetails":{ "kind":"tuple", "fields":[ { "name":"userId" }, { "name":"orgId" }, { "name":"accountAddress" } ] } }, "generatePostmanApi":true }, { "path":"createAccount", "httpMethod":"POST", "contractMethod":{ "name":"createAccount", "signature":"createAccount(string,string,address,int256,int256,string[])" }, "args":[ "userId", "orgId", "userAddress", "maxDailyAmount", "maxDailyTransactions", "applicationGroups" ], "generatePostmanApi":true }, { "path":"deleteAccount", "httpMethod":"POST", "contractMethod":{ "name":"deleteAccount", "signature":"deleteAccount(address)" }, "args":[ "userAddress" ], "generatePostmanApi":true }, { "path":"getAccountByAddress", "httpMethod":"GET", "contractMethod":{ "name":"getAccountByAddress", "signature":"getAccountByAddress(address)" }, "args":[ "userAddress" ], "generatePostmanApi":true }, { "path":"getAccountStatus", "httpMethod":"GET", "contractMethod":{ "name":"getAccountStatus", "signature":"getAccountStatus(address)" }, "args":[ "userAddress" ], "generatePostmanApi":true }, { "path":"getAllAccounts", "httpMethod":"GET", "contractMethod":{ "name":"getAllAccounts", "signature":"getAllAccounts(uint256,uint256)" }, "args":[ "offset", "limit" ], "generatePostmanApi":true }, { "path":"getAllOrgAdmins", "httpMethod":"GET", "contractMethod":{ "name":"getAllOrgAdmins", "signature":"getAllOrgAdmins()" }, "args":[ ], "generatePostmanApi":true }, { "path":"getAllOrgAuditors", "httpMethod":"GET", "contractMethod":{ "name":"getAllOrgAuditors", "signature":"getAllOrgAuditors()" }, "args":[ ], "generatePostmanApi":true }, { "path":"getAllTokenAdmins", "httpMethod":"GET", "contractMethod":{ "name":"getAllTokenAdmins", "signature":"getAllTokenAdmins()" }, "args":[ ], "generatePostmanApi":true }, { "path":"getAllTokenAuditors", "httpMethod":"GET", "contractMethod":{ "name":"getAllTokenAuditors", "signature":"getAllTokenAuditors()" }, "args":[ ], "generatePostmanApi":true }, { "path":"getContext", "httpMethod":"GET", "contractMethod":{ "name":"getContext", "signature":"getContext()" }, "args":[ ], "generatePostmanApi":true }, { "path":"getGovernanceContext", "httpMethod":"GET", "contractMethod":{ "name":"getGovernanceContext", "signature":"getGovernanceContext()" }, "args":[ ], "generatePostmanApi":true }, { "path":"getGroupId", "httpMethod":"GET", "contractMethod":{ "name":"getGroupId", "signature":"getGroupId(address)" }, "args":[ "account" ], "generatePostmanApi":true }, { "path":"getIdentity", "httpMethod":"GET", "contractMethod":{ "name":"getIdentity", "signature":"getIdentity(address)" }, "args":[ "account" ], "generatePostmanApi":true }, { "path":"isActive", "httpMethod":"GET", "contractMethod":{ "name":"isActive", "signature":"isActive(address)" }, "args":[ "account" ], "generatePostmanApi":true }, { "path":"isDeploymentActive", "httpMethod":"GET", "contractMethod":{ "name":"isDeploymentActive", "signature":"isDeploymentActive()" }, "args":[ ], "generatePostmanApi":true }, { "path":"isInRole", "httpMethod":"GET", "contractMethod":{ "name":"isInRole", "signature":"isInRole(string,address)" }, "args":[ "role", "account" ], "generatePostmanApi":true }, { "path":"isOrgAdmin", "httpMethod":"GET", "contractMethod":{ "name":"isOrgAdmin", "signature":"isOrgAdmin(address)" }, "args":[ "adminAddress" ], "generatePostmanApi":true }, { "path":"isOrgAuditor", "httpMethod":"GET", "contractMethod":{ "name":"isOrgAuditor", "signature":"isOrgAuditor(address)" }, "args":[ "auditorAddress" ], "generatePostmanApi":true }, { "path":"isTokenAdmin", "httpMethod":"GET", "contractMethod":{ "name":"isTokenAdmin", "signature":"isTokenAdmin(address)" }, "args":[ "adminAddress" ], "generatePostmanApi":true }, { "path":"isTokenAuditor", "httpMethod":"GET", "contractMethod":{ "name":"isTokenAuditor", "signature":"isTokenAuditor(address)" }, "args":[ "auditorAddress" ], "generatePostmanApi":true }, { "path":"removeOrgAdmin", "httpMethod":"POST", "contractMethod":{ "name":"removeOrgAdmin", "signature":"removeOrgAdmin(address)" }, "args":[ "adminAddress" ], "generatePostmanApi":true }, { "path":"removeOrgAuditor", "httpMethod":"POST", "contractMethod":{ "name":"removeOrgAuditor", "signature":"removeOrgAuditor(address)" }, "args":[ "auditorAddress" ], "generatePostmanApi":true }, { "path":"removeRole", "httpMethod":"POST", "contractMethod":{ "name":"removeRole", "signature":"removeRole(address,string)" }, "args":[ "account", "role" ], "generatePostmanApi":true }, { "path":"removeTokenAdmin", "httpMethod":"POST", "contractMethod":{ "name":"removeTokenAdmin", "signature":"removeTokenAdmin(address)" }, "args":[ "adminAddress" ], "generatePostmanApi":true }, { "path":"removeTokenAuditor", "httpMethod":"POST", "contractMethod":{ "name":"removeTokenAuditor", "signature":"removeTokenAuditor(address)" }, "args":[ "auditorAddress" ], "generatePostmanApi":true }, { "path":"renounceNamedRole", "httpMethod":"POST", "contractMethod":{ "name":"renounceNamedRole", "signature":"renounceNamedRole(address,string)" }, "args":[ "account", "role" ], "generatePostmanApi":true }, { "path":"setContext", "httpMethod":"POST", "contractMethod":{ "name":"setContext", "signature":"setContext(address)" }, "args":[ "tokenAddress" ], "generatePostmanApi":true }, { "path":"setGovernanceContext", "httpMethod":"POST", "contractMethod":{ "name":"setGovernanceContext", "signature":"setGovernanceContext(string,address)" }, "args":[ "uuid", "governance" ], "generatePostmanApi":true }, { "path":"setMaxDailyAmount", "httpMethod":"POST", "contractMethod":{ "name":"setMaxDailyAmount", "signature":"setMaxDailyAmount(int256,address)" }, "args":[ "value", "account" ], "generatePostmanApi":true }, { "path":"setMaxDailyTransactionCount", "httpMethod":"POST", "contractMethod":{ "name":"setMaxDailyTransactionCount", "signature":"setMaxDailyTransactionCount(int256,address)" }, "args":[ "count", "account" ], "generatePostmanApi":true }, { "path":"suspendAccount", "httpMethod":"POST", "contractMethod":{ "name":"suspendAccount", "signature":"suspendAccount(address)" }, "args":[ "userAddress" ], "generatePostmanApi":true }, { "path":"version", "httpMethod":"GET", "contractMethod":{ "name":"version", "signature":"version()" }, "args":[ ], "generatePostmanApi":true }, { "backendOverrideOrds":"true", "ordsBaseUrl":"{{ordsHost}}", "path":"/{{ordsPathPrefix}}/getAllActiveCBDCAccounts", "httpMethod":"GET", "contractMethod":{ "name":"getAllActiveCBDCAccounts", "signature":"getAllActiveCBDCAccounts(string)" }, "args":[ "token_id" ] }, { "backendOverrideOrds":"true", "ordsBaseUrl":"{{ordsHost}}", "path":"/{{ordsPathPrefix}}/getAllCBDCAccountTransactionHistoryWithFilters", "httpMethod":"GET", "contractMethod":{ "name":"getAllCBDCAccountTransactionHistoryWithFilters", "signature":"getAllCBDCAccountTransactionHistoryWithFilters(string,string,string,string,string)" }, "args":[ "bookmark", "endTime", "pageSize", "startTime", "token_id" ] }, { "backendOverrideOrds":"true", "ordsBaseUrl":"{{ordsHost}}", "path":"/{{ordsPathPrefix}}/getAllCBDCAccounts", "httpMethod":"GET", "contractMethod":{ "name":"getAllCBDCAccounts", "signature":"getAllCBDCAccounts(string)" }, "args":[ "token_id" ] }, { "backendOverrideOrds":"true", "ordsBaseUrl":"{{ordsHost}}", "path":"/{{ordsPathPrefix}}/getAllOrgAccounts", "httpMethod":"GET", "contractMethod":{ "name":"getAllOrgAccounts", "signature":"getAllOrgAccounts(string)" }, "args":[ "org_id" ] }, { "backendOverrideOrds":"true", "ordsBaseUrl":"{{ordsHost}}", "path":"/{{ordsPathPrefix}}/getAllRegisteredOrgs", "httpMethod":"GET", "contractMethod":{ "name":"getAllRegisteredOrgs", "signature":"getAllRegisteredOrgs(string)" }, "args":[ "token_id" ] }, { "backendOverrideOrds":"true", "ordsBaseUrl":"{{ordsHost}}", "path":"/{{ordsPathPrefix}}/getAllSuspendedCBDCAccounts", "httpMethod":"GET", "contractMethod":{ "name":"getAllSuspendedCBDCAccounts", "signature":"getAllSuspendedCBDCAccounts(string)" }, "args":[ "token_id" ] }, { "backendOverrideOrds":"true", "ordsBaseUrl":"{{ordsHost}}", "path":"/{{ordsPathPrefix}}/getApproverActionHistory", "httpMethod":"GET", "contractMethod":{ "name":"getApproverActionHistory", "signature":"getApproverActionHistory(string,string)" }, "args":[ "caller_account_id", "token_id" ] }, { "backendOverrideOrds":"true", "ordsBaseUrl":"{{ordsHost}}", "path":"/{{ordsPathPrefix}}/getCBDCAccountHistory", "httpMethod":"GET", "contractMethod":{ "name":"getCBDCAccountHistory", "signature":"getCBDCAccountHistory(string,string,string)" }, "args":[ "account_address", "limit", "offset" ] }, { "backendOverrideOrds":"true", "ordsBaseUrl":"{{ordsHost}}", "path":"/{{ordsPathPrefix}}/getCBDCAccountStatus", "httpMethod":"GET", "contractMethod":{ "name":"getCBDCAccountStatus", "signature":"getCBDCAccountStatus(string,string,string)" }, "args":[ "org_id", "token_id", "user_id" ] }, { "backendOverrideOrds":"true", "ordsBaseUrl":"{{ordsHost}}", "path":"/{{ordsPathPrefix}}/getCBDCAccountStatusHistory", "httpMethod":"GET", "contractMethod":{ "name":"getCBDCAccountStatusHistory", "signature":"getCBDCAccountStatusHistory(string,string,string)" }, "args":[ "org_id", "token_id", "user_id" ] }, { "backendOverrideOrds":"true", "ordsBaseUrl":"{{ordsHost}}", "path":"/{{ordsPathPrefix}}/getCBDCAccountTransactionHistoryWithFilters", "httpMethod":"GET", "contractMethod":{ "name":"getCBDCAccountTransactionHistoryWithFilters", "signature":"getCBDCAccountTransactionHistoryWithFilters(string,string,string,string,string,string,string)" }, "args":[ "bookmark", "endTime", "org_id", "pageSize", "startTime", "token_id", "user_id" ] }, { "backendOverrideOrds":"true", "ordsBaseUrl":"{{ordsHost}}", "path":"/{{ordsPathPrefix}}/getCBDCAccountsByRole", "httpMethod":"GET", "contractMethod":{ "name":"getCBDCAccountsByRole", "signature":"getCBDCAccountsByRole(string)" }, "args":[ "role" ] }, { "backendOverrideOrds":"true", "ordsBaseUrl":"{{ordsHost}}", "path":"/{{ordsPathPrefix}}/getCBDCAccountsByUser", "httpMethod":"GET", "contractMethod":{ "name":"getCBDCAccountsByUser", "signature":"getCBDCAccountsByUser(string,string,string)" }, "args":[ "org_id", "token_id", "user_id" ] }, { "backendOverrideOrds":"true", "ordsBaseUrl":"{{ordsHost}}", "path":"/{{ordsPathPrefix}}/getCBDCMetadata", "httpMethod":"GET", "contractMethod":{ "name":"getCBDCMetadata", "signature":"getCBDCMetadata(string)" }, "args":[ "token_id" ] }, { "backendOverrideOrds":"true", "ordsBaseUrl":"{{ordsHost}}", "path":"/{{ordsPathPrefix}}/getCBDCRetiredQuantity", "httpMethod":"GET", "contractMethod":{ "name":"getCBDCRetiredQuantity", "signature":"getCBDCRetiredQuantity(string)" }, "args":[ "token_id" ] }, { "backendOverrideOrds":"true", "ordsBaseUrl":"{{ordsHost}}", "path":"/{{ordsPathPrefix}}/getCBDCTransactionById", "httpMethod":"GET", "contractMethod":{ "name":"getCBDCTransactionById", "signature":"getCBDCTransactionById(string,string)" }, "args":[ "token_id", "transaction_id" ] }, { "backendOverrideOrds":"true", "ordsBaseUrl":"{{ordsHost}}", "path":"/{{ordsPathPrefix}}/getOrgAccountsByRole", "httpMethod":"GET", "contractMethod":{ "name":"getOrgAccountsByRole", "signature":"getOrgAccountsByRole(string,string)" }, "args":[ "org_id", "role" ] }, { "backendOverrideOrds":"true", "ordsBaseUrl":"{{ordsHost}}", "path":"/{{ordsPathPrefix}}/getPendingCBDCIssuance", "httpMethod":"GET", "contractMethod":{ "name":"getPendingCBDCIssuance", "signature":"getPendingCBDCIssuance(string,string)" }, "args":[ "caller_account_id", "token_id" ] }, { "backendOverrideOrds":"true", "ordsBaseUrl":"{{ordsHost}}", "path":"/{{ordsPathPrefix}}/getPendingCBDCRequest", "httpMethod":"GET", "contractMethod":{ "name":"getPendingCBDCRequest", "signature":"getPendingCBDCRequest(string,string)" }, "args":[ "request_type", "token_id" ] }, { "backendOverrideOrds":"true", "ordsBaseUrl":"{{ordsHost}}", "path":"/{{ordsPathPrefix}}/getPendingRequest", "httpMethod":"GET", "contractMethod":{ "name":"getPendingRequest", "signature":"getPendingRequest(string,string)" }, "args":[ "request_type", "token_id" ] }, { "backendOverrideOrds":"true", "ordsBaseUrl":"{{ordsHost}}", "path":"/{{ordsPathPrefix}}/getRolesByAccount", "httpMethod":"GET", "contractMethod":{ "name":"getRolesByAccount", "signature":"getRolesByAccount(string,string,string,string)" }, "args":[ "account_address", "org_id", "token_id", "user_id" ] }, { "backendOverrideOrds":"true", "ordsBaseUrl":"{{ordsHost}}", "path":"/{{ordsPathPrefix}}/getTokenHistory", "httpMethod":"GET", "contractMethod":{ "name":"getTokenHistory", "signature":"getTokenHistory(string)" }, "args":[ "token_id" ] }, { "backendOverrideOrds":"true", "ordsBaseUrl":"{{ordsHost}}", "path":"/{{ordsPathPrefix}}/getUsersByRole", "httpMethod":"GET", "contractMethod":{ "name":"getUsersByRole", "signature":"getUsersByRole(string)" }, "args":[ "role" ] } ], "combinedApis":[ { "name":"createAccountWithRole", "path":"createAccountWithRole", "httpMethod":"POST", "inputs":{ "required":[ "account", "applicationGroups", "maxDailyAmount", "maxDailyTransactions", "orgId", "role", "userAddress", "userId" ] }, "steps":[ { "method":"createAccount", "args":[ "userId", "orgId", "userAddress", "maxDailyAmount", "maxDailyTransactions", "applicationGroups" ] }, { "method":"addRole", "args":[ "account", "role" ] } ], "mappings":{ "createAccount":{ "userId":"request.userId", "orgId":"request.orgId", "userAddress":"request.userAddress", "maxDailyAmount":"request.maxDailyAmount", "maxDailyTransactions":"request.maxDailyTransactions", "applicationGroups":"request.applicationGroups" }, "addRole":{ "account":"request.account", "role":"request.role" } } } ] } } } } } }, "x-contract-endpoint-name":"register", "x-postman-source-folders":[ "Schema Registration" ], "x-alternate-postman-item":"POST register - account-with-erc5982-uups-endpoints", "x-postman-note":"Two POST /register requests register different endpoint templates;\nthe collection provides the full template payloads as examples.", "description":"Registers contract endpoint templates. The Postman collection\ncontains two distinct POST /register requests using the same HTTP path: one\nfor the wholesale CBDC token/holdable contract and one for the account/ERC-5982/UUPS\ncontract. Both request variants are represented below as named examples.", "x-internal-id":"register-post", "x-filename-id":"register-post" }, "get":{ "summary":"Get Registered Endpoints", "description":"Retrieves the registered contract endpoint templates.", "operationId":"register", "tags":[ "Schema Registration" ], "responses":{ "200":{ "description":"Registered contract templates retrieved successfully.", "content":{ "application/json":{ "schema":{ "$ref":"#/components/schemas/Register_ListSuccessResponse" } } } }, "502":{ "$ref":"#/components/responses/Wrapper_BadGateway" } }, "x-postman-request-name":"GET register", "x-contract-endpoint-name":"register", "x-internal-id":"register-get", "x-filename-id":"register-get" } }, "/register/{wholesaleCbdctokenHoldableContractAddress}":{ "patch":{ "summary":"Update Token Endpoint Template", "description":"Updates the registered wholesale CBDC token and holdable-contract endpoint template.", "operationId":"register_template_wholesale_cbdctoken_holdable_endpoints", "tags":[ "Schema Registration" ], "responses":{ "200":{ "description":"Contract template updated successfully.", "content":{ "application/json":{ "schema":{ "$ref":"#/components/schemas/Register_SuccessResponse" } } } }, "400":{ "$ref":"#/components/responses/Wrapper_BadRequest" }, "401":{ "$ref":"#/components/responses/Wrapper_Unauthorized" }, "404":{ "$ref":"#/components/responses/Wrapper_NotFound" }, "415":{ "$ref":"#/components/responses/Wrapper_UnsupportedMediaType" }, "502":{ "$ref":"#/components/responses/Wrapper_BadGateway" } }, "x-postman-request-name":"PATCH register template - wholesale-cbdctoken-holdable-endpoints", "parameters":[ { "name":"wholesaleCbdctokenHoldableContractAddress", "in":"path", "required":true, "schema":{ "type":"string" }, "description":"Path parameter" } ], "requestBody":{ "required":true, "content":{ "application/json":{ "schema":{ "type":"object", "properties":{ "upsertEndpoints":{ "type":"array", "items":{ "type":"object", "properties":{ "path":{ "type":"string", "example":"initializeCBDCToken" }, "httpMethod":{ "type":"string", "example":"POST" }, "contractMethod":{ "type":"object", "properties":{ "name":{ "type":"string", "example":"initializeCBDCToken" }, "signature":{ "type":"string", "example":"initializeCBDCToken((string,string,string,string,string,string,string[],uint8,(uint256,bool),(bool)))" } }, "required":[ "name", "signature" ], "additionalProperties":false }, "args":{ "type":"array", "items":{ "type":"string", "example":"token" } } }, "required":[ "path", "httpMethod", "contractMethod", "args" ], "additionalProperties":false } }, "deleteEndpoints":{ "type":"array", "items":{ "type":"object", "properties":{ "path":{ "type":"string", "example":"oldEndpoint" }, "httpMethod":{ "type":"string", "example":"POST" } }, "required":[ "path", "httpMethod" ], "additionalProperties":false } } }, "required":[ "upsertEndpoints", "deleteEndpoints" ], "additionalProperties":false }, "example":{ "upsertEndpoints":[ { "path":"initializeCBDCToken", "httpMethod":"POST", "contractMethod":{ "name":"initializeCBDCToken", "signature":"initializeCBDCToken((string,string,string,string,string,string,string[],uint8,(uint256,bool),(bool)))" }, "args":[ "token" ] } ], "deleteEndpoints":[ { "path":"oldEndpoint", "httpMethod":"POST" } ] } } } }, "x-contract-endpoint-name":"{wholesaleCbdctokenHoldableContractAddress}", "x-postman-note":"PATCH payload contains upsertEndpoints and deleteEndpoints;\nendpoint objects include path, httpMethod, contractMethod, args.", "x-internal-id":"register-{wholesaleCbdctokenHoldableContractAddress}-patch", "x-filename-id":"register-wholesalecbdctokenholdablecontractaddress-patch" } }, "/register/{accountWithErc5982UupsContractAddress}":{ "patch":{ "summary":"Update Account Endpoint Template", "description":"Updates the registered account and ERC-5982 UUPS contract endpoint template.", "operationId":"register_template_account_with_erc5982_uups_endpoints", "tags":[ "Schema Registration" ], "responses":{ "200":{ "description":"Contract template updated successfully.", "content":{ "application/json":{ "schema":{ "$ref":"#/components/schemas/Register_SuccessResponse" } } } }, "400":{ "$ref":"#/components/responses/Wrapper_BadRequest" }, "401":{ "$ref":"#/components/responses/Wrapper_Unauthorized" }, "404":{ "$ref":"#/components/responses/Wrapper_NotFound" }, "415":{ "$ref":"#/components/responses/Wrapper_UnsupportedMediaType" }, "502":{ "$ref":"#/components/responses/Wrapper_BadGateway" } }, "x-postman-request-name":"PATCH register template - account-with-erc5982-uups-endpoints", "parameters":[ { "name":"accountWithErc5982UupsContractAddress", "in":"path", "required":true, "schema":{ "type":"string" }, "description":"Path parameter" } ], "requestBody":{ "required":true, "content":{ "application/json":{ "schema":{ "type":"object", "properties":{ "upsertEndpoints":{ "type":"array", "items":{ "type":"object", "properties":{ "path":{ "type":"string", "example":"initializeCBDCToken" }, "httpMethod":{ "type":"string", "example":"POST" }, "contractMethod":{ "type":"object", "properties":{ "name":{ "type":"string", "example":"initializeCBDCToken" }, "signature":{ "type":"string", "example":"initializeCBDCToken((string,string,string,string,string,string,string[],uint8,(uint256,bool),(bool)))" } }, "required":[ "name", "signature" ], "additionalProperties":false }, "args":{ "type":"array", "items":{ "type":"string", "example":"token" } } }, "required":[ "path", "httpMethod", "contractMethod", "args" ], "additionalProperties":false } }, "deleteEndpoints":{ "type":"array", "items":{ "type":"object", "properties":{ "path":{ "type":"string", "example":"oldEndpoint" }, "httpMethod":{ "type":"string", "example":"POST" } }, "required":[ "path", "httpMethod" ], "additionalProperties":false } } }, "required":[ "upsertEndpoints", "deleteEndpoints" ], "additionalProperties":false }, "example":{ "upsertEndpoints":[ { "path":"initializeCBDCToken", "httpMethod":"POST", "contractMethod":{ "name":"initializeCBDCToken", "signature":"initializeCBDCToken((string,string,string,string,string,string,string[],uint8,(uint256,bool),(bool)))" }, "args":[ "token" ] } ], "deleteEndpoints":[ { "path":"oldEndpoint", "httpMethod":"POST" } ] } } } }, "x-contract-endpoint-name":"{accountWithErc5982UupsContractAddress}", "x-postman-note":"PATCH payload contains upsertEndpoints and deleteEndpoints;\nendpoint objects include path, httpMethod, contractMethod, args.", "x-internal-id":"register-{accountWithErc5982UupsContractAddress}-patch", "x-filename-id":"register-accountwitherc5982uupscontractaddress-patch" } }, "/{wholesaleCbdctokenHoldableContractAddress}/allowance":{ "get":{ "summary":"Get Token Allowance", "description":"Retrieves the amount that a spender is authorized to transfer from an owner account.", "operationId":"allowance", "tags":[ "Token Contract Endpoints" ], "responses":{ "200":{ "description":"Successful rpc-proxy query response.", "content":{ "application/json":{ "schema":{ "$ref":"#/components/schemas/RpcProxy_QuerySuccessResponse" } } } }, "400":{ "description":"Wrapper validation failure or rpc-proxy bad-request response." }, "404":{ "description":"Unregistered endpoint or rpc-proxy not-found response." }, "502":{ "description":"Wrapper-to-rpc-proxy failure or rpc-proxy gateway response." }, "default":{ "description":"rpc-proxy status, content type, and response body are passed through unchanged." } }, "x-postman-request-name":"GET allowance", "parameters":[ { "name":"owner", "in":"query", "required":false, "schema":{ "type":"string" } }, { "name":"spender", "in":"query", "required":false, "schema":{ "type":"string" } }, { "name":"fromAddress", "in":"query", "required":false, "schema":{ "type":"string" } }, { "name":"blockTag", "in":"query", "required":false, "schema":{ "type":"string", "default":"latest" } }, { "name":"wholesaleCbdctokenHoldableContractAddress", "in":"path", "required":true, "schema":{ "type":"string" }, "description":"Path parameter" } ], "x-contract-endpoint-name":"allowance", "x-contract-method":{ "name":"allowance", "signature":"allowance(address,address)" }, "x-contract-args":[ "owner", "spender" ], "x-generate-postman-api":true, "x-internal-id":"{wholesaleCbdctokenHoldableContractAddress}-allowance-get", "x-filename-id":"wholesalecbdctokenholdablecontractaddress-allowance-get" } }, "/{wholesaleCbdctokenHoldableContractAddress}/approve":{ "post":{ "summary":"Approve Token Spending", "description":"Authorizes a spender to transfer the specified amount of tokens on behalf of the caller.", "operationId":"approve", "tags":[ "Token Contract Endpoints" ], "responses":{ "200":{ "description":"Successful rpc-proxy transaction response.", "content":{ "application/json":{ "schema":{ "$ref":"#/components/schemas/RpcProxy_TransactionSuccessResponse" } } } }, "400":{ "description":"Wrapper validation failure or rpc-proxy bad-request response." }, "404":{ "description":"Unregistered endpoint or rpc-proxy not-found response." }, "502":{ "description":"Wrapper-to-rpc-proxy failure or rpc-proxy gateway response." }, "default":{ "description":"rpc-proxy status, content type, and response body are passed through unchanged." } }, "x-postman-request-name":"POST approve", "parameters":[ { "name":"wholesaleCbdctokenHoldableContractAddress", "in":"path", "required":true, "schema":{ "type":"string" }, "description":"Path parameter" } ], "requestBody":{ "required":true, "content":{ "application/json":{ "schema":{ "type":"object", "properties":{ "walletId":{ "type":"string", "example":"", "description":"Postman variable {{walletId}}" }, "spender":{ "type":"string", "example":"0x0000000000000000000000000000000000000000" }, "value":{ "type":"integer", "example":0 } }, "required":[ "walletId", "spender", "value" ], "additionalProperties":false }, "example":{ "walletId":"{{walletId}}", "spender":"0x0000000000000000000000000000000000000000", "value":0 } } } }, "x-contract-endpoint-name":"approve", "x-contract-method":{ "name":"approve", "signature":"approve(address,uint256)" }, "x-contract-args":[ "spender", "value" ], "x-generate-postman-api":true, "x-internal-id":"{wholesaleCbdctokenHoldableContractAddress}-approve-post", "x-filename-id":"wholesalecbdctokenholdablecontractaddress-approve-post" } }, "/{wholesaleCbdctokenHoldableContractAddress}/approveBurn":{ "post":{ "summary":"Approve Burn Request", "description":"Approves a pending token-burn request.", "operationId":"approveBurn", "tags":[ "Token Contract Endpoints" ], "responses":{ "200":{ "description":"Successful rpc-proxy transaction response.", "content":{ "application/json":{ "schema":{ "$ref":"#/components/schemas/RpcProxy_TransactionSuccessResponse" } } } }, "400":{ "description":"Wrapper validation failure or rpc-proxy bad-request response." }, "404":{ "description":"Unregistered endpoint or rpc-proxy not-found response." }, "502":{ "description":"Wrapper-to-rpc-proxy failure or rpc-proxy gateway response." }, "default":{ "description":"rpc-proxy status, content type, and response body are passed through unchanged." } }, "x-postman-request-name":"POST approveBurn", "parameters":[ { "name":"wholesaleCbdctokenHoldableContractAddress", "in":"path", "required":true, "schema":{ "type":"string" }, "description":"Path parameter" } ], "requestBody":{ "required":true, "content":{ "application/json":{ "schema":{ "type":"object", "properties":{ "walletId":{ "type":"string", "example":"", "description":"Postman variable {{walletId}}" }, "opId":{ "type":"string", "example":"opId value" } }, "required":[ "walletId", "opId" ], "additionalProperties":false }, "example":{ "walletId":"{{walletId}}", "opId":"opId value" } } } }, "x-contract-endpoint-name":"approveBurn", "x-contract-method":{ "name":"approveBurn", "signature":"approveBurn(string)" }, "x-contract-args":[ "opId" ], "x-generate-postman-api":true, "x-internal-id":"{wholesaleCbdctokenHoldableContractAddress}-approveBurn-post", "x-filename-id":"wholesalecbdctokenholdablecontractaddress-approveburn-post" } }, "/{wholesaleCbdctokenHoldableContractAddress}/approveMint":{ "post":{ "summary":"Approve Mint Request", "description":"Approves a pending token-mint request.", "operationId":"approveMint", "tags":[ "Token Contract Endpoints" ], "responses":{ "200":{ "description":"Successful rpc-proxy transaction response.", "content":{ "application/json":{ "schema":{ "$ref":"#/components/schemas/RpcProxy_TransactionSuccessResponse" } } } }, "400":{ "description":"Wrapper validation failure or rpc-proxy bad-request response." }, "404":{ "description":"Unregistered endpoint or rpc-proxy not-found response." }, "502":{ "description":"Wrapper-to-rpc-proxy failure or rpc-proxy gateway response." }, "default":{ "description":"rpc-proxy status, content type, and response body are passed through unchanged." } }, "x-postman-request-name":"POST approveMint", "parameters":[ { "name":"wholesaleCbdctokenHoldableContractAddress", "in":"path", "required":true, "schema":{ "type":"string" }, "description":"Path parameter" } ], "requestBody":{ "required":true, "content":{ "application/json":{ "schema":{ "type":"object", "properties":{ "walletId":{ "type":"string", "example":"", "description":"Postman variable {{walletId}}" }, "opId":{ "type":"string", "example":"opId value" } }, "required":[ "walletId", "opId" ], "additionalProperties":false }, "example":{ "walletId":"{{walletId}}", "opId":"opId value" } } } }, "x-contract-endpoint-name":"approveMint", "x-contract-method":{ "name":"approveMint", "signature":"approveMint(string)" }, "x-contract-args":[ "opId" ], "x-generate-postman-api":true, "x-internal-id":"{wholesaleCbdctokenHoldableContractAddress}-approveMint-post", "x-filename-id":"wholesalecbdctokenholdablecontractaddress-approvemint-post" } }, "/{wholesaleCbdctokenHoldableContractAddress}/balanceOf":{ "get":{ "summary":"Get Token Balance", "description":"Retrieves the token balance for the specified account.", "operationId":"balanceOf", "tags":[ "Token Contract Endpoints" ], "responses":{ "200":{ "description":"Successful rpc-proxy query response.", "content":{ "application/json":{ "schema":{ "$ref":"#/components/schemas/RpcProxy_QuerySuccessResponse" } } } }, "400":{ "description":"Wrapper validation failure or rpc-proxy bad-request response." }, "404":{ "description":"Unregistered endpoint or rpc-proxy not-found response." }, "502":{ "description":"Wrapper-to-rpc-proxy failure or rpc-proxy gateway response." }, "default":{ "description":"rpc-proxy status, content type, and response body are passed through unchanged." } }, "x-postman-request-name":"GET balanceOf", "parameters":[ { "name":"account", "in":"query", "required":false, "schema":{ "type":"string" } }, { "name":"fromAddress", "in":"query", "required":false, "schema":{ "type":"string" } }, { "name":"blockTag", "in":"query", "required":false, "schema":{ "type":"string", "default":"latest" } }, { "name":"wholesaleCbdctokenHoldableContractAddress", "in":"path", "required":true, "schema":{ "type":"string" }, "description":"Path parameter" } ], "x-contract-endpoint-name":"balanceOf", "x-contract-method":{ "name":"balanceOf", "signature":"balanceOf(address)" }, "x-contract-args":[ "account" ], "x-generate-postman-api":true, "x-internal-id":"{wholesaleCbdctokenHoldableContractAddress}-balanceOf-get", "x-filename-id":"wholesalecbdctokenholdablecontractaddress-balanceof-get" } }, "/{wholesaleCbdctokenHoldableContractAddress}/batchTransfer":{ "post":{ "summary":"Transfer Tokens in Batch", "description":"Transfers tokens to multiple recipient accounts in a single request.", "operationId":"batchTransfer", "tags":[ "Token Contract Endpoints" ], "responses":{ "200":{ "description":"Successful rpc-proxy transaction response.", "content":{ "application/json":{ "schema":{ "$ref":"#/components/schemas/RpcProxy_TransactionSuccessResponse" } } } }, "400":{ "description":"Wrapper validation failure or rpc-proxy bad-request response." }, "404":{ "description":"Unregistered endpoint or rpc-proxy not-found response." }, "502":{ "description":"Wrapper-to-rpc-proxy failure or rpc-proxy gateway response." }, "default":{ "description":"rpc-proxy status, content type, and response body are passed through unchanged." } }, "x-postman-request-name":"POST batchTransfer", "parameters":[ { "name":"wholesaleCbdctokenHoldableContractAddress", "in":"path", "required":true, "schema":{ "type":"string" }, "description":"Path parameter" } ], "requestBody":{ "required":true, "content":{ "application/json":{ "schema":{ "type":"object", "properties":{ "walletId":{ "type":"string", "example":"", "description":"Postman variable {{walletId}}" }, "toList":{ "type":"array", "items":{ "type":"string", "example":"0x0000000000000000000000000000000000000000" } }, "amounts":{ "type":"array", "items":{ "type":"integer", "example":0 } } }, "required":[ "walletId", "toList", "amounts" ], "additionalProperties":false }, "example":{ "walletId":"{{walletId}}", "toList":[ "0x0000000000000000000000000000000000000000" ], "amounts":[ 0 ] } } } }, "x-contract-endpoint-name":"batchTransfer", "x-contract-method":{ "name":"batchTransfer", "signature":"batchTransfer(address[],uint256[])" }, "x-contract-args":[ "toList", "amounts" ], "x-generate-postman-api":true, "x-internal-id":"{wholesaleCbdctokenHoldableContractAddress}-batchTransfer-post", "x-filename-id":"wholesalecbdctokenholdablecontractaddress-batchtransfer-post" } }, "/{wholesaleCbdctokenHoldableContractAddress}/burn":{ "post":{ "summary":"Burn Tokens", "description":"Burns tokens from the caller account.", "operationId":"burn", "tags":[ "Token Contract Endpoints" ], "responses":{ "200":{ "description":"Successful rpc-proxy transaction response.", "content":{ "application/json":{ "schema":{ "$ref":"#/components/schemas/RpcProxy_TransactionSuccessResponse" } } } }, "400":{ "description":"Wrapper validation failure or rpc-proxy bad-request response." }, "404":{ "description":"Unregistered endpoint or rpc-proxy not-found response." }, "502":{ "description":"Wrapper-to-rpc-proxy failure or rpc-proxy gateway response." }, "default":{ "description":"rpc-proxy status, content type, and response body are passed through unchanged." } }, "x-postman-request-name":"POST burn", "parameters":[ { "name":"wholesaleCbdctokenHoldableContractAddress", "in":"path", "required":true, "schema":{ "type":"string" }, "description":"Path parameter" } ], "requestBody":{ "required":true, "content":{ "application/json":{ "schema":{ "type":"object", "properties":{ "walletId":{ "type":"string", "example":"", "description":"Postman variable {{walletId}}" }, "value":{ "type":"integer", "example":0 } }, "required":[ "walletId", "value" ], "additionalProperties":false }, "example":{ "walletId":"{{walletId}}", "value":0 } } } }, "x-contract-endpoint-name":"burn", "x-contract-method":{ "name":"burn", "signature":"burn(uint256)" }, "x-contract-args":[ "value" ], "x-generate-postman-api":true, "x-internal-id":"{wholesaleCbdctokenHoldableContractAddress}-burn-post", "x-filename-id":"wholesalecbdctokenholdablecontractaddress-burn-post" } }, "/{wholesaleCbdctokenHoldableContractAddress}/burnFrom":{ "post":{ "summary":"Burn Approved Tokens", "description":"Burns tokens from an approved account.", "operationId":"burnFrom", "tags":[ "Token Contract Endpoints" ], "responses":{ "200":{ "description":"Successful rpc-proxy transaction response.", "content":{ "application/json":{ "schema":{ "$ref":"#/components/schemas/RpcProxy_TransactionSuccessResponse" } } } }, "400":{ "description":"Wrapper validation failure or rpc-proxy bad-request response." }, "404":{ "description":"Unregistered endpoint or rpc-proxy not-found response." }, "502":{ "description":"Wrapper-to-rpc-proxy failure or rpc-proxy gateway response." }, "default":{ "description":"rpc-proxy status, content type, and response body are passed through unchanged." } }, "x-postman-request-name":"POST burnFrom", "parameters":[ { "name":"wholesaleCbdctokenHoldableContractAddress", "in":"path", "required":true, "schema":{ "type":"string" }, "description":"Path parameter" } ], "requestBody":{ "required":true, "content":{ "application/json":{ "schema":{ "type":"object", "properties":{ "walletId":{ "type":"string", "example":"", "description":"Postman variable {{walletId}}" }, "account":{ "type":"string", "example":"0x0000000000000000000000000000000000000000" }, "value":{ "type":"integer", "example":0 } }, "required":[ "walletId", "account", "value" ], "additionalProperties":false }, "example":{ "walletId":"{{walletId}}", "account":"0x0000000000000000000000000000000000000000", "value":0 } } } }, "x-contract-endpoint-name":"burnFrom", "x-contract-method":{ "name":"burnFrom", "signature":"burnFrom(address,uint256)" }, "x-contract-args":[ "account", "value" ], "x-generate-postman-api":true, "x-internal-id":"{wholesaleCbdctokenHoldableContractAddress}-burnFrom-post", "x-filename-id":"wholesalecbdctokenholdablecontractaddress-burnfrom-post" } }, "/{wholesaleCbdctokenHoldableContractAddress}/cap":{ "get":{ "summary":"Get Token Cap", "description":"Retrieves the maximum token supply.", "operationId":"cap", "tags":[ "Token Contract Endpoints" ], "responses":{ "200":{ "description":"Successful rpc-proxy query response.", "content":{ "application/json":{ "schema":{ "$ref":"#/components/schemas/RpcProxy_QuerySuccessResponse" } } } }, "400":{ "description":"Wrapper validation failure or rpc-proxy bad-request response." }, "404":{ "description":"Unregistered endpoint or rpc-proxy not-found response." }, "502":{ "description":"Wrapper-to-rpc-proxy failure or rpc-proxy gateway response." }, "default":{ "description":"rpc-proxy status, content type, and response body are passed through unchanged." } }, "x-postman-request-name":"GET cap", "parameters":[ { "name":"fromAddress", "in":"query", "required":false, "schema":{ "type":"string" } }, { "name":"blockTag", "in":"query", "required":false, "schema":{ "type":"string", "default":"latest" } }, { "name":"wholesaleCbdctokenHoldableContractAddress", "in":"path", "required":true, "schema":{ "type":"string" }, "description":"Path parameter" } ], "x-contract-endpoint-name":"cap", "x-contract-method":{ "name":"cap", "signature":"cap()" }, "x-contract-args":[ ], "x-generate-postman-api":true, "x-internal-id":"{wholesaleCbdctokenHoldableContractAddress}-cap-get", "x-filename-id":"wholesalecbdctokenholdablecontractaddress-cap-get" } }, "/{wholesaleCbdctokenHoldableContractAddress}/decimals":{ "get":{ "summary":"Get Token Decimals", "description":"Retrieves the number of decimal places used by the token.", "operationId":"decimals", "tags":[ "Token Contract Endpoints" ], "responses":{ "200":{ "description":"Successful rpc-proxy query response.", "content":{ "application/json":{ "schema":{ "$ref":"#/components/schemas/RpcProxy_QuerySuccessResponse" } } } }, "400":{ "description":"Wrapper validation failure or rpc-proxy bad-request response." }, "404":{ "description":"Unregistered endpoint or rpc-proxy not-found response." }, "502":{ "description":"Wrapper-to-rpc-proxy failure or rpc-proxy gateway response." }, "default":{ "description":"rpc-proxy status, content type, and response body are passed through unchanged." } }, "x-postman-request-name":"GET decimals", "parameters":[ { "name":"fromAddress", "in":"query", "required":false, "schema":{ "type":"string" } }, { "name":"blockTag", "in":"query", "required":false, "schema":{ "type":"string", "default":"latest" } }, { "name":"wholesaleCbdctokenHoldableContractAddress", "in":"path", "required":true, "schema":{ "type":"string" }, "description":"Path parameter" } ], "x-contract-endpoint-name":"decimals", "x-contract-method":{ "name":"decimals", "signature":"decimals()" }, "x-contract-args":[ ], "x-generate-postman-api":true, "x-internal-id":"{wholesaleCbdctokenHoldableContractAddress}-decimals-get", "x-filename-id":"wholesalecbdctokenholdablecontractaddress-decimals-get" } }, "/{wholesaleCbdctokenHoldableContractAddress}/executeHold":{ "post":{ "summary":"Execute Token Hold", "description":"Executes a hold operation for the specified token amount.", "operationId":"executeHold", "tags":[ "Token Contract Endpoints" ], "responses":{ "200":{ "description":"Successful rpc-proxy transaction response.", "content":{ "application/json":{ "schema":{ "$ref":"#/components/schemas/RpcProxy_TransactionSuccessResponse" } } } }, "400":{ "description":"Wrapper validation failure or rpc-proxy bad-request response." }, "404":{ "description":"Unregistered endpoint or rpc-proxy not-found response." }, "502":{ "description":"Wrapper-to-rpc-proxy failure or rpc-proxy gateway response." }, "default":{ "description":"rpc-proxy status, content type, and response body are passed through unchanged." } }, "x-postman-request-name":"POST executeHold", "parameters":[ { "name":"wholesaleCbdctokenHoldableContractAddress", "in":"path", "required":true, "schema":{ "type":"string" }, "description":"Path parameter" } ], "requestBody":{ "required":true, "content":{ "application/json":{ "schema":{ "type":"object", "properties":{ "walletId":{ "type":"string", "example":"", "description":"Postman variable {{walletId}}" }, "opId":{ "type":"string", "example":"opId value" }, "amount":{ "type":"integer", "example":0 } }, "required":[ "walletId", "opId", "amount" ], "additionalProperties":false }, "example":{ "walletId":"{{walletId}}", "opId":"opId value", "amount":0 } } } }, "x-contract-endpoint-name":"executeHold", "x-contract-method":{ "name":"executeHold", "signature":"executeHold(string,uint256)" }, "x-contract-args":[ "opId", "amount" ], "x-generate-postman-api":true, "x-internal-id":"{wholesaleCbdctokenHoldableContractAddress}-executeHold-post", "x-filename-id":"wholesalecbdctokenholdablecontractaddress-executehold-post" } }, "/{wholesaleCbdctokenHoldableContractAddress}/getAccountOnHoldBalance":{ "get":{ "summary":"Get Account Hold Balance", "description":"Retrieves the total token balance on hold for an account.", "operationId":"getAccountOnHoldBalance", "tags":[ "Token Contract Endpoints" ], "responses":{ "200":{ "description":"Successful rpc-proxy query response.", "content":{ "application/json":{ "schema":{ "$ref":"#/components/schemas/RpcProxy_QuerySuccessResponse" } } } }, "400":{ "description":"Wrapper validation failure or rpc-proxy bad-request response." }, "404":{ "description":"Unregistered endpoint or rpc-proxy not-found response." }, "502":{ "description":"Wrapper-to-rpc-proxy failure or rpc-proxy gateway response." }, "default":{ "description":"rpc-proxy status, content type, and response body are passed through unchanged." } }, "x-postman-request-name":"GET getAccountOnHoldBalance", "parameters":[ { "name":"account", "in":"query", "required":false, "schema":{ "type":"string" } }, { "name":"fromAddress", "in":"query", "required":false, "schema":{ "type":"string" } }, { "name":"blockTag", "in":"query", "required":false, "schema":{ "type":"string", "default":"latest" } }, { "name":"wholesaleCbdctokenHoldableContractAddress", "in":"path", "required":true, "schema":{ "type":"string" }, "description":"Path parameter" } ], "x-contract-endpoint-name":"getAccountOnHoldBalance", "x-contract-method":{ "name":"getAccountOnHoldBalance", "signature":"getAccountOnHoldBalance(address)" }, "x-contract-args":[ "account" ], "x-generate-postman-api":true, "x-internal-id":"{wholesaleCbdctokenHoldableContractAddress}-getAccountOnHoldBalance-get", "x-filename-id":"wholesalecbdctokenholdablecontractaddress-getaccountonholdbalance-get" } }, "/{wholesaleCbdctokenHoldableContractAddress}/getGovernanceContext":{ "get":{ "summary":"Get Token Governance Context", "description":"Retrieves the governance context for the wholesale CBDC token.", "operationId":"getGovernanceContext_wholesale", "tags":[ "Token Contract Endpoints" ], "responses":{ "200":{ "description":"Successful rpc-proxy query response.", "content":{ "application/json":{ "schema":{ "$ref":"#/components/schemas/RpcProxy_QuerySuccessResponse" } } } }, "400":{ "description":"Wrapper validation failure or rpc-proxy bad-request response." }, "404":{ "description":"Unregistered endpoint or rpc-proxy not-found response." }, "502":{ "description":"Wrapper-to-rpc-proxy failure or rpc-proxy gateway response." }, "default":{ "description":"rpc-proxy status, content type, and response body are passed through unchanged." } }, "x-postman-request-name":"GET getGovernanceContext", "parameters":[ { "name":"fromAddress", "in":"query", "required":false, "schema":{ "type":"string" } }, { "name":"blockTag", "in":"query", "required":false, "schema":{ "type":"string", "default":"latest" } }, { "name":"wholesaleCbdctokenHoldableContractAddress", "in":"path", "required":true, "schema":{ "type":"string" }, "description":"Path parameter" } ], "x-contract-endpoint-name":"getGovernanceContext", "x-contract-method":{ "name":"getGovernanceContext", "signature":"getGovernanceContext()" }, "x-contract-args":[ ], "x-generate-postman-api":true, "x-internal-id":"{wholesaleCbdctokenHoldableContractAddress}-getGovernanceContext-get", "x-filename-id":"wholesalecbdctokenholdablecontractaddress-getgovernancecontext-get" } }, "/{wholesaleCbdctokenHoldableContractAddress}/getOnHoldBalanceWithOperationId":{ "get":{ "summary":"Get Hold Balance", "description":"Retrieves the on-hold token balance for the specified operation.", "operationId":"getOnHoldBalanceWithOperationId", "tags":[ "Token Contract Endpoints" ], "responses":{ "200":{ "description":"Successful rpc-proxy query response.", "content":{ "application/json":{ "schema":{ "$ref":"#/components/schemas/RpcProxy_QuerySuccessResponse" } } } }, "400":{ "description":"Wrapper validation failure or rpc-proxy bad-request response." }, "404":{ "description":"Unregistered endpoint or rpc-proxy not-found response." }, "502":{ "description":"Wrapper-to-rpc-proxy failure or rpc-proxy gateway response." }, "default":{ "description":"rpc-proxy status, content type, and response body are passed through unchanged." } }, "x-postman-request-name":"GET getOnHoldBalanceWithOperationId", "parameters":[ { "name":"opId", "in":"query", "required":false, "schema":{ "type":"string" } }, { "name":"fromAddress", "in":"query", "required":false, "schema":{ "type":"string" } }, { "name":"blockTag", "in":"query", "required":false, "schema":{ "type":"string", "default":"latest" } }, { "name":"wholesaleCbdctokenHoldableContractAddress", "in":"path", "required":true, "schema":{ "type":"string" }, "description":"Path parameter" } ], "x-contract-endpoint-name":"getOnHoldBalanceWithOperationId", "x-contract-method":{ "name":"getOnHoldBalanceWithOperationId", "signature":"getOnHoldBalanceWithOperationId(string)" }, "x-contract-args":[ "opId" ], "x-generate-postman-api":true, "x-internal-id":"{wholesaleCbdctokenHoldableContractAddress}-getOnHoldBalanceWithOperationId-get", "x-filename-id":"wholesalecbdctokenholdablecontractaddress-getonholdbalancewithoperationid-get" } }, "/{wholesaleCbdctokenHoldableContractAddress}/getOnHoldDetailsWithOperationId":{ "get":{ "summary":"Get Hold Details", "description":"Retrieves the details of the specified hold operation.", "operationId":"getOnHoldDetailsWithOperationId", "tags":[ "Token Contract Endpoints" ], "responses":{ "200":{ "description":"Successful rpc-proxy query response.", "content":{ "application/json":{ "schema":{ "$ref":"#/components/schemas/RpcProxy_QuerySuccessResponse" } } } }, "400":{ "description":"Wrapper validation failure or rpc-proxy bad-request response." }, "404":{ "description":"Unregistered endpoint or rpc-proxy not-found response." }, "502":{ "description":"Wrapper-to-rpc-proxy failure or rpc-proxy gateway response." }, "default":{ "description":"rpc-proxy status, content type, and response body are passed through unchanged." } }, "x-postman-request-name":"GET getOnHoldDetailsWithOperationId", "parameters":[ { "name":"opId", "in":"query", "required":false, "schema":{ "type":"string" } }, { "name":"fromAddress", "in":"query", "required":false, "schema":{ "type":"string" } }, { "name":"blockTag", "in":"query", "required":false, "schema":{ "type":"string", "default":"latest" } }, { "name":"wholesaleCbdctokenHoldableContractAddress", "in":"path", "required":true, "schema":{ "type":"string" }, "description":"Path parameter" } ], "x-contract-endpoint-name":"getOnHoldDetailsWithOperationId", "x-contract-method":{ "name":"getOnHoldDetailsWithOperationId", "signature":"getOnHoldDetailsWithOperationId(string)" }, "x-contract-args":[ "opId" ], "x-generate-postman-api":true, "x-internal-id":"{wholesaleCbdctokenHoldableContractAddress}-getOnHoldDetailsWithOperationId-get", "x-filename-id":"wholesalecbdctokenholdablecontractaddress-getonholddetailswithoperationid-get" } }, "/{wholesaleCbdctokenHoldableContractAddress}/getToken":{ "get":{ "summary":"Get Token", "description":"Retrieves the wholesale CBDC token configuration.", "operationId":"getToken", "tags":[ "Token Contract Endpoints" ], "responses":{ "200":{ "description":"Successful rpc-proxy query response.", "content":{ "application/json":{ "schema":{ "$ref":"#/components/schemas/RpcProxy_QuerySuccessResponse" } } } }, "400":{ "description":"Wrapper validation failure or rpc-proxy bad-request response." }, "404":{ "description":"Unregistered endpoint or rpc-proxy not-found response." }, "502":{ "description":"Wrapper-to-rpc-proxy failure or rpc-proxy gateway response." }, "default":{ "description":"rpc-proxy status, content type, and response body are passed through unchanged." } }, "x-postman-request-name":"GET getToken", "parameters":[ { "name":"fromAddress", "in":"query", "required":false, "schema":{ "type":"string" } }, { "name":"blockTag", "in":"query", "required":false, "schema":{ "type":"string", "default":"latest" } }, { "name":"wholesaleCbdctokenHoldableContractAddress", "in":"path", "required":true, "schema":{ "type":"string" }, "description":"Path parameter" } ], "x-contract-endpoint-name":"getToken", "x-contract-method":{ "name":"getToken", "signature":"getToken()" }, "x-contract-args":[ ], "x-generate-postman-api":true, "x-internal-id":"{wholesaleCbdctokenHoldableContractAddress}-getToken-get", "x-filename-id":"wholesalecbdctokenholdablecontractaddress-gettoken-get" } }, "/{wholesaleCbdctokenHoldableContractAddress}/getTokenContext":{ "get":{ "summary":"Get Token Context", "description":"Retrieves the context associated with the wholesale CBDC token.", "operationId":"getTokenContext", "tags":[ "Token Contract Endpoints" ], "responses":{ "200":{ "description":"Successful rpc-proxy query response.", "content":{ "application/json":{ "schema":{ "$ref":"#/components/schemas/RpcProxy_QuerySuccessResponse" } } } }, "400":{ "description":"Wrapper validation failure or rpc-proxy bad-request response." }, "404":{ "description":"Unregistered endpoint or rpc-proxy not-found response." }, "502":{ "description":"Wrapper-to-rpc-proxy failure or rpc-proxy gateway response." }, "default":{ "description":"rpc-proxy status, content type, and response body are passed through unchanged." } }, "x-postman-request-name":"GET getTokenContext", "parameters":[ { "name":"fromAddress", "in":"query", "required":false, "schema":{ "type":"string" } }, { "name":"blockTag", "in":"query", "required":false, "schema":{ "type":"string", "default":"latest" } }, { "name":"wholesaleCbdctokenHoldableContractAddress", "in":"path", "required":true, "schema":{ "type":"string" }, "description":"Path parameter" } ], "x-contract-endpoint-name":"getTokenContext", "x-contract-method":{ "name":"getTokenContext", "signature":"getTokenContext()" }, "x-contract-args":[ ], "x-generate-postman-api":true, "x-internal-id":"{wholesaleCbdctokenHoldableContractAddress}-getTokenContext-get", "x-filename-id":"wholesalecbdctokenholdablecontractaddress-gettokencontext-get" } }, "/{wholesaleCbdctokenHoldableContractAddress}/hold":{ "post":{ "summary":"Place Token Hold", "description":"Places the specified token amount on hold for the caller account.", "operationId":"hold", "tags":[ "Token Contract Endpoints" ], "responses":{ "200":{ "description":"Successful rpc-proxy transaction response.", "content":{ "application/json":{ "schema":{ "$ref":"#/components/schemas/RpcProxy_TransactionSuccessResponse" } } } }, "400":{ "description":"Wrapper validation failure or rpc-proxy bad-request response." }, "404":{ "description":"Unregistered endpoint or rpc-proxy not-found response." }, "502":{ "description":"Wrapper-to-rpc-proxy failure or rpc-proxy gateway response." }, "default":{ "description":"rpc-proxy status, content type, and response body are passed through unchanged." } }, "x-postman-request-name":"POST hold", "parameters":[ { "name":"wholesaleCbdctokenHoldableContractAddress", "in":"path", "required":true, "schema":{ "type":"string" }, "description":"Path parameter" } ], "requestBody":{ "required":true, "content":{ "application/json":{ "schema":{ "type":"object", "properties":{ "walletId":{ "type":"string", "example":"", "description":"Postman variable {{walletId}}" }, "to":{ "type":"string", "example":"0x0000000000000000000000000000000000000000" }, "notary":{ "type":"string", "example":"0x0000000000000000000000000000000000000000" }, "amount":{ "type":"integer", "example":0 }, "expiration":{ "type":"integer", "example":0 }, "opId":{ "type":"string", "example":"opId value" }, "holdType":{ "type":"string", "example":"holdType value" }, "info":{ "type":"string", "example":"{\"category\":\"category value\",\"description\":\"description\nvalue\"}" } }, "required":[ "walletId", "to", "notary", "amount", "expiration", "opId", "holdType", "info" ], "additionalProperties":false }, "example":{ "walletId":"{{walletId}}", "to":"0x0000000000000000000000000000000000000000", "notary":"0x0000000000000000000000000000000000000000", "amount":0, "expiration":0, "opId":"opId value", "holdType":"holdType value", "info":"{\"category\":\"category value\",\"description\":\"description value\"}" } } } }, "x-contract-endpoint-name":"hold", "x-contract-method":{ "name":"hold", "signature":"hold(address,address,uint256,uint256,string,string,(string,string))" }, "x-contract-args":[ "to", "notary", "amount", "expiration", "opId", "holdType", "info" ], "x-contract-arg-definitions":{ "info":{ "kind":"tuple", "fields":[ { "name":"category" }, { "name":"description" } ] } }, "x-generate-postman-api":true, "x-internal-id":"{wholesaleCbdctokenHoldableContractAddress}-hold-post", "x-filename-id":"wholesalecbdctokenholdablecontractaddress-hold-post" } }, "/{wholesaleCbdctokenHoldableContractAddress}/holdFrom":{ "post":{ "summary":"Place Approved Token Hold", "description":"Places tokens from an approved account on hold.", "operationId":"holdFrom", "tags":[ "Token Contract Endpoints" ], "responses":{ "200":{ "description":"Successful rpc-proxy transaction response.", "content":{ "application/json":{ "schema":{ "$ref":"#/components/schemas/RpcProxy_TransactionSuccessResponse" } } } }, "400":{ "description":"Wrapper validation failure or rpc-proxy bad-request response." }, "404":{ "description":"Unregistered endpoint or rpc-proxy not-found response." }, "502":{ "description":"Wrapper-to-rpc-proxy failure or rpc-proxy gateway response." }, "default":{ "description":"rpc-proxy status, content type, and response body are passed through unchanged." } }, "x-postman-request-name":"POST holdFrom", "parameters":[ { "name":"wholesaleCbdctokenHoldableContractAddress", "in":"path", "required":true, "schema":{ "type":"string" }, "description":"Path parameter" } ], "requestBody":{ "required":true, "content":{ "application/json":{ "schema":{ "type":"object", "properties":{ "walletId":{ "type":"string", "example":"", "description":"Postman variable {{walletId}}" }, "fromAccount":{ "type":"string", "example":"0x0000000000000000000000000000000000000000" }, "to":{ "type":"string", "example":"0x0000000000000000000000000000000000000000" }, "notary":{ "type":"string", "example":"0x0000000000000000000000000000000000000000" }, "amount":{ "type":"integer", "example":0 }, "expiration":{ "type":"integer", "example":0 }, "opId":{ "type":"string", "example":"opId value" }, "holdType":{ "type":"string", "example":"holdType value" }, "info":{ "type":"string", "example":"{\"category\":\"category value\",\"description\":\"description\nvalue\"}" } }, "required":[ "walletId", "fromAccount", "to", "notary", "amount", "expiration", "opId", "holdType", "info" ], "additionalProperties":false }, "example":{ "walletId":"{{walletId}}", "fromAccount":"0x0000000000000000000000000000000000000000", "to":"0x0000000000000000000000000000000000000000", "notary":"0x0000000000000000000000000000000000000000", "amount":0, "expiration":0, "opId":"opId value", "holdType":"holdType value", "info":"{\"category\":\"category value\",\"description\":\"description value\"}" } } } }, "x-contract-endpoint-name":"holdFrom", "x-contract-method":{ "name":"holdFrom", "signature":"holdFrom(address,address,address,uint256,uint256,string,string,(string,string))" }, "x-contract-args":[ "fromAccount", "to", "notary", "amount", "expiration", "opId", "holdType", "info" ], "x-contract-arg-definitions":{ "info":{ "kind":"tuple", "fields":[ { "name":"category" }, { "name":"description" } ] } }, "x-generate-postman-api":true, "x-internal-id":"{wholesaleCbdctokenHoldableContractAddress}-holdFrom-post", "x-filename-id":"wholesalecbdctokenholdablecontractaddress-holdfrom-post" } }, "/{wholesaleCbdctokenHoldableContractAddress}/initializeCBDCToken":{ "post":{ "summary":"Initialize CBDC Token", "description":"Initializes the wholesale CBDC token contract.", "operationId":"initializeCBDCToken", "tags":[ "Token Contract Endpoints" ], "responses":{ "200":{ "description":"Successful rpc-proxy transaction response.", "content":{ "application/json":{ "schema":{ "$ref":"#/components/schemas/RpcProxy_TransactionSuccessResponse" } } } }, "400":{ "description":"Wrapper validation failure or rpc-proxy bad-request response." }, "404":{ "description":"Unregistered endpoint or rpc-proxy not-found response." }, "502":{ "description":"Wrapper-to-rpc-proxy failure or rpc-proxy gateway response." }, "default":{ "description":"rpc-proxy status, content type, and response body are passed through unchanged." } }, "x-postman-request-name":"POST initializeCBDCToken", "parameters":[ { "name":"wholesaleCbdctokenHoldableContractAddress", "in":"path", "required":true, "schema":{ "type":"string" }, "description":"Path parameter" } ], "requestBody":{ "required":true, "content":{ "application/json":{ "schema":{ "type":"object", "properties":{ "walletId":{ "type":"string", "example":"", "description":"Postman variable {{walletId}}" }, "token":{ "type":"string", "example":"{\"tokenId\":\"tokenId value\",\"tokenName\":\"tokenName value\",\"tokenDesc\":\"tokenDesc\nvalue\",\"tokenStandard\":\"tokenStandard value\",\"tokenType\":\"tokenType\nvalue\",\"tokenUnit\":\"tokenUnit value\",\"behaviors\":[\"behaviors value\"],\"decimals\":\"decimals\nvalue\",\"mintable\":{\"maxMintQuantity\":\"maxMintQuantity value\",\"mintApprovalRequired\":\"mintApprovalRequired\nvalue\"},\"burnable\":{\"burnApprovalRequired\":\"burnApprovalRequired\nvalue\"}}" } }, "required":[ "walletId", "token" ], "additionalProperties":false }, "example":{ "walletId":"{{walletId}}", "token":"{\"tokenId\":\"tokenId value\",\"tokenName\":\"tokenName value\",\"tokenDesc\":\"tokenDesc\nvalue\",\"tokenStandard\":\"tokenStandard value\",\"tokenType\":\"tokenType\nvalue\",\"tokenUnit\":\"tokenUnit value\",\"behaviors\":[\"behaviors value\"],\"decimals\":\"decimals\nvalue\",\"mintable\":{\"maxMintQuantity\":\"maxMintQuantity value\",\"mintApprovalRequired\":\"mintApprovalRequired\nvalue\"},\"burnable\":{\"burnApprovalRequired\":\"burnApprovalRequired value\"}}" } } } }, "x-contract-endpoint-name":"initializeCBDCToken", "x-contract-method":{ "name":"initializeCBDCToken", "signature":"initializeCBDCToken((string,string,string,string,string,string,string[],uint8,(uint256,bool),(bool)))" }, "x-contract-args":[ "token" ], "x-contract-arg-definitions":{ "token":{ "kind":"tuple", "fields":[ { "name":"tokenId" }, { "name":"tokenName" }, { "name":"tokenDesc" }, { "name":"tokenStandard" }, { "name":"tokenType" }, { "name":"tokenUnit" }, { "name":"behaviors", "kind":"array", "items":{ "kind":"scalar" } }, { "name":"decimals" }, { "name":"mintable", "kind":"tuple", "fields":[ { "name":"maxMintQuantity" }, { "name":"mintApprovalRequired" } ] }, { "name":"burnable", "kind":"tuple", "fields":[ { "name":"burnApprovalRequired" } ] } ] } }, "x-generate-postman-api":true, "x-internal-id":"{wholesaleCbdctokenHoldableContractAddress}-initializeCBDCToken-post", "x-filename-id":"wholesalecbdctokenholdablecontractaddress-initializecbdctoken-post" } }, "/{wholesaleCbdctokenHoldableContractAddress}/isDeploymentActive":{ "get":{ "summary":"Check Token Deployment", "description":"Determines whether the wholesale CBDC token deployment is active.", "operationId":"isDeploymentActive_wholesale", "tags":[ "Token Contract Endpoints" ], "responses":{ "200":{ "description":"Successful rpc-proxy query response.", "content":{ "application/json":{ "schema":{ "$ref":"#/components/schemas/RpcProxy_QuerySuccessResponse" } } } }, "400":{ "description":"Wrapper validation failure or rpc-proxy bad-request response." }, "404":{ "description":"Unregistered endpoint or rpc-proxy not-found response." }, "502":{ "description":"Wrapper-to-rpc-proxy failure or rpc-proxy gateway response." }, "default":{ "description":"rpc-proxy status, content type, and response body are passed through unchanged." } }, "x-postman-request-name":"GET isDeploymentActive", "parameters":[ { "name":"fromAddress", "in":"query", "required":false, "schema":{ "type":"string" } }, { "name":"blockTag", "in":"query", "required":false, "schema":{ "type":"string", "default":"latest" } }, { "name":"wholesaleCbdctokenHoldableContractAddress", "in":"path", "required":true, "schema":{ "type":"string" }, "description":"Path parameter" } ], "x-contract-endpoint-name":"isDeploymentActive", "x-contract-method":{ "name":"isDeploymentActive", "signature":"isDeploymentActive()" }, "x-contract-args":[ ], "x-generate-postman-api":true, "x-internal-id":"{wholesaleCbdctokenHoldableContractAddress}-isDeploymentActive-get", "x-filename-id":"wholesalecbdctokenholdablecontractaddress-isdeploymentactive-get" } }, "/{wholesaleCbdctokenHoldableContractAddress}/mint":{ "post":{ "summary":"Mint Tokens", "description":"Mints tokens to the specified account.", "operationId":"mint", "tags":[ "Token Contract Endpoints" ], "responses":{ "200":{ "description":"Successful rpc-proxy transaction response.", "content":{ "application/json":{ "schema":{ "$ref":"#/components/schemas/RpcProxy_TransactionSuccessResponse" } } } }, "400":{ "description":"Wrapper validation failure or rpc-proxy bad-request response." }, "404":{ "description":"Unregistered endpoint or rpc-proxy not-found response." }, "502":{ "description":"Wrapper-to-rpc-proxy failure or rpc-proxy gateway response." }, "default":{ "description":"rpc-proxy status, content type, and response body are passed through unchanged." } }, "x-postman-request-name":"POST mint", "parameters":[ { "name":"wholesaleCbdctokenHoldableContractAddress", "in":"path", "required":true, "schema":{ "type":"string" }, "description":"Path parameter" } ], "requestBody":{ "required":true, "content":{ "application/json":{ "schema":{ "type":"object", "properties":{ "walletId":{ "type":"string", "example":"", "description":"Postman variable {{walletId}}" }, "to":{ "type":"string", "example":"0x0000000000000000000000000000000000000000" }, "value":{ "type":"integer", "example":0 } }, "required":[ "walletId", "to", "value" ], "additionalProperties":false }, "example":{ "walletId":"{{walletId}}", "to":"0x0000000000000000000000000000000000000000", "value":0 } } } }, "x-contract-endpoint-name":"mint", "x-contract-method":{ "name":"mint", "signature":"mint(address,uint256)" }, "x-contract-args":[ "to", "value" ], "x-generate-postman-api":true, "x-internal-id":"{wholesaleCbdctokenHoldableContractAddress}-mint-post", "x-filename-id":"wholesalecbdctokenholdablecontractaddress-mint-post" } }, "/{wholesaleCbdctokenHoldableContractAddress}/name":{ "get":{ "summary":"Get Token Name", "description":"Retrieves the token name.", "operationId":"name", "tags":[ "Token Contract Endpoints" ], "responses":{ "200":{ "description":"Successful rpc-proxy query response.", "content":{ "application/json":{ "schema":{ "$ref":"#/components/schemas/RpcProxy_QuerySuccessResponse" } } } }, "400":{ "description":"Wrapper validation failure or rpc-proxy bad-request response." }, "404":{ "description":"Unregistered endpoint or rpc-proxy not-found response." }, "502":{ "description":"Wrapper-to-rpc-proxy failure or rpc-proxy gateway response." }, "default":{ "description":"rpc-proxy status, content type, and response body are passed through unchanged." } }, "x-postman-request-name":"GET name", "parameters":[ { "name":"fromAddress", "in":"query", "required":false, "schema":{ "type":"string" } }, { "name":"blockTag", "in":"query", "required":false, "schema":{ "type":"string", "default":"latest" } }, { "name":"wholesaleCbdctokenHoldableContractAddress", "in":"path", "required":true, "schema":{ "type":"string" }, "description":"Path parameter" } ], "x-contract-endpoint-name":"name", "x-contract-method":{ "name":"name", "signature":"name()" }, "x-contract-args":[ ], "x-generate-postman-api":true, "x-internal-id":"{wholesaleCbdctokenHoldableContractAddress}-name-get", "x-filename-id":"wholesalecbdctokenholdablecontractaddress-name-get" } }, "/{wholesaleCbdctokenHoldableContractAddress}/pause":{ "post":{ "summary":"Pause Token", "description":"Pauses token operations.", "operationId":"pause", "tags":[ "Token Contract Endpoints" ], "responses":{ "200":{ "description":"Successful rpc-proxy transaction response.", "content":{ "application/json":{ "schema":{ "$ref":"#/components/schemas/RpcProxy_TransactionSuccessResponse" } } } }, "400":{ "description":"Wrapper validation failure or rpc-proxy bad-request response." }, "404":{ "description":"Unregistered endpoint or rpc-proxy not-found response." }, "502":{ "description":"Wrapper-to-rpc-proxy failure or rpc-proxy gateway response." }, "default":{ "description":"rpc-proxy status, content type, and response body are passed through unchanged." } }, "x-postman-request-name":"POST pause", "parameters":[ { "name":"wholesaleCbdctokenHoldableContractAddress", "in":"path", "required":true, "schema":{ "type":"string" }, "description":"Path parameter" } ], "requestBody":{ "required":true, "content":{ "application/json":{ "schema":{ "type":"object", "properties":{ "walletId":{ "type":"string", "example":"", "description":"Postman variable {{walletId}}" } }, "required":[ "walletId" ], "additionalProperties":false }, "example":{ "walletId":"{{walletId}}" } } } }, "x-contract-endpoint-name":"pause", "x-contract-method":{ "name":"pause", "signature":"pause()" }, "x-contract-args":[ ], "x-generate-postman-api":true, "x-internal-id":"{wholesaleCbdctokenHoldableContractAddress}-pause-post", "x-filename-id":"wholesalecbdctokenholdablecontractaddress-pause-post" } }, "/{wholesaleCbdctokenHoldableContractAddress}/paused":{ "get":{ "summary":"Check Token Paused", "description":"Determines whether token operations are paused.", "operationId":"paused", "tags":[ "Token Contract Endpoints" ], "responses":{ "200":{ "description":"Successful rpc-proxy query response.", "content":{ "application/json":{ "schema":{ "$ref":"#/components/schemas/RpcProxy_QuerySuccessResponse" } } } }, "400":{ "description":"Wrapper validation failure or rpc-proxy bad-request response." }, "404":{ "description":"Unregistered endpoint or rpc-proxy not-found response." }, "502":{ "description":"Wrapper-to-rpc-proxy failure or rpc-proxy gateway response." }, "default":{ "description":"rpc-proxy status, content type, and response body are passed through unchanged." } }, "x-postman-request-name":"GET paused", "parameters":[ { "name":"fromAddress", "in":"query", "required":false, "schema":{ "type":"string" } }, { "name":"blockTag", "in":"query", "required":false, "schema":{ "type":"string", "default":"latest" } }, { "name":"wholesaleCbdctokenHoldableContractAddress", "in":"path", "required":true, "schema":{ "type":"string" }, "description":"Path parameter" } ], "x-contract-endpoint-name":"paused", "x-contract-method":{ "name":"paused", "signature":"paused()" }, "x-contract-args":[ ], "x-generate-postman-api":true, "x-internal-id":"{wholesaleCbdctokenHoldableContractAddress}-paused-get", "x-filename-id":"wholesalecbdctokenholdablecontractaddress-paused-get" } }, "/{wholesaleCbdctokenHoldableContractAddress}/rejectBurn":{ "post":{ "summary":"Reject Burn Request", "description":"Rejects a pending token-burn request.", "operationId":"rejectBurn", "tags":[ "Token Contract Endpoints" ], "responses":{ "200":{ "description":"Successful rpc-proxy transaction response.", "content":{ "application/json":{ "schema":{ "$ref":"#/components/schemas/RpcProxy_TransactionSuccessResponse" } } } }, "400":{ "description":"Wrapper validation failure or rpc-proxy bad-request response." }, "404":{ "description":"Unregistered endpoint or rpc-proxy not-found response." }, "502":{ "description":"Wrapper-to-rpc-proxy failure or rpc-proxy gateway response." }, "default":{ "description":"rpc-proxy status, content type, and response body are passed through unchanged." } }, "x-postman-request-name":"POST rejectBurn", "parameters":[ { "name":"wholesaleCbdctokenHoldableContractAddress", "in":"path", "required":true, "schema":{ "type":"string" }, "description":"Path parameter" } ], "requestBody":{ "required":true, "content":{ "application/json":{ "schema":{ "type":"object", "properties":{ "walletId":{ "type":"string", "example":"", "description":"Postman variable {{walletId}}" }, "opId":{ "type":"string", "example":"opId value" } }, "required":[ "walletId", "opId" ], "additionalProperties":false }, "example":{ "walletId":"{{walletId}}", "opId":"opId value" } } } }, "x-contract-endpoint-name":"rejectBurn", "x-contract-method":{ "name":"rejectBurn", "signature":"rejectBurn(string)" }, "x-contract-args":[ "opId" ], "x-generate-postman-api":true, "x-internal-id":"{wholesaleCbdctokenHoldableContractAddress}-rejectBurn-post", "x-filename-id":"wholesalecbdctokenholdablecontractaddress-rejectburn-post" } }, "/{wholesaleCbdctokenHoldableContractAddress}/rejectMint":{ "post":{ "summary":"Reject Mint Request", "description":"Rejects a pending token-mint request.", "operationId":"rejectMint", "tags":[ "Token Contract Endpoints" ], "responses":{ "200":{ "description":"Successful rpc-proxy transaction response.", "content":{ "application/json":{ "schema":{ "$ref":"#/components/schemas/RpcProxy_TransactionSuccessResponse" } } } }, "400":{ "description":"Wrapper validation failure or rpc-proxy bad-request response." }, "404":{ "description":"Unregistered endpoint or rpc-proxy not-found response." }, "502":{ "description":"Wrapper-to-rpc-proxy failure or rpc-proxy gateway response." }, "default":{ "description":"rpc-proxy status, content type, and response body are passed through unchanged." } }, "x-postman-request-name":"POST rejectMint", "parameters":[ { "name":"wholesaleCbdctokenHoldableContractAddress", "in":"path", "required":true, "schema":{ "type":"string" }, "description":"Path parameter" } ], "requestBody":{ "required":true, "content":{ "application/json":{ "schema":{ "type":"object", "properties":{ "walletId":{ "type":"string", "example":"", "description":"Postman variable {{walletId}}" }, "opId":{ "type":"string", "example":"opId value" } }, "required":[ "walletId", "opId" ], "additionalProperties":false }, "example":{ "walletId":"{{walletId}}", "opId":"opId value" } } } }, "x-contract-endpoint-name":"rejectMint", "x-contract-method":{ "name":"rejectMint", "signature":"rejectMint(string)" }, "x-contract-args":[ "opId" ], "x-generate-postman-api":true, "x-internal-id":"{wholesaleCbdctokenHoldableContractAddress}-rejectMint-post", "x-filename-id":"wholesalecbdctokenholdablecontractaddress-rejectmint-post" } }, "/{wholesaleCbdctokenHoldableContractAddress}/releaseHold":{ "post":{ "summary":"Release Token Hold", "description":"Releases tokens from the specified hold operation.", "operationId":"releaseHold", "tags":[ "Token Contract Endpoints" ], "responses":{ "200":{ "description":"Successful rpc-proxy transaction response.", "content":{ "application/json":{ "schema":{ "$ref":"#/components/schemas/RpcProxy_TransactionSuccessResponse" } } } }, "400":{ "description":"Wrapper validation failure or rpc-proxy bad-request response." }, "404":{ "description":"Unregistered endpoint or rpc-proxy not-found response." }, "502":{ "description":"Wrapper-to-rpc-proxy failure or rpc-proxy gateway response." }, "default":{ "description":"rpc-proxy status, content type, and response body are passed through unchanged." } }, "x-postman-request-name":"POST releaseHold", "parameters":[ { "name":"wholesaleCbdctokenHoldableContractAddress", "in":"path", "required":true, "schema":{ "type":"string" }, "description":"Path parameter" } ], "requestBody":{ "required":true, "content":{ "application/json":{ "schema":{ "type":"object", "properties":{ "walletId":{ "type":"string", "example":"", "description":"Postman variable {{walletId}}" }, "opId":{ "type":"string", "example":"opId value" } }, "required":[ "walletId", "opId" ], "additionalProperties":false }, "example":{ "walletId":"{{walletId}}", "opId":"opId value" } } } }, "x-contract-endpoint-name":"releaseHold", "x-contract-method":{ "name":"releaseHold", "signature":"releaseHold(string)" }, "x-contract-args":[ "opId" ], "x-generate-postman-api":true, "x-internal-id":"{wholesaleCbdctokenHoldableContractAddress}-releaseHold-post", "x-filename-id":"wholesalecbdctokenholdablecontractaddress-releasehold-post" } }, "/{wholesaleCbdctokenHoldableContractAddress}/requestBurn":{ "post":{ "summary":"Request Token Burn", "description":"Submits a request to burn tokens.", "operationId":"requestBurn", "tags":[ "Token Contract Endpoints" ], "responses":{ "200":{ "description":"Successful rpc-proxy transaction response.", "content":{ "application/json":{ "schema":{ "$ref":"#/components/schemas/RpcProxy_TransactionSuccessResponse" } } } }, "400":{ "description":"Wrapper validation failure or rpc-proxy bad-request response." }, "404":{ "description":"Unregistered endpoint or rpc-proxy not-found response." }, "502":{ "description":"Wrapper-to-rpc-proxy failure or rpc-proxy gateway response." }, "default":{ "description":"rpc-proxy status, content type, and response body are passed through unchanged." } }, "x-postman-request-name":"POST requestBurn", "parameters":[ { "name":"wholesaleCbdctokenHoldableContractAddress", "in":"path", "required":true, "schema":{ "type":"string" }, "description":"Path parameter" } ], "requestBody":{ "required":true, "content":{ "application/json":{ "schema":{ "type":"object", "properties":{ "walletId":{ "type":"string", "example":"", "description":"Postman variable {{walletId}}" }, "notary":{ "type":"string", "example":"0x0000000000000000000000000000000000000000" }, "amount":{ "type":"integer", "example":0 }, "expiration":{ "type":"integer", "example":0 }, "opId":{ "type":"string", "example":"opId value" }, "info":{ "type":"string", "example":"{\"category\":\"category value\",\"description\":\"description\nvalue\"}" } }, "required":[ "walletId", "notary", "amount", "expiration", "opId", "info" ], "additionalProperties":false }, "example":{ "walletId":"{{walletId}}", "notary":"0x0000000000000000000000000000000000000000", "amount":0, "expiration":0, "opId":"opId value", "info":"{\"category\":\"category value\",\"description\":\"description value\"}" } } } }, "x-contract-endpoint-name":"requestBurn", "x-contract-method":{ "name":"requestBurn", "signature":"requestBurn(address,uint256,uint256,string,(string,string))" }, "x-contract-args":[ "notary", "amount", "expiration", "opId", "info" ], "x-contract-arg-definitions":{ "info":{ "kind":"tuple", "fields":[ { "name":"category" }, { "name":"description" } ] } }, "x-generate-postman-api":true, "x-internal-id":"{wholesaleCbdctokenHoldableContractAddress}-requestBurn-post", "x-filename-id":"wholesalecbdctokenholdablecontractaddress-requestburn-post" } }, "/{wholesaleCbdctokenHoldableContractAddress}/requestMint":{ "post":{ "summary":"Request Token Mint", "description":"Submits a request to mint tokens.", "operationId":"requestMint", "tags":[ "Token Contract Endpoints" ], "responses":{ "200":{ "description":"Successful rpc-proxy transaction response.", "content":{ "application/json":{ "schema":{ "$ref":"#/components/schemas/RpcProxy_TransactionSuccessResponse" } } } }, "400":{ "description":"Wrapper validation failure or rpc-proxy bad-request response." }, "404":{ "description":"Unregistered endpoint or rpc-proxy not-found response." }, "502":{ "description":"Wrapper-to-rpc-proxy failure or rpc-proxy gateway response." }, "default":{ "description":"rpc-proxy status, content type, and response body are passed through unchanged." } }, "x-postman-request-name":"POST requestMint", "parameters":[ { "name":"wholesaleCbdctokenHoldableContractAddress", "in":"path", "required":true, "schema":{ "type":"string" }, "description":"Path parameter" } ], "requestBody":{ "required":true, "content":{ "application/json":{ "schema":{ "type":"object", "properties":{ "walletId":{ "type":"string", "example":"", "description":"Postman variable {{walletId}}" }, "notary":{ "type":"string", "example":"0x0000000000000000000000000000000000000000" }, "amount":{ "type":"integer", "example":0 }, "expiration":{ "type":"integer", "example":0 }, "opId":{ "type":"string", "example":"opId value" }, "info":{ "type":"string", "example":"{\"category\":\"category value\",\"description\":\"description\nvalue\"}" } }, "required":[ "walletId", "notary", "amount", "expiration", "opId", "info" ], "additionalProperties":false }, "example":{ "walletId":"{{walletId}}", "notary":"0x0000000000000000000000000000000000000000", "amount":0, "expiration":0, "opId":"opId value", "info":"{\"category\":\"category value\",\"description\":\"description value\"}" } } } }, "x-contract-endpoint-name":"requestMint", "x-contract-method":{ "name":"requestMint", "signature":"requestMint(address,uint256,uint256,string,(string,string))" }, "x-contract-args":[ "notary", "amount", "expiration", "opId", "info" ], "x-contract-arg-definitions":{ "info":{ "kind":"tuple", "fields":[ { "name":"category" }, { "name":"description" } ] } }, "x-generate-postman-api":true, "x-internal-id":"{wholesaleCbdctokenHoldableContractAddress}-requestMint-post", "x-filename-id":"wholesalecbdctokenholdablecontractaddress-requestmint-post" } }, "/{wholesaleCbdctokenHoldableContractAddress}/setGovernanceContext":{ "post":{ "summary":"Set Token Governance Context", "description":"Sets the governance context for the wholesale CBDC token.", "operationId":"setGovernanceContext_wholesale", "tags":[ "Token Contract Endpoints" ], "responses":{ "200":{ "description":"Successful rpc-proxy transaction response.", "content":{ "application/json":{ "schema":{ "$ref":"#/components/schemas/RpcProxy_TransactionSuccessResponse" } } } }, "400":{ "description":"Wrapper validation failure or rpc-proxy bad-request response." }, "404":{ "description":"Unregistered endpoint or rpc-proxy not-found response." }, "502":{ "description":"Wrapper-to-rpc-proxy failure or rpc-proxy gateway response." }, "default":{ "description":"rpc-proxy status, content type, and response body are passed through unchanged." } }, "x-postman-request-name":"POST setGovernanceContext", "parameters":[ { "name":"wholesaleCbdctokenHoldableContractAddress", "in":"path", "required":true, "schema":{ "type":"string" }, "description":"Path parameter" } ], "requestBody":{ "required":true, "content":{ "application/json":{ "schema":{ "type":"object", "properties":{ "walletId":{ "type":"string", "example":"", "description":"Postman variable {{walletId}}" }, "uuid":{ "type":"string", "example":"uuid value" }, "governance":{ "type":"string", "example":"0x0000000000000000000000000000000000000000" } }, "required":[ "walletId", "uuid", "governance" ], "additionalProperties":false }, "example":{ "walletId":"{{walletId}}", "uuid":"uuid value", "governance":"0x0000000000000000000000000000000000000000" } } } }, "x-contract-endpoint-name":"setGovernanceContext", "x-contract-method":{ "name":"setGovernanceContext", "signature":"setGovernanceContext(string,address)" }, "x-contract-args":[ "uuid", "governance" ], "x-generate-postman-api":true, "x-internal-id":"{wholesaleCbdctokenHoldableContractAddress}-setGovernanceContext-post", "x-filename-id":"wholesalecbdctokenholdablecontractaddress-setgovernancecontext-post" } }, "/{wholesaleCbdctokenHoldableContractAddress}/setTokenContext":{ "post":{ "summary":"Set Token Context", "description":"Sets the context associated with the wholesale CBDC token.", "operationId":"setTokenContext", "tags":[ "Token Contract Endpoints" ], "responses":{ "200":{ "description":"Successful rpc-proxy transaction response.", "content":{ "application/json":{ "schema":{ "$ref":"#/components/schemas/RpcProxy_TransactionSuccessResponse" } } } }, "400":{ "description":"Wrapper validation failure or rpc-proxy bad-request response." }, "404":{ "description":"Unregistered endpoint or rpc-proxy not-found response." }, "502":{ "description":"Wrapper-to-rpc-proxy failure or rpc-proxy gateway response." }, "default":{ "description":"rpc-proxy status, content type, and response body are passed through unchanged." } }, "x-postman-request-name":"POST setTokenContext", "parameters":[ { "name":"wholesaleCbdctokenHoldableContractAddress", "in":"path", "required":true, "schema":{ "type":"string" }, "description":"Path parameter" } ], "requestBody":{ "required":true, "content":{ "application/json":{ "schema":{ "type":"object", "properties":{ "walletId":{ "type":"string", "example":"", "description":"Postman variable {{walletId}}" }, "identityGateway":{ "type":"string", "example":"0x0000000000000000000000000000000000000000" }, "policyGateway":{ "type":"string", "example":"0x0000000000000000000000000000000000000000" } }, "required":[ "walletId", "identityGateway", "policyGateway" ], "additionalProperties":false }, "example":{ "walletId":"{{walletId}}", "identityGateway":"0x0000000000000000000000000000000000000000", "policyGateway":"0x0000000000000000000000000000000000000000" } } } }, "x-contract-endpoint-name":"setTokenContext", "x-contract-method":{ "name":"setTokenContext", "signature":"setTokenContext(address,address)" }, "x-contract-args":[ "identityGateway", "policyGateway" ], "x-generate-postman-api":true, "x-internal-id":"{wholesaleCbdctokenHoldableContractAddress}-setTokenContext-post", "x-filename-id":"wholesalecbdctokenholdablecontractaddress-settokencontext-post" } }, "/{wholesaleCbdctokenHoldableContractAddress}/symbol":{ "get":{ "summary":"Get Token Symbol", "description":"Retrieves the token symbol.", "operationId":"symbol", "tags":[ "Token Contract Endpoints" ], "responses":{ "200":{ "description":"Successful rpc-proxy query response.", "content":{ "application/json":{ "schema":{ "$ref":"#/components/schemas/RpcProxy_QuerySuccessResponse" } } } }, "400":{ "description":"Wrapper validation failure or rpc-proxy bad-request response." }, "404":{ "description":"Unregistered endpoint or rpc-proxy not-found response." }, "502":{ "description":"Wrapper-to-rpc-proxy failure or rpc-proxy gateway response." }, "default":{ "description":"rpc-proxy status, content type, and response body are passed through unchanged." } }, "x-postman-request-name":"GET symbol", "parameters":[ { "name":"fromAddress", "in":"query", "required":false, "schema":{ "type":"string" } }, { "name":"blockTag", "in":"query", "required":false, "schema":{ "type":"string", "default":"latest" } }, { "name":"wholesaleCbdctokenHoldableContractAddress", "in":"path", "required":true, "schema":{ "type":"string" }, "description":"Path parameter" } ], "x-contract-endpoint-name":"symbol", "x-contract-method":{ "name":"symbol", "signature":"symbol()" }, "x-contract-args":[ ], "x-generate-postman-api":true, "x-internal-id":"{wholesaleCbdctokenHoldableContractAddress}-symbol-get", "x-filename-id":"wholesalecbdctokenholdablecontractaddress-symbol-get" } }, "/{wholesaleCbdctokenHoldableContractAddress}/totalSupply":{ "get":{ "summary":"Get Token Supply", "description":"Retrieves the total supply of tokens.", "operationId":"totalSupply", "tags":[ "Token Contract Endpoints" ], "responses":{ "200":{ "description":"Successful rpc-proxy query response.", "content":{ "application/json":{ "schema":{ "$ref":"#/components/schemas/RpcProxy_QuerySuccessResponse" } } } }, "400":{ "description":"Wrapper validation failure or rpc-proxy bad-request response." }, "404":{ "description":"Unregistered endpoint or rpc-proxy not-found response." }, "502":{ "description":"Wrapper-to-rpc-proxy failure or rpc-proxy gateway response." }, "default":{ "description":"rpc-proxy status, content type, and response body are passed through unchanged." } }, "x-postman-request-name":"GET totalSupply", "parameters":[ { "name":"fromAddress", "in":"query", "required":false, "schema":{ "type":"string" } }, { "name":"blockTag", "in":"query", "required":false, "schema":{ "type":"string", "default":"latest" } }, { "name":"wholesaleCbdctokenHoldableContractAddress", "in":"path", "required":true, "schema":{ "type":"string" }, "description":"Path parameter" } ], "x-contract-endpoint-name":"totalSupply", "x-contract-method":{ "name":"totalSupply", "signature":"totalSupply()" }, "x-contract-args":[ ], "x-generate-postman-api":true, "x-internal-id":"{wholesaleCbdctokenHoldableContractAddress}-totalSupply-get", "x-filename-id":"wholesalecbdctokenholdablecontractaddress-totalsupply-get" } }, "/{wholesaleCbdctokenHoldableContractAddress}/transfer":{ "post":{ "summary":"Transfer Tokens", "description":"Transfers tokens from the caller account to another account.", "operationId":"transfer", "tags":[ "Token Contract Endpoints" ], "responses":{ "200":{ "description":"Successful rpc-proxy transaction response.", "content":{ "application/json":{ "schema":{ "$ref":"#/components/schemas/RpcProxy_TransactionSuccessResponse" } } } }, "400":{ "description":"Wrapper validation failure or rpc-proxy bad-request response." }, "404":{ "description":"Unregistered endpoint or rpc-proxy not-found response." }, "502":{ "description":"Wrapper-to-rpc-proxy failure or rpc-proxy gateway response." }, "default":{ "description":"rpc-proxy status, content type, and response body are passed through unchanged." } }, "x-postman-request-name":"POST transfer", "parameters":[ { "name":"wholesaleCbdctokenHoldableContractAddress", "in":"path", "required":true, "schema":{ "type":"string" }, "description":"Path parameter" } ], "requestBody":{ "required":true, "content":{ "application/json":{ "schema":{ "type":"object", "properties":{ "walletId":{ "type":"string", "example":"", "description":"Postman variable {{walletId}}" }, "to":{ "type":"string", "example":"0x0000000000000000000000000000000000000000" }, "value":{ "type":"integer", "example":0 }, "contextTrailer":{ "type":"object", "properties":{ "category":{ "type":"string", "example":"cat " }, "description":{ "type":"string", "example":"desc " } }, "required":[ "category", "description" ], "additionalProperties":false } }, "required":[ "walletId", "to", "value", "contextTrailer" ], "additionalProperties":false }, "example":{ "walletId":"{{walletId}}", "to":"0x0000000000000000000000000000000000000000", "value":0, "contextTrailer":{ "category":"cat ", "description":"desc " } } } } }, "x-contract-endpoint-name":"transfer", "x-contract-method":{ "name":"transfer", "signature":"transfer(address,uint256)" }, "x-contract-args":[ "to", "value" ], "x-generate-postman-api":true, "x-internal-id":"{wholesaleCbdctokenHoldableContractAddress}-transfer-post", "x-filename-id":"wholesalecbdctokenholdablecontractaddress-transfer-post" } }, "/{wholesaleCbdctokenHoldableContractAddress}/transferFrom":{ "post":{ "summary":"Transfer Approved Tokens", "description":"Transfers tokens from an approved account to another account.", "operationId":"transferFrom", "tags":[ "Token Contract Endpoints" ], "responses":{ "200":{ "description":"Successful rpc-proxy transaction response.", "content":{ "application/json":{ "schema":{ "$ref":"#/components/schemas/RpcProxy_TransactionSuccessResponse" } } } }, "400":{ "description":"Wrapper validation failure or rpc-proxy bad-request response." }, "404":{ "description":"Unregistered endpoint or rpc-proxy not-found response." }, "502":{ "description":"Wrapper-to-rpc-proxy failure or rpc-proxy gateway response." }, "default":{ "description":"rpc-proxy status, content type, and response body are passed through unchanged." } }, "x-postman-request-name":"POST transferFrom", "parameters":[ { "name":"wholesaleCbdctokenHoldableContractAddress", "in":"path", "required":true, "schema":{ "type":"string" }, "description":"Path parameter" } ], "requestBody":{ "required":true, "content":{ "application/json":{ "schema":{ "type":"object", "properties":{ "walletId":{ "type":"string", "example":"", "description":"Postman variable {{walletId}}" }, "from":{ "type":"string", "example":"0x0000000000000000000000000000000000000000" }, "to":{ "type":"string", "example":"0x0000000000000000000000000000000000000000" }, "value":{ "type":"integer", "example":0 } }, "required":[ "walletId", "from", "to", "value" ], "additionalProperties":false }, "example":{ "walletId":"{{walletId}}", "from":"0x0000000000000000000000000000000000000000", "to":"0x0000000000000000000000000000000000000000", "value":0 } } } }, "x-contract-endpoint-name":"transferFrom", "x-contract-method":{ "name":"transferFrom", "signature":"transferFrom(address,address,uint256)" }, "x-contract-args":[ "from", "to", "value" ], "x-generate-postman-api":true, "x-internal-id":"{wholesaleCbdctokenHoldableContractAddress}-transferFrom-post", "x-filename-id":"wholesalecbdctokenholdablecontractaddress-transferfrom-post" } }, "/{wholesaleCbdctokenHoldableContractAddress}/unpause":{ "post":{ "summary":"Resume Token", "description":"Resumes token operations.", "operationId":"unpause", "tags":[ "Token Contract Endpoints" ], "responses":{ "200":{ "description":"Successful rpc-proxy transaction response.", "content":{ "application/json":{ "schema":{ "$ref":"#/components/schemas/RpcProxy_TransactionSuccessResponse" } } } }, "400":{ "description":"Wrapper validation failure or rpc-proxy bad-request response." }, "404":{ "description":"Unregistered endpoint or rpc-proxy not-found response." }, "502":{ "description":"Wrapper-to-rpc-proxy failure or rpc-proxy gateway response." }, "default":{ "description":"rpc-proxy status, content type, and response body are passed through unchanged." } }, "x-postman-request-name":"POST unpause", "parameters":[ { "name":"wholesaleCbdctokenHoldableContractAddress", "in":"path", "required":true, "schema":{ "type":"string" }, "description":"Path parameter" } ], "requestBody":{ "required":true, "content":{ "application/json":{ "schema":{ "type":"object", "properties":{ "walletId":{ "type":"string", "example":"", "description":"Postman variable {{walletId}}" } }, "required":[ "walletId" ], "additionalProperties":false }, "example":{ "walletId":"{{walletId}}" } } } }, "x-contract-endpoint-name":"unpause", "x-contract-method":{ "name":"unpause", "signature":"unpause()" }, "x-contract-args":[ ], "x-generate-postman-api":true, "x-internal-id":"{wholesaleCbdctokenHoldableContractAddress}-unpause-post", "x-filename-id":"wholesalecbdctokenholdablecontractaddress-unpause-post" } }, "/{wholesaleCbdctokenHoldableContractAddress}/updateNotary":{ "post":{ "summary":"Update Token Notary", "description":"Updates the notary assigned to the wholesale CBDC token.", "operationId":"updateNotary", "tags":[ "Token Contract Endpoints" ], "responses":{ "200":{ "description":"Successful rpc-proxy transaction response.", "content":{ "application/json":{ "schema":{ "$ref":"#/components/schemas/RpcProxy_TransactionSuccessResponse" } } } }, "400":{ "description":"Wrapper validation failure or rpc-proxy bad-request response." }, "404":{ "description":"Unregistered endpoint or rpc-proxy not-found response." }, "502":{ "description":"Wrapper-to-rpc-proxy failure or rpc-proxy gateway response." }, "default":{ "description":"rpc-proxy status, content type, and response body are passed through unchanged." } }, "x-postman-request-name":"POST updateNotary", "parameters":[ { "name":"wholesaleCbdctokenHoldableContractAddress", "in":"path", "required":true, "schema":{ "type":"string" }, "description":"Path parameter" } ], "requestBody":{ "required":true, "content":{ "application/json":{ "schema":{ "type":"object", "properties":{ "walletId":{ "type":"string", "example":"", "description":"Postman variable {{walletId}}" }, "opId":{ "type":"string", "example":"opId value" }, "newNotary":{ "type":"string", "example":"0x0000000000000000000000000000000000000000" } }, "required":[ "walletId", "opId", "newNotary" ], "additionalProperties":false }, "example":{ "walletId":"{{walletId}}", "opId":"opId value", "newNotary":"0x0000000000000000000000000000000000000000" } } } }, "x-contract-endpoint-name":"updateNotary", "x-contract-method":{ "name":"updateNotary", "signature":"updateNotary(string,address)" }, "x-contract-args":[ "opId", "newNotary" ], "x-generate-postman-api":true, "x-internal-id":"{wholesaleCbdctokenHoldableContractAddress}-updateNotary-post", "x-filename-id":"wholesalecbdctokenholdablecontractaddress-updatenotary-post" } }, "/{wholesaleCbdctokenHoldableContractAddress}/version":{ "get":{ "summary":"Get Token Version", "description":"Retrieves the wholesale CBDC token contract version.", "operationId":"version_wholesale", "tags":[ "Token Contract Endpoints" ], "responses":{ "200":{ "description":"Successful rpc-proxy query response.", "content":{ "application/json":{ "schema":{ "$ref":"#/components/schemas/RpcProxy_QuerySuccessResponse" } } } }, "400":{ "description":"Wrapper validation failure or rpc-proxy bad-request response." }, "404":{ "description":"Unregistered endpoint or rpc-proxy not-found response." }, "502":{ "description":"Wrapper-to-rpc-proxy failure or rpc-proxy gateway response." }, "default":{ "description":"rpc-proxy status, content type, and response body are passed through unchanged." } }, "x-postman-request-name":"GET version", "parameters":[ { "name":"fromAddress", "in":"query", "required":false, "schema":{ "type":"string" } }, { "name":"blockTag", "in":"query", "required":false, "schema":{ "type":"string", "default":"latest" } }, { "name":"wholesaleCbdctokenHoldableContractAddress", "in":"path", "required":true, "schema":{ "type":"string" }, "description":"Path parameter" } ], "x-contract-endpoint-name":"version", "x-contract-method":{ "name":"version", "signature":"version()" }, "x-contract-args":[ ], "x-generate-postman-api":true, "x-internal-id":"{wholesaleCbdctokenHoldableContractAddress}-version-get", "x-filename-id":"wholesalecbdctokenholdablecontractaddress-version-get" } }, "/{accountWithErc5982UupsContractAddress}/activateAccount":{ "post":{ "summary":"Activate Account", "description":"Activates the specified CBDC account.", "operationId":"activateAccount", "tags":[ "Account Contract Endpoints" ], "responses":{ "200":{ "description":"Successful rpc-proxy transaction response.", "content":{ "application/json":{ "schema":{ "$ref":"#/components/schemas/RpcProxy_TransactionSuccessResponse" } } } }, "400":{ "description":"Wrapper validation failure or rpc-proxy bad-request response." }, "404":{ "description":"Unregistered endpoint or rpc-proxy not-found response." }, "502":{ "description":"Wrapper-to-rpc-proxy failure or rpc-proxy gateway response." }, "default":{ "description":"rpc-proxy status, content type, and response body are passed through unchanged." } }, "x-postman-request-name":"POST activateAccount", "parameters":[ { "name":"accountWithErc5982UupsContractAddress", "in":"path", "required":true, "schema":{ "type":"string" }, "description":"Path parameter" } ], "requestBody":{ "required":true, "content":{ "application/json":{ "schema":{ "type":"object", "properties":{ "walletId":{ "type":"string", "example":"", "description":"Postman variable {{walletId}}" }, "userAddress":{ "type":"string", "example":"0x0000000000000000000000000000000000000000" } }, "required":[ "walletId", "userAddress" ], "additionalProperties":false }, "example":{ "walletId":"{{walletId}}", "userAddress":"0x0000000000000000000000000000000000000000" } } } }, "x-contract-endpoint-name":"activateAccount", "x-contract-method":{ "name":"activateAccount", "signature":"activateAccount(address)" }, "x-contract-args":[ "userAddress" ], "x-generate-postman-api":true, "x-internal-id":"{accountWithErc5982UupsContractAddress}-activateAccount-post", "x-filename-id":"accountwitherc5982uupscontractaddress-activateaccount-post" } }, "/{accountWithErc5982UupsContractAddress}/addOrgAdmin":{ "post":{ "summary":"Add Organization Admin", "description":"Assigns the organization administrator role to an account.", "operationId":"addOrgAdmin", "tags":[ "Account Contract Endpoints" ], "responses":{ "200":{ "description":"Successful rpc-proxy transaction response.", "content":{ "application/json":{ "schema":{ "$ref":"#/components/schemas/RpcProxy_TransactionSuccessResponse" } } } }, "400":{ "description":"Wrapper validation failure or rpc-proxy bad-request response." }, "404":{ "description":"Unregistered endpoint or rpc-proxy not-found response." }, "502":{ "description":"Wrapper-to-rpc-proxy failure or rpc-proxy gateway response." }, "default":{ "description":"rpc-proxy status, content type, and response body are passed through unchanged." } }, "x-postman-request-name":"POST addOrgAdmin", "parameters":[ { "name":"accountWithErc5982UupsContractAddress", "in":"path", "required":true, "schema":{ "type":"string" }, "description":"Path parameter" } ], "requestBody":{ "required":true, "content":{ "application/json":{ "schema":{ "type":"object", "properties":{ "walletId":{ "type":"string", "example":"", "description":"Postman variable {{walletId}}" }, "adminDetails":{ "type":"string", "example":"{\"userId\":\"userId value\",\"orgId\":\"orgId value\",\"accountAddress\":\"accountAddress\nvalue\"}" } }, "required":[ "walletId", "adminDetails" ], "additionalProperties":false }, "example":{ "walletId":"{{walletId}}", "adminDetails":"{\"userId\":\"userId value\",\"orgId\":\"orgId value\",\"accountAddress\":\"accountAddress\nvalue\"}" } } } }, "x-contract-endpoint-name":"addOrgAdmin", "x-contract-method":{ "name":"addOrgAdmin", "signature":"addOrgAdmin((string,string,address))" }, "x-contract-args":[ "adminDetails" ], "x-contract-arg-definitions":{ "adminDetails":{ "kind":"tuple", "fields":[ { "name":"userId" }, { "name":"orgId" }, { "name":"accountAddress" } ] } }, "x-generate-postman-api":true, "x-internal-id":"{accountWithErc5982UupsContractAddress}-addOrgAdmin-post", "x-filename-id":"accountwitherc5982uupscontractaddress-addorgadmin-post" } }, "/{accountWithErc5982UupsContractAddress}/addOrgAuditor":{ "post":{ "summary":"Add Organization Auditor", "description":"Assigns the organization auditor role to an account.", "operationId":"addOrgAuditor", "tags":[ "Account Contract Endpoints" ], "responses":{ "200":{ "description":"Successful rpc-proxy transaction response.", "content":{ "application/json":{ "schema":{ "$ref":"#/components/schemas/RpcProxy_TransactionSuccessResponse" } } } }, "400":{ "description":"Wrapper validation failure or rpc-proxy bad-request response." }, "404":{ "description":"Unregistered endpoint or rpc-proxy not-found response." }, "502":{ "description":"Wrapper-to-rpc-proxy failure or rpc-proxy gateway response." }, "default":{ "description":"rpc-proxy status, content type, and response body are passed through unchanged." } }, "x-postman-request-name":"POST addOrgAuditor", "parameters":[ { "name":"accountWithErc5982UupsContractAddress", "in":"path", "required":true, "schema":{ "type":"string" }, "description":"Path parameter" } ], "requestBody":{ "required":true, "content":{ "application/json":{ "schema":{ "type":"object", "properties":{ "walletId":{ "type":"string", "example":"", "description":"Postman variable {{walletId}}" }, "auditorDetails":{ "type":"string", "example":"{\"userId\":\"userId value\",\"orgId\":\"orgId value\",\"accountAddress\":\"accountAddress\nvalue\"}" } }, "required":[ "walletId", "auditorDetails" ], "additionalProperties":false }, "example":{ "walletId":"{{walletId}}", "auditorDetails":"{\"userId\":\"userId value\",\"orgId\":\"orgId value\",\"accountAddress\":\"accountAddress\nvalue\"}" } } } }, "x-contract-endpoint-name":"addOrgAuditor", "x-contract-method":{ "name":"addOrgAuditor", "signature":"addOrgAuditor((string,string,address))" }, "x-contract-args":[ "auditorDetails" ], "x-contract-arg-definitions":{ "auditorDetails":{ "kind":"tuple", "fields":[ { "name":"userId" }, { "name":"orgId" }, { "name":"accountAddress" } ] } }, "x-generate-postman-api":true, "x-internal-id":"{accountWithErc5982UupsContractAddress}-addOrgAuditor-post", "x-filename-id":"accountwitherc5982uupscontractaddress-addorgauditor-post" } }, "/{accountWithErc5982UupsContractAddress}/addRole":{ "post":{ "summary":"Add Role", "description":"Assigns the specified role to an account.", "operationId":"addRole", "tags":[ "Account Contract Endpoints" ], "responses":{ "200":{ "description":"Successful rpc-proxy transaction response.", "content":{ "application/json":{ "schema":{ "$ref":"#/components/schemas/RpcProxy_TransactionSuccessResponse" } } } }, "400":{ "description":"Wrapper validation failure or rpc-proxy bad-request response." }, "404":{ "description":"Unregistered endpoint or rpc-proxy not-found response." }, "502":{ "description":"Wrapper-to-rpc-proxy failure or rpc-proxy gateway response." }, "default":{ "description":"rpc-proxy status, content type, and response body are passed through unchanged." } }, "x-postman-request-name":"POST addRole", "parameters":[ { "name":"accountWithErc5982UupsContractAddress", "in":"path", "required":true, "schema":{ "type":"string" }, "description":"Path parameter" } ], "requestBody":{ "required":true, "content":{ "application/json":{ "schema":{ "type":"object", "properties":{ "walletId":{ "type":"string", "example":"", "description":"Postman variable {{walletId}}" }, "account":{ "type":"string", "example":"0x0000000000000000000000000000000000000000" }, "role":{ "type":"string", "example":"role value" } }, "required":[ "walletId", "account", "role" ], "additionalProperties":false }, "example":{ "walletId":"{{walletId}}", "account":"0x0000000000000000000000000000000000000000", "role":"role value" } } } }, "x-contract-endpoint-name":"addRole", "x-contract-method":{ "name":"addRole", "signature":"addRole(address,string)" }, "x-contract-args":[ "account", "role" ], "x-generate-postman-api":true, "x-internal-id":"{accountWithErc5982UupsContractAddress}-addRole-post", "x-filename-id":"accountwitherc5982uupscontractaddress-addrole-post" } }, "/{accountWithErc5982UupsContractAddress}/addTokenAdmin":{ "post":{ "summary":"Add Token Admin", "description":"Assigns the token administrator role to an account.", "operationId":"addTokenAdmin", "tags":[ "Account Contract Endpoints" ], "responses":{ "200":{ "description":"Successful rpc-proxy transaction response.", "content":{ "application/json":{ "schema":{ "$ref":"#/components/schemas/RpcProxy_TransactionSuccessResponse" } } } }, "400":{ "description":"Wrapper validation failure or rpc-proxy bad-request response." }, "404":{ "description":"Unregistered endpoint or rpc-proxy not-found response." }, "502":{ "description":"Wrapper-to-rpc-proxy failure or rpc-proxy gateway response." }, "default":{ "description":"rpc-proxy status, content type, and response body are passed through unchanged." } }, "x-postman-request-name":"POST addTokenAdmin", "parameters":[ { "name":"accountWithErc5982UupsContractAddress", "in":"path", "required":true, "schema":{ "type":"string" }, "description":"Path parameter" } ], "requestBody":{ "required":true, "content":{ "application/json":{ "schema":{ "type":"object", "properties":{ "walletId":{ "type":"string", "example":"", "description":"Postman variable {{walletId}}" }, "adminDetails":{ "type":"string", "example":"{\"userId\":\"userId value\",\"orgId\":\"orgId value\",\"accountAddress\":\"accountAddress\nvalue\"}" } }, "required":[ "walletId", "adminDetails" ], "additionalProperties":false }, "example":{ "walletId":"{{walletId}}", "adminDetails":"{\"userId\":\"userId value\",\"orgId\":\"orgId value\",\"accountAddress\":\"accountAddress\nvalue\"}" } } } }, "x-contract-endpoint-name":"addTokenAdmin", "x-contract-method":{ "name":"addTokenAdmin", "signature":"addTokenAdmin((string,string,address))" }, "x-contract-args":[ "adminDetails" ], "x-contract-arg-definitions":{ "adminDetails":{ "kind":"tuple", "fields":[ { "name":"userId" }, { "name":"orgId" }, { "name":"accountAddress" } ] } }, "x-generate-postman-api":true, "x-internal-id":"{accountWithErc5982UupsContractAddress}-addTokenAdmin-post", "x-filename-id":"accountwitherc5982uupscontractaddress-addtokenadmin-post" } }, "/{accountWithErc5982UupsContractAddress}/addTokenAuditor":{ "post":{ "summary":"Add Token Auditor", "description":"Assigns the token auditor role to an account.", "operationId":"addTokenAuditor", "tags":[ "Account Contract Endpoints" ], "responses":{ "200":{ "description":"Successful rpc-proxy transaction response.", "content":{ "application/json":{ "schema":{ "$ref":"#/components/schemas/RpcProxy_TransactionSuccessResponse" } } } }, "400":{ "description":"Wrapper validation failure or rpc-proxy bad-request response." }, "404":{ "description":"Unregistered endpoint or rpc-proxy not-found response." }, "502":{ "description":"Wrapper-to-rpc-proxy failure or rpc-proxy gateway response." }, "default":{ "description":"rpc-proxy status, content type, and response body are passed through unchanged." } }, "x-postman-request-name":"POST addTokenAuditor", "parameters":[ { "name":"accountWithErc5982UupsContractAddress", "in":"path", "required":true, "schema":{ "type":"string" }, "description":"Path parameter" } ], "requestBody":{ "required":true, "content":{ "application/json":{ "schema":{ "type":"object", "properties":{ "walletId":{ "type":"string", "example":"", "description":"Postman variable {{walletId}}" }, "auditorDetails":{ "type":"string", "example":"{\"userId\":\"userId value\",\"orgId\":\"orgId value\",\"accountAddress\":\"accountAddress\nvalue\"}" } }, "required":[ "walletId", "auditorDetails" ], "additionalProperties":false }, "example":{ "walletId":"{{walletId}}", "auditorDetails":"{\"userId\":\"userId value\",\"orgId\":\"orgId value\",\"accountAddress\":\"accountAddress\nvalue\"}" } } } }, "x-contract-endpoint-name":"addTokenAuditor", "x-contract-method":{ "name":"addTokenAuditor", "signature":"addTokenAuditor((string,string,address))" }, "x-contract-args":[ "auditorDetails" ], "x-contract-arg-definitions":{ "auditorDetails":{ "kind":"tuple", "fields":[ { "name":"userId" }, { "name":"orgId" }, { "name":"accountAddress" } ] } }, "x-generate-postman-api":true, "x-internal-id":"{accountWithErc5982UupsContractAddress}-addTokenAuditor-post", "x-filename-id":"accountwitherc5982uupscontractaddress-addtokenauditor-post" } }, "/{accountWithErc5982UupsContractAddress}/createAccount":{ "post":{ "summary":"Create Account", "description":"Creates a CBDC account.", "operationId":"createAccount", "tags":[ "Account Contract Endpoints" ], "responses":{ "200":{ "description":"Successful rpc-proxy transaction response.", "content":{ "application/json":{ "schema":{ "$ref":"#/components/schemas/RpcProxy_TransactionSuccessResponse" } } } }, "400":{ "description":"Wrapper validation failure or rpc-proxy bad-request response." }, "404":{ "description":"Unregistered endpoint or rpc-proxy not-found response." }, "502":{ "description":"Wrapper-to-rpc-proxy failure or rpc-proxy gateway response." }, "default":{ "description":"rpc-proxy status, content type, and response body are passed through unchanged." } }, "x-postman-request-name":"POST createAccount", "parameters":[ { "name":"accountWithErc5982UupsContractAddress", "in":"path", "required":true, "schema":{ "type":"string" }, "description":"Path parameter" } ], "requestBody":{ "required":true, "content":{ "application/json":{ "schema":{ "type":"object", "properties":{ "walletId":{ "type":"string", "example":"", "description":"Postman variable {{walletId}}" }, "userId":{ "type":"string", "example":"userId value" }, "orgId":{ "type":"string", "example":"orgId value" }, "userAddress":{ "type":"string", "example":"0x0000000000000000000000000000000000000000" }, "maxDailyAmount":{ "type":"integer", "example":0 }, "maxDailyTransactions":{ "type":"integer", "example":0 }, "applicationGroups":{ "type":"array", "items":{ "type":"string", "example":"applicationGroups value" } } }, "required":[ "walletId", "userId", "orgId", "userAddress", "maxDailyAmount", "maxDailyTransactions", "applicationGroups" ], "additionalProperties":false }, "example":{ "walletId":"{{walletId}}", "userId":"userId value", "orgId":"orgId value", "userAddress":"0x0000000000000000000000000000000000000000", "maxDailyAmount":0, "maxDailyTransactions":0, "applicationGroups":[ "applicationGroups value" ] } } } }, "x-contract-endpoint-name":"createAccount", "x-contract-method":{ "name":"createAccount", "signature":"createAccount(string,string,address,int256,int256,string[])" }, "x-contract-args":[ "userId", "orgId", "userAddress", "maxDailyAmount", "maxDailyTransactions", "applicationGroups" ], "x-generate-postman-api":true, "x-internal-id":"{accountWithErc5982UupsContractAddress}-createAccount-post", "x-filename-id":"accountwitherc5982uupscontractaddress-createaccount-post" } }, "/{accountWithErc5982UupsContractAddress}/deleteAccount":{ "post":{ "summary":"Delete Account", "description":"Deletes the specified CBDC account.", "operationId":"deleteAccount", "tags":[ "Account Contract Endpoints" ], "responses":{ "200":{ "description":"Successful rpc-proxy transaction response.", "content":{ "application/json":{ "schema":{ "$ref":"#/components/schemas/RpcProxy_TransactionSuccessResponse" } } } }, "400":{ "description":"Wrapper validation failure or rpc-proxy bad-request response." }, "404":{ "description":"Unregistered endpoint or rpc-proxy not-found response." }, "502":{ "description":"Wrapper-to-rpc-proxy failure or rpc-proxy gateway response." }, "default":{ "description":"rpc-proxy status, content type, and response body are passed through unchanged." } }, "x-postman-request-name":"POST deleteAccount", "parameters":[ { "name":"accountWithErc5982UupsContractAddress", "in":"path", "required":true, "schema":{ "type":"string" }, "description":"Path parameter" } ], "requestBody":{ "required":true, "content":{ "application/json":{ "schema":{ "type":"object", "properties":{ "walletId":{ "type":"string", "example":"", "description":"Postman variable {{walletId}}" }, "userAddress":{ "type":"string", "example":"0x0000000000000000000000000000000000000000" } }, "required":[ "walletId", "userAddress" ], "additionalProperties":false }, "example":{ "walletId":"{{walletId}}", "userAddress":"0x0000000000000000000000000000000000000000" } } } }, "x-contract-endpoint-name":"deleteAccount", "x-contract-method":{ "name":"deleteAccount", "signature":"deleteAccount(address)" }, "x-contract-args":[ "userAddress" ], "x-generate-postman-api":true, "x-internal-id":"{accountWithErc5982UupsContractAddress}-deleteAccount-post", "x-filename-id":"accountwitherc5982uupscontractaddress-deleteaccount-post" } }, "/{accountWithErc5982UupsContractAddress}/getAccountByAddress":{ "get":{ "summary":"Get Account by Address", "description":"Retrieves a CBDC account by its address.", "operationId":"getAccountByAddress", "tags":[ "Account Contract Endpoints" ], "responses":{ "200":{ "description":"Successful rpc-proxy query response.", "content":{ "application/json":{ "schema":{ "$ref":"#/components/schemas/RpcProxy_QuerySuccessResponse" } } } }, "400":{ "description":"Wrapper validation failure or rpc-proxy bad-request response." }, "404":{ "description":"Unregistered endpoint or rpc-proxy not-found response." }, "502":{ "description":"Wrapper-to-rpc-proxy failure or rpc-proxy gateway response." }, "default":{ "description":"rpc-proxy status, content type, and response body are passed through unchanged." } }, "x-postman-request-name":"GET getAccountByAddress", "parameters":[ { "name":"userAddress", "in":"query", "required":false, "schema":{ "type":"string" } }, { "name":"fromAddress", "in":"query", "required":false, "schema":{ "type":"string" } }, { "name":"blockTag", "in":"query", "required":false, "schema":{ "type":"string", "default":"latest" } }, { "name":"accountWithErc5982UupsContractAddress", "in":"path", "required":true, "schema":{ "type":"string" }, "description":"Path parameter" } ], "x-contract-endpoint-name":"getAccountByAddress", "x-contract-method":{ "name":"getAccountByAddress", "signature":"getAccountByAddress(address)" }, "x-contract-args":[ "userAddress" ], "x-generate-postman-api":true, "x-internal-id":"{accountWithErc5982UupsContractAddress}-getAccountByAddress-get", "x-filename-id":"accountwitherc5982uupscontractaddress-getaccountbyaddress-get" } }, "/{accountWithErc5982UupsContractAddress}/getAccountStatus":{ "get":{ "summary":"Get Account Status", "description":"Retrieves the status of a CBDC account.", "operationId":"getAccountStatus", "tags":[ "Account Contract Endpoints" ], "responses":{ "200":{ "description":"Successful rpc-proxy query response.", "content":{ "application/json":{ "schema":{ "$ref":"#/components/schemas/RpcProxy_QuerySuccessResponse" } } } }, "400":{ "description":"Wrapper validation failure or rpc-proxy bad-request response." }, "404":{ "description":"Unregistered endpoint or rpc-proxy not-found response." }, "502":{ "description":"Wrapper-to-rpc-proxy failure or rpc-proxy gateway response." }, "default":{ "description":"rpc-proxy status, content type, and response body are passed through unchanged." } }, "x-postman-request-name":"GET getAccountStatus", "parameters":[ { "name":"userAddress", "in":"query", "required":false, "schema":{ "type":"string" } }, { "name":"fromAddress", "in":"query", "required":false, "schema":{ "type":"string" } }, { "name":"blockTag", "in":"query", "required":false, "schema":{ "type":"string", "default":"latest" } }, { "name":"accountWithErc5982UupsContractAddress", "in":"path", "required":true, "schema":{ "type":"string" }, "description":"Path parameter" } ], "x-contract-endpoint-name":"getAccountStatus", "x-contract-method":{ "name":"getAccountStatus", "signature":"getAccountStatus(address)" }, "x-contract-args":[ "userAddress" ], "x-generate-postman-api":true, "x-internal-id":"{accountWithErc5982UupsContractAddress}-getAccountStatus-get", "x-filename-id":"accountwitherc5982uupscontractaddress-getaccountstatus-get" } }, "/{accountWithErc5982UupsContractAddress}/getAllAccounts":{ "get":{ "summary":"Get Accounts", "description":"Retrieves CBDC accounts using the specified pagination settings.", "operationId":"getAllAccounts", "tags":[ "Account Contract Endpoints" ], "responses":{ "200":{ "description":"Successful rpc-proxy query response.", "content":{ "application/json":{ "schema":{ "$ref":"#/components/schemas/RpcProxy_QuerySuccessResponse" } } } }, "400":{ "description":"Wrapper validation failure or rpc-proxy bad-request response." }, "404":{ "description":"Unregistered endpoint or rpc-proxy not-found response." }, "502":{ "description":"Wrapper-to-rpc-proxy failure or rpc-proxy gateway response." }, "default":{ "description":"rpc-proxy status, content type, and response body are passed through unchanged." } }, "x-postman-request-name":"GET getAllAccounts", "parameters":[ { "name":"offset", "in":"query", "required":false, "schema":{ "type":"integer", "format":"int64" } }, { "name":"limit", "in":"query", "required":false, "schema":{ "type":"integer", "format":"int64" } }, { "name":"fromAddress", "in":"query", "required":false, "schema":{ "type":"string" } }, { "name":"blockTag", "in":"query", "required":false, "schema":{ "type":"string", "default":"latest" } }, { "name":"accountWithErc5982UupsContractAddress", "in":"path", "required":true, "schema":{ "type":"string" }, "description":"Path parameter" } ], "x-contract-endpoint-name":"getAllAccounts", "x-contract-method":{ "name":"getAllAccounts", "signature":"getAllAccounts(uint256,uint256)" }, "x-contract-args":[ "offset", "limit" ], "x-generate-postman-api":true, "x-internal-id":"{accountWithErc5982UupsContractAddress}-getAllAccounts-get", "x-filename-id":"accountwitherc5982uupscontractaddress-getallaccounts-get" } }, "/{accountWithErc5982UupsContractAddress}/getAllOrgAdmins":{ "get":{ "summary":"Get Organization Admins", "description":"Retrieves all organization administrator accounts.", "operationId":"getAllOrgAdmins", "tags":[ "Account Contract Endpoints" ], "responses":{ "200":{ "description":"Successful rpc-proxy query response.", "content":{ "application/json":{ "schema":{ "$ref":"#/components/schemas/RpcProxy_QuerySuccessResponse" } } } }, "400":{ "description":"Wrapper validation failure or rpc-proxy bad-request response." }, "404":{ "description":"Unregistered endpoint or rpc-proxy not-found response." }, "502":{ "description":"Wrapper-to-rpc-proxy failure or rpc-proxy gateway response." }, "default":{ "description":"rpc-proxy status, content type, and response body are passed through unchanged." } }, "x-postman-request-name":"GET getAllOrgAdmins", "parameters":[ { "name":"fromAddress", "in":"query", "required":false, "schema":{ "type":"string" } }, { "name":"blockTag", "in":"query", "required":false, "schema":{ "type":"string", "default":"latest" } }, { "name":"accountWithErc5982UupsContractAddress", "in":"path", "required":true, "schema":{ "type":"string" }, "description":"Path parameter" } ], "x-contract-endpoint-name":"getAllOrgAdmins", "x-contract-method":{ "name":"getAllOrgAdmins", "signature":"getAllOrgAdmins()" }, "x-contract-args":[ ], "x-generate-postman-api":true, "x-internal-id":"{accountWithErc5982UupsContractAddress}-getAllOrgAdmins-get", "x-filename-id":"accountwitherc5982uupscontractaddress-getallorgadmins-get" } }, "/{accountWithErc5982UupsContractAddress}/getAllOrgAuditors":{ "get":{ "summary":"Get Organization Auditors", "description":"Retrieves all organization auditor accounts.", "operationId":"getAllOrgAuditors", "tags":[ "Account Contract Endpoints" ], "responses":{ "200":{ "description":"Successful rpc-proxy query response.", "content":{ "application/json":{ "schema":{ "$ref":"#/components/schemas/RpcProxy_QuerySuccessResponse" } } } }, "400":{ "description":"Wrapper validation failure or rpc-proxy bad-request response." }, "404":{ "description":"Unregistered endpoint or rpc-proxy not-found response." }, "502":{ "description":"Wrapper-to-rpc-proxy failure or rpc-proxy gateway response." }, "default":{ "description":"rpc-proxy status, content type, and response body are passed through unchanged." } }, "x-postman-request-name":"GET getAllOrgAuditors", "parameters":[ { "name":"fromAddress", "in":"query", "required":false, "schema":{ "type":"string" } }, { "name":"blockTag", "in":"query", "required":false, "schema":{ "type":"string", "default":"latest" } }, { "name":"accountWithErc5982UupsContractAddress", "in":"path", "required":true, "schema":{ "type":"string" }, "description":"Path parameter" } ], "x-contract-endpoint-name":"getAllOrgAuditors", "x-contract-method":{ "name":"getAllOrgAuditors", "signature":"getAllOrgAuditors()" }, "x-contract-args":[ ], "x-generate-postman-api":true, "x-internal-id":"{accountWithErc5982UupsContractAddress}-getAllOrgAuditors-get", "x-filename-id":"accountwitherc5982uupscontractaddress-getallorgauditors-get" } }, "/{accountWithErc5982UupsContractAddress}/getAllTokenAdmins":{ "get":{ "summary":"Get Token Admins", "description":"Retrieves all token administrator accounts.", "operationId":"getAllTokenAdmins", "tags":[ "Account Contract Endpoints" ], "responses":{ "200":{ "description":"Successful rpc-proxy query response.", "content":{ "application/json":{ "schema":{ "$ref":"#/components/schemas/RpcProxy_QuerySuccessResponse" } } } }, "400":{ "description":"Wrapper validation failure or rpc-proxy bad-request response." }, "404":{ "description":"Unregistered endpoint or rpc-proxy not-found response." }, "502":{ "description":"Wrapper-to-rpc-proxy failure or rpc-proxy gateway response." }, "default":{ "description":"rpc-proxy status, content type, and response body are passed through unchanged." } }, "x-postman-request-name":"GET getAllTokenAdmins", "parameters":[ { "name":"fromAddress", "in":"query", "required":false, "schema":{ "type":"string" } }, { "name":"blockTag", "in":"query", "required":false, "schema":{ "type":"string", "default":"latest" } }, { "name":"accountWithErc5982UupsContractAddress", "in":"path", "required":true, "schema":{ "type":"string" }, "description":"Path parameter" } ], "x-contract-endpoint-name":"getAllTokenAdmins", "x-contract-method":{ "name":"getAllTokenAdmins", "signature":"getAllTokenAdmins()" }, "x-contract-args":[ ], "x-generate-postman-api":true, "x-internal-id":"{accountWithErc5982UupsContractAddress}-getAllTokenAdmins-get", "x-filename-id":"accountwitherc5982uupscontractaddress-getalltokenadmins-get" } }, "/{accountWithErc5982UupsContractAddress}/getAllTokenAuditors":{ "get":{ "summary":"Get Token Auditors", "description":"Retrieves all token auditor accounts.", "operationId":"getAllTokenAuditors", "tags":[ "Account Contract Endpoints" ], "responses":{ "200":{ "description":"Successful rpc-proxy query response.", "content":{ "application/json":{ "schema":{ "$ref":"#/components/schemas/RpcProxy_QuerySuccessResponse" } } } }, "400":{ "description":"Wrapper validation failure or rpc-proxy bad-request response." }, "404":{ "description":"Unregistered endpoint or rpc-proxy not-found response." }, "502":{ "description":"Wrapper-to-rpc-proxy failure or rpc-proxy gateway response." }, "default":{ "description":"rpc-proxy status, content type, and response body are passed through unchanged." } }, "x-postman-request-name":"GET getAllTokenAuditors", "parameters":[ { "name":"fromAddress", "in":"query", "required":false, "schema":{ "type":"string" } }, { "name":"blockTag", "in":"query", "required":false, "schema":{ "type":"string", "default":"latest" } }, { "name":"accountWithErc5982UupsContractAddress", "in":"path", "required":true, "schema":{ "type":"string" }, "description":"Path parameter" } ], "x-contract-endpoint-name":"getAllTokenAuditors", "x-contract-method":{ "name":"getAllTokenAuditors", "signature":"getAllTokenAuditors()" }, "x-contract-args":[ ], "x-generate-postman-api":true, "x-internal-id":"{accountWithErc5982UupsContractAddress}-getAllTokenAuditors-get", "x-filename-id":"accountwitherc5982uupscontractaddress-getalltokenauditors-get" } }, "/{accountWithErc5982UupsContractAddress}/getContext":{ "get":{ "summary":"Get Context", "description":"Retrieves the context associated with the account contract.", "operationId":"getContext", "tags":[ "Account Contract Endpoints" ], "responses":{ "200":{ "description":"Successful rpc-proxy query response.", "content":{ "application/json":{ "schema":{ "$ref":"#/components/schemas/RpcProxy_QuerySuccessResponse" } } } }, "400":{ "description":"Wrapper validation failure or rpc-proxy bad-request response." }, "404":{ "description":"Unregistered endpoint or rpc-proxy not-found response." }, "502":{ "description":"Wrapper-to-rpc-proxy failure or rpc-proxy gateway response." }, "default":{ "description":"rpc-proxy status, content type, and response body are passed through unchanged." } }, "x-postman-request-name":"GET getContext", "parameters":[ { "name":"fromAddress", "in":"query", "required":false, "schema":{ "type":"string" } }, { "name":"blockTag", "in":"query", "required":false, "schema":{ "type":"string", "default":"latest" } }, { "name":"accountWithErc5982UupsContractAddress", "in":"path", "required":true, "schema":{ "type":"string" }, "description":"Path parameter" } ], "x-contract-endpoint-name":"getContext", "x-contract-method":{ "name":"getContext", "signature":"getContext()" }, "x-contract-args":[ ], "x-generate-postman-api":true, "x-internal-id":"{accountWithErc5982UupsContractAddress}-getContext-get", "x-filename-id":"accountwitherc5982uupscontractaddress-getcontext-get" } }, "/{accountWithErc5982UupsContractAddress}/getGovernanceContext":{ "get":{ "summary":"Get Account Governance Context", "description":"Retrieves the governance context for the account contract.", "operationId":"getGovernanceContext_account", "tags":[ "Account Contract Endpoints" ], "responses":{ "200":{ "description":"Successful rpc-proxy query response.", "content":{ "application/json":{ "schema":{ "$ref":"#/components/schemas/RpcProxy_QuerySuccessResponse" } } } }, "400":{ "description":"Wrapper validation failure or rpc-proxy bad-request response." }, "404":{ "description":"Unregistered endpoint or rpc-proxy not-found response." }, "502":{ "description":"Wrapper-to-rpc-proxy failure or rpc-proxy gateway response." }, "default":{ "description":"rpc-proxy status, content type, and response body are passed through unchanged." } }, "x-postman-request-name":"GET getGovernanceContext", "parameters":[ { "name":"fromAddress", "in":"query", "required":false, "schema":{ "type":"string" } }, { "name":"blockTag", "in":"query", "required":false, "schema":{ "type":"string", "default":"latest" } }, { "name":"accountWithErc5982UupsContractAddress", "in":"path", "required":true, "schema":{ "type":"string" }, "description":"Path parameter" } ], "x-contract-endpoint-name":"getGovernanceContext", "x-contract-method":{ "name":"getGovernanceContext", "signature":"getGovernanceContext()" }, "x-contract-args":[ ], "x-generate-postman-api":true, "x-internal-id":"{accountWithErc5982UupsContractAddress}-getGovernanceContext-get", "x-filename-id":"accountwitherc5982uupscontractaddress-getgovernancecontext-get" } }, "/{accountWithErc5982UupsContractAddress}/getGroupId":{ "get":{ "summary":"Get Group ID", "description":"Retrieves the group identifier for an account.", "operationId":"getGroupId", "tags":[ "Account Contract Endpoints" ], "responses":{ "200":{ "description":"Successful rpc-proxy query response.", "content":{ "application/json":{ "schema":{ "$ref":"#/components/schemas/RpcProxy_QuerySuccessResponse" } } } }, "400":{ "description":"Wrapper validation failure or rpc-proxy bad-request response." }, "404":{ "description":"Unregistered endpoint or rpc-proxy not-found response." }, "502":{ "description":"Wrapper-to-rpc-proxy failure or rpc-proxy gateway response." }, "default":{ "description":"rpc-proxy status, content type, and response body are passed through unchanged." } }, "x-postman-request-name":"GET getGroupId", "parameters":[ { "name":"account", "in":"query", "required":false, "schema":{ "type":"string" } }, { "name":"fromAddress", "in":"query", "required":false, "schema":{ "type":"string" } }, { "name":"blockTag", "in":"query", "required":false, "schema":{ "type":"string", "default":"latest" } }, { "name":"accountWithErc5982UupsContractAddress", "in":"path", "required":true, "schema":{ "type":"string" }, "description":"Path parameter" } ], "x-contract-endpoint-name":"getGroupId", "x-contract-method":{ "name":"getGroupId", "signature":"getGroupId(address)" }, "x-contract-args":[ "account" ], "x-generate-postman-api":true, "x-internal-id":"{accountWithErc5982UupsContractAddress}-getGroupId-get", "x-filename-id":"accountwitherc5982uupscontractaddress-getgroupid-get" } }, "/{accountWithErc5982UupsContractAddress}/getIdentity":{ "get":{ "summary":"Get Identity", "description":"Retrieves the identity associated with an account.", "operationId":"getIdentity", "tags":[ "Account Contract Endpoints" ], "responses":{ "200":{ "description":"Successful rpc-proxy query response.", "content":{ "application/json":{ "schema":{ "$ref":"#/components/schemas/RpcProxy_QuerySuccessResponse" } } } }, "400":{ "description":"Wrapper validation failure or rpc-proxy bad-request response." }, "404":{ "description":"Unregistered endpoint or rpc-proxy not-found response." }, "502":{ "description":"Wrapper-to-rpc-proxy failure or rpc-proxy gateway response." }, "default":{ "description":"rpc-proxy status, content type, and response body are passed through unchanged." } }, "x-postman-request-name":"GET getIdentity", "parameters":[ { "name":"account", "in":"query", "required":false, "schema":{ "type":"string" } }, { "name":"fromAddress", "in":"query", "required":false, "schema":{ "type":"string" } }, { "name":"blockTag", "in":"query", "required":false, "schema":{ "type":"string", "default":"latest" } }, { "name":"accountWithErc5982UupsContractAddress", "in":"path", "required":true, "schema":{ "type":"string" }, "description":"Path parameter" } ], "x-contract-endpoint-name":"getIdentity", "x-contract-method":{ "name":"getIdentity", "signature":"getIdentity(address)" }, "x-contract-args":[ "account" ], "x-generate-postman-api":true, "x-internal-id":"{accountWithErc5982UupsContractAddress}-getIdentity-get", "x-filename-id":"accountwitherc5982uupscontractaddress-getidentity-get" } }, "/{accountWithErc5982UupsContractAddress}/isActive":{ "get":{ "summary":"Check Account Active", "description":"Determines whether an account is active.", "operationId":"isActive", "tags":[ "Account Contract Endpoints" ], "responses":{ "200":{ "description":"Successful rpc-proxy query response.", "content":{ "application/json":{ "schema":{ "$ref":"#/components/schemas/RpcProxy_QuerySuccessResponse" } } } }, "400":{ "description":"Wrapper validation failure or rpc-proxy bad-request response." }, "404":{ "description":"Unregistered endpoint or rpc-proxy not-found response." }, "502":{ "description":"Wrapper-to-rpc-proxy failure or rpc-proxy gateway response." }, "default":{ "description":"rpc-proxy status, content type, and response body are passed through unchanged." } }, "x-postman-request-name":"GET isActive", "parameters":[ { "name":"account", "in":"query", "required":false, "schema":{ "type":"string" } }, { "name":"fromAddress", "in":"query", "required":false, "schema":{ "type":"string" } }, { "name":"blockTag", "in":"query", "required":false, "schema":{ "type":"string", "default":"latest" } }, { "name":"accountWithErc5982UupsContractAddress", "in":"path", "required":true, "schema":{ "type":"string" }, "description":"Path parameter" } ], "x-contract-endpoint-name":"isActive", "x-contract-method":{ "name":"isActive", "signature":"isActive(address)" }, "x-contract-args":[ "account" ], "x-generate-postman-api":true, "x-internal-id":"{accountWithErc5982UupsContractAddress}-isActive-get", "x-filename-id":"accountwitherc5982uupscontractaddress-isactive-get" } }, "/{accountWithErc5982UupsContractAddress}/isDeploymentActive":{ "get":{ "summary":"Check Account Deployment", "description":"Determines whether the account contract deployment is active.", "operationId":"isDeploymentActive_account", "tags":[ "Account Contract Endpoints" ], "responses":{ "200":{ "description":"Successful rpc-proxy query response.", "content":{ "application/json":{ "schema":{ "$ref":"#/components/schemas/RpcProxy_QuerySuccessResponse" } } } }, "400":{ "description":"Wrapper validation failure or rpc-proxy bad-request response." }, "404":{ "description":"Unregistered endpoint or rpc-proxy not-found response." }, "502":{ "description":"Wrapper-to-rpc-proxy failure or rpc-proxy gateway response." }, "default":{ "description":"rpc-proxy status, content type, and response body are passed through unchanged." } }, "x-postman-request-name":"GET isDeploymentActive", "parameters":[ { "name":"fromAddress", "in":"query", "required":false, "schema":{ "type":"string" } }, { "name":"blockTag", "in":"query", "required":false, "schema":{ "type":"string", "default":"latest" } }, { "name":"accountWithErc5982UupsContractAddress", "in":"path", "required":true, "schema":{ "type":"string" }, "description":"Path parameter" } ], "x-contract-endpoint-name":"isDeploymentActive", "x-contract-method":{ "name":"isDeploymentActive", "signature":"isDeploymentActive()" }, "x-contract-args":[ ], "x-generate-postman-api":true, "x-internal-id":"{accountWithErc5982UupsContractAddress}-isDeploymentActive-get", "x-filename-id":"accountwitherc5982uupscontractaddress-isdeploymentactive-get" } }, "/{accountWithErc5982UupsContractAddress}/isInRole":{ "get":{ "summary":"Check Account Role", "description":"Determines whether an account has the specified role.", "operationId":"isInRole", "tags":[ "Account Contract Endpoints" ], "responses":{ "200":{ "description":"Successful rpc-proxy query response.", "content":{ "application/json":{ "schema":{ "$ref":"#/components/schemas/RpcProxy_QuerySuccessResponse" } } } }, "400":{ "description":"Wrapper validation failure or rpc-proxy bad-request response." }, "404":{ "description":"Unregistered endpoint or rpc-proxy not-found response." }, "502":{ "description":"Wrapper-to-rpc-proxy failure or rpc-proxy gateway response." }, "default":{ "description":"rpc-proxy status, content type, and response body are passed through unchanged." } }, "x-postman-request-name":"GET isInRole", "parameters":[ { "name":"role", "in":"query", "required":false, "schema":{ "type":"string" } }, { "name":"account", "in":"query", "required":false, "schema":{ "type":"string" } }, { "name":"fromAddress", "in":"query", "required":false, "schema":{ "type":"string" } }, { "name":"blockTag", "in":"query", "required":false, "schema":{ "type":"string", "default":"latest" } }, { "name":"accountWithErc5982UupsContractAddress", "in":"path", "required":true, "schema":{ "type":"string" }, "description":"Path parameter" } ], "x-contract-endpoint-name":"isInRole", "x-contract-method":{ "name":"isInRole", "signature":"isInRole(string,address)" }, "x-contract-args":[ "role", "account" ], "x-generate-postman-api":true, "x-internal-id":"{accountWithErc5982UupsContractAddress}-isInRole-get", "x-filename-id":"accountwitherc5982uupscontractaddress-isinrole-get" } }, "/{accountWithErc5982UupsContractAddress}/isOrgAdmin":{ "get":{ "summary":"Check Organization Admin", "description":"Determines whether an account has the organization administrator role.", "operationId":"isOrgAdmin", "tags":[ "Account Contract Endpoints" ], "responses":{ "200":{ "description":"Successful rpc-proxy query response.", "content":{ "application/json":{ "schema":{ "$ref":"#/components/schemas/RpcProxy_QuerySuccessResponse" } } } }, "400":{ "description":"Wrapper validation failure or rpc-proxy bad-request response." }, "404":{ "description":"Unregistered endpoint or rpc-proxy not-found response." }, "502":{ "description":"Wrapper-to-rpc-proxy failure or rpc-proxy gateway response." }, "default":{ "description":"rpc-proxy status, content type, and response body are passed through unchanged." } }, "x-postman-request-name":"GET isOrgAdmin", "parameters":[ { "name":"adminAddress", "in":"query", "required":false, "schema":{ "type":"string" } }, { "name":"fromAddress", "in":"query", "required":false, "schema":{ "type":"string" } }, { "name":"blockTag", "in":"query", "required":false, "schema":{ "type":"string", "default":"latest" } }, { "name":"accountWithErc5982UupsContractAddress", "in":"path", "required":true, "schema":{ "type":"string" }, "description":"Path parameter" } ], "x-contract-endpoint-name":"isOrgAdmin", "x-contract-method":{ "name":"isOrgAdmin", "signature":"isOrgAdmin(address)" }, "x-contract-args":[ "adminAddress" ], "x-generate-postman-api":true, "x-internal-id":"{accountWithErc5982UupsContractAddress}-isOrgAdmin-get", "x-filename-id":"accountwitherc5982uupscontractaddress-isorgadmin-get" } }, "/{accountWithErc5982UupsContractAddress}/isOrgAuditor":{ "get":{ "summary":"Check Organization Auditor", "description":"Determines whether an account has the organization auditor role.", "operationId":"isOrgAuditor", "tags":[ "Account Contract Endpoints" ], "responses":{ "200":{ "description":"Successful rpc-proxy query response.", "content":{ "application/json":{ "schema":{ "$ref":"#/components/schemas/RpcProxy_QuerySuccessResponse" } } } }, "400":{ "description":"Wrapper validation failure or rpc-proxy bad-request response." }, "404":{ "description":"Unregistered endpoint or rpc-proxy not-found response." }, "502":{ "description":"Wrapper-to-rpc-proxy failure or rpc-proxy gateway response." }, "default":{ "description":"rpc-proxy status, content type, and response body are passed through unchanged." } }, "x-postman-request-name":"GET isOrgAuditor", "parameters":[ { "name":"auditorAddress", "in":"query", "required":false, "schema":{ "type":"string" } }, { "name":"fromAddress", "in":"query", "required":false, "schema":{ "type":"string" } }, { "name":"blockTag", "in":"query", "required":false, "schema":{ "type":"string", "default":"latest" } }, { "name":"accountWithErc5982UupsContractAddress", "in":"path", "required":true, "schema":{ "type":"string" }, "description":"Path parameter" } ], "x-contract-endpoint-name":"isOrgAuditor", "x-contract-method":{ "name":"isOrgAuditor", "signature":"isOrgAuditor(address)" }, "x-contract-args":[ "auditorAddress" ], "x-generate-postman-api":true, "x-internal-id":"{accountWithErc5982UupsContractAddress}-isOrgAuditor-get", "x-filename-id":"accountwitherc5982uupscontractaddress-isorgauditor-get" } }, "/{accountWithErc5982UupsContractAddress}/isTokenAdmin":{ "get":{ "summary":"Check Token Admin", "description":"Determines whether an account has the token administrator role.", "operationId":"isTokenAdmin", "tags":[ "Account Contract Endpoints" ], "responses":{ "200":{ "description":"Successful rpc-proxy query response.", "content":{ "application/json":{ "schema":{ "$ref":"#/components/schemas/RpcProxy_QuerySuccessResponse" } } } }, "400":{ "description":"Wrapper validation failure or rpc-proxy bad-request response." }, "404":{ "description":"Unregistered endpoint or rpc-proxy not-found response." }, "502":{ "description":"Wrapper-to-rpc-proxy failure or rpc-proxy gateway response." }, "default":{ "description":"rpc-proxy status, content type, and response body are passed through unchanged." } }, "x-postman-request-name":"GET isTokenAdmin", "parameters":[ { "name":"adminAddress", "in":"query", "required":false, "schema":{ "type":"string" } }, { "name":"fromAddress", "in":"query", "required":false, "schema":{ "type":"string" } }, { "name":"blockTag", "in":"query", "required":false, "schema":{ "type":"string", "default":"latest" } }, { "name":"accountWithErc5982UupsContractAddress", "in":"path", "required":true, "schema":{ "type":"string" }, "description":"Path parameter" } ], "x-contract-endpoint-name":"isTokenAdmin", "x-contract-method":{ "name":"isTokenAdmin", "signature":"isTokenAdmin(address)" }, "x-contract-args":[ "adminAddress" ], "x-generate-postman-api":true, "x-internal-id":"{accountWithErc5982UupsContractAddress}-isTokenAdmin-get", "x-filename-id":"accountwitherc5982uupscontractaddress-istokenadmin-get" } }, "/{accountWithErc5982UupsContractAddress}/isTokenAuditor":{ "get":{ "summary":"Check Token Auditor", "description":"Determines whether an account has the token auditor role.", "operationId":"isTokenAuditor", "tags":[ "Account Contract Endpoints" ], "responses":{ "200":{ "description":"Successful rpc-proxy query response.", "content":{ "application/json":{ "schema":{ "$ref":"#/components/schemas/RpcProxy_QuerySuccessResponse" } } } }, "400":{ "description":"Wrapper validation failure or rpc-proxy bad-request response." }, "404":{ "description":"Unregistered endpoint or rpc-proxy not-found response." }, "502":{ "description":"Wrapper-to-rpc-proxy failure or rpc-proxy gateway response." }, "default":{ "description":"rpc-proxy status, content type, and response body are passed through unchanged." } }, "x-postman-request-name":"GET isTokenAuditor", "parameters":[ { "name":"auditorAddress", "in":"query", "required":false, "schema":{ "type":"string" } }, { "name":"fromAddress", "in":"query", "required":false, "schema":{ "type":"string" } }, { "name":"blockTag", "in":"query", "required":false, "schema":{ "type":"string", "default":"latest" } }, { "name":"accountWithErc5982UupsContractAddress", "in":"path", "required":true, "schema":{ "type":"string" }, "description":"Path parameter" } ], "x-contract-endpoint-name":"isTokenAuditor", "x-contract-method":{ "name":"isTokenAuditor", "signature":"isTokenAuditor(address)" }, "x-contract-args":[ "auditorAddress" ], "x-generate-postman-api":true, "x-internal-id":"{accountWithErc5982UupsContractAddress}-isTokenAuditor-get", "x-filename-id":"accountwitherc5982uupscontractaddress-istokenauditor-get" } }, "/{accountWithErc5982UupsContractAddress}/removeOrgAdmin":{ "post":{ "summary":"Remove Organization Admin", "description":"Removes the organization administrator role from an account.", "operationId":"removeOrgAdmin", "tags":[ "Account Contract Endpoints" ], "responses":{ "200":{ "description":"Successful rpc-proxy transaction response.", "content":{ "application/json":{ "schema":{ "$ref":"#/components/schemas/RpcProxy_TransactionSuccessResponse" } } } }, "400":{ "description":"Wrapper validation failure or rpc-proxy bad-request response." }, "404":{ "description":"Unregistered endpoint or rpc-proxy not-found response." }, "502":{ "description":"Wrapper-to-rpc-proxy failure or rpc-proxy gateway response." }, "default":{ "description":"rpc-proxy status, content type, and response body are passed through unchanged." } }, "x-postman-request-name":"POST removeOrgAdmin", "parameters":[ { "name":"accountWithErc5982UupsContractAddress", "in":"path", "required":true, "schema":{ "type":"string" }, "description":"Path parameter" } ], "requestBody":{ "required":true, "content":{ "application/json":{ "schema":{ "type":"object", "properties":{ "walletId":{ "type":"string", "example":"", "description":"Postman variable {{walletId}}" }, "adminAddress":{ "type":"string", "example":"0x0000000000000000000000000000000000000000" } }, "required":[ "walletId", "adminAddress" ], "additionalProperties":false }, "example":{ "walletId":"{{walletId}}", "adminAddress":"0x0000000000000000000000000000000000000000" } } } }, "x-contract-endpoint-name":"removeOrgAdmin", "x-contract-method":{ "name":"removeOrgAdmin", "signature":"removeOrgAdmin(address)" }, "x-contract-args":[ "adminAddress" ], "x-generate-postman-api":true, "x-internal-id":"{accountWithErc5982UupsContractAddress}-removeOrgAdmin-post", "x-filename-id":"accountwitherc5982uupscontractaddress-removeorgadmin-post" } }, "/{accountWithErc5982UupsContractAddress}/removeOrgAuditor":{ "post":{ "summary":"Remove Organization Auditor", "description":"Removes the organization auditor role from an account.", "operationId":"removeOrgAuditor", "tags":[ "Account Contract Endpoints" ], "responses":{ "200":{ "description":"Successful rpc-proxy transaction response.", "content":{ "application/json":{ "schema":{ "$ref":"#/components/schemas/RpcProxy_TransactionSuccessResponse" } } } }, "400":{ "description":"Wrapper validation failure or rpc-proxy bad-request response." }, "404":{ "description":"Unregistered endpoint or rpc-proxy not-found response." }, "502":{ "description":"Wrapper-to-rpc-proxy failure or rpc-proxy gateway response." }, "default":{ "description":"rpc-proxy status, content type, and response body are passed through unchanged." } }, "x-postman-request-name":"POST removeOrgAuditor", "parameters":[ { "name":"accountWithErc5982UupsContractAddress", "in":"path", "required":true, "schema":{ "type":"string" }, "description":"Path parameter" } ], "requestBody":{ "required":true, "content":{ "application/json":{ "schema":{ "type":"object", "properties":{ "walletId":{ "type":"string", "example":"", "description":"Postman variable {{walletId}}" }, "auditorAddress":{ "type":"string", "example":"0x0000000000000000000000000000000000000000" } }, "required":[ "walletId", "auditorAddress" ], "additionalProperties":false }, "example":{ "walletId":"{{walletId}}", "auditorAddress":"0x0000000000000000000000000000000000000000" } } } }, "x-contract-endpoint-name":"removeOrgAuditor", "x-contract-method":{ "name":"removeOrgAuditor", "signature":"removeOrgAuditor(address)" }, "x-contract-args":[ "auditorAddress" ], "x-generate-postman-api":true, "x-internal-id":"{accountWithErc5982UupsContractAddress}-removeOrgAuditor-post", "x-filename-id":"accountwitherc5982uupscontractaddress-removeorgauditor-post" } }, "/{accountWithErc5982UupsContractAddress}/removeRole":{ "post":{ "summary":"Remove Role", "description":"Removes the specified role from an account.", "operationId":"removeRole", "tags":[ "Account Contract Endpoints" ], "responses":{ "200":{ "description":"Successful rpc-proxy transaction response.", "content":{ "application/json":{ "schema":{ "$ref":"#/components/schemas/RpcProxy_TransactionSuccessResponse" } } } }, "400":{ "description":"Wrapper validation failure or rpc-proxy bad-request response." }, "404":{ "description":"Unregistered endpoint or rpc-proxy not-found response." }, "502":{ "description":"Wrapper-to-rpc-proxy failure or rpc-proxy gateway response." }, "default":{ "description":"rpc-proxy status, content type, and response body are passed through unchanged." } }, "x-postman-request-name":"POST removeRole", "parameters":[ { "name":"accountWithErc5982UupsContractAddress", "in":"path", "required":true, "schema":{ "type":"string" }, "description":"Path parameter" } ], "requestBody":{ "required":true, "content":{ "application/json":{ "schema":{ "type":"object", "properties":{ "walletId":{ "type":"string", "example":"", "description":"Postman variable {{walletId}}" }, "account":{ "type":"string", "example":"0x0000000000000000000000000000000000000000" }, "role":{ "type":"string", "example":"role value" } }, "required":[ "walletId", "account", "role" ], "additionalProperties":false }, "example":{ "walletId":"{{walletId}}", "account":"0x0000000000000000000000000000000000000000", "role":"role value" } } } }, "x-contract-endpoint-name":"removeRole", "x-contract-method":{ "name":"removeRole", "signature":"removeRole(address,string)" }, "x-contract-args":[ "account", "role" ], "x-generate-postman-api":true, "x-internal-id":"{accountWithErc5982UupsContractAddress}-removeRole-post", "x-filename-id":"accountwitherc5982uupscontractaddress-removerole-post" } }, "/{accountWithErc5982UupsContractAddress}/removeTokenAdmin":{ "post":{ "summary":"Remove Token Admin", "description":"Removes the token administrator role from an account.", "operationId":"removeTokenAdmin", "tags":[ "Account Contract Endpoints" ], "responses":{ "200":{ "description":"Successful rpc-proxy transaction response.", "content":{ "application/json":{ "schema":{ "$ref":"#/components/schemas/RpcProxy_TransactionSuccessResponse" } } } }, "400":{ "description":"Wrapper validation failure or rpc-proxy bad-request response." }, "404":{ "description":"Unregistered endpoint or rpc-proxy not-found response." }, "502":{ "description":"Wrapper-to-rpc-proxy failure or rpc-proxy gateway response." }, "default":{ "description":"rpc-proxy status, content type, and response body are passed through unchanged." } }, "x-postman-request-name":"POST removeTokenAdmin", "parameters":[ { "name":"accountWithErc5982UupsContractAddress", "in":"path", "required":true, "schema":{ "type":"string" }, "description":"Path parameter" } ], "requestBody":{ "required":true, "content":{ "application/json":{ "schema":{ "type":"object", "properties":{ "walletId":{ "type":"string", "example":"", "description":"Postman variable {{walletId}}" }, "adminAddress":{ "type":"string", "example":"0x0000000000000000000000000000000000000000" } }, "required":[ "walletId", "adminAddress" ], "additionalProperties":false }, "example":{ "walletId":"{{walletId}}", "adminAddress":"0x0000000000000000000000000000000000000000" } } } }, "x-contract-endpoint-name":"removeTokenAdmin", "x-contract-method":{ "name":"removeTokenAdmin", "signature":"removeTokenAdmin(address)" }, "x-contract-args":[ "adminAddress" ], "x-generate-postman-api":true, "x-internal-id":"{accountWithErc5982UupsContractAddress}-removeTokenAdmin-post", "x-filename-id":"accountwitherc5982uupscontractaddress-removetokenadmin-post" } }, "/{accountWithErc5982UupsContractAddress}/removeTokenAuditor":{ "post":{ "summary":"Remove Token Auditor", "description":"Removes the token auditor role from an account.", "operationId":"removeTokenAuditor", "tags":[ "Account Contract Endpoints" ], "responses":{ "200":{ "description":"Successful rpc-proxy transaction response.", "content":{ "application/json":{ "schema":{ "$ref":"#/components/schemas/RpcProxy_TransactionSuccessResponse" } } } }, "400":{ "description":"Wrapper validation failure or rpc-proxy bad-request response." }, "404":{ "description":"Unregistered endpoint or rpc-proxy not-found response." }, "502":{ "description":"Wrapper-to-rpc-proxy failure or rpc-proxy gateway response." }, "default":{ "description":"rpc-proxy status, content type, and response body are passed through unchanged." } }, "x-postman-request-name":"POST removeTokenAuditor", "parameters":[ { "name":"accountWithErc5982UupsContractAddress", "in":"path", "required":true, "schema":{ "type":"string" }, "description":"Path parameter" } ], "requestBody":{ "required":true, "content":{ "application/json":{ "schema":{ "type":"object", "properties":{ "walletId":{ "type":"string", "example":"", "description":"Postman variable {{walletId}}" }, "auditorAddress":{ "type":"string", "example":"0x0000000000000000000000000000000000000000" } }, "required":[ "walletId", "auditorAddress" ], "additionalProperties":false }, "example":{ "walletId":"{{walletId}}", "auditorAddress":"0x0000000000000000000000000000000000000000" } } } }, "x-contract-endpoint-name":"removeTokenAuditor", "x-contract-method":{ "name":"removeTokenAuditor", "signature":"removeTokenAuditor(address)" }, "x-contract-args":[ "auditorAddress" ], "x-generate-postman-api":true, "x-internal-id":"{accountWithErc5982UupsContractAddress}-removeTokenAuditor-post", "x-filename-id":"accountwitherc5982uupscontractaddress-removetokenauditor-post" } }, "/{accountWithErc5982UupsContractAddress}/renounceNamedRole":{ "post":{ "summary":"Renounce Named Role", "description":"Renounces the specified role for the caller account.", "operationId":"renounceNamedRole", "tags":[ "Account Contract Endpoints" ], "responses":{ "200":{ "description":"Successful rpc-proxy transaction response.", "content":{ "application/json":{ "schema":{ "$ref":"#/components/schemas/RpcProxy_TransactionSuccessResponse" } } } }, "400":{ "description":"Wrapper validation failure or rpc-proxy bad-request response." }, "404":{ "description":"Unregistered endpoint or rpc-proxy not-found response." }, "502":{ "description":"Wrapper-to-rpc-proxy failure or rpc-proxy gateway response." }, "default":{ "description":"rpc-proxy status, content type, and response body are passed through unchanged." } }, "x-postman-request-name":"POST renounceNamedRole", "parameters":[ { "name":"accountWithErc5982UupsContractAddress", "in":"path", "required":true, "schema":{ "type":"string" }, "description":"Path parameter" } ], "requestBody":{ "required":true, "content":{ "application/json":{ "schema":{ "type":"object", "properties":{ "walletId":{ "type":"string", "example":"", "description":"Postman variable {{walletId}}" }, "account":{ "type":"string", "example":"0x0000000000000000000000000000000000000000" }, "role":{ "type":"string", "example":"role value" } }, "required":[ "walletId", "account", "role" ], "additionalProperties":false }, "example":{ "walletId":"{{walletId}}", "account":"0x0000000000000000000000000000000000000000", "role":"role value" } } } }, "x-contract-endpoint-name":"renounceNamedRole", "x-contract-method":{ "name":"renounceNamedRole", "signature":"renounceNamedRole(address,string)" }, "x-contract-args":[ "account", "role" ], "x-generate-postman-api":true, "x-internal-id":"{accountWithErc5982UupsContractAddress}-renounceNamedRole-post", "x-filename-id":"accountwitherc5982uupscontractaddress-renouncenamedrole-post" } }, "/{accountWithErc5982UupsContractAddress}/setContext":{ "post":{ "summary":"Set Context", "description":"Sets the context associated with the account contract.", "operationId":"setContext", "tags":[ "Account Contract Endpoints" ], "responses":{ "200":{ "description":"Successful rpc-proxy transaction response.", "content":{ "application/json":{ "schema":{ "$ref":"#/components/schemas/RpcProxy_TransactionSuccessResponse" } } } }, "400":{ "description":"Wrapper validation failure or rpc-proxy bad-request response." }, "404":{ "description":"Unregistered endpoint or rpc-proxy not-found response." }, "502":{ "description":"Wrapper-to-rpc-proxy failure or rpc-proxy gateway response." }, "default":{ "description":"rpc-proxy status, content type, and response body are passed through unchanged." } }, "x-postman-request-name":"POST setContext", "parameters":[ { "name":"accountWithErc5982UupsContractAddress", "in":"path", "required":true, "schema":{ "type":"string" }, "description":"Path parameter" } ], "requestBody":{ "required":true, "content":{ "application/json":{ "schema":{ "type":"object", "properties":{ "walletId":{ "type":"string", "example":"", "description":"Postman variable {{walletId}}" }, "tokenAddress":{ "type":"string", "example":"0x0000000000000000000000000000000000000000" } }, "required":[ "walletId", "tokenAddress" ], "additionalProperties":false }, "example":{ "walletId":"{{walletId}}", "tokenAddress":"0x0000000000000000000000000000000000000000" } } } }, "x-contract-endpoint-name":"setContext", "x-contract-method":{ "name":"setContext", "signature":"setContext(address)" }, "x-contract-args":[ "tokenAddress" ], "x-generate-postman-api":true, "x-internal-id":"{accountWithErc5982UupsContractAddress}-setContext-post", "x-filename-id":"accountwitherc5982uupscontractaddress-setcontext-post" } }, "/{accountWithErc5982UupsContractAddress}/setGovernanceContext":{ "post":{ "summary":"Set Account Governance Context", "description":"Sets the governance context for the account contract.", "operationId":"setGovernanceContext_account", "tags":[ "Account Contract Endpoints" ], "responses":{ "200":{ "description":"Successful rpc-proxy transaction response.", "content":{ "application/json":{ "schema":{ "$ref":"#/components/schemas/RpcProxy_TransactionSuccessResponse" } } } }, "400":{ "description":"Wrapper validation failure or rpc-proxy bad-request response." }, "404":{ "description":"Unregistered endpoint or rpc-proxy not-found response." }, "502":{ "description":"Wrapper-to-rpc-proxy failure or rpc-proxy gateway response." }, "default":{ "description":"rpc-proxy status, content type, and response body are passed through unchanged." } }, "x-postman-request-name":"POST setGovernanceContext", "parameters":[ { "name":"accountWithErc5982UupsContractAddress", "in":"path", "required":true, "schema":{ "type":"string" }, "description":"Path parameter" } ], "requestBody":{ "required":true, "content":{ "application/json":{ "schema":{ "type":"object", "properties":{ "walletId":{ "type":"string", "example":"", "description":"Postman variable {{walletId}}" }, "uuid":{ "type":"string", "example":"uuid value" }, "governance":{ "type":"string", "example":"0x0000000000000000000000000000000000000000" } }, "required":[ "walletId", "uuid", "governance" ], "additionalProperties":false }, "example":{ "walletId":"{{walletId}}", "uuid":"uuid value", "governance":"0x0000000000000000000000000000000000000000" } } } }, "x-contract-endpoint-name":"setGovernanceContext", "x-contract-method":{ "name":"setGovernanceContext", "signature":"setGovernanceContext(string,address)" }, "x-contract-args":[ "uuid", "governance" ], "x-generate-postman-api":true, "x-internal-id":"{accountWithErc5982UupsContractAddress}-setGovernanceContext-post", "x-filename-id":"accountwitherc5982uupscontractaddress-setgovernancecontext-post" } }, "/{accountWithErc5982UupsContractAddress}/setMaxDailyAmount":{ "post":{ "summary":"Set Daily Amount Limit", "description":"Sets the maximum daily transaction amount for an account.", "operationId":"setMaxDailyAmount", "tags":[ "Account Contract Endpoints" ], "responses":{ "200":{ "description":"Successful rpc-proxy transaction response.", "content":{ "application/json":{ "schema":{ "$ref":"#/components/schemas/RpcProxy_TransactionSuccessResponse" } } } }, "400":{ "description":"Wrapper validation failure or rpc-proxy bad-request response." }, "404":{ "description":"Unregistered endpoint or rpc-proxy not-found response." }, "502":{ "description":"Wrapper-to-rpc-proxy failure or rpc-proxy gateway response." }, "default":{ "description":"rpc-proxy status, content type, and response body are passed through unchanged." } }, "x-postman-request-name":"POST setMaxDailyAmount", "parameters":[ { "name":"accountWithErc5982UupsContractAddress", "in":"path", "required":true, "schema":{ "type":"string" }, "description":"Path parameter" } ], "requestBody":{ "required":true, "content":{ "application/json":{ "schema":{ "type":"object", "properties":{ "walletId":{ "type":"string", "example":"", "description":"Postman variable {{walletId}}" }, "value":{ "type":"integer", "example":0 }, "account":{ "type":"string", "example":"0x0000000000000000000000000000000000000000" } }, "required":[ "walletId", "value", "account" ], "additionalProperties":false }, "example":{ "walletId":"{{walletId}}", "value":0, "account":"0x0000000000000000000000000000000000000000" } } } }, "x-contract-endpoint-name":"setMaxDailyAmount", "x-contract-method":{ "name":"setMaxDailyAmount", "signature":"setMaxDailyAmount(int256,address)" }, "x-contract-args":[ "value", "account" ], "x-generate-postman-api":true, "x-internal-id":"{accountWithErc5982UupsContractAddress}-setMaxDailyAmount-post", "x-filename-id":"accountwitherc5982uupscontractaddress-setmaxdailyamount-post" } }, "/{accountWithErc5982UupsContractAddress}/setMaxDailyTransactionCount":{ "post":{ "summary":"Set Daily Transaction Limit", "description":"Sets the maximum number of daily transactions for an account.", "operationId":"setMaxDailyTransactionCount", "tags":[ "Account Contract Endpoints" ], "responses":{ "200":{ "description":"Successful rpc-proxy transaction response.", "content":{ "application/json":{ "schema":{ "$ref":"#/components/schemas/RpcProxy_TransactionSuccessResponse" } } } }, "400":{ "description":"Wrapper validation failure or rpc-proxy bad-request response." }, "404":{ "description":"Unregistered endpoint or rpc-proxy not-found response." }, "502":{ "description":"Wrapper-to-rpc-proxy failure or rpc-proxy gateway response." }, "default":{ "description":"rpc-proxy status, content type, and response body are passed through unchanged." } }, "x-postman-request-name":"POST setMaxDailyTransactionCount", "parameters":[ { "name":"accountWithErc5982UupsContractAddress", "in":"path", "required":true, "schema":{ "type":"string" }, "description":"Path parameter" } ], "requestBody":{ "required":true, "content":{ "application/json":{ "schema":{ "type":"object", "properties":{ "walletId":{ "type":"string", "example":"", "description":"Postman variable {{walletId}}" }, "count":{ "type":"integer", "example":0 }, "account":{ "type":"string", "example":"0x0000000000000000000000000000000000000000" } }, "required":[ "walletId", "count", "account" ], "additionalProperties":false }, "example":{ "walletId":"{{walletId}}", "count":0, "account":"0x0000000000000000000000000000000000000000" } } } }, "x-contract-endpoint-name":"setMaxDailyTransactionCount", "x-contract-method":{ "name":"setMaxDailyTransactionCount", "signature":"setMaxDailyTransactionCount(int256,address)" }, "x-contract-args":[ "count", "account" ], "x-generate-postman-api":true, "x-internal-id":"{accountWithErc5982UupsContractAddress}-setMaxDailyTransactionCount-post", "x-filename-id":"accountwitherc5982uupscontractaddress-setmaxdailytransactioncount-post" } }, "/{accountWithErc5982UupsContractAddress}/suspendAccount":{ "post":{ "summary":"Suspend Account", "description":"Suspends the specified CBDC account.", "operationId":"suspendAccount", "tags":[ "Account Contract Endpoints" ], "responses":{ "200":{ "description":"Successful rpc-proxy transaction response.", "content":{ "application/json":{ "schema":{ "$ref":"#/components/schemas/RpcProxy_TransactionSuccessResponse" } } } }, "400":{ "description":"Wrapper validation failure or rpc-proxy bad-request response." }, "404":{ "description":"Unregistered endpoint or rpc-proxy not-found response." }, "502":{ "description":"Wrapper-to-rpc-proxy failure or rpc-proxy gateway response." }, "default":{ "description":"rpc-proxy status, content type, and response body are passed through unchanged." } }, "x-postman-request-name":"POST suspendAccount", "parameters":[ { "name":"accountWithErc5982UupsContractAddress", "in":"path", "required":true, "schema":{ "type":"string" }, "description":"Path parameter" } ], "requestBody":{ "required":true, "content":{ "application/json":{ "schema":{ "type":"object", "properties":{ "walletId":{ "type":"string", "example":"", "description":"Postman variable {{walletId}}" }, "userAddress":{ "type":"string", "example":"0x0000000000000000000000000000000000000000" } }, "required":[ "walletId", "userAddress" ], "additionalProperties":false }, "example":{ "walletId":"{{walletId}}", "userAddress":"0x0000000000000000000000000000000000000000" } } } }, "x-contract-endpoint-name":"suspendAccount", "x-contract-method":{ "name":"suspendAccount", "signature":"suspendAccount(address)" }, "x-contract-args":[ "userAddress" ], "x-generate-postman-api":true, "x-internal-id":"{accountWithErc5982UupsContractAddress}-suspendAccount-post", "x-filename-id":"accountwitherc5982uupscontractaddress-suspendaccount-post" } }, "/{accountWithErc5982UupsContractAddress}/version":{ "get":{ "summary":"Get Account Version", "description":"Retrieves the account contract version.", "operationId":"version_account", "tags":[ "Account Contract Endpoints" ], "responses":{ "200":{ "description":"Successful rpc-proxy query response.", "content":{ "application/json":{ "schema":{ "$ref":"#/components/schemas/RpcProxy_QuerySuccessResponse" } } } }, "400":{ "description":"Wrapper validation failure or rpc-proxy bad-request response." }, "404":{ "description":"Unregistered endpoint or rpc-proxy not-found response." }, "502":{ "description":"Wrapper-to-rpc-proxy failure or rpc-proxy gateway response." }, "default":{ "description":"rpc-proxy status, content type, and response body are passed through unchanged." } }, "x-postman-request-name":"GET version", "parameters":[ { "name":"fromAddress", "in":"query", "required":false, "schema":{ "type":"string" } }, { "name":"blockTag", "in":"query", "required":false, "schema":{ "type":"string", "default":"latest" } }, { "name":"accountWithErc5982UupsContractAddress", "in":"path", "required":true, "schema":{ "type":"string" }, "description":"Path parameter" } ], "x-contract-endpoint-name":"version", "x-contract-method":{ "name":"version", "signature":"version()" }, "x-contract-args":[ ], "x-generate-postman-api":true, "x-internal-id":"{accountWithErc5982UupsContractAddress}-version-get", "x-filename-id":"accountwitherc5982uupscontractaddress-version-get" } }, "/{contractAddress}/{ordsPathPrefix}/getAllActiveCBDCAccounts":{ "get":{ "summary":"Get Active CBDC Accounts", "operationId":"getAllActiveCBDCAccounts", "tags":[ "ORDS Endpoints" ], "security":[ ], "responses":{ "200":{ "description":"The queried record.", "content":{ "application/json":{ "schema":{ "type":"object", "properties":{ "items":{ "type":"array", "items":{ "type":"object", "properties":{ "account_address":{ "$ref":"#/components/schemas/ORDS_VARCHAR2" }, "account_id":{ "$ref":"#/components/schemas/ORDS_VARCHAR2" }, "application_groups":{ "$ref":"#/components/schemas/ORDS_VARCHAR2" }, "balance":{ "$ref":"#/components/schemas/ORDS_VARCHAR2" }, "created_blockno":{ "$ref":"#/components/schemas/ORDS_NUMBER" }, "created_timestamp":{ "$ref":"#/components/schemas/ORDS_TIMESTAMP" }, "created_txnhash":{ "$ref":"#/components/schemas/ORDS_VARCHAR2" }, "created_txnno":{ "$ref":"#/components/schemas/ORDS_NUMBER" }, "daily_amount":{ "$ref":"#/components/schemas/ORDS_VARCHAR2" }, "daily_transactions":{ "$ref":"#/components/schemas/ORDS_VARCHAR2" }, "max_daily_amount":{ "$ref":"#/components/schemas/ORDS_VARCHAR2" }, "max_daily_transactions":{ "$ref":"#/components/schemas/ORDS_VARCHAR2" }, "onhold_balance":{ "$ref":"#/components/schemas/ORDS_VARCHAR2" }, "onhold_burn_balance":{ "$ref":"#/components/schemas/ORDS_CHAR" }, "org_id":{ "$ref":"#/components/schemas/ORDS_VARCHAR2" }, "status":{ "$ref":"#/components/schemas/ORDS_VARCHAR2" }, "token_id":{ "$ref":"#/components/schemas/ORDS_VARCHAR2" }, "token_name":{ "$ref":"#/components/schemas/ORDS_VARCHAR2" }, "user_id":{ "$ref":"#/components/schemas/ORDS_VARCHAR2" } } } } } } } } }, "400":{ "$ref":"#/components/responses/Wrapper_BadRequest" }, "502":{ "$ref":"#/components/responses/Wrapper_BadGateway" }, "default":{ "description":"ORDS upstream status, content type, and response body are passed through unchanged." } }, "x-postman-request-name":"GET getAllActiveCBDCAccounts", "parameters":[ { "name":"X-Service-Token", "in":"header", "required":true, "schema":{ "type":"string" }, "description":"Service token forwarded to ORDS as the Authorization header." }, { "name":"token_id", "in":"query", "required":false, "schema":{ "type":"string" } }, { "name":"contractAddress", "in":"path", "required":true, "schema":{ "type":"string" }, "description":"Path parameter" }, { "name":"ordsPathPrefix", "in":"path", "required":true, "schema":{ "type":"string" }, "description":"Path parameter" } ], "description":"Retrieves all active CBDC accounts for the specified token. Generated from ORDS GET /getAllActiveCBDCAccounts.", "x-contract-endpoint-name":"getAllActiveCBDCAccounts", "x-backend":"ORDS", "x-ords-response-source":"/getAllActiveCBDCAccounts", "x-internal-id":"{contractAddress}-{ordsPathPrefix}-getAllActiveCBDCAccounts-get", "x-filename-id":"contractaddress-ordspathprefix-getallactivecbdcaccounts-get" } }, "/{contractAddress}/{ordsPathPrefix}/getAllCBDCAccountTransactionHistoryWithFilters":{ "get":{ "summary":"Get CBDC Transaction History Using Filters", "operationId":"getAllCBDCAccountTransactionHistoryWithFilters", "tags":[ "ORDS Endpoints" ], "security":[ ], "responses":{ "200":{ "description":"The queried record.", "content":{ "application/json":{ "schema":{ "type":"object", "properties":{ "items":{ "type":"array", "items":{ "type":"object", "properties":{ "account_id":{ "$ref":"#/components/schemas/ORDS_VARCHAR2" }, "balance":{ "$ref":"#/components/schemas/ORDS_VARCHAR2" }, "besu_function":{ "$ref":"#/components/schemas/ORDS_VARCHAR2" }, "blockno":{ "$ref":"#/components/schemas/ORDS_NUMBER" }, "category":{ "$ref":"#/components/schemas/ORDS_VARCHAR2" }, "description":{ "$ref":"#/components/schemas/ORDS_VARCHAR2" }, "from_account":{ "$ref":"#/components/schemas/ORDS_VARCHAR2" }, "from_account_balance":{ "$ref":"#/components/schemas/ORDS_VARCHAR2" }, "from_org_id":{ "$ref":"#/components/schemas/ORDS_VARCHAR2" }, "from_user_id":{ "$ref":"#/components/schemas/ORDS_VARCHAR2" }, "holding_id":{ "$ref":"#/components/schemas/ORDS_VARCHAR2" }, "log_index":{ "$ref":"#/components/schemas/ORDS_NUMBER" }, "onhold_balance":{ "$ref":"#/components/schemas/ORDS_VARCHAR2" }, "timestamp":{ "$ref":"#/components/schemas/ORDS_TIMESTAMP" }, "token_id":{ "$ref":"#/components/schemas/ORDS_VARCHAR2" }, "to_account":{ "$ref":"#/components/schemas/ORDS_VARCHAR2" }, "to_account_balance":{ "$ref":"#/components/schemas/ORDS_VARCHAR2" }, "to_org_id":{ "$ref":"#/components/schemas/ORDS_VARCHAR2" }, "to_user_id":{ "$ref":"#/components/schemas/ORDS_VARCHAR2" }, "transacted_account":{ "$ref":"#/components/schemas/ORDS_VARCHAR2" }, "transacted_amount":{ "$ref":"#/components/schemas/ORDS_VARCHAR2" }, "transaction_id":{ "$ref":"#/components/schemas/ORDS_VARCHAR2" }, "transaction_type":{ "$ref":"#/components/schemas/ORDS_VARCHAR2" }, "txnno":{ "$ref":"#/components/schemas/ORDS_NUMBER" } } } } } } } } }, "400":{ "$ref":"#/components/responses/Wrapper_BadRequest" }, "502":{ "$ref":"#/components/responses/Wrapper_BadGateway" }, "default":{ "description":"ORDS upstream status, content type, and response body are passed through unchanged." } }, "x-postman-request-name":"GET getAllCBDCAccountTransactionHistoryWithFilters", "parameters":[ { "name":"X-Service-Token", "in":"header", "required":true, "schema":{ "type":"string" }, "description":"Service token forwarded to ORDS as the Authorization header." }, { "name":"bookmark", "in":"query", "required":false, "schema":{ "type":"string" } }, { "name":"endTime", "in":"query", "required":false, "schema":{ "type":"string" } }, { "name":"pageSize", "in":"query", "required":false, "schema":{ "type":"integer", "format":"int64" } }, { "name":"startTime", "in":"query", "required":false, "schema":{ "type":"string" } }, { "name":"token_id", "in":"query", "required":false, "schema":{ "type":"string" } }, { "name":"contractAddress", "in":"path", "required":true, "schema":{ "type":"string" }, "description":"Path parameter" }, { "name":"ordsPathPrefix", "in":"path", "required":true, "schema":{ "type":"string" }, "description":"Path parameter" } ], "description":"Retrieves CBDC account transaction history using the specified filters.", "x-contract-endpoint-name":"getAllCBDCAccountTransactionHistoryWithFilters", "x-backend":"ORDS", "x-ords-response-source":"/getAllCBDCAccountTransactionHistoryWithFilters", "x-internal-id":"{contractAddress}-{ordsPathPrefix}-getAllCBDCAccountTransactionHistoryWithFilters-get", "x-filename-id":"contractaddress-ordspathprefix-getallcbdcaccounttransactionhistorywithfilters-get" } }, "/{contractAddress}/{ordsPathPrefix}/getAllCBDCAccounts":{ "get":{ "summary":"Get CBDC Accounts", "operationId":"getAllCBDCAccounts", "tags":[ "ORDS Endpoints" ], "security":[ ], "responses":{ "200":{ "description":"The queried record.", "content":{ "application/json":{ "schema":{ "type":"object", "properties":{ "items":{ "type":"array", "items":{ "type":"object", "properties":{ "account_address":{ "$ref":"#/components/schemas/ORDS_VARCHAR2" }, "account_id":{ "$ref":"#/components/schemas/ORDS_VARCHAR2" }, "application_groups":{ "$ref":"#/components/schemas/ORDS_VARCHAR2" }, "balance":{ "$ref":"#/components/schemas/ORDS_VARCHAR2" }, "created_blockno":{ "$ref":"#/components/schemas/ORDS_NUMBER" }, "created_timestamp":{ "$ref":"#/components/schemas/ORDS_TIMESTAMP" }, "created_txnhash":{ "$ref":"#/components/schemas/ORDS_VARCHAR2" }, "created_txnno":{ "$ref":"#/components/schemas/ORDS_NUMBER" }, "daily_amount":{ "$ref":"#/components/schemas/ORDS_VARCHAR2" }, "daily_transactions":{ "$ref":"#/components/schemas/ORDS_VARCHAR2" }, "max_daily_amount":{ "$ref":"#/components/schemas/ORDS_VARCHAR2" }, "max_daily_transactions":{ "$ref":"#/components/schemas/ORDS_VARCHAR2" }, "onhold_balance":{ "$ref":"#/components/schemas/ORDS_VARCHAR2" }, "onhold_burn_balance":{ "$ref":"#/components/schemas/ORDS_CHAR" }, "org_id":{ "$ref":"#/components/schemas/ORDS_VARCHAR2" }, "status":{ "$ref":"#/components/schemas/ORDS_VARCHAR2" }, "token_id":{ "$ref":"#/components/schemas/ORDS_VARCHAR2" }, "token_name":{ "$ref":"#/components/schemas/ORDS_VARCHAR2" }, "user_id":{ "$ref":"#/components/schemas/ORDS_VARCHAR2" } } } } } } } } }, "400":{ "$ref":"#/components/responses/Wrapper_BadRequest" }, "502":{ "$ref":"#/components/responses/Wrapper_BadGateway" }, "default":{ "description":"ORDS upstream status, content type, and response body are passed through unchanged." } }, "x-postman-request-name":"GET getAllCBDCAccounts", "parameters":[ { "name":"X-Service-Token", "in":"header", "required":true, "schema":{ "type":"string" }, "description":"Service token forwarded to ORDS as the Authorization header." }, { "name":"token_id", "in":"query", "required":false, "schema":{ "type":"string" } }, { "name":"contractAddress", "in":"path", "required":true, "schema":{ "type":"string" }, "description":"Path parameter" }, { "name":"ordsPathPrefix", "in":"path", "required":true, "schema":{ "type":"string" }, "description":"Path parameter" } ], "description":"Retrieves all CBDC accounts for the specified token. Generated from ORDS GET /getAllCBDCAccounts.", "x-contract-endpoint-name":"getAllCBDCAccounts", "x-backend":"ORDS", "x-ords-response-source":"/getAllCBDCAccounts", "x-internal-id":"{contractAddress}-{ordsPathPrefix}-getAllCBDCAccounts-get", "x-filename-id":"contractaddress-ordspathprefix-getallcbdcaccounts-get" } }, "/{contractAddress}/{ordsPathPrefix}/getAllOrgAccounts":{ "get":{ "summary":"Get Organization Accounts", "operationId":"getAllOrgAccounts", "tags":[ "ORDS Endpoints" ], "security":[ ], "responses":{ "200":{ "description":"The queried record.", "content":{ "application/json":{ "schema":{ "type":"object", "properties":{ "items":{ "type":"array", "items":{ "type":"object", "properties":{ "account_address":{ "$ref":"#/components/schemas/ORDS_VARCHAR2" }, "account_id":{ "$ref":"#/components/schemas/ORDS_VARCHAR2" }, "application_groups":{ "$ref":"#/components/schemas/ORDS_VARCHAR2" }, "balance":{ "$ref":"#/components/schemas/ORDS_VARCHAR2" }, "created_blockno":{ "$ref":"#/components/schemas/ORDS_NUMBER" }, "created_timestamp":{ "$ref":"#/components/schemas/ORDS_TIMESTAMP" }, "created_txnhash":{ "$ref":"#/components/schemas/ORDS_VARCHAR2" }, "created_txnno":{ "$ref":"#/components/schemas/ORDS_NUMBER" }, "daily_amount":{ "$ref":"#/components/schemas/ORDS_VARCHAR2" }, "daily_transactions":{ "$ref":"#/components/schemas/ORDS_VARCHAR2" }, "max_daily_amount":{ "$ref":"#/components/schemas/ORDS_VARCHAR2" }, "max_daily_transactions":{ "$ref":"#/components/schemas/ORDS_VARCHAR2" }, "onhold_balance":{ "$ref":"#/components/schemas/ORDS_VARCHAR2" }, "onhold_burn_balance":{ "$ref":"#/components/schemas/ORDS_CHAR" }, "org_id":{ "$ref":"#/components/schemas/ORDS_VARCHAR2" }, "status":{ "$ref":"#/components/schemas/ORDS_VARCHAR2" }, "token_id":{ "$ref":"#/components/schemas/ORDS_VARCHAR2" }, "token_name":{ "$ref":"#/components/schemas/ORDS_VARCHAR2" }, "user_id":{ "$ref":"#/components/schemas/ORDS_VARCHAR2" } } } } } } } } }, "400":{ "$ref":"#/components/responses/Wrapper_BadRequest" }, "502":{ "$ref":"#/components/responses/Wrapper_BadGateway" }, "default":{ "description":"ORDS upstream status, content type, and response body are passed through unchanged." } }, "x-postman-request-name":"GET getAllOrgAccounts", "parameters":[ { "name":"X-Service-Token", "in":"header", "required":true, "schema":{ "type":"string" }, "description":"Service token forwarded to ORDS as the Authorization header." }, { "name":"org_id", "in":"query", "required":false, "schema":{ "type":"string" } }, { "name":"contractAddress", "in":"path", "required":true, "schema":{ "type":"string" }, "description":"Path parameter" }, { "name":"ordsPathPrefix", "in":"path", "required":true, "schema":{ "type":"string" }, "description":"Path parameter" } ], "description":"Retrieves all CBDC accounts associated with the specified organization. Generated from ORDS GET /getAllOrgAccounts.", "x-contract-endpoint-name":"getAllOrgAccounts", "x-backend":"ORDS", "x-ords-response-source":"/getAllOrgAccounts", "x-internal-id":"{contractAddress}-{ordsPathPrefix}-getAllOrgAccounts-get", "x-filename-id":"contractaddress-ordspathprefix-getallorgaccounts-get" } }, "/{contractAddress}/{ordsPathPrefix}/getAllRegisteredOrgs":{ "get":{ "summary":"Get Registered Organizations", "operationId":"getAllRegisteredOrgs", "tags":[ "ORDS Endpoints" ], "security":[ ], "responses":{ "200":{ "description":"The queried record.", "content":{ "application/json":{ "schema":{ "type":"object", "properties":{ "items":{ "type":"array", "items":{ "type":"object", "properties":{ "org_id":{ "$ref":"#/components/schemas/ORDS_VARCHAR2" }, "org_name":{ "$ref":"#/components/schemas/ORDS_VARCHAR2" } } } } } } } } }, "400":{ "$ref":"#/components/responses/Wrapper_BadRequest" }, "502":{ "$ref":"#/components/responses/Wrapper_BadGateway" }, "default":{ "description":"ORDS upstream status, content type, and response body are passed through unchanged." } }, "x-postman-request-name":"GET getAllRegisteredOrgs", "parameters":[ { "name":"X-Service-Token", "in":"header", "required":true, "schema":{ "type":"string" }, "description":"Service token forwarded to ORDS as the Authorization header." }, { "name":"token_id", "in":"query", "required":false, "schema":{ "type":"string" } }, { "name":"contractAddress", "in":"path", "required":true, "schema":{ "type":"string" }, "description":"Path parameter" }, { "name":"ordsPathPrefix", "in":"path", "required":true, "schema":{ "type":"string" }, "description":"Path parameter" } ], "description":"Retrieves all organizations registered for the specified token. Generated from ORDS GET /getAllRegisteredOrgs.", "x-contract-endpoint-name":"getAllRegisteredOrgs", "x-backend":"ORDS", "x-ords-response-source":"/getAllRegisteredOrgs", "x-internal-id":"{contractAddress}-{ordsPathPrefix}-getAllRegisteredOrgs-get", "x-filename-id":"contractaddress-ordspathprefix-getallregisteredorgs-get" } }, "/{contractAddress}/{ordsPathPrefix}/getAllSuspendedCBDCAccounts":{ "get":{ "summary":"Get Suspended CBDC Accounts", "operationId":"getAllSuspendedCBDCAccounts", "tags":[ "ORDS Endpoints" ], "security":[ ], "responses":{ "200":{ "description":"The queried record.", "content":{ "application/json":{ "schema":{ "type":"object", "properties":{ "items":{ "type":"array", "items":{ "type":"object", "properties":{ "account_address":{ "$ref":"#/components/schemas/ORDS_VARCHAR2" }, "account_id":{ "$ref":"#/components/schemas/ORDS_VARCHAR2" }, "application_groups":{ "$ref":"#/components/schemas/ORDS_VARCHAR2" }, "balance":{ "$ref":"#/components/schemas/ORDS_VARCHAR2" }, "created_blockno":{ "$ref":"#/components/schemas/ORDS_NUMBER" }, "created_timestamp":{ "$ref":"#/components/schemas/ORDS_TIMESTAMP" }, "created_txnhash":{ "$ref":"#/components/schemas/ORDS_VARCHAR2" }, "created_txnno":{ "$ref":"#/components/schemas/ORDS_NUMBER" }, "daily_amount":{ "$ref":"#/components/schemas/ORDS_VARCHAR2" }, "daily_transactions":{ "$ref":"#/components/schemas/ORDS_VARCHAR2" }, "max_daily_amount":{ "$ref":"#/components/schemas/ORDS_VARCHAR2" }, "max_daily_transactions":{ "$ref":"#/components/schemas/ORDS_VARCHAR2" }, "onhold_balance":{ "$ref":"#/components/schemas/ORDS_VARCHAR2" }, "onhold_burn_balance":{ "$ref":"#/components/schemas/ORDS_CHAR" }, "org_id":{ "$ref":"#/components/schemas/ORDS_VARCHAR2" }, "status":{ "$ref":"#/components/schemas/ORDS_VARCHAR2" }, "token_id":{ "$ref":"#/components/schemas/ORDS_VARCHAR2" }, "token_name":{ "$ref":"#/components/schemas/ORDS_VARCHAR2" }, "user_id":{ "$ref":"#/components/schemas/ORDS_VARCHAR2" } } } } } } } } }, "400":{ "$ref":"#/components/responses/Wrapper_BadRequest" }, "502":{ "$ref":"#/components/responses/Wrapper_BadGateway" }, "default":{ "description":"ORDS upstream status, content type, and response body are passed through unchanged." } }, "x-postman-request-name":"GET getAllSuspendedCBDCAccounts", "parameters":[ { "name":"X-Service-Token", "in":"header", "required":true, "schema":{ "type":"string" }, "description":"Service token forwarded to ORDS as the Authorization header." }, { "name":"token_id", "in":"query", "required":false, "schema":{ "type":"string" } }, { "name":"contractAddress", "in":"path", "required":true, "schema":{ "type":"string" }, "description":"Path parameter" }, { "name":"ordsPathPrefix", "in":"path", "required":true, "schema":{ "type":"string" }, "description":"Path parameter" } ], "description":"Retrieves all suspended CBDC accounts for the specified token. Generated from ORDS GET /getAllSuspendedCBDCAccounta.", "x-contract-endpoint-name":"getAllSuspendedCBDCAccounts", "x-backend":"ORDS", "x-ords-response-source":"/getAllSuspendedCBDCAccounts", "x-internal-id":"{contractAddress}-{ordsPathPrefix}-getAllSuspendedCBDCAccounts-get", "x-filename-id":"contractaddress-ordspathprefix-getallsuspendedcbdcaccounts-get" } }, "/{contractAddress}/{ordsPathPrefix}/getApproverActionHistory":{ "get":{ "summary":"Get Approver Actions", "operationId":"getApproverActionHistory", "tags":[ "ORDS Endpoints" ], "security":[ ], "responses":{ "200":{ "description":"The queried record.", "content":{ "application/json":{ "schema":{ "type":"object", "properties":{ "items":{ "type":"array", "items":{ "type":"object", "properties":{ "action":{ "$ref":"#/components/schemas/ORDS_VARCHAR2" }, "approver":{ "$ref":"#/components/schemas/ORDS_VARCHAR2" }, "block_number":{ "$ref":"#/components/schemas/ORDS_NUMBER" }, "from_account_id":{ "$ref":"#/components/schemas/ORDS_VARCHAR2" }, "from_org_id":{ "$ref":"#/components/schemas/ORDS_VARCHAR2" }, "from_user_id":{ "$ref":"#/components/schemas/ORDS_VARCHAR2" }, "holding_id":{ "$ref":"#/components/schemas/ORDS_VARCHAR2" }, "holding_status":{ "$ref":"#/components/schemas/ORDS_VARCHAR2" }, "last_updated_time":{ "$ref":"#/components/schemas/ORDS_TIMESTAMP" }, "notary_account_id":{ "$ref":"#/components/schemas/ORDS_VARCHAR2" }, "notary_org_id":{ "$ref":"#/components/schemas/ORDS_VARCHAR2" }, "notary_user_id":{ "$ref":"#/components/schemas/ORDS_VARCHAR2" }, "operation_id":{ "$ref":"#/components/schemas/ORDS_VARCHAR2" }, "quantity":{ "$ref":"#/components/schemas/ORDS_VARCHAR2" }, "request_type":{ "$ref":"#/components/schemas/ORDS_VARCHAR2" }, "timestamp":{ "$ref":"#/components/schemas/ORDS_TIMESTAMP" }, "timetoexpiration":{ "$ref":"#/components/schemas/ORDS_VARCHAR2" }, "token_id":{ "$ref":"#/components/schemas/ORDS_VARCHAR2" }, "token_name":{ "$ref":"#/components/schemas/ORDS_VARCHAR2" }, "to_account_id":{ "$ref":"#/components/schemas/ORDS_VARCHAR2" }, "to_org_id":{ "$ref":"#/components/schemas/ORDS_VARCHAR2" }, "to_user_id":{ "$ref":"#/components/schemas/ORDS_VARCHAR2" }, "transaction_hash":{ "$ref":"#/components/schemas/ORDS_VARCHAR2" }, "transaction_id":{ "$ref":"#/components/schemas/ORDS_VARCHAR2" }, "transaction_index":{ "$ref":"#/components/schemas/ORDS_NUMBER" } } } } } } } } }, "400":{ "$ref":"#/components/responses/Wrapper_BadRequest" }, "502":{ "$ref":"#/components/responses/Wrapper_BadGateway" }, "default":{ "description":"ORDS upstream status, content type, and response body are passed through unchanged." } }, "x-postman-request-name":"GET getApproverActionHistory", "parameters":[ { "name":"X-Service-Token", "in":"header", "required":true, "schema":{ "type":"string" }, "description":"Service token forwarded to ORDS as the Authorization header." }, { "name":"caller_account_id", "in":"query", "required":false, "schema":{ "type":"string" } }, { "name":"token_id", "in":"query", "required":false, "schema":{ "type":"string" } }, { "name":"contractAddress", "in":"path", "required":true, "schema":{ "type":"string" }, "description":"Path parameter" }, { "name":"ordsPathPrefix", "in":"path", "required":true, "schema":{ "type":"string" }, "description":"Path parameter" } ], "description":"Retrieves approver action history for the specified caller account and token. Generated from `ORDS GET /getApproverActionHistory`.", "x-contract-endpoint-name":"getApproverActionHistory", "x-backend":"ORDS", "x-ords-response-source":"/getApproverActionHistory", "x-internal-id":"{contractAddress}-{ordsPathPrefix}-getApproverActionHistory-get", "x-filename-id":"contractaddress-ordspathprefix-getapproveractionhistory-get" } }, "/{contractAddress}/{ordsPathPrefix}/getCBDCAccountHistory":{ "get":{ "summary":"Get CBDC Account History", "operationId":"getCBDCAccountHistory", "tags":[ "ORDS Endpoints" ], "security":[ ], "responses":{ "200":{ "description":"The queried record.", "content":{ "application/json":{ "schema":{ "type":"object", "properties":{ "items":{ "type":"array", "items":{ "type":"object", "properties":{ "account_address":{ "$ref":"#/components/schemas/ORDS_VARCHAR2" }, "account_id":{ "$ref":"#/components/schemas/ORDS_VARCHAR2" }, "application_groups":{ "$ref":"#/components/schemas/ORDS_VARCHAR2" }, "balance":{ "$ref":"#/components/schemas/ORDS_VARCHAR2" }, "bapaccountversion":{ "$ref":"#/components/schemas/ORDS_VARCHAR2" }, "besu_function":{ "$ref":"#/components/schemas/ORDS_VARCHAR2" }, "block_number":{ "$ref":"#/components/schemas/ORDS_NUMBER" }, "daily_amount":{ "$ref":"#/components/schemas/ORDS_VARCHAR2" }, "daily_transactions":{ "$ref":"#/components/schemas/ORDS_VARCHAR2" }, "limit":{ "$ref":"#/components/schemas/ORDS_NUMBER" }, "max_daily_amount":{ "$ref":"#/components/schemas/ORDS_VARCHAR2" }, "max_daily_transactions":{ "$ref":"#/components/schemas/ORDS_VARCHAR2" }, "offset":{ "$ref":"#/components/schemas/ORDS_NUMBER" }, "onhold_balance":{ "$ref":"#/components/schemas/ORDS_VARCHAR2" }, "onhold_burn_balance":{ "$ref":"#/components/schemas/ORDS_CHAR" }, "org_id":{ "$ref":"#/components/schemas/ORDS_VARCHAR2" }, "status":{ "$ref":"#/components/schemas/ORDS_VARCHAR2" }, "timestamp":{ "$ref":"#/components/schemas/ORDS_TIMESTAMP" }, "token_id":{ "$ref":"#/components/schemas/ORDS_VARCHAR2" }, "total":{ "$ref":"#/components/schemas/ORDS_NUMBER" }, "transaction_hash":{ "$ref":"#/components/schemas/ORDS_VARCHAR2" }, "transaction_id":{ "$ref":"#/components/schemas/ORDS_VARCHAR2" }, "transaction_index":{ "$ref":"#/components/schemas/ORDS_NUMBER" }, "user_id":{ "$ref":"#/components/schemas/ORDS_VARCHAR2" } } } } } } } } }, "400":{ "$ref":"#/components/responses/Wrapper_BadRequest" }, "502":{ "$ref":"#/components/responses/Wrapper_BadGateway" }, "default":{ "description":"ORDS upstream status, content type, and response body are passed through unchanged." } }, "x-postman-request-name":"GET getCBDCAccountHistory", "parameters":[ { "name":"X-Service-Token", "in":"header", "required":true, "schema":{ "type":"string" }, "description":"Service token forwarded to ORDS as the Authorization header." }, { "name":"account_address", "in":"query", "required":false, "schema":{ "type":"string" } }, { "name":"limit", "in":"query", "required":false, "schema":{ "type":"integer", "format":"int64" } }, { "name":"offset", "in":"query", "required":false, "schema":{ "type":"integer", "format":"int64" } }, { "name":"contractAddress", "in":"path", "required":true, "schema":{ "type":"string" }, "description":"Path parameter" }, { "name":"ordsPathPrefix", "in":"path", "required":true, "schema":{ "type":"string" }, "description":"Path parameter" } ], "description":"Retrieves the history of the specified CBDC account. Generated from `ORDS GET /getCBDCAccountHistory`.", "x-contract-endpoint-name":"getCBDCAccountHistory", "x-backend":"ORDS", "x-ords-response-source":"/getCBDCAccountHistory", "x-internal-id":"{contractAddress}-{ordsPathPrefix}-getCBDCAccountHistory-get", "x-filename-id":"contractaddress-ordspathprefix-getcbdcaccounthistory-get" } }, "/{contractAddress}/{ordsPathPrefix}/getCBDCAccountStatus":{ "get":{ "summary":"getCBDCAccountStatus", "operationId":"getCBDCAccountStatus", "tags":[ "ORDS Endpoints" ], "security":[ ], "responses":{ "200":{ "description":"The queried record.", "content":{ "application/json":{ "schema":{ "type":"object", "properties":{ "items":{ "type":"array", "items":{ "type":"object", "properties":{ } } } } } } } }, "400":{ "$ref":"#/components/responses/Wrapper_BadRequest" }, "502":{ "$ref":"#/components/responses/Wrapper_BadGateway" }, "default":{ "description":"ORDS upstream status, content type, and response body are passed through unchanged." } }, "x-postman-request-name":"GET getCBDCAccountStatus", "parameters":[ { "name":"X-Service-Token", "in":"header", "required":true, "schema":{ "type":"string" }, "description":"Service token forwarded to ORDS as the Authorization header." }, { "name":"org_id", "in":"query", "required":false, "schema":{ "type":"string" } }, { "name":"token_id", "in":"query", "required":false, "schema":{ "type":"string" } }, { "name":"user_id", "in":"query", "required":false, "schema":{ "type":"string" } }, { "name":"contractAddress", "in":"path", "required":true, "schema":{ "type":"string" }, "description":"Path parameter" }, { "name":"ordsPathPrefix", "in":"path", "required":true, "schema":{ "type":"string" }, "description":"Path parameter" } ], "description":"Retrieves the current status of the specified CBDC account. Generated from `ORDS GET /getCBDCAccountStatus`.", "x-contract-endpoint-name":"getCBDCAccountStatus", "x-backend":"ORDS", "x-ords-response-source":"/getCBDCAccountStatus", "x-internal-id":"{contractAddress}-{ordsPathPrefix}-getCBDCAccountStatus-get", "x-filename-id":"contractaddress-ordspathprefix-getcbdcaccountstatus-get" } }, "/{contractAddress}/{ordsPathPrefix}/getCBDCAccountStatusHistory":{ "get":{ "summary":"Get CBDC Status History", "operationId":"getCBDCAccountStatusHistory", "tags":[ "ORDS Endpoints" ], "security":[ ], "responses":{ "200":{ "description":"The queried record.", "content":{ "application/json":{ "schema":{ "type":"object", "properties":{ "items":{ "type":"array", "items":{ "type":"object", "properties":{ } } } } } } } }, "400":{ "$ref":"#/components/responses/Wrapper_BadRequest" }, "502":{ "$ref":"#/components/responses/Wrapper_BadGateway" }, "default":{ "description":"ORDS upstream status, content type, and response body are passed through unchanged." } }, "x-postman-request-name":"GET getCBDCAccountStatusHistory", "parameters":[ { "name":"X-Service-Token", "in":"header", "required":true, "schema":{ "type":"string" }, "description":"Service token forwarded to ORDS as the Authorization header." }, { "name":"org_id", "in":"query", "required":false, "schema":{ "type":"string" } }, { "name":"token_id", "in":"query", "required":false, "schema":{ "type":"string" } }, { "name":"user_id", "in":"query", "required":false, "schema":{ "type":"string" } }, { "name":"contractAddress", "in":"path", "required":true, "schema":{ "type":"string" }, "description":"Path parameter" }, { "name":"ordsPathPrefix", "in":"path", "required":true, "schema":{ "type":"string" }, "description":"Path parameter" } ], "description":"Retrieves the status history of the specified CBDC account. Generated from `ORDS GET /getCBDCAccountStatusHistory`.", "x-contract-endpoint-name":"getCBDCAccountStatusHistory", "x-backend":"ORDS", "x-ords-response-source":"/getCBDCAccountStatusHistory", "x-internal-id":"{contractAddress}-{ordsPathPrefix}-getCBDCAccountStatusHistory-get", "x-filename-id":"contractaddress-ordspathprefix-getcbdcaccountstatushistory-get" } }, "/{contractAddress}/{ordsPathPrefix}/getCBDCAccountTransactionHistoryWithFilters":{ "get":{ "summary":"Get Account Transactions Using Filters", "operationId":"getCBDCAccountTransactionHistoryWithFilters", "tags":[ "ORDS Endpoints" ], "security":[ ], "responses":{ "200":{ "description":"The queried record.", "content":{ "application/json":{ "schema":{ "type":"object", "properties":{ "items":{ "type":"array", "items":{ "type":"object", "properties":{ "account_id":{ "$ref":"#/components/schemas/ORDS_VARCHAR2" }, "balance":{ "$ref":"#/components/schemas/ORDS_VARCHAR2" }, "besu_function":{ "$ref":"#/components/schemas/ORDS_VARCHAR2" }, "blockno":{ "$ref":"#/components/schemas/ORDS_NUMBER" }, "category":{ "$ref":"#/components/schemas/ORDS_VARCHAR2" }, "description":{ "$ref":"#/components/schemas/ORDS_VARCHAR2" }, "from_account":{ "$ref":"#/components/schemas/ORDS_VARCHAR2" }, "from_account_balance":{ "$ref":"#/components/schemas/ORDS_VARCHAR2" }, "from_org_id":{ "$ref":"#/components/schemas/ORDS_VARCHAR2" }, "from_user_id":{ "$ref":"#/components/schemas/ORDS_VARCHAR2" }, "holding_id":{ "$ref":"#/components/schemas/ORDS_VARCHAR2" }, "log_index":{ "$ref":"#/components/schemas/ORDS_NUMBER" }, "onhold_balance":{ "$ref":"#/components/schemas/ORDS_VARCHAR2" }, "timestamp":{ "$ref":"#/components/schemas/ORDS_TIMESTAMP" }, "token_id":{ "$ref":"#/components/schemas/ORDS_VARCHAR2" }, "to_account":{ "$ref":"#/components/schemas/ORDS_VARCHAR2" }, "to_account_balance":{ "$ref":"#/components/schemas/ORDS_VARCHAR2" }, "to_org_id":{ "$ref":"#/components/schemas/ORDS_VARCHAR2" }, "to_user_id":{ "$ref":"#/components/schemas/ORDS_VARCHAR2" }, "transacted_account":{ "$ref":"#/components/schemas/ORDS_VARCHAR2" }, "transacted_amount":{ "$ref":"#/components/schemas/ORDS_VARCHAR2" }, "transaction_id":{ "$ref":"#/components/schemas/ORDS_VARCHAR2" }, "transaction_type":{ "$ref":"#/components/schemas/ORDS_VARCHAR2" }, "txnno":{ "$ref":"#/components/schemas/ORDS_NUMBER" } } } } } } } } }, "400":{ "$ref":"#/components/responses/Wrapper_BadRequest" }, "502":{ "$ref":"#/components/responses/Wrapper_BadGateway" }, "default":{ "description":"ORDS upstream status, content type, and response body are passed through unchanged." } }, "x-postman-request-name":"GET getCBDCAccountTransactionHistoryWithFilters", "parameters":[ { "name":"X-Service-Token", "in":"header", "required":true, "schema":{ "type":"string" }, "description":"Service token forwarded to ORDS as the Authorization header." }, { "name":"bookmark", "in":"query", "required":false, "schema":{ "type":"string" } }, { "name":"endTime", "in":"query", "required":false, "schema":{ "type":"string" } }, { "name":"org_id", "in":"query", "required":false, "schema":{ "type":"string" } }, { "name":"pageSize", "in":"query", "required":false, "schema":{ "type":"integer", "format":"int64" } }, { "name":"startTime", "in":"query", "required":false, "schema":{ "type":"string" } }, { "name":"token_id", "in":"query", "required":false, "schema":{ "type":"string" } }, { "name":"user_id", "in":"query", "required":false, "schema":{ "type":"string" } }, { "name":"contractAddress", "in":"path", "required":true, "schema":{ "type":"string" }, "description":"Path parameter" }, { "name":"ordsPathPrefix", "in":"path", "required":true, "schema":{ "type":"string" }, "description":"Path parameter" } ], "description":"Retrieves transaction history for the specified CBDC account using the supplied filters. Generated from `ORDS GET /getCBDCAccountTransactionHistoryWithFilters`.", "x-contract-endpoint-name":"getCBDCAccountTransactionHistoryWithFilters", "x-backend":"ORDS", "x-ords-response-source":"/getCBDCAccountTransactionHistoryWithFilters", "x-internal-id":"{contractAddress}-{ordsPathPrefix}-getCBDCAccountTransactionHistoryWithFilters-get", "x-filename-id":"contractaddress-ordspathprefix-getcbdcaccounttransactionhistorywithfilters-get" } }, "/{contractAddress}/{ordsPathPrefix}/getCBDCAccountsByRole":{ "get":{ "summary":"Get CBDC Role Accounts Using Filters", "operationId":"getCBDCAccountsByRole", "tags":[ "ORDS Endpoints" ], "security":[ ], "responses":{ "200":{ "description":"The queried record.", "content":{ "application/json":{ "schema":{ "type":"object", "properties":{ "items":{ "type":"array", "items":{ "type":"object", "properties":{ "account_id":{ "$ref":"#/components/schemas/ORDS_VARCHAR2" } } } } } } } } }, "400":{ "$ref":"#/components/responses/Wrapper_BadRequest" }, "502":{ "$ref":"#/components/responses/Wrapper_BadGateway" }, "default":{ "description":"ORDS upstream status, content type, and response body are passed through unchanged." } }, "x-postman-request-name":"GET getCBDCAccountsByRole", "parameters":[ { "name":"X-Service-Token", "in":"header", "required":true, "schema":{ "type":"string" }, "description":"Service token forwarded to ORDS as the Authorization header." }, { "name":"role", "in":"query", "required":false, "schema":{ "type":"string" } }, { "name":"contractAddress", "in":"path", "required":true, "schema":{ "type":"string" }, "description":"Path parameter" }, { "name":"ordsPathPrefix", "in":"path", "required":true, "schema":{ "type":"string" }, "description":"Path parameter" } ], "description":"Retrieves CBDC accounts assigned to the specified role. Generated from `ORDS GET /getCBDCAccountsByRole`.", "x-contract-endpoint-name":"getCBDCAccountsByRole", "x-backend":"ORDS", "x-ords-response-source":"/getCBDCAccountsByRole", "x-internal-id":"{contractAddress}-{ordsPathPrefix}-getCBDCAccountsByRole-get", "x-filename-id":"contractaddress-ordspathprefix-getcbdcaccountsbyrole-get" } }, "/{contractAddress}/{ordsPathPrefix}/getCBDCAccountsByUser":{ "get":{ "summary":"Get User CBDC Accounts", "operationId":"getCBDCAccountsByUser", "tags":[ "ORDS Endpoints" ], "security":[ ], "responses":{ "200":{ "description":"The queried record.", "content":{ "application/json":{ "schema":{ "type":"object", "properties":{ "items":{ "type":"array", "items":{ "type":"object", "properties":{ "account_address":{ "$ref":"#/components/schemas/ORDS_VARCHAR2" }, "account_id":{ "$ref":"#/components/schemas/ORDS_VARCHAR2" }, "application_groups":{ "$ref":"#/components/schemas/ORDS_VARCHAR2" }, "balance":{ "$ref":"#/components/schemas/ORDS_VARCHAR2" }, "created_blockno":{ "$ref":"#/components/schemas/ORDS_NUMBER" }, "created_timestamp":{ "$ref":"#/components/schemas/ORDS_TIMESTAMP" }, "created_txnhash":{ "$ref":"#/components/schemas/ORDS_VARCHAR2" }, "created_txnno":{ "$ref":"#/components/schemas/ORDS_NUMBER" }, "daily_amount":{ "$ref":"#/components/schemas/ORDS_VARCHAR2" }, "daily_transactions":{ "$ref":"#/components/schemas/ORDS_VARCHAR2" }, "max_daily_amount":{ "$ref":"#/components/schemas/ORDS_VARCHAR2" }, "max_daily_transactions":{ "$ref":"#/components/schemas/ORDS_VARCHAR2" }, "onhold_balance":{ "$ref":"#/components/schemas/ORDS_VARCHAR2" }, "onhold_burn_balance":{ "$ref":"#/components/schemas/ORDS_CHAR" }, "org_id":{ "$ref":"#/components/schemas/ORDS_VARCHAR2" }, "status":{ "$ref":"#/components/schemas/ORDS_VARCHAR2" }, "token_id":{ "$ref":"#/components/schemas/ORDS_VARCHAR2" }, "token_name":{ "$ref":"#/components/schemas/ORDS_VARCHAR2" }, "user_id":{ "$ref":"#/components/schemas/ORDS_VARCHAR2" } } } } } } } } }, "400":{ "$ref":"#/components/responses/Wrapper_BadRequest" }, "502":{ "$ref":"#/components/responses/Wrapper_BadGateway" }, "default":{ "description":"ORDS upstream status, content type, and response body are passed through unchanged." } }, "x-postman-request-name":"GET getCBDCAccountsByUser", "parameters":[ { "name":"X-Service-Token", "in":"header", "required":true, "schema":{ "type":"string" }, "description":"Service token forwarded to ORDS as the Authorization header." }, { "name":"org_id", "in":"query", "required":false, "schema":{ "type":"string" } }, { "name":"token_id", "in":"query", "required":false, "schema":{ "type":"string" } }, { "name":"user_id", "in":"query", "required":false, "schema":{ "type":"string" } }, { "name":"contractAddress", "in":"path", "required":true, "schema":{ "type":"string" }, "description":"Path parameter" }, { "name":"ordsPathPrefix", "in":"path", "required":true, "schema":{ "type":"string" }, "description":"Path parameter" } ], "description":"Retrieves CBDC accounts associated with the specified user. Generated from `ORDS GET /getCBDCAccountsByUser`.", "x-contract-endpoint-name":"getCBDCAccountsByUser", "x-backend":"ORDS", "x-ords-response-source":"/getCBDCAccountsByUser", "x-internal-id":"{contractAddress}-{ordsPathPrefix}-getCBDCAccountsByUser-get", "x-filename-id":"contractaddress-ordspathprefix-getcbdcaccountsbyuser-get" } }, "/{contractAddress}/{ordsPathPrefix}/getCBDCMetadata":{ "get":{ "summary":"Get CBDC Metadata", "operationId":"getCBDCMetadata", "tags":[ "ORDS Endpoints" ], "security":[ ], "responses":{ "200":{ "description":"The queried record.", "content":{ "application/json":{ "schema":{ "type":"object", "properties":{ "items":{ "type":"array", "items":{ "type":"object", "properties":{ "decimals":{ "$ref":"#/components/schemas/ORDS_NUMBER" }, "token_id":{ "$ref":"#/components/schemas/ORDS_VARCHAR2" } } } } } } } } }, "400":{ "$ref":"#/components/responses/Wrapper_BadRequest" }, "502":{ "$ref":"#/components/responses/Wrapper_BadGateway" }, "default":{ "description":"ORDS upstream status, content type, and response body are passed through unchanged." } }, "x-postman-request-name":"GET getCBDCMetadata", "parameters":[ { "name":"X-Service-Token", "in":"header", "required":true, "schema":{ "type":"string" }, "description":"Service token forwarded to ORDS as the Authorization header." }, { "name":"token_id", "in":"query", "required":false, "schema":{ "type":"string" } }, { "name":"contractAddress", "in":"path", "required":true, "schema":{ "type":"string" }, "description":"Path parameter" }, { "name":"ordsPathPrefix", "in":"path", "required":true, "schema":{ "type":"string" }, "description":"Path parameter" } ], "description":"Retrieves metadata for the specified CBDC token. Generated from `ORDS GET /getCBDCMetadata`.", "x-contract-endpoint-name":"getCBDCMetadata", "x-backend":"ORDS", "x-ords-response-source":"/getCBDCMetadata", "x-internal-id":"{contractAddress}-{ordsPathPrefix}-getCBDCMetadata-get", "x-filename-id":"contractaddress-ordspathprefix-getcbdcmetadata-get" } }, "/{contractAddress}/{ordsPathPrefix}/getCBDCRetiredQuantity":{ "get":{ "summary":"Get Retired CBDC Quantity", "operationId":"getCBDCRetiredQuantity", "tags":[ "ORDS Endpoints" ], "security":[ ], "responses":{ "200":{ "description":"The queried record.", "content":{ "application/json":{ "schema":{ "type":"object", "properties":{ "items":{ "type":"array", "items":{ "type":"object", "properties":{ "burnt_quantity":{ "$ref":"#/components/schemas/ORDS_NUMBER" } } } } } } } } }, "400":{ "$ref":"#/components/responses/Wrapper_BadRequest" }, "502":{ "$ref":"#/components/responses/Wrapper_BadGateway" }, "default":{ "description":"ORDS upstream status, content type, and response body are passed through unchanged." } }, "x-postman-request-name":"GET getCBDCRetiredQuantity", "parameters":[ { "name":"X-Service-Token", "in":"header", "required":true, "schema":{ "type":"string" }, "description":"Service token forwarded to ORDS as the Authorization header." }, { "name":"token_id", "in":"query", "required":false, "schema":{ "type":"string" } }, { "name":"contractAddress", "in":"path", "required":true, "schema":{ "type":"string" }, "description":"Path parameter" }, { "name":"ordsPathPrefix", "in":"path", "required":true, "schema":{ "type":"string" }, "description":"Path parameter" } ], "description":"Retrieves the retired quantity for the specified CBDC token. Generated from `ORDS GET /getCBDCRetiredQuantity`.", "x-contract-endpoint-name":"getCBDCRetiredQuantity", "x-backend":"ORDS", "x-ords-response-source":"/getCBDCRetiredQuantity", "x-internal-id":"{contractAddress}-{ordsPathPrefix}-getCBDCRetiredQuantity-get", "x-filename-id":"contractaddress-ordspathprefix-getcbdcretiredquantity-get" } }, "/{contractAddress}/{ordsPathPrefix}/getCBDCTransactionById":{ "get":{ "summary":"Get CBDC Transaction by ID", "operationId":"getCBDCTransactionById", "tags":[ "ORDS Endpoints" ], "security":[ ], "responses":{ "200":{ "description":"The queried record.", "content":{ "application/json":{ "schema":{ "type":"object", "properties":{ "items":{ "type":"array", "items":{ "type":"object", "properties":{ "amount":{ "$ref":"#/components/schemas/ORDS_VARCHAR2" }, "block_number":{ "$ref":"#/components/schemas/ORDS_NUMBER" }, "from_account_id":{ "$ref":"#/components/schemas/ORDS_VARCHAR2" }, "from_org_id":{ "$ref":"#/components/schemas/ORDS_VARCHAR2" }, "from_user_id":{ "$ref":"#/components/schemas/ORDS_VARCHAR2" }, "holding_id":{ "$ref":"#/components/schemas/ORDS_VARCHAR2" }, "operation_id":{ "$ref":"#/components/schemas/ORDS_VARCHAR2" }, "purpose":{ "$ref":"#/components/schemas/ORDS_VARCHAR2" }, "timestamp":{ "$ref":"#/components/schemas/ORDS_TIMESTAMP" }, "token_id":{ "$ref":"#/components/schemas/ORDS_VARCHAR2" }, "to_account_id":{ "$ref":"#/components/schemas/ORDS_VARCHAR2" }, "to_org_id":{ "$ref":"#/components/schemas/ORDS_VARCHAR2" }, "to_user_id":{ "$ref":"#/components/schemas/ORDS_VARCHAR2" }, "transaction_id":{ "$ref":"#/components/schemas/ORDS_VARCHAR2" }, "transaction_type":{ "$ref":"#/components/schemas/ORDS_VARCHAR2" } } } } } } } } }, "400":{ "$ref":"#/components/responses/Wrapper_BadRequest" }, "502":{ "$ref":"#/components/responses/Wrapper_BadGateway" }, "default":{ "description":"ORDS upstream status, content type, and response body are passed through unchanged." } }, "x-postman-request-name":"GET getCBDCTransactionById", "parameters":[ { "name":"X-Service-Token", "in":"header", "required":true, "schema":{ "type":"string" }, "description":"Service token forwarded to ORDS as the Authorization header." }, { "name":"token_id", "in":"query", "required":false, "schema":{ "type":"string" } }, { "name":"transaction_id", "in":"query", "required":false, "schema":{ "type":"string" } }, { "name":"contractAddress", "in":"path", "required":true, "schema":{ "type":"string" }, "description":"Path parameter" }, { "name":"ordsPathPrefix", "in":"path", "required":true, "schema":{ "type":"string" }, "description":"Path parameter" } ], "description":"Retrieves a CBDC transaction by its identifier. Generated from `ORDS GET /getCBDCTransactionById`.", "x-contract-endpoint-name":"getCBDCTransactionById", "x-backend":"ORDS", "x-ords-response-source":"/getCBDCTransactionById", "x-internal-id":"{contractAddress}-{ordsPathPrefix}-getCBDCTransactionById-get", "x-filename-id":"contractaddress-ordspathprefix-getcbdctransactionbyid-get" } }, "/{contractAddress}/{ordsPathPrefix}/getOrgAccountsByRole":{ "get":{ "summary":"Get Organization Accounts by Role", "operationId":"getOrgAccountsByRole", "tags":[ "ORDS Endpoints" ], "security":[ ], "responses":{ "200":{ "description":"The queried record.", "content":{ "application/json":{ "schema":{ "type":"object", "properties":{ "items":{ "type":"array", "items":{ "type":"object", "properties":{ "account_id":{ "$ref":"#/components/schemas/ORDS_VARCHAR2" } } } } } } } } }, "400":{ "$ref":"#/components/responses/Wrapper_BadRequest" }, "502":{ "$ref":"#/components/responses/Wrapper_BadGateway" }, "default":{ "description":"ORDS upstream status, content type, and response body are passed through unchanged." } }, "x-postman-request-name":"GET getOrgAccountsByRole", "parameters":[ { "name":"X-Service-Token", "in":"header", "required":true, "schema":{ "type":"string" }, "description":"Service token forwarded to ORDS as the Authorization header." }, { "name":"org_id", "in":"query", "required":false, "schema":{ "type":"string" } }, { "name":"role", "in":"query", "required":false, "schema":{ "type":"string" } }, { "name":"contractAddress", "in":"path", "required":true, "schema":{ "type":"string" }, "description":"Path parameter" }, { "name":"ordsPathPrefix", "in":"path", "required":true, "schema":{ "type":"string" }, "description":"Path parameter" } ], "description":"Retrieves organization accounts assigned to the specified role. Generated from `ORDS GET /getOrgAccountsByRole`.", "x-contract-endpoint-name":"getOrgAccountsByRole", "x-backend":"ORDS", "x-ords-response-source":"/getOrgAccountsByRole", "x-internal-id":"{contractAddress}-{ordsPathPrefix}-getOrgAccountsByRole-get", "x-filename-id":"contractaddress-ordspathprefix-getorgaccountsbyrole-get" } }, "/{contractAddress}/{ordsPathPrefix}/getPendingCBDCIssuance":{ "get":{ "summary":"Get Pending CBDC Issuance", "operationId":"getPendingCBDCIssuance", "tags":[ "ORDS Endpoints" ], "security":[ ], "responses":{ "200":{ "description":"The queried record.", "content":{ "application/json":{ "schema":{ "type":"object", "properties":{ "items":{ "type":"array", "items":{ "type":"object", "properties":{ "blockno":{ "$ref":"#/components/schemas/ORDS_NUMBER" }, "blocktimestamp":{ "$ref":"#/components/schemas/ORDS_TIMESTAMP" }, "category":{ "$ref":"#/components/schemas/ORDS_VARCHAR2" }, "description":{ "$ref":"#/components/schemas/ORDS_VARCHAR2" }, "expiration_time":{ "$ref":"#/components/schemas/ORDS_VARCHAR2" }, "from_account_id":{ "$ref":"#/components/schemas/ORDS_VARCHAR2" }, "from_org_id":{ "$ref":"#/components/schemas/ORDS_VARCHAR2" }, "from_user_id":{ "$ref":"#/components/schemas/ORDS_VARCHAR2" }, "functionname":{ "$ref":"#/components/schemas/ORDS_VARCHAR2" }, "holding_id":{ "$ref":"#/components/schemas/ORDS_VARCHAR2" }, "notary_account_id":{ "$ref":"#/components/schemas/ORDS_VARCHAR2" }, "notary_org_id":{ "$ref":"#/components/schemas/ORDS_VARCHAR2" }, "notary_user_id":{ "$ref":"#/components/schemas/ORDS_VARCHAR2" }, "op_type":{ "$ref":"#/components/schemas/ORDS_VARCHAR2" }, "original_quantity":{ "$ref":"#/components/schemas/ORDS_VARCHAR2" }, "quantity":{ "$ref":"#/components/schemas/ORDS_VARCHAR2" }, "status":{ "$ref":"#/components/schemas/ORDS_VARCHAR2" }, "status_label":{ "$ref":"#/components/schemas/ORDS_VARCHAR2" }, "storage_key":{ "$ref":"#/components/schemas/ORDS_VARCHAR2" }, "token_id":{ "$ref":"#/components/schemas/ORDS_VARCHAR2" }, "token_name":{ "$ref":"#/components/schemas/ORDS_VARCHAR2" }, "to_account_id":{ "$ref":"#/components/schemas/ORDS_VARCHAR2" }, "to_org_id":{ "$ref":"#/components/schemas/ORDS_VARCHAR2" }, "to_user_id":{ "$ref":"#/components/schemas/ORDS_VARCHAR2" }, "txnhash":{ "$ref":"#/components/schemas/ORDS_VARCHAR2" }, "txnno":{ "$ref":"#/components/schemas/ORDS_NUMBER" } } } } } } } } }, "400":{ "$ref":"#/components/responses/Wrapper_BadRequest" }, "502":{ "$ref":"#/components/responses/Wrapper_BadGateway" }, "default":{ "description":"ORDS upstream status, content type, and response body are passed through unchanged." } }, "x-postman-request-name":"GET getPendingCBDCIssuance", "parameters":[ { "name":"X-Service-Token", "in":"header", "required":true, "schema":{ "type":"string" }, "description":"Service token forwarded to ORDS as the Authorization header." }, { "name":"caller_account_id", "in":"query", "required":false, "schema":{ "type":"string" } }, { "name":"token_id", "in":"query", "required":false, "schema":{ "type":"string" } }, { "name":"contractAddress", "in":"path", "required":true, "schema":{ "type":"string" }, "description":"Path parameter" }, { "name":"ordsPathPrefix", "in":"path", "required":true, "schema":{ "type":"string" }, "description":"Path parameter" } ], "description":"Retrieves pending CBDC issuance requests for the specified caller account and token. Generated from `ORDS GET /getPendingCBDCIssuance`.", "x-contract-endpoint-name":"getPendingCBDCIssuance", "x-backend":"ORDS", "x-ords-response-source":"/getPendingCBDCIssuance", "x-internal-id":"{contractAddress}-{ordsPathPrefix}-getPendingCBDCIssuance-get", "x-filename-id":"contractaddress-ordspathprefix-getpendingcbdcissuance-get" } }, "/{contractAddress}/{ordsPathPrefix}/getPendingCBDCRequest":{ "get":{ "summary":"Get Pending CBDC Requests", "operationId":"getPendingCBDCRequest", "tags":[ "ORDS Endpoints" ], "security":[ ], "responses":{ "200":{ "description":"The queried record.", "content":{ "application/json":{ "schema":{ "type":"object", "properties":{ "items":{ "type":"array", "items":{ "type":"object", "properties":{ "blockno":{ "$ref":"#/components/schemas/ORDS_NUMBER" }, "blocktimestamp":{ "$ref":"#/components/schemas/ORDS_TIMESTAMP" }, "category":{ "$ref":"#/components/schemas/ORDS_VARCHAR2" }, "description":{ "$ref":"#/components/schemas/ORDS_VARCHAR2" }, "expiration_time":{ "$ref":"#/components/schemas/ORDS_VARCHAR2" }, "from_account_id":{ "$ref":"#/components/schemas/ORDS_VARCHAR2" }, "functionname":{ "$ref":"#/components/schemas/ORDS_VARCHAR2" }, "holding_id":{ "$ref":"#/components/schemas/ORDS_VARCHAR2" }, "notary_account_id":{ "$ref":"#/components/schemas/ORDS_VARCHAR2" }, "op_type":{ "$ref":"#/components/schemas/ORDS_VARCHAR2" }, "original_quantity":{ "$ref":"#/components/schemas/ORDS_VARCHAR2" }, "quantity":{ "$ref":"#/components/schemas/ORDS_VARCHAR2" }, "status":{ "$ref":"#/components/schemas/ORDS_VARCHAR2" }, "status_label":{ "$ref":"#/components/schemas/ORDS_VARCHAR2" }, "storage_key":{ "$ref":"#/components/schemas/ORDS_VARCHAR2" }, "token_id":{ "$ref":"#/components/schemas/ORDS_VARCHAR2" }, "token_name":{ "$ref":"#/components/schemas/ORDS_VARCHAR2" }, "to_account_id":{ "$ref":"#/components/schemas/ORDS_VARCHAR2" }, "txnhash":{ "$ref":"#/components/schemas/ORDS_VARCHAR2" }, "txnno":{ "$ref":"#/components/schemas/ORDS_NUMBER" } } } } } } } } }, "400":{ "$ref":"#/components/responses/Wrapper_BadRequest" }, "502":{ "$ref":"#/components/responses/Wrapper_BadGateway" }, "default":{ "description":"ORDS upstream status, content type, and response body are passed through unchanged." } }, "x-postman-request-name":"GET getPendingCBDCRequest", "parameters":[ { "name":"X-Service-Token", "in":"header", "required":true, "schema":{ "type":"string" }, "description":"Service token forwarded to ORDS as the Authorization header." }, { "name":"request_type", "in":"query", "required":false, "schema":{ "type":"string" } }, { "name":"token_id", "in":"query", "required":false, "schema":{ "type":"string" } }, { "name":"contractAddress", "in":"path", "required":true, "schema":{ "type":"string" }, "description":"Path parameter" }, { "name":"ordsPathPrefix", "in":"path", "required":true, "schema":{ "type":"string" }, "description":"Path parameter" } ], "description":"Retrieves pending CBDC requests of the specified type. Generated from `ORDS GET /getPendingCBDCRequest`.", "x-contract-endpoint-name":"getPendingCBDCRequest", "x-backend":"ORDS", "x-ords-response-source":"/getPendingCBDCRequest", "x-internal-id":"{contractAddress}-{ordsPathPrefix}-getPendingCBDCRequest-get", "x-filename-id":"contractaddress-ordspathprefix-getpendingcbdcrequest-get" } }, "/{contractAddress}/{ordsPathPrefix}/getPendingRequest":{ "get":{ "summary":"Get Pending Requests", "operationId":"getPendingRequest", "tags":[ "ORDS Endpoints" ], "security":[ ], "responses":{ "200":{ "description":"The queried record.", "content":{ "application/json":{ "schema":{ "type":"object", "properties":{ "items":{ "type":"array", "items":{ "type":"object", "properties":{ "blockno":{ "$ref":"#/components/schemas/ORDS_NUMBER" }, "blocktimestamp":{ "$ref":"#/components/schemas/ORDS_TIMESTAMP" }, "category":{ "$ref":"#/components/schemas/ORDS_VARCHAR2" }, "description":{ "$ref":"#/components/schemas/ORDS_VARCHAR2" }, "expiration_time":{ "$ref":"#/components/schemas/ORDS_VARCHAR2" }, "from_account_id":{ "$ref":"#/components/schemas/ORDS_VARCHAR2" }, "functionname":{ "$ref":"#/components/schemas/ORDS_VARCHAR2" }, "holding_id":{ "$ref":"#/components/schemas/ORDS_VARCHAR2" }, "notary_account_id":{ "$ref":"#/components/schemas/ORDS_VARCHAR2" }, "op_type":{ "$ref":"#/components/schemas/ORDS_VARCHAR2" }, "original_quantity":{ "$ref":"#/components/schemas/ORDS_VARCHAR2" }, "quantity":{ "$ref":"#/components/schemas/ORDS_VARCHAR2" }, "status":{ "$ref":"#/components/schemas/ORDS_VARCHAR2" }, "status_label":{ "$ref":"#/components/schemas/ORDS_VARCHAR2" }, "storage_key":{ "$ref":"#/components/schemas/ORDS_VARCHAR2" }, "token_id":{ "$ref":"#/components/schemas/ORDS_VARCHAR2" }, "token_name":{ "$ref":"#/components/schemas/ORDS_VARCHAR2" }, "to_account_id":{ "$ref":"#/components/schemas/ORDS_VARCHAR2" }, "txnhash":{ "$ref":"#/components/schemas/ORDS_VARCHAR2" }, "txnno":{ "$ref":"#/components/schemas/ORDS_NUMBER" } } } } } } } } }, "400":{ "$ref":"#/components/responses/Wrapper_BadRequest" }, "502":{ "$ref":"#/components/responses/Wrapper_BadGateway" }, "default":{ "description":"ORDS upstream status, content type, and response body are passed through unchanged." } }, "x-postman-request-name":"GET getPendingRequest", "parameters":[ { "name":"X-Service-Token", "in":"header", "required":true, "schema":{ "type":"string" }, "description":"Service token forwarded to ORDS as the Authorization header." }, { "name":"request_type", "in":"query", "required":false, "schema":{ "type":"string" } }, { "name":"token_id", "in":"query", "required":false, "schema":{ "type":"string" } }, { "name":"contractAddress", "in":"path", "required":true, "schema":{ "type":"string" }, "description":"Path parameter" }, { "name":"ordsPathPrefix", "in":"path", "required":true, "schema":{ "type":"string" }, "description":"Path parameter" } ], "description":"Retrieves pending requests of the specified type. Generated from `ORDS GET /getPendingRequest`.", "x-contract-endpoint-name":"getPendingRequest", "x-backend":"ORDS", "x-ords-response-source":"/getPendingRequest", "x-internal-id":"{contractAddress}-{ordsPathPrefix}-getPendingRequest-get", "x-filename-id":"contractaddress-ordspathprefix-getpendingrequest-get" } }, "/{contractAddress}/{ordsPathPrefix}/getRolesByAccount":{ "get":{ "summary":"Get Roles by Account", "operationId":"getRolesByAccount", "tags":[ "ORDS Endpoints" ], "security":[ ], "responses":{ "200":{ "description":"The queried record.", "content":{ "application/json":{ "schema":{ "type":"object", "properties":{ "items":{ "type":"array", "items":{ "type":"object", "properties":{ "account_address":{ "$ref":"#/components/schemas/ORDS_VARCHAR2" }, "roles":{ "$ref":"#/components/schemas/ORDS_VARCHAR2" } } } } } } } } }, "400":{ "$ref":"#/components/responses/Wrapper_BadRequest" }, "502":{ "$ref":"#/components/responses/Wrapper_BadGateway" }, "default":{ "description":"ORDS upstream status, content type, and response body are passed through unchanged." } }, "x-postman-request-name":"GET getRolesByAccount", "parameters":[ { "name":"X-Service-Token", "in":"header", "required":true, "schema":{ "type":"string" }, "description":"Service token forwarded to ORDS as the Authorization header." }, { "name":"account_address", "in":"query", "required":false, "schema":{ "type":"string" } }, { "name":"org_id", "in":"query", "required":false, "schema":{ "type":"string" } }, { "name":"token_id", "in":"query", "required":false, "schema":{ "type":"string" } }, { "name":"user_id", "in":"query", "required":false, "schema":{ "type":"string" } }, { "name":"contractAddress", "in":"path", "required":true, "schema":{ "type":"string" }, "description":"Path parameter" }, { "name":"ordsPathPrefix", "in":"path", "required":true, "schema":{ "type":"string" }, "description":"Path parameter" } ], "description":"Retrieves the roles assigned to the specified account. Generated from `ORDS GET /getRolesByAccount`.", "x-contract-endpoint-name":"getRolesByAccount", "x-backend":"ORDS", "x-ords-response-source":"/getRolesByAccount", "x-internal-id":"{contractAddress}-{ordsPathPrefix}-getRolesByAccount-get", "x-filename-id":"contractaddress-ordspathprefix-getrolesbyaccount-get" } }, "/{contractAddress}/{ordsPathPrefix}/getTokenHistory":{ "get":{ "summary":"Get Token History", "operationId":"getTokenHistory", "tags":[ "ORDS Endpoints" ], "security":[ ], "responses":{ "200":{ "description":"The queried record.", "content":{ "application/json":{ "schema":{ "type":"object", "properties":{ "items":{ "type":"array", "items":{ "type":"object", "properties":{ } } } } } } } }, "400":{ "$ref":"#/components/responses/Wrapper_BadRequest" }, "502":{ "$ref":"#/components/responses/Wrapper_BadGateway" }, "default":{ "description":"ORDS upstream status, content type, and response body are passed through unchanged." } }, "x-postman-request-name":"GET getTokenHistory", "parameters":[ { "name":"X-Service-Token", "in":"header", "required":true, "schema":{ "type":"string" }, "description":"Service token forwarded to ORDS as the Authorization header." }, { "name":"token_id", "in":"query", "required":false, "schema":{ "type":"string" } }, { "name":"contractAddress", "in":"path", "required":true, "schema":{ "type":"string" }, "description":"Path parameter" }, { "name":"ordsPathPrefix", "in":"path", "required":true, "schema":{ "type":"string" }, "description":"Path parameter" } ], "description":"Retrieves the history of the specified CBDC token. Generated from `ORDS GET /getTokenHistory`.", "x-contract-endpoint-name":"getTokenHistory", "x-backend":"ORDS", "x-ords-response-source":"/getTokenHistory", "x-internal-id":"{contractAddress}-{ordsPathPrefix}-getTokenHistory-get", "x-filename-id":"contractaddress-ordspathprefix-gettokenhistory-get" } }, "/{contractAddress}/{ordsPathPrefix}/getUsersByRole":{ "get":{ "summary":"Get Users by Role", "operationId":"getUsersByRole", "tags":[ "ORDS Endpoints" ], "security":[ ], "responses":{ "200":{ "description":"The queried record.", "content":{ "application/json":{ "schema":{ "type":"object", "properties":{ "items":{ "type":"array", "items":{ "type":"object", "properties":{ "org_id":{ "$ref":"#/components/schemas/ORDS_VARCHAR2" }, "user_id":{ "$ref":"#/components/schemas/ORDS_VARCHAR2" } } } } } } } } }, "400":{ "$ref":"#/components/responses/Wrapper_BadRequest" }, "502":{ "$ref":"#/components/responses/Wrapper_BadGateway" }, "default":{ "description":"ORDS upstream status, content type, and response body are passed through unchanged." } }, "x-postman-request-name":"GET getUsersByRole", "parameters":[ { "name":"X-Service-Token", "in":"header", "required":true, "schema":{ "type":"string" }, "description":"Service token forwarded to ORDS as the Authorization header." }, { "name":"role", "in":"query", "required":false, "schema":{ "type":"string" } }, { "name":"contractAddress", "in":"path", "required":true, "schema":{ "type":"string" }, "description":"Path parameter" }, { "name":"ordsPathPrefix", "in":"path", "required":true, "schema":{ "type":"string" }, "description":"Path parameter" } ], "description":"Retrieves users assigned to the specified role. Generated from `ORDS GET /getUsersByRole`.", "x-contract-endpoint-name":"getUsersByRole", "x-backend":"ORDS", "x-ords-response-source":"/getUsersByRole", "x-internal-id":"{contractAddress}-{ordsPathPrefix}-getUsersByRole-get", "x-filename-id":"contractaddress-ordspathprefix-getusersbyrole-get" } }, "/{accountWithErc5982UupsContractAddress}/createAccountWithRole":{ "post":{ "summary":"Create Account With Role", "description":"Creates a CBDC account and assigns the specified role.", "operationId":"createAccountWithRole", "tags":[ "Combined APIs" ], "responses":{ "200":{ "description":"All combined rpc-proxy steps completed successfully.", "content":{ "application/json":{ "schema":{ "$ref":"#/components/schemas/CombinedApi_SuccessResponse" } } } }, "400":{ "description":"Request validation failed, or a combined step rejected the request.", "content":{ "application/json":{ "schema":{ "$ref":"#/components/schemas/CombinedApi_FailureResponse" } } } }, "502":{ "description":"A combined rpc-proxy step could not be invoked or reported a failed receipt.", "content":{ "application/json":{ "schema":{ "$ref":"#/components/schemas/CombinedApi_FailureResponse" } } } } }, "x-postman-request-name":"POST createAccountWithRole", "parameters":[ { "name":"accountWithErc5982UupsContractAddress", "in":"path", "required":true, "schema":{ "type":"string" }, "description":"Path parameter" } ], "requestBody":{ "required":true, "content":{ "application/json":{ "schema":{ "type":"object", "properties":{ "walletId":{ "type":"string", "example":"", "description":"Postman variable {{walletId}}" }, "account":{ "type":"string", "example":"account value" }, "applicationGroups":{ "type":"string", "example":"applicationGroups value" }, "maxDailyAmount":{ "type":"string", "example":"maxDailyAmount value" }, "maxDailyTransactions":{ "type":"string", "example":"maxDailyTransactions value" }, "orgId":{ "type":"string", "example":"orgId value" }, "role":{ "type":"string", "example":"role value" }, "userAddress":{ "type":"string", "example":"userAddress value" }, "userId":{ "type":"string", "example":"userId value" } }, "required":[ "walletId", "account", "applicationGroups", "maxDailyAmount", "maxDailyTransactions", "orgId", "role", "userAddress", "userId" ], "additionalProperties":false }, "example":{ "walletId":"{{walletId}}", "account":"account value", "applicationGroups":"applicationGroups value", "maxDailyAmount":"maxDailyAmount value", "maxDailyTransactions":"maxDailyTransactions value", "orgId":"orgId value", "role":"role value", "userAddress":"userAddress value", "userId":"userId value" } } } }, "x-contract-endpoint-name":"createAccountWithRole", "x-internal-id":"{accountWithErc5982UupsContractAddress}-createAccountWithRole-post", "x-filename-id":"accountwitherc5982uupscontractaddress-createaccountwithrole-post" } }, "/uwaas/orgs/{orgId}/organization-networks":{ "post":{ "tags":[ "UWaaS" ], "summary":"createOrganizationNetworks", "description":"Creates organization network associations for the specified organization.", "operationId":"UWAAS_createOrganizationNetworks", "parameters":[ { "name":"orgId", "in":"path", "required":true, "schema":{ "type":"string" }, "description":"Organization identifier." } ], "requestBody":{ "required":true, "content":{ "application/json":{ "schema":{ "$ref":"#/components/schemas/UWAAS_BulkCreateOrganizationNetworksRequest" }, "example":{ "items":[ { "accessType":"INSTANCE", "instanceId":"{{instanceId}}", "blockchainType":"BESU", "chainId":"{{chainId}}", "status":"ACTIVE" } ] } } } }, "responses":{ "201":{ "description":"Organization networks created successfully.", "content":{ "application/json":{ "schema":{ "$ref":"#/components/schemas/UWAAS_OrganizationNetworksEnvelope" } } } }, "400":{ "$ref":"#/components/responses/UWAAS_BadRequest" }, "401":{ "$ref":"#/components/responses/UWAAS_Unauthorized" }, "415":{ "$ref":"#/components/responses/Wrapper_UnsupportedMediaType" }, "502":{ "$ref":"#/components/responses/Wrapper_BadGateway" } }, "x-internal-id":"uwaas-orgs-{orgId}-organization-networks-post", "x-filename-id":"uwaas-orgs-orgid-organization-networks-post" } } }, "components":{ "securitySchemes":{ "bearerAuth":{ "type":"http", "scheme":"bearer", "bearerFormat":"Bearer", "description":"HTTP Bearer access token. Obtain a token using the Postman OAuth\n2.0 password_credentials configuration documented in the collection; accessTokenUrl\nis the collection variable {{accessTokenUrl}}." } }, "parameters":{ "fromAddress":{ "name":"fromAddress", "in":"query", "required":false, "schema":{ "type":"string" }, "description":"Caller/from address used by contract read operations." }, "blockTag":{ "name":"blockTag", "in":"query", "required":false, "schema":{ "type":"string", "default":"latest" }, "description":"Blockchain block tag for contract read operations." } }, "schemas":{ "Org":{ "type":"object", "properties":{ "orgId":{ "type":"string" }, "organizationName":{ "type":"string" }, "status":{ "type":"string" }, "description":{ "type":"string" }, "tags":{ "type":"array", "items":{ "type":"string" } } }, "additionalProperties":true }, "WalletUser":{ "type":"object", "properties":{ "userId":{ "type":"string" }, "displayName":{ "type":"string" }, "email":{ "type":"string", "format":"email" }, "roleId":{ "type":"integer" }, "status":{ "type":"string" } }, "additionalProperties":true }, "Wallet":{ "type":"object", "properties":{ "user":{ "$ref":"#/components/schemas/WalletUser" }, "walletLabel":{ "type":"string" }, "walletType":{ "type":"string" }, "status":{ "type":"string" }, "walletTags":{ "type":"array", "items":{ "type":"string" } } }, "additionalProperties":true }, "CreateWalletRequest":{ "type":"object", "properties":{ "org":{ "$ref":"#/components/schemas/Org" }, "instanceId":{ "type":"string" }, "wallet":{ "$ref":"#/components/schemas/Wallet" } }, "required":[ "org", "instanceId", "wallet" ], "additionalProperties":false }, "CreateOrgRequest":{ "type":"object", "properties":{ "orgId":{ "type":"string" }, "organizationName":{ "type":"string" }, "tags":{ "type":"array", "items":{ "type":"string" } }, "description":{ "type":"string" }, "status":{ "type":"string" } }, "required":[ "orgId", "organizationName", "tags", "description", "status" ], "additionalProperties":false }, "UpdateOrgRequest":{ "type":"object", "properties":{ "organizationName":{ "type":"string" }, "tags":{ "type":"array", "items":{ "type":"string" } }, "description":{ "type":"string" }, "status":{ "type":"string" } }, "required":[ "organizationName", "tags", "description", "status" ], "additionalProperties":false }, "InfoTuple":{ "type":"object", "properties":{ "category":{ "type":"string" }, "description":{ "type":"string" } }, "required":[ "category", "description" ], "additionalProperties":false }, "AdminDetailsTuple":{ "type":"object", "properties":{ "userId":{ "type":"string" }, "orgId":{ "type":"string" }, "accountAddress":{ "type":"string", "pattern":"^0x[a-fA-F0-9]{40}$" } }, "required":[ "userId", "orgId", "accountAddress" ], "additionalProperties":false }, "MintableTuple":{ "type":"object", "properties":{ "maxMintQuantity":{ "type":"integer", "format":"int64" }, "mintApprovalRequired":{ "type":"boolean" } }, "required":[ "maxMintQuantity", "mintApprovalRequired" ], "additionalProperties":false }, "BurnableTuple":{ "type":"object", "properties":{ "burnApprovalRequired":{ "type":"boolean" } }, "required":[ "burnApprovalRequired" ], "additionalProperties":false }, "CBDCTokenTuple":{ "type":"object", "properties":{ "tokenId":{ "type":"string" }, "tokenName":{ "type":"string" }, "tokenDesc":{ "type":"string" }, "tokenStandard":{ "type":"string" }, "tokenType":{ "type":"string" }, "tokenUnit":{ "type":"string" }, "behaviors":{ "type":"array", "items":{ "type":"string" } }, "decimals":{ "type":"integer" }, "mintable":{ "$ref":"#/components/schemas/MintableTuple" }, "burnable":{ "$ref":"#/components/schemas/BurnableTuple" } }, "required":[ "tokenId", "tokenName", "tokenDesc", "tokenStandard", "tokenType", "tokenUnit", "behaviors", "decimals", "mintable", "burnable" ], "additionalProperties":false }, "RegisterRequest":{ "type":"object", "properties":{ "contractAddress":{ "type":"string" }, "writeConfigs":{ "type":"object", "properties":{ "type":{ "type":"integer", "format":"int64" }, "gasLimit":{ "type":"integer", "format":"int64" }, "waitForReceipt":{ "type":"boolean" }, "receiptWaitMs":{ "type":"integer", "format":"int64" }, "receiptMaxTries":{ "type":"integer", "format":"int64" }, "decode":{ "type":"object", "properties":{ "inputs":{ "type":"boolean" }, "events":{ "type":"boolean" }, "errors":{ "type":"boolean" } }, "additionalProperties":true } }, "additionalProperties":true }, "readConfigs":{ "type":"object", "properties":{ "blockTag":{ "type":"string" }, "decode":{ "type":"object", "properties":{ "outputs":{ "type":"boolean" }, "errors":{ "type":"boolean" } }, "additionalProperties":true } }, "additionalProperties":true }, "endpoints":{ "type":"array", "items":{ "type":"object", "properties":{ "path":{ "type":"string" }, "httpMethod":{ "type":"string" }, "contractMethod":{ "type":"object", "properties":{ "name":{ "type":"string" }, "signature":{ "type":"string" } }, "additionalProperties":true }, "args":{ "type":"array", "items":{ "type":"string" } }, "generatePostmanApi":{ "type":"boolean" } }, "additionalProperties":true } } }, "additionalProperties":true, "description":"Request shape used by both POST /register variants in the Postman\ncollection." }, "ORDS_CHAR":{ "type":"string" }, "ORDS_NUMBER":{ "type":"number" }, "ORDS_TIMESTAMP":{ "type":"string", "format":"date-time", "pattern":"^\\d{4}-[01]\\d-[0123]\\dT[012]\\d:[0-5]\\d:[0-5]\\d(.\\d+)?(Z|([-+][012]\\d:[0-5]\\d))$" }, "ORDS_VARCHAR2":{ "type":"string" }, "RegisteredSchema":{ "type":"object", "required":[ "contractAddress", "writeConfigs", "readConfigs", "endpoints", "combinedApis" ], "properties":{ "contractAddress":{ "type":"string", "pattern":"^0x[a-fA-F0-9]{40}$" }, "writeConfigs":{ "type":"object", "additionalProperties":true }, "readConfigs":{ "type":"object", "additionalProperties":true }, "endpoints":{ "type":"array", "items":{ "type":"object", "additionalProperties":true } }, "combinedApis":{ "type":"array", "items":{ "type":"object", "additionalProperties":true } } } }, "Register_SuccessResponse":{ "type":"object", "required":[ "status", "schema" ], "properties":{ "status":{ "type":"string", "const":"success" }, "schema":{ "$ref":"#/components/schemas/RegisteredSchema" } } }, "Register_ListSuccessResponse":{ "type":"object", "required":[ "status", "schemas" ], "properties":{ "status":{ "type":"string", "const":"success" }, "schemas":{ "type":"array", "items":{ "$ref":"#/components/schemas/RegisteredSchema" } } } }, "RpcProxy_DecodedValue":{ "type":"object", "required":[ "name", "type", "value" ], "properties":{ "name":{ "type":"string" }, "type":{ "type":"string", "description":"Solidity ABI type." }, "indexed":{ "type":"boolean", "description":"Present for decoded event arguments." }, "value":{ "description":"ABI-decoded value; representation varies by Solidity type." } } }, "RpcProxy_DecodedMeta":{ "type":"object", "properties":{ "abiSource":{ "type":"string" }, "issues":{ "type":"array", "items":{ "type":"object", "additionalProperties":true } } } }, "RpcProxy_DecodedFunction":{ "type":"object", "properties":{ "name":{ "type":"string" }, "signature":{ "type":"string" }, "selector":{ "type":"string", "pattern":"^0x[a-fA-F0-9]{8}$" } } }, "RpcProxy_DecodedEvent":{ "type":"object", "properties":{ "name":{ "type":"string" }, "signature":{ "type":"string" }, "address":{ "type":"string", "pattern":"^0x[a-fA-F0-9]{40}$" }, "logIndex":{ "type":"integer" }, "topics":{ "type":"array", "items":{ "type":"string" } }, "data":{ "type":"string" }, "args":{ "type":"array", "items":{ "$ref":"#/components/schemas/RpcProxy_DecodedValue" } } } }, "RpcProxy_DecodedQuery":{ "type":"object", "properties":{ "meta":{ "$ref":"#/components/schemas/RpcProxy_DecodedMeta" }, "function":{ "$ref":"#/components/schemas/RpcProxy_DecodedFunction" }, "output":{ "type":"object", "properties":{ "returns":{ "type":"array", "items":{ "$ref":"#/components/schemas/RpcProxy_DecodedValue" } } } } } }, "RpcProxy_DecodedTransaction":{ "type":"object", "properties":{ "meta":{ "$ref":"#/components/schemas/RpcProxy_DecodedMeta" }, "function":{ "$ref":"#/components/schemas/RpcProxy_DecodedFunction" }, "events":{ "type":"array", "items":{ "$ref":"#/components/schemas/RpcProxy_DecodedEvent" } } } }, "RpcProxy_QuerySuccessResponse":{ "type":"object", "required":[ "executionStatus", "to", "from", "data", "blockTag", "rawResult" ], "properties":{ "executionStatus":{ "type":"string", "const":"SUCCESS" }, "to":{ "type":"string", "pattern":"^0x[a-fA-F0-9]{40}$" }, "from":{ "type":"string", "pattern":"^0x[a-fA-F0-9]{40}$" }, "data":{ "type":"string", "pattern":"^0x[a-fA-F0-9]*$" }, "blockTag":{ "type":"string" }, "rawResult":{ "type":"string", "pattern":"^0x[a-fA-F0-9]*$" }, "decoded":{ "$ref":"#/components/schemas/RpcProxy_DecodedQuery" } } }, "RpcProxy_TransactionSuccessResponse":{ "type":"object", "required":[ "operation", "from", "txHash", "rawResult", "to", "data", "nonce" ], "properties":{ "operation":{ "type":"string", "example":"NORMAL" }, "from":{ "type":"string", "pattern":"^0x[a-fA-F0-9]{40}$" }, "txHash":{ "type":"string", "pattern":"^0x[a-fA-F0-9]{64}$" }, "rawResult":{ "type":"string", "pattern":"^0x[a-fA-F0-9]*$" }, "to":{ "type":"string", "pattern":"^0x[a-fA-F0-9]{40}$" }, "data":{ "type":"string", "pattern":"^0x[a-fA-F0-9]*$" }, "nonce":{ "type":"string" }, "decoded":{ "$ref":"#/components/schemas/RpcProxy_DecodedTransaction" } } }, "CombinedApi_StepResult":{ "type":"object", "required":[ "step", "stepIndex", "statusCode", "body" ], "properties":{ "step":{ "type":"string" }, "stepIndex":{ "type":"integer" }, "statusCode":{ "type":"integer" }, "body":{ "description":"Parsed rpc-proxy response body, or the unparsed response text." } } }, "CombinedApi_SuccessResponse":{ "type":"object", "required":[ "status", "steps" ], "properties":{ "status":{ "type":"string", "const":"success" }, "steps":{ "type":"array", "items":{ "$ref":"#/components/schemas/CombinedApi_StepResult" } } } }, "CombinedApi_FailureResponse":{ "type":"object", "required":[ "status", "failedStep", "failedStepIndex", "error", "steps" ], "properties":{ "status":{ "type":"string", "const":"failed" }, "failedStep":{ "type":"string" }, "failedStepIndex":{ "type":"integer" }, "error":{ "type":"string" }, "failedStepBody":{ "description":"Parsed response body from the failed step when available." }, "steps":{ "type":"array", "items":{ "$ref":"#/components/schemas/CombinedApi_StepResult" } } } }, "Wrapper_Error":{ "type":"object", "properties":{ "status":{ "type":"integer" }, "error":{ "type":"string" } }, "required":[ "status", "error" ] }, "UWAAS_OrganizationStatus":{ "type":"string", "enum":[ "ACTIVE", "INACTIVE" ], "example":"ACTIVE" }, "UWAAS_OrganizationResponse":{ "type":"object", "properties":{ "orgId":{ "type":"string" }, "organizationName":{ "type":"string" }, "description":{ "type":"string" }, "tags":{ "type":"array", "items":{ "type":"string" } }, "status":{ "$ref":"#/components/schemas/UWAAS_OrganizationStatus" }, "isDeleted":{ "type":"boolean" }, "createdAt":{ "type":"string", "format":"date-time" }, "createdBy":{ "type":"string" }, "updatedAt":{ "type":"string", "format":"date-time" }, "updatedBy":{ "type":"string" } }, "required":[ "orgId", "organizationName", "description", "status", "isDeleted", "createdAt", "createdBy", "updatedAt" ] }, "UWAAS_ListOrganizationsResponse":{ "type":"object", "properties":{ "items":{ "type":"array", "items":{ "$ref":"#/components/schemas/UWAAS_OrganizationResponse" } }, "nextPageToken":{ "type":[ "string", "null" ] } }, "required":[ "items" ] }, "UWAAS_WalletStatus":{ "type":"string", "enum":[ "ACTIVE", "INACTIVE", "CLOSED" ], "example":"ACTIVE" }, "UWAAS_WalletType":{ "type":"string", "enum":[ "1" ], "example":"1" }, "UWAAS_OwnershipType":{ "type":"string", "enum":[ "USER", "SERVICE" ], "default":"USER" }, "UWAAS_ListedWallet":{ "type":"object", "properties":{ "walletId":{ "type":"string" }, "orgId":{ "type":"string" }, "orgNetworkId":{ "type":"integer", "format":"int64" }, "instanceId":{ "type":"string" }, "blockchainType":{ "type":"string" }, "userId":{ "type":"string" }, "status":{ "$ref":"#/components/schemas/UWAAS_WalletStatus" }, "label":{ "type":"string" }, "type":{ "$ref":"#/components/schemas/UWAAS_WalletType" }, "typeLabel":{ "type":"string" }, "ownershipType":{ "$ref":"#/components/schemas/UWAAS_OwnershipType" }, "address":{ "type":"string" }, "createdDate":{ "type":"string", "format":"date-time" }, "updatedDate":{ "type":[ "string", "null" ], "format":"date-time" }, "createdBy":{ "type":"string" }, "updatedBy":{ "type":[ "string", "null" ] }, "walletTags":{ "type":"array", "items":{ "type":"string" } } }, "required":[ "walletId", "orgId", "orgNetworkId", "instanceId", "blockchainType", "userId", "status", "label", "type", "typeLabel", "address", "createdDate", "createdBy", "walletTags" ] }, "UWAAS_ListWalletsResponse":{ "type":"object", "properties":{ "items":{ "type":"array", "items":{ "$ref":"#/components/schemas/UWAAS_ListedWallet" } }, "nextPageToken":{ "type":[ "string", "null" ] } }, "required":[ "items" ] }, "UWAAS_CreateWalletResponse":{ "type":"object", "properties":{ "walletId":{ "type":"string" }, "address":{ "type":"string" }, "userId":{ "type":"string" }, "label":{ "type":"string" }, "status":{ "$ref":"#/components/schemas/UWAAS_WalletStatus" }, "walletType":{ "$ref":"#/components/schemas/UWAAS_WalletType" }, "walletTypeLabel":{ "type":"string" }, "ownershipType":{ "$ref":"#/components/schemas/UWAAS_OwnershipType" }, "providerType":{ "type":"string" }, "providerWalletRef":{ "type":"string" } }, "required":[ "walletId", "address", "label", "status", "walletType", "walletTypeLabel", "providerType", "providerWalletRef" ] }, "UWAAS_ListWalletsEnvelope":{ "type":"object", "required":[ "status", "payload" ], "properties":{ "status":{ "type":"string", "const":"success" }, "payload":{ "$ref":"#/components/schemas/UWAAS_ListWalletsResponse" } } }, "UWAAS_OrganizationEnvelope":{ "type":"object", "required":[ "status", "payload" ], "properties":{ "status":{ "type":"string", "const":"success" }, "payload":{ "$ref":"#/components/schemas/UWAAS_OrganizationResponse" } } }, "UWAAS_ListOrganizationsEnvelope":{ "type":"object", "required":[ "status", "payload" ], "properties":{ "status":{ "type":"string", "const":"success" }, "payload":{ "$ref":"#/components/schemas/UWAAS_ListOrganizationsResponse" } } }, "UWAAS_ProvisionWalletResponse":{ "type":"object", "required":[ "org", "network", "user", "wallet" ], "properties":{ "org":{ "$ref":"#/components/schemas/UWAAS_ProvisionWalletOrganizationResponse" }, "network":{ "$ref":"#/components/schemas/UWAAS_ProvisionWalletNetworkResponse" }, "user":{ "$ref":"#/components/schemas/UWAAS_ProvisionWalletUserResponse" }, "wallet":{ "$ref":"#/components/schemas/UWAAS_ProvisionedWalletResponse" } } }, "UWAAS_ProvisionWalletOrganizationResponse":{ "type":"object", "required":[ "orgId", "status", "created" ], "properties":{ "orgId":{ "type":"string" }, "status":{ "type":"string" }, "created":{ "type":"boolean" } } }, "UWAAS_ProvisionWalletNetworkResponse":{ "type":"object", "required":[ "orgNetworkId", "instanceId", "blockchainType", "chainId", "created" ], "properties":{ "orgNetworkId":{ "type":"integer", "format":"int64" }, "instanceId":{ "type":"string" }, "blockchainType":{ "type":"string" }, "chainId":{ "type":"string" }, "created":{ "type":"boolean" } } }, "UWAAS_ProvisionWalletUserResponse":{ "type":"object", "required":[ "userId", "created" ], "properties":{ "userId":{ "type":"string" }, "created":{ "type":"boolean" } } }, "UWAAS_ProvisionedWalletResponse":{ "type":"object", "required":[ "walletId", "orgId", "orgNetworkId", "instanceId", "blockchainType", "userId", "status", "label", "type", "typeLabel", "ownershipType", "address", "createdDate", "createdBy", "walletTags", "created" ], "properties":{ "walletId":{ "type":"string" }, "orgId":{ "type":"string" }, "orgNetworkId":{ "type":"integer", "format":"int64" }, "instanceId":{ "type":"string" }, "blockchainType":{ "type":"string" }, "userId":{ "type":"string" }, "status":{ "type":"string" }, "label":{ "type":"string" }, "type":{ "type":"string" }, "typeLabel":{ "type":"string" }, "ownershipType":{ "$ref":"#/components/schemas/UWAAS_OwnershipType" }, "address":{ "type":"string" }, "createdDate":{ "type":"string", "format":"date-time" }, "updatedDate":{ "type":"string", "format":"date-time" }, "createdBy":{ "type":"string" }, "walletTags":{ "type":"array", "items":{ "type":"string" } }, "created":{ "type":"boolean" } } }, "UWAAS_CreateOrganizationNetworkRequest":{ "type":"object", "properties":{ "accessType":{ "type":"string", "enum":[ "INSTANCE", "GLOBAL" ] }, "instanceId":{ "type":"string" }, "blockchainType":{ "type":"string" }, "chainId":{ "type":"string" }, "status":{ "type":"string", "enum":[ "ACTIVE", "INACTIVE" ] } } }, "UWAAS_BulkCreateOrganizationNetworksRequest":{ "type":"object", "required":[ "items" ], "properties":{ "items":{ "type":"array", "items":{ "$ref":"#/components/schemas/UWAAS_CreateOrganizationNetworkRequest" } } } }, "UWAAS_OrganizationNetworkResponse":{ "type":"object", "properties":{ "organizationNetworkId":{ "type":"integer", "format":"int64" }, "orgId":{ "type":"string" }, "accessType":{ "type":"string", "enum":[ "INSTANCE", "GLOBAL" ] }, "instanceId":{ "type":"string" }, "blockchainType":{ "type":"string" }, "chainId":{ "type":"string" }, "rpcProxyUrl":{ "type":"string", "format":"uri" }, "walletServiceUrl":{ "type":"string", "format":"uri" }, "status":{ "type":"string", "enum":[ "ACTIVE", "INACTIVE" ] }, "createdBy":{ "type":"string" }, "updatedBy":{ "type":"string" }, "createdAt":{ "type":"string", "format":"date-time" }, "updatedAt":{ "type":"string", "format":"date-time" } } }, "UWAAS_BulkCreateOrganizationNetworksResponse":{ "type":"object", "required":[ "items" ], "properties":{ "items":{ "type":"array", "items":{ "$ref":"#/components/schemas/UWAAS_OrganizationNetworkResponse" } } } }, "UWAAS_OrganizationNetworksEnvelope":{ "type":"object", "required":[ "status", "payload" ], "properties":{ "status":{ "type":"string", "const":"success" }, "payload":{ "$ref":"#/components/schemas/UWAAS_BulkCreateOrganizationNetworksResponse" } } } }, "responses":{ "Wrapper_BadRequest":{ "description":"The wrapper rejected the request before it could complete a downstream call.", "content":{ "application/json":{ "schema":{ "$ref":"#/components/schemas/Wrapper_Error" } } } }, "Wrapper_Unauthorized":{ "description":"A valid Bearer token with a supported user claim is required.", "content":{ "application/json":{ "schema":{ "$ref":"#/components/schemas/Wrapper_Error" } } } }, "Wrapper_NotFound":{ "description":"The requested registered contract schema was not found.", "content":{ "application/json":{ "schema":{ "$ref":"#/components/schemas/Wrapper_Error" } } } }, "Wrapper_UnsupportedMediaType":{ "description":"Content-Type must be application/json.", "content":{ "application/json":{ "schema":{ "$ref":"#/components/schemas/Wrapper_Error" } } } }, "UWAAS_BadRequest":{ "description":"Bad request.", "content":{ "application/json":{ "schema":{ "$ref":"#/components/schemas/Wrapper_Error" } } } }, "UWAAS_Unauthorized":{ "description":"Unauthorized. Authentication details were not specified in the\nPostman collection but this response is included as a reasonable default.", "content":{ "application/json":{ "schema":{ "$ref":"#/components/schemas/Wrapper_Error" } } } }, "UWAAS_NotFound":{ "description":"Requested resource was not found.", "content":{ "application/json":{ "schema":{ "$ref":"#/components/schemas/Wrapper_Error" } } } }, "UWAAS_InternalServerError":{ "description":"Internal server error.", "content":{ "application/json":{ "schema":{ "$ref":"#/components/schemas/Wrapper_Error" } } } }, "Wrapper_BadGateway":{ "description":"The wrapper could not complete the downstream call.", "content":{ "application/json":{ "schema":{ "$ref":"#/components/schemas/Wrapper_Error" } } } } } }, "security":[ { "bearerAuth":[ ] } ] }