{"items":[{"type":"link","label":"Platform API","link":"/apis/platform/api","routeSlug":"/apis/platform/api","content":{"contentType":"overview","seo":{"image":"https://cdn.vilna.io/docs/releases/26103118/og/en/apis-platform-api.png"},"meta":{"name":"Platform API"},"children":[{"nodeType":"container","panels":[{"title":"Download OpenAPI description","titleTranslationKey":"download.description.title","children":[{"kind":"download","label":"api.json","url":"/_bundle/apis/platform/@v2/api.json?download"},{"kind":"download","label":"api.yaml","url":"/_bundle/apis/platform/@v2/api.yaml?download"}]},{"title":"Overview","titleTranslationKey":"info.title","children":[{"kind":"externallink","title":"URL","titleTranslationKey":"info.contact.url","label":"https://vilna.io","url":"https://vilna.io"},{"kind":"email","title":"Vilna API Team","email":"support@vilna.io","label":"support@vilna.io","withCopyButton":true,"copyContent":"support@vilna.io"},{"kind":"externallink","title":"License","titleTranslationKey":"info.license","label":"Apache 2.0","url":"https://www.apache.org/licenses/LICENSE-2.0.html"},{"kind":"externallink","label":"Terms of Service","labelTranslationKey":"info.termsOfService","url":"https://docs.vilna.io/legal/terms"}]},{"title":"Languages","titleTranslationKey":"languages.title","children":[{"kind":"languages","options":[{"key":"curl","title":"curl","lang":"curl"},{"key":"javascript","title":"JavaScript","lang":"JavaScript"},{"key":"python","title":"Python","lang":"Python"},{"key":"go","title":"Go","lang":"Go"}]}]},{"title":"Servers","titleTranslationKey":"servers.title","children":[{"kind":"servers","servers":[{"url":"/_mock/apis/platform/api","description":"Mock server","isMockServer":true},{"url":"https://api.vilna.io/v2","description":"Vilna API."}],"mode":"default"}]}],"children":[{"nodeType":"overview-section-wrapper","children":[{"nodeType":"header","level":1,"label":"Platform API (2.0.0)","showPageActions":true},{"nodeType":"overview-section-wrapper","children":[{"nodeType":"markdoc","content":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Monitor blockchain activity at addresses you provide or derive from your extended public key. Read balances and transactions, reconcile invoice receipts and configure notifications across supported networks."},"children":[]}]}]},{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"See the "},"children":[]},{"$$mdtype":"Node","type":"link","inline":true,"attributes":{"href":"https://docs.vilna.io/apis/platform"},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Platform overview"},"children":[]}]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" for capabilities, "},"children":[]},{"$$mdtype":"Node","type":"link","inline":true,"attributes":{"href":"https://docs.vilna.io/apis/authentication"},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"authentication"},"children":[]}]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" for API keys, and "},"children":[]},{"$$mdtype":"Node","type":"link","inline":true,"attributes":{"href":"https://docs.vilna.io/apis/idempotency"},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"idempotency"},"children":[]}]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" for mutation retries. Each operation declares its required permissions, headers and parameters."},"children":[]}]}]}]}],"sectionId":"/"}],"sectionId":"/"}]}]}},{"type":"separator","label":"Activity & Balances","content":null},{"type":"group","label":"Activity","link":"/apis/platform/api/activity","routeSlug":"/apis/platform/api/activity","items":[{"label":"List activity","deprecated":false,"httpVerb":"get","isAdditionalOperation":false,"isWebhook":false,"type":"link","link":"/apis/platform/api/activity/list-activity","routeSlug":"/apis/platform/api/activity/list-activity","metadata":{"seo":{"title":"List activity","description":"List balance changes across tracked addresses with filtering and pagination."}},"content":{"contentType":"item","itemVariant":"httpItem","meta":{"sourceId":"list-activity","name":"List activity","isWebhook":false,"pointer":"/paths/~1activity/get","hasSamples":false},"children":[{"nodeType":"container","children":[{"nodeType":"header","level":2,"label":"List activity","isWebhook":false,"showPageActions":true}],"panels":[]},{"nodeType":"container","children":[{"nodeType":"header","level":4,"label":"Request","labelTranslationKey":"request","deepLinkSuffix":"request"},{"nodeType":"markdoc","content":"List balance changes across tracked addresses with filtering and pagination."},{"nodeType":"security","requirements":[{"schemes":[{"name":"Auth","scopes":["api:activity:read"],"type":"apiKey","in":"header","paramName":"X-Api-Key","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"API key for authenticating requests. Include your key in the "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"X-Api-Key"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" header. Keys can be created in the Vilna Dashboard or via the Management API. The scopes listed per operation indicate which permissions the key must have."},"children":[]}]}]}]}]}]},{"nodeType":"item-content","variant":"query","label":"Query","labelTranslationKey":"query","parameters":[{"name":"limit","in":"query","schemaId":"schema_0","description":"Maximum number of items to return."},{"name":"page","in":"query","schemaId":"schema_1","description":"Page number for pagination."},{"name":"address","in":"query","style":"form","explode":true,"schemaId":"schema_2","description":"Filter activity by addresses. If not specified, includes all tracked addresses.","example":["0x742d35cc6634c0532925a3b8d1e1d78d8E15e5c4"]},{"name":"asset_gid","in":"query","style":"form","explode":true,"schemaId":"schema_3","description":"Filter activity by asset identifier (CAIP-19 format).","example":["eip155:1/erc20:0xdAC17F958D2ee523a2206206994597C13D831ec7"]},{"name":"chain_gid","in":"query","style":"form","explode":true,"schemaId":"schema_4","description":"Filter activity by blockchain identifier (CAIP-2 format).","example":["eip155:1"]},{"name":"txid","in":"query","style":"form","explode":true,"schemaId":"schema_5","description":"Filter activity by transaction id.","example":["0x1234567890abcdef1234567890abcdef1234567890abcdef1234567890abcdef"]},{"name":"direction","in":"query","schemaId":"schema_6","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Filter activity by movement direction relative to the address."},"children":[]}]}]},{"$$mdtype":"Node","type":"list","attributes":{"ordered":false,"marker":"-"},"children":[{"$$mdtype":"Node","type":"item","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"in"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":": only positive deltas (incoming assets)"},"children":[]}]}]},{"$$mdtype":"Node","type":"item","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"out"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":": only negative deltas (outgoing assets)"},"children":[]}]}]}]},{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"If not specified, both directions are returned."},"children":[]}]}]}],"example":"in"},{"name":"date_from","in":"query","schemaId":"schema_7","description":"Filter activity starting from this date (inclusive, RFC 3339).","example":"2024-01-01T00:00:00Z"},{"name":"date_to","in":"query","schemaId":"schema_7","description":"Filter activity up to this date (inclusive, RFC 3339).","example":"2024-12-31T23:59:59Z"},{"name":"sort_by","in":"query","schemaId":"schema_8","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Field to sort results by. Use "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"-"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" prefix for descending order."},"children":[]}]}]}]}],"pointer":"/paths/~1activity/get/parameters"}],"panels":[{"children":[{"kind":"code-sample","source":{"kind":"code-sample","operationType":"http","method":"GET","path":"/activity","servers":[{"url":"/_mock/apis/platform/api","description":"Mock server","isMockServer":true},{"url":"https://api.vilna.io/v2","description":"Vilna API."}],"parameters":{"path":[],"query":[{"name":"limit","in":"query","required":false,"example":20,"schemaId":"schema_0"},{"name":"page","in":"query","required":false,"example":1,"schemaId":"schema_1"},{"name":"address","in":"query","required":false,"example":["0x742d35cc6634c0532925a3b8d1e1d78d8E15e5c4"],"schemaId":"schema_2","style":"form","explode":true},{"name":"asset_gid","in":"query","required":false,"example":["eip155:1/erc20:0xdAC17F958D2ee523a2206206994597C13D831ec7"],"schemaId":"schema_3","style":"form","explode":true},{"name":"chain_gid","in":"query","required":false,"example":["eip155:1"],"schemaId":"schema_4","style":"form","explode":true},{"name":"txid","in":"query","required":false,"example":["0x1234567890abcdef1234567890abcdef1234567890abcdef1234567890abcdef"],"schemaId":"schema_5","style":"form","explode":true},{"name":"direction","in":"query","required":false,"example":"in","schemaId":"schema_6"},{"name":"date_from","in":"query","required":false,"example":"2024-01-01T00:00:00Z","schemaId":"components/schemas/Timestamp"},{"name":"date_to","in":"query","required":false,"example":"2024-12-31T23:59:59Z","schemaId":"components/schemas/Timestamp"},{"name":"sort_by","in":"query","required":false,"example":"created_at","schemaId":"schema_8"}],"querystring":[],"header":[],"cookie":[]},"security":[{"schemes":[{"id":"Auth","type":"apiKey","name":"X-Api-Key","in":"header"}],"scopes":["api:activity:read"]}],"responseCodes":["200","400","401","403","503","default"],"pointer":"/activity","href":"activity/list-activity","openApiOperationId":"list-activity","summary":"List activity"},"isWebhook":false,"hideReplay":false,"servers":[{"url":"/_mock/apis/platform/api","description":"Mock server","isMockServer":true},{"url":"https://api.vilna.io/v2","description":"Vilna API."}],"examples":[]}]}]},{"nodeType":"container","children":[{"nodeType":"header","level":4,"label":"Responses","labelTranslationKey":"responses","deepLinkSuffix":"responses"},{"nodeType":"item-content","variant":"responses","responses":[{"code":"200","description":"Paginated list of asset movements.","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"schema_9","exampleIds":["paths/~1activity/get/responses/200/content/application~1json/example"]}},"schemaId":"schema_9","exampleIds":["paths/~1activity/get/responses/200/content/application~1json/example"]},{"code":"400","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Bad request (e.g., missing or invalid fields). Invalid text may be reported as address.label_invalid, address.meta_invalid, public_key.label_invalid, invoice.comment_invalid, invoice.metadata_invalid."},"children":[]}]}]}],"mediaType":"application/problem+json","mediaTypes":["application/problem+json"],"mediaTypeContent":{"application/problem+json":{"schemaId":"components/schemas/InvalidRequestProblem","exampleIds":["paths/~1activity/get/responses/400/content/application~1problem+json/examples/malformed_json"]}},"schemaId":"components/schemas/InvalidRequestProblem","exampleIds":["paths/~1activity/get/responses/400/content/application~1problem+json/examples/malformed_json"]},{"code":"401","description":"Missing or invalid authentication credentials.","mediaType":"application/problem+json","mediaTypes":["application/problem+json"],"mediaTypeContent":{"application/problem+json":{"schemaId":"components/schemas/UnauthorizedProblem","exampleIds":["paths/~1activity/get/responses/401/content/application~1problem+json/examples/service_authentication_denied"]}},"schemaId":"components/schemas/UnauthorizedProblem","exampleIds":["paths/~1activity/get/responses/401/content/application~1problem+json/examples/service_authentication_denied"]},{"code":"403","description":"Insufficient permissions.","mediaType":"application/problem+json","mediaTypes":["application/problem+json"],"mediaTypeContent":{"application/problem+json":{"schemaId":"components/schemas/ForbiddenProblem","exampleIds":["paths/~1activity/get/responses/403/content/application~1problem+json/examples/insufficient_permissions"]}},"schemaId":"components/schemas/ForbiddenProblem","exampleIds":["paths/~1activity/get/responses/403/content/application~1problem+json/examples/insufficient_permissions"]},{"code":"503","description":"The operation is temporarily unavailable. Please try again later.","mediaType":"application/problem+json","mediaTypes":["application/problem+json"],"mediaTypeContent":{"application/problem+json":{"schemaId":"components/schemas/Problem","exampleIds":["paths/~1activity/get/responses/503/content/application~1problem+json/examples/temporarily_unavailable"]}},"schemaId":"components/schemas/Problem","exampleIds":["paths/~1activity/get/responses/503/content/application~1problem+json/examples/temporarily_unavailable"]},{"code":"default","description":"Unexpected error.","mediaType":"application/problem+json","mediaTypes":["application/problem+json"],"mediaTypeContent":{"application/problem+json":{"schemaId":"components/schemas/Problem"}},"schemaId":"components/schemas/Problem"}],"pointer":"/paths/~1activity/get/responses"}],"panels":[{"children":[{"kind":"response","responseCodes":[{"code":"200","schemaId":"schema_9","exampleIds":["paths/~1activity/get/responses/200/content/application~1json/example"],"mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"schema_9","exampleIds":["paths/~1activity/get/responses/200/content/application~1json/example"]}}},{"code":"400","schemaId":"components/schemas/InvalidRequestProblem","exampleIds":["paths/~1activity/get/responses/400/content/application~1problem+json/examples/malformed_json"],"mediaTypes":["application/problem+json"],"mediaTypeContent":{"application/problem+json":{"schemaId":"components/schemas/InvalidRequestProblem","exampleIds":["paths/~1activity/get/responses/400/content/application~1problem+json/examples/malformed_json"]}}},{"code":"401","schemaId":"components/schemas/UnauthorizedProblem","exampleIds":["paths/~1activity/get/responses/401/content/application~1problem+json/examples/service_authentication_denied"],"mediaTypes":["application/problem+json"],"mediaTypeContent":{"application/problem+json":{"schemaId":"components/schemas/UnauthorizedProblem","exampleIds":["paths/~1activity/get/responses/401/content/application~1problem+json/examples/service_authentication_denied"]}}},{"code":"403","schemaId":"components/schemas/ForbiddenProblem","exampleIds":["paths/~1activity/get/responses/403/content/application~1problem+json/examples/insufficient_permissions"],"mediaTypes":["application/problem+json"],"mediaTypeContent":{"application/problem+json":{"schemaId":"components/schemas/ForbiddenProblem","exampleIds":["paths/~1activity/get/responses/403/content/application~1problem+json/examples/insufficient_permissions"]}}},{"code":"503","schemaId":"components/schemas/Problem","exampleIds":["paths/~1activity/get/responses/503/content/application~1problem+json/examples/temporarily_unavailable"],"mediaTypes":["application/problem+json"],"mediaTypeContent":{"application/problem+json":{"schemaId":"components/schemas/Problem","exampleIds":["paths/~1activity/get/responses/503/content/application~1problem+json/examples/temporarily_unavailable"]}}},{"code":"default","schemaId":"components/schemas/Problem","mediaTypes":["application/problem+json"],"mediaTypeContent":{"application/problem+json":{"schemaId":"components/schemas/Problem"}}}],"examples":[]}]}]},{"nodeType":"container","children":[{"nodeType":"feedback","pageSlug":"/activity/list-activity"}],"panels":[]}]},"httpPath":"/activity"}],"content":{"contentType":"group","meta":{"name":"activity"},"children":[{"nodeType":"container","children":[{"nodeType":"header","level":2,"label":"Activity","showPageActions":true},{"nodeType":"markdoc","content":"Balance changes across tracked addresses, filterable by chain and asset."}],"panels":[{"children":[{"kind":"group-items","title":"Operations","titleTranslationKey":"operations","items":[{"title":"/activity","summary":"List activity","prefix":{"name":"get","color":"get"},"badges":[],"link":"/activity/list-activity","deprecated":false}]}]}]}]}},{"type":"group","label":"Balances","link":"/apis/platform/api/balance","routeSlug":"/apis/platform/api/balance","items":[{"label":"Search balances","deprecated":false,"httpVerb":"post","isAdditionalOperation":false,"isWebhook":false,"type":"link","link":"/apis/platform/api/balance/search-balances","routeSlug":"/apis/platform/api/balance/search-balances","metadata":{"seo":{"title":"Search balances","description":"Search current balances for a page of address and asset identities within one chain family, with optional chain and asset filters."}},"content":{"contentType":"item","itemVariant":"httpItem","meta":{"sourceId":"search-balances","name":"Search balances","isWebhook":false,"pointer":"/paths/~1balances~1{family}~1search/post","hasSamples":true},"children":[{"nodeType":"container","children":[{"nodeType":"header","level":2,"label":"Search balances","isWebhook":false,"showPageActions":true}],"panels":[]},{"nodeType":"container","children":[{"nodeType":"header","level":4,"label":"Request","labelTranslationKey":"request","deepLinkSuffix":"request"},{"nodeType":"markdoc","content":"Search current balances for a page of address and asset identities within one chain family, with optional chain and asset filters."},{"nodeType":"security","requirements":[{"schemes":[{"name":"Auth","scopes":["api:balance:read"],"type":"apiKey","in":"header","paramName":"X-Api-Key","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"API key for authenticating requests. Include your key in the "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"X-Api-Key"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" header. Keys can be created in the Vilna Dashboard or via the Management API. The scopes listed per operation indicate which permissions the key must have."},"children":[]}]}]}]}]}]},{"nodeType":"item-content","variant":"path","label":"Path","labelTranslationKey":"path","parameters":[{"name":"family","in":"path","schemaId":"schema_10","description":"Chain family for the balance operation. Solana supports catalog data only; balance operations for Solana return 422.","required":true}],"pointer":"/paths/~1balances~1{family}~1search/post/parameters"},{"nodeType":"item-content","variant":"body","label":"Request Body","labelTranslationKey":"body","required":true,"mediaTypes":["application/json"],"mediaTypeSchemas":{"application/json":{"schemaId":"components/schemas/SearchBalancesRequest","exampleIds":["paths/~1balances~1{family}~1search/post/requestBody/content/application~1json/examples/single_address","paths/~1balances~1{family}~1search/post/requestBody/content/application~1json/examples/filtered_search"]}},"schemaId":"components/schemas/SearchBalancesRequest","exampleIds":["paths/~1balances~1{family}~1search/post/requestBody/content/application~1json/examples/single_address","paths/~1balances~1{family}~1search/post/requestBody/content/application~1json/examples/filtered_search"],"pointer":"/paths/~1balances~1{family}~1search/post/requestBody"}],"panels":[{"children":[{"kind":"code-sample","source":{"kind":"code-sample","operationType":"http","method":"POST","path":"/balances/{family}/search","servers":[{"url":"/_mock/apis/platform/api","description":"Mock server","isMockServer":true},{"url":"https://api.vilna.io/v2","description":"Vilna API."}],"parameters":{"path":[{"name":"family","in":"path","required":true,"example":"evm","schemaId":"components/schemas/ChainFamily"}],"query":[],"querystring":[],"header":[],"cookie":[]},"security":[{"schemes":[{"id":"Auth","type":"apiKey","name":"X-Api-Key","in":"header"}],"scopes":["api:balance:read"]}],"requestBody":{"application/json":{"schemaId":"components/schemas/SearchBalancesRequest","exampleIds":["paths/~1balances~1{family}~1search/post/requestBody/content/application~1json/examples/single_address","paths/~1balances~1{family}~1search/post/requestBody/content/application~1json/examples/filtered_search"]}},"responseCodes":["200","400","401","403","404","422","429","502","503","504","default"],"pointer":"/balances/{family}/search","href":"balance/search-balances","openApiOperationId":"search-balances","summary":"Search balances"},"isWebhook":false,"hideReplay":false,"servers":[{"url":"/_mock/apis/platform/api","description":"Mock server","isMockServer":true},{"url":"https://api.vilna.io/v2","description":"Vilna API."}],"schemaId":"components/schemas/SearchBalancesRequest","exampleIds":["paths/~1balances~1{family}~1search/post/requestBody/content/application~1json/examples/single_address","paths/~1balances~1{family}~1search/post/requestBody/content/application~1json/examples/filtered_search"],"mediaTypes":["application/json"],"mediaTypeSchemas":{"application/json":{"schemaId":"components/schemas/SearchBalancesRequest","exampleIds":["paths/~1balances~1{family}~1search/post/requestBody/content/application~1json/examples/single_address","paths/~1balances~1{family}~1search/post/requestBody/content/application~1json/examples/filtered_search"]}},"examples":[{},{}]}]}]},{"nodeType":"container","children":[{"nodeType":"header","level":4,"label":"Responses","labelTranslationKey":"responses","deepLinkSuffix":"responses"},{"nodeType":"item-content","variant":"responses","responses":[{"code":"200","description":"Paginated page of address balances matching the search.","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"schema_11","exampleIds":["paths/~1balances~1{family}~1search/post/responses/200/content/application~1json/example"]}},"schemaId":"schema_11","exampleIds":["paths/~1balances~1{family}~1search/post/responses/200/content/application~1json/example"]},{"code":"400","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Bad request (e.g., missing or invalid fields). Invalid text may be reported as address.label_invalid, address.meta_invalid, public_key.label_invalid, invoice.comment_invalid, invoice.metadata_invalid."},"children":[]}]}]}],"mediaType":"application/problem+json","mediaTypes":["application/problem+json"],"mediaTypeContent":{"application/problem+json":{"schemaId":"components/schemas/InvalidRequestProblem","exampleIds":["paths/~1balances~1{family}~1search/post/responses/400/content/application~1problem+json/examples/malformed_json"]}},"schemaId":"components/schemas/InvalidRequestProblem","exampleIds":["paths/~1balances~1{family}~1search/post/responses/400/content/application~1problem+json/examples/malformed_json"]},{"code":"401","description":"Missing or invalid authentication credentials.","mediaType":"application/problem+json","mediaTypes":["application/problem+json"],"mediaTypeContent":{"application/problem+json":{"schemaId":"components/schemas/UnauthorizedProblem","exampleIds":["paths/~1balances~1{family}~1search/post/responses/401/content/application~1problem+json/examples/service_authentication_denied"]}},"schemaId":"components/schemas/UnauthorizedProblem","exampleIds":["paths/~1balances~1{family}~1search/post/responses/401/content/application~1problem+json/examples/service_authentication_denied"]},{"code":"403","description":"Insufficient permissions.","mediaType":"application/problem+json","mediaTypes":["application/problem+json"],"mediaTypeContent":{"application/problem+json":{"schemaId":"components/schemas/ForbiddenProblem","exampleIds":["paths/~1balances~1{family}~1search/post/responses/403/content/application~1problem+json/examples/insufficient_permissions"]}},"schemaId":"components/schemas/ForbiddenProblem","exampleIds":["paths/~1balances~1{family}~1search/post/responses/403/content/application~1problem+json/examples/insufficient_permissions"]},{"code":"404","description":"Requested resource does not exist.","mediaType":"application/problem+json","mediaTypes":["application/problem+json"],"mediaTypeContent":{"application/problem+json":{"schemaId":"components/schemas/NotFoundProblem","exampleIds":["paths/~1balances~1{family}~1search/post/responses/404/content/application~1problem+json/examples/address_not_found","paths/~1balances~1{family}~1search/post/responses/404/content/application~1problem+json/examples/invoice_not_found"]}},"schemaId":"components/schemas/NotFoundProblem","exampleIds":["paths/~1balances~1{family}~1search/post/responses/404/content/application~1problem+json/examples/address_not_found","paths/~1balances~1{family}~1search/post/responses/404/content/application~1problem+json/examples/invoice_not_found"]},{"code":"422","description":"Request preconditions were not met.","mediaType":"application/problem+json","mediaTypes":["application/problem+json"],"mediaTypeContent":{"application/problem+json":{"schemaId":"components/schemas/PreconditionProblem","exampleIds":["paths/~1balances~1{family}~1search/post/responses/422/content/application~1problem+json/examples/invoice_not_cancellable"]}},"schemaId":"components/schemas/PreconditionProblem","exampleIds":["paths/~1balances~1{family}~1search/post/responses/422/content/application~1problem+json/examples/invoice_not_cancellable"]},{"code":"429","description":"Capacity or action cooldown exceeded.","mediaType":"application/problem+json","mediaTypes":["application/problem+json"],"mediaTypeContent":{"application/problem+json":{"schemaId":"components/schemas/Problem"}},"schemaId":"components/schemas/Problem"},{"code":"502","description":"Invalid upstream response or integration failure.","mediaType":"application/problem+json","mediaTypes":["application/problem+json"],"mediaTypeContent":{"application/problem+json":{"schemaId":"components/schemas/Problem"}},"schemaId":"components/schemas/Problem"},{"code":"503","description":"The operation is temporarily unavailable. Please try again later.","mediaType":"application/problem+json","mediaTypes":["application/problem+json"],"mediaTypeContent":{"application/problem+json":{"schemaId":"components/schemas/Problem","exampleIds":["paths/~1balances~1{family}~1search/post/responses/503/content/application~1problem+json/examples/temporarily_unavailable"]}},"schemaId":"components/schemas/Problem","exampleIds":["paths/~1balances~1{family}~1search/post/responses/503/content/application~1problem+json/examples/temporarily_unavailable"]},{"code":"504","description":"Shared request deadline exhausted.","mediaType":"application/problem+json","mediaTypes":["application/problem+json"],"mediaTypeContent":{"application/problem+json":{"schemaId":"components/schemas/Problem"}},"schemaId":"components/schemas/Problem"},{"code":"default","description":"Unexpected error.","mediaType":"application/problem+json","mediaTypes":["application/problem+json"],"mediaTypeContent":{"application/problem+json":{"schemaId":"components/schemas/Problem"}},"schemaId":"components/schemas/Problem"}],"pointer":"/paths/~1balances~1{family}~1search/post/responses"}],"panels":[{"children":[{"kind":"response","responseCodes":[{"code":"200","schemaId":"schema_11","exampleIds":["paths/~1balances~1{family}~1search/post/responses/200/content/application~1json/example"],"mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"schema_11","exampleIds":["paths/~1balances~1{family}~1search/post/responses/200/content/application~1json/example"]}}},{"code":"400","schemaId":"components/schemas/InvalidRequestProblem","exampleIds":["paths/~1balances~1{family}~1search/post/responses/400/content/application~1problem+json/examples/malformed_json"],"mediaTypes":["application/problem+json"],"mediaTypeContent":{"application/problem+json":{"schemaId":"components/schemas/InvalidRequestProblem","exampleIds":["paths/~1balances~1{family}~1search/post/responses/400/content/application~1problem+json/examples/malformed_json"]}}},{"code":"401","schemaId":"components/schemas/UnauthorizedProblem","exampleIds":["paths/~1balances~1{family}~1search/post/responses/401/content/application~1problem+json/examples/service_authentication_denied"],"mediaTypes":["application/problem+json"],"mediaTypeContent":{"application/problem+json":{"schemaId":"components/schemas/UnauthorizedProblem","exampleIds":["paths/~1balances~1{family}~1search/post/responses/401/content/application~1problem+json/examples/service_authentication_denied"]}}},{"code":"403","schemaId":"components/schemas/ForbiddenProblem","exampleIds":["paths/~1balances~1{family}~1search/post/responses/403/content/application~1problem+json/examples/insufficient_permissions"],"mediaTypes":["application/problem+json"],"mediaTypeContent":{"application/problem+json":{"schemaId":"components/schemas/ForbiddenProblem","exampleIds":["paths/~1balances~1{family}~1search/post/responses/403/content/application~1problem+json/examples/insufficient_permissions"]}}},{"code":"404","schemaId":"components/schemas/NotFoundProblem","exampleIds":["paths/~1balances~1{family}~1search/post/responses/404/content/application~1problem+json/examples/address_not_found","paths/~1balances~1{family}~1search/post/responses/404/content/application~1problem+json/examples/invoice_not_found"],"mediaTypes":["application/problem+json"],"mediaTypeContent":{"application/problem+json":{"schemaId":"components/schemas/NotFoundProblem","exampleIds":["paths/~1balances~1{family}~1search/post/responses/404/content/application~1problem+json/examples/address_not_found","paths/~1balances~1{family}~1search/post/responses/404/content/application~1problem+json/examples/invoice_not_found"]}}},{"code":"422","schemaId":"components/schemas/PreconditionProblem","exampleIds":["paths/~1balances~1{family}~1search/post/responses/422/content/application~1problem+json/examples/invoice_not_cancellable"],"mediaTypes":["application/problem+json"],"mediaTypeContent":{"application/problem+json":{"schemaId":"components/schemas/PreconditionProblem","exampleIds":["paths/~1balances~1{family}~1search/post/responses/422/content/application~1problem+json/examples/invoice_not_cancellable"]}}},{"code":"429","schemaId":"components/schemas/Problem","mediaTypes":["application/problem+json"],"mediaTypeContent":{"application/problem+json":{"schemaId":"components/schemas/Problem"}}},{"code":"502","schemaId":"components/schemas/Problem","mediaTypes":["application/problem+json"],"mediaTypeContent":{"application/problem+json":{"schemaId":"components/schemas/Problem"}}},{"code":"503","schemaId":"components/schemas/Problem","exampleIds":["paths/~1balances~1{family}~1search/post/responses/503/content/application~1problem+json/examples/temporarily_unavailable"],"mediaTypes":["application/problem+json"],"mediaTypeContent":{"application/problem+json":{"schemaId":"components/schemas/Problem","exampleIds":["paths/~1balances~1{family}~1search/post/responses/503/content/application~1problem+json/examples/temporarily_unavailable"]}}},{"code":"504","schemaId":"components/schemas/Problem","mediaTypes":["application/problem+json"],"mediaTypeContent":{"application/problem+json":{"schemaId":"components/schemas/Problem"}}},{"code":"default","schemaId":"components/schemas/Problem","mediaTypes":["application/problem+json"],"mediaTypeContent":{"application/problem+json":{"schemaId":"components/schemas/Problem"}}}],"examples":[]}]}]},{"nodeType":"container","children":[{"nodeType":"feedback","pageSlug":"/balance/search-balances"}],"panels":[]}]},"httpPath":"/balances/{family}/search"},{"label":"Summarize balances","deprecated":false,"httpVerb":"get","isAdditionalOperation":false,"isWebhook":false,"type":"link","link":"/apis/platform/api/balance/summarize-balances","routeSlug":"/apis/platform/api/balance/summarize-balances","metadata":{"seo":{"title":"Summarize balances","description":"Summarize balances by asset across the project's tracked addresses in one chain family. Chain, asset and amount filters apply before pagination; meta.total counts matching assets. Amount bounds use nonnegative integer strings in each asset's base units, without decimal normalization between assets. Known amounts can match even when unsynchronized; unknown amounts match only when both bounds are omitted. Without bounds, zero balances also match. Use min_amount=1 for positive known balances. Results follow ascending canonical asset GID byte order. A min_amount greater than max_amount returns HTTP 400."}},"content":{"contentType":"item","itemVariant":"httpItem","meta":{"sourceId":"summarize-balances","name":"Summarize balances","isWebhook":false,"pointer":"/paths/~1balances~1{family}~1summary/get","hasSamples":false},"children":[{"nodeType":"container","children":[{"nodeType":"header","level":2,"label":"Summarize balances","isWebhook":false,"showPageActions":true}],"panels":[]},{"nodeType":"container","children":[{"nodeType":"header","level":4,"label":"Request","labelTranslationKey":"request","deepLinkSuffix":"request"},{"nodeType":"markdoc","content":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Summarize balances by asset across the project's tracked addresses in one chain family. Chain, asset and amount filters apply before pagination; "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"meta.total"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" counts matching assets. Amount bounds use nonnegative integer strings in each asset's base units, without decimal normalization between assets. Known amounts can match even when unsynchronized; unknown amounts match only when both bounds are omitted. Without bounds, zero balances also match. Use "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"min_amount=1"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" for positive known balances. Results follow ascending canonical asset GID byte order. A "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"min_amount"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" greater than "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"max_amount"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" returns HTTP 400."},"children":[]}]}]}]},{"nodeType":"security","requirements":[{"schemes":[{"name":"Auth","scopes":["api:balance:read"],"type":"apiKey","in":"header","paramName":"X-Api-Key","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"API key for authenticating requests. Include your key in the "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"X-Api-Key"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" header. Keys can be created in the Vilna Dashboard or via the Management API. The scopes listed per operation indicate which permissions the key must have."},"children":[]}]}]}]}]}]},{"nodeType":"item-content","variant":"path","label":"Path","labelTranslationKey":"path","parameters":[{"name":"family","in":"path","schemaId":"schema_10","description":"Chain family for the balance operation. Solana supports catalog data only; balance operations for Solana return 422.","required":true}],"pointer":"/paths/~1balances~1{family}~1summary/get/parameters"},{"nodeType":"item-content","variant":"query","label":"Query","labelTranslationKey":"query","parameters":[{"name":"chain_gid","in":"query","style":"form","explode":true,"schemaId":"schema_4","description":"Filter balances by blockchain identifiers (CAIP-2 format). If not specified, returns all blockchains.","example":["eip155:1"]},{"name":"asset_gid","in":"query","style":"form","explode":true,"schemaId":"schema_3","description":"Filter balances by specific assets (CAIP-19 format). If not specified, returns all assets.","example":["eip155:1/erc20:0xdAC17F958D2ee523a2206206994597C13D831ec7"]},{"name":"min_amount","in":"query","schemaId":"schema_12","description":"Inclusive minimum aggregate amount in each asset's base units, applied before pagination. Unsynchronized known amounts can match; unknown amounts cannot.","example":"1"},{"name":"max_amount","in":"query","schemaId":"schema_12","description":"Inclusive maximum aggregate amount in each asset's base units, applied before pagination. Unsynchronized known amounts can match; unknown amounts cannot.","example":"1000000000000000000"},{"name":"page","in":"query","schemaId":"schema_1","description":"Page number for pagination."},{"name":"limit","in":"query","schemaId":"schema_0","description":"Maximum number of items to return."}],"pointer":"/paths/~1balances~1{family}~1summary/get/parameters"}],"panels":[{"children":[{"kind":"code-sample","source":{"kind":"code-sample","operationType":"http","method":"GET","path":"/balances/{family}/summary","servers":[{"url":"/_mock/apis/platform/api","description":"Mock server","isMockServer":true},{"url":"https://api.vilna.io/v2","description":"Vilna API."}],"parameters":{"path":[{"name":"family","in":"path","required":true,"example":"evm","schemaId":"components/schemas/ChainFamily"}],"query":[{"name":"chain_gid","in":"query","required":false,"example":["eip155:1"],"schemaId":"schema_4","style":"form","explode":true},{"name":"asset_gid","in":"query","required":false,"example":["eip155:1/erc20:0xdAC17F958D2ee523a2206206994597C13D831ec7"],"schemaId":"schema_3","style":"form","explode":true},{"name":"min_amount","in":"query","required":false,"example":"1","schemaId":"components/schemas/AmountInBaseUnits"},{"name":"max_amount","in":"query","required":false,"example":"1000000000000000000","schemaId":"components/schemas/AmountInBaseUnits"},{"name":"page","in":"query","required":false,"example":1,"schemaId":"schema_1"},{"name":"limit","in":"query","required":false,"example":20,"schemaId":"schema_0"}],"querystring":[],"header":[],"cookie":[]},"security":[{"schemes":[{"id":"Auth","type":"apiKey","name":"X-Api-Key","in":"header"}],"scopes":["api:balance:read"]}],"responseCodes":["200","400","401","403","404","422","429","502","503","504","default"],"pointer":"/balances/{family}/summary","href":"balance/summarize-balances","openApiOperationId":"summarize-balances","summary":"Summarize balances"},"isWebhook":false,"hideReplay":false,"servers":[{"url":"/_mock/apis/platform/api","description":"Mock server","isMockServer":true},{"url":"https://api.vilna.io/v2","description":"Vilna API."}],"examples":[]}]}]},{"nodeType":"container","children":[{"nodeType":"header","level":4,"label":"Responses","labelTranslationKey":"responses","deepLinkSuffix":"responses"},{"nodeType":"item-content","variant":"responses","responses":[{"code":"200","description":"Paginated summary of balances by asset across the project's tracked addresses.","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"schema_13","exampleIds":["paths/~1balances~1{family}~1summary/get/responses/200/content/application~1json/example"]}},"schemaId":"schema_13","exampleIds":["paths/~1balances~1{family}~1summary/get/responses/200/content/application~1json/example"]},{"code":"400","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Bad request (e.g., missing or invalid fields). Invalid text may be reported as address.label_invalid, address.meta_invalid, public_key.label_invalid, invoice.comment_invalid, invoice.metadata_invalid."},"children":[]}]}]}],"mediaType":"application/problem+json","mediaTypes":["application/problem+json"],"mediaTypeContent":{"application/problem+json":{"schemaId":"components/schemas/InvalidRequestProblem","exampleIds":["paths/~1balances~1{family}~1summary/get/responses/400/content/application~1problem+json/examples/malformed_json"]}},"schemaId":"components/schemas/InvalidRequestProblem","exampleIds":["paths/~1balances~1{family}~1summary/get/responses/400/content/application~1problem+json/examples/malformed_json"]},{"code":"401","description":"Missing or invalid authentication credentials.","mediaType":"application/problem+json","mediaTypes":["application/problem+json"],"mediaTypeContent":{"application/problem+json":{"schemaId":"components/schemas/UnauthorizedProblem","exampleIds":["paths/~1balances~1{family}~1summary/get/responses/401/content/application~1problem+json/examples/service_authentication_denied"]}},"schemaId":"components/schemas/UnauthorizedProblem","exampleIds":["paths/~1balances~1{family}~1summary/get/responses/401/content/application~1problem+json/examples/service_authentication_denied"]},{"code":"403","description":"Insufficient permissions.","mediaType":"application/problem+json","mediaTypes":["application/problem+json"],"mediaTypeContent":{"application/problem+json":{"schemaId":"components/schemas/ForbiddenProblem","exampleIds":["paths/~1balances~1{family}~1summary/get/responses/403/content/application~1problem+json/examples/insufficient_permissions"]}},"schemaId":"components/schemas/ForbiddenProblem","exampleIds":["paths/~1balances~1{family}~1summary/get/responses/403/content/application~1problem+json/examples/insufficient_permissions"]},{"code":"404","description":"Requested resource does not exist.","mediaType":"application/problem+json","mediaTypes":["application/problem+json"],"mediaTypeContent":{"application/problem+json":{"schemaId":"components/schemas/NotFoundProblem","exampleIds":["paths/~1balances~1{family}~1summary/get/responses/404/content/application~1problem+json/examples/address_not_found","paths/~1balances~1{family}~1summary/get/responses/404/content/application~1problem+json/examples/invoice_not_found"]}},"schemaId":"components/schemas/NotFoundProblem","exampleIds":["paths/~1balances~1{family}~1summary/get/responses/404/content/application~1problem+json/examples/address_not_found","paths/~1balances~1{family}~1summary/get/responses/404/content/application~1problem+json/examples/invoice_not_found"]},{"code":"422","description":"Request preconditions were not met.","mediaType":"application/problem+json","mediaTypes":["application/problem+json"],"mediaTypeContent":{"application/problem+json":{"schemaId":"components/schemas/PreconditionProblem","exampleIds":["paths/~1balances~1{family}~1summary/get/responses/422/content/application~1problem+json/examples/invoice_not_cancellable"]}},"schemaId":"components/schemas/PreconditionProblem","exampleIds":["paths/~1balances~1{family}~1summary/get/responses/422/content/application~1problem+json/examples/invoice_not_cancellable"]},{"code":"429","description":"Capacity or action cooldown exceeded.","mediaType":"application/problem+json","mediaTypes":["application/problem+json"],"mediaTypeContent":{"application/problem+json":{"schemaId":"components/schemas/Problem"}},"schemaId":"components/schemas/Problem"},{"code":"502","description":"Invalid upstream response or integration failure.","mediaType":"application/problem+json","mediaTypes":["application/problem+json"],"mediaTypeContent":{"application/problem+json":{"schemaId":"components/schemas/Problem"}},"schemaId":"components/schemas/Problem"},{"code":"503","description":"The operation is temporarily unavailable. Please try again later.","mediaType":"application/problem+json","mediaTypes":["application/problem+json"],"mediaTypeContent":{"application/problem+json":{"schemaId":"components/schemas/Problem","exampleIds":["paths/~1balances~1{family}~1summary/get/responses/503/content/application~1problem+json/examples/temporarily_unavailable"]}},"schemaId":"components/schemas/Problem","exampleIds":["paths/~1balances~1{family}~1summary/get/responses/503/content/application~1problem+json/examples/temporarily_unavailable"]},{"code":"504","description":"Shared request deadline exhausted.","mediaType":"application/problem+json","mediaTypes":["application/problem+json"],"mediaTypeContent":{"application/problem+json":{"schemaId":"components/schemas/Problem"}},"schemaId":"components/schemas/Problem"},{"code":"default","description":"Unexpected error.","mediaType":"application/problem+json","mediaTypes":["application/problem+json"],"mediaTypeContent":{"application/problem+json":{"schemaId":"components/schemas/Problem"}},"schemaId":"components/schemas/Problem"}],"pointer":"/paths/~1balances~1{family}~1summary/get/responses"}],"panels":[{"children":[{"kind":"response","responseCodes":[{"code":"200","schemaId":"schema_13","exampleIds":["paths/~1balances~1{family}~1summary/get/responses/200/content/application~1json/example"],"mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"schema_13","exampleIds":["paths/~1balances~1{family}~1summary/get/responses/200/content/application~1json/example"]}}},{"code":"400","schemaId":"components/schemas/InvalidRequestProblem","exampleIds":["paths/~1balances~1{family}~1summary/get/responses/400/content/application~1problem+json/examples/malformed_json"],"mediaTypes":["application/problem+json"],"mediaTypeContent":{"application/problem+json":{"schemaId":"components/schemas/InvalidRequestProblem","exampleIds":["paths/~1balances~1{family}~1summary/get/responses/400/content/application~1problem+json/examples/malformed_json"]}}},{"code":"401","schemaId":"components/schemas/UnauthorizedProblem","exampleIds":["paths/~1balances~1{family}~1summary/get/responses/401/content/application~1problem+json/examples/service_authentication_denied"],"mediaTypes":["application/problem+json"],"mediaTypeContent":{"application/problem+json":{"schemaId":"components/schemas/UnauthorizedProblem","exampleIds":["paths/~1balances~1{family}~1summary/get/responses/401/content/application~1problem+json/examples/service_authentication_denied"]}}},{"code":"403","schemaId":"components/schemas/ForbiddenProblem","exampleIds":["paths/~1balances~1{family}~1summary/get/responses/403/content/application~1problem+json/examples/insufficient_permissions"],"mediaTypes":["application/problem+json"],"mediaTypeContent":{"application/problem+json":{"schemaId":"components/schemas/ForbiddenProblem","exampleIds":["paths/~1balances~1{family}~1summary/get/responses/403/content/application~1problem+json/examples/insufficient_permissions"]}}},{"code":"404","schemaId":"components/schemas/NotFoundProblem","exampleIds":["paths/~1balances~1{family}~1summary/get/responses/404/content/application~1problem+json/examples/address_not_found","paths/~1balances~1{family}~1summary/get/responses/404/content/application~1problem+json/examples/invoice_not_found"],"mediaTypes":["application/problem+json"],"mediaTypeContent":{"application/problem+json":{"schemaId":"components/schemas/NotFoundProblem","exampleIds":["paths/~1balances~1{family}~1summary/get/responses/404/content/application~1problem+json/examples/address_not_found","paths/~1balances~1{family}~1summary/get/responses/404/content/application~1problem+json/examples/invoice_not_found"]}}},{"code":"422","schemaId":"components/schemas/PreconditionProblem","exampleIds":["paths/~1balances~1{family}~1summary/get/responses/422/content/application~1problem+json/examples/invoice_not_cancellable"],"mediaTypes":["application/problem+json"],"mediaTypeContent":{"application/problem+json":{"schemaId":"components/schemas/PreconditionProblem","exampleIds":["paths/~1balances~1{family}~1summary/get/responses/422/content/application~1problem+json/examples/invoice_not_cancellable"]}}},{"code":"429","schemaId":"components/schemas/Problem","mediaTypes":["application/problem+json"],"mediaTypeContent":{"application/problem+json":{"schemaId":"components/schemas/Problem"}}},{"code":"502","schemaId":"components/schemas/Problem","mediaTypes":["application/problem+json"],"mediaTypeContent":{"application/problem+json":{"schemaId":"components/schemas/Problem"}}},{"code":"503","schemaId":"components/schemas/Problem","exampleIds":["paths/~1balances~1{family}~1summary/get/responses/503/content/application~1problem+json/examples/temporarily_unavailable"],"mediaTypes":["application/problem+json"],"mediaTypeContent":{"application/problem+json":{"schemaId":"components/schemas/Problem","exampleIds":["paths/~1balances~1{family}~1summary/get/responses/503/content/application~1problem+json/examples/temporarily_unavailable"]}}},{"code":"504","schemaId":"components/schemas/Problem","mediaTypes":["application/problem+json"],"mediaTypeContent":{"application/problem+json":{"schemaId":"components/schemas/Problem"}}},{"code":"default","schemaId":"components/schemas/Problem","mediaTypes":["application/problem+json"],"mediaTypeContent":{"application/problem+json":{"schemaId":"components/schemas/Problem"}}}],"examples":[]}]}]},{"nodeType":"container","children":[{"nodeType":"feedback","pageSlug":"/balance/summarize-balances"}],"panels":[]}]},"httpPath":"/balances/{family}/summary"},{"label":"Refresh balance","deprecated":false,"httpVerb":"post","isAdditionalOperation":false,"isWebhook":false,"type":"link","link":"/apis/platform/api/balance/refresh-balance","routeSlug":"/apis/platform/api/balance/refresh-balance","metadata":{"seo":{"title":"Refresh balance","description":"Synchronously refresh and return the current balance for one address and asset within one chain family.New refreshes share a project-wide rolling limit across all chain families. A request countstoward the limit even if the refresh fails. A limit response includes the effective max andwindow_seconds, with Retry-After when waiting can restore capacity. When max is zero,refresh is prohibited and no timed retry is provided. Temporary service unavailability returns 503."}},"content":{"contentType":"item","itemVariant":"httpItem","meta":{"sourceId":"refresh-balance","name":"Refresh balance","isWebhook":false,"pointer":"/paths/~1balances~1{family}~1actions~1refresh/post","hasSamples":true},"children":[{"nodeType":"container","children":[{"nodeType":"header","level":2,"label":"Refresh balance","isWebhook":false,"showPageActions":true}],"panels":[]},{"nodeType":"container","children":[{"nodeType":"header","level":4,"label":"Request","labelTranslationKey":"request","deepLinkSuffix":"request"},{"nodeType":"markdoc","content":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Synchronously refresh and return the current balance for one address and asset within one chain family."},"children":[]},{"$$mdtype":"Node","type":"softbreak","inline":true,"attributes":{},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"New refreshes share a project-wide rolling limit across all chain families. A request counts"},"children":[]},{"$$mdtype":"Node","type":"softbreak","inline":true,"attributes":{},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"toward the limit even if the refresh fails. A limit response includes the effective "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"max"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" and"},"children":[]},{"$$mdtype":"Node","type":"softbreak","inline":true,"attributes":{},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"window_seconds"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":", with "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"Retry-After"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" when waiting can restore capacity. When "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"max"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" is zero,"},"children":[]},{"$$mdtype":"Node","type":"softbreak","inline":true,"attributes":{},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"refresh is prohibited and no timed retry is provided. Temporary service unavailability returns 503."},"children":[]}]}]}]},{"nodeType":"security","requirements":[{"schemes":[{"name":"Auth","scopes":["api:balance:read"],"type":"apiKey","in":"header","paramName":"X-Api-Key","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"API key for authenticating requests. Include your key in the "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"X-Api-Key"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" header. Keys can be created in the Vilna Dashboard or via the Management API. The scopes listed per operation indicate which permissions the key must have."},"children":[]}]}]}]}]}]},{"nodeType":"item-content","variant":"path","label":"Path","labelTranslationKey":"path","parameters":[{"name":"family","in":"path","schemaId":"schema_10","description":"Chain family for the balance operation. Solana supports catalog data only; balance operations for Solana return 422.","required":true}],"pointer":"/paths/~1balances~1{family}~1actions~1refresh/post/parameters"},{"nodeType":"item-content","variant":"headers","label":"Headers","labelTranslationKey":"header","parameters":[{"name":"Idempotency-Key","in":"header","schemaId":"schema_14","description":"Case-sensitive opaque key for one mutation intent. Send exactly one header occurrence containing 1 to 128 visible ASCII bytes (0x21..0x7e). Commas are literal data; do not trim, lowercase or require UUID syntax. Reuse the same key for retries, with current authorization checked on every attempt. Repeated header occurrences are rejected.\n","required":true}],"pointer":"/paths/~1balances~1{family}~1actions~1refresh/post/parameters"},{"nodeType":"item-content","variant":"body","label":"Request Body","labelTranslationKey":"body","required":true,"mediaTypes":["application/json"],"mediaTypeSchemas":{"application/json":{"schemaId":"components/schemas/RefreshBalanceRequest","exampleIds":["paths/~1balances~1{family}~1actions~1refresh/post/requestBody/content/application~1json/examples/refresh_usdt_balance"]}},"schemaId":"components/schemas/RefreshBalanceRequest","exampleIds":["paths/~1balances~1{family}~1actions~1refresh/post/requestBody/content/application~1json/examples/refresh_usdt_balance"],"pointer":"/paths/~1balances~1{family}~1actions~1refresh/post/requestBody"}],"panels":[{"children":[{"kind":"code-sample","source":{"kind":"code-sample","operationType":"http","method":"POST","path":"/balances/{family}/actions/refresh","servers":[{"url":"/_mock/apis/platform/api","description":"Mock server","isMockServer":true},{"url":"https://api.vilna.io/v2","description":"Vilna API."}],"parameters":{"path":[{"name":"family","in":"path","required":true,"example":"evm","schemaId":"components/schemas/ChainFamily"}],"query":[],"querystring":[],"header":[{"name":"Idempotency-Key","in":"header","required":true,"schemaId":"schema_14"}],"cookie":[]},"security":[{"schemes":[{"id":"Auth","type":"apiKey","name":"X-Api-Key","in":"header"}],"scopes":["api:balance:read"]}],"requestBody":{"application/json":{"schemaId":"components/schemas/RefreshBalanceRequest","exampleIds":["paths/~1balances~1{family}~1actions~1refresh/post/requestBody/content/application~1json/examples/refresh_usdt_balance"]}},"responseCodes":["200","400","401","403","404","409","422","429","502","503","504","default"],"pointer":"/balances/{family}/actions/refresh","href":"balance/refresh-balance","openApiOperationId":"refresh-balance","summary":"Refresh balance"},"isWebhook":false,"hideReplay":false,"servers":[{"url":"/_mock/apis/platform/api","description":"Mock server","isMockServer":true},{"url":"https://api.vilna.io/v2","description":"Vilna API."}],"schemaId":"components/schemas/RefreshBalanceRequest","exampleIds":["paths/~1balances~1{family}~1actions~1refresh/post/requestBody/content/application~1json/examples/refresh_usdt_balance"],"mediaTypes":["application/json"],"mediaTypeSchemas":{"application/json":{"schemaId":"components/schemas/RefreshBalanceRequest","exampleIds":["paths/~1balances~1{family}~1actions~1refresh/post/requestBody/content/application~1json/examples/refresh_usdt_balance"]}},"examples":[{}]}]}]},{"nodeType":"container","children":[{"nodeType":"header","level":4,"label":"Responses","labelTranslationKey":"responses","deepLinkSuffix":"responses"},{"nodeType":"item-content","variant":"responses","responses":[{"code":"200","description":"Freshly refreshed balance for one address and asset.","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"schema_15","exampleIds":["paths/~1balances~1{family}~1actions~1refresh/post/responses/200/content/application~1json/example"]}},"schemaId":"schema_15","exampleIds":["paths/~1balances~1{family}~1actions~1refresh/post/responses/200/content/application~1json/example"]},{"code":"400","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Bad request (e.g., missing or invalid fields). Invalid text may be reported as address.label_invalid, address.meta_invalid, public_key.label_invalid, invoice.comment_invalid, invoice.metadata_invalid."},"children":[]}]}]}],"mediaType":"application/problem+json","mediaTypes":["application/problem+json"],"mediaTypeContent":{"application/problem+json":{"schemaId":"components/schemas/InvalidRequestProblem","exampleIds":["paths/~1balances~1{family}~1actions~1refresh/post/responses/400/content/application~1problem+json/examples/malformed_json"]}},"schemaId":"components/schemas/InvalidRequestProblem","exampleIds":["paths/~1balances~1{family}~1actions~1refresh/post/responses/400/content/application~1problem+json/examples/malformed_json"]},{"code":"401","description":"Missing or invalid authentication credentials.","mediaType":"application/problem+json","mediaTypes":["application/problem+json"],"mediaTypeContent":{"application/problem+json":{"schemaId":"components/schemas/UnauthorizedProblem","exampleIds":["paths/~1balances~1{family}~1actions~1refresh/post/responses/401/content/application~1problem+json/examples/service_authentication_denied"]}},"schemaId":"components/schemas/UnauthorizedProblem","exampleIds":["paths/~1balances~1{family}~1actions~1refresh/post/responses/401/content/application~1problem+json/examples/service_authentication_denied"]},{"code":"403","description":"Insufficient permissions.","mediaType":"application/problem+json","mediaTypes":["application/problem+json"],"mediaTypeContent":{"application/problem+json":{"schemaId":"components/schemas/ForbiddenProblem","exampleIds":["paths/~1balances~1{family}~1actions~1refresh/post/responses/403/content/application~1problem+json/examples/insufficient_permissions"]}},"schemaId":"components/schemas/ForbiddenProblem","exampleIds":["paths/~1balances~1{family}~1actions~1refresh/post/responses/403/content/application~1problem+json/examples/insufficient_permissions"]},{"code":"404","description":"Requested resource does not exist.","mediaType":"application/problem+json","mediaTypes":["application/problem+json"],"mediaTypeContent":{"application/problem+json":{"schemaId":"components/schemas/NotFoundProblem","exampleIds":["paths/~1balances~1{family}~1actions~1refresh/post/responses/404/content/application~1problem+json/examples/address_not_found","paths/~1balances~1{family}~1actions~1refresh/post/responses/404/content/application~1problem+json/examples/invoice_not_found"]}},"schemaId":"components/schemas/NotFoundProblem","exampleIds":["paths/~1balances~1{family}~1actions~1refresh/post/responses/404/content/application~1problem+json/examples/address_not_found","paths/~1balances~1{family}~1actions~1refresh/post/responses/404/content/application~1problem+json/examples/invoice_not_found"]},{"code":"409","description":"Request conflicts with the current resource state.","mediaType":"application/problem+json","mediaTypes":["application/problem+json"],"mediaTypeContent":{"application/problem+json":{"schemaId":"components/schemas/ConflictProblem","exampleIds":["paths/~1balances~1{family}~1actions~1refresh/post/responses/409/content/application~1problem+json/examples/address_occupied","paths/~1balances~1{family}~1actions~1refresh/post/responses/409/content/application~1problem+json/examples/address_in_use","paths/~1balances~1{family}~1actions~1refresh/post/responses/409/content/application~1problem+json/examples/subscription_v1_conflict","paths/~1balances~1{family}~1actions~1refresh/post/responses/409/content/application~1problem+json/examples/notification_send_in_progress","paths/~1balances~1{family}~1actions~1refresh/post/responses/409/content/application~1problem+json/examples/notification_payload_unavailable","paths/~1balances~1{family}~1actions~1refresh/post/responses/409/content/application~1problem+json/examples/notification_test_resend_not_allowed"]}},"schemaId":"components/schemas/ConflictProblem","exampleIds":["paths/~1balances~1{family}~1actions~1refresh/post/responses/409/content/application~1problem+json/examples/address_occupied","paths/~1balances~1{family}~1actions~1refresh/post/responses/409/content/application~1problem+json/examples/address_in_use","paths/~1balances~1{family}~1actions~1refresh/post/responses/409/content/application~1problem+json/examples/subscription_v1_conflict","paths/~1balances~1{family}~1actions~1refresh/post/responses/409/content/application~1problem+json/examples/notification_send_in_progress","paths/~1balances~1{family}~1actions~1refresh/post/responses/409/content/application~1problem+json/examples/notification_payload_unavailable","paths/~1balances~1{family}~1actions~1refresh/post/responses/409/content/application~1problem+json/examples/notification_test_resend_not_allowed"]},{"code":"422","description":"Request preconditions were not met.","mediaType":"application/problem+json","mediaTypes":["application/problem+json"],"mediaTypeContent":{"application/problem+json":{"schemaId":"components/schemas/PreconditionProblem","exampleIds":["paths/~1balances~1{family}~1actions~1refresh/post/responses/422/content/application~1problem+json/examples/invoice_not_cancellable"]}},"schemaId":"components/schemas/PreconditionProblem","exampleIds":["paths/~1balances~1{family}~1actions~1refresh/post/responses/422/content/application~1problem+json/examples/invoice_not_cancellable"]},{"code":"429","description":"The action rate limit is exhausted. The response includes the effective limit and window.","mediaType":"application/problem+json","mediaTypes":["application/problem+json"],"mediaTypeContent":{"application/problem+json":{"schemaId":"components/schemas/RateLimitExceededProblem","exampleIds":["paths/~1balances~1{family}~1actions~1refresh/post/responses/429/content/application~1problem+json/examples/refresh_window_full","paths/~1balances~1{family}~1actions~1refresh/post/responses/429/content/application~1problem+json/examples/refresh_prohibited"]}},"schemaId":"components/schemas/RateLimitExceededProblem","exampleIds":["paths/~1balances~1{family}~1actions~1refresh/post/responses/429/content/application~1problem+json/examples/refresh_window_full","paths/~1balances~1{family}~1actions~1refresh/post/responses/429/content/application~1problem+json/examples/refresh_prohibited"],"headers":{"Retry-After":{"description":"Whole seconds until another action can be admitted under the current limit,\nrounded up. Returned when max is greater than zero and the retry deadline\nis known; omitted when max is zero or the deadline is unknown. This is an\nearliest-retry hint, not a reservation: the next attempt checks the policy\nand usage again.\n","schema":{"type":"integer","minimum":1},"example":7}},"headerSchemaId":"schema_16"},{"code":"502","description":"Invalid upstream response or integration failure.","mediaType":"application/problem+json","mediaTypes":["application/problem+json"],"mediaTypeContent":{"application/problem+json":{"schemaId":"components/schemas/Problem"}},"schemaId":"components/schemas/Problem"},{"code":"503","description":"The operation is temporarily unavailable. Please try again later.","mediaType":"application/problem+json","mediaTypes":["application/problem+json"],"mediaTypeContent":{"application/problem+json":{"schemaId":"components/schemas/Problem","exampleIds":["paths/~1balances~1{family}~1actions~1refresh/post/responses/503/content/application~1problem+json/examples/temporarily_unavailable"]}},"schemaId":"components/schemas/Problem","exampleIds":["paths/~1balances~1{family}~1actions~1refresh/post/responses/503/content/application~1problem+json/examples/temporarily_unavailable"]},{"code":"504","description":"Shared request deadline exhausted.","mediaType":"application/problem+json","mediaTypes":["application/problem+json"],"mediaTypeContent":{"application/problem+json":{"schemaId":"components/schemas/Problem"}},"schemaId":"components/schemas/Problem"},{"code":"default","description":"Unexpected error.","mediaType":"application/problem+json","mediaTypes":["application/problem+json"],"mediaTypeContent":{"application/problem+json":{"schemaId":"components/schemas/Problem"}},"schemaId":"components/schemas/Problem"}],"pointer":"/paths/~1balances~1{family}~1actions~1refresh/post/responses"}],"panels":[{"children":[{"kind":"response","responseCodes":[{"code":"200","schemaId":"schema_15","exampleIds":["paths/~1balances~1{family}~1actions~1refresh/post/responses/200/content/application~1json/example"],"mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"schema_15","exampleIds":["paths/~1balances~1{family}~1actions~1refresh/post/responses/200/content/application~1json/example"]}}},{"code":"400","schemaId":"components/schemas/InvalidRequestProblem","exampleIds":["paths/~1balances~1{family}~1actions~1refresh/post/responses/400/content/application~1problem+json/examples/malformed_json"],"mediaTypes":["application/problem+json"],"mediaTypeContent":{"application/problem+json":{"schemaId":"components/schemas/InvalidRequestProblem","exampleIds":["paths/~1balances~1{family}~1actions~1refresh/post/responses/400/content/application~1problem+json/examples/malformed_json"]}}},{"code":"401","schemaId":"components/schemas/UnauthorizedProblem","exampleIds":["paths/~1balances~1{family}~1actions~1refresh/post/responses/401/content/application~1problem+json/examples/service_authentication_denied"],"mediaTypes":["application/problem+json"],"mediaTypeContent":{"application/problem+json":{"schemaId":"components/schemas/UnauthorizedProblem","exampleIds":["paths/~1balances~1{family}~1actions~1refresh/post/responses/401/content/application~1problem+json/examples/service_authentication_denied"]}}},{"code":"403","schemaId":"components/schemas/ForbiddenProblem","exampleIds":["paths/~1balances~1{family}~1actions~1refresh/post/responses/403/content/application~1problem+json/examples/insufficient_permissions"],"mediaTypes":["application/problem+json"],"mediaTypeContent":{"application/problem+json":{"schemaId":"components/schemas/ForbiddenProblem","exampleIds":["paths/~1balances~1{family}~1actions~1refresh/post/responses/403/content/application~1problem+json/examples/insufficient_permissions"]}}},{"code":"404","schemaId":"components/schemas/NotFoundProblem","exampleIds":["paths/~1balances~1{family}~1actions~1refresh/post/responses/404/content/application~1problem+json/examples/address_not_found","paths/~1balances~1{family}~1actions~1refresh/post/responses/404/content/application~1problem+json/examples/invoice_not_found"],"mediaTypes":["application/problem+json"],"mediaTypeContent":{"application/problem+json":{"schemaId":"components/schemas/NotFoundProblem","exampleIds":["paths/~1balances~1{family}~1actions~1refresh/post/responses/404/content/application~1problem+json/examples/address_not_found","paths/~1balances~1{family}~1actions~1refresh/post/responses/404/content/application~1problem+json/examples/invoice_not_found"]}}},{"code":"409","schemaId":"components/schemas/ConflictProblem","exampleIds":["paths/~1balances~1{family}~1actions~1refresh/post/responses/409/content/application~1problem+json/examples/address_occupied","paths/~1balances~1{family}~1actions~1refresh/post/responses/409/content/application~1problem+json/examples/address_in_use","paths/~1balances~1{family}~1actions~1refresh/post/responses/409/content/application~1problem+json/examples/subscription_v1_conflict","paths/~1balances~1{family}~1actions~1refresh/post/responses/409/content/application~1problem+json/examples/notification_send_in_progress","paths/~1balances~1{family}~1actions~1refresh/post/responses/409/content/application~1problem+json/examples/notification_payload_unavailable","paths/~1balances~1{family}~1actions~1refresh/post/responses/409/content/application~1problem+json/examples/notification_test_resend_not_allowed"],"mediaTypes":["application/problem+json"],"mediaTypeContent":{"application/problem+json":{"schemaId":"components/schemas/ConflictProblem","exampleIds":["paths/~1balances~1{family}~1actions~1refresh/post/responses/409/content/application~1problem+json/examples/address_occupied","paths/~1balances~1{family}~1actions~1refresh/post/responses/409/content/application~1problem+json/examples/address_in_use","paths/~1balances~1{family}~1actions~1refresh/post/responses/409/content/application~1problem+json/examples/subscription_v1_conflict","paths/~1balances~1{family}~1actions~1refresh/post/responses/409/content/application~1problem+json/examples/notification_send_in_progress","paths/~1balances~1{family}~1actions~1refresh/post/responses/409/content/application~1problem+json/examples/notification_payload_unavailable","paths/~1balances~1{family}~1actions~1refresh/post/responses/409/content/application~1problem+json/examples/notification_test_resend_not_allowed"]}}},{"code":"422","schemaId":"components/schemas/PreconditionProblem","exampleIds":["paths/~1balances~1{family}~1actions~1refresh/post/responses/422/content/application~1problem+json/examples/invoice_not_cancellable"],"mediaTypes":["application/problem+json"],"mediaTypeContent":{"application/problem+json":{"schemaId":"components/schemas/PreconditionProblem","exampleIds":["paths/~1balances~1{family}~1actions~1refresh/post/responses/422/content/application~1problem+json/examples/invoice_not_cancellable"]}}},{"code":"429","schemaId":"components/schemas/RateLimitExceededProblem","exampleIds":["paths/~1balances~1{family}~1actions~1refresh/post/responses/429/content/application~1problem+json/examples/refresh_window_full","paths/~1balances~1{family}~1actions~1refresh/post/responses/429/content/application~1problem+json/examples/refresh_prohibited"],"mediaTypes":["application/problem+json"],"mediaTypeContent":{"application/problem+json":{"schemaId":"components/schemas/RateLimitExceededProblem","exampleIds":["paths/~1balances~1{family}~1actions~1refresh/post/responses/429/content/application~1problem+json/examples/refresh_window_full","paths/~1balances~1{family}~1actions~1refresh/post/responses/429/content/application~1problem+json/examples/refresh_prohibited"]}}},{"code":"502","schemaId":"components/schemas/Problem","mediaTypes":["application/problem+json"],"mediaTypeContent":{"application/problem+json":{"schemaId":"components/schemas/Problem"}}},{"code":"503","schemaId":"components/schemas/Problem","exampleIds":["paths/~1balances~1{family}~1actions~1refresh/post/responses/503/content/application~1problem+json/examples/temporarily_unavailable"],"mediaTypes":["application/problem+json"],"mediaTypeContent":{"application/problem+json":{"schemaId":"components/schemas/Problem","exampleIds":["paths/~1balances~1{family}~1actions~1refresh/post/responses/503/content/application~1problem+json/examples/temporarily_unavailable"]}}},{"code":"504","schemaId":"components/schemas/Problem","mediaTypes":["application/problem+json"],"mediaTypeContent":{"application/problem+json":{"schemaId":"components/schemas/Problem"}}},{"code":"default","schemaId":"components/schemas/Problem","mediaTypes":["application/problem+json"],"mediaTypeContent":{"application/problem+json":{"schemaId":"components/schemas/Problem"}}}],"examples":[]}]}]},{"nodeType":"container","children":[{"nodeType":"feedback","pageSlug":"/balance/refresh-balance"}],"panels":[]}]},"httpPath":"/balances/{family}/actions/refresh"}],"content":{"contentType":"group","meta":{"name":"balance"},"children":[{"nodeType":"container","children":[{"nodeType":"header","level":2,"label":"Balances","showPageActions":true},{"nodeType":"markdoc","content":"Search, summarize, and refresh current holdings for tracked addresses, per chain family."}],"panels":[{"children":[{"kind":"group-items","title":"Operations","titleTranslationKey":"operations","items":[{"title":"/balances/{family}/search","summary":"Search balances","prefix":{"name":"post","color":"post"},"badges":[],"link":"/balance/search-balances","deprecated":false},{"title":"/balances/{family}/summary","summary":"Summarize balances","prefix":{"name":"get","color":"get"},"badges":[],"link":"/balance/summarize-balances","deprecated":false},{"title":"/balances/{family}/actions/refresh","summary":"Refresh balance","prefix":{"name":"post","color":"post"},"badges":[],"link":"/balance/refresh-balance","deprecated":false}]}]}]}]}},{"type":"separator","label":"Address Operations","content":null},{"type":"group","label":"Addresses","link":"/apis/platform/api/address","routeSlug":"/apis/platform/api/address","items":[{"label":"List public key addresses","deprecated":false,"httpVerb":"get","isAdditionalOperation":false,"isWebhook":false,"type":"link","link":"/apis/platform/api/address/list-public-key-addresses","routeSlug":"/apis/platform/api/address/list-public-key-addresses","metadata":{"seo":{"title":"List public key addresses","description":"List addresses derived from the public key."}},"content":{"contentType":"item","itemVariant":"httpItem","meta":{"sourceId":"list-public-key-addresses","name":"List public key addresses","isWebhook":false,"pointer":"/paths/~1public-keys~1{public_key_id}~1addresses/get","hasSamples":false},"children":[{"nodeType":"container","children":[{"nodeType":"header","level":2,"label":"List public key addresses","isWebhook":false,"showPageActions":true}],"panels":[]},{"nodeType":"container","children":[{"nodeType":"header","level":4,"label":"Request","labelTranslationKey":"request","deepLinkSuffix":"request"},{"nodeType":"markdoc","content":"List addresses derived from the public key."},{"nodeType":"security","requirements":[{"schemes":[{"name":"Auth","scopes":["api:public_key:read"],"type":"apiKey","in":"header","paramName":"X-Api-Key","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"API key for authenticating requests. Include your key in the "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"X-Api-Key"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" header. Keys can be created in the Vilna Dashboard or via the Management API. The scopes listed per operation indicate which permissions the key must have."},"children":[]}]}]}]}]}]},{"nodeType":"item-content","variant":"path","label":"Path","labelTranslationKey":"path","parameters":[{"name":"public_key_id","in":"path","schemaId":"schema_17","description":"Unique identifier (UUID) of the public key.","required":true}],"pointer":"/paths/~1public-keys~1{public_key_id}~1addresses/get/parameters"},{"nodeType":"item-content","variant":"query","label":"Query","labelTranslationKey":"query","parameters":[{"name":"limit","in":"query","schemaId":"schema_0","description":"Maximum number of items to return."},{"name":"page","in":"query","schemaId":"schema_1","description":"Page number for pagination."},{"name":"sort_by","in":"query","schemaId":"schema_18","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Field to sort results by. Use "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"-"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" prefix for descending order."},"children":[]}]}]}]},{"name":"format","in":"query","style":"form","explode":true,"schemaId":"schema_19","description":"Filter addresses by address format.","example":["p2wpkh"]},{"name":"search","in":"query","schemaId":"schema_20","description":"Filter addresses by value or label (partial match, case-insensitive)."},{"name":"tag_id","in":"query","style":"form","explode":true,"schemaId":"schema_21","description":"Filter addresses by tag identifier (UUID). Repeat the parameter to pass\nmultiple values; addresses tagged with any of them are returned (OR semantics).\n","example":["0199ce7e-d9e7-7c01-9c2a-9d0010eaa1cc"]}],"pointer":"/paths/~1public-keys~1{public_key_id}~1addresses/get/parameters"}],"panels":[{"children":[{"kind":"code-sample","source":{"kind":"code-sample","operationType":"http","method":"GET","path":"/public-keys/{public_key_id}/addresses","servers":[{"url":"/_mock/apis/platform/api","description":"Mock server","isMockServer":true},{"url":"https://api.vilna.io/v2","description":"Vilna API."}],"parameters":{"path":[{"name":"public_key_id","in":"path","required":true,"example":"550e8400-e29b-41d4-a716-446655440000","schemaId":"components/schemas/UUID"}],"query":[{"name":"limit","in":"query","required":false,"example":20,"schemaId":"schema_0"},{"name":"page","in":"query","required":false,"example":1,"schemaId":"schema_1"},{"name":"sort_by","in":"query","required":false,"example":"created_at","schemaId":"schema_18"},{"name":"format","in":"query","required":false,"example":["p2wpkh"],"schemaId":"schema_19","style":"form","explode":true},{"name":"search","in":"query","required":false,"example":"bc1q","schemaId":"schema_20"},{"name":"tag_id","in":"query","required":false,"example":["0199ce7e-d9e7-7c01-9c2a-9d0010eaa1cc"],"schemaId":"schema_21","style":"form","explode":true}],"querystring":[],"header":[],"cookie":[]},"security":[{"schemes":[{"id":"Auth","type":"apiKey","name":"X-Api-Key","in":"header"}],"scopes":["api:public_key:read"]}],"responseCodes":["200","400","401","403","404","503","default"],"pointer":"/public-keys/{public_key_id}/addresses","href":"address/list-public-key-addresses","openApiOperationId":"list-public-key-addresses","summary":"List public key addresses"},"isWebhook":false,"hideReplay":false,"servers":[{"url":"/_mock/apis/platform/api","description":"Mock server","isMockServer":true},{"url":"https://api.vilna.io/v2","description":"Vilna API."}],"examples":[]}]}]},{"nodeType":"container","children":[{"nodeType":"header","level":4,"label":"Responses","labelTranslationKey":"responses","deepLinkSuffix":"responses"},{"nodeType":"item-content","variant":"responses","responses":[{"code":"200","description":"List of addresses derived from the public key.","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"schema_22"}},"schemaId":"schema_22"},{"code":"400","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Bad request (e.g., missing or invalid fields). Invalid text may be reported as address.label_invalid, address.meta_invalid, public_key.label_invalid, invoice.comment_invalid, invoice.metadata_invalid."},"children":[]}]}]}],"mediaType":"application/problem+json","mediaTypes":["application/problem+json"],"mediaTypeContent":{"application/problem+json":{"schemaId":"components/schemas/InvalidRequestProblem","exampleIds":["paths/~1public-keys~1{public_key_id}~1addresses/get/responses/400/content/application~1problem+json/examples/malformed_json"]}},"schemaId":"components/schemas/InvalidRequestProblem","exampleIds":["paths/~1public-keys~1{public_key_id}~1addresses/get/responses/400/content/application~1problem+json/examples/malformed_json"]},{"code":"401","description":"Missing or invalid authentication credentials.","mediaType":"application/problem+json","mediaTypes":["application/problem+json"],"mediaTypeContent":{"application/problem+json":{"schemaId":"components/schemas/UnauthorizedProblem","exampleIds":["paths/~1public-keys~1{public_key_id}~1addresses/get/responses/401/content/application~1problem+json/examples/service_authentication_denied"]}},"schemaId":"components/schemas/UnauthorizedProblem","exampleIds":["paths/~1public-keys~1{public_key_id}~1addresses/get/responses/401/content/application~1problem+json/examples/service_authentication_denied"]},{"code":"403","description":"Insufficient permissions.","mediaType":"application/problem+json","mediaTypes":["application/problem+json"],"mediaTypeContent":{"application/problem+json":{"schemaId":"components/schemas/ForbiddenProblem","exampleIds":["paths/~1public-keys~1{public_key_id}~1addresses/get/responses/403/content/application~1problem+json/examples/insufficient_permissions"]}},"schemaId":"components/schemas/ForbiddenProblem","exampleIds":["paths/~1public-keys~1{public_key_id}~1addresses/get/responses/403/content/application~1problem+json/examples/insufficient_permissions"]},{"code":"404","description":"Requested resource does not exist.","mediaType":"application/problem+json","mediaTypes":["application/problem+json"],"mediaTypeContent":{"application/problem+json":{"schemaId":"components/schemas/NotFoundProblem","exampleIds":["paths/~1public-keys~1{public_key_id}~1addresses/get/responses/404/content/application~1problem+json/examples/address_not_found","paths/~1public-keys~1{public_key_id}~1addresses/get/responses/404/content/application~1problem+json/examples/invoice_not_found"]}},"schemaId":"components/schemas/NotFoundProblem","exampleIds":["paths/~1public-keys~1{public_key_id}~1addresses/get/responses/404/content/application~1problem+json/examples/address_not_found","paths/~1public-keys~1{public_key_id}~1addresses/get/responses/404/content/application~1problem+json/examples/invoice_not_found"]},{"code":"503","description":"The operation is temporarily unavailable. Please try again later.","mediaType":"application/problem+json","mediaTypes":["application/problem+json"],"mediaTypeContent":{"application/problem+json":{"schemaId":"components/schemas/Problem","exampleIds":["paths/~1public-keys~1{public_key_id}~1addresses/get/responses/503/content/application~1problem+json/examples/temporarily_unavailable"]}},"schemaId":"components/schemas/Problem","exampleIds":["paths/~1public-keys~1{public_key_id}~1addresses/get/responses/503/content/application~1problem+json/examples/temporarily_unavailable"]},{"code":"default","description":"Unexpected error.","mediaType":"application/problem+json","mediaTypes":["application/problem+json"],"mediaTypeContent":{"application/problem+json":{"schemaId":"components/schemas/Problem"}},"schemaId":"components/schemas/Problem"}],"pointer":"/paths/~1public-keys~1{public_key_id}~1addresses/get/responses"}],"panels":[{"children":[{"kind":"response","responseCodes":[{"code":"200","schemaId":"schema_22","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"schema_22"}}},{"code":"400","schemaId":"components/schemas/InvalidRequestProblem","exampleIds":["paths/~1public-keys~1{public_key_id}~1addresses/get/responses/400/content/application~1problem+json/examples/malformed_json"],"mediaTypes":["application/problem+json"],"mediaTypeContent":{"application/problem+json":{"schemaId":"components/schemas/InvalidRequestProblem","exampleIds":["paths/~1public-keys~1{public_key_id}~1addresses/get/responses/400/content/application~1problem+json/examples/malformed_json"]}}},{"code":"401","schemaId":"components/schemas/UnauthorizedProblem","exampleIds":["paths/~1public-keys~1{public_key_id}~1addresses/get/responses/401/content/application~1problem+json/examples/service_authentication_denied"],"mediaTypes":["application/problem+json"],"mediaTypeContent":{"application/problem+json":{"schemaId":"components/schemas/UnauthorizedProblem","exampleIds":["paths/~1public-keys~1{public_key_id}~1addresses/get/responses/401/content/application~1problem+json/examples/service_authentication_denied"]}}},{"code":"403","schemaId":"components/schemas/ForbiddenProblem","exampleIds":["paths/~1public-keys~1{public_key_id}~1addresses/get/responses/403/content/application~1problem+json/examples/insufficient_permissions"],"mediaTypes":["application/problem+json"],"mediaTypeContent":{"application/problem+json":{"schemaId":"components/schemas/ForbiddenProblem","exampleIds":["paths/~1public-keys~1{public_key_id}~1addresses/get/responses/403/content/application~1problem+json/examples/insufficient_permissions"]}}},{"code":"404","schemaId":"components/schemas/NotFoundProblem","exampleIds":["paths/~1public-keys~1{public_key_id}~1addresses/get/responses/404/content/application~1problem+json/examples/address_not_found","paths/~1public-keys~1{public_key_id}~1addresses/get/responses/404/content/application~1problem+json/examples/invoice_not_found"],"mediaTypes":["application/problem+json"],"mediaTypeContent":{"application/problem+json":{"schemaId":"components/schemas/NotFoundProblem","exampleIds":["paths/~1public-keys~1{public_key_id}~1addresses/get/responses/404/content/application~1problem+json/examples/address_not_found","paths/~1public-keys~1{public_key_id}~1addresses/get/responses/404/content/application~1problem+json/examples/invoice_not_found"]}}},{"code":"503","schemaId":"components/schemas/Problem","exampleIds":["paths/~1public-keys~1{public_key_id}~1addresses/get/responses/503/content/application~1problem+json/examples/temporarily_unavailable"],"mediaTypes":["application/problem+json"],"mediaTypeContent":{"application/problem+json":{"schemaId":"components/schemas/Problem","exampleIds":["paths/~1public-keys~1{public_key_id}~1addresses/get/responses/503/content/application~1problem+json/examples/temporarily_unavailable"]}}},{"code":"default","schemaId":"components/schemas/Problem","mediaTypes":["application/problem+json"],"mediaTypeContent":{"application/problem+json":{"schemaId":"components/schemas/Problem"}}}],"examples":[]}]}]},{"nodeType":"container","children":[{"nodeType":"feedback","pageSlug":"/address/list-public-key-addresses"}],"panels":[]}]},"httpPath":"/public-keys/{public_key_id}/addresses"},{"label":"Generate public key addresses","deprecated":false,"httpVerb":"post","isAdditionalOperation":false,"isWebhook":false,"type":"link","link":"/apis/platform/api/address/generate-public-key-addresses","routeSlug":"/apis/platform/api/address/generate-public-key-addresses","metadata":{"seo":{"title":"Generate public key addresses","description":"Generate addresses for the public key, either a range of derivation indexes or the next unused one. An index that already has an address is returned unchanged; label and meta apply only to the addresses this call creates. Answers 200 when nothing was created and 201 when at least one address was. next is one past the highest index generated for this key and chain family; two independent next intents get distinct indexes. Retrying the same intent with the same Idempotency-Key returns its original addresses while replay is available."}},"content":{"contentType":"item","itemVariant":"httpItem","meta":{"sourceId":"generate-public-key-addresses","name":"Generate public key addresses","isWebhook":false,"pointer":"/paths/~1public-keys~1{public_key_id}~1addresses/post","hasSamples":true},"children":[{"nodeType":"container","children":[{"nodeType":"header","level":2,"label":"Generate public key addresses","isWebhook":false,"showPageActions":true}],"panels":[]},{"nodeType":"container","children":[{"nodeType":"header","level":4,"label":"Request","labelTranslationKey":"request","deepLinkSuffix":"request"},{"nodeType":"markdoc","content":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Generate addresses for the public key, either a range of derivation indexes or the next unused one. An index that already has an address is returned unchanged; "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"label"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" and "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"meta"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" apply only to the addresses this call creates. Answers 200 when nothing was created and 201 when at least one address was. "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"next"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" is one past the highest index generated for this key and chain family; two independent "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"next"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" intents get distinct indexes. Retrying the same intent with the same Idempotency-Key returns its original addresses while replay is available."},"children":[]}]}]}]},{"nodeType":"security","requirements":[{"schemes":[{"name":"Auth","scopes":["api:address:write"],"type":"apiKey","in":"header","paramName":"X-Api-Key","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"API key for authenticating requests. Include your key in the "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"X-Api-Key"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" header. Keys can be created in the Vilna Dashboard or via the Management API. The scopes listed per operation indicate which permissions the key must have."},"children":[]}]}]}]}]}]},{"nodeType":"item-content","variant":"path","label":"Path","labelTranslationKey":"path","parameters":[{"name":"public_key_id","in":"path","schemaId":"schema_17","description":"Unique identifier (UUID) of the public key.","required":true}],"pointer":"/paths/~1public-keys~1{public_key_id}~1addresses/post/parameters"},{"nodeType":"item-content","variant":"headers","label":"Headers","labelTranslationKey":"header","parameters":[{"name":"Idempotency-Key","in":"header","schemaId":"schema_14","description":"Case-sensitive opaque key for one mutation intent. Send exactly one header occurrence containing 1 to 128 visible ASCII bytes (0x21..0x7e). Commas are literal data; do not trim, lowercase or require UUID syntax. Reuse the same key for retries, with current authorization checked on every attempt. Repeated header occurrences are rejected.\n","required":true}],"pointer":"/paths/~1public-keys~1{public_key_id}~1addresses/post/parameters"},{"nodeType":"item-content","variant":"body","label":"Request Body","labelTranslationKey":"body","required":true,"mediaTypes":["application/json"],"mediaTypeSchemas":{"application/json":{"schemaId":"components/schemas/GenerateHDAddressesRequest","exampleIds":["paths/~1public-keys~1{public_key_id}~1addresses/post/requestBody/content/application~1json/examples/next_address","paths/~1public-keys~1{public_key_id}~1addresses/post/requestBody/content/application~1json/examples/index_range"]}},"schemaId":"components/schemas/GenerateHDAddressesRequest","exampleIds":["paths/~1public-keys~1{public_key_id}~1addresses/post/requestBody/content/application~1json/examples/next_address","paths/~1public-keys~1{public_key_id}~1addresses/post/requestBody/content/application~1json/examples/index_range"],"pointer":"/paths/~1public-keys~1{public_key_id}~1addresses/post/requestBody"}],"panels":[{"children":[{"kind":"code-sample","source":{"kind":"code-sample","operationType":"http","method":"POST","path":"/public-keys/{public_key_id}/addresses","servers":[{"url":"/_mock/apis/platform/api","description":"Mock server","isMockServer":true},{"url":"https://api.vilna.io/v2","description":"Vilna API."}],"parameters":{"path":[{"name":"public_key_id","in":"path","required":true,"example":"550e8400-e29b-41d4-a716-446655440000","schemaId":"components/schemas/UUID"}],"query":[],"querystring":[],"header":[{"name":"Idempotency-Key","in":"header","required":true,"schemaId":"schema_14"}],"cookie":[]},"security":[{"schemes":[{"id":"Auth","type":"apiKey","name":"X-Api-Key","in":"header"}],"scopes":["api:address:write"]}],"requestBody":{"application/json":{"schemaId":"components/schemas/GenerateHDAddressesRequest","exampleIds":["paths/~1public-keys~1{public_key_id}~1addresses/post/requestBody/content/application~1json/examples/next_address","paths/~1public-keys~1{public_key_id}~1addresses/post/requestBody/content/application~1json/examples/index_range"]}},"responseCodes":["200","201","400","401","403","404","409","422","429","503","default"],"pointer":"/public-keys/{public_key_id}/addresses","href":"address/generate-public-key-addresses","openApiOperationId":"generate-public-key-addresses","summary":"Generate public key addresses"},"isWebhook":false,"hideReplay":false,"servers":[{"url":"/_mock/apis/platform/api","description":"Mock server","isMockServer":true},{"url":"https://api.vilna.io/v2","description":"Vilna API."}],"schemaId":"components/schemas/GenerateHDAddressesRequest","exampleIds":["paths/~1public-keys~1{public_key_id}~1addresses/post/requestBody/content/application~1json/examples/next_address","paths/~1public-keys~1{public_key_id}~1addresses/post/requestBody/content/application~1json/examples/index_range"],"mediaTypes":["application/json"],"mediaTypeSchemas":{"application/json":{"schemaId":"components/schemas/GenerateHDAddressesRequest","exampleIds":["paths/~1public-keys~1{public_key_id}~1addresses/post/requestBody/content/application~1json/examples/next_address","paths/~1public-keys~1{public_key_id}~1addresses/post/requestBody/content/application~1json/examples/index_range"]}},"examples":[{},{}]}]}]},{"nodeType":"container","children":[{"nodeType":"header","level":4,"label":"Responses","labelTranslationKey":"responses","deepLinkSuffix":"responses"},{"nodeType":"item-content","variant":"responses","responses":[{"code":"200","description":"The generated addresses, in derivation-index order.","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"schema_23"}},"schemaId":"schema_23"},{"code":"201","description":"The generated addresses, in derivation-index order.","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"schema_23"}},"schemaId":"schema_23"},{"code":"400","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Bad request (e.g., missing or invalid fields). Invalid text may be reported as address.label_invalid, address.meta_invalid, public_key.label_invalid, invoice.comment_invalid, invoice.metadata_invalid."},"children":[]}]}]}],"mediaType":"application/problem+json","mediaTypes":["application/problem+json"],"mediaTypeContent":{"application/problem+json":{"schemaId":"components/schemas/InvalidRequestProblem","exampleIds":["paths/~1public-keys~1{public_key_id}~1addresses/post/responses/400/content/application~1problem+json/examples/malformed_json"]}},"schemaId":"components/schemas/InvalidRequestProblem","exampleIds":["paths/~1public-keys~1{public_key_id}~1addresses/post/responses/400/content/application~1problem+json/examples/malformed_json"]},{"code":"401","description":"Missing or invalid authentication credentials.","mediaType":"application/problem+json","mediaTypes":["application/problem+json"],"mediaTypeContent":{"application/problem+json":{"schemaId":"components/schemas/UnauthorizedProblem","exampleIds":["paths/~1public-keys~1{public_key_id}~1addresses/post/responses/401/content/application~1problem+json/examples/service_authentication_denied"]}},"schemaId":"components/schemas/UnauthorizedProblem","exampleIds":["paths/~1public-keys~1{public_key_id}~1addresses/post/responses/401/content/application~1problem+json/examples/service_authentication_denied"]},{"code":"403","description":"Insufficient permissions.","mediaType":"application/problem+json","mediaTypes":["application/problem+json"],"mediaTypeContent":{"application/problem+json":{"schemaId":"components/schemas/ForbiddenProblem","exampleIds":["paths/~1public-keys~1{public_key_id}~1addresses/post/responses/403/content/application~1problem+json/examples/insufficient_permissions"]}},"schemaId":"components/schemas/ForbiddenProblem","exampleIds":["paths/~1public-keys~1{public_key_id}~1addresses/post/responses/403/content/application~1problem+json/examples/insufficient_permissions"]},{"code":"404","description":"Requested resource does not exist.","mediaType":"application/problem+json","mediaTypes":["application/problem+json"],"mediaTypeContent":{"application/problem+json":{"schemaId":"components/schemas/NotFoundProblem","exampleIds":["paths/~1public-keys~1{public_key_id}~1addresses/post/responses/404/content/application~1problem+json/examples/address_not_found","paths/~1public-keys~1{public_key_id}~1addresses/post/responses/404/content/application~1problem+json/examples/invoice_not_found"]}},"schemaId":"components/schemas/NotFoundProblem","exampleIds":["paths/~1public-keys~1{public_key_id}~1addresses/post/responses/404/content/application~1problem+json/examples/address_not_found","paths/~1public-keys~1{public_key_id}~1addresses/post/responses/404/content/application~1problem+json/examples/invoice_not_found"]},{"code":"409","description":"Request conflicts with the current resource state.","mediaType":"application/problem+json","mediaTypes":["application/problem+json"],"mediaTypeContent":{"application/problem+json":{"schemaId":"components/schemas/ConflictProblem","exampleIds":["paths/~1public-keys~1{public_key_id}~1addresses/post/responses/409/content/application~1problem+json/examples/address_occupied","paths/~1public-keys~1{public_key_id}~1addresses/post/responses/409/content/application~1problem+json/examples/address_in_use","paths/~1public-keys~1{public_key_id}~1addresses/post/responses/409/content/application~1problem+json/examples/subscription_v1_conflict","paths/~1public-keys~1{public_key_id}~1addresses/post/responses/409/content/application~1problem+json/examples/notification_send_in_progress","paths/~1public-keys~1{public_key_id}~1addresses/post/responses/409/content/application~1problem+json/examples/notification_payload_unavailable","paths/~1public-keys~1{public_key_id}~1addresses/post/responses/409/content/application~1problem+json/examples/notification_test_resend_not_allowed"]}},"schemaId":"components/schemas/ConflictProblem","exampleIds":["paths/~1public-keys~1{public_key_id}~1addresses/post/responses/409/content/application~1problem+json/examples/address_occupied","paths/~1public-keys~1{public_key_id}~1addresses/post/responses/409/content/application~1problem+json/examples/address_in_use","paths/~1public-keys~1{public_key_id}~1addresses/post/responses/409/content/application~1problem+json/examples/subscription_v1_conflict","paths/~1public-keys~1{public_key_id}~1addresses/post/responses/409/content/application~1problem+json/examples/notification_send_in_progress","paths/~1public-keys~1{public_key_id}~1addresses/post/responses/409/content/application~1problem+json/examples/notification_payload_unavailable","paths/~1public-keys~1{public_key_id}~1addresses/post/responses/409/content/application~1problem+json/examples/notification_test_resend_not_allowed"]},{"code":"422","description":"Request preconditions were not met.","mediaType":"application/problem+json","mediaTypes":["application/problem+json"],"mediaTypeContent":{"application/problem+json":{"schemaId":"components/schemas/PreconditionProblem","exampleIds":["paths/~1public-keys~1{public_key_id}~1addresses/post/responses/422/content/application~1problem+json/examples/invoice_not_cancellable"]}},"schemaId":"components/schemas/PreconditionProblem","exampleIds":["paths/~1public-keys~1{public_key_id}~1addresses/post/responses/422/content/application~1problem+json/examples/invoice_not_cancellable"]},{"code":"429","description":"Resource quota exceeded. The response includes the effective limit for this scope. The applicable code and limit depend on the operation; examples illustrate different limits.","mediaType":"application/problem+json","mediaTypes":["application/problem+json"],"mediaTypeContent":{"application/problem+json":{"schemaId":"components/schemas/QuotaExceededProblem","exampleIds":["paths/~1public-keys~1{public_key_id}~1addresses/post/responses/429/content/application~1problem+json/examples/address_quota","paths/~1public-keys~1{public_key_id}~1addresses/post/responses/429/content/application~1problem+json/examples/creation_prohibited"]}},"schemaId":"components/schemas/QuotaExceededProblem","exampleIds":["paths/~1public-keys~1{public_key_id}~1addresses/post/responses/429/content/application~1problem+json/examples/address_quota","paths/~1public-keys~1{public_key_id}~1addresses/post/responses/429/content/application~1problem+json/examples/creation_prohibited"]},{"code":"503","description":"The operation is temporarily unavailable. Please try again later.","mediaType":"application/problem+json","mediaTypes":["application/problem+json"],"mediaTypeContent":{"application/problem+json":{"schemaId":"components/schemas/Problem","exampleIds":["paths/~1public-keys~1{public_key_id}~1addresses/post/responses/503/content/application~1problem+json/examples/temporarily_unavailable"]}},"schemaId":"components/schemas/Problem","exampleIds":["paths/~1public-keys~1{public_key_id}~1addresses/post/responses/503/content/application~1problem+json/examples/temporarily_unavailable"]},{"code":"default","description":"Unexpected error.","mediaType":"application/problem+json","mediaTypes":["application/problem+json"],"mediaTypeContent":{"application/problem+json":{"schemaId":"components/schemas/Problem"}},"schemaId":"components/schemas/Problem"}],"pointer":"/paths/~1public-keys~1{public_key_id}~1addresses/post/responses"}],"panels":[{"children":[{"kind":"response","responseCodes":[{"code":"200","schemaId":"schema_23","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"schema_23"}}},{"code":"201","schemaId":"schema_23","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"schema_23"}}},{"code":"400","schemaId":"components/schemas/InvalidRequestProblem","exampleIds":["paths/~1public-keys~1{public_key_id}~1addresses/post/responses/400/content/application~1problem+json/examples/malformed_json"],"mediaTypes":["application/problem+json"],"mediaTypeContent":{"application/problem+json":{"schemaId":"components/schemas/InvalidRequestProblem","exampleIds":["paths/~1public-keys~1{public_key_id}~1addresses/post/responses/400/content/application~1problem+json/examples/malformed_json"]}}},{"code":"401","schemaId":"components/schemas/UnauthorizedProblem","exampleIds":["paths/~1public-keys~1{public_key_id}~1addresses/post/responses/401/content/application~1problem+json/examples/service_authentication_denied"],"mediaTypes":["application/problem+json"],"mediaTypeContent":{"application/problem+json":{"schemaId":"components/schemas/UnauthorizedProblem","exampleIds":["paths/~1public-keys~1{public_key_id}~1addresses/post/responses/401/content/application~1problem+json/examples/service_authentication_denied"]}}},{"code":"403","schemaId":"components/schemas/ForbiddenProblem","exampleIds":["paths/~1public-keys~1{public_key_id}~1addresses/post/responses/403/content/application~1problem+json/examples/insufficient_permissions"],"mediaTypes":["application/problem+json"],"mediaTypeContent":{"application/problem+json":{"schemaId":"components/schemas/ForbiddenProblem","exampleIds":["paths/~1public-keys~1{public_key_id}~1addresses/post/responses/403/content/application~1problem+json/examples/insufficient_permissions"]}}},{"code":"404","schemaId":"components/schemas/NotFoundProblem","exampleIds":["paths/~1public-keys~1{public_key_id}~1addresses/post/responses/404/content/application~1problem+json/examples/address_not_found","paths/~1public-keys~1{public_key_id}~1addresses/post/responses/404/content/application~1problem+json/examples/invoice_not_found"],"mediaTypes":["application/problem+json"],"mediaTypeContent":{"application/problem+json":{"schemaId":"components/schemas/NotFoundProblem","exampleIds":["paths/~1public-keys~1{public_key_id}~1addresses/post/responses/404/content/application~1problem+json/examples/address_not_found","paths/~1public-keys~1{public_key_id}~1addresses/post/responses/404/content/application~1problem+json/examples/invoice_not_found"]}}},{"code":"409","schemaId":"components/schemas/ConflictProblem","exampleIds":["paths/~1public-keys~1{public_key_id}~1addresses/post/responses/409/content/application~1problem+json/examples/address_occupied","paths/~1public-keys~1{public_key_id}~1addresses/post/responses/409/content/application~1problem+json/examples/address_in_use","paths/~1public-keys~1{public_key_id}~1addresses/post/responses/409/content/application~1problem+json/examples/subscription_v1_conflict","paths/~1public-keys~1{public_key_id}~1addresses/post/responses/409/content/application~1problem+json/examples/notification_send_in_progress","paths/~1public-keys~1{public_key_id}~1addresses/post/responses/409/content/application~1problem+json/examples/notification_payload_unavailable","paths/~1public-keys~1{public_key_id}~1addresses/post/responses/409/content/application~1problem+json/examples/notification_test_resend_not_allowed"],"mediaTypes":["application/problem+json"],"mediaTypeContent":{"application/problem+json":{"schemaId":"components/schemas/ConflictProblem","exampleIds":["paths/~1public-keys~1{public_key_id}~1addresses/post/responses/409/content/application~1problem+json/examples/address_occupied","paths/~1public-keys~1{public_key_id}~1addresses/post/responses/409/content/application~1problem+json/examples/address_in_use","paths/~1public-keys~1{public_key_id}~1addresses/post/responses/409/content/application~1problem+json/examples/subscription_v1_conflict","paths/~1public-keys~1{public_key_id}~1addresses/post/responses/409/content/application~1problem+json/examples/notification_send_in_progress","paths/~1public-keys~1{public_key_id}~1addresses/post/responses/409/content/application~1problem+json/examples/notification_payload_unavailable","paths/~1public-keys~1{public_key_id}~1addresses/post/responses/409/content/application~1problem+json/examples/notification_test_resend_not_allowed"]}}},{"code":"422","schemaId":"components/schemas/PreconditionProblem","exampleIds":["paths/~1public-keys~1{public_key_id}~1addresses/post/responses/422/content/application~1problem+json/examples/invoice_not_cancellable"],"mediaTypes":["application/problem+json"],"mediaTypeContent":{"application/problem+json":{"schemaId":"components/schemas/PreconditionProblem","exampleIds":["paths/~1public-keys~1{public_key_id}~1addresses/post/responses/422/content/application~1problem+json/examples/invoice_not_cancellable"]}}},{"code":"429","schemaId":"components/schemas/QuotaExceededProblem","exampleIds":["paths/~1public-keys~1{public_key_id}~1addresses/post/responses/429/content/application~1problem+json/examples/address_quota","paths/~1public-keys~1{public_key_id}~1addresses/post/responses/429/content/application~1problem+json/examples/creation_prohibited"],"mediaTypes":["application/problem+json"],"mediaTypeContent":{"application/problem+json":{"schemaId":"components/schemas/QuotaExceededProblem","exampleIds":["paths/~1public-keys~1{public_key_id}~1addresses/post/responses/429/content/application~1problem+json/examples/address_quota","paths/~1public-keys~1{public_key_id}~1addresses/post/responses/429/content/application~1problem+json/examples/creation_prohibited"]}}},{"code":"503","schemaId":"components/schemas/Problem","exampleIds":["paths/~1public-keys~1{public_key_id}~1addresses/post/responses/503/content/application~1problem+json/examples/temporarily_unavailable"],"mediaTypes":["application/problem+json"],"mediaTypeContent":{"application/problem+json":{"schemaId":"components/schemas/Problem","exampleIds":["paths/~1public-keys~1{public_key_id}~1addresses/post/responses/503/content/application~1problem+json/examples/temporarily_unavailable"]}}},{"code":"default","schemaId":"components/schemas/Problem","mediaTypes":["application/problem+json"],"mediaTypeContent":{"application/problem+json":{"schemaId":"components/schemas/Problem"}}}],"examples":[]}]}]},{"nodeType":"container","children":[{"nodeType":"feedback","pageSlug":"/address/generate-public-key-addresses"}],"panels":[]}]},"httpPath":"/public-keys/{public_key_id}/addresses"},{"label":"List addresses","deprecated":false,"httpVerb":"get","isAdditionalOperation":false,"isWebhook":false,"type":"link","link":"/apis/platform/api/address/list-addresses","routeSlug":"/apis/platform/api/address/list-addresses","metadata":{"seo":{"title":"List addresses","description":"List tracked addresses (HD and external) with filtering and pagination."}},"content":{"contentType":"item","itemVariant":"httpItem","meta":{"sourceId":"list-addresses","name":"List addresses","isWebhook":false,"pointer":"/paths/~1addresses/get","hasSamples":false},"children":[{"nodeType":"container","children":[{"nodeType":"header","level":2,"label":"List addresses","isWebhook":false,"showPageActions":true}],"panels":[]},{"nodeType":"container","children":[{"nodeType":"header","level":4,"label":"Request","labelTranslationKey":"request","deepLinkSuffix":"request"},{"nodeType":"markdoc","content":"List tracked addresses (HD and external) with filtering and pagination."},{"nodeType":"security","requirements":[{"schemes":[{"name":"Auth","scopes":["api:address:read"],"type":"apiKey","in":"header","paramName":"X-Api-Key","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"API key for authenticating requests. Include your key in the "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"X-Api-Key"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" header. Keys can be created in the Vilna Dashboard or via the Management API. The scopes listed per operation indicate which permissions the key must have."},"children":[]}]}]}]}]}]},{"nodeType":"item-content","variant":"query","label":"Query","labelTranslationKey":"query","parameters":[{"name":"limit","in":"query","schemaId":"schema_0","description":"Maximum number of items to return."},{"name":"page","in":"query","schemaId":"schema_1","description":"Page number for pagination."},{"name":"sort_by","in":"query","schemaId":"schema_18","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Field to sort results by. Use "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"-"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" prefix for descending order."},"children":[]}]}]}]},{"name":"format","in":"query","style":"form","explode":true,"schemaId":"schema_19","description":"Filter addresses by address format.","example":["p2wpkh"]},{"name":"search","in":"query","schemaId":"schema_20","description":"Filter addresses by value or label (partial match, case-insensitive)."},{"name":"kind","in":"query","schemaId":"schema_24","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Filter by address kind ("},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"hd"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" or "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"external"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":")."},"children":[]}]}]}]},{"name":"tag_id","in":"query","style":"form","explode":true,"schemaId":"schema_21","description":"Filter addresses by tag identifier (UUID). Repeat the parameter to pass\nmultiple values; addresses tagged with any of them are returned (OR semantics).\n","example":["0199ce7e-d9e7-7c01-9c2a-9d0010eaa1cc"]}],"pointer":"/paths/~1addresses/get/parameters"}],"panels":[{"children":[{"kind":"code-sample","source":{"kind":"code-sample","operationType":"http","method":"GET","path":"/addresses","servers":[{"url":"/_mock/apis/platform/api","description":"Mock server","isMockServer":true},{"url":"https://api.vilna.io/v2","description":"Vilna API."}],"parameters":{"path":[],"query":[{"name":"limit","in":"query","required":false,"example":20,"schemaId":"schema_0"},{"name":"page","in":"query","required":false,"example":1,"schemaId":"schema_1"},{"name":"sort_by","in":"query","required":false,"example":"created_at","schemaId":"schema_18"},{"name":"format","in":"query","required":false,"example":["p2wpkh"],"schemaId":"schema_19","style":"form","explode":true},{"name":"search","in":"query","required":false,"example":"bc1q","schemaId":"schema_20"},{"name":"kind","in":"query","required":false,"example":"hd","schemaId":"components/schemas/AddressKind"},{"name":"tag_id","in":"query","required":false,"example":["0199ce7e-d9e7-7c01-9c2a-9d0010eaa1cc"],"schemaId":"schema_21","style":"form","explode":true}],"querystring":[],"header":[],"cookie":[]},"security":[{"schemes":[{"id":"Auth","type":"apiKey","name":"X-Api-Key","in":"header"}],"scopes":["api:address:read"]}],"responseCodes":["200","400","401","403","503","default"],"pointer":"/addresses","href":"address/list-addresses","openApiOperationId":"list-addresses","summary":"List addresses"},"isWebhook":false,"hideReplay":false,"servers":[{"url":"/_mock/apis/platform/api","description":"Mock server","isMockServer":true},{"url":"https://api.vilna.io/v2","description":"Vilna API."}],"examples":[]}]}]},{"nodeType":"container","children":[{"nodeType":"header","level":4,"label":"Responses","labelTranslationKey":"responses","deepLinkSuffix":"responses"},{"nodeType":"item-content","variant":"responses","responses":[{"code":"200","description":"List of addresses.","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"schema_25"}},"schemaId":"schema_25"},{"code":"400","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Bad request (e.g., missing or invalid fields). Invalid text may be reported as address.label_invalid, address.meta_invalid, public_key.label_invalid, invoice.comment_invalid, invoice.metadata_invalid."},"children":[]}]}]}],"mediaType":"application/problem+json","mediaTypes":["application/problem+json"],"mediaTypeContent":{"application/problem+json":{"schemaId":"components/schemas/InvalidRequestProblem","exampleIds":["paths/~1addresses/get/responses/400/content/application~1problem+json/examples/malformed_json"]}},"schemaId":"components/schemas/InvalidRequestProblem","exampleIds":["paths/~1addresses/get/responses/400/content/application~1problem+json/examples/malformed_json"]},{"code":"401","description":"Missing or invalid authentication credentials.","mediaType":"application/problem+json","mediaTypes":["application/problem+json"],"mediaTypeContent":{"application/problem+json":{"schemaId":"components/schemas/UnauthorizedProblem","exampleIds":["paths/~1addresses/get/responses/401/content/application~1problem+json/examples/service_authentication_denied"]}},"schemaId":"components/schemas/UnauthorizedProblem","exampleIds":["paths/~1addresses/get/responses/401/content/application~1problem+json/examples/service_authentication_denied"]},{"code":"403","description":"Insufficient permissions.","mediaType":"application/problem+json","mediaTypes":["application/problem+json"],"mediaTypeContent":{"application/problem+json":{"schemaId":"components/schemas/ForbiddenProblem","exampleIds":["paths/~1addresses/get/responses/403/content/application~1problem+json/examples/insufficient_permissions"]}},"schemaId":"components/schemas/ForbiddenProblem","exampleIds":["paths/~1addresses/get/responses/403/content/application~1problem+json/examples/insufficient_permissions"]},{"code":"503","description":"The operation is temporarily unavailable. Please try again later.","mediaType":"application/problem+json","mediaTypes":["application/problem+json"],"mediaTypeContent":{"application/problem+json":{"schemaId":"components/schemas/Problem","exampleIds":["paths/~1addresses/get/responses/503/content/application~1problem+json/examples/temporarily_unavailable"]}},"schemaId":"components/schemas/Problem","exampleIds":["paths/~1addresses/get/responses/503/content/application~1problem+json/examples/temporarily_unavailable"]},{"code":"default","description":"Unexpected error.","mediaType":"application/problem+json","mediaTypes":["application/problem+json"],"mediaTypeContent":{"application/problem+json":{"schemaId":"components/schemas/Problem"}},"schemaId":"components/schemas/Problem"}],"pointer":"/paths/~1addresses/get/responses"}],"panels":[{"children":[{"kind":"response","responseCodes":[{"code":"200","schemaId":"schema_25","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"schema_25"}}},{"code":"400","schemaId":"components/schemas/InvalidRequestProblem","exampleIds":["paths/~1addresses/get/responses/400/content/application~1problem+json/examples/malformed_json"],"mediaTypes":["application/problem+json"],"mediaTypeContent":{"application/problem+json":{"schemaId":"components/schemas/InvalidRequestProblem","exampleIds":["paths/~1addresses/get/responses/400/content/application~1problem+json/examples/malformed_json"]}}},{"code":"401","schemaId":"components/schemas/UnauthorizedProblem","exampleIds":["paths/~1addresses/get/responses/401/content/application~1problem+json/examples/service_authentication_denied"],"mediaTypes":["application/problem+json"],"mediaTypeContent":{"application/problem+json":{"schemaId":"components/schemas/UnauthorizedProblem","exampleIds":["paths/~1addresses/get/responses/401/content/application~1problem+json/examples/service_authentication_denied"]}}},{"code":"403","schemaId":"components/schemas/ForbiddenProblem","exampleIds":["paths/~1addresses/get/responses/403/content/application~1problem+json/examples/insufficient_permissions"],"mediaTypes":["application/problem+json"],"mediaTypeContent":{"application/problem+json":{"schemaId":"components/schemas/ForbiddenProblem","exampleIds":["paths/~1addresses/get/responses/403/content/application~1problem+json/examples/insufficient_permissions"]}}},{"code":"503","schemaId":"components/schemas/Problem","exampleIds":["paths/~1addresses/get/responses/503/content/application~1problem+json/examples/temporarily_unavailable"],"mediaTypes":["application/problem+json"],"mediaTypeContent":{"application/problem+json":{"schemaId":"components/schemas/Problem","exampleIds":["paths/~1addresses/get/responses/503/content/application~1problem+json/examples/temporarily_unavailable"]}}},{"code":"default","schemaId":"components/schemas/Problem","mediaTypes":["application/problem+json"],"mediaTypeContent":{"application/problem+json":{"schemaId":"components/schemas/Problem"}}}],"examples":[]}]}]},{"nodeType":"container","children":[{"nodeType":"feedback","pageSlug":"/address/list-addresses"}],"panels":[]}]},"httpPath":"/addresses"},{"label":"Create external address","deprecated":false,"httpVerb":"post","isAdditionalOperation":false,"isWebhook":false,"type":"link","link":"/apis/platform/api/address/create-external-address","routeSlug":"/apis/platform/api/address/create-external-address","metadata":{"seo":{"title":"Create external address","description":"Import an externally managed address for tracking, given the address itself or the raw public key it derives from. Answers 200 with the existing address when the value is already tracked, 201 when it was created."}},"content":{"contentType":"item","itemVariant":"httpItem","meta":{"sourceId":"create-external-address","name":"Create external address","isWebhook":false,"pointer":"/paths/~1addresses~1external/post","hasSamples":true},"children":[{"nodeType":"container","children":[{"nodeType":"header","level":2,"label":"Create external address","isWebhook":false,"showPageActions":true}],"panels":[]},{"nodeType":"container","children":[{"nodeType":"header","level":4,"label":"Request","labelTranslationKey":"request","deepLinkSuffix":"request"},{"nodeType":"markdoc","content":"Import an externally managed address for tracking, given the address itself or the raw public key it derives from. Answers 200 with the existing address when the value is already tracked, 201 when it was created."},{"nodeType":"security","requirements":[{"schemes":[{"name":"Auth","scopes":["api:address:write"],"type":"apiKey","in":"header","paramName":"X-Api-Key","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"API key for authenticating requests. Include your key in the "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"X-Api-Key"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" header. Keys can be created in the Vilna Dashboard or via the Management API. The scopes listed per operation indicate which permissions the key must have."},"children":[]}]}]}]}]}]},{"nodeType":"item-content","variant":"headers","label":"Headers","labelTranslationKey":"header","parameters":[{"name":"Idempotency-Key","in":"header","schemaId":"schema_14","description":"Case-sensitive opaque key for one mutation intent. Send exactly one header occurrence containing 1 to 128 visible ASCII bytes (0x21..0x7e). Commas are literal data; do not trim, lowercase or require UUID syntax. Reuse the same key for retries, with current authorization checked on every attempt. Repeated header occurrences are rejected.\n","required":true}],"pointer":"/paths/~1addresses~1external/post/parameters"},{"nodeType":"item-content","variant":"body","label":"Request Body","labelTranslationKey":"body","required":true,"mediaTypes":["application/json"],"mediaTypeSchemas":{"application/json":{"schemaId":"components/schemas/CreateExternalAddressRequest","exampleIds":["paths/~1addresses~1external/post/requestBody/content/application~1json/examples/from_address","paths/~1addresses~1external/post/requestBody/content/application~1json/examples/from_public_key"]}},"schemaId":"components/schemas/CreateExternalAddressRequest","exampleIds":["paths/~1addresses~1external/post/requestBody/content/application~1json/examples/from_address","paths/~1addresses~1external/post/requestBody/content/application~1json/examples/from_public_key"],"pointer":"/paths/~1addresses~1external/post/requestBody"}],"panels":[{"children":[{"kind":"code-sample","source":{"kind":"code-sample","operationType":"http","method":"POST","path":"/addresses/external","servers":[{"url":"/_mock/apis/platform/api","description":"Mock server","isMockServer":true},{"url":"https://api.vilna.io/v2","description":"Vilna API."}],"parameters":{"path":[],"query":[],"querystring":[],"header":[{"name":"Idempotency-Key","in":"header","required":true,"schemaId":"schema_14"}],"cookie":[]},"security":[{"schemes":[{"id":"Auth","type":"apiKey","name":"X-Api-Key","in":"header"}],"scopes":["api:address:write"]}],"requestBody":{"application/json":{"schemaId":"components/schemas/CreateExternalAddressRequest","exampleIds":["paths/~1addresses~1external/post/requestBody/content/application~1json/examples/from_address","paths/~1addresses~1external/post/requestBody/content/application~1json/examples/from_public_key"]}},"responseCodes":["200","201","400","401","403","409","429","503","default"],"pointer":"/addresses/external","href":"address/create-external-address","openApiOperationId":"create-external-address","summary":"Create external address"},"isWebhook":false,"hideReplay":false,"servers":[{"url":"/_mock/apis/platform/api","description":"Mock server","isMockServer":true},{"url":"https://api.vilna.io/v2","description":"Vilna API."}],"schemaId":"components/schemas/CreateExternalAddressRequest","exampleIds":["paths/~1addresses~1external/post/requestBody/content/application~1json/examples/from_address","paths/~1addresses~1external/post/requestBody/content/application~1json/examples/from_public_key"],"mediaTypes":["application/json"],"mediaTypeSchemas":{"application/json":{"schemaId":"components/schemas/CreateExternalAddressRequest","exampleIds":["paths/~1addresses~1external/post/requestBody/content/application~1json/examples/from_address","paths/~1addresses~1external/post/requestBody/content/application~1json/examples/from_public_key"]}},"examples":[{},{}]}]}]},{"nodeType":"container","children":[{"nodeType":"header","level":4,"label":"Responses","labelTranslationKey":"responses","deepLinkSuffix":"responses"},{"nodeType":"item-content","variant":"responses","responses":[{"code":"200","description":"Created external address.","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"schema_26"}},"schemaId":"schema_26"},{"code":"201","description":"Created external address.","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"schema_26"}},"schemaId":"schema_26"},{"code":"400","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Bad request (e.g., missing or invalid fields). Invalid text may be reported as address.label_invalid, address.meta_invalid, public_key.label_invalid, invoice.comment_invalid, invoice.metadata_invalid."},"children":[]}]}]}],"mediaType":"application/problem+json","mediaTypes":["application/problem+json"],"mediaTypeContent":{"application/problem+json":{"schemaId":"components/schemas/InvalidRequestProblem","exampleIds":["paths/~1addresses~1external/post/responses/400/content/application~1problem+json/examples/malformed_json"]}},"schemaId":"components/schemas/InvalidRequestProblem","exampleIds":["paths/~1addresses~1external/post/responses/400/content/application~1problem+json/examples/malformed_json"]},{"code":"401","description":"Missing or invalid authentication credentials.","mediaType":"application/problem+json","mediaTypes":["application/problem+json"],"mediaTypeContent":{"application/problem+json":{"schemaId":"components/schemas/UnauthorizedProblem","exampleIds":["paths/~1addresses~1external/post/responses/401/content/application~1problem+json/examples/service_authentication_denied"]}},"schemaId":"components/schemas/UnauthorizedProblem","exampleIds":["paths/~1addresses~1external/post/responses/401/content/application~1problem+json/examples/service_authentication_denied"]},{"code":"403","description":"Insufficient permissions.","mediaType":"application/problem+json","mediaTypes":["application/problem+json"],"mediaTypeContent":{"application/problem+json":{"schemaId":"components/schemas/ForbiddenProblem","exampleIds":["paths/~1addresses~1external/post/responses/403/content/application~1problem+json/examples/insufficient_permissions"]}},"schemaId":"components/schemas/ForbiddenProblem","exampleIds":["paths/~1addresses~1external/post/responses/403/content/application~1problem+json/examples/insufficient_permissions"]},{"code":"409","description":"Request conflicts with the current resource state.","mediaType":"application/problem+json","mediaTypes":["application/problem+json"],"mediaTypeContent":{"application/problem+json":{"schemaId":"components/schemas/ConflictProblem","exampleIds":["paths/~1addresses~1external/post/responses/409/content/application~1problem+json/examples/address_occupied","paths/~1addresses~1external/post/responses/409/content/application~1problem+json/examples/address_in_use","paths/~1addresses~1external/post/responses/409/content/application~1problem+json/examples/subscription_v1_conflict","paths/~1addresses~1external/post/responses/409/content/application~1problem+json/examples/notification_send_in_progress","paths/~1addresses~1external/post/responses/409/content/application~1problem+json/examples/notification_payload_unavailable","paths/~1addresses~1external/post/responses/409/content/application~1problem+json/examples/notification_test_resend_not_allowed"]}},"schemaId":"components/schemas/ConflictProblem","exampleIds":["paths/~1addresses~1external/post/responses/409/content/application~1problem+json/examples/address_occupied","paths/~1addresses~1external/post/responses/409/content/application~1problem+json/examples/address_in_use","paths/~1addresses~1external/post/responses/409/content/application~1problem+json/examples/subscription_v1_conflict","paths/~1addresses~1external/post/responses/409/content/application~1problem+json/examples/notification_send_in_progress","paths/~1addresses~1external/post/responses/409/content/application~1problem+json/examples/notification_payload_unavailable","paths/~1addresses~1external/post/responses/409/content/application~1problem+json/examples/notification_test_resend_not_allowed"]},{"code":"429","description":"Resource quota exceeded. The response includes the effective limit for this scope. The applicable code and limit depend on the operation; examples illustrate different limits.","mediaType":"application/problem+json","mediaTypes":["application/problem+json"],"mediaTypeContent":{"application/problem+json":{"schemaId":"components/schemas/QuotaExceededProblem","exampleIds":["paths/~1addresses~1external/post/responses/429/content/application~1problem+json/examples/address_quota","paths/~1addresses~1external/post/responses/429/content/application~1problem+json/examples/creation_prohibited"]}},"schemaId":"components/schemas/QuotaExceededProblem","exampleIds":["paths/~1addresses~1external/post/responses/429/content/application~1problem+json/examples/address_quota","paths/~1addresses~1external/post/responses/429/content/application~1problem+json/examples/creation_prohibited"]},{"code":"503","description":"The operation is temporarily unavailable. Please try again later.","mediaType":"application/problem+json","mediaTypes":["application/problem+json"],"mediaTypeContent":{"application/problem+json":{"schemaId":"components/schemas/Problem","exampleIds":["paths/~1addresses~1external/post/responses/503/content/application~1problem+json/examples/temporarily_unavailable"]}},"schemaId":"components/schemas/Problem","exampleIds":["paths/~1addresses~1external/post/responses/503/content/application~1problem+json/examples/temporarily_unavailable"]},{"code":"default","description":"Unexpected error.","mediaType":"application/problem+json","mediaTypes":["application/problem+json"],"mediaTypeContent":{"application/problem+json":{"schemaId":"components/schemas/Problem"}},"schemaId":"components/schemas/Problem"}],"pointer":"/paths/~1addresses~1external/post/responses"}],"panels":[{"children":[{"kind":"response","responseCodes":[{"code":"200","schemaId":"schema_26","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"schema_26"}}},{"code":"201","schemaId":"schema_26","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"schema_26"}}},{"code":"400","schemaId":"components/schemas/InvalidRequestProblem","exampleIds":["paths/~1addresses~1external/post/responses/400/content/application~1problem+json/examples/malformed_json"],"mediaTypes":["application/problem+json"],"mediaTypeContent":{"application/problem+json":{"schemaId":"components/schemas/InvalidRequestProblem","exampleIds":["paths/~1addresses~1external/post/responses/400/content/application~1problem+json/examples/malformed_json"]}}},{"code":"401","schemaId":"components/schemas/UnauthorizedProblem","exampleIds":["paths/~1addresses~1external/post/responses/401/content/application~1problem+json/examples/service_authentication_denied"],"mediaTypes":["application/problem+json"],"mediaTypeContent":{"application/problem+json":{"schemaId":"components/schemas/UnauthorizedProblem","exampleIds":["paths/~1addresses~1external/post/responses/401/content/application~1problem+json/examples/service_authentication_denied"]}}},{"code":"403","schemaId":"components/schemas/ForbiddenProblem","exampleIds":["paths/~1addresses~1external/post/responses/403/content/application~1problem+json/examples/insufficient_permissions"],"mediaTypes":["application/problem+json"],"mediaTypeContent":{"application/problem+json":{"schemaId":"components/schemas/ForbiddenProblem","exampleIds":["paths/~1addresses~1external/post/responses/403/content/application~1problem+json/examples/insufficient_permissions"]}}},{"code":"409","schemaId":"components/schemas/ConflictProblem","exampleIds":["paths/~1addresses~1external/post/responses/409/content/application~1problem+json/examples/address_occupied","paths/~1addresses~1external/post/responses/409/content/application~1problem+json/examples/address_in_use","paths/~1addresses~1external/post/responses/409/content/application~1problem+json/examples/subscription_v1_conflict","paths/~1addresses~1external/post/responses/409/content/application~1problem+json/examples/notification_send_in_progress","paths/~1addresses~1external/post/responses/409/content/application~1problem+json/examples/notification_payload_unavailable","paths/~1addresses~1external/post/responses/409/content/application~1problem+json/examples/notification_test_resend_not_allowed"],"mediaTypes":["application/problem+json"],"mediaTypeContent":{"application/problem+json":{"schemaId":"components/schemas/ConflictProblem","exampleIds":["paths/~1addresses~1external/post/responses/409/content/application~1problem+json/examples/address_occupied","paths/~1addresses~1external/post/responses/409/content/application~1problem+json/examples/address_in_use","paths/~1addresses~1external/post/responses/409/content/application~1problem+json/examples/subscription_v1_conflict","paths/~1addresses~1external/post/responses/409/content/application~1problem+json/examples/notification_send_in_progress","paths/~1addresses~1external/post/responses/409/content/application~1problem+json/examples/notification_payload_unavailable","paths/~1addresses~1external/post/responses/409/content/application~1problem+json/examples/notification_test_resend_not_allowed"]}}},{"code":"429","schemaId":"components/schemas/QuotaExceededProblem","exampleIds":["paths/~1addresses~1external/post/responses/429/content/application~1problem+json/examples/address_quota","paths/~1addresses~1external/post/responses/429/content/application~1problem+json/examples/creation_prohibited"],"mediaTypes":["application/problem+json"],"mediaTypeContent":{"application/problem+json":{"schemaId":"components/schemas/QuotaExceededProblem","exampleIds":["paths/~1addresses~1external/post/responses/429/content/application~1problem+json/examples/address_quota","paths/~1addresses~1external/post/responses/429/content/application~1problem+json/examples/creation_prohibited"]}}},{"code":"503","schemaId":"components/schemas/Problem","exampleIds":["paths/~1addresses~1external/post/responses/503/content/application~1problem+json/examples/temporarily_unavailable"],"mediaTypes":["application/problem+json"],"mediaTypeContent":{"application/problem+json":{"schemaId":"components/schemas/Problem","exampleIds":["paths/~1addresses~1external/post/responses/503/content/application~1problem+json/examples/temporarily_unavailable"]}}},{"code":"default","schemaId":"components/schemas/Problem","mediaTypes":["application/problem+json"],"mediaTypeContent":{"application/problem+json":{"schemaId":"components/schemas/Problem"}}}],"examples":[]}]}]},{"nodeType":"container","children":[{"nodeType":"feedback","pageSlug":"/address/create-external-address"}],"panels":[]}]},"httpPath":"/addresses/external"},{"label":"List HD addresses","deprecated":false,"httpVerb":"get","isAdditionalOperation":false,"isWebhook":false,"type":"link","link":"/apis/platform/api/address/list-hd-addresses","routeSlug":"/apis/platform/api/address/list-hd-addresses","metadata":{"seo":{"title":"List HD addresses","description":"List only HD-derived addresses (excludes external). Use GET /addresses for all types."}},"content":{"contentType":"item","itemVariant":"httpItem","meta":{"sourceId":"list-hd-addresses","name":"List HD addresses","isWebhook":false,"pointer":"/paths/~1addresses~1hd/get","hasSamples":false},"children":[{"nodeType":"container","children":[{"nodeType":"header","level":2,"label":"List HD addresses","isWebhook":false,"showPageActions":true}],"panels":[]},{"nodeType":"container","children":[{"nodeType":"header","level":4,"label":"Request","labelTranslationKey":"request","deepLinkSuffix":"request"},{"nodeType":"markdoc","content":"List only HD-derived addresses (excludes external). Use GET /addresses for all types."},{"nodeType":"security","requirements":[{"schemes":[{"name":"Auth","scopes":["api:address:read"],"type":"apiKey","in":"header","paramName":"X-Api-Key","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"API key for authenticating requests. Include your key in the "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"X-Api-Key"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" header. Keys can be created in the Vilna Dashboard or via the Management API. The scopes listed per operation indicate which permissions the key must have."},"children":[]}]}]}]}]}]},{"nodeType":"item-content","variant":"query","label":"Query","labelTranslationKey":"query","parameters":[{"name":"limit","in":"query","schemaId":"schema_0","description":"Maximum number of items to return."},{"name":"page","in":"query","schemaId":"schema_1","description":"Page number for pagination."},{"name":"sort_by","in":"query","schemaId":"schema_18","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Field to sort results by. Use "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"-"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" prefix for descending order."},"children":[]}]}]}]},{"name":"format","in":"query","style":"form","explode":true,"schemaId":"schema_19","description":"Filter addresses by address format.","example":["p2wpkh"]},{"name":"search","in":"query","schemaId":"schema_20","description":"Filter addresses by value or label (partial match, case-insensitive)."},{"name":"tag_id","in":"query","style":"form","explode":true,"schemaId":"schema_21","description":"Filter addresses by tag identifier (UUID). Repeat the parameter to pass\nmultiple values; addresses tagged with any of them are returned (OR semantics).\n","example":["0199ce7e-d9e7-7c01-9c2a-9d0010eaa1cc"]}],"pointer":"/paths/~1addresses~1hd/get/parameters"}],"panels":[{"children":[{"kind":"code-sample","source":{"kind":"code-sample","operationType":"http","method":"GET","path":"/addresses/hd","servers":[{"url":"/_mock/apis/platform/api","description":"Mock server","isMockServer":true},{"url":"https://api.vilna.io/v2","description":"Vilna API."}],"parameters":{"path":[],"query":[{"name":"limit","in":"query","required":false,"example":20,"schemaId":"schema_0"},{"name":"page","in":"query","required":false,"example":1,"schemaId":"schema_1"},{"name":"sort_by","in":"query","required":false,"example":"created_at","schemaId":"schema_18"},{"name":"format","in":"query","required":false,"example":["p2wpkh"],"schemaId":"schema_19","style":"form","explode":true},{"name":"search","in":"query","required":false,"example":"bc1q","schemaId":"schema_20"},{"name":"tag_id","in":"query","required":false,"example":["0199ce7e-d9e7-7c01-9c2a-9d0010eaa1cc"],"schemaId":"schema_21","style":"form","explode":true}],"querystring":[],"header":[],"cookie":[]},"security":[{"schemes":[{"id":"Auth","type":"apiKey","name":"X-Api-Key","in":"header"}],"scopes":["api:address:read"]}],"responseCodes":["200","400","401","403","503","default"],"pointer":"/addresses/hd","href":"address/list-hd-addresses","openApiOperationId":"list-hd-addresses","summary":"List HD addresses"},"isWebhook":false,"hideReplay":false,"servers":[{"url":"/_mock/apis/platform/api","description":"Mock server","isMockServer":true},{"url":"https://api.vilna.io/v2","description":"Vilna API."}],"examples":[]}]}]},{"nodeType":"container","children":[{"nodeType":"header","level":4,"label":"Responses","labelTranslationKey":"responses","deepLinkSuffix":"responses"},{"nodeType":"item-content","variant":"responses","responses":[{"code":"200","description":"List of addresses derived from the public key.","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"schema_22"}},"schemaId":"schema_22"},{"code":"400","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Bad request (e.g., missing or invalid fields). Invalid text may be reported as address.label_invalid, address.meta_invalid, public_key.label_invalid, invoice.comment_invalid, invoice.metadata_invalid."},"children":[]}]}]}],"mediaType":"application/problem+json","mediaTypes":["application/problem+json"],"mediaTypeContent":{"application/problem+json":{"schemaId":"components/schemas/InvalidRequestProblem","exampleIds":["paths/~1addresses~1hd/get/responses/400/content/application~1problem+json/examples/malformed_json"]}},"schemaId":"components/schemas/InvalidRequestProblem","exampleIds":["paths/~1addresses~1hd/get/responses/400/content/application~1problem+json/examples/malformed_json"]},{"code":"401","description":"Missing or invalid authentication credentials.","mediaType":"application/problem+json","mediaTypes":["application/problem+json"],"mediaTypeContent":{"application/problem+json":{"schemaId":"components/schemas/UnauthorizedProblem","exampleIds":["paths/~1addresses~1hd/get/responses/401/content/application~1problem+json/examples/service_authentication_denied"]}},"schemaId":"components/schemas/UnauthorizedProblem","exampleIds":["paths/~1addresses~1hd/get/responses/401/content/application~1problem+json/examples/service_authentication_denied"]},{"code":"403","description":"Insufficient permissions.","mediaType":"application/problem+json","mediaTypes":["application/problem+json"],"mediaTypeContent":{"application/problem+json":{"schemaId":"components/schemas/ForbiddenProblem","exampleIds":["paths/~1addresses~1hd/get/responses/403/content/application~1problem+json/examples/insufficient_permissions"]}},"schemaId":"components/schemas/ForbiddenProblem","exampleIds":["paths/~1addresses~1hd/get/responses/403/content/application~1problem+json/examples/insufficient_permissions"]},{"code":"503","description":"The operation is temporarily unavailable. Please try again later.","mediaType":"application/problem+json","mediaTypes":["application/problem+json"],"mediaTypeContent":{"application/problem+json":{"schemaId":"components/schemas/Problem","exampleIds":["paths/~1addresses~1hd/get/responses/503/content/application~1problem+json/examples/temporarily_unavailable"]}},"schemaId":"components/schemas/Problem","exampleIds":["paths/~1addresses~1hd/get/responses/503/content/application~1problem+json/examples/temporarily_unavailable"]},{"code":"default","description":"Unexpected error.","mediaType":"application/problem+json","mediaTypes":["application/problem+json"],"mediaTypeContent":{"application/problem+json":{"schemaId":"components/schemas/Problem"}},"schemaId":"components/schemas/Problem"}],"pointer":"/paths/~1addresses~1hd/get/responses"}],"panels":[{"children":[{"kind":"response","responseCodes":[{"code":"200","schemaId":"schema_22","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"schema_22"}}},{"code":"400","schemaId":"components/schemas/InvalidRequestProblem","exampleIds":["paths/~1addresses~1hd/get/responses/400/content/application~1problem+json/examples/malformed_json"],"mediaTypes":["application/problem+json"],"mediaTypeContent":{"application/problem+json":{"schemaId":"components/schemas/InvalidRequestProblem","exampleIds":["paths/~1addresses~1hd/get/responses/400/content/application~1problem+json/examples/malformed_json"]}}},{"code":"401","schemaId":"components/schemas/UnauthorizedProblem","exampleIds":["paths/~1addresses~1hd/get/responses/401/content/application~1problem+json/examples/service_authentication_denied"],"mediaTypes":["application/problem+json"],"mediaTypeContent":{"application/problem+json":{"schemaId":"components/schemas/UnauthorizedProblem","exampleIds":["paths/~1addresses~1hd/get/responses/401/content/application~1problem+json/examples/service_authentication_denied"]}}},{"code":"403","schemaId":"components/schemas/ForbiddenProblem","exampleIds":["paths/~1addresses~1hd/get/responses/403/content/application~1problem+json/examples/insufficient_permissions"],"mediaTypes":["application/problem+json"],"mediaTypeContent":{"application/problem+json":{"schemaId":"components/schemas/ForbiddenProblem","exampleIds":["paths/~1addresses~1hd/get/responses/403/content/application~1problem+json/examples/insufficient_permissions"]}}},{"code":"503","schemaId":"components/schemas/Problem","exampleIds":["paths/~1addresses~1hd/get/responses/503/content/application~1problem+json/examples/temporarily_unavailable"],"mediaTypes":["application/problem+json"],"mediaTypeContent":{"application/problem+json":{"schemaId":"components/schemas/Problem","exampleIds":["paths/~1addresses~1hd/get/responses/503/content/application~1problem+json/examples/temporarily_unavailable"]}}},{"code":"default","schemaId":"components/schemas/Problem","mediaTypes":["application/problem+json"],"mediaTypeContent":{"application/problem+json":{"schemaId":"components/schemas/Problem"}}}],"examples":[]}]}]},{"nodeType":"container","children":[{"nodeType":"feedback","pageSlug":"/address/list-hd-addresses"}],"panels":[]}]},"httpPath":"/addresses/hd"},{"label":"Delete address","deprecated":false,"httpVerb":"delete","isAdditionalOperation":false,"isWebhook":false,"type":"link","link":"/apis/platform/api/address/delete-address","routeSlug":"/apis/platform/api/address/delete-address","metadata":{"seo":{"title":"Delete address","description":"Delete a tracked address. This operation is irreversible."}},"content":{"contentType":"item","itemVariant":"httpItem","meta":{"sourceId":"delete-address","name":"Delete address","isWebhook":false,"pointer":"/paths/~1addresses~1{address}/delete","hasSamples":false},"children":[{"nodeType":"container","children":[{"nodeType":"header","level":2,"label":"Delete address","isWebhook":false,"showPageActions":true}],"panels":[]},{"nodeType":"container","children":[{"nodeType":"header","level":4,"label":"Request","labelTranslationKey":"request","deepLinkSuffix":"request"},{"nodeType":"markdoc","content":"Delete a tracked address. This operation is irreversible."},{"nodeType":"security","requirements":[{"schemes":[{"name":"Auth","scopes":["api:address:delete"],"type":"apiKey","in":"header","paramName":"X-Api-Key","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"API key for authenticating requests. Include your key in the "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"X-Api-Key"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" header. Keys can be created in the Vilna Dashboard or via the Management API. The scopes listed per operation indicate which permissions the key must have."},"children":[]}]}]}]}]}]},{"nodeType":"item-content","variant":"path","label":"Path","labelTranslationKey":"path","parameters":[{"name":"address","in":"path","schemaId":"schema_27","description":"Blockchain address in its native format (e.g., 0x8521E8b15eCEF4D4269Fded3E6694225E096959E for EVM chains).","required":true}],"pointer":"/paths/~1addresses~1{address}/delete/parameters"},{"nodeType":"item-content","variant":"headers","label":"Headers","labelTranslationKey":"header","parameters":[{"name":"Idempotency-Key","in":"header","schemaId":"schema_14","description":"Case-sensitive opaque key for one mutation intent. Send exactly one header occurrence containing 1 to 128 visible ASCII bytes (0x21..0x7e). Commas are literal data; do not trim, lowercase or require UUID syntax. Reuse the same key for retries, with current authorization checked on every attempt. Repeated header occurrences are rejected.\n","required":true}],"pointer":"/paths/~1addresses~1{address}/delete/parameters"}],"panels":[{"children":[{"kind":"code-sample","source":{"kind":"code-sample","operationType":"http","method":"DELETE","path":"/addresses/{address}","servers":[{"url":"/_mock/apis/platform/api","description":"Mock server","isMockServer":true},{"url":"https://api.vilna.io/v2","description":"Vilna API."}],"parameters":{"path":[{"name":"address","in":"path","required":true,"example":"0x8521E8b15eCEF4D4269Fded3E6694225E096959E","schemaId":"components/schemas/AddressValue"}],"query":[],"querystring":[],"header":[{"name":"Idempotency-Key","in":"header","required":true,"schemaId":"schema_14"}],"cookie":[]},"security":[{"schemes":[{"id":"Auth","type":"apiKey","name":"X-Api-Key","in":"header"}],"scopes":["api:address:delete"]}],"responseCodes":["204","400","401","403","404","409","503","default"],"pointer":"/addresses/{address}","href":"address/delete-address","openApiOperationId":"delete-address","summary":"Delete address"},"isWebhook":false,"hideReplay":false,"servers":[{"url":"/_mock/apis/platform/api","description":"Mock server","isMockServer":true},{"url":"https://api.vilna.io/v2","description":"Vilna API."}],"examples":[]}]}]},{"nodeType":"container","children":[{"nodeType":"header","level":4,"label":"Responses","labelTranslationKey":"responses","deepLinkSuffix":"responses"},{"nodeType":"item-content","variant":"responses","responses":[{"code":"204","description":"Successful operation with no response body."},{"code":"400","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Bad request (e.g., missing or invalid fields). Invalid text may be reported as address.label_invalid, address.meta_invalid, public_key.label_invalid, invoice.comment_invalid, invoice.metadata_invalid."},"children":[]}]}]}],"mediaType":"application/problem+json","mediaTypes":["application/problem+json"],"mediaTypeContent":{"application/problem+json":{"schemaId":"components/schemas/InvalidRequestProblem","exampleIds":["paths/~1addresses~1{address}/delete/responses/400/content/application~1problem+json/examples/malformed_json"]}},"schemaId":"components/schemas/InvalidRequestProblem","exampleIds":["paths/~1addresses~1{address}/delete/responses/400/content/application~1problem+json/examples/malformed_json"]},{"code":"401","description":"Missing or invalid authentication credentials.","mediaType":"application/problem+json","mediaTypes":["application/problem+json"],"mediaTypeContent":{"application/problem+json":{"schemaId":"components/schemas/UnauthorizedProblem","exampleIds":["paths/~1addresses~1{address}/delete/responses/401/content/application~1problem+json/examples/service_authentication_denied"]}},"schemaId":"components/schemas/UnauthorizedProblem","exampleIds":["paths/~1addresses~1{address}/delete/responses/401/content/application~1problem+json/examples/service_authentication_denied"]},{"code":"403","description":"Insufficient permissions.","mediaType":"application/problem+json","mediaTypes":["application/problem+json"],"mediaTypeContent":{"application/problem+json":{"schemaId":"components/schemas/ForbiddenProblem","exampleIds":["paths/~1addresses~1{address}/delete/responses/403/content/application~1problem+json/examples/insufficient_permissions"]}},"schemaId":"components/schemas/ForbiddenProblem","exampleIds":["paths/~1addresses~1{address}/delete/responses/403/content/application~1problem+json/examples/insufficient_permissions"]},{"code":"404","description":"Requested resource does not exist.","mediaType":"application/problem+json","mediaTypes":["application/problem+json"],"mediaTypeContent":{"application/problem+json":{"schemaId":"components/schemas/NotFoundProblem","exampleIds":["paths/~1addresses~1{address}/delete/responses/404/content/application~1problem+json/examples/address_not_found","paths/~1addresses~1{address}/delete/responses/404/content/application~1problem+json/examples/invoice_not_found"]}},"schemaId":"components/schemas/NotFoundProblem","exampleIds":["paths/~1addresses~1{address}/delete/responses/404/content/application~1problem+json/examples/address_not_found","paths/~1addresses~1{address}/delete/responses/404/content/application~1problem+json/examples/invoice_not_found"]},{"code":"409","description":"Request conflicts with the current resource state.","mediaType":"application/problem+json","mediaTypes":["application/problem+json"],"mediaTypeContent":{"application/problem+json":{"schemaId":"components/schemas/ConflictProblem","exampleIds":["paths/~1addresses~1{address}/delete/responses/409/content/application~1problem+json/examples/address_occupied","paths/~1addresses~1{address}/delete/responses/409/content/application~1problem+json/examples/address_in_use","paths/~1addresses~1{address}/delete/responses/409/content/application~1problem+json/examples/subscription_v1_conflict","paths/~1addresses~1{address}/delete/responses/409/content/application~1problem+json/examples/notification_send_in_progress","paths/~1addresses~1{address}/delete/responses/409/content/application~1problem+json/examples/notification_payload_unavailable","paths/~1addresses~1{address}/delete/responses/409/content/application~1problem+json/examples/notification_test_resend_not_allowed"]}},"schemaId":"components/schemas/ConflictProblem","exampleIds":["paths/~1addresses~1{address}/delete/responses/409/content/application~1problem+json/examples/address_occupied","paths/~1addresses~1{address}/delete/responses/409/content/application~1problem+json/examples/address_in_use","paths/~1addresses~1{address}/delete/responses/409/content/application~1problem+json/examples/subscription_v1_conflict","paths/~1addresses~1{address}/delete/responses/409/content/application~1problem+json/examples/notification_send_in_progress","paths/~1addresses~1{address}/delete/responses/409/content/application~1problem+json/examples/notification_payload_unavailable","paths/~1addresses~1{address}/delete/responses/409/content/application~1problem+json/examples/notification_test_resend_not_allowed"]},{"code":"503","description":"The operation is temporarily unavailable. Please try again later.","mediaType":"application/problem+json","mediaTypes":["application/problem+json"],"mediaTypeContent":{"application/problem+json":{"schemaId":"components/schemas/Problem","exampleIds":["paths/~1addresses~1{address}/delete/responses/503/content/application~1problem+json/examples/temporarily_unavailable"]}},"schemaId":"components/schemas/Problem","exampleIds":["paths/~1addresses~1{address}/delete/responses/503/content/application~1problem+json/examples/temporarily_unavailable"]},{"code":"default","description":"Unexpected error.","mediaType":"application/problem+json","mediaTypes":["application/problem+json"],"mediaTypeContent":{"application/problem+json":{"schemaId":"components/schemas/Problem"}},"schemaId":"components/schemas/Problem"}],"pointer":"/paths/~1addresses~1{address}/delete/responses"}],"panels":[{"children":[{"kind":"response","responseCodes":[{"code":"204"},{"code":"400","schemaId":"components/schemas/InvalidRequestProblem","exampleIds":["paths/~1addresses~1{address}/delete/responses/400/content/application~1problem+json/examples/malformed_json"],"mediaTypes":["application/problem+json"],"mediaTypeContent":{"application/problem+json":{"schemaId":"components/schemas/InvalidRequestProblem","exampleIds":["paths/~1addresses~1{address}/delete/responses/400/content/application~1problem+json/examples/malformed_json"]}}},{"code":"401","schemaId":"components/schemas/UnauthorizedProblem","exampleIds":["paths/~1addresses~1{address}/delete/responses/401/content/application~1problem+json/examples/service_authentication_denied"],"mediaTypes":["application/problem+json"],"mediaTypeContent":{"application/problem+json":{"schemaId":"components/schemas/UnauthorizedProblem","exampleIds":["paths/~1addresses~1{address}/delete/responses/401/content/application~1problem+json/examples/service_authentication_denied"]}}},{"code":"403","schemaId":"components/schemas/ForbiddenProblem","exampleIds":["paths/~1addresses~1{address}/delete/responses/403/content/application~1problem+json/examples/insufficient_permissions"],"mediaTypes":["application/problem+json"],"mediaTypeContent":{"application/problem+json":{"schemaId":"components/schemas/ForbiddenProblem","exampleIds":["paths/~1addresses~1{address}/delete/responses/403/content/application~1problem+json/examples/insufficient_permissions"]}}},{"code":"404","schemaId":"components/schemas/NotFoundProblem","exampleIds":["paths/~1addresses~1{address}/delete/responses/404/content/application~1problem+json/examples/address_not_found","paths/~1addresses~1{address}/delete/responses/404/content/application~1problem+json/examples/invoice_not_found"],"mediaTypes":["application/problem+json"],"mediaTypeContent":{"application/problem+json":{"schemaId":"components/schemas/NotFoundProblem","exampleIds":["paths/~1addresses~1{address}/delete/responses/404/content/application~1problem+json/examples/address_not_found","paths/~1addresses~1{address}/delete/responses/404/content/application~1problem+json/examples/invoice_not_found"]}}},{"code":"409","schemaId":"components/schemas/ConflictProblem","exampleIds":["paths/~1addresses~1{address}/delete/responses/409/content/application~1problem+json/examples/address_occupied","paths/~1addresses~1{address}/delete/responses/409/content/application~1problem+json/examples/address_in_use","paths/~1addresses~1{address}/delete/responses/409/content/application~1problem+json/examples/subscription_v1_conflict","paths/~1addresses~1{address}/delete/responses/409/content/application~1problem+json/examples/notification_send_in_progress","paths/~1addresses~1{address}/delete/responses/409/content/application~1problem+json/examples/notification_payload_unavailable","paths/~1addresses~1{address}/delete/responses/409/content/application~1problem+json/examples/notification_test_resend_not_allowed"],"mediaTypes":["application/problem+json"],"mediaTypeContent":{"application/problem+json":{"schemaId":"components/schemas/ConflictProblem","exampleIds":["paths/~1addresses~1{address}/delete/responses/409/content/application~1problem+json/examples/address_occupied","paths/~1addresses~1{address}/delete/responses/409/content/application~1problem+json/examples/address_in_use","paths/~1addresses~1{address}/delete/responses/409/content/application~1problem+json/examples/subscription_v1_conflict","paths/~1addresses~1{address}/delete/responses/409/content/application~1problem+json/examples/notification_send_in_progress","paths/~1addresses~1{address}/delete/responses/409/content/application~1problem+json/examples/notification_payload_unavailable","paths/~1addresses~1{address}/delete/responses/409/content/application~1problem+json/examples/notification_test_resend_not_allowed"]}}},{"code":"503","schemaId":"components/schemas/Problem","exampleIds":["paths/~1addresses~1{address}/delete/responses/503/content/application~1problem+json/examples/temporarily_unavailable"],"mediaTypes":["application/problem+json"],"mediaTypeContent":{"application/problem+json":{"schemaId":"components/schemas/Problem","exampleIds":["paths/~1addresses~1{address}/delete/responses/503/content/application~1problem+json/examples/temporarily_unavailable"]}}},{"code":"default","schemaId":"components/schemas/Problem","mediaTypes":["application/problem+json"],"mediaTypeContent":{"application/problem+json":{"schemaId":"components/schemas/Problem"}}}],"examples":[]}]}]},{"nodeType":"container","children":[{"nodeType":"feedback","pageSlug":"/address/delete-address"}],"panels":[]}]},"httpPath":"/addresses/{address}"},{"label":"Get address","deprecated":false,"httpVerb":"get","isAdditionalOperation":false,"isWebhook":false,"type":"link","link":"/apis/platform/api/address/get-address","routeSlug":"/apis/platform/api/address/get-address","metadata":{"seo":{"title":"Get address","description":"Get tracked address details by address value."}},"content":{"contentType":"item","itemVariant":"httpItem","meta":{"sourceId":"get-address","name":"Get address","isWebhook":false,"pointer":"/paths/~1addresses~1{address}/get","hasSamples":false},"children":[{"nodeType":"container","children":[{"nodeType":"header","level":2,"label":"Get address","isWebhook":false,"showPageActions":true}],"panels":[]},{"nodeType":"container","children":[{"nodeType":"header","level":4,"label":"Request","labelTranslationKey":"request","deepLinkSuffix":"request"},{"nodeType":"markdoc","content":"Get tracked address details by address value."},{"nodeType":"security","requirements":[{"schemes":[{"name":"Auth","scopes":["api:address:read"],"type":"apiKey","in":"header","paramName":"X-Api-Key","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"API key for authenticating requests. Include your key in the "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"X-Api-Key"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" header. Keys can be created in the Vilna Dashboard or via the Management API. The scopes listed per operation indicate which permissions the key must have."},"children":[]}]}]}]}]}]},{"nodeType":"item-content","variant":"path","label":"Path","labelTranslationKey":"path","parameters":[{"name":"address","in":"path","schemaId":"schema_27","description":"Blockchain address in its native format (e.g., 0x8521E8b15eCEF4D4269Fded3E6694225E096959E for EVM chains).","required":true}],"pointer":"/paths/~1addresses~1{address}/get/parameters"}],"panels":[{"children":[{"kind":"code-sample","source":{"kind":"code-sample","operationType":"http","method":"GET","path":"/addresses/{address}","servers":[{"url":"/_mock/apis/platform/api","description":"Mock server","isMockServer":true},{"url":"https://api.vilna.io/v2","description":"Vilna API."}],"parameters":{"path":[{"name":"address","in":"path","required":true,"example":"0x8521E8b15eCEF4D4269Fded3E6694225E096959E","schemaId":"components/schemas/AddressValue"}],"query":[],"querystring":[],"header":[],"cookie":[]},"security":[{"schemes":[{"id":"Auth","type":"apiKey","name":"X-Api-Key","in":"header"}],"scopes":["api:address:read"]}],"responseCodes":["200","400","401","403","404","503","default"],"pointer":"/addresses/{address}","href":"address/get-address","openApiOperationId":"get-address","summary":"Get address"},"isWebhook":false,"hideReplay":false,"servers":[{"url":"/_mock/apis/platform/api","description":"Mock server","isMockServer":true},{"url":"https://api.vilna.io/v2","description":"Vilna API."}],"examples":[]}]}]},{"nodeType":"container","children":[{"nodeType":"header","level":4,"label":"Responses","labelTranslationKey":"responses","deepLinkSuffix":"responses"},{"nodeType":"item-content","variant":"responses","responses":[{"code":"200","description":"Address details.","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"schema_28"}},"schemaId":"schema_28"},{"code":"400","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Bad request (e.g., missing or invalid fields). Invalid text may be reported as address.label_invalid, address.meta_invalid, public_key.label_invalid, invoice.comment_invalid, invoice.metadata_invalid."},"children":[]}]}]}],"mediaType":"application/problem+json","mediaTypes":["application/problem+json"],"mediaTypeContent":{"application/problem+json":{"schemaId":"components/schemas/InvalidRequestProblem","exampleIds":["paths/~1addresses~1{address}/get/responses/400/content/application~1problem+json/examples/malformed_json"]}},"schemaId":"components/schemas/InvalidRequestProblem","exampleIds":["paths/~1addresses~1{address}/get/responses/400/content/application~1problem+json/examples/malformed_json"]},{"code":"401","description":"Missing or invalid authentication credentials.","mediaType":"application/problem+json","mediaTypes":["application/problem+json"],"mediaTypeContent":{"application/problem+json":{"schemaId":"components/schemas/UnauthorizedProblem","exampleIds":["paths/~1addresses~1{address}/get/responses/401/content/application~1problem+json/examples/service_authentication_denied"]}},"schemaId":"components/schemas/UnauthorizedProblem","exampleIds":["paths/~1addresses~1{address}/get/responses/401/content/application~1problem+json/examples/service_authentication_denied"]},{"code":"403","description":"Insufficient permissions.","mediaType":"application/problem+json","mediaTypes":["application/problem+json"],"mediaTypeContent":{"application/problem+json":{"schemaId":"components/schemas/ForbiddenProblem","exampleIds":["paths/~1addresses~1{address}/get/responses/403/content/application~1problem+json/examples/insufficient_permissions"]}},"schemaId":"components/schemas/ForbiddenProblem","exampleIds":["paths/~1addresses~1{address}/get/responses/403/content/application~1problem+json/examples/insufficient_permissions"]},{"code":"404","description":"Requested resource does not exist.","mediaType":"application/problem+json","mediaTypes":["application/problem+json"],"mediaTypeContent":{"application/problem+json":{"schemaId":"components/schemas/NotFoundProblem","exampleIds":["paths/~1addresses~1{address}/get/responses/404/content/application~1problem+json/examples/address_not_found","paths/~1addresses~1{address}/get/responses/404/content/application~1problem+json/examples/invoice_not_found"]}},"schemaId":"components/schemas/NotFoundProblem","exampleIds":["paths/~1addresses~1{address}/get/responses/404/content/application~1problem+json/examples/address_not_found","paths/~1addresses~1{address}/get/responses/404/content/application~1problem+json/examples/invoice_not_found"]},{"code":"503","description":"The operation is temporarily unavailable. Please try again later.","mediaType":"application/problem+json","mediaTypes":["application/problem+json"],"mediaTypeContent":{"application/problem+json":{"schemaId":"components/schemas/Problem","exampleIds":["paths/~1addresses~1{address}/get/responses/503/content/application~1problem+json/examples/temporarily_unavailable"]}},"schemaId":"components/schemas/Problem","exampleIds":["paths/~1addresses~1{address}/get/responses/503/content/application~1problem+json/examples/temporarily_unavailable"]},{"code":"default","description":"Unexpected error.","mediaType":"application/problem+json","mediaTypes":["application/problem+json"],"mediaTypeContent":{"application/problem+json":{"schemaId":"components/schemas/Problem"}},"schemaId":"components/schemas/Problem"}],"pointer":"/paths/~1addresses~1{address}/get/responses"}],"panels":[{"children":[{"kind":"response","responseCodes":[{"code":"200","schemaId":"schema_28","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"schema_28"}}},{"code":"400","schemaId":"components/schemas/InvalidRequestProblem","exampleIds":["paths/~1addresses~1{address}/get/responses/400/content/application~1problem+json/examples/malformed_json"],"mediaTypes":["application/problem+json"],"mediaTypeContent":{"application/problem+json":{"schemaId":"components/schemas/InvalidRequestProblem","exampleIds":["paths/~1addresses~1{address}/get/responses/400/content/application~1problem+json/examples/malformed_json"]}}},{"code":"401","schemaId":"components/schemas/UnauthorizedProblem","exampleIds":["paths/~1addresses~1{address}/get/responses/401/content/application~1problem+json/examples/service_authentication_denied"],"mediaTypes":["application/problem+json"],"mediaTypeContent":{"application/problem+json":{"schemaId":"components/schemas/UnauthorizedProblem","exampleIds":["paths/~1addresses~1{address}/get/responses/401/content/application~1problem+json/examples/service_authentication_denied"]}}},{"code":"403","schemaId":"components/schemas/ForbiddenProblem","exampleIds":["paths/~1addresses~1{address}/get/responses/403/content/application~1problem+json/examples/insufficient_permissions"],"mediaTypes":["application/problem+json"],"mediaTypeContent":{"application/problem+json":{"schemaId":"components/schemas/ForbiddenProblem","exampleIds":["paths/~1addresses~1{address}/get/responses/403/content/application~1problem+json/examples/insufficient_permissions"]}}},{"code":"404","schemaId":"components/schemas/NotFoundProblem","exampleIds":["paths/~1addresses~1{address}/get/responses/404/content/application~1problem+json/examples/address_not_found","paths/~1addresses~1{address}/get/responses/404/content/application~1problem+json/examples/invoice_not_found"],"mediaTypes":["application/problem+json"],"mediaTypeContent":{"application/problem+json":{"schemaId":"components/schemas/NotFoundProblem","exampleIds":["paths/~1addresses~1{address}/get/responses/404/content/application~1problem+json/examples/address_not_found","paths/~1addresses~1{address}/get/responses/404/content/application~1problem+json/examples/invoice_not_found"]}}},{"code":"503","schemaId":"components/schemas/Problem","exampleIds":["paths/~1addresses~1{address}/get/responses/503/content/application~1problem+json/examples/temporarily_unavailable"],"mediaTypes":["application/problem+json"],"mediaTypeContent":{"application/problem+json":{"schemaId":"components/schemas/Problem","exampleIds":["paths/~1addresses~1{address}/get/responses/503/content/application~1problem+json/examples/temporarily_unavailable"]}}},{"code":"default","schemaId":"components/schemas/Problem","mediaTypes":["application/problem+json"],"mediaTypeContent":{"application/problem+json":{"schemaId":"components/schemas/Problem"}}}],"examples":[]}]}]},{"nodeType":"container","children":[{"nodeType":"feedback","pageSlug":"/address/get-address"}],"panels":[]}]},"httpPath":"/addresses/{address}"},{"label":"Update address","deprecated":false,"httpVerb":"patch","isAdditionalOperation":false,"isWebhook":false,"type":"link","link":"/apis/platform/api/address/patch-address","routeSlug":"/apis/platform/api/address/patch-address","metadata":{"seo":{"title":"Update address","description":"Update tracked address metadata."}},"content":{"contentType":"item","itemVariant":"httpItem","meta":{"sourceId":"patch-address","name":"Update address","isWebhook":false,"pointer":"/paths/~1addresses~1{address}/patch","hasSamples":true},"children":[{"nodeType":"container","children":[{"nodeType":"header","level":2,"label":"Update address","isWebhook":false,"showPageActions":true}],"panels":[]},{"nodeType":"container","children":[{"nodeType":"header","level":4,"label":"Request","labelTranslationKey":"request","deepLinkSuffix":"request"},{"nodeType":"markdoc","content":"Update tracked address metadata."},{"nodeType":"security","requirements":[{"schemes":[{"name":"Auth","scopes":["api:address:write"],"type":"apiKey","in":"header","paramName":"X-Api-Key","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"API key for authenticating requests. Include your key in the "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"X-Api-Key"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" header. Keys can be created in the Vilna Dashboard or via the Management API. The scopes listed per operation indicate which permissions the key must have."},"children":[]}]}]}]}]}]},{"nodeType":"item-content","variant":"path","label":"Path","labelTranslationKey":"path","parameters":[{"name":"address","in":"path","schemaId":"schema_27","description":"Blockchain address in its native format (e.g., 0x8521E8b15eCEF4D4269Fded3E6694225E096959E for EVM chains).","required":true}],"pointer":"/paths/~1addresses~1{address}/patch/parameters"},{"nodeType":"item-content","variant":"headers","label":"Headers","labelTranslationKey":"header","parameters":[{"name":"Idempotency-Key","in":"header","schemaId":"schema_14","description":"Case-sensitive opaque key for one mutation intent. Send exactly one header occurrence containing 1 to 128 visible ASCII bytes (0x21..0x7e). Commas are literal data; do not trim, lowercase or require UUID syntax. Reuse the same key for retries, with current authorization checked on every attempt. Repeated header occurrences are rejected.\n","required":true}],"pointer":"/paths/~1addresses~1{address}/patch/parameters"},{"nodeType":"item-content","variant":"body","label":"Request Body","labelTranslationKey":"body","required":true,"mediaTypes":["application/json"],"mediaTypeSchemas":{"application/json":{"schemaId":"components/schemas/UpdateAddressRequest"}},"schemaId":"components/schemas/UpdateAddressRequest","pointer":"/paths/~1addresses~1{address}/patch/requestBody"}],"panels":[{"children":[{"kind":"code-sample","source":{"kind":"code-sample","operationType":"http","method":"PATCH","path":"/addresses/{address}","servers":[{"url":"/_mock/apis/platform/api","description":"Mock server","isMockServer":true},{"url":"https://api.vilna.io/v2","description":"Vilna API."}],"parameters":{"path":[{"name":"address","in":"path","required":true,"example":"0x8521E8b15eCEF4D4269Fded3E6694225E096959E","schemaId":"components/schemas/AddressValue"}],"query":[],"querystring":[],"header":[{"name":"Idempotency-Key","in":"header","required":true,"schemaId":"schema_14"}],"cookie":[]},"security":[{"schemes":[{"id":"Auth","type":"apiKey","name":"X-Api-Key","in":"header"}],"scopes":["api:address:write"]}],"requestBody":{"application/json":{"schemaId":"components/schemas/UpdateAddressRequest"}},"responseCodes":["204","400","401","403","404","409","503","default"],"pointer":"/addresses/{address}","href":"address/patch-address","openApiOperationId":"patch-address","summary":"Update address"},"isWebhook":false,"hideReplay":false,"servers":[{"url":"/_mock/apis/platform/api","description":"Mock server","isMockServer":true},{"url":"https://api.vilna.io/v2","description":"Vilna API."}],"schemaId":"components/schemas/UpdateAddressRequest","mediaTypes":["application/json"],"mediaTypeSchemas":{"application/json":{"schemaId":"components/schemas/UpdateAddressRequest"}},"examples":[]}]}]},{"nodeType":"container","children":[{"nodeType":"header","level":4,"label":"Responses","labelTranslationKey":"responses","deepLinkSuffix":"responses"},{"nodeType":"item-content","variant":"responses","responses":[{"code":"204","description":"Successful operation with no response body."},{"code":"400","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Bad request (e.g., missing or invalid fields). Invalid text may be reported as address.label_invalid, address.meta_invalid, public_key.label_invalid, invoice.comment_invalid, invoice.metadata_invalid."},"children":[]}]}]}],"mediaType":"application/problem+json","mediaTypes":["application/problem+json"],"mediaTypeContent":{"application/problem+json":{"schemaId":"components/schemas/InvalidRequestProblem","exampleIds":["paths/~1addresses~1{address}/patch/responses/400/content/application~1problem+json/examples/malformed_json"]}},"schemaId":"components/schemas/InvalidRequestProblem","exampleIds":["paths/~1addresses~1{address}/patch/responses/400/content/application~1problem+json/examples/malformed_json"]},{"code":"401","description":"Missing or invalid authentication credentials.","mediaType":"application/problem+json","mediaTypes":["application/problem+json"],"mediaTypeContent":{"application/problem+json":{"schemaId":"components/schemas/UnauthorizedProblem","exampleIds":["paths/~1addresses~1{address}/patch/responses/401/content/application~1problem+json/examples/service_authentication_denied"]}},"schemaId":"components/schemas/UnauthorizedProblem","exampleIds":["paths/~1addresses~1{address}/patch/responses/401/content/application~1problem+json/examples/service_authentication_denied"]},{"code":"403","description":"Insufficient permissions.","mediaType":"application/problem+json","mediaTypes":["application/problem+json"],"mediaTypeContent":{"application/problem+json":{"schemaId":"components/schemas/ForbiddenProblem","exampleIds":["paths/~1addresses~1{address}/patch/responses/403/content/application~1problem+json/examples/insufficient_permissions"]}},"schemaId":"components/schemas/ForbiddenProblem","exampleIds":["paths/~1addresses~1{address}/patch/responses/403/content/application~1problem+json/examples/insufficient_permissions"]},{"code":"404","description":"Requested resource does not exist.","mediaType":"application/problem+json","mediaTypes":["application/problem+json"],"mediaTypeContent":{"application/problem+json":{"schemaId":"components/schemas/NotFoundProblem","exampleIds":["paths/~1addresses~1{address}/patch/responses/404/content/application~1problem+json/examples/address_not_found","paths/~1addresses~1{address}/patch/responses/404/content/application~1problem+json/examples/invoice_not_found"]}},"schemaId":"components/schemas/NotFoundProblem","exampleIds":["paths/~1addresses~1{address}/patch/responses/404/content/application~1problem+json/examples/address_not_found","paths/~1addresses~1{address}/patch/responses/404/content/application~1problem+json/examples/invoice_not_found"]},{"code":"409","description":"Request conflicts with the current resource state.","mediaType":"application/problem+json","mediaTypes":["application/problem+json"],"mediaTypeContent":{"application/problem+json":{"schemaId":"components/schemas/ConflictProblem","exampleIds":["paths/~1addresses~1{address}/patch/responses/409/content/application~1problem+json/examples/address_occupied","paths/~1addresses~1{address}/patch/responses/409/content/application~1problem+json/examples/address_in_use","paths/~1addresses~1{address}/patch/responses/409/content/application~1problem+json/examples/subscription_v1_conflict","paths/~1addresses~1{address}/patch/responses/409/content/application~1problem+json/examples/notification_send_in_progress","paths/~1addresses~1{address}/patch/responses/409/content/application~1problem+json/examples/notification_payload_unavailable","paths/~1addresses~1{address}/patch/responses/409/content/application~1problem+json/examples/notification_test_resend_not_allowed"]}},"schemaId":"components/schemas/ConflictProblem","exampleIds":["paths/~1addresses~1{address}/patch/responses/409/content/application~1problem+json/examples/address_occupied","paths/~1addresses~1{address}/patch/responses/409/content/application~1problem+json/examples/address_in_use","paths/~1addresses~1{address}/patch/responses/409/content/application~1problem+json/examples/subscription_v1_conflict","paths/~1addresses~1{address}/patch/responses/409/content/application~1problem+json/examples/notification_send_in_progress","paths/~1addresses~1{address}/patch/responses/409/content/application~1problem+json/examples/notification_payload_unavailable","paths/~1addresses~1{address}/patch/responses/409/content/application~1problem+json/examples/notification_test_resend_not_allowed"]},{"code":"503","description":"The operation is temporarily unavailable. Please try again later.","mediaType":"application/problem+json","mediaTypes":["application/problem+json"],"mediaTypeContent":{"application/problem+json":{"schemaId":"components/schemas/Problem","exampleIds":["paths/~1addresses~1{address}/patch/responses/503/content/application~1problem+json/examples/temporarily_unavailable"]}},"schemaId":"components/schemas/Problem","exampleIds":["paths/~1addresses~1{address}/patch/responses/503/content/application~1problem+json/examples/temporarily_unavailable"]},{"code":"default","description":"Unexpected error.","mediaType":"application/problem+json","mediaTypes":["application/problem+json"],"mediaTypeContent":{"application/problem+json":{"schemaId":"components/schemas/Problem"}},"schemaId":"components/schemas/Problem"}],"pointer":"/paths/~1addresses~1{address}/patch/responses"}],"panels":[{"children":[{"kind":"response","responseCodes":[{"code":"204"},{"code":"400","schemaId":"components/schemas/InvalidRequestProblem","exampleIds":["paths/~1addresses~1{address}/patch/responses/400/content/application~1problem+json/examples/malformed_json"],"mediaTypes":["application/problem+json"],"mediaTypeContent":{"application/problem+json":{"schemaId":"components/schemas/InvalidRequestProblem","exampleIds":["paths/~1addresses~1{address}/patch/responses/400/content/application~1problem+json/examples/malformed_json"]}}},{"code":"401","schemaId":"components/schemas/UnauthorizedProblem","exampleIds":["paths/~1addresses~1{address}/patch/responses/401/content/application~1problem+json/examples/service_authentication_denied"],"mediaTypes":["application/problem+json"],"mediaTypeContent":{"application/problem+json":{"schemaId":"components/schemas/UnauthorizedProblem","exampleIds":["paths/~1addresses~1{address}/patch/responses/401/content/application~1problem+json/examples/service_authentication_denied"]}}},{"code":"403","schemaId":"components/schemas/ForbiddenProblem","exampleIds":["paths/~1addresses~1{address}/patch/responses/403/content/application~1problem+json/examples/insufficient_permissions"],"mediaTypes":["application/problem+json"],"mediaTypeContent":{"application/problem+json":{"schemaId":"components/schemas/ForbiddenProblem","exampleIds":["paths/~1addresses~1{address}/patch/responses/403/content/application~1problem+json/examples/insufficient_permissions"]}}},{"code":"404","schemaId":"components/schemas/NotFoundProblem","exampleIds":["paths/~1addresses~1{address}/patch/responses/404/content/application~1problem+json/examples/address_not_found","paths/~1addresses~1{address}/patch/responses/404/content/application~1problem+json/examples/invoice_not_found"],"mediaTypes":["application/problem+json"],"mediaTypeContent":{"application/problem+json":{"schemaId":"components/schemas/NotFoundProblem","exampleIds":["paths/~1addresses~1{address}/patch/responses/404/content/application~1problem+json/examples/address_not_found","paths/~1addresses~1{address}/patch/responses/404/content/application~1problem+json/examples/invoice_not_found"]}}},{"code":"409","schemaId":"components/schemas/ConflictProblem","exampleIds":["paths/~1addresses~1{address}/patch/responses/409/content/application~1problem+json/examples/address_occupied","paths/~1addresses~1{address}/patch/responses/409/content/application~1problem+json/examples/address_in_use","paths/~1addresses~1{address}/patch/responses/409/content/application~1problem+json/examples/subscription_v1_conflict","paths/~1addresses~1{address}/patch/responses/409/content/application~1problem+json/examples/notification_send_in_progress","paths/~1addresses~1{address}/patch/responses/409/content/application~1problem+json/examples/notification_payload_unavailable","paths/~1addresses~1{address}/patch/responses/409/content/application~1problem+json/examples/notification_test_resend_not_allowed"],"mediaTypes":["application/problem+json"],"mediaTypeContent":{"application/problem+json":{"schemaId":"components/schemas/ConflictProblem","exampleIds":["paths/~1addresses~1{address}/patch/responses/409/content/application~1problem+json/examples/address_occupied","paths/~1addresses~1{address}/patch/responses/409/content/application~1problem+json/examples/address_in_use","paths/~1addresses~1{address}/patch/responses/409/content/application~1problem+json/examples/subscription_v1_conflict","paths/~1addresses~1{address}/patch/responses/409/content/application~1problem+json/examples/notification_send_in_progress","paths/~1addresses~1{address}/patch/responses/409/content/application~1problem+json/examples/notification_payload_unavailable","paths/~1addresses~1{address}/patch/responses/409/content/application~1problem+json/examples/notification_test_resend_not_allowed"]}}},{"code":"503","schemaId":"components/schemas/Problem","exampleIds":["paths/~1addresses~1{address}/patch/responses/503/content/application~1problem+json/examples/temporarily_unavailable"],"mediaTypes":["application/problem+json"],"mediaTypeContent":{"application/problem+json":{"schemaId":"components/schemas/Problem","exampleIds":["paths/~1addresses~1{address}/patch/responses/503/content/application~1problem+json/examples/temporarily_unavailable"]}}},{"code":"default","schemaId":"components/schemas/Problem","mediaTypes":["application/problem+json"],"mediaTypeContent":{"application/problem+json":{"schemaId":"components/schemas/Problem"}}}],"examples":[]}]}]},{"nodeType":"container","children":[{"nodeType":"feedback","pageSlug":"/address/patch-address"}],"panels":[]}]},"httpPath":"/addresses/{address}"},{"label":"List UTXOs","deprecated":false,"httpVerb":"get","isAdditionalOperation":false,"isWebhook":false,"type":"link","link":"/apis/platform/api/address/list-bitcoin-utxos","routeSlug":"/apis/platform/api/address/list-bitcoin-utxos","metadata":{"seo":{"title":"List UTXOs","description":"List unspent outputs held by one Bitcoin address on one network, with pagination and sorting."}},"content":{"contentType":"item","itemVariant":"httpItem","meta":{"sourceId":"list-bitcoin-utxos","name":"List UTXOs","isWebhook":false,"pointer":"/paths/~1bitcoin~1utxos/get","hasSamples":false},"children":[{"nodeType":"container","children":[{"nodeType":"header","level":2,"label":"List UTXOs","isWebhook":false,"showPageActions":true}],"panels":[]},{"nodeType":"container","children":[{"nodeType":"header","level":4,"label":"Request","labelTranslationKey":"request","deepLinkSuffix":"request"},{"nodeType":"markdoc","content":"List unspent outputs held by one Bitcoin address on one network, with pagination and sorting."},{"nodeType":"security","requirements":[{"schemes":[{"name":"Auth","scopes":["api:address:read"],"type":"apiKey","in":"header","paramName":"X-Api-Key","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"API key for authenticating requests. Include your key in the "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"X-Api-Key"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" header. Keys can be created in the Vilna Dashboard or via the Management API. The scopes listed per operation indicate which permissions the key must have."},"children":[]}]}]}]}]}]},{"nodeType":"item-content","variant":"query","label":"Query","labelTranslationKey":"query","parameters":[{"name":"chain_gid","in":"query","schemaId":"schema_29","description":"Exactly one Bitcoin network. Repeated values are invalid.","required":true,"example":"bip122:000000000019d6689c085ae165831e93"},{"name":"address","in":"query","schemaId":"schema_27","description":"Bitcoin address whose unspent outputs are listed, in its native format.","required":true,"example":"bc1qxy2kgdygjrsqtzq2n0yrf2493p83kkfjhx0wlh"},{"name":"limit","in":"query","schemaId":"schema_0","description":"Maximum number of items to return."},{"name":"page","in":"query","schemaId":"schema_1","description":"Page number for pagination."},{"name":"sort_by","in":"query","schemaId":"schema_30","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Field to sort results by. Use "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"-"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" prefix for descending order."},"children":[]}]}]}]}],"pointer":"/paths/~1bitcoin~1utxos/get/parameters"}],"panels":[{"children":[{"kind":"code-sample","source":{"kind":"code-sample","operationType":"http","method":"GET","path":"/bitcoin/utxos","servers":[{"url":"/_mock/apis/platform/api","description":"Mock server","isMockServer":true},{"url":"https://api.vilna.io/v2","description":"Vilna API."}],"parameters":{"path":[],"query":[{"name":"chain_gid","in":"query","required":true,"example":"bip122:000000000019d6689c085ae165831e93","schemaId":"components/schemas/ChainGID"},{"name":"address","in":"query","required":true,"example":"bc1qxy2kgdygjrsqtzq2n0yrf2493p83kkfjhx0wlh","schemaId":"components/schemas/AddressValue"},{"name":"limit","in":"query","required":false,"example":20,"schemaId":"schema_0"},{"name":"page","in":"query","required":false,"example":1,"schemaId":"schema_1"},{"name":"sort_by","in":"query","required":false,"example":"-amount","schemaId":"schema_30"}],"querystring":[],"header":[],"cookie":[]},"security":[{"schemes":[{"id":"Auth","type":"apiKey","name":"X-Api-Key","in":"header"}],"scopes":["api:address:read"]}],"responseCodes":["200","400","401","403","404","422","429","502","503","504","default"],"pointer":"/bitcoin/utxos","href":"address/list-bitcoin-utxos","openApiOperationId":"list-bitcoin-utxos","summary":"List UTXOs"},"isWebhook":false,"hideReplay":false,"servers":[{"url":"/_mock/apis/platform/api","description":"Mock server","isMockServer":true},{"url":"https://api.vilna.io/v2","description":"Vilna API."}],"examples":[]}]}]},{"nodeType":"container","children":[{"nodeType":"header","level":4,"label":"Responses","labelTranslationKey":"responses","deepLinkSuffix":"responses"},{"nodeType":"item-content","variant":"responses","responses":[{"code":"200","description":"Paginated list of unspent outputs held by the address.","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"schema_31"}},"schemaId":"schema_31"},{"code":"400","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Bad request (e.g., missing or invalid fields). Invalid text may be reported as address.label_invalid, address.meta_invalid, public_key.label_invalid, invoice.comment_invalid, invoice.metadata_invalid."},"children":[]}]}]}],"mediaType":"application/problem+json","mediaTypes":["application/problem+json"],"mediaTypeContent":{"application/problem+json":{"schemaId":"components/schemas/InvalidRequestProblem","exampleIds":["paths/~1bitcoin~1utxos/get/responses/400/content/application~1problem+json/examples/malformed_json"]}},"schemaId":"components/schemas/InvalidRequestProblem","exampleIds":["paths/~1bitcoin~1utxos/get/responses/400/content/application~1problem+json/examples/malformed_json"]},{"code":"401","description":"Missing or invalid authentication credentials.","mediaType":"application/problem+json","mediaTypes":["application/problem+json"],"mediaTypeContent":{"application/problem+json":{"schemaId":"components/schemas/UnauthorizedProblem","exampleIds":["paths/~1bitcoin~1utxos/get/responses/401/content/application~1problem+json/examples/service_authentication_denied"]}},"schemaId":"components/schemas/UnauthorizedProblem","exampleIds":["paths/~1bitcoin~1utxos/get/responses/401/content/application~1problem+json/examples/service_authentication_denied"]},{"code":"403","description":"Insufficient permissions.","mediaType":"application/problem+json","mediaTypes":["application/problem+json"],"mediaTypeContent":{"application/problem+json":{"schemaId":"components/schemas/ForbiddenProblem","exampleIds":["paths/~1bitcoin~1utxos/get/responses/403/content/application~1problem+json/examples/insufficient_permissions"]}},"schemaId":"components/schemas/ForbiddenProblem","exampleIds":["paths/~1bitcoin~1utxos/get/responses/403/content/application~1problem+json/examples/insufficient_permissions"]},{"code":"404","description":"Requested resource does not exist.","mediaType":"application/problem+json","mediaTypes":["application/problem+json"],"mediaTypeContent":{"application/problem+json":{"schemaId":"components/schemas/NotFoundProblem","exampleIds":["paths/~1bitcoin~1utxos/get/responses/404/content/application~1problem+json/examples/address_not_found","paths/~1bitcoin~1utxos/get/responses/404/content/application~1problem+json/examples/invoice_not_found"]}},"schemaId":"components/schemas/NotFoundProblem","exampleIds":["paths/~1bitcoin~1utxos/get/responses/404/content/application~1problem+json/examples/address_not_found","paths/~1bitcoin~1utxos/get/responses/404/content/application~1problem+json/examples/invoice_not_found"]},{"code":"422","description":"Request preconditions were not met.","mediaType":"application/problem+json","mediaTypes":["application/problem+json"],"mediaTypeContent":{"application/problem+json":{"schemaId":"components/schemas/PreconditionProblem","exampleIds":["paths/~1bitcoin~1utxos/get/responses/422/content/application~1problem+json/examples/invoice_not_cancellable"]}},"schemaId":"components/schemas/PreconditionProblem","exampleIds":["paths/~1bitcoin~1utxos/get/responses/422/content/application~1problem+json/examples/invoice_not_cancellable"]},{"code":"429","description":"Capacity or action cooldown exceeded.","mediaType":"application/problem+json","mediaTypes":["application/problem+json"],"mediaTypeContent":{"application/problem+json":{"schemaId":"components/schemas/Problem"}},"schemaId":"components/schemas/Problem"},{"code":"502","description":"Invalid upstream response or integration failure.","mediaType":"application/problem+json","mediaTypes":["application/problem+json"],"mediaTypeContent":{"application/problem+json":{"schemaId":"components/schemas/Problem"}},"schemaId":"components/schemas/Problem"},{"code":"503","description":"The operation is temporarily unavailable. Please try again later.","mediaType":"application/problem+json","mediaTypes":["application/problem+json"],"mediaTypeContent":{"application/problem+json":{"schemaId":"components/schemas/Problem","exampleIds":["paths/~1bitcoin~1utxos/get/responses/503/content/application~1problem+json/examples/temporarily_unavailable"]}},"schemaId":"components/schemas/Problem","exampleIds":["paths/~1bitcoin~1utxos/get/responses/503/content/application~1problem+json/examples/temporarily_unavailable"]},{"code":"504","description":"Shared request deadline exhausted.","mediaType":"application/problem+json","mediaTypes":["application/problem+json"],"mediaTypeContent":{"application/problem+json":{"schemaId":"components/schemas/Problem"}},"schemaId":"components/schemas/Problem"},{"code":"default","description":"Unexpected error.","mediaType":"application/problem+json","mediaTypes":["application/problem+json"],"mediaTypeContent":{"application/problem+json":{"schemaId":"components/schemas/Problem"}},"schemaId":"components/schemas/Problem"}],"pointer":"/paths/~1bitcoin~1utxos/get/responses"}],"panels":[{"children":[{"kind":"response","responseCodes":[{"code":"200","schemaId":"schema_31","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"schema_31"}}},{"code":"400","schemaId":"components/schemas/InvalidRequestProblem","exampleIds":["paths/~1bitcoin~1utxos/get/responses/400/content/application~1problem+json/examples/malformed_json"],"mediaTypes":["application/problem+json"],"mediaTypeContent":{"application/problem+json":{"schemaId":"components/schemas/InvalidRequestProblem","exampleIds":["paths/~1bitcoin~1utxos/get/responses/400/content/application~1problem+json/examples/malformed_json"]}}},{"code":"401","schemaId":"components/schemas/UnauthorizedProblem","exampleIds":["paths/~1bitcoin~1utxos/get/responses/401/content/application~1problem+json/examples/service_authentication_denied"],"mediaTypes":["application/problem+json"],"mediaTypeContent":{"application/problem+json":{"schemaId":"components/schemas/UnauthorizedProblem","exampleIds":["paths/~1bitcoin~1utxos/get/responses/401/content/application~1problem+json/examples/service_authentication_denied"]}}},{"code":"403","schemaId":"components/schemas/ForbiddenProblem","exampleIds":["paths/~1bitcoin~1utxos/get/responses/403/content/application~1problem+json/examples/insufficient_permissions"],"mediaTypes":["application/problem+json"],"mediaTypeContent":{"application/problem+json":{"schemaId":"components/schemas/ForbiddenProblem","exampleIds":["paths/~1bitcoin~1utxos/get/responses/403/content/application~1problem+json/examples/insufficient_permissions"]}}},{"code":"404","schemaId":"components/schemas/NotFoundProblem","exampleIds":["paths/~1bitcoin~1utxos/get/responses/404/content/application~1problem+json/examples/address_not_found","paths/~1bitcoin~1utxos/get/responses/404/content/application~1problem+json/examples/invoice_not_found"],"mediaTypes":["application/problem+json"],"mediaTypeContent":{"application/problem+json":{"schemaId":"components/schemas/NotFoundProblem","exampleIds":["paths/~1bitcoin~1utxos/get/responses/404/content/application~1problem+json/examples/address_not_found","paths/~1bitcoin~1utxos/get/responses/404/content/application~1problem+json/examples/invoice_not_found"]}}},{"code":"422","schemaId":"components/schemas/PreconditionProblem","exampleIds":["paths/~1bitcoin~1utxos/get/responses/422/content/application~1problem+json/examples/invoice_not_cancellable"],"mediaTypes":["application/problem+json"],"mediaTypeContent":{"application/problem+json":{"schemaId":"components/schemas/PreconditionProblem","exampleIds":["paths/~1bitcoin~1utxos/get/responses/422/content/application~1problem+json/examples/invoice_not_cancellable"]}}},{"code":"429","schemaId":"components/schemas/Problem","mediaTypes":["application/problem+json"],"mediaTypeContent":{"application/problem+json":{"schemaId":"components/schemas/Problem"}}},{"code":"502","schemaId":"components/schemas/Problem","mediaTypes":["application/problem+json"],"mediaTypeContent":{"application/problem+json":{"schemaId":"components/schemas/Problem"}}},{"code":"503","schemaId":"components/schemas/Problem","exampleIds":["paths/~1bitcoin~1utxos/get/responses/503/content/application~1problem+json/examples/temporarily_unavailable"],"mediaTypes":["application/problem+json"],"mediaTypeContent":{"application/problem+json":{"schemaId":"components/schemas/Problem","exampleIds":["paths/~1bitcoin~1utxos/get/responses/503/content/application~1problem+json/examples/temporarily_unavailable"]}}},{"code":"504","schemaId":"components/schemas/Problem","mediaTypes":["application/problem+json"],"mediaTypeContent":{"application/problem+json":{"schemaId":"components/schemas/Problem"}}},{"code":"default","schemaId":"components/schemas/Problem","mediaTypes":["application/problem+json"],"mediaTypeContent":{"application/problem+json":{"schemaId":"components/schemas/Problem"}}}],"examples":[]}]}]},{"nodeType":"container","children":[{"nodeType":"feedback","pageSlug":"/address/list-bitcoin-utxos"}],"panels":[]}]},"httpPath":"/bitcoin/utxos"}],"content":{"contentType":"group","meta":{"name":"address"},"children":[{"nodeType":"container","children":[{"nodeType":"header","level":2,"label":"Addresses","showPageActions":true},{"nodeType":"markdoc","content":"List, import, update, and delete tracked blockchain addresses."}],"panels":[{"children":[{"kind":"group-items","title":"Operations","titleTranslationKey":"operations","items":[{"title":"/public-keys/{public_key_id}/addresses","summary":"List public key addresses","prefix":{"name":"get","color":"get"},"badges":[],"link":"/address/list-public-key-addresses","deprecated":false},{"title":"/public-keys/{public_key_id}/addresses","summary":"Generate public key addresses","prefix":{"name":"post","color":"post"},"badges":[],"link":"/address/generate-public-key-addresses","deprecated":false},{"title":"/addresses","summary":"List addresses","prefix":{"name":"get","color":"get"},"badges":[],"link":"/address/list-addresses","deprecated":false},{"title":"/addresses/external","summary":"Create external address","prefix":{"name":"post","color":"post"},"badges":[],"link":"/address/create-external-address","deprecated":false},{"title":"/addresses/hd","summary":"List HD addresses","prefix":{"name":"get","color":"get"},"badges":[],"link":"/address/list-hd-addresses","deprecated":false},{"title":"/addresses/{address}","summary":"Delete address","prefix":{"name":"delete","color":"delete"},"badges":[],"link":"/address/delete-address","deprecated":false},{"title":"/addresses/{address}","summary":"Get address","prefix":{"name":"get","color":"get"},"badges":[],"link":"/address/get-address","deprecated":false},{"title":"/addresses/{address}","summary":"Update address","prefix":{"name":"patch","color":"patch"},"badges":[],"link":"/address/patch-address","deprecated":false},{"title":"/bitcoin/utxos","summary":"List UTXOs","prefix":{"name":"get","color":"get"},"badges":[],"link":"/address/list-bitcoin-utxos","deprecated":false}]}]}]}]}},{"type":"group","label":"Address Tags","link":"/apis/platform/api/address_tag","routeSlug":"/apis/platform/api/address_tag","items":[{"label":"List address tags","deprecated":false,"httpVerb":"get","isAdditionalOperation":false,"isWebhook":false,"type":"link","link":"/apis/platform/api/address_tag/list-address-tags","routeSlug":"/apis/platform/api/address_tag/list-address-tags","metadata":{"seo":{"title":"List address tags","description":"List address tags with pagination."}},"content":{"contentType":"item","itemVariant":"httpItem","meta":{"sourceId":"list-address-tags","name":"List address tags","isWebhook":false,"pointer":"/paths/~1address-tags/get","hasSamples":false},"children":[{"nodeType":"container","children":[{"nodeType":"header","level":2,"label":"List address tags","isWebhook":false,"showPageActions":true}],"panels":[]},{"nodeType":"container","children":[{"nodeType":"header","level":4,"label":"Request","labelTranslationKey":"request","deepLinkSuffix":"request"},{"nodeType":"markdoc","content":"List address tags with pagination."},{"nodeType":"security","requirements":[{"schemes":[{"name":"Auth","scopes":["api:address_tag:read"],"type":"apiKey","in":"header","paramName":"X-Api-Key","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"API key for authenticating requests. Include your key in the "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"X-Api-Key"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" header. Keys can be created in the Vilna Dashboard or via the Management API. The scopes listed per operation indicate which permissions the key must have."},"children":[]}]}]}]}]}]},{"nodeType":"item-content","variant":"query","label":"Query","labelTranslationKey":"query","parameters":[{"name":"limit","in":"query","schemaId":"schema_0","description":"Maximum number of items to return."},{"name":"page","in":"query","schemaId":"schema_1","description":"Page number for pagination."},{"name":"sort_by","in":"query","schemaId":"schema_32","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Field to sort results by. Use "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"-"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" prefix for descending order."},"children":[]}]}]}]},{"name":"search","in":"query","schemaId":"schema_33","description":"Filter address tags by name (partial match, case-insensitive).","example":"Hot Wallets"}],"pointer":"/paths/~1address-tags/get/parameters"}],"panels":[{"children":[{"kind":"code-sample","source":{"kind":"code-sample","operationType":"http","method":"GET","path":"/address-tags","servers":[{"url":"/_mock/apis/platform/api","description":"Mock server","isMockServer":true},{"url":"https://api.vilna.io/v2","description":"Vilna API."}],"parameters":{"path":[],"query":[{"name":"limit","in":"query","required":false,"example":20,"schemaId":"schema_0"},{"name":"page","in":"query","required":false,"example":1,"schemaId":"schema_1"},{"name":"sort_by","in":"query","required":false,"example":"created_at","schemaId":"schema_32"},{"name":"search","in":"query","required":false,"example":"Hot Wallets","schemaId":"schema_33"}],"querystring":[],"header":[],"cookie":[]},"security":[{"schemes":[{"id":"Auth","type":"apiKey","name":"X-Api-Key","in":"header"}],"scopes":["api:address_tag:read"]}],"responseCodes":["200","400","401","403","503","default"],"pointer":"/address-tags","href":"address_tag/list-address-tags","openApiOperationId":"list-address-tags","summary":"List address tags"},"isWebhook":false,"hideReplay":false,"servers":[{"url":"/_mock/apis/platform/api","description":"Mock server","isMockServer":true},{"url":"https://api.vilna.io/v2","description":"Vilna API."}],"examples":[]}]}]},{"nodeType":"container","children":[{"nodeType":"header","level":4,"label":"Responses","labelTranslationKey":"responses","deepLinkSuffix":"responses"},{"nodeType":"item-content","variant":"responses","responses":[{"code":"200","description":"List of address tags with pagination.","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"schema_34"}},"schemaId":"schema_34"},{"code":"400","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Bad request (e.g., missing or invalid fields). Invalid text may be reported as address.label_invalid, address.meta_invalid, public_key.label_invalid, invoice.comment_invalid, invoice.metadata_invalid."},"children":[]}]}]}],"mediaType":"application/problem+json","mediaTypes":["application/problem+json"],"mediaTypeContent":{"application/problem+json":{"schemaId":"components/schemas/InvalidRequestProblem","exampleIds":["paths/~1address-tags/get/responses/400/content/application~1problem+json/examples/malformed_json"]}},"schemaId":"components/schemas/InvalidRequestProblem","exampleIds":["paths/~1address-tags/get/responses/400/content/application~1problem+json/examples/malformed_json"]},{"code":"401","description":"Missing or invalid authentication credentials.","mediaType":"application/problem+json","mediaTypes":["application/problem+json"],"mediaTypeContent":{"application/problem+json":{"schemaId":"components/schemas/UnauthorizedProblem","exampleIds":["paths/~1address-tags/get/responses/401/content/application~1problem+json/examples/service_authentication_denied"]}},"schemaId":"components/schemas/UnauthorizedProblem","exampleIds":["paths/~1address-tags/get/responses/401/content/application~1problem+json/examples/service_authentication_denied"]},{"code":"403","description":"Insufficient permissions.","mediaType":"application/problem+json","mediaTypes":["application/problem+json"],"mediaTypeContent":{"application/problem+json":{"schemaId":"components/schemas/ForbiddenProblem","exampleIds":["paths/~1address-tags/get/responses/403/content/application~1problem+json/examples/insufficient_permissions"]}},"schemaId":"components/schemas/ForbiddenProblem","exampleIds":["paths/~1address-tags/get/responses/403/content/application~1problem+json/examples/insufficient_permissions"]},{"code":"503","description":"The operation is temporarily unavailable. Please try again later.","mediaType":"application/problem+json","mediaTypes":["application/problem+json"],"mediaTypeContent":{"application/problem+json":{"schemaId":"components/schemas/Problem","exampleIds":["paths/~1address-tags/get/responses/503/content/application~1problem+json/examples/temporarily_unavailable"]}},"schemaId":"components/schemas/Problem","exampleIds":["paths/~1address-tags/get/responses/503/content/application~1problem+json/examples/temporarily_unavailable"]},{"code":"default","description":"Unexpected error.","mediaType":"application/problem+json","mediaTypes":["application/problem+json"],"mediaTypeContent":{"application/problem+json":{"schemaId":"components/schemas/Problem"}},"schemaId":"components/schemas/Problem"}],"pointer":"/paths/~1address-tags/get/responses"}],"panels":[{"children":[{"kind":"response","responseCodes":[{"code":"200","schemaId":"schema_34","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"schema_34"}}},{"code":"400","schemaId":"components/schemas/InvalidRequestProblem","exampleIds":["paths/~1address-tags/get/responses/400/content/application~1problem+json/examples/malformed_json"],"mediaTypes":["application/problem+json"],"mediaTypeContent":{"application/problem+json":{"schemaId":"components/schemas/InvalidRequestProblem","exampleIds":["paths/~1address-tags/get/responses/400/content/application~1problem+json/examples/malformed_json"]}}},{"code":"401","schemaId":"components/schemas/UnauthorizedProblem","exampleIds":["paths/~1address-tags/get/responses/401/content/application~1problem+json/examples/service_authentication_denied"],"mediaTypes":["application/problem+json"],"mediaTypeContent":{"application/problem+json":{"schemaId":"components/schemas/UnauthorizedProblem","exampleIds":["paths/~1address-tags/get/responses/401/content/application~1problem+json/examples/service_authentication_denied"]}}},{"code":"403","schemaId":"components/schemas/ForbiddenProblem","exampleIds":["paths/~1address-tags/get/responses/403/content/application~1problem+json/examples/insufficient_permissions"],"mediaTypes":["application/problem+json"],"mediaTypeContent":{"application/problem+json":{"schemaId":"components/schemas/ForbiddenProblem","exampleIds":["paths/~1address-tags/get/responses/403/content/application~1problem+json/examples/insufficient_permissions"]}}},{"code":"503","schemaId":"components/schemas/Problem","exampleIds":["paths/~1address-tags/get/responses/503/content/application~1problem+json/examples/temporarily_unavailable"],"mediaTypes":["application/problem+json"],"mediaTypeContent":{"application/problem+json":{"schemaId":"components/schemas/Problem","exampleIds":["paths/~1address-tags/get/responses/503/content/application~1problem+json/examples/temporarily_unavailable"]}}},{"code":"default","schemaId":"components/schemas/Problem","mediaTypes":["application/problem+json"],"mediaTypeContent":{"application/problem+json":{"schemaId":"components/schemas/Problem"}}}],"examples":[]}]}]},{"nodeType":"container","children":[{"nodeType":"feedback","pageSlug":"/address_tag/list-address-tags"}],"panels":[]}]},"httpPath":"/address-tags"},{"label":"Create address tag","deprecated":false,"httpVerb":"post","isAdditionalOperation":false,"isWebhook":false,"type":"link","link":"/apis/platform/api/address_tag/create-address-tag","routeSlug":"/apis/platform/api/address_tag/create-address-tag","metadata":{"seo":{"title":"Create address tag","description":"Create a named collection of addresses within a project. Tag names are unique per project (case-insensitive). Creating a tag whose name already exists returns the existing tag."}},"content":{"contentType":"item","itemVariant":"httpItem","meta":{"sourceId":"create-address-tag","name":"Create address tag","isWebhook":false,"pointer":"/paths/~1address-tags/post","hasSamples":true},"children":[{"nodeType":"container","children":[{"nodeType":"header","level":2,"label":"Create address tag","isWebhook":false,"showPageActions":true}],"panels":[]},{"nodeType":"container","children":[{"nodeType":"header","level":4,"label":"Request","labelTranslationKey":"request","deepLinkSuffix":"request"},{"nodeType":"markdoc","content":"Create a named collection of addresses within a project. Tag names are\nunique per project (case-insensitive). Creating a tag whose name already\nexists returns the existing tag.\n"},{"nodeType":"security","requirements":[{"schemes":[{"name":"Auth","scopes":["api:address_tag:write"],"type":"apiKey","in":"header","paramName":"X-Api-Key","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"API key for authenticating requests. Include your key in the "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"X-Api-Key"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" header. Keys can be created in the Vilna Dashboard or via the Management API. The scopes listed per operation indicate which permissions the key must have."},"children":[]}]}]}]}]}]},{"nodeType":"item-content","variant":"headers","label":"Headers","labelTranslationKey":"header","parameters":[{"name":"Idempotency-Key","in":"header","schemaId":"schema_14","description":"Case-sensitive opaque key for one mutation intent. Send exactly one header occurrence containing 1 to 128 visible ASCII bytes (0x21..0x7e). Commas are literal data; do not trim, lowercase or require UUID syntax. Reuse the same key for retries, with current authorization checked on every attempt. Repeated header occurrences are rejected.\n","required":true}],"pointer":"/paths/~1address-tags/post/parameters"},{"nodeType":"item-content","variant":"body","label":"Request Body","labelTranslationKey":"body","required":true,"mediaTypes":["application/json"],"mediaTypeSchemas":{"application/json":{"schemaId":"components/schemas/CreateAddressTagRequest"}},"schemaId":"components/schemas/CreateAddressTagRequest","pointer":"/paths/~1address-tags/post/requestBody"}],"panels":[{"children":[{"kind":"code-sample","source":{"kind":"code-sample","operationType":"http","method":"POST","path":"/address-tags","servers":[{"url":"/_mock/apis/platform/api","description":"Mock server","isMockServer":true},{"url":"https://api.vilna.io/v2","description":"Vilna API."}],"parameters":{"path":[],"query":[],"querystring":[],"header":[{"name":"Idempotency-Key","in":"header","required":true,"schemaId":"schema_14"}],"cookie":[]},"security":[{"schemes":[{"id":"Auth","type":"apiKey","name":"X-Api-Key","in":"header"}],"scopes":["api:address_tag:write"]}],"requestBody":{"application/json":{"schemaId":"components/schemas/CreateAddressTagRequest"}},"responseCodes":["200","201","400","401","403","409","429","503","default"],"pointer":"/address-tags","href":"address_tag/create-address-tag","openApiOperationId":"create-address-tag","summary":"Create address tag"},"isWebhook":false,"hideReplay":false,"servers":[{"url":"/_mock/apis/platform/api","description":"Mock server","isMockServer":true},{"url":"https://api.vilna.io/v2","description":"Vilna API."}],"schemaId":"components/schemas/CreateAddressTagRequest","mediaTypes":["application/json"],"mediaTypeSchemas":{"application/json":{"schemaId":"components/schemas/CreateAddressTagRequest"}},"examples":[]}]}]},{"nodeType":"container","children":[{"nodeType":"header","level":4,"label":"Responses","labelTranslationKey":"responses","deepLinkSuffix":"responses"},{"nodeType":"item-content","variant":"responses","responses":[{"code":"200","description":"Address tag details.","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"schema_35"}},"schemaId":"schema_35"},{"code":"201","description":"Address tag details.","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"schema_35"}},"schemaId":"schema_35"},{"code":"400","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Bad request (e.g., missing or invalid fields). Invalid text may be reported as address.label_invalid, address.meta_invalid, public_key.label_invalid, invoice.comment_invalid, invoice.metadata_invalid."},"children":[]}]}]}],"mediaType":"application/problem+json","mediaTypes":["application/problem+json"],"mediaTypeContent":{"application/problem+json":{"schemaId":"components/schemas/InvalidRequestProblem","exampleIds":["paths/~1address-tags/post/responses/400/content/application~1problem+json/examples/malformed_json"]}},"schemaId":"components/schemas/InvalidRequestProblem","exampleIds":["paths/~1address-tags/post/responses/400/content/application~1problem+json/examples/malformed_json"]},{"code":"401","description":"Missing or invalid authentication credentials.","mediaType":"application/problem+json","mediaTypes":["application/problem+json"],"mediaTypeContent":{"application/problem+json":{"schemaId":"components/schemas/UnauthorizedProblem","exampleIds":["paths/~1address-tags/post/responses/401/content/application~1problem+json/examples/service_authentication_denied"]}},"schemaId":"components/schemas/UnauthorizedProblem","exampleIds":["paths/~1address-tags/post/responses/401/content/application~1problem+json/examples/service_authentication_denied"]},{"code":"403","description":"Insufficient permissions.","mediaType":"application/problem+json","mediaTypes":["application/problem+json"],"mediaTypeContent":{"application/problem+json":{"schemaId":"components/schemas/ForbiddenProblem","exampleIds":["paths/~1address-tags/post/responses/403/content/application~1problem+json/examples/insufficient_permissions"]}},"schemaId":"components/schemas/ForbiddenProblem","exampleIds":["paths/~1address-tags/post/responses/403/content/application~1problem+json/examples/insufficient_permissions"]},{"code":"409","description":"Request conflicts with the current resource state.","mediaType":"application/problem+json","mediaTypes":["application/problem+json"],"mediaTypeContent":{"application/problem+json":{"schemaId":"components/schemas/ConflictProblem","exampleIds":["paths/~1address-tags/post/responses/409/content/application~1problem+json/examples/address_occupied","paths/~1address-tags/post/responses/409/content/application~1problem+json/examples/address_in_use","paths/~1address-tags/post/responses/409/content/application~1problem+json/examples/subscription_v1_conflict","paths/~1address-tags/post/responses/409/content/application~1problem+json/examples/notification_send_in_progress","paths/~1address-tags/post/responses/409/content/application~1problem+json/examples/notification_payload_unavailable","paths/~1address-tags/post/responses/409/content/application~1problem+json/examples/notification_test_resend_not_allowed"]}},"schemaId":"components/schemas/ConflictProblem","exampleIds":["paths/~1address-tags/post/responses/409/content/application~1problem+json/examples/address_occupied","paths/~1address-tags/post/responses/409/content/application~1problem+json/examples/address_in_use","paths/~1address-tags/post/responses/409/content/application~1problem+json/examples/subscription_v1_conflict","paths/~1address-tags/post/responses/409/content/application~1problem+json/examples/notification_send_in_progress","paths/~1address-tags/post/responses/409/content/application~1problem+json/examples/notification_payload_unavailable","paths/~1address-tags/post/responses/409/content/application~1problem+json/examples/notification_test_resend_not_allowed"]},{"code":"429","description":"Resource quota exceeded. The response includes the effective limit for this scope. The applicable code and limit depend on the operation; examples illustrate different limits.","mediaType":"application/problem+json","mediaTypes":["application/problem+json"],"mediaTypeContent":{"application/problem+json":{"schemaId":"components/schemas/QuotaExceededProblem","exampleIds":["paths/~1address-tags/post/responses/429/content/application~1problem+json/examples/address_quota","paths/~1address-tags/post/responses/429/content/application~1problem+json/examples/creation_prohibited"]}},"schemaId":"components/schemas/QuotaExceededProblem","exampleIds":["paths/~1address-tags/post/responses/429/content/application~1problem+json/examples/address_quota","paths/~1address-tags/post/responses/429/content/application~1problem+json/examples/creation_prohibited"]},{"code":"503","description":"The operation is temporarily unavailable. Please try again later.","mediaType":"application/problem+json","mediaTypes":["application/problem+json"],"mediaTypeContent":{"application/problem+json":{"schemaId":"components/schemas/Problem","exampleIds":["paths/~1address-tags/post/responses/503/content/application~1problem+json/examples/temporarily_unavailable"]}},"schemaId":"components/schemas/Problem","exampleIds":["paths/~1address-tags/post/responses/503/content/application~1problem+json/examples/temporarily_unavailable"]},{"code":"default","description":"Unexpected error.","mediaType":"application/problem+json","mediaTypes":["application/problem+json"],"mediaTypeContent":{"application/problem+json":{"schemaId":"components/schemas/Problem"}},"schemaId":"components/schemas/Problem"}],"pointer":"/paths/~1address-tags/post/responses"}],"panels":[{"children":[{"kind":"response","responseCodes":[{"code":"200","schemaId":"schema_35","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"schema_35"}}},{"code":"201","schemaId":"schema_35","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"schema_35"}}},{"code":"400","schemaId":"components/schemas/InvalidRequestProblem","exampleIds":["paths/~1address-tags/post/responses/400/content/application~1problem+json/examples/malformed_json"],"mediaTypes":["application/problem+json"],"mediaTypeContent":{"application/problem+json":{"schemaId":"components/schemas/InvalidRequestProblem","exampleIds":["paths/~1address-tags/post/responses/400/content/application~1problem+json/examples/malformed_json"]}}},{"code":"401","schemaId":"components/schemas/UnauthorizedProblem","exampleIds":["paths/~1address-tags/post/responses/401/content/application~1problem+json/examples/service_authentication_denied"],"mediaTypes":["application/problem+json"],"mediaTypeContent":{"application/problem+json":{"schemaId":"components/schemas/UnauthorizedProblem","exampleIds":["paths/~1address-tags/post/responses/401/content/application~1problem+json/examples/service_authentication_denied"]}}},{"code":"403","schemaId":"components/schemas/ForbiddenProblem","exampleIds":["paths/~1address-tags/post/responses/403/content/application~1problem+json/examples/insufficient_permissions"],"mediaTypes":["application/problem+json"],"mediaTypeContent":{"application/problem+json":{"schemaId":"components/schemas/ForbiddenProblem","exampleIds":["paths/~1address-tags/post/responses/403/content/application~1problem+json/examples/insufficient_permissions"]}}},{"code":"409","schemaId":"components/schemas/ConflictProblem","exampleIds":["paths/~1address-tags/post/responses/409/content/application~1problem+json/examples/address_occupied","paths/~1address-tags/post/responses/409/content/application~1problem+json/examples/address_in_use","paths/~1address-tags/post/responses/409/content/application~1problem+json/examples/subscription_v1_conflict","paths/~1address-tags/post/responses/409/content/application~1problem+json/examples/notification_send_in_progress","paths/~1address-tags/post/responses/409/content/application~1problem+json/examples/notification_payload_unavailable","paths/~1address-tags/post/responses/409/content/application~1problem+json/examples/notification_test_resend_not_allowed"],"mediaTypes":["application/problem+json"],"mediaTypeContent":{"application/problem+json":{"schemaId":"components/schemas/ConflictProblem","exampleIds":["paths/~1address-tags/post/responses/409/content/application~1problem+json/examples/address_occupied","paths/~1address-tags/post/responses/409/content/application~1problem+json/examples/address_in_use","paths/~1address-tags/post/responses/409/content/application~1problem+json/examples/subscription_v1_conflict","paths/~1address-tags/post/responses/409/content/application~1problem+json/examples/notification_send_in_progress","paths/~1address-tags/post/responses/409/content/application~1problem+json/examples/notification_payload_unavailable","paths/~1address-tags/post/responses/409/content/application~1problem+json/examples/notification_test_resend_not_allowed"]}}},{"code":"429","schemaId":"components/schemas/QuotaExceededProblem","exampleIds":["paths/~1address-tags/post/responses/429/content/application~1problem+json/examples/address_quota","paths/~1address-tags/post/responses/429/content/application~1problem+json/examples/creation_prohibited"],"mediaTypes":["application/problem+json"],"mediaTypeContent":{"application/problem+json":{"schemaId":"components/schemas/QuotaExceededProblem","exampleIds":["paths/~1address-tags/post/responses/429/content/application~1problem+json/examples/address_quota","paths/~1address-tags/post/responses/429/content/application~1problem+json/examples/creation_prohibited"]}}},{"code":"503","schemaId":"components/schemas/Problem","exampleIds":["paths/~1address-tags/post/responses/503/content/application~1problem+json/examples/temporarily_unavailable"],"mediaTypes":["application/problem+json"],"mediaTypeContent":{"application/problem+json":{"schemaId":"components/schemas/Problem","exampleIds":["paths/~1address-tags/post/responses/503/content/application~1problem+json/examples/temporarily_unavailable"]}}},{"code":"default","schemaId":"components/schemas/Problem","mediaTypes":["application/problem+json"],"mediaTypeContent":{"application/problem+json":{"schemaId":"components/schemas/Problem"}}}],"examples":[]}]}]},{"nodeType":"container","children":[{"nodeType":"feedback","pageSlug":"/address_tag/create-address-tag"}],"panels":[]}]},"httpPath":"/address-tags"},{"label":"Get address tag","deprecated":false,"httpVerb":"get","isAdditionalOperation":false,"isWebhook":false,"type":"link","link":"/apis/platform/api/address_tag/get-address-tag","routeSlug":"/apis/platform/api/address_tag/get-address-tag","metadata":{"seo":{"title":"Get address tag","description":"Get an address tag."}},"content":{"contentType":"item","itemVariant":"httpItem","meta":{"sourceId":"get-address-tag","name":"Get address tag","isWebhook":false,"pointer":"/paths/~1address-tags~1{address_tag_id}/get","hasSamples":false},"children":[{"nodeType":"container","children":[{"nodeType":"header","level":2,"label":"Get address tag","isWebhook":false,"showPageActions":true}],"panels":[]},{"nodeType":"container","children":[{"nodeType":"header","level":4,"label":"Request","labelTranslationKey":"request","deepLinkSuffix":"request"},{"nodeType":"markdoc","content":"Get an address tag."},{"nodeType":"security","requirements":[{"schemes":[{"name":"Auth","scopes":["api:address_tag:read"],"type":"apiKey","in":"header","paramName":"X-Api-Key","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"API key for authenticating requests. Include your key in the "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"X-Api-Key"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" header. Keys can be created in the Vilna Dashboard or via the Management API. The scopes listed per operation indicate which permissions the key must have."},"children":[]}]}]}]}]}]},{"nodeType":"item-content","variant":"path","label":"Path","labelTranslationKey":"path","parameters":[{"name":"address_tag_id","in":"path","schemaId":"schema_17","description":"Unique identifier (UUID) of the address tag.","required":true}],"pointer":"/paths/~1address-tags~1{address_tag_id}/get/parameters"}],"panels":[{"children":[{"kind":"code-sample","source":{"kind":"code-sample","operationType":"http","method":"GET","path":"/address-tags/{address_tag_id}","servers":[{"url":"/_mock/apis/platform/api","description":"Mock server","isMockServer":true},{"url":"https://api.vilna.io/v2","description":"Vilna API."}],"parameters":{"path":[{"name":"address_tag_id","in":"path","required":true,"example":"550e8400-e29b-41d4-a716-446655440000","schemaId":"components/schemas/UUID"}],"query":[],"querystring":[],"header":[],"cookie":[]},"security":[{"schemes":[{"id":"Auth","type":"apiKey","name":"X-Api-Key","in":"header"}],"scopes":["api:address_tag:read"]}],"responseCodes":["200","400","401","403","404","503","default"],"pointer":"/address-tags/{address_tag_id}","href":"address_tag/get-address-tag","openApiOperationId":"get-address-tag","summary":"Get address tag"},"isWebhook":false,"hideReplay":false,"servers":[{"url":"/_mock/apis/platform/api","description":"Mock server","isMockServer":true},{"url":"https://api.vilna.io/v2","description":"Vilna API."}],"examples":[]}]}]},{"nodeType":"container","children":[{"nodeType":"header","level":4,"label":"Responses","labelTranslationKey":"responses","deepLinkSuffix":"responses"},{"nodeType":"item-content","variant":"responses","responses":[{"code":"200","description":"Address tag details.","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"schema_35"}},"schemaId":"schema_35"},{"code":"400","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Bad request (e.g., missing or invalid fields). Invalid text may be reported as address.label_invalid, address.meta_invalid, public_key.label_invalid, invoice.comment_invalid, invoice.metadata_invalid."},"children":[]}]}]}],"mediaType":"application/problem+json","mediaTypes":["application/problem+json"],"mediaTypeContent":{"application/problem+json":{"schemaId":"components/schemas/InvalidRequestProblem","exampleIds":["paths/~1address-tags~1{address_tag_id}/get/responses/400/content/application~1problem+json/examples/malformed_json"]}},"schemaId":"components/schemas/InvalidRequestProblem","exampleIds":["paths/~1address-tags~1{address_tag_id}/get/responses/400/content/application~1problem+json/examples/malformed_json"]},{"code":"401","description":"Missing or invalid authentication credentials.","mediaType":"application/problem+json","mediaTypes":["application/problem+json"],"mediaTypeContent":{"application/problem+json":{"schemaId":"components/schemas/UnauthorizedProblem","exampleIds":["paths/~1address-tags~1{address_tag_id}/get/responses/401/content/application~1problem+json/examples/service_authentication_denied"]}},"schemaId":"components/schemas/UnauthorizedProblem","exampleIds":["paths/~1address-tags~1{address_tag_id}/get/responses/401/content/application~1problem+json/examples/service_authentication_denied"]},{"code":"403","description":"Insufficient permissions.","mediaType":"application/problem+json","mediaTypes":["application/problem+json"],"mediaTypeContent":{"application/problem+json":{"schemaId":"components/schemas/ForbiddenProblem","exampleIds":["paths/~1address-tags~1{address_tag_id}/get/responses/403/content/application~1problem+json/examples/insufficient_permissions"]}},"schemaId":"components/schemas/ForbiddenProblem","exampleIds":["paths/~1address-tags~1{address_tag_id}/get/responses/403/content/application~1problem+json/examples/insufficient_permissions"]},{"code":"404","description":"Requested resource does not exist.","mediaType":"application/problem+json","mediaTypes":["application/problem+json"],"mediaTypeContent":{"application/problem+json":{"schemaId":"components/schemas/NotFoundProblem","exampleIds":["paths/~1address-tags~1{address_tag_id}/get/responses/404/content/application~1problem+json/examples/address_not_found","paths/~1address-tags~1{address_tag_id}/get/responses/404/content/application~1problem+json/examples/invoice_not_found"]}},"schemaId":"components/schemas/NotFoundProblem","exampleIds":["paths/~1address-tags~1{address_tag_id}/get/responses/404/content/application~1problem+json/examples/address_not_found","paths/~1address-tags~1{address_tag_id}/get/responses/404/content/application~1problem+json/examples/invoice_not_found"]},{"code":"503","description":"The operation is temporarily unavailable. Please try again later.","mediaType":"application/problem+json","mediaTypes":["application/problem+json"],"mediaTypeContent":{"application/problem+json":{"schemaId":"components/schemas/Problem","exampleIds":["paths/~1address-tags~1{address_tag_id}/get/responses/503/content/application~1problem+json/examples/temporarily_unavailable"]}},"schemaId":"components/schemas/Problem","exampleIds":["paths/~1address-tags~1{address_tag_id}/get/responses/503/content/application~1problem+json/examples/temporarily_unavailable"]},{"code":"default","description":"Unexpected error.","mediaType":"application/problem+json","mediaTypes":["application/problem+json"],"mediaTypeContent":{"application/problem+json":{"schemaId":"components/schemas/Problem"}},"schemaId":"components/schemas/Problem"}],"pointer":"/paths/~1address-tags~1{address_tag_id}/get/responses"}],"panels":[{"children":[{"kind":"response","responseCodes":[{"code":"200","schemaId":"schema_35","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"schema_35"}}},{"code":"400","schemaId":"components/schemas/InvalidRequestProblem","exampleIds":["paths/~1address-tags~1{address_tag_id}/get/responses/400/content/application~1problem+json/examples/malformed_json"],"mediaTypes":["application/problem+json"],"mediaTypeContent":{"application/problem+json":{"schemaId":"components/schemas/InvalidRequestProblem","exampleIds":["paths/~1address-tags~1{address_tag_id}/get/responses/400/content/application~1problem+json/examples/malformed_json"]}}},{"code":"401","schemaId":"components/schemas/UnauthorizedProblem","exampleIds":["paths/~1address-tags~1{address_tag_id}/get/responses/401/content/application~1problem+json/examples/service_authentication_denied"],"mediaTypes":["application/problem+json"],"mediaTypeContent":{"application/problem+json":{"schemaId":"components/schemas/UnauthorizedProblem","exampleIds":["paths/~1address-tags~1{address_tag_id}/get/responses/401/content/application~1problem+json/examples/service_authentication_denied"]}}},{"code":"403","schemaId":"components/schemas/ForbiddenProblem","exampleIds":["paths/~1address-tags~1{address_tag_id}/get/responses/403/content/application~1problem+json/examples/insufficient_permissions"],"mediaTypes":["application/problem+json"],"mediaTypeContent":{"application/problem+json":{"schemaId":"components/schemas/ForbiddenProblem","exampleIds":["paths/~1address-tags~1{address_tag_id}/get/responses/403/content/application~1problem+json/examples/insufficient_permissions"]}}},{"code":"404","schemaId":"components/schemas/NotFoundProblem","exampleIds":["paths/~1address-tags~1{address_tag_id}/get/responses/404/content/application~1problem+json/examples/address_not_found","paths/~1address-tags~1{address_tag_id}/get/responses/404/content/application~1problem+json/examples/invoice_not_found"],"mediaTypes":["application/problem+json"],"mediaTypeContent":{"application/problem+json":{"schemaId":"components/schemas/NotFoundProblem","exampleIds":["paths/~1address-tags~1{address_tag_id}/get/responses/404/content/application~1problem+json/examples/address_not_found","paths/~1address-tags~1{address_tag_id}/get/responses/404/content/application~1problem+json/examples/invoice_not_found"]}}},{"code":"503","schemaId":"components/schemas/Problem","exampleIds":["paths/~1address-tags~1{address_tag_id}/get/responses/503/content/application~1problem+json/examples/temporarily_unavailable"],"mediaTypes":["application/problem+json"],"mediaTypeContent":{"application/problem+json":{"schemaId":"components/schemas/Problem","exampleIds":["paths/~1address-tags~1{address_tag_id}/get/responses/503/content/application~1problem+json/examples/temporarily_unavailable"]}}},{"code":"default","schemaId":"components/schemas/Problem","mediaTypes":["application/problem+json"],"mediaTypeContent":{"application/problem+json":{"schemaId":"components/schemas/Problem"}}}],"examples":[]}]}]},{"nodeType":"container","children":[{"nodeType":"feedback","pageSlug":"/address_tag/get-address-tag"}],"panels":[]}]},"httpPath":"/address-tags/{address_tag_id}"},{"label":"Update address tag","deprecated":false,"httpVerb":"patch","isAdditionalOperation":false,"isWebhook":false,"type":"link","link":"/apis/platform/api/address_tag/patch-address-tag","routeSlug":"/apis/platform/api/address_tag/patch-address-tag","metadata":{"seo":{"title":"Update address tag","description":"Rename an address tag."}},"content":{"contentType":"item","itemVariant":"httpItem","meta":{"sourceId":"patch-address-tag","name":"Update address tag","isWebhook":false,"pointer":"/paths/~1address-tags~1{address_tag_id}/patch","hasSamples":true},"children":[{"nodeType":"container","children":[{"nodeType":"header","level":2,"label":"Update address tag","isWebhook":false,"showPageActions":true}],"panels":[]},{"nodeType":"container","children":[{"nodeType":"header","level":4,"label":"Request","labelTranslationKey":"request","deepLinkSuffix":"request"},{"nodeType":"markdoc","content":"Rename an address tag."},{"nodeType":"security","requirements":[{"schemes":[{"name":"Auth","scopes":["api:address_tag:write"],"type":"apiKey","in":"header","paramName":"X-Api-Key","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"API key for authenticating requests. Include your key in the "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"X-Api-Key"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" header. Keys can be created in the Vilna Dashboard or via the Management API. The scopes listed per operation indicate which permissions the key must have."},"children":[]}]}]}]}]}]},{"nodeType":"item-content","variant":"path","label":"Path","labelTranslationKey":"path","parameters":[{"name":"address_tag_id","in":"path","schemaId":"schema_17","description":"Unique identifier (UUID) of the address tag.","required":true}],"pointer":"/paths/~1address-tags~1{address_tag_id}/patch/parameters"},{"nodeType":"item-content","variant":"headers","label":"Headers","labelTranslationKey":"header","parameters":[{"name":"Idempotency-Key","in":"header","schemaId":"schema_14","description":"Case-sensitive opaque key for one mutation intent. Send exactly one header occurrence containing 1 to 128 visible ASCII bytes (0x21..0x7e). Commas are literal data; do not trim, lowercase or require UUID syntax. Reuse the same key for retries, with current authorization checked on every attempt. Repeated header occurrences are rejected.\n","required":true}],"pointer":"/paths/~1address-tags~1{address_tag_id}/patch/parameters"},{"nodeType":"item-content","variant":"body","label":"Request Body","labelTranslationKey":"body","required":true,"mediaTypes":["application/json"],"mediaTypeSchemas":{"application/json":{"schemaId":"components/schemas/UpdateAddressTagRequest"}},"schemaId":"components/schemas/UpdateAddressTagRequest","pointer":"/paths/~1address-tags~1{address_tag_id}/patch/requestBody"}],"panels":[{"children":[{"kind":"code-sample","source":{"kind":"code-sample","operationType":"http","method":"PATCH","path":"/address-tags/{address_tag_id}","servers":[{"url":"/_mock/apis/platform/api","description":"Mock server","isMockServer":true},{"url":"https://api.vilna.io/v2","description":"Vilna API."}],"parameters":{"path":[{"name":"address_tag_id","in":"path","required":true,"example":"550e8400-e29b-41d4-a716-446655440000","schemaId":"components/schemas/UUID"}],"query":[],"querystring":[],"header":[{"name":"Idempotency-Key","in":"header","required":true,"schemaId":"schema_14"}],"cookie":[]},"security":[{"schemes":[{"id":"Auth","type":"apiKey","name":"X-Api-Key","in":"header"}],"scopes":["api:address_tag:write"]}],"requestBody":{"application/json":{"schemaId":"components/schemas/UpdateAddressTagRequest"}},"responseCodes":["200","400","401","403","404","409","503","default"],"pointer":"/address-tags/{address_tag_id}","href":"address_tag/patch-address-tag","openApiOperationId":"patch-address-tag","summary":"Update address tag"},"isWebhook":false,"hideReplay":false,"servers":[{"url":"/_mock/apis/platform/api","description":"Mock server","isMockServer":true},{"url":"https://api.vilna.io/v2","description":"Vilna API."}],"schemaId":"components/schemas/UpdateAddressTagRequest","mediaTypes":["application/json"],"mediaTypeSchemas":{"application/json":{"schemaId":"components/schemas/UpdateAddressTagRequest"}},"examples":[]}]}]},{"nodeType":"container","children":[{"nodeType":"header","level":4,"label":"Responses","labelTranslationKey":"responses","deepLinkSuffix":"responses"},{"nodeType":"item-content","variant":"responses","responses":[{"code":"200","description":"Address tag details.","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"schema_35"}},"schemaId":"schema_35"},{"code":"400","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Bad request (e.g., missing or invalid fields). Invalid text may be reported as address.label_invalid, address.meta_invalid, public_key.label_invalid, invoice.comment_invalid, invoice.metadata_invalid."},"children":[]}]}]}],"mediaType":"application/problem+json","mediaTypes":["application/problem+json"],"mediaTypeContent":{"application/problem+json":{"schemaId":"components/schemas/InvalidRequestProblem","exampleIds":["paths/~1address-tags~1{address_tag_id}/patch/responses/400/content/application~1problem+json/examples/malformed_json"]}},"schemaId":"components/schemas/InvalidRequestProblem","exampleIds":["paths/~1address-tags~1{address_tag_id}/patch/responses/400/content/application~1problem+json/examples/malformed_json"]},{"code":"401","description":"Missing or invalid authentication credentials.","mediaType":"application/problem+json","mediaTypes":["application/problem+json"],"mediaTypeContent":{"application/problem+json":{"schemaId":"components/schemas/UnauthorizedProblem","exampleIds":["paths/~1address-tags~1{address_tag_id}/patch/responses/401/content/application~1problem+json/examples/service_authentication_denied"]}},"schemaId":"components/schemas/UnauthorizedProblem","exampleIds":["paths/~1address-tags~1{address_tag_id}/patch/responses/401/content/application~1problem+json/examples/service_authentication_denied"]},{"code":"403","description":"Insufficient permissions.","mediaType":"application/problem+json","mediaTypes":["application/problem+json"],"mediaTypeContent":{"application/problem+json":{"schemaId":"components/schemas/ForbiddenProblem","exampleIds":["paths/~1address-tags~1{address_tag_id}/patch/responses/403/content/application~1problem+json/examples/insufficient_permissions"]}},"schemaId":"components/schemas/ForbiddenProblem","exampleIds":["paths/~1address-tags~1{address_tag_id}/patch/responses/403/content/application~1problem+json/examples/insufficient_permissions"]},{"code":"404","description":"Requested resource does not exist.","mediaType":"application/problem+json","mediaTypes":["application/problem+json"],"mediaTypeContent":{"application/problem+json":{"schemaId":"components/schemas/NotFoundProblem","exampleIds":["paths/~1address-tags~1{address_tag_id}/patch/responses/404/content/application~1problem+json/examples/address_not_found","paths/~1address-tags~1{address_tag_id}/patch/responses/404/content/application~1problem+json/examples/invoice_not_found"]}},"schemaId":"components/schemas/NotFoundProblem","exampleIds":["paths/~1address-tags~1{address_tag_id}/patch/responses/404/content/application~1problem+json/examples/address_not_found","paths/~1address-tags~1{address_tag_id}/patch/responses/404/content/application~1problem+json/examples/invoice_not_found"]},{"code":"409","description":"Request conflicts with the current resource state.","mediaType":"application/problem+json","mediaTypes":["application/problem+json"],"mediaTypeContent":{"application/problem+json":{"schemaId":"components/schemas/ConflictProblem","exampleIds":["paths/~1address-tags~1{address_tag_id}/patch/responses/409/content/application~1problem+json/examples/address_occupied","paths/~1address-tags~1{address_tag_id}/patch/responses/409/content/application~1problem+json/examples/address_in_use","paths/~1address-tags~1{address_tag_id}/patch/responses/409/content/application~1problem+json/examples/subscription_v1_conflict","paths/~1address-tags~1{address_tag_id}/patch/responses/409/content/application~1problem+json/examples/notification_send_in_progress","paths/~1address-tags~1{address_tag_id}/patch/responses/409/content/application~1problem+json/examples/notification_payload_unavailable","paths/~1address-tags~1{address_tag_id}/patch/responses/409/content/application~1problem+json/examples/notification_test_resend_not_allowed"]}},"schemaId":"components/schemas/ConflictProblem","exampleIds":["paths/~1address-tags~1{address_tag_id}/patch/responses/409/content/application~1problem+json/examples/address_occupied","paths/~1address-tags~1{address_tag_id}/patch/responses/409/content/application~1problem+json/examples/address_in_use","paths/~1address-tags~1{address_tag_id}/patch/responses/409/content/application~1problem+json/examples/subscription_v1_conflict","paths/~1address-tags~1{address_tag_id}/patch/responses/409/content/application~1problem+json/examples/notification_send_in_progress","paths/~1address-tags~1{address_tag_id}/patch/responses/409/content/application~1problem+json/examples/notification_payload_unavailable","paths/~1address-tags~1{address_tag_id}/patch/responses/409/content/application~1problem+json/examples/notification_test_resend_not_allowed"]},{"code":"503","description":"The operation is temporarily unavailable. Please try again later.","mediaType":"application/problem+json","mediaTypes":["application/problem+json"],"mediaTypeContent":{"application/problem+json":{"schemaId":"components/schemas/Problem","exampleIds":["paths/~1address-tags~1{address_tag_id}/patch/responses/503/content/application~1problem+json/examples/temporarily_unavailable"]}},"schemaId":"components/schemas/Problem","exampleIds":["paths/~1address-tags~1{address_tag_id}/patch/responses/503/content/application~1problem+json/examples/temporarily_unavailable"]},{"code":"default","description":"Unexpected error.","mediaType":"application/problem+json","mediaTypes":["application/problem+json"],"mediaTypeContent":{"application/problem+json":{"schemaId":"components/schemas/Problem"}},"schemaId":"components/schemas/Problem"}],"pointer":"/paths/~1address-tags~1{address_tag_id}/patch/responses"}],"panels":[{"children":[{"kind":"response","responseCodes":[{"code":"200","schemaId":"schema_35","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"schema_35"}}},{"code":"400","schemaId":"components/schemas/InvalidRequestProblem","exampleIds":["paths/~1address-tags~1{address_tag_id}/patch/responses/400/content/application~1problem+json/examples/malformed_json"],"mediaTypes":["application/problem+json"],"mediaTypeContent":{"application/problem+json":{"schemaId":"components/schemas/InvalidRequestProblem","exampleIds":["paths/~1address-tags~1{address_tag_id}/patch/responses/400/content/application~1problem+json/examples/malformed_json"]}}},{"code":"401","schemaId":"components/schemas/UnauthorizedProblem","exampleIds":["paths/~1address-tags~1{address_tag_id}/patch/responses/401/content/application~1problem+json/examples/service_authentication_denied"],"mediaTypes":["application/problem+json"],"mediaTypeContent":{"application/problem+json":{"schemaId":"components/schemas/UnauthorizedProblem","exampleIds":["paths/~1address-tags~1{address_tag_id}/patch/responses/401/content/application~1problem+json/examples/service_authentication_denied"]}}},{"code":"403","schemaId":"components/schemas/ForbiddenProblem","exampleIds":["paths/~1address-tags~1{address_tag_id}/patch/responses/403/content/application~1problem+json/examples/insufficient_permissions"],"mediaTypes":["application/problem+json"],"mediaTypeContent":{"application/problem+json":{"schemaId":"components/schemas/ForbiddenProblem","exampleIds":["paths/~1address-tags~1{address_tag_id}/patch/responses/403/content/application~1problem+json/examples/insufficient_permissions"]}}},{"code":"404","schemaId":"components/schemas/NotFoundProblem","exampleIds":["paths/~1address-tags~1{address_tag_id}/patch/responses/404/content/application~1problem+json/examples/address_not_found","paths/~1address-tags~1{address_tag_id}/patch/responses/404/content/application~1problem+json/examples/invoice_not_found"],"mediaTypes":["application/problem+json"],"mediaTypeContent":{"application/problem+json":{"schemaId":"components/schemas/NotFoundProblem","exampleIds":["paths/~1address-tags~1{address_tag_id}/patch/responses/404/content/application~1problem+json/examples/address_not_found","paths/~1address-tags~1{address_tag_id}/patch/responses/404/content/application~1problem+json/examples/invoice_not_found"]}}},{"code":"409","schemaId":"components/schemas/ConflictProblem","exampleIds":["paths/~1address-tags~1{address_tag_id}/patch/responses/409/content/application~1problem+json/examples/address_occupied","paths/~1address-tags~1{address_tag_id}/patch/responses/409/content/application~1problem+json/examples/address_in_use","paths/~1address-tags~1{address_tag_id}/patch/responses/409/content/application~1problem+json/examples/subscription_v1_conflict","paths/~1address-tags~1{address_tag_id}/patch/responses/409/content/application~1problem+json/examples/notification_send_in_progress","paths/~1address-tags~1{address_tag_id}/patch/responses/409/content/application~1problem+json/examples/notification_payload_unavailable","paths/~1address-tags~1{address_tag_id}/patch/responses/409/content/application~1problem+json/examples/notification_test_resend_not_allowed"],"mediaTypes":["application/problem+json"],"mediaTypeContent":{"application/problem+json":{"schemaId":"components/schemas/ConflictProblem","exampleIds":["paths/~1address-tags~1{address_tag_id}/patch/responses/409/content/application~1problem+json/examples/address_occupied","paths/~1address-tags~1{address_tag_id}/patch/responses/409/content/application~1problem+json/examples/address_in_use","paths/~1address-tags~1{address_tag_id}/patch/responses/409/content/application~1problem+json/examples/subscription_v1_conflict","paths/~1address-tags~1{address_tag_id}/patch/responses/409/content/application~1problem+json/examples/notification_send_in_progress","paths/~1address-tags~1{address_tag_id}/patch/responses/409/content/application~1problem+json/examples/notification_payload_unavailable","paths/~1address-tags~1{address_tag_id}/patch/responses/409/content/application~1problem+json/examples/notification_test_resend_not_allowed"]}}},{"code":"503","schemaId":"components/schemas/Problem","exampleIds":["paths/~1address-tags~1{address_tag_id}/patch/responses/503/content/application~1problem+json/examples/temporarily_unavailable"],"mediaTypes":["application/problem+json"],"mediaTypeContent":{"application/problem+json":{"schemaId":"components/schemas/Problem","exampleIds":["paths/~1address-tags~1{address_tag_id}/patch/responses/503/content/application~1problem+json/examples/temporarily_unavailable"]}}},{"code":"default","schemaId":"components/schemas/Problem","mediaTypes":["application/problem+json"],"mediaTypeContent":{"application/problem+json":{"schemaId":"components/schemas/Problem"}}}],"examples":[]}]}]},{"nodeType":"container","children":[{"nodeType":"feedback","pageSlug":"/address_tag/patch-address-tag"}],"panels":[]}]},"httpPath":"/address-tags/{address_tag_id}"},{"label":"Delete address tag","deprecated":false,"httpVerb":"delete","isAdditionalOperation":false,"isWebhook":false,"type":"link","link":"/apis/platform/api/address_tag/delete-address-tag","routeSlug":"/apis/platform/api/address_tag/delete-address-tag","metadata":{"seo":{"title":"Delete address tag","description":"Delete an address tag."}},"content":{"contentType":"item","itemVariant":"httpItem","meta":{"sourceId":"delete-address-tag","name":"Delete address tag","isWebhook":false,"pointer":"/paths/~1address-tags~1{address_tag_id}/delete","hasSamples":false},"children":[{"nodeType":"container","children":[{"nodeType":"header","level":2,"label":"Delete address tag","isWebhook":false,"showPageActions":true}],"panels":[]},{"nodeType":"container","children":[{"nodeType":"header","level":4,"label":"Request","labelTranslationKey":"request","deepLinkSuffix":"request"},{"nodeType":"markdoc","content":"Delete an address tag."},{"nodeType":"security","requirements":[{"schemes":[{"name":"Auth","scopes":["api:address_tag:delete"],"type":"apiKey","in":"header","paramName":"X-Api-Key","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"API key for authenticating requests. Include your key in the "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"X-Api-Key"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" header. Keys can be created in the Vilna Dashboard or via the Management API. The scopes listed per operation indicate which permissions the key must have."},"children":[]}]}]}]}]}]},{"nodeType":"item-content","variant":"path","label":"Path","labelTranslationKey":"path","parameters":[{"name":"address_tag_id","in":"path","schemaId":"schema_17","description":"Unique identifier (UUID) of the address tag.","required":true}],"pointer":"/paths/~1address-tags~1{address_tag_id}/delete/parameters"},{"nodeType":"item-content","variant":"headers","label":"Headers","labelTranslationKey":"header","parameters":[{"name":"Idempotency-Key","in":"header","schemaId":"schema_14","description":"Case-sensitive opaque key for one mutation intent. Send exactly one header occurrence containing 1 to 128 visible ASCII bytes (0x21..0x7e). Commas are literal data; do not trim, lowercase or require UUID syntax. Reuse the same key for retries, with current authorization checked on every attempt. Repeated header occurrences are rejected.\n","required":true}],"pointer":"/paths/~1address-tags~1{address_tag_id}/delete/parameters"}],"panels":[{"children":[{"kind":"code-sample","source":{"kind":"code-sample","operationType":"http","method":"DELETE","path":"/address-tags/{address_tag_id}","servers":[{"url":"/_mock/apis/platform/api","description":"Mock server","isMockServer":true},{"url":"https://api.vilna.io/v2","description":"Vilna API."}],"parameters":{"path":[{"name":"address_tag_id","in":"path","required":true,"example":"550e8400-e29b-41d4-a716-446655440000","schemaId":"components/schemas/UUID"}],"query":[],"querystring":[],"header":[{"name":"Idempotency-Key","in":"header","required":true,"schemaId":"schema_14"}],"cookie":[]},"security":[{"schemes":[{"id":"Auth","type":"apiKey","name":"X-Api-Key","in":"header"}],"scopes":["api:address_tag:delete"]}],"responseCodes":["204","400","401","403","404","409","503","default"],"pointer":"/address-tags/{address_tag_id}","href":"address_tag/delete-address-tag","openApiOperationId":"delete-address-tag","summary":"Delete address tag"},"isWebhook":false,"hideReplay":false,"servers":[{"url":"/_mock/apis/platform/api","description":"Mock server","isMockServer":true},{"url":"https://api.vilna.io/v2","description":"Vilna API."}],"examples":[]}]}]},{"nodeType":"container","children":[{"nodeType":"header","level":4,"label":"Responses","labelTranslationKey":"responses","deepLinkSuffix":"responses"},{"nodeType":"item-content","variant":"responses","responses":[{"code":"204","description":"Successful operation with no response body."},{"code":"400","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Bad request (e.g., missing or invalid fields). Invalid text may be reported as address.label_invalid, address.meta_invalid, public_key.label_invalid, invoice.comment_invalid, invoice.metadata_invalid."},"children":[]}]}]}],"mediaType":"application/problem+json","mediaTypes":["application/problem+json"],"mediaTypeContent":{"application/problem+json":{"schemaId":"components/schemas/InvalidRequestProblem","exampleIds":["paths/~1address-tags~1{address_tag_id}/delete/responses/400/content/application~1problem+json/examples/malformed_json"]}},"schemaId":"components/schemas/InvalidRequestProblem","exampleIds":["paths/~1address-tags~1{address_tag_id}/delete/responses/400/content/application~1problem+json/examples/malformed_json"]},{"code":"401","description":"Missing or invalid authentication credentials.","mediaType":"application/problem+json","mediaTypes":["application/problem+json"],"mediaTypeContent":{"application/problem+json":{"schemaId":"components/schemas/UnauthorizedProblem","exampleIds":["paths/~1address-tags~1{address_tag_id}/delete/responses/401/content/application~1problem+json/examples/service_authentication_denied"]}},"schemaId":"components/schemas/UnauthorizedProblem","exampleIds":["paths/~1address-tags~1{address_tag_id}/delete/responses/401/content/application~1problem+json/examples/service_authentication_denied"]},{"code":"403","description":"Insufficient permissions.","mediaType":"application/problem+json","mediaTypes":["application/problem+json"],"mediaTypeContent":{"application/problem+json":{"schemaId":"components/schemas/ForbiddenProblem","exampleIds":["paths/~1address-tags~1{address_tag_id}/delete/responses/403/content/application~1problem+json/examples/insufficient_permissions"]}},"schemaId":"components/schemas/ForbiddenProblem","exampleIds":["paths/~1address-tags~1{address_tag_id}/delete/responses/403/content/application~1problem+json/examples/insufficient_permissions"]},{"code":"404","description":"Requested resource does not exist.","mediaType":"application/problem+json","mediaTypes":["application/problem+json"],"mediaTypeContent":{"application/problem+json":{"schemaId":"components/schemas/NotFoundProblem","exampleIds":["paths/~1address-tags~1{address_tag_id}/delete/responses/404/content/application~1problem+json/examples/address_not_found","paths/~1address-tags~1{address_tag_id}/delete/responses/404/content/application~1problem+json/examples/invoice_not_found"]}},"schemaId":"components/schemas/NotFoundProblem","exampleIds":["paths/~1address-tags~1{address_tag_id}/delete/responses/404/content/application~1problem+json/examples/address_not_found","paths/~1address-tags~1{address_tag_id}/delete/responses/404/content/application~1problem+json/examples/invoice_not_found"]},{"code":"409","description":"Request conflicts with the current resource state.","mediaType":"application/problem+json","mediaTypes":["application/problem+json"],"mediaTypeContent":{"application/problem+json":{"schemaId":"components/schemas/ConflictProblem","exampleIds":["paths/~1address-tags~1{address_tag_id}/delete/responses/409/content/application~1problem+json/examples/address_occupied","paths/~1address-tags~1{address_tag_id}/delete/responses/409/content/application~1problem+json/examples/address_in_use","paths/~1address-tags~1{address_tag_id}/delete/responses/409/content/application~1problem+json/examples/subscription_v1_conflict","paths/~1address-tags~1{address_tag_id}/delete/responses/409/content/application~1problem+json/examples/notification_send_in_progress","paths/~1address-tags~1{address_tag_id}/delete/responses/409/content/application~1problem+json/examples/notification_payload_unavailable","paths/~1address-tags~1{address_tag_id}/delete/responses/409/content/application~1problem+json/examples/notification_test_resend_not_allowed"]}},"schemaId":"components/schemas/ConflictProblem","exampleIds":["paths/~1address-tags~1{address_tag_id}/delete/responses/409/content/application~1problem+json/examples/address_occupied","paths/~1address-tags~1{address_tag_id}/delete/responses/409/content/application~1problem+json/examples/address_in_use","paths/~1address-tags~1{address_tag_id}/delete/responses/409/content/application~1problem+json/examples/subscription_v1_conflict","paths/~1address-tags~1{address_tag_id}/delete/responses/409/content/application~1problem+json/examples/notification_send_in_progress","paths/~1address-tags~1{address_tag_id}/delete/responses/409/content/application~1problem+json/examples/notification_payload_unavailable","paths/~1address-tags~1{address_tag_id}/delete/responses/409/content/application~1problem+json/examples/notification_test_resend_not_allowed"]},{"code":"503","description":"The operation is temporarily unavailable. Please try again later.","mediaType":"application/problem+json","mediaTypes":["application/problem+json"],"mediaTypeContent":{"application/problem+json":{"schemaId":"components/schemas/Problem","exampleIds":["paths/~1address-tags~1{address_tag_id}/delete/responses/503/content/application~1problem+json/examples/temporarily_unavailable"]}},"schemaId":"components/schemas/Problem","exampleIds":["paths/~1address-tags~1{address_tag_id}/delete/responses/503/content/application~1problem+json/examples/temporarily_unavailable"]},{"code":"default","description":"Unexpected error.","mediaType":"application/problem+json","mediaTypes":["application/problem+json"],"mediaTypeContent":{"application/problem+json":{"schemaId":"components/schemas/Problem"}},"schemaId":"components/schemas/Problem"}],"pointer":"/paths/~1address-tags~1{address_tag_id}/delete/responses"}],"panels":[{"children":[{"kind":"response","responseCodes":[{"code":"204"},{"code":"400","schemaId":"components/schemas/InvalidRequestProblem","exampleIds":["paths/~1address-tags~1{address_tag_id}/delete/responses/400/content/application~1problem+json/examples/malformed_json"],"mediaTypes":["application/problem+json"],"mediaTypeContent":{"application/problem+json":{"schemaId":"components/schemas/InvalidRequestProblem","exampleIds":["paths/~1address-tags~1{address_tag_id}/delete/responses/400/content/application~1problem+json/examples/malformed_json"]}}},{"code":"401","schemaId":"components/schemas/UnauthorizedProblem","exampleIds":["paths/~1address-tags~1{address_tag_id}/delete/responses/401/content/application~1problem+json/examples/service_authentication_denied"],"mediaTypes":["application/problem+json"],"mediaTypeContent":{"application/problem+json":{"schemaId":"components/schemas/UnauthorizedProblem","exampleIds":["paths/~1address-tags~1{address_tag_id}/delete/responses/401/content/application~1problem+json/examples/service_authentication_denied"]}}},{"code":"403","schemaId":"components/schemas/ForbiddenProblem","exampleIds":["paths/~1address-tags~1{address_tag_id}/delete/responses/403/content/application~1problem+json/examples/insufficient_permissions"],"mediaTypes":["application/problem+json"],"mediaTypeContent":{"application/problem+json":{"schemaId":"components/schemas/ForbiddenProblem","exampleIds":["paths/~1address-tags~1{address_tag_id}/delete/responses/403/content/application~1problem+json/examples/insufficient_permissions"]}}},{"code":"404","schemaId":"components/schemas/NotFoundProblem","exampleIds":["paths/~1address-tags~1{address_tag_id}/delete/responses/404/content/application~1problem+json/examples/address_not_found","paths/~1address-tags~1{address_tag_id}/delete/responses/404/content/application~1problem+json/examples/invoice_not_found"],"mediaTypes":["application/problem+json"],"mediaTypeContent":{"application/problem+json":{"schemaId":"components/schemas/NotFoundProblem","exampleIds":["paths/~1address-tags~1{address_tag_id}/delete/responses/404/content/application~1problem+json/examples/address_not_found","paths/~1address-tags~1{address_tag_id}/delete/responses/404/content/application~1problem+json/examples/invoice_not_found"]}}},{"code":"409","schemaId":"components/schemas/ConflictProblem","exampleIds":["paths/~1address-tags~1{address_tag_id}/delete/responses/409/content/application~1problem+json/examples/address_occupied","paths/~1address-tags~1{address_tag_id}/delete/responses/409/content/application~1problem+json/examples/address_in_use","paths/~1address-tags~1{address_tag_id}/delete/responses/409/content/application~1problem+json/examples/subscription_v1_conflict","paths/~1address-tags~1{address_tag_id}/delete/responses/409/content/application~1problem+json/examples/notification_send_in_progress","paths/~1address-tags~1{address_tag_id}/delete/responses/409/content/application~1problem+json/examples/notification_payload_unavailable","paths/~1address-tags~1{address_tag_id}/delete/responses/409/content/application~1problem+json/examples/notification_test_resend_not_allowed"],"mediaTypes":["application/problem+json"],"mediaTypeContent":{"application/problem+json":{"schemaId":"components/schemas/ConflictProblem","exampleIds":["paths/~1address-tags~1{address_tag_id}/delete/responses/409/content/application~1problem+json/examples/address_occupied","paths/~1address-tags~1{address_tag_id}/delete/responses/409/content/application~1problem+json/examples/address_in_use","paths/~1address-tags~1{address_tag_id}/delete/responses/409/content/application~1problem+json/examples/subscription_v1_conflict","paths/~1address-tags~1{address_tag_id}/delete/responses/409/content/application~1problem+json/examples/notification_send_in_progress","paths/~1address-tags~1{address_tag_id}/delete/responses/409/content/application~1problem+json/examples/notification_payload_unavailable","paths/~1address-tags~1{address_tag_id}/delete/responses/409/content/application~1problem+json/examples/notification_test_resend_not_allowed"]}}},{"code":"503","schemaId":"components/schemas/Problem","exampleIds":["paths/~1address-tags~1{address_tag_id}/delete/responses/503/content/application~1problem+json/examples/temporarily_unavailable"],"mediaTypes":["application/problem+json"],"mediaTypeContent":{"application/problem+json":{"schemaId":"components/schemas/Problem","exampleIds":["paths/~1address-tags~1{address_tag_id}/delete/responses/503/content/application~1problem+json/examples/temporarily_unavailable"]}}},{"code":"default","schemaId":"components/schemas/Problem","mediaTypes":["application/problem+json"],"mediaTypeContent":{"application/problem+json":{"schemaId":"components/schemas/Problem"}}}],"examples":[]}]}]},{"nodeType":"container","children":[{"nodeType":"feedback","pageSlug":"/address_tag/delete-address-tag"}],"panels":[]}]},"httpPath":"/address-tags/{address_tag_id}"},{"label":"Add addresses to address tag","deprecated":false,"httpVerb":"post","isAdditionalOperation":false,"isWebhook":false,"type":"link","link":"/apis/platform/api/address_tag/add-address-tag-addresses","routeSlug":"/apis/platform/api/address_tag/add-address-tag-addresses","metadata":{"seo":{"title":"Add addresses to address tag","description":"Add addresses to an address tag by address value."}},"content":{"contentType":"item","itemVariant":"httpItem","meta":{"sourceId":"add-address-tag-addresses","name":"Add addresses to address tag","isWebhook":false,"pointer":"/paths/~1address-tags~1{address_tag_id}~1actions~1add/post","hasSamples":true},"children":[{"nodeType":"container","children":[{"nodeType":"header","level":2,"label":"Add addresses to address tag","isWebhook":false,"showPageActions":true}],"panels":[]},{"nodeType":"container","children":[{"nodeType":"header","level":4,"label":"Request","labelTranslationKey":"request","deepLinkSuffix":"request"},{"nodeType":"markdoc","content":"Add addresses to an address tag by address value."},{"nodeType":"security","requirements":[{"schemes":[{"name":"Auth","scopes":["api:address_tag:write"],"type":"apiKey","in":"header","paramName":"X-Api-Key","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"API key for authenticating requests. Include your key in the "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"X-Api-Key"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" header. Keys can be created in the Vilna Dashboard or via the Management API. The scopes listed per operation indicate which permissions the key must have."},"children":[]}]}]}]}]}]},{"nodeType":"item-content","variant":"path","label":"Path","labelTranslationKey":"path","parameters":[{"name":"address_tag_id","in":"path","schemaId":"schema_17","description":"Unique identifier (UUID) of the address tag.","required":true}],"pointer":"/paths/~1address-tags~1{address_tag_id}~1actions~1add/post/parameters"},{"nodeType":"item-content","variant":"headers","label":"Headers","labelTranslationKey":"header","parameters":[{"name":"Idempotency-Key","in":"header","schemaId":"schema_14","description":"Case-sensitive opaque key for one mutation intent. Send exactly one header occurrence containing 1 to 128 visible ASCII bytes (0x21..0x7e). Commas are literal data; do not trim, lowercase or require UUID syntax. Reuse the same key for retries, with current authorization checked on every attempt. Repeated header occurrences are rejected.\n","required":true}],"pointer":"/paths/~1address-tags~1{address_tag_id}~1actions~1add/post/parameters"},{"nodeType":"item-content","variant":"body","label":"Request Body","labelTranslationKey":"body","required":true,"mediaTypes":["application/json"],"mediaTypeSchemas":{"application/json":{"schemaId":"components/schemas/AddAddressTagAddressesRequest"}},"schemaId":"components/schemas/AddAddressTagAddressesRequest","pointer":"/paths/~1address-tags~1{address_tag_id}~1actions~1add/post/requestBody"}],"panels":[{"children":[{"kind":"code-sample","source":{"kind":"code-sample","operationType":"http","method":"POST","path":"/address-tags/{address_tag_id}/actions/add","servers":[{"url":"/_mock/apis/platform/api","description":"Mock server","isMockServer":true},{"url":"https://api.vilna.io/v2","description":"Vilna API."}],"parameters":{"path":[{"name":"address_tag_id","in":"path","required":true,"example":"550e8400-e29b-41d4-a716-446655440000","schemaId":"components/schemas/UUID"}],"query":[],"querystring":[],"header":[{"name":"Idempotency-Key","in":"header","required":true,"schemaId":"schema_14"}],"cookie":[]},"security":[{"schemes":[{"id":"Auth","type":"apiKey","name":"X-Api-Key","in":"header"}],"scopes":["api:address_tag:write"]}],"requestBody":{"application/json":{"schemaId":"components/schemas/AddAddressTagAddressesRequest"}},"responseCodes":["204","400","401","403","404","409","503","default"],"pointer":"/address-tags/{address_tag_id}/actions/add","href":"address_tag/add-address-tag-addresses","openApiOperationId":"add-address-tag-addresses","summary":"Add addresses to address tag"},"isWebhook":false,"hideReplay":false,"servers":[{"url":"/_mock/apis/platform/api","description":"Mock server","isMockServer":true},{"url":"https://api.vilna.io/v2","description":"Vilna API."}],"schemaId":"components/schemas/AddAddressTagAddressesRequest","mediaTypes":["application/json"],"mediaTypeSchemas":{"application/json":{"schemaId":"components/schemas/AddAddressTagAddressesRequest"}},"examples":[]}]}]},{"nodeType":"container","children":[{"nodeType":"header","level":4,"label":"Responses","labelTranslationKey":"responses","deepLinkSuffix":"responses"},{"nodeType":"item-content","variant":"responses","responses":[{"code":"204","description":"Successful operation with no response body."},{"code":"400","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Bad request (e.g., missing or invalid fields). Invalid text may be reported as address.label_invalid, address.meta_invalid, public_key.label_invalid, invoice.comment_invalid, invoice.metadata_invalid."},"children":[]}]}]}],"mediaType":"application/problem+json","mediaTypes":["application/problem+json"],"mediaTypeContent":{"application/problem+json":{"schemaId":"components/schemas/InvalidRequestProblem","exampleIds":["paths/~1address-tags~1{address_tag_id}~1actions~1add/post/responses/400/content/application~1problem+json/examples/malformed_json"]}},"schemaId":"components/schemas/InvalidRequestProblem","exampleIds":["paths/~1address-tags~1{address_tag_id}~1actions~1add/post/responses/400/content/application~1problem+json/examples/malformed_json"]},{"code":"401","description":"Missing or invalid authentication credentials.","mediaType":"application/problem+json","mediaTypes":["application/problem+json"],"mediaTypeContent":{"application/problem+json":{"schemaId":"components/schemas/UnauthorizedProblem","exampleIds":["paths/~1address-tags~1{address_tag_id}~1actions~1add/post/responses/401/content/application~1problem+json/examples/service_authentication_denied"]}},"schemaId":"components/schemas/UnauthorizedProblem","exampleIds":["paths/~1address-tags~1{address_tag_id}~1actions~1add/post/responses/401/content/application~1problem+json/examples/service_authentication_denied"]},{"code":"403","description":"Insufficient permissions.","mediaType":"application/problem+json","mediaTypes":["application/problem+json"],"mediaTypeContent":{"application/problem+json":{"schemaId":"components/schemas/ForbiddenProblem","exampleIds":["paths/~1address-tags~1{address_tag_id}~1actions~1add/post/responses/403/content/application~1problem+json/examples/insufficient_permissions"]}},"schemaId":"components/schemas/ForbiddenProblem","exampleIds":["paths/~1address-tags~1{address_tag_id}~1actions~1add/post/responses/403/content/application~1problem+json/examples/insufficient_permissions"]},{"code":"404","description":"Requested resource does not exist.","mediaType":"application/problem+json","mediaTypes":["application/problem+json"],"mediaTypeContent":{"application/problem+json":{"schemaId":"components/schemas/NotFoundProblem","exampleIds":["paths/~1address-tags~1{address_tag_id}~1actions~1add/post/responses/404/content/application~1problem+json/examples/address_not_found","paths/~1address-tags~1{address_tag_id}~1actions~1add/post/responses/404/content/application~1problem+json/examples/invoice_not_found"]}},"schemaId":"components/schemas/NotFoundProblem","exampleIds":["paths/~1address-tags~1{address_tag_id}~1actions~1add/post/responses/404/content/application~1problem+json/examples/address_not_found","paths/~1address-tags~1{address_tag_id}~1actions~1add/post/responses/404/content/application~1problem+json/examples/invoice_not_found"]},{"code":"409","description":"Request conflicts with the current resource state.","mediaType":"application/problem+json","mediaTypes":["application/problem+json"],"mediaTypeContent":{"application/problem+json":{"schemaId":"components/schemas/ConflictProblem","exampleIds":["paths/~1address-tags~1{address_tag_id}~1actions~1add/post/responses/409/content/application~1problem+json/examples/address_occupied","paths/~1address-tags~1{address_tag_id}~1actions~1add/post/responses/409/content/application~1problem+json/examples/address_in_use","paths/~1address-tags~1{address_tag_id}~1actions~1add/post/responses/409/content/application~1problem+json/examples/subscription_v1_conflict","paths/~1address-tags~1{address_tag_id}~1actions~1add/post/responses/409/content/application~1problem+json/examples/notification_send_in_progress","paths/~1address-tags~1{address_tag_id}~1actions~1add/post/responses/409/content/application~1problem+json/examples/notification_payload_unavailable","paths/~1address-tags~1{address_tag_id}~1actions~1add/post/responses/409/content/application~1problem+json/examples/notification_test_resend_not_allowed"]}},"schemaId":"components/schemas/ConflictProblem","exampleIds":["paths/~1address-tags~1{address_tag_id}~1actions~1add/post/responses/409/content/application~1problem+json/examples/address_occupied","paths/~1address-tags~1{address_tag_id}~1actions~1add/post/responses/409/content/application~1problem+json/examples/address_in_use","paths/~1address-tags~1{address_tag_id}~1actions~1add/post/responses/409/content/application~1problem+json/examples/subscription_v1_conflict","paths/~1address-tags~1{address_tag_id}~1actions~1add/post/responses/409/content/application~1problem+json/examples/notification_send_in_progress","paths/~1address-tags~1{address_tag_id}~1actions~1add/post/responses/409/content/application~1problem+json/examples/notification_payload_unavailable","paths/~1address-tags~1{address_tag_id}~1actions~1add/post/responses/409/content/application~1problem+json/examples/notification_test_resend_not_allowed"]},{"code":"503","description":"The operation is temporarily unavailable. Please try again later.","mediaType":"application/problem+json","mediaTypes":["application/problem+json"],"mediaTypeContent":{"application/problem+json":{"schemaId":"components/schemas/Problem","exampleIds":["paths/~1address-tags~1{address_tag_id}~1actions~1add/post/responses/503/content/application~1problem+json/examples/temporarily_unavailable"]}},"schemaId":"components/schemas/Problem","exampleIds":["paths/~1address-tags~1{address_tag_id}~1actions~1add/post/responses/503/content/application~1problem+json/examples/temporarily_unavailable"]},{"code":"default","description":"Unexpected error.","mediaType":"application/problem+json","mediaTypes":["application/problem+json"],"mediaTypeContent":{"application/problem+json":{"schemaId":"components/schemas/Problem"}},"schemaId":"components/schemas/Problem"}],"pointer":"/paths/~1address-tags~1{address_tag_id}~1actions~1add/post/responses"}],"panels":[{"children":[{"kind":"response","responseCodes":[{"code":"204"},{"code":"400","schemaId":"components/schemas/InvalidRequestProblem","exampleIds":["paths/~1address-tags~1{address_tag_id}~1actions~1add/post/responses/400/content/application~1problem+json/examples/malformed_json"],"mediaTypes":["application/problem+json"],"mediaTypeContent":{"application/problem+json":{"schemaId":"components/schemas/InvalidRequestProblem","exampleIds":["paths/~1address-tags~1{address_tag_id}~1actions~1add/post/responses/400/content/application~1problem+json/examples/malformed_json"]}}},{"code":"401","schemaId":"components/schemas/UnauthorizedProblem","exampleIds":["paths/~1address-tags~1{address_tag_id}~1actions~1add/post/responses/401/content/application~1problem+json/examples/service_authentication_denied"],"mediaTypes":["application/problem+json"],"mediaTypeContent":{"application/problem+json":{"schemaId":"components/schemas/UnauthorizedProblem","exampleIds":["paths/~1address-tags~1{address_tag_id}~1actions~1add/post/responses/401/content/application~1problem+json/examples/service_authentication_denied"]}}},{"code":"403","schemaId":"components/schemas/ForbiddenProblem","exampleIds":["paths/~1address-tags~1{address_tag_id}~1actions~1add/post/responses/403/content/application~1problem+json/examples/insufficient_permissions"],"mediaTypes":["application/problem+json"],"mediaTypeContent":{"application/problem+json":{"schemaId":"components/schemas/ForbiddenProblem","exampleIds":["paths/~1address-tags~1{address_tag_id}~1actions~1add/post/responses/403/content/application~1problem+json/examples/insufficient_permissions"]}}},{"code":"404","schemaId":"components/schemas/NotFoundProblem","exampleIds":["paths/~1address-tags~1{address_tag_id}~1actions~1add/post/responses/404/content/application~1problem+json/examples/address_not_found","paths/~1address-tags~1{address_tag_id}~1actions~1add/post/responses/404/content/application~1problem+json/examples/invoice_not_found"],"mediaTypes":["application/problem+json"],"mediaTypeContent":{"application/problem+json":{"schemaId":"components/schemas/NotFoundProblem","exampleIds":["paths/~1address-tags~1{address_tag_id}~1actions~1add/post/responses/404/content/application~1problem+json/examples/address_not_found","paths/~1address-tags~1{address_tag_id}~1actions~1add/post/responses/404/content/application~1problem+json/examples/invoice_not_found"]}}},{"code":"409","schemaId":"components/schemas/ConflictProblem","exampleIds":["paths/~1address-tags~1{address_tag_id}~1actions~1add/post/responses/409/content/application~1problem+json/examples/address_occupied","paths/~1address-tags~1{address_tag_id}~1actions~1add/post/responses/409/content/application~1problem+json/examples/address_in_use","paths/~1address-tags~1{address_tag_id}~1actions~1add/post/responses/409/content/application~1problem+json/examples/subscription_v1_conflict","paths/~1address-tags~1{address_tag_id}~1actions~1add/post/responses/409/content/application~1problem+json/examples/notification_send_in_progress","paths/~1address-tags~1{address_tag_id}~1actions~1add/post/responses/409/content/application~1problem+json/examples/notification_payload_unavailable","paths/~1address-tags~1{address_tag_id}~1actions~1add/post/responses/409/content/application~1problem+json/examples/notification_test_resend_not_allowed"],"mediaTypes":["application/problem+json"],"mediaTypeContent":{"application/problem+json":{"schemaId":"components/schemas/ConflictProblem","exampleIds":["paths/~1address-tags~1{address_tag_id}~1actions~1add/post/responses/409/content/application~1problem+json/examples/address_occupied","paths/~1address-tags~1{address_tag_id}~1actions~1add/post/responses/409/content/application~1problem+json/examples/address_in_use","paths/~1address-tags~1{address_tag_id}~1actions~1add/post/responses/409/content/application~1problem+json/examples/subscription_v1_conflict","paths/~1address-tags~1{address_tag_id}~1actions~1add/post/responses/409/content/application~1problem+json/examples/notification_send_in_progress","paths/~1address-tags~1{address_tag_id}~1actions~1add/post/responses/409/content/application~1problem+json/examples/notification_payload_unavailable","paths/~1address-tags~1{address_tag_id}~1actions~1add/post/responses/409/content/application~1problem+json/examples/notification_test_resend_not_allowed"]}}},{"code":"503","schemaId":"components/schemas/Problem","exampleIds":["paths/~1address-tags~1{address_tag_id}~1actions~1add/post/responses/503/content/application~1problem+json/examples/temporarily_unavailable"],"mediaTypes":["application/problem+json"],"mediaTypeContent":{"application/problem+json":{"schemaId":"components/schemas/Problem","exampleIds":["paths/~1address-tags~1{address_tag_id}~1actions~1add/post/responses/503/content/application~1problem+json/examples/temporarily_unavailable"]}}},{"code":"default","schemaId":"components/schemas/Problem","mediaTypes":["application/problem+json"],"mediaTypeContent":{"application/problem+json":{"schemaId":"components/schemas/Problem"}}}],"examples":[]}]}]},{"nodeType":"container","children":[{"nodeType":"feedback","pageSlug":"/address_tag/add-address-tag-addresses"}],"panels":[]}]},"httpPath":"/address-tags/{address_tag_id}/actions/add"},{"label":"Remove addresses from address tag","deprecated":false,"httpVerb":"post","isAdditionalOperation":false,"isWebhook":false,"type":"link","link":"/apis/platform/api/address_tag/remove-address-tag-addresses","routeSlug":"/apis/platform/api/address_tag/remove-address-tag-addresses","metadata":{"seo":{"title":"Remove addresses from address tag","description":"Remove addresses from an address tag by address value."}},"content":{"contentType":"item","itemVariant":"httpItem","meta":{"sourceId":"remove-address-tag-addresses","name":"Remove addresses from address tag","isWebhook":false,"pointer":"/paths/~1address-tags~1{address_tag_id}~1actions~1remove/post","hasSamples":true},"children":[{"nodeType":"container","children":[{"nodeType":"header","level":2,"label":"Remove addresses from address tag","isWebhook":false,"showPageActions":true}],"panels":[]},{"nodeType":"container","children":[{"nodeType":"header","level":4,"label":"Request","labelTranslationKey":"request","deepLinkSuffix":"request"},{"nodeType":"markdoc","content":"Remove addresses from an address tag by address value."},{"nodeType":"security","requirements":[{"schemes":[{"name":"Auth","scopes":["api:address_tag:write"],"type":"apiKey","in":"header","paramName":"X-Api-Key","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"API key for authenticating requests. Include your key in the "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"X-Api-Key"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" header. Keys can be created in the Vilna Dashboard or via the Management API. The scopes listed per operation indicate which permissions the key must have."},"children":[]}]}]}]}]}]},{"nodeType":"item-content","variant":"path","label":"Path","labelTranslationKey":"path","parameters":[{"name":"address_tag_id","in":"path","schemaId":"schema_17","description":"Unique identifier (UUID) of the address tag.","required":true}],"pointer":"/paths/~1address-tags~1{address_tag_id}~1actions~1remove/post/parameters"},{"nodeType":"item-content","variant":"headers","label":"Headers","labelTranslationKey":"header","parameters":[{"name":"Idempotency-Key","in":"header","schemaId":"schema_14","description":"Case-sensitive opaque key for one mutation intent. Send exactly one header occurrence containing 1 to 128 visible ASCII bytes (0x21..0x7e). Commas are literal data; do not trim, lowercase or require UUID syntax. Reuse the same key for retries, with current authorization checked on every attempt. Repeated header occurrences are rejected.\n","required":true}],"pointer":"/paths/~1address-tags~1{address_tag_id}~1actions~1remove/post/parameters"},{"nodeType":"item-content","variant":"body","label":"Request Body","labelTranslationKey":"body","required":true,"mediaTypes":["application/json"],"mediaTypeSchemas":{"application/json":{"schemaId":"components/schemas/RemoveAddressTagAddressesRequest"}},"schemaId":"components/schemas/RemoveAddressTagAddressesRequest","pointer":"/paths/~1address-tags~1{address_tag_id}~1actions~1remove/post/requestBody"}],"panels":[{"children":[{"kind":"code-sample","source":{"kind":"code-sample","operationType":"http","method":"POST","path":"/address-tags/{address_tag_id}/actions/remove","servers":[{"url":"/_mock/apis/platform/api","description":"Mock server","isMockServer":true},{"url":"https://api.vilna.io/v2","description":"Vilna API."}],"parameters":{"path":[{"name":"address_tag_id","in":"path","required":true,"example":"550e8400-e29b-41d4-a716-446655440000","schemaId":"components/schemas/UUID"}],"query":[],"querystring":[],"header":[{"name":"Idempotency-Key","in":"header","required":true,"schemaId":"schema_14"}],"cookie":[]},"security":[{"schemes":[{"id":"Auth","type":"apiKey","name":"X-Api-Key","in":"header"}],"scopes":["api:address_tag:write"]}],"requestBody":{"application/json":{"schemaId":"components/schemas/RemoveAddressTagAddressesRequest"}},"responseCodes":["204","400","401","403","404","409","503","default"],"pointer":"/address-tags/{address_tag_id}/actions/remove","href":"address_tag/remove-address-tag-addresses","openApiOperationId":"remove-address-tag-addresses","summary":"Remove addresses from address tag"},"isWebhook":false,"hideReplay":false,"servers":[{"url":"/_mock/apis/platform/api","description":"Mock server","isMockServer":true},{"url":"https://api.vilna.io/v2","description":"Vilna API."}],"schemaId":"components/schemas/RemoveAddressTagAddressesRequest","mediaTypes":["application/json"],"mediaTypeSchemas":{"application/json":{"schemaId":"components/schemas/RemoveAddressTagAddressesRequest"}},"examples":[]}]}]},{"nodeType":"container","children":[{"nodeType":"header","level":4,"label":"Responses","labelTranslationKey":"responses","deepLinkSuffix":"responses"},{"nodeType":"item-content","variant":"responses","responses":[{"code":"204","description":"Successful operation with no response body."},{"code":"400","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Bad request (e.g., missing or invalid fields). Invalid text may be reported as address.label_invalid, address.meta_invalid, public_key.label_invalid, invoice.comment_invalid, invoice.metadata_invalid."},"children":[]}]}]}],"mediaType":"application/problem+json","mediaTypes":["application/problem+json"],"mediaTypeContent":{"application/problem+json":{"schemaId":"components/schemas/InvalidRequestProblem","exampleIds":["paths/~1address-tags~1{address_tag_id}~1actions~1remove/post/responses/400/content/application~1problem+json/examples/malformed_json"]}},"schemaId":"components/schemas/InvalidRequestProblem","exampleIds":["paths/~1address-tags~1{address_tag_id}~1actions~1remove/post/responses/400/content/application~1problem+json/examples/malformed_json"]},{"code":"401","description":"Missing or invalid authentication credentials.","mediaType":"application/problem+json","mediaTypes":["application/problem+json"],"mediaTypeContent":{"application/problem+json":{"schemaId":"components/schemas/UnauthorizedProblem","exampleIds":["paths/~1address-tags~1{address_tag_id}~1actions~1remove/post/responses/401/content/application~1problem+json/examples/service_authentication_denied"]}},"schemaId":"components/schemas/UnauthorizedProblem","exampleIds":["paths/~1address-tags~1{address_tag_id}~1actions~1remove/post/responses/401/content/application~1problem+json/examples/service_authentication_denied"]},{"code":"403","description":"Insufficient permissions.","mediaType":"application/problem+json","mediaTypes":["application/problem+json"],"mediaTypeContent":{"application/problem+json":{"schemaId":"components/schemas/ForbiddenProblem","exampleIds":["paths/~1address-tags~1{address_tag_id}~1actions~1remove/post/responses/403/content/application~1problem+json/examples/insufficient_permissions"]}},"schemaId":"components/schemas/ForbiddenProblem","exampleIds":["paths/~1address-tags~1{address_tag_id}~1actions~1remove/post/responses/403/content/application~1problem+json/examples/insufficient_permissions"]},{"code":"404","description":"Requested resource does not exist.","mediaType":"application/problem+json","mediaTypes":["application/problem+json"],"mediaTypeContent":{"application/problem+json":{"schemaId":"components/schemas/NotFoundProblem","exampleIds":["paths/~1address-tags~1{address_tag_id}~1actions~1remove/post/responses/404/content/application~1problem+json/examples/address_not_found","paths/~1address-tags~1{address_tag_id}~1actions~1remove/post/responses/404/content/application~1problem+json/examples/invoice_not_found"]}},"schemaId":"components/schemas/NotFoundProblem","exampleIds":["paths/~1address-tags~1{address_tag_id}~1actions~1remove/post/responses/404/content/application~1problem+json/examples/address_not_found","paths/~1address-tags~1{address_tag_id}~1actions~1remove/post/responses/404/content/application~1problem+json/examples/invoice_not_found"]},{"code":"409","description":"Request conflicts with the current resource state.","mediaType":"application/problem+json","mediaTypes":["application/problem+json"],"mediaTypeContent":{"application/problem+json":{"schemaId":"components/schemas/ConflictProblem","exampleIds":["paths/~1address-tags~1{address_tag_id}~1actions~1remove/post/responses/409/content/application~1problem+json/examples/address_occupied","paths/~1address-tags~1{address_tag_id}~1actions~1remove/post/responses/409/content/application~1problem+json/examples/address_in_use","paths/~1address-tags~1{address_tag_id}~1actions~1remove/post/responses/409/content/application~1problem+json/examples/subscription_v1_conflict","paths/~1address-tags~1{address_tag_id}~1actions~1remove/post/responses/409/content/application~1problem+json/examples/notification_send_in_progress","paths/~1address-tags~1{address_tag_id}~1actions~1remove/post/responses/409/content/application~1problem+json/examples/notification_payload_unavailable","paths/~1address-tags~1{address_tag_id}~1actions~1remove/post/responses/409/content/application~1problem+json/examples/notification_test_resend_not_allowed"]}},"schemaId":"components/schemas/ConflictProblem","exampleIds":["paths/~1address-tags~1{address_tag_id}~1actions~1remove/post/responses/409/content/application~1problem+json/examples/address_occupied","paths/~1address-tags~1{address_tag_id}~1actions~1remove/post/responses/409/content/application~1problem+json/examples/address_in_use","paths/~1address-tags~1{address_tag_id}~1actions~1remove/post/responses/409/content/application~1problem+json/examples/subscription_v1_conflict","paths/~1address-tags~1{address_tag_id}~1actions~1remove/post/responses/409/content/application~1problem+json/examples/notification_send_in_progress","paths/~1address-tags~1{address_tag_id}~1actions~1remove/post/responses/409/content/application~1problem+json/examples/notification_payload_unavailable","paths/~1address-tags~1{address_tag_id}~1actions~1remove/post/responses/409/content/application~1problem+json/examples/notification_test_resend_not_allowed"]},{"code":"503","description":"The operation is temporarily unavailable. Please try again later.","mediaType":"application/problem+json","mediaTypes":["application/problem+json"],"mediaTypeContent":{"application/problem+json":{"schemaId":"components/schemas/Problem","exampleIds":["paths/~1address-tags~1{address_tag_id}~1actions~1remove/post/responses/503/content/application~1problem+json/examples/temporarily_unavailable"]}},"schemaId":"components/schemas/Problem","exampleIds":["paths/~1address-tags~1{address_tag_id}~1actions~1remove/post/responses/503/content/application~1problem+json/examples/temporarily_unavailable"]},{"code":"default","description":"Unexpected error.","mediaType":"application/problem+json","mediaTypes":["application/problem+json"],"mediaTypeContent":{"application/problem+json":{"schemaId":"components/schemas/Problem"}},"schemaId":"components/schemas/Problem"}],"pointer":"/paths/~1address-tags~1{address_tag_id}~1actions~1remove/post/responses"}],"panels":[{"children":[{"kind":"response","responseCodes":[{"code":"204"},{"code":"400","schemaId":"components/schemas/InvalidRequestProblem","exampleIds":["paths/~1address-tags~1{address_tag_id}~1actions~1remove/post/responses/400/content/application~1problem+json/examples/malformed_json"],"mediaTypes":["application/problem+json"],"mediaTypeContent":{"application/problem+json":{"schemaId":"components/schemas/InvalidRequestProblem","exampleIds":["paths/~1address-tags~1{address_tag_id}~1actions~1remove/post/responses/400/content/application~1problem+json/examples/malformed_json"]}}},{"code":"401","schemaId":"components/schemas/UnauthorizedProblem","exampleIds":["paths/~1address-tags~1{address_tag_id}~1actions~1remove/post/responses/401/content/application~1problem+json/examples/service_authentication_denied"],"mediaTypes":["application/problem+json"],"mediaTypeContent":{"application/problem+json":{"schemaId":"components/schemas/UnauthorizedProblem","exampleIds":["paths/~1address-tags~1{address_tag_id}~1actions~1remove/post/responses/401/content/application~1problem+json/examples/service_authentication_denied"]}}},{"code":"403","schemaId":"components/schemas/ForbiddenProblem","exampleIds":["paths/~1address-tags~1{address_tag_id}~1actions~1remove/post/responses/403/content/application~1problem+json/examples/insufficient_permissions"],"mediaTypes":["application/problem+json"],"mediaTypeContent":{"application/problem+json":{"schemaId":"components/schemas/ForbiddenProblem","exampleIds":["paths/~1address-tags~1{address_tag_id}~1actions~1remove/post/responses/403/content/application~1problem+json/examples/insufficient_permissions"]}}},{"code":"404","schemaId":"components/schemas/NotFoundProblem","exampleIds":["paths/~1address-tags~1{address_tag_id}~1actions~1remove/post/responses/404/content/application~1problem+json/examples/address_not_found","paths/~1address-tags~1{address_tag_id}~1actions~1remove/post/responses/404/content/application~1problem+json/examples/invoice_not_found"],"mediaTypes":["application/problem+json"],"mediaTypeContent":{"application/problem+json":{"schemaId":"components/schemas/NotFoundProblem","exampleIds":["paths/~1address-tags~1{address_tag_id}~1actions~1remove/post/responses/404/content/application~1problem+json/examples/address_not_found","paths/~1address-tags~1{address_tag_id}~1actions~1remove/post/responses/404/content/application~1problem+json/examples/invoice_not_found"]}}},{"code":"409","schemaId":"components/schemas/ConflictProblem","exampleIds":["paths/~1address-tags~1{address_tag_id}~1actions~1remove/post/responses/409/content/application~1problem+json/examples/address_occupied","paths/~1address-tags~1{address_tag_id}~1actions~1remove/post/responses/409/content/application~1problem+json/examples/address_in_use","paths/~1address-tags~1{address_tag_id}~1actions~1remove/post/responses/409/content/application~1problem+json/examples/subscription_v1_conflict","paths/~1address-tags~1{address_tag_id}~1actions~1remove/post/responses/409/content/application~1problem+json/examples/notification_send_in_progress","paths/~1address-tags~1{address_tag_id}~1actions~1remove/post/responses/409/content/application~1problem+json/examples/notification_payload_unavailable","paths/~1address-tags~1{address_tag_id}~1actions~1remove/post/responses/409/content/application~1problem+json/examples/notification_test_resend_not_allowed"],"mediaTypes":["application/problem+json"],"mediaTypeContent":{"application/problem+json":{"schemaId":"components/schemas/ConflictProblem","exampleIds":["paths/~1address-tags~1{address_tag_id}~1actions~1remove/post/responses/409/content/application~1problem+json/examples/address_occupied","paths/~1address-tags~1{address_tag_id}~1actions~1remove/post/responses/409/content/application~1problem+json/examples/address_in_use","paths/~1address-tags~1{address_tag_id}~1actions~1remove/post/responses/409/content/application~1problem+json/examples/subscription_v1_conflict","paths/~1address-tags~1{address_tag_id}~1actions~1remove/post/responses/409/content/application~1problem+json/examples/notification_send_in_progress","paths/~1address-tags~1{address_tag_id}~1actions~1remove/post/responses/409/content/application~1problem+json/examples/notification_payload_unavailable","paths/~1address-tags~1{address_tag_id}~1actions~1remove/post/responses/409/content/application~1problem+json/examples/notification_test_resend_not_allowed"]}}},{"code":"503","schemaId":"components/schemas/Problem","exampleIds":["paths/~1address-tags~1{address_tag_id}~1actions~1remove/post/responses/503/content/application~1problem+json/examples/temporarily_unavailable"],"mediaTypes":["application/problem+json"],"mediaTypeContent":{"application/problem+json":{"schemaId":"components/schemas/Problem","exampleIds":["paths/~1address-tags~1{address_tag_id}~1actions~1remove/post/responses/503/content/application~1problem+json/examples/temporarily_unavailable"]}}},{"code":"default","schemaId":"components/schemas/Problem","mediaTypes":["application/problem+json"],"mediaTypeContent":{"application/problem+json":{"schemaId":"components/schemas/Problem"}}}],"examples":[]}]}]},{"nodeType":"container","children":[{"nodeType":"feedback","pageSlug":"/address_tag/remove-address-tag-addresses"}],"panels":[]}]},"httpPath":"/address-tags/{address_tag_id}/actions/remove"}],"content":{"contentType":"group","meta":{"name":"address_tag"},"children":[{"nodeType":"container","children":[{"nodeType":"header","level":2,"label":"Address Tags","showPageActions":true},{"nodeType":"markdoc","content":"Named collections of addresses. Pass a tag ID to list endpoints to filter results by membership."}],"panels":[{"children":[{"kind":"group-items","title":"Operations","titleTranslationKey":"operations","items":[{"title":"/address-tags","summary":"List address tags","prefix":{"name":"get","color":"get"},"badges":[],"link":"/address_tag/list-address-tags","deprecated":false},{"title":"/address-tags","summary":"Create address tag","prefix":{"name":"post","color":"post"},"badges":[],"link":"/address_tag/create-address-tag","deprecated":false},{"title":"/address-tags/{address_tag_id}","summary":"Get address tag","prefix":{"name":"get","color":"get"},"badges":[],"link":"/address_tag/get-address-tag","deprecated":false},{"title":"/address-tags/{address_tag_id}","summary":"Update address tag","prefix":{"name":"patch","color":"patch"},"badges":[],"link":"/address_tag/patch-address-tag","deprecated":false},{"title":"/address-tags/{address_tag_id}","summary":"Delete address tag","prefix":{"name":"delete","color":"delete"},"badges":[],"link":"/address_tag/delete-address-tag","deprecated":false},{"title":"/address-tags/{address_tag_id}/actions/add","summary":"Add addresses to address tag","prefix":{"name":"post","color":"post"},"badges":[],"link":"/address_tag/add-address-tag-addresses","deprecated":false},{"title":"/address-tags/{address_tag_id}/actions/remove","summary":"Remove addresses from address tag","prefix":{"name":"post","color":"post"},"badges":[],"link":"/address_tag/remove-address-tag-addresses","deprecated":false}]}]}]}]}},{"type":"group","label":"Extended Public Keys","link":"/apis/platform/api/public_key","routeSlug":"/apis/platform/api/public_key","items":[{"label":"List public keys","deprecated":false,"httpVerb":"get","isAdditionalOperation":false,"isWebhook":false,"type":"link","link":"/apis/platform/api/public_key/list-public-keys","routeSlug":"/apis/platform/api/public_key/list-public-keys","metadata":{"seo":{"title":"List public keys","description":"List registered extended public keys with filtering and pagination."}},"content":{"contentType":"item","itemVariant":"httpItem","meta":{"sourceId":"list-public-keys","name":"List public keys","isWebhook":false,"pointer":"/paths/~1public-keys/get","hasSamples":false},"children":[{"nodeType":"container","children":[{"nodeType":"header","level":2,"label":"List public keys","isWebhook":false,"showPageActions":true}],"panels":[]},{"nodeType":"container","children":[{"nodeType":"header","level":4,"label":"Request","labelTranslationKey":"request","deepLinkSuffix":"request"},{"nodeType":"markdoc","content":"List registered extended public keys with filtering and pagination."},{"nodeType":"security","requirements":[{"schemes":[{"name":"Auth","scopes":["api:public_key:read"],"type":"apiKey","in":"header","paramName":"X-Api-Key","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"API key for authenticating requests. Include your key in the "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"X-Api-Key"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" header. Keys can be created in the Vilna Dashboard or via the Management API. The scopes listed per operation indicate which permissions the key must have."},"children":[]}]}]}]}]}]},{"nodeType":"item-content","variant":"query","label":"Query","labelTranslationKey":"query","parameters":[{"name":"limit","in":"query","schemaId":"schema_0","description":"Maximum number of items to return."},{"name":"page","in":"query","schemaId":"schema_1","description":"Page number for pagination."},{"name":"search","in":"query","schemaId":"schema_36","description":"Filter public keys by label (partial match, case-insensitive)."},{"name":"sort_by","in":"query","schemaId":"schema_37","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Field to sort results by. Use "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"-"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" prefix for descending order."},"children":[]}]}]}]}],"pointer":"/paths/~1public-keys/get/parameters"}],"panels":[{"children":[{"kind":"code-sample","source":{"kind":"code-sample","operationType":"http","method":"GET","path":"/public-keys","servers":[{"url":"/_mock/apis/platform/api","description":"Mock server","isMockServer":true},{"url":"https://api.vilna.io/v2","description":"Vilna API."}],"parameters":{"path":[],"query":[{"name":"limit","in":"query","required":false,"example":20,"schemaId":"schema_0"},{"name":"page","in":"query","required":false,"example":1,"schemaId":"schema_1"},{"name":"search","in":"query","required":false,"example":"wallet","schemaId":"schema_36"},{"name":"sort_by","in":"query","required":false,"example":"created_at","schemaId":"schema_37"}],"querystring":[],"header":[],"cookie":[]},"security":[{"schemes":[{"id":"Auth","type":"apiKey","name":"X-Api-Key","in":"header"}],"scopes":["api:public_key:read"]}],"responseCodes":["200","400","401","403","503","default"],"pointer":"/public-keys","href":"public_key/list-public-keys","openApiOperationId":"list-public-keys","summary":"List public keys"},"isWebhook":false,"hideReplay":false,"servers":[{"url":"/_mock/apis/platform/api","description":"Mock server","isMockServer":true},{"url":"https://api.vilna.io/v2","description":"Vilna API."}],"examples":[]}]}]},{"nodeType":"container","children":[{"nodeType":"header","level":4,"label":"Responses","labelTranslationKey":"responses","deepLinkSuffix":"responses"},{"nodeType":"item-content","variant":"responses","responses":[{"code":"200","description":"Paginated list of public keys.","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"schema_38"}},"schemaId":"schema_38"},{"code":"400","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Bad request (e.g., missing or invalid fields). Invalid text may be reported as address.label_invalid, address.meta_invalid, public_key.label_invalid, invoice.comment_invalid, invoice.metadata_invalid."},"children":[]}]}]}],"mediaType":"application/problem+json","mediaTypes":["application/problem+json"],"mediaTypeContent":{"application/problem+json":{"schemaId":"components/schemas/InvalidRequestProblem","exampleIds":["paths/~1public-keys/get/responses/400/content/application~1problem+json/examples/malformed_json"]}},"schemaId":"components/schemas/InvalidRequestProblem","exampleIds":["paths/~1public-keys/get/responses/400/content/application~1problem+json/examples/malformed_json"]},{"code":"401","description":"Missing or invalid authentication credentials.","mediaType":"application/problem+json","mediaTypes":["application/problem+json"],"mediaTypeContent":{"application/problem+json":{"schemaId":"components/schemas/UnauthorizedProblem","exampleIds":["paths/~1public-keys/get/responses/401/content/application~1problem+json/examples/service_authentication_denied"]}},"schemaId":"components/schemas/UnauthorizedProblem","exampleIds":["paths/~1public-keys/get/responses/401/content/application~1problem+json/examples/service_authentication_denied"]},{"code":"403","description":"Insufficient permissions.","mediaType":"application/problem+json","mediaTypes":["application/problem+json"],"mediaTypeContent":{"application/problem+json":{"schemaId":"components/schemas/ForbiddenProblem","exampleIds":["paths/~1public-keys/get/responses/403/content/application~1problem+json/examples/insufficient_permissions"]}},"schemaId":"components/schemas/ForbiddenProblem","exampleIds":["paths/~1public-keys/get/responses/403/content/application~1problem+json/examples/insufficient_permissions"]},{"code":"503","description":"The operation is temporarily unavailable. Please try again later.","mediaType":"application/problem+json","mediaTypes":["application/problem+json"],"mediaTypeContent":{"application/problem+json":{"schemaId":"components/schemas/Problem","exampleIds":["paths/~1public-keys/get/responses/503/content/application~1problem+json/examples/temporarily_unavailable"]}},"schemaId":"components/schemas/Problem","exampleIds":["paths/~1public-keys/get/responses/503/content/application~1problem+json/examples/temporarily_unavailable"]},{"code":"default","description":"Unexpected error.","mediaType":"application/problem+json","mediaTypes":["application/problem+json"],"mediaTypeContent":{"application/problem+json":{"schemaId":"components/schemas/Problem"}},"schemaId":"components/schemas/Problem"}],"pointer":"/paths/~1public-keys/get/responses"}],"panels":[{"children":[{"kind":"response","responseCodes":[{"code":"200","schemaId":"schema_38","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"schema_38"}}},{"code":"400","schemaId":"components/schemas/InvalidRequestProblem","exampleIds":["paths/~1public-keys/get/responses/400/content/application~1problem+json/examples/malformed_json"],"mediaTypes":["application/problem+json"],"mediaTypeContent":{"application/problem+json":{"schemaId":"components/schemas/InvalidRequestProblem","exampleIds":["paths/~1public-keys/get/responses/400/content/application~1problem+json/examples/malformed_json"]}}},{"code":"401","schemaId":"components/schemas/UnauthorizedProblem","exampleIds":["paths/~1public-keys/get/responses/401/content/application~1problem+json/examples/service_authentication_denied"],"mediaTypes":["application/problem+json"],"mediaTypeContent":{"application/problem+json":{"schemaId":"components/schemas/UnauthorizedProblem","exampleIds":["paths/~1public-keys/get/responses/401/content/application~1problem+json/examples/service_authentication_denied"]}}},{"code":"403","schemaId":"components/schemas/ForbiddenProblem","exampleIds":["paths/~1public-keys/get/responses/403/content/application~1problem+json/examples/insufficient_permissions"],"mediaTypes":["application/problem+json"],"mediaTypeContent":{"application/problem+json":{"schemaId":"components/schemas/ForbiddenProblem","exampleIds":["paths/~1public-keys/get/responses/403/content/application~1problem+json/examples/insufficient_permissions"]}}},{"code":"503","schemaId":"components/schemas/Problem","exampleIds":["paths/~1public-keys/get/responses/503/content/application~1problem+json/examples/temporarily_unavailable"],"mediaTypes":["application/problem+json"],"mediaTypeContent":{"application/problem+json":{"schemaId":"components/schemas/Problem","exampleIds":["paths/~1public-keys/get/responses/503/content/application~1problem+json/examples/temporarily_unavailable"]}}},{"code":"default","schemaId":"components/schemas/Problem","mediaTypes":["application/problem+json"],"mediaTypeContent":{"application/problem+json":{"schemaId":"components/schemas/Problem"}}}],"examples":[]}]}]},{"nodeType":"container","children":[{"nodeType":"feedback","pageSlug":"/public_key/list-public-keys"}],"panels":[]}]},"httpPath":"/public-keys"},{"label":"Create public key","deprecated":false,"httpVerb":"post","isAdditionalOperation":false,"isWebhook":false,"type":"link","link":"/apis/platform/api/public_key/create-public-key","routeSlug":"/apis/platform/api/public_key/create-public-key","metadata":{"seo":{"title":"Create public key","description":"Register an extended public key for HD address derivation."}},"content":{"contentType":"item","itemVariant":"httpItem","meta":{"sourceId":"create-public-key","name":"Create public key","isWebhook":false,"pointer":"/paths/~1public-keys/post","hasSamples":true},"children":[{"nodeType":"container","children":[{"nodeType":"header","level":2,"label":"Create public key","isWebhook":false,"showPageActions":true}],"panels":[]},{"nodeType":"container","children":[{"nodeType":"header","level":4,"label":"Request","labelTranslationKey":"request","deepLinkSuffix":"request"},{"nodeType":"markdoc","content":"Register an extended public key for HD address derivation."},{"nodeType":"security","requirements":[{"schemes":[{"name":"Auth","scopes":["api:public_key:write"],"type":"apiKey","in":"header","paramName":"X-Api-Key","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"API key for authenticating requests. Include your key in the "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"X-Api-Key"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" header. Keys can be created in the Vilna Dashboard or via the Management API. The scopes listed per operation indicate which permissions the key must have."},"children":[]}]}]}]}]}]},{"nodeType":"item-content","variant":"headers","label":"Headers","labelTranslationKey":"header","parameters":[{"name":"Idempotency-Key","in":"header","schemaId":"schema_14","description":"Case-sensitive opaque key for one mutation intent. Send exactly one header occurrence containing 1 to 128 visible ASCII bytes (0x21..0x7e). Commas are literal data; do not trim, lowercase or require UUID syntax. Reuse the same key for retries, with current authorization checked on every attempt. Repeated header occurrences are rejected.\n","required":true}],"pointer":"/paths/~1public-keys/post/parameters"},{"nodeType":"item-content","variant":"body","label":"Request Body","labelTranslationKey":"body","required":true,"mediaTypes":["application/json"],"mediaTypeSchemas":{"application/json":{"schemaId":"components/schemas/CreatePublicKeyRequest","exampleIds":["paths/~1public-keys/post/requestBody/content/application~1json/examples/xpub_example","paths/~1public-keys/post/requestBody/content/application~1json/examples/ypub_example","paths/~1public-keys/post/requestBody/content/application~1json/examples/zpub_example","paths/~1public-keys/post/requestBody/content/application~1json/examples/taproot_example"]}},"schemaId":"components/schemas/CreatePublicKeyRequest","exampleIds":["paths/~1public-keys/post/requestBody/content/application~1json/examples/xpub_example","paths/~1public-keys/post/requestBody/content/application~1json/examples/ypub_example","paths/~1public-keys/post/requestBody/content/application~1json/examples/zpub_example","paths/~1public-keys/post/requestBody/content/application~1json/examples/taproot_example"],"pointer":"/paths/~1public-keys/post/requestBody"}],"panels":[{"children":[{"kind":"code-sample","source":{"kind":"code-sample","operationType":"http","method":"POST","path":"/public-keys","servers":[{"url":"/_mock/apis/platform/api","description":"Mock server","isMockServer":true},{"url":"https://api.vilna.io/v2","description":"Vilna API."}],"parameters":{"path":[],"query":[],"querystring":[],"header":[{"name":"Idempotency-Key","in":"header","required":true,"schemaId":"schema_14"}],"cookie":[]},"security":[{"schemes":[{"id":"Auth","type":"apiKey","name":"X-Api-Key","in":"header"}],"scopes":["api:public_key:write"]}],"requestBody":{"application/json":{"schemaId":"components/schemas/CreatePublicKeyRequest","exampleIds":["paths/~1public-keys/post/requestBody/content/application~1json/examples/xpub_example","paths/~1public-keys/post/requestBody/content/application~1json/examples/ypub_example","paths/~1public-keys/post/requestBody/content/application~1json/examples/zpub_example","paths/~1public-keys/post/requestBody/content/application~1json/examples/taproot_example"]}},"responseCodes":["200","201","400","401","403","409","422","429","503","default"],"pointer":"/public-keys","href":"public_key/create-public-key","openApiOperationId":"create-public-key","summary":"Create public key"},"isWebhook":false,"hideReplay":false,"servers":[{"url":"/_mock/apis/platform/api","description":"Mock server","isMockServer":true},{"url":"https://api.vilna.io/v2","description":"Vilna API."}],"schemaId":"components/schemas/CreatePublicKeyRequest","exampleIds":["paths/~1public-keys/post/requestBody/content/application~1json/examples/xpub_example","paths/~1public-keys/post/requestBody/content/application~1json/examples/ypub_example","paths/~1public-keys/post/requestBody/content/application~1json/examples/zpub_example","paths/~1public-keys/post/requestBody/content/application~1json/examples/taproot_example"],"mediaTypes":["application/json"],"mediaTypeSchemas":{"application/json":{"schemaId":"components/schemas/CreatePublicKeyRequest","exampleIds":["paths/~1public-keys/post/requestBody/content/application~1json/examples/xpub_example","paths/~1public-keys/post/requestBody/content/application~1json/examples/ypub_example","paths/~1public-keys/post/requestBody/content/application~1json/examples/zpub_example","paths/~1public-keys/post/requestBody/content/application~1json/examples/taproot_example"]}},"examples":[{},{},{},{}]}]}]},{"nodeType":"container","children":[{"nodeType":"header","level":4,"label":"Responses","labelTranslationKey":"responses","deepLinkSuffix":"responses"},{"nodeType":"item-content","variant":"responses","responses":[{"code":"200","description":"Created public key.","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"schema_39"}},"schemaId":"schema_39"},{"code":"201","description":"Created public key.","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"schema_39"}},"schemaId":"schema_39"},{"code":"400","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Bad request (e.g., missing or invalid fields). Invalid text may be reported as address.label_invalid, address.meta_invalid, public_key.label_invalid, invoice.comment_invalid, invoice.metadata_invalid."},"children":[]}]}]}],"mediaType":"application/problem+json","mediaTypes":["application/problem+json"],"mediaTypeContent":{"application/problem+json":{"schemaId":"components/schemas/InvalidRequestProblem","exampleIds":["paths/~1public-keys/post/responses/400/content/application~1problem+json/examples/malformed_json"]}},"schemaId":"components/schemas/InvalidRequestProblem","exampleIds":["paths/~1public-keys/post/responses/400/content/application~1problem+json/examples/malformed_json"]},{"code":"401","description":"Missing or invalid authentication credentials.","mediaType":"application/problem+json","mediaTypes":["application/problem+json"],"mediaTypeContent":{"application/problem+json":{"schemaId":"components/schemas/UnauthorizedProblem","exampleIds":["paths/~1public-keys/post/responses/401/content/application~1problem+json/examples/service_authentication_denied"]}},"schemaId":"components/schemas/UnauthorizedProblem","exampleIds":["paths/~1public-keys/post/responses/401/content/application~1problem+json/examples/service_authentication_denied"]},{"code":"403","description":"Insufficient permissions.","mediaType":"application/problem+json","mediaTypes":["application/problem+json"],"mediaTypeContent":{"application/problem+json":{"schemaId":"components/schemas/ForbiddenProblem","exampleIds":["paths/~1public-keys/post/responses/403/content/application~1problem+json/examples/insufficient_permissions"]}},"schemaId":"components/schemas/ForbiddenProblem","exampleIds":["paths/~1public-keys/post/responses/403/content/application~1problem+json/examples/insufficient_permissions"]},{"code":"409","description":"Request conflicts with the current resource state.","mediaType":"application/problem+json","mediaTypes":["application/problem+json"],"mediaTypeContent":{"application/problem+json":{"schemaId":"components/schemas/ConflictProblem","exampleIds":["paths/~1public-keys/post/responses/409/content/application~1problem+json/examples/address_occupied","paths/~1public-keys/post/responses/409/content/application~1problem+json/examples/address_in_use","paths/~1public-keys/post/responses/409/content/application~1problem+json/examples/subscription_v1_conflict","paths/~1public-keys/post/responses/409/content/application~1problem+json/examples/notification_send_in_progress","paths/~1public-keys/post/responses/409/content/application~1problem+json/examples/notification_payload_unavailable","paths/~1public-keys/post/responses/409/content/application~1problem+json/examples/notification_test_resend_not_allowed"]}},"schemaId":"components/schemas/ConflictProblem","exampleIds":["paths/~1public-keys/post/responses/409/content/application~1problem+json/examples/address_occupied","paths/~1public-keys/post/responses/409/content/application~1problem+json/examples/address_in_use","paths/~1public-keys/post/responses/409/content/application~1problem+json/examples/subscription_v1_conflict","paths/~1public-keys/post/responses/409/content/application~1problem+json/examples/notification_send_in_progress","paths/~1public-keys/post/responses/409/content/application~1problem+json/examples/notification_payload_unavailable","paths/~1public-keys/post/responses/409/content/application~1problem+json/examples/notification_test_resend_not_allowed"]},{"code":"422","description":"Request preconditions were not met.","mediaType":"application/problem+json","mediaTypes":["application/problem+json"],"mediaTypeContent":{"application/problem+json":{"schemaId":"components/schemas/PreconditionProblem","exampleIds":["paths/~1public-keys/post/responses/422/content/application~1problem+json/examples/invoice_not_cancellable"]}},"schemaId":"components/schemas/PreconditionProblem","exampleIds":["paths/~1public-keys/post/responses/422/content/application~1problem+json/examples/invoice_not_cancellable"]},{"code":"429","description":"Resource quota exceeded. The response includes the effective limit for this scope. The applicable code and limit depend on the operation; examples illustrate different limits.","mediaType":"application/problem+json","mediaTypes":["application/problem+json"],"mediaTypeContent":{"application/problem+json":{"schemaId":"components/schemas/QuotaExceededProblem","exampleIds":["paths/~1public-keys/post/responses/429/content/application~1problem+json/examples/address_quota","paths/~1public-keys/post/responses/429/content/application~1problem+json/examples/creation_prohibited"]}},"schemaId":"components/schemas/QuotaExceededProblem","exampleIds":["paths/~1public-keys/post/responses/429/content/application~1problem+json/examples/address_quota","paths/~1public-keys/post/responses/429/content/application~1problem+json/examples/creation_prohibited"]},{"code":"503","description":"The operation is temporarily unavailable. Please try again later.","mediaType":"application/problem+json","mediaTypes":["application/problem+json"],"mediaTypeContent":{"application/problem+json":{"schemaId":"components/schemas/Problem","exampleIds":["paths/~1public-keys/post/responses/503/content/application~1problem+json/examples/temporarily_unavailable"]}},"schemaId":"components/schemas/Problem","exampleIds":["paths/~1public-keys/post/responses/503/content/application~1problem+json/examples/temporarily_unavailable"]},{"code":"default","description":"Unexpected error.","mediaType":"application/problem+json","mediaTypes":["application/problem+json"],"mediaTypeContent":{"application/problem+json":{"schemaId":"components/schemas/Problem"}},"schemaId":"components/schemas/Problem"}],"pointer":"/paths/~1public-keys/post/responses"}],"panels":[{"children":[{"kind":"response","responseCodes":[{"code":"200","schemaId":"schema_39","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"schema_39"}}},{"code":"201","schemaId":"schema_39","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"schema_39"}}},{"code":"400","schemaId":"components/schemas/InvalidRequestProblem","exampleIds":["paths/~1public-keys/post/responses/400/content/application~1problem+json/examples/malformed_json"],"mediaTypes":["application/problem+json"],"mediaTypeContent":{"application/problem+json":{"schemaId":"components/schemas/InvalidRequestProblem","exampleIds":["paths/~1public-keys/post/responses/400/content/application~1problem+json/examples/malformed_json"]}}},{"code":"401","schemaId":"components/schemas/UnauthorizedProblem","exampleIds":["paths/~1public-keys/post/responses/401/content/application~1problem+json/examples/service_authentication_denied"],"mediaTypes":["application/problem+json"],"mediaTypeContent":{"application/problem+json":{"schemaId":"components/schemas/UnauthorizedProblem","exampleIds":["paths/~1public-keys/post/responses/401/content/application~1problem+json/examples/service_authentication_denied"]}}},{"code":"403","schemaId":"components/schemas/ForbiddenProblem","exampleIds":["paths/~1public-keys/post/responses/403/content/application~1problem+json/examples/insufficient_permissions"],"mediaTypes":["application/problem+json"],"mediaTypeContent":{"application/problem+json":{"schemaId":"components/schemas/ForbiddenProblem","exampleIds":["paths/~1public-keys/post/responses/403/content/application~1problem+json/examples/insufficient_permissions"]}}},{"code":"409","schemaId":"components/schemas/ConflictProblem","exampleIds":["paths/~1public-keys/post/responses/409/content/application~1problem+json/examples/address_occupied","paths/~1public-keys/post/responses/409/content/application~1problem+json/examples/address_in_use","paths/~1public-keys/post/responses/409/content/application~1problem+json/examples/subscription_v1_conflict","paths/~1public-keys/post/responses/409/content/application~1problem+json/examples/notification_send_in_progress","paths/~1public-keys/post/responses/409/content/application~1problem+json/examples/notification_payload_unavailable","paths/~1public-keys/post/responses/409/content/application~1problem+json/examples/notification_test_resend_not_allowed"],"mediaTypes":["application/problem+json"],"mediaTypeContent":{"application/problem+json":{"schemaId":"components/schemas/ConflictProblem","exampleIds":["paths/~1public-keys/post/responses/409/content/application~1problem+json/examples/address_occupied","paths/~1public-keys/post/responses/409/content/application~1problem+json/examples/address_in_use","paths/~1public-keys/post/responses/409/content/application~1problem+json/examples/subscription_v1_conflict","paths/~1public-keys/post/responses/409/content/application~1problem+json/examples/notification_send_in_progress","paths/~1public-keys/post/responses/409/content/application~1problem+json/examples/notification_payload_unavailable","paths/~1public-keys/post/responses/409/content/application~1problem+json/examples/notification_test_resend_not_allowed"]}}},{"code":"422","schemaId":"components/schemas/PreconditionProblem","exampleIds":["paths/~1public-keys/post/responses/422/content/application~1problem+json/examples/invoice_not_cancellable"],"mediaTypes":["application/problem+json"],"mediaTypeContent":{"application/problem+json":{"schemaId":"components/schemas/PreconditionProblem","exampleIds":["paths/~1public-keys/post/responses/422/content/application~1problem+json/examples/invoice_not_cancellable"]}}},{"code":"429","schemaId":"components/schemas/QuotaExceededProblem","exampleIds":["paths/~1public-keys/post/responses/429/content/application~1problem+json/examples/address_quota","paths/~1public-keys/post/responses/429/content/application~1problem+json/examples/creation_prohibited"],"mediaTypes":["application/problem+json"],"mediaTypeContent":{"application/problem+json":{"schemaId":"components/schemas/QuotaExceededProblem","exampleIds":["paths/~1public-keys/post/responses/429/content/application~1problem+json/examples/address_quota","paths/~1public-keys/post/responses/429/content/application~1problem+json/examples/creation_prohibited"]}}},{"code":"503","schemaId":"components/schemas/Problem","exampleIds":["paths/~1public-keys/post/responses/503/content/application~1problem+json/examples/temporarily_unavailable"],"mediaTypes":["application/problem+json"],"mediaTypeContent":{"application/problem+json":{"schemaId":"components/schemas/Problem","exampleIds":["paths/~1public-keys/post/responses/503/content/application~1problem+json/examples/temporarily_unavailable"]}}},{"code":"default","schemaId":"components/schemas/Problem","mediaTypes":["application/problem+json"],"mediaTypeContent":{"application/problem+json":{"schemaId":"components/schemas/Problem"}}}],"examples":[]}]}]},{"nodeType":"container","children":[{"nodeType":"feedback","pageSlug":"/public_key/create-public-key"}],"panels":[]}]},"httpPath":"/public-keys"},{"label":"Delete public key","deprecated":false,"httpVerb":"delete","isAdditionalOperation":false,"isWebhook":false,"type":"link","link":"/apis/platform/api/public_key/delete-public-key","routeSlug":"/apis/platform/api/public_key/delete-public-key","metadata":{"seo":{"title":"Delete public key","description":"Delete a registered public key by ID, together with the addresses derived from it. An open invoice on any affected address returns 409."}},"content":{"contentType":"item","itemVariant":"httpItem","meta":{"sourceId":"delete-public-key","name":"Delete public key","isWebhook":false,"pointer":"/paths/~1public-keys~1{public_key_id}/delete","hasSamples":false},"children":[{"nodeType":"container","children":[{"nodeType":"header","level":2,"label":"Delete public key","isWebhook":false,"showPageActions":true}],"panels":[]},{"nodeType":"container","children":[{"nodeType":"header","level":4,"label":"Request","labelTranslationKey":"request","deepLinkSuffix":"request"},{"nodeType":"markdoc","content":"Delete a registered public key by ID, together with the addresses derived from it. An open invoice on any affected address returns 409."},{"nodeType":"security","requirements":[{"schemes":[{"name":"Auth","scopes":["api:public_key:delete"],"type":"apiKey","in":"header","paramName":"X-Api-Key","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"API key for authenticating requests. Include your key in the "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"X-Api-Key"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" header. Keys can be created in the Vilna Dashboard or via the Management API. The scopes listed per operation indicate which permissions the key must have."},"children":[]}]}]}]}]}]},{"nodeType":"item-content","variant":"path","label":"Path","labelTranslationKey":"path","parameters":[{"name":"public_key_id","in":"path","schemaId":"schema_17","description":"Unique identifier (UUID) of the public key.","required":true}],"pointer":"/paths/~1public-keys~1{public_key_id}/delete/parameters"},{"nodeType":"item-content","variant":"headers","label":"Headers","labelTranslationKey":"header","parameters":[{"name":"Idempotency-Key","in":"header","schemaId":"schema_14","description":"Case-sensitive opaque key for one mutation intent. Send exactly one header occurrence containing 1 to 128 visible ASCII bytes (0x21..0x7e). Commas are literal data; do not trim, lowercase or require UUID syntax. Reuse the same key for retries, with current authorization checked on every attempt. Repeated header occurrences are rejected.\n","required":true}],"pointer":"/paths/~1public-keys~1{public_key_id}/delete/parameters"}],"panels":[{"children":[{"kind":"code-sample","source":{"kind":"code-sample","operationType":"http","method":"DELETE","path":"/public-keys/{public_key_id}","servers":[{"url":"/_mock/apis/platform/api","description":"Mock server","isMockServer":true},{"url":"https://api.vilna.io/v2","description":"Vilna API."}],"parameters":{"path":[{"name":"public_key_id","in":"path","required":true,"example":"550e8400-e29b-41d4-a716-446655440000","schemaId":"components/schemas/UUID"}],"query":[],"querystring":[],"header":[{"name":"Idempotency-Key","in":"header","required":true,"schemaId":"schema_14"}],"cookie":[]},"security":[{"schemes":[{"id":"Auth","type":"apiKey","name":"X-Api-Key","in":"header"}],"scopes":["api:public_key:delete"]}],"responseCodes":["204","400","401","403","404","409","503","default"],"pointer":"/public-keys/{public_key_id}","href":"public_key/delete-public-key","openApiOperationId":"delete-public-key","summary":"Delete public key"},"isWebhook":false,"hideReplay":false,"servers":[{"url":"/_mock/apis/platform/api","description":"Mock server","isMockServer":true},{"url":"https://api.vilna.io/v2","description":"Vilna API."}],"examples":[]}]}]},{"nodeType":"container","children":[{"nodeType":"header","level":4,"label":"Responses","labelTranslationKey":"responses","deepLinkSuffix":"responses"},{"nodeType":"item-content","variant":"responses","responses":[{"code":"204","description":"Successful operation with no response body."},{"code":"400","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Bad request (e.g., missing or invalid fields). Invalid text may be reported as address.label_invalid, address.meta_invalid, public_key.label_invalid, invoice.comment_invalid, invoice.metadata_invalid."},"children":[]}]}]}],"mediaType":"application/problem+json","mediaTypes":["application/problem+json"],"mediaTypeContent":{"application/problem+json":{"schemaId":"components/schemas/InvalidRequestProblem","exampleIds":["paths/~1public-keys~1{public_key_id}/delete/responses/400/content/application~1problem+json/examples/malformed_json"]}},"schemaId":"components/schemas/InvalidRequestProblem","exampleIds":["paths/~1public-keys~1{public_key_id}/delete/responses/400/content/application~1problem+json/examples/malformed_json"]},{"code":"401","description":"Missing or invalid authentication credentials.","mediaType":"application/problem+json","mediaTypes":["application/problem+json"],"mediaTypeContent":{"application/problem+json":{"schemaId":"components/schemas/UnauthorizedProblem","exampleIds":["paths/~1public-keys~1{public_key_id}/delete/responses/401/content/application~1problem+json/examples/service_authentication_denied"]}},"schemaId":"components/schemas/UnauthorizedProblem","exampleIds":["paths/~1public-keys~1{public_key_id}/delete/responses/401/content/application~1problem+json/examples/service_authentication_denied"]},{"code":"403","description":"Insufficient permissions.","mediaType":"application/problem+json","mediaTypes":["application/problem+json"],"mediaTypeContent":{"application/problem+json":{"schemaId":"components/schemas/ForbiddenProblem","exampleIds":["paths/~1public-keys~1{public_key_id}/delete/responses/403/content/application~1problem+json/examples/insufficient_permissions"]}},"schemaId":"components/schemas/ForbiddenProblem","exampleIds":["paths/~1public-keys~1{public_key_id}/delete/responses/403/content/application~1problem+json/examples/insufficient_permissions"]},{"code":"404","description":"Requested resource does not exist.","mediaType":"application/problem+json","mediaTypes":["application/problem+json"],"mediaTypeContent":{"application/problem+json":{"schemaId":"components/schemas/NotFoundProblem","exampleIds":["paths/~1public-keys~1{public_key_id}/delete/responses/404/content/application~1problem+json/examples/address_not_found","paths/~1public-keys~1{public_key_id}/delete/responses/404/content/application~1problem+json/examples/invoice_not_found"]}},"schemaId":"components/schemas/NotFoundProblem","exampleIds":["paths/~1public-keys~1{public_key_id}/delete/responses/404/content/application~1problem+json/examples/address_not_found","paths/~1public-keys~1{public_key_id}/delete/responses/404/content/application~1problem+json/examples/invoice_not_found"]},{"code":"409","description":"Request conflicts with the current resource state.","mediaType":"application/problem+json","mediaTypes":["application/problem+json"],"mediaTypeContent":{"application/problem+json":{"schemaId":"components/schemas/ConflictProblem","exampleIds":["paths/~1public-keys~1{public_key_id}/delete/responses/409/content/application~1problem+json/examples/address_occupied","paths/~1public-keys~1{public_key_id}/delete/responses/409/content/application~1problem+json/examples/address_in_use","paths/~1public-keys~1{public_key_id}/delete/responses/409/content/application~1problem+json/examples/subscription_v1_conflict","paths/~1public-keys~1{public_key_id}/delete/responses/409/content/application~1problem+json/examples/notification_send_in_progress","paths/~1public-keys~1{public_key_id}/delete/responses/409/content/application~1problem+json/examples/notification_payload_unavailable","paths/~1public-keys~1{public_key_id}/delete/responses/409/content/application~1problem+json/examples/notification_test_resend_not_allowed"]}},"schemaId":"components/schemas/ConflictProblem","exampleIds":["paths/~1public-keys~1{public_key_id}/delete/responses/409/content/application~1problem+json/examples/address_occupied","paths/~1public-keys~1{public_key_id}/delete/responses/409/content/application~1problem+json/examples/address_in_use","paths/~1public-keys~1{public_key_id}/delete/responses/409/content/application~1problem+json/examples/subscription_v1_conflict","paths/~1public-keys~1{public_key_id}/delete/responses/409/content/application~1problem+json/examples/notification_send_in_progress","paths/~1public-keys~1{public_key_id}/delete/responses/409/content/application~1problem+json/examples/notification_payload_unavailable","paths/~1public-keys~1{public_key_id}/delete/responses/409/content/application~1problem+json/examples/notification_test_resend_not_allowed"]},{"code":"503","description":"The operation is temporarily unavailable. Please try again later.","mediaType":"application/problem+json","mediaTypes":["application/problem+json"],"mediaTypeContent":{"application/problem+json":{"schemaId":"components/schemas/Problem","exampleIds":["paths/~1public-keys~1{public_key_id}/delete/responses/503/content/application~1problem+json/examples/temporarily_unavailable"]}},"schemaId":"components/schemas/Problem","exampleIds":["paths/~1public-keys~1{public_key_id}/delete/responses/503/content/application~1problem+json/examples/temporarily_unavailable"]},{"code":"default","description":"Unexpected error.","mediaType":"application/problem+json","mediaTypes":["application/problem+json"],"mediaTypeContent":{"application/problem+json":{"schemaId":"components/schemas/Problem"}},"schemaId":"components/schemas/Problem"}],"pointer":"/paths/~1public-keys~1{public_key_id}/delete/responses"}],"panels":[{"children":[{"kind":"response","responseCodes":[{"code":"204"},{"code":"400","schemaId":"components/schemas/InvalidRequestProblem","exampleIds":["paths/~1public-keys~1{public_key_id}/delete/responses/400/content/application~1problem+json/examples/malformed_json"],"mediaTypes":["application/problem+json"],"mediaTypeContent":{"application/problem+json":{"schemaId":"components/schemas/InvalidRequestProblem","exampleIds":["paths/~1public-keys~1{public_key_id}/delete/responses/400/content/application~1problem+json/examples/malformed_json"]}}},{"code":"401","schemaId":"components/schemas/UnauthorizedProblem","exampleIds":["paths/~1public-keys~1{public_key_id}/delete/responses/401/content/application~1problem+json/examples/service_authentication_denied"],"mediaTypes":["application/problem+json"],"mediaTypeContent":{"application/problem+json":{"schemaId":"components/schemas/UnauthorizedProblem","exampleIds":["paths/~1public-keys~1{public_key_id}/delete/responses/401/content/application~1problem+json/examples/service_authentication_denied"]}}},{"code":"403","schemaId":"components/schemas/ForbiddenProblem","exampleIds":["paths/~1public-keys~1{public_key_id}/delete/responses/403/content/application~1problem+json/examples/insufficient_permissions"],"mediaTypes":["application/problem+json"],"mediaTypeContent":{"application/problem+json":{"schemaId":"components/schemas/ForbiddenProblem","exampleIds":["paths/~1public-keys~1{public_key_id}/delete/responses/403/content/application~1problem+json/examples/insufficient_permissions"]}}},{"code":"404","schemaId":"components/schemas/NotFoundProblem","exampleIds":["paths/~1public-keys~1{public_key_id}/delete/responses/404/content/application~1problem+json/examples/address_not_found","paths/~1public-keys~1{public_key_id}/delete/responses/404/content/application~1problem+json/examples/invoice_not_found"],"mediaTypes":["application/problem+json"],"mediaTypeContent":{"application/problem+json":{"schemaId":"components/schemas/NotFoundProblem","exampleIds":["paths/~1public-keys~1{public_key_id}/delete/responses/404/content/application~1problem+json/examples/address_not_found","paths/~1public-keys~1{public_key_id}/delete/responses/404/content/application~1problem+json/examples/invoice_not_found"]}}},{"code":"409","schemaId":"components/schemas/ConflictProblem","exampleIds":["paths/~1public-keys~1{public_key_id}/delete/responses/409/content/application~1problem+json/examples/address_occupied","paths/~1public-keys~1{public_key_id}/delete/responses/409/content/application~1problem+json/examples/address_in_use","paths/~1public-keys~1{public_key_id}/delete/responses/409/content/application~1problem+json/examples/subscription_v1_conflict","paths/~1public-keys~1{public_key_id}/delete/responses/409/content/application~1problem+json/examples/notification_send_in_progress","paths/~1public-keys~1{public_key_id}/delete/responses/409/content/application~1problem+json/examples/notification_payload_unavailable","paths/~1public-keys~1{public_key_id}/delete/responses/409/content/application~1problem+json/examples/notification_test_resend_not_allowed"],"mediaTypes":["application/problem+json"],"mediaTypeContent":{"application/problem+json":{"schemaId":"components/schemas/ConflictProblem","exampleIds":["paths/~1public-keys~1{public_key_id}/delete/responses/409/content/application~1problem+json/examples/address_occupied","paths/~1public-keys~1{public_key_id}/delete/responses/409/content/application~1problem+json/examples/address_in_use","paths/~1public-keys~1{public_key_id}/delete/responses/409/content/application~1problem+json/examples/subscription_v1_conflict","paths/~1public-keys~1{public_key_id}/delete/responses/409/content/application~1problem+json/examples/notification_send_in_progress","paths/~1public-keys~1{public_key_id}/delete/responses/409/content/application~1problem+json/examples/notification_payload_unavailable","paths/~1public-keys~1{public_key_id}/delete/responses/409/content/application~1problem+json/examples/notification_test_resend_not_allowed"]}}},{"code":"503","schemaId":"components/schemas/Problem","exampleIds":["paths/~1public-keys~1{public_key_id}/delete/responses/503/content/application~1problem+json/examples/temporarily_unavailable"],"mediaTypes":["application/problem+json"],"mediaTypeContent":{"application/problem+json":{"schemaId":"components/schemas/Problem","exampleIds":["paths/~1public-keys~1{public_key_id}/delete/responses/503/content/application~1problem+json/examples/temporarily_unavailable"]}}},{"code":"default","schemaId":"components/schemas/Problem","mediaTypes":["application/problem+json"],"mediaTypeContent":{"application/problem+json":{"schemaId":"components/schemas/Problem"}}}],"examples":[]}]}]},{"nodeType":"container","children":[{"nodeType":"feedback","pageSlug":"/public_key/delete-public-key"}],"panels":[]}]},"httpPath":"/public-keys/{public_key_id}"},{"label":"Get public key","deprecated":false,"httpVerb":"get","isAdditionalOperation":false,"isWebhook":false,"type":"link","link":"/apis/platform/api/public_key/get-public-key","routeSlug":"/apis/platform/api/public_key/get-public-key","metadata":{"seo":{"title":"Get public key","description":"Get public key details by ID."}},"content":{"contentType":"item","itemVariant":"httpItem","meta":{"sourceId":"get-public-key","name":"Get public key","isWebhook":false,"pointer":"/paths/~1public-keys~1{public_key_id}/get","hasSamples":false},"children":[{"nodeType":"container","children":[{"nodeType":"header","level":2,"label":"Get public key","isWebhook":false,"showPageActions":true}],"panels":[]},{"nodeType":"container","children":[{"nodeType":"header","level":4,"label":"Request","labelTranslationKey":"request","deepLinkSuffix":"request"},{"nodeType":"markdoc","content":"Get public key details by ID."},{"nodeType":"security","requirements":[{"schemes":[{"name":"Auth","scopes":["api:public_key:read"],"type":"apiKey","in":"header","paramName":"X-Api-Key","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"API key for authenticating requests. Include your key in the "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"X-Api-Key"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" header. Keys can be created in the Vilna Dashboard or via the Management API. The scopes listed per operation indicate which permissions the key must have."},"children":[]}]}]}]}]}]},{"nodeType":"item-content","variant":"path","label":"Path","labelTranslationKey":"path","parameters":[{"name":"public_key_id","in":"path","schemaId":"schema_17","description":"Unique identifier (UUID) of the public key.","required":true}],"pointer":"/paths/~1public-keys~1{public_key_id}/get/parameters"}],"panels":[{"children":[{"kind":"code-sample","source":{"kind":"code-sample","operationType":"http","method":"GET","path":"/public-keys/{public_key_id}","servers":[{"url":"/_mock/apis/platform/api","description":"Mock server","isMockServer":true},{"url":"https://api.vilna.io/v2","description":"Vilna API."}],"parameters":{"path":[{"name":"public_key_id","in":"path","required":true,"example":"550e8400-e29b-41d4-a716-446655440000","schemaId":"components/schemas/UUID"}],"query":[],"querystring":[],"header":[],"cookie":[]},"security":[{"schemes":[{"id":"Auth","type":"apiKey","name":"X-Api-Key","in":"header"}],"scopes":["api:public_key:read"]}],"responseCodes":["200","400","401","403","404","503","default"],"pointer":"/public-keys/{public_key_id}","href":"public_key/get-public-key","openApiOperationId":"get-public-key","summary":"Get public key"},"isWebhook":false,"hideReplay":false,"servers":[{"url":"/_mock/apis/platform/api","description":"Mock server","isMockServer":true},{"url":"https://api.vilna.io/v2","description":"Vilna API."}],"examples":[]}]}]},{"nodeType":"container","children":[{"nodeType":"header","level":4,"label":"Responses","labelTranslationKey":"responses","deepLinkSuffix":"responses"},{"nodeType":"item-content","variant":"responses","responses":[{"code":"200","description":"Public key details.","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"schema_39"}},"schemaId":"schema_39"},{"code":"400","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Bad request (e.g., missing or invalid fields). Invalid text may be reported as address.label_invalid, address.meta_invalid, public_key.label_invalid, invoice.comment_invalid, invoice.metadata_invalid."},"children":[]}]}]}],"mediaType":"application/problem+json","mediaTypes":["application/problem+json"],"mediaTypeContent":{"application/problem+json":{"schemaId":"components/schemas/InvalidRequestProblem","exampleIds":["paths/~1public-keys~1{public_key_id}/get/responses/400/content/application~1problem+json/examples/malformed_json"]}},"schemaId":"components/schemas/InvalidRequestProblem","exampleIds":["paths/~1public-keys~1{public_key_id}/get/responses/400/content/application~1problem+json/examples/malformed_json"]},{"code":"401","description":"Missing or invalid authentication credentials.","mediaType":"application/problem+json","mediaTypes":["application/problem+json"],"mediaTypeContent":{"application/problem+json":{"schemaId":"components/schemas/UnauthorizedProblem","exampleIds":["paths/~1public-keys~1{public_key_id}/get/responses/401/content/application~1problem+json/examples/service_authentication_denied"]}},"schemaId":"components/schemas/UnauthorizedProblem","exampleIds":["paths/~1public-keys~1{public_key_id}/get/responses/401/content/application~1problem+json/examples/service_authentication_denied"]},{"code":"403","description":"Insufficient permissions.","mediaType":"application/problem+json","mediaTypes":["application/problem+json"],"mediaTypeContent":{"application/problem+json":{"schemaId":"components/schemas/ForbiddenProblem","exampleIds":["paths/~1public-keys~1{public_key_id}/get/responses/403/content/application~1problem+json/examples/insufficient_permissions"]}},"schemaId":"components/schemas/ForbiddenProblem","exampleIds":["paths/~1public-keys~1{public_key_id}/get/responses/403/content/application~1problem+json/examples/insufficient_permissions"]},{"code":"404","description":"Requested resource does not exist.","mediaType":"application/problem+json","mediaTypes":["application/problem+json"],"mediaTypeContent":{"application/problem+json":{"schemaId":"components/schemas/NotFoundProblem","exampleIds":["paths/~1public-keys~1{public_key_id}/get/responses/404/content/application~1problem+json/examples/address_not_found","paths/~1public-keys~1{public_key_id}/get/responses/404/content/application~1problem+json/examples/invoice_not_found"]}},"schemaId":"components/schemas/NotFoundProblem","exampleIds":["paths/~1public-keys~1{public_key_id}/get/responses/404/content/application~1problem+json/examples/address_not_found","paths/~1public-keys~1{public_key_id}/get/responses/404/content/application~1problem+json/examples/invoice_not_found"]},{"code":"503","description":"The operation is temporarily unavailable. Please try again later.","mediaType":"application/problem+json","mediaTypes":["application/problem+json"],"mediaTypeContent":{"application/problem+json":{"schemaId":"components/schemas/Problem","exampleIds":["paths/~1public-keys~1{public_key_id}/get/responses/503/content/application~1problem+json/examples/temporarily_unavailable"]}},"schemaId":"components/schemas/Problem","exampleIds":["paths/~1public-keys~1{public_key_id}/get/responses/503/content/application~1problem+json/examples/temporarily_unavailable"]},{"code":"default","description":"Unexpected error.","mediaType":"application/problem+json","mediaTypes":["application/problem+json"],"mediaTypeContent":{"application/problem+json":{"schemaId":"components/schemas/Problem"}},"schemaId":"components/schemas/Problem"}],"pointer":"/paths/~1public-keys~1{public_key_id}/get/responses"}],"panels":[{"children":[{"kind":"response","responseCodes":[{"code":"200","schemaId":"schema_39","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"schema_39"}}},{"code":"400","schemaId":"components/schemas/InvalidRequestProblem","exampleIds":["paths/~1public-keys~1{public_key_id}/get/responses/400/content/application~1problem+json/examples/malformed_json"],"mediaTypes":["application/problem+json"],"mediaTypeContent":{"application/problem+json":{"schemaId":"components/schemas/InvalidRequestProblem","exampleIds":["paths/~1public-keys~1{public_key_id}/get/responses/400/content/application~1problem+json/examples/malformed_json"]}}},{"code":"401","schemaId":"components/schemas/UnauthorizedProblem","exampleIds":["paths/~1public-keys~1{public_key_id}/get/responses/401/content/application~1problem+json/examples/service_authentication_denied"],"mediaTypes":["application/problem+json"],"mediaTypeContent":{"application/problem+json":{"schemaId":"components/schemas/UnauthorizedProblem","exampleIds":["paths/~1public-keys~1{public_key_id}/get/responses/401/content/application~1problem+json/examples/service_authentication_denied"]}}},{"code":"403","schemaId":"components/schemas/ForbiddenProblem","exampleIds":["paths/~1public-keys~1{public_key_id}/get/responses/403/content/application~1problem+json/examples/insufficient_permissions"],"mediaTypes":["application/problem+json"],"mediaTypeContent":{"application/problem+json":{"schemaId":"components/schemas/ForbiddenProblem","exampleIds":["paths/~1public-keys~1{public_key_id}/get/responses/403/content/application~1problem+json/examples/insufficient_permissions"]}}},{"code":"404","schemaId":"components/schemas/NotFoundProblem","exampleIds":["paths/~1public-keys~1{public_key_id}/get/responses/404/content/application~1problem+json/examples/address_not_found","paths/~1public-keys~1{public_key_id}/get/responses/404/content/application~1problem+json/examples/invoice_not_found"],"mediaTypes":["application/problem+json"],"mediaTypeContent":{"application/problem+json":{"schemaId":"components/schemas/NotFoundProblem","exampleIds":["paths/~1public-keys~1{public_key_id}/get/responses/404/content/application~1problem+json/examples/address_not_found","paths/~1public-keys~1{public_key_id}/get/responses/404/content/application~1problem+json/examples/invoice_not_found"]}}},{"code":"503","schemaId":"components/schemas/Problem","exampleIds":["paths/~1public-keys~1{public_key_id}/get/responses/503/content/application~1problem+json/examples/temporarily_unavailable"],"mediaTypes":["application/problem+json"],"mediaTypeContent":{"application/problem+json":{"schemaId":"components/schemas/Problem","exampleIds":["paths/~1public-keys~1{public_key_id}/get/responses/503/content/application~1problem+json/examples/temporarily_unavailable"]}}},{"code":"default","schemaId":"components/schemas/Problem","mediaTypes":["application/problem+json"],"mediaTypeContent":{"application/problem+json":{"schemaId":"components/schemas/Problem"}}}],"examples":[]}]}]},{"nodeType":"container","children":[{"nodeType":"feedback","pageSlug":"/public_key/get-public-key"}],"panels":[]}]},"httpPath":"/public-keys/{public_key_id}"},{"label":"Update public key","deprecated":false,"httpVerb":"patch","isAdditionalOperation":false,"isWebhook":false,"type":"link","link":"/apis/platform/api/public_key/patch-public-key","routeSlug":"/apis/platform/api/public_key/patch-public-key","metadata":{"seo":{"title":"Update public key","description":"Update public key metadata."}},"content":{"contentType":"item","itemVariant":"httpItem","meta":{"sourceId":"patch-public-key","name":"Update public key","isWebhook":false,"pointer":"/paths/~1public-keys~1{public_key_id}/patch","hasSamples":true},"children":[{"nodeType":"container","children":[{"nodeType":"header","level":2,"label":"Update public key","isWebhook":false,"showPageActions":true}],"panels":[]},{"nodeType":"container","children":[{"nodeType":"header","level":4,"label":"Request","labelTranslationKey":"request","deepLinkSuffix":"request"},{"nodeType":"markdoc","content":"Update public key metadata."},{"nodeType":"security","requirements":[{"schemes":[{"name":"Auth","scopes":["api:public_key:write"],"type":"apiKey","in":"header","paramName":"X-Api-Key","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"API key for authenticating requests. Include your key in the "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"X-Api-Key"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" header. Keys can be created in the Vilna Dashboard or via the Management API. The scopes listed per operation indicate which permissions the key must have."},"children":[]}]}]}]}]}]},{"nodeType":"item-content","variant":"path","label":"Path","labelTranslationKey":"path","parameters":[{"name":"public_key_id","in":"path","schemaId":"schema_17","description":"Unique identifier (UUID) of the public key.","required":true}],"pointer":"/paths/~1public-keys~1{public_key_id}/patch/parameters"},{"nodeType":"item-content","variant":"headers","label":"Headers","labelTranslationKey":"header","parameters":[{"name":"Idempotency-Key","in":"header","schemaId":"schema_14","description":"Case-sensitive opaque key for one mutation intent. Send exactly one header occurrence containing 1 to 128 visible ASCII bytes (0x21..0x7e). Commas are literal data; do not trim, lowercase or require UUID syntax. Reuse the same key for retries, with current authorization checked on every attempt. Repeated header occurrences are rejected.\n","required":true}],"pointer":"/paths/~1public-keys~1{public_key_id}/patch/parameters"},{"nodeType":"item-content","variant":"body","label":"Request Body","labelTranslationKey":"body","required":true,"mediaTypes":["application/json"],"mediaTypeSchemas":{"application/json":{"schemaId":"components/schemas/UpdatePublicKeyRequest"}},"schemaId":"components/schemas/UpdatePublicKeyRequest","pointer":"/paths/~1public-keys~1{public_key_id}/patch/requestBody"}],"panels":[{"children":[{"kind":"code-sample","source":{"kind":"code-sample","operationType":"http","method":"PATCH","path":"/public-keys/{public_key_id}","servers":[{"url":"/_mock/apis/platform/api","description":"Mock server","isMockServer":true},{"url":"https://api.vilna.io/v2","description":"Vilna API."}],"parameters":{"path":[{"name":"public_key_id","in":"path","required":true,"example":"550e8400-e29b-41d4-a716-446655440000","schemaId":"components/schemas/UUID"}],"query":[],"querystring":[],"header":[{"name":"Idempotency-Key","in":"header","required":true,"schemaId":"schema_14"}],"cookie":[]},"security":[{"schemes":[{"id":"Auth","type":"apiKey","name":"X-Api-Key","in":"header"}],"scopes":["api:public_key:write"]}],"requestBody":{"application/json":{"schemaId":"components/schemas/UpdatePublicKeyRequest"}},"responseCodes":["200","400","401","403","404","409","503","default"],"pointer":"/public-keys/{public_key_id}","href":"public_key/patch-public-key","openApiOperationId":"patch-public-key","summary":"Update public key"},"isWebhook":false,"hideReplay":false,"servers":[{"url":"/_mock/apis/platform/api","description":"Mock server","isMockServer":true},{"url":"https://api.vilna.io/v2","description":"Vilna API."}],"schemaId":"components/schemas/UpdatePublicKeyRequest","mediaTypes":["application/json"],"mediaTypeSchemas":{"application/json":{"schemaId":"components/schemas/UpdatePublicKeyRequest"}},"examples":[]}]}]},{"nodeType":"container","children":[{"nodeType":"header","level":4,"label":"Responses","labelTranslationKey":"responses","deepLinkSuffix":"responses"},{"nodeType":"item-content","variant":"responses","responses":[{"code":"200","description":"Updated public key.","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"schema_39"}},"schemaId":"schema_39"},{"code":"400","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Bad request (e.g., missing or invalid fields). Invalid text may be reported as address.label_invalid, address.meta_invalid, public_key.label_invalid, invoice.comment_invalid, invoice.metadata_invalid."},"children":[]}]}]}],"mediaType":"application/problem+json","mediaTypes":["application/problem+json"],"mediaTypeContent":{"application/problem+json":{"schemaId":"components/schemas/InvalidRequestProblem","exampleIds":["paths/~1public-keys~1{public_key_id}/patch/responses/400/content/application~1problem+json/examples/malformed_json"]}},"schemaId":"components/schemas/InvalidRequestProblem","exampleIds":["paths/~1public-keys~1{public_key_id}/patch/responses/400/content/application~1problem+json/examples/malformed_json"]},{"code":"401","description":"Missing or invalid authentication credentials.","mediaType":"application/problem+json","mediaTypes":["application/problem+json"],"mediaTypeContent":{"application/problem+json":{"schemaId":"components/schemas/UnauthorizedProblem","exampleIds":["paths/~1public-keys~1{public_key_id}/patch/responses/401/content/application~1problem+json/examples/service_authentication_denied"]}},"schemaId":"components/schemas/UnauthorizedProblem","exampleIds":["paths/~1public-keys~1{public_key_id}/patch/responses/401/content/application~1problem+json/examples/service_authentication_denied"]},{"code":"403","description":"Insufficient permissions.","mediaType":"application/problem+json","mediaTypes":["application/problem+json"],"mediaTypeContent":{"application/problem+json":{"schemaId":"components/schemas/ForbiddenProblem","exampleIds":["paths/~1public-keys~1{public_key_id}/patch/responses/403/content/application~1problem+json/examples/insufficient_permissions"]}},"schemaId":"components/schemas/ForbiddenProblem","exampleIds":["paths/~1public-keys~1{public_key_id}/patch/responses/403/content/application~1problem+json/examples/insufficient_permissions"]},{"code":"404","description":"Requested resource does not exist.","mediaType":"application/problem+json","mediaTypes":["application/problem+json"],"mediaTypeContent":{"application/problem+json":{"schemaId":"components/schemas/NotFoundProblem","exampleIds":["paths/~1public-keys~1{public_key_id}/patch/responses/404/content/application~1problem+json/examples/address_not_found","paths/~1public-keys~1{public_key_id}/patch/responses/404/content/application~1problem+json/examples/invoice_not_found"]}},"schemaId":"components/schemas/NotFoundProblem","exampleIds":["paths/~1public-keys~1{public_key_id}/patch/responses/404/content/application~1problem+json/examples/address_not_found","paths/~1public-keys~1{public_key_id}/patch/responses/404/content/application~1problem+json/examples/invoice_not_found"]},{"code":"409","description":"Request conflicts with the current resource state.","mediaType":"application/problem+json","mediaTypes":["application/problem+json"],"mediaTypeContent":{"application/problem+json":{"schemaId":"components/schemas/ConflictProblem","exampleIds":["paths/~1public-keys~1{public_key_id}/patch/responses/409/content/application~1problem+json/examples/address_occupied","paths/~1public-keys~1{public_key_id}/patch/responses/409/content/application~1problem+json/examples/address_in_use","paths/~1public-keys~1{public_key_id}/patch/responses/409/content/application~1problem+json/examples/subscription_v1_conflict","paths/~1public-keys~1{public_key_id}/patch/responses/409/content/application~1problem+json/examples/notification_send_in_progress","paths/~1public-keys~1{public_key_id}/patch/responses/409/content/application~1problem+json/examples/notification_payload_unavailable","paths/~1public-keys~1{public_key_id}/patch/responses/409/content/application~1problem+json/examples/notification_test_resend_not_allowed"]}},"schemaId":"components/schemas/ConflictProblem","exampleIds":["paths/~1public-keys~1{public_key_id}/patch/responses/409/content/application~1problem+json/examples/address_occupied","paths/~1public-keys~1{public_key_id}/patch/responses/409/content/application~1problem+json/examples/address_in_use","paths/~1public-keys~1{public_key_id}/patch/responses/409/content/application~1problem+json/examples/subscription_v1_conflict","paths/~1public-keys~1{public_key_id}/patch/responses/409/content/application~1problem+json/examples/notification_send_in_progress","paths/~1public-keys~1{public_key_id}/patch/responses/409/content/application~1problem+json/examples/notification_payload_unavailable","paths/~1public-keys~1{public_key_id}/patch/responses/409/content/application~1problem+json/examples/notification_test_resend_not_allowed"]},{"code":"503","description":"The operation is temporarily unavailable. Please try again later.","mediaType":"application/problem+json","mediaTypes":["application/problem+json"],"mediaTypeContent":{"application/problem+json":{"schemaId":"components/schemas/Problem","exampleIds":["paths/~1public-keys~1{public_key_id}/patch/responses/503/content/application~1problem+json/examples/temporarily_unavailable"]}},"schemaId":"components/schemas/Problem","exampleIds":["paths/~1public-keys~1{public_key_id}/patch/responses/503/content/application~1problem+json/examples/temporarily_unavailable"]},{"code":"default","description":"Unexpected error.","mediaType":"application/problem+json","mediaTypes":["application/problem+json"],"mediaTypeContent":{"application/problem+json":{"schemaId":"components/schemas/Problem"}},"schemaId":"components/schemas/Problem"}],"pointer":"/paths/~1public-keys~1{public_key_id}/patch/responses"}],"panels":[{"children":[{"kind":"response","responseCodes":[{"code":"200","schemaId":"schema_39","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"schema_39"}}},{"code":"400","schemaId":"components/schemas/InvalidRequestProblem","exampleIds":["paths/~1public-keys~1{public_key_id}/patch/responses/400/content/application~1problem+json/examples/malformed_json"],"mediaTypes":["application/problem+json"],"mediaTypeContent":{"application/problem+json":{"schemaId":"components/schemas/InvalidRequestProblem","exampleIds":["paths/~1public-keys~1{public_key_id}/patch/responses/400/content/application~1problem+json/examples/malformed_json"]}}},{"code":"401","schemaId":"components/schemas/UnauthorizedProblem","exampleIds":["paths/~1public-keys~1{public_key_id}/patch/responses/401/content/application~1problem+json/examples/service_authentication_denied"],"mediaTypes":["application/problem+json"],"mediaTypeContent":{"application/problem+json":{"schemaId":"components/schemas/UnauthorizedProblem","exampleIds":["paths/~1public-keys~1{public_key_id}/patch/responses/401/content/application~1problem+json/examples/service_authentication_denied"]}}},{"code":"403","schemaId":"components/schemas/ForbiddenProblem","exampleIds":["paths/~1public-keys~1{public_key_id}/patch/responses/403/content/application~1problem+json/examples/insufficient_permissions"],"mediaTypes":["application/problem+json"],"mediaTypeContent":{"application/problem+json":{"schemaId":"components/schemas/ForbiddenProblem","exampleIds":["paths/~1public-keys~1{public_key_id}/patch/responses/403/content/application~1problem+json/examples/insufficient_permissions"]}}},{"code":"404","schemaId":"components/schemas/NotFoundProblem","exampleIds":["paths/~1public-keys~1{public_key_id}/patch/responses/404/content/application~1problem+json/examples/address_not_found","paths/~1public-keys~1{public_key_id}/patch/responses/404/content/application~1problem+json/examples/invoice_not_found"],"mediaTypes":["application/problem+json"],"mediaTypeContent":{"application/problem+json":{"schemaId":"components/schemas/NotFoundProblem","exampleIds":["paths/~1public-keys~1{public_key_id}/patch/responses/404/content/application~1problem+json/examples/address_not_found","paths/~1public-keys~1{public_key_id}/patch/responses/404/content/application~1problem+json/examples/invoice_not_found"]}}},{"code":"409","schemaId":"components/schemas/ConflictProblem","exampleIds":["paths/~1public-keys~1{public_key_id}/patch/responses/409/content/application~1problem+json/examples/address_occupied","paths/~1public-keys~1{public_key_id}/patch/responses/409/content/application~1problem+json/examples/address_in_use","paths/~1public-keys~1{public_key_id}/patch/responses/409/content/application~1problem+json/examples/subscription_v1_conflict","paths/~1public-keys~1{public_key_id}/patch/responses/409/content/application~1problem+json/examples/notification_send_in_progress","paths/~1public-keys~1{public_key_id}/patch/responses/409/content/application~1problem+json/examples/notification_payload_unavailable","paths/~1public-keys~1{public_key_id}/patch/responses/409/content/application~1problem+json/examples/notification_test_resend_not_allowed"],"mediaTypes":["application/problem+json"],"mediaTypeContent":{"application/problem+json":{"schemaId":"components/schemas/ConflictProblem","exampleIds":["paths/~1public-keys~1{public_key_id}/patch/responses/409/content/application~1problem+json/examples/address_occupied","paths/~1public-keys~1{public_key_id}/patch/responses/409/content/application~1problem+json/examples/address_in_use","paths/~1public-keys~1{public_key_id}/patch/responses/409/content/application~1problem+json/examples/subscription_v1_conflict","paths/~1public-keys~1{public_key_id}/patch/responses/409/content/application~1problem+json/examples/notification_send_in_progress","paths/~1public-keys~1{public_key_id}/patch/responses/409/content/application~1problem+json/examples/notification_payload_unavailable","paths/~1public-keys~1{public_key_id}/patch/responses/409/content/application~1problem+json/examples/notification_test_resend_not_allowed"]}}},{"code":"503","schemaId":"components/schemas/Problem","exampleIds":["paths/~1public-keys~1{public_key_id}/patch/responses/503/content/application~1problem+json/examples/temporarily_unavailable"],"mediaTypes":["application/problem+json"],"mediaTypeContent":{"application/problem+json":{"schemaId":"components/schemas/Problem","exampleIds":["paths/~1public-keys~1{public_key_id}/patch/responses/503/content/application~1problem+json/examples/temporarily_unavailable"]}}},{"code":"default","schemaId":"components/schemas/Problem","mediaTypes":["application/problem+json"],"mediaTypeContent":{"application/problem+json":{"schemaId":"components/schemas/Problem"}}}],"examples":[]}]}]},{"nodeType":"container","children":[{"nodeType":"feedback","pageSlug":"/public_key/patch-public-key"}],"panels":[]}]},"httpPath":"/public-keys/{public_key_id}"},{"label":"Create child public key","deprecated":false,"httpVerb":"post","isAdditionalOperation":false,"isWebhook":false,"type":"link","link":"/apis/platform/api/public_key/create-public-key-child","routeSlug":"/apis/platform/api/public_key/create-public-key-child","metadata":{"seo":{"title":"Create child public key","description":"Derive and register a child key from an account-level public key. The server derives the child extended public key using BIP-32 derivation: no cryptography needed on the client side."}},"content":{"contentType":"item","itemVariant":"httpItem","meta":{"sourceId":"create-public-key-child","name":"Create child public key","isWebhook":false,"pointer":"/paths/~1public-keys~1{public_key_id}~1children/post","hasSamples":true},"children":[{"nodeType":"container","children":[{"nodeType":"header","level":2,"label":"Create child public key","isWebhook":false,"showPageActions":true}],"panels":[]},{"nodeType":"container","children":[{"nodeType":"header","level":4,"label":"Request","labelTranslationKey":"request","deepLinkSuffix":"request"},{"nodeType":"markdoc","content":"Derive and register a child key from an account-level public key.\nThe server derives the child extended public key using BIP-32 derivation: no cryptography\nneeded on the client side.\n\nIf a standalone key with the same derived value already exists in the project, it is adopted\nas a child of this account key.\n\nOnly applicable to account-level keys (depth-3).\n"},{"nodeType":"security","requirements":[{"schemes":[{"name":"Auth","scopes":["api:public_key:write"],"type":"apiKey","in":"header","paramName":"X-Api-Key","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"API key for authenticating requests. Include your key in the "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"X-Api-Key"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" header. Keys can be created in the Vilna Dashboard or via the Management API. The scopes listed per operation indicate which permissions the key must have."},"children":[]}]}]}]}]}]},{"nodeType":"item-content","variant":"path","label":"Path","labelTranslationKey":"path","parameters":[{"name":"public_key_id","in":"path","schemaId":"schema_17","description":"Unique identifier (UUID) of the public key.","required":true}],"pointer":"/paths/~1public-keys~1{public_key_id}~1children/post/parameters"},{"nodeType":"item-content","variant":"headers","label":"Headers","labelTranslationKey":"header","parameters":[{"name":"Idempotency-Key","in":"header","schemaId":"schema_14","description":"Case-sensitive opaque key for one mutation intent. Send exactly one header occurrence containing 1 to 128 visible ASCII bytes (0x21..0x7e). Commas are literal data; do not trim, lowercase or require UUID syntax. Reuse the same key for retries, with current authorization checked on every attempt. Repeated header occurrences are rejected.\n","required":true}],"pointer":"/paths/~1public-keys~1{public_key_id}~1children/post/parameters"},{"nodeType":"item-content","variant":"body","label":"Request Body","labelTranslationKey":"body","required":true,"mediaTypes":["application/json"],"mediaTypeSchemas":{"application/json":{"schemaId":"components/schemas/CreatePublicKeyChildRequest","exampleIds":["paths/~1public-keys~1{public_key_id}~1children/post/requestBody/content/application~1json/examples/external_child","paths/~1public-keys~1{public_key_id}~1children/post/requestBody/content/application~1json/examples/internal_child"]}},"schemaId":"components/schemas/CreatePublicKeyChildRequest","exampleIds":["paths/~1public-keys~1{public_key_id}~1children/post/requestBody/content/application~1json/examples/external_child","paths/~1public-keys~1{public_key_id}~1children/post/requestBody/content/application~1json/examples/internal_child"],"pointer":"/paths/~1public-keys~1{public_key_id}~1children/post/requestBody"}],"panels":[{"children":[{"kind":"code-sample","source":{"kind":"code-sample","operationType":"http","method":"POST","path":"/public-keys/{public_key_id}/children","servers":[{"url":"/_mock/apis/platform/api","description":"Mock server","isMockServer":true},{"url":"https://api.vilna.io/v2","description":"Vilna API."}],"parameters":{"path":[{"name":"public_key_id","in":"path","required":true,"example":"550e8400-e29b-41d4-a716-446655440000","schemaId":"components/schemas/UUID"}],"query":[],"querystring":[],"header":[{"name":"Idempotency-Key","in":"header","required":true,"schemaId":"schema_14"}],"cookie":[]},"security":[{"schemes":[{"id":"Auth","type":"apiKey","name":"X-Api-Key","in":"header"}],"scopes":["api:public_key:write"]}],"requestBody":{"application/json":{"schemaId":"components/schemas/CreatePublicKeyChildRequest","exampleIds":["paths/~1public-keys~1{public_key_id}~1children/post/requestBody/content/application~1json/examples/external_child","paths/~1public-keys~1{public_key_id}~1children/post/requestBody/content/application~1json/examples/internal_child"]}},"responseCodes":["200","201","400","401","403","404","409","422","429","503","default"],"pointer":"/public-keys/{public_key_id}/children","href":"public_key/create-public-key-child","openApiOperationId":"create-public-key-child","summary":"Create child public key"},"isWebhook":false,"hideReplay":false,"servers":[{"url":"/_mock/apis/platform/api","description":"Mock server","isMockServer":true},{"url":"https://api.vilna.io/v2","description":"Vilna API."}],"schemaId":"components/schemas/CreatePublicKeyChildRequest","exampleIds":["paths/~1public-keys~1{public_key_id}~1children/post/requestBody/content/application~1json/examples/external_child","paths/~1public-keys~1{public_key_id}~1children/post/requestBody/content/application~1json/examples/internal_child"],"mediaTypes":["application/json"],"mediaTypeSchemas":{"application/json":{"schemaId":"components/schemas/CreatePublicKeyChildRequest","exampleIds":["paths/~1public-keys~1{public_key_id}~1children/post/requestBody/content/application~1json/examples/external_child","paths/~1public-keys~1{public_key_id}~1children/post/requestBody/content/application~1json/examples/internal_child"]}},"examples":[{},{}]}]}]},{"nodeType":"container","children":[{"nodeType":"header","level":4,"label":"Responses","labelTranslationKey":"responses","deepLinkSuffix":"responses"},{"nodeType":"item-content","variant":"responses","responses":[{"code":"200","description":"Created child public key.","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"schema_39"}},"schemaId":"schema_39"},{"code":"201","description":"Created child public key.","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"schema_39"}},"schemaId":"schema_39"},{"code":"400","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Bad request (e.g., missing or invalid fields). Invalid text may be reported as address.label_invalid, address.meta_invalid, public_key.label_invalid, invoice.comment_invalid, invoice.metadata_invalid."},"children":[]}]}]}],"mediaType":"application/problem+json","mediaTypes":["application/problem+json"],"mediaTypeContent":{"application/problem+json":{"schemaId":"components/schemas/InvalidRequestProblem","exampleIds":["paths/~1public-keys~1{public_key_id}~1children/post/responses/400/content/application~1problem+json/examples/malformed_json"]}},"schemaId":"components/schemas/InvalidRequestProblem","exampleIds":["paths/~1public-keys~1{public_key_id}~1children/post/responses/400/content/application~1problem+json/examples/malformed_json"]},{"code":"401","description":"Missing or invalid authentication credentials.","mediaType":"application/problem+json","mediaTypes":["application/problem+json"],"mediaTypeContent":{"application/problem+json":{"schemaId":"components/schemas/UnauthorizedProblem","exampleIds":["paths/~1public-keys~1{public_key_id}~1children/post/responses/401/content/application~1problem+json/examples/service_authentication_denied"]}},"schemaId":"components/schemas/UnauthorizedProblem","exampleIds":["paths/~1public-keys~1{public_key_id}~1children/post/responses/401/content/application~1problem+json/examples/service_authentication_denied"]},{"code":"403","description":"Insufficient permissions.","mediaType":"application/problem+json","mediaTypes":["application/problem+json"],"mediaTypeContent":{"application/problem+json":{"schemaId":"components/schemas/ForbiddenProblem","exampleIds":["paths/~1public-keys~1{public_key_id}~1children/post/responses/403/content/application~1problem+json/examples/insufficient_permissions"]}},"schemaId":"components/schemas/ForbiddenProblem","exampleIds":["paths/~1public-keys~1{public_key_id}~1children/post/responses/403/content/application~1problem+json/examples/insufficient_permissions"]},{"code":"404","description":"Requested resource does not exist.","mediaType":"application/problem+json","mediaTypes":["application/problem+json"],"mediaTypeContent":{"application/problem+json":{"schemaId":"components/schemas/NotFoundProblem","exampleIds":["paths/~1public-keys~1{public_key_id}~1children/post/responses/404/content/application~1problem+json/examples/address_not_found","paths/~1public-keys~1{public_key_id}~1children/post/responses/404/content/application~1problem+json/examples/invoice_not_found"]}},"schemaId":"components/schemas/NotFoundProblem","exampleIds":["paths/~1public-keys~1{public_key_id}~1children/post/responses/404/content/application~1problem+json/examples/address_not_found","paths/~1public-keys~1{public_key_id}~1children/post/responses/404/content/application~1problem+json/examples/invoice_not_found"]},{"code":"409","description":"Request conflicts with the current resource state.","mediaType":"application/problem+json","mediaTypes":["application/problem+json"],"mediaTypeContent":{"application/problem+json":{"schemaId":"components/schemas/ConflictProblem","exampleIds":["paths/~1public-keys~1{public_key_id}~1children/post/responses/409/content/application~1problem+json/examples/address_occupied","paths/~1public-keys~1{public_key_id}~1children/post/responses/409/content/application~1problem+json/examples/address_in_use","paths/~1public-keys~1{public_key_id}~1children/post/responses/409/content/application~1problem+json/examples/subscription_v1_conflict","paths/~1public-keys~1{public_key_id}~1children/post/responses/409/content/application~1problem+json/examples/notification_send_in_progress","paths/~1public-keys~1{public_key_id}~1children/post/responses/409/content/application~1problem+json/examples/notification_payload_unavailable","paths/~1public-keys~1{public_key_id}~1children/post/responses/409/content/application~1problem+json/examples/notification_test_resend_not_allowed"]}},"schemaId":"components/schemas/ConflictProblem","exampleIds":["paths/~1public-keys~1{public_key_id}~1children/post/responses/409/content/application~1problem+json/examples/address_occupied","paths/~1public-keys~1{public_key_id}~1children/post/responses/409/content/application~1problem+json/examples/address_in_use","paths/~1public-keys~1{public_key_id}~1children/post/responses/409/content/application~1problem+json/examples/subscription_v1_conflict","paths/~1public-keys~1{public_key_id}~1children/post/responses/409/content/application~1problem+json/examples/notification_send_in_progress","paths/~1public-keys~1{public_key_id}~1children/post/responses/409/content/application~1problem+json/examples/notification_payload_unavailable","paths/~1public-keys~1{public_key_id}~1children/post/responses/409/content/application~1problem+json/examples/notification_test_resend_not_allowed"]},{"code":"422","description":"Request preconditions were not met.","mediaType":"application/problem+json","mediaTypes":["application/problem+json"],"mediaTypeContent":{"application/problem+json":{"schemaId":"components/schemas/PreconditionProblem","exampleIds":["paths/~1public-keys~1{public_key_id}~1children/post/responses/422/content/application~1problem+json/examples/invoice_not_cancellable"]}},"schemaId":"components/schemas/PreconditionProblem","exampleIds":["paths/~1public-keys~1{public_key_id}~1children/post/responses/422/content/application~1problem+json/examples/invoice_not_cancellable"]},{"code":"429","description":"Resource quota exceeded. The response includes the effective limit for this scope. The applicable code and limit depend on the operation; examples illustrate different limits.","mediaType":"application/problem+json","mediaTypes":["application/problem+json"],"mediaTypeContent":{"application/problem+json":{"schemaId":"components/schemas/QuotaExceededProblem","exampleIds":["paths/~1public-keys~1{public_key_id}~1children/post/responses/429/content/application~1problem+json/examples/address_quota","paths/~1public-keys~1{public_key_id}~1children/post/responses/429/content/application~1problem+json/examples/creation_prohibited"]}},"schemaId":"components/schemas/QuotaExceededProblem","exampleIds":["paths/~1public-keys~1{public_key_id}~1children/post/responses/429/content/application~1problem+json/examples/address_quota","paths/~1public-keys~1{public_key_id}~1children/post/responses/429/content/application~1problem+json/examples/creation_prohibited"]},{"code":"503","description":"The operation is temporarily unavailable. Please try again later.","mediaType":"application/problem+json","mediaTypes":["application/problem+json"],"mediaTypeContent":{"application/problem+json":{"schemaId":"components/schemas/Problem","exampleIds":["paths/~1public-keys~1{public_key_id}~1children/post/responses/503/content/application~1problem+json/examples/temporarily_unavailable"]}},"schemaId":"components/schemas/Problem","exampleIds":["paths/~1public-keys~1{public_key_id}~1children/post/responses/503/content/application~1problem+json/examples/temporarily_unavailable"]},{"code":"default","description":"Unexpected error.","mediaType":"application/problem+json","mediaTypes":["application/problem+json"],"mediaTypeContent":{"application/problem+json":{"schemaId":"components/schemas/Problem"}},"schemaId":"components/schemas/Problem"}],"pointer":"/paths/~1public-keys~1{public_key_id}~1children/post/responses"}],"panels":[{"children":[{"kind":"response","responseCodes":[{"code":"200","schemaId":"schema_39","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"schema_39"}}},{"code":"201","schemaId":"schema_39","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"schema_39"}}},{"code":"400","schemaId":"components/schemas/InvalidRequestProblem","exampleIds":["paths/~1public-keys~1{public_key_id}~1children/post/responses/400/content/application~1problem+json/examples/malformed_json"],"mediaTypes":["application/problem+json"],"mediaTypeContent":{"application/problem+json":{"schemaId":"components/schemas/InvalidRequestProblem","exampleIds":["paths/~1public-keys~1{public_key_id}~1children/post/responses/400/content/application~1problem+json/examples/malformed_json"]}}},{"code":"401","schemaId":"components/schemas/UnauthorizedProblem","exampleIds":["paths/~1public-keys~1{public_key_id}~1children/post/responses/401/content/application~1problem+json/examples/service_authentication_denied"],"mediaTypes":["application/problem+json"],"mediaTypeContent":{"application/problem+json":{"schemaId":"components/schemas/UnauthorizedProblem","exampleIds":["paths/~1public-keys~1{public_key_id}~1children/post/responses/401/content/application~1problem+json/examples/service_authentication_denied"]}}},{"code":"403","schemaId":"components/schemas/ForbiddenProblem","exampleIds":["paths/~1public-keys~1{public_key_id}~1children/post/responses/403/content/application~1problem+json/examples/insufficient_permissions"],"mediaTypes":["application/problem+json"],"mediaTypeContent":{"application/problem+json":{"schemaId":"components/schemas/ForbiddenProblem","exampleIds":["paths/~1public-keys~1{public_key_id}~1children/post/responses/403/content/application~1problem+json/examples/insufficient_permissions"]}}},{"code":"404","schemaId":"components/schemas/NotFoundProblem","exampleIds":["paths/~1public-keys~1{public_key_id}~1children/post/responses/404/content/application~1problem+json/examples/address_not_found","paths/~1public-keys~1{public_key_id}~1children/post/responses/404/content/application~1problem+json/examples/invoice_not_found"],"mediaTypes":["application/problem+json"],"mediaTypeContent":{"application/problem+json":{"schemaId":"components/schemas/NotFoundProblem","exampleIds":["paths/~1public-keys~1{public_key_id}~1children/post/responses/404/content/application~1problem+json/examples/address_not_found","paths/~1public-keys~1{public_key_id}~1children/post/responses/404/content/application~1problem+json/examples/invoice_not_found"]}}},{"code":"409","schemaId":"components/schemas/ConflictProblem","exampleIds":["paths/~1public-keys~1{public_key_id}~1children/post/responses/409/content/application~1problem+json/examples/address_occupied","paths/~1public-keys~1{public_key_id}~1children/post/responses/409/content/application~1problem+json/examples/address_in_use","paths/~1public-keys~1{public_key_id}~1children/post/responses/409/content/application~1problem+json/examples/subscription_v1_conflict","paths/~1public-keys~1{public_key_id}~1children/post/responses/409/content/application~1problem+json/examples/notification_send_in_progress","paths/~1public-keys~1{public_key_id}~1children/post/responses/409/content/application~1problem+json/examples/notification_payload_unavailable","paths/~1public-keys~1{public_key_id}~1children/post/responses/409/content/application~1problem+json/examples/notification_test_resend_not_allowed"],"mediaTypes":["application/problem+json"],"mediaTypeContent":{"application/problem+json":{"schemaId":"components/schemas/ConflictProblem","exampleIds":["paths/~1public-keys~1{public_key_id}~1children/post/responses/409/content/application~1problem+json/examples/address_occupied","paths/~1public-keys~1{public_key_id}~1children/post/responses/409/content/application~1problem+json/examples/address_in_use","paths/~1public-keys~1{public_key_id}~1children/post/responses/409/content/application~1problem+json/examples/subscription_v1_conflict","paths/~1public-keys~1{public_key_id}~1children/post/responses/409/content/application~1problem+json/examples/notification_send_in_progress","paths/~1public-keys~1{public_key_id}~1children/post/responses/409/content/application~1problem+json/examples/notification_payload_unavailable","paths/~1public-keys~1{public_key_id}~1children/post/responses/409/content/application~1problem+json/examples/notification_test_resend_not_allowed"]}}},{"code":"422","schemaId":"components/schemas/PreconditionProblem","exampleIds":["paths/~1public-keys~1{public_key_id}~1children/post/responses/422/content/application~1problem+json/examples/invoice_not_cancellable"],"mediaTypes":["application/problem+json"],"mediaTypeContent":{"application/problem+json":{"schemaId":"components/schemas/PreconditionProblem","exampleIds":["paths/~1public-keys~1{public_key_id}~1children/post/responses/422/content/application~1problem+json/examples/invoice_not_cancellable"]}}},{"code":"429","schemaId":"components/schemas/QuotaExceededProblem","exampleIds":["paths/~1public-keys~1{public_key_id}~1children/post/responses/429/content/application~1problem+json/examples/address_quota","paths/~1public-keys~1{public_key_id}~1children/post/responses/429/content/application~1problem+json/examples/creation_prohibited"],"mediaTypes":["application/problem+json"],"mediaTypeContent":{"application/problem+json":{"schemaId":"components/schemas/QuotaExceededProblem","exampleIds":["paths/~1public-keys~1{public_key_id}~1children/post/responses/429/content/application~1problem+json/examples/address_quota","paths/~1public-keys~1{public_key_id}~1children/post/responses/429/content/application~1problem+json/examples/creation_prohibited"]}}},{"code":"503","schemaId":"components/schemas/Problem","exampleIds":["paths/~1public-keys~1{public_key_id}~1children/post/responses/503/content/application~1problem+json/examples/temporarily_unavailable"],"mediaTypes":["application/problem+json"],"mediaTypeContent":{"application/problem+json":{"schemaId":"components/schemas/Problem","exampleIds":["paths/~1public-keys~1{public_key_id}~1children/post/responses/503/content/application~1problem+json/examples/temporarily_unavailable"]}}},{"code":"default","schemaId":"components/schemas/Problem","mediaTypes":["application/problem+json"],"mediaTypeContent":{"application/problem+json":{"schemaId":"components/schemas/Problem"}}}],"examples":[]}]}]},{"nodeType":"container","children":[{"nodeType":"feedback","pageSlug":"/public_key/create-public-key-child"}],"panels":[]}]},"httpPath":"/public-keys/{public_key_id}/children"},{"label":"List public key addresses","deprecated":false,"httpVerb":"get","isAdditionalOperation":false,"isWebhook":false,"type":"link","link":"/apis/platform/api/public_key/list-public-key-addresses","routeSlug":"/apis/platform/api/public_key/list-public-key-addresses","metadata":{"seo":{"title":"List public key addresses","description":"List addresses derived from the public key."}},"content":{"contentType":"item","itemVariant":"httpItem","meta":{"sourceId":"list-public-key-addresses","name":"List public key addresses","isWebhook":false,"pointer":"/paths/~1public-keys~1{public_key_id}~1addresses/get","hasSamples":false},"children":[{"nodeType":"container","children":[{"nodeType":"header","level":2,"label":"List public key addresses","isWebhook":false,"showPageActions":true}],"panels":[]},{"nodeType":"container","children":[{"nodeType":"header","level":4,"label":"Request","labelTranslationKey":"request","deepLinkSuffix":"request"},{"nodeType":"markdoc","content":"List addresses derived from the public key."},{"nodeType":"security","requirements":[{"schemes":[{"name":"Auth","scopes":["api:public_key:read"],"type":"apiKey","in":"header","paramName":"X-Api-Key","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"API key for authenticating requests. Include your key in the "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"X-Api-Key"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" header. Keys can be created in the Vilna Dashboard or via the Management API. The scopes listed per operation indicate which permissions the key must have."},"children":[]}]}]}]}]}]},{"nodeType":"item-content","variant":"path","label":"Path","labelTranslationKey":"path","parameters":[{"name":"public_key_id","in":"path","schemaId":"schema_17","description":"Unique identifier (UUID) of the public key.","required":true}],"pointer":"/paths/~1public-keys~1{public_key_id}~1addresses/get/parameters"},{"nodeType":"item-content","variant":"query","label":"Query","labelTranslationKey":"query","parameters":[{"name":"limit","in":"query","schemaId":"schema_0","description":"Maximum number of items to return."},{"name":"page","in":"query","schemaId":"schema_1","description":"Page number for pagination."},{"name":"sort_by","in":"query","schemaId":"schema_18","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Field to sort results by. Use "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"-"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" prefix for descending order."},"children":[]}]}]}]},{"name":"format","in":"query","style":"form","explode":true,"schemaId":"schema_19","description":"Filter addresses by address format.","example":["p2wpkh"]},{"name":"search","in":"query","schemaId":"schema_20","description":"Filter addresses by value or label (partial match, case-insensitive)."},{"name":"tag_id","in":"query","style":"form","explode":true,"schemaId":"schema_21","description":"Filter addresses by tag identifier (UUID). Repeat the parameter to pass\nmultiple values; addresses tagged with any of them are returned (OR semantics).\n","example":["0199ce7e-d9e7-7c01-9c2a-9d0010eaa1cc"]}],"pointer":"/paths/~1public-keys~1{public_key_id}~1addresses/get/parameters"}],"panels":[{"children":[{"kind":"code-sample","source":{"kind":"code-sample","operationType":"http","method":"GET","path":"/public-keys/{public_key_id}/addresses","servers":[{"url":"/_mock/apis/platform/api","description":"Mock server","isMockServer":true},{"url":"https://api.vilna.io/v2","description":"Vilna API."}],"parameters":{"path":[{"name":"public_key_id","in":"path","required":true,"example":"550e8400-e29b-41d4-a716-446655440000","schemaId":"components/schemas/UUID"}],"query":[{"name":"limit","in":"query","required":false,"example":20,"schemaId":"schema_0"},{"name":"page","in":"query","required":false,"example":1,"schemaId":"schema_1"},{"name":"sort_by","in":"query","required":false,"example":"created_at","schemaId":"schema_18"},{"name":"format","in":"query","required":false,"example":["p2wpkh"],"schemaId":"schema_19","style":"form","explode":true},{"name":"search","in":"query","required":false,"example":"bc1q","schemaId":"schema_20"},{"name":"tag_id","in":"query","required":false,"example":["0199ce7e-d9e7-7c01-9c2a-9d0010eaa1cc"],"schemaId":"schema_21","style":"form","explode":true}],"querystring":[],"header":[],"cookie":[]},"security":[{"schemes":[{"id":"Auth","type":"apiKey","name":"X-Api-Key","in":"header"}],"scopes":["api:public_key:read"]}],"responseCodes":["200","400","401","403","404","503","default"],"pointer":"/public-keys/{public_key_id}/addresses","href":"public_key/list-public-key-addresses","openApiOperationId":"list-public-key-addresses","summary":"List public key addresses"},"isWebhook":false,"hideReplay":false,"servers":[{"url":"/_mock/apis/platform/api","description":"Mock server","isMockServer":true},{"url":"https://api.vilna.io/v2","description":"Vilna API."}],"examples":[]}]}]},{"nodeType":"container","children":[{"nodeType":"header","level":4,"label":"Responses","labelTranslationKey":"responses","deepLinkSuffix":"responses"},{"nodeType":"item-content","variant":"responses","responses":[{"code":"200","description":"List of addresses derived from the public key.","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"schema_22"}},"schemaId":"schema_22"},{"code":"400","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Bad request (e.g., missing or invalid fields). Invalid text may be reported as address.label_invalid, address.meta_invalid, public_key.label_invalid, invoice.comment_invalid, invoice.metadata_invalid."},"children":[]}]}]}],"mediaType":"application/problem+json","mediaTypes":["application/problem+json"],"mediaTypeContent":{"application/problem+json":{"schemaId":"components/schemas/InvalidRequestProblem","exampleIds":["paths/~1public-keys~1{public_key_id}~1addresses/get/responses/400/content/application~1problem+json/examples/malformed_json"]}},"schemaId":"components/schemas/InvalidRequestProblem","exampleIds":["paths/~1public-keys~1{public_key_id}~1addresses/get/responses/400/content/application~1problem+json/examples/malformed_json"]},{"code":"401","description":"Missing or invalid authentication credentials.","mediaType":"application/problem+json","mediaTypes":["application/problem+json"],"mediaTypeContent":{"application/problem+json":{"schemaId":"components/schemas/UnauthorizedProblem","exampleIds":["paths/~1public-keys~1{public_key_id}~1addresses/get/responses/401/content/application~1problem+json/examples/service_authentication_denied"]}},"schemaId":"components/schemas/UnauthorizedProblem","exampleIds":["paths/~1public-keys~1{public_key_id}~1addresses/get/responses/401/content/application~1problem+json/examples/service_authentication_denied"]},{"code":"403","description":"Insufficient permissions.","mediaType":"application/problem+json","mediaTypes":["application/problem+json"],"mediaTypeContent":{"application/problem+json":{"schemaId":"components/schemas/ForbiddenProblem","exampleIds":["paths/~1public-keys~1{public_key_id}~1addresses/get/responses/403/content/application~1problem+json/examples/insufficient_permissions"]}},"schemaId":"components/schemas/ForbiddenProblem","exampleIds":["paths/~1public-keys~1{public_key_id}~1addresses/get/responses/403/content/application~1problem+json/examples/insufficient_permissions"]},{"code":"404","description":"Requested resource does not exist.","mediaType":"application/problem+json","mediaTypes":["application/problem+json"],"mediaTypeContent":{"application/problem+json":{"schemaId":"components/schemas/NotFoundProblem","exampleIds":["paths/~1public-keys~1{public_key_id}~1addresses/get/responses/404/content/application~1problem+json/examples/address_not_found","paths/~1public-keys~1{public_key_id}~1addresses/get/responses/404/content/application~1problem+json/examples/invoice_not_found"]}},"schemaId":"components/schemas/NotFoundProblem","exampleIds":["paths/~1public-keys~1{public_key_id}~1addresses/get/responses/404/content/application~1problem+json/examples/address_not_found","paths/~1public-keys~1{public_key_id}~1addresses/get/responses/404/content/application~1problem+json/examples/invoice_not_found"]},{"code":"503","description":"The operation is temporarily unavailable. Please try again later.","mediaType":"application/problem+json","mediaTypes":["application/problem+json"],"mediaTypeContent":{"application/problem+json":{"schemaId":"components/schemas/Problem","exampleIds":["paths/~1public-keys~1{public_key_id}~1addresses/get/responses/503/content/application~1problem+json/examples/temporarily_unavailable"]}},"schemaId":"components/schemas/Problem","exampleIds":["paths/~1public-keys~1{public_key_id}~1addresses/get/responses/503/content/application~1problem+json/examples/temporarily_unavailable"]},{"code":"default","description":"Unexpected error.","mediaType":"application/problem+json","mediaTypes":["application/problem+json"],"mediaTypeContent":{"application/problem+json":{"schemaId":"components/schemas/Problem"}},"schemaId":"components/schemas/Problem"}],"pointer":"/paths/~1public-keys~1{public_key_id}~1addresses/get/responses"}],"panels":[{"children":[{"kind":"response","responseCodes":[{"code":"200","schemaId":"schema_22","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"schema_22"}}},{"code":"400","schemaId":"components/schemas/InvalidRequestProblem","exampleIds":["paths/~1public-keys~1{public_key_id}~1addresses/get/responses/400/content/application~1problem+json/examples/malformed_json"],"mediaTypes":["application/problem+json"],"mediaTypeContent":{"application/problem+json":{"schemaId":"components/schemas/InvalidRequestProblem","exampleIds":["paths/~1public-keys~1{public_key_id}~1addresses/get/responses/400/content/application~1problem+json/examples/malformed_json"]}}},{"code":"401","schemaId":"components/schemas/UnauthorizedProblem","exampleIds":["paths/~1public-keys~1{public_key_id}~1addresses/get/responses/401/content/application~1problem+json/examples/service_authentication_denied"],"mediaTypes":["application/problem+json"],"mediaTypeContent":{"application/problem+json":{"schemaId":"components/schemas/UnauthorizedProblem","exampleIds":["paths/~1public-keys~1{public_key_id}~1addresses/get/responses/401/content/application~1problem+json/examples/service_authentication_denied"]}}},{"code":"403","schemaId":"components/schemas/ForbiddenProblem","exampleIds":["paths/~1public-keys~1{public_key_id}~1addresses/get/responses/403/content/application~1problem+json/examples/insufficient_permissions"],"mediaTypes":["application/problem+json"],"mediaTypeContent":{"application/problem+json":{"schemaId":"components/schemas/ForbiddenProblem","exampleIds":["paths/~1public-keys~1{public_key_id}~1addresses/get/responses/403/content/application~1problem+json/examples/insufficient_permissions"]}}},{"code":"404","schemaId":"components/schemas/NotFoundProblem","exampleIds":["paths/~1public-keys~1{public_key_id}~1addresses/get/responses/404/content/application~1problem+json/examples/address_not_found","paths/~1public-keys~1{public_key_id}~1addresses/get/responses/404/content/application~1problem+json/examples/invoice_not_found"],"mediaTypes":["application/problem+json"],"mediaTypeContent":{"application/problem+json":{"schemaId":"components/schemas/NotFoundProblem","exampleIds":["paths/~1public-keys~1{public_key_id}~1addresses/get/responses/404/content/application~1problem+json/examples/address_not_found","paths/~1public-keys~1{public_key_id}~1addresses/get/responses/404/content/application~1problem+json/examples/invoice_not_found"]}}},{"code":"503","schemaId":"components/schemas/Problem","exampleIds":["paths/~1public-keys~1{public_key_id}~1addresses/get/responses/503/content/application~1problem+json/examples/temporarily_unavailable"],"mediaTypes":["application/problem+json"],"mediaTypeContent":{"application/problem+json":{"schemaId":"components/schemas/Problem","exampleIds":["paths/~1public-keys~1{public_key_id}~1addresses/get/responses/503/content/application~1problem+json/examples/temporarily_unavailable"]}}},{"code":"default","schemaId":"components/schemas/Problem","mediaTypes":["application/problem+json"],"mediaTypeContent":{"application/problem+json":{"schemaId":"components/schemas/Problem"}}}],"examples":[]}]}]},{"nodeType":"container","children":[{"nodeType":"feedback","pageSlug":"/public_key/list-public-key-addresses"}],"panels":[]}]},"httpPath":"/public-keys/{public_key_id}/addresses"},{"label":"Generate public key addresses","deprecated":false,"httpVerb":"post","isAdditionalOperation":false,"isWebhook":false,"type":"link","link":"/apis/platform/api/public_key/generate-public-key-addresses","routeSlug":"/apis/platform/api/public_key/generate-public-key-addresses","metadata":{"seo":{"title":"Generate public key addresses","description":"Generate addresses for the public key, either a range of derivation indexes or the next unused one. An index that already has an address is returned unchanged; label and meta apply only to the addresses this call creates. Answers 200 when nothing was created and 201 when at least one address was. next is one past the highest index generated for this key and chain family; two independent next intents get distinct indexes. Retrying the same intent with the same Idempotency-Key returns its original addresses while replay is available."}},"content":{"contentType":"item","itemVariant":"httpItem","meta":{"sourceId":"generate-public-key-addresses","name":"Generate public key addresses","isWebhook":false,"pointer":"/paths/~1public-keys~1{public_key_id}~1addresses/post","hasSamples":true},"children":[{"nodeType":"container","children":[{"nodeType":"header","level":2,"label":"Generate public key addresses","isWebhook":false,"showPageActions":true}],"panels":[]},{"nodeType":"container","children":[{"nodeType":"header","level":4,"label":"Request","labelTranslationKey":"request","deepLinkSuffix":"request"},{"nodeType":"markdoc","content":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Generate addresses for the public key, either a range of derivation indexes or the next unused one. An index that already has an address is returned unchanged; "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"label"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" and "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"meta"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" apply only to the addresses this call creates. Answers 200 when nothing was created and 201 when at least one address was. "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"next"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" is one past the highest index generated for this key and chain family; two independent "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"next"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" intents get distinct indexes. Retrying the same intent with the same Idempotency-Key returns its original addresses while replay is available."},"children":[]}]}]}]},{"nodeType":"security","requirements":[{"schemes":[{"name":"Auth","scopes":["api:address:write"],"type":"apiKey","in":"header","paramName":"X-Api-Key","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"API key for authenticating requests. Include your key in the "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"X-Api-Key"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" header. Keys can be created in the Vilna Dashboard or via the Management API. The scopes listed per operation indicate which permissions the key must have."},"children":[]}]}]}]}]}]},{"nodeType":"item-content","variant":"path","label":"Path","labelTranslationKey":"path","parameters":[{"name":"public_key_id","in":"path","schemaId":"schema_17","description":"Unique identifier (UUID) of the public key.","required":true}],"pointer":"/paths/~1public-keys~1{public_key_id}~1addresses/post/parameters"},{"nodeType":"item-content","variant":"headers","label":"Headers","labelTranslationKey":"header","parameters":[{"name":"Idempotency-Key","in":"header","schemaId":"schema_14","description":"Case-sensitive opaque key for one mutation intent. Send exactly one header occurrence containing 1 to 128 visible ASCII bytes (0x21..0x7e). Commas are literal data; do not trim, lowercase or require UUID syntax. Reuse the same key for retries, with current authorization checked on every attempt. Repeated header occurrences are rejected.\n","required":true}],"pointer":"/paths/~1public-keys~1{public_key_id}~1addresses/post/parameters"},{"nodeType":"item-content","variant":"body","label":"Request Body","labelTranslationKey":"body","required":true,"mediaTypes":["application/json"],"mediaTypeSchemas":{"application/json":{"schemaId":"components/schemas/GenerateHDAddressesRequest","exampleIds":["paths/~1public-keys~1{public_key_id}~1addresses/post/requestBody/content/application~1json/examples/next_address","paths/~1public-keys~1{public_key_id}~1addresses/post/requestBody/content/application~1json/examples/index_range"]}},"schemaId":"components/schemas/GenerateHDAddressesRequest","exampleIds":["paths/~1public-keys~1{public_key_id}~1addresses/post/requestBody/content/application~1json/examples/next_address","paths/~1public-keys~1{public_key_id}~1addresses/post/requestBody/content/application~1json/examples/index_range"],"pointer":"/paths/~1public-keys~1{public_key_id}~1addresses/post/requestBody"}],"panels":[{"children":[{"kind":"code-sample","source":{"kind":"code-sample","operationType":"http","method":"POST","path":"/public-keys/{public_key_id}/addresses","servers":[{"url":"/_mock/apis/platform/api","description":"Mock server","isMockServer":true},{"url":"https://api.vilna.io/v2","description":"Vilna API."}],"parameters":{"path":[{"name":"public_key_id","in":"path","required":true,"example":"550e8400-e29b-41d4-a716-446655440000","schemaId":"components/schemas/UUID"}],"query":[],"querystring":[],"header":[{"name":"Idempotency-Key","in":"header","required":true,"schemaId":"schema_14"}],"cookie":[]},"security":[{"schemes":[{"id":"Auth","type":"apiKey","name":"X-Api-Key","in":"header"}],"scopes":["api:address:write"]}],"requestBody":{"application/json":{"schemaId":"components/schemas/GenerateHDAddressesRequest","exampleIds":["paths/~1public-keys~1{public_key_id}~1addresses/post/requestBody/content/application~1json/examples/next_address","paths/~1public-keys~1{public_key_id}~1addresses/post/requestBody/content/application~1json/examples/index_range"]}},"responseCodes":["200","201","400","401","403","404","409","422","429","503","default"],"pointer":"/public-keys/{public_key_id}/addresses","href":"public_key/generate-public-key-addresses","openApiOperationId":"generate-public-key-addresses","summary":"Generate public key addresses"},"isWebhook":false,"hideReplay":false,"servers":[{"url":"/_mock/apis/platform/api","description":"Mock server","isMockServer":true},{"url":"https://api.vilna.io/v2","description":"Vilna API."}],"schemaId":"components/schemas/GenerateHDAddressesRequest","exampleIds":["paths/~1public-keys~1{public_key_id}~1addresses/post/requestBody/content/application~1json/examples/next_address","paths/~1public-keys~1{public_key_id}~1addresses/post/requestBody/content/application~1json/examples/index_range"],"mediaTypes":["application/json"],"mediaTypeSchemas":{"application/json":{"schemaId":"components/schemas/GenerateHDAddressesRequest","exampleIds":["paths/~1public-keys~1{public_key_id}~1addresses/post/requestBody/content/application~1json/examples/next_address","paths/~1public-keys~1{public_key_id}~1addresses/post/requestBody/content/application~1json/examples/index_range"]}},"examples":[{},{}]}]}]},{"nodeType":"container","children":[{"nodeType":"header","level":4,"label":"Responses","labelTranslationKey":"responses","deepLinkSuffix":"responses"},{"nodeType":"item-content","variant":"responses","responses":[{"code":"200","description":"The generated addresses, in derivation-index order.","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"schema_23"}},"schemaId":"schema_23"},{"code":"201","description":"The generated addresses, in derivation-index order.","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"schema_23"}},"schemaId":"schema_23"},{"code":"400","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Bad request (e.g., missing or invalid fields). Invalid text may be reported as address.label_invalid, address.meta_invalid, public_key.label_invalid, invoice.comment_invalid, invoice.metadata_invalid."},"children":[]}]}]}],"mediaType":"application/problem+json","mediaTypes":["application/problem+json"],"mediaTypeContent":{"application/problem+json":{"schemaId":"components/schemas/InvalidRequestProblem","exampleIds":["paths/~1public-keys~1{public_key_id}~1addresses/post/responses/400/content/application~1problem+json/examples/malformed_json"]}},"schemaId":"components/schemas/InvalidRequestProblem","exampleIds":["paths/~1public-keys~1{public_key_id}~1addresses/post/responses/400/content/application~1problem+json/examples/malformed_json"]},{"code":"401","description":"Missing or invalid authentication credentials.","mediaType":"application/problem+json","mediaTypes":["application/problem+json"],"mediaTypeContent":{"application/problem+json":{"schemaId":"components/schemas/UnauthorizedProblem","exampleIds":["paths/~1public-keys~1{public_key_id}~1addresses/post/responses/401/content/application~1problem+json/examples/service_authentication_denied"]}},"schemaId":"components/schemas/UnauthorizedProblem","exampleIds":["paths/~1public-keys~1{public_key_id}~1addresses/post/responses/401/content/application~1problem+json/examples/service_authentication_denied"]},{"code":"403","description":"Insufficient permissions.","mediaType":"application/problem+json","mediaTypes":["application/problem+json"],"mediaTypeContent":{"application/problem+json":{"schemaId":"components/schemas/ForbiddenProblem","exampleIds":["paths/~1public-keys~1{public_key_id}~1addresses/post/responses/403/content/application~1problem+json/examples/insufficient_permissions"]}},"schemaId":"components/schemas/ForbiddenProblem","exampleIds":["paths/~1public-keys~1{public_key_id}~1addresses/post/responses/403/content/application~1problem+json/examples/insufficient_permissions"]},{"code":"404","description":"Requested resource does not exist.","mediaType":"application/problem+json","mediaTypes":["application/problem+json"],"mediaTypeContent":{"application/problem+json":{"schemaId":"components/schemas/NotFoundProblem","exampleIds":["paths/~1public-keys~1{public_key_id}~1addresses/post/responses/404/content/application~1problem+json/examples/address_not_found","paths/~1public-keys~1{public_key_id}~1addresses/post/responses/404/content/application~1problem+json/examples/invoice_not_found"]}},"schemaId":"components/schemas/NotFoundProblem","exampleIds":["paths/~1public-keys~1{public_key_id}~1addresses/post/responses/404/content/application~1problem+json/examples/address_not_found","paths/~1public-keys~1{public_key_id}~1addresses/post/responses/404/content/application~1problem+json/examples/invoice_not_found"]},{"code":"409","description":"Request conflicts with the current resource state.","mediaType":"application/problem+json","mediaTypes":["application/problem+json"],"mediaTypeContent":{"application/problem+json":{"schemaId":"components/schemas/ConflictProblem","exampleIds":["paths/~1public-keys~1{public_key_id}~1addresses/post/responses/409/content/application~1problem+json/examples/address_occupied","paths/~1public-keys~1{public_key_id}~1addresses/post/responses/409/content/application~1problem+json/examples/address_in_use","paths/~1public-keys~1{public_key_id}~1addresses/post/responses/409/content/application~1problem+json/examples/subscription_v1_conflict","paths/~1public-keys~1{public_key_id}~1addresses/post/responses/409/content/application~1problem+json/examples/notification_send_in_progress","paths/~1public-keys~1{public_key_id}~1addresses/post/responses/409/content/application~1problem+json/examples/notification_payload_unavailable","paths/~1public-keys~1{public_key_id}~1addresses/post/responses/409/content/application~1problem+json/examples/notification_test_resend_not_allowed"]}},"schemaId":"components/schemas/ConflictProblem","exampleIds":["paths/~1public-keys~1{public_key_id}~1addresses/post/responses/409/content/application~1problem+json/examples/address_occupied","paths/~1public-keys~1{public_key_id}~1addresses/post/responses/409/content/application~1problem+json/examples/address_in_use","paths/~1public-keys~1{public_key_id}~1addresses/post/responses/409/content/application~1problem+json/examples/subscription_v1_conflict","paths/~1public-keys~1{public_key_id}~1addresses/post/responses/409/content/application~1problem+json/examples/notification_send_in_progress","paths/~1public-keys~1{public_key_id}~1addresses/post/responses/409/content/application~1problem+json/examples/notification_payload_unavailable","paths/~1public-keys~1{public_key_id}~1addresses/post/responses/409/content/application~1problem+json/examples/notification_test_resend_not_allowed"]},{"code":"422","description":"Request preconditions were not met.","mediaType":"application/problem+json","mediaTypes":["application/problem+json"],"mediaTypeContent":{"application/problem+json":{"schemaId":"components/schemas/PreconditionProblem","exampleIds":["paths/~1public-keys~1{public_key_id}~1addresses/post/responses/422/content/application~1problem+json/examples/invoice_not_cancellable"]}},"schemaId":"components/schemas/PreconditionProblem","exampleIds":["paths/~1public-keys~1{public_key_id}~1addresses/post/responses/422/content/application~1problem+json/examples/invoice_not_cancellable"]},{"code":"429","description":"Resource quota exceeded. The response includes the effective limit for this scope. The applicable code and limit depend on the operation; examples illustrate different limits.","mediaType":"application/problem+json","mediaTypes":["application/problem+json"],"mediaTypeContent":{"application/problem+json":{"schemaId":"components/schemas/QuotaExceededProblem","exampleIds":["paths/~1public-keys~1{public_key_id}~1addresses/post/responses/429/content/application~1problem+json/examples/address_quota","paths/~1public-keys~1{public_key_id}~1addresses/post/responses/429/content/application~1problem+json/examples/creation_prohibited"]}},"schemaId":"components/schemas/QuotaExceededProblem","exampleIds":["paths/~1public-keys~1{public_key_id}~1addresses/post/responses/429/content/application~1problem+json/examples/address_quota","paths/~1public-keys~1{public_key_id}~1addresses/post/responses/429/content/application~1problem+json/examples/creation_prohibited"]},{"code":"503","description":"The operation is temporarily unavailable. Please try again later.","mediaType":"application/problem+json","mediaTypes":["application/problem+json"],"mediaTypeContent":{"application/problem+json":{"schemaId":"components/schemas/Problem","exampleIds":["paths/~1public-keys~1{public_key_id}~1addresses/post/responses/503/content/application~1problem+json/examples/temporarily_unavailable"]}},"schemaId":"components/schemas/Problem","exampleIds":["paths/~1public-keys~1{public_key_id}~1addresses/post/responses/503/content/application~1problem+json/examples/temporarily_unavailable"]},{"code":"default","description":"Unexpected error.","mediaType":"application/problem+json","mediaTypes":["application/problem+json"],"mediaTypeContent":{"application/problem+json":{"schemaId":"components/schemas/Problem"}},"schemaId":"components/schemas/Problem"}],"pointer":"/paths/~1public-keys~1{public_key_id}~1addresses/post/responses"}],"panels":[{"children":[{"kind":"response","responseCodes":[{"code":"200","schemaId":"schema_23","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"schema_23"}}},{"code":"201","schemaId":"schema_23","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"schema_23"}}},{"code":"400","schemaId":"components/schemas/InvalidRequestProblem","exampleIds":["paths/~1public-keys~1{public_key_id}~1addresses/post/responses/400/content/application~1problem+json/examples/malformed_json"],"mediaTypes":["application/problem+json"],"mediaTypeContent":{"application/problem+json":{"schemaId":"components/schemas/InvalidRequestProblem","exampleIds":["paths/~1public-keys~1{public_key_id}~1addresses/post/responses/400/content/application~1problem+json/examples/malformed_json"]}}},{"code":"401","schemaId":"components/schemas/UnauthorizedProblem","exampleIds":["paths/~1public-keys~1{public_key_id}~1addresses/post/responses/401/content/application~1problem+json/examples/service_authentication_denied"],"mediaTypes":["application/problem+json"],"mediaTypeContent":{"application/problem+json":{"schemaId":"components/schemas/UnauthorizedProblem","exampleIds":["paths/~1public-keys~1{public_key_id}~1addresses/post/responses/401/content/application~1problem+json/examples/service_authentication_denied"]}}},{"code":"403","schemaId":"components/schemas/ForbiddenProblem","exampleIds":["paths/~1public-keys~1{public_key_id}~1addresses/post/responses/403/content/application~1problem+json/examples/insufficient_permissions"],"mediaTypes":["application/problem+json"],"mediaTypeContent":{"application/problem+json":{"schemaId":"components/schemas/ForbiddenProblem","exampleIds":["paths/~1public-keys~1{public_key_id}~1addresses/post/responses/403/content/application~1problem+json/examples/insufficient_permissions"]}}},{"code":"404","schemaId":"components/schemas/NotFoundProblem","exampleIds":["paths/~1public-keys~1{public_key_id}~1addresses/post/responses/404/content/application~1problem+json/examples/address_not_found","paths/~1public-keys~1{public_key_id}~1addresses/post/responses/404/content/application~1problem+json/examples/invoice_not_found"],"mediaTypes":["application/problem+json"],"mediaTypeContent":{"application/problem+json":{"schemaId":"components/schemas/NotFoundProblem","exampleIds":["paths/~1public-keys~1{public_key_id}~1addresses/post/responses/404/content/application~1problem+json/examples/address_not_found","paths/~1public-keys~1{public_key_id}~1addresses/post/responses/404/content/application~1problem+json/examples/invoice_not_found"]}}},{"code":"409","schemaId":"components/schemas/ConflictProblem","exampleIds":["paths/~1public-keys~1{public_key_id}~1addresses/post/responses/409/content/application~1problem+json/examples/address_occupied","paths/~1public-keys~1{public_key_id}~1addresses/post/responses/409/content/application~1problem+json/examples/address_in_use","paths/~1public-keys~1{public_key_id}~1addresses/post/responses/409/content/application~1problem+json/examples/subscription_v1_conflict","paths/~1public-keys~1{public_key_id}~1addresses/post/responses/409/content/application~1problem+json/examples/notification_send_in_progress","paths/~1public-keys~1{public_key_id}~1addresses/post/responses/409/content/application~1problem+json/examples/notification_payload_unavailable","paths/~1public-keys~1{public_key_id}~1addresses/post/responses/409/content/application~1problem+json/examples/notification_test_resend_not_allowed"],"mediaTypes":["application/problem+json"],"mediaTypeContent":{"application/problem+json":{"schemaId":"components/schemas/ConflictProblem","exampleIds":["paths/~1public-keys~1{public_key_id}~1addresses/post/responses/409/content/application~1problem+json/examples/address_occupied","paths/~1public-keys~1{public_key_id}~1addresses/post/responses/409/content/application~1problem+json/examples/address_in_use","paths/~1public-keys~1{public_key_id}~1addresses/post/responses/409/content/application~1problem+json/examples/subscription_v1_conflict","paths/~1public-keys~1{public_key_id}~1addresses/post/responses/409/content/application~1problem+json/examples/notification_send_in_progress","paths/~1public-keys~1{public_key_id}~1addresses/post/responses/409/content/application~1problem+json/examples/notification_payload_unavailable","paths/~1public-keys~1{public_key_id}~1addresses/post/responses/409/content/application~1problem+json/examples/notification_test_resend_not_allowed"]}}},{"code":"422","schemaId":"components/schemas/PreconditionProblem","exampleIds":["paths/~1public-keys~1{public_key_id}~1addresses/post/responses/422/content/application~1problem+json/examples/invoice_not_cancellable"],"mediaTypes":["application/problem+json"],"mediaTypeContent":{"application/problem+json":{"schemaId":"components/schemas/PreconditionProblem","exampleIds":["paths/~1public-keys~1{public_key_id}~1addresses/post/responses/422/content/application~1problem+json/examples/invoice_not_cancellable"]}}},{"code":"429","schemaId":"components/schemas/QuotaExceededProblem","exampleIds":["paths/~1public-keys~1{public_key_id}~1addresses/post/responses/429/content/application~1problem+json/examples/address_quota","paths/~1public-keys~1{public_key_id}~1addresses/post/responses/429/content/application~1problem+json/examples/creation_prohibited"],"mediaTypes":["application/problem+json"],"mediaTypeContent":{"application/problem+json":{"schemaId":"components/schemas/QuotaExceededProblem","exampleIds":["paths/~1public-keys~1{public_key_id}~1addresses/post/responses/429/content/application~1problem+json/examples/address_quota","paths/~1public-keys~1{public_key_id}~1addresses/post/responses/429/content/application~1problem+json/examples/creation_prohibited"]}}},{"code":"503","schemaId":"components/schemas/Problem","exampleIds":["paths/~1public-keys~1{public_key_id}~1addresses/post/responses/503/content/application~1problem+json/examples/temporarily_unavailable"],"mediaTypes":["application/problem+json"],"mediaTypeContent":{"application/problem+json":{"schemaId":"components/schemas/Problem","exampleIds":["paths/~1public-keys~1{public_key_id}~1addresses/post/responses/503/content/application~1problem+json/examples/temporarily_unavailable"]}}},{"code":"default","schemaId":"components/schemas/Problem","mediaTypes":["application/problem+json"],"mediaTypeContent":{"application/problem+json":{"schemaId":"components/schemas/Problem"}}}],"examples":[]}]}]},{"nodeType":"container","children":[{"nodeType":"feedback","pageSlug":"/public_key/generate-public-key-addresses"}],"panels":[]}]},"httpPath":"/public-keys/{public_key_id}/addresses"}],"content":{"contentType":"group","meta":{"name":"public_key"},"children":[{"nodeType":"container","children":[{"nodeType":"header","level":2,"label":"Extended Public Keys","showPageActions":true},{"nodeType":"markdoc","content":"Register extended public keys (BIP44/49/84/86) and derive HD addresses."}],"panels":[{"children":[{"kind":"group-items","title":"Operations","titleTranslationKey":"operations","items":[{"title":"/public-keys","summary":"List public keys","prefix":{"name":"get","color":"get"},"badges":[],"link":"/public_key/list-public-keys","deprecated":false},{"title":"/public-keys","summary":"Create public key","prefix":{"name":"post","color":"post"},"badges":[],"link":"/public_key/create-public-key","deprecated":false},{"title":"/public-keys/{public_key_id}","summary":"Delete public key","prefix":{"name":"delete","color":"delete"},"badges":[],"link":"/public_key/delete-public-key","deprecated":false},{"title":"/public-keys/{public_key_id}","summary":"Get public key","prefix":{"name":"get","color":"get"},"badges":[],"link":"/public_key/get-public-key","deprecated":false},{"title":"/public-keys/{public_key_id}","summary":"Update public key","prefix":{"name":"patch","color":"patch"},"badges":[],"link":"/public_key/patch-public-key","deprecated":false},{"title":"/public-keys/{public_key_id}/children","summary":"Create child public key","prefix":{"name":"post","color":"post"},"badges":[],"link":"/public_key/create-public-key-child","deprecated":false},{"title":"/public-keys/{public_key_id}/addresses","summary":"List public key addresses","prefix":{"name":"get","color":"get"},"badges":[],"link":"/public_key/list-public-key-addresses","deprecated":false},{"title":"/public-keys/{public_key_id}/addresses","summary":"Generate public key addresses","prefix":{"name":"post","color":"post"},"badges":[],"link":"/public_key/generate-public-key-addresses","deprecated":false}]}]}]}]}},{"type":"separator","label":"Transactions","content":null},{"type":"group","label":"Transactions","link":"/apis/platform/api/transaction","routeSlug":"/apis/platform/api/transaction","items":[{"label":"List transactions","deprecated":false,"httpVerb":"get","isAdditionalOperation":false,"isWebhook":false,"type":"link","link":"/apis/platform/api/transaction/list-transactions","routeSlug":"/apis/platform/api/transaction/list-transactions","metadata":{"seo":{"title":"List transactions","description":"List blockchain transactions with filtering, sorting, and pagination."}},"content":{"contentType":"item","itemVariant":"httpItem","meta":{"sourceId":"list-transactions","name":"List transactions","isWebhook":false,"pointer":"/paths/~1transactions/get","hasSamples":false},"children":[{"nodeType":"container","children":[{"nodeType":"header","level":2,"label":"List transactions","isWebhook":false,"showPageActions":true}],"panels":[]},{"nodeType":"container","children":[{"nodeType":"header","level":4,"label":"Request","labelTranslationKey":"request","deepLinkSuffix":"request"},{"nodeType":"markdoc","content":"List blockchain transactions with filtering, sorting, and pagination."},{"nodeType":"security","requirements":[{"schemes":[{"name":"Auth","scopes":["api:transaction:read"],"type":"apiKey","in":"header","paramName":"X-Api-Key","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"API key for authenticating requests. Include your key in the "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"X-Api-Key"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" header. Keys can be created in the Vilna Dashboard or via the Management API. The scopes listed per operation indicate which permissions the key must have."},"children":[]}]}]}]}]}]},{"nodeType":"item-content","variant":"query","label":"Query","labelTranslationKey":"query","parameters":[{"name":"limit","in":"query","schemaId":"schema_0","description":"Maximum number of items to return."},{"name":"page","in":"query","schemaId":"schema_1","description":"Page number for pagination."},{"name":"chain_gid","in":"query","style":"form","explode":true,"schemaId":"schema_4","description":"Filter transactions by blockchain identifier (CAIP-2 format).","example":["eip155:1"]},{"name":"txid","in":"query","style":"form","explode":true,"schemaId":"schema_5","description":"Filter transactions by transaction id.","example":["0x1234567890abcdef1234567890abcdef1234567890abcdef1234567890abcdef"]},{"name":"block_number","in":"query","style":"form","explode":true,"schemaId":"schema_40","description":"Filter transactions by block number.","example":[18500000]},{"name":"is_success","in":"query","schemaId":"schema_41","description":"Filter transactions by execution status.","example":true},{"name":"address","in":"query","style":"form","explode":true,"schemaId":"schema_2","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Filter transactions by the addresses they touch. Repeat the parameter to"},"children":[]},{"$$mdtype":"Node","type":"softbreak","inline":true,"attributes":{},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"pass multiple values; transactions touching any of them are returned (OR"},"children":[]},{"$$mdtype":"Node","type":"softbreak","inline":true,"attributes":{},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"semantics). Combined with "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"tag_id"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" as a union."},"children":[]}]}]}],"example":["0x8521E8b15eCEF4D4269Fded3E6694225E096959E"]},{"name":"tag_id","in":"query","style":"form","explode":true,"schemaId":"schema_21","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Filter transactions by address tag identifier (UUID). Repeat the parameter"},"children":[]},{"$$mdtype":"Node","type":"softbreak","inline":true,"attributes":{},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"to pass multiple values; transactions touching an address with any of these"},"children":[]},{"$$mdtype":"Node","type":"softbreak","inline":true,"attributes":{},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"tags are returned (OR semantics). Combined with "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"address"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" as a union."},"children":[]}]}]}],"example":["0199ce7e-d9e7-7c01-9c2a-9d0010eaa1cc"]},{"name":"sort_by","in":"query","schemaId":"schema_42","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Field to sort results by. Use "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"-"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" prefix for descending order."},"children":[]}]}]}]}],"pointer":"/paths/~1transactions/get/parameters"}],"panels":[{"children":[{"kind":"code-sample","source":{"kind":"code-sample","operationType":"http","method":"GET","path":"/transactions","servers":[{"url":"/_mock/apis/platform/api","description":"Mock server","isMockServer":true},{"url":"https://api.vilna.io/v2","description":"Vilna API."}],"parameters":{"path":[],"query":[{"name":"limit","in":"query","required":false,"example":20,"schemaId":"schema_0"},{"name":"page","in":"query","required":false,"example":1,"schemaId":"schema_1"},{"name":"chain_gid","in":"query","required":false,"example":["eip155:1"],"schemaId":"schema_4","style":"form","explode":true},{"name":"txid","in":"query","required":false,"example":["0x1234567890abcdef1234567890abcdef1234567890abcdef1234567890abcdef"],"schemaId":"schema_5","style":"form","explode":true},{"name":"block_number","in":"query","required":false,"example":[18500000],"schemaId":"schema_40","style":"form","explode":true},{"name":"is_success","in":"query","required":false,"example":true,"schemaId":"schema_41"},{"name":"address","in":"query","required":false,"example":["0x8521E8b15eCEF4D4269Fded3E6694225E096959E"],"schemaId":"schema_2","style":"form","explode":true},{"name":"tag_id","in":"query","required":false,"example":["0199ce7e-d9e7-7c01-9c2a-9d0010eaa1cc"],"schemaId":"schema_21","style":"form","explode":true},{"name":"sort_by","in":"query","required":false,"example":"created_at","schemaId":"schema_42"}],"querystring":[],"header":[],"cookie":[]},"security":[{"schemes":[{"id":"Auth","type":"apiKey","name":"X-Api-Key","in":"header"}],"scopes":["api:transaction:read"]}],"responseCodes":["200","400","401","403","503","default"],"pointer":"/transactions","href":"transaction/list-transactions","openApiOperationId":"list-transactions","summary":"List transactions"},"isWebhook":false,"hideReplay":false,"servers":[{"url":"/_mock/apis/platform/api","description":"Mock server","isMockServer":true},{"url":"https://api.vilna.io/v2","description":"Vilna API."}],"examples":[]}]}]},{"nodeType":"container","children":[{"nodeType":"header","level":4,"label":"Responses","labelTranslationKey":"responses","deepLinkSuffix":"responses"},{"nodeType":"item-content","variant":"responses","responses":[{"code":"200","description":"Paginated list of transactions.","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"schema_43","exampleIds":["paths/~1transactions/get/responses/200/content/application~1json/example"]}},"schemaId":"schema_43","exampleIds":["paths/~1transactions/get/responses/200/content/application~1json/example"]},{"code":"400","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Bad request (e.g., missing or invalid fields). Invalid text may be reported as address.label_invalid, address.meta_invalid, public_key.label_invalid, invoice.comment_invalid, invoice.metadata_invalid."},"children":[]}]}]}],"mediaType":"application/problem+json","mediaTypes":["application/problem+json"],"mediaTypeContent":{"application/problem+json":{"schemaId":"components/schemas/InvalidRequestProblem","exampleIds":["paths/~1transactions/get/responses/400/content/application~1problem+json/examples/malformed_json"]}},"schemaId":"components/schemas/InvalidRequestProblem","exampleIds":["paths/~1transactions/get/responses/400/content/application~1problem+json/examples/malformed_json"]},{"code":"401","description":"Missing or invalid authentication credentials.","mediaType":"application/problem+json","mediaTypes":["application/problem+json"],"mediaTypeContent":{"application/problem+json":{"schemaId":"components/schemas/UnauthorizedProblem","exampleIds":["paths/~1transactions/get/responses/401/content/application~1problem+json/examples/service_authentication_denied"]}},"schemaId":"components/schemas/UnauthorizedProblem","exampleIds":["paths/~1transactions/get/responses/401/content/application~1problem+json/examples/service_authentication_denied"]},{"code":"403","description":"Insufficient permissions.","mediaType":"application/problem+json","mediaTypes":["application/problem+json"],"mediaTypeContent":{"application/problem+json":{"schemaId":"components/schemas/ForbiddenProblem","exampleIds":["paths/~1transactions/get/responses/403/content/application~1problem+json/examples/insufficient_permissions"]}},"schemaId":"components/schemas/ForbiddenProblem","exampleIds":["paths/~1transactions/get/responses/403/content/application~1problem+json/examples/insufficient_permissions"]},{"code":"503","description":"The operation is temporarily unavailable. Please try again later.","mediaType":"application/problem+json","mediaTypes":["application/problem+json"],"mediaTypeContent":{"application/problem+json":{"schemaId":"components/schemas/Problem","exampleIds":["paths/~1transactions/get/responses/503/content/application~1problem+json/examples/temporarily_unavailable"]}},"schemaId":"components/schemas/Problem","exampleIds":["paths/~1transactions/get/responses/503/content/application~1problem+json/examples/temporarily_unavailable"]},{"code":"default","description":"Unexpected error.","mediaType":"application/problem+json","mediaTypes":["application/problem+json"],"mediaTypeContent":{"application/problem+json":{"schemaId":"components/schemas/Problem"}},"schemaId":"components/schemas/Problem"}],"pointer":"/paths/~1transactions/get/responses"}],"panels":[{"children":[{"kind":"response","responseCodes":[{"code":"200","schemaId":"schema_43","exampleIds":["paths/~1transactions/get/responses/200/content/application~1json/example"],"mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"schema_43","exampleIds":["paths/~1transactions/get/responses/200/content/application~1json/example"]}}},{"code":"400","schemaId":"components/schemas/InvalidRequestProblem","exampleIds":["paths/~1transactions/get/responses/400/content/application~1problem+json/examples/malformed_json"],"mediaTypes":["application/problem+json"],"mediaTypeContent":{"application/problem+json":{"schemaId":"components/schemas/InvalidRequestProblem","exampleIds":["paths/~1transactions/get/responses/400/content/application~1problem+json/examples/malformed_json"]}}},{"code":"401","schemaId":"components/schemas/UnauthorizedProblem","exampleIds":["paths/~1transactions/get/responses/401/content/application~1problem+json/examples/service_authentication_denied"],"mediaTypes":["application/problem+json"],"mediaTypeContent":{"application/problem+json":{"schemaId":"components/schemas/UnauthorizedProblem","exampleIds":["paths/~1transactions/get/responses/401/content/application~1problem+json/examples/service_authentication_denied"]}}},{"code":"403","schemaId":"components/schemas/ForbiddenProblem","exampleIds":["paths/~1transactions/get/responses/403/content/application~1problem+json/examples/insufficient_permissions"],"mediaTypes":["application/problem+json"],"mediaTypeContent":{"application/problem+json":{"schemaId":"components/schemas/ForbiddenProblem","exampleIds":["paths/~1transactions/get/responses/403/content/application~1problem+json/examples/insufficient_permissions"]}}},{"code":"503","schemaId":"components/schemas/Problem","exampleIds":["paths/~1transactions/get/responses/503/content/application~1problem+json/examples/temporarily_unavailable"],"mediaTypes":["application/problem+json"],"mediaTypeContent":{"application/problem+json":{"schemaId":"components/schemas/Problem","exampleIds":["paths/~1transactions/get/responses/503/content/application~1problem+json/examples/temporarily_unavailable"]}}},{"code":"default","schemaId":"components/schemas/Problem","mediaTypes":["application/problem+json"],"mediaTypeContent":{"application/problem+json":{"schemaId":"components/schemas/Problem"}}}],"examples":[]}]}]},{"nodeType":"container","children":[{"nodeType":"feedback","pageSlug":"/transaction/list-transactions"}],"panels":[]}]},"httpPath":"/transactions"},{"label":"Get transaction","deprecated":false,"httpVerb":"get","isAdditionalOperation":false,"isWebhook":false,"type":"link","link":"/apis/platform/api/transaction/get-transaction","routeSlug":"/apis/platform/api/transaction/get-transaction","metadata":{"seo":{"title":"Get transaction","description":"Get transaction details with events and balance changes."}},"content":{"contentType":"item","itemVariant":"httpItem","meta":{"sourceId":"get-transaction","name":"Get transaction","isWebhook":false,"pointer":"/paths/~1transactions~1{chain_gid}~1{txid}/get","hasSamples":false},"children":[{"nodeType":"container","children":[{"nodeType":"header","level":2,"label":"Get transaction","isWebhook":false,"showPageActions":true}],"panels":[]},{"nodeType":"container","children":[{"nodeType":"header","level":4,"label":"Request","labelTranslationKey":"request","deepLinkSuffix":"request"},{"nodeType":"markdoc","content":"Get transaction details with events and balance changes."},{"nodeType":"security","requirements":[{"schemes":[{"name":"Auth","scopes":["api:transaction:read"],"type":"apiKey","in":"header","paramName":"X-Api-Key","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"API key for authenticating requests. Include your key in the "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"X-Api-Key"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" header. Keys can be created in the Vilna Dashboard or via the Management API. The scopes listed per operation indicate which permissions the key must have."},"children":[]}]}]}]}]}]},{"nodeType":"item-content","variant":"path","label":"Path","labelTranslationKey":"path","parameters":[{"name":"chain_gid","in":"path","schemaId":"schema_29","description":"Blockchain identifier in CAIP-2 format (namespace:reference).","required":true},{"name":"txid","in":"path","schemaId":"schema_44","description":"Native transaction id of the chain.","required":true,"example":"0x1234567890abcdef1234567890abcdef1234567890abcdef1234567890abcdef"}],"pointer":"/paths/~1transactions~1{chain_gid}~1{txid}/get/parameters"}],"panels":[{"children":[{"kind":"code-sample","source":{"kind":"code-sample","operationType":"http","method":"GET","path":"/transactions/{chain_gid}/{txid}","servers":[{"url":"/_mock/apis/platform/api","description":"Mock server","isMockServer":true},{"url":"https://api.vilna.io/v2","description":"Vilna API."}],"parameters":{"path":[{"name":"chain_gid","in":"path","required":true,"example":"eip155:1","schemaId":"components/schemas/ChainGID"},{"name":"txid","in":"path","required":true,"example":"0x1234567890abcdef1234567890abcdef1234567890abcdef1234567890abcdef","schemaId":"components/schemas/Txid"}],"query":[],"querystring":[],"header":[],"cookie":[]},"security":[{"schemes":[{"id":"Auth","type":"apiKey","name":"X-Api-Key","in":"header"}],"scopes":["api:transaction:read"]}],"responseCodes":["200","400","401","403","404","429","502","503","504","default"],"pointer":"/transactions/{chain_gid}/{txid}","href":"transaction/get-transaction","openApiOperationId":"get-transaction","summary":"Get transaction"},"isWebhook":false,"hideReplay":false,"servers":[{"url":"/_mock/apis/platform/api","description":"Mock server","isMockServer":true},{"url":"https://api.vilna.io/v2","description":"Vilna API."}],"examples":[]}]}]},{"nodeType":"container","children":[{"nodeType":"header","level":4,"label":"Responses","labelTranslationKey":"responses","deepLinkSuffix":"responses"},{"nodeType":"item-content","variant":"responses","responses":[{"code":"200","description":"Transaction details with events and balance changes.","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"schema_45","exampleIds":["paths/~1transactions~1{chain_gid}~1{txid}/get/responses/200/content/application~1json/example"]}},"schemaId":"schema_45","exampleIds":["paths/~1transactions~1{chain_gid}~1{txid}/get/responses/200/content/application~1json/example"]},{"code":"400","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Bad request (e.g., missing or invalid fields). Invalid text may be reported as address.label_invalid, address.meta_invalid, public_key.label_invalid, invoice.comment_invalid, invoice.metadata_invalid."},"children":[]}]}]}],"mediaType":"application/problem+json","mediaTypes":["application/problem+json"],"mediaTypeContent":{"application/problem+json":{"schemaId":"components/schemas/InvalidRequestProblem","exampleIds":["paths/~1transactions~1{chain_gid}~1{txid}/get/responses/400/content/application~1problem+json/examples/malformed_json"]}},"schemaId":"components/schemas/InvalidRequestProblem","exampleIds":["paths/~1transactions~1{chain_gid}~1{txid}/get/responses/400/content/application~1problem+json/examples/malformed_json"]},{"code":"401","description":"Missing or invalid authentication credentials.","mediaType":"application/problem+json","mediaTypes":["application/problem+json"],"mediaTypeContent":{"application/problem+json":{"schemaId":"components/schemas/UnauthorizedProblem","exampleIds":["paths/~1transactions~1{chain_gid}~1{txid}/get/responses/401/content/application~1problem+json/examples/service_authentication_denied"]}},"schemaId":"components/schemas/UnauthorizedProblem","exampleIds":["paths/~1transactions~1{chain_gid}~1{txid}/get/responses/401/content/application~1problem+json/examples/service_authentication_denied"]},{"code":"403","description":"Insufficient permissions.","mediaType":"application/problem+json","mediaTypes":["application/problem+json"],"mediaTypeContent":{"application/problem+json":{"schemaId":"components/schemas/ForbiddenProblem","exampleIds":["paths/~1transactions~1{chain_gid}~1{txid}/get/responses/403/content/application~1problem+json/examples/insufficient_permissions"]}},"schemaId":"components/schemas/ForbiddenProblem","exampleIds":["paths/~1transactions~1{chain_gid}~1{txid}/get/responses/403/content/application~1problem+json/examples/insufficient_permissions"]},{"code":"404","description":"Requested resource does not exist.","mediaType":"application/problem+json","mediaTypes":["application/problem+json"],"mediaTypeContent":{"application/problem+json":{"schemaId":"components/schemas/NotFoundProblem","exampleIds":["paths/~1transactions~1{chain_gid}~1{txid}/get/responses/404/content/application~1problem+json/examples/address_not_found","paths/~1transactions~1{chain_gid}~1{txid}/get/responses/404/content/application~1problem+json/examples/invoice_not_found"]}},"schemaId":"components/schemas/NotFoundProblem","exampleIds":["paths/~1transactions~1{chain_gid}~1{txid}/get/responses/404/content/application~1problem+json/examples/address_not_found","paths/~1transactions~1{chain_gid}~1{txid}/get/responses/404/content/application~1problem+json/examples/invoice_not_found"]},{"code":"429","description":"Capacity or action cooldown exceeded.","mediaType":"application/problem+json","mediaTypes":["application/problem+json"],"mediaTypeContent":{"application/problem+json":{"schemaId":"components/schemas/Problem"}},"schemaId":"components/schemas/Problem"},{"code":"502","description":"Invalid upstream response or integration failure.","mediaType":"application/problem+json","mediaTypes":["application/problem+json"],"mediaTypeContent":{"application/problem+json":{"schemaId":"components/schemas/Problem"}},"schemaId":"components/schemas/Problem"},{"code":"503","description":"The operation is temporarily unavailable. Please try again later.","mediaType":"application/problem+json","mediaTypes":["application/problem+json"],"mediaTypeContent":{"application/problem+json":{"schemaId":"components/schemas/Problem","exampleIds":["paths/~1transactions~1{chain_gid}~1{txid}/get/responses/503/content/application~1problem+json/examples/temporarily_unavailable"]}},"schemaId":"components/schemas/Problem","exampleIds":["paths/~1transactions~1{chain_gid}~1{txid}/get/responses/503/content/application~1problem+json/examples/temporarily_unavailable"]},{"code":"504","description":"Shared request deadline exhausted.","mediaType":"application/problem+json","mediaTypes":["application/problem+json"],"mediaTypeContent":{"application/problem+json":{"schemaId":"components/schemas/Problem"}},"schemaId":"components/schemas/Problem"},{"code":"default","description":"Unexpected error.","mediaType":"application/problem+json","mediaTypes":["application/problem+json"],"mediaTypeContent":{"application/problem+json":{"schemaId":"components/schemas/Problem"}},"schemaId":"components/schemas/Problem"}],"pointer":"/paths/~1transactions~1{chain_gid}~1{txid}/get/responses"}],"panels":[{"children":[{"kind":"response","responseCodes":[{"code":"200","schemaId":"schema_45","exampleIds":["paths/~1transactions~1{chain_gid}~1{txid}/get/responses/200/content/application~1json/example"],"mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"schema_45","exampleIds":["paths/~1transactions~1{chain_gid}~1{txid}/get/responses/200/content/application~1json/example"]}}},{"code":"400","schemaId":"components/schemas/InvalidRequestProblem","exampleIds":["paths/~1transactions~1{chain_gid}~1{txid}/get/responses/400/content/application~1problem+json/examples/malformed_json"],"mediaTypes":["application/problem+json"],"mediaTypeContent":{"application/problem+json":{"schemaId":"components/schemas/InvalidRequestProblem","exampleIds":["paths/~1transactions~1{chain_gid}~1{txid}/get/responses/400/content/application~1problem+json/examples/malformed_json"]}}},{"code":"401","schemaId":"components/schemas/UnauthorizedProblem","exampleIds":["paths/~1transactions~1{chain_gid}~1{txid}/get/responses/401/content/application~1problem+json/examples/service_authentication_denied"],"mediaTypes":["application/problem+json"],"mediaTypeContent":{"application/problem+json":{"schemaId":"components/schemas/UnauthorizedProblem","exampleIds":["paths/~1transactions~1{chain_gid}~1{txid}/get/responses/401/content/application~1problem+json/examples/service_authentication_denied"]}}},{"code":"403","schemaId":"components/schemas/ForbiddenProblem","exampleIds":["paths/~1transactions~1{chain_gid}~1{txid}/get/responses/403/content/application~1problem+json/examples/insufficient_permissions"],"mediaTypes":["application/problem+json"],"mediaTypeContent":{"application/problem+json":{"schemaId":"components/schemas/ForbiddenProblem","exampleIds":["paths/~1transactions~1{chain_gid}~1{txid}/get/responses/403/content/application~1problem+json/examples/insufficient_permissions"]}}},{"code":"404","schemaId":"components/schemas/NotFoundProblem","exampleIds":["paths/~1transactions~1{chain_gid}~1{txid}/get/responses/404/content/application~1problem+json/examples/address_not_found","paths/~1transactions~1{chain_gid}~1{txid}/get/responses/404/content/application~1problem+json/examples/invoice_not_found"],"mediaTypes":["application/problem+json"],"mediaTypeContent":{"application/problem+json":{"schemaId":"components/schemas/NotFoundProblem","exampleIds":["paths/~1transactions~1{chain_gid}~1{txid}/get/responses/404/content/application~1problem+json/examples/address_not_found","paths/~1transactions~1{chain_gid}~1{txid}/get/responses/404/content/application~1problem+json/examples/invoice_not_found"]}}},{"code":"429","schemaId":"components/schemas/Problem","mediaTypes":["application/problem+json"],"mediaTypeContent":{"application/problem+json":{"schemaId":"components/schemas/Problem"}}},{"code":"502","schemaId":"components/schemas/Problem","mediaTypes":["application/problem+json"],"mediaTypeContent":{"application/problem+json":{"schemaId":"components/schemas/Problem"}}},{"code":"503","schemaId":"components/schemas/Problem","exampleIds":["paths/~1transactions~1{chain_gid}~1{txid}/get/responses/503/content/application~1problem+json/examples/temporarily_unavailable"],"mediaTypes":["application/problem+json"],"mediaTypeContent":{"application/problem+json":{"schemaId":"components/schemas/Problem","exampleIds":["paths/~1transactions~1{chain_gid}~1{txid}/get/responses/503/content/application~1problem+json/examples/temporarily_unavailable"]}}},{"code":"504","schemaId":"components/schemas/Problem","mediaTypes":["application/problem+json"],"mediaTypeContent":{"application/problem+json":{"schemaId":"components/schemas/Problem"}}},{"code":"default","schemaId":"components/schemas/Problem","mediaTypes":["application/problem+json"],"mediaTypeContent":{"application/problem+json":{"schemaId":"components/schemas/Problem"}}}],"examples":[]}]}]},{"nodeType":"container","children":[{"nodeType":"feedback","pageSlug":"/transaction/get-transaction"}],"panels":[]}]},"httpPath":"/transactions/{chain_gid}/{txid}"}],"content":{"contentType":"group","meta":{"name":"transaction"},"children":[{"nodeType":"container","children":[{"nodeType":"header","level":2,"label":"Transactions","showPageActions":true},{"nodeType":"markdoc","content":"Transaction listing and details with canonical events and balance deltas."}],"panels":[{"children":[{"kind":"group-items","title":"Operations","titleTranslationKey":"operations","items":[{"title":"/transactions","summary":"List transactions","prefix":{"name":"get","color":"get"},"badges":[],"link":"/transaction/list-transactions","deprecated":false},{"title":"/transactions/{chain_gid}/{txid}","summary":"Get transaction","prefix":{"name":"get","color":"get"},"badges":[],"link":"/transaction/get-transaction","deprecated":false}]}]}]}]}},{"type":"separator","label":"Payments","content":null},{"type":"group","label":"Invoices","link":"/apis/platform/api/invoice","routeSlug":"/apis/platform/api/invoice","items":[{"label":"List invoices","deprecated":false,"httpVerb":"get","isAdditionalOperation":false,"isWebhook":false,"type":"link","link":"/apis/platform/api/invoice/list-invoices","routeSlug":"/apis/platform/api/invoice/list-invoices","metadata":{"seo":{"title":"List invoices","description":"List invoices with filtering and pagination."}},"content":{"contentType":"item","itemVariant":"httpItem","meta":{"sourceId":"list-invoices","name":"List invoices","isWebhook":false,"pointer":"/paths/~1invoices/get","hasSamples":false},"children":[{"nodeType":"container","children":[{"nodeType":"header","level":2,"label":"List invoices","isWebhook":false,"showPageActions":true}],"panels":[]},{"nodeType":"container","children":[{"nodeType":"header","level":4,"label":"Request","labelTranslationKey":"request","deepLinkSuffix":"request"},{"nodeType":"markdoc","content":"List invoices with filtering and pagination."},{"nodeType":"security","requirements":[{"schemes":[{"name":"Auth","scopes":["api:invoice:read"],"type":"apiKey","in":"header","paramName":"X-Api-Key","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"API key for authenticating requests. Include your key in the "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"X-Api-Key"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" header. Keys can be created in the Vilna Dashboard or via the Management API. The scopes listed per operation indicate which permissions the key must have."},"children":[]}]}]}]}]}]},{"nodeType":"item-content","variant":"query","label":"Query","labelTranslationKey":"query","parameters":[{"name":"limit","in":"query","schemaId":"schema_0","description":"Maximum number of items to return."},{"name":"page","in":"query","schemaId":"schema_1","description":"Page number for pagination."},{"name":"status","in":"query","style":"form","explode":true,"schemaId":"schema_46","description":"Filter invoices by lifecycle status.","example":["open"]},{"name":"sort_by","in":"query","schemaId":"schema_47","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Field to sort results by. Use "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"-"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" prefix for descending order."},"children":[]}]}]}]}],"pointer":"/paths/~1invoices/get/parameters"}],"panels":[{"children":[{"kind":"code-sample","source":{"kind":"code-sample","operationType":"http","method":"GET","path":"/invoices","servers":[{"url":"/_mock/apis/platform/api","description":"Mock server","isMockServer":true},{"url":"https://api.vilna.io/v2","description":"Vilna API."}],"parameters":{"path":[],"query":[{"name":"limit","in":"query","required":false,"example":20,"schemaId":"schema_0"},{"name":"page","in":"query","required":false,"example":1,"schemaId":"schema_1"},{"name":"status","in":"query","required":false,"example":["open"],"schemaId":"schema_46","style":"form","explode":true},{"name":"sort_by","in":"query","required":false,"example":"created_at","schemaId":"schema_47"}],"querystring":[],"header":[],"cookie":[]},"security":[{"schemes":[{"id":"Auth","type":"apiKey","name":"X-Api-Key","in":"header"}],"scopes":["api:invoice:read"]}],"responseCodes":["200","400","401","403","503","default"],"pointer":"/invoices","href":"invoice/list-invoices","openApiOperationId":"list-invoices","summary":"List invoices"},"isWebhook":false,"hideReplay":false,"servers":[{"url":"/_mock/apis/platform/api","description":"Mock server","isMockServer":true},{"url":"https://api.vilna.io/v2","description":"Vilna API."}],"examples":[]}]}]},{"nodeType":"container","children":[{"nodeType":"header","level":4,"label":"Responses","labelTranslationKey":"responses","deepLinkSuffix":"responses"},{"nodeType":"item-content","variant":"responses","responses":[{"code":"200","description":"List of invoices with pagination.","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"schema_48"}},"schemaId":"schema_48"},{"code":"400","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Bad request (e.g., missing or invalid fields). Invalid text may be reported as address.label_invalid, address.meta_invalid, public_key.label_invalid, invoice.comment_invalid, invoice.metadata_invalid."},"children":[]}]}]}],"mediaType":"application/problem+json","mediaTypes":["application/problem+json"],"mediaTypeContent":{"application/problem+json":{"schemaId":"components/schemas/InvalidRequestProblem","exampleIds":["paths/~1invoices/get/responses/400/content/application~1problem+json/examples/malformed_json"]}},"schemaId":"components/schemas/InvalidRequestProblem","exampleIds":["paths/~1invoices/get/responses/400/content/application~1problem+json/examples/malformed_json"]},{"code":"401","description":"Missing or invalid authentication credentials.","mediaType":"application/problem+json","mediaTypes":["application/problem+json"],"mediaTypeContent":{"application/problem+json":{"schemaId":"components/schemas/UnauthorizedProblem","exampleIds":["paths/~1invoices/get/responses/401/content/application~1problem+json/examples/service_authentication_denied"]}},"schemaId":"components/schemas/UnauthorizedProblem","exampleIds":["paths/~1invoices/get/responses/401/content/application~1problem+json/examples/service_authentication_denied"]},{"code":"403","description":"Insufficient permissions.","mediaType":"application/problem+json","mediaTypes":["application/problem+json"],"mediaTypeContent":{"application/problem+json":{"schemaId":"components/schemas/ForbiddenProblem","exampleIds":["paths/~1invoices/get/responses/403/content/application~1problem+json/examples/insufficient_permissions"]}},"schemaId":"components/schemas/ForbiddenProblem","exampleIds":["paths/~1invoices/get/responses/403/content/application~1problem+json/examples/insufficient_permissions"]},{"code":"503","description":"The operation is temporarily unavailable. Please try again later.","mediaType":"application/problem+json","mediaTypes":["application/problem+json"],"mediaTypeContent":{"application/problem+json":{"schemaId":"components/schemas/Problem","exampleIds":["paths/~1invoices/get/responses/503/content/application~1problem+json/examples/temporarily_unavailable"]}},"schemaId":"components/schemas/Problem","exampleIds":["paths/~1invoices/get/responses/503/content/application~1problem+json/examples/temporarily_unavailable"]},{"code":"default","description":"Unexpected error.","mediaType":"application/problem+json","mediaTypes":["application/problem+json"],"mediaTypeContent":{"application/problem+json":{"schemaId":"components/schemas/Problem"}},"schemaId":"components/schemas/Problem"}],"pointer":"/paths/~1invoices/get/responses"}],"panels":[{"children":[{"kind":"response","responseCodes":[{"code":"200","schemaId":"schema_48","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"schema_48"}}},{"code":"400","schemaId":"components/schemas/InvalidRequestProblem","exampleIds":["paths/~1invoices/get/responses/400/content/application~1problem+json/examples/malformed_json"],"mediaTypes":["application/problem+json"],"mediaTypeContent":{"application/problem+json":{"schemaId":"components/schemas/InvalidRequestProblem","exampleIds":["paths/~1invoices/get/responses/400/content/application~1problem+json/examples/malformed_json"]}}},{"code":"401","schemaId":"components/schemas/UnauthorizedProblem","exampleIds":["paths/~1invoices/get/responses/401/content/application~1problem+json/examples/service_authentication_denied"],"mediaTypes":["application/problem+json"],"mediaTypeContent":{"application/problem+json":{"schemaId":"components/schemas/UnauthorizedProblem","exampleIds":["paths/~1invoices/get/responses/401/content/application~1problem+json/examples/service_authentication_denied"]}}},{"code":"403","schemaId":"components/schemas/ForbiddenProblem","exampleIds":["paths/~1invoices/get/responses/403/content/application~1problem+json/examples/insufficient_permissions"],"mediaTypes":["application/problem+json"],"mediaTypeContent":{"application/problem+json":{"schemaId":"components/schemas/ForbiddenProblem","exampleIds":["paths/~1invoices/get/responses/403/content/application~1problem+json/examples/insufficient_permissions"]}}},{"code":"503","schemaId":"components/schemas/Problem","exampleIds":["paths/~1invoices/get/responses/503/content/application~1problem+json/examples/temporarily_unavailable"],"mediaTypes":["application/problem+json"],"mediaTypeContent":{"application/problem+json":{"schemaId":"components/schemas/Problem","exampleIds":["paths/~1invoices/get/responses/503/content/application~1problem+json/examples/temporarily_unavailable"]}}},{"code":"default","schemaId":"components/schemas/Problem","mediaTypes":["application/problem+json"],"mediaTypeContent":{"application/problem+json":{"schemaId":"components/schemas/Problem"}}}],"examples":[]}]}]},{"nodeType":"container","children":[{"nodeType":"feedback","pageSlug":"/invoice/list-invoices"}],"panels":[]}]},"httpPath":"/invoices"},{"label":"Create invoice","deprecated":false,"httpVerb":"post","isAdditionalOperation":false,"isWebhook":false,"type":"link","link":"/apis/platform/api/invoice/create-invoice","routeSlug":"/apis/platform/api/invoice/create-invoice","metadata":{"seo":{"title":"Create invoice","description":"Create a payment invoice for an address in the current project and a specific token.If no invoice is accepting payments at that address, create a new invoice and return 201 Created.If an invoice is already accepting payments with the same token and amount, return thatexisting invoice with 200 OK; its expiry and metadata remain unchanged, even if therequest supplies different values. A different token or amount returns 409 Conflict.Check the returned invoice ID, expiry and metadata before associating it with an order.After cancellation closes an invoice's payment window, the address can be used for anew invoice, subject to the usual creation requirements. The new invoice has its ownpayment window; payments from the cancelled invoice are not transferred to it.Use a new Idempotency-Key for the new invoice; retrying the original creation requestwith its original key follows the mutation idempotency policy."}},"content":{"contentType":"item","itemVariant":"httpItem","meta":{"sourceId":"create-invoice","name":"Create invoice","isWebhook":false,"pointer":"/paths/~1invoices/post","hasSamples":true},"children":[{"nodeType":"container","children":[{"nodeType":"header","level":2,"label":"Create invoice","isWebhook":false,"showPageActions":true}],"panels":[]},{"nodeType":"container","children":[{"nodeType":"header","level":4,"label":"Request","labelTranslationKey":"request","deepLinkSuffix":"request"},{"nodeType":"markdoc","content":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Create a payment invoice for an address in the current project and a specific token."},"children":[]},{"$$mdtype":"Node","type":"softbreak","inline":true,"attributes":{},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"If no invoice is accepting payments at that address, create a new invoice and return "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"201 Created"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"."},"children":[]},{"$$mdtype":"Node","type":"softbreak","inline":true,"attributes":{},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"If an invoice is already accepting payments with the same token and amount, return that"},"children":[]},{"$$mdtype":"Node","type":"softbreak","inline":true,"attributes":{},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"existing invoice with "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"200 OK"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"; its expiry and metadata remain unchanged, even if the"},"children":[]},{"$$mdtype":"Node","type":"softbreak","inline":true,"attributes":{},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"request supplies different values. A different token or amount returns "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"409 Conflict"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"."},"children":[]},{"$$mdtype":"Node","type":"softbreak","inline":true,"attributes":{},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Check the returned invoice ID, expiry and metadata before associating it with an order."},"children":[]},{"$$mdtype":"Node","type":"softbreak","inline":true,"attributes":{},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"After cancellation closes an invoice's payment window, the address can be used for a"},"children":[]},{"$$mdtype":"Node","type":"softbreak","inline":true,"attributes":{},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"new invoice, subject to the usual creation requirements. The new invoice has its own"},"children":[]},{"$$mdtype":"Node","type":"softbreak","inline":true,"attributes":{},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"payment window; payments from the cancelled invoice are not transferred to it."},"children":[]},{"$$mdtype":"Node","type":"softbreak","inline":true,"attributes":{},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Use a new "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"Idempotency-Key"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" for the new invoice; retrying the original creation request"},"children":[]},{"$$mdtype":"Node","type":"softbreak","inline":true,"attributes":{},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"with its original key follows the mutation idempotency policy."},"children":[]}]}]}]},{"nodeType":"security","requirements":[{"schemes":[{"name":"Auth","scopes":["api:invoice:write"],"type":"apiKey","in":"header","paramName":"X-Api-Key","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"API key for authenticating requests. Include your key in the "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"X-Api-Key"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" header. Keys can be created in the Vilna Dashboard or via the Management API. The scopes listed per operation indicate which permissions the key must have."},"children":[]}]}]}]}]}]},{"nodeType":"item-content","variant":"headers","label":"Headers","labelTranslationKey":"header","parameters":[{"name":"Idempotency-Key","in":"header","schemaId":"schema_14","description":"Case-sensitive opaque key for one mutation intent. Send exactly one header occurrence containing 1 to 128 visible ASCII bytes (0x21..0x7e). Commas are literal data; do not trim, lowercase or require UUID syntax. Reuse the same key for retries, with current authorization checked on every attempt. Repeated header occurrences are rejected.\n","required":true}],"pointer":"/paths/~1invoices/post/parameters"},{"nodeType":"item-content","variant":"body","label":"Request Body","labelTranslationKey":"body","required":true,"mediaTypes":["application/json"],"mediaTypeSchemas":{"application/json":{"schemaId":"components/schemas/CreateInvoiceRequest","exampleIds":["paths/~1invoices/post/requestBody/content/application~1json/examples/create_usdt_invoice"]}},"schemaId":"components/schemas/CreateInvoiceRequest","exampleIds":["paths/~1invoices/post/requestBody/content/application~1json/examples/create_usdt_invoice"],"pointer":"/paths/~1invoices/post/requestBody"}],"panels":[{"children":[{"kind":"code-sample","source":{"kind":"code-sample","operationType":"http","method":"POST","path":"/invoices","servers":[{"url":"/_mock/apis/platform/api","description":"Mock server","isMockServer":true},{"url":"https://api.vilna.io/v2","description":"Vilna API."}],"parameters":{"path":[],"query":[],"querystring":[],"header":[{"name":"Idempotency-Key","in":"header","required":true,"schemaId":"schema_14"}],"cookie":[]},"security":[{"schemes":[{"id":"Auth","type":"apiKey","name":"X-Api-Key","in":"header"}],"scopes":["api:invoice:write"]}],"requestBody":{"application/json":{"schemaId":"components/schemas/CreateInvoiceRequest","exampleIds":["paths/~1invoices/post/requestBody/content/application~1json/examples/create_usdt_invoice"]}},"responseCodes":["200","201","400","401","403","404","409","422","429","502","503","504","default"],"pointer":"/invoices","href":"invoice/create-invoice","openApiOperationId":"create-invoice","summary":"Create invoice"},"isWebhook":false,"hideReplay":false,"servers":[{"url":"/_mock/apis/platform/api","description":"Mock server","isMockServer":true},{"url":"https://api.vilna.io/v2","description":"Vilna API."}],"schemaId":"components/schemas/CreateInvoiceRequest","exampleIds":["paths/~1invoices/post/requestBody/content/application~1json/examples/create_usdt_invoice"],"mediaTypes":["application/json"],"mediaTypeSchemas":{"application/json":{"schemaId":"components/schemas/CreateInvoiceRequest","exampleIds":["paths/~1invoices/post/requestBody/content/application~1json/examples/create_usdt_invoice"]}},"examples":[{}]}]}]},{"nodeType":"container","children":[{"nodeType":"header","level":4,"label":"Responses","labelTranslationKey":"responses","deepLinkSuffix":"responses"},{"nodeType":"item-content","variant":"responses","responses":[{"code":"200","description":"Invoice details.","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"schema_49","exampleIds":["paths/~1invoices/post/responses/200/content/application~1json/examples/open_invoice","paths/~1invoices/post/responses/200/content/application~1json/examples/confirmed_invoice"]}},"schemaId":"schema_49","exampleIds":["paths/~1invoices/post/responses/200/content/application~1json/examples/open_invoice","paths/~1invoices/post/responses/200/content/application~1json/examples/confirmed_invoice"]},{"code":"201","description":"Invoice details.","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"schema_49","exampleIds":["paths/~1invoices/post/responses/201/content/application~1json/examples/open_invoice","paths/~1invoices/post/responses/201/content/application~1json/examples/confirmed_invoice"]}},"schemaId":"schema_49","exampleIds":["paths/~1invoices/post/responses/201/content/application~1json/examples/open_invoice","paths/~1invoices/post/responses/201/content/application~1json/examples/confirmed_invoice"]},{"code":"400","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Bad request (e.g., missing or invalid fields). Invalid text may be reported as address.label_invalid, address.meta_invalid, public_key.label_invalid, invoice.comment_invalid, invoice.metadata_invalid."},"children":[]}]}]}],"mediaType":"application/problem+json","mediaTypes":["application/problem+json"],"mediaTypeContent":{"application/problem+json":{"schemaId":"components/schemas/InvalidRequestProblem","exampleIds":["paths/~1invoices/post/responses/400/content/application~1problem+json/examples/malformed_json"]}},"schemaId":"components/schemas/InvalidRequestProblem","exampleIds":["paths/~1invoices/post/responses/400/content/application~1problem+json/examples/malformed_json"]},{"code":"401","description":"Missing or invalid authentication credentials.","mediaType":"application/problem+json","mediaTypes":["application/problem+json"],"mediaTypeContent":{"application/problem+json":{"schemaId":"components/schemas/UnauthorizedProblem","exampleIds":["paths/~1invoices/post/responses/401/content/application~1problem+json/examples/service_authentication_denied"]}},"schemaId":"components/schemas/UnauthorizedProblem","exampleIds":["paths/~1invoices/post/responses/401/content/application~1problem+json/examples/service_authentication_denied"]},{"code":"403","description":"Insufficient permissions.","mediaType":"application/problem+json","mediaTypes":["application/problem+json"],"mediaTypeContent":{"application/problem+json":{"schemaId":"components/schemas/ForbiddenProblem","exampleIds":["paths/~1invoices/post/responses/403/content/application~1problem+json/examples/insufficient_permissions"]}},"schemaId":"components/schemas/ForbiddenProblem","exampleIds":["paths/~1invoices/post/responses/403/content/application~1problem+json/examples/insufficient_permissions"]},{"code":"404","description":"Requested resource does not exist.","mediaType":"application/problem+json","mediaTypes":["application/problem+json"],"mediaTypeContent":{"application/problem+json":{"schemaId":"components/schemas/NotFoundProblem","exampleIds":["paths/~1invoices/post/responses/404/content/application~1problem+json/examples/address_not_found","paths/~1invoices/post/responses/404/content/application~1problem+json/examples/invoice_not_found"]}},"schemaId":"components/schemas/NotFoundProblem","exampleIds":["paths/~1invoices/post/responses/404/content/application~1problem+json/examples/address_not_found","paths/~1invoices/post/responses/404/content/application~1problem+json/examples/invoice_not_found"]},{"code":"409","description":"Request conflicts with the current resource state.","mediaType":"application/problem+json","mediaTypes":["application/problem+json"],"mediaTypeContent":{"application/problem+json":{"schemaId":"components/schemas/ConflictProblem","exampleIds":["paths/~1invoices/post/responses/409/content/application~1problem+json/examples/address_occupied","paths/~1invoices/post/responses/409/content/application~1problem+json/examples/address_in_use","paths/~1invoices/post/responses/409/content/application~1problem+json/examples/subscription_v1_conflict","paths/~1invoices/post/responses/409/content/application~1problem+json/examples/notification_send_in_progress","paths/~1invoices/post/responses/409/content/application~1problem+json/examples/notification_payload_unavailable","paths/~1invoices/post/responses/409/content/application~1problem+json/examples/notification_test_resend_not_allowed"]}},"schemaId":"components/schemas/ConflictProblem","exampleIds":["paths/~1invoices/post/responses/409/content/application~1problem+json/examples/address_occupied","paths/~1invoices/post/responses/409/content/application~1problem+json/examples/address_in_use","paths/~1invoices/post/responses/409/content/application~1problem+json/examples/subscription_v1_conflict","paths/~1invoices/post/responses/409/content/application~1problem+json/examples/notification_send_in_progress","paths/~1invoices/post/responses/409/content/application~1problem+json/examples/notification_payload_unavailable","paths/~1invoices/post/responses/409/content/application~1problem+json/examples/notification_test_resend_not_allowed"]},{"code":"422","description":"Request preconditions were not met.","mediaType":"application/problem+json","mediaTypes":["application/problem+json"],"mediaTypeContent":{"application/problem+json":{"schemaId":"components/schemas/PreconditionProblem","exampleIds":["paths/~1invoices/post/responses/422/content/application~1problem+json/examples/invoice_not_cancellable"]}},"schemaId":"components/schemas/PreconditionProblem","exampleIds":["paths/~1invoices/post/responses/422/content/application~1problem+json/examples/invoice_not_cancellable"]},{"code":"429","description":"Resource quota exceeded. The response includes the effective limit for this scope. The applicable code and limit depend on the operation; examples illustrate different limits.","mediaType":"application/problem+json","mediaTypes":["application/problem+json"],"mediaTypeContent":{"application/problem+json":{"schemaId":"components/schemas/QuotaExceededProblem","exampleIds":["paths/~1invoices/post/responses/429/content/application~1problem+json/examples/address_quota","paths/~1invoices/post/responses/429/content/application~1problem+json/examples/creation_prohibited"]}},"schemaId":"components/schemas/QuotaExceededProblem","exampleIds":["paths/~1invoices/post/responses/429/content/application~1problem+json/examples/address_quota","paths/~1invoices/post/responses/429/content/application~1problem+json/examples/creation_prohibited"]},{"code":"502","description":"Invalid upstream response or integration failure.","mediaType":"application/problem+json","mediaTypes":["application/problem+json"],"mediaTypeContent":{"application/problem+json":{"schemaId":"components/schemas/Problem"}},"schemaId":"components/schemas/Problem"},{"code":"503","description":"The operation is temporarily unavailable. Please try again later.","mediaType":"application/problem+json","mediaTypes":["application/problem+json"],"mediaTypeContent":{"application/problem+json":{"schemaId":"components/schemas/Problem","exampleIds":["paths/~1invoices/post/responses/503/content/application~1problem+json/examples/temporarily_unavailable"]}},"schemaId":"components/schemas/Problem","exampleIds":["paths/~1invoices/post/responses/503/content/application~1problem+json/examples/temporarily_unavailable"]},{"code":"504","description":"Shared request deadline exhausted.","mediaType":"application/problem+json","mediaTypes":["application/problem+json"],"mediaTypeContent":{"application/problem+json":{"schemaId":"components/schemas/Problem"}},"schemaId":"components/schemas/Problem"},{"code":"default","description":"Unexpected error.","mediaType":"application/problem+json","mediaTypes":["application/problem+json"],"mediaTypeContent":{"application/problem+json":{"schemaId":"components/schemas/Problem"}},"schemaId":"components/schemas/Problem"}],"pointer":"/paths/~1invoices/post/responses"}],"panels":[{"children":[{"kind":"response","responseCodes":[{"code":"200","schemaId":"schema_49","exampleIds":["paths/~1invoices/post/responses/200/content/application~1json/examples/open_invoice","paths/~1invoices/post/responses/200/content/application~1json/examples/confirmed_invoice"],"mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"schema_49","exampleIds":["paths/~1invoices/post/responses/200/content/application~1json/examples/open_invoice","paths/~1invoices/post/responses/200/content/application~1json/examples/confirmed_invoice"]}}},{"code":"201","schemaId":"schema_49","exampleIds":["paths/~1invoices/post/responses/201/content/application~1json/examples/open_invoice","paths/~1invoices/post/responses/201/content/application~1json/examples/confirmed_invoice"],"mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"schema_49","exampleIds":["paths/~1invoices/post/responses/201/content/application~1json/examples/open_invoice","paths/~1invoices/post/responses/201/content/application~1json/examples/confirmed_invoice"]}}},{"code":"400","schemaId":"components/schemas/InvalidRequestProblem","exampleIds":["paths/~1invoices/post/responses/400/content/application~1problem+json/examples/malformed_json"],"mediaTypes":["application/problem+json"],"mediaTypeContent":{"application/problem+json":{"schemaId":"components/schemas/InvalidRequestProblem","exampleIds":["paths/~1invoices/post/responses/400/content/application~1problem+json/examples/malformed_json"]}}},{"code":"401","schemaId":"components/schemas/UnauthorizedProblem","exampleIds":["paths/~1invoices/post/responses/401/content/application~1problem+json/examples/service_authentication_denied"],"mediaTypes":["application/problem+json"],"mediaTypeContent":{"application/problem+json":{"schemaId":"components/schemas/UnauthorizedProblem","exampleIds":["paths/~1invoices/post/responses/401/content/application~1problem+json/examples/service_authentication_denied"]}}},{"code":"403","schemaId":"components/schemas/ForbiddenProblem","exampleIds":["paths/~1invoices/post/responses/403/content/application~1problem+json/examples/insufficient_permissions"],"mediaTypes":["application/problem+json"],"mediaTypeContent":{"application/problem+json":{"schemaId":"components/schemas/ForbiddenProblem","exampleIds":["paths/~1invoices/post/responses/403/content/application~1problem+json/examples/insufficient_permissions"]}}},{"code":"404","schemaId":"components/schemas/NotFoundProblem","exampleIds":["paths/~1invoices/post/responses/404/content/application~1problem+json/examples/address_not_found","paths/~1invoices/post/responses/404/content/application~1problem+json/examples/invoice_not_found"],"mediaTypes":["application/problem+json"],"mediaTypeContent":{"application/problem+json":{"schemaId":"components/schemas/NotFoundProblem","exampleIds":["paths/~1invoices/post/responses/404/content/application~1problem+json/examples/address_not_found","paths/~1invoices/post/responses/404/content/application~1problem+json/examples/invoice_not_found"]}}},{"code":"409","schemaId":"components/schemas/ConflictProblem","exampleIds":["paths/~1invoices/post/responses/409/content/application~1problem+json/examples/address_occupied","paths/~1invoices/post/responses/409/content/application~1problem+json/examples/address_in_use","paths/~1invoices/post/responses/409/content/application~1problem+json/examples/subscription_v1_conflict","paths/~1invoices/post/responses/409/content/application~1problem+json/examples/notification_send_in_progress","paths/~1invoices/post/responses/409/content/application~1problem+json/examples/notification_payload_unavailable","paths/~1invoices/post/responses/409/content/application~1problem+json/examples/notification_test_resend_not_allowed"],"mediaTypes":["application/problem+json"],"mediaTypeContent":{"application/problem+json":{"schemaId":"components/schemas/ConflictProblem","exampleIds":["paths/~1invoices/post/responses/409/content/application~1problem+json/examples/address_occupied","paths/~1invoices/post/responses/409/content/application~1problem+json/examples/address_in_use","paths/~1invoices/post/responses/409/content/application~1problem+json/examples/subscription_v1_conflict","paths/~1invoices/post/responses/409/content/application~1problem+json/examples/notification_send_in_progress","paths/~1invoices/post/responses/409/content/application~1problem+json/examples/notification_payload_unavailable","paths/~1invoices/post/responses/409/content/application~1problem+json/examples/notification_test_resend_not_allowed"]}}},{"code":"422","schemaId":"components/schemas/PreconditionProblem","exampleIds":["paths/~1invoices/post/responses/422/content/application~1problem+json/examples/invoice_not_cancellable"],"mediaTypes":["application/problem+json"],"mediaTypeContent":{"application/problem+json":{"schemaId":"components/schemas/PreconditionProblem","exampleIds":["paths/~1invoices/post/responses/422/content/application~1problem+json/examples/invoice_not_cancellable"]}}},{"code":"429","schemaId":"components/schemas/QuotaExceededProblem","exampleIds":["paths/~1invoices/post/responses/429/content/application~1problem+json/examples/address_quota","paths/~1invoices/post/responses/429/content/application~1problem+json/examples/creation_prohibited"],"mediaTypes":["application/problem+json"],"mediaTypeContent":{"application/problem+json":{"schemaId":"components/schemas/QuotaExceededProblem","exampleIds":["paths/~1invoices/post/responses/429/content/application~1problem+json/examples/address_quota","paths/~1invoices/post/responses/429/content/application~1problem+json/examples/creation_prohibited"]}}},{"code":"502","schemaId":"components/schemas/Problem","mediaTypes":["application/problem+json"],"mediaTypeContent":{"application/problem+json":{"schemaId":"components/schemas/Problem"}}},{"code":"503","schemaId":"components/schemas/Problem","exampleIds":["paths/~1invoices/post/responses/503/content/application~1problem+json/examples/temporarily_unavailable"],"mediaTypes":["application/problem+json"],"mediaTypeContent":{"application/problem+json":{"schemaId":"components/schemas/Problem","exampleIds":["paths/~1invoices/post/responses/503/content/application~1problem+json/examples/temporarily_unavailable"]}}},{"code":"504","schemaId":"components/schemas/Problem","mediaTypes":["application/problem+json"],"mediaTypeContent":{"application/problem+json":{"schemaId":"components/schemas/Problem"}}},{"code":"default","schemaId":"components/schemas/Problem","mediaTypes":["application/problem+json"],"mediaTypeContent":{"application/problem+json":{"schemaId":"components/schemas/Problem"}}}],"examples":[]}]}]},{"nodeType":"container","children":[{"nodeType":"feedback","pageSlug":"/invoice/create-invoice"}],"panels":[]}]},"httpPath":"/invoices"},{"label":"Get invoice","deprecated":false,"httpVerb":"get","isAdditionalOperation":false,"isWebhook":false,"type":"link","link":"/apis/platform/api/invoice/get-invoice","routeSlug":"/apis/platform/api/invoice/get-invoice","metadata":{"seo":{"title":"Get invoice","description":"Get full invoice details including merchant notes and metadata."}},"content":{"contentType":"item","itemVariant":"httpItem","meta":{"sourceId":"get-invoice","name":"Get invoice","isWebhook":false,"pointer":"/paths/~1invoices~1{invoice_id}/get","hasSamples":false},"children":[{"nodeType":"container","children":[{"nodeType":"header","level":2,"label":"Get invoice","isWebhook":false,"showPageActions":true}],"panels":[]},{"nodeType":"container","children":[{"nodeType":"header","level":4,"label":"Request","labelTranslationKey":"request","deepLinkSuffix":"request"},{"nodeType":"markdoc","content":"Get full invoice details including merchant notes and metadata."},{"nodeType":"security","requirements":[{"schemes":[{"name":"Auth","scopes":["api:invoice:read"],"type":"apiKey","in":"header","paramName":"X-Api-Key","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"API key for authenticating requests. Include your key in the "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"X-Api-Key"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" header. Keys can be created in the Vilna Dashboard or via the Management API. The scopes listed per operation indicate which permissions the key must have."},"children":[]}]}]}]}]}]},{"nodeType":"item-content","variant":"path","label":"Path","labelTranslationKey":"path","parameters":[{"name":"invoice_id","in":"path","schemaId":"schema_17","description":"Unique identifier (UUID) of the invoice.","required":true}],"pointer":"/paths/~1invoices~1{invoice_id}/get/parameters"}],"panels":[{"children":[{"kind":"code-sample","source":{"kind":"code-sample","operationType":"http","method":"GET","path":"/invoices/{invoice_id}","servers":[{"url":"/_mock/apis/platform/api","description":"Mock server","isMockServer":true},{"url":"https://api.vilna.io/v2","description":"Vilna API."}],"parameters":{"path":[{"name":"invoice_id","in":"path","required":true,"example":"550e8400-e29b-41d4-a716-446655440000","schemaId":"components/schemas/UUID"}],"query":[],"querystring":[],"header":[],"cookie":[]},"security":[{"schemes":[{"id":"Auth","type":"apiKey","name":"X-Api-Key","in":"header"}],"scopes":["api:invoice:read"]}],"responseCodes":["200","400","401","403","404","503","default"],"pointer":"/invoices/{invoice_id}","href":"invoice/get-invoice","openApiOperationId":"get-invoice","summary":"Get invoice"},"isWebhook":false,"hideReplay":false,"servers":[{"url":"/_mock/apis/platform/api","description":"Mock server","isMockServer":true},{"url":"https://api.vilna.io/v2","description":"Vilna API."}],"examples":[]}]}]},{"nodeType":"container","children":[{"nodeType":"header","level":4,"label":"Responses","labelTranslationKey":"responses","deepLinkSuffix":"responses"},{"nodeType":"item-content","variant":"responses","responses":[{"code":"200","description":"Invoice details.","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"schema_49","exampleIds":["paths/~1invoices~1{invoice_id}/get/responses/200/content/application~1json/examples/open_invoice","paths/~1invoices~1{invoice_id}/get/responses/200/content/application~1json/examples/confirmed_invoice"]}},"schemaId":"schema_49","exampleIds":["paths/~1invoices~1{invoice_id}/get/responses/200/content/application~1json/examples/open_invoice","paths/~1invoices~1{invoice_id}/get/responses/200/content/application~1json/examples/confirmed_invoice"]},{"code":"400","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Bad request (e.g., missing or invalid fields). Invalid text may be reported as address.label_invalid, address.meta_invalid, public_key.label_invalid, invoice.comment_invalid, invoice.metadata_invalid."},"children":[]}]}]}],"mediaType":"application/problem+json","mediaTypes":["application/problem+json"],"mediaTypeContent":{"application/problem+json":{"schemaId":"components/schemas/InvalidRequestProblem","exampleIds":["paths/~1invoices~1{invoice_id}/get/responses/400/content/application~1problem+json/examples/malformed_json"]}},"schemaId":"components/schemas/InvalidRequestProblem","exampleIds":["paths/~1invoices~1{invoice_id}/get/responses/400/content/application~1problem+json/examples/malformed_json"]},{"code":"401","description":"Missing or invalid authentication credentials.","mediaType":"application/problem+json","mediaTypes":["application/problem+json"],"mediaTypeContent":{"application/problem+json":{"schemaId":"components/schemas/UnauthorizedProblem","exampleIds":["paths/~1invoices~1{invoice_id}/get/responses/401/content/application~1problem+json/examples/service_authentication_denied"]}},"schemaId":"components/schemas/UnauthorizedProblem","exampleIds":["paths/~1invoices~1{invoice_id}/get/responses/401/content/application~1problem+json/examples/service_authentication_denied"]},{"code":"403","description":"Insufficient permissions.","mediaType":"application/problem+json","mediaTypes":["application/problem+json"],"mediaTypeContent":{"application/problem+json":{"schemaId":"components/schemas/ForbiddenProblem","exampleIds":["paths/~1invoices~1{invoice_id}/get/responses/403/content/application~1problem+json/examples/insufficient_permissions"]}},"schemaId":"components/schemas/ForbiddenProblem","exampleIds":["paths/~1invoices~1{invoice_id}/get/responses/403/content/application~1problem+json/examples/insufficient_permissions"]},{"code":"404","description":"Requested resource does not exist.","mediaType":"application/problem+json","mediaTypes":["application/problem+json"],"mediaTypeContent":{"application/problem+json":{"schemaId":"components/schemas/NotFoundProblem","exampleIds":["paths/~1invoices~1{invoice_id}/get/responses/404/content/application~1problem+json/examples/address_not_found","paths/~1invoices~1{invoice_id}/get/responses/404/content/application~1problem+json/examples/invoice_not_found"]}},"schemaId":"components/schemas/NotFoundProblem","exampleIds":["paths/~1invoices~1{invoice_id}/get/responses/404/content/application~1problem+json/examples/address_not_found","paths/~1invoices~1{invoice_id}/get/responses/404/content/application~1problem+json/examples/invoice_not_found"]},{"code":"503","description":"The operation is temporarily unavailable. Please try again later.","mediaType":"application/problem+json","mediaTypes":["application/problem+json"],"mediaTypeContent":{"application/problem+json":{"schemaId":"components/schemas/Problem","exampleIds":["paths/~1invoices~1{invoice_id}/get/responses/503/content/application~1problem+json/examples/temporarily_unavailable"]}},"schemaId":"components/schemas/Problem","exampleIds":["paths/~1invoices~1{invoice_id}/get/responses/503/content/application~1problem+json/examples/temporarily_unavailable"]},{"code":"default","description":"Unexpected error.","mediaType":"application/problem+json","mediaTypes":["application/problem+json"],"mediaTypeContent":{"application/problem+json":{"schemaId":"components/schemas/Problem"}},"schemaId":"components/schemas/Problem"}],"pointer":"/paths/~1invoices~1{invoice_id}/get/responses"}],"panels":[{"children":[{"kind":"response","responseCodes":[{"code":"200","schemaId":"schema_49","exampleIds":["paths/~1invoices~1{invoice_id}/get/responses/200/content/application~1json/examples/open_invoice","paths/~1invoices~1{invoice_id}/get/responses/200/content/application~1json/examples/confirmed_invoice"],"mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"schema_49","exampleIds":["paths/~1invoices~1{invoice_id}/get/responses/200/content/application~1json/examples/open_invoice","paths/~1invoices~1{invoice_id}/get/responses/200/content/application~1json/examples/confirmed_invoice"]}}},{"code":"400","schemaId":"components/schemas/InvalidRequestProblem","exampleIds":["paths/~1invoices~1{invoice_id}/get/responses/400/content/application~1problem+json/examples/malformed_json"],"mediaTypes":["application/problem+json"],"mediaTypeContent":{"application/problem+json":{"schemaId":"components/schemas/InvalidRequestProblem","exampleIds":["paths/~1invoices~1{invoice_id}/get/responses/400/content/application~1problem+json/examples/malformed_json"]}}},{"code":"401","schemaId":"components/schemas/UnauthorizedProblem","exampleIds":["paths/~1invoices~1{invoice_id}/get/responses/401/content/application~1problem+json/examples/service_authentication_denied"],"mediaTypes":["application/problem+json"],"mediaTypeContent":{"application/problem+json":{"schemaId":"components/schemas/UnauthorizedProblem","exampleIds":["paths/~1invoices~1{invoice_id}/get/responses/401/content/application~1problem+json/examples/service_authentication_denied"]}}},{"code":"403","schemaId":"components/schemas/ForbiddenProblem","exampleIds":["paths/~1invoices~1{invoice_id}/get/responses/403/content/application~1problem+json/examples/insufficient_permissions"],"mediaTypes":["application/problem+json"],"mediaTypeContent":{"application/problem+json":{"schemaId":"components/schemas/ForbiddenProblem","exampleIds":["paths/~1invoices~1{invoice_id}/get/responses/403/content/application~1problem+json/examples/insufficient_permissions"]}}},{"code":"404","schemaId":"components/schemas/NotFoundProblem","exampleIds":["paths/~1invoices~1{invoice_id}/get/responses/404/content/application~1problem+json/examples/address_not_found","paths/~1invoices~1{invoice_id}/get/responses/404/content/application~1problem+json/examples/invoice_not_found"],"mediaTypes":["application/problem+json"],"mediaTypeContent":{"application/problem+json":{"schemaId":"components/schemas/NotFoundProblem","exampleIds":["paths/~1invoices~1{invoice_id}/get/responses/404/content/application~1problem+json/examples/address_not_found","paths/~1invoices~1{invoice_id}/get/responses/404/content/application~1problem+json/examples/invoice_not_found"]}}},{"code":"503","schemaId":"components/schemas/Problem","exampleIds":["paths/~1invoices~1{invoice_id}/get/responses/503/content/application~1problem+json/examples/temporarily_unavailable"],"mediaTypes":["application/problem+json"],"mediaTypeContent":{"application/problem+json":{"schemaId":"components/schemas/Problem","exampleIds":["paths/~1invoices~1{invoice_id}/get/responses/503/content/application~1problem+json/examples/temporarily_unavailable"]}}},{"code":"default","schemaId":"components/schemas/Problem","mediaTypes":["application/problem+json"],"mediaTypeContent":{"application/problem+json":{"schemaId":"components/schemas/Problem"}}}],"examples":[]}]}]},{"nodeType":"container","children":[{"nodeType":"feedback","pageSlug":"/invoice/get-invoice"}],"panels":[]}]},"httpPath":"/invoices/{invoice_id}"},{"label":"Delete invoice","deprecated":false,"httpVerb":"delete","isAdditionalOperation":false,"isWebhook":false,"type":"link","link":"/apis/platform/api/invoice/delete-invoice","routeSlug":"/apis/platform/api/invoice/delete-invoice","metadata":{"seo":{"title":"Delete invoice","description":"Hide a settled invoice from the project. Only an invoice in a terminal status can bedeleted: confirmed, cancelled or expired. An open invoice has to be cancelledfirst, or left to reach a terminal status."}},"content":{"contentType":"item","itemVariant":"httpItem","meta":{"sourceId":"delete-invoice","name":"Delete invoice","isWebhook":false,"pointer":"/paths/~1invoices~1{invoice_id}/delete","hasSamples":false},"children":[{"nodeType":"container","children":[{"nodeType":"header","level":2,"label":"Delete invoice","isWebhook":false,"showPageActions":true}],"panels":[]},{"nodeType":"container","children":[{"nodeType":"header","level":4,"label":"Request","labelTranslationKey":"request","deepLinkSuffix":"request"},{"nodeType":"markdoc","content":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Hide a settled invoice from the project. Only an invoice in a terminal status can be"},"children":[]},{"$$mdtype":"Node","type":"softbreak","inline":true,"attributes":{},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"deleted: "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"confirmed"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":", "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"cancelled"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" or "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"expired"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":". An "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"open"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" invoice has to be cancelled"},"children":[]},{"$$mdtype":"Node","type":"softbreak","inline":true,"attributes":{},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"first, or left to reach a terminal status."},"children":[]}]}]},{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Deletion cannot be undone. The invoice no longer appears in list or get responses."},"children":[]},{"$$mdtype":"Node","type":"softbreak","inline":true,"attributes":{},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Payments credited to this invoice cannot be credited to another invoice."},"children":[]}]}]}]},{"nodeType":"security","requirements":[{"schemes":[{"name":"Auth","scopes":["api:invoice:delete"],"type":"apiKey","in":"header","paramName":"X-Api-Key","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"API key for authenticating requests. Include your key in the "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"X-Api-Key"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" header. Keys can be created in the Vilna Dashboard or via the Management API. The scopes listed per operation indicate which permissions the key must have."},"children":[]}]}]}]}]}]},{"nodeType":"item-content","variant":"path","label":"Path","labelTranslationKey":"path","parameters":[{"name":"invoice_id","in":"path","schemaId":"schema_17","description":"Unique identifier (UUID) of the invoice.","required":true}],"pointer":"/paths/~1invoices~1{invoice_id}/delete/parameters"},{"nodeType":"item-content","variant":"headers","label":"Headers","labelTranslationKey":"header","parameters":[{"name":"Idempotency-Key","in":"header","schemaId":"schema_14","description":"Case-sensitive opaque key for one mutation intent. Send exactly one header occurrence containing 1 to 128 visible ASCII bytes (0x21..0x7e). Commas are literal data; do not trim, lowercase or require UUID syntax. Reuse the same key for retries, with current authorization checked on every attempt. Repeated header occurrences are rejected.\n","required":true}],"pointer":"/paths/~1invoices~1{invoice_id}/delete/parameters"}],"panels":[{"children":[{"kind":"code-sample","source":{"kind":"code-sample","operationType":"http","method":"DELETE","path":"/invoices/{invoice_id}","servers":[{"url":"/_mock/apis/platform/api","description":"Mock server","isMockServer":true},{"url":"https://api.vilna.io/v2","description":"Vilna API."}],"parameters":{"path":[{"name":"invoice_id","in":"path","required":true,"example":"550e8400-e29b-41d4-a716-446655440000","schemaId":"components/schemas/UUID"}],"query":[],"querystring":[],"header":[{"name":"Idempotency-Key","in":"header","required":true,"schemaId":"schema_14"}],"cookie":[]},"security":[{"schemes":[{"id":"Auth","type":"apiKey","name":"X-Api-Key","in":"header"}],"scopes":["api:invoice:delete"]}],"responseCodes":["204","400","401","403","404","409","422","503","default"],"pointer":"/invoices/{invoice_id}","href":"invoice/delete-invoice","openApiOperationId":"delete-invoice","summary":"Delete invoice"},"isWebhook":false,"hideReplay":false,"servers":[{"url":"/_mock/apis/platform/api","description":"Mock server","isMockServer":true},{"url":"https://api.vilna.io/v2","description":"Vilna API."}],"examples":[]}]}]},{"nodeType":"container","children":[{"nodeType":"header","level":4,"label":"Responses","labelTranslationKey":"responses","deepLinkSuffix":"responses"},{"nodeType":"item-content","variant":"responses","responses":[{"code":"204","description":"Successful operation with no response body."},{"code":"400","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Bad request (e.g., missing or invalid fields). Invalid text may be reported as address.label_invalid, address.meta_invalid, public_key.label_invalid, invoice.comment_invalid, invoice.metadata_invalid."},"children":[]}]}]}],"mediaType":"application/problem+json","mediaTypes":["application/problem+json"],"mediaTypeContent":{"application/problem+json":{"schemaId":"components/schemas/InvalidRequestProblem","exampleIds":["paths/~1invoices~1{invoice_id}/delete/responses/400/content/application~1problem+json/examples/malformed_json"]}},"schemaId":"components/schemas/InvalidRequestProblem","exampleIds":["paths/~1invoices~1{invoice_id}/delete/responses/400/content/application~1problem+json/examples/malformed_json"]},{"code":"401","description":"Missing or invalid authentication credentials.","mediaType":"application/problem+json","mediaTypes":["application/problem+json"],"mediaTypeContent":{"application/problem+json":{"schemaId":"components/schemas/UnauthorizedProblem","exampleIds":["paths/~1invoices~1{invoice_id}/delete/responses/401/content/application~1problem+json/examples/service_authentication_denied"]}},"schemaId":"components/schemas/UnauthorizedProblem","exampleIds":["paths/~1invoices~1{invoice_id}/delete/responses/401/content/application~1problem+json/examples/service_authentication_denied"]},{"code":"403","description":"Insufficient permissions.","mediaType":"application/problem+json","mediaTypes":["application/problem+json"],"mediaTypeContent":{"application/problem+json":{"schemaId":"components/schemas/ForbiddenProblem","exampleIds":["paths/~1invoices~1{invoice_id}/delete/responses/403/content/application~1problem+json/examples/insufficient_permissions"]}},"schemaId":"components/schemas/ForbiddenProblem","exampleIds":["paths/~1invoices~1{invoice_id}/delete/responses/403/content/application~1problem+json/examples/insufficient_permissions"]},{"code":"404","description":"Requested resource does not exist.","mediaType":"application/problem+json","mediaTypes":["application/problem+json"],"mediaTypeContent":{"application/problem+json":{"schemaId":"components/schemas/NotFoundProblem","exampleIds":["paths/~1invoices~1{invoice_id}/delete/responses/404/content/application~1problem+json/examples/address_not_found","paths/~1invoices~1{invoice_id}/delete/responses/404/content/application~1problem+json/examples/invoice_not_found"]}},"schemaId":"components/schemas/NotFoundProblem","exampleIds":["paths/~1invoices~1{invoice_id}/delete/responses/404/content/application~1problem+json/examples/address_not_found","paths/~1invoices~1{invoice_id}/delete/responses/404/content/application~1problem+json/examples/invoice_not_found"]},{"code":"409","description":"Request conflicts with the current resource state.","mediaType":"application/problem+json","mediaTypes":["application/problem+json"],"mediaTypeContent":{"application/problem+json":{"schemaId":"components/schemas/ConflictProblem","exampleIds":["paths/~1invoices~1{invoice_id}/delete/responses/409/content/application~1problem+json/examples/address_occupied","paths/~1invoices~1{invoice_id}/delete/responses/409/content/application~1problem+json/examples/address_in_use","paths/~1invoices~1{invoice_id}/delete/responses/409/content/application~1problem+json/examples/subscription_v1_conflict","paths/~1invoices~1{invoice_id}/delete/responses/409/content/application~1problem+json/examples/notification_send_in_progress","paths/~1invoices~1{invoice_id}/delete/responses/409/content/application~1problem+json/examples/notification_payload_unavailable","paths/~1invoices~1{invoice_id}/delete/responses/409/content/application~1problem+json/examples/notification_test_resend_not_allowed"]}},"schemaId":"components/schemas/ConflictProblem","exampleIds":["paths/~1invoices~1{invoice_id}/delete/responses/409/content/application~1problem+json/examples/address_occupied","paths/~1invoices~1{invoice_id}/delete/responses/409/content/application~1problem+json/examples/address_in_use","paths/~1invoices~1{invoice_id}/delete/responses/409/content/application~1problem+json/examples/subscription_v1_conflict","paths/~1invoices~1{invoice_id}/delete/responses/409/content/application~1problem+json/examples/notification_send_in_progress","paths/~1invoices~1{invoice_id}/delete/responses/409/content/application~1problem+json/examples/notification_payload_unavailable","paths/~1invoices~1{invoice_id}/delete/responses/409/content/application~1problem+json/examples/notification_test_resend_not_allowed"]},{"code":"422","description":"Request preconditions were not met.","mediaType":"application/problem+json","mediaTypes":["application/problem+json"],"mediaTypeContent":{"application/problem+json":{"schemaId":"components/schemas/PreconditionProblem","exampleIds":["paths/~1invoices~1{invoice_id}/delete/responses/422/content/application~1problem+json/examples/invoice_not_cancellable"]}},"schemaId":"components/schemas/PreconditionProblem","exampleIds":["paths/~1invoices~1{invoice_id}/delete/responses/422/content/application~1problem+json/examples/invoice_not_cancellable"]},{"code":"503","description":"The operation is temporarily unavailable. Please try again later.","mediaType":"application/problem+json","mediaTypes":["application/problem+json"],"mediaTypeContent":{"application/problem+json":{"schemaId":"components/schemas/Problem","exampleIds":["paths/~1invoices~1{invoice_id}/delete/responses/503/content/application~1problem+json/examples/temporarily_unavailable"]}},"schemaId":"components/schemas/Problem","exampleIds":["paths/~1invoices~1{invoice_id}/delete/responses/503/content/application~1problem+json/examples/temporarily_unavailable"]},{"code":"default","description":"Unexpected error.","mediaType":"application/problem+json","mediaTypes":["application/problem+json"],"mediaTypeContent":{"application/problem+json":{"schemaId":"components/schemas/Problem"}},"schemaId":"components/schemas/Problem"}],"pointer":"/paths/~1invoices~1{invoice_id}/delete/responses"}],"panels":[{"children":[{"kind":"response","responseCodes":[{"code":"204"},{"code":"400","schemaId":"components/schemas/InvalidRequestProblem","exampleIds":["paths/~1invoices~1{invoice_id}/delete/responses/400/content/application~1problem+json/examples/malformed_json"],"mediaTypes":["application/problem+json"],"mediaTypeContent":{"application/problem+json":{"schemaId":"components/schemas/InvalidRequestProblem","exampleIds":["paths/~1invoices~1{invoice_id}/delete/responses/400/content/application~1problem+json/examples/malformed_json"]}}},{"code":"401","schemaId":"components/schemas/UnauthorizedProblem","exampleIds":["paths/~1invoices~1{invoice_id}/delete/responses/401/content/application~1problem+json/examples/service_authentication_denied"],"mediaTypes":["application/problem+json"],"mediaTypeContent":{"application/problem+json":{"schemaId":"components/schemas/UnauthorizedProblem","exampleIds":["paths/~1invoices~1{invoice_id}/delete/responses/401/content/application~1problem+json/examples/service_authentication_denied"]}}},{"code":"403","schemaId":"components/schemas/ForbiddenProblem","exampleIds":["paths/~1invoices~1{invoice_id}/delete/responses/403/content/application~1problem+json/examples/insufficient_permissions"],"mediaTypes":["application/problem+json"],"mediaTypeContent":{"application/problem+json":{"schemaId":"components/schemas/ForbiddenProblem","exampleIds":["paths/~1invoices~1{invoice_id}/delete/responses/403/content/application~1problem+json/examples/insufficient_permissions"]}}},{"code":"404","schemaId":"components/schemas/NotFoundProblem","exampleIds":["paths/~1invoices~1{invoice_id}/delete/responses/404/content/application~1problem+json/examples/address_not_found","paths/~1invoices~1{invoice_id}/delete/responses/404/content/application~1problem+json/examples/invoice_not_found"],"mediaTypes":["application/problem+json"],"mediaTypeContent":{"application/problem+json":{"schemaId":"components/schemas/NotFoundProblem","exampleIds":["paths/~1invoices~1{invoice_id}/delete/responses/404/content/application~1problem+json/examples/address_not_found","paths/~1invoices~1{invoice_id}/delete/responses/404/content/application~1problem+json/examples/invoice_not_found"]}}},{"code":"409","schemaId":"components/schemas/ConflictProblem","exampleIds":["paths/~1invoices~1{invoice_id}/delete/responses/409/content/application~1problem+json/examples/address_occupied","paths/~1invoices~1{invoice_id}/delete/responses/409/content/application~1problem+json/examples/address_in_use","paths/~1invoices~1{invoice_id}/delete/responses/409/content/application~1problem+json/examples/subscription_v1_conflict","paths/~1invoices~1{invoice_id}/delete/responses/409/content/application~1problem+json/examples/notification_send_in_progress","paths/~1invoices~1{invoice_id}/delete/responses/409/content/application~1problem+json/examples/notification_payload_unavailable","paths/~1invoices~1{invoice_id}/delete/responses/409/content/application~1problem+json/examples/notification_test_resend_not_allowed"],"mediaTypes":["application/problem+json"],"mediaTypeContent":{"application/problem+json":{"schemaId":"components/schemas/ConflictProblem","exampleIds":["paths/~1invoices~1{invoice_id}/delete/responses/409/content/application~1problem+json/examples/address_occupied","paths/~1invoices~1{invoice_id}/delete/responses/409/content/application~1problem+json/examples/address_in_use","paths/~1invoices~1{invoice_id}/delete/responses/409/content/application~1problem+json/examples/subscription_v1_conflict","paths/~1invoices~1{invoice_id}/delete/responses/409/content/application~1problem+json/examples/notification_send_in_progress","paths/~1invoices~1{invoice_id}/delete/responses/409/content/application~1problem+json/examples/notification_payload_unavailable","paths/~1invoices~1{invoice_id}/delete/responses/409/content/application~1problem+json/examples/notification_test_resend_not_allowed"]}}},{"code":"422","schemaId":"components/schemas/PreconditionProblem","exampleIds":["paths/~1invoices~1{invoice_id}/delete/responses/422/content/application~1problem+json/examples/invoice_not_cancellable"],"mediaTypes":["application/problem+json"],"mediaTypeContent":{"application/problem+json":{"schemaId":"components/schemas/PreconditionProblem","exampleIds":["paths/~1invoices~1{invoice_id}/delete/responses/422/content/application~1problem+json/examples/invoice_not_cancellable"]}}},{"code":"503","schemaId":"components/schemas/Problem","exampleIds":["paths/~1invoices~1{invoice_id}/delete/responses/503/content/application~1problem+json/examples/temporarily_unavailable"],"mediaTypes":["application/problem+json"],"mediaTypeContent":{"application/problem+json":{"schemaId":"components/schemas/Problem","exampleIds":["paths/~1invoices~1{invoice_id}/delete/responses/503/content/application~1problem+json/examples/temporarily_unavailable"]}}},{"code":"default","schemaId":"components/schemas/Problem","mediaTypes":["application/problem+json"],"mediaTypeContent":{"application/problem+json":{"schemaId":"components/schemas/Problem"}}}],"examples":[]}]}]},{"nodeType":"container","children":[{"nodeType":"feedback","pageSlug":"/invoice/delete-invoice"}],"panels":[]}]},"httpPath":"/invoices/{invoice_id}"},{"label":"Cancel invoice","deprecated":false,"httpVerb":"post","isAdditionalOperation":false,"isWebhook":false,"type":"link","link":"/apis/platform/api/invoice/cancel-invoice","routeSlug":"/apis/platform/api/invoice/cancel-invoice","metadata":{"seo":{"title":"Cancel invoice","description":"Cancel an open or processing invoice when no recorded valid payment isunconfirmed and confirmed_amount is less than amount. This includes unpaidinvoices and invoices with fully confirmed partial payments. The same rules applyafter the payment window ends.Cancellation refused under these rules returns 422."}},"content":{"contentType":"item","itemVariant":"httpItem","meta":{"sourceId":"cancel-invoice","name":"Cancel invoice","isWebhook":false,"pointer":"/paths/~1invoices~1{invoice_id}~1actions~1cancel/post","hasSamples":true},"children":[{"nodeType":"container","children":[{"nodeType":"header","level":2,"label":"Cancel invoice","isWebhook":false,"showPageActions":true}],"panels":[]},{"nodeType":"container","children":[{"nodeType":"header","level":4,"label":"Request","labelTranslationKey":"request","deepLinkSuffix":"request"},{"nodeType":"markdoc","content":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Cancel an "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"open"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" or "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"processing"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" invoice when no recorded valid payment is"},"children":[]},{"$$mdtype":"Node","type":"softbreak","inline":true,"attributes":{},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"unconfirmed and "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"confirmed_amount"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" is less than "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"amount"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":". This includes unpaid"},"children":[]},{"$$mdtype":"Node","type":"softbreak","inline":true,"attributes":{},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"invoices and invoices with fully confirmed partial payments. The same rules apply"},"children":[]},{"$$mdtype":"Node","type":"softbreak","inline":true,"attributes":{},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"after the payment window ends."},"children":[]},{"$$mdtype":"Node","type":"softbreak","inline":true,"attributes":{},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Cancellation refused under these rules returns 422."},"children":[]}]}]},{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"After cancellation, no new payments are associated with the invoice, including payments"},"children":[]},{"$$mdtype":"Node","type":"softbreak","inline":true,"attributes":{},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"discovered later whose block time falls within its former payment window. Existing"},"children":[]},{"$$mdtype":"Node","type":"softbreak","inline":true,"attributes":{},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"payment associations remain. Updates to those payments, including blockchain"},"children":[]},{"$$mdtype":"Node","type":"softbreak","inline":true,"attributes":{},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"reorganizations, can change "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"received_amount"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" and "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"confirmed_amount"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"; the status"},"children":[]},{"$$mdtype":"Node","type":"softbreak","inline":true,"attributes":{},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"remains "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"cancelled"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":". The address can be used for a new invoice, subject to the usual"},"children":[]},{"$$mdtype":"Node","type":"softbreak","inline":true,"attributes":{},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"creation requirements. Payments are not transferred to the new invoice, and cancellation"},"children":[]},{"$$mdtype":"Node","type":"softbreak","inline":true,"attributes":{},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"does not refund them."},"children":[]}]}]},{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"The operation is idempotent: cancelling an already-cancelled invoice returns 204."},"children":[]}]}]}]},{"nodeType":"security","requirements":[{"schemes":[{"name":"Auth","scopes":["api:invoice:write"],"type":"apiKey","in":"header","paramName":"X-Api-Key","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"API key for authenticating requests. Include your key in the "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"X-Api-Key"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" header. Keys can be created in the Vilna Dashboard or via the Management API. The scopes listed per operation indicate which permissions the key must have."},"children":[]}]}]}]}]}]},{"nodeType":"item-content","variant":"path","label":"Path","labelTranslationKey":"path","parameters":[{"name":"invoice_id","in":"path","schemaId":"schema_17","description":"Unique identifier (UUID) of the invoice.","required":true}],"pointer":"/paths/~1invoices~1{invoice_id}~1actions~1cancel/post/parameters"},{"nodeType":"item-content","variant":"headers","label":"Headers","labelTranslationKey":"header","parameters":[{"name":"Idempotency-Key","in":"header","schemaId":"schema_14","description":"Case-sensitive opaque key for one mutation intent. Send exactly one header occurrence containing 1 to 128 visible ASCII bytes (0x21..0x7e). Commas are literal data; do not trim, lowercase or require UUID syntax. Reuse the same key for retries, with current authorization checked on every attempt. Repeated header occurrences are rejected.\n","required":true}],"pointer":"/paths/~1invoices~1{invoice_id}~1actions~1cancel/post/parameters"},{"nodeType":"item-content","variant":"body","label":"Request Body","labelTranslationKey":"body","required":false,"mediaTypes":["application/json"],"mediaTypeSchemas":{"application/json":{"schemaId":"components/schemas/CancelInvoiceRequest","exampleIds":["paths/~1invoices~1{invoice_id}~1actions~1cancel/post/requestBody/content/application~1json/examples/with_comment","paths/~1invoices~1{invoice_id}~1actions~1cancel/post/requestBody/content/application~1json/examples/without_comment"]}},"schemaId":"components/schemas/CancelInvoiceRequest","exampleIds":["paths/~1invoices~1{invoice_id}~1actions~1cancel/post/requestBody/content/application~1json/examples/with_comment","paths/~1invoices~1{invoice_id}~1actions~1cancel/post/requestBody/content/application~1json/examples/without_comment"],"pointer":"/paths/~1invoices~1{invoice_id}~1actions~1cancel/post/requestBody","description":"Optional cancellation details."}],"panels":[{"children":[{"kind":"code-sample","source":{"kind":"code-sample","operationType":"http","method":"POST","path":"/invoices/{invoice_id}/actions/cancel","servers":[{"url":"/_mock/apis/platform/api","description":"Mock server","isMockServer":true},{"url":"https://api.vilna.io/v2","description":"Vilna API."}],"parameters":{"path":[{"name":"invoice_id","in":"path","required":true,"example":"550e8400-e29b-41d4-a716-446655440000","schemaId":"components/schemas/UUID"}],"query":[],"querystring":[],"header":[{"name":"Idempotency-Key","in":"header","required":true,"schemaId":"schema_14"}],"cookie":[]},"security":[{"schemes":[{"id":"Auth","type":"apiKey","name":"X-Api-Key","in":"header"}],"scopes":["api:invoice:write"]}],"requestBody":{"application/json":{"schemaId":"components/schemas/CancelInvoiceRequest","exampleIds":["paths/~1invoices~1{invoice_id}~1actions~1cancel/post/requestBody/content/application~1json/examples/with_comment","paths/~1invoices~1{invoice_id}~1actions~1cancel/post/requestBody/content/application~1json/examples/without_comment"]}},"responseCodes":["204","400","401","403","404","409","422","503","default"],"pointer":"/invoices/{invoice_id}/actions/cancel","href":"invoice/cancel-invoice","openApiOperationId":"cancel-invoice","summary":"Cancel invoice"},"isWebhook":false,"hideReplay":false,"servers":[{"url":"/_mock/apis/platform/api","description":"Mock server","isMockServer":true},{"url":"https://api.vilna.io/v2","description":"Vilna API."}],"schemaId":"components/schemas/CancelInvoiceRequest","exampleIds":["paths/~1invoices~1{invoice_id}~1actions~1cancel/post/requestBody/content/application~1json/examples/with_comment","paths/~1invoices~1{invoice_id}~1actions~1cancel/post/requestBody/content/application~1json/examples/without_comment"],"mediaTypes":["application/json"],"mediaTypeSchemas":{"application/json":{"schemaId":"components/schemas/CancelInvoiceRequest","exampleIds":["paths/~1invoices~1{invoice_id}~1actions~1cancel/post/requestBody/content/application~1json/examples/with_comment","paths/~1invoices~1{invoice_id}~1actions~1cancel/post/requestBody/content/application~1json/examples/without_comment"]}},"examples":[{},{}]}]}]},{"nodeType":"container","children":[{"nodeType":"header","level":4,"label":"Responses","labelTranslationKey":"responses","deepLinkSuffix":"responses"},{"nodeType":"item-content","variant":"responses","responses":[{"code":"204","description":"Successful operation with no response body."},{"code":"400","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Bad request (e.g., missing or invalid fields). Invalid text may be reported as address.label_invalid, address.meta_invalid, public_key.label_invalid, invoice.comment_invalid, invoice.metadata_invalid."},"children":[]}]}]}],"mediaType":"application/problem+json","mediaTypes":["application/problem+json"],"mediaTypeContent":{"application/problem+json":{"schemaId":"components/schemas/InvalidRequestProblem","exampleIds":["paths/~1invoices~1{invoice_id}~1actions~1cancel/post/responses/400/content/application~1problem+json/examples/malformed_json"]}},"schemaId":"components/schemas/InvalidRequestProblem","exampleIds":["paths/~1invoices~1{invoice_id}~1actions~1cancel/post/responses/400/content/application~1problem+json/examples/malformed_json"]},{"code":"401","description":"Missing or invalid authentication credentials.","mediaType":"application/problem+json","mediaTypes":["application/problem+json"],"mediaTypeContent":{"application/problem+json":{"schemaId":"components/schemas/UnauthorizedProblem","exampleIds":["paths/~1invoices~1{invoice_id}~1actions~1cancel/post/responses/401/content/application~1problem+json/examples/service_authentication_denied"]}},"schemaId":"components/schemas/UnauthorizedProblem","exampleIds":["paths/~1invoices~1{invoice_id}~1actions~1cancel/post/responses/401/content/application~1problem+json/examples/service_authentication_denied"]},{"code":"403","description":"Insufficient permissions.","mediaType":"application/problem+json","mediaTypes":["application/problem+json"],"mediaTypeContent":{"application/problem+json":{"schemaId":"components/schemas/ForbiddenProblem","exampleIds":["paths/~1invoices~1{invoice_id}~1actions~1cancel/post/responses/403/content/application~1problem+json/examples/insufficient_permissions"]}},"schemaId":"components/schemas/ForbiddenProblem","exampleIds":["paths/~1invoices~1{invoice_id}~1actions~1cancel/post/responses/403/content/application~1problem+json/examples/insufficient_permissions"]},{"code":"404","description":"Requested resource does not exist.","mediaType":"application/problem+json","mediaTypes":["application/problem+json"],"mediaTypeContent":{"application/problem+json":{"schemaId":"components/schemas/NotFoundProblem","exampleIds":["paths/~1invoices~1{invoice_id}~1actions~1cancel/post/responses/404/content/application~1problem+json/examples/address_not_found","paths/~1invoices~1{invoice_id}~1actions~1cancel/post/responses/404/content/application~1problem+json/examples/invoice_not_found"]}},"schemaId":"components/schemas/NotFoundProblem","exampleIds":["paths/~1invoices~1{invoice_id}~1actions~1cancel/post/responses/404/content/application~1problem+json/examples/address_not_found","paths/~1invoices~1{invoice_id}~1actions~1cancel/post/responses/404/content/application~1problem+json/examples/invoice_not_found"]},{"code":"409","description":"Request conflicts with the current resource state.","mediaType":"application/problem+json","mediaTypes":["application/problem+json"],"mediaTypeContent":{"application/problem+json":{"schemaId":"components/schemas/ConflictProblem","exampleIds":["paths/~1invoices~1{invoice_id}~1actions~1cancel/post/responses/409/content/application~1problem+json/examples/address_occupied","paths/~1invoices~1{invoice_id}~1actions~1cancel/post/responses/409/content/application~1problem+json/examples/address_in_use","paths/~1invoices~1{invoice_id}~1actions~1cancel/post/responses/409/content/application~1problem+json/examples/subscription_v1_conflict","paths/~1invoices~1{invoice_id}~1actions~1cancel/post/responses/409/content/application~1problem+json/examples/notification_send_in_progress","paths/~1invoices~1{invoice_id}~1actions~1cancel/post/responses/409/content/application~1problem+json/examples/notification_payload_unavailable","paths/~1invoices~1{invoice_id}~1actions~1cancel/post/responses/409/content/application~1problem+json/examples/notification_test_resend_not_allowed"]}},"schemaId":"components/schemas/ConflictProblem","exampleIds":["paths/~1invoices~1{invoice_id}~1actions~1cancel/post/responses/409/content/application~1problem+json/examples/address_occupied","paths/~1invoices~1{invoice_id}~1actions~1cancel/post/responses/409/content/application~1problem+json/examples/address_in_use","paths/~1invoices~1{invoice_id}~1actions~1cancel/post/responses/409/content/application~1problem+json/examples/subscription_v1_conflict","paths/~1invoices~1{invoice_id}~1actions~1cancel/post/responses/409/content/application~1problem+json/examples/notification_send_in_progress","paths/~1invoices~1{invoice_id}~1actions~1cancel/post/responses/409/content/application~1problem+json/examples/notification_payload_unavailable","paths/~1invoices~1{invoice_id}~1actions~1cancel/post/responses/409/content/application~1problem+json/examples/notification_test_resend_not_allowed"]},{"code":"422","description":"Request preconditions were not met.","mediaType":"application/problem+json","mediaTypes":["application/problem+json"],"mediaTypeContent":{"application/problem+json":{"schemaId":"components/schemas/PreconditionProblem","exampleIds":["paths/~1invoices~1{invoice_id}~1actions~1cancel/post/responses/422/content/application~1problem+json/examples/invoice_not_cancellable"]}},"schemaId":"components/schemas/PreconditionProblem","exampleIds":["paths/~1invoices~1{invoice_id}~1actions~1cancel/post/responses/422/content/application~1problem+json/examples/invoice_not_cancellable"]},{"code":"503","description":"The operation is temporarily unavailable. Please try again later.","mediaType":"application/problem+json","mediaTypes":["application/problem+json"],"mediaTypeContent":{"application/problem+json":{"schemaId":"components/schemas/Problem","exampleIds":["paths/~1invoices~1{invoice_id}~1actions~1cancel/post/responses/503/content/application~1problem+json/examples/temporarily_unavailable"]}},"schemaId":"components/schemas/Problem","exampleIds":["paths/~1invoices~1{invoice_id}~1actions~1cancel/post/responses/503/content/application~1problem+json/examples/temporarily_unavailable"]},{"code":"default","description":"Unexpected error.","mediaType":"application/problem+json","mediaTypes":["application/problem+json"],"mediaTypeContent":{"application/problem+json":{"schemaId":"components/schemas/Problem"}},"schemaId":"components/schemas/Problem"}],"pointer":"/paths/~1invoices~1{invoice_id}~1actions~1cancel/post/responses"}],"panels":[{"children":[{"kind":"response","responseCodes":[{"code":"204"},{"code":"400","schemaId":"components/schemas/InvalidRequestProblem","exampleIds":["paths/~1invoices~1{invoice_id}~1actions~1cancel/post/responses/400/content/application~1problem+json/examples/malformed_json"],"mediaTypes":["application/problem+json"],"mediaTypeContent":{"application/problem+json":{"schemaId":"components/schemas/InvalidRequestProblem","exampleIds":["paths/~1invoices~1{invoice_id}~1actions~1cancel/post/responses/400/content/application~1problem+json/examples/malformed_json"]}}},{"code":"401","schemaId":"components/schemas/UnauthorizedProblem","exampleIds":["paths/~1invoices~1{invoice_id}~1actions~1cancel/post/responses/401/content/application~1problem+json/examples/service_authentication_denied"],"mediaTypes":["application/problem+json"],"mediaTypeContent":{"application/problem+json":{"schemaId":"components/schemas/UnauthorizedProblem","exampleIds":["paths/~1invoices~1{invoice_id}~1actions~1cancel/post/responses/401/content/application~1problem+json/examples/service_authentication_denied"]}}},{"code":"403","schemaId":"components/schemas/ForbiddenProblem","exampleIds":["paths/~1invoices~1{invoice_id}~1actions~1cancel/post/responses/403/content/application~1problem+json/examples/insufficient_permissions"],"mediaTypes":["application/problem+json"],"mediaTypeContent":{"application/problem+json":{"schemaId":"components/schemas/ForbiddenProblem","exampleIds":["paths/~1invoices~1{invoice_id}~1actions~1cancel/post/responses/403/content/application~1problem+json/examples/insufficient_permissions"]}}},{"code":"404","schemaId":"components/schemas/NotFoundProblem","exampleIds":["paths/~1invoices~1{invoice_id}~1actions~1cancel/post/responses/404/content/application~1problem+json/examples/address_not_found","paths/~1invoices~1{invoice_id}~1actions~1cancel/post/responses/404/content/application~1problem+json/examples/invoice_not_found"],"mediaTypes":["application/problem+json"],"mediaTypeContent":{"application/problem+json":{"schemaId":"components/schemas/NotFoundProblem","exampleIds":["paths/~1invoices~1{invoice_id}~1actions~1cancel/post/responses/404/content/application~1problem+json/examples/address_not_found","paths/~1invoices~1{invoice_id}~1actions~1cancel/post/responses/404/content/application~1problem+json/examples/invoice_not_found"]}}},{"code":"409","schemaId":"components/schemas/ConflictProblem","exampleIds":["paths/~1invoices~1{invoice_id}~1actions~1cancel/post/responses/409/content/application~1problem+json/examples/address_occupied","paths/~1invoices~1{invoice_id}~1actions~1cancel/post/responses/409/content/application~1problem+json/examples/address_in_use","paths/~1invoices~1{invoice_id}~1actions~1cancel/post/responses/409/content/application~1problem+json/examples/subscription_v1_conflict","paths/~1invoices~1{invoice_id}~1actions~1cancel/post/responses/409/content/application~1problem+json/examples/notification_send_in_progress","paths/~1invoices~1{invoice_id}~1actions~1cancel/post/responses/409/content/application~1problem+json/examples/notification_payload_unavailable","paths/~1invoices~1{invoice_id}~1actions~1cancel/post/responses/409/content/application~1problem+json/examples/notification_test_resend_not_allowed"],"mediaTypes":["application/problem+json"],"mediaTypeContent":{"application/problem+json":{"schemaId":"components/schemas/ConflictProblem","exampleIds":["paths/~1invoices~1{invoice_id}~1actions~1cancel/post/responses/409/content/application~1problem+json/examples/address_occupied","paths/~1invoices~1{invoice_id}~1actions~1cancel/post/responses/409/content/application~1problem+json/examples/address_in_use","paths/~1invoices~1{invoice_id}~1actions~1cancel/post/responses/409/content/application~1problem+json/examples/subscription_v1_conflict","paths/~1invoices~1{invoice_id}~1actions~1cancel/post/responses/409/content/application~1problem+json/examples/notification_send_in_progress","paths/~1invoices~1{invoice_id}~1actions~1cancel/post/responses/409/content/application~1problem+json/examples/notification_payload_unavailable","paths/~1invoices~1{invoice_id}~1actions~1cancel/post/responses/409/content/application~1problem+json/examples/notification_test_resend_not_allowed"]}}},{"code":"422","schemaId":"components/schemas/PreconditionProblem","exampleIds":["paths/~1invoices~1{invoice_id}~1actions~1cancel/post/responses/422/content/application~1problem+json/examples/invoice_not_cancellable"],"mediaTypes":["application/problem+json"],"mediaTypeContent":{"application/problem+json":{"schemaId":"components/schemas/PreconditionProblem","exampleIds":["paths/~1invoices~1{invoice_id}~1actions~1cancel/post/responses/422/content/application~1problem+json/examples/invoice_not_cancellable"]}}},{"code":"503","schemaId":"components/schemas/Problem","exampleIds":["paths/~1invoices~1{invoice_id}~1actions~1cancel/post/responses/503/content/application~1problem+json/examples/temporarily_unavailable"],"mediaTypes":["application/problem+json"],"mediaTypeContent":{"application/problem+json":{"schemaId":"components/schemas/Problem","exampleIds":["paths/~1invoices~1{invoice_id}~1actions~1cancel/post/responses/503/content/application~1problem+json/examples/temporarily_unavailable"]}}},{"code":"default","schemaId":"components/schemas/Problem","mediaTypes":["application/problem+json"],"mediaTypeContent":{"application/problem+json":{"schemaId":"components/schemas/Problem"}}}],"examples":[]}]}]},{"nodeType":"container","children":[{"nodeType":"feedback","pageSlug":"/invoice/cancel-invoice"}],"panels":[]}]},"httpPath":"/invoices/{invoice_id}/actions/cancel"},{"label":"Get public invoice","deprecated":false,"httpVerb":"get","isAdditionalOperation":false,"isWebhook":false,"type":"link","link":"/apis/platform/api/invoice/get-public-invoice","routeSlug":"/apis/platform/api/invoice/get-public-invoice","metadata":{"seo":{"title":"Get public invoice","description":"Public endpoint for payers. Returns invoice details needed for payment. No authentication required: the invoice UUID is the access token."}},"content":{"contentType":"item","itemVariant":"httpItem","meta":{"sourceId":"get-public-invoice","name":"Get public invoice","isWebhook":false,"pointer":"/paths/~1public~1invoices~1{invoice_id}/get","hasSamples":false},"children":[{"nodeType":"container","children":[{"nodeType":"header","level":2,"label":"Get public invoice","isWebhook":false,"showPageActions":true}],"panels":[]},{"nodeType":"container","children":[{"nodeType":"header","level":4,"label":"Request","labelTranslationKey":"request","deepLinkSuffix":"request"},{"nodeType":"markdoc","content":"Public endpoint for payers. Returns invoice details needed for payment.\nNo authentication required: the invoice UUID is the access token.\n"},{"nodeType":"item-content","variant":"path","label":"Path","labelTranslationKey":"path","parameters":[{"name":"invoice_id","in":"path","schemaId":"schema_17","description":"Unique identifier (UUID) of the invoice.","required":true}],"pointer":"/paths/~1public~1invoices~1{invoice_id}/get/parameters"}],"panels":[{"children":[{"kind":"code-sample","source":{"kind":"code-sample","operationType":"http","method":"GET","path":"/public/invoices/{invoice_id}","servers":[{"url":"/_mock/apis/platform/api","description":"Mock server","isMockServer":true},{"url":"https://api.vilna.io/v2","description":"Vilna API."}],"parameters":{"path":[{"name":"invoice_id","in":"path","required":true,"example":"550e8400-e29b-41d4-a716-446655440000","schemaId":"components/schemas/UUID"}],"query":[],"querystring":[],"header":[],"cookie":[]},"security":[],"responseCodes":["200","400","404","503","default"],"pointer":"/public/invoices/{invoice_id}","href":"invoice/get-public-invoice","openApiOperationId":"get-public-invoice","summary":"Get public invoice"},"isWebhook":false,"hideReplay":false,"servers":[{"url":"/_mock/apis/platform/api","description":"Mock server","isMockServer":true},{"url":"https://api.vilna.io/v2","description":"Vilna API."}],"examples":[]}]}]},{"nodeType":"container","children":[{"nodeType":"header","level":4,"label":"Responses","labelTranslationKey":"responses","deepLinkSuffix":"responses"},{"nodeType":"item-content","variant":"responses","responses":[{"code":"200","description":"Public invoice details for payers.","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"schema_50"}},"schemaId":"schema_50"},{"code":"400","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Bad request (e.g., missing or invalid fields). Invalid text may be reported as address.label_invalid, address.meta_invalid, public_key.label_invalid, invoice.comment_invalid, invoice.metadata_invalid."},"children":[]}]}]}],"mediaType":"application/problem+json","mediaTypes":["application/problem+json"],"mediaTypeContent":{"application/problem+json":{"schemaId":"components/schemas/InvalidRequestProblem","exampleIds":["paths/~1public~1invoices~1{invoice_id}/get/responses/400/content/application~1problem+json/examples/malformed_json"]}},"schemaId":"components/schemas/InvalidRequestProblem","exampleIds":["paths/~1public~1invoices~1{invoice_id}/get/responses/400/content/application~1problem+json/examples/malformed_json"]},{"code":"404","description":"Requested resource does not exist.","mediaType":"application/problem+json","mediaTypes":["application/problem+json"],"mediaTypeContent":{"application/problem+json":{"schemaId":"components/schemas/NotFoundProblem","exampleIds":["paths/~1public~1invoices~1{invoice_id}/get/responses/404/content/application~1problem+json/examples/address_not_found","paths/~1public~1invoices~1{invoice_id}/get/responses/404/content/application~1problem+json/examples/invoice_not_found"]}},"schemaId":"components/schemas/NotFoundProblem","exampleIds":["paths/~1public~1invoices~1{invoice_id}/get/responses/404/content/application~1problem+json/examples/address_not_found","paths/~1public~1invoices~1{invoice_id}/get/responses/404/content/application~1problem+json/examples/invoice_not_found"]},{"code":"503","description":"The operation is temporarily unavailable. Please try again later.","mediaType":"application/problem+json","mediaTypes":["application/problem+json"],"mediaTypeContent":{"application/problem+json":{"schemaId":"components/schemas/Problem","exampleIds":["paths/~1public~1invoices~1{invoice_id}/get/responses/503/content/application~1problem+json/examples/temporarily_unavailable"]}},"schemaId":"components/schemas/Problem","exampleIds":["paths/~1public~1invoices~1{invoice_id}/get/responses/503/content/application~1problem+json/examples/temporarily_unavailable"]},{"code":"default","description":"Unexpected error.","mediaType":"application/problem+json","mediaTypes":["application/problem+json"],"mediaTypeContent":{"application/problem+json":{"schemaId":"components/schemas/Problem"}},"schemaId":"components/schemas/Problem"}],"pointer":"/paths/~1public~1invoices~1{invoice_id}/get/responses"}],"panels":[{"children":[{"kind":"response","responseCodes":[{"code":"200","schemaId":"schema_50","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"schema_50"}}},{"code":"400","schemaId":"components/schemas/InvalidRequestProblem","exampleIds":["paths/~1public~1invoices~1{invoice_id}/get/responses/400/content/application~1problem+json/examples/malformed_json"],"mediaTypes":["application/problem+json"],"mediaTypeContent":{"application/problem+json":{"schemaId":"components/schemas/InvalidRequestProblem","exampleIds":["paths/~1public~1invoices~1{invoice_id}/get/responses/400/content/application~1problem+json/examples/malformed_json"]}}},{"code":"404","schemaId":"components/schemas/NotFoundProblem","exampleIds":["paths/~1public~1invoices~1{invoice_id}/get/responses/404/content/application~1problem+json/examples/address_not_found","paths/~1public~1invoices~1{invoice_id}/get/responses/404/content/application~1problem+json/examples/invoice_not_found"],"mediaTypes":["application/problem+json"],"mediaTypeContent":{"application/problem+json":{"schemaId":"components/schemas/NotFoundProblem","exampleIds":["paths/~1public~1invoices~1{invoice_id}/get/responses/404/content/application~1problem+json/examples/address_not_found","paths/~1public~1invoices~1{invoice_id}/get/responses/404/content/application~1problem+json/examples/invoice_not_found"]}}},{"code":"503","schemaId":"components/schemas/Problem","exampleIds":["paths/~1public~1invoices~1{invoice_id}/get/responses/503/content/application~1problem+json/examples/temporarily_unavailable"],"mediaTypes":["application/problem+json"],"mediaTypeContent":{"application/problem+json":{"schemaId":"components/schemas/Problem","exampleIds":["paths/~1public~1invoices~1{invoice_id}/get/responses/503/content/application~1problem+json/examples/temporarily_unavailable"]}}},{"code":"default","schemaId":"components/schemas/Problem","mediaTypes":["application/problem+json"],"mediaTypeContent":{"application/problem+json":{"schemaId":"components/schemas/Problem"}}}],"examples":[]}]}]},{"nodeType":"container","children":[{"nodeType":"feedback","pageSlug":"/invoice/get-public-invoice"}],"panels":[]}]},"httpPath":"/public/invoices/{invoice_id}"}],"content":{"contentType":"group","meta":{"name":"invoice"},"children":[{"nodeType":"container","children":[{"nodeType":"header","level":2,"label":"Invoices","showPageActions":true},{"nodeType":"markdoc","content":"Create and track crypto payment invoices."}],"panels":[{"children":[{"kind":"group-items","title":"Operations","titleTranslationKey":"operations","items":[{"title":"/invoices","summary":"List invoices","prefix":{"name":"get","color":"get"},"badges":[],"link":"/invoice/list-invoices","deprecated":false},{"title":"/invoices","summary":"Create invoice","prefix":{"name":"post","color":"post"},"badges":[],"link":"/invoice/create-invoice","deprecated":false},{"title":"/invoices/{invoice_id}","summary":"Get invoice","prefix":{"name":"get","color":"get"},"badges":[],"link":"/invoice/get-invoice","deprecated":false},{"title":"/invoices/{invoice_id}","summary":"Delete invoice","prefix":{"name":"delete","color":"delete"},"badges":[],"link":"/invoice/delete-invoice","deprecated":false},{"title":"/invoices/{invoice_id}/actions/cancel","summary":"Cancel invoice","prefix":{"name":"post","color":"post"},"badges":[],"link":"/invoice/cancel-invoice","deprecated":false},{"title":"/public/invoices/{invoice_id}","summary":"Get public invoice","prefix":{"name":"get","color":"get"},"badges":[],"link":"/invoice/get-public-invoice","deprecated":false}]}]}]}]}},{"type":"separator","label":"Monitoring","content":null},{"type":"group","label":"Notification Channels","link":"/apis/platform/api/channel","routeSlug":"/apis/platform/api/channel","items":[{"label":"List channels","deprecated":false,"httpVerb":"get","isAdditionalOperation":false,"isWebhook":false,"type":"link","link":"/apis/platform/api/channel/list-channels","routeSlug":"/apis/platform/api/channel/list-channels","metadata":{"seo":{"title":"List channels","description":"List channels with filtering and pagination."}},"content":{"contentType":"item","itemVariant":"httpItem","meta":{"sourceId":"list-channels","name":"List channels","isWebhook":false,"pointer":"/paths/~1channels/get","hasSamples":false},"children":[{"nodeType":"container","children":[{"nodeType":"header","level":2,"label":"List channels","isWebhook":false,"showPageActions":true}],"panels":[]},{"nodeType":"container","children":[{"nodeType":"header","level":4,"label":"Request","labelTranslationKey":"request","deepLinkSuffix":"request"},{"nodeType":"markdoc","content":"List channels with filtering and pagination."},{"nodeType":"security","requirements":[{"schemes":[{"name":"Auth","scopes":["api:channel:read"],"type":"apiKey","in":"header","paramName":"X-Api-Key","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"API key for authenticating requests. Include your key in the "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"X-Api-Key"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" header. Keys can be created in the Vilna Dashboard or via the Management API. The scopes listed per operation indicate which permissions the key must have."},"children":[]}]}]}]}]}]},{"nodeType":"item-content","variant":"query","label":"Query","labelTranslationKey":"query","parameters":[{"name":"limit","in":"query","schemaId":"schema_0","description":"Maximum number of items to return."},{"name":"page","in":"query","schemaId":"schema_1","description":"Page number for pagination."},{"name":"kind","in":"query","schemaId":"schema_51","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Filter by delivery type ("},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"telegram"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" or "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"webhook"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":")."},"children":[]}]}]}],"example":"webhook"},{"name":"search","in":"query","schemaId":"schema_33","description":"Filter channels by name (partial match, case-insensitive).","example":"production"},{"name":"is_enabled","in":"query","schemaId":"schema_41","description":"Filter channels by whether they currently deliver notifications.","example":true},{"name":"sort_by","in":"query","schemaId":"schema_52","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Field to sort results by. Use "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"-"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" prefix for descending order."},"children":[]}]}]}]}],"pointer":"/paths/~1channels/get/parameters"}],"panels":[{"children":[{"kind":"code-sample","source":{"kind":"code-sample","operationType":"http","method":"GET","path":"/channels","servers":[{"url":"/_mock/apis/platform/api","description":"Mock server","isMockServer":true},{"url":"https://api.vilna.io/v2","description":"Vilna API."}],"parameters":{"path":[],"query":[{"name":"limit","in":"query","required":false,"example":20,"schemaId":"schema_0"},{"name":"page","in":"query","required":false,"example":1,"schemaId":"schema_1"},{"name":"kind","in":"query","required":false,"example":"webhook","schemaId":"components/schemas/ChannelKind"},{"name":"search","in":"query","required":false,"example":"production","schemaId":"schema_33"},{"name":"is_enabled","in":"query","required":false,"example":true,"schemaId":"schema_41"},{"name":"sort_by","in":"query","required":false,"example":"created_at","schemaId":"schema_52"}],"querystring":[],"header":[],"cookie":[]},"security":[{"schemes":[{"id":"Auth","type":"apiKey","name":"X-Api-Key","in":"header"}],"scopes":["api:channel:read"]}],"responseCodes":["200","400","401","403","503","default"],"pointer":"/channels","href":"channel/list-channels","openApiOperationId":"list-channels","summary":"List channels"},"isWebhook":false,"hideReplay":false,"servers":[{"url":"/_mock/apis/platform/api","description":"Mock server","isMockServer":true},{"url":"https://api.vilna.io/v2","description":"Vilna API."}],"examples":[]}]}]},{"nodeType":"container","children":[{"nodeType":"header","level":4,"label":"Responses","labelTranslationKey":"responses","deepLinkSuffix":"responses"},{"nodeType":"item-content","variant":"responses","responses":[{"code":"200","description":"List of channels with pagination.","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"schema_53"}},"schemaId":"schema_53"},{"code":"400","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Bad request (e.g., missing or invalid fields). Invalid text may be reported as address.label_invalid, address.meta_invalid, public_key.label_invalid, invoice.comment_invalid, invoice.metadata_invalid."},"children":[]}]}]}],"mediaType":"application/problem+json","mediaTypes":["application/problem+json"],"mediaTypeContent":{"application/problem+json":{"schemaId":"components/schemas/InvalidRequestProblem","exampleIds":["paths/~1channels/get/responses/400/content/application~1problem+json/examples/malformed_json"]}},"schemaId":"components/schemas/InvalidRequestProblem","exampleIds":["paths/~1channels/get/responses/400/content/application~1problem+json/examples/malformed_json"]},{"code":"401","description":"Missing or invalid authentication credentials.","mediaType":"application/problem+json","mediaTypes":["application/problem+json"],"mediaTypeContent":{"application/problem+json":{"schemaId":"components/schemas/UnauthorizedProblem","exampleIds":["paths/~1channels/get/responses/401/content/application~1problem+json/examples/service_authentication_denied"]}},"schemaId":"components/schemas/UnauthorizedProblem","exampleIds":["paths/~1channels/get/responses/401/content/application~1problem+json/examples/service_authentication_denied"]},{"code":"403","description":"Insufficient permissions.","mediaType":"application/problem+json","mediaTypes":["application/problem+json"],"mediaTypeContent":{"application/problem+json":{"schemaId":"components/schemas/ForbiddenProblem","exampleIds":["paths/~1channels/get/responses/403/content/application~1problem+json/examples/insufficient_permissions"]}},"schemaId":"components/schemas/ForbiddenProblem","exampleIds":["paths/~1channels/get/responses/403/content/application~1problem+json/examples/insufficient_permissions"]},{"code":"503","description":"The operation is temporarily unavailable. Please try again later.","mediaType":"application/problem+json","mediaTypes":["application/problem+json"],"mediaTypeContent":{"application/problem+json":{"schemaId":"components/schemas/Problem","exampleIds":["paths/~1channels/get/responses/503/content/application~1problem+json/examples/temporarily_unavailable"]}},"schemaId":"components/schemas/Problem","exampleIds":["paths/~1channels/get/responses/503/content/application~1problem+json/examples/temporarily_unavailable"]},{"code":"default","description":"Unexpected error.","mediaType":"application/problem+json","mediaTypes":["application/problem+json"],"mediaTypeContent":{"application/problem+json":{"schemaId":"components/schemas/Problem"}},"schemaId":"components/schemas/Problem"}],"pointer":"/paths/~1channels/get/responses"}],"panels":[{"children":[{"kind":"response","responseCodes":[{"code":"200","schemaId":"schema_53","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"schema_53"}}},{"code":"400","schemaId":"components/schemas/InvalidRequestProblem","exampleIds":["paths/~1channels/get/responses/400/content/application~1problem+json/examples/malformed_json"],"mediaTypes":["application/problem+json"],"mediaTypeContent":{"application/problem+json":{"schemaId":"components/schemas/InvalidRequestProblem","exampleIds":["paths/~1channels/get/responses/400/content/application~1problem+json/examples/malformed_json"]}}},{"code":"401","schemaId":"components/schemas/UnauthorizedProblem","exampleIds":["paths/~1channels/get/responses/401/content/application~1problem+json/examples/service_authentication_denied"],"mediaTypes":["application/problem+json"],"mediaTypeContent":{"application/problem+json":{"schemaId":"components/schemas/UnauthorizedProblem","exampleIds":["paths/~1channels/get/responses/401/content/application~1problem+json/examples/service_authentication_denied"]}}},{"code":"403","schemaId":"components/schemas/ForbiddenProblem","exampleIds":["paths/~1channels/get/responses/403/content/application~1problem+json/examples/insufficient_permissions"],"mediaTypes":["application/problem+json"],"mediaTypeContent":{"application/problem+json":{"schemaId":"components/schemas/ForbiddenProblem","exampleIds":["paths/~1channels/get/responses/403/content/application~1problem+json/examples/insufficient_permissions"]}}},{"code":"503","schemaId":"components/schemas/Problem","exampleIds":["paths/~1channels/get/responses/503/content/application~1problem+json/examples/temporarily_unavailable"],"mediaTypes":["application/problem+json"],"mediaTypeContent":{"application/problem+json":{"schemaId":"components/schemas/Problem","exampleIds":["paths/~1channels/get/responses/503/content/application~1problem+json/examples/temporarily_unavailable"]}}},{"code":"default","schemaId":"components/schemas/Problem","mediaTypes":["application/problem+json"],"mediaTypeContent":{"application/problem+json":{"schemaId":"components/schemas/Problem"}}}],"examples":[]}]}]},{"nodeType":"container","children":[{"nodeType":"feedback","pageSlug":"/channel/list-channels"}],"panels":[]}]},"httpPath":"/channels"},{"label":"Create channel","deprecated":false,"httpVerb":"post","isAdditionalOperation":false,"isWebhook":false,"type":"link","link":"/apis/platform/api/channel/create-channel","routeSlug":"/apis/platform/api/channel/create-channel","metadata":{"seo":{"title":"Create channel","description":"Create a channel. The configuration schema is selected by config.kind. Retry the same requestwith the same Idempotency-Key to replay its original completed response under currentauthorization: ordinary responses are available for 24 hours from the original completion; aresponse containing a webhook signing secret is available for 60 seconds from that completionand only while the secret is current. A new key represents a new intent and may create anotherchannel; there is no deduplication by name or configuration. See the common mutation idempotencypolicy for expiry and conflict behavior. Send max_attempts explicitly; the server does notsupply the documented default."}},"content":{"contentType":"item","itemVariant":"httpItem","meta":{"sourceId":"create-channel","name":"Create channel","isWebhook":false,"pointer":"/paths/~1channels/post","hasSamples":true},"children":[{"nodeType":"container","children":[{"nodeType":"header","level":2,"label":"Create channel","isWebhook":false,"showPageActions":true}],"panels":[]},{"nodeType":"container","children":[{"nodeType":"header","level":4,"label":"Request","labelTranslationKey":"request","deepLinkSuffix":"request"},{"nodeType":"markdoc","content":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Create a channel. The configuration schema is selected by "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"config.kind"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":". Retry the same request"},"children":[]},{"$$mdtype":"Node","type":"softbreak","inline":true,"attributes":{},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"with the same "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"Idempotency-Key"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" to replay its original completed response under current"},"children":[]},{"$$mdtype":"Node","type":"softbreak","inline":true,"attributes":{},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"authorization: ordinary responses are available for 24 hours from the original completion; a"},"children":[]},{"$$mdtype":"Node","type":"softbreak","inline":true,"attributes":{},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"response containing a webhook signing secret is available for 60 seconds from that completion"},"children":[]},{"$$mdtype":"Node","type":"softbreak","inline":true,"attributes":{},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"and only while the secret is current. A new key represents a new intent and may create another"},"children":[]},{"$$mdtype":"Node","type":"softbreak","inline":true,"attributes":{},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"channel; there is no deduplication by name or configuration. See the common mutation idempotency"},"children":[]},{"$$mdtype":"Node","type":"softbreak","inline":true,"attributes":{},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"policy for expiry and conflict behavior. Send "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"max_attempts"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" explicitly; the server does not"},"children":[]},{"$$mdtype":"Node","type":"softbreak","inline":true,"attributes":{},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"supply the documented default."},"children":[]}]}]}]},{"nodeType":"security","requirements":[{"schemes":[{"name":"Auth","scopes":["api:channel:write"],"type":"apiKey","in":"header","paramName":"X-Api-Key","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"API key for authenticating requests. Include your key in the "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"X-Api-Key"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" header. Keys can be created in the Vilna Dashboard or via the Management API. The scopes listed per operation indicate which permissions the key must have."},"children":[]}]}]}]}]}]},{"nodeType":"item-content","variant":"headers","label":"Headers","labelTranslationKey":"header","parameters":[{"name":"Idempotency-Key","in":"header","schemaId":"schema_14","description":"Case-sensitive opaque key for one mutation intent. Send exactly one header occurrence containing 1 to 128 visible ASCII bytes (0x21..0x7e). Commas are literal data; do not trim, lowercase or require UUID syntax. Reuse the same key for retries, with current authorization checked on every attempt. Repeated header occurrences are rejected.\n","required":true}],"pointer":"/paths/~1channels/post/parameters"},{"nodeType":"item-content","variant":"body","label":"Request Body","labelTranslationKey":"body","required":true,"mediaTypes":["application/json"],"mediaTypeSchemas":{"application/json":{"schemaId":"components/schemas/CreateChannelRequest","exampleIds":["paths/~1channels/post/requestBody/content/application~1json/examples/create_telegram_channel","paths/~1channels/post/requestBody/content/application~1json/examples/create_webhook_channel","paths/~1channels/post/requestBody/content/application~1json/examples/create_disabled_channel"]}},"schemaId":"components/schemas/CreateChannelRequest","exampleIds":["paths/~1channels/post/requestBody/content/application~1json/examples/create_telegram_channel","paths/~1channels/post/requestBody/content/application~1json/examples/create_webhook_channel","paths/~1channels/post/requestBody/content/application~1json/examples/create_disabled_channel"],"pointer":"/paths/~1channels/post/requestBody"}],"panels":[{"children":[{"kind":"code-sample","source":{"kind":"code-sample","operationType":"http","method":"POST","path":"/channels","servers":[{"url":"/_mock/apis/platform/api","description":"Mock server","isMockServer":true},{"url":"https://api.vilna.io/v2","description":"Vilna API."}],"parameters":{"path":[],"query":[],"querystring":[],"header":[{"name":"Idempotency-Key","in":"header","required":true,"schemaId":"schema_14"}],"cookie":[]},"security":[{"schemes":[{"id":"Auth","type":"apiKey","name":"X-Api-Key","in":"header"}],"scopes":["api:channel:write"]}],"requestBody":{"application/json":{"schemaId":"components/schemas/CreateChannelRequest","exampleIds":["paths/~1channels/post/requestBody/content/application~1json/examples/create_telegram_channel","paths/~1channels/post/requestBody/content/application~1json/examples/create_webhook_channel","paths/~1channels/post/requestBody/content/application~1json/examples/create_disabled_channel"]}},"responseCodes":["200","201","400","401","403","409","429","503","default"],"pointer":"/channels","href":"channel/create-channel","openApiOperationId":"create-channel","summary":"Create channel"},"isWebhook":false,"hideReplay":false,"servers":[{"url":"/_mock/apis/platform/api","description":"Mock server","isMockServer":true},{"url":"https://api.vilna.io/v2","description":"Vilna API."}],"schemaId":"components/schemas/CreateChannelRequest","exampleIds":["paths/~1channels/post/requestBody/content/application~1json/examples/create_telegram_channel","paths/~1channels/post/requestBody/content/application~1json/examples/create_webhook_channel","paths/~1channels/post/requestBody/content/application~1json/examples/create_disabled_channel"],"mediaTypes":["application/json"],"mediaTypeSchemas":{"application/json":{"schemaId":"components/schemas/CreateChannelRequest","exampleIds":["paths/~1channels/post/requestBody/content/application~1json/examples/create_telegram_channel","paths/~1channels/post/requestBody/content/application~1json/examples/create_webhook_channel","paths/~1channels/post/requestBody/content/application~1json/examples/create_disabled_channel"]}},"examples":[{},{},{}]}]}]},{"nodeType":"container","children":[{"nodeType":"header","level":4,"label":"Responses","labelTranslationKey":"responses","deepLinkSuffix":"responses"},{"nodeType":"item-content","variant":"responses","responses":[{"code":"200","description":"Channel created.","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"schema_54"}},"schemaId":"schema_54"},{"code":"201","description":"Channel created.","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"schema_54"}},"schemaId":"schema_54"},{"code":"400","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Bad request (e.g., missing or invalid fields). Invalid text may be reported as address.label_invalid, address.meta_invalid, public_key.label_invalid, invoice.comment_invalid, invoice.metadata_invalid."},"children":[]}]}]}],"mediaType":"application/problem+json","mediaTypes":["application/problem+json"],"mediaTypeContent":{"application/problem+json":{"schemaId":"components/schemas/InvalidRequestProblem","exampleIds":["paths/~1channels/post/responses/400/content/application~1problem+json/examples/malformed_json"]}},"schemaId":"components/schemas/InvalidRequestProblem","exampleIds":["paths/~1channels/post/responses/400/content/application~1problem+json/examples/malformed_json"]},{"code":"401","description":"Missing or invalid authentication credentials.","mediaType":"application/problem+json","mediaTypes":["application/problem+json"],"mediaTypeContent":{"application/problem+json":{"schemaId":"components/schemas/UnauthorizedProblem","exampleIds":["paths/~1channels/post/responses/401/content/application~1problem+json/examples/service_authentication_denied"]}},"schemaId":"components/schemas/UnauthorizedProblem","exampleIds":["paths/~1channels/post/responses/401/content/application~1problem+json/examples/service_authentication_denied"]},{"code":"403","description":"Insufficient permissions.","mediaType":"application/problem+json","mediaTypes":["application/problem+json"],"mediaTypeContent":{"application/problem+json":{"schemaId":"components/schemas/ForbiddenProblem","exampleIds":["paths/~1channels/post/responses/403/content/application~1problem+json/examples/insufficient_permissions"]}},"schemaId":"components/schemas/ForbiddenProblem","exampleIds":["paths/~1channels/post/responses/403/content/application~1problem+json/examples/insufficient_permissions"]},{"code":"409","description":"Request conflicts with the current resource state.","mediaType":"application/problem+json","mediaTypes":["application/problem+json"],"mediaTypeContent":{"application/problem+json":{"schemaId":"components/schemas/ConflictProblem","exampleIds":["paths/~1channels/post/responses/409/content/application~1problem+json/examples/address_occupied","paths/~1channels/post/responses/409/content/application~1problem+json/examples/address_in_use","paths/~1channels/post/responses/409/content/application~1problem+json/examples/subscription_v1_conflict","paths/~1channels/post/responses/409/content/application~1problem+json/examples/notification_send_in_progress","paths/~1channels/post/responses/409/content/application~1problem+json/examples/notification_payload_unavailable","paths/~1channels/post/responses/409/content/application~1problem+json/examples/notification_test_resend_not_allowed"]}},"schemaId":"components/schemas/ConflictProblem","exampleIds":["paths/~1channels/post/responses/409/content/application~1problem+json/examples/address_occupied","paths/~1channels/post/responses/409/content/application~1problem+json/examples/address_in_use","paths/~1channels/post/responses/409/content/application~1problem+json/examples/subscription_v1_conflict","paths/~1channels/post/responses/409/content/application~1problem+json/examples/notification_send_in_progress","paths/~1channels/post/responses/409/content/application~1problem+json/examples/notification_payload_unavailable","paths/~1channels/post/responses/409/content/application~1problem+json/examples/notification_test_resend_not_allowed"]},{"code":"429","description":"Resource quota exceeded. The response includes the effective limit for this scope. The applicable code and limit depend on the operation; examples illustrate different limits.","mediaType":"application/problem+json","mediaTypes":["application/problem+json"],"mediaTypeContent":{"application/problem+json":{"schemaId":"components/schemas/QuotaExceededProblem","exampleIds":["paths/~1channels/post/responses/429/content/application~1problem+json/examples/address_quota","paths/~1channels/post/responses/429/content/application~1problem+json/examples/creation_prohibited"]}},"schemaId":"components/schemas/QuotaExceededProblem","exampleIds":["paths/~1channels/post/responses/429/content/application~1problem+json/examples/address_quota","paths/~1channels/post/responses/429/content/application~1problem+json/examples/creation_prohibited"]},{"code":"503","description":"The operation is temporarily unavailable. Please try again later.","mediaType":"application/problem+json","mediaTypes":["application/problem+json"],"mediaTypeContent":{"application/problem+json":{"schemaId":"components/schemas/Problem","exampleIds":["paths/~1channels/post/responses/503/content/application~1problem+json/examples/temporarily_unavailable"]}},"schemaId":"components/schemas/Problem","exampleIds":["paths/~1channels/post/responses/503/content/application~1problem+json/examples/temporarily_unavailable"]},{"code":"default","description":"Unexpected error.","mediaType":"application/problem+json","mediaTypes":["application/problem+json"],"mediaTypeContent":{"application/problem+json":{"schemaId":"components/schemas/Problem"}},"schemaId":"components/schemas/Problem"}],"pointer":"/paths/~1channels/post/responses"}],"panels":[{"children":[{"kind":"response","responseCodes":[{"code":"200","schemaId":"schema_54","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"schema_54"}}},{"code":"201","schemaId":"schema_54","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"schema_54"}}},{"code":"400","schemaId":"components/schemas/InvalidRequestProblem","exampleIds":["paths/~1channels/post/responses/400/content/application~1problem+json/examples/malformed_json"],"mediaTypes":["application/problem+json"],"mediaTypeContent":{"application/problem+json":{"schemaId":"components/schemas/InvalidRequestProblem","exampleIds":["paths/~1channels/post/responses/400/content/application~1problem+json/examples/malformed_json"]}}},{"code":"401","schemaId":"components/schemas/UnauthorizedProblem","exampleIds":["paths/~1channels/post/responses/401/content/application~1problem+json/examples/service_authentication_denied"],"mediaTypes":["application/problem+json"],"mediaTypeContent":{"application/problem+json":{"schemaId":"components/schemas/UnauthorizedProblem","exampleIds":["paths/~1channels/post/responses/401/content/application~1problem+json/examples/service_authentication_denied"]}}},{"code":"403","schemaId":"components/schemas/ForbiddenProblem","exampleIds":["paths/~1channels/post/responses/403/content/application~1problem+json/examples/insufficient_permissions"],"mediaTypes":["application/problem+json"],"mediaTypeContent":{"application/problem+json":{"schemaId":"components/schemas/ForbiddenProblem","exampleIds":["paths/~1channels/post/responses/403/content/application~1problem+json/examples/insufficient_permissions"]}}},{"code":"409","schemaId":"components/schemas/ConflictProblem","exampleIds":["paths/~1channels/post/responses/409/content/application~1problem+json/examples/address_occupied","paths/~1channels/post/responses/409/content/application~1problem+json/examples/address_in_use","paths/~1channels/post/responses/409/content/application~1problem+json/examples/subscription_v1_conflict","paths/~1channels/post/responses/409/content/application~1problem+json/examples/notification_send_in_progress","paths/~1channels/post/responses/409/content/application~1problem+json/examples/notification_payload_unavailable","paths/~1channels/post/responses/409/content/application~1problem+json/examples/notification_test_resend_not_allowed"],"mediaTypes":["application/problem+json"],"mediaTypeContent":{"application/problem+json":{"schemaId":"components/schemas/ConflictProblem","exampleIds":["paths/~1channels/post/responses/409/content/application~1problem+json/examples/address_occupied","paths/~1channels/post/responses/409/content/application~1problem+json/examples/address_in_use","paths/~1channels/post/responses/409/content/application~1problem+json/examples/subscription_v1_conflict","paths/~1channels/post/responses/409/content/application~1problem+json/examples/notification_send_in_progress","paths/~1channels/post/responses/409/content/application~1problem+json/examples/notification_payload_unavailable","paths/~1channels/post/responses/409/content/application~1problem+json/examples/notification_test_resend_not_allowed"]}}},{"code":"429","schemaId":"components/schemas/QuotaExceededProblem","exampleIds":["paths/~1channels/post/responses/429/content/application~1problem+json/examples/address_quota","paths/~1channels/post/responses/429/content/application~1problem+json/examples/creation_prohibited"],"mediaTypes":["application/problem+json"],"mediaTypeContent":{"application/problem+json":{"schemaId":"components/schemas/QuotaExceededProblem","exampleIds":["paths/~1channels/post/responses/429/content/application~1problem+json/examples/address_quota","paths/~1channels/post/responses/429/content/application~1problem+json/examples/creation_prohibited"]}}},{"code":"503","schemaId":"components/schemas/Problem","exampleIds":["paths/~1channels/post/responses/503/content/application~1problem+json/examples/temporarily_unavailable"],"mediaTypes":["application/problem+json"],"mediaTypeContent":{"application/problem+json":{"schemaId":"components/schemas/Problem","exampleIds":["paths/~1channels/post/responses/503/content/application~1problem+json/examples/temporarily_unavailable"]}}},{"code":"default","schemaId":"components/schemas/Problem","mediaTypes":["application/problem+json"],"mediaTypeContent":{"application/problem+json":{"schemaId":"components/schemas/Problem"}}}],"examples":[]}]}]},{"nodeType":"container","children":[{"nodeType":"feedback","pageSlug":"/channel/create-channel"}],"panels":[]}]},"httpPath":"/channels"},{"label":"Get channel","deprecated":false,"httpVerb":"get","isAdditionalOperation":false,"isWebhook":false,"type":"link","link":"/apis/platform/api/channel/get-channel","routeSlug":"/apis/platform/api/channel/get-channel","metadata":{"seo":{"title":"Get channel","description":"Get channel details by ID."}},"content":{"contentType":"item","itemVariant":"httpItem","meta":{"sourceId":"get-channel","name":"Get channel","isWebhook":false,"pointer":"/paths/~1channels~1{channel_id}/get","hasSamples":false},"children":[{"nodeType":"container","children":[{"nodeType":"header","level":2,"label":"Get channel","isWebhook":false,"showPageActions":true}],"panels":[]},{"nodeType":"container","children":[{"nodeType":"header","level":4,"label":"Request","labelTranslationKey":"request","deepLinkSuffix":"request"},{"nodeType":"markdoc","content":"Get channel details by ID."},{"nodeType":"security","requirements":[{"schemes":[{"name":"Auth","scopes":["api:channel:read"],"type":"apiKey","in":"header","paramName":"X-Api-Key","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"API key for authenticating requests. Include your key in the "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"X-Api-Key"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" header. Keys can be created in the Vilna Dashboard or via the Management API. The scopes listed per operation indicate which permissions the key must have."},"children":[]}]}]}]}]}]},{"nodeType":"item-content","variant":"path","label":"Path","labelTranslationKey":"path","parameters":[{"name":"channel_id","in":"path","schemaId":"schema_17","description":"Unique identifier (UUID) of the channel.","required":true}],"pointer":"/paths/~1channels~1{channel_id}/get/parameters"}],"panels":[{"children":[{"kind":"code-sample","source":{"kind":"code-sample","operationType":"http","method":"GET","path":"/channels/{channel_id}","servers":[{"url":"/_mock/apis/platform/api","description":"Mock server","isMockServer":true},{"url":"https://api.vilna.io/v2","description":"Vilna API."}],"parameters":{"path":[{"name":"channel_id","in":"path","required":true,"example":"550e8400-e29b-41d4-a716-446655440000","schemaId":"components/schemas/UUID"}],"query":[],"querystring":[],"header":[],"cookie":[]},"security":[{"schemes":[{"id":"Auth","type":"apiKey","name":"X-Api-Key","in":"header"}],"scopes":["api:channel:read"]}],"responseCodes":["200","400","401","403","404","503","default"],"pointer":"/channels/{channel_id}","href":"channel/get-channel","openApiOperationId":"get-channel","summary":"Get channel"},"isWebhook":false,"hideReplay":false,"servers":[{"url":"/_mock/apis/platform/api","description":"Mock server","isMockServer":true},{"url":"https://api.vilna.io/v2","description":"Vilna API."}],"examples":[]}]}]},{"nodeType":"container","children":[{"nodeType":"header","level":4,"label":"Responses","labelTranslationKey":"responses","deepLinkSuffix":"responses"},{"nodeType":"item-content","variant":"responses","responses":[{"code":"200","description":"Notification channel details.","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"schema_55"}},"schemaId":"schema_55"},{"code":"400","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Bad request (e.g., missing or invalid fields). Invalid text may be reported as address.label_invalid, address.meta_invalid, public_key.label_invalid, invoice.comment_invalid, invoice.metadata_invalid."},"children":[]}]}]}],"mediaType":"application/problem+json","mediaTypes":["application/problem+json"],"mediaTypeContent":{"application/problem+json":{"schemaId":"components/schemas/InvalidRequestProblem","exampleIds":["paths/~1channels~1{channel_id}/get/responses/400/content/application~1problem+json/examples/malformed_json"]}},"schemaId":"components/schemas/InvalidRequestProblem","exampleIds":["paths/~1channels~1{channel_id}/get/responses/400/content/application~1problem+json/examples/malformed_json"]},{"code":"401","description":"Missing or invalid authentication credentials.","mediaType":"application/problem+json","mediaTypes":["application/problem+json"],"mediaTypeContent":{"application/problem+json":{"schemaId":"components/schemas/UnauthorizedProblem","exampleIds":["paths/~1channels~1{channel_id}/get/responses/401/content/application~1problem+json/examples/service_authentication_denied"]}},"schemaId":"components/schemas/UnauthorizedProblem","exampleIds":["paths/~1channels~1{channel_id}/get/responses/401/content/application~1problem+json/examples/service_authentication_denied"]},{"code":"403","description":"Insufficient permissions.","mediaType":"application/problem+json","mediaTypes":["application/problem+json"],"mediaTypeContent":{"application/problem+json":{"schemaId":"components/schemas/ForbiddenProblem","exampleIds":["paths/~1channels~1{channel_id}/get/responses/403/content/application~1problem+json/examples/insufficient_permissions"]}},"schemaId":"components/schemas/ForbiddenProblem","exampleIds":["paths/~1channels~1{channel_id}/get/responses/403/content/application~1problem+json/examples/insufficient_permissions"]},{"code":"404","description":"Requested resource does not exist.","mediaType":"application/problem+json","mediaTypes":["application/problem+json"],"mediaTypeContent":{"application/problem+json":{"schemaId":"components/schemas/NotFoundProblem","exampleIds":["paths/~1channels~1{channel_id}/get/responses/404/content/application~1problem+json/examples/address_not_found","paths/~1channels~1{channel_id}/get/responses/404/content/application~1problem+json/examples/invoice_not_found"]}},"schemaId":"components/schemas/NotFoundProblem","exampleIds":["paths/~1channels~1{channel_id}/get/responses/404/content/application~1problem+json/examples/address_not_found","paths/~1channels~1{channel_id}/get/responses/404/content/application~1problem+json/examples/invoice_not_found"]},{"code":"503","description":"The operation is temporarily unavailable. Please try again later.","mediaType":"application/problem+json","mediaTypes":["application/problem+json"],"mediaTypeContent":{"application/problem+json":{"schemaId":"components/schemas/Problem","exampleIds":["paths/~1channels~1{channel_id}/get/responses/503/content/application~1problem+json/examples/temporarily_unavailable"]}},"schemaId":"components/schemas/Problem","exampleIds":["paths/~1channels~1{channel_id}/get/responses/503/content/application~1problem+json/examples/temporarily_unavailable"]},{"code":"default","description":"Unexpected error.","mediaType":"application/problem+json","mediaTypes":["application/problem+json"],"mediaTypeContent":{"application/problem+json":{"schemaId":"components/schemas/Problem"}},"schemaId":"components/schemas/Problem"}],"pointer":"/paths/~1channels~1{channel_id}/get/responses"}],"panels":[{"children":[{"kind":"response","responseCodes":[{"code":"200","schemaId":"schema_55","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"schema_55"}}},{"code":"400","schemaId":"components/schemas/InvalidRequestProblem","exampleIds":["paths/~1channels~1{channel_id}/get/responses/400/content/application~1problem+json/examples/malformed_json"],"mediaTypes":["application/problem+json"],"mediaTypeContent":{"application/problem+json":{"schemaId":"components/schemas/InvalidRequestProblem","exampleIds":["paths/~1channels~1{channel_id}/get/responses/400/content/application~1problem+json/examples/malformed_json"]}}},{"code":"401","schemaId":"components/schemas/UnauthorizedProblem","exampleIds":["paths/~1channels~1{channel_id}/get/responses/401/content/application~1problem+json/examples/service_authentication_denied"],"mediaTypes":["application/problem+json"],"mediaTypeContent":{"application/problem+json":{"schemaId":"components/schemas/UnauthorizedProblem","exampleIds":["paths/~1channels~1{channel_id}/get/responses/401/content/application~1problem+json/examples/service_authentication_denied"]}}},{"code":"403","schemaId":"components/schemas/ForbiddenProblem","exampleIds":["paths/~1channels~1{channel_id}/get/responses/403/content/application~1problem+json/examples/insufficient_permissions"],"mediaTypes":["application/problem+json"],"mediaTypeContent":{"application/problem+json":{"schemaId":"components/schemas/ForbiddenProblem","exampleIds":["paths/~1channels~1{channel_id}/get/responses/403/content/application~1problem+json/examples/insufficient_permissions"]}}},{"code":"404","schemaId":"components/schemas/NotFoundProblem","exampleIds":["paths/~1channels~1{channel_id}/get/responses/404/content/application~1problem+json/examples/address_not_found","paths/~1channels~1{channel_id}/get/responses/404/content/application~1problem+json/examples/invoice_not_found"],"mediaTypes":["application/problem+json"],"mediaTypeContent":{"application/problem+json":{"schemaId":"components/schemas/NotFoundProblem","exampleIds":["paths/~1channels~1{channel_id}/get/responses/404/content/application~1problem+json/examples/address_not_found","paths/~1channels~1{channel_id}/get/responses/404/content/application~1problem+json/examples/invoice_not_found"]}}},{"code":"503","schemaId":"components/schemas/Problem","exampleIds":["paths/~1channels~1{channel_id}/get/responses/503/content/application~1problem+json/examples/temporarily_unavailable"],"mediaTypes":["application/problem+json"],"mediaTypeContent":{"application/problem+json":{"schemaId":"components/schemas/Problem","exampleIds":["paths/~1channels~1{channel_id}/get/responses/503/content/application~1problem+json/examples/temporarily_unavailable"]}}},{"code":"default","schemaId":"components/schemas/Problem","mediaTypes":["application/problem+json"],"mediaTypeContent":{"application/problem+json":{"schemaId":"components/schemas/Problem"}}}],"examples":[]}]}]},{"nodeType":"container","children":[{"nodeType":"feedback","pageSlug":"/channel/get-channel"}],"panels":[]}]},"httpPath":"/channels/{channel_id}"},{"label":"Delete channel","deprecated":false,"httpVerb":"delete","isAdditionalOperation":false,"isWebhook":false,"type":"link","link":"/apis/platform/api/channel/delete-channel","routeSlug":"/apis/platform/api/channel/delete-channel","metadata":{"seo":{"title":"Delete channel","description":"Delete a channel by ID."}},"content":{"contentType":"item","itemVariant":"httpItem","meta":{"sourceId":"delete-channel","name":"Delete channel","isWebhook":false,"pointer":"/paths/~1channels~1{channel_id}/delete","hasSamples":false},"children":[{"nodeType":"container","children":[{"nodeType":"header","level":2,"label":"Delete channel","isWebhook":false,"showPageActions":true}],"panels":[]},{"nodeType":"container","children":[{"nodeType":"header","level":4,"label":"Request","labelTranslationKey":"request","deepLinkSuffix":"request"},{"nodeType":"markdoc","content":"Delete a channel by ID."},{"nodeType":"security","requirements":[{"schemes":[{"name":"Auth","scopes":["api:channel:delete"],"type":"apiKey","in":"header","paramName":"X-Api-Key","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"API key for authenticating requests. Include your key in the "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"X-Api-Key"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" header. Keys can be created in the Vilna Dashboard or via the Management API. The scopes listed per operation indicate which permissions the key must have."},"children":[]}]}]}]}]}]},{"nodeType":"item-content","variant":"path","label":"Path","labelTranslationKey":"path","parameters":[{"name":"channel_id","in":"path","schemaId":"schema_17","description":"Unique identifier (UUID) of the channel.","required":true}],"pointer":"/paths/~1channels~1{channel_id}/delete/parameters"},{"nodeType":"item-content","variant":"headers","label":"Headers","labelTranslationKey":"header","parameters":[{"name":"Idempotency-Key","in":"header","schemaId":"schema_14","description":"Case-sensitive opaque key for one mutation intent. Send exactly one header occurrence containing 1 to 128 visible ASCII bytes (0x21..0x7e). Commas are literal data; do not trim, lowercase or require UUID syntax. Reuse the same key for retries, with current authorization checked on every attempt. Repeated header occurrences are rejected.\n","required":true}],"pointer":"/paths/~1channels~1{channel_id}/delete/parameters"}],"panels":[{"children":[{"kind":"code-sample","source":{"kind":"code-sample","operationType":"http","method":"DELETE","path":"/channels/{channel_id}","servers":[{"url":"/_mock/apis/platform/api","description":"Mock server","isMockServer":true},{"url":"https://api.vilna.io/v2","description":"Vilna API."}],"parameters":{"path":[{"name":"channel_id","in":"path","required":true,"example":"550e8400-e29b-41d4-a716-446655440000","schemaId":"components/schemas/UUID"}],"query":[],"querystring":[],"header":[{"name":"Idempotency-Key","in":"header","required":true,"schemaId":"schema_14"}],"cookie":[]},"security":[{"schemes":[{"id":"Auth","type":"apiKey","name":"X-Api-Key","in":"header"}],"scopes":["api:channel:delete"]}],"responseCodes":["204","400","401","403","404","409","503","default"],"pointer":"/channels/{channel_id}","href":"channel/delete-channel","openApiOperationId":"delete-channel","summary":"Delete channel"},"isWebhook":false,"hideReplay":false,"servers":[{"url":"/_mock/apis/platform/api","description":"Mock server","isMockServer":true},{"url":"https://api.vilna.io/v2","description":"Vilna API."}],"examples":[]}]}]},{"nodeType":"container","children":[{"nodeType":"header","level":4,"label":"Responses","labelTranslationKey":"responses","deepLinkSuffix":"responses"},{"nodeType":"item-content","variant":"responses","responses":[{"code":"204","description":"Successful operation with no response body."},{"code":"400","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Bad request (e.g., missing or invalid fields). Invalid text may be reported as address.label_invalid, address.meta_invalid, public_key.label_invalid, invoice.comment_invalid, invoice.metadata_invalid."},"children":[]}]}]}],"mediaType":"application/problem+json","mediaTypes":["application/problem+json"],"mediaTypeContent":{"application/problem+json":{"schemaId":"components/schemas/InvalidRequestProblem","exampleIds":["paths/~1channels~1{channel_id}/delete/responses/400/content/application~1problem+json/examples/malformed_json"]}},"schemaId":"components/schemas/InvalidRequestProblem","exampleIds":["paths/~1channels~1{channel_id}/delete/responses/400/content/application~1problem+json/examples/malformed_json"]},{"code":"401","description":"Missing or invalid authentication credentials.","mediaType":"application/problem+json","mediaTypes":["application/problem+json"],"mediaTypeContent":{"application/problem+json":{"schemaId":"components/schemas/UnauthorizedProblem","exampleIds":["paths/~1channels~1{channel_id}/delete/responses/401/content/application~1problem+json/examples/service_authentication_denied"]}},"schemaId":"components/schemas/UnauthorizedProblem","exampleIds":["paths/~1channels~1{channel_id}/delete/responses/401/content/application~1problem+json/examples/service_authentication_denied"]},{"code":"403","description":"Insufficient permissions.","mediaType":"application/problem+json","mediaTypes":["application/problem+json"],"mediaTypeContent":{"application/problem+json":{"schemaId":"components/schemas/ForbiddenProblem","exampleIds":["paths/~1channels~1{channel_id}/delete/responses/403/content/application~1problem+json/examples/insufficient_permissions"]}},"schemaId":"components/schemas/ForbiddenProblem","exampleIds":["paths/~1channels~1{channel_id}/delete/responses/403/content/application~1problem+json/examples/insufficient_permissions"]},{"code":"404","description":"Requested resource does not exist.","mediaType":"application/problem+json","mediaTypes":["application/problem+json"],"mediaTypeContent":{"application/problem+json":{"schemaId":"components/schemas/NotFoundProblem","exampleIds":["paths/~1channels~1{channel_id}/delete/responses/404/content/application~1problem+json/examples/address_not_found","paths/~1channels~1{channel_id}/delete/responses/404/content/application~1problem+json/examples/invoice_not_found"]}},"schemaId":"components/schemas/NotFoundProblem","exampleIds":["paths/~1channels~1{channel_id}/delete/responses/404/content/application~1problem+json/examples/address_not_found","paths/~1channels~1{channel_id}/delete/responses/404/content/application~1problem+json/examples/invoice_not_found"]},{"code":"409","description":"Request conflicts with the current resource state.","mediaType":"application/problem+json","mediaTypes":["application/problem+json"],"mediaTypeContent":{"application/problem+json":{"schemaId":"components/schemas/ConflictProblem","exampleIds":["paths/~1channels~1{channel_id}/delete/responses/409/content/application~1problem+json/examples/address_occupied","paths/~1channels~1{channel_id}/delete/responses/409/content/application~1problem+json/examples/address_in_use","paths/~1channels~1{channel_id}/delete/responses/409/content/application~1problem+json/examples/subscription_v1_conflict","paths/~1channels~1{channel_id}/delete/responses/409/content/application~1problem+json/examples/notification_send_in_progress","paths/~1channels~1{channel_id}/delete/responses/409/content/application~1problem+json/examples/notification_payload_unavailable","paths/~1channels~1{channel_id}/delete/responses/409/content/application~1problem+json/examples/notification_test_resend_not_allowed"]}},"schemaId":"components/schemas/ConflictProblem","exampleIds":["paths/~1channels~1{channel_id}/delete/responses/409/content/application~1problem+json/examples/address_occupied","paths/~1channels~1{channel_id}/delete/responses/409/content/application~1problem+json/examples/address_in_use","paths/~1channels~1{channel_id}/delete/responses/409/content/application~1problem+json/examples/subscription_v1_conflict","paths/~1channels~1{channel_id}/delete/responses/409/content/application~1problem+json/examples/notification_send_in_progress","paths/~1channels~1{channel_id}/delete/responses/409/content/application~1problem+json/examples/notification_payload_unavailable","paths/~1channels~1{channel_id}/delete/responses/409/content/application~1problem+json/examples/notification_test_resend_not_allowed"]},{"code":"503","description":"The operation is temporarily unavailable. Please try again later.","mediaType":"application/problem+json","mediaTypes":["application/problem+json"],"mediaTypeContent":{"application/problem+json":{"schemaId":"components/schemas/Problem","exampleIds":["paths/~1channels~1{channel_id}/delete/responses/503/content/application~1problem+json/examples/temporarily_unavailable"]}},"schemaId":"components/schemas/Problem","exampleIds":["paths/~1channels~1{channel_id}/delete/responses/503/content/application~1problem+json/examples/temporarily_unavailable"]},{"code":"default","description":"Unexpected error.","mediaType":"application/problem+json","mediaTypes":["application/problem+json"],"mediaTypeContent":{"application/problem+json":{"schemaId":"components/schemas/Problem"}},"schemaId":"components/schemas/Problem"}],"pointer":"/paths/~1channels~1{channel_id}/delete/responses"}],"panels":[{"children":[{"kind":"response","responseCodes":[{"code":"204"},{"code":"400","schemaId":"components/schemas/InvalidRequestProblem","exampleIds":["paths/~1channels~1{channel_id}/delete/responses/400/content/application~1problem+json/examples/malformed_json"],"mediaTypes":["application/problem+json"],"mediaTypeContent":{"application/problem+json":{"schemaId":"components/schemas/InvalidRequestProblem","exampleIds":["paths/~1channels~1{channel_id}/delete/responses/400/content/application~1problem+json/examples/malformed_json"]}}},{"code":"401","schemaId":"components/schemas/UnauthorizedProblem","exampleIds":["paths/~1channels~1{channel_id}/delete/responses/401/content/application~1problem+json/examples/service_authentication_denied"],"mediaTypes":["application/problem+json"],"mediaTypeContent":{"application/problem+json":{"schemaId":"components/schemas/UnauthorizedProblem","exampleIds":["paths/~1channels~1{channel_id}/delete/responses/401/content/application~1problem+json/examples/service_authentication_denied"]}}},{"code":"403","schemaId":"components/schemas/ForbiddenProblem","exampleIds":["paths/~1channels~1{channel_id}/delete/responses/403/content/application~1problem+json/examples/insufficient_permissions"],"mediaTypes":["application/problem+json"],"mediaTypeContent":{"application/problem+json":{"schemaId":"components/schemas/ForbiddenProblem","exampleIds":["paths/~1channels~1{channel_id}/delete/responses/403/content/application~1problem+json/examples/insufficient_permissions"]}}},{"code":"404","schemaId":"components/schemas/NotFoundProblem","exampleIds":["paths/~1channels~1{channel_id}/delete/responses/404/content/application~1problem+json/examples/address_not_found","paths/~1channels~1{channel_id}/delete/responses/404/content/application~1problem+json/examples/invoice_not_found"],"mediaTypes":["application/problem+json"],"mediaTypeContent":{"application/problem+json":{"schemaId":"components/schemas/NotFoundProblem","exampleIds":["paths/~1channels~1{channel_id}/delete/responses/404/content/application~1problem+json/examples/address_not_found","paths/~1channels~1{channel_id}/delete/responses/404/content/application~1problem+json/examples/invoice_not_found"]}}},{"code":"409","schemaId":"components/schemas/ConflictProblem","exampleIds":["paths/~1channels~1{channel_id}/delete/responses/409/content/application~1problem+json/examples/address_occupied","paths/~1channels~1{channel_id}/delete/responses/409/content/application~1problem+json/examples/address_in_use","paths/~1channels~1{channel_id}/delete/responses/409/content/application~1problem+json/examples/subscription_v1_conflict","paths/~1channels~1{channel_id}/delete/responses/409/content/application~1problem+json/examples/notification_send_in_progress","paths/~1channels~1{channel_id}/delete/responses/409/content/application~1problem+json/examples/notification_payload_unavailable","paths/~1channels~1{channel_id}/delete/responses/409/content/application~1problem+json/examples/notification_test_resend_not_allowed"],"mediaTypes":["application/problem+json"],"mediaTypeContent":{"application/problem+json":{"schemaId":"components/schemas/ConflictProblem","exampleIds":["paths/~1channels~1{channel_id}/delete/responses/409/content/application~1problem+json/examples/address_occupied","paths/~1channels~1{channel_id}/delete/responses/409/content/application~1problem+json/examples/address_in_use","paths/~1channels~1{channel_id}/delete/responses/409/content/application~1problem+json/examples/subscription_v1_conflict","paths/~1channels~1{channel_id}/delete/responses/409/content/application~1problem+json/examples/notification_send_in_progress","paths/~1channels~1{channel_id}/delete/responses/409/content/application~1problem+json/examples/notification_payload_unavailable","paths/~1channels~1{channel_id}/delete/responses/409/content/application~1problem+json/examples/notification_test_resend_not_allowed"]}}},{"code":"503","schemaId":"components/schemas/Problem","exampleIds":["paths/~1channels~1{channel_id}/delete/responses/503/content/application~1problem+json/examples/temporarily_unavailable"],"mediaTypes":["application/problem+json"],"mediaTypeContent":{"application/problem+json":{"schemaId":"components/schemas/Problem","exampleIds":["paths/~1channels~1{channel_id}/delete/responses/503/content/application~1problem+json/examples/temporarily_unavailable"]}}},{"code":"default","schemaId":"components/schemas/Problem","mediaTypes":["application/problem+json"],"mediaTypeContent":{"application/problem+json":{"schemaId":"components/schemas/Problem"}}}],"examples":[]}]}]},{"nodeType":"container","children":[{"nodeType":"feedback","pageSlug":"/channel/delete-channel"}],"panels":[]}]},"httpPath":"/channels/{channel_id}"},{"label":"Update channel","deprecated":false,"httpVerb":"patch","isAdditionalOperation":false,"isWebhook":false,"type":"link","link":"/apis/platform/api/channel/patch-channel","routeSlug":"/apis/platform/api/channel/patch-channel","metadata":{"seo":{"title":"Update channel","description":"Update channel metadata or configuration. Name, configuration, availability and the attempt budgetare validated and applied together, and kind cannot change."}},"content":{"contentType":"item","itemVariant":"httpItem","meta":{"sourceId":"patch-channel","name":"Update channel","isWebhook":false,"pointer":"/paths/~1channels~1{channel_id}/patch","hasSamples":true},"children":[{"nodeType":"container","children":[{"nodeType":"header","level":2,"label":"Update channel","isWebhook":false,"showPageActions":true}],"panels":[]},{"nodeType":"container","children":[{"nodeType":"header","level":4,"label":"Request","labelTranslationKey":"request","deepLinkSuffix":"request"},{"nodeType":"markdoc","content":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Update channel metadata or configuration. Name, configuration, availability and the attempt budget"},"children":[]},{"$$mdtype":"Node","type":"softbreak","inline":true,"attributes":{},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"are validated and applied together, and "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"kind"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" cannot change."},"children":[]}]}]}]},{"nodeType":"security","requirements":[{"schemes":[{"name":"Auth","scopes":["api:channel:write"],"type":"apiKey","in":"header","paramName":"X-Api-Key","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"API key for authenticating requests. Include your key in the "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"X-Api-Key"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" header. Keys can be created in the Vilna Dashboard or via the Management API. The scopes listed per operation indicate which permissions the key must have."},"children":[]}]}]}]}]}]},{"nodeType":"item-content","variant":"path","label":"Path","labelTranslationKey":"path","parameters":[{"name":"channel_id","in":"path","schemaId":"schema_17","description":"Unique identifier (UUID) of the channel.","required":true}],"pointer":"/paths/~1channels~1{channel_id}/patch/parameters"},{"nodeType":"item-content","variant":"headers","label":"Headers","labelTranslationKey":"header","parameters":[{"name":"Idempotency-Key","in":"header","schemaId":"schema_14","description":"Case-sensitive opaque key for one mutation intent. Send exactly one header occurrence containing 1 to 128 visible ASCII bytes (0x21..0x7e). Commas are literal data; do not trim, lowercase or require UUID syntax. Reuse the same key for retries, with current authorization checked on every attempt. Repeated header occurrences are rejected.\n","required":true}],"pointer":"/paths/~1channels~1{channel_id}/patch/parameters"},{"nodeType":"item-content","variant":"body","label":"Request Body","labelTranslationKey":"body","required":true,"mediaTypes":["application/json"],"mediaTypeSchemas":{"application/json":{"schemaId":"components/schemas/UpdateChannelRequest","exampleIds":["paths/~1channels~1{channel_id}/patch/requestBody/content/application~1json/examples/update_telegram_keep_token","paths/~1channels~1{channel_id}/patch/requestBody/content/application~1json/examples/update_telegram_rotate_token","paths/~1channels~1{channel_id}/patch/requestBody/content/application~1json/examples/update_webhook_keep_headers","paths/~1channels~1{channel_id}/patch/requestBody/content/application~1json/examples/update_webhook_replace_headers","paths/~1channels~1{channel_id}/patch/requestBody/content/application~1json/examples/update_webhook_clear_headers","paths/~1channels~1{channel_id}/patch/requestBody/content/application~1json/examples/update_webhook_payload_version","paths/~1channels~1{channel_id}/patch/requestBody/content/application~1json/examples/update_name_only","paths/~1channels~1{channel_id}/patch/requestBody/content/application~1json/examples/reenable_channel"]}},"schemaId":"components/schemas/UpdateChannelRequest","exampleIds":["paths/~1channels~1{channel_id}/patch/requestBody/content/application~1json/examples/update_telegram_keep_token","paths/~1channels~1{channel_id}/patch/requestBody/content/application~1json/examples/update_telegram_rotate_token","paths/~1channels~1{channel_id}/patch/requestBody/content/application~1json/examples/update_webhook_keep_headers","paths/~1channels~1{channel_id}/patch/requestBody/content/application~1json/examples/update_webhook_replace_headers","paths/~1channels~1{channel_id}/patch/requestBody/content/application~1json/examples/update_webhook_clear_headers","paths/~1channels~1{channel_id}/patch/requestBody/content/application~1json/examples/update_webhook_payload_version","paths/~1channels~1{channel_id}/patch/requestBody/content/application~1json/examples/update_name_only","paths/~1channels~1{channel_id}/patch/requestBody/content/application~1json/examples/reenable_channel"],"pointer":"/paths/~1channels~1{channel_id}/patch/requestBody"}],"panels":[{"children":[{"kind":"code-sample","source":{"kind":"code-sample","operationType":"http","method":"PATCH","path":"/channels/{channel_id}","servers":[{"url":"/_mock/apis/platform/api","description":"Mock server","isMockServer":true},{"url":"https://api.vilna.io/v2","description":"Vilna API."}],"parameters":{"path":[{"name":"channel_id","in":"path","required":true,"example":"550e8400-e29b-41d4-a716-446655440000","schemaId":"components/schemas/UUID"}],"query":[],"querystring":[],"header":[{"name":"Idempotency-Key","in":"header","required":true,"schemaId":"schema_14"}],"cookie":[]},"security":[{"schemes":[{"id":"Auth","type":"apiKey","name":"X-Api-Key","in":"header"}],"scopes":["api:channel:write"]}],"requestBody":{"application/json":{"schemaId":"components/schemas/UpdateChannelRequest","exampleIds":["paths/~1channels~1{channel_id}/patch/requestBody/content/application~1json/examples/update_telegram_keep_token","paths/~1channels~1{channel_id}/patch/requestBody/content/application~1json/examples/update_telegram_rotate_token","paths/~1channels~1{channel_id}/patch/requestBody/content/application~1json/examples/update_webhook_keep_headers","paths/~1channels~1{channel_id}/patch/requestBody/content/application~1json/examples/update_webhook_replace_headers","paths/~1channels~1{channel_id}/patch/requestBody/content/application~1json/examples/update_webhook_clear_headers","paths/~1channels~1{channel_id}/patch/requestBody/content/application~1json/examples/update_webhook_payload_version","paths/~1channels~1{channel_id}/patch/requestBody/content/application~1json/examples/update_name_only","paths/~1channels~1{channel_id}/patch/requestBody/content/application~1json/examples/reenable_channel"]}},"responseCodes":["200","400","401","403","404","409","503","default"],"pointer":"/channels/{channel_id}","href":"channel/patch-channel","openApiOperationId":"patch-channel","summary":"Update channel"},"isWebhook":false,"hideReplay":false,"servers":[{"url":"/_mock/apis/platform/api","description":"Mock server","isMockServer":true},{"url":"https://api.vilna.io/v2","description":"Vilna API."}],"schemaId":"components/schemas/UpdateChannelRequest","exampleIds":["paths/~1channels~1{channel_id}/patch/requestBody/content/application~1json/examples/update_telegram_keep_token","paths/~1channels~1{channel_id}/patch/requestBody/content/application~1json/examples/update_telegram_rotate_token","paths/~1channels~1{channel_id}/patch/requestBody/content/application~1json/examples/update_webhook_keep_headers","paths/~1channels~1{channel_id}/patch/requestBody/content/application~1json/examples/update_webhook_replace_headers","paths/~1channels~1{channel_id}/patch/requestBody/content/application~1json/examples/update_webhook_clear_headers","paths/~1channels~1{channel_id}/patch/requestBody/content/application~1json/examples/update_webhook_payload_version","paths/~1channels~1{channel_id}/patch/requestBody/content/application~1json/examples/update_name_only","paths/~1channels~1{channel_id}/patch/requestBody/content/application~1json/examples/reenable_channel"],"mediaTypes":["application/json"],"mediaTypeSchemas":{"application/json":{"schemaId":"components/schemas/UpdateChannelRequest","exampleIds":["paths/~1channels~1{channel_id}/patch/requestBody/content/application~1json/examples/update_telegram_keep_token","paths/~1channels~1{channel_id}/patch/requestBody/content/application~1json/examples/update_telegram_rotate_token","paths/~1channels~1{channel_id}/patch/requestBody/content/application~1json/examples/update_webhook_keep_headers","paths/~1channels~1{channel_id}/patch/requestBody/content/application~1json/examples/update_webhook_replace_headers","paths/~1channels~1{channel_id}/patch/requestBody/content/application~1json/examples/update_webhook_clear_headers","paths/~1channels~1{channel_id}/patch/requestBody/content/application~1json/examples/update_webhook_payload_version","paths/~1channels~1{channel_id}/patch/requestBody/content/application~1json/examples/update_name_only","paths/~1channels~1{channel_id}/patch/requestBody/content/application~1json/examples/reenable_channel"]}},"examples":[{},{},{},{},{},{},{},{}]}]}]},{"nodeType":"container","children":[{"nodeType":"header","level":4,"label":"Responses","labelTranslationKey":"responses","deepLinkSuffix":"responses"},{"nodeType":"item-content","variant":"responses","responses":[{"code":"200","description":"Notification channel details.","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"schema_55"}},"schemaId":"schema_55"},{"code":"400","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Bad request (e.g., missing or invalid fields). Invalid text may be reported as address.label_invalid, address.meta_invalid, public_key.label_invalid, invoice.comment_invalid, invoice.metadata_invalid."},"children":[]}]}]}],"mediaType":"application/problem+json","mediaTypes":["application/problem+json"],"mediaTypeContent":{"application/problem+json":{"schemaId":"components/schemas/InvalidRequestProblem","exampleIds":["paths/~1channels~1{channel_id}/patch/responses/400/content/application~1problem+json/examples/malformed_json"]}},"schemaId":"components/schemas/InvalidRequestProblem","exampleIds":["paths/~1channels~1{channel_id}/patch/responses/400/content/application~1problem+json/examples/malformed_json"]},{"code":"401","description":"Missing or invalid authentication credentials.","mediaType":"application/problem+json","mediaTypes":["application/problem+json"],"mediaTypeContent":{"application/problem+json":{"schemaId":"components/schemas/UnauthorizedProblem","exampleIds":["paths/~1channels~1{channel_id}/patch/responses/401/content/application~1problem+json/examples/service_authentication_denied"]}},"schemaId":"components/schemas/UnauthorizedProblem","exampleIds":["paths/~1channels~1{channel_id}/patch/responses/401/content/application~1problem+json/examples/service_authentication_denied"]},{"code":"403","description":"Insufficient permissions.","mediaType":"application/problem+json","mediaTypes":["application/problem+json"],"mediaTypeContent":{"application/problem+json":{"schemaId":"components/schemas/ForbiddenProblem","exampleIds":["paths/~1channels~1{channel_id}/patch/responses/403/content/application~1problem+json/examples/insufficient_permissions"]}},"schemaId":"components/schemas/ForbiddenProblem","exampleIds":["paths/~1channels~1{channel_id}/patch/responses/403/content/application~1problem+json/examples/insufficient_permissions"]},{"code":"404","description":"Requested resource does not exist.","mediaType":"application/problem+json","mediaTypes":["application/problem+json"],"mediaTypeContent":{"application/problem+json":{"schemaId":"components/schemas/NotFoundProblem","exampleIds":["paths/~1channels~1{channel_id}/patch/responses/404/content/application~1problem+json/examples/address_not_found","paths/~1channels~1{channel_id}/patch/responses/404/content/application~1problem+json/examples/invoice_not_found"]}},"schemaId":"components/schemas/NotFoundProblem","exampleIds":["paths/~1channels~1{channel_id}/patch/responses/404/content/application~1problem+json/examples/address_not_found","paths/~1channels~1{channel_id}/patch/responses/404/content/application~1problem+json/examples/invoice_not_found"]},{"code":"409","description":"Request conflicts with the current resource state.","mediaType":"application/problem+json","mediaTypes":["application/problem+json"],"mediaTypeContent":{"application/problem+json":{"schemaId":"components/schemas/ConflictProblem","exampleIds":["paths/~1channels~1{channel_id}/patch/responses/409/content/application~1problem+json/examples/address_occupied","paths/~1channels~1{channel_id}/patch/responses/409/content/application~1problem+json/examples/address_in_use","paths/~1channels~1{channel_id}/patch/responses/409/content/application~1problem+json/examples/subscription_v1_conflict","paths/~1channels~1{channel_id}/patch/responses/409/content/application~1problem+json/examples/notification_send_in_progress","paths/~1channels~1{channel_id}/patch/responses/409/content/application~1problem+json/examples/notification_payload_unavailable","paths/~1channels~1{channel_id}/patch/responses/409/content/application~1problem+json/examples/notification_test_resend_not_allowed"]}},"schemaId":"components/schemas/ConflictProblem","exampleIds":["paths/~1channels~1{channel_id}/patch/responses/409/content/application~1problem+json/examples/address_occupied","paths/~1channels~1{channel_id}/patch/responses/409/content/application~1problem+json/examples/address_in_use","paths/~1channels~1{channel_id}/patch/responses/409/content/application~1problem+json/examples/subscription_v1_conflict","paths/~1channels~1{channel_id}/patch/responses/409/content/application~1problem+json/examples/notification_send_in_progress","paths/~1channels~1{channel_id}/patch/responses/409/content/application~1problem+json/examples/notification_payload_unavailable","paths/~1channels~1{channel_id}/patch/responses/409/content/application~1problem+json/examples/notification_test_resend_not_allowed"]},{"code":"503","description":"The operation is temporarily unavailable. Please try again later.","mediaType":"application/problem+json","mediaTypes":["application/problem+json"],"mediaTypeContent":{"application/problem+json":{"schemaId":"components/schemas/Problem","exampleIds":["paths/~1channels~1{channel_id}/patch/responses/503/content/application~1problem+json/examples/temporarily_unavailable"]}},"schemaId":"components/schemas/Problem","exampleIds":["paths/~1channels~1{channel_id}/patch/responses/503/content/application~1problem+json/examples/temporarily_unavailable"]},{"code":"default","description":"Unexpected error.","mediaType":"application/problem+json","mediaTypes":["application/problem+json"],"mediaTypeContent":{"application/problem+json":{"schemaId":"components/schemas/Problem"}},"schemaId":"components/schemas/Problem"}],"pointer":"/paths/~1channels~1{channel_id}/patch/responses"}],"panels":[{"children":[{"kind":"response","responseCodes":[{"code":"200","schemaId":"schema_55","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"schema_55"}}},{"code":"400","schemaId":"components/schemas/InvalidRequestProblem","exampleIds":["paths/~1channels~1{channel_id}/patch/responses/400/content/application~1problem+json/examples/malformed_json"],"mediaTypes":["application/problem+json"],"mediaTypeContent":{"application/problem+json":{"schemaId":"components/schemas/InvalidRequestProblem","exampleIds":["paths/~1channels~1{channel_id}/patch/responses/400/content/application~1problem+json/examples/malformed_json"]}}},{"code":"401","schemaId":"components/schemas/UnauthorizedProblem","exampleIds":["paths/~1channels~1{channel_id}/patch/responses/401/content/application~1problem+json/examples/service_authentication_denied"],"mediaTypes":["application/problem+json"],"mediaTypeContent":{"application/problem+json":{"schemaId":"components/schemas/UnauthorizedProblem","exampleIds":["paths/~1channels~1{channel_id}/patch/responses/401/content/application~1problem+json/examples/service_authentication_denied"]}}},{"code":"403","schemaId":"components/schemas/ForbiddenProblem","exampleIds":["paths/~1channels~1{channel_id}/patch/responses/403/content/application~1problem+json/examples/insufficient_permissions"],"mediaTypes":["application/problem+json"],"mediaTypeContent":{"application/problem+json":{"schemaId":"components/schemas/ForbiddenProblem","exampleIds":["paths/~1channels~1{channel_id}/patch/responses/403/content/application~1problem+json/examples/insufficient_permissions"]}}},{"code":"404","schemaId":"components/schemas/NotFoundProblem","exampleIds":["paths/~1channels~1{channel_id}/patch/responses/404/content/application~1problem+json/examples/address_not_found","paths/~1channels~1{channel_id}/patch/responses/404/content/application~1problem+json/examples/invoice_not_found"],"mediaTypes":["application/problem+json"],"mediaTypeContent":{"application/problem+json":{"schemaId":"components/schemas/NotFoundProblem","exampleIds":["paths/~1channels~1{channel_id}/patch/responses/404/content/application~1problem+json/examples/address_not_found","paths/~1channels~1{channel_id}/patch/responses/404/content/application~1problem+json/examples/invoice_not_found"]}}},{"code":"409","schemaId":"components/schemas/ConflictProblem","exampleIds":["paths/~1channels~1{channel_id}/patch/responses/409/content/application~1problem+json/examples/address_occupied","paths/~1channels~1{channel_id}/patch/responses/409/content/application~1problem+json/examples/address_in_use","paths/~1channels~1{channel_id}/patch/responses/409/content/application~1problem+json/examples/subscription_v1_conflict","paths/~1channels~1{channel_id}/patch/responses/409/content/application~1problem+json/examples/notification_send_in_progress","paths/~1channels~1{channel_id}/patch/responses/409/content/application~1problem+json/examples/notification_payload_unavailable","paths/~1channels~1{channel_id}/patch/responses/409/content/application~1problem+json/examples/notification_test_resend_not_allowed"],"mediaTypes":["application/problem+json"],"mediaTypeContent":{"application/problem+json":{"schemaId":"components/schemas/ConflictProblem","exampleIds":["paths/~1channels~1{channel_id}/patch/responses/409/content/application~1problem+json/examples/address_occupied","paths/~1channels~1{channel_id}/patch/responses/409/content/application~1problem+json/examples/address_in_use","paths/~1channels~1{channel_id}/patch/responses/409/content/application~1problem+json/examples/subscription_v1_conflict","paths/~1channels~1{channel_id}/patch/responses/409/content/application~1problem+json/examples/notification_send_in_progress","paths/~1channels~1{channel_id}/patch/responses/409/content/application~1problem+json/examples/notification_payload_unavailable","paths/~1channels~1{channel_id}/patch/responses/409/content/application~1problem+json/examples/notification_test_resend_not_allowed"]}}},{"code":"503","schemaId":"components/schemas/Problem","exampleIds":["paths/~1channels~1{channel_id}/patch/responses/503/content/application~1problem+json/examples/temporarily_unavailable"],"mediaTypes":["application/problem+json"],"mediaTypeContent":{"application/problem+json":{"schemaId":"components/schemas/Problem","exampleIds":["paths/~1channels~1{channel_id}/patch/responses/503/content/application~1problem+json/examples/temporarily_unavailable"]}}},{"code":"default","schemaId":"components/schemas/Problem","mediaTypes":["application/problem+json"],"mediaTypeContent":{"application/problem+json":{"schemaId":"components/schemas/Problem"}}}],"examples":[]}]}]},{"nodeType":"container","children":[{"nodeType":"feedback","pageSlug":"/channel/patch-channel"}],"panels":[]}]},"httpPath":"/channels/{channel_id}"},{"label":"Test channel","deprecated":false,"httpVerb":"post","isAdditionalOperation":false,"isWebhook":false,"type":"link","link":"/apis/platform/api/channel/test-channel","routeSlug":"/apis/platform/api/channel/test-channel","metadata":{"seo":{"title":"Test channel","description":"Send a synthetic message of the given family through the channel, rendered in the channel's ownformat. A disabled channel may be tested; the test does not change channel state. One attempt ismade and no automatic retry follows it, and a test that has not started within five minutesexpires. Each new Idempotency-Key starts a new test; retrying the same key replays itsaccepted result while replay is available."}},"content":{"contentType":"item","itemVariant":"httpItem","meta":{"sourceId":"test-channel","name":"Test channel","isWebhook":false,"pointer":"/paths/~1channels~1{channel_id}~1actions~1test/post","hasSamples":true},"children":[{"nodeType":"container","children":[{"nodeType":"header","level":2,"label":"Test channel","isWebhook":false,"showPageActions":true}],"panels":[]},{"nodeType":"container","children":[{"nodeType":"header","level":4,"label":"Request","labelTranslationKey":"request","deepLinkSuffix":"request"},{"nodeType":"markdoc","content":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Send a synthetic message of the given family through the channel, rendered in the channel's own"},"children":[]},{"$$mdtype":"Node","type":"softbreak","inline":true,"attributes":{},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"format. A disabled channel may be tested; the test does not change channel state. One attempt is"},"children":[]},{"$$mdtype":"Node","type":"softbreak","inline":true,"attributes":{},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"made and no automatic retry follows it, and a test that has not started within five minutes"},"children":[]},{"$$mdtype":"Node","type":"softbreak","inline":true,"attributes":{},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"expires. Each new "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"Idempotency-Key"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" starts a new test; retrying the same key replays its"},"children":[]},{"$$mdtype":"Node","type":"softbreak","inline":true,"attributes":{},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"accepted result while replay is available."},"children":[]}]}]}]},{"nodeType":"security","requirements":[{"schemes":[{"name":"Auth","scopes":["api:channel:write"],"type":"apiKey","in":"header","paramName":"X-Api-Key","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"API key for authenticating requests. Include your key in the "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"X-Api-Key"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" header. Keys can be created in the Vilna Dashboard or via the Management API. The scopes listed per operation indicate which permissions the key must have."},"children":[]}]}]}]}]}]},{"nodeType":"item-content","variant":"path","label":"Path","labelTranslationKey":"path","parameters":[{"name":"channel_id","in":"path","schemaId":"schema_17","description":"Unique identifier (UUID) of the channel.","required":true}],"pointer":"/paths/~1channels~1{channel_id}~1actions~1test/post/parameters"},{"nodeType":"item-content","variant":"headers","label":"Headers","labelTranslationKey":"header","parameters":[{"name":"Idempotency-Key","in":"header","schemaId":"schema_14","description":"Case-sensitive opaque key for one mutation intent. Send exactly one header occurrence containing 1 to 128 visible ASCII bytes (0x21..0x7e). Commas are literal data; do not trim, lowercase or require UUID syntax. Reuse the same key for retries, with current authorization checked on every attempt. Repeated header occurrences are rejected.\n","required":true}],"pointer":"/paths/~1channels~1{channel_id}~1actions~1test/post/parameters"},{"nodeType":"item-content","variant":"body","label":"Request Body","labelTranslationKey":"body","required":true,"mediaTypes":["application/json"],"mediaTypeSchemas":{"application/json":{"schemaId":"components/schemas/TestChannelRequest","exampleIds":["paths/~1channels~1{channel_id}~1actions~1test/post/requestBody/content/application~1json/examples/evm_test","paths/~1channels~1{channel_id}~1actions~1test/post/requestBody/content/application~1json/examples/bitcoin_test"]}},"schemaId":"components/schemas/TestChannelRequest","exampleIds":["paths/~1channels~1{channel_id}~1actions~1test/post/requestBody/content/application~1json/examples/evm_test","paths/~1channels~1{channel_id}~1actions~1test/post/requestBody/content/application~1json/examples/bitcoin_test"],"pointer":"/paths/~1channels~1{channel_id}~1actions~1test/post/requestBody"}],"panels":[{"children":[{"kind":"code-sample","source":{"kind":"code-sample","operationType":"http","method":"POST","path":"/channels/{channel_id}/actions/test","servers":[{"url":"/_mock/apis/platform/api","description":"Mock server","isMockServer":true},{"url":"https://api.vilna.io/v2","description":"Vilna API."}],"parameters":{"path":[{"name":"channel_id","in":"path","required":true,"example":"550e8400-e29b-41d4-a716-446655440000","schemaId":"components/schemas/UUID"}],"query":[],"querystring":[],"header":[{"name":"Idempotency-Key","in":"header","required":true,"schemaId":"schema_14"}],"cookie":[]},"security":[{"schemes":[{"id":"Auth","type":"apiKey","name":"X-Api-Key","in":"header"}],"scopes":["api:channel:write"]}],"requestBody":{"application/json":{"schemaId":"components/schemas/TestChannelRequest","exampleIds":["paths/~1channels~1{channel_id}~1actions~1test/post/requestBody/content/application~1json/examples/evm_test","paths/~1channels~1{channel_id}~1actions~1test/post/requestBody/content/application~1json/examples/bitcoin_test"]}},"responseCodes":["202","400","401","403","404","409","422","503","default"],"pointer":"/channels/{channel_id}/actions/test","href":"channel/test-channel","openApiOperationId":"test-channel","summary":"Test channel"},"isWebhook":false,"hideReplay":false,"servers":[{"url":"/_mock/apis/platform/api","description":"Mock server","isMockServer":true},{"url":"https://api.vilna.io/v2","description":"Vilna API."}],"schemaId":"components/schemas/TestChannelRequest","exampleIds":["paths/~1channels~1{channel_id}~1actions~1test/post/requestBody/content/application~1json/examples/evm_test","paths/~1channels~1{channel_id}~1actions~1test/post/requestBody/content/application~1json/examples/bitcoin_test"],"mediaTypes":["application/json"],"mediaTypeSchemas":{"application/json":{"schemaId":"components/schemas/TestChannelRequest","exampleIds":["paths/~1channels~1{channel_id}~1actions~1test/post/requestBody/content/application~1json/examples/evm_test","paths/~1channels~1{channel_id}~1actions~1test/post/requestBody/content/application~1json/examples/bitcoin_test"]}},"examples":[{},{}]}]}]},{"nodeType":"container","children":[{"nodeType":"header","level":4,"label":"Responses","labelTranslationKey":"responses","deepLinkSuffix":"responses"},{"nodeType":"item-content","variant":"responses","responses":[{"code":"202","description":"Test notification accepted for delivery; nothing has been delivered yet.","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/NotificationAccepted"}},"schemaId":"components/schemas/NotificationAccepted"},{"code":"400","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Bad request (e.g., missing or invalid fields). Invalid text may be reported as address.label_invalid, address.meta_invalid, public_key.label_invalid, invoice.comment_invalid, invoice.metadata_invalid."},"children":[]}]}]}],"mediaType":"application/problem+json","mediaTypes":["application/problem+json"],"mediaTypeContent":{"application/problem+json":{"schemaId":"components/schemas/InvalidRequestProblem","exampleIds":["paths/~1channels~1{channel_id}~1actions~1test/post/responses/400/content/application~1problem+json/examples/malformed_json"]}},"schemaId":"components/schemas/InvalidRequestProblem","exampleIds":["paths/~1channels~1{channel_id}~1actions~1test/post/responses/400/content/application~1problem+json/examples/malformed_json"]},{"code":"401","description":"Missing or invalid authentication credentials.","mediaType":"application/problem+json","mediaTypes":["application/problem+json"],"mediaTypeContent":{"application/problem+json":{"schemaId":"components/schemas/UnauthorizedProblem","exampleIds":["paths/~1channels~1{channel_id}~1actions~1test/post/responses/401/content/application~1problem+json/examples/service_authentication_denied"]}},"schemaId":"components/schemas/UnauthorizedProblem","exampleIds":["paths/~1channels~1{channel_id}~1actions~1test/post/responses/401/content/application~1problem+json/examples/service_authentication_denied"]},{"code":"403","description":"Insufficient permissions.","mediaType":"application/problem+json","mediaTypes":["application/problem+json"],"mediaTypeContent":{"application/problem+json":{"schemaId":"components/schemas/ForbiddenProblem","exampleIds":["paths/~1channels~1{channel_id}~1actions~1test/post/responses/403/content/application~1problem+json/examples/insufficient_permissions"]}},"schemaId":"components/schemas/ForbiddenProblem","exampleIds":["paths/~1channels~1{channel_id}~1actions~1test/post/responses/403/content/application~1problem+json/examples/insufficient_permissions"]},{"code":"404","description":"Requested resource does not exist.","mediaType":"application/problem+json","mediaTypes":["application/problem+json"],"mediaTypeContent":{"application/problem+json":{"schemaId":"components/schemas/NotFoundProblem","exampleIds":["paths/~1channels~1{channel_id}~1actions~1test/post/responses/404/content/application~1problem+json/examples/address_not_found","paths/~1channels~1{channel_id}~1actions~1test/post/responses/404/content/application~1problem+json/examples/invoice_not_found"]}},"schemaId":"components/schemas/NotFoundProblem","exampleIds":["paths/~1channels~1{channel_id}~1actions~1test/post/responses/404/content/application~1problem+json/examples/address_not_found","paths/~1channels~1{channel_id}~1actions~1test/post/responses/404/content/application~1problem+json/examples/invoice_not_found"]},{"code":"409","description":"Request conflicts with the current resource state.","mediaType":"application/problem+json","mediaTypes":["application/problem+json"],"mediaTypeContent":{"application/problem+json":{"schemaId":"components/schemas/ConflictProblem","exampleIds":["paths/~1channels~1{channel_id}~1actions~1test/post/responses/409/content/application~1problem+json/examples/address_occupied","paths/~1channels~1{channel_id}~1actions~1test/post/responses/409/content/application~1problem+json/examples/address_in_use","paths/~1channels~1{channel_id}~1actions~1test/post/responses/409/content/application~1problem+json/examples/subscription_v1_conflict","paths/~1channels~1{channel_id}~1actions~1test/post/responses/409/content/application~1problem+json/examples/notification_send_in_progress","paths/~1channels~1{channel_id}~1actions~1test/post/responses/409/content/application~1problem+json/examples/notification_payload_unavailable","paths/~1channels~1{channel_id}~1actions~1test/post/responses/409/content/application~1problem+json/examples/notification_test_resend_not_allowed"]}},"schemaId":"components/schemas/ConflictProblem","exampleIds":["paths/~1channels~1{channel_id}~1actions~1test/post/responses/409/content/application~1problem+json/examples/address_occupied","paths/~1channels~1{channel_id}~1actions~1test/post/responses/409/content/application~1problem+json/examples/address_in_use","paths/~1channels~1{channel_id}~1actions~1test/post/responses/409/content/application~1problem+json/examples/subscription_v1_conflict","paths/~1channels~1{channel_id}~1actions~1test/post/responses/409/content/application~1problem+json/examples/notification_send_in_progress","paths/~1channels~1{channel_id}~1actions~1test/post/responses/409/content/application~1problem+json/examples/notification_payload_unavailable","paths/~1channels~1{channel_id}~1actions~1test/post/responses/409/content/application~1problem+json/examples/notification_test_resend_not_allowed"]},{"code":"422","description":"Request preconditions were not met.","mediaType":"application/problem+json","mediaTypes":["application/problem+json"],"mediaTypeContent":{"application/problem+json":{"schemaId":"components/schemas/PreconditionProblem","exampleIds":["paths/~1channels~1{channel_id}~1actions~1test/post/responses/422/content/application~1problem+json/examples/invoice_not_cancellable"]}},"schemaId":"components/schemas/PreconditionProblem","exampleIds":["paths/~1channels~1{channel_id}~1actions~1test/post/responses/422/content/application~1problem+json/examples/invoice_not_cancellable"]},{"code":"503","description":"The operation is temporarily unavailable. Please try again later.","mediaType":"application/problem+json","mediaTypes":["application/problem+json"],"mediaTypeContent":{"application/problem+json":{"schemaId":"components/schemas/Problem","exampleIds":["paths/~1channels~1{channel_id}~1actions~1test/post/responses/503/content/application~1problem+json/examples/temporarily_unavailable"]}},"schemaId":"components/schemas/Problem","exampleIds":["paths/~1channels~1{channel_id}~1actions~1test/post/responses/503/content/application~1problem+json/examples/temporarily_unavailable"]},{"code":"default","description":"Unexpected error.","mediaType":"application/problem+json","mediaTypes":["application/problem+json"],"mediaTypeContent":{"application/problem+json":{"schemaId":"components/schemas/Problem"}},"schemaId":"components/schemas/Problem"}],"pointer":"/paths/~1channels~1{channel_id}~1actions~1test/post/responses"}],"panels":[{"children":[{"kind":"response","responseCodes":[{"code":"202","schemaId":"components/schemas/NotificationAccepted","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/NotificationAccepted"}}},{"code":"400","schemaId":"components/schemas/InvalidRequestProblem","exampleIds":["paths/~1channels~1{channel_id}~1actions~1test/post/responses/400/content/application~1problem+json/examples/malformed_json"],"mediaTypes":["application/problem+json"],"mediaTypeContent":{"application/problem+json":{"schemaId":"components/schemas/InvalidRequestProblem","exampleIds":["paths/~1channels~1{channel_id}~1actions~1test/post/responses/400/content/application~1problem+json/examples/malformed_json"]}}},{"code":"401","schemaId":"components/schemas/UnauthorizedProblem","exampleIds":["paths/~1channels~1{channel_id}~1actions~1test/post/responses/401/content/application~1problem+json/examples/service_authentication_denied"],"mediaTypes":["application/problem+json"],"mediaTypeContent":{"application/problem+json":{"schemaId":"components/schemas/UnauthorizedProblem","exampleIds":["paths/~1channels~1{channel_id}~1actions~1test/post/responses/401/content/application~1problem+json/examples/service_authentication_denied"]}}},{"code":"403","schemaId":"components/schemas/ForbiddenProblem","exampleIds":["paths/~1channels~1{channel_id}~1actions~1test/post/responses/403/content/application~1problem+json/examples/insufficient_permissions"],"mediaTypes":["application/problem+json"],"mediaTypeContent":{"application/problem+json":{"schemaId":"components/schemas/ForbiddenProblem","exampleIds":["paths/~1channels~1{channel_id}~1actions~1test/post/responses/403/content/application~1problem+json/examples/insufficient_permissions"]}}},{"code":"404","schemaId":"components/schemas/NotFoundProblem","exampleIds":["paths/~1channels~1{channel_id}~1actions~1test/post/responses/404/content/application~1problem+json/examples/address_not_found","paths/~1channels~1{channel_id}~1actions~1test/post/responses/404/content/application~1problem+json/examples/invoice_not_found"],"mediaTypes":["application/problem+json"],"mediaTypeContent":{"application/problem+json":{"schemaId":"components/schemas/NotFoundProblem","exampleIds":["paths/~1channels~1{channel_id}~1actions~1test/post/responses/404/content/application~1problem+json/examples/address_not_found","paths/~1channels~1{channel_id}~1actions~1test/post/responses/404/content/application~1problem+json/examples/invoice_not_found"]}}},{"code":"409","schemaId":"components/schemas/ConflictProblem","exampleIds":["paths/~1channels~1{channel_id}~1actions~1test/post/responses/409/content/application~1problem+json/examples/address_occupied","paths/~1channels~1{channel_id}~1actions~1test/post/responses/409/content/application~1problem+json/examples/address_in_use","paths/~1channels~1{channel_id}~1actions~1test/post/responses/409/content/application~1problem+json/examples/subscription_v1_conflict","paths/~1channels~1{channel_id}~1actions~1test/post/responses/409/content/application~1problem+json/examples/notification_send_in_progress","paths/~1channels~1{channel_id}~1actions~1test/post/responses/409/content/application~1problem+json/examples/notification_payload_unavailable","paths/~1channels~1{channel_id}~1actions~1test/post/responses/409/content/application~1problem+json/examples/notification_test_resend_not_allowed"],"mediaTypes":["application/problem+json"],"mediaTypeContent":{"application/problem+json":{"schemaId":"components/schemas/ConflictProblem","exampleIds":["paths/~1channels~1{channel_id}~1actions~1test/post/responses/409/content/application~1problem+json/examples/address_occupied","paths/~1channels~1{channel_id}~1actions~1test/post/responses/409/content/application~1problem+json/examples/address_in_use","paths/~1channels~1{channel_id}~1actions~1test/post/responses/409/content/application~1problem+json/examples/subscription_v1_conflict","paths/~1channels~1{channel_id}~1actions~1test/post/responses/409/content/application~1problem+json/examples/notification_send_in_progress","paths/~1channels~1{channel_id}~1actions~1test/post/responses/409/content/application~1problem+json/examples/notification_payload_unavailable","paths/~1channels~1{channel_id}~1actions~1test/post/responses/409/content/application~1problem+json/examples/notification_test_resend_not_allowed"]}}},{"code":"422","schemaId":"components/schemas/PreconditionProblem","exampleIds":["paths/~1channels~1{channel_id}~1actions~1test/post/responses/422/content/application~1problem+json/examples/invoice_not_cancellable"],"mediaTypes":["application/problem+json"],"mediaTypeContent":{"application/problem+json":{"schemaId":"components/schemas/PreconditionProblem","exampleIds":["paths/~1channels~1{channel_id}~1actions~1test/post/responses/422/content/application~1problem+json/examples/invoice_not_cancellable"]}}},{"code":"503","schemaId":"components/schemas/Problem","exampleIds":["paths/~1channels~1{channel_id}~1actions~1test/post/responses/503/content/application~1problem+json/examples/temporarily_unavailable"],"mediaTypes":["application/problem+json"],"mediaTypeContent":{"application/problem+json":{"schemaId":"components/schemas/Problem","exampleIds":["paths/~1channels~1{channel_id}~1actions~1test/post/responses/503/content/application~1problem+json/examples/temporarily_unavailable"]}}},{"code":"default","schemaId":"components/schemas/Problem","mediaTypes":["application/problem+json"],"mediaTypeContent":{"application/problem+json":{"schemaId":"components/schemas/Problem"}}}],"examples":[]}]}]},{"nodeType":"container","children":[{"nodeType":"feedback","pageSlug":"/channel/test-channel"}],"panels":[]}]},"httpPath":"/channels/{channel_id}/actions/test"},{"label":"Get webhook signing secrets","deprecated":false,"httpVerb":"get","isAdditionalOperation":false,"isWebhook":false,"type":"link","link":"/apis/platform/api/channel/get-channel-webhook-secrets","routeSlug":"/apis/platform/api/channel/get-channel-webhook-secrets","metadata":{"seo":{"title":"Get webhook signing secrets","description":"Returns the channel's signing secrets: always a current secret, plus aprevious secret during the 24-hour rotation overlap window."}},"content":{"contentType":"item","itemVariant":"httpItem","meta":{"sourceId":"get-channel-webhook-secrets","name":"Get webhook signing secrets","isWebhook":false,"pointer":"/paths/~1channels~1{channel_id}~1webhook-secrets/get","hasSamples":false},"children":[{"nodeType":"container","children":[{"nodeType":"header","level":2,"label":"Get webhook signing secrets","isWebhook":false,"showPageActions":true}],"panels":[]},{"nodeType":"container","children":[{"nodeType":"header","level":4,"label":"Request","labelTranslationKey":"request","deepLinkSuffix":"request"},{"nodeType":"markdoc","content":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Returns the channel's signing secrets: always a "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"current"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" secret, plus a"},"children":[]},{"$$mdtype":"Node","type":"softbreak","inline":true,"attributes":{},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"previous"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" secret during the 24-hour rotation overlap window."},"children":[]}]}]},{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Only valid for channels with "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"kind=webhook"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"; otherwise returns 400."},"children":[]}]}]}]},{"nodeType":"security","requirements":[{"schemes":[{"name":"Auth","scopes":["api:channel:read"],"type":"apiKey","in":"header","paramName":"X-Api-Key","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"API key for authenticating requests. Include your key in the "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"X-Api-Key"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" header. Keys can be created in the Vilna Dashboard or via the Management API. The scopes listed per operation indicate which permissions the key must have."},"children":[]}]}]}]}]}]},{"nodeType":"item-content","variant":"path","label":"Path","labelTranslationKey":"path","parameters":[{"name":"channel_id","in":"path","schemaId":"schema_17","description":"Unique identifier (UUID) of the channel.","required":true}],"pointer":"/paths/~1channels~1{channel_id}~1webhook-secrets/get/parameters"}],"panels":[{"children":[{"kind":"code-sample","source":{"kind":"code-sample","operationType":"http","method":"GET","path":"/channels/{channel_id}/webhook-secrets","servers":[{"url":"/_mock/apis/platform/api","description":"Mock server","isMockServer":true},{"url":"https://api.vilna.io/v2","description":"Vilna API."}],"parameters":{"path":[{"name":"channel_id","in":"path","required":true,"example":"550e8400-e29b-41d4-a716-446655440000","schemaId":"components/schemas/UUID"}],"query":[],"querystring":[],"header":[],"cookie":[]},"security":[{"schemes":[{"id":"Auth","type":"apiKey","name":"X-Api-Key","in":"header"}],"scopes":["api:channel:read"]}],"responseCodes":["200","400","401","403","404","503","default"],"pointer":"/channels/{channel_id}/webhook-secrets","href":"channel/get-channel-webhook-secrets","openApiOperationId":"get-channel-webhook-secrets","summary":"Get webhook signing secrets"},"isWebhook":false,"hideReplay":false,"servers":[{"url":"/_mock/apis/platform/api","description":"Mock server","isMockServer":true},{"url":"https://api.vilna.io/v2","description":"Vilna API."}],"examples":[]}]}]},{"nodeType":"container","children":[{"nodeType":"header","level":4,"label":"Responses","labelTranslationKey":"responses","deepLinkSuffix":"responses"},{"nodeType":"item-content","variant":"responses","responses":[{"code":"200","description":"Webhook signing secrets for the channel.","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"schema_56"}},"schemaId":"schema_56"},{"code":"400","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Bad request (e.g., missing or invalid fields). Invalid text may be reported as address.label_invalid, address.meta_invalid, public_key.label_invalid, invoice.comment_invalid, invoice.metadata_invalid."},"children":[]}]}]}],"mediaType":"application/problem+json","mediaTypes":["application/problem+json"],"mediaTypeContent":{"application/problem+json":{"schemaId":"components/schemas/InvalidRequestProblem","exampleIds":["paths/~1channels~1{channel_id}~1webhook-secrets/get/responses/400/content/application~1problem+json/examples/malformed_json"]}},"schemaId":"components/schemas/InvalidRequestProblem","exampleIds":["paths/~1channels~1{channel_id}~1webhook-secrets/get/responses/400/content/application~1problem+json/examples/malformed_json"]},{"code":"401","description":"Missing or invalid authentication credentials.","mediaType":"application/problem+json","mediaTypes":["application/problem+json"],"mediaTypeContent":{"application/problem+json":{"schemaId":"components/schemas/UnauthorizedProblem","exampleIds":["paths/~1channels~1{channel_id}~1webhook-secrets/get/responses/401/content/application~1problem+json/examples/service_authentication_denied"]}},"schemaId":"components/schemas/UnauthorizedProblem","exampleIds":["paths/~1channels~1{channel_id}~1webhook-secrets/get/responses/401/content/application~1problem+json/examples/service_authentication_denied"]},{"code":"403","description":"Insufficient permissions.","mediaType":"application/problem+json","mediaTypes":["application/problem+json"],"mediaTypeContent":{"application/problem+json":{"schemaId":"components/schemas/ForbiddenProblem","exampleIds":["paths/~1channels~1{channel_id}~1webhook-secrets/get/responses/403/content/application~1problem+json/examples/insufficient_permissions"]}},"schemaId":"components/schemas/ForbiddenProblem","exampleIds":["paths/~1channels~1{channel_id}~1webhook-secrets/get/responses/403/content/application~1problem+json/examples/insufficient_permissions"]},{"code":"404","description":"Requested resource does not exist.","mediaType":"application/problem+json","mediaTypes":["application/problem+json"],"mediaTypeContent":{"application/problem+json":{"schemaId":"components/schemas/NotFoundProblem","exampleIds":["paths/~1channels~1{channel_id}~1webhook-secrets/get/responses/404/content/application~1problem+json/examples/address_not_found","paths/~1channels~1{channel_id}~1webhook-secrets/get/responses/404/content/application~1problem+json/examples/invoice_not_found"]}},"schemaId":"components/schemas/NotFoundProblem","exampleIds":["paths/~1channels~1{channel_id}~1webhook-secrets/get/responses/404/content/application~1problem+json/examples/address_not_found","paths/~1channels~1{channel_id}~1webhook-secrets/get/responses/404/content/application~1problem+json/examples/invoice_not_found"]},{"code":"503","description":"The operation is temporarily unavailable. Please try again later.","mediaType":"application/problem+json","mediaTypes":["application/problem+json"],"mediaTypeContent":{"application/problem+json":{"schemaId":"components/schemas/Problem","exampleIds":["paths/~1channels~1{channel_id}~1webhook-secrets/get/responses/503/content/application~1problem+json/examples/temporarily_unavailable"]}},"schemaId":"components/schemas/Problem","exampleIds":["paths/~1channels~1{channel_id}~1webhook-secrets/get/responses/503/content/application~1problem+json/examples/temporarily_unavailable"]},{"code":"default","description":"Unexpected error.","mediaType":"application/problem+json","mediaTypes":["application/problem+json"],"mediaTypeContent":{"application/problem+json":{"schemaId":"components/schemas/Problem"}},"schemaId":"components/schemas/Problem"}],"pointer":"/paths/~1channels~1{channel_id}~1webhook-secrets/get/responses"}],"panels":[{"children":[{"kind":"response","responseCodes":[{"code":"200","schemaId":"schema_56","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"schema_56"}}},{"code":"400","schemaId":"components/schemas/InvalidRequestProblem","exampleIds":["paths/~1channels~1{channel_id}~1webhook-secrets/get/responses/400/content/application~1problem+json/examples/malformed_json"],"mediaTypes":["application/problem+json"],"mediaTypeContent":{"application/problem+json":{"schemaId":"components/schemas/InvalidRequestProblem","exampleIds":["paths/~1channels~1{channel_id}~1webhook-secrets/get/responses/400/content/application~1problem+json/examples/malformed_json"]}}},{"code":"401","schemaId":"components/schemas/UnauthorizedProblem","exampleIds":["paths/~1channels~1{channel_id}~1webhook-secrets/get/responses/401/content/application~1problem+json/examples/service_authentication_denied"],"mediaTypes":["application/problem+json"],"mediaTypeContent":{"application/problem+json":{"schemaId":"components/schemas/UnauthorizedProblem","exampleIds":["paths/~1channels~1{channel_id}~1webhook-secrets/get/responses/401/content/application~1problem+json/examples/service_authentication_denied"]}}},{"code":"403","schemaId":"components/schemas/ForbiddenProblem","exampleIds":["paths/~1channels~1{channel_id}~1webhook-secrets/get/responses/403/content/application~1problem+json/examples/insufficient_permissions"],"mediaTypes":["application/problem+json"],"mediaTypeContent":{"application/problem+json":{"schemaId":"components/schemas/ForbiddenProblem","exampleIds":["paths/~1channels~1{channel_id}~1webhook-secrets/get/responses/403/content/application~1problem+json/examples/insufficient_permissions"]}}},{"code":"404","schemaId":"components/schemas/NotFoundProblem","exampleIds":["paths/~1channels~1{channel_id}~1webhook-secrets/get/responses/404/content/application~1problem+json/examples/address_not_found","paths/~1channels~1{channel_id}~1webhook-secrets/get/responses/404/content/application~1problem+json/examples/invoice_not_found"],"mediaTypes":["application/problem+json"],"mediaTypeContent":{"application/problem+json":{"schemaId":"components/schemas/NotFoundProblem","exampleIds":["paths/~1channels~1{channel_id}~1webhook-secrets/get/responses/404/content/application~1problem+json/examples/address_not_found","paths/~1channels~1{channel_id}~1webhook-secrets/get/responses/404/content/application~1problem+json/examples/invoice_not_found"]}}},{"code":"503","schemaId":"components/schemas/Problem","exampleIds":["paths/~1channels~1{channel_id}~1webhook-secrets/get/responses/503/content/application~1problem+json/examples/temporarily_unavailable"],"mediaTypes":["application/problem+json"],"mediaTypeContent":{"application/problem+json":{"schemaId":"components/schemas/Problem","exampleIds":["paths/~1channels~1{channel_id}~1webhook-secrets/get/responses/503/content/application~1problem+json/examples/temporarily_unavailable"]}}},{"code":"default","schemaId":"components/schemas/Problem","mediaTypes":["application/problem+json"],"mediaTypeContent":{"application/problem+json":{"schemaId":"components/schemas/Problem"}}}],"examples":[]}]}]},{"nodeType":"container","children":[{"nodeType":"feedback","pageSlug":"/channel/get-channel-webhook-secrets"}],"panels":[]}]},"httpPath":"/channels/{channel_id}/webhook-secrets"},{"label":"Rotate webhook signing secret","deprecated":false,"httpVerb":"post","isAdditionalOperation":false,"isWebhook":false,"type":"link","link":"/apis/platform/api/channel/rotate-channel-webhook-secret","routeSlug":"/apis/platform/api/channel/rotate-channel-webhook-secret","metadata":{"seo":{"title":"Rotate webhook signing secret","description":"Issues a new signing secret, demotes the existing current to previous fora 24-hour overlap window, and returns the new plaintext value. Theplaintext is returned only here; store it immediately."}},"content":{"contentType":"item","itemVariant":"httpItem","meta":{"sourceId":"rotate-channel-webhook-secret","name":"Rotate webhook signing secret","isWebhook":false,"pointer":"/paths/~1channels~1{channel_id}~1webhook-secrets~1actions~1rotate/post","hasSamples":false},"children":[{"nodeType":"container","children":[{"nodeType":"header","level":2,"label":"Rotate webhook signing secret","isWebhook":false,"showPageActions":true}],"panels":[]},{"nodeType":"container","children":[{"nodeType":"header","level":4,"label":"Request","labelTranslationKey":"request","deepLinkSuffix":"request"},{"nodeType":"markdoc","content":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Issues a new signing secret, demotes the existing current to previous for"},"children":[]},{"$$mdtype":"Node","type":"softbreak","inline":true,"attributes":{},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"a 24-hour overlap window, and returns the new plaintext value. The"},"children":[]},{"$$mdtype":"Node","type":"softbreak","inline":true,"attributes":{},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"plaintext is returned only here; store it immediately."},"children":[]}]}]},{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"During the overlap window outgoing webhooks are signed with both secrets:"},"children":[]},{"$$mdtype":"Node","type":"softbreak","inline":true,"attributes":{},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"the "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"X-Webhook-Signature"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" header carries two "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"v1="},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" entries, so receivers"},"children":[]},{"$$mdtype":"Node","type":"softbreak","inline":true,"attributes":{},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"that verify with either secret keep accepting deliveries."},"children":[]}]}]},{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Returns 409 if a previous secret is still within its overlap window;"},"children":[]},{"$$mdtype":"Node","type":"softbreak","inline":true,"attributes":{},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"end it via "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"deleteChannelPreviousWebhookSecret"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" before rotating again."},"children":[]}]}]},{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Only valid for channels with "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"kind=webhook"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"; otherwise returns 400."},"children":[]}]}]}]},{"nodeType":"security","requirements":[{"schemes":[{"name":"Auth","scopes":["api:channel:write"],"type":"apiKey","in":"header","paramName":"X-Api-Key","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"API key for authenticating requests. Include your key in the "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"X-Api-Key"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" header. Keys can be created in the Vilna Dashboard or via the Management API. The scopes listed per operation indicate which permissions the key must have."},"children":[]}]}]}]}]}]},{"nodeType":"item-content","variant":"path","label":"Path","labelTranslationKey":"path","parameters":[{"name":"channel_id","in":"path","schemaId":"schema_17","description":"Unique identifier (UUID) of the channel.","required":true}],"pointer":"/paths/~1channels~1{channel_id}~1webhook-secrets~1actions~1rotate/post/parameters"},{"nodeType":"item-content","variant":"headers","label":"Headers","labelTranslationKey":"header","parameters":[{"name":"Idempotency-Key","in":"header","schemaId":"schema_14","description":"Case-sensitive opaque key for one mutation intent. Send exactly one header occurrence containing 1 to 128 visible ASCII bytes (0x21..0x7e). Commas are literal data; do not trim, lowercase or require UUID syntax. Reuse the same key for retries, with current authorization checked on every attempt. Repeated header occurrences are rejected.\n","required":true}],"pointer":"/paths/~1channels~1{channel_id}~1webhook-secrets~1actions~1rotate/post/parameters"}],"panels":[{"children":[{"kind":"code-sample","source":{"kind":"code-sample","operationType":"http","method":"POST","path":"/channels/{channel_id}/webhook-secrets/actions/rotate","servers":[{"url":"/_mock/apis/platform/api","description":"Mock server","isMockServer":true},{"url":"https://api.vilna.io/v2","description":"Vilna API."}],"parameters":{"path":[{"name":"channel_id","in":"path","required":true,"example":"550e8400-e29b-41d4-a716-446655440000","schemaId":"components/schemas/UUID"}],"query":[],"querystring":[],"header":[{"name":"Idempotency-Key","in":"header","required":true,"schemaId":"schema_14"}],"cookie":[]},"security":[{"schemes":[{"id":"Auth","type":"apiKey","name":"X-Api-Key","in":"header"}],"scopes":["api:channel:write"]}],"responseCodes":["200","400","401","403","404","409","503","default"],"pointer":"/channels/{channel_id}/webhook-secrets/actions/rotate","href":"channel/rotate-channel-webhook-secret","openApiOperationId":"rotate-channel-webhook-secret","summary":"Rotate webhook signing secret"},"isWebhook":false,"hideReplay":false,"servers":[{"url":"/_mock/apis/platform/api","description":"Mock server","isMockServer":true},{"url":"https://api.vilna.io/v2","description":"Vilna API."}],"examples":[]}]}]},{"nodeType":"container","children":[{"nodeType":"header","level":4,"label":"Responses","labelTranslationKey":"responses","deepLinkSuffix":"responses"},{"nodeType":"item-content","variant":"responses","responses":[{"code":"200","description":"Updated webhook signing secrets after rotation, including the new plaintext.","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"schema_57"}},"schemaId":"schema_57"},{"code":"400","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Bad request (e.g., missing or invalid fields). Invalid text may be reported as address.label_invalid, address.meta_invalid, public_key.label_invalid, invoice.comment_invalid, invoice.metadata_invalid."},"children":[]}]}]}],"mediaType":"application/problem+json","mediaTypes":["application/problem+json"],"mediaTypeContent":{"application/problem+json":{"schemaId":"components/schemas/InvalidRequestProblem","exampleIds":["paths/~1channels~1{channel_id}~1webhook-secrets~1actions~1rotate/post/responses/400/content/application~1problem+json/examples/malformed_json"]}},"schemaId":"components/schemas/InvalidRequestProblem","exampleIds":["paths/~1channels~1{channel_id}~1webhook-secrets~1actions~1rotate/post/responses/400/content/application~1problem+json/examples/malformed_json"]},{"code":"401","description":"Missing or invalid authentication credentials.","mediaType":"application/problem+json","mediaTypes":["application/problem+json"],"mediaTypeContent":{"application/problem+json":{"schemaId":"components/schemas/UnauthorizedProblem","exampleIds":["paths/~1channels~1{channel_id}~1webhook-secrets~1actions~1rotate/post/responses/401/content/application~1problem+json/examples/service_authentication_denied"]}},"schemaId":"components/schemas/UnauthorizedProblem","exampleIds":["paths/~1channels~1{channel_id}~1webhook-secrets~1actions~1rotate/post/responses/401/content/application~1problem+json/examples/service_authentication_denied"]},{"code":"403","description":"Insufficient permissions.","mediaType":"application/problem+json","mediaTypes":["application/problem+json"],"mediaTypeContent":{"application/problem+json":{"schemaId":"components/schemas/ForbiddenProblem","exampleIds":["paths/~1channels~1{channel_id}~1webhook-secrets~1actions~1rotate/post/responses/403/content/application~1problem+json/examples/insufficient_permissions"]}},"schemaId":"components/schemas/ForbiddenProblem","exampleIds":["paths/~1channels~1{channel_id}~1webhook-secrets~1actions~1rotate/post/responses/403/content/application~1problem+json/examples/insufficient_permissions"]},{"code":"404","description":"Requested resource does not exist.","mediaType":"application/problem+json","mediaTypes":["application/problem+json"],"mediaTypeContent":{"application/problem+json":{"schemaId":"components/schemas/NotFoundProblem","exampleIds":["paths/~1channels~1{channel_id}~1webhook-secrets~1actions~1rotate/post/responses/404/content/application~1problem+json/examples/address_not_found","paths/~1channels~1{channel_id}~1webhook-secrets~1actions~1rotate/post/responses/404/content/application~1problem+json/examples/invoice_not_found"]}},"schemaId":"components/schemas/NotFoundProblem","exampleIds":["paths/~1channels~1{channel_id}~1webhook-secrets~1actions~1rotate/post/responses/404/content/application~1problem+json/examples/address_not_found","paths/~1channels~1{channel_id}~1webhook-secrets~1actions~1rotate/post/responses/404/content/application~1problem+json/examples/invoice_not_found"]},{"code":"409","description":"Request conflicts with the current resource state.","mediaType":"application/problem+json","mediaTypes":["application/problem+json"],"mediaTypeContent":{"application/problem+json":{"schemaId":"components/schemas/ConflictProblem","exampleIds":["paths/~1channels~1{channel_id}~1webhook-secrets~1actions~1rotate/post/responses/409/content/application~1problem+json/examples/address_occupied","paths/~1channels~1{channel_id}~1webhook-secrets~1actions~1rotate/post/responses/409/content/application~1problem+json/examples/address_in_use","paths/~1channels~1{channel_id}~1webhook-secrets~1actions~1rotate/post/responses/409/content/application~1problem+json/examples/subscription_v1_conflict","paths/~1channels~1{channel_id}~1webhook-secrets~1actions~1rotate/post/responses/409/content/application~1problem+json/examples/notification_send_in_progress","paths/~1channels~1{channel_id}~1webhook-secrets~1actions~1rotate/post/responses/409/content/application~1problem+json/examples/notification_payload_unavailable","paths/~1channels~1{channel_id}~1webhook-secrets~1actions~1rotate/post/responses/409/content/application~1problem+json/examples/notification_test_resend_not_allowed"]}},"schemaId":"components/schemas/ConflictProblem","exampleIds":["paths/~1channels~1{channel_id}~1webhook-secrets~1actions~1rotate/post/responses/409/content/application~1problem+json/examples/address_occupied","paths/~1channels~1{channel_id}~1webhook-secrets~1actions~1rotate/post/responses/409/content/application~1problem+json/examples/address_in_use","paths/~1channels~1{channel_id}~1webhook-secrets~1actions~1rotate/post/responses/409/content/application~1problem+json/examples/subscription_v1_conflict","paths/~1channels~1{channel_id}~1webhook-secrets~1actions~1rotate/post/responses/409/content/application~1problem+json/examples/notification_send_in_progress","paths/~1channels~1{channel_id}~1webhook-secrets~1actions~1rotate/post/responses/409/content/application~1problem+json/examples/notification_payload_unavailable","paths/~1channels~1{channel_id}~1webhook-secrets~1actions~1rotate/post/responses/409/content/application~1problem+json/examples/notification_test_resend_not_allowed"]},{"code":"503","description":"The operation is temporarily unavailable. Please try again later.","mediaType":"application/problem+json","mediaTypes":["application/problem+json"],"mediaTypeContent":{"application/problem+json":{"schemaId":"components/schemas/Problem","exampleIds":["paths/~1channels~1{channel_id}~1webhook-secrets~1actions~1rotate/post/responses/503/content/application~1problem+json/examples/temporarily_unavailable"]}},"schemaId":"components/schemas/Problem","exampleIds":["paths/~1channels~1{channel_id}~1webhook-secrets~1actions~1rotate/post/responses/503/content/application~1problem+json/examples/temporarily_unavailable"]},{"code":"default","description":"Unexpected error.","mediaType":"application/problem+json","mediaTypes":["application/problem+json"],"mediaTypeContent":{"application/problem+json":{"schemaId":"components/schemas/Problem"}},"schemaId":"components/schemas/Problem"}],"pointer":"/paths/~1channels~1{channel_id}~1webhook-secrets~1actions~1rotate/post/responses"}],"panels":[{"children":[{"kind":"response","responseCodes":[{"code":"200","schemaId":"schema_57","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"schema_57"}}},{"code":"400","schemaId":"components/schemas/InvalidRequestProblem","exampleIds":["paths/~1channels~1{channel_id}~1webhook-secrets~1actions~1rotate/post/responses/400/content/application~1problem+json/examples/malformed_json"],"mediaTypes":["application/problem+json"],"mediaTypeContent":{"application/problem+json":{"schemaId":"components/schemas/InvalidRequestProblem","exampleIds":["paths/~1channels~1{channel_id}~1webhook-secrets~1actions~1rotate/post/responses/400/content/application~1problem+json/examples/malformed_json"]}}},{"code":"401","schemaId":"components/schemas/UnauthorizedProblem","exampleIds":["paths/~1channels~1{channel_id}~1webhook-secrets~1actions~1rotate/post/responses/401/content/application~1problem+json/examples/service_authentication_denied"],"mediaTypes":["application/problem+json"],"mediaTypeContent":{"application/problem+json":{"schemaId":"components/schemas/UnauthorizedProblem","exampleIds":["paths/~1channels~1{channel_id}~1webhook-secrets~1actions~1rotate/post/responses/401/content/application~1problem+json/examples/service_authentication_denied"]}}},{"code":"403","schemaId":"components/schemas/ForbiddenProblem","exampleIds":["paths/~1channels~1{channel_id}~1webhook-secrets~1actions~1rotate/post/responses/403/content/application~1problem+json/examples/insufficient_permissions"],"mediaTypes":["application/problem+json"],"mediaTypeContent":{"application/problem+json":{"schemaId":"components/schemas/ForbiddenProblem","exampleIds":["paths/~1channels~1{channel_id}~1webhook-secrets~1actions~1rotate/post/responses/403/content/application~1problem+json/examples/insufficient_permissions"]}}},{"code":"404","schemaId":"components/schemas/NotFoundProblem","exampleIds":["paths/~1channels~1{channel_id}~1webhook-secrets~1actions~1rotate/post/responses/404/content/application~1problem+json/examples/address_not_found","paths/~1channels~1{channel_id}~1webhook-secrets~1actions~1rotate/post/responses/404/content/application~1problem+json/examples/invoice_not_found"],"mediaTypes":["application/problem+json"],"mediaTypeContent":{"application/problem+json":{"schemaId":"components/schemas/NotFoundProblem","exampleIds":["paths/~1channels~1{channel_id}~1webhook-secrets~1actions~1rotate/post/responses/404/content/application~1problem+json/examples/address_not_found","paths/~1channels~1{channel_id}~1webhook-secrets~1actions~1rotate/post/responses/404/content/application~1problem+json/examples/invoice_not_found"]}}},{"code":"409","schemaId":"components/schemas/ConflictProblem","exampleIds":["paths/~1channels~1{channel_id}~1webhook-secrets~1actions~1rotate/post/responses/409/content/application~1problem+json/examples/address_occupied","paths/~1channels~1{channel_id}~1webhook-secrets~1actions~1rotate/post/responses/409/content/application~1problem+json/examples/address_in_use","paths/~1channels~1{channel_id}~1webhook-secrets~1actions~1rotate/post/responses/409/content/application~1problem+json/examples/subscription_v1_conflict","paths/~1channels~1{channel_id}~1webhook-secrets~1actions~1rotate/post/responses/409/content/application~1problem+json/examples/notification_send_in_progress","paths/~1channels~1{channel_id}~1webhook-secrets~1actions~1rotate/post/responses/409/content/application~1problem+json/examples/notification_payload_unavailable","paths/~1channels~1{channel_id}~1webhook-secrets~1actions~1rotate/post/responses/409/content/application~1problem+json/examples/notification_test_resend_not_allowed"],"mediaTypes":["application/problem+json"],"mediaTypeContent":{"application/problem+json":{"schemaId":"components/schemas/ConflictProblem","exampleIds":["paths/~1channels~1{channel_id}~1webhook-secrets~1actions~1rotate/post/responses/409/content/application~1problem+json/examples/address_occupied","paths/~1channels~1{channel_id}~1webhook-secrets~1actions~1rotate/post/responses/409/content/application~1problem+json/examples/address_in_use","paths/~1channels~1{channel_id}~1webhook-secrets~1actions~1rotate/post/responses/409/content/application~1problem+json/examples/subscription_v1_conflict","paths/~1channels~1{channel_id}~1webhook-secrets~1actions~1rotate/post/responses/409/content/application~1problem+json/examples/notification_send_in_progress","paths/~1channels~1{channel_id}~1webhook-secrets~1actions~1rotate/post/responses/409/content/application~1problem+json/examples/notification_payload_unavailable","paths/~1channels~1{channel_id}~1webhook-secrets~1actions~1rotate/post/responses/409/content/application~1problem+json/examples/notification_test_resend_not_allowed"]}}},{"code":"503","schemaId":"components/schemas/Problem","exampleIds":["paths/~1channels~1{channel_id}~1webhook-secrets~1actions~1rotate/post/responses/503/content/application~1problem+json/examples/temporarily_unavailable"],"mediaTypes":["application/problem+json"],"mediaTypeContent":{"application/problem+json":{"schemaId":"components/schemas/Problem","exampleIds":["paths/~1channels~1{channel_id}~1webhook-secrets~1actions~1rotate/post/responses/503/content/application~1problem+json/examples/temporarily_unavailable"]}}},{"code":"default","schemaId":"components/schemas/Problem","mediaTypes":["application/problem+json"],"mediaTypeContent":{"application/problem+json":{"schemaId":"components/schemas/Problem"}}}],"examples":[]}]}]},{"nodeType":"container","children":[{"nodeType":"feedback","pageSlug":"/channel/rotate-channel-webhook-secret"}],"panels":[]}]},"httpPath":"/channels/{channel_id}/webhook-secrets/actions/rotate"},{"label":"Delete previous webhook signing secret","deprecated":false,"httpVerb":"delete","isAdditionalOperation":false,"isWebhook":false,"type":"link","link":"/apis/platform/api/channel/delete-channel-previous-webhook-secret","routeSlug":"/apis/platform/api/channel/delete-channel-previous-webhook-secret","metadata":{"seo":{"title":"Delete previous webhook signing secret","description":"Ends the rotation overlap window early. After this call, outgoing webhooksare signed only with the current secret."}},"content":{"contentType":"item","itemVariant":"httpItem","meta":{"sourceId":"delete-channel-previous-webhook-secret","name":"Delete previous webhook signing secret","isWebhook":false,"pointer":"/paths/~1channels~1{channel_id}~1webhook-secrets~1previous/delete","hasSamples":false},"children":[{"nodeType":"container","children":[{"nodeType":"header","level":2,"label":"Delete previous webhook signing secret","isWebhook":false,"showPageActions":true}],"panels":[]},{"nodeType":"container","children":[{"nodeType":"header","level":4,"label":"Request","labelTranslationKey":"request","deepLinkSuffix":"request"},{"nodeType":"markdoc","content":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Ends the rotation overlap window early. After this call, outgoing webhooks"},"children":[]},{"$$mdtype":"Node","type":"softbreak","inline":true,"attributes":{},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"are signed only with the current secret."},"children":[]}]}]},{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Idempotent: if there is no previous secret (the channel has never been"},"children":[]},{"$$mdtype":"Node","type":"softbreak","inline":true,"attributes":{},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"rotated, or it was already deleted), the response is still 204."},"children":[]}]}]},{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Only valid for channels with "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"kind=webhook"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"; otherwise returns 400."},"children":[]}]}]}]},{"nodeType":"security","requirements":[{"schemes":[{"name":"Auth","scopes":["api:channel:write"],"type":"apiKey","in":"header","paramName":"X-Api-Key","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"API key for authenticating requests. Include your key in the "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"X-Api-Key"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" header. Keys can be created in the Vilna Dashboard or via the Management API. The scopes listed per operation indicate which permissions the key must have."},"children":[]}]}]}]}]}]},{"nodeType":"item-content","variant":"path","label":"Path","labelTranslationKey":"path","parameters":[{"name":"channel_id","in":"path","schemaId":"schema_17","description":"Unique identifier (UUID) of the channel.","required":true}],"pointer":"/paths/~1channels~1{channel_id}~1webhook-secrets~1previous/delete/parameters"},{"nodeType":"item-content","variant":"headers","label":"Headers","labelTranslationKey":"header","parameters":[{"name":"Idempotency-Key","in":"header","schemaId":"schema_14","description":"Case-sensitive opaque key for one mutation intent. Send exactly one header occurrence containing 1 to 128 visible ASCII bytes (0x21..0x7e). Commas are literal data; do not trim, lowercase or require UUID syntax. Reuse the same key for retries, with current authorization checked on every attempt. Repeated header occurrences are rejected.\n","required":true}],"pointer":"/paths/~1channels~1{channel_id}~1webhook-secrets~1previous/delete/parameters"}],"panels":[{"children":[{"kind":"code-sample","source":{"kind":"code-sample","operationType":"http","method":"DELETE","path":"/channels/{channel_id}/webhook-secrets/previous","servers":[{"url":"/_mock/apis/platform/api","description":"Mock server","isMockServer":true},{"url":"https://api.vilna.io/v2","description":"Vilna API."}],"parameters":{"path":[{"name":"channel_id","in":"path","required":true,"example":"550e8400-e29b-41d4-a716-446655440000","schemaId":"components/schemas/UUID"}],"query":[],"querystring":[],"header":[{"name":"Idempotency-Key","in":"header","required":true,"schemaId":"schema_14"}],"cookie":[]},"security":[{"schemes":[{"id":"Auth","type":"apiKey","name":"X-Api-Key","in":"header"}],"scopes":["api:channel:write"]}],"responseCodes":["204","400","401","403","404","409","503","default"],"pointer":"/channels/{channel_id}/webhook-secrets/previous","href":"channel/delete-channel-previous-webhook-secret","openApiOperationId":"delete-channel-previous-webhook-secret","summary":"Delete previous webhook signing secret"},"isWebhook":false,"hideReplay":false,"servers":[{"url":"/_mock/apis/platform/api","description":"Mock server","isMockServer":true},{"url":"https://api.vilna.io/v2","description":"Vilna API."}],"examples":[]}]}]},{"nodeType":"container","children":[{"nodeType":"header","level":4,"label":"Responses","labelTranslationKey":"responses","deepLinkSuffix":"responses"},{"nodeType":"item-content","variant":"responses","responses":[{"code":"204","description":"Successful operation with no response body."},{"code":"400","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Bad request (e.g., missing or invalid fields). Invalid text may be reported as address.label_invalid, address.meta_invalid, public_key.label_invalid, invoice.comment_invalid, invoice.metadata_invalid."},"children":[]}]}]}],"mediaType":"application/problem+json","mediaTypes":["application/problem+json"],"mediaTypeContent":{"application/problem+json":{"schemaId":"components/schemas/InvalidRequestProblem","exampleIds":["paths/~1channels~1{channel_id}~1webhook-secrets~1previous/delete/responses/400/content/application~1problem+json/examples/malformed_json"]}},"schemaId":"components/schemas/InvalidRequestProblem","exampleIds":["paths/~1channels~1{channel_id}~1webhook-secrets~1previous/delete/responses/400/content/application~1problem+json/examples/malformed_json"]},{"code":"401","description":"Missing or invalid authentication credentials.","mediaType":"application/problem+json","mediaTypes":["application/problem+json"],"mediaTypeContent":{"application/problem+json":{"schemaId":"components/schemas/UnauthorizedProblem","exampleIds":["paths/~1channels~1{channel_id}~1webhook-secrets~1previous/delete/responses/401/content/application~1problem+json/examples/service_authentication_denied"]}},"schemaId":"components/schemas/UnauthorizedProblem","exampleIds":["paths/~1channels~1{channel_id}~1webhook-secrets~1previous/delete/responses/401/content/application~1problem+json/examples/service_authentication_denied"]},{"code":"403","description":"Insufficient permissions.","mediaType":"application/problem+json","mediaTypes":["application/problem+json"],"mediaTypeContent":{"application/problem+json":{"schemaId":"components/schemas/ForbiddenProblem","exampleIds":["paths/~1channels~1{channel_id}~1webhook-secrets~1previous/delete/responses/403/content/application~1problem+json/examples/insufficient_permissions"]}},"schemaId":"components/schemas/ForbiddenProblem","exampleIds":["paths/~1channels~1{channel_id}~1webhook-secrets~1previous/delete/responses/403/content/application~1problem+json/examples/insufficient_permissions"]},{"code":"404","description":"Requested resource does not exist.","mediaType":"application/problem+json","mediaTypes":["application/problem+json"],"mediaTypeContent":{"application/problem+json":{"schemaId":"components/schemas/NotFoundProblem","exampleIds":["paths/~1channels~1{channel_id}~1webhook-secrets~1previous/delete/responses/404/content/application~1problem+json/examples/address_not_found","paths/~1channels~1{channel_id}~1webhook-secrets~1previous/delete/responses/404/content/application~1problem+json/examples/invoice_not_found"]}},"schemaId":"components/schemas/NotFoundProblem","exampleIds":["paths/~1channels~1{channel_id}~1webhook-secrets~1previous/delete/responses/404/content/application~1problem+json/examples/address_not_found","paths/~1channels~1{channel_id}~1webhook-secrets~1previous/delete/responses/404/content/application~1problem+json/examples/invoice_not_found"]},{"code":"409","description":"Request conflicts with the current resource state.","mediaType":"application/problem+json","mediaTypes":["application/problem+json"],"mediaTypeContent":{"application/problem+json":{"schemaId":"components/schemas/ConflictProblem","exampleIds":["paths/~1channels~1{channel_id}~1webhook-secrets~1previous/delete/responses/409/content/application~1problem+json/examples/address_occupied","paths/~1channels~1{channel_id}~1webhook-secrets~1previous/delete/responses/409/content/application~1problem+json/examples/address_in_use","paths/~1channels~1{channel_id}~1webhook-secrets~1previous/delete/responses/409/content/application~1problem+json/examples/subscription_v1_conflict","paths/~1channels~1{channel_id}~1webhook-secrets~1previous/delete/responses/409/content/application~1problem+json/examples/notification_send_in_progress","paths/~1channels~1{channel_id}~1webhook-secrets~1previous/delete/responses/409/content/application~1problem+json/examples/notification_payload_unavailable","paths/~1channels~1{channel_id}~1webhook-secrets~1previous/delete/responses/409/content/application~1problem+json/examples/notification_test_resend_not_allowed"]}},"schemaId":"components/schemas/ConflictProblem","exampleIds":["paths/~1channels~1{channel_id}~1webhook-secrets~1previous/delete/responses/409/content/application~1problem+json/examples/address_occupied","paths/~1channels~1{channel_id}~1webhook-secrets~1previous/delete/responses/409/content/application~1problem+json/examples/address_in_use","paths/~1channels~1{channel_id}~1webhook-secrets~1previous/delete/responses/409/content/application~1problem+json/examples/subscription_v1_conflict","paths/~1channels~1{channel_id}~1webhook-secrets~1previous/delete/responses/409/content/application~1problem+json/examples/notification_send_in_progress","paths/~1channels~1{channel_id}~1webhook-secrets~1previous/delete/responses/409/content/application~1problem+json/examples/notification_payload_unavailable","paths/~1channels~1{channel_id}~1webhook-secrets~1previous/delete/responses/409/content/application~1problem+json/examples/notification_test_resend_not_allowed"]},{"code":"503","description":"The operation is temporarily unavailable. Please try again later.","mediaType":"application/problem+json","mediaTypes":["application/problem+json"],"mediaTypeContent":{"application/problem+json":{"schemaId":"components/schemas/Problem","exampleIds":["paths/~1channels~1{channel_id}~1webhook-secrets~1previous/delete/responses/503/content/application~1problem+json/examples/temporarily_unavailable"]}},"schemaId":"components/schemas/Problem","exampleIds":["paths/~1channels~1{channel_id}~1webhook-secrets~1previous/delete/responses/503/content/application~1problem+json/examples/temporarily_unavailable"]},{"code":"default","description":"Unexpected error.","mediaType":"application/problem+json","mediaTypes":["application/problem+json"],"mediaTypeContent":{"application/problem+json":{"schemaId":"components/schemas/Problem"}},"schemaId":"components/schemas/Problem"}],"pointer":"/paths/~1channels~1{channel_id}~1webhook-secrets~1previous/delete/responses"}],"panels":[{"children":[{"kind":"response","responseCodes":[{"code":"204"},{"code":"400","schemaId":"components/schemas/InvalidRequestProblem","exampleIds":["paths/~1channels~1{channel_id}~1webhook-secrets~1previous/delete/responses/400/content/application~1problem+json/examples/malformed_json"],"mediaTypes":["application/problem+json"],"mediaTypeContent":{"application/problem+json":{"schemaId":"components/schemas/InvalidRequestProblem","exampleIds":["paths/~1channels~1{channel_id}~1webhook-secrets~1previous/delete/responses/400/content/application~1problem+json/examples/malformed_json"]}}},{"code":"401","schemaId":"components/schemas/UnauthorizedProblem","exampleIds":["paths/~1channels~1{channel_id}~1webhook-secrets~1previous/delete/responses/401/content/application~1problem+json/examples/service_authentication_denied"],"mediaTypes":["application/problem+json"],"mediaTypeContent":{"application/problem+json":{"schemaId":"components/schemas/UnauthorizedProblem","exampleIds":["paths/~1channels~1{channel_id}~1webhook-secrets~1previous/delete/responses/401/content/application~1problem+json/examples/service_authentication_denied"]}}},{"code":"403","schemaId":"components/schemas/ForbiddenProblem","exampleIds":["paths/~1channels~1{channel_id}~1webhook-secrets~1previous/delete/responses/403/content/application~1problem+json/examples/insufficient_permissions"],"mediaTypes":["application/problem+json"],"mediaTypeContent":{"application/problem+json":{"schemaId":"components/schemas/ForbiddenProblem","exampleIds":["paths/~1channels~1{channel_id}~1webhook-secrets~1previous/delete/responses/403/content/application~1problem+json/examples/insufficient_permissions"]}}},{"code":"404","schemaId":"components/schemas/NotFoundProblem","exampleIds":["paths/~1channels~1{channel_id}~1webhook-secrets~1previous/delete/responses/404/content/application~1problem+json/examples/address_not_found","paths/~1channels~1{channel_id}~1webhook-secrets~1previous/delete/responses/404/content/application~1problem+json/examples/invoice_not_found"],"mediaTypes":["application/problem+json"],"mediaTypeContent":{"application/problem+json":{"schemaId":"components/schemas/NotFoundProblem","exampleIds":["paths/~1channels~1{channel_id}~1webhook-secrets~1previous/delete/responses/404/content/application~1problem+json/examples/address_not_found","paths/~1channels~1{channel_id}~1webhook-secrets~1previous/delete/responses/404/content/application~1problem+json/examples/invoice_not_found"]}}},{"code":"409","schemaId":"components/schemas/ConflictProblem","exampleIds":["paths/~1channels~1{channel_id}~1webhook-secrets~1previous/delete/responses/409/content/application~1problem+json/examples/address_occupied","paths/~1channels~1{channel_id}~1webhook-secrets~1previous/delete/responses/409/content/application~1problem+json/examples/address_in_use","paths/~1channels~1{channel_id}~1webhook-secrets~1previous/delete/responses/409/content/application~1problem+json/examples/subscription_v1_conflict","paths/~1channels~1{channel_id}~1webhook-secrets~1previous/delete/responses/409/content/application~1problem+json/examples/notification_send_in_progress","paths/~1channels~1{channel_id}~1webhook-secrets~1previous/delete/responses/409/content/application~1problem+json/examples/notification_payload_unavailable","paths/~1channels~1{channel_id}~1webhook-secrets~1previous/delete/responses/409/content/application~1problem+json/examples/notification_test_resend_not_allowed"],"mediaTypes":["application/problem+json"],"mediaTypeContent":{"application/problem+json":{"schemaId":"components/schemas/ConflictProblem","exampleIds":["paths/~1channels~1{channel_id}~1webhook-secrets~1previous/delete/responses/409/content/application~1problem+json/examples/address_occupied","paths/~1channels~1{channel_id}~1webhook-secrets~1previous/delete/responses/409/content/application~1problem+json/examples/address_in_use","paths/~1channels~1{channel_id}~1webhook-secrets~1previous/delete/responses/409/content/application~1problem+json/examples/subscription_v1_conflict","paths/~1channels~1{channel_id}~1webhook-secrets~1previous/delete/responses/409/content/application~1problem+json/examples/notification_send_in_progress","paths/~1channels~1{channel_id}~1webhook-secrets~1previous/delete/responses/409/content/application~1problem+json/examples/notification_payload_unavailable","paths/~1channels~1{channel_id}~1webhook-secrets~1previous/delete/responses/409/content/application~1problem+json/examples/notification_test_resend_not_allowed"]}}},{"code":"503","schemaId":"components/schemas/Problem","exampleIds":["paths/~1channels~1{channel_id}~1webhook-secrets~1previous/delete/responses/503/content/application~1problem+json/examples/temporarily_unavailable"],"mediaTypes":["application/problem+json"],"mediaTypeContent":{"application/problem+json":{"schemaId":"components/schemas/Problem","exampleIds":["paths/~1channels~1{channel_id}~1webhook-secrets~1previous/delete/responses/503/content/application~1problem+json/examples/temporarily_unavailable"]}}},{"code":"default","schemaId":"components/schemas/Problem","mediaTypes":["application/problem+json"],"mediaTypeContent":{"application/problem+json":{"schemaId":"components/schemas/Problem"}}}],"examples":[]}]}]},{"nodeType":"container","children":[{"nodeType":"feedback","pageSlug":"/channel/delete-channel-previous-webhook-secret"}],"panels":[]}]},"httpPath":"/channels/{channel_id}/webhook-secrets/previous"}],"content":{"contentType":"group","meta":{"name":"channel"},"children":[{"nodeType":"container","children":[{"nodeType":"header","level":2,"label":"Notification Channels","showPageActions":true},{"nodeType":"markdoc","content":"Configure notification delivery through webhooks or Telegram."}],"panels":[{"children":[{"kind":"group-items","title":"Operations","titleTranslationKey":"operations","items":[{"title":"/channels","summary":"List channels","prefix":{"name":"get","color":"get"},"badges":[],"link":"/channel/list-channels","deprecated":false},{"title":"/channels","summary":"Create channel","prefix":{"name":"post","color":"post"},"badges":[],"link":"/channel/create-channel","deprecated":false},{"title":"/channels/{channel_id}","summary":"Get channel","prefix":{"name":"get","color":"get"},"badges":[],"link":"/channel/get-channel","deprecated":false},{"title":"/channels/{channel_id}","summary":"Delete channel","prefix":{"name":"delete","color":"delete"},"badges":[],"link":"/channel/delete-channel","deprecated":false},{"title":"/channels/{channel_id}","summary":"Update channel","prefix":{"name":"patch","color":"patch"},"badges":[],"link":"/channel/patch-channel","deprecated":false},{"title":"/channels/{channel_id}/actions/test","summary":"Test channel","prefix":{"name":"post","color":"post"},"badges":[],"link":"/channel/test-channel","deprecated":false},{"title":"/channels/{channel_id}/webhook-secrets","summary":"Get webhook signing secrets","prefix":{"name":"get","color":"get"},"badges":[],"link":"/channel/get-channel-webhook-secrets","deprecated":false},{"title":"/channels/{channel_id}/webhook-secrets/actions/rotate","summary":"Rotate webhook signing secret","prefix":{"name":"post","color":"post"},"badges":[],"link":"/channel/rotate-channel-webhook-secret","deprecated":false},{"title":"/channels/{channel_id}/webhook-secrets/previous","summary":"Delete previous webhook signing secret","prefix":{"name":"delete","color":"delete"},"badges":[],"link":"/channel/delete-channel-previous-webhook-secret","deprecated":false}]}]}]}]}},{"type":"group","label":"Notification Subscriptions","link":"/apis/platform/api/subscription","routeSlug":"/apis/platform/api/subscription","items":[{"label":"List subscriptions","deprecated":false,"httpVerb":"get","isAdditionalOperation":false,"isWebhook":false,"type":"link","link":"/apis/platform/api/subscription/list-subscriptions","routeSlug":"/apis/platform/api/subscription/list-subscriptions","metadata":{"seo":{"title":"List subscriptions","description":"List subscriptions with filtering and pagination."}},"content":{"contentType":"item","itemVariant":"httpItem","meta":{"sourceId":"list-subscriptions","name":"List subscriptions","isWebhook":false,"pointer":"/paths/~1subscriptions/get","hasSamples":false},"children":[{"nodeType":"container","children":[{"nodeType":"header","level":2,"label":"List subscriptions","isWebhook":false,"showPageActions":true}],"panels":[]},{"nodeType":"container","children":[{"nodeType":"header","level":4,"label":"Request","labelTranslationKey":"request","deepLinkSuffix":"request"},{"nodeType":"markdoc","content":"List subscriptions with filtering and pagination."},{"nodeType":"security","requirements":[{"schemes":[{"name":"Auth","scopes":["api:subscription:read"],"type":"apiKey","in":"header","paramName":"X-Api-Key","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"API key for authenticating requests. Include your key in the "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"X-Api-Key"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" header. Keys can be created in the Vilna Dashboard or via the Management API. The scopes listed per operation indicate which permissions the key must have."},"children":[]}]}]}]}]}]},{"nodeType":"item-content","variant":"query","label":"Query","labelTranslationKey":"query","parameters":[{"name":"limit","in":"query","schemaId":"schema_0","description":"Maximum number of items to return."},{"name":"page","in":"query","schemaId":"schema_1","description":"Page number for pagination."},{"name":"channel_id","in":"query","schemaId":"schema_17","description":"Filter by channel ID (UUID)."},{"name":"family","in":"query","schemaId":"schema_58","description":"Filter by transaction family. Matches the configured family exactly, not wildcard (null) subscriptions. Omit to include every configuration."},{"name":"enabled","in":"query","schemaId":"schema_41","description":"Filter by enabled status."},{"name":"search","in":"query","schemaId":"schema_59","description":"Filter subscriptions by name (partial match, case-insensitive).","example":"transaction"},{"name":"sort_by","in":"query","schemaId":"schema_60","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Field to sort results by. Use "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"-"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" prefix for descending order."},"children":[]}]}]}]}],"pointer":"/paths/~1subscriptions/get/parameters"}],"panels":[{"children":[{"kind":"code-sample","source":{"kind":"code-sample","operationType":"http","method":"GET","path":"/subscriptions","servers":[{"url":"/_mock/apis/platform/api","description":"Mock server","isMockServer":true},{"url":"https://api.vilna.io/v2","description":"Vilna API."}],"parameters":{"path":[],"query":[{"name":"limit","in":"query","required":false,"example":20,"schemaId":"schema_0"},{"name":"page","in":"query","required":false,"example":1,"schemaId":"schema_1"},{"name":"channel_id","in":"query","required":false,"example":"550e8400-e29b-41d4-a716-446655440000","schemaId":"components/schemas/UUID"},{"name":"family","in":"query","required":false,"example":"evm","schemaId":"components/schemas/SubscriptionConcreteFamily"},{"name":"enabled","in":"query","required":false,"schemaId":"schema_41"},{"name":"search","in":"query","required":false,"example":"transaction","schemaId":"schema_59"},{"name":"sort_by","in":"query","required":false,"example":"created_at","schemaId":"schema_60"}],"querystring":[],"header":[],"cookie":[]},"security":[{"schemes":[{"id":"Auth","type":"apiKey","name":"X-Api-Key","in":"header"}],"scopes":["api:subscription:read"]}],"responseCodes":["200","400","401","403","503","default"],"pointer":"/subscriptions","href":"subscription/list-subscriptions","openApiOperationId":"list-subscriptions","summary":"List subscriptions"},"isWebhook":false,"hideReplay":false,"servers":[{"url":"/_mock/apis/platform/api","description":"Mock server","isMockServer":true},{"url":"https://api.vilna.io/v2","description":"Vilna API."}],"examples":[]}]}]},{"nodeType":"container","children":[{"nodeType":"header","level":4,"label":"Responses","labelTranslationKey":"responses","deepLinkSuffix":"responses"},{"nodeType":"item-content","variant":"responses","responses":[{"code":"200","description":"List of subscriptions with pagination.","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"schema_61"}},"schemaId":"schema_61"},{"code":"400","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Bad request (e.g., missing or invalid fields). Invalid text may be reported as address.label_invalid, address.meta_invalid, public_key.label_invalid, invoice.comment_invalid, invoice.metadata_invalid."},"children":[]}]}]}],"mediaType":"application/problem+json","mediaTypes":["application/problem+json"],"mediaTypeContent":{"application/problem+json":{"schemaId":"components/schemas/InvalidRequestProblem","exampleIds":["paths/~1subscriptions/get/responses/400/content/application~1problem+json/examples/malformed_json"]}},"schemaId":"components/schemas/InvalidRequestProblem","exampleIds":["paths/~1subscriptions/get/responses/400/content/application~1problem+json/examples/malformed_json"]},{"code":"401","description":"Missing or invalid authentication credentials.","mediaType":"application/problem+json","mediaTypes":["application/problem+json"],"mediaTypeContent":{"application/problem+json":{"schemaId":"components/schemas/UnauthorizedProblem","exampleIds":["paths/~1subscriptions/get/responses/401/content/application~1problem+json/examples/service_authentication_denied"]}},"schemaId":"components/schemas/UnauthorizedProblem","exampleIds":["paths/~1subscriptions/get/responses/401/content/application~1problem+json/examples/service_authentication_denied"]},{"code":"403","description":"Insufficient permissions.","mediaType":"application/problem+json","mediaTypes":["application/problem+json"],"mediaTypeContent":{"application/problem+json":{"schemaId":"components/schemas/ForbiddenProblem","exampleIds":["paths/~1subscriptions/get/responses/403/content/application~1problem+json/examples/insufficient_permissions"]}},"schemaId":"components/schemas/ForbiddenProblem","exampleIds":["paths/~1subscriptions/get/responses/403/content/application~1problem+json/examples/insufficient_permissions"]},{"code":"503","description":"The operation is temporarily unavailable. Please try again later.","mediaType":"application/problem+json","mediaTypes":["application/problem+json"],"mediaTypeContent":{"application/problem+json":{"schemaId":"components/schemas/Problem","exampleIds":["paths/~1subscriptions/get/responses/503/content/application~1problem+json/examples/temporarily_unavailable"]}},"schemaId":"components/schemas/Problem","exampleIds":["paths/~1subscriptions/get/responses/503/content/application~1problem+json/examples/temporarily_unavailable"]},{"code":"default","description":"Unexpected error.","mediaType":"application/problem+json","mediaTypes":["application/problem+json"],"mediaTypeContent":{"application/problem+json":{"schemaId":"components/schemas/Problem"}},"schemaId":"components/schemas/Problem"}],"pointer":"/paths/~1subscriptions/get/responses"}],"panels":[{"children":[{"kind":"response","responseCodes":[{"code":"200","schemaId":"schema_61","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"schema_61"}}},{"code":"400","schemaId":"components/schemas/InvalidRequestProblem","exampleIds":["paths/~1subscriptions/get/responses/400/content/application~1problem+json/examples/malformed_json"],"mediaTypes":["application/problem+json"],"mediaTypeContent":{"application/problem+json":{"schemaId":"components/schemas/InvalidRequestProblem","exampleIds":["paths/~1subscriptions/get/responses/400/content/application~1problem+json/examples/malformed_json"]}}},{"code":"401","schemaId":"components/schemas/UnauthorizedProblem","exampleIds":["paths/~1subscriptions/get/responses/401/content/application~1problem+json/examples/service_authentication_denied"],"mediaTypes":["application/problem+json"],"mediaTypeContent":{"application/problem+json":{"schemaId":"components/schemas/UnauthorizedProblem","exampleIds":["paths/~1subscriptions/get/responses/401/content/application~1problem+json/examples/service_authentication_denied"]}}},{"code":"403","schemaId":"components/schemas/ForbiddenProblem","exampleIds":["paths/~1subscriptions/get/responses/403/content/application~1problem+json/examples/insufficient_permissions"],"mediaTypes":["application/problem+json"],"mediaTypeContent":{"application/problem+json":{"schemaId":"components/schemas/ForbiddenProblem","exampleIds":["paths/~1subscriptions/get/responses/403/content/application~1problem+json/examples/insufficient_permissions"]}}},{"code":"503","schemaId":"components/schemas/Problem","exampleIds":["paths/~1subscriptions/get/responses/503/content/application~1problem+json/examples/temporarily_unavailable"],"mediaTypes":["application/problem+json"],"mediaTypeContent":{"application/problem+json":{"schemaId":"components/schemas/Problem","exampleIds":["paths/~1subscriptions/get/responses/503/content/application~1problem+json/examples/temporarily_unavailable"]}}},{"code":"default","schemaId":"components/schemas/Problem","mediaTypes":["application/problem+json"],"mediaTypeContent":{"application/problem+json":{"schemaId":"components/schemas/Problem"}}}],"examples":[]}]}]},{"nodeType":"container","children":[{"nodeType":"feedback","pageSlug":"/subscription/list-subscriptions"}],"panels":[]}]},"httpPath":"/subscriptions"},{"label":"Create subscription","deprecated":false,"httpVerb":"post","isAdditionalOperation":false,"isWebhook":false,"type":"link","link":"/apis/platform/api/subscription/create-subscription","routeSlug":"/apis/platform/api/subscription/create-subscription","metadata":{"seo":{"title":"Create subscription","description":"Create a subscription binding a channel to a transaction family and a trigger, with an optional scope filter. Exactly matching an existing configuration returns it unchanged with 200 instead of creating a duplicate; a new configuration returns 201."}},"content":{"contentType":"item","itemVariant":"httpItem","meta":{"sourceId":"create-subscription","name":"Create subscription","isWebhook":false,"pointer":"/paths/~1subscriptions/post","hasSamples":true},"children":[{"nodeType":"container","children":[{"nodeType":"header","level":2,"label":"Create subscription","isWebhook":false,"showPageActions":true}],"panels":[]},{"nodeType":"container","children":[{"nodeType":"header","level":4,"label":"Request","labelTranslationKey":"request","deepLinkSuffix":"request"},{"nodeType":"markdoc","content":"Create a subscription binding a channel to a transaction family and a trigger, with an optional scope\nfilter. Exactly matching an existing configuration returns it unchanged with 200 instead of creating a\nduplicate; a new configuration returns 201.\n"},{"nodeType":"security","requirements":[{"schemes":[{"name":"Auth","scopes":["api:subscription:write"],"type":"apiKey","in":"header","paramName":"X-Api-Key","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"API key for authenticating requests. Include your key in the "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"X-Api-Key"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" header. Keys can be created in the Vilna Dashboard or via the Management API. The scopes listed per operation indicate which permissions the key must have."},"children":[]}]}]}]}]}]},{"nodeType":"item-content","variant":"headers","label":"Headers","labelTranslationKey":"header","parameters":[{"name":"Idempotency-Key","in":"header","schemaId":"schema_14","description":"Case-sensitive opaque key for one mutation intent. Send exactly one header occurrence containing 1 to 128 visible ASCII bytes (0x21..0x7e). Commas are literal data; do not trim, lowercase or require UUID syntax. Reuse the same key for retries, with current authorization checked on every attempt. Repeated header occurrences are rejected.\n","required":true}],"pointer":"/paths/~1subscriptions/post/parameters"},{"nodeType":"item-content","variant":"body","label":"Request Body","labelTranslationKey":"body","required":true,"mediaTypes":["application/json"],"mediaTypeSchemas":{"application/json":{"schemaId":"components/schemas/CreateSubscriptionRequest","exampleIds":["paths/~1subscriptions/post/requestBody/content/application~1json/examples/create_block_trigger_subscription","paths/~1subscriptions/post/requestBody/content/application~1json/examples/create_mempool_trigger_subscription"]}},"schemaId":"components/schemas/CreateSubscriptionRequest","exampleIds":["paths/~1subscriptions/post/requestBody/content/application~1json/examples/create_block_trigger_subscription","paths/~1subscriptions/post/requestBody/content/application~1json/examples/create_mempool_trigger_subscription"],"pointer":"/paths/~1subscriptions/post/requestBody"}],"panels":[{"children":[{"kind":"code-sample","source":{"kind":"code-sample","operationType":"http","method":"POST","path":"/subscriptions","servers":[{"url":"/_mock/apis/platform/api","description":"Mock server","isMockServer":true},{"url":"https://api.vilna.io/v2","description":"Vilna API."}],"parameters":{"path":[],"query":[],"querystring":[],"header":[{"name":"Idempotency-Key","in":"header","required":true,"schemaId":"schema_14"}],"cookie":[]},"security":[{"schemes":[{"id":"Auth","type":"apiKey","name":"X-Api-Key","in":"header"}],"scopes":["api:subscription:write"]}],"requestBody":{"application/json":{"schemaId":"components/schemas/CreateSubscriptionRequest","exampleIds":["paths/~1subscriptions/post/requestBody/content/application~1json/examples/create_block_trigger_subscription","paths/~1subscriptions/post/requestBody/content/application~1json/examples/create_mempool_trigger_subscription"]}},"responseCodes":["200","201","400","401","403","404","409","429","503","default"],"pointer":"/subscriptions","href":"subscription/create-subscription","openApiOperationId":"create-subscription","summary":"Create subscription"},"isWebhook":false,"hideReplay":false,"servers":[{"url":"/_mock/apis/platform/api","description":"Mock server","isMockServer":true},{"url":"https://api.vilna.io/v2","description":"Vilna API."}],"schemaId":"components/schemas/CreateSubscriptionRequest","exampleIds":["paths/~1subscriptions/post/requestBody/content/application~1json/examples/create_block_trigger_subscription","paths/~1subscriptions/post/requestBody/content/application~1json/examples/create_mempool_trigger_subscription"],"mediaTypes":["application/json"],"mediaTypeSchemas":{"application/json":{"schemaId":"components/schemas/CreateSubscriptionRequest","exampleIds":["paths/~1subscriptions/post/requestBody/content/application~1json/examples/create_block_trigger_subscription","paths/~1subscriptions/post/requestBody/content/application~1json/examples/create_mempool_trigger_subscription"]}},"examples":[{},{}]}]}]},{"nodeType":"container","children":[{"nodeType":"header","level":4,"label":"Responses","labelTranslationKey":"responses","deepLinkSuffix":"responses"},{"nodeType":"item-content","variant":"responses","responses":[{"code":"200","description":"Notification subscription details.","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"schema_62"}},"schemaId":"schema_62"},{"code":"201","description":"Notification subscription details.","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"schema_62"}},"schemaId":"schema_62"},{"code":"400","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Bad request (e.g., missing or invalid fields). Invalid text may be reported as address.label_invalid, address.meta_invalid, public_key.label_invalid, invoice.comment_invalid, invoice.metadata_invalid."},"children":[]}]}]}],"mediaType":"application/problem+json","mediaTypes":["application/problem+json"],"mediaTypeContent":{"application/problem+json":{"schemaId":"components/schemas/InvalidRequestProblem","exampleIds":["paths/~1subscriptions/post/responses/400/content/application~1problem+json/examples/malformed_json"]}},"schemaId":"components/schemas/InvalidRequestProblem","exampleIds":["paths/~1subscriptions/post/responses/400/content/application~1problem+json/examples/malformed_json"]},{"code":"401","description":"Missing or invalid authentication credentials.","mediaType":"application/problem+json","mediaTypes":["application/problem+json"],"mediaTypeContent":{"application/problem+json":{"schemaId":"components/schemas/UnauthorizedProblem","exampleIds":["paths/~1subscriptions/post/responses/401/content/application~1problem+json/examples/service_authentication_denied"]}},"schemaId":"components/schemas/UnauthorizedProblem","exampleIds":["paths/~1subscriptions/post/responses/401/content/application~1problem+json/examples/service_authentication_denied"]},{"code":"403","description":"Insufficient permissions.","mediaType":"application/problem+json","mediaTypes":["application/problem+json"],"mediaTypeContent":{"application/problem+json":{"schemaId":"components/schemas/ForbiddenProblem","exampleIds":["paths/~1subscriptions/post/responses/403/content/application~1problem+json/examples/insufficient_permissions"]}},"schemaId":"components/schemas/ForbiddenProblem","exampleIds":["paths/~1subscriptions/post/responses/403/content/application~1problem+json/examples/insufficient_permissions"]},{"code":"404","description":"Requested resource does not exist.","mediaType":"application/problem+json","mediaTypes":["application/problem+json"],"mediaTypeContent":{"application/problem+json":{"schemaId":"components/schemas/NotFoundProblem","exampleIds":["paths/~1subscriptions/post/responses/404/content/application~1problem+json/examples/address_not_found","paths/~1subscriptions/post/responses/404/content/application~1problem+json/examples/invoice_not_found"]}},"schemaId":"components/schemas/NotFoundProblem","exampleIds":["paths/~1subscriptions/post/responses/404/content/application~1problem+json/examples/address_not_found","paths/~1subscriptions/post/responses/404/content/application~1problem+json/examples/invoice_not_found"]},{"code":"409","description":"Request conflicts with the current resource state.","mediaType":"application/problem+json","mediaTypes":["application/problem+json"],"mediaTypeContent":{"application/problem+json":{"schemaId":"components/schemas/ConflictProblem","exampleIds":["paths/~1subscriptions/post/responses/409/content/application~1problem+json/examples/address_occupied","paths/~1subscriptions/post/responses/409/content/application~1problem+json/examples/address_in_use","paths/~1subscriptions/post/responses/409/content/application~1problem+json/examples/subscription_v1_conflict","paths/~1subscriptions/post/responses/409/content/application~1problem+json/examples/notification_send_in_progress","paths/~1subscriptions/post/responses/409/content/application~1problem+json/examples/notification_payload_unavailable","paths/~1subscriptions/post/responses/409/content/application~1problem+json/examples/notification_test_resend_not_allowed"]}},"schemaId":"components/schemas/ConflictProblem","exampleIds":["paths/~1subscriptions/post/responses/409/content/application~1problem+json/examples/address_occupied","paths/~1subscriptions/post/responses/409/content/application~1problem+json/examples/address_in_use","paths/~1subscriptions/post/responses/409/content/application~1problem+json/examples/subscription_v1_conflict","paths/~1subscriptions/post/responses/409/content/application~1problem+json/examples/notification_send_in_progress","paths/~1subscriptions/post/responses/409/content/application~1problem+json/examples/notification_payload_unavailable","paths/~1subscriptions/post/responses/409/content/application~1problem+json/examples/notification_test_resend_not_allowed"]},{"code":"429","description":"Resource quota exceeded. The response includes the effective limit for this scope. The applicable code and limit depend on the operation; examples illustrate different limits.","mediaType":"application/problem+json","mediaTypes":["application/problem+json"],"mediaTypeContent":{"application/problem+json":{"schemaId":"components/schemas/QuotaExceededProblem","exampleIds":["paths/~1subscriptions/post/responses/429/content/application~1problem+json/examples/address_quota","paths/~1subscriptions/post/responses/429/content/application~1problem+json/examples/creation_prohibited"]}},"schemaId":"components/schemas/QuotaExceededProblem","exampleIds":["paths/~1subscriptions/post/responses/429/content/application~1problem+json/examples/address_quota","paths/~1subscriptions/post/responses/429/content/application~1problem+json/examples/creation_prohibited"]},{"code":"503","description":"The operation is temporarily unavailable. Please try again later.","mediaType":"application/problem+json","mediaTypes":["application/problem+json"],"mediaTypeContent":{"application/problem+json":{"schemaId":"components/schemas/Problem","exampleIds":["paths/~1subscriptions/post/responses/503/content/application~1problem+json/examples/temporarily_unavailable"]}},"schemaId":"components/schemas/Problem","exampleIds":["paths/~1subscriptions/post/responses/503/content/application~1problem+json/examples/temporarily_unavailable"]},{"code":"default","description":"Unexpected error.","mediaType":"application/problem+json","mediaTypes":["application/problem+json"],"mediaTypeContent":{"application/problem+json":{"schemaId":"components/schemas/Problem"}},"schemaId":"components/schemas/Problem"}],"pointer":"/paths/~1subscriptions/post/responses"}],"panels":[{"children":[{"kind":"response","responseCodes":[{"code":"200","schemaId":"schema_62","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"schema_62"}}},{"code":"201","schemaId":"schema_62","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"schema_62"}}},{"code":"400","schemaId":"components/schemas/InvalidRequestProblem","exampleIds":["paths/~1subscriptions/post/responses/400/content/application~1problem+json/examples/malformed_json"],"mediaTypes":["application/problem+json"],"mediaTypeContent":{"application/problem+json":{"schemaId":"components/schemas/InvalidRequestProblem","exampleIds":["paths/~1subscriptions/post/responses/400/content/application~1problem+json/examples/malformed_json"]}}},{"code":"401","schemaId":"components/schemas/UnauthorizedProblem","exampleIds":["paths/~1subscriptions/post/responses/401/content/application~1problem+json/examples/service_authentication_denied"],"mediaTypes":["application/problem+json"],"mediaTypeContent":{"application/problem+json":{"schemaId":"components/schemas/UnauthorizedProblem","exampleIds":["paths/~1subscriptions/post/responses/401/content/application~1problem+json/examples/service_authentication_denied"]}}},{"code":"403","schemaId":"components/schemas/ForbiddenProblem","exampleIds":["paths/~1subscriptions/post/responses/403/content/application~1problem+json/examples/insufficient_permissions"],"mediaTypes":["application/problem+json"],"mediaTypeContent":{"application/problem+json":{"schemaId":"components/schemas/ForbiddenProblem","exampleIds":["paths/~1subscriptions/post/responses/403/content/application~1problem+json/examples/insufficient_permissions"]}}},{"code":"404","schemaId":"components/schemas/NotFoundProblem","exampleIds":["paths/~1subscriptions/post/responses/404/content/application~1problem+json/examples/address_not_found","paths/~1subscriptions/post/responses/404/content/application~1problem+json/examples/invoice_not_found"],"mediaTypes":["application/problem+json"],"mediaTypeContent":{"application/problem+json":{"schemaId":"components/schemas/NotFoundProblem","exampleIds":["paths/~1subscriptions/post/responses/404/content/application~1problem+json/examples/address_not_found","paths/~1subscriptions/post/responses/404/content/application~1problem+json/examples/invoice_not_found"]}}},{"code":"409","schemaId":"components/schemas/ConflictProblem","exampleIds":["paths/~1subscriptions/post/responses/409/content/application~1problem+json/examples/address_occupied","paths/~1subscriptions/post/responses/409/content/application~1problem+json/examples/address_in_use","paths/~1subscriptions/post/responses/409/content/application~1problem+json/examples/subscription_v1_conflict","paths/~1subscriptions/post/responses/409/content/application~1problem+json/examples/notification_send_in_progress","paths/~1subscriptions/post/responses/409/content/application~1problem+json/examples/notification_payload_unavailable","paths/~1subscriptions/post/responses/409/content/application~1problem+json/examples/notification_test_resend_not_allowed"],"mediaTypes":["application/problem+json"],"mediaTypeContent":{"application/problem+json":{"schemaId":"components/schemas/ConflictProblem","exampleIds":["paths/~1subscriptions/post/responses/409/content/application~1problem+json/examples/address_occupied","paths/~1subscriptions/post/responses/409/content/application~1problem+json/examples/address_in_use","paths/~1subscriptions/post/responses/409/content/application~1problem+json/examples/subscription_v1_conflict","paths/~1subscriptions/post/responses/409/content/application~1problem+json/examples/notification_send_in_progress","paths/~1subscriptions/post/responses/409/content/application~1problem+json/examples/notification_payload_unavailable","paths/~1subscriptions/post/responses/409/content/application~1problem+json/examples/notification_test_resend_not_allowed"]}}},{"code":"429","schemaId":"components/schemas/QuotaExceededProblem","exampleIds":["paths/~1subscriptions/post/responses/429/content/application~1problem+json/examples/address_quota","paths/~1subscriptions/post/responses/429/content/application~1problem+json/examples/creation_prohibited"],"mediaTypes":["application/problem+json"],"mediaTypeContent":{"application/problem+json":{"schemaId":"components/schemas/QuotaExceededProblem","exampleIds":["paths/~1subscriptions/post/responses/429/content/application~1problem+json/examples/address_quota","paths/~1subscriptions/post/responses/429/content/application~1problem+json/examples/creation_prohibited"]}}},{"code":"503","schemaId":"components/schemas/Problem","exampleIds":["paths/~1subscriptions/post/responses/503/content/application~1problem+json/examples/temporarily_unavailable"],"mediaTypes":["application/problem+json"],"mediaTypeContent":{"application/problem+json":{"schemaId":"components/schemas/Problem","exampleIds":["paths/~1subscriptions/post/responses/503/content/application~1problem+json/examples/temporarily_unavailable"]}}},{"code":"default","schemaId":"components/schemas/Problem","mediaTypes":["application/problem+json"],"mediaTypeContent":{"application/problem+json":{"schemaId":"components/schemas/Problem"}}}],"examples":[]}]}]},{"nodeType":"container","children":[{"nodeType":"feedback","pageSlug":"/subscription/create-subscription"}],"panels":[]}]},"httpPath":"/subscriptions"},{"label":"Get subscription","deprecated":false,"httpVerb":"get","isAdditionalOperation":false,"isWebhook":false,"type":"link","link":"/apis/platform/api/subscription/get-subscription","routeSlug":"/apis/platform/api/subscription/get-subscription","metadata":{"seo":{"title":"Get subscription","description":"Get subscription details by ID."}},"content":{"contentType":"item","itemVariant":"httpItem","meta":{"sourceId":"get-subscription","name":"Get subscription","isWebhook":false,"pointer":"/paths/~1subscriptions~1{subscription_id}/get","hasSamples":false},"children":[{"nodeType":"container","children":[{"nodeType":"header","level":2,"label":"Get subscription","isWebhook":false,"showPageActions":true}],"panels":[]},{"nodeType":"container","children":[{"nodeType":"header","level":4,"label":"Request","labelTranslationKey":"request","deepLinkSuffix":"request"},{"nodeType":"markdoc","content":"Get subscription details by ID."},{"nodeType":"security","requirements":[{"schemes":[{"name":"Auth","scopes":["api:subscription:read"],"type":"apiKey","in":"header","paramName":"X-Api-Key","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"API key for authenticating requests. Include your key in the "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"X-Api-Key"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" header. Keys can be created in the Vilna Dashboard or via the Management API. The scopes listed per operation indicate which permissions the key must have."},"children":[]}]}]}]}]}]},{"nodeType":"item-content","variant":"path","label":"Path","labelTranslationKey":"path","parameters":[{"name":"subscription_id","in":"path","schemaId":"schema_17","description":"Unique identifier (UUID) of the subscription.","required":true}],"pointer":"/paths/~1subscriptions~1{subscription_id}/get/parameters"}],"panels":[{"children":[{"kind":"code-sample","source":{"kind":"code-sample","operationType":"http","method":"GET","path":"/subscriptions/{subscription_id}","servers":[{"url":"/_mock/apis/platform/api","description":"Mock server","isMockServer":true},{"url":"https://api.vilna.io/v2","description":"Vilna API."}],"parameters":{"path":[{"name":"subscription_id","in":"path","required":true,"example":"550e8400-e29b-41d4-a716-446655440000","schemaId":"components/schemas/UUID"}],"query":[],"querystring":[],"header":[],"cookie":[]},"security":[{"schemes":[{"id":"Auth","type":"apiKey","name":"X-Api-Key","in":"header"}],"scopes":["api:subscription:read"]}],"responseCodes":["200","400","401","403","404","503","default"],"pointer":"/subscriptions/{subscription_id}","href":"subscription/get-subscription","openApiOperationId":"get-subscription","summary":"Get subscription"},"isWebhook":false,"hideReplay":false,"servers":[{"url":"/_mock/apis/platform/api","description":"Mock server","isMockServer":true},{"url":"https://api.vilna.io/v2","description":"Vilna API."}],"examples":[]}]}]},{"nodeType":"container","children":[{"nodeType":"header","level":4,"label":"Responses","labelTranslationKey":"responses","deepLinkSuffix":"responses"},{"nodeType":"item-content","variant":"responses","responses":[{"code":"200","description":"Notification subscription details.","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"schema_62"}},"schemaId":"schema_62"},{"code":"400","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Bad request (e.g., missing or invalid fields). Invalid text may be reported as address.label_invalid, address.meta_invalid, public_key.label_invalid, invoice.comment_invalid, invoice.metadata_invalid."},"children":[]}]}]}],"mediaType":"application/problem+json","mediaTypes":["application/problem+json"],"mediaTypeContent":{"application/problem+json":{"schemaId":"components/schemas/InvalidRequestProblem","exampleIds":["paths/~1subscriptions~1{subscription_id}/get/responses/400/content/application~1problem+json/examples/malformed_json"]}},"schemaId":"components/schemas/InvalidRequestProblem","exampleIds":["paths/~1subscriptions~1{subscription_id}/get/responses/400/content/application~1problem+json/examples/malformed_json"]},{"code":"401","description":"Missing or invalid authentication credentials.","mediaType":"application/problem+json","mediaTypes":["application/problem+json"],"mediaTypeContent":{"application/problem+json":{"schemaId":"components/schemas/UnauthorizedProblem","exampleIds":["paths/~1subscriptions~1{subscription_id}/get/responses/401/content/application~1problem+json/examples/service_authentication_denied"]}},"schemaId":"components/schemas/UnauthorizedProblem","exampleIds":["paths/~1subscriptions~1{subscription_id}/get/responses/401/content/application~1problem+json/examples/service_authentication_denied"]},{"code":"403","description":"Insufficient permissions.","mediaType":"application/problem+json","mediaTypes":["application/problem+json"],"mediaTypeContent":{"application/problem+json":{"schemaId":"components/schemas/ForbiddenProblem","exampleIds":["paths/~1subscriptions~1{subscription_id}/get/responses/403/content/application~1problem+json/examples/insufficient_permissions"]}},"schemaId":"components/schemas/ForbiddenProblem","exampleIds":["paths/~1subscriptions~1{subscription_id}/get/responses/403/content/application~1problem+json/examples/insufficient_permissions"]},{"code":"404","description":"Requested resource does not exist.","mediaType":"application/problem+json","mediaTypes":["application/problem+json"],"mediaTypeContent":{"application/problem+json":{"schemaId":"components/schemas/NotFoundProblem","exampleIds":["paths/~1subscriptions~1{subscription_id}/get/responses/404/content/application~1problem+json/examples/address_not_found","paths/~1subscriptions~1{subscription_id}/get/responses/404/content/application~1problem+json/examples/invoice_not_found"]}},"schemaId":"components/schemas/NotFoundProblem","exampleIds":["paths/~1subscriptions~1{subscription_id}/get/responses/404/content/application~1problem+json/examples/address_not_found","paths/~1subscriptions~1{subscription_id}/get/responses/404/content/application~1problem+json/examples/invoice_not_found"]},{"code":"503","description":"The operation is temporarily unavailable. Please try again later.","mediaType":"application/problem+json","mediaTypes":["application/problem+json"],"mediaTypeContent":{"application/problem+json":{"schemaId":"components/schemas/Problem","exampleIds":["paths/~1subscriptions~1{subscription_id}/get/responses/503/content/application~1problem+json/examples/temporarily_unavailable"]}},"schemaId":"components/schemas/Problem","exampleIds":["paths/~1subscriptions~1{subscription_id}/get/responses/503/content/application~1problem+json/examples/temporarily_unavailable"]},{"code":"default","description":"Unexpected error.","mediaType":"application/problem+json","mediaTypes":["application/problem+json"],"mediaTypeContent":{"application/problem+json":{"schemaId":"components/schemas/Problem"}},"schemaId":"components/schemas/Problem"}],"pointer":"/paths/~1subscriptions~1{subscription_id}/get/responses"}],"panels":[{"children":[{"kind":"response","responseCodes":[{"code":"200","schemaId":"schema_62","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"schema_62"}}},{"code":"400","schemaId":"components/schemas/InvalidRequestProblem","exampleIds":["paths/~1subscriptions~1{subscription_id}/get/responses/400/content/application~1problem+json/examples/malformed_json"],"mediaTypes":["application/problem+json"],"mediaTypeContent":{"application/problem+json":{"schemaId":"components/schemas/InvalidRequestProblem","exampleIds":["paths/~1subscriptions~1{subscription_id}/get/responses/400/content/application~1problem+json/examples/malformed_json"]}}},{"code":"401","schemaId":"components/schemas/UnauthorizedProblem","exampleIds":["paths/~1subscriptions~1{subscription_id}/get/responses/401/content/application~1problem+json/examples/service_authentication_denied"],"mediaTypes":["application/problem+json"],"mediaTypeContent":{"application/problem+json":{"schemaId":"components/schemas/UnauthorizedProblem","exampleIds":["paths/~1subscriptions~1{subscription_id}/get/responses/401/content/application~1problem+json/examples/service_authentication_denied"]}}},{"code":"403","schemaId":"components/schemas/ForbiddenProblem","exampleIds":["paths/~1subscriptions~1{subscription_id}/get/responses/403/content/application~1problem+json/examples/insufficient_permissions"],"mediaTypes":["application/problem+json"],"mediaTypeContent":{"application/problem+json":{"schemaId":"components/schemas/ForbiddenProblem","exampleIds":["paths/~1subscriptions~1{subscription_id}/get/responses/403/content/application~1problem+json/examples/insufficient_permissions"]}}},{"code":"404","schemaId":"components/schemas/NotFoundProblem","exampleIds":["paths/~1subscriptions~1{subscription_id}/get/responses/404/content/application~1problem+json/examples/address_not_found","paths/~1subscriptions~1{subscription_id}/get/responses/404/content/application~1problem+json/examples/invoice_not_found"],"mediaTypes":["application/problem+json"],"mediaTypeContent":{"application/problem+json":{"schemaId":"components/schemas/NotFoundProblem","exampleIds":["paths/~1subscriptions~1{subscription_id}/get/responses/404/content/application~1problem+json/examples/address_not_found","paths/~1subscriptions~1{subscription_id}/get/responses/404/content/application~1problem+json/examples/invoice_not_found"]}}},{"code":"503","schemaId":"components/schemas/Problem","exampleIds":["paths/~1subscriptions~1{subscription_id}/get/responses/503/content/application~1problem+json/examples/temporarily_unavailable"],"mediaTypes":["application/problem+json"],"mediaTypeContent":{"application/problem+json":{"schemaId":"components/schemas/Problem","exampleIds":["paths/~1subscriptions~1{subscription_id}/get/responses/503/content/application~1problem+json/examples/temporarily_unavailable"]}}},{"code":"default","schemaId":"components/schemas/Problem","mediaTypes":["application/problem+json"],"mediaTypeContent":{"application/problem+json":{"schemaId":"components/schemas/Problem"}}}],"examples":[]}]}]},{"nodeType":"container","children":[{"nodeType":"feedback","pageSlug":"/subscription/get-subscription"}],"panels":[]}]},"httpPath":"/subscriptions/{subscription_id}"},{"label":"Delete subscription","deprecated":false,"httpVerb":"delete","isAdditionalOperation":false,"isWebhook":false,"type":"link","link":"/apis/platform/api/subscription/delete-subscription","routeSlug":"/apis/platform/api/subscription/delete-subscription","metadata":{"seo":{"title":"Delete subscription","description":"Delete a subscription by ID."}},"content":{"contentType":"item","itemVariant":"httpItem","meta":{"sourceId":"delete-subscription","name":"Delete subscription","isWebhook":false,"pointer":"/paths/~1subscriptions~1{subscription_id}/delete","hasSamples":false},"children":[{"nodeType":"container","children":[{"nodeType":"header","level":2,"label":"Delete subscription","isWebhook":false,"showPageActions":true}],"panels":[]},{"nodeType":"container","children":[{"nodeType":"header","level":4,"label":"Request","labelTranslationKey":"request","deepLinkSuffix":"request"},{"nodeType":"markdoc","content":"Delete a subscription by ID."},{"nodeType":"security","requirements":[{"schemes":[{"name":"Auth","scopes":["api:subscription:delete"],"type":"apiKey","in":"header","paramName":"X-Api-Key","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"API key for authenticating requests. Include your key in the "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"X-Api-Key"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" header. Keys can be created in the Vilna Dashboard or via the Management API. The scopes listed per operation indicate which permissions the key must have."},"children":[]}]}]}]}]}]},{"nodeType":"item-content","variant":"path","label":"Path","labelTranslationKey":"path","parameters":[{"name":"subscription_id","in":"path","schemaId":"schema_17","description":"Unique identifier (UUID) of the subscription.","required":true}],"pointer":"/paths/~1subscriptions~1{subscription_id}/delete/parameters"},{"nodeType":"item-content","variant":"headers","label":"Headers","labelTranslationKey":"header","parameters":[{"name":"Idempotency-Key","in":"header","schemaId":"schema_14","description":"Case-sensitive opaque key for one mutation intent. Send exactly one header occurrence containing 1 to 128 visible ASCII bytes (0x21..0x7e). Commas are literal data; do not trim, lowercase or require UUID syntax. Reuse the same key for retries, with current authorization checked on every attempt. Repeated header occurrences are rejected.\n","required":true}],"pointer":"/paths/~1subscriptions~1{subscription_id}/delete/parameters"}],"panels":[{"children":[{"kind":"code-sample","source":{"kind":"code-sample","operationType":"http","method":"DELETE","path":"/subscriptions/{subscription_id}","servers":[{"url":"/_mock/apis/platform/api","description":"Mock server","isMockServer":true},{"url":"https://api.vilna.io/v2","description":"Vilna API."}],"parameters":{"path":[{"name":"subscription_id","in":"path","required":true,"example":"550e8400-e29b-41d4-a716-446655440000","schemaId":"components/schemas/UUID"}],"query":[],"querystring":[],"header":[{"name":"Idempotency-Key","in":"header","required":true,"schemaId":"schema_14"}],"cookie":[]},"security":[{"schemes":[{"id":"Auth","type":"apiKey","name":"X-Api-Key","in":"header"}],"scopes":["api:subscription:delete"]}],"responseCodes":["204","400","401","403","404","409","503","default"],"pointer":"/subscriptions/{subscription_id}","href":"subscription/delete-subscription","openApiOperationId":"delete-subscription","summary":"Delete subscription"},"isWebhook":false,"hideReplay":false,"servers":[{"url":"/_mock/apis/platform/api","description":"Mock server","isMockServer":true},{"url":"https://api.vilna.io/v2","description":"Vilna API."}],"examples":[]}]}]},{"nodeType":"container","children":[{"nodeType":"header","level":4,"label":"Responses","labelTranslationKey":"responses","deepLinkSuffix":"responses"},{"nodeType":"item-content","variant":"responses","responses":[{"code":"204","description":"Successful operation with no response body."},{"code":"400","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Bad request (e.g., missing or invalid fields). Invalid text may be reported as address.label_invalid, address.meta_invalid, public_key.label_invalid, invoice.comment_invalid, invoice.metadata_invalid."},"children":[]}]}]}],"mediaType":"application/problem+json","mediaTypes":["application/problem+json"],"mediaTypeContent":{"application/problem+json":{"schemaId":"components/schemas/InvalidRequestProblem","exampleIds":["paths/~1subscriptions~1{subscription_id}/delete/responses/400/content/application~1problem+json/examples/malformed_json"]}},"schemaId":"components/schemas/InvalidRequestProblem","exampleIds":["paths/~1subscriptions~1{subscription_id}/delete/responses/400/content/application~1problem+json/examples/malformed_json"]},{"code":"401","description":"Missing or invalid authentication credentials.","mediaType":"application/problem+json","mediaTypes":["application/problem+json"],"mediaTypeContent":{"application/problem+json":{"schemaId":"components/schemas/UnauthorizedProblem","exampleIds":["paths/~1subscriptions~1{subscription_id}/delete/responses/401/content/application~1problem+json/examples/service_authentication_denied"]}},"schemaId":"components/schemas/UnauthorizedProblem","exampleIds":["paths/~1subscriptions~1{subscription_id}/delete/responses/401/content/application~1problem+json/examples/service_authentication_denied"]},{"code":"403","description":"Insufficient permissions.","mediaType":"application/problem+json","mediaTypes":["application/problem+json"],"mediaTypeContent":{"application/problem+json":{"schemaId":"components/schemas/ForbiddenProblem","exampleIds":["paths/~1subscriptions~1{subscription_id}/delete/responses/403/content/application~1problem+json/examples/insufficient_permissions"]}},"schemaId":"components/schemas/ForbiddenProblem","exampleIds":["paths/~1subscriptions~1{subscription_id}/delete/responses/403/content/application~1problem+json/examples/insufficient_permissions"]},{"code":"404","description":"Requested resource does not exist.","mediaType":"application/problem+json","mediaTypes":["application/problem+json"],"mediaTypeContent":{"application/problem+json":{"schemaId":"components/schemas/NotFoundProblem","exampleIds":["paths/~1subscriptions~1{subscription_id}/delete/responses/404/content/application~1problem+json/examples/address_not_found","paths/~1subscriptions~1{subscription_id}/delete/responses/404/content/application~1problem+json/examples/invoice_not_found"]}},"schemaId":"components/schemas/NotFoundProblem","exampleIds":["paths/~1subscriptions~1{subscription_id}/delete/responses/404/content/application~1problem+json/examples/address_not_found","paths/~1subscriptions~1{subscription_id}/delete/responses/404/content/application~1problem+json/examples/invoice_not_found"]},{"code":"409","description":"Request conflicts with the current resource state.","mediaType":"application/problem+json","mediaTypes":["application/problem+json"],"mediaTypeContent":{"application/problem+json":{"schemaId":"components/schemas/ConflictProblem","exampleIds":["paths/~1subscriptions~1{subscription_id}/delete/responses/409/content/application~1problem+json/examples/address_occupied","paths/~1subscriptions~1{subscription_id}/delete/responses/409/content/application~1problem+json/examples/address_in_use","paths/~1subscriptions~1{subscription_id}/delete/responses/409/content/application~1problem+json/examples/subscription_v1_conflict","paths/~1subscriptions~1{subscription_id}/delete/responses/409/content/application~1problem+json/examples/notification_send_in_progress","paths/~1subscriptions~1{subscription_id}/delete/responses/409/content/application~1problem+json/examples/notification_payload_unavailable","paths/~1subscriptions~1{subscription_id}/delete/responses/409/content/application~1problem+json/examples/notification_test_resend_not_allowed"]}},"schemaId":"components/schemas/ConflictProblem","exampleIds":["paths/~1subscriptions~1{subscription_id}/delete/responses/409/content/application~1problem+json/examples/address_occupied","paths/~1subscriptions~1{subscription_id}/delete/responses/409/content/application~1problem+json/examples/address_in_use","paths/~1subscriptions~1{subscription_id}/delete/responses/409/content/application~1problem+json/examples/subscription_v1_conflict","paths/~1subscriptions~1{subscription_id}/delete/responses/409/content/application~1problem+json/examples/notification_send_in_progress","paths/~1subscriptions~1{subscription_id}/delete/responses/409/content/application~1problem+json/examples/notification_payload_unavailable","paths/~1subscriptions~1{subscription_id}/delete/responses/409/content/application~1problem+json/examples/notification_test_resend_not_allowed"]},{"code":"503","description":"The operation is temporarily unavailable. Please try again later.","mediaType":"application/problem+json","mediaTypes":["application/problem+json"],"mediaTypeContent":{"application/problem+json":{"schemaId":"components/schemas/Problem","exampleIds":["paths/~1subscriptions~1{subscription_id}/delete/responses/503/content/application~1problem+json/examples/temporarily_unavailable"]}},"schemaId":"components/schemas/Problem","exampleIds":["paths/~1subscriptions~1{subscription_id}/delete/responses/503/content/application~1problem+json/examples/temporarily_unavailable"]},{"code":"default","description":"Unexpected error.","mediaType":"application/problem+json","mediaTypes":["application/problem+json"],"mediaTypeContent":{"application/problem+json":{"schemaId":"components/schemas/Problem"}},"schemaId":"components/schemas/Problem"}],"pointer":"/paths/~1subscriptions~1{subscription_id}/delete/responses"}],"panels":[{"children":[{"kind":"response","responseCodes":[{"code":"204"},{"code":"400","schemaId":"components/schemas/InvalidRequestProblem","exampleIds":["paths/~1subscriptions~1{subscription_id}/delete/responses/400/content/application~1problem+json/examples/malformed_json"],"mediaTypes":["application/problem+json"],"mediaTypeContent":{"application/problem+json":{"schemaId":"components/schemas/InvalidRequestProblem","exampleIds":["paths/~1subscriptions~1{subscription_id}/delete/responses/400/content/application~1problem+json/examples/malformed_json"]}}},{"code":"401","schemaId":"components/schemas/UnauthorizedProblem","exampleIds":["paths/~1subscriptions~1{subscription_id}/delete/responses/401/content/application~1problem+json/examples/service_authentication_denied"],"mediaTypes":["application/problem+json"],"mediaTypeContent":{"application/problem+json":{"schemaId":"components/schemas/UnauthorizedProblem","exampleIds":["paths/~1subscriptions~1{subscription_id}/delete/responses/401/content/application~1problem+json/examples/service_authentication_denied"]}}},{"code":"403","schemaId":"components/schemas/ForbiddenProblem","exampleIds":["paths/~1subscriptions~1{subscription_id}/delete/responses/403/content/application~1problem+json/examples/insufficient_permissions"],"mediaTypes":["application/problem+json"],"mediaTypeContent":{"application/problem+json":{"schemaId":"components/schemas/ForbiddenProblem","exampleIds":["paths/~1subscriptions~1{subscription_id}/delete/responses/403/content/application~1problem+json/examples/insufficient_permissions"]}}},{"code":"404","schemaId":"components/schemas/NotFoundProblem","exampleIds":["paths/~1subscriptions~1{subscription_id}/delete/responses/404/content/application~1problem+json/examples/address_not_found","paths/~1subscriptions~1{subscription_id}/delete/responses/404/content/application~1problem+json/examples/invoice_not_found"],"mediaTypes":["application/problem+json"],"mediaTypeContent":{"application/problem+json":{"schemaId":"components/schemas/NotFoundProblem","exampleIds":["paths/~1subscriptions~1{subscription_id}/delete/responses/404/content/application~1problem+json/examples/address_not_found","paths/~1subscriptions~1{subscription_id}/delete/responses/404/content/application~1problem+json/examples/invoice_not_found"]}}},{"code":"409","schemaId":"components/schemas/ConflictProblem","exampleIds":["paths/~1subscriptions~1{subscription_id}/delete/responses/409/content/application~1problem+json/examples/address_occupied","paths/~1subscriptions~1{subscription_id}/delete/responses/409/content/application~1problem+json/examples/address_in_use","paths/~1subscriptions~1{subscription_id}/delete/responses/409/content/application~1problem+json/examples/subscription_v1_conflict","paths/~1subscriptions~1{subscription_id}/delete/responses/409/content/application~1problem+json/examples/notification_send_in_progress","paths/~1subscriptions~1{subscription_id}/delete/responses/409/content/application~1problem+json/examples/notification_payload_unavailable","paths/~1subscriptions~1{subscription_id}/delete/responses/409/content/application~1problem+json/examples/notification_test_resend_not_allowed"],"mediaTypes":["application/problem+json"],"mediaTypeContent":{"application/problem+json":{"schemaId":"components/schemas/ConflictProblem","exampleIds":["paths/~1subscriptions~1{subscription_id}/delete/responses/409/content/application~1problem+json/examples/address_occupied","paths/~1subscriptions~1{subscription_id}/delete/responses/409/content/application~1problem+json/examples/address_in_use","paths/~1subscriptions~1{subscription_id}/delete/responses/409/content/application~1problem+json/examples/subscription_v1_conflict","paths/~1subscriptions~1{subscription_id}/delete/responses/409/content/application~1problem+json/examples/notification_send_in_progress","paths/~1subscriptions~1{subscription_id}/delete/responses/409/content/application~1problem+json/examples/notification_payload_unavailable","paths/~1subscriptions~1{subscription_id}/delete/responses/409/content/application~1problem+json/examples/notification_test_resend_not_allowed"]}}},{"code":"503","schemaId":"components/schemas/Problem","exampleIds":["paths/~1subscriptions~1{subscription_id}/delete/responses/503/content/application~1problem+json/examples/temporarily_unavailable"],"mediaTypes":["application/problem+json"],"mediaTypeContent":{"application/problem+json":{"schemaId":"components/schemas/Problem","exampleIds":["paths/~1subscriptions~1{subscription_id}/delete/responses/503/content/application~1problem+json/examples/temporarily_unavailable"]}}},{"code":"default","schemaId":"components/schemas/Problem","mediaTypes":["application/problem+json"],"mediaTypeContent":{"application/problem+json":{"schemaId":"components/schemas/Problem"}}}],"examples":[]}]}]},{"nodeType":"container","children":[{"nodeType":"feedback","pageSlug":"/subscription/delete-subscription"}],"panels":[]}]},"httpPath":"/subscriptions/{subscription_id}"},{"label":"Update subscription","deprecated":false,"httpVerb":"patch","isAdditionalOperation":false,"isWebhook":false,"type":"link","link":"/apis/platform/api/subscription/patch-subscription","routeSlug":"/apis/platform/api/subscription/patch-subscription","metadata":{"seo":{"title":"Update subscription","description":"Update a subscription's name, availability, delay or filters. Omitted fields stay unchanged.filters replaces the whole filter object; {} clears both restrictions. family, channel_idand the trigger kind are immutable."}},"content":{"contentType":"item","itemVariant":"httpItem","meta":{"sourceId":"patch-subscription","name":"Update subscription","isWebhook":false,"pointer":"/paths/~1subscriptions~1{subscription_id}/patch","hasSamples":true},"children":[{"nodeType":"container","children":[{"nodeType":"header","level":2,"label":"Update subscription","isWebhook":false,"showPageActions":true}],"panels":[]},{"nodeType":"container","children":[{"nodeType":"header","level":4,"label":"Request","labelTranslationKey":"request","deepLinkSuffix":"request"},{"nodeType":"markdoc","content":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Update a subscription's name, availability, delay or filters. Omitted fields stay unchanged."},"children":[]},{"$$mdtype":"Node","type":"softbreak","inline":true,"attributes":{},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"filters"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" replaces the whole filter object; "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"{}"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" clears both restrictions. "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"family"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":", "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"channel_id"},"children":[]},{"$$mdtype":"Node","type":"softbreak","inline":true,"attributes":{},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"and the trigger kind are immutable."},"children":[]}]}]},{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Subscriptions created through v1 allow changes to "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"name"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" and "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"enabled"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" only. Replacing their"},"children":[]},{"$$mdtype":"Node","type":"softbreak","inline":true,"attributes":{},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"filters or changing the existing trigger's delay or noise-filter setting returns"},"children":[]},{"$$mdtype":"Node","type":"softbreak","inline":true,"attributes":{},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"409 notification.subscription_v1_conflict"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"."},"children":[]}]}]}]},{"nodeType":"security","requirements":[{"schemes":[{"name":"Auth","scopes":["api:subscription:write"],"type":"apiKey","in":"header","paramName":"X-Api-Key","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"API key for authenticating requests. Include your key in the "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"X-Api-Key"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" header. Keys can be created in the Vilna Dashboard or via the Management API. The scopes listed per operation indicate which permissions the key must have."},"children":[]}]}]}]}]}]},{"nodeType":"item-content","variant":"path","label":"Path","labelTranslationKey":"path","parameters":[{"name":"subscription_id","in":"path","schemaId":"schema_17","description":"Unique identifier (UUID) of the subscription.","required":true}],"pointer":"/paths/~1subscriptions~1{subscription_id}/patch/parameters"},{"nodeType":"item-content","variant":"headers","label":"Headers","labelTranslationKey":"header","parameters":[{"name":"Idempotency-Key","in":"header","schemaId":"schema_14","description":"Case-sensitive opaque key for one mutation intent. Send exactly one header occurrence containing 1 to 128 visible ASCII bytes (0x21..0x7e). Commas are literal data; do not trim, lowercase or require UUID syntax. Reuse the same key for retries, with current authorization checked on every attempt. Repeated header occurrences are rejected.\n","required":true}],"pointer":"/paths/~1subscriptions~1{subscription_id}/patch/parameters"},{"nodeType":"item-content","variant":"body","label":"Request Body","labelTranslationKey":"body","required":true,"mediaTypes":["application/json"],"mediaTypeSchemas":{"application/json":{"schemaId":"components/schemas/UpdateSubscriptionRequest","exampleIds":["paths/~1subscriptions~1{subscription_id}/patch/requestBody/content/application~1json/examples/update_delay","paths/~1subscriptions~1{subscription_id}/patch/requestBody/content/application~1json/examples/clear_filters","paths/~1subscriptions~1{subscription_id}/patch/requestBody/content/application~1json/examples/disable_subscription"]}},"schemaId":"components/schemas/UpdateSubscriptionRequest","exampleIds":["paths/~1subscriptions~1{subscription_id}/patch/requestBody/content/application~1json/examples/update_delay","paths/~1subscriptions~1{subscription_id}/patch/requestBody/content/application~1json/examples/clear_filters","paths/~1subscriptions~1{subscription_id}/patch/requestBody/content/application~1json/examples/disable_subscription"],"pointer":"/paths/~1subscriptions~1{subscription_id}/patch/requestBody"}],"panels":[{"children":[{"kind":"code-sample","source":{"kind":"code-sample","operationType":"http","method":"PATCH","path":"/subscriptions/{subscription_id}","servers":[{"url":"/_mock/apis/platform/api","description":"Mock server","isMockServer":true},{"url":"https://api.vilna.io/v2","description":"Vilna API."}],"parameters":{"path":[{"name":"subscription_id","in":"path","required":true,"example":"550e8400-e29b-41d4-a716-446655440000","schemaId":"components/schemas/UUID"}],"query":[],"querystring":[],"header":[{"name":"Idempotency-Key","in":"header","required":true,"schemaId":"schema_14"}],"cookie":[]},"security":[{"schemes":[{"id":"Auth","type":"apiKey","name":"X-Api-Key","in":"header"}],"scopes":["api:subscription:write"]}],"requestBody":{"application/json":{"schemaId":"components/schemas/UpdateSubscriptionRequest","exampleIds":["paths/~1subscriptions~1{subscription_id}/patch/requestBody/content/application~1json/examples/update_delay","paths/~1subscriptions~1{subscription_id}/patch/requestBody/content/application~1json/examples/clear_filters","paths/~1subscriptions~1{subscription_id}/patch/requestBody/content/application~1json/examples/disable_subscription"]}},"responseCodes":["200","400","401","403","404","409","503","default"],"pointer":"/subscriptions/{subscription_id}","href":"subscription/patch-subscription","openApiOperationId":"patch-subscription","summary":"Update subscription"},"isWebhook":false,"hideReplay":false,"servers":[{"url":"/_mock/apis/platform/api","description":"Mock server","isMockServer":true},{"url":"https://api.vilna.io/v2","description":"Vilna API."}],"schemaId":"components/schemas/UpdateSubscriptionRequest","exampleIds":["paths/~1subscriptions~1{subscription_id}/patch/requestBody/content/application~1json/examples/update_delay","paths/~1subscriptions~1{subscription_id}/patch/requestBody/content/application~1json/examples/clear_filters","paths/~1subscriptions~1{subscription_id}/patch/requestBody/content/application~1json/examples/disable_subscription"],"mediaTypes":["application/json"],"mediaTypeSchemas":{"application/json":{"schemaId":"components/schemas/UpdateSubscriptionRequest","exampleIds":["paths/~1subscriptions~1{subscription_id}/patch/requestBody/content/application~1json/examples/update_delay","paths/~1subscriptions~1{subscription_id}/patch/requestBody/content/application~1json/examples/clear_filters","paths/~1subscriptions~1{subscription_id}/patch/requestBody/content/application~1json/examples/disable_subscription"]}},"examples":[{},{},{}]}]}]},{"nodeType":"container","children":[{"nodeType":"header","level":4,"label":"Responses","labelTranslationKey":"responses","deepLinkSuffix":"responses"},{"nodeType":"item-content","variant":"responses","responses":[{"code":"200","description":"Notification subscription details.","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"schema_62"}},"schemaId":"schema_62"},{"code":"400","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Bad request (e.g., missing or invalid fields). Invalid text may be reported as address.label_invalid, address.meta_invalid, public_key.label_invalid, invoice.comment_invalid, invoice.metadata_invalid."},"children":[]}]}]}],"mediaType":"application/problem+json","mediaTypes":["application/problem+json"],"mediaTypeContent":{"application/problem+json":{"schemaId":"components/schemas/InvalidRequestProblem","exampleIds":["paths/~1subscriptions~1{subscription_id}/patch/responses/400/content/application~1problem+json/examples/malformed_json"]}},"schemaId":"components/schemas/InvalidRequestProblem","exampleIds":["paths/~1subscriptions~1{subscription_id}/patch/responses/400/content/application~1problem+json/examples/malformed_json"]},{"code":"401","description":"Missing or invalid authentication credentials.","mediaType":"application/problem+json","mediaTypes":["application/problem+json"],"mediaTypeContent":{"application/problem+json":{"schemaId":"components/schemas/UnauthorizedProblem","exampleIds":["paths/~1subscriptions~1{subscription_id}/patch/responses/401/content/application~1problem+json/examples/service_authentication_denied"]}},"schemaId":"components/schemas/UnauthorizedProblem","exampleIds":["paths/~1subscriptions~1{subscription_id}/patch/responses/401/content/application~1problem+json/examples/service_authentication_denied"]},{"code":"403","description":"Insufficient permissions.","mediaType":"application/problem+json","mediaTypes":["application/problem+json"],"mediaTypeContent":{"application/problem+json":{"schemaId":"components/schemas/ForbiddenProblem","exampleIds":["paths/~1subscriptions~1{subscription_id}/patch/responses/403/content/application~1problem+json/examples/insufficient_permissions"]}},"schemaId":"components/schemas/ForbiddenProblem","exampleIds":["paths/~1subscriptions~1{subscription_id}/patch/responses/403/content/application~1problem+json/examples/insufficient_permissions"]},{"code":"404","description":"Requested resource does not exist.","mediaType":"application/problem+json","mediaTypes":["application/problem+json"],"mediaTypeContent":{"application/problem+json":{"schemaId":"components/schemas/NotFoundProblem","exampleIds":["paths/~1subscriptions~1{subscription_id}/patch/responses/404/content/application~1problem+json/examples/address_not_found","paths/~1subscriptions~1{subscription_id}/patch/responses/404/content/application~1problem+json/examples/invoice_not_found"]}},"schemaId":"components/schemas/NotFoundProblem","exampleIds":["paths/~1subscriptions~1{subscription_id}/patch/responses/404/content/application~1problem+json/examples/address_not_found","paths/~1subscriptions~1{subscription_id}/patch/responses/404/content/application~1problem+json/examples/invoice_not_found"]},{"code":"409","description":"Request conflicts with the current resource state.","mediaType":"application/problem+json","mediaTypes":["application/problem+json"],"mediaTypeContent":{"application/problem+json":{"schemaId":"components/schemas/ConflictProblem","exampleIds":["paths/~1subscriptions~1{subscription_id}/patch/responses/409/content/application~1problem+json/examples/address_occupied","paths/~1subscriptions~1{subscription_id}/patch/responses/409/content/application~1problem+json/examples/address_in_use","paths/~1subscriptions~1{subscription_id}/patch/responses/409/content/application~1problem+json/examples/subscription_v1_conflict","paths/~1subscriptions~1{subscription_id}/patch/responses/409/content/application~1problem+json/examples/notification_send_in_progress","paths/~1subscriptions~1{subscription_id}/patch/responses/409/content/application~1problem+json/examples/notification_payload_unavailable","paths/~1subscriptions~1{subscription_id}/patch/responses/409/content/application~1problem+json/examples/notification_test_resend_not_allowed"]}},"schemaId":"components/schemas/ConflictProblem","exampleIds":["paths/~1subscriptions~1{subscription_id}/patch/responses/409/content/application~1problem+json/examples/address_occupied","paths/~1subscriptions~1{subscription_id}/patch/responses/409/content/application~1problem+json/examples/address_in_use","paths/~1subscriptions~1{subscription_id}/patch/responses/409/content/application~1problem+json/examples/subscription_v1_conflict","paths/~1subscriptions~1{subscription_id}/patch/responses/409/content/application~1problem+json/examples/notification_send_in_progress","paths/~1subscriptions~1{subscription_id}/patch/responses/409/content/application~1problem+json/examples/notification_payload_unavailable","paths/~1subscriptions~1{subscription_id}/patch/responses/409/content/application~1problem+json/examples/notification_test_resend_not_allowed"]},{"code":"503","description":"The operation is temporarily unavailable. Please try again later.","mediaType":"application/problem+json","mediaTypes":["application/problem+json"],"mediaTypeContent":{"application/problem+json":{"schemaId":"components/schemas/Problem","exampleIds":["paths/~1subscriptions~1{subscription_id}/patch/responses/503/content/application~1problem+json/examples/temporarily_unavailable"]}},"schemaId":"components/schemas/Problem","exampleIds":["paths/~1subscriptions~1{subscription_id}/patch/responses/503/content/application~1problem+json/examples/temporarily_unavailable"]},{"code":"default","description":"Unexpected error.","mediaType":"application/problem+json","mediaTypes":["application/problem+json"],"mediaTypeContent":{"application/problem+json":{"schemaId":"components/schemas/Problem"}},"schemaId":"components/schemas/Problem"}],"pointer":"/paths/~1subscriptions~1{subscription_id}/patch/responses"}],"panels":[{"children":[{"kind":"response","responseCodes":[{"code":"200","schemaId":"schema_62","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"schema_62"}}},{"code":"400","schemaId":"components/schemas/InvalidRequestProblem","exampleIds":["paths/~1subscriptions~1{subscription_id}/patch/responses/400/content/application~1problem+json/examples/malformed_json"],"mediaTypes":["application/problem+json"],"mediaTypeContent":{"application/problem+json":{"schemaId":"components/schemas/InvalidRequestProblem","exampleIds":["paths/~1subscriptions~1{subscription_id}/patch/responses/400/content/application~1problem+json/examples/malformed_json"]}}},{"code":"401","schemaId":"components/schemas/UnauthorizedProblem","exampleIds":["paths/~1subscriptions~1{subscription_id}/patch/responses/401/content/application~1problem+json/examples/service_authentication_denied"],"mediaTypes":["application/problem+json"],"mediaTypeContent":{"application/problem+json":{"schemaId":"components/schemas/UnauthorizedProblem","exampleIds":["paths/~1subscriptions~1{subscription_id}/patch/responses/401/content/application~1problem+json/examples/service_authentication_denied"]}}},{"code":"403","schemaId":"components/schemas/ForbiddenProblem","exampleIds":["paths/~1subscriptions~1{subscription_id}/patch/responses/403/content/application~1problem+json/examples/insufficient_permissions"],"mediaTypes":["application/problem+json"],"mediaTypeContent":{"application/problem+json":{"schemaId":"components/schemas/ForbiddenProblem","exampleIds":["paths/~1subscriptions~1{subscription_id}/patch/responses/403/content/application~1problem+json/examples/insufficient_permissions"]}}},{"code":"404","schemaId":"components/schemas/NotFoundProblem","exampleIds":["paths/~1subscriptions~1{subscription_id}/patch/responses/404/content/application~1problem+json/examples/address_not_found","paths/~1subscriptions~1{subscription_id}/patch/responses/404/content/application~1problem+json/examples/invoice_not_found"],"mediaTypes":["application/problem+json"],"mediaTypeContent":{"application/problem+json":{"schemaId":"components/schemas/NotFoundProblem","exampleIds":["paths/~1subscriptions~1{subscription_id}/patch/responses/404/content/application~1problem+json/examples/address_not_found","paths/~1subscriptions~1{subscription_id}/patch/responses/404/content/application~1problem+json/examples/invoice_not_found"]}}},{"code":"409","schemaId":"components/schemas/ConflictProblem","exampleIds":["paths/~1subscriptions~1{subscription_id}/patch/responses/409/content/application~1problem+json/examples/address_occupied","paths/~1subscriptions~1{subscription_id}/patch/responses/409/content/application~1problem+json/examples/address_in_use","paths/~1subscriptions~1{subscription_id}/patch/responses/409/content/application~1problem+json/examples/subscription_v1_conflict","paths/~1subscriptions~1{subscription_id}/patch/responses/409/content/application~1problem+json/examples/notification_send_in_progress","paths/~1subscriptions~1{subscription_id}/patch/responses/409/content/application~1problem+json/examples/notification_payload_unavailable","paths/~1subscriptions~1{subscription_id}/patch/responses/409/content/application~1problem+json/examples/notification_test_resend_not_allowed"],"mediaTypes":["application/problem+json"],"mediaTypeContent":{"application/problem+json":{"schemaId":"components/schemas/ConflictProblem","exampleIds":["paths/~1subscriptions~1{subscription_id}/patch/responses/409/content/application~1problem+json/examples/address_occupied","paths/~1subscriptions~1{subscription_id}/patch/responses/409/content/application~1problem+json/examples/address_in_use","paths/~1subscriptions~1{subscription_id}/patch/responses/409/content/application~1problem+json/examples/subscription_v1_conflict","paths/~1subscriptions~1{subscription_id}/patch/responses/409/content/application~1problem+json/examples/notification_send_in_progress","paths/~1subscriptions~1{subscription_id}/patch/responses/409/content/application~1problem+json/examples/notification_payload_unavailable","paths/~1subscriptions~1{subscription_id}/patch/responses/409/content/application~1problem+json/examples/notification_test_resend_not_allowed"]}}},{"code":"503","schemaId":"components/schemas/Problem","exampleIds":["paths/~1subscriptions~1{subscription_id}/patch/responses/503/content/application~1problem+json/examples/temporarily_unavailable"],"mediaTypes":["application/problem+json"],"mediaTypeContent":{"application/problem+json":{"schemaId":"components/schemas/Problem","exampleIds":["paths/~1subscriptions~1{subscription_id}/patch/responses/503/content/application~1problem+json/examples/temporarily_unavailable"]}}},{"code":"default","schemaId":"components/schemas/Problem","mediaTypes":["application/problem+json"],"mediaTypeContent":{"application/problem+json":{"schemaId":"components/schemas/Problem"}}}],"examples":[]}]}]},{"nodeType":"container","children":[{"nodeType":"feedback","pageSlug":"/subscription/patch-subscription"}],"panels":[]}]},"httpPath":"/subscriptions/{subscription_id}"}],"content":{"contentType":"group","meta":{"name":"subscription"},"children":[{"nodeType":"container","children":[{"nodeType":"header","level":2,"label":"Notification Subscriptions","showPageActions":true},{"nodeType":"markdoc","content":"Bind a channel to a chain family, a trigger and selection filters for targeted alert routing."}],"panels":[{"children":[{"kind":"group-items","title":"Operations","titleTranslationKey":"operations","items":[{"title":"/subscriptions","summary":"List subscriptions","prefix":{"name":"get","color":"get"},"badges":[],"link":"/subscription/list-subscriptions","deprecated":false},{"title":"/subscriptions","summary":"Create subscription","prefix":{"name":"post","color":"post"},"badges":[],"link":"/subscription/create-subscription","deprecated":false},{"title":"/subscriptions/{subscription_id}","summary":"Get subscription","prefix":{"name":"get","color":"get"},"badges":[],"link":"/subscription/get-subscription","deprecated":false},{"title":"/subscriptions/{subscription_id}","summary":"Delete subscription","prefix":{"name":"delete","color":"delete"},"badges":[],"link":"/subscription/delete-subscription","deprecated":false},{"title":"/subscriptions/{subscription_id}","summary":"Update subscription","prefix":{"name":"patch","color":"patch"},"badges":[],"link":"/subscription/patch-subscription","deprecated":false}]}]}]}]}},{"type":"group","label":"Notifications","link":"/apis/platform/api/notification","routeSlug":"/apis/platform/api/notification","items":[{"label":"List notifications","deprecated":false,"httpVerb":"get","isAdditionalOperation":false,"isWebhook":false,"type":"link","link":"/apis/platform/api/notification/list-notifications","routeSlug":"/apis/platform/api/notification/list-notifications","metadata":{"seo":{"title":"List notifications","description":"List the project's notification history, including notifications waiting for their subscription condition, with filtering and pagination. Filters combine with AND, and filtering by a channel or subscription that has since been deleted still works, because the history keeps the identity it was created with."}},"content":{"contentType":"item","itemVariant":"httpItem","meta":{"sourceId":"list-notifications","name":"List notifications","isWebhook":false,"pointer":"/paths/~1notifications/get","hasSamples":false},"children":[{"nodeType":"container","children":[{"nodeType":"header","level":2,"label":"List notifications","isWebhook":false,"showPageActions":true}],"panels":[]},{"nodeType":"container","children":[{"nodeType":"header","level":4,"label":"Request","labelTranslationKey":"request","deepLinkSuffix":"request"},{"nodeType":"markdoc","content":"List the project's notification history, including notifications waiting for their subscription\ncondition, with filtering and pagination. Filters combine with AND, and filtering by a channel\nor subscription that has since been deleted still works, because the history keeps the identity\nit was created with.\n"},{"nodeType":"security","requirements":[{"schemes":[{"name":"Auth","scopes":["api:channel:read"],"type":"apiKey","in":"header","paramName":"X-Api-Key","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"API key for authenticating requests. Include your key in the "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"X-Api-Key"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" header. Keys can be created in the Vilna Dashboard or via the Management API. The scopes listed per operation indicate which permissions the key must have."},"children":[]}]}]}]}]}]},{"nodeType":"item-content","variant":"query","label":"Query","labelTranslationKey":"query","parameters":[{"name":"limit","in":"query","schemaId":"schema_0","description":"Maximum number of items to return."},{"name":"page","in":"query","schemaId":"schema_1","description":"Page number for pagination."},{"name":"channel_id","in":"query","schemaId":"schema_17","description":"Filter by the channel the notification was sent to. The channel need not still exist."},{"name":"subscription_id","in":"query","schemaId":"schema_17","description":"Filter by the subscription that selected the transaction. The subscription need not still exist."},{"name":"status","in":"query","schemaId":"schema_63","description":"Filter by current notification status."},{"name":"chain_gid","in":"query","schemaId":"schema_29","description":"Filter by the network of the transaction. Tests carry no network and are excluded.","example":"eip155:1"},{"name":"txid","in":"query","schemaId":"schema_44","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Filter by transaction. Requires chain_gid, since a transaction id alone is ambiguous across networks."},"children":[]}]}]}]},{"name":"is_test","in":"query","schemaId":"schema_41","description":"Filter by whether the notification is a channel test. Omit it to get both tests and transaction notifications.","example":false},{"name":"date_from","in":"query","schemaId":"schema_7","description":"Filter notifications created from this moment on (inclusive, RFC 3339).","example":"2024-01-01T00:00:00Z"},{"name":"date_to","in":"query","schemaId":"schema_7","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Filter notifications created before this moment (exclusive, RFC 3339). It has to follow date_from."},"children":[]}]}]}],"example":"2024-02-01T00:00:00Z"},{"name":"sort_by","in":"query","schemaId":"schema_64","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Field to sort results by. Use "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"-"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" prefix for descending order."},"children":[]}]}]}]}],"pointer":"/paths/~1notifications/get/parameters"}],"panels":[{"children":[{"kind":"code-sample","source":{"kind":"code-sample","operationType":"http","method":"GET","path":"/notifications","servers":[{"url":"/_mock/apis/platform/api","description":"Mock server","isMockServer":true},{"url":"https://api.vilna.io/v2","description":"Vilna API."}],"parameters":{"path":[],"query":[{"name":"limit","in":"query","required":false,"example":20,"schemaId":"schema_0"},{"name":"page","in":"query","required":false,"example":1,"schemaId":"schema_1"},{"name":"channel_id","in":"query","required":false,"example":"550e8400-e29b-41d4-a716-446655440000","schemaId":"components/schemas/UUID"},{"name":"subscription_id","in":"query","required":false,"example":"550e8400-e29b-41d4-a716-446655440000","schemaId":"components/schemas/UUID"},{"name":"status","in":"query","required":false,"example":"delivered","schemaId":"components/schemas/NotificationStatus"},{"name":"chain_gid","in":"query","required":false,"example":"eip155:1","schemaId":"components/schemas/ChainGID"},{"name":"txid","in":"query","required":false,"example":"0x1234567890abcdef1234567890abcdef1234567890abcdef1234567890abcdef","schemaId":"components/schemas/Txid"},{"name":"is_test","in":"query","required":false,"example":false,"schemaId":"schema_41"},{"name":"date_from","in":"query","required":false,"example":"2024-01-01T00:00:00Z","schemaId":"components/schemas/Timestamp"},{"name":"date_to","in":"query","required":false,"example":"2024-02-01T00:00:00Z","schemaId":"components/schemas/Timestamp"},{"name":"sort_by","in":"query","required":false,"example":"created_at","schemaId":"schema_64"}],"querystring":[],"header":[],"cookie":[]},"security":[{"schemes":[{"id":"Auth","type":"apiKey","name":"X-Api-Key","in":"header"}],"scopes":["api:channel:read"]}],"responseCodes":["200","400","401","403","503","default"],"pointer":"/notifications","href":"notification/list-notifications","openApiOperationId":"list-notifications","summary":"List notifications"},"isWebhook":false,"hideReplay":false,"servers":[{"url":"/_mock/apis/platform/api","description":"Mock server","isMockServer":true},{"url":"https://api.vilna.io/v2","description":"Vilna API."}],"examples":[]}]}]},{"nodeType":"container","children":[{"nodeType":"header","level":4,"label":"Responses","labelTranslationKey":"responses","deepLinkSuffix":"responses"},{"nodeType":"item-content","variant":"responses","responses":[{"code":"200","description":"List of notifications with pagination.","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"schema_65"}},"schemaId":"schema_65"},{"code":"400","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Bad request (e.g., missing or invalid fields). Invalid text may be reported as address.label_invalid, address.meta_invalid, public_key.label_invalid, invoice.comment_invalid, invoice.metadata_invalid."},"children":[]}]}]}],"mediaType":"application/problem+json","mediaTypes":["application/problem+json"],"mediaTypeContent":{"application/problem+json":{"schemaId":"components/schemas/InvalidRequestProblem","exampleIds":["paths/~1notifications/get/responses/400/content/application~1problem+json/examples/malformed_json"]}},"schemaId":"components/schemas/InvalidRequestProblem","exampleIds":["paths/~1notifications/get/responses/400/content/application~1problem+json/examples/malformed_json"]},{"code":"401","description":"Missing or invalid authentication credentials.","mediaType":"application/problem+json","mediaTypes":["application/problem+json"],"mediaTypeContent":{"application/problem+json":{"schemaId":"components/schemas/UnauthorizedProblem","exampleIds":["paths/~1notifications/get/responses/401/content/application~1problem+json/examples/service_authentication_denied"]}},"schemaId":"components/schemas/UnauthorizedProblem","exampleIds":["paths/~1notifications/get/responses/401/content/application~1problem+json/examples/service_authentication_denied"]},{"code":"403","description":"Insufficient permissions.","mediaType":"application/problem+json","mediaTypes":["application/problem+json"],"mediaTypeContent":{"application/problem+json":{"schemaId":"components/schemas/ForbiddenProblem","exampleIds":["paths/~1notifications/get/responses/403/content/application~1problem+json/examples/insufficient_permissions"]}},"schemaId":"components/schemas/ForbiddenProblem","exampleIds":["paths/~1notifications/get/responses/403/content/application~1problem+json/examples/insufficient_permissions"]},{"code":"503","description":"The operation is temporarily unavailable. Please try again later.","mediaType":"application/problem+json","mediaTypes":["application/problem+json"],"mediaTypeContent":{"application/problem+json":{"schemaId":"components/schemas/Problem","exampleIds":["paths/~1notifications/get/responses/503/content/application~1problem+json/examples/temporarily_unavailable"]}},"schemaId":"components/schemas/Problem","exampleIds":["paths/~1notifications/get/responses/503/content/application~1problem+json/examples/temporarily_unavailable"]},{"code":"default","description":"Unexpected error.","mediaType":"application/problem+json","mediaTypes":["application/problem+json"],"mediaTypeContent":{"application/problem+json":{"schemaId":"components/schemas/Problem"}},"schemaId":"components/schemas/Problem"}],"pointer":"/paths/~1notifications/get/responses"}],"panels":[{"children":[{"kind":"response","responseCodes":[{"code":"200","schemaId":"schema_65","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"schema_65"}}},{"code":"400","schemaId":"components/schemas/InvalidRequestProblem","exampleIds":["paths/~1notifications/get/responses/400/content/application~1problem+json/examples/malformed_json"],"mediaTypes":["application/problem+json"],"mediaTypeContent":{"application/problem+json":{"schemaId":"components/schemas/InvalidRequestProblem","exampleIds":["paths/~1notifications/get/responses/400/content/application~1problem+json/examples/malformed_json"]}}},{"code":"401","schemaId":"components/schemas/UnauthorizedProblem","exampleIds":["paths/~1notifications/get/responses/401/content/application~1problem+json/examples/service_authentication_denied"],"mediaTypes":["application/problem+json"],"mediaTypeContent":{"application/problem+json":{"schemaId":"components/schemas/UnauthorizedProblem","exampleIds":["paths/~1notifications/get/responses/401/content/application~1problem+json/examples/service_authentication_denied"]}}},{"code":"403","schemaId":"components/schemas/ForbiddenProblem","exampleIds":["paths/~1notifications/get/responses/403/content/application~1problem+json/examples/insufficient_permissions"],"mediaTypes":["application/problem+json"],"mediaTypeContent":{"application/problem+json":{"schemaId":"components/schemas/ForbiddenProblem","exampleIds":["paths/~1notifications/get/responses/403/content/application~1problem+json/examples/insufficient_permissions"]}}},{"code":"503","schemaId":"components/schemas/Problem","exampleIds":["paths/~1notifications/get/responses/503/content/application~1problem+json/examples/temporarily_unavailable"],"mediaTypes":["application/problem+json"],"mediaTypeContent":{"application/problem+json":{"schemaId":"components/schemas/Problem","exampleIds":["paths/~1notifications/get/responses/503/content/application~1problem+json/examples/temporarily_unavailable"]}}},{"code":"default","schemaId":"components/schemas/Problem","mediaTypes":["application/problem+json"],"mediaTypeContent":{"application/problem+json":{"schemaId":"components/schemas/Problem"}}}],"examples":[]}]}]},{"nodeType":"container","children":[{"nodeType":"feedback","pageSlug":"/notification/list-notifications"}],"panels":[]}]},"httpPath":"/notifications"},{"label":"Get notification","deprecated":false,"httpVerb":"get","isAdditionalOperation":false,"isWebhook":false,"type":"link","link":"/apis/platform/api/notification/get-notification","routeSlug":"/apis/platform/api/notification/get-notification","metadata":{"seo":{"title":"Get notification","description":"Get one notification and its original content. The content remains readable after thetransaction has changed. Delivery attempts are paginated separately under /logs."}},"content":{"contentType":"item","itemVariant":"httpItem","meta":{"sourceId":"get-notification","name":"Get notification","isWebhook":false,"pointer":"/paths/~1notifications~1{notification_id}/get","hasSamples":false},"children":[{"nodeType":"container","children":[{"nodeType":"header","level":2,"label":"Get notification","isWebhook":false,"showPageActions":true}],"panels":[]},{"nodeType":"container","children":[{"nodeType":"header","level":4,"label":"Request","labelTranslationKey":"request","deepLinkSuffix":"request"},{"nodeType":"markdoc","content":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Get one notification and its original content. The content remains readable after the"},"children":[]},{"$$mdtype":"Node","type":"softbreak","inline":true,"attributes":{},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"transaction has changed. Delivery attempts are paginated separately under "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"/logs"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"."},"children":[]}]}]}]},{"nodeType":"security","requirements":[{"schemes":[{"name":"Auth","scopes":["api:channel:read"],"type":"apiKey","in":"header","paramName":"X-Api-Key","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"API key for authenticating requests. Include your key in the "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"X-Api-Key"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" header. Keys can be created in the Vilna Dashboard or via the Management API. The scopes listed per operation indicate which permissions the key must have."},"children":[]}]}]}]}]}]},{"nodeType":"item-content","variant":"path","label":"Path","labelTranslationKey":"path","parameters":[{"name":"notification_id","in":"path","schemaId":"schema_17","description":"Unique identifier (UUID) of the notification.","required":true}],"pointer":"/paths/~1notifications~1{notification_id}/get/parameters"}],"panels":[{"children":[{"kind":"code-sample","source":{"kind":"code-sample","operationType":"http","method":"GET","path":"/notifications/{notification_id}","servers":[{"url":"/_mock/apis/platform/api","description":"Mock server","isMockServer":true},{"url":"https://api.vilna.io/v2","description":"Vilna API."}],"parameters":{"path":[{"name":"notification_id","in":"path","required":true,"example":"550e8400-e29b-41d4-a716-446655440000","schemaId":"components/schemas/UUID"}],"query":[],"querystring":[],"header":[],"cookie":[]},"security":[{"schemes":[{"id":"Auth","type":"apiKey","name":"X-Api-Key","in":"header"}],"scopes":["api:channel:read"]}],"responseCodes":["200","400","401","403","404","503","default"],"pointer":"/notifications/{notification_id}","href":"notification/get-notification","openApiOperationId":"get-notification","summary":"Get notification"},"isWebhook":false,"hideReplay":false,"servers":[{"url":"/_mock/apis/platform/api","description":"Mock server","isMockServer":true},{"url":"https://api.vilna.io/v2","description":"Vilna API."}],"examples":[]}]}]},{"nodeType":"container","children":[{"nodeType":"header","level":4,"label":"Responses","labelTranslationKey":"responses","deepLinkSuffix":"responses"},{"nodeType":"item-content","variant":"responses","responses":[{"code":"200","description":"One notification with the content frozen for it.","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"schema_66"}},"schemaId":"schema_66"},{"code":"400","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Bad request (e.g., missing or invalid fields). Invalid text may be reported as address.label_invalid, address.meta_invalid, public_key.label_invalid, invoice.comment_invalid, invoice.metadata_invalid."},"children":[]}]}]}],"mediaType":"application/problem+json","mediaTypes":["application/problem+json"],"mediaTypeContent":{"application/problem+json":{"schemaId":"components/schemas/InvalidRequestProblem","exampleIds":["paths/~1notifications~1{notification_id}/get/responses/400/content/application~1problem+json/examples/malformed_json"]}},"schemaId":"components/schemas/InvalidRequestProblem","exampleIds":["paths/~1notifications~1{notification_id}/get/responses/400/content/application~1problem+json/examples/malformed_json"]},{"code":"401","description":"Missing or invalid authentication credentials.","mediaType":"application/problem+json","mediaTypes":["application/problem+json"],"mediaTypeContent":{"application/problem+json":{"schemaId":"components/schemas/UnauthorizedProblem","exampleIds":["paths/~1notifications~1{notification_id}/get/responses/401/content/application~1problem+json/examples/service_authentication_denied"]}},"schemaId":"components/schemas/UnauthorizedProblem","exampleIds":["paths/~1notifications~1{notification_id}/get/responses/401/content/application~1problem+json/examples/service_authentication_denied"]},{"code":"403","description":"Insufficient permissions.","mediaType":"application/problem+json","mediaTypes":["application/problem+json"],"mediaTypeContent":{"application/problem+json":{"schemaId":"components/schemas/ForbiddenProblem","exampleIds":["paths/~1notifications~1{notification_id}/get/responses/403/content/application~1problem+json/examples/insufficient_permissions"]}},"schemaId":"components/schemas/ForbiddenProblem","exampleIds":["paths/~1notifications~1{notification_id}/get/responses/403/content/application~1problem+json/examples/insufficient_permissions"]},{"code":"404","description":"Requested resource does not exist.","mediaType":"application/problem+json","mediaTypes":["application/problem+json"],"mediaTypeContent":{"application/problem+json":{"schemaId":"components/schemas/NotFoundProblem","exampleIds":["paths/~1notifications~1{notification_id}/get/responses/404/content/application~1problem+json/examples/address_not_found","paths/~1notifications~1{notification_id}/get/responses/404/content/application~1problem+json/examples/invoice_not_found"]}},"schemaId":"components/schemas/NotFoundProblem","exampleIds":["paths/~1notifications~1{notification_id}/get/responses/404/content/application~1problem+json/examples/address_not_found","paths/~1notifications~1{notification_id}/get/responses/404/content/application~1problem+json/examples/invoice_not_found"]},{"code":"503","description":"The operation is temporarily unavailable. Please try again later.","mediaType":"application/problem+json","mediaTypes":["application/problem+json"],"mediaTypeContent":{"application/problem+json":{"schemaId":"components/schemas/Problem","exampleIds":["paths/~1notifications~1{notification_id}/get/responses/503/content/application~1problem+json/examples/temporarily_unavailable"]}},"schemaId":"components/schemas/Problem","exampleIds":["paths/~1notifications~1{notification_id}/get/responses/503/content/application~1problem+json/examples/temporarily_unavailable"]},{"code":"default","description":"Unexpected error.","mediaType":"application/problem+json","mediaTypes":["application/problem+json"],"mediaTypeContent":{"application/problem+json":{"schemaId":"components/schemas/Problem"}},"schemaId":"components/schemas/Problem"}],"pointer":"/paths/~1notifications~1{notification_id}/get/responses"}],"panels":[{"children":[{"kind":"response","responseCodes":[{"code":"200","schemaId":"schema_66","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"schema_66"}}},{"code":"400","schemaId":"components/schemas/InvalidRequestProblem","exampleIds":["paths/~1notifications~1{notification_id}/get/responses/400/content/application~1problem+json/examples/malformed_json"],"mediaTypes":["application/problem+json"],"mediaTypeContent":{"application/problem+json":{"schemaId":"components/schemas/InvalidRequestProblem","exampleIds":["paths/~1notifications~1{notification_id}/get/responses/400/content/application~1problem+json/examples/malformed_json"]}}},{"code":"401","schemaId":"components/schemas/UnauthorizedProblem","exampleIds":["paths/~1notifications~1{notification_id}/get/responses/401/content/application~1problem+json/examples/service_authentication_denied"],"mediaTypes":["application/problem+json"],"mediaTypeContent":{"application/problem+json":{"schemaId":"components/schemas/UnauthorizedProblem","exampleIds":["paths/~1notifications~1{notification_id}/get/responses/401/content/application~1problem+json/examples/service_authentication_denied"]}}},{"code":"403","schemaId":"components/schemas/ForbiddenProblem","exampleIds":["paths/~1notifications~1{notification_id}/get/responses/403/content/application~1problem+json/examples/insufficient_permissions"],"mediaTypes":["application/problem+json"],"mediaTypeContent":{"application/problem+json":{"schemaId":"components/schemas/ForbiddenProblem","exampleIds":["paths/~1notifications~1{notification_id}/get/responses/403/content/application~1problem+json/examples/insufficient_permissions"]}}},{"code":"404","schemaId":"components/schemas/NotFoundProblem","exampleIds":["paths/~1notifications~1{notification_id}/get/responses/404/content/application~1problem+json/examples/address_not_found","paths/~1notifications~1{notification_id}/get/responses/404/content/application~1problem+json/examples/invoice_not_found"],"mediaTypes":["application/problem+json"],"mediaTypeContent":{"application/problem+json":{"schemaId":"components/schemas/NotFoundProblem","exampleIds":["paths/~1notifications~1{notification_id}/get/responses/404/content/application~1problem+json/examples/address_not_found","paths/~1notifications~1{notification_id}/get/responses/404/content/application~1problem+json/examples/invoice_not_found"]}}},{"code":"503","schemaId":"components/schemas/Problem","exampleIds":["paths/~1notifications~1{notification_id}/get/responses/503/content/application~1problem+json/examples/temporarily_unavailable"],"mediaTypes":["application/problem+json"],"mediaTypeContent":{"application/problem+json":{"schemaId":"components/schemas/Problem","exampleIds":["paths/~1notifications~1{notification_id}/get/responses/503/content/application~1problem+json/examples/temporarily_unavailable"]}}},{"code":"default","schemaId":"components/schemas/Problem","mediaTypes":["application/problem+json"],"mediaTypeContent":{"application/problem+json":{"schemaId":"components/schemas/Problem"}}}],"examples":[]}]}]},{"nodeType":"container","children":[{"nodeType":"feedback","pageSlug":"/notification/get-notification"}],"panels":[]}]},"httpPath":"/notifications/{notification_id}"},{"label":"List notification logs","deprecated":false,"httpVerb":"get","isAdditionalOperation":false,"isWebhook":false,"type":"link","link":"/apis/platform/api/notification/list-notification-logs","routeSlug":"/apis/platform/api/notification/list-notification-logs","metadata":{"seo":{"title":"List notification logs","description":"List the delivery attempts of a notification, manual sends included, with pagination. A notification that has not been attempted yet returns an empty page rather than a 404."}},"content":{"contentType":"item","itemVariant":"httpItem","meta":{"sourceId":"list-notification-logs","name":"List notification logs","isWebhook":false,"pointer":"/paths/~1notifications~1{notification_id}~1logs/get","hasSamples":false},"children":[{"nodeType":"container","children":[{"nodeType":"header","level":2,"label":"List notification logs","isWebhook":false,"showPageActions":true}],"panels":[]},{"nodeType":"container","children":[{"nodeType":"header","level":4,"label":"Request","labelTranslationKey":"request","deepLinkSuffix":"request"},{"nodeType":"markdoc","content":"List the delivery attempts of a notification, manual sends included, with pagination. A notification\nthat has not been attempted yet returns an empty page rather than a 404.\n"},{"nodeType":"security","requirements":[{"schemes":[{"name":"Auth","scopes":["api:channel:read"],"type":"apiKey","in":"header","paramName":"X-Api-Key","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"API key for authenticating requests. Include your key in the "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"X-Api-Key"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" header. Keys can be created in the Vilna Dashboard or via the Management API. The scopes listed per operation indicate which permissions the key must have."},"children":[]}]}]}]}]}]},{"nodeType":"item-content","variant":"path","label":"Path","labelTranslationKey":"path","parameters":[{"name":"notification_id","in":"path","schemaId":"schema_17","description":"Unique identifier (UUID) of the notification.","required":true}],"pointer":"/paths/~1notifications~1{notification_id}~1logs/get/parameters"},{"nodeType":"item-content","variant":"query","label":"Query","labelTranslationKey":"query","parameters":[{"name":"limit","in":"query","schemaId":"schema_0","description":"Maximum number of items to return."},{"name":"page","in":"query","schemaId":"schema_1","description":"Page number for pagination."},{"name":"sort_by","in":"query","schemaId":"schema_67","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Field to sort results by. Use "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"-"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" prefix for descending order."},"children":[]}]}]}]}],"pointer":"/paths/~1notifications~1{notification_id}~1logs/get/parameters"}],"panels":[{"children":[{"kind":"code-sample","source":{"kind":"code-sample","operationType":"http","method":"GET","path":"/notifications/{notification_id}/logs","servers":[{"url":"/_mock/apis/platform/api","description":"Mock server","isMockServer":true},{"url":"https://api.vilna.io/v2","description":"Vilna API."}],"parameters":{"path":[{"name":"notification_id","in":"path","required":true,"example":"550e8400-e29b-41d4-a716-446655440000","schemaId":"components/schemas/UUID"}],"query":[{"name":"limit","in":"query","required":false,"example":20,"schemaId":"schema_0"},{"name":"page","in":"query","required":false,"example":1,"schemaId":"schema_1"},{"name":"sort_by","in":"query","required":false,"example":"number","schemaId":"schema_67"}],"querystring":[],"header":[],"cookie":[]},"security":[{"schemes":[{"id":"Auth","type":"apiKey","name":"X-Api-Key","in":"header"}],"scopes":["api:channel:read"]}],"responseCodes":["200","400","401","403","404","503","default"],"pointer":"/notifications/{notification_id}/logs","href":"notification/list-notification-logs","openApiOperationId":"list-notification-logs","summary":"List notification logs"},"isWebhook":false,"hideReplay":false,"servers":[{"url":"/_mock/apis/platform/api","description":"Mock server","isMockServer":true},{"url":"https://api.vilna.io/v2","description":"Vilna API."}],"examples":[]}]}]},{"nodeType":"container","children":[{"nodeType":"header","level":4,"label":"Responses","labelTranslationKey":"responses","deepLinkSuffix":"responses"},{"nodeType":"item-content","variant":"responses","responses":[{"code":"200","description":"List of delivery attempts for the notification, with pagination.","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"schema_68"}},"schemaId":"schema_68"},{"code":"400","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Bad request (e.g., missing or invalid fields). Invalid text may be reported as address.label_invalid, address.meta_invalid, public_key.label_invalid, invoice.comment_invalid, invoice.metadata_invalid."},"children":[]}]}]}],"mediaType":"application/problem+json","mediaTypes":["application/problem+json"],"mediaTypeContent":{"application/problem+json":{"schemaId":"components/schemas/InvalidRequestProblem","exampleIds":["paths/~1notifications~1{notification_id}~1logs/get/responses/400/content/application~1problem+json/examples/malformed_json"]}},"schemaId":"components/schemas/InvalidRequestProblem","exampleIds":["paths/~1notifications~1{notification_id}~1logs/get/responses/400/content/application~1problem+json/examples/malformed_json"]},{"code":"401","description":"Missing or invalid authentication credentials.","mediaType":"application/problem+json","mediaTypes":["application/problem+json"],"mediaTypeContent":{"application/problem+json":{"schemaId":"components/schemas/UnauthorizedProblem","exampleIds":["paths/~1notifications~1{notification_id}~1logs/get/responses/401/content/application~1problem+json/examples/service_authentication_denied"]}},"schemaId":"components/schemas/UnauthorizedProblem","exampleIds":["paths/~1notifications~1{notification_id}~1logs/get/responses/401/content/application~1problem+json/examples/service_authentication_denied"]},{"code":"403","description":"Insufficient permissions.","mediaType":"application/problem+json","mediaTypes":["application/problem+json"],"mediaTypeContent":{"application/problem+json":{"schemaId":"components/schemas/ForbiddenProblem","exampleIds":["paths/~1notifications~1{notification_id}~1logs/get/responses/403/content/application~1problem+json/examples/insufficient_permissions"]}},"schemaId":"components/schemas/ForbiddenProblem","exampleIds":["paths/~1notifications~1{notification_id}~1logs/get/responses/403/content/application~1problem+json/examples/insufficient_permissions"]},{"code":"404","description":"Requested resource does not exist.","mediaType":"application/problem+json","mediaTypes":["application/problem+json"],"mediaTypeContent":{"application/problem+json":{"schemaId":"components/schemas/NotFoundProblem","exampleIds":["paths/~1notifications~1{notification_id}~1logs/get/responses/404/content/application~1problem+json/examples/address_not_found","paths/~1notifications~1{notification_id}~1logs/get/responses/404/content/application~1problem+json/examples/invoice_not_found"]}},"schemaId":"components/schemas/NotFoundProblem","exampleIds":["paths/~1notifications~1{notification_id}~1logs/get/responses/404/content/application~1problem+json/examples/address_not_found","paths/~1notifications~1{notification_id}~1logs/get/responses/404/content/application~1problem+json/examples/invoice_not_found"]},{"code":"503","description":"The operation is temporarily unavailable. Please try again later.","mediaType":"application/problem+json","mediaTypes":["application/problem+json"],"mediaTypeContent":{"application/problem+json":{"schemaId":"components/schemas/Problem","exampleIds":["paths/~1notifications~1{notification_id}~1logs/get/responses/503/content/application~1problem+json/examples/temporarily_unavailable"]}},"schemaId":"components/schemas/Problem","exampleIds":["paths/~1notifications~1{notification_id}~1logs/get/responses/503/content/application~1problem+json/examples/temporarily_unavailable"]},{"code":"default","description":"Unexpected error.","mediaType":"application/problem+json","mediaTypes":["application/problem+json"],"mediaTypeContent":{"application/problem+json":{"schemaId":"components/schemas/Problem"}},"schemaId":"components/schemas/Problem"}],"pointer":"/paths/~1notifications~1{notification_id}~1logs/get/responses"}],"panels":[{"children":[{"kind":"response","responseCodes":[{"code":"200","schemaId":"schema_68","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"schema_68"}}},{"code":"400","schemaId":"components/schemas/InvalidRequestProblem","exampleIds":["paths/~1notifications~1{notification_id}~1logs/get/responses/400/content/application~1problem+json/examples/malformed_json"],"mediaTypes":["application/problem+json"],"mediaTypeContent":{"application/problem+json":{"schemaId":"components/schemas/InvalidRequestProblem","exampleIds":["paths/~1notifications~1{notification_id}~1logs/get/responses/400/content/application~1problem+json/examples/malformed_json"]}}},{"code":"401","schemaId":"components/schemas/UnauthorizedProblem","exampleIds":["paths/~1notifications~1{notification_id}~1logs/get/responses/401/content/application~1problem+json/examples/service_authentication_denied"],"mediaTypes":["application/problem+json"],"mediaTypeContent":{"application/problem+json":{"schemaId":"components/schemas/UnauthorizedProblem","exampleIds":["paths/~1notifications~1{notification_id}~1logs/get/responses/401/content/application~1problem+json/examples/service_authentication_denied"]}}},{"code":"403","schemaId":"components/schemas/ForbiddenProblem","exampleIds":["paths/~1notifications~1{notification_id}~1logs/get/responses/403/content/application~1problem+json/examples/insufficient_permissions"],"mediaTypes":["application/problem+json"],"mediaTypeContent":{"application/problem+json":{"schemaId":"components/schemas/ForbiddenProblem","exampleIds":["paths/~1notifications~1{notification_id}~1logs/get/responses/403/content/application~1problem+json/examples/insufficient_permissions"]}}},{"code":"404","schemaId":"components/schemas/NotFoundProblem","exampleIds":["paths/~1notifications~1{notification_id}~1logs/get/responses/404/content/application~1problem+json/examples/address_not_found","paths/~1notifications~1{notification_id}~1logs/get/responses/404/content/application~1problem+json/examples/invoice_not_found"],"mediaTypes":["application/problem+json"],"mediaTypeContent":{"application/problem+json":{"schemaId":"components/schemas/NotFoundProblem","exampleIds":["paths/~1notifications~1{notification_id}~1logs/get/responses/404/content/application~1problem+json/examples/address_not_found","paths/~1notifications~1{notification_id}~1logs/get/responses/404/content/application~1problem+json/examples/invoice_not_found"]}}},{"code":"503","schemaId":"components/schemas/Problem","exampleIds":["paths/~1notifications~1{notification_id}~1logs/get/responses/503/content/application~1problem+json/examples/temporarily_unavailable"],"mediaTypes":["application/problem+json"],"mediaTypeContent":{"application/problem+json":{"schemaId":"components/schemas/Problem","exampleIds":["paths/~1notifications~1{notification_id}~1logs/get/responses/503/content/application~1problem+json/examples/temporarily_unavailable"]}}},{"code":"default","schemaId":"components/schemas/Problem","mediaTypes":["application/problem+json"],"mediaTypeContent":{"application/problem+json":{"schemaId":"components/schemas/Problem"}}}],"examples":[]}]}]},{"nodeType":"container","children":[{"nodeType":"feedback","pageSlug":"/notification/list-notification-logs"}],"panels":[]}]},"httpPath":"/notifications/{notification_id}/logs"},{"label":"Resend notification","deprecated":false,"httpVerb":"post","isAdditionalOperation":false,"isWebhook":false,"type":"link","link":"/apis/platform/api/notification/resend-notification","routeSlug":"/apis/platform/api/notification/resend-notification","metadata":{"seo":{"title":"Resend notification","description":"Send one more attempt of a notification that still has its content, delivered ones included. Thestored bytes, the event id and the payload version are reused exactly. Delivery uses the channel'scurrent delivery configuration; the request cannot override it. A channel that is disabled maystill be resent to, as long as it still exists."}},"content":{"contentType":"item","itemVariant":"httpItem","meta":{"sourceId":"resend-notification","name":"Resend notification","isWebhook":false,"pointer":"/paths/~1notifications~1{notification_id}~1actions~1resend/post","hasSamples":false},"children":[{"nodeType":"container","children":[{"nodeType":"header","level":2,"label":"Resend notification","isWebhook":false,"showPageActions":true}],"panels":[]},{"nodeType":"container","children":[{"nodeType":"header","level":4,"label":"Request","labelTranslationKey":"request","deepLinkSuffix":"request"},{"nodeType":"markdoc","content":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Send one more attempt of a notification that still has its content, delivered ones included. The"},"children":[]},{"$$mdtype":"Node","type":"softbreak","inline":true,"attributes":{},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"stored bytes, the event id and the payload version are reused exactly. Delivery uses the channel's"},"children":[]},{"$$mdtype":"Node","type":"softbreak","inline":true,"attributes":{},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"current delivery configuration; the request cannot override it. A channel that is disabled may"},"children":[]},{"$$mdtype":"Node","type":"softbreak","inline":true,"attributes":{},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"still be resent to, as long as it still exists."},"children":[]}]}]},{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"A test, a notification whose payload has been cleared by retention, and a notification with an"},"children":[]},{"$$mdtype":"Node","type":"softbreak","inline":true,"attributes":{},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"attempt already queued or in flight all return 409. A pause in the future or the ten-second"},"children":[]},{"$$mdtype":"Node","type":"softbreak","inline":true,"attributes":{},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"interval since the last attempt returns 429 with "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"Retry-After"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":". Resending does not reset the"},"children":[]},{"$$mdtype":"Node","type":"softbreak","inline":true,"attributes":{},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"automatic attempt budget."},"children":[]}]}]}]},{"nodeType":"security","requirements":[{"schemes":[{"name":"Auth","scopes":["api:channel:write"],"type":"apiKey","in":"header","paramName":"X-Api-Key","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"API key for authenticating requests. Include your key in the "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"X-Api-Key"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" header. Keys can be created in the Vilna Dashboard or via the Management API. The scopes listed per operation indicate which permissions the key must have."},"children":[]}]}]}]}]}]},{"nodeType":"item-content","variant":"path","label":"Path","labelTranslationKey":"path","parameters":[{"name":"notification_id","in":"path","schemaId":"schema_17","description":"Unique identifier (UUID) of the notification.","required":true}],"pointer":"/paths/~1notifications~1{notification_id}~1actions~1resend/post/parameters"},{"nodeType":"item-content","variant":"headers","label":"Headers","labelTranslationKey":"header","parameters":[{"name":"Idempotency-Key","in":"header","schemaId":"schema_14","description":"Case-sensitive opaque key for one mutation intent. Send exactly one header occurrence containing 1 to 128 visible ASCII bytes (0x21..0x7e). Commas are literal data; do not trim, lowercase or require UUID syntax. Reuse the same key for retries, with current authorization checked on every attempt. Repeated header occurrences are rejected.\n","required":true}],"pointer":"/paths/~1notifications~1{notification_id}~1actions~1resend/post/parameters"}],"panels":[{"children":[{"kind":"code-sample","source":{"kind":"code-sample","operationType":"http","method":"POST","path":"/notifications/{notification_id}/actions/resend","servers":[{"url":"/_mock/apis/platform/api","description":"Mock server","isMockServer":true},{"url":"https://api.vilna.io/v2","description":"Vilna API."}],"parameters":{"path":[{"name":"notification_id","in":"path","required":true,"example":"550e8400-e29b-41d4-a716-446655440000","schemaId":"components/schemas/UUID"}],"query":[],"querystring":[],"header":[{"name":"Idempotency-Key","in":"header","required":true,"schemaId":"schema_14"}],"cookie":[]},"security":[{"schemes":[{"id":"Auth","type":"apiKey","name":"X-Api-Key","in":"header"}],"scopes":["api:channel:write"]}],"responseCodes":["202","400","401","403","404","409","429","503","default"],"pointer":"/notifications/{notification_id}/actions/resend","href":"notification/resend-notification","openApiOperationId":"resend-notification","summary":"Resend notification"},"isWebhook":false,"hideReplay":false,"servers":[{"url":"/_mock/apis/platform/api","description":"Mock server","isMockServer":true},{"url":"https://api.vilna.io/v2","description":"Vilna API."}],"examples":[]}]}]},{"nodeType":"container","children":[{"nodeType":"header","level":4,"label":"Responses","labelTranslationKey":"responses","deepLinkSuffix":"responses"},{"nodeType":"item-content","variant":"responses","responses":[{"code":"202","description":"One manual attempt durably accepted for the same notification.","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/NotificationAccepted"}},"schemaId":"components/schemas/NotificationAccepted"},{"code":"400","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Bad request (e.g., missing or invalid fields). Invalid text may be reported as address.label_invalid, address.meta_invalid, public_key.label_invalid, invoice.comment_invalid, invoice.metadata_invalid."},"children":[]}]}]}],"mediaType":"application/problem+json","mediaTypes":["application/problem+json"],"mediaTypeContent":{"application/problem+json":{"schemaId":"components/schemas/InvalidRequestProblem","exampleIds":["paths/~1notifications~1{notification_id}~1actions~1resend/post/responses/400/content/application~1problem+json/examples/malformed_json"]}},"schemaId":"components/schemas/InvalidRequestProblem","exampleIds":["paths/~1notifications~1{notification_id}~1actions~1resend/post/responses/400/content/application~1problem+json/examples/malformed_json"]},{"code":"401","description":"Missing or invalid authentication credentials.","mediaType":"application/problem+json","mediaTypes":["application/problem+json"],"mediaTypeContent":{"application/problem+json":{"schemaId":"components/schemas/UnauthorizedProblem","exampleIds":["paths/~1notifications~1{notification_id}~1actions~1resend/post/responses/401/content/application~1problem+json/examples/service_authentication_denied"]}},"schemaId":"components/schemas/UnauthorizedProblem","exampleIds":["paths/~1notifications~1{notification_id}~1actions~1resend/post/responses/401/content/application~1problem+json/examples/service_authentication_denied"]},{"code":"403","description":"Insufficient permissions.","mediaType":"application/problem+json","mediaTypes":["application/problem+json"],"mediaTypeContent":{"application/problem+json":{"schemaId":"components/schemas/ForbiddenProblem","exampleIds":["paths/~1notifications~1{notification_id}~1actions~1resend/post/responses/403/content/application~1problem+json/examples/insufficient_permissions"]}},"schemaId":"components/schemas/ForbiddenProblem","exampleIds":["paths/~1notifications~1{notification_id}~1actions~1resend/post/responses/403/content/application~1problem+json/examples/insufficient_permissions"]},{"code":"404","description":"Requested resource does not exist.","mediaType":"application/problem+json","mediaTypes":["application/problem+json"],"mediaTypeContent":{"application/problem+json":{"schemaId":"components/schemas/NotFoundProblem","exampleIds":["paths/~1notifications~1{notification_id}~1actions~1resend/post/responses/404/content/application~1problem+json/examples/address_not_found","paths/~1notifications~1{notification_id}~1actions~1resend/post/responses/404/content/application~1problem+json/examples/invoice_not_found"]}},"schemaId":"components/schemas/NotFoundProblem","exampleIds":["paths/~1notifications~1{notification_id}~1actions~1resend/post/responses/404/content/application~1problem+json/examples/address_not_found","paths/~1notifications~1{notification_id}~1actions~1resend/post/responses/404/content/application~1problem+json/examples/invoice_not_found"]},{"code":"409","description":"Request conflicts with the current resource state.","mediaType":"application/problem+json","mediaTypes":["application/problem+json"],"mediaTypeContent":{"application/problem+json":{"schemaId":"components/schemas/ConflictProblem","exampleIds":["paths/~1notifications~1{notification_id}~1actions~1resend/post/responses/409/content/application~1problem+json/examples/address_occupied","paths/~1notifications~1{notification_id}~1actions~1resend/post/responses/409/content/application~1problem+json/examples/address_in_use","paths/~1notifications~1{notification_id}~1actions~1resend/post/responses/409/content/application~1problem+json/examples/subscription_v1_conflict","paths/~1notifications~1{notification_id}~1actions~1resend/post/responses/409/content/application~1problem+json/examples/notification_send_in_progress","paths/~1notifications~1{notification_id}~1actions~1resend/post/responses/409/content/application~1problem+json/examples/notification_payload_unavailable","paths/~1notifications~1{notification_id}~1actions~1resend/post/responses/409/content/application~1problem+json/examples/notification_test_resend_not_allowed"]}},"schemaId":"components/schemas/ConflictProblem","exampleIds":["paths/~1notifications~1{notification_id}~1actions~1resend/post/responses/409/content/application~1problem+json/examples/address_occupied","paths/~1notifications~1{notification_id}~1actions~1resend/post/responses/409/content/application~1problem+json/examples/address_in_use","paths/~1notifications~1{notification_id}~1actions~1resend/post/responses/409/content/application~1problem+json/examples/subscription_v1_conflict","paths/~1notifications~1{notification_id}~1actions~1resend/post/responses/409/content/application~1problem+json/examples/notification_send_in_progress","paths/~1notifications~1{notification_id}~1actions~1resend/post/responses/409/content/application~1problem+json/examples/notification_payload_unavailable","paths/~1notifications~1{notification_id}~1actions~1resend/post/responses/409/content/application~1problem+json/examples/notification_test_resend_not_allowed"]},{"code":"429","description":"Capacity or action cooldown exceeded.","mediaType":"application/problem+json","mediaTypes":["application/problem+json"],"mediaTypeContent":{"application/problem+json":{"schemaId":"components/schemas/Problem","exampleIds":["paths/~1notifications~1{notification_id}~1actions~1resend/post/responses/429/content/application~1problem+json/examples/resend_delayed"]}},"schemaId":"components/schemas/Problem","exampleIds":["paths/~1notifications~1{notification_id}~1actions~1resend/post/responses/429/content/application~1problem+json/examples/resend_delayed"],"headers":{"Retry-After":{"description":"Whole seconds to wait, rounded up to the later of the two deadlines that blocked the\nrequest: the delivery pause and the cooldown since the last attempt. It is a hint about the\nearliest retry, not a reservation: the next request checks the state again.\n","schema":{"type":"integer","minimum":1},"example":7}},"headerSchemaId":"schema_69"},{"code":"503","description":"The operation is temporarily unavailable. Please try again later.","mediaType":"application/problem+json","mediaTypes":["application/problem+json"],"mediaTypeContent":{"application/problem+json":{"schemaId":"components/schemas/Problem","exampleIds":["paths/~1notifications~1{notification_id}~1actions~1resend/post/responses/503/content/application~1problem+json/examples/temporarily_unavailable"]}},"schemaId":"components/schemas/Problem","exampleIds":["paths/~1notifications~1{notification_id}~1actions~1resend/post/responses/503/content/application~1problem+json/examples/temporarily_unavailable"]},{"code":"default","description":"Unexpected error.","mediaType":"application/problem+json","mediaTypes":["application/problem+json"],"mediaTypeContent":{"application/problem+json":{"schemaId":"components/schemas/Problem"}},"schemaId":"components/schemas/Problem"}],"pointer":"/paths/~1notifications~1{notification_id}~1actions~1resend/post/responses"}],"panels":[{"children":[{"kind":"response","responseCodes":[{"code":"202","schemaId":"components/schemas/NotificationAccepted","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/NotificationAccepted"}}},{"code":"400","schemaId":"components/schemas/InvalidRequestProblem","exampleIds":["paths/~1notifications~1{notification_id}~1actions~1resend/post/responses/400/content/application~1problem+json/examples/malformed_json"],"mediaTypes":["application/problem+json"],"mediaTypeContent":{"application/problem+json":{"schemaId":"components/schemas/InvalidRequestProblem","exampleIds":["paths/~1notifications~1{notification_id}~1actions~1resend/post/responses/400/content/application~1problem+json/examples/malformed_json"]}}},{"code":"401","schemaId":"components/schemas/UnauthorizedProblem","exampleIds":["paths/~1notifications~1{notification_id}~1actions~1resend/post/responses/401/content/application~1problem+json/examples/service_authentication_denied"],"mediaTypes":["application/problem+json"],"mediaTypeContent":{"application/problem+json":{"schemaId":"components/schemas/UnauthorizedProblem","exampleIds":["paths/~1notifications~1{notification_id}~1actions~1resend/post/responses/401/content/application~1problem+json/examples/service_authentication_denied"]}}},{"code":"403","schemaId":"components/schemas/ForbiddenProblem","exampleIds":["paths/~1notifications~1{notification_id}~1actions~1resend/post/responses/403/content/application~1problem+json/examples/insufficient_permissions"],"mediaTypes":["application/problem+json"],"mediaTypeContent":{"application/problem+json":{"schemaId":"components/schemas/ForbiddenProblem","exampleIds":["paths/~1notifications~1{notification_id}~1actions~1resend/post/responses/403/content/application~1problem+json/examples/insufficient_permissions"]}}},{"code":"404","schemaId":"components/schemas/NotFoundProblem","exampleIds":["paths/~1notifications~1{notification_id}~1actions~1resend/post/responses/404/content/application~1problem+json/examples/address_not_found","paths/~1notifications~1{notification_id}~1actions~1resend/post/responses/404/content/application~1problem+json/examples/invoice_not_found"],"mediaTypes":["application/problem+json"],"mediaTypeContent":{"application/problem+json":{"schemaId":"components/schemas/NotFoundProblem","exampleIds":["paths/~1notifications~1{notification_id}~1actions~1resend/post/responses/404/content/application~1problem+json/examples/address_not_found","paths/~1notifications~1{notification_id}~1actions~1resend/post/responses/404/content/application~1problem+json/examples/invoice_not_found"]}}},{"code":"409","schemaId":"components/schemas/ConflictProblem","exampleIds":["paths/~1notifications~1{notification_id}~1actions~1resend/post/responses/409/content/application~1problem+json/examples/address_occupied","paths/~1notifications~1{notification_id}~1actions~1resend/post/responses/409/content/application~1problem+json/examples/address_in_use","paths/~1notifications~1{notification_id}~1actions~1resend/post/responses/409/content/application~1problem+json/examples/subscription_v1_conflict","paths/~1notifications~1{notification_id}~1actions~1resend/post/responses/409/content/application~1problem+json/examples/notification_send_in_progress","paths/~1notifications~1{notification_id}~1actions~1resend/post/responses/409/content/application~1problem+json/examples/notification_payload_unavailable","paths/~1notifications~1{notification_id}~1actions~1resend/post/responses/409/content/application~1problem+json/examples/notification_test_resend_not_allowed"],"mediaTypes":["application/problem+json"],"mediaTypeContent":{"application/problem+json":{"schemaId":"components/schemas/ConflictProblem","exampleIds":["paths/~1notifications~1{notification_id}~1actions~1resend/post/responses/409/content/application~1problem+json/examples/address_occupied","paths/~1notifications~1{notification_id}~1actions~1resend/post/responses/409/content/application~1problem+json/examples/address_in_use","paths/~1notifications~1{notification_id}~1actions~1resend/post/responses/409/content/application~1problem+json/examples/subscription_v1_conflict","paths/~1notifications~1{notification_id}~1actions~1resend/post/responses/409/content/application~1problem+json/examples/notification_send_in_progress","paths/~1notifications~1{notification_id}~1actions~1resend/post/responses/409/content/application~1problem+json/examples/notification_payload_unavailable","paths/~1notifications~1{notification_id}~1actions~1resend/post/responses/409/content/application~1problem+json/examples/notification_test_resend_not_allowed"]}}},{"code":"429","schemaId":"components/schemas/Problem","exampleIds":["paths/~1notifications~1{notification_id}~1actions~1resend/post/responses/429/content/application~1problem+json/examples/resend_delayed"],"mediaTypes":["application/problem+json"],"mediaTypeContent":{"application/problem+json":{"schemaId":"components/schemas/Problem","exampleIds":["paths/~1notifications~1{notification_id}~1actions~1resend/post/responses/429/content/application~1problem+json/examples/resend_delayed"]}}},{"code":"503","schemaId":"components/schemas/Problem","exampleIds":["paths/~1notifications~1{notification_id}~1actions~1resend/post/responses/503/content/application~1problem+json/examples/temporarily_unavailable"],"mediaTypes":["application/problem+json"],"mediaTypeContent":{"application/problem+json":{"schemaId":"components/schemas/Problem","exampleIds":["paths/~1notifications~1{notification_id}~1actions~1resend/post/responses/503/content/application~1problem+json/examples/temporarily_unavailable"]}}},{"code":"default","schemaId":"components/schemas/Problem","mediaTypes":["application/problem+json"],"mediaTypeContent":{"application/problem+json":{"schemaId":"components/schemas/Problem"}}}],"examples":[]}]}]},{"nodeType":"container","children":[{"nodeType":"feedback","pageSlug":"/notification/resend-notification"}],"panels":[]}]},"httpPath":"/notifications/{notification_id}/actions/resend"}],"content":{"contentType":"group","meta":{"name":"notification"},"children":[{"nodeType":"container","children":[{"nodeType":"header","level":2,"label":"Notifications","showPageActions":true},{"nodeType":"markdoc","content":"Individual notification deliveries and their status."}],"panels":[{"children":[{"kind":"group-items","title":"Operations","titleTranslationKey":"operations","items":[{"title":"/notifications","summary":"List notifications","prefix":{"name":"get","color":"get"},"badges":[],"link":"/notification/list-notifications","deprecated":false},{"title":"/notifications/{notification_id}","summary":"Get notification","prefix":{"name":"get","color":"get"},"badges":[],"link":"/notification/get-notification","deprecated":false},{"title":"/notifications/{notification_id}/logs","summary":"List notification logs","prefix":{"name":"get","color":"get"},"badges":[],"link":"/notification/list-notification-logs","deprecated":false},{"title":"/notifications/{notification_id}/actions/resend","summary":"Resend notification","prefix":{"name":"post","color":"post"},"badges":[],"link":"/notification/resend-notification","deprecated":false}]}]}]}]}},{"type":"separator","label":"Blockchain Data","content":null},{"type":"group","label":"Blockchains","link":"/apis/platform/api/blockchain","routeSlug":"/apis/platform/api/blockchain","items":[{"label":"List blockchains","deprecated":false,"httpVerb":"get","isAdditionalOperation":false,"isWebhook":false,"type":"link","link":"/apis/platform/api/blockchain/list-blockchains","routeSlug":"/apis/platform/api/blockchain/list-blockchains","metadata":{"seo":{"title":"List blockchains","description":"List supported blockchains with filtering and pagination."}},"content":{"contentType":"item","itemVariant":"httpItem","meta":{"sourceId":"list-blockchains","name":"List blockchains","isWebhook":false,"pointer":"/paths/~1blockchains/get","hasSamples":false},"children":[{"nodeType":"container","children":[{"nodeType":"header","level":2,"label":"List blockchains","isWebhook":false,"showPageActions":true}],"panels":[]},{"nodeType":"container","children":[{"nodeType":"header","level":4,"label":"Request","labelTranslationKey":"request","deepLinkSuffix":"request"},{"nodeType":"markdoc","content":"List supported blockchains with filtering and pagination."},{"nodeType":"security","requirements":[{"schemes":[{"name":"Auth","scopes":["api:blockchain:read"],"type":"apiKey","in":"header","paramName":"X-Api-Key","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"API key for authenticating requests. Include your key in the "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"X-Api-Key"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" header. Keys can be created in the Vilna Dashboard or via the Management API. The scopes listed per operation indicate which permissions the key must have."},"children":[]}]}]}]}]}]},{"nodeType":"item-content","variant":"query","label":"Query","labelTranslationKey":"query","parameters":[{"name":"limit","in":"query","schemaId":"schema_0","description":"Maximum number of items to return."},{"name":"page","in":"query","schemaId":"schema_1","description":"Page number for pagination."},{"name":"sort_by","in":"query","schemaId":"schema_70","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Field to sort results by. Use "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"-"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" prefix for descending order."},"children":[]}]}]}]},{"name":"search","in":"query","schemaId":"schema_71","description":"Filter blockchains by name or short name (partial match, case-insensitive)."},{"name":"family","in":"query","style":"form","explode":true,"schemaId":"schema_72","description":"Filter blockchains by chain family.","example":["evm"]}],"pointer":"/paths/~1blockchains/get/parameters"}],"panels":[{"children":[{"kind":"code-sample","source":{"kind":"code-sample","operationType":"http","method":"GET","path":"/blockchains","servers":[{"url":"/_mock/apis/platform/api","description":"Mock server","isMockServer":true},{"url":"https://api.vilna.io/v2","description":"Vilna API."}],"parameters":{"path":[],"query":[{"name":"limit","in":"query","required":false,"example":20,"schemaId":"schema_0"},{"name":"page","in":"query","required":false,"example":1,"schemaId":"schema_1"},{"name":"sort_by","in":"query","required":false,"example":"name","schemaId":"schema_70"},{"name":"search","in":"query","required":false,"example":"ethereum","schemaId":"schema_71"},{"name":"family","in":"query","required":false,"example":["evm"],"schemaId":"schema_72","style":"form","explode":true}],"querystring":[],"header":[],"cookie":[]},"security":[{"schemes":[{"id":"Auth","type":"apiKey","name":"X-Api-Key","in":"header"}],"scopes":["api:blockchain:read"]}],"responseCodes":["200","400","401","403","503","default"],"pointer":"/blockchains","href":"blockchain/list-blockchains","openApiOperationId":"list-blockchains","summary":"List blockchains"},"isWebhook":false,"hideReplay":false,"servers":[{"url":"/_mock/apis/platform/api","description":"Mock server","isMockServer":true},{"url":"https://api.vilna.io/v2","description":"Vilna API."}],"examples":[]}]}]},{"nodeType":"container","children":[{"nodeType":"header","level":4,"label":"Responses","labelTranslationKey":"responses","deepLinkSuffix":"responses"},{"nodeType":"item-content","variant":"responses","responses":[{"code":"200","description":"Paginated list of supported blockchains.","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"schema_73"}},"schemaId":"schema_73"},{"code":"400","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Bad request (e.g., missing or invalid fields). Invalid text may be reported as address.label_invalid, address.meta_invalid, public_key.label_invalid, invoice.comment_invalid, invoice.metadata_invalid."},"children":[]}]}]}],"mediaType":"application/problem+json","mediaTypes":["application/problem+json"],"mediaTypeContent":{"application/problem+json":{"schemaId":"components/schemas/InvalidRequestProblem","exampleIds":["paths/~1blockchains/get/responses/400/content/application~1problem+json/examples/malformed_json"]}},"schemaId":"components/schemas/InvalidRequestProblem","exampleIds":["paths/~1blockchains/get/responses/400/content/application~1problem+json/examples/malformed_json"]},{"code":"401","description":"Missing or invalid authentication credentials.","mediaType":"application/problem+json","mediaTypes":["application/problem+json"],"mediaTypeContent":{"application/problem+json":{"schemaId":"components/schemas/UnauthorizedProblem","exampleIds":["paths/~1blockchains/get/responses/401/content/application~1problem+json/examples/service_authentication_denied"]}},"schemaId":"components/schemas/UnauthorizedProblem","exampleIds":["paths/~1blockchains/get/responses/401/content/application~1problem+json/examples/service_authentication_denied"]},{"code":"403","description":"Insufficient permissions.","mediaType":"application/problem+json","mediaTypes":["application/problem+json"],"mediaTypeContent":{"application/problem+json":{"schemaId":"components/schemas/ForbiddenProblem","exampleIds":["paths/~1blockchains/get/responses/403/content/application~1problem+json/examples/insufficient_permissions"]}},"schemaId":"components/schemas/ForbiddenProblem","exampleIds":["paths/~1blockchains/get/responses/403/content/application~1problem+json/examples/insufficient_permissions"]},{"code":"503","description":"The operation is temporarily unavailable. Please try again later.","mediaType":"application/problem+json","mediaTypes":["application/problem+json"],"mediaTypeContent":{"application/problem+json":{"schemaId":"components/schemas/Problem","exampleIds":["paths/~1blockchains/get/responses/503/content/application~1problem+json/examples/temporarily_unavailable"]}},"schemaId":"components/schemas/Problem","exampleIds":["paths/~1blockchains/get/responses/503/content/application~1problem+json/examples/temporarily_unavailable"]},{"code":"default","description":"Unexpected error.","mediaType":"application/problem+json","mediaTypes":["application/problem+json"],"mediaTypeContent":{"application/problem+json":{"schemaId":"components/schemas/Problem"}},"schemaId":"components/schemas/Problem"}],"pointer":"/paths/~1blockchains/get/responses"}],"panels":[{"children":[{"kind":"response","responseCodes":[{"code":"200","schemaId":"schema_73","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"schema_73"}}},{"code":"400","schemaId":"components/schemas/InvalidRequestProblem","exampleIds":["paths/~1blockchains/get/responses/400/content/application~1problem+json/examples/malformed_json"],"mediaTypes":["application/problem+json"],"mediaTypeContent":{"application/problem+json":{"schemaId":"components/schemas/InvalidRequestProblem","exampleIds":["paths/~1blockchains/get/responses/400/content/application~1problem+json/examples/malformed_json"]}}},{"code":"401","schemaId":"components/schemas/UnauthorizedProblem","exampleIds":["paths/~1blockchains/get/responses/401/content/application~1problem+json/examples/service_authentication_denied"],"mediaTypes":["application/problem+json"],"mediaTypeContent":{"application/problem+json":{"schemaId":"components/schemas/UnauthorizedProblem","exampleIds":["paths/~1blockchains/get/responses/401/content/application~1problem+json/examples/service_authentication_denied"]}}},{"code":"403","schemaId":"components/schemas/ForbiddenProblem","exampleIds":["paths/~1blockchains/get/responses/403/content/application~1problem+json/examples/insufficient_permissions"],"mediaTypes":["application/problem+json"],"mediaTypeContent":{"application/problem+json":{"schemaId":"components/schemas/ForbiddenProblem","exampleIds":["paths/~1blockchains/get/responses/403/content/application~1problem+json/examples/insufficient_permissions"]}}},{"code":"503","schemaId":"components/schemas/Problem","exampleIds":["paths/~1blockchains/get/responses/503/content/application~1problem+json/examples/temporarily_unavailable"],"mediaTypes":["application/problem+json"],"mediaTypeContent":{"application/problem+json":{"schemaId":"components/schemas/Problem","exampleIds":["paths/~1blockchains/get/responses/503/content/application~1problem+json/examples/temporarily_unavailable"]}}},{"code":"default","schemaId":"components/schemas/Problem","mediaTypes":["application/problem+json"],"mediaTypeContent":{"application/problem+json":{"schemaId":"components/schemas/Problem"}}}],"examples":[]}]}]},{"nodeType":"container","children":[{"nodeType":"feedback","pageSlug":"/blockchain/list-blockchains"}],"panels":[]}]},"httpPath":"/blockchains"},{"label":"Get blockchain","deprecated":false,"httpVerb":"get","isAdditionalOperation":false,"isWebhook":false,"type":"link","link":"/apis/platform/api/blockchain/get-blockchain","routeSlug":"/apis/platform/api/blockchain/get-blockchain","metadata":{"seo":{"title":"Get blockchain","description":"Get blockchain details by chain GID."}},"content":{"contentType":"item","itemVariant":"httpItem","meta":{"sourceId":"get-blockchain","name":"Get blockchain","isWebhook":false,"pointer":"/paths/~1blockchains~1{chain_gid}/get","hasSamples":false},"children":[{"nodeType":"container","children":[{"nodeType":"header","level":2,"label":"Get blockchain","isWebhook":false,"showPageActions":true}],"panels":[]},{"nodeType":"container","children":[{"nodeType":"header","level":4,"label":"Request","labelTranslationKey":"request","deepLinkSuffix":"request"},{"nodeType":"markdoc","content":"Get blockchain details by chain GID."},{"nodeType":"security","requirements":[{"schemes":[{"name":"Auth","scopes":["api:blockchain:read"],"type":"apiKey","in":"header","paramName":"X-Api-Key","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"API key for authenticating requests. Include your key in the "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"X-Api-Key"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" header. Keys can be created in the Vilna Dashboard or via the Management API. The scopes listed per operation indicate which permissions the key must have."},"children":[]}]}]}]}]}]},{"nodeType":"item-content","variant":"path","label":"Path","labelTranslationKey":"path","parameters":[{"name":"chain_gid","in":"path","schemaId":"schema_29","description":"Blockchain identifier in CAIP-2 format (namespace:reference).","required":true}],"pointer":"/paths/~1blockchains~1{chain_gid}/get/parameters"}],"panels":[{"children":[{"kind":"code-sample","source":{"kind":"code-sample","operationType":"http","method":"GET","path":"/blockchains/{chain_gid}","servers":[{"url":"/_mock/apis/platform/api","description":"Mock server","isMockServer":true},{"url":"https://api.vilna.io/v2","description":"Vilna API."}],"parameters":{"path":[{"name":"chain_gid","in":"path","required":true,"example":"eip155:1","schemaId":"components/schemas/ChainGID"}],"query":[],"querystring":[],"header":[],"cookie":[]},"security":[{"schemes":[{"id":"Auth","type":"apiKey","name":"X-Api-Key","in":"header"}],"scopes":["api:blockchain:read"]}],"responseCodes":["200","400","401","403","404","503","default"],"pointer":"/blockchains/{chain_gid}","href":"blockchain/get-blockchain","openApiOperationId":"get-blockchain","summary":"Get blockchain"},"isWebhook":false,"hideReplay":false,"servers":[{"url":"/_mock/apis/platform/api","description":"Mock server","isMockServer":true},{"url":"https://api.vilna.io/v2","description":"Vilna API."}],"examples":[]}]}]},{"nodeType":"container","children":[{"nodeType":"header","level":4,"label":"Responses","labelTranslationKey":"responses","deepLinkSuffix":"responses"},{"nodeType":"item-content","variant":"responses","responses":[{"code":"200","description":"Blockchain details.","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"schema_74"}},"schemaId":"schema_74"},{"code":"400","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Bad request (e.g., missing or invalid fields). Invalid text may be reported as address.label_invalid, address.meta_invalid, public_key.label_invalid, invoice.comment_invalid, invoice.metadata_invalid."},"children":[]}]}]}],"mediaType":"application/problem+json","mediaTypes":["application/problem+json"],"mediaTypeContent":{"application/problem+json":{"schemaId":"components/schemas/InvalidRequestProblem","exampleIds":["paths/~1blockchains~1{chain_gid}/get/responses/400/content/application~1problem+json/examples/malformed_json"]}},"schemaId":"components/schemas/InvalidRequestProblem","exampleIds":["paths/~1blockchains~1{chain_gid}/get/responses/400/content/application~1problem+json/examples/malformed_json"]},{"code":"401","description":"Missing or invalid authentication credentials.","mediaType":"application/problem+json","mediaTypes":["application/problem+json"],"mediaTypeContent":{"application/problem+json":{"schemaId":"components/schemas/UnauthorizedProblem","exampleIds":["paths/~1blockchains~1{chain_gid}/get/responses/401/content/application~1problem+json/examples/service_authentication_denied"]}},"schemaId":"components/schemas/UnauthorizedProblem","exampleIds":["paths/~1blockchains~1{chain_gid}/get/responses/401/content/application~1problem+json/examples/service_authentication_denied"]},{"code":"403","description":"Insufficient permissions.","mediaType":"application/problem+json","mediaTypes":["application/problem+json"],"mediaTypeContent":{"application/problem+json":{"schemaId":"components/schemas/ForbiddenProblem","exampleIds":["paths/~1blockchains~1{chain_gid}/get/responses/403/content/application~1problem+json/examples/insufficient_permissions"]}},"schemaId":"components/schemas/ForbiddenProblem","exampleIds":["paths/~1blockchains~1{chain_gid}/get/responses/403/content/application~1problem+json/examples/insufficient_permissions"]},{"code":"404","description":"Requested resource does not exist.","mediaType":"application/problem+json","mediaTypes":["application/problem+json"],"mediaTypeContent":{"application/problem+json":{"schemaId":"components/schemas/NotFoundProblem","exampleIds":["paths/~1blockchains~1{chain_gid}/get/responses/404/content/application~1problem+json/examples/address_not_found","paths/~1blockchains~1{chain_gid}/get/responses/404/content/application~1problem+json/examples/invoice_not_found"]}},"schemaId":"components/schemas/NotFoundProblem","exampleIds":["paths/~1blockchains~1{chain_gid}/get/responses/404/content/application~1problem+json/examples/address_not_found","paths/~1blockchains~1{chain_gid}/get/responses/404/content/application~1problem+json/examples/invoice_not_found"]},{"code":"503","description":"The operation is temporarily unavailable. Please try again later.","mediaType":"application/problem+json","mediaTypes":["application/problem+json"],"mediaTypeContent":{"application/problem+json":{"schemaId":"components/schemas/Problem","exampleIds":["paths/~1blockchains~1{chain_gid}/get/responses/503/content/application~1problem+json/examples/temporarily_unavailable"]}},"schemaId":"components/schemas/Problem","exampleIds":["paths/~1blockchains~1{chain_gid}/get/responses/503/content/application~1problem+json/examples/temporarily_unavailable"]},{"code":"default","description":"Unexpected error.","mediaType":"application/problem+json","mediaTypes":["application/problem+json"],"mediaTypeContent":{"application/problem+json":{"schemaId":"components/schemas/Problem"}},"schemaId":"components/schemas/Problem"}],"pointer":"/paths/~1blockchains~1{chain_gid}/get/responses"}],"panels":[{"children":[{"kind":"response","responseCodes":[{"code":"200","schemaId":"schema_74","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"schema_74"}}},{"code":"400","schemaId":"components/schemas/InvalidRequestProblem","exampleIds":["paths/~1blockchains~1{chain_gid}/get/responses/400/content/application~1problem+json/examples/malformed_json"],"mediaTypes":["application/problem+json"],"mediaTypeContent":{"application/problem+json":{"schemaId":"components/schemas/InvalidRequestProblem","exampleIds":["paths/~1blockchains~1{chain_gid}/get/responses/400/content/application~1problem+json/examples/malformed_json"]}}},{"code":"401","schemaId":"components/schemas/UnauthorizedProblem","exampleIds":["paths/~1blockchains~1{chain_gid}/get/responses/401/content/application~1problem+json/examples/service_authentication_denied"],"mediaTypes":["application/problem+json"],"mediaTypeContent":{"application/problem+json":{"schemaId":"components/schemas/UnauthorizedProblem","exampleIds":["paths/~1blockchains~1{chain_gid}/get/responses/401/content/application~1problem+json/examples/service_authentication_denied"]}}},{"code":"403","schemaId":"components/schemas/ForbiddenProblem","exampleIds":["paths/~1blockchains~1{chain_gid}/get/responses/403/content/application~1problem+json/examples/insufficient_permissions"],"mediaTypes":["application/problem+json"],"mediaTypeContent":{"application/problem+json":{"schemaId":"components/schemas/ForbiddenProblem","exampleIds":["paths/~1blockchains~1{chain_gid}/get/responses/403/content/application~1problem+json/examples/insufficient_permissions"]}}},{"code":"404","schemaId":"components/schemas/NotFoundProblem","exampleIds":["paths/~1blockchains~1{chain_gid}/get/responses/404/content/application~1problem+json/examples/address_not_found","paths/~1blockchains~1{chain_gid}/get/responses/404/content/application~1problem+json/examples/invoice_not_found"],"mediaTypes":["application/problem+json"],"mediaTypeContent":{"application/problem+json":{"schemaId":"components/schemas/NotFoundProblem","exampleIds":["paths/~1blockchains~1{chain_gid}/get/responses/404/content/application~1problem+json/examples/address_not_found","paths/~1blockchains~1{chain_gid}/get/responses/404/content/application~1problem+json/examples/invoice_not_found"]}}},{"code":"503","schemaId":"components/schemas/Problem","exampleIds":["paths/~1blockchains~1{chain_gid}/get/responses/503/content/application~1problem+json/examples/temporarily_unavailable"],"mediaTypes":["application/problem+json"],"mediaTypeContent":{"application/problem+json":{"schemaId":"components/schemas/Problem","exampleIds":["paths/~1blockchains~1{chain_gid}/get/responses/503/content/application~1problem+json/examples/temporarily_unavailable"]}}},{"code":"default","schemaId":"components/schemas/Problem","mediaTypes":["application/problem+json"],"mediaTypeContent":{"application/problem+json":{"schemaId":"components/schemas/Problem"}}}],"examples":[]}]}]},{"nodeType":"container","children":[{"nodeType":"feedback","pageSlug":"/blockchain/get-blockchain"}],"panels":[]}]},"httpPath":"/blockchains/{chain_gid}"}],"content":{"contentType":"group","meta":{"name":"blockchain"},"children":[{"nodeType":"container","children":[{"nodeType":"header","level":2,"label":"Blockchains","showPageActions":true},{"nodeType":"markdoc","content":"Supported blockchains and their metadata."}],"panels":[{"children":[{"kind":"group-items","title":"Operations","titleTranslationKey":"operations","items":[{"title":"/blockchains","summary":"List blockchains","prefix":{"name":"get","color":"get"},"badges":[],"link":"/blockchain/list-blockchains","deprecated":false},{"title":"/blockchains/{chain_gid}","summary":"Get blockchain","prefix":{"name":"get","color":"get"},"badges":[],"link":"/blockchain/get-blockchain","deprecated":false}]}]}]}]}},{"type":"group","label":"Tokens","link":"/apis/platform/api/token","routeSlug":"/apis/platform/api/token","items":[{"label":"List tokens","deprecated":false,"httpVerb":"get","isAdditionalOperation":false,"isWebhook":false,"type":"link","link":"/apis/platform/api/token/list-tokens","routeSlug":"/apis/platform/api/token/list-tokens","metadata":{"seo":{"title":"List tokens","description":"List catalog assets with filtering and pagination. Use scope=project to return only the project's selected assets."}},"content":{"contentType":"item","itemVariant":"httpItem","meta":{"sourceId":"list-tokens","name":"List tokens","isWebhook":false,"pointer":"/paths/~1tokens/get","hasSamples":false},"children":[{"nodeType":"container","children":[{"nodeType":"header","level":2,"label":"List tokens","isWebhook":false,"showPageActions":true}],"panels":[]},{"nodeType":"container","children":[{"nodeType":"header","level":4,"label":"Request","labelTranslationKey":"request","deepLinkSuffix":"request"},{"nodeType":"markdoc","content":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"List catalog assets with filtering and pagination. Use "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"scope=project"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" to return only the project's selected assets."},"children":[]}]}]}]},{"nodeType":"security","requirements":[{"schemes":[{"name":"Auth","scopes":["api:asset:read"],"type":"apiKey","in":"header","paramName":"X-Api-Key","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"API key for authenticating requests. Include your key in the "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"X-Api-Key"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" header. Keys can be created in the Vilna Dashboard or via the Management API. The scopes listed per operation indicate which permissions the key must have."},"children":[]}]}]}]}]}]},{"nodeType":"item-content","variant":"query","label":"Query","labelTranslationKey":"query","parameters":[{"name":"limit","in":"query","schemaId":"schema_0","description":"Maximum number of items to return."},{"name":"page","in":"query","schemaId":"schema_1","description":"Page number for pagination."},{"name":"sort_by","in":"query","schemaId":"schema_75","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Field to sort results by. Use "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"-"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" prefix for descending order."},"children":[]}]}]}]},{"name":"search","in":"query","schemaId":"schema_76","description":"Search tokens by GID, reference, name, or symbol (partial match, case-insensitive). Does not grant trust."},{"name":"chain_gid","in":"query","style":"form","explode":true,"schemaId":"schema_4","description":"Filter tokens by blockchain identifiers (CAIP-2 format).","example":["eip155:1"]},{"name":"tag_id","in":"query","style":"form","explode":true,"schemaId":"schema_21","description":"Filter tokens by tag identifier (UUID). Repeat the parameter to pass\nmultiple values; tokens tagged with any of them are returned (OR semantics).\n","example":["0199ce7e-d9e7-7c01-9c2a-9d0010eaa1cc"]},{"name":"scope","in":"query","schemaId":"schema_77","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Filter tokens by scope. "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"all"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" returns the full catalog; "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"project"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" returns only the tokens this project has selected (native coins, defaults, and explicit trust)."},"children":[]}]}]}]}],"pointer":"/paths/~1tokens/get/parameters"}],"panels":[{"children":[{"kind":"code-sample","source":{"kind":"code-sample","operationType":"http","method":"GET","path":"/tokens","servers":[{"url":"/_mock/apis/platform/api","description":"Mock server","isMockServer":true},{"url":"https://api.vilna.io/v2","description":"Vilna API."}],"parameters":{"path":[],"query":[{"name":"limit","in":"query","required":false,"example":20,"schemaId":"schema_0"},{"name":"page","in":"query","required":false,"example":1,"schemaId":"schema_1"},{"name":"sort_by","in":"query","required":false,"example":"symbol","schemaId":"schema_75"},{"name":"search","in":"query","required":false,"example":"USDT","schemaId":"schema_76"},{"name":"chain_gid","in":"query","required":false,"example":["eip155:1"],"schemaId":"schema_4","style":"form","explode":true},{"name":"tag_id","in":"query","required":false,"example":["0199ce7e-d9e7-7c01-9c2a-9d0010eaa1cc"],"schemaId":"schema_21","style":"form","explode":true},{"name":"scope","in":"query","required":false,"example":"all","schemaId":"schema_77"}],"querystring":[],"header":[],"cookie":[]},"security":[{"schemes":[{"id":"Auth","type":"apiKey","name":"X-Api-Key","in":"header"}],"scopes":["api:asset:read"]}],"responseCodes":["200","400","401","403","503","default"],"pointer":"/tokens","href":"token/list-tokens","openApiOperationId":"list-tokens","summary":"List tokens"},"isWebhook":false,"hideReplay":false,"servers":[{"url":"/_mock/apis/platform/api","description":"Mock server","isMockServer":true},{"url":"https://api.vilna.io/v2","description":"Vilna API."}],"examples":[]}]}]},{"nodeType":"container","children":[{"nodeType":"header","level":4,"label":"Responses","labelTranslationKey":"responses","deepLinkSuffix":"responses"},{"nodeType":"item-content","variant":"responses","responses":[{"code":"200","description":"List of catalog assets.","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"schema_78","exampleIds":["paths/~1tokens/get/responses/200/content/application~1json/example"]}},"schemaId":"schema_78","exampleIds":["paths/~1tokens/get/responses/200/content/application~1json/example"]},{"code":"400","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Bad request (e.g., missing or invalid fields). Invalid text may be reported as address.label_invalid, address.meta_invalid, public_key.label_invalid, invoice.comment_invalid, invoice.metadata_invalid."},"children":[]}]}]}],"mediaType":"application/problem+json","mediaTypes":["application/problem+json"],"mediaTypeContent":{"application/problem+json":{"schemaId":"components/schemas/InvalidRequestProblem","exampleIds":["paths/~1tokens/get/responses/400/content/application~1problem+json/examples/malformed_json"]}},"schemaId":"components/schemas/InvalidRequestProblem","exampleIds":["paths/~1tokens/get/responses/400/content/application~1problem+json/examples/malformed_json"]},{"code":"401","description":"Missing or invalid authentication credentials.","mediaType":"application/problem+json","mediaTypes":["application/problem+json"],"mediaTypeContent":{"application/problem+json":{"schemaId":"components/schemas/UnauthorizedProblem","exampleIds":["paths/~1tokens/get/responses/401/content/application~1problem+json/examples/service_authentication_denied"]}},"schemaId":"components/schemas/UnauthorizedProblem","exampleIds":["paths/~1tokens/get/responses/401/content/application~1problem+json/examples/service_authentication_denied"]},{"code":"403","description":"Insufficient permissions.","mediaType":"application/problem+json","mediaTypes":["application/problem+json"],"mediaTypeContent":{"application/problem+json":{"schemaId":"components/schemas/ForbiddenProblem","exampleIds":["paths/~1tokens/get/responses/403/content/application~1problem+json/examples/insufficient_permissions"]}},"schemaId":"components/schemas/ForbiddenProblem","exampleIds":["paths/~1tokens/get/responses/403/content/application~1problem+json/examples/insufficient_permissions"]},{"code":"503","description":"The operation is temporarily unavailable. Please try again later.","mediaType":"application/problem+json","mediaTypes":["application/problem+json"],"mediaTypeContent":{"application/problem+json":{"schemaId":"components/schemas/Problem","exampleIds":["paths/~1tokens/get/responses/503/content/application~1problem+json/examples/temporarily_unavailable"]}},"schemaId":"components/schemas/Problem","exampleIds":["paths/~1tokens/get/responses/503/content/application~1problem+json/examples/temporarily_unavailable"]},{"code":"default","description":"Unexpected error.","mediaType":"application/problem+json","mediaTypes":["application/problem+json"],"mediaTypeContent":{"application/problem+json":{"schemaId":"components/schemas/Problem"}},"schemaId":"components/schemas/Problem"}],"pointer":"/paths/~1tokens/get/responses"}],"panels":[{"children":[{"kind":"response","responseCodes":[{"code":"200","schemaId":"schema_78","exampleIds":["paths/~1tokens/get/responses/200/content/application~1json/example"],"mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"schema_78","exampleIds":["paths/~1tokens/get/responses/200/content/application~1json/example"]}}},{"code":"400","schemaId":"components/schemas/InvalidRequestProblem","exampleIds":["paths/~1tokens/get/responses/400/content/application~1problem+json/examples/malformed_json"],"mediaTypes":["application/problem+json"],"mediaTypeContent":{"application/problem+json":{"schemaId":"components/schemas/InvalidRequestProblem","exampleIds":["paths/~1tokens/get/responses/400/content/application~1problem+json/examples/malformed_json"]}}},{"code":"401","schemaId":"components/schemas/UnauthorizedProblem","exampleIds":["paths/~1tokens/get/responses/401/content/application~1problem+json/examples/service_authentication_denied"],"mediaTypes":["application/problem+json"],"mediaTypeContent":{"application/problem+json":{"schemaId":"components/schemas/UnauthorizedProblem","exampleIds":["paths/~1tokens/get/responses/401/content/application~1problem+json/examples/service_authentication_denied"]}}},{"code":"403","schemaId":"components/schemas/ForbiddenProblem","exampleIds":["paths/~1tokens/get/responses/403/content/application~1problem+json/examples/insufficient_permissions"],"mediaTypes":["application/problem+json"],"mediaTypeContent":{"application/problem+json":{"schemaId":"components/schemas/ForbiddenProblem","exampleIds":["paths/~1tokens/get/responses/403/content/application~1problem+json/examples/insufficient_permissions"]}}},{"code":"503","schemaId":"components/schemas/Problem","exampleIds":["paths/~1tokens/get/responses/503/content/application~1problem+json/examples/temporarily_unavailable"],"mediaTypes":["application/problem+json"],"mediaTypeContent":{"application/problem+json":{"schemaId":"components/schemas/Problem","exampleIds":["paths/~1tokens/get/responses/503/content/application~1problem+json/examples/temporarily_unavailable"]}}},{"code":"default","schemaId":"components/schemas/Problem","mediaTypes":["application/problem+json"],"mediaTypeContent":{"application/problem+json":{"schemaId":"components/schemas/Problem"}}}],"examples":[]}]}]},{"nodeType":"container","children":[{"nodeType":"feedback","pageSlug":"/token/list-tokens"}],"panels":[]}]},"httpPath":"/tokens"},{"label":"Create token","deprecated":false,"httpVerb":"post","isAdditionalOperation":false,"isWebhook":false,"type":"link","link":"/apis/platform/api/token/create-token","routeSlug":"/apis/platform/api/token/create-token","metadata":{"seo":{"title":"Create token","description":"Create a token by chain GID and asset path. Metadata is resolved from chain data. A successful response's item always has status supported; a pending or unsupported resolution is reported as 422 instead."}},"content":{"contentType":"item","itemVariant":"httpItem","meta":{"sourceId":"create-token","name":"Create token","isWebhook":false,"pointer":"/paths/~1tokens~1{chain_gid}~1{asset_path}/post","hasSamples":false},"children":[{"nodeType":"container","children":[{"nodeType":"header","level":2,"label":"Create token","isWebhook":false,"showPageActions":true}],"panels":[]},{"nodeType":"container","children":[{"nodeType":"header","level":4,"label":"Request","labelTranslationKey":"request","deepLinkSuffix":"request"},{"nodeType":"markdoc","content":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Create a token by chain GID and asset path. Metadata is resolved from chain data. A successful response's item always has status "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"supported"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"; a pending or unsupported resolution is reported as 422 instead."},"children":[]}]}]}]},{"nodeType":"security","requirements":[{"schemes":[{"name":"Auth","scopes":["api:asset:write"],"type":"apiKey","in":"header","paramName":"X-Api-Key","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"API key for authenticating requests. Include your key in the "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"X-Api-Key"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" header. Keys can be created in the Vilna Dashboard or via the Management API. The scopes listed per operation indicate which permissions the key must have."},"children":[]}]}]}]}]}]},{"nodeType":"item-content","variant":"path","label":"Path","labelTranslationKey":"path","parameters":[{"name":"chain_gid","in":"path","schemaId":"schema_29","description":"Blockchain identifier in CAIP-2 format (namespace:reference).","required":true},{"name":"asset_path","in":"path","schemaId":"schema_79","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Asset type identifier in CAIP-19 format (asset_namespace:asset_reference)."},"children":[]}]}]}],"required":true}],"pointer":"/paths/~1tokens~1{chain_gid}~1{asset_path}/post/parameters"},{"nodeType":"item-content","variant":"headers","label":"Headers","labelTranslationKey":"header","parameters":[{"name":"Idempotency-Key","in":"header","schemaId":"schema_14","description":"Case-sensitive opaque key for one mutation intent. Send exactly one header occurrence containing 1 to 128 visible ASCII bytes (0x21..0x7e). Commas are literal data; do not trim, lowercase or require UUID syntax. Reuse the same key for retries, with current authorization checked on every attempt. Repeated header occurrences are rejected.\n","required":true}],"pointer":"/paths/~1tokens~1{chain_gid}~1{asset_path}/post/parameters"}],"panels":[{"children":[{"kind":"code-sample","source":{"kind":"code-sample","operationType":"http","method":"POST","path":"/tokens/{chain_gid}/{asset_path}","servers":[{"url":"/_mock/apis/platform/api","description":"Mock server","isMockServer":true},{"url":"https://api.vilna.io/v2","description":"Vilna API."}],"parameters":{"path":[{"name":"chain_gid","in":"path","required":true,"example":"eip155:1","schemaId":"components/schemas/ChainGID"},{"name":"asset_path","in":"path","required":true,"example":"erc20:0x6B175474E89094C44Da98b954EedeAC495271d0F","schemaId":"components/schemas/AssetPath"}],"query":[],"querystring":[],"header":[{"name":"Idempotency-Key","in":"header","required":true,"schemaId":"schema_14"}],"cookie":[]},"security":[{"schemes":[{"id":"Auth","type":"apiKey","name":"X-Api-Key","in":"header"}],"scopes":["api:asset:write"]}],"responseCodes":["200","201","400","401","403","404","409","422","429","502","503","504","default"],"pointer":"/tokens/{chain_gid}/{asset_path}","href":"token/create-token","openApiOperationId":"create-token","summary":"Create token"},"isWebhook":false,"hideReplay":false,"servers":[{"url":"/_mock/apis/platform/api","description":"Mock server","isMockServer":true},{"url":"https://api.vilna.io/v2","description":"Vilna API."}],"examples":[]}]}]},{"nodeType":"container","children":[{"nodeType":"header","level":4,"label":"Responses","labelTranslationKey":"responses","deepLinkSuffix":"responses"},{"nodeType":"item-content","variant":"responses","responses":[{"code":"200","description":"Catalog asset details.","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"schema_80","exampleIds":["paths/~1tokens~1{chain_gid}~1{asset_path}/post/responses/200/content/application~1json/example"]}},"schemaId":"schema_80","exampleIds":["paths/~1tokens~1{chain_gid}~1{asset_path}/post/responses/200/content/application~1json/example"]},{"code":"201","description":"Catalog asset details.","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"schema_80","exampleIds":["paths/~1tokens~1{chain_gid}~1{asset_path}/post/responses/201/content/application~1json/example"]}},"schemaId":"schema_80","exampleIds":["paths/~1tokens~1{chain_gid}~1{asset_path}/post/responses/201/content/application~1json/example"]},{"code":"400","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Bad request (e.g., missing or invalid fields). Invalid text may be reported as address.label_invalid, address.meta_invalid, public_key.label_invalid, invoice.comment_invalid, invoice.metadata_invalid."},"children":[]}]}]}],"mediaType":"application/problem+json","mediaTypes":["application/problem+json"],"mediaTypeContent":{"application/problem+json":{"schemaId":"components/schemas/InvalidRequestProblem","exampleIds":["paths/~1tokens~1{chain_gid}~1{asset_path}/post/responses/400/content/application~1problem+json/examples/malformed_json"]}},"schemaId":"components/schemas/InvalidRequestProblem","exampleIds":["paths/~1tokens~1{chain_gid}~1{asset_path}/post/responses/400/content/application~1problem+json/examples/malformed_json"]},{"code":"401","description":"Missing or invalid authentication credentials.","mediaType":"application/problem+json","mediaTypes":["application/problem+json"],"mediaTypeContent":{"application/problem+json":{"schemaId":"components/schemas/UnauthorizedProblem","exampleIds":["paths/~1tokens~1{chain_gid}~1{asset_path}/post/responses/401/content/application~1problem+json/examples/service_authentication_denied"]}},"schemaId":"components/schemas/UnauthorizedProblem","exampleIds":["paths/~1tokens~1{chain_gid}~1{asset_path}/post/responses/401/content/application~1problem+json/examples/service_authentication_denied"]},{"code":"403","description":"Insufficient permissions.","mediaType":"application/problem+json","mediaTypes":["application/problem+json"],"mediaTypeContent":{"application/problem+json":{"schemaId":"components/schemas/ForbiddenProblem","exampleIds":["paths/~1tokens~1{chain_gid}~1{asset_path}/post/responses/403/content/application~1problem+json/examples/insufficient_permissions"]}},"schemaId":"components/schemas/ForbiddenProblem","exampleIds":["paths/~1tokens~1{chain_gid}~1{asset_path}/post/responses/403/content/application~1problem+json/examples/insufficient_permissions"]},{"code":"404","description":"Requested resource does not exist.","mediaType":"application/problem+json","mediaTypes":["application/problem+json"],"mediaTypeContent":{"application/problem+json":{"schemaId":"components/schemas/NotFoundProblem","exampleIds":["paths/~1tokens~1{chain_gid}~1{asset_path}/post/responses/404/content/application~1problem+json/examples/address_not_found","paths/~1tokens~1{chain_gid}~1{asset_path}/post/responses/404/content/application~1problem+json/examples/invoice_not_found"]}},"schemaId":"components/schemas/NotFoundProblem","exampleIds":["paths/~1tokens~1{chain_gid}~1{asset_path}/post/responses/404/content/application~1problem+json/examples/address_not_found","paths/~1tokens~1{chain_gid}~1{asset_path}/post/responses/404/content/application~1problem+json/examples/invoice_not_found"]},{"code":"409","description":"Request conflicts with the current resource state.","mediaType":"application/problem+json","mediaTypes":["application/problem+json"],"mediaTypeContent":{"application/problem+json":{"schemaId":"components/schemas/ConflictProblem","exampleIds":["paths/~1tokens~1{chain_gid}~1{asset_path}/post/responses/409/content/application~1problem+json/examples/address_occupied","paths/~1tokens~1{chain_gid}~1{asset_path}/post/responses/409/content/application~1problem+json/examples/address_in_use","paths/~1tokens~1{chain_gid}~1{asset_path}/post/responses/409/content/application~1problem+json/examples/subscription_v1_conflict","paths/~1tokens~1{chain_gid}~1{asset_path}/post/responses/409/content/application~1problem+json/examples/notification_send_in_progress","paths/~1tokens~1{chain_gid}~1{asset_path}/post/responses/409/content/application~1problem+json/examples/notification_payload_unavailable","paths/~1tokens~1{chain_gid}~1{asset_path}/post/responses/409/content/application~1problem+json/examples/notification_test_resend_not_allowed"]}},"schemaId":"components/schemas/ConflictProblem","exampleIds":["paths/~1tokens~1{chain_gid}~1{asset_path}/post/responses/409/content/application~1problem+json/examples/address_occupied","paths/~1tokens~1{chain_gid}~1{asset_path}/post/responses/409/content/application~1problem+json/examples/address_in_use","paths/~1tokens~1{chain_gid}~1{asset_path}/post/responses/409/content/application~1problem+json/examples/subscription_v1_conflict","paths/~1tokens~1{chain_gid}~1{asset_path}/post/responses/409/content/application~1problem+json/examples/notification_send_in_progress","paths/~1tokens~1{chain_gid}~1{asset_path}/post/responses/409/content/application~1problem+json/examples/notification_payload_unavailable","paths/~1tokens~1{chain_gid}~1{asset_path}/post/responses/409/content/application~1problem+json/examples/notification_test_resend_not_allowed"]},{"code":"422","description":"Request preconditions were not met.","mediaType":"application/problem+json","mediaTypes":["application/problem+json"],"mediaTypeContent":{"application/problem+json":{"schemaId":"components/schemas/PreconditionProblem","exampleIds":["paths/~1tokens~1{chain_gid}~1{asset_path}/post/responses/422/content/application~1problem+json/examples/invoice_not_cancellable"]}},"schemaId":"components/schemas/PreconditionProblem","exampleIds":["paths/~1tokens~1{chain_gid}~1{asset_path}/post/responses/422/content/application~1problem+json/examples/invoice_not_cancellable"]},{"code":"429","description":"Capacity or action cooldown exceeded.","mediaType":"application/problem+json","mediaTypes":["application/problem+json"],"mediaTypeContent":{"application/problem+json":{"schemaId":"components/schemas/Problem"}},"schemaId":"components/schemas/Problem"},{"code":"502","description":"Invalid upstream response or integration failure.","mediaType":"application/problem+json","mediaTypes":["application/problem+json"],"mediaTypeContent":{"application/problem+json":{"schemaId":"components/schemas/Problem"}},"schemaId":"components/schemas/Problem"},{"code":"503","description":"The operation is temporarily unavailable. Please try again later.","mediaType":"application/problem+json","mediaTypes":["application/problem+json"],"mediaTypeContent":{"application/problem+json":{"schemaId":"components/schemas/Problem","exampleIds":["paths/~1tokens~1{chain_gid}~1{asset_path}/post/responses/503/content/application~1problem+json/examples/temporarily_unavailable"]}},"schemaId":"components/schemas/Problem","exampleIds":["paths/~1tokens~1{chain_gid}~1{asset_path}/post/responses/503/content/application~1problem+json/examples/temporarily_unavailable"]},{"code":"504","description":"Shared request deadline exhausted.","mediaType":"application/problem+json","mediaTypes":["application/problem+json"],"mediaTypeContent":{"application/problem+json":{"schemaId":"components/schemas/Problem"}},"schemaId":"components/schemas/Problem"},{"code":"default","description":"Unexpected error.","mediaType":"application/problem+json","mediaTypes":["application/problem+json"],"mediaTypeContent":{"application/problem+json":{"schemaId":"components/schemas/Problem"}},"schemaId":"components/schemas/Problem"}],"pointer":"/paths/~1tokens~1{chain_gid}~1{asset_path}/post/responses"}],"panels":[{"children":[{"kind":"response","responseCodes":[{"code":"200","schemaId":"schema_80","exampleIds":["paths/~1tokens~1{chain_gid}~1{asset_path}/post/responses/200/content/application~1json/example"],"mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"schema_80","exampleIds":["paths/~1tokens~1{chain_gid}~1{asset_path}/post/responses/200/content/application~1json/example"]}}},{"code":"201","schemaId":"schema_80","exampleIds":["paths/~1tokens~1{chain_gid}~1{asset_path}/post/responses/201/content/application~1json/example"],"mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"schema_80","exampleIds":["paths/~1tokens~1{chain_gid}~1{asset_path}/post/responses/201/content/application~1json/example"]}}},{"code":"400","schemaId":"components/schemas/InvalidRequestProblem","exampleIds":["paths/~1tokens~1{chain_gid}~1{asset_path}/post/responses/400/content/application~1problem+json/examples/malformed_json"],"mediaTypes":["application/problem+json"],"mediaTypeContent":{"application/problem+json":{"schemaId":"components/schemas/InvalidRequestProblem","exampleIds":["paths/~1tokens~1{chain_gid}~1{asset_path}/post/responses/400/content/application~1problem+json/examples/malformed_json"]}}},{"code":"401","schemaId":"components/schemas/UnauthorizedProblem","exampleIds":["paths/~1tokens~1{chain_gid}~1{asset_path}/post/responses/401/content/application~1problem+json/examples/service_authentication_denied"],"mediaTypes":["application/problem+json"],"mediaTypeContent":{"application/problem+json":{"schemaId":"components/schemas/UnauthorizedProblem","exampleIds":["paths/~1tokens~1{chain_gid}~1{asset_path}/post/responses/401/content/application~1problem+json/examples/service_authentication_denied"]}}},{"code":"403","schemaId":"components/schemas/ForbiddenProblem","exampleIds":["paths/~1tokens~1{chain_gid}~1{asset_path}/post/responses/403/content/application~1problem+json/examples/insufficient_permissions"],"mediaTypes":["application/problem+json"],"mediaTypeContent":{"application/problem+json":{"schemaId":"components/schemas/ForbiddenProblem","exampleIds":["paths/~1tokens~1{chain_gid}~1{asset_path}/post/responses/403/content/application~1problem+json/examples/insufficient_permissions"]}}},{"code":"404","schemaId":"components/schemas/NotFoundProblem","exampleIds":["paths/~1tokens~1{chain_gid}~1{asset_path}/post/responses/404/content/application~1problem+json/examples/address_not_found","paths/~1tokens~1{chain_gid}~1{asset_path}/post/responses/404/content/application~1problem+json/examples/invoice_not_found"],"mediaTypes":["application/problem+json"],"mediaTypeContent":{"application/problem+json":{"schemaId":"components/schemas/NotFoundProblem","exampleIds":["paths/~1tokens~1{chain_gid}~1{asset_path}/post/responses/404/content/application~1problem+json/examples/address_not_found","paths/~1tokens~1{chain_gid}~1{asset_path}/post/responses/404/content/application~1problem+json/examples/invoice_not_found"]}}},{"code":"409","schemaId":"components/schemas/ConflictProblem","exampleIds":["paths/~1tokens~1{chain_gid}~1{asset_path}/post/responses/409/content/application~1problem+json/examples/address_occupied","paths/~1tokens~1{chain_gid}~1{asset_path}/post/responses/409/content/application~1problem+json/examples/address_in_use","paths/~1tokens~1{chain_gid}~1{asset_path}/post/responses/409/content/application~1problem+json/examples/subscription_v1_conflict","paths/~1tokens~1{chain_gid}~1{asset_path}/post/responses/409/content/application~1problem+json/examples/notification_send_in_progress","paths/~1tokens~1{chain_gid}~1{asset_path}/post/responses/409/content/application~1problem+json/examples/notification_payload_unavailable","paths/~1tokens~1{chain_gid}~1{asset_path}/post/responses/409/content/application~1problem+json/examples/notification_test_resend_not_allowed"],"mediaTypes":["application/problem+json"],"mediaTypeContent":{"application/problem+json":{"schemaId":"components/schemas/ConflictProblem","exampleIds":["paths/~1tokens~1{chain_gid}~1{asset_path}/post/responses/409/content/application~1problem+json/examples/address_occupied","paths/~1tokens~1{chain_gid}~1{asset_path}/post/responses/409/content/application~1problem+json/examples/address_in_use","paths/~1tokens~1{chain_gid}~1{asset_path}/post/responses/409/content/application~1problem+json/examples/subscription_v1_conflict","paths/~1tokens~1{chain_gid}~1{asset_path}/post/responses/409/content/application~1problem+json/examples/notification_send_in_progress","paths/~1tokens~1{chain_gid}~1{asset_path}/post/responses/409/content/application~1problem+json/examples/notification_payload_unavailable","paths/~1tokens~1{chain_gid}~1{asset_path}/post/responses/409/content/application~1problem+json/examples/notification_test_resend_not_allowed"]}}},{"code":"422","schemaId":"components/schemas/PreconditionProblem","exampleIds":["paths/~1tokens~1{chain_gid}~1{asset_path}/post/responses/422/content/application~1problem+json/examples/invoice_not_cancellable"],"mediaTypes":["application/problem+json"],"mediaTypeContent":{"application/problem+json":{"schemaId":"components/schemas/PreconditionProblem","exampleIds":["paths/~1tokens~1{chain_gid}~1{asset_path}/post/responses/422/content/application~1problem+json/examples/invoice_not_cancellable"]}}},{"code":"429","schemaId":"components/schemas/Problem","mediaTypes":["application/problem+json"],"mediaTypeContent":{"application/problem+json":{"schemaId":"components/schemas/Problem"}}},{"code":"502","schemaId":"components/schemas/Problem","mediaTypes":["application/problem+json"],"mediaTypeContent":{"application/problem+json":{"schemaId":"components/schemas/Problem"}}},{"code":"503","schemaId":"components/schemas/Problem","exampleIds":["paths/~1tokens~1{chain_gid}~1{asset_path}/post/responses/503/content/application~1problem+json/examples/temporarily_unavailable"],"mediaTypes":["application/problem+json"],"mediaTypeContent":{"application/problem+json":{"schemaId":"components/schemas/Problem","exampleIds":["paths/~1tokens~1{chain_gid}~1{asset_path}/post/responses/503/content/application~1problem+json/examples/temporarily_unavailable"]}}},{"code":"504","schemaId":"components/schemas/Problem","mediaTypes":["application/problem+json"],"mediaTypeContent":{"application/problem+json":{"schemaId":"components/schemas/Problem"}}},{"code":"default","schemaId":"components/schemas/Problem","mediaTypes":["application/problem+json"],"mediaTypeContent":{"application/problem+json":{"schemaId":"components/schemas/Problem"}}}],"examples":[]}]}]},{"nodeType":"container","children":[{"nodeType":"feedback","pageSlug":"/token/create-token"}],"panels":[]}]},"httpPath":"/tokens/{chain_gid}/{asset_path}"},{"label":"Get token","deprecated":false,"httpVerb":"get","isAdditionalOperation":false,"isWebhook":false,"type":"link","link":"/apis/platform/api/token/get-token","routeSlug":"/apis/platform/api/token/get-token","metadata":{"seo":{"title":"Get token","description":"Get token details by chain GID and asset path."}},"content":{"contentType":"item","itemVariant":"httpItem","meta":{"sourceId":"get-token","name":"Get token","isWebhook":false,"pointer":"/paths/~1tokens~1{chain_gid}~1{asset_path}/get","hasSamples":false},"children":[{"nodeType":"container","children":[{"nodeType":"header","level":2,"label":"Get token","isWebhook":false,"showPageActions":true}],"panels":[]},{"nodeType":"container","children":[{"nodeType":"header","level":4,"label":"Request","labelTranslationKey":"request","deepLinkSuffix":"request"},{"nodeType":"markdoc","content":"Get token details by chain GID and asset path."},{"nodeType":"security","requirements":[{"schemes":[{"name":"Auth","scopes":["api:asset:read"],"type":"apiKey","in":"header","paramName":"X-Api-Key","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"API key for authenticating requests. Include your key in the "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"X-Api-Key"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" header. Keys can be created in the Vilna Dashboard or via the Management API. The scopes listed per operation indicate which permissions the key must have."},"children":[]}]}]}]}]}]},{"nodeType":"item-content","variant":"path","label":"Path","labelTranslationKey":"path","parameters":[{"name":"chain_gid","in":"path","schemaId":"schema_29","description":"Blockchain identifier in CAIP-2 format (namespace:reference).","required":true},{"name":"asset_path","in":"path","schemaId":"schema_79","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Asset type identifier in CAIP-19 format (asset_namespace:asset_reference)."},"children":[]}]}]}],"required":true}],"pointer":"/paths/~1tokens~1{chain_gid}~1{asset_path}/get/parameters"}],"panels":[{"children":[{"kind":"code-sample","source":{"kind":"code-sample","operationType":"http","method":"GET","path":"/tokens/{chain_gid}/{asset_path}","servers":[{"url":"/_mock/apis/platform/api","description":"Mock server","isMockServer":true},{"url":"https://api.vilna.io/v2","description":"Vilna API."}],"parameters":{"path":[{"name":"chain_gid","in":"path","required":true,"example":"eip155:1","schemaId":"components/schemas/ChainGID"},{"name":"asset_path","in":"path","required":true,"example":"erc20:0x6B175474E89094C44Da98b954EedeAC495271d0F","schemaId":"components/schemas/AssetPath"}],"query":[],"querystring":[],"header":[],"cookie":[]},"security":[{"schemes":[{"id":"Auth","type":"apiKey","name":"X-Api-Key","in":"header"}],"scopes":["api:asset:read"]}],"responseCodes":["200","400","401","403","404","503","default"],"pointer":"/tokens/{chain_gid}/{asset_path}","href":"token/get-token","openApiOperationId":"get-token","summary":"Get token"},"isWebhook":false,"hideReplay":false,"servers":[{"url":"/_mock/apis/platform/api","description":"Mock server","isMockServer":true},{"url":"https://api.vilna.io/v2","description":"Vilna API."}],"examples":[]}]}]},{"nodeType":"container","children":[{"nodeType":"header","level":4,"label":"Responses","labelTranslationKey":"responses","deepLinkSuffix":"responses"},{"nodeType":"item-content","variant":"responses","responses":[{"code":"200","description":"Catalog asset details.","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"schema_80","exampleIds":["paths/~1tokens~1{chain_gid}~1{asset_path}/get/responses/200/content/application~1json/example"]}},"schemaId":"schema_80","exampleIds":["paths/~1tokens~1{chain_gid}~1{asset_path}/get/responses/200/content/application~1json/example"]},{"code":"400","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Bad request (e.g., missing or invalid fields). Invalid text may be reported as address.label_invalid, address.meta_invalid, public_key.label_invalid, invoice.comment_invalid, invoice.metadata_invalid."},"children":[]}]}]}],"mediaType":"application/problem+json","mediaTypes":["application/problem+json"],"mediaTypeContent":{"application/problem+json":{"schemaId":"components/schemas/InvalidRequestProblem","exampleIds":["paths/~1tokens~1{chain_gid}~1{asset_path}/get/responses/400/content/application~1problem+json/examples/malformed_json"]}},"schemaId":"components/schemas/InvalidRequestProblem","exampleIds":["paths/~1tokens~1{chain_gid}~1{asset_path}/get/responses/400/content/application~1problem+json/examples/malformed_json"]},{"code":"401","description":"Missing or invalid authentication credentials.","mediaType":"application/problem+json","mediaTypes":["application/problem+json"],"mediaTypeContent":{"application/problem+json":{"schemaId":"components/schemas/UnauthorizedProblem","exampleIds":["paths/~1tokens~1{chain_gid}~1{asset_path}/get/responses/401/content/application~1problem+json/examples/service_authentication_denied"]}},"schemaId":"components/schemas/UnauthorizedProblem","exampleIds":["paths/~1tokens~1{chain_gid}~1{asset_path}/get/responses/401/content/application~1problem+json/examples/service_authentication_denied"]},{"code":"403","description":"Insufficient permissions.","mediaType":"application/problem+json","mediaTypes":["application/problem+json"],"mediaTypeContent":{"application/problem+json":{"schemaId":"components/schemas/ForbiddenProblem","exampleIds":["paths/~1tokens~1{chain_gid}~1{asset_path}/get/responses/403/content/application~1problem+json/examples/insufficient_permissions"]}},"schemaId":"components/schemas/ForbiddenProblem","exampleIds":["paths/~1tokens~1{chain_gid}~1{asset_path}/get/responses/403/content/application~1problem+json/examples/insufficient_permissions"]},{"code":"404","description":"Requested resource does not exist.","mediaType":"application/problem+json","mediaTypes":["application/problem+json"],"mediaTypeContent":{"application/problem+json":{"schemaId":"components/schemas/NotFoundProblem","exampleIds":["paths/~1tokens~1{chain_gid}~1{asset_path}/get/responses/404/content/application~1problem+json/examples/address_not_found","paths/~1tokens~1{chain_gid}~1{asset_path}/get/responses/404/content/application~1problem+json/examples/invoice_not_found"]}},"schemaId":"components/schemas/NotFoundProblem","exampleIds":["paths/~1tokens~1{chain_gid}~1{asset_path}/get/responses/404/content/application~1problem+json/examples/address_not_found","paths/~1tokens~1{chain_gid}~1{asset_path}/get/responses/404/content/application~1problem+json/examples/invoice_not_found"]},{"code":"503","description":"The operation is temporarily unavailable. Please try again later.","mediaType":"application/problem+json","mediaTypes":["application/problem+json"],"mediaTypeContent":{"application/problem+json":{"schemaId":"components/schemas/Problem","exampleIds":["paths/~1tokens~1{chain_gid}~1{asset_path}/get/responses/503/content/application~1problem+json/examples/temporarily_unavailable"]}},"schemaId":"components/schemas/Problem","exampleIds":["paths/~1tokens~1{chain_gid}~1{asset_path}/get/responses/503/content/application~1problem+json/examples/temporarily_unavailable"]},{"code":"default","description":"Unexpected error.","mediaType":"application/problem+json","mediaTypes":["application/problem+json"],"mediaTypeContent":{"application/problem+json":{"schemaId":"components/schemas/Problem"}},"schemaId":"components/schemas/Problem"}],"pointer":"/paths/~1tokens~1{chain_gid}~1{asset_path}/get/responses"}],"panels":[{"children":[{"kind":"response","responseCodes":[{"code":"200","schemaId":"schema_80","exampleIds":["paths/~1tokens~1{chain_gid}~1{asset_path}/get/responses/200/content/application~1json/example"],"mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"schema_80","exampleIds":["paths/~1tokens~1{chain_gid}~1{asset_path}/get/responses/200/content/application~1json/example"]}}},{"code":"400","schemaId":"components/schemas/InvalidRequestProblem","exampleIds":["paths/~1tokens~1{chain_gid}~1{asset_path}/get/responses/400/content/application~1problem+json/examples/malformed_json"],"mediaTypes":["application/problem+json"],"mediaTypeContent":{"application/problem+json":{"schemaId":"components/schemas/InvalidRequestProblem","exampleIds":["paths/~1tokens~1{chain_gid}~1{asset_path}/get/responses/400/content/application~1problem+json/examples/malformed_json"]}}},{"code":"401","schemaId":"components/schemas/UnauthorizedProblem","exampleIds":["paths/~1tokens~1{chain_gid}~1{asset_path}/get/responses/401/content/application~1problem+json/examples/service_authentication_denied"],"mediaTypes":["application/problem+json"],"mediaTypeContent":{"application/problem+json":{"schemaId":"components/schemas/UnauthorizedProblem","exampleIds":["paths/~1tokens~1{chain_gid}~1{asset_path}/get/responses/401/content/application~1problem+json/examples/service_authentication_denied"]}}},{"code":"403","schemaId":"components/schemas/ForbiddenProblem","exampleIds":["paths/~1tokens~1{chain_gid}~1{asset_path}/get/responses/403/content/application~1problem+json/examples/insufficient_permissions"],"mediaTypes":["application/problem+json"],"mediaTypeContent":{"application/problem+json":{"schemaId":"components/schemas/ForbiddenProblem","exampleIds":["paths/~1tokens~1{chain_gid}~1{asset_path}/get/responses/403/content/application~1problem+json/examples/insufficient_permissions"]}}},{"code":"404","schemaId":"components/schemas/NotFoundProblem","exampleIds":["paths/~1tokens~1{chain_gid}~1{asset_path}/get/responses/404/content/application~1problem+json/examples/address_not_found","paths/~1tokens~1{chain_gid}~1{asset_path}/get/responses/404/content/application~1problem+json/examples/invoice_not_found"],"mediaTypes":["application/problem+json"],"mediaTypeContent":{"application/problem+json":{"schemaId":"components/schemas/NotFoundProblem","exampleIds":["paths/~1tokens~1{chain_gid}~1{asset_path}/get/responses/404/content/application~1problem+json/examples/address_not_found","paths/~1tokens~1{chain_gid}~1{asset_path}/get/responses/404/content/application~1problem+json/examples/invoice_not_found"]}}},{"code":"503","schemaId":"components/schemas/Problem","exampleIds":["paths/~1tokens~1{chain_gid}~1{asset_path}/get/responses/503/content/application~1problem+json/examples/temporarily_unavailable"],"mediaTypes":["application/problem+json"],"mediaTypeContent":{"application/problem+json":{"schemaId":"components/schemas/Problem","exampleIds":["paths/~1tokens~1{chain_gid}~1{asset_path}/get/responses/503/content/application~1problem+json/examples/temporarily_unavailable"]}}},{"code":"default","schemaId":"components/schemas/Problem","mediaTypes":["application/problem+json"],"mediaTypeContent":{"application/problem+json":{"schemaId":"components/schemas/Problem"}}}],"examples":[]}]}]},{"nodeType":"container","children":[{"nodeType":"feedback","pageSlug":"/token/get-token"}],"panels":[]}]},"httpPath":"/tokens/{chain_gid}/{asset_path}"},{"label":"Trust token","deprecated":false,"httpVerb":"post","isAdditionalOperation":false,"isWebhook":false,"type":"link","link":"/apis/platform/api/token/trust-token","routeSlug":"/apis/platform/api/token/trust-token","metadata":{"seo":{"title":"Trust token","description":"Add an existing supported token to this project's explicit trust selection."}},"content":{"contentType":"item","itemVariant":"httpItem","meta":{"sourceId":"trust-token","name":"Trust token","isWebhook":false,"pointer":"/paths/~1tokens~1{chain_gid}~1{asset_path}~1actions~1trust/post","hasSamples":false},"children":[{"nodeType":"container","children":[{"nodeType":"header","level":2,"label":"Trust token","isWebhook":false,"showPageActions":true}],"panels":[]},{"nodeType":"container","children":[{"nodeType":"header","level":4,"label":"Request","labelTranslationKey":"request","deepLinkSuffix":"request"},{"nodeType":"markdoc","content":"Add an existing supported token to this project's explicit trust selection."},{"nodeType":"security","requirements":[{"schemes":[{"name":"Auth","scopes":["api:asset:write"],"type":"apiKey","in":"header","paramName":"X-Api-Key","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"API key for authenticating requests. Include your key in the "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"X-Api-Key"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" header. Keys can be created in the Vilna Dashboard or via the Management API. The scopes listed per operation indicate which permissions the key must have."},"children":[]}]}]}]}]}]},{"nodeType":"item-content","variant":"path","label":"Path","labelTranslationKey":"path","parameters":[{"name":"chain_gid","in":"path","schemaId":"schema_29","description":"Blockchain identifier in CAIP-2 format (namespace:reference).","required":true},{"name":"asset_path","in":"path","schemaId":"schema_79","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Asset type identifier in CAIP-19 format (asset_namespace:asset_reference)."},"children":[]}]}]}],"required":true}],"pointer":"/paths/~1tokens~1{chain_gid}~1{asset_path}~1actions~1trust/post/parameters"},{"nodeType":"item-content","variant":"headers","label":"Headers","labelTranslationKey":"header","parameters":[{"name":"Idempotency-Key","in":"header","schemaId":"schema_14","description":"Case-sensitive opaque key for one mutation intent. Send exactly one header occurrence containing 1 to 128 visible ASCII bytes (0x21..0x7e). Commas are literal data; do not trim, lowercase or require UUID syntax. Reuse the same key for retries, with current authorization checked on every attempt. Repeated header occurrences are rejected.\n","required":true}],"pointer":"/paths/~1tokens~1{chain_gid}~1{asset_path}~1actions~1trust/post/parameters"}],"panels":[{"children":[{"kind":"code-sample","source":{"kind":"code-sample","operationType":"http","method":"POST","path":"/tokens/{chain_gid}/{asset_path}/actions/trust","servers":[{"url":"/_mock/apis/platform/api","description":"Mock server","isMockServer":true},{"url":"https://api.vilna.io/v2","description":"Vilna API."}],"parameters":{"path":[{"name":"chain_gid","in":"path","required":true,"example":"eip155:1","schemaId":"components/schemas/ChainGID"},{"name":"asset_path","in":"path","required":true,"example":"erc20:0x6B175474E89094C44Da98b954EedeAC495271d0F","schemaId":"components/schemas/AssetPath"}],"query":[],"querystring":[],"header":[{"name":"Idempotency-Key","in":"header","required":true,"schemaId":"schema_14"}],"cookie":[]},"security":[{"schemes":[{"id":"Auth","type":"apiKey","name":"X-Api-Key","in":"header"}],"scopes":["api:asset:write"]}],"responseCodes":["200","400","401","403","404","409","422","429","503","default"],"pointer":"/tokens/{chain_gid}/{asset_path}/actions/trust","href":"token/trust-token","openApiOperationId":"trust-token","summary":"Trust token"},"isWebhook":false,"hideReplay":false,"servers":[{"url":"/_mock/apis/platform/api","description":"Mock server","isMockServer":true},{"url":"https://api.vilna.io/v2","description":"Vilna API."}],"examples":[]}]}]},{"nodeType":"container","children":[{"nodeType":"header","level":4,"label":"Responses","labelTranslationKey":"responses","deepLinkSuffix":"responses"},{"nodeType":"item-content","variant":"responses","responses":[{"code":"200","description":"Catalog asset details.","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"schema_80","exampleIds":["paths/~1tokens~1{chain_gid}~1{asset_path}~1actions~1trust/post/responses/200/content/application~1json/example"]}},"schemaId":"schema_80","exampleIds":["paths/~1tokens~1{chain_gid}~1{asset_path}~1actions~1trust/post/responses/200/content/application~1json/example"]},{"code":"400","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Bad request (e.g., missing or invalid fields). Invalid text may be reported as address.label_invalid, address.meta_invalid, public_key.label_invalid, invoice.comment_invalid, invoice.metadata_invalid."},"children":[]}]}]}],"mediaType":"application/problem+json","mediaTypes":["application/problem+json"],"mediaTypeContent":{"application/problem+json":{"schemaId":"components/schemas/InvalidRequestProblem","exampleIds":["paths/~1tokens~1{chain_gid}~1{asset_path}~1actions~1trust/post/responses/400/content/application~1problem+json/examples/malformed_json"]}},"schemaId":"components/schemas/InvalidRequestProblem","exampleIds":["paths/~1tokens~1{chain_gid}~1{asset_path}~1actions~1trust/post/responses/400/content/application~1problem+json/examples/malformed_json"]},{"code":"401","description":"Missing or invalid authentication credentials.","mediaType":"application/problem+json","mediaTypes":["application/problem+json"],"mediaTypeContent":{"application/problem+json":{"schemaId":"components/schemas/UnauthorizedProblem","exampleIds":["paths/~1tokens~1{chain_gid}~1{asset_path}~1actions~1trust/post/responses/401/content/application~1problem+json/examples/service_authentication_denied"]}},"schemaId":"components/schemas/UnauthorizedProblem","exampleIds":["paths/~1tokens~1{chain_gid}~1{asset_path}~1actions~1trust/post/responses/401/content/application~1problem+json/examples/service_authentication_denied"]},{"code":"403","description":"Insufficient permissions.","mediaType":"application/problem+json","mediaTypes":["application/problem+json"],"mediaTypeContent":{"application/problem+json":{"schemaId":"components/schemas/ForbiddenProblem","exampleIds":["paths/~1tokens~1{chain_gid}~1{asset_path}~1actions~1trust/post/responses/403/content/application~1problem+json/examples/insufficient_permissions"]}},"schemaId":"components/schemas/ForbiddenProblem","exampleIds":["paths/~1tokens~1{chain_gid}~1{asset_path}~1actions~1trust/post/responses/403/content/application~1problem+json/examples/insufficient_permissions"]},{"code":"404","description":"Requested resource does not exist.","mediaType":"application/problem+json","mediaTypes":["application/problem+json"],"mediaTypeContent":{"application/problem+json":{"schemaId":"components/schemas/NotFoundProblem","exampleIds":["paths/~1tokens~1{chain_gid}~1{asset_path}~1actions~1trust/post/responses/404/content/application~1problem+json/examples/address_not_found","paths/~1tokens~1{chain_gid}~1{asset_path}~1actions~1trust/post/responses/404/content/application~1problem+json/examples/invoice_not_found"]}},"schemaId":"components/schemas/NotFoundProblem","exampleIds":["paths/~1tokens~1{chain_gid}~1{asset_path}~1actions~1trust/post/responses/404/content/application~1problem+json/examples/address_not_found","paths/~1tokens~1{chain_gid}~1{asset_path}~1actions~1trust/post/responses/404/content/application~1problem+json/examples/invoice_not_found"]},{"code":"409","description":"Request conflicts with the current resource state.","mediaType":"application/problem+json","mediaTypes":["application/problem+json"],"mediaTypeContent":{"application/problem+json":{"schemaId":"components/schemas/ConflictProblem","exampleIds":["paths/~1tokens~1{chain_gid}~1{asset_path}~1actions~1trust/post/responses/409/content/application~1problem+json/examples/address_occupied","paths/~1tokens~1{chain_gid}~1{asset_path}~1actions~1trust/post/responses/409/content/application~1problem+json/examples/address_in_use","paths/~1tokens~1{chain_gid}~1{asset_path}~1actions~1trust/post/responses/409/content/application~1problem+json/examples/subscription_v1_conflict","paths/~1tokens~1{chain_gid}~1{asset_path}~1actions~1trust/post/responses/409/content/application~1problem+json/examples/notification_send_in_progress","paths/~1tokens~1{chain_gid}~1{asset_path}~1actions~1trust/post/responses/409/content/application~1problem+json/examples/notification_payload_unavailable","paths/~1tokens~1{chain_gid}~1{asset_path}~1actions~1trust/post/responses/409/content/application~1problem+json/examples/notification_test_resend_not_allowed"]}},"schemaId":"components/schemas/ConflictProblem","exampleIds":["paths/~1tokens~1{chain_gid}~1{asset_path}~1actions~1trust/post/responses/409/content/application~1problem+json/examples/address_occupied","paths/~1tokens~1{chain_gid}~1{asset_path}~1actions~1trust/post/responses/409/content/application~1problem+json/examples/address_in_use","paths/~1tokens~1{chain_gid}~1{asset_path}~1actions~1trust/post/responses/409/content/application~1problem+json/examples/subscription_v1_conflict","paths/~1tokens~1{chain_gid}~1{asset_path}~1actions~1trust/post/responses/409/content/application~1problem+json/examples/notification_send_in_progress","paths/~1tokens~1{chain_gid}~1{asset_path}~1actions~1trust/post/responses/409/content/application~1problem+json/examples/notification_payload_unavailable","paths/~1tokens~1{chain_gid}~1{asset_path}~1actions~1trust/post/responses/409/content/application~1problem+json/examples/notification_test_resend_not_allowed"]},{"code":"422","description":"Request preconditions were not met.","mediaType":"application/problem+json","mediaTypes":["application/problem+json"],"mediaTypeContent":{"application/problem+json":{"schemaId":"components/schemas/PreconditionProblem","exampleIds":["paths/~1tokens~1{chain_gid}~1{asset_path}~1actions~1trust/post/responses/422/content/application~1problem+json/examples/invoice_not_cancellable"]}},"schemaId":"components/schemas/PreconditionProblem","exampleIds":["paths/~1tokens~1{chain_gid}~1{asset_path}~1actions~1trust/post/responses/422/content/application~1problem+json/examples/invoice_not_cancellable"]},{"code":"429","description":"Resource quota exceeded. The response includes the effective limit for this scope. The applicable code and limit depend on the operation; examples illustrate different limits.","mediaType":"application/problem+json","mediaTypes":["application/problem+json"],"mediaTypeContent":{"application/problem+json":{"schemaId":"components/schemas/QuotaExceededProblem","exampleIds":["paths/~1tokens~1{chain_gid}~1{asset_path}~1actions~1trust/post/responses/429/content/application~1problem+json/examples/address_quota","paths/~1tokens~1{chain_gid}~1{asset_path}~1actions~1trust/post/responses/429/content/application~1problem+json/examples/creation_prohibited"]}},"schemaId":"components/schemas/QuotaExceededProblem","exampleIds":["paths/~1tokens~1{chain_gid}~1{asset_path}~1actions~1trust/post/responses/429/content/application~1problem+json/examples/address_quota","paths/~1tokens~1{chain_gid}~1{asset_path}~1actions~1trust/post/responses/429/content/application~1problem+json/examples/creation_prohibited"]},{"code":"503","description":"The operation is temporarily unavailable. Please try again later.","mediaType":"application/problem+json","mediaTypes":["application/problem+json"],"mediaTypeContent":{"application/problem+json":{"schemaId":"components/schemas/Problem","exampleIds":["paths/~1tokens~1{chain_gid}~1{asset_path}~1actions~1trust/post/responses/503/content/application~1problem+json/examples/temporarily_unavailable"]}},"schemaId":"components/schemas/Problem","exampleIds":["paths/~1tokens~1{chain_gid}~1{asset_path}~1actions~1trust/post/responses/503/content/application~1problem+json/examples/temporarily_unavailable"]},{"code":"default","description":"Unexpected error.","mediaType":"application/problem+json","mediaTypes":["application/problem+json"],"mediaTypeContent":{"application/problem+json":{"schemaId":"components/schemas/Problem"}},"schemaId":"components/schemas/Problem"}],"pointer":"/paths/~1tokens~1{chain_gid}~1{asset_path}~1actions~1trust/post/responses"}],"panels":[{"children":[{"kind":"response","responseCodes":[{"code":"200","schemaId":"schema_80","exampleIds":["paths/~1tokens~1{chain_gid}~1{asset_path}~1actions~1trust/post/responses/200/content/application~1json/example"],"mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"schema_80","exampleIds":["paths/~1tokens~1{chain_gid}~1{asset_path}~1actions~1trust/post/responses/200/content/application~1json/example"]}}},{"code":"400","schemaId":"components/schemas/InvalidRequestProblem","exampleIds":["paths/~1tokens~1{chain_gid}~1{asset_path}~1actions~1trust/post/responses/400/content/application~1problem+json/examples/malformed_json"],"mediaTypes":["application/problem+json"],"mediaTypeContent":{"application/problem+json":{"schemaId":"components/schemas/InvalidRequestProblem","exampleIds":["paths/~1tokens~1{chain_gid}~1{asset_path}~1actions~1trust/post/responses/400/content/application~1problem+json/examples/malformed_json"]}}},{"code":"401","schemaId":"components/schemas/UnauthorizedProblem","exampleIds":["paths/~1tokens~1{chain_gid}~1{asset_path}~1actions~1trust/post/responses/401/content/application~1problem+json/examples/service_authentication_denied"],"mediaTypes":["application/problem+json"],"mediaTypeContent":{"application/problem+json":{"schemaId":"components/schemas/UnauthorizedProblem","exampleIds":["paths/~1tokens~1{chain_gid}~1{asset_path}~1actions~1trust/post/responses/401/content/application~1problem+json/examples/service_authentication_denied"]}}},{"code":"403","schemaId":"components/schemas/ForbiddenProblem","exampleIds":["paths/~1tokens~1{chain_gid}~1{asset_path}~1actions~1trust/post/responses/403/content/application~1problem+json/examples/insufficient_permissions"],"mediaTypes":["application/problem+json"],"mediaTypeContent":{"application/problem+json":{"schemaId":"components/schemas/ForbiddenProblem","exampleIds":["paths/~1tokens~1{chain_gid}~1{asset_path}~1actions~1trust/post/responses/403/content/application~1problem+json/examples/insufficient_permissions"]}}},{"code":"404","schemaId":"components/schemas/NotFoundProblem","exampleIds":["paths/~1tokens~1{chain_gid}~1{asset_path}~1actions~1trust/post/responses/404/content/application~1problem+json/examples/address_not_found","paths/~1tokens~1{chain_gid}~1{asset_path}~1actions~1trust/post/responses/404/content/application~1problem+json/examples/invoice_not_found"],"mediaTypes":["application/problem+json"],"mediaTypeContent":{"application/problem+json":{"schemaId":"components/schemas/NotFoundProblem","exampleIds":["paths/~1tokens~1{chain_gid}~1{asset_path}~1actions~1trust/post/responses/404/content/application~1problem+json/examples/address_not_found","paths/~1tokens~1{chain_gid}~1{asset_path}~1actions~1trust/post/responses/404/content/application~1problem+json/examples/invoice_not_found"]}}},{"code":"409","schemaId":"components/schemas/ConflictProblem","exampleIds":["paths/~1tokens~1{chain_gid}~1{asset_path}~1actions~1trust/post/responses/409/content/application~1problem+json/examples/address_occupied","paths/~1tokens~1{chain_gid}~1{asset_path}~1actions~1trust/post/responses/409/content/application~1problem+json/examples/address_in_use","paths/~1tokens~1{chain_gid}~1{asset_path}~1actions~1trust/post/responses/409/content/application~1problem+json/examples/subscription_v1_conflict","paths/~1tokens~1{chain_gid}~1{asset_path}~1actions~1trust/post/responses/409/content/application~1problem+json/examples/notification_send_in_progress","paths/~1tokens~1{chain_gid}~1{asset_path}~1actions~1trust/post/responses/409/content/application~1problem+json/examples/notification_payload_unavailable","paths/~1tokens~1{chain_gid}~1{asset_path}~1actions~1trust/post/responses/409/content/application~1problem+json/examples/notification_test_resend_not_allowed"],"mediaTypes":["application/problem+json"],"mediaTypeContent":{"application/problem+json":{"schemaId":"components/schemas/ConflictProblem","exampleIds":["paths/~1tokens~1{chain_gid}~1{asset_path}~1actions~1trust/post/responses/409/content/application~1problem+json/examples/address_occupied","paths/~1tokens~1{chain_gid}~1{asset_path}~1actions~1trust/post/responses/409/content/application~1problem+json/examples/address_in_use","paths/~1tokens~1{chain_gid}~1{asset_path}~1actions~1trust/post/responses/409/content/application~1problem+json/examples/subscription_v1_conflict","paths/~1tokens~1{chain_gid}~1{asset_path}~1actions~1trust/post/responses/409/content/application~1problem+json/examples/notification_send_in_progress","paths/~1tokens~1{chain_gid}~1{asset_path}~1actions~1trust/post/responses/409/content/application~1problem+json/examples/notification_payload_unavailable","paths/~1tokens~1{chain_gid}~1{asset_path}~1actions~1trust/post/responses/409/content/application~1problem+json/examples/notification_test_resend_not_allowed"]}}},{"code":"422","schemaId":"components/schemas/PreconditionProblem","exampleIds":["paths/~1tokens~1{chain_gid}~1{asset_path}~1actions~1trust/post/responses/422/content/application~1problem+json/examples/invoice_not_cancellable"],"mediaTypes":["application/problem+json"],"mediaTypeContent":{"application/problem+json":{"schemaId":"components/schemas/PreconditionProblem","exampleIds":["paths/~1tokens~1{chain_gid}~1{asset_path}~1actions~1trust/post/responses/422/content/application~1problem+json/examples/invoice_not_cancellable"]}}},{"code":"429","schemaId":"components/schemas/QuotaExceededProblem","exampleIds":["paths/~1tokens~1{chain_gid}~1{asset_path}~1actions~1trust/post/responses/429/content/application~1problem+json/examples/address_quota","paths/~1tokens~1{chain_gid}~1{asset_path}~1actions~1trust/post/responses/429/content/application~1problem+json/examples/creation_prohibited"],"mediaTypes":["application/problem+json"],"mediaTypeContent":{"application/problem+json":{"schemaId":"components/schemas/QuotaExceededProblem","exampleIds":["paths/~1tokens~1{chain_gid}~1{asset_path}~1actions~1trust/post/responses/429/content/application~1problem+json/examples/address_quota","paths/~1tokens~1{chain_gid}~1{asset_path}~1actions~1trust/post/responses/429/content/application~1problem+json/examples/creation_prohibited"]}}},{"code":"503","schemaId":"components/schemas/Problem","exampleIds":["paths/~1tokens~1{chain_gid}~1{asset_path}~1actions~1trust/post/responses/503/content/application~1problem+json/examples/temporarily_unavailable"],"mediaTypes":["application/problem+json"],"mediaTypeContent":{"application/problem+json":{"schemaId":"components/schemas/Problem","exampleIds":["paths/~1tokens~1{chain_gid}~1{asset_path}~1actions~1trust/post/responses/503/content/application~1problem+json/examples/temporarily_unavailable"]}}},{"code":"default","schemaId":"components/schemas/Problem","mediaTypes":["application/problem+json"],"mediaTypeContent":{"application/problem+json":{"schemaId":"components/schemas/Problem"}}}],"examples":[]}]}]},{"nodeType":"container","children":[{"nodeType":"feedback","pageSlug":"/token/trust-token"}],"panels":[]}]},"httpPath":"/tokens/{chain_gid}/{asset_path}/actions/trust"},{"label":"Untrust token","deprecated":false,"httpVerb":"post","isAdditionalOperation":false,"isWebhook":false,"type":"link","link":"/apis/platform/api/token/untrust-token","routeSlug":"/apis/platform/api/token/untrust-token","metadata":{"seo":{"title":"Untrust token","description":"Remove this project's explicit trust selection for a token."}},"content":{"contentType":"item","itemVariant":"httpItem","meta":{"sourceId":"untrust-token","name":"Untrust token","isWebhook":false,"pointer":"/paths/~1tokens~1{chain_gid}~1{asset_path}~1actions~1untrust/post","hasSamples":false},"children":[{"nodeType":"container","children":[{"nodeType":"header","level":2,"label":"Untrust token","isWebhook":false,"showPageActions":true}],"panels":[]},{"nodeType":"container","children":[{"nodeType":"header","level":4,"label":"Request","labelTranslationKey":"request","deepLinkSuffix":"request"},{"nodeType":"markdoc","content":"Remove this project's explicit trust selection for a token."},{"nodeType":"security","requirements":[{"schemes":[{"name":"Auth","scopes":["api:asset:write"],"type":"apiKey","in":"header","paramName":"X-Api-Key","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"API key for authenticating requests. Include your key in the "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"X-Api-Key"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" header. Keys can be created in the Vilna Dashboard or via the Management API. The scopes listed per operation indicate which permissions the key must have."},"children":[]}]}]}]}]}]},{"nodeType":"item-content","variant":"path","label":"Path","labelTranslationKey":"path","parameters":[{"name":"chain_gid","in":"path","schemaId":"schema_29","description":"Blockchain identifier in CAIP-2 format (namespace:reference).","required":true},{"name":"asset_path","in":"path","schemaId":"schema_79","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Asset type identifier in CAIP-19 format (asset_namespace:asset_reference)."},"children":[]}]}]}],"required":true}],"pointer":"/paths/~1tokens~1{chain_gid}~1{asset_path}~1actions~1untrust/post/parameters"},{"nodeType":"item-content","variant":"headers","label":"Headers","labelTranslationKey":"header","parameters":[{"name":"Idempotency-Key","in":"header","schemaId":"schema_14","description":"Case-sensitive opaque key for one mutation intent. Send exactly one header occurrence containing 1 to 128 visible ASCII bytes (0x21..0x7e). Commas are literal data; do not trim, lowercase or require UUID syntax. Reuse the same key for retries, with current authorization checked on every attempt. Repeated header occurrences are rejected.\n","required":true}],"pointer":"/paths/~1tokens~1{chain_gid}~1{asset_path}~1actions~1untrust/post/parameters"}],"panels":[{"children":[{"kind":"code-sample","source":{"kind":"code-sample","operationType":"http","method":"POST","path":"/tokens/{chain_gid}/{asset_path}/actions/untrust","servers":[{"url":"/_mock/apis/platform/api","description":"Mock server","isMockServer":true},{"url":"https://api.vilna.io/v2","description":"Vilna API."}],"parameters":{"path":[{"name":"chain_gid","in":"path","required":true,"example":"eip155:1","schemaId":"components/schemas/ChainGID"},{"name":"asset_path","in":"path","required":true,"example":"erc20:0x6B175474E89094C44Da98b954EedeAC495271d0F","schemaId":"components/schemas/AssetPath"}],"query":[],"querystring":[],"header":[{"name":"Idempotency-Key","in":"header","required":true,"schemaId":"schema_14"}],"cookie":[]},"security":[{"schemes":[{"id":"Auth","type":"apiKey","name":"X-Api-Key","in":"header"}],"scopes":["api:asset:write"]}],"responseCodes":["204","400","401","403","404","409","422","503","default"],"pointer":"/tokens/{chain_gid}/{asset_path}/actions/untrust","href":"token/untrust-token","openApiOperationId":"untrust-token","summary":"Untrust token"},"isWebhook":false,"hideReplay":false,"servers":[{"url":"/_mock/apis/platform/api","description":"Mock server","isMockServer":true},{"url":"https://api.vilna.io/v2","description":"Vilna API."}],"examples":[]}]}]},{"nodeType":"container","children":[{"nodeType":"header","level":4,"label":"Responses","labelTranslationKey":"responses","deepLinkSuffix":"responses"},{"nodeType":"item-content","variant":"responses","responses":[{"code":"204","description":"Successful operation with no response body."},{"code":"400","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Bad request (e.g., missing or invalid fields). Invalid text may be reported as address.label_invalid, address.meta_invalid, public_key.label_invalid, invoice.comment_invalid, invoice.metadata_invalid."},"children":[]}]}]}],"mediaType":"application/problem+json","mediaTypes":["application/problem+json"],"mediaTypeContent":{"application/problem+json":{"schemaId":"components/schemas/InvalidRequestProblem","exampleIds":["paths/~1tokens~1{chain_gid}~1{asset_path}~1actions~1untrust/post/responses/400/content/application~1problem+json/examples/malformed_json"]}},"schemaId":"components/schemas/InvalidRequestProblem","exampleIds":["paths/~1tokens~1{chain_gid}~1{asset_path}~1actions~1untrust/post/responses/400/content/application~1problem+json/examples/malformed_json"]},{"code":"401","description":"Missing or invalid authentication credentials.","mediaType":"application/problem+json","mediaTypes":["application/problem+json"],"mediaTypeContent":{"application/problem+json":{"schemaId":"components/schemas/UnauthorizedProblem","exampleIds":["paths/~1tokens~1{chain_gid}~1{asset_path}~1actions~1untrust/post/responses/401/content/application~1problem+json/examples/service_authentication_denied"]}},"schemaId":"components/schemas/UnauthorizedProblem","exampleIds":["paths/~1tokens~1{chain_gid}~1{asset_path}~1actions~1untrust/post/responses/401/content/application~1problem+json/examples/service_authentication_denied"]},{"code":"403","description":"Insufficient permissions.","mediaType":"application/problem+json","mediaTypes":["application/problem+json"],"mediaTypeContent":{"application/problem+json":{"schemaId":"components/schemas/ForbiddenProblem","exampleIds":["paths/~1tokens~1{chain_gid}~1{asset_path}~1actions~1untrust/post/responses/403/content/application~1problem+json/examples/insufficient_permissions"]}},"schemaId":"components/schemas/ForbiddenProblem","exampleIds":["paths/~1tokens~1{chain_gid}~1{asset_path}~1actions~1untrust/post/responses/403/content/application~1problem+json/examples/insufficient_permissions"]},{"code":"404","description":"Requested resource does not exist.","mediaType":"application/problem+json","mediaTypes":["application/problem+json"],"mediaTypeContent":{"application/problem+json":{"schemaId":"components/schemas/NotFoundProblem","exampleIds":["paths/~1tokens~1{chain_gid}~1{asset_path}~1actions~1untrust/post/responses/404/content/application~1problem+json/examples/address_not_found","paths/~1tokens~1{chain_gid}~1{asset_path}~1actions~1untrust/post/responses/404/content/application~1problem+json/examples/invoice_not_found"]}},"schemaId":"components/schemas/NotFoundProblem","exampleIds":["paths/~1tokens~1{chain_gid}~1{asset_path}~1actions~1untrust/post/responses/404/content/application~1problem+json/examples/address_not_found","paths/~1tokens~1{chain_gid}~1{asset_path}~1actions~1untrust/post/responses/404/content/application~1problem+json/examples/invoice_not_found"]},{"code":"409","description":"Request conflicts with the current resource state.","mediaType":"application/problem+json","mediaTypes":["application/problem+json"],"mediaTypeContent":{"application/problem+json":{"schemaId":"components/schemas/ConflictProblem","exampleIds":["paths/~1tokens~1{chain_gid}~1{asset_path}~1actions~1untrust/post/responses/409/content/application~1problem+json/examples/address_occupied","paths/~1tokens~1{chain_gid}~1{asset_path}~1actions~1untrust/post/responses/409/content/application~1problem+json/examples/address_in_use","paths/~1tokens~1{chain_gid}~1{asset_path}~1actions~1untrust/post/responses/409/content/application~1problem+json/examples/subscription_v1_conflict","paths/~1tokens~1{chain_gid}~1{asset_path}~1actions~1untrust/post/responses/409/content/application~1problem+json/examples/notification_send_in_progress","paths/~1tokens~1{chain_gid}~1{asset_path}~1actions~1untrust/post/responses/409/content/application~1problem+json/examples/notification_payload_unavailable","paths/~1tokens~1{chain_gid}~1{asset_path}~1actions~1untrust/post/responses/409/content/application~1problem+json/examples/notification_test_resend_not_allowed"]}},"schemaId":"components/schemas/ConflictProblem","exampleIds":["paths/~1tokens~1{chain_gid}~1{asset_path}~1actions~1untrust/post/responses/409/content/application~1problem+json/examples/address_occupied","paths/~1tokens~1{chain_gid}~1{asset_path}~1actions~1untrust/post/responses/409/content/application~1problem+json/examples/address_in_use","paths/~1tokens~1{chain_gid}~1{asset_path}~1actions~1untrust/post/responses/409/content/application~1problem+json/examples/subscription_v1_conflict","paths/~1tokens~1{chain_gid}~1{asset_path}~1actions~1untrust/post/responses/409/content/application~1problem+json/examples/notification_send_in_progress","paths/~1tokens~1{chain_gid}~1{asset_path}~1actions~1untrust/post/responses/409/content/application~1problem+json/examples/notification_payload_unavailable","paths/~1tokens~1{chain_gid}~1{asset_path}~1actions~1untrust/post/responses/409/content/application~1problem+json/examples/notification_test_resend_not_allowed"]},{"code":"422","description":"Request preconditions were not met.","mediaType":"application/problem+json","mediaTypes":["application/problem+json"],"mediaTypeContent":{"application/problem+json":{"schemaId":"components/schemas/PreconditionProblem","exampleIds":["paths/~1tokens~1{chain_gid}~1{asset_path}~1actions~1untrust/post/responses/422/content/application~1problem+json/examples/invoice_not_cancellable"]}},"schemaId":"components/schemas/PreconditionProblem","exampleIds":["paths/~1tokens~1{chain_gid}~1{asset_path}~1actions~1untrust/post/responses/422/content/application~1problem+json/examples/invoice_not_cancellable"]},{"code":"503","description":"The operation is temporarily unavailable. Please try again later.","mediaType":"application/problem+json","mediaTypes":["application/problem+json"],"mediaTypeContent":{"application/problem+json":{"schemaId":"components/schemas/Problem","exampleIds":["paths/~1tokens~1{chain_gid}~1{asset_path}~1actions~1untrust/post/responses/503/content/application~1problem+json/examples/temporarily_unavailable"]}},"schemaId":"components/schemas/Problem","exampleIds":["paths/~1tokens~1{chain_gid}~1{asset_path}~1actions~1untrust/post/responses/503/content/application~1problem+json/examples/temporarily_unavailable"]},{"code":"default","description":"Unexpected error.","mediaType":"application/problem+json","mediaTypes":["application/problem+json"],"mediaTypeContent":{"application/problem+json":{"schemaId":"components/schemas/Problem"}},"schemaId":"components/schemas/Problem"}],"pointer":"/paths/~1tokens~1{chain_gid}~1{asset_path}~1actions~1untrust/post/responses"}],"panels":[{"children":[{"kind":"response","responseCodes":[{"code":"204"},{"code":"400","schemaId":"components/schemas/InvalidRequestProblem","exampleIds":["paths/~1tokens~1{chain_gid}~1{asset_path}~1actions~1untrust/post/responses/400/content/application~1problem+json/examples/malformed_json"],"mediaTypes":["application/problem+json"],"mediaTypeContent":{"application/problem+json":{"schemaId":"components/schemas/InvalidRequestProblem","exampleIds":["paths/~1tokens~1{chain_gid}~1{asset_path}~1actions~1untrust/post/responses/400/content/application~1problem+json/examples/malformed_json"]}}},{"code":"401","schemaId":"components/schemas/UnauthorizedProblem","exampleIds":["paths/~1tokens~1{chain_gid}~1{asset_path}~1actions~1untrust/post/responses/401/content/application~1problem+json/examples/service_authentication_denied"],"mediaTypes":["application/problem+json"],"mediaTypeContent":{"application/problem+json":{"schemaId":"components/schemas/UnauthorizedProblem","exampleIds":["paths/~1tokens~1{chain_gid}~1{asset_path}~1actions~1untrust/post/responses/401/content/application~1problem+json/examples/service_authentication_denied"]}}},{"code":"403","schemaId":"components/schemas/ForbiddenProblem","exampleIds":["paths/~1tokens~1{chain_gid}~1{asset_path}~1actions~1untrust/post/responses/403/content/application~1problem+json/examples/insufficient_permissions"],"mediaTypes":["application/problem+json"],"mediaTypeContent":{"application/problem+json":{"schemaId":"components/schemas/ForbiddenProblem","exampleIds":["paths/~1tokens~1{chain_gid}~1{asset_path}~1actions~1untrust/post/responses/403/content/application~1problem+json/examples/insufficient_permissions"]}}},{"code":"404","schemaId":"components/schemas/NotFoundProblem","exampleIds":["paths/~1tokens~1{chain_gid}~1{asset_path}~1actions~1untrust/post/responses/404/content/application~1problem+json/examples/address_not_found","paths/~1tokens~1{chain_gid}~1{asset_path}~1actions~1untrust/post/responses/404/content/application~1problem+json/examples/invoice_not_found"],"mediaTypes":["application/problem+json"],"mediaTypeContent":{"application/problem+json":{"schemaId":"components/schemas/NotFoundProblem","exampleIds":["paths/~1tokens~1{chain_gid}~1{asset_path}~1actions~1untrust/post/responses/404/content/application~1problem+json/examples/address_not_found","paths/~1tokens~1{chain_gid}~1{asset_path}~1actions~1untrust/post/responses/404/content/application~1problem+json/examples/invoice_not_found"]}}},{"code":"409","schemaId":"components/schemas/ConflictProblem","exampleIds":["paths/~1tokens~1{chain_gid}~1{asset_path}~1actions~1untrust/post/responses/409/content/application~1problem+json/examples/address_occupied","paths/~1tokens~1{chain_gid}~1{asset_path}~1actions~1untrust/post/responses/409/content/application~1problem+json/examples/address_in_use","paths/~1tokens~1{chain_gid}~1{asset_path}~1actions~1untrust/post/responses/409/content/application~1problem+json/examples/subscription_v1_conflict","paths/~1tokens~1{chain_gid}~1{asset_path}~1actions~1untrust/post/responses/409/content/application~1problem+json/examples/notification_send_in_progress","paths/~1tokens~1{chain_gid}~1{asset_path}~1actions~1untrust/post/responses/409/content/application~1problem+json/examples/notification_payload_unavailable","paths/~1tokens~1{chain_gid}~1{asset_path}~1actions~1untrust/post/responses/409/content/application~1problem+json/examples/notification_test_resend_not_allowed"],"mediaTypes":["application/problem+json"],"mediaTypeContent":{"application/problem+json":{"schemaId":"components/schemas/ConflictProblem","exampleIds":["paths/~1tokens~1{chain_gid}~1{asset_path}~1actions~1untrust/post/responses/409/content/application~1problem+json/examples/address_occupied","paths/~1tokens~1{chain_gid}~1{asset_path}~1actions~1untrust/post/responses/409/content/application~1problem+json/examples/address_in_use","paths/~1tokens~1{chain_gid}~1{asset_path}~1actions~1untrust/post/responses/409/content/application~1problem+json/examples/subscription_v1_conflict","paths/~1tokens~1{chain_gid}~1{asset_path}~1actions~1untrust/post/responses/409/content/application~1problem+json/examples/notification_send_in_progress","paths/~1tokens~1{chain_gid}~1{asset_path}~1actions~1untrust/post/responses/409/content/application~1problem+json/examples/notification_payload_unavailable","paths/~1tokens~1{chain_gid}~1{asset_path}~1actions~1untrust/post/responses/409/content/application~1problem+json/examples/notification_test_resend_not_allowed"]}}},{"code":"422","schemaId":"components/schemas/PreconditionProblem","exampleIds":["paths/~1tokens~1{chain_gid}~1{asset_path}~1actions~1untrust/post/responses/422/content/application~1problem+json/examples/invoice_not_cancellable"],"mediaTypes":["application/problem+json"],"mediaTypeContent":{"application/problem+json":{"schemaId":"components/schemas/PreconditionProblem","exampleIds":["paths/~1tokens~1{chain_gid}~1{asset_path}~1actions~1untrust/post/responses/422/content/application~1problem+json/examples/invoice_not_cancellable"]}}},{"code":"503","schemaId":"components/schemas/Problem","exampleIds":["paths/~1tokens~1{chain_gid}~1{asset_path}~1actions~1untrust/post/responses/503/content/application~1problem+json/examples/temporarily_unavailable"],"mediaTypes":["application/problem+json"],"mediaTypeContent":{"application/problem+json":{"schemaId":"components/schemas/Problem","exampleIds":["paths/~1tokens~1{chain_gid}~1{asset_path}~1actions~1untrust/post/responses/503/content/application~1problem+json/examples/temporarily_unavailable"]}}},{"code":"default","schemaId":"components/schemas/Problem","mediaTypes":["application/problem+json"],"mediaTypeContent":{"application/problem+json":{"schemaId":"components/schemas/Problem"}}}],"examples":[]}]}]},{"nodeType":"container","children":[{"nodeType":"feedback","pageSlug":"/token/untrust-token"}],"panels":[]}]},"httpPath":"/tokens/{chain_gid}/{asset_path}/actions/untrust"}],"content":{"contentType":"group","meta":{"name":"token"},"children":[{"nodeType":"container","children":[{"nodeType":"header","level":2,"label":"Tokens","showPageActions":true},{"nodeType":"markdoc","content":"Token metadata (symbols, decimals, names) for supported asset types."}],"panels":[{"children":[{"kind":"group-items","title":"Operations","titleTranslationKey":"operations","items":[{"title":"/tokens","summary":"List tokens","prefix":{"name":"get","color":"get"},"badges":[],"link":"/token/list-tokens","deprecated":false},{"title":"/tokens/{chain_gid}/{asset_path}","summary":"Create token","prefix":{"name":"post","color":"post"},"badges":[],"link":"/token/create-token","deprecated":false},{"title":"/tokens/{chain_gid}/{asset_path}","summary":"Get token","prefix":{"name":"get","color":"get"},"badges":[],"link":"/token/get-token","deprecated":false},{"title":"/tokens/{chain_gid}/{asset_path}/actions/trust","summary":"Trust token","prefix":{"name":"post","color":"post"},"badges":[],"link":"/token/trust-token","deprecated":false},{"title":"/tokens/{chain_gid}/{asset_path}/actions/untrust","summary":"Untrust token","prefix":{"name":"post","color":"post"},"badges":[],"link":"/token/untrust-token","deprecated":false}]}]}]}]}},{"type":"group","label":"Token Tags","link":"/apis/platform/api/token_tag","routeSlug":"/apis/platform/api/token_tag","items":[{"label":"List token tags","deprecated":false,"httpVerb":"get","isAdditionalOperation":false,"isWebhook":false,"type":"link","link":"/apis/platform/api/token_tag/list-token-tags","routeSlug":"/apis/platform/api/token_tag/list-token-tags","metadata":{"seo":{"title":"List token tags","description":"List token tags with pagination."}},"content":{"contentType":"item","itemVariant":"httpItem","meta":{"sourceId":"list-token-tags","name":"List token tags","isWebhook":false,"pointer":"/paths/~1token-tags/get","hasSamples":false},"children":[{"nodeType":"container","children":[{"nodeType":"header","level":2,"label":"List token tags","isWebhook":false,"showPageActions":true}],"panels":[]},{"nodeType":"container","children":[{"nodeType":"header","level":4,"label":"Request","labelTranslationKey":"request","deepLinkSuffix":"request"},{"nodeType":"markdoc","content":"List token tags with pagination."},{"nodeType":"security","requirements":[{"schemes":[{"name":"Auth","scopes":["api:token_tag:read"],"type":"apiKey","in":"header","paramName":"X-Api-Key","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"API key for authenticating requests. Include your key in the "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"X-Api-Key"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" header. Keys can be created in the Vilna Dashboard or via the Management API. The scopes listed per operation indicate which permissions the key must have."},"children":[]}]}]}]}]}]},{"nodeType":"item-content","variant":"query","label":"Query","labelTranslationKey":"query","parameters":[{"name":"limit","in":"query","schemaId":"schema_0","description":"Maximum number of items to return."},{"name":"page","in":"query","schemaId":"schema_1","description":"Page number for pagination."},{"name":"sort_by","in":"query","schemaId":"schema_32","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Field to sort results by. Use "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"-"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" prefix for descending order."},"children":[]}]}]}]},{"name":"search","in":"query","schemaId":"schema_33","description":"Filter token tags by name (partial match, case-insensitive).","example":"Stablecoins"}],"pointer":"/paths/~1token-tags/get/parameters"}],"panels":[{"children":[{"kind":"code-sample","source":{"kind":"code-sample","operationType":"http","method":"GET","path":"/token-tags","servers":[{"url":"/_mock/apis/platform/api","description":"Mock server","isMockServer":true},{"url":"https://api.vilna.io/v2","description":"Vilna API."}],"parameters":{"path":[],"query":[{"name":"limit","in":"query","required":false,"example":20,"schemaId":"schema_0"},{"name":"page","in":"query","required":false,"example":1,"schemaId":"schema_1"},{"name":"sort_by","in":"query","required":false,"example":"created_at","schemaId":"schema_32"},{"name":"search","in":"query","required":false,"example":"Stablecoins","schemaId":"schema_33"}],"querystring":[],"header":[],"cookie":[]},"security":[{"schemes":[{"id":"Auth","type":"apiKey","name":"X-Api-Key","in":"header"}],"scopes":["api:token_tag:read"]}],"responseCodes":["200","400","401","403","503","default"],"pointer":"/token-tags","href":"token_tag/list-token-tags","openApiOperationId":"list-token-tags","summary":"List token tags"},"isWebhook":false,"hideReplay":false,"servers":[{"url":"/_mock/apis/platform/api","description":"Mock server","isMockServer":true},{"url":"https://api.vilna.io/v2","description":"Vilna API."}],"examples":[]}]}]},{"nodeType":"container","children":[{"nodeType":"header","level":4,"label":"Responses","labelTranslationKey":"responses","deepLinkSuffix":"responses"},{"nodeType":"item-content","variant":"responses","responses":[{"code":"200","description":"List of token tags with pagination.","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"schema_81"}},"schemaId":"schema_81"},{"code":"400","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Bad request (e.g., missing or invalid fields). Invalid text may be reported as address.label_invalid, address.meta_invalid, public_key.label_invalid, invoice.comment_invalid, invoice.metadata_invalid."},"children":[]}]}]}],"mediaType":"application/problem+json","mediaTypes":["application/problem+json"],"mediaTypeContent":{"application/problem+json":{"schemaId":"components/schemas/InvalidRequestProblem","exampleIds":["paths/~1token-tags/get/responses/400/content/application~1problem+json/examples/malformed_json"]}},"schemaId":"components/schemas/InvalidRequestProblem","exampleIds":["paths/~1token-tags/get/responses/400/content/application~1problem+json/examples/malformed_json"]},{"code":"401","description":"Missing or invalid authentication credentials.","mediaType":"application/problem+json","mediaTypes":["application/problem+json"],"mediaTypeContent":{"application/problem+json":{"schemaId":"components/schemas/UnauthorizedProblem","exampleIds":["paths/~1token-tags/get/responses/401/content/application~1problem+json/examples/service_authentication_denied"]}},"schemaId":"components/schemas/UnauthorizedProblem","exampleIds":["paths/~1token-tags/get/responses/401/content/application~1problem+json/examples/service_authentication_denied"]},{"code":"403","description":"Insufficient permissions.","mediaType":"application/problem+json","mediaTypes":["application/problem+json"],"mediaTypeContent":{"application/problem+json":{"schemaId":"components/schemas/ForbiddenProblem","exampleIds":["paths/~1token-tags/get/responses/403/content/application~1problem+json/examples/insufficient_permissions"]}},"schemaId":"components/schemas/ForbiddenProblem","exampleIds":["paths/~1token-tags/get/responses/403/content/application~1problem+json/examples/insufficient_permissions"]},{"code":"503","description":"The operation is temporarily unavailable. Please try again later.","mediaType":"application/problem+json","mediaTypes":["application/problem+json"],"mediaTypeContent":{"application/problem+json":{"schemaId":"components/schemas/Problem","exampleIds":["paths/~1token-tags/get/responses/503/content/application~1problem+json/examples/temporarily_unavailable"]}},"schemaId":"components/schemas/Problem","exampleIds":["paths/~1token-tags/get/responses/503/content/application~1problem+json/examples/temporarily_unavailable"]},{"code":"default","description":"Unexpected error.","mediaType":"application/problem+json","mediaTypes":["application/problem+json"],"mediaTypeContent":{"application/problem+json":{"schemaId":"components/schemas/Problem"}},"schemaId":"components/schemas/Problem"}],"pointer":"/paths/~1token-tags/get/responses"}],"panels":[{"children":[{"kind":"response","responseCodes":[{"code":"200","schemaId":"schema_81","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"schema_81"}}},{"code":"400","schemaId":"components/schemas/InvalidRequestProblem","exampleIds":["paths/~1token-tags/get/responses/400/content/application~1problem+json/examples/malformed_json"],"mediaTypes":["application/problem+json"],"mediaTypeContent":{"application/problem+json":{"schemaId":"components/schemas/InvalidRequestProblem","exampleIds":["paths/~1token-tags/get/responses/400/content/application~1problem+json/examples/malformed_json"]}}},{"code":"401","schemaId":"components/schemas/UnauthorizedProblem","exampleIds":["paths/~1token-tags/get/responses/401/content/application~1problem+json/examples/service_authentication_denied"],"mediaTypes":["application/problem+json"],"mediaTypeContent":{"application/problem+json":{"schemaId":"components/schemas/UnauthorizedProblem","exampleIds":["paths/~1token-tags/get/responses/401/content/application~1problem+json/examples/service_authentication_denied"]}}},{"code":"403","schemaId":"components/schemas/ForbiddenProblem","exampleIds":["paths/~1token-tags/get/responses/403/content/application~1problem+json/examples/insufficient_permissions"],"mediaTypes":["application/problem+json"],"mediaTypeContent":{"application/problem+json":{"schemaId":"components/schemas/ForbiddenProblem","exampleIds":["paths/~1token-tags/get/responses/403/content/application~1problem+json/examples/insufficient_permissions"]}}},{"code":"503","schemaId":"components/schemas/Problem","exampleIds":["paths/~1token-tags/get/responses/503/content/application~1problem+json/examples/temporarily_unavailable"],"mediaTypes":["application/problem+json"],"mediaTypeContent":{"application/problem+json":{"schemaId":"components/schemas/Problem","exampleIds":["paths/~1token-tags/get/responses/503/content/application~1problem+json/examples/temporarily_unavailable"]}}},{"code":"default","schemaId":"components/schemas/Problem","mediaTypes":["application/problem+json"],"mediaTypeContent":{"application/problem+json":{"schemaId":"components/schemas/Problem"}}}],"examples":[]}]}]},{"nodeType":"container","children":[{"nodeType":"feedback","pageSlug":"/token_tag/list-token-tags"}],"panels":[]}]},"httpPath":"/token-tags"},{"label":"Create token tag","deprecated":false,"httpVerb":"post","isAdditionalOperation":false,"isWebhook":false,"type":"link","link":"/apis/platform/api/token_tag/create-token-tag","routeSlug":"/apis/platform/api/token_tag/create-token-tag","metadata":{"seo":{"title":"Create token tag","description":"Create a named collection of tokens within a project. Tag names are unique per project (case-insensitive). Creating a tag whose name already exists returns the existing tag."}},"content":{"contentType":"item","itemVariant":"httpItem","meta":{"sourceId":"create-token-tag","name":"Create token tag","isWebhook":false,"pointer":"/paths/~1token-tags/post","hasSamples":true},"children":[{"nodeType":"container","children":[{"nodeType":"header","level":2,"label":"Create token tag","isWebhook":false,"showPageActions":true}],"panels":[]},{"nodeType":"container","children":[{"nodeType":"header","level":4,"label":"Request","labelTranslationKey":"request","deepLinkSuffix":"request"},{"nodeType":"markdoc","content":"Create a named collection of tokens within a project. Tag names are\nunique per project (case-insensitive). Creating a tag whose name already\nexists returns the existing tag.\n"},{"nodeType":"security","requirements":[{"schemes":[{"name":"Auth","scopes":["api:token_tag:write"],"type":"apiKey","in":"header","paramName":"X-Api-Key","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"API key for authenticating requests. Include your key in the "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"X-Api-Key"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" header. Keys can be created in the Vilna Dashboard or via the Management API. The scopes listed per operation indicate which permissions the key must have."},"children":[]}]}]}]}]}]},{"nodeType":"item-content","variant":"headers","label":"Headers","labelTranslationKey":"header","parameters":[{"name":"Idempotency-Key","in":"header","schemaId":"schema_14","description":"Case-sensitive opaque key for one mutation intent. Send exactly one header occurrence containing 1 to 128 visible ASCII bytes (0x21..0x7e). Commas are literal data; do not trim, lowercase or require UUID syntax. Reuse the same key for retries, with current authorization checked on every attempt. Repeated header occurrences are rejected.\n","required":true}],"pointer":"/paths/~1token-tags/post/parameters"},{"nodeType":"item-content","variant":"body","label":"Request Body","labelTranslationKey":"body","required":true,"mediaTypes":["application/json"],"mediaTypeSchemas":{"application/json":{"schemaId":"components/schemas/CreateTokenTagRequest"}},"schemaId":"components/schemas/CreateTokenTagRequest","pointer":"/paths/~1token-tags/post/requestBody"}],"panels":[{"children":[{"kind":"code-sample","source":{"kind":"code-sample","operationType":"http","method":"POST","path":"/token-tags","servers":[{"url":"/_mock/apis/platform/api","description":"Mock server","isMockServer":true},{"url":"https://api.vilna.io/v2","description":"Vilna API."}],"parameters":{"path":[],"query":[],"querystring":[],"header":[{"name":"Idempotency-Key","in":"header","required":true,"schemaId":"schema_14"}],"cookie":[]},"security":[{"schemes":[{"id":"Auth","type":"apiKey","name":"X-Api-Key","in":"header"}],"scopes":["api:token_tag:write"]}],"requestBody":{"application/json":{"schemaId":"components/schemas/CreateTokenTagRequest"}},"responseCodes":["200","201","400","401","403","409","429","503","default"],"pointer":"/token-tags","href":"token_tag/create-token-tag","openApiOperationId":"create-token-tag","summary":"Create token tag"},"isWebhook":false,"hideReplay":false,"servers":[{"url":"/_mock/apis/platform/api","description":"Mock server","isMockServer":true},{"url":"https://api.vilna.io/v2","description":"Vilna API."}],"schemaId":"components/schemas/CreateTokenTagRequest","mediaTypes":["application/json"],"mediaTypeSchemas":{"application/json":{"schemaId":"components/schemas/CreateTokenTagRequest"}},"examples":[]}]}]},{"nodeType":"container","children":[{"nodeType":"header","level":4,"label":"Responses","labelTranslationKey":"responses","deepLinkSuffix":"responses"},{"nodeType":"item-content","variant":"responses","responses":[{"code":"200","description":"Token tag details.","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"schema_82"}},"schemaId":"schema_82"},{"code":"201","description":"Token tag details.","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"schema_82"}},"schemaId":"schema_82"},{"code":"400","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Bad request (e.g., missing or invalid fields). Invalid text may be reported as address.label_invalid, address.meta_invalid, public_key.label_invalid, invoice.comment_invalid, invoice.metadata_invalid."},"children":[]}]}]}],"mediaType":"application/problem+json","mediaTypes":["application/problem+json"],"mediaTypeContent":{"application/problem+json":{"schemaId":"components/schemas/InvalidRequestProblem","exampleIds":["paths/~1token-tags/post/responses/400/content/application~1problem+json/examples/malformed_json"]}},"schemaId":"components/schemas/InvalidRequestProblem","exampleIds":["paths/~1token-tags/post/responses/400/content/application~1problem+json/examples/malformed_json"]},{"code":"401","description":"Missing or invalid authentication credentials.","mediaType":"application/problem+json","mediaTypes":["application/problem+json"],"mediaTypeContent":{"application/problem+json":{"schemaId":"components/schemas/UnauthorizedProblem","exampleIds":["paths/~1token-tags/post/responses/401/content/application~1problem+json/examples/service_authentication_denied"]}},"schemaId":"components/schemas/UnauthorizedProblem","exampleIds":["paths/~1token-tags/post/responses/401/content/application~1problem+json/examples/service_authentication_denied"]},{"code":"403","description":"Insufficient permissions.","mediaType":"application/problem+json","mediaTypes":["application/problem+json"],"mediaTypeContent":{"application/problem+json":{"schemaId":"components/schemas/ForbiddenProblem","exampleIds":["paths/~1token-tags/post/responses/403/content/application~1problem+json/examples/insufficient_permissions"]}},"schemaId":"components/schemas/ForbiddenProblem","exampleIds":["paths/~1token-tags/post/responses/403/content/application~1problem+json/examples/insufficient_permissions"]},{"code":"409","description":"Request conflicts with the current resource state.","mediaType":"application/problem+json","mediaTypes":["application/problem+json"],"mediaTypeContent":{"application/problem+json":{"schemaId":"components/schemas/ConflictProblem","exampleIds":["paths/~1token-tags/post/responses/409/content/application~1problem+json/examples/address_occupied","paths/~1token-tags/post/responses/409/content/application~1problem+json/examples/address_in_use","paths/~1token-tags/post/responses/409/content/application~1problem+json/examples/subscription_v1_conflict","paths/~1token-tags/post/responses/409/content/application~1problem+json/examples/notification_send_in_progress","paths/~1token-tags/post/responses/409/content/application~1problem+json/examples/notification_payload_unavailable","paths/~1token-tags/post/responses/409/content/application~1problem+json/examples/notification_test_resend_not_allowed"]}},"schemaId":"components/schemas/ConflictProblem","exampleIds":["paths/~1token-tags/post/responses/409/content/application~1problem+json/examples/address_occupied","paths/~1token-tags/post/responses/409/content/application~1problem+json/examples/address_in_use","paths/~1token-tags/post/responses/409/content/application~1problem+json/examples/subscription_v1_conflict","paths/~1token-tags/post/responses/409/content/application~1problem+json/examples/notification_send_in_progress","paths/~1token-tags/post/responses/409/content/application~1problem+json/examples/notification_payload_unavailable","paths/~1token-tags/post/responses/409/content/application~1problem+json/examples/notification_test_resend_not_allowed"]},{"code":"429","description":"Resource quota exceeded. The response includes the effective limit for this scope. The applicable code and limit depend on the operation; examples illustrate different limits.","mediaType":"application/problem+json","mediaTypes":["application/problem+json"],"mediaTypeContent":{"application/problem+json":{"schemaId":"components/schemas/QuotaExceededProblem","exampleIds":["paths/~1token-tags/post/responses/429/content/application~1problem+json/examples/address_quota","paths/~1token-tags/post/responses/429/content/application~1problem+json/examples/creation_prohibited"]}},"schemaId":"components/schemas/QuotaExceededProblem","exampleIds":["paths/~1token-tags/post/responses/429/content/application~1problem+json/examples/address_quota","paths/~1token-tags/post/responses/429/content/application~1problem+json/examples/creation_prohibited"]},{"code":"503","description":"The operation is temporarily unavailable. Please try again later.","mediaType":"application/problem+json","mediaTypes":["application/problem+json"],"mediaTypeContent":{"application/problem+json":{"schemaId":"components/schemas/Problem","exampleIds":["paths/~1token-tags/post/responses/503/content/application~1problem+json/examples/temporarily_unavailable"]}},"schemaId":"components/schemas/Problem","exampleIds":["paths/~1token-tags/post/responses/503/content/application~1problem+json/examples/temporarily_unavailable"]},{"code":"default","description":"Unexpected error.","mediaType":"application/problem+json","mediaTypes":["application/problem+json"],"mediaTypeContent":{"application/problem+json":{"schemaId":"components/schemas/Problem"}},"schemaId":"components/schemas/Problem"}],"pointer":"/paths/~1token-tags/post/responses"}],"panels":[{"children":[{"kind":"response","responseCodes":[{"code":"200","schemaId":"schema_82","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"schema_82"}}},{"code":"201","schemaId":"schema_82","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"schema_82"}}},{"code":"400","schemaId":"components/schemas/InvalidRequestProblem","exampleIds":["paths/~1token-tags/post/responses/400/content/application~1problem+json/examples/malformed_json"],"mediaTypes":["application/problem+json"],"mediaTypeContent":{"application/problem+json":{"schemaId":"components/schemas/InvalidRequestProblem","exampleIds":["paths/~1token-tags/post/responses/400/content/application~1problem+json/examples/malformed_json"]}}},{"code":"401","schemaId":"components/schemas/UnauthorizedProblem","exampleIds":["paths/~1token-tags/post/responses/401/content/application~1problem+json/examples/service_authentication_denied"],"mediaTypes":["application/problem+json"],"mediaTypeContent":{"application/problem+json":{"schemaId":"components/schemas/UnauthorizedProblem","exampleIds":["paths/~1token-tags/post/responses/401/content/application~1problem+json/examples/service_authentication_denied"]}}},{"code":"403","schemaId":"components/schemas/ForbiddenProblem","exampleIds":["paths/~1token-tags/post/responses/403/content/application~1problem+json/examples/insufficient_permissions"],"mediaTypes":["application/problem+json"],"mediaTypeContent":{"application/problem+json":{"schemaId":"components/schemas/ForbiddenProblem","exampleIds":["paths/~1token-tags/post/responses/403/content/application~1problem+json/examples/insufficient_permissions"]}}},{"code":"409","schemaId":"components/schemas/ConflictProblem","exampleIds":["paths/~1token-tags/post/responses/409/content/application~1problem+json/examples/address_occupied","paths/~1token-tags/post/responses/409/content/application~1problem+json/examples/address_in_use","paths/~1token-tags/post/responses/409/content/application~1problem+json/examples/subscription_v1_conflict","paths/~1token-tags/post/responses/409/content/application~1problem+json/examples/notification_send_in_progress","paths/~1token-tags/post/responses/409/content/application~1problem+json/examples/notification_payload_unavailable","paths/~1token-tags/post/responses/409/content/application~1problem+json/examples/notification_test_resend_not_allowed"],"mediaTypes":["application/problem+json"],"mediaTypeContent":{"application/problem+json":{"schemaId":"components/schemas/ConflictProblem","exampleIds":["paths/~1token-tags/post/responses/409/content/application~1problem+json/examples/address_occupied","paths/~1token-tags/post/responses/409/content/application~1problem+json/examples/address_in_use","paths/~1token-tags/post/responses/409/content/application~1problem+json/examples/subscription_v1_conflict","paths/~1token-tags/post/responses/409/content/application~1problem+json/examples/notification_send_in_progress","paths/~1token-tags/post/responses/409/content/application~1problem+json/examples/notification_payload_unavailable","paths/~1token-tags/post/responses/409/content/application~1problem+json/examples/notification_test_resend_not_allowed"]}}},{"code":"429","schemaId":"components/schemas/QuotaExceededProblem","exampleIds":["paths/~1token-tags/post/responses/429/content/application~1problem+json/examples/address_quota","paths/~1token-tags/post/responses/429/content/application~1problem+json/examples/creation_prohibited"],"mediaTypes":["application/problem+json"],"mediaTypeContent":{"application/problem+json":{"schemaId":"components/schemas/QuotaExceededProblem","exampleIds":["paths/~1token-tags/post/responses/429/content/application~1problem+json/examples/address_quota","paths/~1token-tags/post/responses/429/content/application~1problem+json/examples/creation_prohibited"]}}},{"code":"503","schemaId":"components/schemas/Problem","exampleIds":["paths/~1token-tags/post/responses/503/content/application~1problem+json/examples/temporarily_unavailable"],"mediaTypes":["application/problem+json"],"mediaTypeContent":{"application/problem+json":{"schemaId":"components/schemas/Problem","exampleIds":["paths/~1token-tags/post/responses/503/content/application~1problem+json/examples/temporarily_unavailable"]}}},{"code":"default","schemaId":"components/schemas/Problem","mediaTypes":["application/problem+json"],"mediaTypeContent":{"application/problem+json":{"schemaId":"components/schemas/Problem"}}}],"examples":[]}]}]},{"nodeType":"container","children":[{"nodeType":"feedback","pageSlug":"/token_tag/create-token-tag"}],"panels":[]}]},"httpPath":"/token-tags"},{"label":"Get token tag","deprecated":false,"httpVerb":"get","isAdditionalOperation":false,"isWebhook":false,"type":"link","link":"/apis/platform/api/token_tag/get-token-tag","routeSlug":"/apis/platform/api/token_tag/get-token-tag","metadata":{"seo":{"title":"Get token tag","description":"Get a token tag."}},"content":{"contentType":"item","itemVariant":"httpItem","meta":{"sourceId":"get-token-tag","name":"Get token tag","isWebhook":false,"pointer":"/paths/~1token-tags~1{token_tag_id}/get","hasSamples":false},"children":[{"nodeType":"container","children":[{"nodeType":"header","level":2,"label":"Get token tag","isWebhook":false,"showPageActions":true}],"panels":[]},{"nodeType":"container","children":[{"nodeType":"header","level":4,"label":"Request","labelTranslationKey":"request","deepLinkSuffix":"request"},{"nodeType":"markdoc","content":"Get a token tag."},{"nodeType":"security","requirements":[{"schemes":[{"name":"Auth","scopes":["api:token_tag:read"],"type":"apiKey","in":"header","paramName":"X-Api-Key","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"API key for authenticating requests. Include your key in the "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"X-Api-Key"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" header. Keys can be created in the Vilna Dashboard or via the Management API. The scopes listed per operation indicate which permissions the key must have."},"children":[]}]}]}]}]}]},{"nodeType":"item-content","variant":"path","label":"Path","labelTranslationKey":"path","parameters":[{"name":"token_tag_id","in":"path","schemaId":"schema_17","description":"Unique identifier (UUID) of the token tag.","required":true}],"pointer":"/paths/~1token-tags~1{token_tag_id}/get/parameters"}],"panels":[{"children":[{"kind":"code-sample","source":{"kind":"code-sample","operationType":"http","method":"GET","path":"/token-tags/{token_tag_id}","servers":[{"url":"/_mock/apis/platform/api","description":"Mock server","isMockServer":true},{"url":"https://api.vilna.io/v2","description":"Vilna API."}],"parameters":{"path":[{"name":"token_tag_id","in":"path","required":true,"example":"550e8400-e29b-41d4-a716-446655440000","schemaId":"components/schemas/UUID"}],"query":[],"querystring":[],"header":[],"cookie":[]},"security":[{"schemes":[{"id":"Auth","type":"apiKey","name":"X-Api-Key","in":"header"}],"scopes":["api:token_tag:read"]}],"responseCodes":["200","400","401","403","404","503","default"],"pointer":"/token-tags/{token_tag_id}","href":"token_tag/get-token-tag","openApiOperationId":"get-token-tag","summary":"Get token tag"},"isWebhook":false,"hideReplay":false,"servers":[{"url":"/_mock/apis/platform/api","description":"Mock server","isMockServer":true},{"url":"https://api.vilna.io/v2","description":"Vilna API."}],"examples":[]}]}]},{"nodeType":"container","children":[{"nodeType":"header","level":4,"label":"Responses","labelTranslationKey":"responses","deepLinkSuffix":"responses"},{"nodeType":"item-content","variant":"responses","responses":[{"code":"200","description":"Token tag details.","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"schema_82"}},"schemaId":"schema_82"},{"code":"400","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Bad request (e.g., missing or invalid fields). Invalid text may be reported as address.label_invalid, address.meta_invalid, public_key.label_invalid, invoice.comment_invalid, invoice.metadata_invalid."},"children":[]}]}]}],"mediaType":"application/problem+json","mediaTypes":["application/problem+json"],"mediaTypeContent":{"application/problem+json":{"schemaId":"components/schemas/InvalidRequestProblem","exampleIds":["paths/~1token-tags~1{token_tag_id}/get/responses/400/content/application~1problem+json/examples/malformed_json"]}},"schemaId":"components/schemas/InvalidRequestProblem","exampleIds":["paths/~1token-tags~1{token_tag_id}/get/responses/400/content/application~1problem+json/examples/malformed_json"]},{"code":"401","description":"Missing or invalid authentication credentials.","mediaType":"application/problem+json","mediaTypes":["application/problem+json"],"mediaTypeContent":{"application/problem+json":{"schemaId":"components/schemas/UnauthorizedProblem","exampleIds":["paths/~1token-tags~1{token_tag_id}/get/responses/401/content/application~1problem+json/examples/service_authentication_denied"]}},"schemaId":"components/schemas/UnauthorizedProblem","exampleIds":["paths/~1token-tags~1{token_tag_id}/get/responses/401/content/application~1problem+json/examples/service_authentication_denied"]},{"code":"403","description":"Insufficient permissions.","mediaType":"application/problem+json","mediaTypes":["application/problem+json"],"mediaTypeContent":{"application/problem+json":{"schemaId":"components/schemas/ForbiddenProblem","exampleIds":["paths/~1token-tags~1{token_tag_id}/get/responses/403/content/application~1problem+json/examples/insufficient_permissions"]}},"schemaId":"components/schemas/ForbiddenProblem","exampleIds":["paths/~1token-tags~1{token_tag_id}/get/responses/403/content/application~1problem+json/examples/insufficient_permissions"]},{"code":"404","description":"Requested resource does not exist.","mediaType":"application/problem+json","mediaTypes":["application/problem+json"],"mediaTypeContent":{"application/problem+json":{"schemaId":"components/schemas/NotFoundProblem","exampleIds":["paths/~1token-tags~1{token_tag_id}/get/responses/404/content/application~1problem+json/examples/address_not_found","paths/~1token-tags~1{token_tag_id}/get/responses/404/content/application~1problem+json/examples/invoice_not_found"]}},"schemaId":"components/schemas/NotFoundProblem","exampleIds":["paths/~1token-tags~1{token_tag_id}/get/responses/404/content/application~1problem+json/examples/address_not_found","paths/~1token-tags~1{token_tag_id}/get/responses/404/content/application~1problem+json/examples/invoice_not_found"]},{"code":"503","description":"The operation is temporarily unavailable. Please try again later.","mediaType":"application/problem+json","mediaTypes":["application/problem+json"],"mediaTypeContent":{"application/problem+json":{"schemaId":"components/schemas/Problem","exampleIds":["paths/~1token-tags~1{token_tag_id}/get/responses/503/content/application~1problem+json/examples/temporarily_unavailable"]}},"schemaId":"components/schemas/Problem","exampleIds":["paths/~1token-tags~1{token_tag_id}/get/responses/503/content/application~1problem+json/examples/temporarily_unavailable"]},{"code":"default","description":"Unexpected error.","mediaType":"application/problem+json","mediaTypes":["application/problem+json"],"mediaTypeContent":{"application/problem+json":{"schemaId":"components/schemas/Problem"}},"schemaId":"components/schemas/Problem"}],"pointer":"/paths/~1token-tags~1{token_tag_id}/get/responses"}],"panels":[{"children":[{"kind":"response","responseCodes":[{"code":"200","schemaId":"schema_82","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"schema_82"}}},{"code":"400","schemaId":"components/schemas/InvalidRequestProblem","exampleIds":["paths/~1token-tags~1{token_tag_id}/get/responses/400/content/application~1problem+json/examples/malformed_json"],"mediaTypes":["application/problem+json"],"mediaTypeContent":{"application/problem+json":{"schemaId":"components/schemas/InvalidRequestProblem","exampleIds":["paths/~1token-tags~1{token_tag_id}/get/responses/400/content/application~1problem+json/examples/malformed_json"]}}},{"code":"401","schemaId":"components/schemas/UnauthorizedProblem","exampleIds":["paths/~1token-tags~1{token_tag_id}/get/responses/401/content/application~1problem+json/examples/service_authentication_denied"],"mediaTypes":["application/problem+json"],"mediaTypeContent":{"application/problem+json":{"schemaId":"components/schemas/UnauthorizedProblem","exampleIds":["paths/~1token-tags~1{token_tag_id}/get/responses/401/content/application~1problem+json/examples/service_authentication_denied"]}}},{"code":"403","schemaId":"components/schemas/ForbiddenProblem","exampleIds":["paths/~1token-tags~1{token_tag_id}/get/responses/403/content/application~1problem+json/examples/insufficient_permissions"],"mediaTypes":["application/problem+json"],"mediaTypeContent":{"application/problem+json":{"schemaId":"components/schemas/ForbiddenProblem","exampleIds":["paths/~1token-tags~1{token_tag_id}/get/responses/403/content/application~1problem+json/examples/insufficient_permissions"]}}},{"code":"404","schemaId":"components/schemas/NotFoundProblem","exampleIds":["paths/~1token-tags~1{token_tag_id}/get/responses/404/content/application~1problem+json/examples/address_not_found","paths/~1token-tags~1{token_tag_id}/get/responses/404/content/application~1problem+json/examples/invoice_not_found"],"mediaTypes":["application/problem+json"],"mediaTypeContent":{"application/problem+json":{"schemaId":"components/schemas/NotFoundProblem","exampleIds":["paths/~1token-tags~1{token_tag_id}/get/responses/404/content/application~1problem+json/examples/address_not_found","paths/~1token-tags~1{token_tag_id}/get/responses/404/content/application~1problem+json/examples/invoice_not_found"]}}},{"code":"503","schemaId":"components/schemas/Problem","exampleIds":["paths/~1token-tags~1{token_tag_id}/get/responses/503/content/application~1problem+json/examples/temporarily_unavailable"],"mediaTypes":["application/problem+json"],"mediaTypeContent":{"application/problem+json":{"schemaId":"components/schemas/Problem","exampleIds":["paths/~1token-tags~1{token_tag_id}/get/responses/503/content/application~1problem+json/examples/temporarily_unavailable"]}}},{"code":"default","schemaId":"components/schemas/Problem","mediaTypes":["application/problem+json"],"mediaTypeContent":{"application/problem+json":{"schemaId":"components/schemas/Problem"}}}],"examples":[]}]}]},{"nodeType":"container","children":[{"nodeType":"feedback","pageSlug":"/token_tag/get-token-tag"}],"panels":[]}]},"httpPath":"/token-tags/{token_tag_id}"},{"label":"Update token tag","deprecated":false,"httpVerb":"patch","isAdditionalOperation":false,"isWebhook":false,"type":"link","link":"/apis/platform/api/token_tag/patch-token-tag","routeSlug":"/apis/platform/api/token_tag/patch-token-tag","metadata":{"seo":{"title":"Update token tag","description":"Rename a token tag."}},"content":{"contentType":"item","itemVariant":"httpItem","meta":{"sourceId":"patch-token-tag","name":"Update token tag","isWebhook":false,"pointer":"/paths/~1token-tags~1{token_tag_id}/patch","hasSamples":true},"children":[{"nodeType":"container","children":[{"nodeType":"header","level":2,"label":"Update token tag","isWebhook":false,"showPageActions":true}],"panels":[]},{"nodeType":"container","children":[{"nodeType":"header","level":4,"label":"Request","labelTranslationKey":"request","deepLinkSuffix":"request"},{"nodeType":"markdoc","content":"Rename a token tag."},{"nodeType":"security","requirements":[{"schemes":[{"name":"Auth","scopes":["api:token_tag:write"],"type":"apiKey","in":"header","paramName":"X-Api-Key","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"API key for authenticating requests. Include your key in the "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"X-Api-Key"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" header. Keys can be created in the Vilna Dashboard or via the Management API. The scopes listed per operation indicate which permissions the key must have."},"children":[]}]}]}]}]}]},{"nodeType":"item-content","variant":"path","label":"Path","labelTranslationKey":"path","parameters":[{"name":"token_tag_id","in":"path","schemaId":"schema_17","description":"Unique identifier (UUID) of the token tag.","required":true}],"pointer":"/paths/~1token-tags~1{token_tag_id}/patch/parameters"},{"nodeType":"item-content","variant":"headers","label":"Headers","labelTranslationKey":"header","parameters":[{"name":"Idempotency-Key","in":"header","schemaId":"schema_14","description":"Case-sensitive opaque key for one mutation intent. Send exactly one header occurrence containing 1 to 128 visible ASCII bytes (0x21..0x7e). Commas are literal data; do not trim, lowercase or require UUID syntax. Reuse the same key for retries, with current authorization checked on every attempt. Repeated header occurrences are rejected.\n","required":true}],"pointer":"/paths/~1token-tags~1{token_tag_id}/patch/parameters"},{"nodeType":"item-content","variant":"body","label":"Request Body","labelTranslationKey":"body","required":true,"mediaTypes":["application/json"],"mediaTypeSchemas":{"application/json":{"schemaId":"components/schemas/UpdateTokenTagRequest"}},"schemaId":"components/schemas/UpdateTokenTagRequest","pointer":"/paths/~1token-tags~1{token_tag_id}/patch/requestBody"}],"panels":[{"children":[{"kind":"code-sample","source":{"kind":"code-sample","operationType":"http","method":"PATCH","path":"/token-tags/{token_tag_id}","servers":[{"url":"/_mock/apis/platform/api","description":"Mock server","isMockServer":true},{"url":"https://api.vilna.io/v2","description":"Vilna API."}],"parameters":{"path":[{"name":"token_tag_id","in":"path","required":true,"example":"550e8400-e29b-41d4-a716-446655440000","schemaId":"components/schemas/UUID"}],"query":[],"querystring":[],"header":[{"name":"Idempotency-Key","in":"header","required":true,"schemaId":"schema_14"}],"cookie":[]},"security":[{"schemes":[{"id":"Auth","type":"apiKey","name":"X-Api-Key","in":"header"}],"scopes":["api:token_tag:write"]}],"requestBody":{"application/json":{"schemaId":"components/schemas/UpdateTokenTagRequest"}},"responseCodes":["200","400","401","403","404","409","503","default"],"pointer":"/token-tags/{token_tag_id}","href":"token_tag/patch-token-tag","openApiOperationId":"patch-token-tag","summary":"Update token tag"},"isWebhook":false,"hideReplay":false,"servers":[{"url":"/_mock/apis/platform/api","description":"Mock server","isMockServer":true},{"url":"https://api.vilna.io/v2","description":"Vilna API."}],"schemaId":"components/schemas/UpdateTokenTagRequest","mediaTypes":["application/json"],"mediaTypeSchemas":{"application/json":{"schemaId":"components/schemas/UpdateTokenTagRequest"}},"examples":[]}]}]},{"nodeType":"container","children":[{"nodeType":"header","level":4,"label":"Responses","labelTranslationKey":"responses","deepLinkSuffix":"responses"},{"nodeType":"item-content","variant":"responses","responses":[{"code":"200","description":"Token tag details.","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"schema_82"}},"schemaId":"schema_82"},{"code":"400","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Bad request (e.g., missing or invalid fields). Invalid text may be reported as address.label_invalid, address.meta_invalid, public_key.label_invalid, invoice.comment_invalid, invoice.metadata_invalid."},"children":[]}]}]}],"mediaType":"application/problem+json","mediaTypes":["application/problem+json"],"mediaTypeContent":{"application/problem+json":{"schemaId":"components/schemas/InvalidRequestProblem","exampleIds":["paths/~1token-tags~1{token_tag_id}/patch/responses/400/content/application~1problem+json/examples/malformed_json"]}},"schemaId":"components/schemas/InvalidRequestProblem","exampleIds":["paths/~1token-tags~1{token_tag_id}/patch/responses/400/content/application~1problem+json/examples/malformed_json"]},{"code":"401","description":"Missing or invalid authentication credentials.","mediaType":"application/problem+json","mediaTypes":["application/problem+json"],"mediaTypeContent":{"application/problem+json":{"schemaId":"components/schemas/UnauthorizedProblem","exampleIds":["paths/~1token-tags~1{token_tag_id}/patch/responses/401/content/application~1problem+json/examples/service_authentication_denied"]}},"schemaId":"components/schemas/UnauthorizedProblem","exampleIds":["paths/~1token-tags~1{token_tag_id}/patch/responses/401/content/application~1problem+json/examples/service_authentication_denied"]},{"code":"403","description":"Insufficient permissions.","mediaType":"application/problem+json","mediaTypes":["application/problem+json"],"mediaTypeContent":{"application/problem+json":{"schemaId":"components/schemas/ForbiddenProblem","exampleIds":["paths/~1token-tags~1{token_tag_id}/patch/responses/403/content/application~1problem+json/examples/insufficient_permissions"]}},"schemaId":"components/schemas/ForbiddenProblem","exampleIds":["paths/~1token-tags~1{token_tag_id}/patch/responses/403/content/application~1problem+json/examples/insufficient_permissions"]},{"code":"404","description":"Requested resource does not exist.","mediaType":"application/problem+json","mediaTypes":["application/problem+json"],"mediaTypeContent":{"application/problem+json":{"schemaId":"components/schemas/NotFoundProblem","exampleIds":["paths/~1token-tags~1{token_tag_id}/patch/responses/404/content/application~1problem+json/examples/address_not_found","paths/~1token-tags~1{token_tag_id}/patch/responses/404/content/application~1problem+json/examples/invoice_not_found"]}},"schemaId":"components/schemas/NotFoundProblem","exampleIds":["paths/~1token-tags~1{token_tag_id}/patch/responses/404/content/application~1problem+json/examples/address_not_found","paths/~1token-tags~1{token_tag_id}/patch/responses/404/content/application~1problem+json/examples/invoice_not_found"]},{"code":"409","description":"Request conflicts with the current resource state.","mediaType":"application/problem+json","mediaTypes":["application/problem+json"],"mediaTypeContent":{"application/problem+json":{"schemaId":"components/schemas/ConflictProblem","exampleIds":["paths/~1token-tags~1{token_tag_id}/patch/responses/409/content/application~1problem+json/examples/address_occupied","paths/~1token-tags~1{token_tag_id}/patch/responses/409/content/application~1problem+json/examples/address_in_use","paths/~1token-tags~1{token_tag_id}/patch/responses/409/content/application~1problem+json/examples/subscription_v1_conflict","paths/~1token-tags~1{token_tag_id}/patch/responses/409/content/application~1problem+json/examples/notification_send_in_progress","paths/~1token-tags~1{token_tag_id}/patch/responses/409/content/application~1problem+json/examples/notification_payload_unavailable","paths/~1token-tags~1{token_tag_id}/patch/responses/409/content/application~1problem+json/examples/notification_test_resend_not_allowed"]}},"schemaId":"components/schemas/ConflictProblem","exampleIds":["paths/~1token-tags~1{token_tag_id}/patch/responses/409/content/application~1problem+json/examples/address_occupied","paths/~1token-tags~1{token_tag_id}/patch/responses/409/content/application~1problem+json/examples/address_in_use","paths/~1token-tags~1{token_tag_id}/patch/responses/409/content/application~1problem+json/examples/subscription_v1_conflict","paths/~1token-tags~1{token_tag_id}/patch/responses/409/content/application~1problem+json/examples/notification_send_in_progress","paths/~1token-tags~1{token_tag_id}/patch/responses/409/content/application~1problem+json/examples/notification_payload_unavailable","paths/~1token-tags~1{token_tag_id}/patch/responses/409/content/application~1problem+json/examples/notification_test_resend_not_allowed"]},{"code":"503","description":"The operation is temporarily unavailable. Please try again later.","mediaType":"application/problem+json","mediaTypes":["application/problem+json"],"mediaTypeContent":{"application/problem+json":{"schemaId":"components/schemas/Problem","exampleIds":["paths/~1token-tags~1{token_tag_id}/patch/responses/503/content/application~1problem+json/examples/temporarily_unavailable"]}},"schemaId":"components/schemas/Problem","exampleIds":["paths/~1token-tags~1{token_tag_id}/patch/responses/503/content/application~1problem+json/examples/temporarily_unavailable"]},{"code":"default","description":"Unexpected error.","mediaType":"application/problem+json","mediaTypes":["application/problem+json"],"mediaTypeContent":{"application/problem+json":{"schemaId":"components/schemas/Problem"}},"schemaId":"components/schemas/Problem"}],"pointer":"/paths/~1token-tags~1{token_tag_id}/patch/responses"}],"panels":[{"children":[{"kind":"response","responseCodes":[{"code":"200","schemaId":"schema_82","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"schema_82"}}},{"code":"400","schemaId":"components/schemas/InvalidRequestProblem","exampleIds":["paths/~1token-tags~1{token_tag_id}/patch/responses/400/content/application~1problem+json/examples/malformed_json"],"mediaTypes":["application/problem+json"],"mediaTypeContent":{"application/problem+json":{"schemaId":"components/schemas/InvalidRequestProblem","exampleIds":["paths/~1token-tags~1{token_tag_id}/patch/responses/400/content/application~1problem+json/examples/malformed_json"]}}},{"code":"401","schemaId":"components/schemas/UnauthorizedProblem","exampleIds":["paths/~1token-tags~1{token_tag_id}/patch/responses/401/content/application~1problem+json/examples/service_authentication_denied"],"mediaTypes":["application/problem+json"],"mediaTypeContent":{"application/problem+json":{"schemaId":"components/schemas/UnauthorizedProblem","exampleIds":["paths/~1token-tags~1{token_tag_id}/patch/responses/401/content/application~1problem+json/examples/service_authentication_denied"]}}},{"code":"403","schemaId":"components/schemas/ForbiddenProblem","exampleIds":["paths/~1token-tags~1{token_tag_id}/patch/responses/403/content/application~1problem+json/examples/insufficient_permissions"],"mediaTypes":["application/problem+json"],"mediaTypeContent":{"application/problem+json":{"schemaId":"components/schemas/ForbiddenProblem","exampleIds":["paths/~1token-tags~1{token_tag_id}/patch/responses/403/content/application~1problem+json/examples/insufficient_permissions"]}}},{"code":"404","schemaId":"components/schemas/NotFoundProblem","exampleIds":["paths/~1token-tags~1{token_tag_id}/patch/responses/404/content/application~1problem+json/examples/address_not_found","paths/~1token-tags~1{token_tag_id}/patch/responses/404/content/application~1problem+json/examples/invoice_not_found"],"mediaTypes":["application/problem+json"],"mediaTypeContent":{"application/problem+json":{"schemaId":"components/schemas/NotFoundProblem","exampleIds":["paths/~1token-tags~1{token_tag_id}/patch/responses/404/content/application~1problem+json/examples/address_not_found","paths/~1token-tags~1{token_tag_id}/patch/responses/404/content/application~1problem+json/examples/invoice_not_found"]}}},{"code":"409","schemaId":"components/schemas/ConflictProblem","exampleIds":["paths/~1token-tags~1{token_tag_id}/patch/responses/409/content/application~1problem+json/examples/address_occupied","paths/~1token-tags~1{token_tag_id}/patch/responses/409/content/application~1problem+json/examples/address_in_use","paths/~1token-tags~1{token_tag_id}/patch/responses/409/content/application~1problem+json/examples/subscription_v1_conflict","paths/~1token-tags~1{token_tag_id}/patch/responses/409/content/application~1problem+json/examples/notification_send_in_progress","paths/~1token-tags~1{token_tag_id}/patch/responses/409/content/application~1problem+json/examples/notification_payload_unavailable","paths/~1token-tags~1{token_tag_id}/patch/responses/409/content/application~1problem+json/examples/notification_test_resend_not_allowed"],"mediaTypes":["application/problem+json"],"mediaTypeContent":{"application/problem+json":{"schemaId":"components/schemas/ConflictProblem","exampleIds":["paths/~1token-tags~1{token_tag_id}/patch/responses/409/content/application~1problem+json/examples/address_occupied","paths/~1token-tags~1{token_tag_id}/patch/responses/409/content/application~1problem+json/examples/address_in_use","paths/~1token-tags~1{token_tag_id}/patch/responses/409/content/application~1problem+json/examples/subscription_v1_conflict","paths/~1token-tags~1{token_tag_id}/patch/responses/409/content/application~1problem+json/examples/notification_send_in_progress","paths/~1token-tags~1{token_tag_id}/patch/responses/409/content/application~1problem+json/examples/notification_payload_unavailable","paths/~1token-tags~1{token_tag_id}/patch/responses/409/content/application~1problem+json/examples/notification_test_resend_not_allowed"]}}},{"code":"503","schemaId":"components/schemas/Problem","exampleIds":["paths/~1token-tags~1{token_tag_id}/patch/responses/503/content/application~1problem+json/examples/temporarily_unavailable"],"mediaTypes":["application/problem+json"],"mediaTypeContent":{"application/problem+json":{"schemaId":"components/schemas/Problem","exampleIds":["paths/~1token-tags~1{token_tag_id}/patch/responses/503/content/application~1problem+json/examples/temporarily_unavailable"]}}},{"code":"default","schemaId":"components/schemas/Problem","mediaTypes":["application/problem+json"],"mediaTypeContent":{"application/problem+json":{"schemaId":"components/schemas/Problem"}}}],"examples":[]}]}]},{"nodeType":"container","children":[{"nodeType":"feedback","pageSlug":"/token_tag/patch-token-tag"}],"panels":[]}]},"httpPath":"/token-tags/{token_tag_id}"},{"label":"Delete token tag","deprecated":false,"httpVerb":"delete","isAdditionalOperation":false,"isWebhook":false,"type":"link","link":"/apis/platform/api/token_tag/delete-token-tag","routeSlug":"/apis/platform/api/token_tag/delete-token-tag","metadata":{"seo":{"title":"Delete token tag","description":"Delete a token tag."}},"content":{"contentType":"item","itemVariant":"httpItem","meta":{"sourceId":"delete-token-tag","name":"Delete token tag","isWebhook":false,"pointer":"/paths/~1token-tags~1{token_tag_id}/delete","hasSamples":false},"children":[{"nodeType":"container","children":[{"nodeType":"header","level":2,"label":"Delete token tag","isWebhook":false,"showPageActions":true}],"panels":[]},{"nodeType":"container","children":[{"nodeType":"header","level":4,"label":"Request","labelTranslationKey":"request","deepLinkSuffix":"request"},{"nodeType":"markdoc","content":"Delete a token tag."},{"nodeType":"security","requirements":[{"schemes":[{"name":"Auth","scopes":["api:token_tag:delete"],"type":"apiKey","in":"header","paramName":"X-Api-Key","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"API key for authenticating requests. Include your key in the "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"X-Api-Key"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" header. Keys can be created in the Vilna Dashboard or via the Management API. The scopes listed per operation indicate which permissions the key must have."},"children":[]}]}]}]}]}]},{"nodeType":"item-content","variant":"path","label":"Path","labelTranslationKey":"path","parameters":[{"name":"token_tag_id","in":"path","schemaId":"schema_17","description":"Unique identifier (UUID) of the token tag.","required":true}],"pointer":"/paths/~1token-tags~1{token_tag_id}/delete/parameters"},{"nodeType":"item-content","variant":"headers","label":"Headers","labelTranslationKey":"header","parameters":[{"name":"Idempotency-Key","in":"header","schemaId":"schema_14","description":"Case-sensitive opaque key for one mutation intent. Send exactly one header occurrence containing 1 to 128 visible ASCII bytes (0x21..0x7e). Commas are literal data; do not trim, lowercase or require UUID syntax. Reuse the same key for retries, with current authorization checked on every attempt. Repeated header occurrences are rejected.\n","required":true}],"pointer":"/paths/~1token-tags~1{token_tag_id}/delete/parameters"}],"panels":[{"children":[{"kind":"code-sample","source":{"kind":"code-sample","operationType":"http","method":"DELETE","path":"/token-tags/{token_tag_id}","servers":[{"url":"/_mock/apis/platform/api","description":"Mock server","isMockServer":true},{"url":"https://api.vilna.io/v2","description":"Vilna API."}],"parameters":{"path":[{"name":"token_tag_id","in":"path","required":true,"example":"550e8400-e29b-41d4-a716-446655440000","schemaId":"components/schemas/UUID"}],"query":[],"querystring":[],"header":[{"name":"Idempotency-Key","in":"header","required":true,"schemaId":"schema_14"}],"cookie":[]},"security":[{"schemes":[{"id":"Auth","type":"apiKey","name":"X-Api-Key","in":"header"}],"scopes":["api:token_tag:delete"]}],"responseCodes":["204","400","401","403","404","409","503","default"],"pointer":"/token-tags/{token_tag_id}","href":"token_tag/delete-token-tag","openApiOperationId":"delete-token-tag","summary":"Delete token tag"},"isWebhook":false,"hideReplay":false,"servers":[{"url":"/_mock/apis/platform/api","description":"Mock server","isMockServer":true},{"url":"https://api.vilna.io/v2","description":"Vilna API."}],"examples":[]}]}]},{"nodeType":"container","children":[{"nodeType":"header","level":4,"label":"Responses","labelTranslationKey":"responses","deepLinkSuffix":"responses"},{"nodeType":"item-content","variant":"responses","responses":[{"code":"204","description":"Successful operation with no response body."},{"code":"400","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Bad request (e.g., missing or invalid fields). Invalid text may be reported as address.label_invalid, address.meta_invalid, public_key.label_invalid, invoice.comment_invalid, invoice.metadata_invalid."},"children":[]}]}]}],"mediaType":"application/problem+json","mediaTypes":["application/problem+json"],"mediaTypeContent":{"application/problem+json":{"schemaId":"components/schemas/InvalidRequestProblem","exampleIds":["paths/~1token-tags~1{token_tag_id}/delete/responses/400/content/application~1problem+json/examples/malformed_json"]}},"schemaId":"components/schemas/InvalidRequestProblem","exampleIds":["paths/~1token-tags~1{token_tag_id}/delete/responses/400/content/application~1problem+json/examples/malformed_json"]},{"code":"401","description":"Missing or invalid authentication credentials.","mediaType":"application/problem+json","mediaTypes":["application/problem+json"],"mediaTypeContent":{"application/problem+json":{"schemaId":"components/schemas/UnauthorizedProblem","exampleIds":["paths/~1token-tags~1{token_tag_id}/delete/responses/401/content/application~1problem+json/examples/service_authentication_denied"]}},"schemaId":"components/schemas/UnauthorizedProblem","exampleIds":["paths/~1token-tags~1{token_tag_id}/delete/responses/401/content/application~1problem+json/examples/service_authentication_denied"]},{"code":"403","description":"Insufficient permissions.","mediaType":"application/problem+json","mediaTypes":["application/problem+json"],"mediaTypeContent":{"application/problem+json":{"schemaId":"components/schemas/ForbiddenProblem","exampleIds":["paths/~1token-tags~1{token_tag_id}/delete/responses/403/content/application~1problem+json/examples/insufficient_permissions"]}},"schemaId":"components/schemas/ForbiddenProblem","exampleIds":["paths/~1token-tags~1{token_tag_id}/delete/responses/403/content/application~1problem+json/examples/insufficient_permissions"]},{"code":"404","description":"Requested resource does not exist.","mediaType":"application/problem+json","mediaTypes":["application/problem+json"],"mediaTypeContent":{"application/problem+json":{"schemaId":"components/schemas/NotFoundProblem","exampleIds":["paths/~1token-tags~1{token_tag_id}/delete/responses/404/content/application~1problem+json/examples/address_not_found","paths/~1token-tags~1{token_tag_id}/delete/responses/404/content/application~1problem+json/examples/invoice_not_found"]}},"schemaId":"components/schemas/NotFoundProblem","exampleIds":["paths/~1token-tags~1{token_tag_id}/delete/responses/404/content/application~1problem+json/examples/address_not_found","paths/~1token-tags~1{token_tag_id}/delete/responses/404/content/application~1problem+json/examples/invoice_not_found"]},{"code":"409","description":"Request conflicts with the current resource state.","mediaType":"application/problem+json","mediaTypes":["application/problem+json"],"mediaTypeContent":{"application/problem+json":{"schemaId":"components/schemas/ConflictProblem","exampleIds":["paths/~1token-tags~1{token_tag_id}/delete/responses/409/content/application~1problem+json/examples/address_occupied","paths/~1token-tags~1{token_tag_id}/delete/responses/409/content/application~1problem+json/examples/address_in_use","paths/~1token-tags~1{token_tag_id}/delete/responses/409/content/application~1problem+json/examples/subscription_v1_conflict","paths/~1token-tags~1{token_tag_id}/delete/responses/409/content/application~1problem+json/examples/notification_send_in_progress","paths/~1token-tags~1{token_tag_id}/delete/responses/409/content/application~1problem+json/examples/notification_payload_unavailable","paths/~1token-tags~1{token_tag_id}/delete/responses/409/content/application~1problem+json/examples/notification_test_resend_not_allowed"]}},"schemaId":"components/schemas/ConflictProblem","exampleIds":["paths/~1token-tags~1{token_tag_id}/delete/responses/409/content/application~1problem+json/examples/address_occupied","paths/~1token-tags~1{token_tag_id}/delete/responses/409/content/application~1problem+json/examples/address_in_use","paths/~1token-tags~1{token_tag_id}/delete/responses/409/content/application~1problem+json/examples/subscription_v1_conflict","paths/~1token-tags~1{token_tag_id}/delete/responses/409/content/application~1problem+json/examples/notification_send_in_progress","paths/~1token-tags~1{token_tag_id}/delete/responses/409/content/application~1problem+json/examples/notification_payload_unavailable","paths/~1token-tags~1{token_tag_id}/delete/responses/409/content/application~1problem+json/examples/notification_test_resend_not_allowed"]},{"code":"503","description":"The operation is temporarily unavailable. Please try again later.","mediaType":"application/problem+json","mediaTypes":["application/problem+json"],"mediaTypeContent":{"application/problem+json":{"schemaId":"components/schemas/Problem","exampleIds":["paths/~1token-tags~1{token_tag_id}/delete/responses/503/content/application~1problem+json/examples/temporarily_unavailable"]}},"schemaId":"components/schemas/Problem","exampleIds":["paths/~1token-tags~1{token_tag_id}/delete/responses/503/content/application~1problem+json/examples/temporarily_unavailable"]},{"code":"default","description":"Unexpected error.","mediaType":"application/problem+json","mediaTypes":["application/problem+json"],"mediaTypeContent":{"application/problem+json":{"schemaId":"components/schemas/Problem"}},"schemaId":"components/schemas/Problem"}],"pointer":"/paths/~1token-tags~1{token_tag_id}/delete/responses"}],"panels":[{"children":[{"kind":"response","responseCodes":[{"code":"204"},{"code":"400","schemaId":"components/schemas/InvalidRequestProblem","exampleIds":["paths/~1token-tags~1{token_tag_id}/delete/responses/400/content/application~1problem+json/examples/malformed_json"],"mediaTypes":["application/problem+json"],"mediaTypeContent":{"application/problem+json":{"schemaId":"components/schemas/InvalidRequestProblem","exampleIds":["paths/~1token-tags~1{token_tag_id}/delete/responses/400/content/application~1problem+json/examples/malformed_json"]}}},{"code":"401","schemaId":"components/schemas/UnauthorizedProblem","exampleIds":["paths/~1token-tags~1{token_tag_id}/delete/responses/401/content/application~1problem+json/examples/service_authentication_denied"],"mediaTypes":["application/problem+json"],"mediaTypeContent":{"application/problem+json":{"schemaId":"components/schemas/UnauthorizedProblem","exampleIds":["paths/~1token-tags~1{token_tag_id}/delete/responses/401/content/application~1problem+json/examples/service_authentication_denied"]}}},{"code":"403","schemaId":"components/schemas/ForbiddenProblem","exampleIds":["paths/~1token-tags~1{token_tag_id}/delete/responses/403/content/application~1problem+json/examples/insufficient_permissions"],"mediaTypes":["application/problem+json"],"mediaTypeContent":{"application/problem+json":{"schemaId":"components/schemas/ForbiddenProblem","exampleIds":["paths/~1token-tags~1{token_tag_id}/delete/responses/403/content/application~1problem+json/examples/insufficient_permissions"]}}},{"code":"404","schemaId":"components/schemas/NotFoundProblem","exampleIds":["paths/~1token-tags~1{token_tag_id}/delete/responses/404/content/application~1problem+json/examples/address_not_found","paths/~1token-tags~1{token_tag_id}/delete/responses/404/content/application~1problem+json/examples/invoice_not_found"],"mediaTypes":["application/problem+json"],"mediaTypeContent":{"application/problem+json":{"schemaId":"components/schemas/NotFoundProblem","exampleIds":["paths/~1token-tags~1{token_tag_id}/delete/responses/404/content/application~1problem+json/examples/address_not_found","paths/~1token-tags~1{token_tag_id}/delete/responses/404/content/application~1problem+json/examples/invoice_not_found"]}}},{"code":"409","schemaId":"components/schemas/ConflictProblem","exampleIds":["paths/~1token-tags~1{token_tag_id}/delete/responses/409/content/application~1problem+json/examples/address_occupied","paths/~1token-tags~1{token_tag_id}/delete/responses/409/content/application~1problem+json/examples/address_in_use","paths/~1token-tags~1{token_tag_id}/delete/responses/409/content/application~1problem+json/examples/subscription_v1_conflict","paths/~1token-tags~1{token_tag_id}/delete/responses/409/content/application~1problem+json/examples/notification_send_in_progress","paths/~1token-tags~1{token_tag_id}/delete/responses/409/content/application~1problem+json/examples/notification_payload_unavailable","paths/~1token-tags~1{token_tag_id}/delete/responses/409/content/application~1problem+json/examples/notification_test_resend_not_allowed"],"mediaTypes":["application/problem+json"],"mediaTypeContent":{"application/problem+json":{"schemaId":"components/schemas/ConflictProblem","exampleIds":["paths/~1token-tags~1{token_tag_id}/delete/responses/409/content/application~1problem+json/examples/address_occupied","paths/~1token-tags~1{token_tag_id}/delete/responses/409/content/application~1problem+json/examples/address_in_use","paths/~1token-tags~1{token_tag_id}/delete/responses/409/content/application~1problem+json/examples/subscription_v1_conflict","paths/~1token-tags~1{token_tag_id}/delete/responses/409/content/application~1problem+json/examples/notification_send_in_progress","paths/~1token-tags~1{token_tag_id}/delete/responses/409/content/application~1problem+json/examples/notification_payload_unavailable","paths/~1token-tags~1{token_tag_id}/delete/responses/409/content/application~1problem+json/examples/notification_test_resend_not_allowed"]}}},{"code":"503","schemaId":"components/schemas/Problem","exampleIds":["paths/~1token-tags~1{token_tag_id}/delete/responses/503/content/application~1problem+json/examples/temporarily_unavailable"],"mediaTypes":["application/problem+json"],"mediaTypeContent":{"application/problem+json":{"schemaId":"components/schemas/Problem","exampleIds":["paths/~1token-tags~1{token_tag_id}/delete/responses/503/content/application~1problem+json/examples/temporarily_unavailable"]}}},{"code":"default","schemaId":"components/schemas/Problem","mediaTypes":["application/problem+json"],"mediaTypeContent":{"application/problem+json":{"schemaId":"components/schemas/Problem"}}}],"examples":[]}]}]},{"nodeType":"container","children":[{"nodeType":"feedback","pageSlug":"/token_tag/delete-token-tag"}],"panels":[]}]},"httpPath":"/token-tags/{token_tag_id}"},{"label":"Add assets to token tag","deprecated":false,"httpVerb":"post","isAdditionalOperation":false,"isWebhook":false,"type":"link","link":"/apis/platform/api/token_tag/add-token-tag-assets","routeSlug":"/apis/platform/api/token_tag/add-token-tag-assets","metadata":{"seo":{"title":"Add assets to token tag","description":"Add tokens to a token tag by asset GID."}},"content":{"contentType":"item","itemVariant":"httpItem","meta":{"sourceId":"add-token-tag-assets","name":"Add assets to token tag","isWebhook":false,"pointer":"/paths/~1token-tags~1{token_tag_id}~1actions~1add/post","hasSamples":true},"children":[{"nodeType":"container","children":[{"nodeType":"header","level":2,"label":"Add assets to token tag","isWebhook":false,"showPageActions":true}],"panels":[]},{"nodeType":"container","children":[{"nodeType":"header","level":4,"label":"Request","labelTranslationKey":"request","deepLinkSuffix":"request"},{"nodeType":"markdoc","content":"Add tokens to a token tag by asset GID."},{"nodeType":"security","requirements":[{"schemes":[{"name":"Auth","scopes":["api:token_tag:write"],"type":"apiKey","in":"header","paramName":"X-Api-Key","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"API key for authenticating requests. Include your key in the "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"X-Api-Key"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" header. Keys can be created in the Vilna Dashboard or via the Management API. The scopes listed per operation indicate which permissions the key must have."},"children":[]}]}]}]}]}]},{"nodeType":"item-content","variant":"path","label":"Path","labelTranslationKey":"path","parameters":[{"name":"token_tag_id","in":"path","schemaId":"schema_17","description":"Unique identifier (UUID) of the token tag.","required":true}],"pointer":"/paths/~1token-tags~1{token_tag_id}~1actions~1add/post/parameters"},{"nodeType":"item-content","variant":"headers","label":"Headers","labelTranslationKey":"header","parameters":[{"name":"Idempotency-Key","in":"header","schemaId":"schema_14","description":"Case-sensitive opaque key for one mutation intent. Send exactly one header occurrence containing 1 to 128 visible ASCII bytes (0x21..0x7e). Commas are literal data; do not trim, lowercase or require UUID syntax. Reuse the same key for retries, with current authorization checked on every attempt. Repeated header occurrences are rejected.\n","required":true}],"pointer":"/paths/~1token-tags~1{token_tag_id}~1actions~1add/post/parameters"},{"nodeType":"item-content","variant":"body","label":"Request Body","labelTranslationKey":"body","required":true,"mediaTypes":["application/json"],"mediaTypeSchemas":{"application/json":{"schemaId":"components/schemas/AddTokenTagAssetsRequest"}},"schemaId":"components/schemas/AddTokenTagAssetsRequest","pointer":"/paths/~1token-tags~1{token_tag_id}~1actions~1add/post/requestBody"}],"panels":[{"children":[{"kind":"code-sample","source":{"kind":"code-sample","operationType":"http","method":"POST","path":"/token-tags/{token_tag_id}/actions/add","servers":[{"url":"/_mock/apis/platform/api","description":"Mock server","isMockServer":true},{"url":"https://api.vilna.io/v2","description":"Vilna API."}],"parameters":{"path":[{"name":"token_tag_id","in":"path","required":true,"example":"550e8400-e29b-41d4-a716-446655440000","schemaId":"components/schemas/UUID"}],"query":[],"querystring":[],"header":[{"name":"Idempotency-Key","in":"header","required":true,"schemaId":"schema_14"}],"cookie":[]},"security":[{"schemes":[{"id":"Auth","type":"apiKey","name":"X-Api-Key","in":"header"}],"scopes":["api:token_tag:write"]}],"requestBody":{"application/json":{"schemaId":"components/schemas/AddTokenTagAssetsRequest"}},"responseCodes":["204","400","401","403","404","409","503","default"],"pointer":"/token-tags/{token_tag_id}/actions/add","href":"token_tag/add-token-tag-assets","openApiOperationId":"add-token-tag-assets","summary":"Add assets to token tag"},"isWebhook":false,"hideReplay":false,"servers":[{"url":"/_mock/apis/platform/api","description":"Mock server","isMockServer":true},{"url":"https://api.vilna.io/v2","description":"Vilna API."}],"schemaId":"components/schemas/AddTokenTagAssetsRequest","mediaTypes":["application/json"],"mediaTypeSchemas":{"application/json":{"schemaId":"components/schemas/AddTokenTagAssetsRequest"}},"examples":[]}]}]},{"nodeType":"container","children":[{"nodeType":"header","level":4,"label":"Responses","labelTranslationKey":"responses","deepLinkSuffix":"responses"},{"nodeType":"item-content","variant":"responses","responses":[{"code":"204","description":"Successful operation with no response body."},{"code":"400","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Bad request (e.g., missing or invalid fields). Invalid text may be reported as address.label_invalid, address.meta_invalid, public_key.label_invalid, invoice.comment_invalid, invoice.metadata_invalid."},"children":[]}]}]}],"mediaType":"application/problem+json","mediaTypes":["application/problem+json"],"mediaTypeContent":{"application/problem+json":{"schemaId":"components/schemas/InvalidRequestProblem","exampleIds":["paths/~1token-tags~1{token_tag_id}~1actions~1add/post/responses/400/content/application~1problem+json/examples/malformed_json"]}},"schemaId":"components/schemas/InvalidRequestProblem","exampleIds":["paths/~1token-tags~1{token_tag_id}~1actions~1add/post/responses/400/content/application~1problem+json/examples/malformed_json"]},{"code":"401","description":"Missing or invalid authentication credentials.","mediaType":"application/problem+json","mediaTypes":["application/problem+json"],"mediaTypeContent":{"application/problem+json":{"schemaId":"components/schemas/UnauthorizedProblem","exampleIds":["paths/~1token-tags~1{token_tag_id}~1actions~1add/post/responses/401/content/application~1problem+json/examples/service_authentication_denied"]}},"schemaId":"components/schemas/UnauthorizedProblem","exampleIds":["paths/~1token-tags~1{token_tag_id}~1actions~1add/post/responses/401/content/application~1problem+json/examples/service_authentication_denied"]},{"code":"403","description":"Insufficient permissions.","mediaType":"application/problem+json","mediaTypes":["application/problem+json"],"mediaTypeContent":{"application/problem+json":{"schemaId":"components/schemas/ForbiddenProblem","exampleIds":["paths/~1token-tags~1{token_tag_id}~1actions~1add/post/responses/403/content/application~1problem+json/examples/insufficient_permissions"]}},"schemaId":"components/schemas/ForbiddenProblem","exampleIds":["paths/~1token-tags~1{token_tag_id}~1actions~1add/post/responses/403/content/application~1problem+json/examples/insufficient_permissions"]},{"code":"404","description":"Requested resource does not exist.","mediaType":"application/problem+json","mediaTypes":["application/problem+json"],"mediaTypeContent":{"application/problem+json":{"schemaId":"components/schemas/NotFoundProblem","exampleIds":["paths/~1token-tags~1{token_tag_id}~1actions~1add/post/responses/404/content/application~1problem+json/examples/address_not_found","paths/~1token-tags~1{token_tag_id}~1actions~1add/post/responses/404/content/application~1problem+json/examples/invoice_not_found"]}},"schemaId":"components/schemas/NotFoundProblem","exampleIds":["paths/~1token-tags~1{token_tag_id}~1actions~1add/post/responses/404/content/application~1problem+json/examples/address_not_found","paths/~1token-tags~1{token_tag_id}~1actions~1add/post/responses/404/content/application~1problem+json/examples/invoice_not_found"]},{"code":"409","description":"Request conflicts with the current resource state.","mediaType":"application/problem+json","mediaTypes":["application/problem+json"],"mediaTypeContent":{"application/problem+json":{"schemaId":"components/schemas/ConflictProblem","exampleIds":["paths/~1token-tags~1{token_tag_id}~1actions~1add/post/responses/409/content/application~1problem+json/examples/address_occupied","paths/~1token-tags~1{token_tag_id}~1actions~1add/post/responses/409/content/application~1problem+json/examples/address_in_use","paths/~1token-tags~1{token_tag_id}~1actions~1add/post/responses/409/content/application~1problem+json/examples/subscription_v1_conflict","paths/~1token-tags~1{token_tag_id}~1actions~1add/post/responses/409/content/application~1problem+json/examples/notification_send_in_progress","paths/~1token-tags~1{token_tag_id}~1actions~1add/post/responses/409/content/application~1problem+json/examples/notification_payload_unavailable","paths/~1token-tags~1{token_tag_id}~1actions~1add/post/responses/409/content/application~1problem+json/examples/notification_test_resend_not_allowed"]}},"schemaId":"components/schemas/ConflictProblem","exampleIds":["paths/~1token-tags~1{token_tag_id}~1actions~1add/post/responses/409/content/application~1problem+json/examples/address_occupied","paths/~1token-tags~1{token_tag_id}~1actions~1add/post/responses/409/content/application~1problem+json/examples/address_in_use","paths/~1token-tags~1{token_tag_id}~1actions~1add/post/responses/409/content/application~1problem+json/examples/subscription_v1_conflict","paths/~1token-tags~1{token_tag_id}~1actions~1add/post/responses/409/content/application~1problem+json/examples/notification_send_in_progress","paths/~1token-tags~1{token_tag_id}~1actions~1add/post/responses/409/content/application~1problem+json/examples/notification_payload_unavailable","paths/~1token-tags~1{token_tag_id}~1actions~1add/post/responses/409/content/application~1problem+json/examples/notification_test_resend_not_allowed"]},{"code":"503","description":"The operation is temporarily unavailable. Please try again later.","mediaType":"application/problem+json","mediaTypes":["application/problem+json"],"mediaTypeContent":{"application/problem+json":{"schemaId":"components/schemas/Problem","exampleIds":["paths/~1token-tags~1{token_tag_id}~1actions~1add/post/responses/503/content/application~1problem+json/examples/temporarily_unavailable"]}},"schemaId":"components/schemas/Problem","exampleIds":["paths/~1token-tags~1{token_tag_id}~1actions~1add/post/responses/503/content/application~1problem+json/examples/temporarily_unavailable"]},{"code":"default","description":"Unexpected error.","mediaType":"application/problem+json","mediaTypes":["application/problem+json"],"mediaTypeContent":{"application/problem+json":{"schemaId":"components/schemas/Problem"}},"schemaId":"components/schemas/Problem"}],"pointer":"/paths/~1token-tags~1{token_tag_id}~1actions~1add/post/responses"}],"panels":[{"children":[{"kind":"response","responseCodes":[{"code":"204"},{"code":"400","schemaId":"components/schemas/InvalidRequestProblem","exampleIds":["paths/~1token-tags~1{token_tag_id}~1actions~1add/post/responses/400/content/application~1problem+json/examples/malformed_json"],"mediaTypes":["application/problem+json"],"mediaTypeContent":{"application/problem+json":{"schemaId":"components/schemas/InvalidRequestProblem","exampleIds":["paths/~1token-tags~1{token_tag_id}~1actions~1add/post/responses/400/content/application~1problem+json/examples/malformed_json"]}}},{"code":"401","schemaId":"components/schemas/UnauthorizedProblem","exampleIds":["paths/~1token-tags~1{token_tag_id}~1actions~1add/post/responses/401/content/application~1problem+json/examples/service_authentication_denied"],"mediaTypes":["application/problem+json"],"mediaTypeContent":{"application/problem+json":{"schemaId":"components/schemas/UnauthorizedProblem","exampleIds":["paths/~1token-tags~1{token_tag_id}~1actions~1add/post/responses/401/content/application~1problem+json/examples/service_authentication_denied"]}}},{"code":"403","schemaId":"components/schemas/ForbiddenProblem","exampleIds":["paths/~1token-tags~1{token_tag_id}~1actions~1add/post/responses/403/content/application~1problem+json/examples/insufficient_permissions"],"mediaTypes":["application/problem+json"],"mediaTypeContent":{"application/problem+json":{"schemaId":"components/schemas/ForbiddenProblem","exampleIds":["paths/~1token-tags~1{token_tag_id}~1actions~1add/post/responses/403/content/application~1problem+json/examples/insufficient_permissions"]}}},{"code":"404","schemaId":"components/schemas/NotFoundProblem","exampleIds":["paths/~1token-tags~1{token_tag_id}~1actions~1add/post/responses/404/content/application~1problem+json/examples/address_not_found","paths/~1token-tags~1{token_tag_id}~1actions~1add/post/responses/404/content/application~1problem+json/examples/invoice_not_found"],"mediaTypes":["application/problem+json"],"mediaTypeContent":{"application/problem+json":{"schemaId":"components/schemas/NotFoundProblem","exampleIds":["paths/~1token-tags~1{token_tag_id}~1actions~1add/post/responses/404/content/application~1problem+json/examples/address_not_found","paths/~1token-tags~1{token_tag_id}~1actions~1add/post/responses/404/content/application~1problem+json/examples/invoice_not_found"]}}},{"code":"409","schemaId":"components/schemas/ConflictProblem","exampleIds":["paths/~1token-tags~1{token_tag_id}~1actions~1add/post/responses/409/content/application~1problem+json/examples/address_occupied","paths/~1token-tags~1{token_tag_id}~1actions~1add/post/responses/409/content/application~1problem+json/examples/address_in_use","paths/~1token-tags~1{token_tag_id}~1actions~1add/post/responses/409/content/application~1problem+json/examples/subscription_v1_conflict","paths/~1token-tags~1{token_tag_id}~1actions~1add/post/responses/409/content/application~1problem+json/examples/notification_send_in_progress","paths/~1token-tags~1{token_tag_id}~1actions~1add/post/responses/409/content/application~1problem+json/examples/notification_payload_unavailable","paths/~1token-tags~1{token_tag_id}~1actions~1add/post/responses/409/content/application~1problem+json/examples/notification_test_resend_not_allowed"],"mediaTypes":["application/problem+json"],"mediaTypeContent":{"application/problem+json":{"schemaId":"components/schemas/ConflictProblem","exampleIds":["paths/~1token-tags~1{token_tag_id}~1actions~1add/post/responses/409/content/application~1problem+json/examples/address_occupied","paths/~1token-tags~1{token_tag_id}~1actions~1add/post/responses/409/content/application~1problem+json/examples/address_in_use","paths/~1token-tags~1{token_tag_id}~1actions~1add/post/responses/409/content/application~1problem+json/examples/subscription_v1_conflict","paths/~1token-tags~1{token_tag_id}~1actions~1add/post/responses/409/content/application~1problem+json/examples/notification_send_in_progress","paths/~1token-tags~1{token_tag_id}~1actions~1add/post/responses/409/content/application~1problem+json/examples/notification_payload_unavailable","paths/~1token-tags~1{token_tag_id}~1actions~1add/post/responses/409/content/application~1problem+json/examples/notification_test_resend_not_allowed"]}}},{"code":"503","schemaId":"components/schemas/Problem","exampleIds":["paths/~1token-tags~1{token_tag_id}~1actions~1add/post/responses/503/content/application~1problem+json/examples/temporarily_unavailable"],"mediaTypes":["application/problem+json"],"mediaTypeContent":{"application/problem+json":{"schemaId":"components/schemas/Problem","exampleIds":["paths/~1token-tags~1{token_tag_id}~1actions~1add/post/responses/503/content/application~1problem+json/examples/temporarily_unavailable"]}}},{"code":"default","schemaId":"components/schemas/Problem","mediaTypes":["application/problem+json"],"mediaTypeContent":{"application/problem+json":{"schemaId":"components/schemas/Problem"}}}],"examples":[]}]}]},{"nodeType":"container","children":[{"nodeType":"feedback","pageSlug":"/token_tag/add-token-tag-assets"}],"panels":[]}]},"httpPath":"/token-tags/{token_tag_id}/actions/add"},{"label":"Remove assets from token tag","deprecated":false,"httpVerb":"post","isAdditionalOperation":false,"isWebhook":false,"type":"link","link":"/apis/platform/api/token_tag/remove-token-tag-assets","routeSlug":"/apis/platform/api/token_tag/remove-token-tag-assets","metadata":{"seo":{"title":"Remove assets from token tag","description":"Remove tokens from a token tag by asset GID."}},"content":{"contentType":"item","itemVariant":"httpItem","meta":{"sourceId":"remove-token-tag-assets","name":"Remove assets from token tag","isWebhook":false,"pointer":"/paths/~1token-tags~1{token_tag_id}~1actions~1remove/post","hasSamples":true},"children":[{"nodeType":"container","children":[{"nodeType":"header","level":2,"label":"Remove assets from token tag","isWebhook":false,"showPageActions":true}],"panels":[]},{"nodeType":"container","children":[{"nodeType":"header","level":4,"label":"Request","labelTranslationKey":"request","deepLinkSuffix":"request"},{"nodeType":"markdoc","content":"Remove tokens from a token tag by asset GID."},{"nodeType":"security","requirements":[{"schemes":[{"name":"Auth","scopes":["api:token_tag:write"],"type":"apiKey","in":"header","paramName":"X-Api-Key","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"API key for authenticating requests. Include your key in the "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"X-Api-Key"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" header. Keys can be created in the Vilna Dashboard or via the Management API. The scopes listed per operation indicate which permissions the key must have."},"children":[]}]}]}]}]}]},{"nodeType":"item-content","variant":"path","label":"Path","labelTranslationKey":"path","parameters":[{"name":"token_tag_id","in":"path","schemaId":"schema_17","description":"Unique identifier (UUID) of the token tag.","required":true}],"pointer":"/paths/~1token-tags~1{token_tag_id}~1actions~1remove/post/parameters"},{"nodeType":"item-content","variant":"headers","label":"Headers","labelTranslationKey":"header","parameters":[{"name":"Idempotency-Key","in":"header","schemaId":"schema_14","description":"Case-sensitive opaque key for one mutation intent. Send exactly one header occurrence containing 1 to 128 visible ASCII bytes (0x21..0x7e). Commas are literal data; do not trim, lowercase or require UUID syntax. Reuse the same key for retries, with current authorization checked on every attempt. Repeated header occurrences are rejected.\n","required":true}],"pointer":"/paths/~1token-tags~1{token_tag_id}~1actions~1remove/post/parameters"},{"nodeType":"item-content","variant":"body","label":"Request Body","labelTranslationKey":"body","required":true,"mediaTypes":["application/json"],"mediaTypeSchemas":{"application/json":{"schemaId":"components/schemas/RemoveTokenTagAssetsRequest"}},"schemaId":"components/schemas/RemoveTokenTagAssetsRequest","pointer":"/paths/~1token-tags~1{token_tag_id}~1actions~1remove/post/requestBody"}],"panels":[{"children":[{"kind":"code-sample","source":{"kind":"code-sample","operationType":"http","method":"POST","path":"/token-tags/{token_tag_id}/actions/remove","servers":[{"url":"/_mock/apis/platform/api","description":"Mock server","isMockServer":true},{"url":"https://api.vilna.io/v2","description":"Vilna API."}],"parameters":{"path":[{"name":"token_tag_id","in":"path","required":true,"example":"550e8400-e29b-41d4-a716-446655440000","schemaId":"components/schemas/UUID"}],"query":[],"querystring":[],"header":[{"name":"Idempotency-Key","in":"header","required":true,"schemaId":"schema_14"}],"cookie":[]},"security":[{"schemes":[{"id":"Auth","type":"apiKey","name":"X-Api-Key","in":"header"}],"scopes":["api:token_tag:write"]}],"requestBody":{"application/json":{"schemaId":"components/schemas/RemoveTokenTagAssetsRequest"}},"responseCodes":["204","400","401","403","404","409","503","default"],"pointer":"/token-tags/{token_tag_id}/actions/remove","href":"token_tag/remove-token-tag-assets","openApiOperationId":"remove-token-tag-assets","summary":"Remove assets from token tag"},"isWebhook":false,"hideReplay":false,"servers":[{"url":"/_mock/apis/platform/api","description":"Mock server","isMockServer":true},{"url":"https://api.vilna.io/v2","description":"Vilna API."}],"schemaId":"components/schemas/RemoveTokenTagAssetsRequest","mediaTypes":["application/json"],"mediaTypeSchemas":{"application/json":{"schemaId":"components/schemas/RemoveTokenTagAssetsRequest"}},"examples":[]}]}]},{"nodeType":"container","children":[{"nodeType":"header","level":4,"label":"Responses","labelTranslationKey":"responses","deepLinkSuffix":"responses"},{"nodeType":"item-content","variant":"responses","responses":[{"code":"204","description":"Successful operation with no response body."},{"code":"400","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Bad request (e.g., missing or invalid fields). Invalid text may be reported as address.label_invalid, address.meta_invalid, public_key.label_invalid, invoice.comment_invalid, invoice.metadata_invalid."},"children":[]}]}]}],"mediaType":"application/problem+json","mediaTypes":["application/problem+json"],"mediaTypeContent":{"application/problem+json":{"schemaId":"components/schemas/InvalidRequestProblem","exampleIds":["paths/~1token-tags~1{token_tag_id}~1actions~1remove/post/responses/400/content/application~1problem+json/examples/malformed_json"]}},"schemaId":"components/schemas/InvalidRequestProblem","exampleIds":["paths/~1token-tags~1{token_tag_id}~1actions~1remove/post/responses/400/content/application~1problem+json/examples/malformed_json"]},{"code":"401","description":"Missing or invalid authentication credentials.","mediaType":"application/problem+json","mediaTypes":["application/problem+json"],"mediaTypeContent":{"application/problem+json":{"schemaId":"components/schemas/UnauthorizedProblem","exampleIds":["paths/~1token-tags~1{token_tag_id}~1actions~1remove/post/responses/401/content/application~1problem+json/examples/service_authentication_denied"]}},"schemaId":"components/schemas/UnauthorizedProblem","exampleIds":["paths/~1token-tags~1{token_tag_id}~1actions~1remove/post/responses/401/content/application~1problem+json/examples/service_authentication_denied"]},{"code":"403","description":"Insufficient permissions.","mediaType":"application/problem+json","mediaTypes":["application/problem+json"],"mediaTypeContent":{"application/problem+json":{"schemaId":"components/schemas/ForbiddenProblem","exampleIds":["paths/~1token-tags~1{token_tag_id}~1actions~1remove/post/responses/403/content/application~1problem+json/examples/insufficient_permissions"]}},"schemaId":"components/schemas/ForbiddenProblem","exampleIds":["paths/~1token-tags~1{token_tag_id}~1actions~1remove/post/responses/403/content/application~1problem+json/examples/insufficient_permissions"]},{"code":"404","description":"Requested resource does not exist.","mediaType":"application/problem+json","mediaTypes":["application/problem+json"],"mediaTypeContent":{"application/problem+json":{"schemaId":"components/schemas/NotFoundProblem","exampleIds":["paths/~1token-tags~1{token_tag_id}~1actions~1remove/post/responses/404/content/application~1problem+json/examples/address_not_found","paths/~1token-tags~1{token_tag_id}~1actions~1remove/post/responses/404/content/application~1problem+json/examples/invoice_not_found"]}},"schemaId":"components/schemas/NotFoundProblem","exampleIds":["paths/~1token-tags~1{token_tag_id}~1actions~1remove/post/responses/404/content/application~1problem+json/examples/address_not_found","paths/~1token-tags~1{token_tag_id}~1actions~1remove/post/responses/404/content/application~1problem+json/examples/invoice_not_found"]},{"code":"409","description":"Request conflicts with the current resource state.","mediaType":"application/problem+json","mediaTypes":["application/problem+json"],"mediaTypeContent":{"application/problem+json":{"schemaId":"components/schemas/ConflictProblem","exampleIds":["paths/~1token-tags~1{token_tag_id}~1actions~1remove/post/responses/409/content/application~1problem+json/examples/address_occupied","paths/~1token-tags~1{token_tag_id}~1actions~1remove/post/responses/409/content/application~1problem+json/examples/address_in_use","paths/~1token-tags~1{token_tag_id}~1actions~1remove/post/responses/409/content/application~1problem+json/examples/subscription_v1_conflict","paths/~1token-tags~1{token_tag_id}~1actions~1remove/post/responses/409/content/application~1problem+json/examples/notification_send_in_progress","paths/~1token-tags~1{token_tag_id}~1actions~1remove/post/responses/409/content/application~1problem+json/examples/notification_payload_unavailable","paths/~1token-tags~1{token_tag_id}~1actions~1remove/post/responses/409/content/application~1problem+json/examples/notification_test_resend_not_allowed"]}},"schemaId":"components/schemas/ConflictProblem","exampleIds":["paths/~1token-tags~1{token_tag_id}~1actions~1remove/post/responses/409/content/application~1problem+json/examples/address_occupied","paths/~1token-tags~1{token_tag_id}~1actions~1remove/post/responses/409/content/application~1problem+json/examples/address_in_use","paths/~1token-tags~1{token_tag_id}~1actions~1remove/post/responses/409/content/application~1problem+json/examples/subscription_v1_conflict","paths/~1token-tags~1{token_tag_id}~1actions~1remove/post/responses/409/content/application~1problem+json/examples/notification_send_in_progress","paths/~1token-tags~1{token_tag_id}~1actions~1remove/post/responses/409/content/application~1problem+json/examples/notification_payload_unavailable","paths/~1token-tags~1{token_tag_id}~1actions~1remove/post/responses/409/content/application~1problem+json/examples/notification_test_resend_not_allowed"]},{"code":"503","description":"The operation is temporarily unavailable. Please try again later.","mediaType":"application/problem+json","mediaTypes":["application/problem+json"],"mediaTypeContent":{"application/problem+json":{"schemaId":"components/schemas/Problem","exampleIds":["paths/~1token-tags~1{token_tag_id}~1actions~1remove/post/responses/503/content/application~1problem+json/examples/temporarily_unavailable"]}},"schemaId":"components/schemas/Problem","exampleIds":["paths/~1token-tags~1{token_tag_id}~1actions~1remove/post/responses/503/content/application~1problem+json/examples/temporarily_unavailable"]},{"code":"default","description":"Unexpected error.","mediaType":"application/problem+json","mediaTypes":["application/problem+json"],"mediaTypeContent":{"application/problem+json":{"schemaId":"components/schemas/Problem"}},"schemaId":"components/schemas/Problem"}],"pointer":"/paths/~1token-tags~1{token_tag_id}~1actions~1remove/post/responses"}],"panels":[{"children":[{"kind":"response","responseCodes":[{"code":"204"},{"code":"400","schemaId":"components/schemas/InvalidRequestProblem","exampleIds":["paths/~1token-tags~1{token_tag_id}~1actions~1remove/post/responses/400/content/application~1problem+json/examples/malformed_json"],"mediaTypes":["application/problem+json"],"mediaTypeContent":{"application/problem+json":{"schemaId":"components/schemas/InvalidRequestProblem","exampleIds":["paths/~1token-tags~1{token_tag_id}~1actions~1remove/post/responses/400/content/application~1problem+json/examples/malformed_json"]}}},{"code":"401","schemaId":"components/schemas/UnauthorizedProblem","exampleIds":["paths/~1token-tags~1{token_tag_id}~1actions~1remove/post/responses/401/content/application~1problem+json/examples/service_authentication_denied"],"mediaTypes":["application/problem+json"],"mediaTypeContent":{"application/problem+json":{"schemaId":"components/schemas/UnauthorizedProblem","exampleIds":["paths/~1token-tags~1{token_tag_id}~1actions~1remove/post/responses/401/content/application~1problem+json/examples/service_authentication_denied"]}}},{"code":"403","schemaId":"components/schemas/ForbiddenProblem","exampleIds":["paths/~1token-tags~1{token_tag_id}~1actions~1remove/post/responses/403/content/application~1problem+json/examples/insufficient_permissions"],"mediaTypes":["application/problem+json"],"mediaTypeContent":{"application/problem+json":{"schemaId":"components/schemas/ForbiddenProblem","exampleIds":["paths/~1token-tags~1{token_tag_id}~1actions~1remove/post/responses/403/content/application~1problem+json/examples/insufficient_permissions"]}}},{"code":"404","schemaId":"components/schemas/NotFoundProblem","exampleIds":["paths/~1token-tags~1{token_tag_id}~1actions~1remove/post/responses/404/content/application~1problem+json/examples/address_not_found","paths/~1token-tags~1{token_tag_id}~1actions~1remove/post/responses/404/content/application~1problem+json/examples/invoice_not_found"],"mediaTypes":["application/problem+json"],"mediaTypeContent":{"application/problem+json":{"schemaId":"components/schemas/NotFoundProblem","exampleIds":["paths/~1token-tags~1{token_tag_id}~1actions~1remove/post/responses/404/content/application~1problem+json/examples/address_not_found","paths/~1token-tags~1{token_tag_id}~1actions~1remove/post/responses/404/content/application~1problem+json/examples/invoice_not_found"]}}},{"code":"409","schemaId":"components/schemas/ConflictProblem","exampleIds":["paths/~1token-tags~1{token_tag_id}~1actions~1remove/post/responses/409/content/application~1problem+json/examples/address_occupied","paths/~1token-tags~1{token_tag_id}~1actions~1remove/post/responses/409/content/application~1problem+json/examples/address_in_use","paths/~1token-tags~1{token_tag_id}~1actions~1remove/post/responses/409/content/application~1problem+json/examples/subscription_v1_conflict","paths/~1token-tags~1{token_tag_id}~1actions~1remove/post/responses/409/content/application~1problem+json/examples/notification_send_in_progress","paths/~1token-tags~1{token_tag_id}~1actions~1remove/post/responses/409/content/application~1problem+json/examples/notification_payload_unavailable","paths/~1token-tags~1{token_tag_id}~1actions~1remove/post/responses/409/content/application~1problem+json/examples/notification_test_resend_not_allowed"],"mediaTypes":["application/problem+json"],"mediaTypeContent":{"application/problem+json":{"schemaId":"components/schemas/ConflictProblem","exampleIds":["paths/~1token-tags~1{token_tag_id}~1actions~1remove/post/responses/409/content/application~1problem+json/examples/address_occupied","paths/~1token-tags~1{token_tag_id}~1actions~1remove/post/responses/409/content/application~1problem+json/examples/address_in_use","paths/~1token-tags~1{token_tag_id}~1actions~1remove/post/responses/409/content/application~1problem+json/examples/subscription_v1_conflict","paths/~1token-tags~1{token_tag_id}~1actions~1remove/post/responses/409/content/application~1problem+json/examples/notification_send_in_progress","paths/~1token-tags~1{token_tag_id}~1actions~1remove/post/responses/409/content/application~1problem+json/examples/notification_payload_unavailable","paths/~1token-tags~1{token_tag_id}~1actions~1remove/post/responses/409/content/application~1problem+json/examples/notification_test_resend_not_allowed"]}}},{"code":"503","schemaId":"components/schemas/Problem","exampleIds":["paths/~1token-tags~1{token_tag_id}~1actions~1remove/post/responses/503/content/application~1problem+json/examples/temporarily_unavailable"],"mediaTypes":["application/problem+json"],"mediaTypeContent":{"application/problem+json":{"schemaId":"components/schemas/Problem","exampleIds":["paths/~1token-tags~1{token_tag_id}~1actions~1remove/post/responses/503/content/application~1problem+json/examples/temporarily_unavailable"]}}},{"code":"default","schemaId":"components/schemas/Problem","mediaTypes":["application/problem+json"],"mediaTypeContent":{"application/problem+json":{"schemaId":"components/schemas/Problem"}}}],"examples":[]}]}]},{"nodeType":"container","children":[{"nodeType":"feedback","pageSlug":"/token_tag/remove-token-tag-assets"}],"panels":[]}]},"httpPath":"/token-tags/{token_tag_id}/actions/remove"}],"content":{"contentType":"group","meta":{"name":"token_tag"},"children":[{"nodeType":"container","children":[{"nodeType":"header","level":2,"label":"Token Tags","showPageActions":true},{"nodeType":"markdoc","content":"Named collections of tokens. Pass a tag ID to list endpoints to filter results by membership."}],"panels":[{"children":[{"kind":"group-items","title":"Operations","titleTranslationKey":"operations","items":[{"title":"/token-tags","summary":"List token tags","prefix":{"name":"get","color":"get"},"badges":[],"link":"/token_tag/list-token-tags","deprecated":false},{"title":"/token-tags","summary":"Create token tag","prefix":{"name":"post","color":"post"},"badges":[],"link":"/token_tag/create-token-tag","deprecated":false},{"title":"/token-tags/{token_tag_id}","summary":"Get token tag","prefix":{"name":"get","color":"get"},"badges":[],"link":"/token_tag/get-token-tag","deprecated":false},{"title":"/token-tags/{token_tag_id}","summary":"Update token tag","prefix":{"name":"patch","color":"patch"},"badges":[],"link":"/token_tag/patch-token-tag","deprecated":false},{"title":"/token-tags/{token_tag_id}","summary":"Delete token tag","prefix":{"name":"delete","color":"delete"},"badges":[],"link":"/token_tag/delete-token-tag","deprecated":false},{"title":"/token-tags/{token_tag_id}/actions/add","summary":"Add assets to token tag","prefix":{"name":"post","color":"post"},"badges":[],"link":"/token_tag/add-token-tag-assets","deprecated":false},{"title":"/token-tags/{token_tag_id}/actions/remove","summary":"Remove assets from token tag","prefix":{"name":"post","color":"post"},"badges":[],"link":"/token_tag/remove-token-tag-assets","deprecated":false}]}]}]}]}},{"type":"separator","label":"Developer Tools","content":null},{"type":"group","label":"limits","link":"/apis/platform/api/limits","routeSlug":"/apis/platform/api/limits","items":[{"label":"Get project limits","deprecated":false,"httpVerb":"get","isAdditionalOperation":false,"isWebhook":false,"type":"link","link":"/apis/platform/api/limits/get-limits","routeSlug":"/apis/platform/api/limits/get-limits","metadata":{"seo":{"title":"Get project limits","description":"Get resource usage and effective limits for the current project."}},"content":{"contentType":"item","itemVariant":"httpItem","meta":{"sourceId":"get-limits","name":"Get project limits","isWebhook":false,"pointer":"/paths/~1limits/get","hasSamples":false},"children":[{"nodeType":"container","children":[{"nodeType":"header","level":2,"label":"Get project limits","isWebhook":false,"showPageActions":true}],"panels":[]},{"nodeType":"container","children":[{"nodeType":"header","level":4,"label":"Request","labelTranslationKey":"request","deepLinkSuffix":"request"},{"nodeType":"markdoc","content":"Get resource usage and effective limits for the current project."},{"nodeType":"security","requirements":[{"schemes":[{"name":"Auth","scopes":["api:limits:read"],"type":"apiKey","in":"header","paramName":"X-Api-Key","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"API key for authenticating requests. Include your key in the "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"X-Api-Key"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" header. Keys can be created in the Vilna Dashboard or via the Management API. The scopes listed per operation indicate which permissions the key must have."},"children":[]}]}]}]}]}]}],"panels":[{"children":[{"kind":"code-sample","source":{"kind":"code-sample","operationType":"http","method":"GET","path":"/limits","servers":[{"url":"/_mock/apis/platform/api","description":"Mock server","isMockServer":true},{"url":"https://api.vilna.io/v2","description":"Vilna API."}],"parameters":{"path":[],"query":[],"querystring":[],"header":[],"cookie":[]},"security":[{"schemes":[{"id":"Auth","type":"apiKey","name":"X-Api-Key","in":"header"}],"scopes":["api:limits:read"]}],"responseCodes":["200","400","401","403","503","default"],"pointer":"/limits","href":"limits/get-limits","openApiOperationId":"get-limits","summary":"Get project limits"},"isWebhook":false,"hideReplay":false,"servers":[{"url":"/_mock/apis/platform/api","description":"Mock server","isMockServer":true},{"url":"https://api.vilna.io/v2","description":"Vilna API."}],"examples":[]}]}]},{"nodeType":"container","children":[{"nodeType":"header","level":4,"label":"Responses","labelTranslationKey":"responses","deepLinkSuffix":"responses"},{"nodeType":"item-content","variant":"responses","responses":[{"code":"200","description":"Resource usage and limits.","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"schema_83"}},"schemaId":"schema_83"},{"code":"400","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Bad request (e.g., missing or invalid fields). Invalid text may be reported as address.label_invalid, address.meta_invalid, public_key.label_invalid, invoice.comment_invalid, invoice.metadata_invalid."},"children":[]}]}]}],"mediaType":"application/problem+json","mediaTypes":["application/problem+json"],"mediaTypeContent":{"application/problem+json":{"schemaId":"components/schemas/InvalidRequestProblem","exampleIds":["paths/~1limits/get/responses/400/content/application~1problem+json/examples/malformed_json"]}},"schemaId":"components/schemas/InvalidRequestProblem","exampleIds":["paths/~1limits/get/responses/400/content/application~1problem+json/examples/malformed_json"]},{"code":"401","description":"Missing or invalid authentication credentials.","mediaType":"application/problem+json","mediaTypes":["application/problem+json"],"mediaTypeContent":{"application/problem+json":{"schemaId":"components/schemas/UnauthorizedProblem","exampleIds":["paths/~1limits/get/responses/401/content/application~1problem+json/examples/service_authentication_denied"]}},"schemaId":"components/schemas/UnauthorizedProblem","exampleIds":["paths/~1limits/get/responses/401/content/application~1problem+json/examples/service_authentication_denied"]},{"code":"403","description":"Insufficient permissions.","mediaType":"application/problem+json","mediaTypes":["application/problem+json"],"mediaTypeContent":{"application/problem+json":{"schemaId":"components/schemas/ForbiddenProblem","exampleIds":["paths/~1limits/get/responses/403/content/application~1problem+json/examples/insufficient_permissions"]}},"schemaId":"components/schemas/ForbiddenProblem","exampleIds":["paths/~1limits/get/responses/403/content/application~1problem+json/examples/insufficient_permissions"]},{"code":"503","description":"The operation is temporarily unavailable. Please try again later.","mediaType":"application/problem+json","mediaTypes":["application/problem+json"],"mediaTypeContent":{"application/problem+json":{"schemaId":"components/schemas/Problem","exampleIds":["paths/~1limits/get/responses/503/content/application~1problem+json/examples/temporarily_unavailable"]}},"schemaId":"components/schemas/Problem","exampleIds":["paths/~1limits/get/responses/503/content/application~1problem+json/examples/temporarily_unavailable"]},{"code":"default","description":"Unexpected error.","mediaType":"application/problem+json","mediaTypes":["application/problem+json"],"mediaTypeContent":{"application/problem+json":{"schemaId":"components/schemas/Problem"}},"schemaId":"components/schemas/Problem"}],"pointer":"/paths/~1limits/get/responses"}],"panels":[{"children":[{"kind":"response","responseCodes":[{"code":"200","schemaId":"schema_83","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"schema_83"}}},{"code":"400","schemaId":"components/schemas/InvalidRequestProblem","exampleIds":["paths/~1limits/get/responses/400/content/application~1problem+json/examples/malformed_json"],"mediaTypes":["application/problem+json"],"mediaTypeContent":{"application/problem+json":{"schemaId":"components/schemas/InvalidRequestProblem","exampleIds":["paths/~1limits/get/responses/400/content/application~1problem+json/examples/malformed_json"]}}},{"code":"401","schemaId":"components/schemas/UnauthorizedProblem","exampleIds":["paths/~1limits/get/responses/401/content/application~1problem+json/examples/service_authentication_denied"],"mediaTypes":["application/problem+json"],"mediaTypeContent":{"application/problem+json":{"schemaId":"components/schemas/UnauthorizedProblem","exampleIds":["paths/~1limits/get/responses/401/content/application~1problem+json/examples/service_authentication_denied"]}}},{"code":"403","schemaId":"components/schemas/ForbiddenProblem","exampleIds":["paths/~1limits/get/responses/403/content/application~1problem+json/examples/insufficient_permissions"],"mediaTypes":["application/problem+json"],"mediaTypeContent":{"application/problem+json":{"schemaId":"components/schemas/ForbiddenProblem","exampleIds":["paths/~1limits/get/responses/403/content/application~1problem+json/examples/insufficient_permissions"]}}},{"code":"503","schemaId":"components/schemas/Problem","exampleIds":["paths/~1limits/get/responses/503/content/application~1problem+json/examples/temporarily_unavailable"],"mediaTypes":["application/problem+json"],"mediaTypeContent":{"application/problem+json":{"schemaId":"components/schemas/Problem","exampleIds":["paths/~1limits/get/responses/503/content/application~1problem+json/examples/temporarily_unavailable"]}}},{"code":"default","schemaId":"components/schemas/Problem","mediaTypes":["application/problem+json"],"mediaTypeContent":{"application/problem+json":{"schemaId":"components/schemas/Problem"}}}],"examples":[]}]}]},{"nodeType":"container","children":[{"nodeType":"feedback","pageSlug":"/limits/get-limits"}],"panels":[]}]},"httpPath":"/limits"}],"content":{"contentType":"group","meta":{"name":"limits"},"children":[{"nodeType":"container","children":[{"nodeType":"header","level":2,"label":"limits","showPageActions":true},{"nodeType":"markdoc","content":"Resource usage and effective limits."}],"panels":[{"children":[{"kind":"group-items","title":"Operations","titleTranslationKey":"operations","items":[{"title":"/limits","summary":"Get project limits","prefix":{"name":"get","color":"get"},"badges":[],"link":"/limits/get-limits","deprecated":false}]}]}]}]}},{"type":"group","label":"Simulation","link":"/apis/platform/api/simulate","routeSlug":"/apis/platform/api/simulate","items":[{"label":"Simulate EVM transactions","deprecated":false,"httpVerb":"post","isAdditionalOperation":false,"isWebhook":false,"type":"link","link":"/apis/platform/api/simulate/simulate-evm","routeSlug":"/apis/platform/api/simulate/simulate-evm","metadata":{"seo":{"title":"Simulate EVM transactions","description":"Simulate one or more EVM transactions on the chain named in the body and return execution results."}},"content":{"contentType":"item","itemVariant":"httpItem","meta":{"sourceId":"simulate-evm","name":"Simulate EVM transactions","isWebhook":false,"pointer":"/paths/~1evm~1simulations/post","hasSamples":true},"children":[{"nodeType":"container","children":[{"nodeType":"header","level":2,"label":"Simulate EVM transactions","isWebhook":false,"showPageActions":true}],"panels":[]},{"nodeType":"container","children":[{"nodeType":"header","level":4,"label":"Request","labelTranslationKey":"request","deepLinkSuffix":"request"},{"nodeType":"markdoc","content":"Simulate one or more EVM transactions on the chain named in the body and return execution results."},{"nodeType":"security","requirements":[{"schemes":[{"name":"Auth","scopes":["api:simulate:call"],"type":"apiKey","in":"header","paramName":"X-Api-Key","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"API key for authenticating requests. Include your key in the "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"X-Api-Key"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" header. Keys can be created in the Vilna Dashboard or via the Management API. The scopes listed per operation indicate which permissions the key must have."},"children":[]}]}]}]}]}]},{"nodeType":"item-content","variant":"body","label":"Request Body","labelTranslationKey":"body","required":true,"mediaTypes":["application/json"],"mediaTypeSchemas":{"application/json":{"schemaId":"components/schemas/SimulateEVMRequest","exampleIds":["paths/~1evm~1simulations/post/requestBody/content/application~1json/examples/multi_transaction_simulation","paths/~1evm~1simulations/post/requestBody/content/application~1json/examples/simple_transfer","paths/~1evm~1simulations/post/requestBody/content/application~1json/examples/strict_validation"]}},"schemaId":"components/schemas/SimulateEVMRequest","exampleIds":["paths/~1evm~1simulations/post/requestBody/content/application~1json/examples/multi_transaction_simulation","paths/~1evm~1simulations/post/requestBody/content/application~1json/examples/simple_transfer","paths/~1evm~1simulations/post/requestBody/content/application~1json/examples/strict_validation"],"pointer":"/paths/~1evm~1simulations/post/requestBody"}],"panels":[{"children":[{"kind":"code-sample","source":{"kind":"code-sample","operationType":"http","method":"POST","path":"/evm/simulations","servers":[{"url":"/_mock/apis/platform/api","description":"Mock server","isMockServer":true},{"url":"https://api.vilna.io/v2","description":"Vilna API."}],"parameters":{"path":[],"query":[],"querystring":[],"header":[],"cookie":[]},"security":[{"schemes":[{"id":"Auth","type":"apiKey","name":"X-Api-Key","in":"header"}],"scopes":["api:simulate:call"]}],"requestBody":{"application/json":{"schemaId":"components/schemas/SimulateEVMRequest","exampleIds":["paths/~1evm~1simulations/post/requestBody/content/application~1json/examples/multi_transaction_simulation","paths/~1evm~1simulations/post/requestBody/content/application~1json/examples/simple_transfer","paths/~1evm~1simulations/post/requestBody/content/application~1json/examples/strict_validation"]}},"responseCodes":["200","400","401","403","404","422","429","502","503","504","default"],"pointer":"/evm/simulations","href":"simulate/simulate-evm","openApiOperationId":"simulate-evm","summary":"Simulate EVM transactions"},"isWebhook":false,"hideReplay":false,"servers":[{"url":"/_mock/apis/platform/api","description":"Mock server","isMockServer":true},{"url":"https://api.vilna.io/v2","description":"Vilna API."}],"schemaId":"components/schemas/SimulateEVMRequest","exampleIds":["paths/~1evm~1simulations/post/requestBody/content/application~1json/examples/multi_transaction_simulation","paths/~1evm~1simulations/post/requestBody/content/application~1json/examples/simple_transfer","paths/~1evm~1simulations/post/requestBody/content/application~1json/examples/strict_validation"],"mediaTypes":["application/json"],"mediaTypeSchemas":{"application/json":{"schemaId":"components/schemas/SimulateEVMRequest","exampleIds":["paths/~1evm~1simulations/post/requestBody/content/application~1json/examples/multi_transaction_simulation","paths/~1evm~1simulations/post/requestBody/content/application~1json/examples/simple_transfer","paths/~1evm~1simulations/post/requestBody/content/application~1json/examples/strict_validation"]}},"examples":[{},{},{}]}]}]},{"nodeType":"container","children":[{"nodeType":"header","level":4,"label":"Responses","labelTranslationKey":"responses","deepLinkSuffix":"responses"},{"nodeType":"item-content","variant":"responses","responses":[{"code":"200","description":"EVM simulation result.","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"schema_84"}},"schemaId":"schema_84"},{"code":"400","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Bad request (e.g., missing or invalid fields). Invalid text may be reported as address.label_invalid, address.meta_invalid, public_key.label_invalid, invoice.comment_invalid, invoice.metadata_invalid."},"children":[]}]}]}],"mediaType":"application/problem+json","mediaTypes":["application/problem+json"],"mediaTypeContent":{"application/problem+json":{"schemaId":"components/schemas/InvalidRequestProblem","exampleIds":["paths/~1evm~1simulations/post/responses/400/content/application~1problem+json/examples/malformed_json"]}},"schemaId":"components/schemas/InvalidRequestProblem","exampleIds":["paths/~1evm~1simulations/post/responses/400/content/application~1problem+json/examples/malformed_json"]},{"code":"401","description":"Missing or invalid authentication credentials.","mediaType":"application/problem+json","mediaTypes":["application/problem+json"],"mediaTypeContent":{"application/problem+json":{"schemaId":"components/schemas/UnauthorizedProblem","exampleIds":["paths/~1evm~1simulations/post/responses/401/content/application~1problem+json/examples/service_authentication_denied"]}},"schemaId":"components/schemas/UnauthorizedProblem","exampleIds":["paths/~1evm~1simulations/post/responses/401/content/application~1problem+json/examples/service_authentication_denied"]},{"code":"403","description":"Insufficient permissions.","mediaType":"application/problem+json","mediaTypes":["application/problem+json"],"mediaTypeContent":{"application/problem+json":{"schemaId":"components/schemas/ForbiddenProblem","exampleIds":["paths/~1evm~1simulations/post/responses/403/content/application~1problem+json/examples/insufficient_permissions"]}},"schemaId":"components/schemas/ForbiddenProblem","exampleIds":["paths/~1evm~1simulations/post/responses/403/content/application~1problem+json/examples/insufficient_permissions"]},{"code":"404","description":"Requested resource does not exist.","mediaType":"application/problem+json","mediaTypes":["application/problem+json"],"mediaTypeContent":{"application/problem+json":{"schemaId":"components/schemas/NotFoundProblem","exampleIds":["paths/~1evm~1simulations/post/responses/404/content/application~1problem+json/examples/address_not_found","paths/~1evm~1simulations/post/responses/404/content/application~1problem+json/examples/invoice_not_found"]}},"schemaId":"components/schemas/NotFoundProblem","exampleIds":["paths/~1evm~1simulations/post/responses/404/content/application~1problem+json/examples/address_not_found","paths/~1evm~1simulations/post/responses/404/content/application~1problem+json/examples/invoice_not_found"]},{"code":"422","description":"Request preconditions were not met.","mediaType":"application/problem+json","mediaTypes":["application/problem+json"],"mediaTypeContent":{"application/problem+json":{"schemaId":"components/schemas/PreconditionProblem","exampleIds":["paths/~1evm~1simulations/post/responses/422/content/application~1problem+json/examples/invoice_not_cancellable"]}},"schemaId":"components/schemas/PreconditionProblem","exampleIds":["paths/~1evm~1simulations/post/responses/422/content/application~1problem+json/examples/invoice_not_cancellable"]},{"code":"429","description":"Capacity or action cooldown exceeded.","mediaType":"application/problem+json","mediaTypes":["application/problem+json"],"mediaTypeContent":{"application/problem+json":{"schemaId":"components/schemas/Problem"}},"schemaId":"components/schemas/Problem"},{"code":"502","description":"Invalid upstream response or integration failure.","mediaType":"application/problem+json","mediaTypes":["application/problem+json"],"mediaTypeContent":{"application/problem+json":{"schemaId":"components/schemas/Problem"}},"schemaId":"components/schemas/Problem"},{"code":"503","description":"The operation is temporarily unavailable. Please try again later.","mediaType":"application/problem+json","mediaTypes":["application/problem+json"],"mediaTypeContent":{"application/problem+json":{"schemaId":"components/schemas/Problem","exampleIds":["paths/~1evm~1simulations/post/responses/503/content/application~1problem+json/examples/temporarily_unavailable"]}},"schemaId":"components/schemas/Problem","exampleIds":["paths/~1evm~1simulations/post/responses/503/content/application~1problem+json/examples/temporarily_unavailable"]},{"code":"504","description":"Shared request deadline exhausted.","mediaType":"application/problem+json","mediaTypes":["application/problem+json"],"mediaTypeContent":{"application/problem+json":{"schemaId":"components/schemas/Problem"}},"schemaId":"components/schemas/Problem"},{"code":"default","description":"Unexpected error.","mediaType":"application/problem+json","mediaTypes":["application/problem+json"],"mediaTypeContent":{"application/problem+json":{"schemaId":"components/schemas/Problem"}},"schemaId":"components/schemas/Problem"}],"pointer":"/paths/~1evm~1simulations/post/responses"}],"panels":[{"children":[{"kind":"response","responseCodes":[{"code":"200","schemaId":"schema_84","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"schema_84"}}},{"code":"400","schemaId":"components/schemas/InvalidRequestProblem","exampleIds":["paths/~1evm~1simulations/post/responses/400/content/application~1problem+json/examples/malformed_json"],"mediaTypes":["application/problem+json"],"mediaTypeContent":{"application/problem+json":{"schemaId":"components/schemas/InvalidRequestProblem","exampleIds":["paths/~1evm~1simulations/post/responses/400/content/application~1problem+json/examples/malformed_json"]}}},{"code":"401","schemaId":"components/schemas/UnauthorizedProblem","exampleIds":["paths/~1evm~1simulations/post/responses/401/content/application~1problem+json/examples/service_authentication_denied"],"mediaTypes":["application/problem+json"],"mediaTypeContent":{"application/problem+json":{"schemaId":"components/schemas/UnauthorizedProblem","exampleIds":["paths/~1evm~1simulations/post/responses/401/content/application~1problem+json/examples/service_authentication_denied"]}}},{"code":"403","schemaId":"components/schemas/ForbiddenProblem","exampleIds":["paths/~1evm~1simulations/post/responses/403/content/application~1problem+json/examples/insufficient_permissions"],"mediaTypes":["application/problem+json"],"mediaTypeContent":{"application/problem+json":{"schemaId":"components/schemas/ForbiddenProblem","exampleIds":["paths/~1evm~1simulations/post/responses/403/content/application~1problem+json/examples/insufficient_permissions"]}}},{"code":"404","schemaId":"components/schemas/NotFoundProblem","exampleIds":["paths/~1evm~1simulations/post/responses/404/content/application~1problem+json/examples/address_not_found","paths/~1evm~1simulations/post/responses/404/content/application~1problem+json/examples/invoice_not_found"],"mediaTypes":["application/problem+json"],"mediaTypeContent":{"application/problem+json":{"schemaId":"components/schemas/NotFoundProblem","exampleIds":["paths/~1evm~1simulations/post/responses/404/content/application~1problem+json/examples/address_not_found","paths/~1evm~1simulations/post/responses/404/content/application~1problem+json/examples/invoice_not_found"]}}},{"code":"422","schemaId":"components/schemas/PreconditionProblem","exampleIds":["paths/~1evm~1simulations/post/responses/422/content/application~1problem+json/examples/invoice_not_cancellable"],"mediaTypes":["application/problem+json"],"mediaTypeContent":{"application/problem+json":{"schemaId":"components/schemas/PreconditionProblem","exampleIds":["paths/~1evm~1simulations/post/responses/422/content/application~1problem+json/examples/invoice_not_cancellable"]}}},{"code":"429","schemaId":"components/schemas/Problem","mediaTypes":["application/problem+json"],"mediaTypeContent":{"application/problem+json":{"schemaId":"components/schemas/Problem"}}},{"code":"502","schemaId":"components/schemas/Problem","mediaTypes":["application/problem+json"],"mediaTypeContent":{"application/problem+json":{"schemaId":"components/schemas/Problem"}}},{"code":"503","schemaId":"components/schemas/Problem","exampleIds":["paths/~1evm~1simulations/post/responses/503/content/application~1problem+json/examples/temporarily_unavailable"],"mediaTypes":["application/problem+json"],"mediaTypeContent":{"application/problem+json":{"schemaId":"components/schemas/Problem","exampleIds":["paths/~1evm~1simulations/post/responses/503/content/application~1problem+json/examples/temporarily_unavailable"]}}},{"code":"504","schemaId":"components/schemas/Problem","mediaTypes":["application/problem+json"],"mediaTypeContent":{"application/problem+json":{"schemaId":"components/schemas/Problem"}}},{"code":"default","schemaId":"components/schemas/Problem","mediaTypes":["application/problem+json"],"mediaTypeContent":{"application/problem+json":{"schemaId":"components/schemas/Problem"}}}],"examples":[]}]}]},{"nodeType":"container","children":[{"nodeType":"feedback","pageSlug":"/simulate/simulate-evm"}],"panels":[]}]},"httpPath":"/evm/simulations"}],"content":{"contentType":"group","meta":{"name":"simulate"},"children":[{"nodeType":"container","children":[{"nodeType":"header","level":2,"label":"Simulation","showPageActions":true},{"nodeType":"markdoc","content":"Simulate EVM transactions before sending."}],"panels":[{"children":[{"kind":"group-items","title":"Operations","titleTranslationKey":"operations","items":[{"title":"/evm/simulations","summary":"Simulate EVM transactions","prefix":{"name":"post","color":"post"},"badges":[],"link":"/simulate/simulate-evm","deprecated":false}]}]}]}]}},{"type":"group","label":"Version","link":"/apis/platform/api/version","routeSlug":"/apis/platform/api/version","items":[{"label":"Get service version","deprecated":false,"httpVerb":"get","isAdditionalOperation":false,"isWebhook":false,"type":"link","link":"/apis/platform/api/version/get-version","routeSlug":"/apis/platform/api/version/get-version","metadata":{"seo":{"title":"Get service version","description":"Get the current API version."}},"content":{"contentType":"item","itemVariant":"httpItem","meta":{"sourceId":"get-version","name":"Get service version","isWebhook":false,"pointer":"/paths/~1version/get","hasSamples":false},"children":[{"nodeType":"container","children":[{"nodeType":"header","level":2,"label":"Get service version","isWebhook":false,"showPageActions":true}],"panels":[]},{"nodeType":"container","children":[{"nodeType":"header","level":4,"label":"Request","labelTranslationKey":"request","deepLinkSuffix":"request"},{"nodeType":"markdoc","content":"Get the current API version."}],"panels":[{"children":[{"kind":"code-sample","source":{"kind":"code-sample","operationType":"http","method":"GET","path":"/version","servers":[{"url":"/_mock/apis/platform/api","description":"Mock server","isMockServer":true},{"url":"https://api.vilna.io/v2","description":"Vilna API."}],"parameters":{"path":[],"query":[],"querystring":[],"header":[],"cookie":[]},"security":[],"responseCodes":["200","400","503","default"],"pointer":"/version","href":"version/get-version","openApiOperationId":"get-version","summary":"Get service version"},"isWebhook":false,"hideReplay":false,"servers":[{"url":"/_mock/apis/platform/api","description":"Mock server","isMockServer":true},{"url":"https://api.vilna.io/v2","description":"Vilna API."}],"examples":[]}]}]},{"nodeType":"container","children":[{"nodeType":"header","level":4,"label":"Responses","labelTranslationKey":"responses","deepLinkSuffix":"responses"},{"nodeType":"item-content","variant":"responses","responses":[{"code":"200","description":"Service version info.","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"schema_85","exampleIds":["paths/~1version/get/responses/200/content/application~1json/example"]}},"schemaId":"schema_85","exampleIds":["paths/~1version/get/responses/200/content/application~1json/example"]},{"code":"400","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Bad request (e.g., missing or invalid fields). Invalid text may be reported as address.label_invalid, address.meta_invalid, public_key.label_invalid, invoice.comment_invalid, invoice.metadata_invalid."},"children":[]}]}]}],"mediaType":"application/problem+json","mediaTypes":["application/problem+json"],"mediaTypeContent":{"application/problem+json":{"schemaId":"components/schemas/InvalidRequestProblem","exampleIds":["paths/~1version/get/responses/400/content/application~1problem+json/examples/malformed_json"]}},"schemaId":"components/schemas/InvalidRequestProblem","exampleIds":["paths/~1version/get/responses/400/content/application~1problem+json/examples/malformed_json"]},{"code":"503","description":"The operation is temporarily unavailable. Please try again later.","mediaType":"application/problem+json","mediaTypes":["application/problem+json"],"mediaTypeContent":{"application/problem+json":{"schemaId":"components/schemas/Problem","exampleIds":["paths/~1version/get/responses/503/content/application~1problem+json/examples/temporarily_unavailable"]}},"schemaId":"components/schemas/Problem","exampleIds":["paths/~1version/get/responses/503/content/application~1problem+json/examples/temporarily_unavailable"]},{"code":"default","description":"Unexpected error.","mediaType":"application/problem+json","mediaTypes":["application/problem+json"],"mediaTypeContent":{"application/problem+json":{"schemaId":"components/schemas/Problem"}},"schemaId":"components/schemas/Problem"}],"pointer":"/paths/~1version/get/responses"}],"panels":[{"children":[{"kind":"response","responseCodes":[{"code":"200","schemaId":"schema_85","exampleIds":["paths/~1version/get/responses/200/content/application~1json/example"],"mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"schema_85","exampleIds":["paths/~1version/get/responses/200/content/application~1json/example"]}}},{"code":"400","schemaId":"components/schemas/InvalidRequestProblem","exampleIds":["paths/~1version/get/responses/400/content/application~1problem+json/examples/malformed_json"],"mediaTypes":["application/problem+json"],"mediaTypeContent":{"application/problem+json":{"schemaId":"components/schemas/InvalidRequestProblem","exampleIds":["paths/~1version/get/responses/400/content/application~1problem+json/examples/malformed_json"]}}},{"code":"503","schemaId":"components/schemas/Problem","exampleIds":["paths/~1version/get/responses/503/content/application~1problem+json/examples/temporarily_unavailable"],"mediaTypes":["application/problem+json"],"mediaTypeContent":{"application/problem+json":{"schemaId":"components/schemas/Problem","exampleIds":["paths/~1version/get/responses/503/content/application~1problem+json/examples/temporarily_unavailable"]}}},{"code":"default","schemaId":"components/schemas/Problem","mediaTypes":["application/problem+json"],"mediaTypeContent":{"application/problem+json":{"schemaId":"components/schemas/Problem"}}}],"examples":[]}]}]},{"nodeType":"container","children":[{"nodeType":"feedback","pageSlug":"/version/get-version"}],"panels":[]}]},"httpPath":"/version"}],"content":{"contentType":"group","meta":{"name":"version"},"children":[{"nodeType":"container","children":[{"nodeType":"header","level":2,"label":"Version","showPageActions":true},{"nodeType":"markdoc","content":"Service version information."}],"panels":[{"children":[{"kind":"group-items","title":"Operations","titleTranslationKey":"operations","items":[{"title":"/version","summary":"Get service version","prefix":{"name":"get","color":"get"},"badges":[],"link":"/version/get-version","deprecated":false}]}]}]}]}}],"store":{"schemaStore":{"components/schemas/ProblemType":{"id":"components/schemas/ProblemType","kind":"json-schema","title":"ProblemType","data":{"type":"string","format":"uri","description":"A URI that identifies the error type.\n","example":"https://docs.vilna.io/apis/errors#internal-error"}},"components/schemas/ProblemTitle":{"id":"components/schemas/ProblemTitle","kind":"json-schema","title":"ProblemTitle","data":{"type":"string","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"A short summary of the error type."},"children":[]},{"$$mdtype":"Node","type":"softbreak","inline":true,"attributes":{},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Use "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"detail"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" for information specific to this occurrence."},"children":[]}]}]}],"example":"Bad Request"}},"components/schemas/ProblemStatus":{"id":"components/schemas/ProblemStatus","kind":"json-schema","title":"ProblemStatus","data":{"type":"integer","description":"The HTTP status code for this error.\nMatches the status code of the HTTP response.\n","example":400}},"components/schemas/ProblemDetail":{"id":"components/schemas/ProblemDetail","kind":"json-schema","title":"ProblemDetail","data":{"type":"string","description":"A human-readable explanation of what went wrong in this specific case.\nMay be localized.\n","example":"The address is already assigned to another invoice"}},"components/schemas/ProblemInstance":{"id":"components/schemas/ProblemInstance","kind":"json-schema","title":"ProblemInstance","data":{"type":"string","description":"A URI that identifies this specific error occurrence.\nInclude this value when contacting support.\n","example":"/traces/0123456789abcdef0123456789abcdef"}},"components/schemas/ProblemCode":{"id":"components/schemas/ProblemCode","kind":"json-schema","title":"ProblemCode","data":{"type":"string","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Stable machine-readable error code for programmatic error handling. Unlike the HTTP "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"status"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" or free-form "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"detail"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":", this code is guaranteed not to change between versions for a given error condition, so it is safe to branch on in client code. Defaults to "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"unspecified"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" when the server has not assigned a specific code."},"children":[]}]}]}],"default":"unspecified","example":"blockchain.not_found"}},"components/schemas/Problem":{"id":"components/schemas/Problem","kind":"json-schema","title":"Problem","data":{"type":"object","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Error response following "},"children":[]},{"$$mdtype":"Node","type":"link","inline":true,"attributes":{"href":"https://tools.ietf.org/rfc/rfc7807.txt"},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"RFC 7807"},"children":[]}]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":". Served with "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"Content-Type: application/problem+json"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":". All error responses use this format; branch on "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"code"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" for programmatic handling and surface "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"detail"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" to end users."},"children":[]}]}]}],"required":["type","title","status","code"],"properties":{"type":{"$ref":"#/components/schemas/ProblemType"},"title":{"$ref":"#/components/schemas/ProblemTitle"},"status":{"$ref":"#/components/schemas/ProblemStatus"},"detail":{"$ref":"#/components/schemas/ProblemDetail"},"instance":{"$ref":"#/components/schemas/ProblemInstance"},"code":{"$ref":"#/components/schemas/ProblemCode"}}}},"components/schemas/ResourceQuota":{"id":"components/schemas/ResourceQuota","kind":"json-schema","title":"ResourceQuota","data":{"type":"object","description":"Current resource usage and effective limit. Usage may exceed a reduced limit.","required":["used","max"],"properties":{"used":{"type":"integer","format":"int64","minimum":0,"description":"Number of resources consuming the quota."},"max":{"type":"integer","format":"int32","minimum":0,"description":"Effective limit. Zero prevents new resources."}}}},"components/schemas/ProjectLimits":{"id":"components/schemas/ProjectLimits","kind":"json-schema","title":"ProjectLimits","data":{"type":"object","description":"Disabled subscriptions and channels and child public keys count toward usage. Open invoices count occupied payment windows. Trusted assets count project trust entries.","required":["addresses","subscriptions","open_invoices","channels","public_keys","address_tags","token_tags","trusted_assets"],"properties":{"addresses":{"$ref":"#/components/schemas/ResourceQuota"},"subscriptions":{"$ref":"#/components/schemas/ResourceQuota"},"open_invoices":{"$ref":"#/components/schemas/ResourceQuota"},"channels":{"$ref":"#/components/schemas/ResourceQuota"},"public_keys":{"$ref":"#/components/schemas/ResourceQuota"},"address_tags":{"$ref":"#/components/schemas/ResourceQuota"},"token_tags":{"$ref":"#/components/schemas/ResourceQuota"},"trusted_assets":{"$ref":"#/components/schemas/ResourceQuota"}}}},"components/schemas/InvalidRequestProblem":{"id":"components/schemas/InvalidRequestProblem","kind":"json-schema","title":"InvalidRequestProblem","data":{"type":"object","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Problem details for invalid request errors (400 Bad Request)."},"children":[]}]}]},{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Extends base Problem with field-specific validation error details"},"children":[]},{"$$mdtype":"Node","type":"softbreak","inline":true,"attributes":{},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"following "},"children":[]},{"$$mdtype":"Node","type":"link","inline":true,"attributes":{"href":"https://tools.ietf.org/rfc/rfc7807.txt"},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"RFC 7807"},"children":[]}]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"."},"children":[]}]}]}],"required":["type","title","status","code"],"properties":{"type":{"$ref":"#/components/schemas/ProblemType","example":"https://docs.vilna.io/apis/errors#invalid-request"},"title":{"$ref":"#/components/schemas/ProblemTitle","example":"Invalid Request"},"status":{"$ref":"#/components/schemas/ProblemStatus","example":400},"detail":{"$ref":"#/components/schemas/ProblemDetail","example":"Validation error"},"instance":{"$ref":"#/components/schemas/ProblemInstance"},"code":{"$ref":"#/components/schemas/ProblemCode","example":"blockchain.name_too_long"},"fields":{"type":"array","description":"List of invalid fields in the request.","items":{"type":"object","required":["name","reason"],"properties":{"name":{"type":"string","description":"The name of the invalid field.","example":"max_len"},"reason":{"type":"string","description":"Why this field is invalid.","example":"32"}}}}}}},"components/schemas/UnauthorizedProblem":{"id":"components/schemas/UnauthorizedProblem","kind":"json-schema","title":"UnauthorizedProblem","data":{"type":"object","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Standard problem response when authentication is missing or invalid,"},"children":[]},{"$$mdtype":"Node","type":"softbreak","inline":true,"attributes":{},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"following "},"children":[]},{"$$mdtype":"Node","type":"link","inline":true,"attributes":{"href":"https://tools.ietf.org/rfc/rfc7807.txt"},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"RFC 7807"},"children":[]}]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"."},"children":[]}]}]}],"required":["type","title","status","code"],"properties":{"type":{"$ref":"#/components/schemas/ProblemType","example":"https://docs.vilna.io/apis/errors#unauthorized"},"title":{"$ref":"#/components/schemas/ProblemTitle","example":"Unauthorized"},"status":{"$ref":"#/components/schemas/ProblemStatus","example":401},"detail":{"$ref":"#/components/schemas/ProblemDetail","example":"Missing or invalid authentication credentials"},"instance":{"$ref":"#/components/schemas/ProblemInstance"},"code":{"$ref":"#/components/schemas/ProblemCode","example":"auth.unauthorized"}}}},"components/schemas/ForbiddenProblem":{"id":"components/schemas/ForbiddenProblem","kind":"json-schema","title":"ForbiddenProblem","data":{"type":"object","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Standard problem response when the authenticated user lacks permission"},"children":[]},{"$$mdtype":"Node","type":"softbreak","inline":true,"attributes":{},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"to access the requested resource, following "},"children":[]},{"$$mdtype":"Node","type":"link","inline":true,"attributes":{"href":"https://tools.ietf.org/rfc/rfc7807.txt"},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"RFC 7807"},"children":[]}]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"."},"children":[]}]}]}],"required":["type","title","status","code"],"properties":{"type":{"$ref":"#/components/schemas/ProblemType","example":"https://docs.vilna.io/apis/errors#forbidden"},"title":{"$ref":"#/components/schemas/ProblemTitle","example":"Forbidden"},"status":{"$ref":"#/components/schemas/ProblemStatus","example":403},"detail":{"$ref":"#/components/schemas/ProblemDetail","example":"You do not have permission to perform this action"},"instance":{"$ref":"#/components/schemas/ProblemInstance"},"code":{"$ref":"#/components/schemas/ProblemCode","example":"chain.not_allowed"}}}},"components/schemas/ChainFamily":{"id":"components/schemas/ChainFamily","kind":"json-schema","title":"ChainFamily","data":{"description":"Chain family that identifies blockchain ecosystems united by common protocol or account model.","enum":["evm","bitcoin","solana","tron"],"x-enumDescriptions":{"evm":"Ethereum Virtual Machine-based blockchains (Ethereum, BSC, Polygon, Arbitrum, etc.).","bitcoin":"Bitcoin and Bitcoin-compatible networks.","solana":"Solana blockchain ecosystem.","tron":"Tron blockchain ecosystem."},"example":"evm","type":"string"}},"components/schemas/ChainGID":{"id":"components/schemas/ChainGID","kind":"json-schema","title":"ChainGID","data":{"type":"string","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Blockchain identifier in "},"children":[]},{"$$mdtype":"Node","type":"link","inline":true,"attributes":{"href":"https://chainagnostic.org/CAIPs/caip-2"},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"CAIP-2"},"children":[]}]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" format."},"children":[]}]}]},{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Format: "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"{namespace}:{reference}"},"children":[]}]}]},{"$$mdtype":"Node","type":"list","attributes":{"ordered":false,"marker":"-"},"children":[{"$$mdtype":"Node","type":"item","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"strong","inline":true,"attributes":{"marker":"**"},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"namespace"},"children":[]}]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":": Ecosystem identifier (3-8 chars, lowercase)"},"children":[]}]}]},{"$$mdtype":"Node","type":"item","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"strong","inline":true,"attributes":{"marker":"**"},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"reference"},"children":[]}]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":": Blockchain identifier within namespace (1-32 chars)"},"children":[]}]}]}]},{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"strong","inline":true,"attributes":{"marker":"**"},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Examples"},"children":[]}]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":":"},"children":[]}]}]},{"$$mdtype":"Node","type":"list","attributes":{"ordered":false,"marker":"-"},"children":[{"$$mdtype":"Node","type":"item","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"eip155:1"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":": Ethereum mainnet"},"children":[]}]}]},{"$$mdtype":"Node","type":"item","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"eip155:56"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":": BNB Smart Chain mainnet"},"children":[]}]}]},{"$$mdtype":"Node","type":"item","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"eip155:137"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":": Polygon mainnet"},"children":[]}]}]},{"$$mdtype":"Node","type":"item","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"bip122:000000000019d6689c085ae165831e93"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":": Bitcoin mainnet"},"children":[]}]}]},{"$$mdtype":"Node","type":"item","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"tron:728126428"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":": Tron mainnet"},"children":[]}]}]}]}],"pattern":"^[-a-z0-9]{3,8}:[-_a-zA-Z0-9]{1,32}$","example":"eip155:1"}},"components/schemas/Blockchain":{"id":"components/schemas/Blockchain","kind":"json-schema","title":"Blockchain","data":{"description":"Blockchain details.","properties":{"gid":{"$ref":"#/components/schemas/ChainGID"},"image_url":{"description":"Blockchain logo URL.","format":"uri","type":"string"},"name":{"description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Blockchain name identifier (for example, "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"ethereum"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":")."},"children":[]}]}]}],"type":"string","minLength":1,"maxLength":32},"short_name":{"description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Short blockchain identifier (for example, "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"eth"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":")."},"children":[]}]}]}],"type":"string","minLength":1,"maxLength":32}},"required":["gid","name","short_name","image_url"],"type":"object","example":{"gid":"eip155:1","name":"ethereum","short_name":"eth","image_url":"https://raw.githubusercontent.com/vilna-io/icons/refs/heads/main/chains/ethereum.svg"}}},"components/schemas/PaginationMeta":{"id":"components/schemas/PaginationMeta","kind":"json-schema","title":"PaginationMeta","data":{"type":"object","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Pagination metadata returned on every list response. "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"page"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" and "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"limit"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" echo the values used to build this page (defaults are applied when the request omits them). "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"total"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" and "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"total_pages"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" reflect the full result set after any filters are applied."},"children":[]}]}]}],"properties":{"limit":{"description":"Page size used to build this response.","type":"integer","format":"uint","minimum":1},"page":{"description":"Index of the page returned, starting at 1.","type":"integer","format":"uint","minimum":1},"total":{"description":"Total number of items matching the request across all pages.","type":"integer","format":"uint","minimum":0},"total_pages":{"description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Total number of pages available at the current "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"limit"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"."},"children":[]}]}]}],"type":"integer","format":"uint","minimum":0}},"required":["total","page","limit","total_pages"],"example":{"limit":20,"page":1,"total":42,"total_pages":3}}},"components/schemas/NotFoundProblem":{"id":"components/schemas/NotFoundProblem","kind":"json-schema","title":"NotFoundProblem","data":{"type":"object","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Problem details for not found errors (404 Not Found)."},"children":[]}]}]},{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Standard problem response when requested resource does not exist"},"children":[]},{"$$mdtype":"Node","type":"softbreak","inline":true,"attributes":{},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"following "},"children":[]},{"$$mdtype":"Node","type":"link","inline":true,"attributes":{"href":"https://tools.ietf.org/rfc/rfc7807.txt"},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"RFC 7807"},"children":[]}]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"."},"children":[]}]}]}],"required":["type","title","status","code"],"properties":{"type":{"$ref":"#/components/schemas/ProblemType","example":"https://docs.vilna.io/apis/errors#not-found"},"title":{"$ref":"#/components/schemas/ProblemTitle","example":"Not Found"},"status":{"$ref":"#/components/schemas/ProblemStatus","example":404},"detail":{"$ref":"#/components/schemas/ProblemDetail","example":"The requested resource was not found"},"instance":{"$ref":"#/components/schemas/ProblemInstance"},"code":{"$ref":"#/components/schemas/ProblemCode","example":"blockchain.not_found"}}}},"components/schemas/UUID":{"id":"components/schemas/UUID","kind":"json-schema","title":"UUID","data":{"type":"string","format":"uuid","description":"Unique identifier (UUID).","example":"550e8400-e29b-41d4-a716-446655440000"}},"components/schemas/PublicKeyValue":{"id":"components/schemas/PublicKeyValue","kind":"json-schema","title":"PublicKeyValue","data":{"description":"BIP32/SLIP-0132 extended public key in Base58Check format.\n","type":"string","pattern":"^(xpub|ypub|zpub|tpub|vpub|upub)[1-9A-HJ-NP-Za-km-z]{100,108}$","examples":["xpub6EFxzN6ZgMCZ1PxeRigmAhm2UBGzXtZNgznCEaWuEt9efBpJwAXFA4ZckBdR1pdMQ1pBgsey7ebjToZ5gYXveftB3zwoQ8NvEkimvyaz34i","ypub6ZtCaoXpd9GqsJMiFThRchS8RXiyRBD3WxyoZhhnKF9n198VSV8U38TPrrhMenYSXZGU4N8Q5J1XYEjc4JKr8Dj1BtvhCjNTRxPimrfCN4T","zpub6svdUH71uTR9YXumEJroNo51GfHdASMmzKFafeBr51yEzf4gj4cPBafQDjk18AGTZSfhXi8uMuuZKpSdmzHjZDTDCVK3KjVYj1NKUTFfCkk","tpub6EFxzN6ZgMCZ1PxeRigmAhm2UBGzXtZNgznCEaWuEt9efBpJwAXFA4ZckBdR1pdMQ1pBgsey7ebjToZ5gYXveftB3zwoQ8NvEkimvyaz34i"]}},"components/schemas/PublicKeyLabel":{"id":"components/schemas/PublicKeyLabel","kind":"json-schema","title":"PublicKeyLabel","data":{"description":"User-friendly label for the public key.","maxLength":32,"minLength":1,"type":"string","example":"Main Bitcoin Wallet"}},"components/schemas/PublicKeyDerivationPath":{"id":"components/schemas/PublicKeyDerivationPath","kind":"json-schema","title":"PublicKeyDerivationPath","data":{"description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"HD derivation path in BIP-44 format. Supports both account-level ("},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"m/purpose'/coin_type'/account'"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":")"},"children":[]},{"$$mdtype":"Node","type":"softbreak","inline":true,"attributes":{},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"and change-level ("},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"m/purpose'/coin_type'/account'/change"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":") paths."},"children":[]}]}]},{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Account-level paths (depth-3) represent HD wallet accounts and cannot derive addresses directly:"},"children":[]},{"$$mdtype":"Node","type":"softbreak","inline":true,"attributes":{},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"use the children endpoint to create change-level child keys first."},"children":[]}]}]}],"pattern":"^m/(44|49|84|86)'/\\d+'/\\d+'(/\\d+)?$","type":"string","examples":["m/44'/0'/0'/0","m/44'/60'/0'/0","m/44'/137'/0'/0","m/49'/0'/0'/0","m/84'/0'/0'","m/84'/0'/0'/0","m/86'/0'/0'/0"]}},"components/schemas/PublicKey":{"id":"components/schemas/PublicKey","kind":"json-schema","title":"PublicKey","data":{"type":"object","description":"HD public key used to derive child addresses.\n","properties":{"id":{"$ref":"#/components/schemas/UUID"},"value":{"$ref":"#/components/schemas/PublicKeyValue"},"label":{"$ref":"#/components/schemas/PublicKeyLabel"},"derivation_path":{"$ref":"#/components/schemas/PublicKeyDerivationPath"},"children":{"description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Child keys derived from this account-level key. Present only for account-level keys (depth-3)."},"children":[]},{"$$mdtype":"Node","type":"softbreak","inline":true,"attributes":{},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Each child represents an external (change=0) or internal (change=1) chain."},"children":[]}]}]}],"type":"array","items":{"$ref":"#/components/schemas/PublicKey"}},"created_at":{"$ref":"#/components/schemas/CreatedAt"},"updated_at":{"$ref":"#/components/schemas/UpdatedAt"}},"required":["id","value","label","derivation_path","created_at","updated_at"],"example":{"id":"550e8400-e29b-41d4-a716-446655440000","value":"xpub6EFxzN6ZgMCZ1PxeRigmAhm2UBGzXtZNgznCEaWuEt9efBpJwAXFA4ZckBdR1pdMQ1pBgsey7ebjToZ5gYXveftB3zwoQ8NvEkimvyaz34i","label":"Main Bitcoin Wallet","derivation_path":"m/84'/0'/0'","children":[{"id":"660e8400-e29b-41d4-a716-446655440001","value":"xpub6F7C1ZtQ411zykk6KTEoQMqfNdxiSA4uxAwAoqFanijnAavqQvVmh5zZCH6Swhdbzt2HuMRLx4chEVRZu9ic4Cnkkq5AsQcmjeMASk6FLqf","label":"external","derivation_path":"m/84'/0'/0'/0","created_at":"2025-01-15T12:00:00Z","updated_at":"2025-01-15T12:00:00Z"}],"created_at":"2025-01-15T12:00:00Z","updated_at":"2025-01-15T12:00:00Z"}}},"components/schemas/CreatedAt":{"id":"components/schemas/CreatedAt","kind":"json-schema","title":"CreatedAt","data":{"description":"Timestamp when the resource was created.","format":"date-time","type":"string","example":"2024-01-15T10:30:00Z"}},"components/schemas/UpdatedAt":{"id":"components/schemas/UpdatedAt","kind":"json-schema","title":"UpdatedAt","data":{"description":"Timestamp when the resource was last updated.","format":"date-time","type":"string","example":"2024-01-15T10:30:00Z"}},"components/schemas/CreatePublicKeyRequest":{"id":"components/schemas/CreatePublicKeyRequest","kind":"json-schema","title":"CreatePublicKeyRequest","data":{"type":"object","description":"Public key creation payload.","properties":{"derivation_path":{"$ref":"#/components/schemas/PublicKeyDerivationPath"},"label":{"$ref":"#/components/schemas/PublicKeyLabel"},"value":{"$ref":"#/components/schemas/PublicKeyValue"}},"required":["value","label","derivation_path"],"additionalProperties":false}},"components/schemas/ConflictProblem":{"id":"components/schemas/ConflictProblem","kind":"json-schema","title":"ConflictProblem","data":{"type":"object","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Problem details for conflict errors (409 Conflict)."},"children":[]}]}]},{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Standard problem response when request conflicts with current server state"},"children":[]},{"$$mdtype":"Node","type":"softbreak","inline":true,"attributes":{},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"following "},"children":[]},{"$$mdtype":"Node","type":"link","inline":true,"attributes":{"href":"https://tools.ietf.org/rfc/rfc7807.txt"},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"RFC 7807"},"children":[]}]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"."},"children":[]}]}]}],"required":["type","title","status","code"],"properties":{"type":{"$ref":"#/components/schemas/ProblemType","example":"https://docs.vilna.io/apis/errors#conflict"},"title":{"$ref":"#/components/schemas/ProblemTitle","example":"Conflict"},"status":{"$ref":"#/components/schemas/ProblemStatus","example":409},"detail":{"$ref":"#/components/schemas/ProblemDetail","example":"Resource already exists with the same identifier"},"instance":{"$ref":"#/components/schemas/ProblemInstance"},"code":{"$ref":"#/components/schemas/ProblemCode","example":"invoice.address_occupied"}}}},"components/schemas/PreconditionProblem":{"id":"components/schemas/PreconditionProblem","kind":"json-schema","title":"PreconditionProblem","data":{"type":"object","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Problem details for precondition failed errors (422 Unprocessable Entity)."},"children":[]}]}]},{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Standard problem response when request cannot be processed due to failed"},"children":[]},{"$$mdtype":"Node","type":"softbreak","inline":true,"attributes":{},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"business rule validation following "},"children":[]},{"$$mdtype":"Node","type":"link","inline":true,"attributes":{"href":"https://tools.ietf.org/rfc/rfc7807.txt"},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"RFC 7807"},"children":[]}]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"."},"children":[]}]}]}],"required":["type","title","status","code"],"properties":{"type":{"$ref":"#/components/schemas/ProblemType","example":"https://docs.vilna.io/apis/errors#precondition"},"title":{"$ref":"#/components/schemas/ProblemTitle","example":"Precondition Failed"},"status":{"$ref":"#/components/schemas/ProblemStatus","example":422},"detail":{"$ref":"#/components/schemas/ProblemDetail","example":"The request cannot be processed due to failed business rule validation"},"instance":{"$ref":"#/components/schemas/ProblemInstance"},"code":{"$ref":"#/components/schemas/ProblemCode","example":"simulation.failed"},"fields":{"type":"array","description":"List of fields that failed precondition validation.","items":{"type":"object","required":["name","reason"],"properties":{"name":{"type":"string","description":"The name of the field that failed validation.","example":"status"},"reason":{"type":"string","description":"Why the precondition failed for this field.","example":"Cannot transition from archived to active state"}}}}}}},"components/schemas/QuotaProblemCode":{"id":"components/schemas/QuotaProblemCode","kind":"json-schema","title":"QuotaProblemCode","data":{"type":"string","description":"Stable machine-readable code identifying the exhausted resource quota. The code is always\nsupplied by the service; clients branch on it instead of the human-readable detail.\n","example":"address.quota_exceeded"}},"components/schemas/QuotaExceededProblem":{"id":"components/schemas/QuotaExceededProblem","kind":"json-schema","title":"QuotaExceededProblem","data":{"type":"object","description":"Resource quota exceeded (429 Too Many Requests). The quota applies to the resource and scope\nidentified by the operation and code. Waiting alone does not free capacity; reduce usage or\narrange a limit change before retrying. The same shape serves API and management quotas.\n","required":["type","title","status","code","max"],"properties":{"type":{"$ref":"#/components/schemas/ProblemType"},"title":{"$ref":"#/components/schemas/ProblemTitle"},"status":{"$ref":"#/components/schemas/ProblemStatus"},"detail":{"$ref":"#/components/schemas/ProblemDetail"},"instance":{"$ref":"#/components/schemas/ProblemInstance"},"code":{"$ref":"#/components/schemas/QuotaProblemCode"},"max":{"type":"integer","format":"int32","minimum":0,"description":"Effective maximum for this resource in the caller's scope. Zero prohibits new admissions;\nit does not disable resources already held. This is the configured limit, not current usage.\n","example":100}}}},"components/schemas/UpdatePublicKeyRequest":{"id":"components/schemas/UpdatePublicKeyRequest","kind":"json-schema","title":"UpdatePublicKeyRequest","data":{"type":"object","description":"Public key update payload.","properties":{"label":{"$ref":"#/components/schemas/PublicKeyLabel"}},"additionalProperties":false}},"components/schemas/PublicKeyChildChange":{"id":"components/schemas/PublicKeyChildChange","kind":"json-schema","title":"PublicKeyChildChange","data":{"description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"BIP-44 change index for child key derivation."},"children":[]},{"$$mdtype":"Node","type":"softbreak","inline":true,"attributes":{},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"0"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" = external chain (receiving addresses), "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"1"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" = internal chain (change addresses)."},"children":[]}]}]}],"type":"integer","enum":[0,1],"x-enumDescriptions":{"0":"External chain (receiving addresses).","1":"Internal chain (change addresses)."},"example":0}},"components/schemas/CreatePublicKeyChildRequest":{"id":"components/schemas/CreatePublicKeyChildRequest","kind":"json-schema","title":"CreatePublicKeyChildRequest","data":{"type":"object","description":"Create a child key from an account-level public key.\nThe server derives the child extended public key: no cryptography needed on the client side.\n","properties":{"change":{"$ref":"#/components/schemas/PublicKeyChildChange"},"label":{"$ref":"#/components/schemas/PublicKeyLabel"}},"required":["change","label"],"additionalProperties":false}},"components/schemas/AddressFormat":{"id":"components/schemas/AddressFormat","kind":"json-schema","title":"AddressFormat","data":{"description":"Blockchain address format that determines how the address should be interpreted and validated.","enum":["evm","solana","tron","p2pkh","p2sh","p2wpkh","p2wsh","p2tr","p2pkh-testnet","p2sh-testnet","p2wpkh-testnet","p2wsh-testnet","p2tr-testnet"],"x-enumDescriptions":{"evm":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"EVM-compatible address (Ethereum, BSC, Polygon, Arbitrum). Format: 0x + 40 hex chars. Normalized to EIP-55 checksum on import."},"children":[]}]}]}],"solana":"Solana address. Format: Base58 encoded, 32-44 characters.","tron":"Tron address. Format: Base58 encoded, starts with T.","p2pkh":"Pay-to-Public-Key-Hash (Legacy). Starts with 1.","p2sh":"Pay-to-Script-Hash. Starts with 3.","p2wpkh":"Pay-to-Witness-Public-Key-Hash (Native SegWit). Starts with bc1q, 42 characters.","p2wsh":"Pay-to-Witness-Script-Hash (Native SegWit). Starts with bc1q, 62 characters.","p2tr":"Pay-to-Taproot (BIP-341). Starts with bc1p, 62 characters.","p2pkh-testnet":"Pay-to-Public-Key-Hash (Legacy testnet). Starts with m or n.","p2sh-testnet":"Pay-to-Script-Hash (testnet). Starts with 2.","p2wpkh-testnet":"Pay-to-Witness-Public-Key-Hash (Native SegWit testnet). Starts with tb1q, 42 characters.","p2wsh-testnet":"Pay-to-Witness-Script-Hash (Native SegWit testnet). Starts with tb1q, 62 characters.","p2tr-testnet":"Pay-to-Taproot (BIP-341 testnet). Starts with tb1p, 62 characters."},"example":"p2wpkh","type":"string"}},"components/schemas/AddressValue":{"id":"components/schemas/AddressValue","kind":"json-schema","title":"AddressValue","data":{"description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Blockchain address in its native format."},"children":[]}]}]},{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"strong","inline":true,"attributes":{"marker":"**"},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Format by network"},"children":[]}]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":":"},"children":[]}]}]},{"$$mdtype":"Node","type":"list","attributes":{"ordered":false,"marker":"-"},"children":[{"$$mdtype":"Node","type":"item","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"strong","inline":true,"attributes":{"marker":"**"},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"EVM"},"children":[]}]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":": "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"0x"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" + 40 hex chars (normalized to "},"children":[]},{"$$mdtype":"Node","type":"link","inline":true,"attributes":{"href":"https://eips.ethereum.org/EIPS/eip-55"},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"EIP-55"},"children":[]}]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" checksum on import)"},"children":[]}]}]},{"$$mdtype":"Node","type":"item","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"strong","inline":true,"attributes":{"marker":"**"},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Bitcoin"},"children":[]}]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":": P2PKH (1...), P2SH (3...), P2WPKH (bc1...)"},"children":[]}]}]},{"$$mdtype":"Node","type":"item","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"strong","inline":true,"attributes":{"marker":"**"},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Solana"},"children":[]}]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":": Base58, 32-44 chars"},"children":[]}]}]},{"$$mdtype":"Node","type":"item","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"strong","inline":true,"attributes":{"marker":"**"},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Tron"},"children":[]}]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":": Base58, starts with "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"T"},"children":[]}]}]}]}],"type":"string","minLength":1,"maxLength":128,"pattern":"^[a-zA-Z0-9]+$","example":"0x8521E8b15eCEF4D4269Fded3E6694225E096959E"}},"components/schemas/AddressLabel":{"id":"components/schemas/AddressLabel","kind":"json-schema","title":"AddressLabel","data":{"description":"User-friendly label for the address.","maxLength":32,"type":"string","example":"user_deposit_wallet"}},"components/schemas/AddressKind":{"id":"components/schemas/AddressKind","kind":"json-schema","title":"AddressKind","data":{"description":"Kind of address.","enum":["hd","external"],"x-enumDescriptions":{"hd":"HD (Hierarchical Deterministic) address derived from an extended public key.","external":"Externally managed address imported directly or from a raw public key."},"example":"hd","type":"string"}},"components/schemas/AddressMeta":{"id":"components/schemas/AddressMeta","kind":"json-schema","title":"AddressMeta","data":{"type":"object","description":"Optional key-value pairs attached to the address for tracking user associations,\nsource information, or custom application data.\nThe combined UTF-8 size of the decoded keys and values must not exceed 4096 bytes.\n","additionalProperties":{"type":"string"},"example":{"user_id":"12345","source":"exchange","category":"trading"}}},"components/schemas/Address":{"id":"components/schemas/Address","kind":"json-schema","title":"Address","data":{"type":"object","description":"Blockchain address that can be monitored for transactions.","properties":{"value":{"$ref":"#/components/schemas/AddressValue"},"format":{"$ref":"#/components/schemas/AddressFormat"},"label":{"$ref":"#/components/schemas/AddressLabel"},"kind":{"$ref":"#/components/schemas/AddressKind"},"meta":{"$ref":"#/components/schemas/AddressMeta"},"tag_ids":{"type":"array","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"IDs of the address tags assigned to this address. The full tag for each ID is included in "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"references.address_tags"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"."},"children":[]}]}]}],"items":{"$ref":"#/components/schemas/UUID"}},"created_at":{"$ref":"#/components/schemas/CreatedAt"},"updated_at":{"$ref":"#/components/schemas/UpdatedAt"}},"required":["value","format","kind","tag_ids","created_at","updated_at"],"example":{"value":"0x8521E8b15eCEF4D4269Fded3E6694225E096959E","format":"evm","label":"cold_wallet","kind":"external","tag_ids":["3fa85f64-5717-4562-b3fc-2c963f66afa6"],"meta":{"exchange":"binance","type":"withdrawal"},"created_at":"2025-07-03T14:20:00Z","updated_at":"2025-07-03T14:20:00Z"}}},"components/schemas/HDAddress":{"id":"components/schemas/HDAddress","kind":"json-schema","title":"HDAddress","data":{"allOf":[{"$ref":"#/components/schemas/Address"},{"type":"object","properties":{"kind":{"type":"string","enum":["hd"]},"public_key_id":{"$ref":"#/components/schemas/UUID","description":"ID of the public key used to derive this HD address."},"derivation_index":{"type":"integer","format":"uint32","minimum":0,"maximum":2147483647,"description":"Index used for address derivation from the public key.","example":0}},"required":["kind","public_key_id","derivation_index"]}],"description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"HD address derived from a public key using "},"children":[]},{"$$mdtype":"Node","type":"link","inline":true,"attributes":{"href":"https://github.com/bitcoin/bips/blob/master/bip-0032.mediawiki"},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"BIP32"},"children":[]}]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"/"},"children":[]},{"$$mdtype":"Node","type":"link","inline":true,"attributes":{"href":"https://github.com/bitcoin/bips/blob/master/bip-0044.mediawiki"},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"BIP44"},"children":[]}]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"/"},"children":[]},{"$$mdtype":"Node","type":"link","inline":true,"attributes":{"href":"https://github.com/bitcoin/bips/blob/master/bip-0049.mediawiki"},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"BIP49"},"children":[]}]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"/"},"children":[]},{"$$mdtype":"Node","type":"link","inline":true,"attributes":{"href":"https://github.com/bitcoin/bips/blob/master/bip-0084.mediawiki"},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"BIP84"},"children":[]}]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"/"},"children":[]},{"$$mdtype":"Node","type":"link","inline":true,"attributes":{"href":"https://github.com/bitcoin/bips/blob/master/bip-0086.mediawiki"},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"BIP86"},"children":[]}]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" standards."},"children":[]}]}]},{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"For Bitcoin addresses, the BIP standard determines the address type:"},"children":[]}]}]},{"$$mdtype":"Node","type":"list","attributes":{"ordered":false,"marker":"-"},"children":[{"$$mdtype":"Node","type":"item","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"BIP44: Legacy P2PKH"},"children":[]}]}]},{"$$mdtype":"Node","type":"item","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"BIP49: SegWit P2SH-P2WPKH"},"children":[]}]}]},{"$$mdtype":"Node","type":"item","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"BIP84: Native SegWit P2WPKH"},"children":[]}]}]},{"$$mdtype":"Node","type":"item","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"BIP86: Taproot P2TR"},"children":[]}]}]}]}],"example":{"value":"bc1q8faxe8g4u2v67qfwf9d8xhyl5tkkkphvet6r08","format":"p2wpkh","label":"user_45_deposit","kind":"hd","public_key_id":"123e4567-e89b-12d3-a456-426614174000","derivation_index":0,"tag_ids":["3fa85f64-5717-4562-b3fc-2c963f66afa6"],"meta":{"user_id":"45","purpose":"deposit"},"created_at":"2025-07-03T12:45:00Z","updated_at":"2025-07-03T13:15:22Z"}}},"components/schemas/AddressTagName":{"id":"components/schemas/AddressTagName","kind":"json-schema","title":"AddressTagName","data":{"type":"string","description":"Display name for the address tag.","minLength":1,"maxLength":32,"example":"Hot Wallets"}},"components/schemas/AddressTag":{"id":"components/schemas/AddressTag","kind":"json-schema","title":"AddressTag","data":{"type":"object","description":"A named collection of addresses within a project.","properties":{"id":{"$ref":"#/components/schemas/UUID"},"name":{"$ref":"#/components/schemas/AddressTagName"},"created_at":{"$ref":"#/components/schemas/CreatedAt"},"updated_at":{"$ref":"#/components/schemas/UpdatedAt"}},"required":["id","name","created_at","updated_at"]}},"components/schemas/AddressReferences":{"id":"components/schemas/AddressReferences","kind":"json-schema","title":"AddressReferences","data":{"type":"object","description":"Related objects included in the response, keyed by ID.","properties":{"public_keys":{"type":"object","description":"Map of public keys indexed by their UUID ID.","propertyNames":{"$ref":"#/components/schemas/UUID"},"additionalProperties":{"$ref":"#/components/schemas/PublicKey"}},"address_tags":{"type":"object","description":"Map of address tags indexed by their UUID ID.","propertyNames":{"$ref":"#/components/schemas/UUID"},"additionalProperties":{"$ref":"#/components/schemas/AddressTag"}}},"required":["public_keys","address_tags"],"example":{"public_keys":{},"address_tags":{}}}},"components/schemas/ChainFamilyForGeneration":{"id":"components/schemas/ChainFamilyForGeneration","kind":"json-schema","title":"ChainFamilyForGeneration","data":{"description":"Chain family for HD address generation. Solana is not supported for HD address generation from public keys.\n","enum":["evm","bitcoin","tron"],"x-enumDescriptions":{"evm":"Ethereum Virtual Machine-based blockchains (Ethereum, BSC, Polygon, Arbitrum, etc.).","bitcoin":"Bitcoin and Bitcoin-compatible networks.","tron":"Tron blockchain ecosystem."},"example":"evm","type":"string"}},"components/schemas/HDAddressRangeSelection":{"id":"components/schemas/HDAddressRangeSelection","kind":"json-schema","title":"HDAddressRangeSelection","data":{"type":"object","description":"A contiguous range of derivation indexes.","properties":{"kind":{"type":"string","enum":["range"],"description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Selection kind, the discriminator of "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"HDAddressSelection"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"."},"children":[]}]}]}]},"start_index":{"type":"integer","format":"uint32","minimum":0,"maximum":2147483647,"description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"First derivation index, inclusive. "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"start_index + count - 1"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" stays below 2^31, the"},"children":[]},{"$$mdtype":"Node","type":"softbreak","inline":true,"attributes":{},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"non-hardened BIP32 bound."},"children":[]}]}]}],"example":100},"count":{"type":"integer","minimum":1,"maximum":1000,"description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Number of addresses to generate from "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"start_index"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"."},"children":[]}]}]}],"example":50}},"required":["kind","start_index","count"],"additionalProperties":false,"example":{"kind":"range","start_index":100,"count":50}}},"components/schemas/HDAddressNextSelection":{"id":"components/schemas/HDAddressNextSelection","kind":"json-schema","title":"HDAddressNextSelection","data":{"type":"object","description":"The next derivation index the public key has not used yet, one address.","properties":{"kind":{"type":"string","enum":["next"],"description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Selection kind, the discriminator of "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"HDAddressSelection"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"."},"children":[]}]}]}]}},"required":["kind"],"additionalProperties":false,"example":{"kind":"next"}}},"components/schemas/HDAddressSelection":{"id":"components/schemas/HDAddressSelection","kind":"json-schema","title":"HDAddressSelection","data":{"description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Which derivation indexes to generate. "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"kind"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" names the shape."},"children":[]}]}]}],"oneOf":[{"$ref":"#/components/schemas/HDAddressRangeSelection"},{"$ref":"#/components/schemas/HDAddressNextSelection"}],"discriminator":{"propertyName":"kind","mapping":{"range":"#/components/schemas/HDAddressRangeSelection","next":"#/components/schemas/HDAddressNextSelection"}}}},"components/schemas/GenerateHDAddressesRequest":{"id":"components/schemas/GenerateHDAddressesRequest","kind":"json-schema","title":"GenerateHDAddressesRequest","data":{"type":"object","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"HD address generation. "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"selection"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" picks the indexes; "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"label"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" and "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"meta"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" are applied to"},"children":[]},{"$$mdtype":"Node","type":"softbreak","inline":true,"attributes":{},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"every generated address."},"children":[]}]}]}],"properties":{"chain_family":{"$ref":"#/components/schemas/ChainFamilyForGeneration"},"selection":{"$ref":"#/components/schemas/HDAddressSelection"},"label":{"$ref":"#/components/schemas/AddressLabel"},"meta":{"$ref":"#/components/schemas/AddressMeta"}},"required":["chain_family","selection"],"additionalProperties":false,"example":{"chain_family":"evm","selection":{"kind":"next"},"meta":{"user_id":"100","type":"deposit"}}}},"components/schemas/ExternalAddress":{"id":"components/schemas/ExternalAddress","kind":"json-schema","title":"ExternalAddress","data":{"allOf":[{"$ref":"#/components/schemas/Address"},{"type":"object","properties":{"kind":{"type":"string","enum":["external"]}},"required":["kind"]}],"description":"Externally managed address imported for tracking, either directly or from a raw public key.\n","example":{"value":"0xCa79F73628E5D46Cc2c0F6CcD3a3F934d3cE66B7","format":"evm","label":"cold_wallet","kind":"external","tag_ids":["3fa85f64-5717-4562-b3fc-2c963f66afa6"],"meta":{"exchange":"binance","type":"withdrawal"},"created_at":"2025-07-03T14:20:00Z","updated_at":"2025-07-03T14:20:00Z"}}},"components/schemas/AddressUnion":{"id":"components/schemas/AddressUnion","kind":"json-schema","title":"AddressUnion","data":{"oneOf":[{"$ref":"#/components/schemas/HDAddress"},{"$ref":"#/components/schemas/ExternalAddress"}],"discriminator":{"propertyName":"kind","mapping":{"hd":"#/components/schemas/HDAddress","external":"#/components/schemas/ExternalAddress"}}}},"components/schemas/ExternalAddressFromAddress":{"id":"components/schemas/ExternalAddressFromAddress","kind":"json-schema","title":"ExternalAddressFromAddress","data":{"type":"object","description":"Import an address the caller already has.","properties":{"source":{"type":"string","enum":["address"],"description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Input kind, the discriminator of "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"ExternalAddressInput"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"."},"children":[]}]}]}]},"value":{"$ref":"#/components/schemas/AddressValue","description":"Blockchain address to import for tracking."},"chain_family":{"$ref":"#/components/schemas/ChainFamily"}},"required":["source","value","chain_family"],"additionalProperties":false,"example":{"source":"address","value":"0xCa79F73628E5D46Cc2c0F6CcD3a3F934d3cE66B7","chain_family":"evm"}}},"components/schemas/PublicKeyAddressFormat":{"id":"components/schemas/PublicKeyAddressFormat","kind":"json-schema","title":"PublicKeyAddressFormat","data":{"description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Address format to derive from a public key. A subset of "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"AddressFormat"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":": script formats"},"children":[]},{"$$mdtype":"Node","type":"softbreak","inline":true,"attributes":{},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"such as p2wsh cannot be derived from a single key."},"children":[]}]}]}],"type":"string","enum":["evm","tron","solana","p2pkh","p2sh","p2wpkh","p2pkh-testnet","p2sh-testnet","p2wpkh-testnet"],"x-enumDescriptions":{"evm":"EVM-compatible address (Ethereum, BSC, Polygon, Arbitrum). Input: hex secp256k1 public key. Output normalized to EIP-55 checksum.","tron":"Tron address. Input: hex secp256k1 public key.","solana":"Solana address. Input: base58 ed25519 public key.","p2pkh":"Pay-to-Public-Key-Hash (Legacy). Input: hex secp256k1 public key.","p2sh":"Pay-to-Script-Hash (Nested SegWit). Input: hex secp256k1 public key.","p2wpkh":"Pay-to-Witness-Public-Key-Hash (Native SegWit). Input: hex secp256k1 public key.","p2pkh-testnet":"Pay-to-Public-Key-Hash (Legacy testnet). Input: hex secp256k1 public key.","p2sh-testnet":"Pay-to-Script-Hash (testnet). Input: hex secp256k1 public key.","p2wpkh-testnet":"Pay-to-Witness-Public-Key-Hash (Native SegWit testnet). Input: hex secp256k1 public key."},"example":"evm"}},"components/schemas/ExternalAddressFromPublicKey":{"id":"components/schemas/ExternalAddressFromPublicKey","kind":"json-schema","title":"ExternalAddressFromPublicKey","data":{"type":"object","description":"Import the address a raw public key derives to. The key is used for the computation\nonly and is not stored.\n","properties":{"source":{"type":"string","enum":["public_key"],"description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Input kind, the discriminator of "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"ExternalAddressInput"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"."},"children":[]}]}]}]},"public_key":{"type":"string","description":"Raw public key. Hex-encoded for secp256k1 chains (EVM, Tron, Bitcoin), base58-encoded\nfor ed25519 chains (Solana). Compressed (33 bytes) and uncompressed (65 bytes) secp256k1\nkeys are both accepted; the 0x prefix is optional for hex keys.\n","example":"02c6047f9441ed7d6d3045406e95c07cd85c778e4b8cef3ca7abac09b95c709ee5"},"address_format":{"$ref":"#/components/schemas/PublicKeyAddressFormat"}},"required":["source","public_key","address_format"],"additionalProperties":false,"example":{"source":"public_key","public_key":"02c6047f9441ed7d6d3045406e95c07cd85c778e4b8cef3ca7abac09b95c709ee5","address_format":"evm"}}},"components/schemas/ExternalAddressInput":{"id":"components/schemas/ExternalAddressInput","kind":"json-schema","title":"ExternalAddressInput","data":{"description":"What identifies the address to import: the address itself, or the raw public key it\nderives from.\n","oneOf":[{"$ref":"#/components/schemas/ExternalAddressFromAddress"},{"$ref":"#/components/schemas/ExternalAddressFromPublicKey"}],"discriminator":{"propertyName":"source","mapping":{"address":"#/components/schemas/ExternalAddressFromAddress","public_key":"#/components/schemas/ExternalAddressFromPublicKey"}}}},"components/schemas/CreateExternalAddressRequest":{"id":"components/schemas/CreateExternalAddressRequest","kind":"json-schema","title":"CreateExternalAddressRequest","data":{"type":"object","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Body of an external-address creation: the address to import in "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"input"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":", chosen by"},"children":[]},{"$$mdtype":"Node","type":"softbreak","inline":true,"attributes":{},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"source"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":", plus an optional label and metadata."},"children":[]}]}]}],"properties":{"input":{"$ref":"#/components/schemas/ExternalAddressInput"},"label":{"$ref":"#/components/schemas/AddressLabel"},"meta":{"$ref":"#/components/schemas/AddressMeta"}},"required":["input"],"additionalProperties":false,"example":{"input":{"source":"address","value":"0xCa79F73628E5D46Cc2c0F6CcD3a3F934d3cE66B7","chain_family":"evm"},"label":"cold_wallet"}}},"components/schemas/UpdateAddressRequest":{"id":"components/schemas/UpdateAddressRequest","kind":"json-schema","title":"UpdateAddressRequest","data":{"type":"object","description":"Address metadata payload.","properties":{"label":{"$ref":"#/components/schemas/AddressLabel"},"meta":{"$ref":"#/components/schemas/AddressMeta"}},"additionalProperties":false}},"components/schemas/AssetGID":{"id":"components/schemas/AssetGID","kind":"json-schema","title":"AssetGID","data":{"description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Global asset identifier in "},"children":[]},{"$$mdtype":"Node","type":"link","inline":true,"attributes":{"href":"https://chainagnostic.org/CAIPs/caip-19"},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"CAIP-19"},"children":[]}]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" format."},"children":[]}]}]},{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Format: "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"{chain_gid}/{asset_path}"},"children":[]}]}]},{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"strong","inline":true,"attributes":{"marker":"**"},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Examples"},"children":[]}]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":":"},"children":[]}]}]},{"$$mdtype":"Node","type":"list","attributes":{"ordered":false,"marker":"-"},"children":[{"$$mdtype":"Node","type":"item","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"eip155:1/slip44:60"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":": ETH on Ethereum"},"children":[]}]}]},{"$$mdtype":"Node","type":"item","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"eip155:1/erc20:0xdAC17F958D2ee523a2206206994597C13D831ec7"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":": USDT on Ethereum"},"children":[]}]}]},{"$$mdtype":"Node","type":"item","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"eip155:56/erc20:0x55d398326f99059fF775485246999027B3197955"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":": USDT on BNB Smart Chain"},"children":[]}]}]},{"$$mdtype":"Node","type":"item","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"tron:728126428/trc20:TR7NHqjeKQxGTCi8q8ZY4pL8otSzgjLj6t"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":": USDT on Tron"},"children":[]}]}]},{"$$mdtype":"Node","type":"item","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"eip155:137/erc20:0x2791Bca1f2de4661ED88A30C99A7a9449Aa84174"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":": USDC on Polygon"},"children":[]}]}]}]}],"pattern":"^[-a-z0-9]{3,8}:[-_a-zA-Z0-9]{1,32}/[-a-z0-9]{3,8}:[-.%a-zA-Z0-9]{1,128}$","type":"string","example":"eip155:1/erc20:0xdAC17F958D2ee523a2206206994597C13D831ec7"}},"components/schemas/CatalogAssetStatus":{"id":"components/schemas/CatalogAssetStatus","kind":"json-schema","title":"CatalogAssetStatus","data":{"type":"string","description":"Catalog resolution state of an asset.","enum":["pending","supported","unsupported"],"x-enumDescriptions":{"pending":"Only the identity is known; metadata has not been resolved yet.","supported":"Metadata was resolved and the asset is usable normally.","unsupported":"Resolution completed and the chain does not support this asset."},"example":"supported"}},"components/schemas/TokenName":{"id":"components/schemas/TokenName","kind":"json-schema","title":"TokenName","data":{"description":"Full token name (e.g., \"Tether USD\", \"Ethereum\", \"Binance Coin\").","type":"string","minLength":1,"maxLength":64,"examples":["Tether USD","Ethereum","Binance Coin","USD Coin"]}},"components/schemas/TokenSymbol":{"id":"components/schemas/TokenSymbol","kind":"json-schema","title":"TokenSymbol","data":{"description":"Token symbol (e.g., \"USDT\", \"ETH\", \"BNB\").","type":"string","minLength":1,"maxLength":32,"examples":["USDT","ETH","BNB","USDC"]}},"components/schemas/TokenDecimals":{"id":"components/schemas/TokenDecimals","kind":"json-schema","title":"TokenDecimals","data":{"description":"Number of decimal places for the token (e.g., 6 for USDT, 18 for ETH).","maximum":64,"minimum":0,"type":"integer","examples":[18,6,8,0]}},"components/schemas/CatalogAsset":{"id":"components/schemas/CatalogAsset","kind":"json-schema","title":"CatalogAsset","data":{"type":"object","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Catalog entry for a fungible asset, including states that are not yet fully resolved. "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"name"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":", "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"symbol"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":", and "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"decimals"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" are present once "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"status"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" is "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"supported"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"; for other statuses they appear only when already known."},"children":[]}]}]}],"properties":{"gid":{"$ref":"#/components/schemas/AssetGID"},"status":{"$ref":"#/components/schemas/CatalogAssetStatus"},"is_trusted":{"type":"boolean","description":"Explicit selection by the authorized project."},"is_verified":{"type":"boolean","description":"Manual global verification of a non-native asset."},"name":{"$ref":"#/components/schemas/TokenName"},"symbol":{"$ref":"#/components/schemas/TokenSymbol"},"decimals":{"$ref":"#/components/schemas/TokenDecimals"}},"required":["gid","status","is_trusted","is_verified"],"example":{"gid":"eip155:1/erc20:0x0000000000000000000000000000000000000100","status":"supported","is_trusted":true,"is_verified":false,"name":"Example token","symbol":"EXAMPLE","decimals":0}}},"components/schemas/AssetPath":{"id":"components/schemas/AssetPath","kind":"json-schema","title":"AssetPath","data":{"type":"string","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Asset identifier in "},"children":[]},{"$$mdtype":"Node","type":"link","inline":true,"attributes":{"href":"https://chainagnostic.org/CAIPs/caip-19"},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"CAIP-19"},"children":[]}]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" format."},"children":[]}]}]},{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Format: "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"{namespace}:{reference}"},"children":[]}]}]},{"$$mdtype":"Node","type":"list","attributes":{"ordered":false,"marker":"-"},"children":[{"$$mdtype":"Node","type":"item","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"strong","inline":true,"attributes":{"marker":"**"},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"namespace"},"children":[]}]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":": Asset type (3-8 chars, lowercase)"},"children":[]}]}]},{"$$mdtype":"Node","type":"item","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"strong","inline":true,"attributes":{"marker":"**"},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"reference"},"children":[]}]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":": Asset-specific identifier (1-128 chars)"},"children":[]}]}]}]},{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"strong","inline":true,"attributes":{"marker":"**"},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Examples"},"children":[]}]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":":"},"children":[]}]}]},{"$$mdtype":"Node","type":"list","attributes":{"ordered":false,"marker":"-"},"children":[{"$$mdtype":"Node","type":"item","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"slip44:60"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":": Ethereum native token"},"children":[]}]}]},{"$$mdtype":"Node","type":"item","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"erc20:0x6B175474E89094C44Da98b954EedeAC495271d0F"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":": DAI token"},"children":[]}]}]},{"$$mdtype":"Node","type":"item","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"erc721:0x06012c8cf97BEaD5deAe237070F9587f8E7A266d"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":": CryptoKitties NFT"},"children":[]}]}]},{"$$mdtype":"Node","type":"item","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"trc20:TR7NHqjeKQxGTCi8q8ZY4pL8otSzgjLj6t"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":": USDT on Tron"},"children":[]}]}]},{"$$mdtype":"Node","type":"item","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"erc20:0x55d398326f99059fF775485246999027B3197955"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":": USDT on BNB Smart Chain"},"children":[]}]}]}]}],"pattern":"^[a-z0-9]{3,8}:[-.%a-zA-Z0-9]{1,128}$","example":"erc20:0x6B175474E89094C44Da98b954EedeAC495271d0F"}},"components/schemas/Txid":{"id":"components/schemas/Txid","kind":"json-schema","title":"Txid","data":{"type":"string","minLength":1,"maxLength":512,"description":"Native transaction id of the chain (hash for EVM and Tron, txid for Bitcoin).","example":"0x1234567890abcdef1234567890abcdef1234567890abcdef1234567890abcdef"}},"components/schemas/Timestamp":{"id":"components/schemas/Timestamp","kind":"json-schema","title":"Timestamp","data":{"type":"string","format":"date-time","description":"Point in time in RFC 3339 format.","example":"2024-01-15T10:30:00Z"}},"components/schemas/TransactionAddressValue":{"id":"components/schemas/TransactionAddressValue","kind":"json-schema","title":"TransactionAddressValue","data":{"type":"string","minLength":1,"maxLength":512,"description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Blockchain address in the native format of its chain, as carried by transaction data."},"children":[]},{"$$mdtype":"Node","type":"softbreak","inline":true,"attributes":{},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"The bound is wider than "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"AddressValue"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" and there is no character restriction, because a"},"children":[]},{"$$mdtype":"Node","type":"softbreak","inline":true,"attributes":{},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"transaction payload can name an address the project never imported."},"children":[]}]}]}],"example":"0x742d35cc6634c0532925a3b8d1e1d78d8E15e5c4"}},"components/schemas/ActivityDirection":{"id":"components/schemas/ActivityDirection","kind":"json-schema","title":"ActivityDirection","data":{"type":"string","description":"Direction of the asset movement relative to the tracked address.","enum":["in","out"],"x-enumDescriptions":{"in":"Balance increased (received assets).","out":"Balance decreased (sent assets or paid fees)."},"examples":["in","out"]}},"components/schemas/Delta":{"id":"components/schemas/Delta","kind":"json-schema","title":"Delta","data":{"type":"object","description":"Signed balance change in base units, plus a human-readable value\nwhen we know the token's decimals.\n","properties":{"base":{"type":"string","pattern":"^-?[0-9]+$","description":"Signed amount in the smallest asset unit."},"formatted":{"type":"string","pattern":"^[+-]?[0-9]+([.][0-9]+)?$","description":"Human-readable signed amount."}},"required":["base"],"examples":[{"base":"1000000000000000000","formatted":"+1.0"},{"base":"-500000000","formatted":"-0.5"}]}},"components/schemas/ActivityItem":{"id":"components/schemas/ActivityItem","kind":"json-schema","title":"ActivityItem","data":{"type":"object","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Asset balance change for an address caused by a transaction."},"children":[]}]}]},{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"An "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"in"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" entry carries a positive "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"delta"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":", an "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"out"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" entry a negative one."},"children":[]}]}]}],"properties":{"chain_gid":{"$ref":"#/components/schemas/ChainGID"},"txid":{"$ref":"#/components/schemas/Txid"},"address":{"$ref":"#/components/schemas/TransactionAddressValue","description":"Address whose balance changed."},"asset_gid":{"$ref":"#/components/schemas/AssetGID"},"direction":{"$ref":"#/components/schemas/ActivityDirection"},"delta":{"$ref":"#/components/schemas/Delta"},"created_at":{"$ref":"#/components/schemas/Timestamp","description":"Time the movement was recorded."},"entry_kind":{"type":"string","minLength":1,"maxLength":64,"description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Movement classification. Known values include "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"native_transfer"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":", "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"token_transfer"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":","},"children":[]},{"$$mdtype":"Node","type":"softbreak","inline":true,"attributes":{},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"network_fee"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":", "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"stake"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":", "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"stake_withdrawal"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":", "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"utxo_spend"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":", and "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"utxo_create"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":". Additional"},"children":[]},{"$$mdtype":"Node","type":"softbreak","inline":true,"attributes":{},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"values may be returned; display unfamiliar values as generic movements."},"children":[]}]}]}]}},"required":["chain_gid","txid","address","asset_gid","direction","delta","created_at","entry_kind"],"example":{"chain_gid":"eip155:1","txid":"0x1234567890abcdef1234567890abcdef1234567890abcdef1234567890abcdef","address":"0x742d35cc6634c0532925a3b8d1e1d78d8E15e5c4","asset_gid":"eip155:1/erc20:0xdAC17F958D2ee523a2206206994597C13D831ec7","direction":"out","delta":{"base":"-1000000","formatted":"-1.0"},"created_at":"2024-01-15T10:30:00Z","entry_kind":"token_transfer"}}},"components/schemas/Token":{"id":"components/schemas/Token","kind":"json-schema","title":"Token","data":{"title":"Token","type":"object","description":"Fungible blockchain asset metadata.\n","properties":{"gid":{"$ref":"#/components/schemas/AssetGID"},"decimals":{"$ref":"#/components/schemas/TokenDecimals"},"name":{"$ref":"#/components/schemas/TokenName"},"symbol":{"$ref":"#/components/schemas/TokenSymbol"}},"required":["gid","decimals","name","symbol"],"example":{"gid":"eip155:1/erc20:0xdAC17F958D2ee523a2206206994597C13D831ec7","symbol":"USDT","name":"Tether USD","decimals":6}}},"components/schemas/ActivityReferences":{"id":"components/schemas/ActivityReferences","kind":"json-schema","title":"ActivityReferences","data":{"type":"object","description":"Related objects included in the response, keyed by ID.","properties":{"tokens":{"type":"object","description":"Map of tokens indexed by their CAIP-19 Asset GID.","propertyNames":{"$ref":"#/components/schemas/AssetGID"},"additionalProperties":{"$ref":"#/components/schemas/Token"}},"blockchains":{"type":"object","description":"Map of blockchains indexed by their CAIP-2 Chain GID.","propertyNames":{"$ref":"#/components/schemas/ChainGID"},"additionalProperties":{"$ref":"#/components/schemas/Blockchain"}},"addresses":{"type":"object","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Map of tracked addresses to labels. Presence in this map means the address is tracked; value is label or "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"null"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"."},"children":[]}]}]}],"propertyNames":{"$ref":"#/components/schemas/AddressValue"},"additionalProperties":{"oneOf":[{"$ref":"#/components/schemas/AddressLabel"},{"type":"null"}]}}}}},"components/schemas/SearchBalancesRequest":{"id":"components/schemas/SearchBalancesRequest","kind":"json-schema","title":"SearchBalancesRequest","data":{"type":"object","description":"Search payload selecting up to 100 address/asset identities to page.","properties":{"addresses":{"type":"array","description":"Addresses to search. Canonicalized and deduplicated before matching.","items":{"$ref":"#/components/schemas/AddressValue"},"minItems":1,"maxItems":100},"chain_gids":{"type":"array","description":"Blockchains to narrow the search to (CAIP-2 format). If not specified, all supported blockchains are eligible.","items":{"$ref":"#/components/schemas/ChainGID"},"maxItems":10},"asset_gids":{"type":"array","description":"Assets to narrow the search to (CAIP-19 format). If not specified, all assets are eligible.","items":{"$ref":"#/components/schemas/AssetGID"},"maxItems":10},"page":{"type":"integer","description":"Page number for pagination.","default":1,"minimum":1},"limit":{"type":"integer","description":"Maximum number of items to return.","default":30,"minimum":1,"maximum":100}},"required":["addresses"],"additionalProperties":false}},"components/schemas/AmountInBaseUnits":{"id":"components/schemas/AmountInBaseUnits","kind":"json-schema","title":"AmountInBaseUnits","data":{"type":"string","pattern":"^[0-9]+$","description":"Amount in the smallest asset unit.","examples":["1000000000000000000","1000000000","500000","1"]}},"components/schemas/AmountFormatted":{"id":"components/schemas/AmountFormatted","kind":"json-schema","title":"AmountFormatted","data":{"type":"string","pattern":"^[0-9]+([.][0-9]+)?$","description":"Human-readable amount.","examples":["1.0","1000.5","0.001","42.123456"]}},"components/schemas/Amount":{"id":"components/schemas/Amount","kind":"json-schema","title":"Amount","data":{"type":"object","description":"Asset amount in base units, plus a human-readable value when we know\nthe token's decimals.\n","properties":{"base":{"$ref":"#/components/schemas/AmountInBaseUnits"},"formatted":{"$ref":"#/components/schemas/AmountFormatted"}},"required":["base"],"example":{"base":"1000000000","formatted":"1.0"}}},"components/schemas/AddressBalance":{"id":"components/schemas/AddressBalance","kind":"json-schema","title":"AddressBalance","data":{"type":"object","description":"Current balance of one asset held by one tracked address.","properties":{"address":{"$ref":"#/components/schemas/AddressValue"},"asset_gid":{"$ref":"#/components/schemas/AssetGID"},"amount":{"$ref":"#/components/schemas/Amount"},"is_sync":{"type":"boolean","description":"Whether the amount is a known, current read. The amount is omitted\nentirely, never zero, when it is unknown.\n"}},"required":["address","asset_gid","is_sync"],"example":{"address":"0x8521E8b15eCEF4D4269Fded3E6694225E096959E","asset_gid":"eip155:1/erc20:0xdAC17F958D2ee523a2206206994597C13D831ec7","amount":{"base":"1000000000","formatted":"1000.0"},"is_sync":true}}},"components/schemas/BalanceReferences":{"id":"components/schemas/BalanceReferences","kind":"json-schema","title":"BalanceReferences","data":{"type":"object","description":"Related objects included in the response, keyed by ID.","properties":{"tokens":{"type":"object","description":"Map of tokens indexed by their CAIP-19 Asset GID.","propertyNames":{"$ref":"#/components/schemas/AssetGID"},"additionalProperties":{"$ref":"#/components/schemas/Token"}},"blockchains":{"type":"object","description":"Map of blockchains indexed by their CAIP-2 Chain GID.","propertyNames":{"$ref":"#/components/schemas/ChainGID"},"additionalProperties":{"$ref":"#/components/schemas/Blockchain"}},"addresses":{"type":"object","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Map of tracked addresses to labels. Presence in this map means the"},"children":[]},{"$$mdtype":"Node","type":"softbreak","inline":true,"attributes":{},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"address is tracked; value is label or "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"null"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"."},"children":[]}]}]}],"propertyNames":{"$ref":"#/components/schemas/AddressValue"},"additionalProperties":{"oneOf":[{"$ref":"#/components/schemas/AddressLabel"},{"type":"null"}]}}},"example":{"tokens":{"eip155:1/erc20:0xdAC17F958D2ee523a2206206994597C13D831ec7":{"gid":"eip155:1/erc20:0xdAC17F958D2ee523a2206206994597C13D831ec7","symbol":"USDT","name":"Tether USD","decimals":6}},"blockchains":{"eip155:1":{"gid":"eip155:1","name":"ethereum","short_name":"eth","image_url":"https://raw.githubusercontent.com/vilna-io/icons/refs/heads/main/chains/ethereum.svg"}},"addresses":{"0x8521E8b15eCEF4D4269Fded3E6694225E096959E":"Hot wallet"}}}},"components/schemas/Balance":{"id":"components/schemas/Balance","kind":"json-schema","title":"Balance","data":{"type":"object","description":"Current balance of one asset, summed across the project's tracked addresses.","properties":{"asset_gid":{"$ref":"#/components/schemas/AssetGID"},"amount":{"$ref":"#/components/schemas/Amount"},"is_sync":{"type":"boolean","description":"Whether the amount reflects a fully synced sum. False marks a known\npartial sum; the amount is omitted entirely, never zero, when it is\nunknown.\n"}},"required":["asset_gid","is_sync"],"example":{"asset_gid":"eip155:1/erc20:0xdAC17F958D2ee523a2206206994597C13D831ec7","amount":{"base":"5000000000","formatted":"5000.0"},"is_sync":true}}},"components/schemas/BalanceSummaryReferences":{"id":"components/schemas/BalanceSummaryReferences","kind":"json-schema","title":"BalanceSummaryReferences","data":{"type":"object","description":"Related objects included in the response, keyed by ID.","properties":{"tokens":{"type":"object","description":"Map of tokens indexed by their CAIP-19 Asset GID.","propertyNames":{"$ref":"#/components/schemas/AssetGID"},"additionalProperties":{"$ref":"#/components/schemas/Token"}},"blockchains":{"type":"object","description":"Map of blockchains indexed by their CAIP-2 Chain GID.","propertyNames":{"$ref":"#/components/schemas/ChainGID"},"additionalProperties":{"$ref":"#/components/schemas/Blockchain"}}},"example":{"tokens":{"eip155:1/erc20:0xdAC17F958D2ee523a2206206994597C13D831ec7":{"gid":"eip155:1/erc20:0xdAC17F958D2ee523a2206206994597C13D831ec7","symbol":"USDT","name":"Tether USD","decimals":6}},"blockchains":{"eip155:1":{"gid":"eip155:1","name":"ethereum","short_name":"eth","image_url":"https://raw.githubusercontent.com/vilna-io/icons/refs/heads/main/chains/ethereum.svg"}}}}},"components/schemas/RefreshBalanceRequest":{"id":"components/schemas/RefreshBalanceRequest","kind":"json-schema","title":"RefreshBalanceRequest","data":{"type":"object","description":"Refresh payload identifying one address/asset pair.","properties":{"address":{"$ref":"#/components/schemas/AddressValue"},"asset_gid":{"$ref":"#/components/schemas/AssetGID"}},"required":["address","asset_gid"],"additionalProperties":false}},"components/schemas/RefreshedAddressBalance":{"id":"components/schemas/RefreshedAddressBalance","kind":"json-schema","title":"RefreshedAddressBalance","data":{"type":"object","description":"Current balance of one asset for one address, returned by a synchronous refresh.","properties":{"address":{"$ref":"#/components/schemas/AddressValue"},"asset_gid":{"$ref":"#/components/schemas/AssetGID"},"amount":{"$ref":"#/components/schemas/Amount"},"is_sync":{"type":"boolean","enum":[true],"description":"Always true. A failed refresh never returns a stale amount labelled as refreshed."}},"required":["address","asset_gid","amount","is_sync"],"example":{"address":"0x8521E8b15eCEF4D4269Fded3E6694225E096959E","asset_gid":"eip155:1/erc20:0xdAC17F958D2ee523a2206206994597C13D831ec7","amount":{"base":"1000000000","formatted":"1000.0"},"is_sync":true}}},"components/schemas/RateLimitExceededProblem":{"id":"components/schemas/RateLimitExceededProblem","kind":"json-schema","title":"RateLimitExceededProblem","data":{"type":"object","description":"The caller has reached the effective limit of actions within a time window.\nA zero limit prohibits new actions until the policy changes. A positive limit\nmay permit another attempt as earlier actions leave the window.\n","required":["type","title","status","code","max","window_seconds"],"properties":{"type":{"$ref":"#/components/schemas/ProblemType"},"title":{"$ref":"#/components/schemas/ProblemTitle"},"status":{"$ref":"#/components/schemas/ProblemStatus"},"detail":{"$ref":"#/components/schemas/ProblemDetail"},"instance":{"$ref":"#/components/schemas/ProblemInstance"},"code":{"$ref":"#/components/schemas/ProblemCode"},"max":{"type":"integer","format":"int32","minimum":0,"description":"Effective maximum number of admitted actions per window for the applicable scope.\nZero prohibits new actions until the policy changes. This is the limit, not the remaining capacity.\n","example":1},"window_seconds":{"type":"integer","format":"int32","minimum":1,"description":"Duration in seconds of the limit window, not the remaining wait.","example":60}}}},"components/schemas/BlockNumber":{"id":"components/schemas/BlockNumber","kind":"json-schema","title":"BlockNumber","data":{"type":"integer","format":"uint64","minimum":0,"description":"Block number/height on the blockchain.","example":18500000}},"components/schemas/BitcoinUTXOItem":{"id":"components/schemas/BitcoinUTXOItem","kind":"json-schema","title":"BitcoinUTXOItem","data":{"type":"object","description":"Unspent Bitcoin output held by an address.","properties":{"chain_gid":{"$ref":"#/components/schemas/ChainGID"},"address":{"$ref":"#/components/schemas/AddressValue"},"txid":{"$ref":"#/components/schemas/Txid"},"vout_index":{"type":"integer","format":"uint32","minimum":0,"description":"Output index within the transaction.","example":0},"amount":{"$ref":"#/components/schemas/Amount"},"script_pubkey_hex":{"type":"string","description":"Hex-encoded locking script of the address.","pattern":"^[0-9a-f]+$","example":"0014751e76e8199196d454941c45d1b3a323f1433bd6"},"block_number":{"$ref":"#/components/schemas/BlockNumber"}},"required":["chain_gid","address","txid","vout_index","amount","script_pubkey_hex","block_number"]}},"components/schemas/BitcoinUTXOReferences":{"id":"components/schemas/BitcoinUTXOReferences","kind":"json-schema","title":"BitcoinUTXOReferences","data":{"type":"object","description":"Related objects included in the response, keyed by ID.","properties":{"blockchains":{"type":"object","description":"Map of blockchains indexed by their CAIP-2 Chain GID.","propertyNames":{"$ref":"#/components/schemas/ChainGID"},"additionalProperties":{"$ref":"#/components/schemas/Blockchain"}}},"required":["blockchains"]}},"components/schemas/EVMTransactionSummary":{"id":"components/schemas/EVMTransactionSummary","kind":"json-schema","title":"EVMTransactionSummary","data":{"type":"object","description":"EVM part of a transaction summary.","properties":{"family":{"type":"string","enum":["evm"],"description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Chain family of the transaction, the discriminator of "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"TransactionSummaryDetails"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"."},"children":[]}]}]}]},"block_height":{"type":"integer","format":"int64","minimum":0,"description":"Height of the block that carries the transaction."},"is_success":{"type":"boolean","description":"Whether the transaction executed without reverting."}},"required":["family","block_height","is_success"],"example":{"family":"evm","block_height":18500000,"is_success":true}}},"components/schemas/TronTransactionSummary":{"id":"components/schemas/TronTransactionSummary","kind":"json-schema","title":"TronTransactionSummary","data":{"type":"object","description":"Tron part of a transaction summary.","properties":{"family":{"type":"string","enum":["tron"],"description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Chain family of the transaction, the discriminator of "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"TransactionSummaryDetails"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"."},"children":[]}]}]}]},"block_height":{"type":"integer","format":"int64","minimum":0,"description":"Height of the block that carries the transaction."},"is_success":{"type":"boolean","description":"Whether the transaction executed without reverting."}},"required":["family","block_height","is_success"],"example":{"family":"tron","block_height":67635453,"is_success":true}}},"components/schemas/BitcoinTransactionSummary":{"id":"components/schemas/BitcoinTransactionSummary","kind":"json-schema","title":"BitcoinTransactionSummary","data":{"type":"object","description":"Bitcoin part of a transaction summary. A mempool transaction has no block height.","properties":{"family":{"type":"string","enum":["bitcoin"],"description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Chain family of the transaction, the discriminator of "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"TransactionSummaryDetails"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"."},"children":[]}]}]}]},"block_height":{"type":"integer","format":"int64","minimum":0,"description":"Height of the block that carries the transaction."}},"required":["family"],"example":{"family":"bitcoin","block_height":820000}}},"components/schemas/TransactionSummaryDetails":{"id":"components/schemas/TransactionSummaryDetails","kind":"json-schema","title":"TransactionSummaryDetails","data":{"description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Transaction summary details for the chain family identified by "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"family"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":". This value matches"},"children":[]},{"$$mdtype":"Node","type":"softbreak","inline":true,"attributes":{},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"the chain family of the transaction's "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"chain_gid"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"."},"children":[]}]}]}],"oneOf":[{"$ref":"#/components/schemas/EVMTransactionSummary"},{"$ref":"#/components/schemas/TronTransactionSummary"},{"$ref":"#/components/schemas/BitcoinTransactionSummary"}],"discriminator":{"propertyName":"family","mapping":{"evm":"#/components/schemas/EVMTransactionSummary","tron":"#/components/schemas/TronTransactionSummary","bitcoin":"#/components/schemas/BitcoinTransactionSummary"}}}},"components/schemas/TransactionSummary":{"id":"components/schemas/TransactionSummary","kind":"json-schema","title":"TransactionSummary","data":{"type":"object","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Core transaction metadata with the family summary in details. "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"details.family"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" equals the"},"children":[]},{"$$mdtype":"Node","type":"softbreak","inline":true,"attributes":{},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"chain family of "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"chain_gid"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"."},"children":[]}]}]}],"properties":{"chain_gid":{"$ref":"#/components/schemas/ChainGID"},"txid":{"$ref":"#/components/schemas/Txid"},"created_at":{"$ref":"#/components/schemas/Timestamp","description":"Time the transaction was first recorded for the project."},"details":{"$ref":"#/components/schemas/TransactionSummaryDetails"}},"required":["chain_gid","txid","created_at","details"],"example":{"chain_gid":"eip155:1","txid":"0x1234567890abcdef1234567890abcdef1234567890abcdef1234567890abcdef","created_at":"2024-01-15T10:30:00Z","details":{"family":"evm","block_height":18500000,"is_success":true}}}},"components/schemas/TransactionReferences":{"id":"components/schemas/TransactionReferences","kind":"json-schema","title":"TransactionReferences","data":{"type":"object","description":"Related objects included in the response, keyed by ID.","properties":{"tokens":{"type":"object","description":"Map of tokens indexed by their CAIP-19 Asset GID.","propertyNames":{"$ref":"#/components/schemas/AssetGID"},"additionalProperties":{"$ref":"#/components/schemas/Token"}},"blockchains":{"type":"object","description":"Map of blockchains indexed by their CAIP-2 Chain GID.","propertyNames":{"$ref":"#/components/schemas/ChainGID"},"additionalProperties":{"$ref":"#/components/schemas/Blockchain"}},"addresses":{"type":"object","description":"Map of tracked addresses to labels. Presence in this map means the address is tracked.","propertyNames":{"$ref":"#/components/schemas/TransactionAddressValue"},"additionalProperties":{"type":"string","description":"Label of the tracked address, empty when the project gave it none."}}},"example":{"tokens":{"eip155:1/erc20:0xdAC17F958D2ee523a2206206994597C13D831ec7":{"gid":"eip155:1/erc20:0xdAC17F958D2ee523a2206206994597C13D831ec7","symbol":"USDT","name":"Tether USD","decimals":6}},"blockchains":{"eip155:1":{"gid":"eip155:1","name":"ethereum","short_name":"eth","image_url":"https://raw.githubusercontent.com/vilna-io/icons/refs/heads/main/chains/ethereum.svg"}},"addresses":{"0x742d35cc6634c0532925a3b8d1e1d78d8E15e5c4":"Hot wallet"}}}},"components/schemas/EventIndex":{"id":"components/schemas/EventIndex","kind":"json-schema","title":"EventIndex","data":{"type":"integer","format":"int64","minimum":0,"description":"Zero-based index within its container, bounded to the signed 64-bit range.\nUnique only within the transaction version that names it; consumers preserve the integer exactly.\n","example":0}},"components/schemas/EVMTransferEvent":{"id":"components/schemas/EVMTransferEvent","kind":"json-schema","title":"EVMTransferEvent","data":{"type":"object","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Asset movement: a qualified transfer with its asset, gross amount, operation and the"},"children":[]},{"$$mdtype":"Node","type":"softbreak","inline":true,"attributes":{},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"actual endpoints carried directly by this family event."},"children":[]}]}]},{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"A "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"transfer"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" carries both "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"from_address"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" and "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"to_address"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":". A "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"mint"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" carries only"},"children":[]},{"$$mdtype":"Node","type":"softbreak","inline":true,"attributes":{},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"to_address"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":", a "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"burn"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" only "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"from_address"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"."},"children":[]}]}]}],"properties":{"event_index":{"$ref":"#/components/schemas/EventIndex"},"kind":{"type":"string","enum":["transfer"],"description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Event kind, the discriminator of "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"EVMTransactionEvent"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"."},"children":[]}]}]}]},"asset_gid":{"$ref":"#/components/schemas/AssetGID"},"amount":{"$ref":"#/components/schemas/Amount"},"operation":{"type":"string","description":"Kind of movement the transfer records.","enum":["transfer","mint","burn"],"x-enumDescriptions":{"transfer":"Assets moved between two existing holders.","mint":"Assets came into existence for the recipient.","burn":"Assets were destroyed by the sender."}},"from_address":{"$ref":"#/components/schemas/TransactionAddressValue","description":"Sender of the assets. Absent for a mint."},"to_address":{"$ref":"#/components/schemas/TransactionAddressValue","description":"Recipient of the assets. Absent for a burn."}},"required":["event_index","kind","asset_gid","amount","operation"],"example":{"event_index":0,"kind":"transfer","asset_gid":"eip155:1/erc20:0xdAC17F958D2ee523a2206206994597C13D831ec7","amount":{"base":"1000000","formatted":"1.0"},"operation":"transfer","from_address":"0x742d35cc6634c0532925a3b8d1e1d78d8E15e5c4","to_address":"0x95212290dd7278aa3ddd389cc1e1d165cc4bafe5"}}},"components/schemas/EVMApprovalEvent":{"id":"components/schemas/EVMApprovalEvent","kind":"json-schema","title":"EVMApprovalEvent","data":{"type":"object","description":"Spending allowance change: an allowance granted by an owner to a spender.","properties":{"event_index":{"$ref":"#/components/schemas/EventIndex"},"kind":{"type":"string","enum":["approval"],"description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Event kind, the discriminator of "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"EVMTransactionEvent"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"."},"children":[]}]}]}]},"asset_gid":{"$ref":"#/components/schemas/AssetGID"},"owner_address":{"$ref":"#/components/schemas/TransactionAddressValue","description":"Holder that granted the allowance."},"spender_address":{"$ref":"#/components/schemas/TransactionAddressValue","description":"Address allowed to spend."},"allowance":{"$ref":"#/components/schemas/Amount","description":"Allowance after this approval."}},"required":["event_index","kind","asset_gid","owner_address","spender_address","allowance"],"example":{"event_index":0,"kind":"approval","asset_gid":"eip155:1/erc20:0xdAC17F958D2ee523a2206206994597C13D831ec7","owner_address":"0x742d35cc6634c0532925a3b8d1e1d78d8E15e5c4","spender_address":"0x68b3465833fb72A70ecDF485E0e4C7bD8665Fc45","allowance":{"base":"1000000000","formatted":"1000.0"}}}},"components/schemas/InteractionOutcome":{"id":"components/schemas/InteractionOutcome","kind":"json-schema","title":"InteractionOutcome","data":{"type":"string","description":"Result in the recorded execution, including ancestor rollback; independent of chain reorganization.","enum":["succeeded","reverted"],"x-enumDescriptions":{"succeeded":"The call completed and its state changes were kept.","reverted":"The call was rolled back, on its own or with an ancestor call."},"examples":["succeeded","reverted"]}},"components/schemas/EVMInteractionEvent":{"id":"components/schemas/EVMInteractionEvent","kind":"json-schema","title":"EVMInteractionEvent","data":{"type":"object","description":"Contract call: a call against a contract, with the outcome recorded for that call.","properties":{"event_index":{"$ref":"#/components/schemas/EventIndex"},"kind":{"type":"string","enum":["interaction"],"description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Event kind, the discriminator of "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"EVMTransactionEvent"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"."},"children":[]}]}]}]},"target_address":{"$ref":"#/components/schemas/TransactionAddressValue","description":"Contract the call was made against."},"caller_address":{"$ref":"#/components/schemas/TransactionAddressValue","description":"Present only when the caller is known from transaction data. An absent caller cannot\nmatch a caller filter and must not be replaced with the fee payer.\n"},"outcome":{"$ref":"#/components/schemas/InteractionOutcome"}},"required":["event_index","kind","target_address","outcome"],"example":{"event_index":0,"kind":"interaction","target_address":"0xdAC17F958D2ee523a2206206994597C13D831ec7","caller_address":"0x742d35cc6634c0532925a3b8d1e1d78d8E15e5c4","outcome":"succeeded"}}},"components/schemas/EVMContractCreationEvent":{"id":"components/schemas/EVMContractCreationEvent","kind":"json-schema","title":"EVMContractCreationEvent","data":{"type":"object","description":"Contract deployment: a successfully observed contract creation with an established\naddress; predicted addresses and failed creation attempts are not this event.\n","properties":{"event_index":{"$ref":"#/components/schemas/EventIndex"},"kind":{"type":"string","enum":["contract_creation"],"description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Event kind, the discriminator of "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"EVMTransactionEvent"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"."},"children":[]}]}]}]},"creator_address":{"$ref":"#/components/schemas/TransactionAddressValue","description":"Address that deployed the contract."},"created_address":{"$ref":"#/components/schemas/TransactionAddressValue","description":"Address the contract now lives at."}},"required":["event_index","kind","creator_address","created_address"],"example":{"event_index":0,"kind":"contract_creation","creator_address":"0x742d35cc6634c0532925a3b8d1e1d78d8E15e5c4","created_address":"0x68b3465833fb72A70ecDF485E0e4C7bD8665Fc45"}}},"components/schemas/EVMTransactionEvent":{"id":"components/schemas/EVMTransactionEvent","kind":"json-schema","title":"EVMTransactionEvent","data":{"description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"One decoded event of an EVM transaction. "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"kind"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" names the shape."},"children":[]}]}]}],"oneOf":[{"$ref":"#/components/schemas/EVMTransferEvent"},{"$ref":"#/components/schemas/EVMApprovalEvent"},{"$ref":"#/components/schemas/EVMInteractionEvent"},{"$ref":"#/components/schemas/EVMContractCreationEvent"}],"discriminator":{"propertyName":"kind","mapping":{"transfer":"#/components/schemas/EVMTransferEvent","approval":"#/components/schemas/EVMApprovalEvent","interaction":"#/components/schemas/EVMInteractionEvent","contract_creation":"#/components/schemas/EVMContractCreationEvent"}}}},"components/schemas/BlockHash":{"id":"components/schemas/BlockHash","kind":"json-schema","title":"BlockHash","data":{"type":"string","minLength":1,"maxLength":512,"description":"Native block hash in the format of the selected family; not a transaction identifier.","example":"0x1234567890abcdef1234567890abcdef1234567890abcdef1234567890abcdef"}},"components/schemas/EVMBlockReference":{"id":"components/schemas/EVMBlockReference","kind":"json-schema","title":"EVMBlockReference","data":{"type":"object","description":"Block that carries the transaction.","properties":{"block_hash":{"$ref":"#/components/schemas/BlockHash"},"block_height":{"$ref":"#/components/schemas/EventIndex","description":"Height of the block."}},"required":["block_hash","block_height"],"example":{"block_hash":"0x9f1c2a3b4d5e6f708192a3b4c5d6e7f8091a2b3c4d5e6f708192a3b4c5d6e7f8","block_height":18500000}}},"components/schemas/EVMTransaction":{"id":"components/schemas/EVMTransaction","kind":"json-schema","title":"EVMTransaction","data":{"type":"object","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"EVM part of a transaction."},"children":[]}]}]},{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"When "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"is_success"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" is false, every interaction event in "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"events"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" has the outcome "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"reverted"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"."},"children":[]}]}]}],"properties":{"family":{"type":"string","enum":["evm"],"description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Chain family of the transaction, the discriminator of "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"TransactionDetails"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"."},"children":[]}]}]}]},"events":{"type":"array","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Decoded events of the transaction, ordered by "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"event_index"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"."},"children":[]}]}]}],"items":{"$ref":"#/components/schemas/EVMTransactionEvent"}},"is_success":{"type":"boolean","description":"Whether the transaction executed without reverting."},"fee":{"$ref":"#/components/schemas/Amount","description":"Total commission paid in the native asset of the chain."},"block":{"$ref":"#/components/schemas/EVMBlockReference"},"transaction_index":{"$ref":"#/components/schemas/EventIndex","description":"Position of the transaction inside its block."},"from_address":{"$ref":"#/components/schemas/TransactionAddressValue","description":"Outer sender of the transaction."},"to_address":{"$ref":"#/components/schemas/TransactionAddressValue","description":"Outer destination; absent only for a contract-creation transaction, including failed attempts."},"gas_used":{"type":"integer","format":"int64","minimum":0,"description":"Actual transaction receipt gasUsed; not a fee, gas limit or cumulative block gas."}},"required":["family","events","is_success","block","transaction_index","from_address","gas_used"],"example":{"family":"evm","events":[{"event_index":0,"kind":"transfer","asset_gid":"eip155:1/erc20:0xdAC17F958D2ee523a2206206994597C13D831ec7","amount":{"base":"1000000","formatted":"1.0"},"operation":"transfer","from_address":"0x742d35cc6634c0532925a3b8d1e1d78d8E15e5c4","to_address":"0x95212290dd7278aa3ddd389cc1e1d165cc4bafe5"},{"event_index":1,"kind":"interaction","target_address":"0xdAC17F958D2ee523a2206206994597C13D831ec7","caller_address":"0x742d35cc6634c0532925a3b8d1e1d78d8E15e5c4","outcome":"succeeded"}],"is_success":true,"fee":{"base":"21000000000000000","formatted":"0.021"},"block":{"block_hash":"0x9f1c2a3b4d5e6f708192a3b4c5d6e7f8091a2b3c4d5e6f708192a3b4c5d6e7f8","block_height":18500000},"transaction_index":42,"from_address":"0x742d35cc6634c0532925a3b8d1e1d78d8E15e5c4","to_address":"0xdAC17F958D2ee523a2206206994597C13D831ec7","gas_used":65000}}},"components/schemas/TronTransferEvent":{"id":"components/schemas/TronTransferEvent","kind":"json-schema","title":"TronTransferEvent","data":{"type":"object","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Asset movement: a qualified transfer with its asset, gross amount, operation and the"},"children":[]},{"$$mdtype":"Node","type":"softbreak","inline":true,"attributes":{},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"actual endpoints carried directly by this family event."},"children":[]}]}]},{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"A "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"transfer"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" carries both "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"from_address"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" and "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"to_address"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":". A "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"mint"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" carries only"},"children":[]},{"$$mdtype":"Node","type":"softbreak","inline":true,"attributes":{},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"to_address"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":", a "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"burn"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" only "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"from_address"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"."},"children":[]}]}]}],"properties":{"event_index":{"$ref":"#/components/schemas/EventIndex"},"kind":{"type":"string","enum":["transfer"],"description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Event kind, the discriminator of "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"TronTransactionEvent"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"."},"children":[]}]}]}]},"asset_gid":{"$ref":"#/components/schemas/AssetGID"},"amount":{"$ref":"#/components/schemas/Amount"},"operation":{"type":"string","description":"Kind of movement the transfer records.","enum":["transfer","mint","burn"],"x-enumDescriptions":{"transfer":"Assets moved between two existing holders.","mint":"Assets came into existence for the recipient.","burn":"Assets were destroyed by the sender."}},"from_address":{"$ref":"#/components/schemas/TransactionAddressValue","description":"Sender of the assets. Absent for a mint."},"to_address":{"$ref":"#/components/schemas/TransactionAddressValue","description":"Recipient of the assets. Absent for a burn."}},"required":["event_index","kind","asset_gid","amount","operation"],"example":{"event_index":0,"kind":"transfer","asset_gid":"tron:728126428/trc20:TR7NHqjeKQxGTCi8q8ZY4pL8otSzgjLj6t","amount":{"base":"1000000","formatted":"1.0"},"operation":"transfer","from_address":"TJRabPrwbZy45sbavfcjinPJC18kjpRTv8","to_address":"TWd4WrZ9wn84f5x1hZhL4DHvk738ns5jwb"}}},"components/schemas/TronApprovalEvent":{"id":"components/schemas/TronApprovalEvent","kind":"json-schema","title":"TronApprovalEvent","data":{"type":"object","description":"Spending allowance change: an allowance granted by an owner to a spender.","properties":{"event_index":{"$ref":"#/components/schemas/EventIndex"},"kind":{"type":"string","enum":["approval"],"description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Event kind, the discriminator of "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"TronTransactionEvent"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"."},"children":[]}]}]}]},"asset_gid":{"$ref":"#/components/schemas/AssetGID"},"owner_address":{"$ref":"#/components/schemas/TransactionAddressValue","description":"Holder that granted the allowance."},"spender_address":{"$ref":"#/components/schemas/TransactionAddressValue","description":"Address allowed to spend."},"allowance":{"$ref":"#/components/schemas/Amount","description":"Allowance after this approval."}},"required":["event_index","kind","asset_gid","owner_address","spender_address","allowance"],"example":{"event_index":0,"kind":"approval","asset_gid":"tron:728126428/trc20:TR7NHqjeKQxGTCi8q8ZY4pL8otSzgjLj6t","owner_address":"TJRabPrwbZy45sbavfcjinPJC18kjpRTv8","spender_address":"TKzxdSv2FZKQrEqkKVgp5DcwEXBEKMg2Ax","allowance":{"base":"1000000000","formatted":"1000.0"}}}},"components/schemas/TronInteractionEvent":{"id":"components/schemas/TronInteractionEvent","kind":"json-schema","title":"TronInteractionEvent","data":{"type":"object","description":"Contract call: a call against a contract, with the outcome recorded for that call.","properties":{"event_index":{"$ref":"#/components/schemas/EventIndex"},"kind":{"type":"string","enum":["interaction"],"description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Event kind, the discriminator of "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"TronTransactionEvent"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"."},"children":[]}]}]}]},"target_address":{"$ref":"#/components/schemas/TransactionAddressValue","description":"Contract the call was made against."},"caller_address":{"$ref":"#/components/schemas/TransactionAddressValue","description":"Present only when the caller is known from transaction data. An absent caller cannot\nmatch a caller filter and must not be replaced with the fee payer.\n"},"outcome":{"$ref":"#/components/schemas/InteractionOutcome"}},"required":["event_index","kind","target_address","outcome"],"example":{"event_index":0,"kind":"interaction","target_address":"TR7NHqjeKQxGTCi8q8ZY4pL8otSzgjLj6t","caller_address":"TJRabPrwbZy45sbavfcjinPJC18kjpRTv8","outcome":"succeeded"}}},"components/schemas/TronContractCreationEvent":{"id":"components/schemas/TronContractCreationEvent","kind":"json-schema","title":"TronContractCreationEvent","data":{"type":"object","description":"Contract deployment: a successfully observed contract creation with an established\naddress; predicted addresses and failed creation attempts are not this event.\n","properties":{"event_index":{"$ref":"#/components/schemas/EventIndex"},"kind":{"type":"string","enum":["contract_creation"],"description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Event kind, the discriminator of "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"TronTransactionEvent"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"."},"children":[]}]}]}]},"creator_address":{"$ref":"#/components/schemas/TransactionAddressValue","description":"Address that deployed the contract."},"created_address":{"$ref":"#/components/schemas/TransactionAddressValue","description":"Address the contract now lives at."}},"required":["event_index","kind","creator_address","created_address"],"example":{"event_index":0,"kind":"contract_creation","creator_address":"TJRabPrwbZy45sbavfcjinPJC18kjpRTv8","created_address":"TKzxdSv2FZKQrEqkKVgp5DcwEXBEKMg2Ax"}}},"components/schemas/TronStakeResource":{"id":"components/schemas/TronStakeResource","kind":"json-schema","title":"TronStakeResource","data":{"type":"string","description":"Network resource a stake operation applies to.","enum":["bandwidth","energy","tron_power"],"x-enumDescriptions":{"bandwidth":"Transaction size quota.","energy":"Contract execution quota.","tron_power":"Voting weight."},"examples":["bandwidth","energy","tron_power"]}},"components/schemas/TronStakeEvent":{"id":"components/schemas/TronStakeEvent","kind":"json-schema","title":"TronStakeEvent","data":{"type":"object","description":"Stake of TRX for a network resource. The staked amount is strictly positive.","properties":{"event_index":{"$ref":"#/components/schemas/EventIndex"},"kind":{"type":"string","enum":["stake"],"description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Event kind, the discriminator of "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"TronTransactionEvent"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"."},"children":[]}]}]}]},"owner_address":{"$ref":"#/components/schemas/TransactionAddressValue","description":"Account that staked."},"amount":{"$ref":"#/components/schemas/Amount","description":"Staked amount in SUN."},"resource":{"$ref":"#/components/schemas/TronStakeResource"}},"required":["event_index","kind","owner_address","amount","resource"],"example":{"event_index":0,"kind":"stake","owner_address":"TJRabPrwbZy45sbavfcjinPJC18kjpRTv8","amount":{"base":"1000000000","formatted":"1000.0"},"resource":"energy"}}},"components/schemas/TronUnstakeEvent":{"id":"components/schemas/TronUnstakeEvent","kind":"json-schema","title":"TronUnstakeEvent","data":{"type":"object","description":"Unstake of TRX from a network resource. The unstaked amount is strictly positive.","properties":{"event_index":{"$ref":"#/components/schemas/EventIndex"},"kind":{"type":"string","enum":["unstake"],"description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Event kind, the discriminator of "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"TronTransactionEvent"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"."},"children":[]}]}]}]},"owner_address":{"$ref":"#/components/schemas/TransactionAddressValue","description":"Account that unstaked."},"amount":{"$ref":"#/components/schemas/Amount","description":"Unstaked amount in SUN."},"resource":{"$ref":"#/components/schemas/TronStakeResource"}},"required":["event_index","kind","owner_address","amount","resource"],"example":{"event_index":0,"kind":"unstake","owner_address":"TJRabPrwbZy45sbavfcjinPJC18kjpRTv8","amount":{"base":"1000000000","formatted":"1000.0"},"resource":"energy"}}},"components/schemas/TronStakeWithdrawalEvent":{"id":"components/schemas/TronStakeWithdrawalEvent","kind":"json-schema","title":"TronStakeWithdrawalEvent","data":{"type":"object","description":"Withdrawal of TRX released by a matured unstake. The withdrawn amount is strictly\npositive.\n","properties":{"event_index":{"$ref":"#/components/schemas/EventIndex"},"kind":{"type":"string","enum":["stake_withdrawal"],"description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Event kind, the discriminator of "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"TronTransactionEvent"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"."},"children":[]}]}]}]},"owner_address":{"$ref":"#/components/schemas/TransactionAddressValue","description":"Account that withdrew."},"amount":{"$ref":"#/components/schemas/Amount","description":"Withdrawn amount in SUN."}},"required":["event_index","kind","owner_address","amount"],"example":{"event_index":0,"kind":"stake_withdrawal","owner_address":"TJRabPrwbZy45sbavfcjinPJC18kjpRTv8","amount":{"base":"1000000000","formatted":"1000.0"}}}},"components/schemas/TronUnstakeCancellationEvent":{"id":"components/schemas/TronUnstakeCancellationEvent","kind":"json-schema","title":"TronUnstakeCancellationEvent","data":{"type":"object","description":"Cancellation of a pending unstake. The returned amount is strictly positive.","properties":{"event_index":{"$ref":"#/components/schemas/EventIndex"},"kind":{"type":"string","enum":["unstake_cancellation"],"description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Event kind, the discriminator of "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"TronTransactionEvent"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"."},"children":[]}]}]}]},"owner_address":{"$ref":"#/components/schemas/TransactionAddressValue","description":"Account whose unstake was cancelled."},"amount":{"$ref":"#/components/schemas/Amount","description":"Amount returned to the stake, in SUN."},"resource":{"$ref":"#/components/schemas/TronStakeResource"}},"required":["event_index","kind","owner_address","amount","resource"],"example":{"event_index":0,"kind":"unstake_cancellation","owner_address":"TJRabPrwbZy45sbavfcjinPJC18kjpRTv8","amount":{"base":"1000000000","formatted":"1000.0"},"resource":"energy"}}},"components/schemas/TronTransactionEvent":{"id":"components/schemas/TronTransactionEvent","kind":"json-schema","title":"TronTransactionEvent","data":{"description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"One decoded event of a Tron transaction. "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"kind"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" names the shape."},"children":[]}]}]}],"oneOf":[{"$ref":"#/components/schemas/TronTransferEvent"},{"$ref":"#/components/schemas/TronApprovalEvent"},{"$ref":"#/components/schemas/TronInteractionEvent"},{"$ref":"#/components/schemas/TronContractCreationEvent"},{"$ref":"#/components/schemas/TronStakeEvent"},{"$ref":"#/components/schemas/TronUnstakeEvent"},{"$ref":"#/components/schemas/TronStakeWithdrawalEvent"},{"$ref":"#/components/schemas/TronUnstakeCancellationEvent"}],"discriminator":{"propertyName":"kind","mapping":{"transfer":"#/components/schemas/TronTransferEvent","approval":"#/components/schemas/TronApprovalEvent","interaction":"#/components/schemas/TronInteractionEvent","contract_creation":"#/components/schemas/TronContractCreationEvent","stake":"#/components/schemas/TronStakeEvent","unstake":"#/components/schemas/TronUnstakeEvent","stake_withdrawal":"#/components/schemas/TronStakeWithdrawalEvent","unstake_cancellation":"#/components/schemas/TronUnstakeCancellationEvent"}}}},"components/schemas/TronFee":{"id":"components/schemas/TronFee","kind":"json-schema","title":"TronFee","data":{"type":"object","description":"Actual total TRX commission in SUN and its identified fee payer. Resolve the native asset\nfrom the chain catalog; resources are separate.\n","properties":{"payer_address":{"$ref":"#/components/schemas/TransactionAddressValue","description":"Account charged for the transaction."},"amount":{"$ref":"#/components/schemas/Amount","description":"Commission in SUN."}},"required":["payer_address","amount"],"example":{"payer_address":"TJRabPrwbZy45sbavfcjinPJC18kjpRTv8","amount":{"base":"1100000","formatted":"1.1"}}}},"components/schemas/TronBlockReference":{"id":"components/schemas/TronBlockReference","kind":"json-schema","title":"TronBlockReference","data":{"type":"object","description":"Block that carries the transaction.","properties":{"block_hash":{"$ref":"#/components/schemas/BlockHash"},"block_height":{"$ref":"#/components/schemas/EventIndex","description":"Height of the block."}},"required":["block_hash","block_height"],"example":{"block_hash":"0000000004087cfd7b3e1a7f22a0e0f5cbbd0f1b2b1a4f4bb6a3a9c5d7e8f901","block_height":67635453}}},"components/schemas/TronResources":{"id":"components/schemas/TronResources","kind":"json-schema","title":"TronResources","data":{"type":"object","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Transaction resource usage. All counters, including zero, are present. Caller and creator"},"children":[]},{"$$mdtype":"Node","type":"softbreak","inline":true,"attributes":{},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Energy quota usage together must not exceed "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"energy_used"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":". These counters do not represent"},"children":[]},{"$$mdtype":"Node","type":"softbreak","inline":true,"attributes":{},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"monetary debits or remaining resource balances."},"children":[]}]}]}],"properties":{"energy_used":{"type":"integer","format":"int64","minimum":0,"description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Total receipt energy_usage_total, including applicable penalty."},"children":[]}]}]}]},"caller_energy_quota_used":{"type":"integer","format":"int64","minimum":0,"description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Caller Energy quota consumed (receipt energy_usage), excluding Energy paid with TRX."},"children":[]}]}]}]},"creator_energy_quota_used":{"type":"integer","format":"int64","minimum":0,"description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Contract creator Energy quota contribution (receipt origin_energy_usage)."},"children":[]}]}]}]},"bandwidth_quota_used":{"type":"integer","format":"int64","minimum":0,"description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Charged Bandwidth quota (receipt net_usage), not total transaction bytes or proof of its owner."},"children":[]}]}]}]}},"required":["energy_used","caller_energy_quota_used","creator_energy_quota_used","bandwidth_quota_used"],"example":{"energy_used":130285,"caller_energy_quota_used":0,"creator_energy_quota_used":130285,"bandwidth_quota_used":345}}},"components/schemas/TronTransaction":{"id":"components/schemas/TronTransaction","kind":"json-schema","title":"TronTransaction","data":{"type":"object","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Tron part of a transaction."},"children":[]}]}]},{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"When "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"is_success"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" is false, every interaction event in "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"events"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" has the outcome "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"reverted"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"."},"children":[]}]}]}],"properties":{"family":{"type":"string","enum":["tron"],"description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Chain family of the transaction, the discriminator of "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"TransactionDetails"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"."},"children":[]}]}]}]},"events":{"type":"array","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Decoded events of the transaction, ordered by "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"event_index"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"."},"children":[]}]}]}],"items":{"$ref":"#/components/schemas/TronTransactionEvent"}},"is_success":{"type":"boolean","description":"Whether the transaction executed without reverting."},"fee":{"$ref":"#/components/schemas/TronFee"},"block":{"$ref":"#/components/schemas/TronBlockReference"},"transaction_index":{"$ref":"#/components/schemas/EventIndex","description":"Position of the transaction inside its block."},"resources":{"$ref":"#/components/schemas/TronResources"},"owner_address":{"$ref":"#/components/schemas/TransactionAddressValue","description":"Account that owns the transaction's outer operation. Present for ordinary supported\npublic operations; absent only when the source operation has no public owner. Do not\ninterpret this as the signer or infer the fee payer from it.\n"}},"required":["family","events","is_success","block","transaction_index"],"example":{"family":"tron","events":[{"event_index":0,"kind":"transfer","asset_gid":"tron:728126428/trc20:TR7NHqjeKQxGTCi8q8ZY4pL8otSzgjLj6t","amount":{"base":"1000000","formatted":"1.0"},"operation":"transfer","from_address":"TJRabPrwbZy45sbavfcjinPJC18kjpRTv8","to_address":"TWd4WrZ9wn84f5x1hZhL4DHvk738ns5jwb"}],"is_success":true,"fee":{"payer_address":"TJRabPrwbZy45sbavfcjinPJC18kjpRTv8","amount":{"base":"1100000","formatted":"1.1"}},"block":{"block_hash":"0000000004087cfd7b3e1a7f22a0e0f5cbbd0f1b2b1a4f4bb6a3a9c5d7e8f901","block_height":67635453},"transaction_index":12,"resources":{"energy_used":130285,"caller_energy_quota_used":0,"creator_energy_quota_used":130285,"bandwidth_quota_used":345},"owner_address":"TJRabPrwbZy45sbavfcjinPJC18kjpRTv8"}}},"components/schemas/UTXOIndex":{"id":"components/schemas/UTXOIndex","kind":"json-schema","title":"UTXOIndex","data":{"type":"integer","format":"uint32","minimum":0,"maximum":4294967295,"description":"Position of an input or an output inside its transaction.","example":0}},"components/schemas/BitcoinUTXOInput":{"id":"components/schemas/BitcoinUTXOInput","kind":"json-schema","title":"BitcoinUTXOInput","data":{"type":"object","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"One normal transaction input. "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"input_index"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" is distinct from "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"previous_output_index"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"; an"},"children":[]},{"$$mdtype":"Node","type":"softbreak","inline":true,"attributes":{},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"absent previous-output "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"amount"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" is unavailable, never zero."},"children":[]}]}]}],"properties":{"input_index":{"$ref":"#/components/schemas/UTXOIndex","description":"Position of this input inside the spending transaction."},"previous_txid":{"$ref":"#/components/schemas/Txid","description":"Transaction that created the output being spent."},"previous_output_index":{"$ref":"#/components/schemas/UTXOIndex","description":"Position of the spent output inside that transaction."},"amount":{"$ref":"#/components/schemas/Amount","description":"Value of the spent output, when available."},"address":{"$ref":"#/components/schemas/TransactionAddressValue","description":"Address, when available. The input remains present when its address is unavailable.\n"}},"required":["input_index","previous_txid","previous_output_index"],"example":{"input_index":0,"previous_txid":"4a5e1e4baab89f3a32518a88c31bc87f618f76673e2cc77ab2127b7afdeda33b","previous_output_index":1,"amount":{"base":"150000","formatted":"0.0015"},"address":"bc1qar0srrr7xfkvy5l643lydnw9re59gtzzwf5mdq"}}},"components/schemas/BitcoinUTXOOutput":{"id":"components/schemas/BitcoinUTXOOutput","kind":"json-schema","title":"BitcoinUTXOOutput","data":{"type":"object","description":"One transaction output, with its value and the address it pays when known.","properties":{"output_index":{"$ref":"#/components/schemas/UTXOIndex","description":"Position of this output inside the transaction."},"amount":{"$ref":"#/components/schemas/Amount","description":"Value of the output."},"address":{"$ref":"#/components/schemas/TransactionAddressValue","description":"Address, when available. The output remains present when its address is unavailable.\n"}},"required":["output_index","amount"],"example":{"output_index":0,"amount":{"base":"100000","formatted":"0.001"},"address":"bc1qxy2kgdygjrsqtzq2n0yrf2493p83kkfjhx0wlh"}}},"components/schemas/BitcoinUTXOTransferEvent":{"id":"components/schemas/BitcoinUTXOTransferEvent","kind":"json-schema","title":"BitcoinUTXOTransferEvent","data":{"type":"object","description":"Complete input and output set of the transaction: native BTC only. One complete\ninput/output event per ACTIVE transaction version; INACTIVE has no events. Inputs and\noutputs are listed separately. Transaction-wide cost is reported in BitcoinTransaction.fee.\n\nA coinbase transfer has no inputs; every other transfer has at least one.\n","properties":{"event_index":{"$ref":"#/components/schemas/EventIndex"},"kind":{"type":"string","enum":["utxo_transfer"],"description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Event kind, the discriminator of "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"BitcoinTransactionEvent"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"."},"children":[]}]}]}]},"asset_gid":{"$ref":"#/components/schemas/AssetGID"},"is_coinbase":{"type":"boolean","description":"Whether the transaction mints the block subsidy."},"inputs":{"type":"array","description":"Outputs this transaction spends, ordered by input index.","items":{"$ref":"#/components/schemas/BitcoinUTXOInput"}},"outputs":{"type":"array","minItems":1,"description":"Outputs this transaction creates, ordered by output index.","items":{"$ref":"#/components/schemas/BitcoinUTXOOutput"}}},"required":["event_index","kind","asset_gid","is_coinbase","inputs","outputs"],"example":{"event_index":0,"kind":"utxo_transfer","asset_gid":"bip122:000000000019d6689c085ae165831e93/slip44:0","is_coinbase":false,"inputs":[{"input_index":0,"previous_txid":"4a5e1e4baab89f3a32518a88c31bc87f618f76673e2cc77ab2127b7afdeda33b","previous_output_index":1,"amount":{"base":"150000","formatted":"0.0015"},"address":"bc1qar0srrr7xfkvy5l643lydnw9re59gtzzwf5mdq"}],"outputs":[{"output_index":0,"amount":{"base":"100000","formatted":"0.001"},"address":"bc1qxy2kgdygjrsqtzq2n0yrf2493p83kkfjhx0wlh"},{"output_index":1,"amount":{"base":"45000","formatted":"0.00045"},"address":"bc1qar0srrr7xfkvy5l643lydnw9re59gtzzwf5mdq"}]}}},"components/schemas/BitcoinTransactionEvent":{"id":"components/schemas/BitcoinTransactionEvent","kind":"json-schema","title":"BitcoinTransactionEvent","data":{"description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"The single decoded event of a Bitcoin transaction. "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"kind"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" names the shape."},"children":[]}]}]}],"oneOf":[{"$ref":"#/components/schemas/BitcoinUTXOTransferEvent"}],"discriminator":{"propertyName":"kind","mapping":{"utxo_transfer":"#/components/schemas/BitcoinUTXOTransferEvent"}}}},"components/schemas/BitcoinBlockReference":{"id":"components/schemas/BitcoinBlockReference","kind":"json-schema","title":"BitcoinBlockReference","data":{"type":"object","description":"Block that carries the transaction.","properties":{"block_hash":{"$ref":"#/components/schemas/BlockHash"},"block_height":{"$ref":"#/components/schemas/EventIndex","description":"Height of the block."}},"required":["block_hash","block_height"],"example":{"block_hash":"00000000000000000002a7c4c1e48d76c5a37902165a270156b7a8d72728a054","block_height":820000}}},"components/schemas/BitcoinTransaction":{"id":"components/schemas/BitcoinTransaction","kind":"json-schema","title":"BitcoinTransaction","data":{"type":"object","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Bitcoin part of a transaction."},"children":[]}]}]},{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"block"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" and "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"transaction_index"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" are either both present or both absent: a mempool"},"children":[]},{"$$mdtype":"Node","type":"softbreak","inline":true,"attributes":{},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"transaction has neither."},"children":[]}]}]}],"properties":{"family":{"type":"string","enum":["bitcoin"],"description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Chain family of the transaction, the discriminator of "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"TransactionDetails"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"."},"children":[]}]}]}]},"events":{"type":"array","maxItems":1,"description":"The decoded event of the transaction, when the version carries one.","items":{"$ref":"#/components/schemas/BitcoinTransactionEvent"}},"fee":{"$ref":"#/components/schemas/Amount","description":"Sum of inputs minus sum of outputs, in satoshi."},"block":{"$ref":"#/components/schemas/BitcoinBlockReference"},"transaction_index":{"$ref":"#/components/schemas/EventIndex","description":"Position of the transaction inside its block."}},"required":["family","events"],"example":{"family":"bitcoin","events":[{"event_index":0,"kind":"utxo_transfer","asset_gid":"bip122:000000000019d6689c085ae165831e93/slip44:0","is_coinbase":false,"inputs":[{"input_index":0,"previous_txid":"4a5e1e4baab89f3a32518a88c31bc87f618f76673e2cc77ab2127b7afdeda33b","previous_output_index":1,"amount":{"base":"150000","formatted":"0.0015"},"address":"bc1qar0srrr7xfkvy5l643lydnw9re59gtzzwf5mdq"}],"outputs":[{"output_index":0,"amount":{"base":"100000","formatted":"0.001"},"address":"bc1qxy2kgdygjrsqtzq2n0yrf2493p83kkfjhx0wlh"},{"output_index":1,"amount":{"base":"45000","formatted":"0.00045"},"address":"bc1qar0srrr7xfkvy5l643lydnw9re59gtzzwf5mdq"}]}],"fee":{"base":"5000","formatted":"0.00005"},"block":{"block_hash":"00000000000000000002a7c4c1e48d76c5a37902165a270156b7a8d72728a054","block_height":820000},"transaction_index":314}}},"components/schemas/TransactionDetails":{"id":"components/schemas/TransactionDetails","kind":"json-schema","title":"TransactionDetails","data":{"description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Transaction details for the chain family identified by "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"family"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":". This value matches the"},"children":[]},{"$$mdtype":"Node","type":"softbreak","inline":true,"attributes":{},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"chain family of the transaction's "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"chain_gid"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"."},"children":[]}]}]}],"oneOf":[{"$ref":"#/components/schemas/EVMTransaction"},{"$ref":"#/components/schemas/TronTransaction"},{"$ref":"#/components/schemas/BitcoinTransaction"}],"discriminator":{"propertyName":"family","mapping":{"evm":"#/components/schemas/EVMTransaction","tron":"#/components/schemas/TronTransaction","bitcoin":"#/components/schemas/BitcoinTransaction"}}}},"components/schemas/Transaction":{"id":"components/schemas/Transaction","kind":"json-schema","title":"Transaction","data":{"type":"object","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Transaction with the decoded events of its chain family and the balance changes of tracked"},"children":[]},{"$$mdtype":"Node","type":"softbreak","inline":true,"attributes":{},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"addresses. "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"details.family"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" equals the chain family of "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"chain_gid"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"."},"children":[]}]}]}],"properties":{"chain_gid":{"$ref":"#/components/schemas/ChainGID"},"txid":{"$ref":"#/components/schemas/Txid"},"created_at":{"$ref":"#/components/schemas/Timestamp","description":"Time the transaction was first recorded for the project."},"activity":{"type":"array","description":"Balance changes for tracked addresses.","items":{"$ref":"#/components/schemas/ActivityItem"}},"details":{"$ref":"#/components/schemas/TransactionDetails"}},"required":["chain_gid","txid","created_at","activity","details"],"example":{"chain_gid":"eip155:1","txid":"0x1234567890abcdef1234567890abcdef1234567890abcdef1234567890abcdef","created_at":"2024-01-15T10:30:00Z","activity":[{"chain_gid":"eip155:1","txid":"0x1234567890abcdef1234567890abcdef1234567890abcdef1234567890abcdef","address":"0x742d35cc6634c0532925a3b8d1e1d78d8E15e5c4","asset_gid":"eip155:1/erc20:0xdAC17F958D2ee523a2206206994597C13D831ec7","direction":"out","delta":{"base":"-1000000","formatted":"-1.0"},"created_at":"2024-01-15T10:30:00Z","entry_kind":"token_transfer"},{"chain_gid":"eip155:1","txid":"0x1234567890abcdef1234567890abcdef1234567890abcdef1234567890abcdef","address":"0x742d35cc6634c0532925a3b8d1e1d78d8E15e5c4","asset_gid":"eip155:1/slip44:60","direction":"out","delta":{"base":"-21000000000000000","formatted":"-0.021"},"created_at":"2024-01-15T10:30:00Z","entry_kind":"network_fee"}],"details":{"family":"evm","events":[{"event_index":0,"kind":"transfer","asset_gid":"eip155:1/erc20:0xdAC17F958D2ee523a2206206994597C13D831ec7","amount":{"base":"1000000","formatted":"1.0"},"operation":"transfer","from_address":"0x742d35cc6634c0532925a3b8d1e1d78d8E15e5c4","to_address":"0x95212290dd7278aa3ddd389cc1e1d165cc4bafe5"},{"event_index":1,"kind":"interaction","target_address":"0xdAC17F958D2ee523a2206206994597C13D831ec7","caller_address":"0x742d35cc6634c0532925a3b8d1e1d78d8E15e5c4","outcome":"succeeded"}],"is_success":true,"fee":{"base":"21000000000000000","formatted":"0.021"},"block":{"block_hash":"0x9f1c2a3b4d5e6f708192a3b4c5d6e7f8091a2b3c4d5e6f708192a3b4c5d6e7f8","block_height":18500000},"transaction_index":42,"from_address":"0x742d35cc6634c0532925a3b8d1e1d78d8E15e5c4","to_address":"0xdAC17F958D2ee523a2206206994597C13D831ec7","gas_used":65000}}}},"components/schemas/SimulateEVMRequest":{"id":"components/schemas/SimulateEVMRequest","kind":"json-schema","title":"SimulateEVMRequest","data":{"type":"object","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"EVM simulation payload. Within a call, gas_price is mutually exclusive with"},"children":[]},{"$$mdtype":"Node","type":"softbreak","inline":true,"attributes":{},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"max_fee_per_gas and max_priority_fee_per_gas; max_fee_per_gas and"},"children":[]},{"$$mdtype":"Node","type":"softbreak","inline":true,"attributes":{},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"max_priority_fee_per_gas must both be set or both left out."},"children":[]}]}]}],"properties":{"chain_gid":{"$ref":"#/components/schemas/ChainGID","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"EVM chain the simulation runs on, an "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"eip155:"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" network the project can reach."},"children":[]}]}]}]},"validation":{"type":"boolean","description":"When true, the simulation checks sender balance, nonce sequence, and\nfee consistency the same way a real submission would. When false\n(default), missing parameters are filled with permissive defaults\nand balance is not checked.\n","default":false},"block_state_calls":{"type":"array","description":"Blocks to simulate.","items":{"type":"object","properties":{"calls":{"type":"array","description":"Calls in this block, at most 100. The server also applies its gas and byte budgets to the whole request.","items":{"type":"object","properties":{"from":{"type":"string","pattern":"^0x[a-fA-F0-9]{40}$","description":"Sender address.","example":"0x974caa59e49682cda0ad2bbe82983419a2ecc400"},"to":{"type":"string","pattern":"^0x[a-fA-F0-9]{40}$","description":"Recipient address.","example":"0xd0930a8fc56fd94038250bb93dbac0e13da4eb99"},"value":{"type":"string","pattern":"^(0x[a-fA-F0-9]+|[0-9]+)$","description":"Transfer value in wei (decimal or 0x hex).","example":"10000000000000000","default":"0"},"data":{"type":"string","pattern":"^0x(?:[a-fA-F0-9]{2})*$","description":"Call data (hex).","example":"0xa9059cbb000000000000000000000000d0930a8fc56fd94038250bb93dbac0e13da4eb99000000000000000000000000000000000000000000000000000000003b9aca00","default":"0x"},"nonce":{"type":"string","pattern":"^(0x[a-fA-F0-9]+|[0-9]+)$","description":"Sender nonce (decimal or 0x hex). If omitted, the current nonce is used.","example":"1"},"gas":{"type":"string","pattern":"^(0x[a-fA-F0-9]+|[0-9]+)$","description":"Positive gas limit (decimal or 0x hex), subject to the simulation gas budget.","example":"21000"},"gas_price":{"type":"string","pattern":"^(0x[a-fA-F0-9]+|[0-9]+)$","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Gas price in wei (decimal or 0x hex). Legacy transactions only. Mutually exclusive with max_fee_per_gas / max_priority_fee_per_gas."},"children":[]}]}]}],"example":"1000000000"},"max_fee_per_gas":{"type":"string","pattern":"^(0x[a-fA-F0-9]+|[0-9]+)$","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Max fee per gas in wei (decimal or 0x hex). EIP-1559 only. Mutually exclusive with gas_price."},"children":[]}]}]}],"example":"2000000000"},"max_priority_fee_per_gas":{"type":"string","pattern":"^(0x[a-fA-F0-9]+|[0-9]+)$","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Priority fee (tip) per gas in wei (decimal or 0x hex). EIP-1559 only. Mutually exclusive with gas_price."},"children":[]}]}]}],"example":"1000000000"}},"required":["from","to"],"additionalProperties":false},"minItems":1,"maxItems":100}},"required":["calls"],"additionalProperties":false},"minItems":1,"maxItems":256}},"required":["chain_gid","block_state_calls"],"additionalProperties":false}},"components/schemas/SimulationError":{"id":"components/schemas/SimulationError","kind":"json-schema","title":"SimulationError","data":{"type":"object","description":"Error details for a failed simulation.\n","properties":{"code":{"type":"integer","description":"Error code from the EVM execution.","example":-32000},"message":{"type":"string","description":"Human-readable error message.","example":"execution reverted"},"data":{"type":"string","description":"Raw revert data (hex-encoded) for detailed error decoding.","example":"0x08c379a00000000000000000000000000000000000000000000000000000000000000020000000000000000000000000000000000000000000000000000000000000001a4e6f7420656e6f75676820746f6b656e2062616c616e636500000000000000"}},"required":["code","message"],"example":{"code":-32000,"message":"execution reverted","data":"0x"}}},"components/schemas/SimulatedTransaction":{"id":"components/schemas/SimulatedTransaction","kind":"json-schema","title":"SimulatedTransaction","data":{"type":"object","description":"Predicted result of a simulated transaction, in the shape of a real one plus error on a\nfailed call.\n","properties":{"chain_gid":{"$ref":"#/components/schemas/ChainGID"},"txid":{"$ref":"#/components/schemas/Txid"},"created_at":{"$ref":"#/components/schemas/Timestamp","description":"Time the simulation ran."},"activity":{"type":"array","description":"Predicted balance changes for involved addresses.","items":{"$ref":"#/components/schemas/ActivityItem"}},"details":{"$ref":"#/components/schemas/EVMTransaction","description":"EVM execution of the simulated call. Simulation runs on EVM chains only, so this is not a\nunion.\n"},"error":{"$ref":"#/components/schemas/SimulationError"}},"required":["chain_gid","txid","created_at","activity","details"],"example":{"chain_gid":"eip155:1","txid":"0x5ab3bd0e9411c0537ae0d4d277e2b88951ac0e4eef1e4ed1434b2e6b6ae677f7","created_at":"2025-01-15T10:30:00Z","activity":[{"chain_gid":"eip155:1","txid":"0x5ab3bd0e9411c0537ae0d4d277e2b88951ac0e4eef1e4ed1434b2e6b6ae677f7","address":"0x974caa59e49682cda0ad2bbe82983419a2ecc400","asset_gid":"eip155:1/erc20:0xdAC17F958D2ee523a2206206994597C13D831ec7","direction":"out","delta":{"base":"-1000000","formatted":"-1.0"},"created_at":"2025-01-15T10:30:00Z","entry_kind":"token_transfer"},{"chain_gid":"eip155:1","txid":"0x5ab3bd0e9411c0537ae0d4d277e2b88951ac0e4eef1e4ed1434b2e6b6ae677f7","address":"0xd0930a8fc56fd94038250bb93dbac0e13da4eb99","asset_gid":"eip155:1/erc20:0xdAC17F958D2ee523a2206206994597C13D831ec7","direction":"in","delta":{"base":"1000000","formatted":"1.0"},"created_at":"2025-01-15T10:30:00Z","entry_kind":"token_transfer"}],"details":{"family":"evm","events":[{"event_index":0,"kind":"transfer","asset_gid":"eip155:1/erc20:0xdAC17F958D2ee523a2206206994597C13D831ec7","amount":{"base":"1000000","formatted":"1.0"},"operation":"transfer","from_address":"0x974caa59e49682cda0ad2bbe82983419a2ecc400","to_address":"0xd0930a8fc56fd94038250bb93dbac0e13da4eb99"}],"is_success":true,"fee":{"base":"1100877000000000","formatted":"0.001100877"},"block":{"block_hash":"0x9f1c2a3b4d5e6f708192a3b4c5d6e7f8091a2b3c4d5e6f708192a3b4c5d6e7f8","block_height":24331622},"transaction_index":0,"from_address":"0x974caa59e49682cda0ad2bbe82983419a2ecc400","to_address":"0xdAC17F958D2ee523a2206206994597C13D831ec7","gas_used":51262}}}},"components/schemas/InvoiceStatus":{"id":"components/schemas/InvoiceStatus","kind":"json-schema","title":"InvoiceStatus","data":{"type":"string","description":"Lifecycle status of the invoice.","enum":["open","processing","confirmed","cancelled","expired"],"x-enumDescriptions":{"open":"The payment window is open.","processing":"The payment window ended, but payment checks, confirmations or operator handling are still pending.","confirmed":"The confirmed amount is sufficient and the invoice is settled.","cancelled":"Cancelled by the merchant under the invoice cancellation rules.","expired":"The payment window ended, payment checks completed and no valid payments were found."},"example":"open"}},"components/schemas/InvoiceSummary":{"id":"components/schemas/InvoiceSummary","kind":"json-schema","title":"InvoiceSummary","data":{"type":"object","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Compact invoice representation for list endpoints."},"children":[]},{"$$mdtype":"Node","type":"softbreak","inline":true,"attributes":{},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Use GET /invoices/{invoice_id} for full details including status logs and transactions."},"children":[]}]}]}],"properties":{"id":{"$ref":"#/components/schemas/UUID"},"address":{"$ref":"#/components/schemas/TransactionAddressValue"},"asset_gid":{"$ref":"#/components/schemas/AssetGID"},"amount":{"$ref":"#/components/schemas/AmountInBaseUnits"},"received_amount":{"$ref":"#/components/schemas/AmountInBaseUnits","description":"Total amount from currently valid payments accepted during the payment window."},"confirmed_amount":{"$ref":"#/components/schemas/AmountInBaseUnits","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Portion of received_amount that has reached the required confirmations."},"children":[]}]}]}]},"status":{"$ref":"#/components/schemas/InvoiceStatus"},"expires_at":{"$ref":"#/components/schemas/Timestamp","description":"Exclusive end of the payment window unless the invoice becomes confirmed or cancelled earlier.","example":"2024-01-15T13:00:00Z"},"metadata":{"type":"object","description":"Optional key-value pairs for storing additional information about the invoice. The combined UTF-8 size of the decoded keys and values must not exceed 4096 bytes.\n","additionalProperties":{"type":"string"},"example":{"order_id":"1234","customer":"john@example.com"}},"created_at":{"$ref":"#/components/schemas/CreatedAt"},"updated_at":{"$ref":"#/components/schemas/UpdatedAt"}},"required":["id","address","asset_gid","amount","received_amount","confirmed_amount","status","expires_at","metadata","created_at","updated_at"],"example":{"id":"550e8400-e29b-41d4-a716-446655440000","address":"0x742d35Cc6634C0532925a3b844Bc9e7595f2bD18","asset_gid":"eip155:56/erc20:0x55d398326f99059fF775485246999027B3197955","amount":"42500000","received_amount":"0","confirmed_amount":"0","status":"open","expires_at":"2024-01-15T13:00:00Z","metadata":{"order_id":"1234"},"created_at":"2024-01-15T10:30:00Z","updated_at":"2024-01-15T10:30:00Z"}}},"components/schemas/InvoiceReferences":{"id":"components/schemas/InvoiceReferences","kind":"json-schema","title":"InvoiceReferences","data":{"type":"object","description":"Related objects included in the response, keyed by ID.","properties":{"tokens":{"type":"object","description":"Map of tokens indexed by their CAIP-19 Asset GID.","propertyNames":{"$ref":"#/components/schemas/AssetGID"},"additionalProperties":{"$ref":"#/components/schemas/Token"}},"blockchains":{"type":"object","description":"Map of blockchains indexed by their CAIP-2 Chain GID.","propertyNames":{"$ref":"#/components/schemas/ChainGID"},"additionalProperties":{"$ref":"#/components/schemas/Blockchain"}},"transactions":{"type":"object","description":"Summaries of the active linked transactions, keyed by chain GID and then by txid. An\ninactive link has no entry here.\n","propertyNames":{"$ref":"#/components/schemas/ChainGID"},"additionalProperties":{"type":"object","propertyNames":{"$ref":"#/components/schemas/Txid"},"additionalProperties":{"$ref":"#/components/schemas/TransactionSummary"}}}},"required":["tokens","blockchains","transactions"],"example":{"tokens":{},"blockchains":{},"transactions":{}}}},"components/schemas/CreateInvoiceRequest":{"id":"components/schemas/CreateInvoiceRequest","kind":"json-schema","title":"CreateInvoiceRequest","data":{"type":"object","description":"Invoice creation payload.","properties":{"address":{"$ref":"#/components/schemas/AddressValue"},"asset_gid":{"$ref":"#/components/schemas/AssetGID"},"amount":{"$ref":"#/components/schemas/AmountInBaseUnits"},"expires_at":{"$ref":"#/components/schemas/Timestamp","description":"Exclusive end of the payment window. Must be in the future.","example":"2024-01-15T13:00:00Z"},"metadata":{"type":"object","description":"Optional key-value pairs for storing additional information about the invoice. The combined UTF-8 size of the decoded keys and values must not exceed 4096 bytes.\n","additionalProperties":{"type":"string"},"example":{"order_id":"1234"}}},"required":["address","asset_gid","amount","expires_at"],"additionalProperties":false}},"components/schemas/InvoiceStatusLog":{"id":"components/schemas/InvoiceStatusLog","kind":"json-schema","title":"InvoiceStatusLog","data":{"type":"object","description":"A lifecycle transition in the invoice history, with an optional manager comment.\n","properties":{"status":{"$ref":"#/components/schemas/InvoiceStatus","description":"New lifecycle status."},"comment":{"oneOf":[{"type":"string"},{"type":"null"}],"description":"Optional comment explaining the change (e.g. cancellation reason).","example":"Cancelled by merchant"},"changed_at":{"$ref":"#/components/schemas/Timestamp","description":"When the transition occurred.","example":"2024-01-15T12:05:00Z"}},"required":["status","comment","changed_at"],"example":{"status":"cancelled","comment":"Cancelled by merchant","changed_at":"2024-01-15T12:05:00Z"}}},"components/schemas/InvoiceDeposit":{"id":"components/schemas/InvoiceDeposit","kind":"json-schema","title":"InvoiceDeposit","data":{"type":"object","description":"Individual token deposit received within a transaction. amount is never zero.\n","properties":{"asset_gid":{"$ref":"#/components/schemas/AssetGID"},"amount":{"description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Deposit amount in base units (smallest token denomination). Use the token metadata"},"children":[]},{"$$mdtype":"Node","type":"softbreak","inline":true,"attributes":{},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"from the "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"references.tokens"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" map to format the value for display. A token missing"},"children":[]},{"$$mdtype":"Node","type":"softbreak","inline":true,"attributes":{},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"from that map has no complete display metadata known to the service; the deposit"},"children":[]},{"$$mdtype":"Node","type":"softbreak","inline":true,"attributes":{},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"itself is still real and still listed."},"children":[]}]}]}],"$ref":"#/components/schemas/AmountInBaseUnits"},"is_matched":{"type":"boolean","description":"Whether this deposit's token matches the invoice's expected token.","example":true}},"required":["asset_gid","amount","is_matched"],"example":{"asset_gid":"eip155:56/erc20:0x55d398326f99059fF775485246999027B3197955","amount":"42500000","is_matched":true}}},"components/schemas/InvoiceTransactionLink":{"id":"components/schemas/InvoiceTransactionLink","kind":"json-schema","title":"InvoiceTransactionLink","data":{"type":"object","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"A transaction associated with the invoice. The association outlives the transaction: after"},"children":[]},{"$$mdtype":"Node","type":"softbreak","inline":true,"attributes":{},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"a reorg or a replaced Bitcoin candidate, "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"is_active"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" turns false, "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"deposits"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" empties and the"},"children":[]},{"$$mdtype":"Node","type":"softbreak","inline":true,"attributes":{},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"link stays, so the same transfer can never pay another invoice. The summary of an active"},"children":[]},{"$$mdtype":"Node","type":"softbreak","inline":true,"attributes":{},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"transaction is in "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"references.transactions"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":", keyed by "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"chain_gid"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" and then "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"txid"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"; an"},"children":[]},{"$$mdtype":"Node","type":"softbreak","inline":true,"attributes":{},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"inactive link has no entry there."},"children":[]}]}]}],"properties":{"chain_gid":{"$ref":"#/components/schemas/ChainGID"},"txid":{"$ref":"#/components/schemas/Txid"},"is_active":{"type":"boolean","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Whether the observed transaction is still current on its chain; false after a reorg or"},"children":[]},{"$$mdtype":"Node","type":"softbreak","inline":true,"attributes":{},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"a replaced Bitcoin candidate. It says nothing about payment by itself: a transaction that"},"children":[]},{"$$mdtype":"Node","type":"softbreak","inline":true,"attributes":{},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"is only in the mempool is active but adds nothing to "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"received_amount"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":", and an active"},"children":[]},{"$$mdtype":"Node","type":"softbreak","inline":true,"attributes":{},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"transaction may carry deposits in other tokens only."},"children":[]}]}]}]},"deposits":{"type":"array","description":"Net positive contribution per asset at the invoice address within this transaction.\nEmpty while no eligible contribution remains.\n","items":{"$ref":"#/components/schemas/InvoiceDeposit"}}},"required":["chain_gid","txid","is_active","deposits"],"example":{"chain_gid":"eip155:56","txid":"0xabc123def456789012345678901234567890123456789012345678901234abcd","is_active":true,"deposits":[{"asset_gid":"eip155:56/erc20:0x55d398326f99059fF775485246999027B3197955","amount":"42500000","is_matched":true}]}}},"components/schemas/Invoice":{"id":"components/schemas/Invoice","kind":"json-schema","title":"Invoice","data":{"type":"object","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Payment invoice. A request for crypto payment to a specific address for a specific token amount."},"children":[]},{"$$mdtype":"Node","type":"softbreak","inline":true,"attributes":{},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"The invoice UUID is the access token: anyone with the UUID can view the invoice."},"children":[]},{"$$mdtype":"Node","type":"softbreak","inline":true,"attributes":{},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"The payment window starts at "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"created_at"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" and ends at "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"expires_at"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":", or at an earlier"},"children":[]},{"$$mdtype":"Node","type":"softbreak","inline":true,"attributes":{},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"transition to "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"confirmed"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" or "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"cancelled"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":". Only payments included in a block within this"},"children":[]},{"$$mdtype":"Node","type":"softbreak","inline":true,"attributes":{},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"window count; its end is exclusive. Cancelled invoices do not accept new payment"},"children":[]},{"$$mdtype":"Node","type":"softbreak","inline":true,"attributes":{},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"links, including payments discovered later with a block time within the former window."},"children":[]},{"$$mdtype":"Node","type":"softbreak","inline":true,"attributes":{},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Existing payment links are retained."},"children":[]}]}]}],"properties":{"id":{"$ref":"#/components/schemas/UUID"},"address":{"$ref":"#/components/schemas/TransactionAddressValue"},"asset_gid":{"$ref":"#/components/schemas/AssetGID"},"amount":{"$ref":"#/components/schemas/AmountInBaseUnits"},"received_amount":{"$ref":"#/components/schemas/AmountInBaseUnits","description":"Total amount from currently valid payments accepted during the payment window."},"confirmed_amount":{"$ref":"#/components/schemas/AmountInBaseUnits","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Portion of received_amount that has reached the required confirmations."},"children":[]}]}]}]},"status":{"$ref":"#/components/schemas/InvoiceStatus"},"expires_at":{"$ref":"#/components/schemas/Timestamp","description":"Exclusive end of the payment window unless the invoice becomes confirmed or cancelled earlier.","example":"2024-01-15T13:00:00Z"},"metadata":{"type":"object","description":"Optional key-value pairs for storing additional information about the invoice. The combined UTF-8 size of the decoded keys and values must not exceed 4096 bytes.\n","additionalProperties":{"type":"string"},"example":{"order_id":"1234","customer":"john@example.com"}},"created_at":{"$ref":"#/components/schemas/CreatedAt"},"updated_at":{"$ref":"#/components/schemas/UpdatedAt"},"status_logs":{"type":"array","description":"Chronological log of invoice status transitions with optional comments.","items":{"$ref":"#/components/schemas/InvoiceStatusLog"}},"transactions":{"type":"array","description":"Transactions associated with the invoice, active and retained.","items":{"$ref":"#/components/schemas/InvoiceTransactionLink"}}},"required":["id","address","asset_gid","amount","received_amount","confirmed_amount","status","expires_at","metadata","created_at","updated_at","status_logs","transactions"],"example":{"id":"550e8400-e29b-41d4-a716-446655440000","address":"0x742d35Cc6634C0532925a3b844Bc9e7595f2bD18","asset_gid":"eip155:56/erc20:0x55d398326f99059fF775485246999027B3197955","amount":"42500000","received_amount":"42500000","confirmed_amount":"42500000","status":"confirmed","expires_at":"2024-01-15T13:00:00Z","metadata":{"order_id":"1234"},"created_at":"2024-01-15T10:30:00Z","updated_at":"2024-01-15T12:15:00Z","status_logs":[{"status":"open","comment":null,"changed_at":"2024-01-15T10:30:00Z"},{"status":"confirmed","comment":null,"changed_at":"2024-01-15T12:15:00Z"}],"transactions":[{"chain_gid":"eip155:56","txid":"0xabc123def456789012345678901234567890123456789012345678901234abcd","is_active":true,"deposits":[{"asset_gid":"eip155:56/erc20:0x55d398326f99059fF775485246999027B3197955","amount":"42500000","is_matched":true}]}]}}},"components/schemas/CancelInvoiceRequest":{"id":"components/schemas/CancelInvoiceRequest","kind":"json-schema","title":"CancelInvoiceRequest","data":{"type":"object","description":"Optional payload for invoice cancellation.","properties":{"comment":{"type":"string","description":"Optional reason for cancellation. Max 64 characters.","maxLength":64,"example":"Cancelled by merchant"}},"additionalProperties":false}},"components/schemas/InvoiceDisplayAmount":{"id":"components/schemas/InvoiceDisplayAmount","kind":"json-schema","title":"InvoiceDisplayAmount","data":{"type":"object","description":"Amount for a payer-facing view. Carries the base-unit value and, when available,\na human-readable rendering; formatted is not constrained to a numeric pattern.\n","properties":{"base":{"$ref":"#/components/schemas/AmountInBaseUnits"},"formatted":{"type":"string","description":"Human-readable amount for display.","example":"42.5"}},"required":["base"],"example":{"base":"42500000","formatted":"42.5"}}},"components/schemas/PublicInvoiceStatusLog":{"id":"components/schemas/PublicInvoiceStatusLog","kind":"json-schema","title":"PublicInvoiceStatusLog","data":{"type":"object","description":"A lifecycle transition in the invoice history visible to payers.\n","properties":{"status":{"$ref":"#/components/schemas/InvoiceStatus","description":"New lifecycle status."},"changed_at":{"$ref":"#/components/schemas/Timestamp","description":"When the transition occurred.","example":"2024-01-15T12:05:00Z"}},"required":["status","changed_at"],"example":{"status":"open","changed_at":"2024-01-15T12:00:00Z"}}},"components/schemas/PublicInvoice":{"id":"components/schemas/PublicInvoice","kind":"json-schema","title":"PublicInvoice","data":{"type":"object","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Public-facing invoice view for payers. Contains only information necessary"},"children":[]},{"$$mdtype":"Node","type":"softbreak","inline":true,"attributes":{},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"for payment: no internal IDs, no merchant notes, no metadata."},"children":[]},{"$$mdtype":"Node","type":"softbreak","inline":true,"attributes":{},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"The payment window starts at "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"created_at"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" and ends at "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"expires_at"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":", or at an earlier"},"children":[]},{"$$mdtype":"Node","type":"softbreak","inline":true,"attributes":{},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"transition to "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"confirmed"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" or "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"cancelled"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":". Only payments included in a block within this"},"children":[]},{"$$mdtype":"Node","type":"softbreak","inline":true,"attributes":{},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"window count; its end is exclusive. Cancelled invoices do not accept new payment"},"children":[]},{"$$mdtype":"Node","type":"softbreak","inline":true,"attributes":{},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"links, including payments discovered later with a block time within the former window."},"children":[]},{"$$mdtype":"Node","type":"softbreak","inline":true,"attributes":{},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Existing payment links are retained."},"children":[]}]}]}],"properties":{"id":{"$ref":"#/components/schemas/UUID"},"status":{"$ref":"#/components/schemas/InvoiceStatus"},"amount":{"$ref":"#/components/schemas/InvoiceDisplayAmount"},"received_amount":{"$ref":"#/components/schemas/InvoiceDisplayAmount","description":"Total amount from currently valid payments accepted during the payment window."},"confirmed_amount":{"$ref":"#/components/schemas/InvoiceDisplayAmount","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Portion of received_amount that has reached the required confirmations."},"children":[]}]}]}]},"address":{"$ref":"#/components/schemas/TransactionAddressValue"},"asset_gid":{"$ref":"#/components/schemas/AssetGID"},"expires_at":{"$ref":"#/components/schemas/Timestamp","description":"Exclusive end of the payment window unless the invoice becomes confirmed or cancelled earlier.","example":"2024-01-15T13:00:00Z"},"created_at":{"$ref":"#/components/schemas/CreatedAt"},"status_logs":{"type":"array","description":"Chronological log of invoice status transitions.","items":{"$ref":"#/components/schemas/PublicInvoiceStatusLog"}},"transactions":{"type":"array","description":"Transactions associated with the invoice, active and retained.","items":{"$ref":"#/components/schemas/InvoiceTransactionLink"}}},"required":["id","status","amount","received_amount","confirmed_amount","address","asset_gid","expires_at","created_at","status_logs","transactions"],"example":{"id":"550e8400-e29b-41d4-a716-446655440000","status":"open","amount":{"base":"42500000000000000000","formatted":"42.5"},"received_amount":{"base":"0","formatted":"0"},"confirmed_amount":{"base":"0","formatted":"0"},"address":"0x742d35Cc6634C0532925a3b844Bc9e7595f2bD18","asset_gid":"eip155:56/erc20:0x55d398326f99059fF775485246999027B3197955","expires_at":"2024-01-15T13:00:00Z","created_at":"2024-01-15T12:00:00Z","status_logs":[{"status":"open","changed_at":"2024-01-15T12:00:00Z"}],"transactions":[]}}},"components/schemas/ChannelKind":{"id":"components/schemas/ChannelKind","kind":"json-schema","title":"ChannelKind","data":{"type":"string","description":"Type of notification delivery channel.","enum":["telegram","webhook"],"x-enumDescriptions":{"telegram":"Telegram bot message delivery to chats or direct messages.","webhook":"HTTP POST callbacks to external endpoints."},"example":"webhook"}},"components/schemas/ChannelName":{"id":"components/schemas/ChannelName","kind":"json-schema","title":"ChannelName","data":{"type":"string","description":"Display name for the notification channel.","minLength":1,"maxLength":32,"example":"Production Alerts Webhook"}},"components/schemas/ChannelDisabledReason":{"id":"components/schemas/ChannelDisabledReason","kind":"json-schema","title":"ChannelDisabledReason","data":{"type":"string","description":"Why the channel stopped delivering notifications.","enum":["manual","attempts_exhausted","channel_error"],"example":"attempts_exhausted"}},"components/schemas/ChannelMaxAttempts":{"id":"components/schemas/ChannelMaxAttempts","kind":"json-schema","title":"ChannelMaxAttempts","data":{"type":"integer","description":"Automatic delivery attempts allowed for one notification, counting the first one. Manual\nresends are not charged against it.\n","minimum":1,"maximum":10,"example":3}},"components/schemas/ChannelSummary":{"id":"components/schemas/ChannelSummary","kind":"json-schema","title":"ChannelSummary","data":{"type":"object","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Notification channel summary for list responses. "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"disabled_reason"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" is null while "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"is_enabled"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" is"},"children":[]},{"$$mdtype":"Node","type":"softbreak","inline":true,"attributes":{},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"true and holds the cause once the channel has been disabled."},"children":[]}]}]}],"properties":{"id":{"$ref":"#/components/schemas/UUID"},"kind":{"$ref":"#/components/schemas/ChannelKind"},"name":{"$ref":"#/components/schemas/ChannelName"},"is_enabled":{"type":"boolean","description":"Whether the channel currently delivers notifications."},"disabled_reason":{"description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Cause of the current disabled state, or null while is_enabled is true."},"children":[]}]}]}],"oneOf":[{"$ref":"#/components/schemas/ChannelDisabledReason"},{"type":"null"}]},"max_attempts":{"$ref":"#/components/schemas/ChannelMaxAttempts"},"created_at":{"$ref":"#/components/schemas/CreatedAt"}},"required":["id","kind","name","is_enabled","disabled_reason","max_attempts","created_at"],"example":{"id":"550e8400-e29b-41d4-a716-446655440000","kind":"webhook","name":"Production Alerts Webhook","is_enabled":true,"disabled_reason":null,"max_attempts":3,"created_at":"2024-01-15T10:30:00Z"}}},"components/schemas/TelegramBotToken":{"id":"components/schemas/TelegramBotToken","kind":"json-schema","title":"TelegramBotToken","data":{"type":"string","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Telegram Bot API token from @BotFather. Format: "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"{bot_id}:{auth_token}"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"."},"children":[]}]}]},{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Accepted on write (create, or update to rotate the token). On read the"},"children":[]},{"$$mdtype":"Node","type":"softbreak","inline":true,"attributes":{},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"value is masked (see "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"TelegramBotTokenMasked"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":")."},"children":[]}]}]}],"pattern":"^\\d{7,12}:[A-Za-z0-9_-]{35}$","examples":["123456789:ABCDEFGHIJKLMNOPQRSTUVWXYZ123456789"]}},"components/schemas/TelegramChatID":{"id":"components/schemas/TelegramChatID","kind":"json-schema","title":"TelegramChatID","data":{"type":"integer","format":"int64","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Telegram chat ID where notifications are sent."},"children":[]},{"$$mdtype":"Node","type":"softbreak","inline":true,"attributes":{},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Positive for private chats, negative for groups, "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"-100..."},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" prefix for channels."},"children":[]},{"$$mdtype":"Node","type":"softbreak","inline":true,"attributes":{},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Use the Telegram Bot API "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"getUpdates"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" method to find your chat ID."},"children":[]}]}]}],"examples":[-1001234567890,123456789,-987654321]}},"components/schemas/Language":{"id":"components/schemas/Language","kind":"json-schema","title":"Language","data":{"type":"string","description":"Language code for localization.","enum":["ru","en"],"x-enumDescriptions":{"ru":"Russian.","en":"English."},"example":"en"}},"components/schemas/TelegramThreadID":{"id":"components/schemas/TelegramThreadID","kind":"json-schema","title":"TelegramThreadID","data":{"type":"integer","format":"int32","description":"Unique identifier for the target message thread (topic) of a forum.\n\nUsed for forum supergroups and private chats of bots with forum topic mode enabled only.\nDefault value is 0 (no specific thread).\n","default":0,"example":0}},"components/schemas/CreateTelegramChannelConfig":{"id":"components/schemas/CreateTelegramChannelConfig","kind":"json-schema","title":"CreateTelegramChannelConfig","data":{"type":"object","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Telegram channel configuration for channel creation. The "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"bot_token"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" is"},"children":[]},{"$$mdtype":"Node","type":"softbreak","inline":true,"attributes":{},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"required in plaintext; after that it's only ever returned masked."},"children":[]}]}]}],"properties":{"kind":{"type":"string","enum":["telegram"],"description":"Configuration type discriminator."},"bot_token":{"$ref":"#/components/schemas/TelegramBotToken"},"chat_id":{"$ref":"#/components/schemas/TelegramChatID"},"language":{"$ref":"#/components/schemas/Language"},"thread_id":{"$ref":"#/components/schemas/TelegramThreadID"}},"required":["kind","bot_token","chat_id","language","thread_id"],"additionalProperties":false,"example":{"kind":"telegram","bot_token":"123456789:ABCDEFGHIJKLMNOPQRSTUVWXYZ123456789","chat_id":-1001234567890,"language":"en","thread_id":0}}},"components/schemas/WebhookURL":{"id":"components/schemas/WebhookURL","kind":"json-schema","title":"WebhookURL","data":{"type":"string","format":"uri","description":"HTTP/HTTPS endpoint that accepts POST requests with JSON payloads.\nUse headers (not query params) for authentication.\n","examples":["https://api.example.com/webhooks/notifications","https://hooks.slack.com/services/T00000000/B00000000/XXXXXXXXXXXXXXXXXXXXXXXX","https://discord.com/api/webhooks/123456789012345678/abcdefghijklmnopqrstuvwxyz123456789"]}},"components/schemas/WebhookHeaders":{"id":"components/schemas/WebhookHeaders","kind":"json-schema","title":"WebhookHeaders","data":{"type":"object","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Optional HTTP headers to include with webhook requests, including"},"children":[]},{"$$mdtype":"Node","type":"softbreak","inline":true,"attributes":{},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"receiver authentication headers such as "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"X-Webhook-Secret"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"."},"children":[]}]}]},{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Anyone authorized to read the channel can read these values; they are"},"children":[]},{"$$mdtype":"Node","type":"softbreak","inline":true,"attributes":{},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"not masked. The webhook signing secret is managed separately and"},"children":[]},{"$$mdtype":"Node","type":"softbreak","inline":true,"attributes":{},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"produces the "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"X-Webhook-Signature"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" header. Custom headers cannot override"},"children":[]},{"$$mdtype":"Node","type":"softbreak","inline":true,"attributes":{},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"signing or event headers. Other names starting with "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"X-Webhook-"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" are"},"children":[]},{"$$mdtype":"Node","type":"softbreak","inline":true,"attributes":{},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"reserved; header names are case-insensitive."},"children":[]}]}]},{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"On update, omit "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"headers"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" to keep the stored set, send an object to"},"children":[]},{"$$mdtype":"Node","type":"softbreak","inline":true,"attributes":{},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"replace it, or "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"{}"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" to clear them."},"children":[]}]}]}],"additionalProperties":{"type":"string"},"example":{"X-Tenant-Id":"acme"}}},"components/schemas/WebhookPayloadVersion":{"id":"components/schemas/WebhookPayloadVersion","kind":"json-schema","title":"WebhookPayloadVersion","data":{"type":"string","description":"Webhook body contract a channel sends. It names the complete payload shape, not the HTTP route\nand not the signature algorithm. Webhook channels created through v2 state it explicitly.\n","enum":["v1","v2"],"x-enumDescriptions":{"v1":"The legacy four-field body kept for channels migrated from v1.","v2":"The current six-field body carrying the v2 transaction shape."},"example":"v2"}},"components/schemas/CreateWebhookChannelConfig":{"id":"components/schemas/CreateWebhookChannelConfig","kind":"json-schema","title":"CreateWebhookChannelConfig","data":{"type":"object","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Webhook channel configuration for channel creation, the request form of "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"WebhookChannelConfig"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":";"},"children":[]},{"$$mdtype":"Node","type":"softbreak","inline":true,"attributes":{},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"an unknown property is rejected. "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"payload_version"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" picks the body shape and belongs to webhook"},"children":[]},{"$$mdtype":"Node","type":"softbreak","inline":true,"attributes":{},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"channels only: a Telegram configuration that carries it is rejected."},"children":[]}]}]}],"properties":{"kind":{"type":"string","enum":["webhook"],"description":"Configuration type discriminator."},"url":{"$ref":"#/components/schemas/WebhookURL"},"headers":{"$ref":"#/components/schemas/WebhookHeaders"},"payload_version":{"$ref":"#/components/schemas/WebhookPayloadVersion"}},"required":["kind","url","payload_version"],"additionalProperties":false,"example":{"kind":"webhook","url":"https://api.example.com/webhooks/notifications","headers":{"Content-Type":"application/json","X-Tenant-Id":"acme"},"payload_version":"v2"}}},"components/schemas/CreateChannelConfig":{"id":"components/schemas/CreateChannelConfig","kind":"json-schema","title":"CreateChannelConfig","data":{"description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Channel-specific configuration for channel creation. The Telegram"},"children":[]},{"$$mdtype":"Node","type":"softbreak","inline":true,"attributes":{},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"bot_token"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" is required in plaintext; after that it's only ever returned"},"children":[]},{"$$mdtype":"Node","type":"softbreak","inline":true,"attributes":{},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"masked. A webhook configuration must state "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"payload_version"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"; a Telegram"},"children":[]},{"$$mdtype":"Node","type":"softbreak","inline":true,"attributes":{},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"configuration that carries it is rejected."},"children":[]}]}]}],"discriminator":{"propertyName":"kind","mapping":{"telegram":"#/components/schemas/CreateTelegramChannelConfig","webhook":"#/components/schemas/CreateWebhookChannelConfig"}},"oneOf":[{"$ref":"#/components/schemas/CreateTelegramChannelConfig"},{"$ref":"#/components/schemas/CreateWebhookChannelConfig"}]}},"components/schemas/CreateChannelRequest":{"id":"components/schemas/CreateChannelRequest","kind":"json-schema","title":"CreateChannelRequest","data":{"type":"object","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Notification channel creation payload. "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"max_attempts"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" is required. The documented default of"},"children":[]},{"$$mdtype":"Node","type":"softbreak","inline":true,"attributes":{},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"3 is a suggested client value; the server does not supply it."},"children":[]}]}]}],"properties":{"name":{"$ref":"#/components/schemas/ChannelName"},"config":{"$ref":"#/components/schemas/CreateChannelConfig"},"max_attempts":{"$ref":"#/components/schemas/ChannelMaxAttempts"},"is_enabled":{"type":"boolean","description":"Whether the channel starts out delivering notifications.","default":true}},"required":["name","config","max_attempts"],"additionalProperties":false}},"components/schemas/TelegramBotTokenMasked":{"id":"components/schemas/TelegramBotTokenMasked","kind":"json-schema","title":"TelegramBotTokenMasked","data":{"type":"string","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Masked Telegram bot token returned in responses. The "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"bot_id"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" prefix is"},"children":[]},{"$$mdtype":"Node","type":"softbreak","inline":true,"attributes":{},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"preserved for identification; the secret "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"auth_token"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" portion is hidden,"},"children":[]},{"$$mdtype":"Node","type":"softbreak","inline":true,"attributes":{},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"showing only its last 4 characters: "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"{bot_id}:••••<last4>"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"."},"children":[]}]}]},{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"To keep the stored token on update, omit "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"bot_token"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" from the request."},"children":[]},{"$$mdtype":"Node","type":"softbreak","inline":true,"attributes":{},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"To rotate it, send a new plaintext token (see "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"TelegramBotToken"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":")."},"children":[]}]}]}],"examples":["123456789:••••6789"]}},"components/schemas/TelegramChannelConfig":{"id":"components/schemas/TelegramChannelConfig","kind":"json-schema","title":"TelegramChannelConfig","data":{"type":"object","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Telegram notification channel configuration as returned in responses."},"children":[]}]}]},{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"bot_token"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" is masked (see "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"TelegramBotTokenMasked"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"); all other fields are"},"children":[]},{"$$mdtype":"Node","type":"softbreak","inline":true,"attributes":{},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"returned verbatim."},"children":[]}]}]}],"properties":{"kind":{"type":"string","enum":["telegram"],"description":"Configuration type discriminator."},"bot_token":{"$ref":"#/components/schemas/TelegramBotTokenMasked"},"chat_id":{"$ref":"#/components/schemas/TelegramChatID"},"language":{"$ref":"#/components/schemas/Language"},"thread_id":{"$ref":"#/components/schemas/TelegramThreadID"}},"required":["kind","bot_token","chat_id","language","thread_id"],"example":{"kind":"telegram","bot_token":"123456789:••••6789","chat_id":-1001234567890,"language":"en","thread_id":0}}},"components/schemas/WebhookChannelConfig":{"id":"components/schemas/WebhookChannelConfig","kind":"json-schema","title":"WebhookChannelConfig","data":{"type":"object","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Webhook notification channel configuration as returned on read; "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"CreateWebhookChannelConfig"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" is"},"children":[]},{"$$mdtype":"Node","type":"softbreak","inline":true,"attributes":{},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"what a client sends."},"children":[]}]}]},{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Sends HTTP POST requests with JSON payloads to the configured URL."},"children":[]},{"$$mdtype":"Node","type":"softbreak","inline":true,"attributes":{},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Optional "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"headers"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" are returned verbatim (see "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"WebhookHeaders"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":")."},"children":[]},{"$$mdtype":"Node","type":"softbreak","inline":true,"attributes":{},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"payload_version"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" picks the body shape and belongs to webhook channels only:"},"children":[]},{"$$mdtype":"Node","type":"softbreak","inline":true,"attributes":{},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"a Telegram configuration that carries it is rejected."},"children":[]}]}]}],"properties":{"kind":{"type":"string","enum":["webhook"],"description":"Configuration type discriminator."},"url":{"$ref":"#/components/schemas/WebhookURL"},"headers":{"$ref":"#/components/schemas/WebhookHeaders"},"payload_version":{"$ref":"#/components/schemas/WebhookPayloadVersion"}},"required":["kind","url","payload_version"],"example":{"kind":"webhook","url":"https://api.example.com/webhooks/notifications","headers":{"X-Tenant-Id":"acme"},"payload_version":"v2"}}},"components/schemas/ChannelConfig":{"id":"components/schemas/ChannelConfig","kind":"json-schema","title":"ChannelConfig","data":{"description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Channel-specific configuration as returned in responses. Schema depends"},"children":[]},{"$$mdtype":"Node","type":"softbreak","inline":true,"attributes":{},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"on "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"kind"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":": "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"telegram"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" (bot_token + chat_id) or "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"webhook"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" (url + headers)."},"children":[]},{"$$mdtype":"Node","type":"softbreak","inline":true,"attributes":{},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"The Telegram "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"bot_token"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" is masked; webhook headers are returned verbatim."},"children":[]},{"$$mdtype":"Node","type":"softbreak","inline":true,"attributes":{},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"config.kind"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" always equals the channel's own "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"kind"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":", and "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"payload_version"},"children":[]},{"$$mdtype":"Node","type":"softbreak","inline":true,"attributes":{},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"appears on webhook configurations only."},"children":[]}]}]}],"discriminator":{"propertyName":"kind","mapping":{"telegram":"#/components/schemas/TelegramChannelConfig","webhook":"#/components/schemas/WebhookChannelConfig"}},"oneOf":[{"$ref":"#/components/schemas/TelegramChannelConfig"},{"$ref":"#/components/schemas/WebhookChannelConfig"}]}},"components/schemas/Channel":{"id":"components/schemas/Channel","kind":"json-schema","title":"Channel","data":{"type":"object","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Notification delivery channel."},"children":[]}]}]},{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"disabled_reason"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" is null while "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"is_enabled"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" is true and names the cause once the channel has"},"children":[]},{"$$mdtype":"Node","type":"softbreak","inline":true,"attributes":{},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"been disabled. "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"config.kind"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" always equals the channel's "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"kind"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":", which is fixed at creation."},"children":[]}]}]}],"properties":{"id":{"$ref":"#/components/schemas/UUID"},"kind":{"$ref":"#/components/schemas/ChannelKind"},"name":{"$ref":"#/components/schemas/ChannelName"},"is_enabled":{"type":"boolean","description":"Whether the channel currently delivers notifications."},"disabled_reason":{"description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Cause of the current disabled state, or null while is_enabled is true."},"children":[]}]}]}],"oneOf":[{"$ref":"#/components/schemas/ChannelDisabledReason"},{"type":"null"}]},"max_attempts":{"$ref":"#/components/schemas/ChannelMaxAttempts"},"config":{"$ref":"#/components/schemas/ChannelConfig"},"created_at":{"$ref":"#/components/schemas/CreatedAt"},"updated_at":{"$ref":"#/components/schemas/UpdatedAt"}},"required":["id","kind","name","is_enabled","disabled_reason","max_attempts","config","created_at","updated_at"],"example":{"id":"550e8400-e29b-41d4-a716-446655440001","kind":"telegram","name":"Production Alerts","is_enabled":true,"disabled_reason":null,"max_attempts":3,"config":{"kind":"telegram","bot_token":"123456789:••••6789","chat_id":-1001234567890,"language":"en","thread_id":0},"created_at":"2024-01-15T10:30:00Z","updated_at":"2024-01-15T10:30:00Z"}}},"components/schemas/RawWebhookSecret":{"id":"components/schemas/RawWebhookSecret","kind":"json-schema","title":"RawWebhookSecret","data":{"type":"string","minLength":55,"maxLength":55,"pattern":"^vilna_whsec_[A-Za-z0-9]{43}$","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"The full webhook signing secret, 55 characters: "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"vilna_whsec_{body}"},"children":[]},{"$$mdtype":"Node","type":"softbreak","inline":true,"attributes":{},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"where "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"{body}"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" is 43 ASCII base62 characters. Used as the HMAC-SHA256 key"},"children":[]},{"$$mdtype":"Node","type":"softbreak","inline":true,"attributes":{},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"for the "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"X-Webhook-Signature"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" header on outgoing webhook deliveries."},"children":[]},{"$$mdtype":"Node","type":"softbreak","inline":true,"attributes":{},"children":[]},{"$$mdtype":"Node","type":"strong","inline":true,"attributes":{"marker":"**"},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Returned only at channel creation and on rotation; store it"},"children":[]},{"$$mdtype":"Node","type":"softbreak","inline":true,"attributes":{},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"securely."},"children":[]}]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" Lost secrets must be rotated."},"children":[]}]}]}],"example":"vilna_whsec_a3K9pQ2mB5N8rT1xY7cZ4dH6eJ0fLm0123456789ABC"}},"components/schemas/UpdateTelegramChannelConfig":{"id":"components/schemas/UpdateTelegramChannelConfig","kind":"json-schema","title":"UpdateTelegramChannelConfig","data":{"type":"object","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Telegram channel configuration for channel update (partial). Omit"},"children":[]},{"$$mdtype":"Node","type":"softbreak","inline":true,"attributes":{},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"bot_token"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" to keep the stored token; send a new plaintext value to"},"children":[]},{"$$mdtype":"Node","type":"softbreak","inline":true,"attributes":{},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"rotate it."},"children":[]}]}]}],"properties":{"kind":{"type":"string","enum":["telegram"],"description":"Configuration type discriminator."},"bot_token":{"$ref":"#/components/schemas/TelegramBotToken"},"chat_id":{"$ref":"#/components/schemas/TelegramChatID"},"language":{"$ref":"#/components/schemas/Language"},"thread_id":{"$ref":"#/components/schemas/TelegramThreadID"}},"required":["kind","chat_id","language","thread_id"],"additionalProperties":false,"example":{"kind":"telegram","chat_id":-1001234567890,"language":"en","thread_id":0}}},"components/schemas/UpdateWebhookChannelConfig":{"id":"components/schemas/UpdateWebhookChannelConfig","kind":"json-schema","title":"UpdateWebhookChannelConfig","data":{"type":"object","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Webhook notification channel configuration for channel update (partial)."},"children":[]}]}]},{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"url"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" is still required. Omit "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"headers"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" to keep the stored set, send an object to replace it,"},"children":[]},{"$$mdtype":"Node","type":"softbreak","inline":true,"attributes":{},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"or "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"{}"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" to clear it. Omit "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"payload_version"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" to keep the live version; sending one switches the"},"children":[]},{"$$mdtype":"Node","type":"softbreak","inline":true,"attributes":{},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"body shape without resetting attempts, cancelling frozen work or enabling the channel."},"children":[]}]}]}],"properties":{"kind":{"type":"string","enum":["webhook"],"description":"Configuration type discriminator."},"url":{"$ref":"#/components/schemas/WebhookURL"},"headers":{"$ref":"#/components/schemas/WebhookHeaders"},"payload_version":{"$ref":"#/components/schemas/WebhookPayloadVersion"}},"required":["kind","url"],"additionalProperties":false,"example":{"kind":"webhook","url":"https://api.example.com/webhooks/notifications","payload_version":"v2"}}},"components/schemas/UpdateChannelConfig":{"id":"components/schemas/UpdateChannelConfig","kind":"json-schema","title":"UpdateChannelConfig","data":{"description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Channel-specific configuration for channel update (partial). Omit the"},"children":[]},{"$$mdtype":"Node","type":"softbreak","inline":true,"attributes":{},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Telegram "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"bot_token"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" to keep the stored token; send a new value to rotate"},"children":[]},{"$$mdtype":"Node","type":"softbreak","inline":true,"attributes":{},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"it. Webhook "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"headers"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" may be omitted (keep), replaced, or cleared ("},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"{}"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"),"},"children":[]},{"$$mdtype":"Node","type":"softbreak","inline":true,"attributes":{},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"and an omitted "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"payload_version"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" keeps the live one. "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"kind"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" is immutable,"},"children":[]},{"$$mdtype":"Node","type":"softbreak","inline":true,"attributes":{},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"so it must match the channel's stored kind."},"children":[]}]}]}],"discriminator":{"propertyName":"kind","mapping":{"telegram":"#/components/schemas/UpdateTelegramChannelConfig","webhook":"#/components/schemas/UpdateWebhookChannelConfig"}},"oneOf":[{"$ref":"#/components/schemas/UpdateTelegramChannelConfig"},{"$ref":"#/components/schemas/UpdateWebhookChannelConfig"}]}},"components/schemas/UpdateChannelRequest":{"id":"components/schemas/UpdateChannelRequest","kind":"json-schema","title":"UpdateChannelRequest","data":{"type":"object","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Notification channel update payload. At least one field is required; omitted fields keep"},"children":[]},{"$$mdtype":"Node","type":"softbreak","inline":true,"attributes":{},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"their stored value. "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"disabled_reason"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" is read-only. Setting "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"is_enabled"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" to true enables"},"children":[]},{"$$mdtype":"Node","type":"softbreak","inline":true,"attributes":{},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"the channel explicitly; renaming it, repairing its configuration or raising "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"max_attempts"},"children":[]},{"$$mdtype":"Node","type":"softbreak","inline":true,"attributes":{},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"never enables it by implication."},"children":[]}]}]}],"properties":{"name":{"$ref":"#/components/schemas/ChannelName"},"config":{"$ref":"#/components/schemas/UpdateChannelConfig"},"is_enabled":{"type":"boolean","description":"Whether the channel delivers notifications."},"max_attempts":{"$ref":"#/components/schemas/ChannelMaxAttempts"}},"minProperties":1,"additionalProperties":false}},"components/schemas/SubscriptionConcreteFamily":{"id":"components/schemas/SubscriptionConcreteFamily","kind":"json-schema","title":"SubscriptionConcreteFamily","data":{"type":"string","description":"One supported transaction family. Solana is not included: its catalog-only mode does not\nsupport transaction subscriptions. Exact-match list filters do not accept null.\n","enum":["evm","tron","bitcoin"],"example":"evm"}},"components/schemas/TestChannelRequest":{"id":"components/schemas/TestChannelRequest","kind":"json-schema","title":"TestChannelRequest","data":{"type":"object","description":"Channel test payload. The family picks the synthetic example rendered in the channel's own\nformat; no transaction, recipient override or event type is accepted.\n","properties":{"family":{"$ref":"#/components/schemas/SubscriptionConcreteFamily"}},"required":["family"],"additionalProperties":false}},"components/schemas/NotificationAccepted":{"id":"components/schemas/NotificationAccepted","kind":"json-schema","title":"NotificationAccepted","data":{"type":"object","description":"Identity of the notification an accepted action belongs to.","properties":{"notification_id":{"$ref":"#/components/schemas/UUID"}},"required":["notification_id"]}},"components/schemas/WebhookSecretMask":{"id":"components/schemas/WebhookSecretMask","kind":"json-schema","title":"WebhookSecretMask","data":{"type":"string","minLength":20,"maxLength":20,"description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Masked form of a webhook signing secret: the "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"vilna_whsec_"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" prefix, four obfuscation"},"children":[]},{"$$mdtype":"Node","type":"softbreak","inline":true,"attributes":{},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"bullets, and the last 4 characters of the random body. Use the mask to identify the stored"},"children":[]},{"$$mdtype":"Node","type":"softbreak","inline":true,"attributes":{},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"secret without displaying its plaintext."},"children":[]}]}]}],"example":"vilna_whsec_••••2gW9"}},"components/schemas/WebhookSecret":{"id":"components/schemas/WebhookSecret","kind":"json-schema","title":"WebhookSecret","data":{"type":"object","description":"A webhook signing secret in masked form. The plaintext value is only\nreturned at issuance (channel creation or rotation); subsequent reads\nexpose just the mask.\n","required":["mask","created_at"],"properties":{"mask":{"$ref":"#/components/schemas/WebhookSecretMask"},"created_at":{"$ref":"#/components/schemas/CreatedAt"},"expires_at":{"$ref":"#/components/schemas/Timestamp","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"The moment after which this secret will no longer sign new"},"children":[]},{"$$mdtype":"Node","type":"softbreak","inline":true,"attributes":{},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"outgoing webhooks. Set only when this secret occupies the"},"children":[]},{"$$mdtype":"Node","type":"softbreak","inline":true,"attributes":{},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"previous"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" slot."},"children":[]}]}]}]}}}},"components/schemas/WebhookSecrets":{"id":"components/schemas/WebhookSecrets","kind":"json-schema","title":"WebhookSecrets","data":{"type":"object","description":"The signing secrets a webhook channel holds, in masked form.","properties":{"current":{"$ref":"#/components/schemas/WebhookSecret","description":"Signing secret used for all new outgoing webhooks."},"previous":{"$ref":"#/components/schemas/WebhookSecret","description":"Previous secret retained during the 24-hour rotation overlap. Absent outside a rotation window."}},"required":["current"]}},"components/schemas/SubscriptionName":{"id":"components/schemas/SubscriptionName","kind":"json-schema","title":"SubscriptionName","data":{"type":"string","description":"Display name for the notification subscription.","minLength":1,"maxLength":64,"example":"Transaction Alerts"}},"components/schemas/SubscriptionFamily":{"id":"components/schemas/SubscriptionFamily","kind":"json-schema","title":"SubscriptionFamily","data":{"description":"Transaction family this subscription watches. Null selects every supported family.","oneOf":[{"$ref":"#/components/schemas/SubscriptionConcreteFamily"},{"type":"null"}],"example":"evm"}},"components/schemas/BlockTrigger":{"id":"components/schemas/BlockTrigger","kind":"json-schema","title":"BlockTrigger","data":{"type":"object","description":"Fire a fixed number of blocks after the transaction is included. Available for every family. Zero means\nnotify as soon as the transaction is included, never from the mempool.\n","properties":{"kind":{"type":"string","enum":["block"],"description":"Trigger kind, the discriminator of SubscriptionTrigger."},"after_blocks":{"type":"integer","format":"int64","minimum":0,"description":"Number of blocks to wait after inclusion before notifying. Bounded by the int64 range. Zero reports\nan observed inclusion without a finality guarantee. Sent notifications are not automatically\ncorrected after a withdrawal or replacement.\n"}},"required":["kind","after_blocks"],"example":{"kind":"block","after_blocks":3}}},"components/schemas/NetworkTrigger":{"id":"components/schemas/NetworkTrigger","kind":"json-schema","title":"NetworkTrigger","data":{"type":"object","description":"Fire once the transaction reaches the network's own managed minimum confirmations, instead of a fixed\ndelay. Available for every family, including null (all families).\n","properties":{"kind":{"type":"string","enum":["network"],"description":"Trigger kind, the discriminator of SubscriptionTrigger."}},"required":["kind"],"example":{"kind":"network"}}},"components/schemas/MempoolTrigger":{"id":"components/schemas/MempoolTrigger","kind":"json-schema","title":"MempoolTrigger","data":{"type":"object","description":"Fire as soon as the transaction is seen in the mempool, before inclusion. Only valid for family bitcoin;\na subscription cannot mix this with another trigger kind or family.\n","properties":{"kind":{"type":"string","enum":["mempool"],"description":"Trigger kind, the discriminator of SubscriptionTrigger."}},"required":["kind"],"example":{"kind":"mempool"}}},"components/schemas/SubscriptionTrigger":{"id":"components/schemas/SubscriptionTrigger","kind":"json-schema","title":"SubscriptionTrigger","data":{"description":"Condition under which the subscription notifies, exactly one alternative. A block trigger fires a fixed\nnumber of blocks after inclusion; a network trigger fires at the network's own confirmation policy; a\nmempool trigger fires before inclusion and requires family bitcoin. A subscription cannot switch between\ntrigger kinds once created.\n","oneOf":[{"$ref":"#/components/schemas/BlockTrigger"},{"$ref":"#/components/schemas/NetworkTrigger"},{"$ref":"#/components/schemas/MempoolTrigger"}],"discriminator":{"propertyName":"kind","mapping":{"block":"#/components/schemas/BlockTrigger","network":"#/components/schemas/NetworkTrigger","mempool":"#/components/schemas/MempoolTrigger"}}}},"components/schemas/SubscriptionFilters":{"id":"components/schemas/SubscriptionFilters","kind":"json-schema","title":"SubscriptionFilters","data":{"description":"Transaction scope within the subscribed family. Omitted properties mean unrestricted scope;\na present array must be nonempty. Selected networks must support the subscription, and\nselected tags must belong to the project.\n","type":"object","properties":{"chain_gids":{"type":"array","description":"Restrict matching to these networks. Omit for no network restriction within the family.","minItems":1,"maxItems":10,"uniqueItems":true,"items":{"$ref":"#/components/schemas/ChainGID"}},"address_tag_ids":{"type":"array","description":"Restrict matching to addresses carrying any of these project tags. Omit for every project address.","minItems":1,"maxItems":10,"uniqueItems":true,"items":{"$ref":"#/components/schemas/UUID"}}},"example":{"chain_gids":["eip155:1","eip155:56"],"address_tag_ids":["550e8400-e29b-41d4-a716-446655440020"]}}},"components/schemas/SubscriptionIsNoiseFiltered":{"id":"components/schemas/SubscriptionIsNoiseFiltered","kind":"json-schema","title":"SubscriptionIsNoiseFiltered","data":{"type":"boolean","description":"Whether automatic noise filtering applies to candidate activity. Setting this to false\nbypasses only noise filtering; project ownership, enabled and active state requirements, and\nnotification timing still apply.\n","example":true}},"components/schemas/Subscription":{"id":"components/schemas/Subscription","kind":"json-schema","title":"Subscription","data":{"type":"object","description":"Notification subscription that binds a channel to a transaction family, a firing trigger and an optional\nscope filter. When trigger is a mempool trigger, family must be bitcoin.\n","properties":{"id":{"$ref":"#/components/schemas/UUID"},"channel_id":{"$ref":"#/components/schemas/UUID"},"name":{"$ref":"#/components/schemas/SubscriptionName"},"family":{"$ref":"#/components/schemas/SubscriptionFamily"},"trigger":{"$ref":"#/components/schemas/SubscriptionTrigger"},"filters":{"$ref":"#/components/schemas/SubscriptionFilters"},"is_noise_filtered":{"$ref":"#/components/schemas/SubscriptionIsNoiseFiltered"},"enabled":{"type":"boolean","description":"Whether this subscription is active."},"created_at":{"$ref":"#/components/schemas/CreatedAt"},"updated_at":{"$ref":"#/components/schemas/UpdatedAt"}},"required":["id","channel_id","name","family","trigger","filters","is_noise_filtered","enabled","created_at","updated_at"],"example":{"id":"550e8400-e29b-41d4-a716-446655440010","channel_id":"550e8400-e29b-41d4-a716-446655440001","name":"Customer payments","family":"evm","trigger":{"kind":"block","after_blocks":3},"filters":{"chain_gids":["eip155:1","eip155:56"],"address_tag_ids":["550e8400-e29b-41d4-a716-446655440020"]},"is_noise_filtered":true,"enabled":true,"created_at":"2024-01-15T10:30:00Z","updated_at":"2024-01-15T10:30:00Z"}}},"components/schemas/SubscriptionReferences":{"id":"components/schemas/SubscriptionReferences","kind":"json-schema","title":"SubscriptionReferences","data":{"type":"object","description":"Related objects included in the response, keyed by ID.","properties":{"channels":{"type":"object","description":"Map of notification channels indexed by their UUID ID.","propertyNames":{"$ref":"#/components/schemas/UUID"},"additionalProperties":{"$ref":"#/components/schemas/ChannelSummary"}},"address_tags":{"type":"object","description":"Map of address tags selected by filters, indexed by their UUID ID.","propertyNames":{"$ref":"#/components/schemas/UUID"},"additionalProperties":{"$ref":"#/components/schemas/AddressTag"}},"blockchains":{"type":"object","description":"Map of blockchains selected by filters, indexed by their CAIP-2 Chain GID.","propertyNames":{"$ref":"#/components/schemas/ChainGID"},"additionalProperties":{"$ref":"#/components/schemas/Blockchain"}}}}},"components/schemas/BlockTriggerInput":{"id":"components/schemas/BlockTriggerInput","kind":"json-schema","title":"BlockTriggerInput","data":{"type":"object","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"The block trigger as a client sends it, the request form of "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"BlockTrigger"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"; an unknown property is"},"children":[]},{"$$mdtype":"Node","type":"softbreak","inline":true,"attributes":{},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"rejected. What the trigger means is described on "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"BlockTrigger"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"."},"children":[]}]}]}],"properties":{"kind":{"type":"string","enum":["block"],"description":"Trigger kind, the discriminator of SubscriptionTriggerInput."},"after_blocks":{"type":"integer","format":"int64","minimum":0,"description":"Number of blocks to wait after inclusion before notifying. Bounded by the int64 range. Zero reports\nan observed inclusion without a finality guarantee.\n"}},"required":["kind","after_blocks"],"additionalProperties":false,"example":{"kind":"block","after_blocks":3}}},"components/schemas/NetworkTriggerInput":{"id":"components/schemas/NetworkTriggerInput","kind":"json-schema","title":"NetworkTriggerInput","data":{"type":"object","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"The network trigger as a client sends it, the request form of "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"NetworkTrigger"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"; an unknown property is"},"children":[]},{"$$mdtype":"Node","type":"softbreak","inline":true,"attributes":{},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"rejected. What the trigger means is described on "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"NetworkTrigger"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"."},"children":[]}]}]}],"properties":{"kind":{"type":"string","enum":["network"],"description":"Trigger kind, the discriminator of SubscriptionTriggerInput."}},"required":["kind"],"additionalProperties":false,"example":{"kind":"network"}}},"components/schemas/MempoolTriggerInput":{"id":"components/schemas/MempoolTriggerInput","kind":"json-schema","title":"MempoolTriggerInput","data":{"type":"object","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"The mempool trigger as a client sends it, the request form of "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"MempoolTrigger"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"; an unknown property is"},"children":[]},{"$$mdtype":"Node","type":"softbreak","inline":true,"attributes":{},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"rejected. What the trigger means is described on "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"MempoolTrigger"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"."},"children":[]}]}]}],"properties":{"kind":{"type":"string","enum":["mempool"],"description":"Trigger kind, the discriminator of SubscriptionTriggerInput."}},"required":["kind"],"additionalProperties":false,"example":{"kind":"mempool"}}},"components/schemas/SubscriptionTriggerInput":{"id":"components/schemas/SubscriptionTriggerInput","kind":"json-schema","title":"SubscriptionTriggerInput","data":{"description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"The trigger as a client sends it, the request form of "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"SubscriptionTrigger"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":": exactly one alternative,"},"children":[]},{"$$mdtype":"Node","type":"softbreak","inline":true,"attributes":{},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"each closed to unknown properties. What each kind means is described on "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"SubscriptionTrigger"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"."},"children":[]}]}]}],"oneOf":[{"$ref":"#/components/schemas/BlockTriggerInput"},{"$ref":"#/components/schemas/NetworkTriggerInput"},{"$ref":"#/components/schemas/MempoolTriggerInput"}],"discriminator":{"propertyName":"kind","mapping":{"block":"#/components/schemas/BlockTriggerInput","network":"#/components/schemas/NetworkTriggerInput","mempool":"#/components/schemas/MempoolTriggerInput"}}}},"components/schemas/SubscriptionFiltersInput":{"id":"components/schemas/SubscriptionFiltersInput","kind":"json-schema","title":"SubscriptionFiltersInput","data":{"description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Transaction scope as a client sends it, the request form of "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"SubscriptionFilters"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":". Omitted"},"children":[]},{"$$mdtype":"Node","type":"softbreak","inline":true,"attributes":{},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"properties mean unrestricted scope; a present array must be nonempty; an unknown property is"},"children":[]},{"$$mdtype":"Node","type":"softbreak","inline":true,"attributes":{},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"rejected. Selected networks must support the subscription, and selected tags must belong to"},"children":[]},{"$$mdtype":"Node","type":"softbreak","inline":true,"attributes":{},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"the project."},"children":[]}]}]}],"type":"object","properties":{"chain_gids":{"type":"array","description":"Restrict matching to these networks. Omit for no network restriction within the family.","minItems":1,"maxItems":10,"uniqueItems":true,"items":{"$ref":"#/components/schemas/ChainGID"}},"address_tag_ids":{"type":"array","description":"Restrict matching to addresses carrying any of these project tags. Omit for every project address.","minItems":1,"maxItems":10,"uniqueItems":true,"items":{"$ref":"#/components/schemas/UUID"}}},"additionalProperties":false,"example":{"chain_gids":["eip155:1","eip155:56"],"address_tag_ids":["550e8400-e29b-41d4-a716-446655440020"]}}},"components/schemas/CreateSubscriptionRequest":{"id":"components/schemas/CreateSubscriptionRequest","kind":"json-schema","title":"CreateSubscriptionRequest","data":{"type":"object","description":"Notification subscription creation payload. When trigger is a mempool trigger, family must be\nbitcoin. Exactly matching an existing configuration returns that subscription unchanged instead of\ncreating a duplicate.\n","properties":{"name":{"$ref":"#/components/schemas/SubscriptionName"},"channel_id":{"$ref":"#/components/schemas/UUID"},"family":{"$ref":"#/components/schemas/SubscriptionFamily"},"trigger":{"$ref":"#/components/schemas/SubscriptionTriggerInput"},"filters":{"$ref":"#/components/schemas/SubscriptionFiltersInput"},"is_noise_filtered":{"$ref":"#/components/schemas/SubscriptionIsNoiseFiltered"}},"required":["name","channel_id","family","trigger"],"additionalProperties":false}},"components/schemas/UpdateSubscriptionRequest":{"id":"components/schemas/UpdateSubscriptionRequest","kind":"json-schema","title":"UpdateSubscriptionRequest","data":{"type":"object","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Notification subscription update payload. Omitted fields stay unchanged. "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"filters"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" replaces"},"children":[]},{"$$mdtype":"Node","type":"softbreak","inline":true,"attributes":{},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"the whole filter object; "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"{}"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" clears both restrictions. "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"family"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":", "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"channel_id"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" and the trigger"},"children":[]},{"$$mdtype":"Node","type":"softbreak","inline":true,"attributes":{},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"kind cannot change; "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"trigger"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" may only change its delay within the current kind. Subscriptions"},"children":[]},{"$$mdtype":"Node","type":"softbreak","inline":true,"attributes":{},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"created through v1 allow changes to "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"name"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" and "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"enabled"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" only."},"children":[]}]}]}],"properties":{"name":{"$ref":"#/components/schemas/SubscriptionName"},"trigger":{"$ref":"#/components/schemas/SubscriptionTriggerInput"},"filters":{"$ref":"#/components/schemas/SubscriptionFiltersInput"},"is_noise_filtered":{"$ref":"#/components/schemas/SubscriptionIsNoiseFiltered"},"enabled":{"type":"boolean","description":"Whether this subscription is active."}},"minProperties":1,"additionalProperties":false}},"components/schemas/NotificationStatus":{"id":"components/schemas/NotificationStatus","kind":"json-schema","title":"NotificationStatus","data":{"type":"string","description":"State of one notification. It describes delivery bookkeeping, not blockchain confirmation and\nnot the state of the channel. A canceled or failed notification may still have been seen by the\nreceiver, so there is no single success flag.\n","enum":["waiting","scheduled","sending","delivered","failed","canceled","unknown"],"x-enumDescriptions":{"waiting":"The subscription's network condition has not been met yet.","scheduled":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Queued for the first attempt or waiting for a retry; attempt_count tells the two apart."},"children":[]}]}]}],"sending":"An attempt is authorized, which is not proof the receiver has the bytes.","delivered":"A valid acknowledgment was durably recorded.","failed":"Automatic delivery ended without success under the failure policy.","canceled":"A configuration or lifecycle change ended delivery.","unknown":"Delivery ended with an uncertain external outcome, most often a lost Telegram response."},"example":"delivered"}},"components/schemas/NotificationReason":{"id":"components/schemas/NotificationReason","kind":"json-schema","title":"NotificationReason","data":{"type":"string","description":"Closed decision code explaining how a notification reached its current status. It is separate\nfrom the channel's disable reason and from the error of any single attempt. Notifications that\nare waiting, scheduled, sending or delivered normally carry no reason.\n","enum":["attempts_exhausted","limit_reduced","channel_error","message_error","attempt_failed","unknown_result","channel_disabled","channel_deleted","subscription_disabled","subscription_deleted","destination_changed","address_removed","source_changed","test_expired"],"x-enumDescriptions":{"attempts_exhausted":"Automatic failures consumed the attempt budget.","limit_reduced":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Lowering max_attempts left no permitted automatic attempt."},"children":[]}]}]}],"channel_error":"A confirmed unusable destination or configuration stopped this notification.","message_error":"A permanent rejection or rendering problem limited to this content.","attempt_failed":"A test's only attempt failed, with no retry policy to exhaust.","unknown_result":"Delivery stopped with an uncertain outcome.","channel_disabled":"Disabling the channel canceled the work.","channel_deleted":"Deleting the channel canceled the work, including unstarted tests.","subscription_disabled":"Disabling the subscription canceled the work.","subscription_deleted":"Deleting the subscription canceled the work.","destination_changed":"A recipient, header or token edit canceled already started delivery.","address_removed":"No qualifying address was still owned by the project before the first attempt.","source_changed":"A selected, unattempted Bitcoin mempool appearance ended.","test_expired":"A test did not authorize its first attempt within five minutes."},"example":"attempts_exhausted"}},"components/schemas/NotificationCounter":{"id":"components/schemas/NotificationCounter","kind":"json-schema","title":"NotificationCounter","data":{"type":"integer","description":"Count of authorized attempts. Authorization is not proof of remote receipt.","minimum":0,"maximum":2147483647,"example":2}},"components/schemas/NotificationResendStatus":{"id":"components/schemas/NotificationResendStatus","kind":"json-schema","title":"NotificationResendStatus","data":{"type":"string","description":"Progress of a manual resend. It is separate from the notification's own delivery status.\n","enum":["queued","sending"],"x-enumDescriptions":{"queued":"A manual delivery attempt is accepted and queued.","sending":"A manual attempt is in flight."},"example":"queued"}},"components/schemas/NotificationAttemptStatus":{"id":"components/schemas/NotificationAttemptStatus","kind":"json-schema","title":"NotificationAttemptStatus","data":{"type":"string","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Evidence one attempt produced. "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"failed"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" means a proven pre-send failure or an explicit"},"children":[]},{"$$mdtype":"Node","type":"softbreak","inline":true,"attributes":{},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"rejection; "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"unknown"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" is neither, most often a lost response."},"children":[]}]}]}],"enum":["sending","succeeded","failed","unknown"],"x-enumDescriptions":{"sending":"Authorized and not yet completed.","succeeded":"A valid acknowledgment was recorded.","failed":"The attempt definitively did not deliver.","unknown":"The outcome could not be established."},"example":"failed"}},"components/schemas/NotificationEventName":{"id":"components/schemas/NotificationEventName","kind":"json-schema","title":"NotificationEventName","data":{"type":"string","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Logical event name frozen alongside the content and kept after the body is cleaned up. The two"},"children":[]},{"$$mdtype":"Node","type":"softbreak","inline":true,"attributes":{},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"legacy names belong to the v1 webhook body; the v2 body always carries "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"transaction.notification"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"."},"children":[]}]}]}],"enum":["transaction.detected","transaction.confirmed","transaction.notification"],"x-enumDescriptions":{"transaction.detected":"A tracked address appeared in a new transaction (v1 body).","transaction.confirmed":"A detected transaction reached the required confirmations (v1 body).","transaction.notification":"The single v2 transaction event."},"example":"transaction.notification"}},"components/schemas/NotificationSummary":{"id":"components/schemas/NotificationSummary","kind":"json-schema","title":"NotificationSummary","data":{"type":"object","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"One notification in a history list, without its frozen content."},"children":[]}]}]},{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"A test notification ("},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"is_test"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" true) carries no "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"subscription_id"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":", no "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"chain_gid"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" and no"},"children":[]},{"$$mdtype":"Node","type":"softbreak","inline":true,"attributes":{},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"txid"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":": its synthetic transaction exists only inside the payload. A test also makes at most one"},"children":[]},{"$$mdtype":"Node","type":"softbreak","inline":true,"attributes":{},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"attempt, so its "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"manual_attempt_count"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" and "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"automatic_attempt_count"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" are 0, its "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"attempt_count"},"children":[]},{"$$mdtype":"Node","type":"softbreak","inline":true,"attributes":{},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"is at most 1, and its "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"resend_status"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" and "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"next_attempt_at"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" are null. An ordinary notification"},"children":[]},{"$$mdtype":"Node","type":"softbreak","inline":true,"attributes":{},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"always carries "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"subscription_id"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":", "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"chain_gid"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" and "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"txid"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"."},"children":[]}]}]},{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"last_attempt_at"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" and "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"last_attempt_status"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" are read from the same attempt and are null"},"children":[]},{"$$mdtype":"Node","type":"softbreak","inline":true,"attributes":{},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"together, before anything has been attempted."},"children":[]}]}]},{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"payload_version"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" and "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"event_name"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" are frozen with the content and survive its cleanup."},"children":[]},{"$$mdtype":"Node","type":"softbreak","inline":true,"attributes":{},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Version "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"v1"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" goes with "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"transaction.detected"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" or "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"transaction.confirmed"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":", version "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"v2"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" with"},"children":[]},{"$$mdtype":"Node","type":"softbreak","inline":true,"attributes":{},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"transaction.notification"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":", and a null version means Telegram content. A null "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"event_name"},"children":[]},{"$$mdtype":"Node","type":"softbreak","inline":true,"attributes":{},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"means nothing has been frozen yet, so "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"payload_version"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" is null as well."},"children":[]}]}]}],"properties":{"id":{"$ref":"#/components/schemas/UUID","description":"Identity of the notification, stable across retries and equal to the webhook event id."},"channel_id":{"$ref":"#/components/schemas/UUID","description":"Channel selected for delivery. Its identifier stays readable after the channel is deleted."},"subscription_id":{"description":"Subscription that selected the transaction, or null for a channel test.","oneOf":[{"$ref":"#/components/schemas/UUID"},{"type":"null"}]},"is_test":{"type":"boolean","description":"Whether this is a channel diagnostic rather than a real transaction notification."},"chain_gid":{"$ref":"#/components/schemas/ChainGID","description":"Network of the transaction. Absent on tests."},"txid":{"$ref":"#/components/schemas/Txid","description":"Transaction the notification is about. Absent on tests."},"status":{"$ref":"#/components/schemas/NotificationStatus"},"reason":{"description":"Why the notification reached its status, or null while there is nothing to explain.","oneOf":[{"$ref":"#/components/schemas/NotificationReason"},{"type":"null"}]},"attempt_count":{"$ref":"#/components/schemas/NotificationCounter","description":"Authorized attempts of every kind."},"manual_attempt_count":{"$ref":"#/components/schemas/NotificationCounter","description":"Authorized manual attempts, failed and uncertain ones included."},"automatic_attempt_count":{"type":"integer","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Authorized automatic attempts, which is attempt_count minus manual_attempt_count."},"children":[]}]}]}],"minimum":0,"maximum":10},"resend_status":{"description":"Progress of a manual resend, or null when none is running.","oneOf":[{"$ref":"#/components/schemas/NotificationResendStatus"},{"type":"null"}]},"last_attempt_at":{"description":"When the most recent attempt was authorized, or null before any attempt.","oneOf":[{"$ref":"#/components/schemas/Timestamp"},{"type":"null"}]},"last_attempt_status":{"description":"Status of that same most recent attempt, or null before any attempt.","oneOf":[{"$ref":"#/components/schemas/NotificationAttemptStatus"},{"type":"null"}]},"next_attempt_at":{"description":"When the next automatic attempt is due, or null without automatic eligibility.","oneOf":[{"$ref":"#/components/schemas/Timestamp"},{"type":"null"}]},"created_at":{"$ref":"#/components/schemas/Timestamp","description":"When the notification was created."},"updated_at":{"$ref":"#/components/schemas/Timestamp","description":"When the notification last changed."},"payload_version":{"description":"Webhook body version actually frozen, or null before preparation and for Telegram. It is\nnever substituted from the channel's live configuration.\n","oneOf":[{"$ref":"#/components/schemas/WebhookPayloadVersion"},{"type":"null"}]},"event_name":{"description":"Logical event name frozen with the content, or null before preparation.","oneOf":[{"$ref":"#/components/schemas/NotificationEventName"},{"type":"null"}]}},"required":["id","channel_id","subscription_id","is_test","status","reason","attempt_count","manual_attempt_count","automatic_attempt_count","resend_status","last_attempt_at","last_attempt_status","next_attempt_at","created_at","updated_at","payload_version","event_name"],"example":{"id":"550e8400-e29b-41d4-a716-446655440020","channel_id":"550e8400-e29b-41d4-a716-446655440001","subscription_id":"550e8400-e29b-41d4-a716-446655440002","is_test":false,"chain_gid":"eip155:1","txid":"0x1234567890abcdef1234567890abcdef1234567890abcdef1234567890abcdef","status":"delivered","reason":null,"attempt_count":2,"manual_attempt_count":0,"automatic_attempt_count":2,"resend_status":null,"last_attempt_at":"2024-01-15T10:31:05Z","last_attempt_status":"succeeded","next_attempt_at":null,"created_at":"2024-01-15T10:30:00Z","updated_at":"2024-01-15T10:31:05Z","payload_version":"v2","event_name":"transaction.notification"}}},"components/schemas/WebhookV1UUID":{"id":"components/schemas/WebhookV1UUID","kind":"json-schema","title":"WebhookV1UUID","data":{"type":"string","format":"uuid","description":"Identifier in the v1 webhook body.","example":"550e8400-e29b-41d4-a716-446655440020"}},"components/schemas/WebhookV1ChainGID":{"id":"components/schemas/WebhookV1ChainGID","kind":"json-schema","title":"WebhookV1ChainGID","data":{"type":"string","description":"Blockchain identifier in the v1 webhook body. The bounds are frozen with that body and are\nnarrower than the CAIP-2 identifier the rest of the API returns.\n","pattern":"^[a-z0-9]{3,8}:[-_a-zA-Z0-9]{1,32}$","example":"eip155:1"}},"components/schemas/WebhookV1TransactionHash":{"id":"components/schemas/WebhookV1TransactionHash","kind":"json-schema","title":"WebhookV1TransactionHash","data":{"type":"string","description":"Transaction hash in the v1 webhook body, with no length bound.","example":"0x1234567890abcdef1234567890abcdef1234567890abcdef1234567890abcdef"}},"components/schemas/WebhookV1BlockNumber":{"id":"components/schemas/WebhookV1BlockNumber","kind":"json-schema","title":"WebhookV1BlockNumber","data":{"type":"integer","format":"uint64","description":"Block height in the v1 webhook body.","minimum":0,"example":18500000}},"components/schemas/WebhookV1CreatedAt":{"id":"components/schemas/WebhookV1CreatedAt","kind":"json-schema","title":"WebhookV1CreatedAt","data":{"type":"string","format":"date-time","description":"Timestamp in the v1 webhook body.","example":"2024-01-15T10:30:00Z"}},"components/schemas/WebhookV1TransactionSummary":{"id":"components/schemas/WebhookV1TransactionSummary","kind":"json-schema","title":"WebhookV1TransactionSummary","data":{"type":"object","description":"Transaction header in the v1 webhook body.","properties":{"chain_gid":{"$ref":"#/components/schemas/WebhookV1ChainGID"},"hash":{"$ref":"#/components/schemas/WebhookV1TransactionHash"},"block_number":{"$ref":"#/components/schemas/WebhookV1BlockNumber"},"is_success":{"type":"boolean","description":"Whether the transaction executed successfully."},"confirmed_at":{"description":"Time the transaction reached the required confirmations, or null while it has not.","oneOf":[{"type":"string","format":"date-time"},{"type":"null"}]},"created_at":{"$ref":"#/components/schemas/WebhookV1CreatedAt"}},"required":["chain_gid","hash","block_number","is_success","confirmed_at","created_at"],"example":{"chain_gid":"eip155:1","hash":"0x1234567890abcdef1234567890abcdef1234567890abcdef1234567890abcdef","block_number":18500000,"is_success":true,"confirmed_at":"2024-01-15T10:33:00Z","created_at":"2024-01-15T10:30:00Z"}}},"components/schemas/WebhookV1EventKind":{"id":"components/schemas/WebhookV1EventKind","kind":"json-schema","title":"WebhookV1EventKind","data":{"type":"string","description":"Kind of decoded event in the v1 webhook body.","enum":["transfer","utxo_transfer","fee","approval","call","contract_create"],"example":"transfer"}},"components/schemas/WebhookV1AssetGID":{"id":"components/schemas/WebhookV1AssetGID","kind":"json-schema","title":"WebhookV1AssetGID","data":{"type":"string","description":"Global asset identifier in the v1 webhook body. The bounds are frozen with that body and are\nnarrower than the CAIP-19 identifier the rest of the API returns.\n","pattern":"^[-a-zA-Z0-9]{1,32}:[-a-zA-Z0-9]{1,64}/[-a-zA-Z0-9]{1,64}:[-a-zA-Z0-9]{1,128}$","example":"eip155:1/erc20:0xdAC17F958D2ee523a2206206994597C13D831ec7"}},"components/schemas/WebhookV1AddressValue":{"id":"components/schemas/WebhookV1AddressValue","kind":"json-schema","title":"WebhookV1AddressValue","data":{"type":"string","description":"Blockchain address in its native format, in the v1 webhook body.","minLength":1,"maxLength":128,"pattern":"^[a-zA-Z0-9]+$","example":"0x742d35cc6634c0532925a3b8d1e1d78d8E15e5c4"}},"components/schemas/WebhookV1AmountInBaseUnits":{"id":"components/schemas/WebhookV1AmountInBaseUnits","kind":"json-schema","title":"WebhookV1AmountInBaseUnits","data":{"type":"string","description":"Amount in the smallest asset unit in the v1 webhook body.","pattern":"^[0-9]+$","example":"1000000"}},"components/schemas/WebhookV1AmountFormatted":{"id":"components/schemas/WebhookV1AmountFormatted","kind":"json-schema","title":"WebhookV1AmountFormatted","data":{"type":"string","description":"Human-readable amount in the v1 webhook body, with no pattern.","example":"1.0"}},"components/schemas/WebhookV1Amount":{"id":"components/schemas/WebhookV1Amount","kind":"json-schema","title":"WebhookV1Amount","data":{"type":"object","description":"Asset amount in the v1 webhook body, in base units plus a human-readable form.","properties":{"base":{"$ref":"#/components/schemas/WebhookV1AmountInBaseUnits"},"formatted":{"$ref":"#/components/schemas/WebhookV1AmountFormatted"}},"required":["base"],"example":{"base":"1000000","formatted":"1.0"}}},"components/schemas/WebhookV1TransferDataSource":{"id":"components/schemas/WebhookV1TransferDataSource","kind":"json-schema","title":"WebhookV1TransferDataSource","data":{"type":"string","description":"Where the v1 webhook body saw the transfer.","enum":["native","contract","internal"],"x-enumDescriptions":{"native":"The chain's own value transfer.","contract":"A token contract transfer.","internal":"A transfer made by an internal call."},"example":"contract"}},"components/schemas/WebhookV1TransferEventData":{"id":"components/schemas/WebhookV1TransferEventData","kind":"json-schema","title":"WebhookV1TransferEventData","data":{"type":"object","description":"Account-model asset transfer in the v1 webhook body.","properties":{"kind":{"type":"string","enum":["transfer"],"description":"Event kind discriminator."},"asset_gid":{"$ref":"#/components/schemas/WebhookV1AssetGID"},"from":{"$ref":"#/components/schemas/WebhookV1AddressValue"},"to":{"$ref":"#/components/schemas/WebhookV1AddressValue"},"amount":{"$ref":"#/components/schemas/WebhookV1Amount"},"token_id":{"type":"string","description":"Token id of the moved item, for non-fungible assets."},"source":{"$ref":"#/components/schemas/WebhookV1TransferDataSource"}},"required":["kind","asset_gid","from","to","amount","source"],"example":{"kind":"transfer","asset_gid":"eip155:1/erc20:0xdAC17F958D2ee523a2206206994597C13D831ec7","from":"0x742d35cc6634c0532925a3b8d1e1d78d8E15e5c4","to":"0x8521E8b15eCEF4D4269Fded3E6694225E096959E","amount":{"base":"1000000","formatted":"1.0"},"source":"contract"}}},"components/schemas/WebhookV1UTXOEntry":{"id":"components/schemas/WebhookV1UTXOEntry","kind":"json-schema","title":"WebhookV1UTXOEntry","data":{"type":"object","description":"One input or output of a UTXO transfer in the v1 webhook body.","properties":{"address":{"$ref":"#/components/schemas/WebhookV1AddressValue"},"amount":{"$ref":"#/components/schemas/WebhookV1Amount"},"index":{"type":"integer","minimum":0,"description":"Position of the entry in the transaction."}},"required":["address","amount","index"],"example":{"address":"bc1qar0srrr7xfkvy5l643lydnw9re59gtzzwf5mdq","amount":{"base":"150000","formatted":"0.0015"},"index":0}}},"components/schemas/WebhookV1UTXOTransferEventData":{"id":"components/schemas/WebhookV1UTXOTransferEventData","kind":"json-schema","title":"WebhookV1UTXOTransferEventData","data":{"type":"object","description":"UTXO-model transfer in the v1 webhook body.","properties":{"kind":{"type":"string","enum":["utxo_transfer"],"description":"Event kind discriminator."},"asset_gid":{"$ref":"#/components/schemas/WebhookV1AssetGID"},"inputs":{"type":"array","description":"Spent outputs.","items":{"$ref":"#/components/schemas/WebhookV1UTXOEntry"}},"outputs":{"type":"array","description":"Created outputs.","items":{"$ref":"#/components/schemas/WebhookV1UTXOEntry"}},"fee":{"$ref":"#/components/schemas/WebhookV1Amount"}},"required":["kind","asset_gid","inputs","outputs","fee"],"example":{"kind":"utxo_transfer","asset_gid":"bip122:000000000019d6689c085ae165831e93/slip44:0","inputs":[{"address":"bc1qar0srrr7xfkvy5l643lydnw9re59gtzzwf5mdq","amount":{"base":"150000","formatted":"0.0015"},"index":0}],"outputs":[{"address":"bc1qw508d6qejxtdg4y5r3zarvary0c5xw7kv8f3t4","amount":{"base":"140000","formatted":"0.0014"},"index":0}],"fee":{"base":"10000","formatted":"0.0001"}}}},"components/schemas/WebhookV1FeeEventData":{"id":"components/schemas/WebhookV1FeeEventData","kind":"json-schema","title":"WebhookV1FeeEventData","data":{"type":"object","description":"Fee paid by the transaction, in the v1 webhook body.","properties":{"kind":{"type":"string","enum":["fee"],"description":"Event kind discriminator."},"asset_gid":{"$ref":"#/components/schemas/WebhookV1AssetGID"},"payer":{"$ref":"#/components/schemas/WebhookV1AddressValue"},"amount":{"$ref":"#/components/schemas/WebhookV1Amount"}},"required":["kind","asset_gid","payer","amount"],"example":{"kind":"fee","asset_gid":"eip155:1/slip44:60","payer":"0x742d35cc6634c0532925a3b8d1e1d78d8E15e5c4","amount":{"base":"21000000000000000","formatted":"0.021"}}}},"components/schemas/WebhookV1ApprovalEventData":{"id":"components/schemas/WebhookV1ApprovalEventData","kind":"json-schema","title":"WebhookV1ApprovalEventData","data":{"type":"object","description":"Spending allowance change in the v1 webhook body.","properties":{"kind":{"type":"string","enum":["approval"],"description":"Event kind discriminator."},"asset_gid":{"$ref":"#/components/schemas/WebhookV1AssetGID"},"owner":{"$ref":"#/components/schemas/WebhookV1AddressValue"},"spender":{"$ref":"#/components/schemas/WebhookV1AddressValue"},"amount":{"$ref":"#/components/schemas/WebhookV1Amount"},"token_id":{"type":"string","description":"Token id the allowance covers, for non-fungible assets."}},"required":["kind","asset_gid","owner","spender","amount"],"example":{"kind":"approval","asset_gid":"eip155:1/erc20:0xdAC17F958D2ee523a2206206994597C13D831ec7","owner":"0x742d35cc6634c0532925a3b8d1e1d78d8E15e5c4","spender":"0x8521E8b15eCEF4D4269Fded3E6694225E096959E","amount":{"base":"1000000","formatted":"1.0"}}}},"components/schemas/WebhookV1CallEventData":{"id":"components/schemas/WebhookV1CallEventData","kind":"json-schema","title":"WebhookV1CallEventData","data":{"type":"object","description":"Contract call in the v1 webhook body.","properties":{"kind":{"type":"string","enum":["call"],"description":"Event kind discriminator."},"caller":{"$ref":"#/components/schemas/WebhookV1AddressValue"},"target":{"$ref":"#/components/schemas/WebhookV1AddressValue"}},"required":["kind","caller","target"],"example":{"kind":"call","caller":"0x742d35cc6634c0532925a3b8d1e1d78d8E15e5c4","target":"0xdAC17F958D2ee523a2206206994597C13D831ec7"}}},"components/schemas/WebhookV1ContractCreateEventData":{"id":"components/schemas/WebhookV1ContractCreateEventData","kind":"json-schema","title":"WebhookV1ContractCreateEventData","data":{"type":"object","description":"Contract deployment in the v1 webhook body.","properties":{"kind":{"type":"string","enum":["contract_create"],"description":"Event kind discriminator."},"creator":{"$ref":"#/components/schemas/WebhookV1AddressValue"},"created_address":{"$ref":"#/components/schemas/WebhookV1AddressValue"}},"required":["kind","creator","created_address"],"example":{"kind":"contract_create","creator":"0x742d35cc6634c0532925a3b8d1e1d78d8E15e5c4","created_address":"0x8521E8b15eCEF4D4269Fded3E6694225E096959E"}}},"components/schemas/WebhookV1Event":{"id":"components/schemas/WebhookV1Event","kind":"json-schema","title":"WebhookV1Event","data":{"type":"object","description":"One decoded event of the transaction carried by the v1 webhook body.","properties":{"hash":{"$ref":"#/components/schemas/WebhookV1TransactionHash"},"sequence":{"type":"integer","minimum":0,"description":"Position of the event within the transaction."},"kind":{"$ref":"#/components/schemas/WebhookV1EventKind"},"data":{"description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Event body, selected by "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"kind"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"."},"children":[]}]}]}],"oneOf":[{"$ref":"#/components/schemas/WebhookV1TransferEventData"},{"$ref":"#/components/schemas/WebhookV1UTXOTransferEventData"},{"$ref":"#/components/schemas/WebhookV1FeeEventData"},{"$ref":"#/components/schemas/WebhookV1ApprovalEventData"},{"$ref":"#/components/schemas/WebhookV1CallEventData"},{"$ref":"#/components/schemas/WebhookV1ContractCreateEventData"}],"discriminator":{"propertyName":"kind","mapping":{"transfer":"#/components/schemas/WebhookV1TransferEventData","utxo_transfer":"#/components/schemas/WebhookV1UTXOTransferEventData","fee":"#/components/schemas/WebhookV1FeeEventData","approval":"#/components/schemas/WebhookV1ApprovalEventData","call":"#/components/schemas/WebhookV1CallEventData","contract_create":"#/components/schemas/WebhookV1ContractCreateEventData"}}}},"required":["hash","sequence","kind","data"],"example":{"hash":"0x1234567890abcdef1234567890abcdef1234567890abcdef1234567890abcdef","sequence":0,"kind":"transfer","data":{"kind":"transfer","asset_gid":"eip155:1/erc20:0xdAC17F958D2ee523a2206206994597C13D831ec7","from":"0x742d35cc6634c0532925a3b8d1e1d78d8E15e5c4","to":"0x8521E8b15eCEF4D4269Fded3E6694225E096959E","amount":{"base":"1000000","formatted":"1.0"},"source":"contract"}}}},"components/schemas/WebhookV1ActivityDirection":{"id":"components/schemas/WebhookV1ActivityDirection","kind":"json-schema","title":"WebhookV1ActivityDirection","data":{"type":"string","description":"Direction of the balance change relative to the tracked address, in the v1 webhook body.","enum":["in","out"],"x-enumDescriptions":{"in":"Balance increased.","out":"Balance decreased."},"example":"out"}},"components/schemas/WebhookV1DeltaInBaseUnits":{"id":"components/schemas/WebhookV1DeltaInBaseUnits","kind":"json-schema","title":"WebhookV1DeltaInBaseUnits","data":{"type":"string","description":"Signed balance change in the smallest asset unit in the v1 webhook body.","pattern":"^-?[0-9]+$","example":"-1000000"}},"components/schemas/WebhookV1DeltaFormatted":{"id":"components/schemas/WebhookV1DeltaFormatted","kind":"json-schema","title":"WebhookV1DeltaFormatted","data":{"type":"string","description":"Human-readable signed balance change in the v1 webhook body, with no pattern.","example":"-1.0"}},"components/schemas/WebhookV1Delta":{"id":"components/schemas/WebhookV1Delta","kind":"json-schema","title":"WebhookV1Delta","data":{"type":"object","description":"Signed balance change in the v1 webhook body.","properties":{"base":{"$ref":"#/components/schemas/WebhookV1DeltaInBaseUnits"},"formatted":{"$ref":"#/components/schemas/WebhookV1DeltaFormatted"}},"required":["base"],"example":{"base":"-1000000","formatted":"-1.0"}}},"components/schemas/WebhookV1ActivityItem":{"id":"components/schemas/WebhookV1ActivityItem","kind":"json-schema","title":"WebhookV1ActivityItem","data":{"type":"object","description":"Balance change of one tracked address, in the v1 webhook body.","properties":{"chain_gid":{"$ref":"#/components/schemas/WebhookV1ChainGID"},"hash":{"$ref":"#/components/schemas/WebhookV1TransactionHash"},"address":{"$ref":"#/components/schemas/WebhookV1AddressValue"},"asset_gid":{"$ref":"#/components/schemas/WebhookV1AssetGID"},"direction":{"$ref":"#/components/schemas/WebhookV1ActivityDirection"},"delta":{"$ref":"#/components/schemas/WebhookV1Delta"},"created_at":{"$ref":"#/components/schemas/WebhookV1CreatedAt"}},"required":["chain_gid","hash","address","asset_gid","direction","delta","created_at"],"example":{"chain_gid":"eip155:1","hash":"0x1234567890abcdef1234567890abcdef1234567890abcdef1234567890abcdef","address":"0x742d35cc6634c0532925a3b8d1e1d78d8E15e5c4","asset_gid":"eip155:1/erc20:0xdAC17F958D2ee523a2206206994597C13D831ec7","direction":"out","delta":{"base":"-1000000","formatted":"-1.0"},"created_at":"2024-01-15T10:30:00Z"}}},"components/schemas/WebhookV1Transaction":{"id":"components/schemas/WebhookV1Transaction","kind":"json-schema","title":"WebhookV1Transaction","data":{"type":"object","description":"Transaction carried by the v1 webhook body, with its decoded events and activity.","allOf":[{"$ref":"#/components/schemas/WebhookV1TransactionSummary"},{"type":"object","properties":{"events":{"type":"array","description":"Decoded events of the transaction.","items":{"$ref":"#/components/schemas/WebhookV1Event"}},"activity":{"type":"array","description":"Balance changes of tracked addresses.","items":{"$ref":"#/components/schemas/WebhookV1ActivityItem"}}},"required":["events","activity"]}]}},"components/schemas/WebhookV1TokenDecimals":{"id":"components/schemas/WebhookV1TokenDecimals","kind":"json-schema","title":"WebhookV1TokenDecimals","data":{"type":"integer","description":"Number of decimal places for the token in the v1 webhook body.","minimum":0,"maximum":64,"example":6}},"components/schemas/WebhookV1TokenName":{"id":"components/schemas/WebhookV1TokenName","kind":"json-schema","title":"WebhookV1TokenName","data":{"type":"string","description":"Full token name in the v1 webhook body.","minLength":1,"maxLength":64,"example":"Tether USD"}},"components/schemas/WebhookV1TokenSymbol":{"id":"components/schemas/WebhookV1TokenSymbol","kind":"json-schema","title":"WebhookV1TokenSymbol","data":{"type":"string","description":"Token symbol in the v1 webhook body.","minLength":1,"maxLength":32,"example":"USDT"}},"components/schemas/WebhookV1Token":{"id":"components/schemas/WebhookV1Token","kind":"json-schema","title":"WebhookV1Token","data":{"type":"object","description":"Token metadata in the v1 webhook body.","properties":{"gid":{"$ref":"#/components/schemas/WebhookV1AssetGID"},"decimals":{"$ref":"#/components/schemas/WebhookV1TokenDecimals"},"name":{"$ref":"#/components/schemas/WebhookV1TokenName"},"symbol":{"$ref":"#/components/schemas/WebhookV1TokenSymbol"}},"required":["gid","decimals","name","symbol"],"example":{"gid":"eip155:1/erc20:0xdAC17F958D2ee523a2206206994597C13D831ec7","decimals":6,"name":"Tether USD","symbol":"USDT"}}},"components/schemas/WebhookV1MinConfirmations":{"id":"components/schemas/WebhookV1MinConfirmations","kind":"json-schema","title":"WebhookV1MinConfirmations","data":{"type":"integer","format":"uint8","description":"Confirmations the v1 webhook body considers a transaction final at.","minimum":1,"maximum":100,"example":12}},"components/schemas/WebhookV1Blockchain":{"id":"components/schemas/WebhookV1Blockchain","kind":"json-schema","title":"WebhookV1Blockchain","data":{"type":"object","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Blockchain metadata in the v1 webhook body, including min_confirmations."},"children":[]}]}]}],"properties":{"gid":{"$ref":"#/components/schemas/WebhookV1ChainGID"},"image_url":{"type":"string","format":"uri","description":"Blockchain logo URL."},"name":{"type":"string","minLength":1,"maxLength":32,"description":"Blockchain name identifier."},"short_name":{"type":"string","minLength":1,"maxLength":32,"description":"Short blockchain identifier."},"min_confirmations":{"$ref":"#/components/schemas/WebhookV1MinConfirmations"}},"required":["gid","name","short_name","image_url","min_confirmations"],"example":{"gid":"eip155:1","name":"ethereum","short_name":"eth","image_url":"https://raw.githubusercontent.com/vilna-io/icons/refs/heads/main/chains/ethereum.svg","min_confirmations":12}}},"components/schemas/WebhookV1AddressLabel":{"id":"components/schemas/WebhookV1AddressLabel","kind":"json-schema","title":"WebhookV1AddressLabel","data":{"type":"string","description":"Label the project gave a tracked address, in the v1 webhook body.","maxLength":32,"example":"Hot wallet"}},"components/schemas/WebhookV1TransactionReferences":{"id":"components/schemas/WebhookV1TransactionReferences","kind":"json-schema","title":"WebhookV1TransactionReferences","data":{"type":"object","description":"Objects the v1 webhook body's transaction refers to, keyed by identifier.","properties":{"tokens":{"type":"object","description":"Tokens indexed by asset identifier.","propertyNames":{"$ref":"#/components/schemas/WebhookV1AssetGID"},"additionalProperties":{"$ref":"#/components/schemas/WebhookV1Token"}},"blockchains":{"type":"object","description":"Blockchains indexed by chain identifier.","propertyNames":{"$ref":"#/components/schemas/WebhookV1ChainGID"},"additionalProperties":{"$ref":"#/components/schemas/WebhookV1Blockchain"}},"addresses":{"type":"object","description":"Tracked addresses mapped to their label, which is null when the project gave none.","propertyNames":{"$ref":"#/components/schemas/WebhookV1AddressValue"},"additionalProperties":{"oneOf":[{"$ref":"#/components/schemas/WebhookV1AddressLabel"},{"type":"null"}]}}},"example":{"tokens":{"eip155:1/erc20:0xdAC17F958D2ee523a2206206994597C13D831ec7":{"gid":"eip155:1/erc20:0xdAC17F958D2ee523a2206206994597C13D831ec7","decimals":6,"name":"Tether USD","symbol":"USDT"}},"blockchains":{"eip155:1":{"gid":"eip155:1","name":"ethereum","short_name":"eth","image_url":"https://raw.githubusercontent.com/vilna-io/icons/refs/heads/main/chains/ethereum.svg","min_confirmations":12}},"addresses":{"0x742d35cc6634c0532925a3b8d1e1d78d8E15e5c4":"Hot wallet"}}}},"components/schemas/WebhookV1Payload":{"id":"components/schemas/WebhookV1Payload","kind":"json-schema","title":"V1 webhook payload","data":{"title":"V1 webhook payload","type":"object","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Webhook payload for channels with "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"payload_version"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" set to "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"v1"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":". Retries send the original"},"children":[]},{"$$mdtype":"Node","type":"softbreak","inline":true,"attributes":{},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"payload unchanged, even if the transaction has changed since the first delivery."},"children":[]}]}]}],"properties":{"event_id":{"$ref":"#/components/schemas/WebhookV1UUID","description":"Identity of the notification this body belongs to, equal to the notification id."},"item":{"$ref":"#/components/schemas/WebhookV1Transaction"},"references":{"$ref":"#/components/schemas/WebhookV1TransactionReferences"},"is_test_message":{"type":"boolean","description":"Whether the body was produced by a channel test rather than by a real transaction."}},"required":["event_id","item","references","is_test_message"],"example":{"event_id":"550e8400-e29b-41d4-a716-446655440020","item":{"chain_gid":"eip155:1","hash":"0x1234567890abcdef1234567890abcdef1234567890abcdef1234567890abcdef","block_number":18500000,"is_success":true,"confirmed_at":"2024-01-15T10:33:00Z","created_at":"2024-01-15T10:30:00Z","events":[{"hash":"0x1234567890abcdef1234567890abcdef1234567890abcdef1234567890abcdef","sequence":0,"kind":"transfer","data":{"kind":"transfer","asset_gid":"eip155:1/erc20:0xdAC17F958D2ee523a2206206994597C13D831ec7","from":"0x742d35cc6634c0532925a3b8d1e1d78d8E15e5c4","to":"0x8521E8b15eCEF4D4269Fded3E6694225E096959E","amount":{"base":"1000000","formatted":"1.0"},"source":"contract"}}],"activity":[{"chain_gid":"eip155:1","hash":"0x1234567890abcdef1234567890abcdef1234567890abcdef1234567890abcdef","address":"0x742d35cc6634c0532925a3b8d1e1d78d8E15e5c4","asset_gid":"eip155:1/erc20:0xdAC17F958D2ee523a2206206994597C13D831ec7","direction":"out","delta":{"base":"-1000000","formatted":"-1.0"},"created_at":"2024-01-15T10:30:00Z"}]},"references":{"tokens":{"eip155:1/erc20:0xdAC17F958D2ee523a2206206994597C13D831ec7":{"gid":"eip155:1/erc20:0xdAC17F958D2ee523a2206206994597C13D831ec7","decimals":6,"name":"Tether USD","symbol":"USDT"}},"blockchains":{"eip155:1":{"gid":"eip155:1","name":"ethereum","short_name":"eth","image_url":"https://raw.githubusercontent.com/vilna-io/icons/refs/heads/main/chains/ethereum.svg","min_confirmations":12}},"addresses":{"0x742d35cc6634c0532925a3b8d1e1d78d8E15e5c4":"Hot wallet"}},"is_test_message":false}}},"components/schemas/WebhookV1NotificationPayload":{"id":"components/schemas/WebhookV1NotificationPayload","kind":"json-schema","title":"WebhookV1NotificationPayload","data":{"type":"object","description":"Frozen v1 webhook body, wrapped with the kind the API assigns.","properties":{"kind":{"type":"string","enum":["webhook_v1"],"description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Payload kind, the discriminator of "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"NotificationPayload"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"."},"children":[]}]}]}]},"body":{"$ref":"#/components/schemas/WebhookV1Payload"}},"required":["kind","body"]}},"components/schemas/WebhookV2Payload":{"id":"components/schemas/WebhookV2Payload","kind":"json-schema","title":"Vilna transaction notification webhook","data":{"title":"Vilna transaction notification webhook","type":"object","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"The v2 webhook body, sent by channels whose "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"payload_version"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" is "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"v2"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":". It carries the same"},"children":[]},{"$$mdtype":"Node","type":"softbreak","inline":true,"attributes":{},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"public transaction and reference objects as "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"GET /transactions/{chain_gid}/{txid}"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":". Test and"},"children":[]},{"$$mdtype":"Node","type":"softbreak","inline":true,"attributes":{},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"real deliveries use the same envelope, and a retry resends the exact stored bytes."},"children":[]}]}]},{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"event_id"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" is the notification's own identity and is never the nil UUID. "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"subscription_id"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" is"},"children":[]},{"$$mdtype":"Node","type":"softbreak","inline":true,"attributes":{},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"null exactly when "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"is_test"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" is true, and is the subscription's identity otherwise."},"children":[]}]}]}],"properties":{"version":{"type":"string","enum":["v2"],"description":"Frozen webhook body version, covered by the raw-body signature. It is independent of the\nHTTP API version and of the transaction version.\n"},"event_id":{"$ref":"#/components/schemas/UUID","description":"Identity of the notification this body belongs to, equal to the notification id."},"subscription_id":{"description":"Subscription that selected the transaction, or null for a channel test.","oneOf":[{"$ref":"#/components/schemas/UUID"},{"type":"null"}]},"is_test":{"type":"boolean","description":"Whether the body was produced by a channel test rather than by a real transaction."},"item":{"$ref":"#/components/schemas/Transaction"},"references":{"$ref":"#/components/schemas/TransactionReferences"}},"required":["version","event_id","subscription_id","is_test","item","references"],"example":{"version":"v2","event_id":"550e8400-e29b-41d4-a716-446655440020","subscription_id":"550e8400-e29b-41d4-a716-446655440002","is_test":false,"item":{"chain_gid":"eip155:1","txid":"0x1234567890abcdef1234567890abcdef1234567890abcdef1234567890abcdef","created_at":"2024-01-15T10:30:00Z","activity":[{"chain_gid":"eip155:1","txid":"0x1234567890abcdef1234567890abcdef1234567890abcdef1234567890abcdef","address":"0x742d35cc6634c0532925a3b8d1e1d78d8E15e5c4","asset_gid":"eip155:1/erc20:0xdAC17F958D2ee523a2206206994597C13D831ec7","direction":"out","delta":{"base":"-1000000","formatted":"-1.0"},"created_at":"2024-01-15T10:30:00Z","entry_kind":"token_transfer"}],"details":{"family":"evm","events":[{"event_index":0,"kind":"transfer","asset_gid":"eip155:1/erc20:0xdAC17F958D2ee523a2206206994597C13D831ec7","amount":{"base":"1000000","formatted":"1.0"},"operation":"transfer","from_address":"0x742d35cc6634c0532925a3b8d1e1d78d8E15e5c4","to_address":"0x95212290dd7278aa3ddd389cc1e1d165cc4bafe5"}],"is_success":true,"fee":{"base":"21000000000000000","formatted":"0.021"},"block":{"block_hash":"0x9f1c2a3b4d5e6f708192a3b4c5d6e7f8091a2b3c4d5e6f708192a3b4c5d6e7f8","block_height":18500000},"transaction_index":42,"from_address":"0x742d35cc6634c0532925a3b8d1e1d78d8E15e5c4","to_address":"0xdAC17F958D2ee523a2206206994597C13D831ec7","gas_used":65000}},"references":{"tokens":{"eip155:1/erc20:0xdAC17F958D2ee523a2206206994597C13D831ec7":{"gid":"eip155:1/erc20:0xdAC17F958D2ee523a2206206994597C13D831ec7","symbol":"USDT","name":"Tether USD","decimals":6}},"blockchains":{"eip155:1":{"gid":"eip155:1","name":"ethereum","short_name":"eth","image_url":"https://raw.githubusercontent.com/vilna-io/icons/refs/heads/main/chains/ethereum.svg"}},"addresses":{"0x742d35cc6634c0532925a3b8d1e1d78d8E15e5c4":"Hot wallet"}}}}},"components/schemas/WebhookV2NotificationPayload":{"id":"components/schemas/WebhookV2NotificationPayload","kind":"json-schema","title":"WebhookV2NotificationPayload","data":{"type":"object","description":"Frozen v2 webhook body, wrapped with the kind the API assigns.","properties":{"kind":{"type":"string","enum":["webhook_v2"],"description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Payload kind, the discriminator of "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"NotificationPayload"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"."},"children":[]}]}]}]},"body":{"$ref":"#/components/schemas/WebhookV2Payload"}},"required":["kind","body"]}},"components/schemas/TelegramContent":{"id":"components/schemas/TelegramContent","kind":"json-schema","title":"TelegramContent","data":{"type":"object","description":"Frozen Telegram message text and formatting mode. No recipient, bot token,\nthread id or transport header is kept here. The text is untrusted display content and has to be\nescaped or safely rendered.\n","properties":{"text":{"type":"string","minLength":1,"description":"Rendered message text prepared for delivery."},"parse_mode":{"type":"string","enum":["HTML"],"description":"Telegram formatting mode of the text, always HTML."}},"required":["text","parse_mode"],"example":{"text":"<b>Transaction confirmed</b>\nUSDT 1.0 to 0x742d…e5c4","parse_mode":"HTML"}}},"components/schemas/TelegramNotificationPayload":{"id":"components/schemas/TelegramNotificationPayload","kind":"json-schema","title":"TelegramNotificationPayload","data":{"type":"object","description":"Frozen Telegram content, wrapped with the kind the API assigns.","properties":{"kind":{"type":"string","enum":["telegram"],"description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Payload kind, the discriminator of "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"NotificationPayload"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"."},"children":[]}]}]}]},"body":{"$ref":"#/components/schemas/TelegramContent"}},"required":["kind","body"]}},"components/schemas/NotificationPayload":{"id":"components/schemas/NotificationPayload","kind":"json-schema","title":"NotificationPayload","data":{"description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Prepared content retained for a notification. Ordinary notification content is frozen when"},"children":[]},{"$$mdtype":"Node","type":"softbreak","inline":true,"attributes":{},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"its first attempt is authorized; test content is frozen when the channel test is created."},"children":[]},{"$$mdtype":"Node","type":"softbreak","inline":true,"attributes":{},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"kind"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" identifies its shape. Webhook bodies retain the original payload; Telegram content retains the rendered text"},"children":[]},{"$$mdtype":"Node","type":"softbreak","inline":true,"attributes":{},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"and formatting mode. The content stays unchanged even if the transaction changes, but does not"},"children":[]},{"$$mdtype":"Node","type":"softbreak","inline":true,"attributes":{},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"prove delivery. Credentials and transport data are not included."},"children":[]}]}]}],"oneOf":[{"$ref":"#/components/schemas/WebhookV1NotificationPayload"},{"$ref":"#/components/schemas/WebhookV2NotificationPayload"},{"$ref":"#/components/schemas/TelegramNotificationPayload"}],"discriminator":{"propertyName":"kind","mapping":{"webhook_v1":"#/components/schemas/WebhookV1NotificationPayload","webhook_v2":"#/components/schemas/WebhookV2NotificationPayload","telegram":"#/components/schemas/TelegramNotificationPayload"}}}},"components/schemas/Notification":{"id":"components/schemas/Notification","kind":"json-schema","title":"Notification","data":{"type":"object","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"One notification with the content that was frozen for it."},"children":[]}]}]},{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"A test notification ("},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"is_test"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" true) carries no "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"subscription_id"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":", no "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"chain_gid"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" and no"},"children":[]},{"$$mdtype":"Node","type":"softbreak","inline":true,"attributes":{},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"txid"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":": its synthetic transaction exists only inside the payload. A test also makes at most"},"children":[]},{"$$mdtype":"Node","type":"softbreak","inline":true,"attributes":{},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"one attempt, so its "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"manual_attempt_count"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" and "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"automatic_attempt_count"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" are 0, its"},"children":[]},{"$$mdtype":"Node","type":"softbreak","inline":true,"attributes":{},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"attempt_count"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" is at most 1, and its "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"resend_status"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" and "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"next_attempt_at"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" are null. An"},"children":[]},{"$$mdtype":"Node","type":"softbreak","inline":true,"attributes":{},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"ordinary notification always carries "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"subscription_id"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":", "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"chain_gid"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" and "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"txid"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"."},"children":[]}]}]},{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"last_attempt_at"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" and "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"last_attempt_status"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" are read from the same attempt and are null"},"children":[]},{"$$mdtype":"Node","type":"softbreak","inline":true,"attributes":{},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"together, before anything has been attempted."},"children":[]}]}]},{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"payload_version"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" and "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"event_name"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" are frozen with the content and survive its cleanup."},"children":[]},{"$$mdtype":"Node","type":"softbreak","inline":true,"attributes":{},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Version "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"v1"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" goes with "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"transaction.detected"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" or "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"transaction.confirmed"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":", version "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"v2"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" with"},"children":[]},{"$$mdtype":"Node","type":"softbreak","inline":true,"attributes":{},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"transaction.notification"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":", and a null version means Telegram content. A null "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"event_name"},"children":[]},{"$$mdtype":"Node","type":"softbreak","inline":true,"attributes":{},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"means nothing has been frozen yet, so "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"payload_version"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" and "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"payload"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" are null as well."},"children":[]}]}]},{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"payload_version"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" also pins the frozen "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"payload"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"'s "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"kind"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":": "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"v1"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" with "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"webhook_v1"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":", "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"v2"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" with"},"children":[]},{"$$mdtype":"Node","type":"softbreak","inline":true,"attributes":{},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"webhook_v2"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":", and a null "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"payload_version"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" with "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"telegram"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"."},"children":[]}]}]}],"properties":{"id":{"$ref":"#/components/schemas/UUID","description":"Identity of the notification, stable across retries and equal to the webhook event id."},"channel_id":{"$ref":"#/components/schemas/UUID","description":"Channel selected for delivery. Its identifier stays readable after the channel is deleted."},"subscription_id":{"description":"Subscription that selected the transaction, or null for a channel test.","oneOf":[{"$ref":"#/components/schemas/UUID"},{"type":"null"}]},"is_test":{"type":"boolean","description":"Whether this is a channel diagnostic rather than a real transaction notification."},"chain_gid":{"$ref":"#/components/schemas/ChainGID","description":"Network of the transaction. Absent on tests."},"txid":{"$ref":"#/components/schemas/Txid","description":"Transaction the notification is about. Absent on tests."},"status":{"$ref":"#/components/schemas/NotificationStatus"},"reason":{"description":"Why the notification reached its status, or null while there is nothing to explain.","oneOf":[{"$ref":"#/components/schemas/NotificationReason"},{"type":"null"}]},"attempt_count":{"$ref":"#/components/schemas/NotificationCounter","description":"Authorized attempts of every kind."},"manual_attempt_count":{"$ref":"#/components/schemas/NotificationCounter","description":"Authorized manual attempts, failed and uncertain ones included."},"automatic_attempt_count":{"type":"integer","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Authorized automatic attempts, which is attempt_count minus manual_attempt_count."},"children":[]}]}]}],"minimum":0,"maximum":10},"resend_status":{"description":"Progress of a manual resend, or null when none is running.","oneOf":[{"$ref":"#/components/schemas/NotificationResendStatus"},{"type":"null"}]},"last_attempt_at":{"description":"When the most recent attempt was authorized, or null before any attempt.","oneOf":[{"$ref":"#/components/schemas/Timestamp"},{"type":"null"}]},"last_attempt_status":{"description":"Status of that same most recent attempt, or null before any attempt.","oneOf":[{"$ref":"#/components/schemas/NotificationAttemptStatus"},{"type":"null"}]},"next_attempt_at":{"description":"When the next automatic attempt is due, or null without automatic eligibility.","oneOf":[{"$ref":"#/components/schemas/Timestamp"},{"type":"null"}]},"created_at":{"$ref":"#/components/schemas/Timestamp","description":"When the notification was created."},"updated_at":{"$ref":"#/components/schemas/Timestamp","description":"When the notification last changed."},"payload":{"description":"Frozen content of the notification, or null before preparation and after cleanup.","oneOf":[{"$ref":"#/components/schemas/NotificationPayload"},{"type":"null"}]},"payload_version":{"description":"Webhook body version actually frozen, or null before preparation and for Telegram. It is\nnever substituted from the channel's live configuration.\n","oneOf":[{"$ref":"#/components/schemas/WebhookPayloadVersion"},{"type":"null"}]},"event_name":{"description":"Logical event name frozen with the content, or null before preparation.","oneOf":[{"$ref":"#/components/schemas/NotificationEventName"},{"type":"null"}]}},"required":["id","channel_id","subscription_id","is_test","status","reason","attempt_count","manual_attempt_count","automatic_attempt_count","resend_status","last_attempt_at","last_attempt_status","next_attempt_at","created_at","updated_at","payload","payload_version","event_name"],"example":{"id":"550e8400-e29b-41d4-a716-446655440020","channel_id":"550e8400-e29b-41d4-a716-446655440001","subscription_id":"550e8400-e29b-41d4-a716-446655440002","is_test":false,"chain_gid":"eip155:1","txid":"0x1234567890abcdef1234567890abcdef1234567890abcdef1234567890abcdef","status":"delivered","reason":null,"attempt_count":2,"manual_attempt_count":0,"automatic_attempt_count":2,"resend_status":null,"last_attempt_at":"2024-01-15T10:31:05Z","last_attempt_status":"succeeded","next_attempt_at":null,"created_at":"2024-01-15T10:30:00Z","updated_at":"2024-01-15T10:31:05Z","payload":{"kind":"webhook_v2","body":{"version":"v2","event_id":"550e8400-e29b-41d4-a716-446655440020","subscription_id":"550e8400-e29b-41d4-a716-446655440002","is_test":false,"item":{"chain_gid":"eip155:1","txid":"0x1234567890abcdef1234567890abcdef1234567890abcdef1234567890abcdef","created_at":"2024-01-15T10:30:00Z","activity":[{"chain_gid":"eip155:1","txid":"0x1234567890abcdef1234567890abcdef1234567890abcdef1234567890abcdef","address":"0x742d35cc6634c0532925a3b8d1e1d78d8E15e5c4","asset_gid":"eip155:1/erc20:0xdAC17F958D2ee523a2206206994597C13D831ec7","direction":"out","delta":{"base":"-1000000","formatted":"-1.0"},"created_at":"2024-01-15T10:30:00Z","entry_kind":"token_transfer"}],"details":{"family":"evm","events":[{"event_index":0,"kind":"transfer","asset_gid":"eip155:1/erc20:0xdAC17F958D2ee523a2206206994597C13D831ec7","amount":{"base":"1000000","formatted":"1.0"},"operation":"transfer","from_address":"0x742d35cc6634c0532925a3b8d1e1d78d8E15e5c4","to_address":"0x95212290dd7278aa3ddd389cc1e1d165cc4bafe5"}],"is_success":true,"fee":{"base":"21000000000000000","formatted":"0.021"},"block":{"block_hash":"0x9f1c2a3b4d5e6f708192a3b4c5d6e7f8091a2b3c4d5e6f708192a3b4c5d6e7f8","block_height":18500000},"transaction_index":42,"from_address":"0x742d35cc6634c0532925a3b8d1e1d78d8E15e5c4","to_address":"0xdAC17F958D2ee523a2206206994597C13D831ec7","gas_used":65000}},"references":{"tokens":{"eip155:1/erc20:0xdAC17F958D2ee523a2206206994597C13D831ec7":{"gid":"eip155:1/erc20:0xdAC17F958D2ee523a2206206994597C13D831ec7","symbol":"USDT","name":"Tether USD","decimals":6}},"blockchains":{"eip155:1":{"gid":"eip155:1","name":"ethereum","short_name":"eth","image_url":"https://raw.githubusercontent.com/vilna-io/icons/refs/heads/main/chains/ethereum.svg"}},"addresses":{"0x742d35cc6634c0532925a3b8d1e1d78d8E15e5c4":"Hot wallet"}}}},"payload_version":"v2","event_name":"transaction.notification"}}},"components/schemas/NotificationAttemptKind":{"id":"components/schemas/NotificationAttemptKind","kind":"json-schema","title":"NotificationAttemptKind","data":{"type":"string","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Why the attempt was authorized. Only automatic attempts consume the channel's max_attempts."},"children":[]}]}]}],"enum":["automatic","manual","test"],"x-enumDescriptions":{"automatic":"Scheduled by the retry policy.","manual":"Requested through the resend action.","test":"Produced by a channel test."},"example":"automatic"}},"components/schemas/NotificationAttemptErrorCode":{"id":"components/schemas/NotificationAttemptErrorCode","kind":"json-schema","title":"NotificationAttemptErrorCode","data":{"type":"string","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"The reason a delivery attempt did not succeed, independent of "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"status_code"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":". A timeout or"},"children":[]},{"$$mdtype":"Node","type":"softbreak","inline":true,"attributes":{},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"server error does not always mean the destination did not receive the notification. A"},"children":[]},{"$$mdtype":"Node","type":"softbreak","inline":true,"attributes":{},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"successful attempt has no error code."},"children":[]}]}]}],"enum":["transport_error","timeout","invalid_response","remote_rejected","remote_error","rate_limited","destination_rejected","credentials_rejected","recipient_unavailable","payload_invalid","worker_interrupted"],"x-enumDescriptions":{"transport_error":"The connection to the destination failed.","timeout":"The destination did not answer within the deadline.","invalid_response":"The destination answered with something unusable.","remote_rejected":"The destination explicitly rejected the message.","remote_error":"The destination reported a server-side error.","rate_limited":"The destination throttled the request.","destination_rejected":"Local destination policy refused the target.","credentials_rejected":"The destination refused the channel's credentials.","recipient_unavailable":"The recipient no longer exists or cannot be reached.","payload_invalid":"The destination refused the content as invalid.","worker_interrupted":"The delivery attempt was interrupted before its outcome was recorded."},"example":"timeout"}},"components/schemas/NotificationAttempt":{"id":"components/schemas/NotificationAttempt","kind":"json-schema","title":"NotificationAttempt","data":{"type":"object","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"One delivery attempt of a notification. "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"created_at"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" is the moment the attempt was authorized,"},"children":[]},{"$$mdtype":"Node","type":"softbreak","inline":true,"attributes":{},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"not a proven network send, and a late result may still refine an attempt whose outcome is"},"children":[]},{"$$mdtype":"Node","type":"softbreak","inline":true,"attributes":{},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"unknown. An attempt that is still "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"sending"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" has no "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"completed_at"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"; every other status has one."},"children":[]},{"$$mdtype":"Node","type":"softbreak","inline":true,"attributes":{},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"No attempt repeats the channel configuration, its secrets or the payload."},"children":[]}]}]}],"properties":{"id":{"$ref":"#/components/schemas/UUID"},"number":{"type":"integer","description":"Authorization order within the notification. Manual sends can push it past ten.","minimum":1,"maximum":2147483647},"kind":{"$ref":"#/components/schemas/NotificationAttemptKind"},"status":{"$ref":"#/components/schemas/NotificationAttemptStatus"},"status_code":{"description":"HTTP status the destination answered with, or null when there was no response.","oneOf":[{"type":"integer","minimum":100,"maximum":599},{"type":"null"}]},"error_code":{"description":"Typed cause of the failure, or null for a successful or still running attempt.","oneOf":[{"$ref":"#/components/schemas/NotificationAttemptErrorCode"},{"type":"null"}]},"error":{"description":"Short redacted diagnostic, or null when there is nothing to report.","oneOf":[{"type":"string"},{"type":"null"}]},"created_at":{"$ref":"#/components/schemas/Timestamp","description":"Time the attempt was authorized."},"completed_at":{"description":"Time the attempt finished, or null while it is still sending.","oneOf":[{"$ref":"#/components/schemas/Timestamp"},{"type":"null"}]},"duration_ms":{"description":"Measured duration of the attempt, or null when it was not measured.","oneOf":[{"type":"integer","minimum":0,"maximum":2147483647},{"type":"null"}]}},"required":["id","number","kind","status","status_code","error_code","error","created_at","completed_at","duration_ms"],"example":{"id":"550e8400-e29b-41d4-a716-446655440030","number":1,"kind":"automatic","status":"failed","status_code":503,"error_code":"remote_error","error":"destination returned 503","created_at":"2024-01-15T10:31:00Z","completed_at":"2024-01-15T10:31:02Z","duration_ms":1840}}},"components/schemas/TokenTagName":{"id":"components/schemas/TokenTagName","kind":"json-schema","title":"TokenTagName","data":{"type":"string","description":"Display name for the token tag.","minLength":1,"maxLength":32,"example":"Stablecoins"}},"components/schemas/TokenTag":{"id":"components/schemas/TokenTag","kind":"json-schema","title":"TokenTag","data":{"type":"object","description":"A named collection of tokens within a project.","properties":{"id":{"$ref":"#/components/schemas/UUID"},"name":{"$ref":"#/components/schemas/TokenTagName"},"created_at":{"$ref":"#/components/schemas/CreatedAt"},"updated_at":{"$ref":"#/components/schemas/UpdatedAt"}},"required":["id","name","created_at","updated_at"]}},"components/schemas/CreateTokenTagRequest":{"id":"components/schemas/CreateTokenTagRequest","kind":"json-schema","title":"CreateTokenTagRequest","data":{"type":"object","description":"Token tag creation payload.","properties":{"name":{"$ref":"#/components/schemas/TokenTagName"}},"required":["name"],"additionalProperties":false}},"components/schemas/UpdateTokenTagRequest":{"id":"components/schemas/UpdateTokenTagRequest","kind":"json-schema","title":"UpdateTokenTagRequest","data":{"type":"object","description":"Token tag update payload.","properties":{"name":{"$ref":"#/components/schemas/TokenTagName"}},"additionalProperties":false}},"components/schemas/AddTokenTagAssetsRequest":{"id":"components/schemas/AddTokenTagAssetsRequest","kind":"json-schema","title":"AddTokenTagAssetsRequest","data":{"type":"object","description":"Add tokens to a tag by asset GID.","properties":{"asset_gids":{"type":"array","description":"List of CAIP-19 asset GIDs to add.","items":{"$ref":"#/components/schemas/AssetGID"},"minItems":1,"maxItems":100}},"required":["asset_gids"],"additionalProperties":false}},"components/schemas/RemoveTokenTagAssetsRequest":{"id":"components/schemas/RemoveTokenTagAssetsRequest","kind":"json-schema","title":"RemoveTokenTagAssetsRequest","data":{"type":"object","description":"Remove tokens from a tag by asset GID.","properties":{"asset_gids":{"type":"array","description":"List of CAIP-19 asset GIDs to remove.","items":{"$ref":"#/components/schemas/AssetGID"},"minItems":1,"maxItems":100}},"required":["asset_gids"],"additionalProperties":false}},"components/schemas/CreateAddressTagRequest":{"id":"components/schemas/CreateAddressTagRequest","kind":"json-schema","title":"CreateAddressTagRequest","data":{"type":"object","description":"Address tag creation payload.","properties":{"name":{"$ref":"#/components/schemas/AddressTagName"}},"required":["name"],"additionalProperties":false}},"components/schemas/UpdateAddressTagRequest":{"id":"components/schemas/UpdateAddressTagRequest","kind":"json-schema","title":"UpdateAddressTagRequest","data":{"type":"object","description":"Address tag update payload.","properties":{"name":{"$ref":"#/components/schemas/AddressTagName"}},"required":["name"],"additionalProperties":false}},"components/schemas/AddAddressTagAddressesRequest":{"id":"components/schemas/AddAddressTagAddressesRequest","kind":"json-schema","title":"AddAddressTagAddressesRequest","data":{"type":"object","description":"Add addresses to a tag by address value.","properties":{"addresses":{"type":"array","description":"List of address values to add.","items":{"$ref":"#/components/schemas/AddressValue"},"minItems":1,"maxItems":100}},"required":["addresses"],"additionalProperties":false}},"components/schemas/RemoveAddressTagAddressesRequest":{"id":"components/schemas/RemoveAddressTagAddressesRequest","kind":"json-schema","title":"RemoveAddressTagAddressesRequest","data":{"type":"object","description":"Remove addresses from a tag by address value.","properties":{"addresses":{"type":"array","description":"List of address values to remove.","items":{"$ref":"#/components/schemas/AddressValue"},"minItems":1,"maxItems":100}},"required":["addresses"],"additionalProperties":false}},"components/schemas/VersionInfo":{"id":"components/schemas/VersionInfo","kind":"json-schema","title":"VersionInfo","data":{"type":"object","description":"API version information.","properties":{"version":{"description":"API version (semantic versioning).","type":"string"}},"required":["version"],"example":{"version":"2.0.0"},"examples":[{"version":"2.0.0"},{"version":"1.2.3"},{"version":"2.0.0-beta.1"},{"version":"1.5.2-rc.1"}]}},"schema_0":{"kind":"json-schema","data":{"default":30,"example":20,"maximum":100,"minimum":1,"type":"integer"},"id":"schema_0"},"schema_1":{"kind":"json-schema","data":{"default":1,"example":1,"minimum":1,"type":"integer"},"id":"schema_1"},"schema_2":{"kind":"json-schema","data":{"type":"array","maxItems":10,"items":{"$ref":"#/components/schemas/AddressValue"}},"id":"schema_2"},"schema_3":{"kind":"json-schema","data":{"type":"array","maxItems":10,"items":{"$ref":"#/components/schemas/AssetGID"}},"id":"schema_3"},"schema_4":{"kind":"json-schema","data":{"type":"array","maxItems":10,"items":{"$ref":"#/components/schemas/ChainGID"}},"id":"schema_4"},"schema_5":{"kind":"json-schema","data":{"type":"array","maxItems":10,"items":{"$ref":"#/components/schemas/Txid"}},"id":"schema_5"},"schema_6":{"kind":"json-schema","data":{"type":"string","enum":["in","out"]},"id":"schema_6"},"schema_7":{"kind":"json-schema","data":{"$ref":"#/components/schemas/Timestamp"},"id":"schema_7"},"schema_8":{"kind":"json-schema","data":{"type":"string","enum":["address","-address","asset_gid","-asset_gid","txid","-txid","created_at","-created_at","delta","-delta"],"default":"-created_at","example":"created_at"},"id":"schema_8"},"schema_9":{"kind":"json-schema","data":{"type":"object","properties":{"items":{"type":"array","description":"List of asset movement records.","items":{"$ref":"#/components/schemas/ActivityItem"}},"references":{"$ref":"#/components/schemas/ActivityReferences"},"meta":{"$ref":"#/components/schemas/PaginationMeta"}},"required":["items","references","meta"]},"id":"schema_9"},"schema_10":{"kind":"json-schema","data":{"$ref":"#/components/schemas/ChainFamily"},"id":"schema_10"},"schema_11":{"kind":"json-schema","data":{"type":"object","properties":{"items":{"type":"array","description":"List of address balances.","items":{"$ref":"#/components/schemas/AddressBalance"}},"references":{"$ref":"#/components/schemas/BalanceReferences"},"meta":{"$ref":"#/components/schemas/PaginationMeta"}},"required":["items","references","meta"]},"id":"schema_11"},"schema_12":{"kind":"json-schema","data":{"$ref":"#/components/schemas/AmountInBaseUnits"},"id":"schema_12"},"schema_13":{"kind":"json-schema","data":{"type":"object","properties":{"items":{"type":"array","description":"List of asset balance summaries.","items":{"$ref":"#/components/schemas/Balance"}},"references":{"$ref":"#/components/schemas/BalanceSummaryReferences"},"meta":{"$ref":"#/components/schemas/PaginationMeta"}},"required":["items","references","meta"]},"id":"schema_13"},"schema_14":{"kind":"json-schema","data":{"type":"string","minLength":1,"maxLength":128,"pattern":"^[!-~]+$"},"id":"schema_14"},"schema_15":{"kind":"json-schema","data":{"type":"object","properties":{"item":{"$ref":"#/components/schemas/RefreshedAddressBalance"},"references":{"$ref":"#/components/schemas/BalanceReferences"}},"required":["item","references"]},"id":"schema_15"},"schema_16":{"kind":"json-schema","data":{"type":"object","properties":{"Retry-After":{"type":"integer","minimum":1,"description":"Whole seconds until another action can be admitted under the current limit,\nrounded up. Returned when max is greater than zero and the retry deadline\nis known; omitted when max is zero or the deadline is unknown. This is an\nearliest-retry hint, not a reservation: the next attempt checks the policy\nand usage again.\n","example":7}}},"id":"schema_16"},"schema_17":{"kind":"json-schema","data":{"$ref":"#/components/schemas/UUID"},"id":"schema_17"},"schema_18":{"kind":"json-schema","data":{"type":"string","enum":["label","-label","value","-value","created_at","-created_at","updated_at","-updated_at"],"default":"-created_at","example":"created_at"},"id":"schema_18"},"schema_19":{"kind":"json-schema","data":{"type":"array","items":{"$ref":"#/components/schemas/AddressFormat"},"maxItems":10},"id":"schema_19"},"schema_20":{"kind":"json-schema","data":{"type":"string","maxLength":64,"example":"bc1q"},"id":"schema_20"},"schema_21":{"kind":"json-schema","data":{"type":"array","maxItems":10,"items":{"$ref":"#/components/schemas/UUID"}},"id":"schema_21"},"schema_22":{"kind":"json-schema","data":{"type":"object","properties":{"items":{"type":"array","description":"List of HD addresses derived from public keys.","items":{"$ref":"#/components/schemas/HDAddress"}},"references":{"$ref":"#/components/schemas/AddressReferences"},"meta":{"$ref":"#/components/schemas/PaginationMeta"}},"required":["items","references","meta"]},"id":"schema_22"},"schema_23":{"kind":"json-schema","data":{"type":"object","properties":{"items":{"type":"array","description":"Generated addresses, one per derivation index, in index order.","items":{"$ref":"#/components/schemas/HDAddress"}},"references":{"$ref":"#/components/schemas/AddressReferences"}},"required":["items","references"],"example":{"items":[{"value":"0xCa79F73628E5D46Cc2c0F6CcD3a3F934d3cE66B7","format":"evm","label":"user_45_deposit","kind":"hd","public_key_id":"123e4567-e89b-12d3-a456-426614174000","derivation_index":100,"tag_ids":[],"meta":{"user_id":"45","purpose":"deposit"},"created_at":"2025-07-03T12:45:00Z","updated_at":"2025-07-03T13:15:22Z"}],"references":{"public_keys":{"123e4567-e89b-12d3-a456-426614174000":{"id":"123e4567-e89b-12d3-a456-426614174000","value":"xpub6EFxzN6ZgMCZ1PxeRigmAhm2UBGzXtZNgznCEaWuEt9efBpJwAXFA4ZckBdR1pdMQ1pBgsey7ebjToZ5gYXveftB3zwoQ8NvEkimvyaz34i","label":"Main EVM Wallet","derivation_path":"m/44'/60'/0'","children":[{"id":"660e8400-e29b-41d4-a716-446655440001","value":"xpub6F7C1ZtQ411zykk6KTEoQMqfNdxiSA4uxAwAoqFanijnAavqQvVmh5zZCH6Swhdbzt2HuMRLx4chEVRZu9ic4Cnkkq5AsQcmjeMASk6FLqf","label":"external","derivation_path":"m/44'/60'/0'/0","created_at":"2025-01-15T12:00:00Z","updated_at":"2025-01-15T12:00:00Z"}],"created_at":"2025-01-15T12:00:00Z","updated_at":"2025-01-15T12:00:00Z"}},"address_tags":{}}}},"id":"schema_23"},"schema_24":{"kind":"json-schema","data":{"$ref":"#/components/schemas/AddressKind"},"id":"schema_24"},"schema_25":{"kind":"json-schema","data":{"type":"object","properties":{"items":{"type":"array","description":"List of addresses.","items":{"$ref":"#/components/schemas/AddressUnion"}},"references":{"$ref":"#/components/schemas/AddressReferences"},"meta":{"$ref":"#/components/schemas/PaginationMeta"}},"required":["items","references","meta"]},"id":"schema_25"},"schema_26":{"kind":"json-schema","data":{"type":"object","properties":{"item":{"$ref":"#/components/schemas/ExternalAddress"},"references":{"$ref":"#/components/schemas/AddressReferences"}},"required":["item","references"]},"id":"schema_26"},"schema_27":{"kind":"json-schema","data":{"$ref":"#/components/schemas/AddressValue"},"id":"schema_27"},"schema_28":{"kind":"json-schema","data":{"type":"object","properties":{"item":{"$ref":"#/components/schemas/AddressUnion"},"references":{"$ref":"#/components/schemas/AddressReferences"}},"required":["item","references"]},"id":"schema_28"},"schema_29":{"kind":"json-schema","data":{"$ref":"#/components/schemas/ChainGID"},"id":"schema_29"},"schema_30":{"kind":"json-schema","data":{"type":"string","enum":["txid","-txid","amount","-amount","block_number","-block_number"],"default":"-block_number","example":"-amount"},"id":"schema_30"},"schema_31":{"kind":"json-schema","data":{"type":"object","properties":{"items":{"type":"array","description":"List of unspent outputs.","items":{"$ref":"#/components/schemas/BitcoinUTXOItem"}},"references":{"$ref":"#/components/schemas/BitcoinUTXOReferences"},"meta":{"$ref":"#/components/schemas/PaginationMeta"}},"required":["items","references","meta"]},"id":"schema_31"},"schema_32":{"kind":"json-schema","data":{"type":"string","enum":["name","-name","created_at","-created_at","updated_at","-updated_at"],"default":"-created_at","example":"created_at"},"id":"schema_32"},"schema_33":{"kind":"json-schema","data":{"type":"string","maxLength":32},"id":"schema_33"},"schema_34":{"kind":"json-schema","data":{"type":"object","properties":{"items":{"type":"array","items":{"$ref":"#/components/schemas/AddressTag"}},"meta":{"$ref":"#/components/schemas/PaginationMeta"}},"required":["items","meta"]},"id":"schema_34"},"schema_35":{"kind":"json-schema","data":{"type":"object","properties":{"item":{"$ref":"#/components/schemas/AddressTag"}},"required":["item"]},"id":"schema_35"},"schema_36":{"kind":"json-schema","data":{"type":"string","maxLength":32,"example":"wallet"},"id":"schema_36"},"schema_37":{"kind":"json-schema","data":{"type":"string","enum":["id","-id","label","-label","created_at","-created_at","updated_at","-updated_at"],"default":"-created_at","example":"created_at"},"id":"schema_37"},"schema_38":{"kind":"json-schema","data":{"type":"object","properties":{"items":{"type":"array","description":"List of public keys.","items":{"$ref":"#/components/schemas/PublicKey"}},"meta":{"$ref":"#/components/schemas/PaginationMeta"}},"required":["items","meta"]},"id":"schema_38"},"schema_39":{"kind":"json-schema","data":{"type":"object","properties":{"item":{"$ref":"#/components/schemas/PublicKey"}},"required":["item"]},"id":"schema_39"},"schema_40":{"kind":"json-schema","data":{"type":"array","maxItems":10,"items":{"$ref":"#/components/schemas/BlockNumber"}},"id":"schema_40"},"schema_41":{"kind":"json-schema","data":{"type":"boolean"},"id":"schema_41"},"schema_42":{"kind":"json-schema","data":{"type":"string","enum":["txid","-txid","block_number","-block_number","is_success","-is_success","created_at","-created_at"],"default":"-created_at","example":"created_at"},"id":"schema_42"},"schema_43":{"kind":"json-schema","data":{"type":"object","properties":{"items":{"type":"array","description":"List of blockchain transactions.","items":{"$ref":"#/components/schemas/TransactionSummary"}},"references":{"$ref":"#/components/schemas/TransactionReferences"},"meta":{"$ref":"#/components/schemas/PaginationMeta"}},"required":["items","references","meta"]},"id":"schema_43"},"schema_44":{"kind":"json-schema","data":{"$ref":"#/components/schemas/Txid"},"id":"schema_44"},"schema_45":{"kind":"json-schema","data":{"type":"object","properties":{"item":{"$ref":"#/components/schemas/Transaction"},"references":{"$ref":"#/components/schemas/TransactionReferences"}},"required":["item","references"]},"id":"schema_45"},"schema_46":{"kind":"json-schema","data":{"type":"array","items":{"$ref":"#/components/schemas/InvoiceStatus"},"maxItems":10},"id":"schema_46"},"schema_47":{"kind":"json-schema","data":{"type":"string","enum":["created_at","-created_at","updated_at","-updated_at","expires_at","-expires_at","status","-status"],"default":"-created_at","example":"created_at"},"id":"schema_47"},"schema_48":{"kind":"json-schema","data":{"type":"object","properties":{"items":{"type":"array","items":{"$ref":"#/components/schemas/InvoiceSummary"}},"references":{"$ref":"#/components/schemas/InvoiceReferences"},"meta":{"$ref":"#/components/schemas/PaginationMeta"}},"required":["items","references","meta"]},"id":"schema_48"},"schema_49":{"kind":"json-schema","data":{"type":"object","properties":{"item":{"$ref":"#/components/schemas/Invoice"},"references":{"$ref":"#/components/schemas/InvoiceReferences"}},"required":["item","references"]},"id":"schema_49"},"schema_50":{"kind":"json-schema","data":{"type":"object","properties":{"item":{"$ref":"#/components/schemas/PublicInvoice"},"references":{"$ref":"#/components/schemas/InvoiceReferences"}},"required":["item","references"]},"id":"schema_50"},"schema_51":{"kind":"json-schema","data":{"$ref":"#/components/schemas/ChannelKind"},"id":"schema_51"},"schema_52":{"kind":"json-schema","data":{"type":"string","enum":["name","-name","kind","-kind","created_at","-created_at","updated_at","-updated_at"],"default":"-created_at","example":"created_at"},"id":"schema_52"},"schema_53":{"kind":"json-schema","data":{"type":"object","properties":{"items":{"type":"array","items":{"$ref":"#/components/schemas/ChannelSummary"}},"meta":{"$ref":"#/components/schemas/PaginationMeta"}},"required":["items","meta"]},"id":"schema_53"},"schema_54":{"kind":"json-schema","data":{"type":"object","required":["item"],"properties":{"item":{"$ref":"#/components/schemas/Channel"},"webhook_secret":{"$ref":"#/components/schemas/RawWebhookSecret","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Plaintext signing secret for the new channel. Present only when "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"kind=webhook"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"."},"children":[]},{"$$mdtype":"Node","type":"softbreak","inline":true,"attributes":{},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Retrying with the same "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"Idempotency-Key"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" replays this response for 60 seconds"},"children":[]},{"$$mdtype":"Node","type":"softbreak","inline":true,"attributes":{},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"after completion while the secret remains current. A new key can create another"},"children":[]},{"$$mdtype":"Node","type":"softbreak","inline":true,"attributes":{},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"channel. Replace a lost secret by rotation."},"children":[]}]}]}]}}},"id":"schema_54"},"schema_55":{"kind":"json-schema","data":{"type":"object","properties":{"item":{"$ref":"#/components/schemas/Channel"}},"required":["item"]},"id":"schema_55"},"schema_56":{"kind":"json-schema","data":{"type":"object","properties":{"item":{"$ref":"#/components/schemas/WebhookSecrets"}},"required":["item"]},"id":"schema_56"},"schema_57":{"kind":"json-schema","data":{"type":"object","properties":{"item":{"$ref":"#/components/schemas/WebhookSecrets","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"The secrets after rotation; "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"current"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" is the one just issued."},"children":[]}]}]}]},"webhook_secret":{"$ref":"#/components/schemas/RawWebhookSecret","description":"Plaintext form of the new current secret. Store it now; if lost, rotate again."}},"required":["item","webhook_secret"]},"id":"schema_57"},"schema_58":{"kind":"json-schema","data":{"$ref":"#/components/schemas/SubscriptionConcreteFamily"},"id":"schema_58"},"schema_59":{"kind":"json-schema","data":{"type":"string","maxLength":64},"id":"schema_59"},"schema_60":{"kind":"json-schema","data":{"type":"string","enum":["name","-name","family","-family","created_at","-created_at","updated_at","-updated_at"],"default":"-created_at","example":"created_at"},"id":"schema_60"},"schema_61":{"kind":"json-schema","data":{"type":"object","properties":{"items":{"type":"array","items":{"$ref":"#/components/schemas/Subscription"}},"references":{"$ref":"#/components/schemas/SubscriptionReferences"},"meta":{"$ref":"#/components/schemas/PaginationMeta"}},"required":["items","references","meta"]},"id":"schema_61"},"schema_62":{"kind":"json-schema","data":{"type":"object","properties":{"item":{"$ref":"#/components/schemas/Subscription"},"references":{"$ref":"#/components/schemas/SubscriptionReferences"}},"required":["item","references"]},"id":"schema_62"},"schema_63":{"kind":"json-schema","data":{"$ref":"#/components/schemas/NotificationStatus"},"id":"schema_63"},"schema_64":{"kind":"json-schema","data":{"type":"string","enum":["created_at","-created_at"],"default":"-created_at","example":"created_at"},"id":"schema_64"},"schema_65":{"kind":"json-schema","data":{"type":"object","properties":{"items":{"type":"array","items":{"$ref":"#/components/schemas/NotificationSummary"}},"meta":{"$ref":"#/components/schemas/PaginationMeta"}},"required":["items","meta"],"example":{"items":[{"id":"550e8400-e29b-41d4-a716-446655440020","channel_id":"550e8400-e29b-41d4-a716-446655440001","subscription_id":"550e8400-e29b-41d4-a716-446655440002","is_test":false,"chain_gid":"eip155:1","txid":"0x1234567890abcdef1234567890abcdef1234567890abcdef1234567890abcdef","status":"delivered","reason":null,"attempt_count":2,"manual_attempt_count":0,"automatic_attempt_count":2,"resend_status":null,"last_attempt_at":"2024-01-15T10:31:05Z","last_attempt_status":"succeeded","next_attempt_at":null,"created_at":"2024-01-15T10:30:00Z","updated_at":"2024-01-15T10:31:05Z","payload_version":"v2","event_name":"transaction.notification"}],"meta":{"limit":20,"page":1,"total":1,"total_pages":1}}},"id":"schema_65"},"schema_66":{"kind":"json-schema","data":{"type":"object","properties":{"item":{"$ref":"#/components/schemas/Notification"}},"required":["item"],"example":{"item":{"id":"550e8400-e29b-41d4-a716-446655440020","channel_id":"550e8400-e29b-41d4-a716-446655440001","subscription_id":"550e8400-e29b-41d4-a716-446655440002","is_test":false,"chain_gid":"eip155:1","txid":"0x1234567890abcdef1234567890abcdef1234567890abcdef1234567890abcdef","status":"delivered","reason":null,"attempt_count":2,"manual_attempt_count":0,"automatic_attempt_count":2,"resend_status":null,"last_attempt_at":"2024-01-15T10:31:05Z","last_attempt_status":"succeeded","next_attempt_at":null,"created_at":"2024-01-15T10:30:00Z","updated_at":"2024-01-15T10:31:05Z","payload":{"kind":"webhook_v2","body":{"version":"v2","event_id":"550e8400-e29b-41d4-a716-446655440020","subscription_id":"550e8400-e29b-41d4-a716-446655440002","is_test":false,"item":{"chain_gid":"eip155:1","txid":"0x1234567890abcdef1234567890abcdef1234567890abcdef1234567890abcdef","created_at":"2024-01-15T10:30:00Z","activity":[{"chain_gid":"eip155:1","txid":"0x1234567890abcdef1234567890abcdef1234567890abcdef1234567890abcdef","address":"0x742d35cc6634c0532925a3b8d1e1d78d8E15e5c4","asset_gid":"eip155:1/erc20:0xdAC17F958D2ee523a2206206994597C13D831ec7","direction":"out","delta":{"base":"-1000000","formatted":"-1.0"},"created_at":"2024-01-15T10:30:00Z","entry_kind":"token_transfer"}],"details":{"family":"evm","events":[{"event_index":0,"kind":"transfer","asset_gid":"eip155:1/erc20:0xdAC17F958D2ee523a2206206994597C13D831ec7","amount":{"base":"1000000","formatted":"1.0"},"operation":"transfer","from_address":"0x742d35cc6634c0532925a3b8d1e1d78d8E15e5c4","to_address":"0x95212290dd7278aa3ddd389cc1e1d165cc4bafe5"}],"is_success":true,"fee":{"base":"21000000000000000","formatted":"0.021"},"block":{"block_hash":"0x9f1c2a3b4d5e6f708192a3b4c5d6e7f8091a2b3c4d5e6f708192a3b4c5d6e7f8","block_height":18500000},"transaction_index":42,"from_address":"0x742d35cc6634c0532925a3b8d1e1d78d8E15e5c4","to_address":"0xdAC17F958D2ee523a2206206994597C13D831ec7","gas_used":65000}},"references":{"tokens":{"eip155:1/erc20:0xdAC17F958D2ee523a2206206994597C13D831ec7":{"gid":"eip155:1/erc20:0xdAC17F958D2ee523a2206206994597C13D831ec7","symbol":"USDT","name":"Tether USD","decimals":6}},"blockchains":{"eip155:1":{"gid":"eip155:1","name":"ethereum","short_name":"eth","image_url":"https://raw.githubusercontent.com/vilna-io/icons/refs/heads/main/chains/ethereum.svg"}},"addresses":{"0x742d35cc6634c0532925a3b8d1e1d78d8E15e5c4":"Hot wallet"}}}},"payload_version":"v2","event_name":"transaction.notification"}}},"id":"schema_66"},"schema_67":{"kind":"json-schema","data":{"type":"string","enum":["number","-number"],"default":"-number","example":"number"},"id":"schema_67"},"schema_68":{"kind":"json-schema","data":{"type":"object","properties":{"items":{"type":"array","items":{"$ref":"#/components/schemas/NotificationAttempt"}},"meta":{"$ref":"#/components/schemas/PaginationMeta"}},"required":["items","meta"],"example":{"items":[{"id":"550e8400-e29b-41d4-a716-446655440031","number":2,"kind":"automatic","status":"succeeded","status_code":200,"error_code":null,"error":null,"created_at":"2024-01-15T10:31:05Z","completed_at":"2024-01-15T10:31:06Z","duration_ms":420},{"id":"550e8400-e29b-41d4-a716-446655440030","number":1,"kind":"automatic","status":"failed","status_code":503,"error_code":"remote_error","error":"destination returned 503","created_at":"2024-01-15T10:31:00Z","completed_at":"2024-01-15T10:31:02Z","duration_ms":1840}],"meta":{"limit":20,"page":1,"total":2,"total_pages":1}}},"id":"schema_68"},"schema_69":{"kind":"json-schema","data":{"type":"object","properties":{"Retry-After":{"type":"integer","minimum":1,"description":"Whole seconds to wait, rounded up to the later of the two deadlines that blocked the\nrequest: the delivery pause and the cooldown since the last attempt. It is a hint about the\nearliest retry, not a reservation: the next request checks the state again.\n","example":7}}},"id":"schema_69"},"schema_70":{"kind":"json-schema","data":{"type":"string","enum":["gid","-gid","name","-name","short_name","-short_name"],"example":"name","default":"name"},"id":"schema_70"},"schema_71":{"kind":"json-schema","data":{"type":"string","maxLength":32,"example":"ethereum"},"id":"schema_71"},"schema_72":{"kind":"json-schema","data":{"type":"array","items":{"$ref":"#/components/schemas/ChainFamily"},"maxItems":10},"id":"schema_72"},"schema_73":{"kind":"json-schema","data":{"type":"object","properties":{"items":{"type":"array","items":{"$ref":"#/components/schemas/Blockchain"}},"meta":{"$ref":"#/components/schemas/PaginationMeta"}},"required":["items","meta"]},"id":"schema_73"},"schema_74":{"kind":"json-schema","data":{"type":"object","properties":{"item":{"$ref":"#/components/schemas/Blockchain"}},"required":["item"]},"id":"schema_74"},"schema_75":{"kind":"json-schema","data":{"type":"string","enum":["gid","-gid","address","-address","decimals","-decimals","name","-name","symbol","-symbol"],"default":"symbol","example":"symbol"},"id":"schema_75"},"schema_76":{"kind":"json-schema","data":{"type":"string","maxLength":256,"example":"USDT"},"id":"schema_76"},"schema_77":{"kind":"json-schema","data":{"type":"string","enum":["all","project"],"default":"all","example":"all"},"id":"schema_77"},"schema_78":{"kind":"json-schema","data":{"type":"object","properties":{"items":{"type":"array","description":"Catalog assets matching the filter.","items":{"$ref":"#/components/schemas/CatalogAsset"}},"meta":{"$ref":"#/components/schemas/PaginationMeta"}},"required":["items","meta"]},"id":"schema_78"},"schema_79":{"kind":"json-schema","data":{"$ref":"#/components/schemas/AssetPath"},"id":"schema_79"},"schema_80":{"kind":"json-schema","data":{"type":"object","properties":{"item":{"$ref":"#/components/schemas/CatalogAsset"}},"required":["item"]},"id":"schema_80"},"schema_81":{"kind":"json-schema","data":{"type":"object","properties":{"items":{"type":"array","items":{"$ref":"#/components/schemas/TokenTag"}},"meta":{"$ref":"#/components/schemas/PaginationMeta"}},"required":["items","meta"]},"id":"schema_81"},"schema_82":{"kind":"json-schema","data":{"type":"object","properties":{"item":{"$ref":"#/components/schemas/TokenTag"}},"required":["item"]},"id":"schema_82"},"schema_83":{"kind":"json-schema","data":{"type":"object","required":["item"],"properties":{"item":{"$ref":"#/components/schemas/ProjectLimits"}}},"id":"schema_83"},"schema_84":{"kind":"json-schema","data":{"type":"object","properties":{"items":{"type":"array","description":"List of simulated transaction results, one per input call in submission order.","items":{"$ref":"#/components/schemas/SimulatedTransaction"}},"references":{"$ref":"#/components/schemas/TransactionReferences"}},"required":["items","references"]},"id":"schema_84"},"schema_85":{"kind":"json-schema","data":{"type":"object","properties":{"item":{"$ref":"#/components/schemas/VersionInfo"}},"required":["item"]},"id":"schema_85"}},"exampleStore":{"paths/~1activity/get/responses/200/content/application~1json/example":{"value":{"items":[{"chain_gid":"eip155:1","txid":"0x1234567890abcdef1234567890abcdef1234567890abcdef1234567890abcdef","address":"0x742d35cc6634c0532925a3b8d1e1d78d8E15e5c4","asset_gid":"eip155:1/erc20:0xdAC17F958D2ee523a2206206994597C13D831ec7","direction":"out","delta":{"base":"-1000000","formatted":"-1.0"},"created_at":"2024-01-15T10:30:00Z","entry_kind":"token_transfer"},{"chain_gid":"eip155:1","txid":"0x1234567890abcdef1234567890abcdef1234567890abcdef1234567890abcdef","address":"0x742d35cc6634c0532925a3b8d1e1d78d8E15e5c4","asset_gid":"eip155:1/slip44:60","direction":"out","delta":{"base":"-21000000000000000","formatted":"-0.021"},"created_at":"2024-01-15T10:30:00Z","entry_kind":"network_fee"}],"references":{"tokens":{"eip155:1/erc20:0xdAC17F958D2ee523a2206206994597C13D831ec7":{"gid":"eip155:1/erc20:0xdAC17F958D2ee523a2206206994597C13D831ec7","symbol":"USDT","name":"Tether USD","decimals":6}},"blockchains":{"eip155:1":{"gid":"eip155:1","name":"ethereum","short_name":"eth","image_url":"https://raw.githubusercontent.com/vilna-io/icons/refs/heads/main/chains/ethereum.svg"}},"addresses":{"0x742d35cc6634c0532925a3b8d1e1d78d8E15e5c4":"Hot wallet"}},"meta":{"limit":20,"page":1,"total":2,"total_pages":1}},"id":"paths/~1activity/get/responses/200/content/application~1json/example"},"paths/~1activity/get/responses/400/content/application~1problem+json/examples/malformed_json":{"value":{"type":"https://docs.vilna.io/apis/errors#invalid-request","title":"Invalid Request","status":400,"code":"request.malformed","detail":"The request could not be decoded.","instance":"/traces/0123456789abcdef0123456789abcdef"},"key":"malformed_json","summary":"The request body contains malformed JSON","id":"paths/~1activity/get/responses/400/content/application~1problem+json/examples/malformed_json"},"paths/~1activity/get/responses/401/content/application~1problem+json/examples/service_authentication_denied":{"value":{"type":"https://docs.vilna.io/apis/errors#unauthorized","title":"Unauthorized","status":401,"code":"unspecified","detail":"You are not authorized to access this resource. If the problem persists, please contact our support team.","instance":"/unauthorized?method=createInvoice"},"key":"service_authentication_denied","summary":"The API service refused authentication","id":"paths/~1activity/get/responses/401/content/application~1problem+json/examples/service_authentication_denied"},"paths/~1activity/get/responses/403/content/application~1problem+json/examples/insufficient_permissions":{"value":{"type":"https://docs.vilna.io/apis/errors#forbidden","title":"Forbidden","status":403,"code":"unspecified","detail":"Your credentials are valid but don't include the permission this operation needs. Check the API key permissions in the dashboard. Permissions are set when the key is created and can't be edited later. To change them, create a new key.","instance":"/forbidden?method=createInvoice"},"key":"insufficient_permissions","summary":"The API key lacks the required permission","id":"paths/~1activity/get/responses/403/content/application~1problem+json/examples/insufficient_permissions"},"paths/~1activity/get/responses/503/content/application~1problem+json/examples/temporarily_unavailable":{"value":{"type":"https://docs.vilna.io/apis/errors#service-unavailable","title":"Service Unavailable","status":503,"code":"service.temporarily_unavailable","detail":"The operation is temporarily unavailable. Please try again later."},"key":"temporarily_unavailable","summary":"The operation cannot be completed at present","id":"paths/~1activity/get/responses/503/content/application~1problem+json/examples/temporarily_unavailable"},"paths/~1balances~1{family}~1search/post/requestBody/content/application~1json/examples/single_address":{"value":{"addresses":["0x8521E8b15eCEF4D4269Fded3E6694225E096959E"]},"key":"single_address","summary":"One address, all assets","id":"paths/~1balances~1{family}~1search/post/requestBody/content/application~1json/examples/single_address"},"paths/~1balances~1{family}~1search/post/requestBody/content/application~1json/examples/filtered_search":{"value":{"addresses":["0x8521E8b15eCEF4D4269Fded3E6694225E096959E","0x742d35Cc6634C0532925a3b844Bc9e7595f2bD18"],"chain_gids":["eip155:1"],"asset_gids":["eip155:1/erc20:0xdAC17F958D2ee523a2206206994597C13D831ec7"],"page":1,"limit":30},"key":"filtered_search","summary":"Multiple addresses narrowed by chain and asset","id":"paths/~1balances~1{family}~1search/post/requestBody/content/application~1json/examples/filtered_search"},"paths/~1balances~1{family}~1search/post/responses/200/content/application~1json/example":{"value":{"items":[{"address":"0x8521E8b15eCEF4D4269Fded3E6694225E096959E","asset_gid":"eip155:1/erc20:0xdAC17F958D2ee523a2206206994597C13D831ec7","amount":{"base":"1000000000","formatted":"1000.0"},"is_sync":true},{"address":"0x8521E8b15eCEF4D4269Fded3E6694225E096959E","asset_gid":"eip155:1/slip44:60","is_sync":false}],"references":{"tokens":{"eip155:1/erc20:0xdAC17F958D2ee523a2206206994597C13D831ec7":{"gid":"eip155:1/erc20:0xdAC17F958D2ee523a2206206994597C13D831ec7","symbol":"USDT","name":"Tether USD","decimals":6}},"blockchains":{"eip155:1":{"gid":"eip155:1","name":"ethereum","short_name":"eth","image_url":"https://raw.githubusercontent.com/vilna-io/icons/refs/heads/main/chains/ethereum.svg"}},"addresses":{"0x8521E8b15eCEF4D4269Fded3E6694225E096959E":"Hot wallet"}},"meta":{"limit":30,"page":1,"total":2,"total_pages":1}},"id":"paths/~1balances~1{family}~1search/post/responses/200/content/application~1json/example"},"paths/~1balances~1{family}~1search/post/responses/400/content/application~1problem+json/examples/malformed_json":{"value":{"type":"https://docs.vilna.io/apis/errors#invalid-request","title":"Invalid Request","status":400,"code":"request.malformed","detail":"The request could not be decoded.","instance":"/traces/0123456789abcdef0123456789abcdef"},"key":"malformed_json","summary":"The request body contains malformed JSON","id":"paths/~1balances~1{family}~1search/post/responses/400/content/application~1problem+json/examples/malformed_json"},"paths/~1balances~1{family}~1search/post/responses/401/content/application~1problem+json/examples/service_authentication_denied":{"value":{"type":"https://docs.vilna.io/apis/errors#unauthorized","title":"Unauthorized","status":401,"code":"unspecified","detail":"You are not authorized to access this resource. If the problem persists, please contact our support team.","instance":"/unauthorized?method=createInvoice"},"key":"service_authentication_denied","summary":"The API service refused authentication","id":"paths/~1balances~1{family}~1search/post/responses/401/content/application~1problem+json/examples/service_authentication_denied"},"paths/~1balances~1{family}~1search/post/responses/403/content/application~1problem+json/examples/insufficient_permissions":{"value":{"type":"https://docs.vilna.io/apis/errors#forbidden","title":"Forbidden","status":403,"code":"unspecified","detail":"Your credentials are valid but don't include the permission this operation needs. Check the API key permissions in the dashboard. Permissions are set when the key is created and can't be edited later. To change them, create a new key.","instance":"/forbidden?method=createInvoice"},"key":"insufficient_permissions","summary":"The API key lacks the required permission","id":"paths/~1balances~1{family}~1search/post/responses/403/content/application~1problem+json/examples/insufficient_permissions"},"paths/~1balances~1{family}~1search/post/responses/404/content/application~1problem+json/examples/address_not_found":{"value":{"type":"https://docs.vilna.io/apis/errors#not-found","title":"Not Found","status":404,"code":"address.not_found","detail":"address not found","instance":"/traces/0123456789abcdef0123456789abcdef"},"key":"address_not_found","summary":"The address does not exist in this project","id":"paths/~1balances~1{family}~1search/post/responses/404/content/application~1problem+json/examples/address_not_found"},"paths/~1balances~1{family}~1search/post/responses/404/content/application~1problem+json/examples/invoice_not_found":{"value":{"type":"https://docs.vilna.io/apis/errors#not-found","title":"Not Found","status":404,"code":"invoice.not_found","detail":"invoice not found","instance":"/traces/0123456789abcdef0123456789abcdef"},"key":"invoice_not_found","summary":"The invoice does not exist in this project","id":"paths/~1balances~1{family}~1search/post/responses/404/content/application~1problem+json/examples/invoice_not_found"},"paths/~1balances~1{family}~1search/post/responses/422/content/application~1problem+json/examples/invoice_not_cancellable":{"value":{"type":"https://docs.vilna.io/apis/errors#precondition","title":"Precondition Failed","status":422,"code":"invoice.not_cancellable","detail":"invoice cannot be cancelled in current status","instance":"/traces/0123456789abcdef0123456789abcdef","fields":[{"name":"status","reason":"confirmed"}]},"key":"invoice_not_cancellable","summary":"A confirmed invoice cannot be cancelled","id":"paths/~1balances~1{family}~1search/post/responses/422/content/application~1problem+json/examples/invoice_not_cancellable"},"paths/~1balances~1{family}~1search/post/responses/503/content/application~1problem+json/examples/temporarily_unavailable":{"value":{"type":"https://docs.vilna.io/apis/errors#service-unavailable","title":"Service Unavailable","status":503,"code":"service.temporarily_unavailable","detail":"The operation is temporarily unavailable. Please try again later."},"key":"temporarily_unavailable","summary":"The operation cannot be completed at present","id":"paths/~1balances~1{family}~1search/post/responses/503/content/application~1problem+json/examples/temporarily_unavailable"},"paths/~1balances~1{family}~1summary/get/responses/200/content/application~1json/example":{"value":{"items":[{"asset_gid":"eip155:1/erc20:0xdAC17F958D2ee523a2206206994597C13D831ec7","amount":{"base":"5000000000","formatted":"5000.0"},"is_sync":true}],"references":{"tokens":{"eip155:1/erc20:0xdAC17F958D2ee523a2206206994597C13D831ec7":{"gid":"eip155:1/erc20:0xdAC17F958D2ee523a2206206994597C13D831ec7","symbol":"USDT","name":"Tether USD","decimals":6}},"blockchains":{"eip155:1":{"gid":"eip155:1","name":"ethereum","short_name":"eth","image_url":"https://raw.githubusercontent.com/vilna-io/icons/refs/heads/main/chains/ethereum.svg"}}},"meta":{"limit":30,"page":1,"total":1,"total_pages":1}},"id":"paths/~1balances~1{family}~1summary/get/responses/200/content/application~1json/example"},"paths/~1balances~1{family}~1summary/get/responses/400/content/application~1problem+json/examples/malformed_json":{"value":{"type":"https://docs.vilna.io/apis/errors#invalid-request","title":"Invalid Request","status":400,"code":"request.malformed","detail":"The request could not be decoded.","instance":"/traces/0123456789abcdef0123456789abcdef"},"key":"malformed_json","summary":"The request body contains malformed JSON","id":"paths/~1balances~1{family}~1summary/get/responses/400/content/application~1problem+json/examples/malformed_json"},"paths/~1balances~1{family}~1summary/get/responses/401/content/application~1problem+json/examples/service_authentication_denied":{"value":{"type":"https://docs.vilna.io/apis/errors#unauthorized","title":"Unauthorized","status":401,"code":"unspecified","detail":"You are not authorized to access this resource. If the problem persists, please contact our support team.","instance":"/unauthorized?method=createInvoice"},"key":"service_authentication_denied","summary":"The API service refused authentication","id":"paths/~1balances~1{family}~1summary/get/responses/401/content/application~1problem+json/examples/service_authentication_denied"},"paths/~1balances~1{family}~1summary/get/responses/403/content/application~1problem+json/examples/insufficient_permissions":{"value":{"type":"https://docs.vilna.io/apis/errors#forbidden","title":"Forbidden","status":403,"code":"unspecified","detail":"Your credentials are valid but don't include the permission this operation needs. Check the API key permissions in the dashboard. Permissions are set when the key is created and can't be edited later. To change them, create a new key.","instance":"/forbidden?method=createInvoice"},"key":"insufficient_permissions","summary":"The API key lacks the required permission","id":"paths/~1balances~1{family}~1summary/get/responses/403/content/application~1problem+json/examples/insufficient_permissions"},"paths/~1balances~1{family}~1summary/get/responses/404/content/application~1problem+json/examples/address_not_found":{"value":{"type":"https://docs.vilna.io/apis/errors#not-found","title":"Not Found","status":404,"code":"address.not_found","detail":"address not found","instance":"/traces/0123456789abcdef0123456789abcdef"},"key":"address_not_found","summary":"The address does not exist in this project","id":"paths/~1balances~1{family}~1summary/get/responses/404/content/application~1problem+json/examples/address_not_found"},"paths/~1balances~1{family}~1summary/get/responses/404/content/application~1problem+json/examples/invoice_not_found":{"value":{"type":"https://docs.vilna.io/apis/errors#not-found","title":"Not Found","status":404,"code":"invoice.not_found","detail":"invoice not found","instance":"/traces/0123456789abcdef0123456789abcdef"},"key":"invoice_not_found","summary":"The invoice does not exist in this project","id":"paths/~1balances~1{family}~1summary/get/responses/404/content/application~1problem+json/examples/invoice_not_found"},"paths/~1balances~1{family}~1summary/get/responses/422/content/application~1problem+json/examples/invoice_not_cancellable":{"value":{"type":"https://docs.vilna.io/apis/errors#precondition","title":"Precondition Failed","status":422,"code":"invoice.not_cancellable","detail":"invoice cannot be cancelled in current status","instance":"/traces/0123456789abcdef0123456789abcdef","fields":[{"name":"status","reason":"confirmed"}]},"key":"invoice_not_cancellable","summary":"A confirmed invoice cannot be cancelled","id":"paths/~1balances~1{family}~1summary/get/responses/422/content/application~1problem+json/examples/invoice_not_cancellable"},"paths/~1balances~1{family}~1summary/get/responses/503/content/application~1problem+json/examples/temporarily_unavailable":{"value":{"type":"https://docs.vilna.io/apis/errors#service-unavailable","title":"Service Unavailable","status":503,"code":"service.temporarily_unavailable","detail":"The operation is temporarily unavailable. Please try again later."},"key":"temporarily_unavailable","summary":"The operation cannot be completed at present","id":"paths/~1balances~1{family}~1summary/get/responses/503/content/application~1problem+json/examples/temporarily_unavailable"},"paths/~1balances~1{family}~1actions~1refresh/post/requestBody/content/application~1json/examples/refresh_usdt_balance":{"value":{"address":"0x8521E8b15eCEF4D4269Fded3E6694225E096959E","asset_gid":"eip155:1/erc20:0xdAC17F958D2ee523a2206206994597C13D831ec7"},"key":"refresh_usdt_balance","summary":"Refresh a USDT balance on Ethereum","id":"paths/~1balances~1{family}~1actions~1refresh/post/requestBody/content/application~1json/examples/refresh_usdt_balance"},"paths/~1balances~1{family}~1actions~1refresh/post/responses/200/content/application~1json/example":{"value":{"item":{"address":"0x8521E8b15eCEF4D4269Fded3E6694225E096959E","asset_gid":"eip155:1/erc20:0xdAC17F958D2ee523a2206206994597C13D831ec7","amount":{"base":"1000000000","formatted":"1000.0"},"is_sync":true},"references":{"tokens":{"eip155:1/erc20:0xdAC17F958D2ee523a2206206994597C13D831ec7":{"gid":"eip155:1/erc20:0xdAC17F958D2ee523a2206206994597C13D831ec7","symbol":"USDT","name":"Tether USD","decimals":6}},"blockchains":{"eip155:1":{"gid":"eip155:1","name":"ethereum","short_name":"eth","image_url":"https://raw.githubusercontent.com/vilna-io/icons/refs/heads/main/chains/ethereum.svg"}},"addresses":{"0x8521E8b15eCEF4D4269Fded3E6694225E096959E":"Hot wallet"}}},"id":"paths/~1balances~1{family}~1actions~1refresh/post/responses/200/content/application~1json/example"},"paths/~1balances~1{family}~1actions~1refresh/post/responses/400/content/application~1problem+json/examples/malformed_json":{"value":{"type":"https://docs.vilna.io/apis/errors#invalid-request","title":"Invalid Request","status":400,"code":"request.malformed","detail":"The request could not be decoded.","instance":"/traces/0123456789abcdef0123456789abcdef"},"key":"malformed_json","summary":"The request body contains malformed JSON","id":"paths/~1balances~1{family}~1actions~1refresh/post/responses/400/content/application~1problem+json/examples/malformed_json"},"paths/~1balances~1{family}~1actions~1refresh/post/responses/401/content/application~1problem+json/examples/service_authentication_denied":{"value":{"type":"https://docs.vilna.io/apis/errors#unauthorized","title":"Unauthorized","status":401,"code":"unspecified","detail":"You are not authorized to access this resource. If the problem persists, please contact our support team.","instance":"/unauthorized?method=createInvoice"},"key":"service_authentication_denied","summary":"The API service refused authentication","id":"paths/~1balances~1{family}~1actions~1refresh/post/responses/401/content/application~1problem+json/examples/service_authentication_denied"},"paths/~1balances~1{family}~1actions~1refresh/post/responses/403/content/application~1problem+json/examples/insufficient_permissions":{"value":{"type":"https://docs.vilna.io/apis/errors#forbidden","title":"Forbidden","status":403,"code":"unspecified","detail":"Your credentials are valid but don't include the permission this operation needs. Check the API key permissions in the dashboard. Permissions are set when the key is created and can't be edited later. To change them, create a new key.","instance":"/forbidden?method=createInvoice"},"key":"insufficient_permissions","summary":"The API key lacks the required permission","id":"paths/~1balances~1{family}~1actions~1refresh/post/responses/403/content/application~1problem+json/examples/insufficient_permissions"},"paths/~1balances~1{family}~1actions~1refresh/post/responses/404/content/application~1problem+json/examples/address_not_found":{"value":{"type":"https://docs.vilna.io/apis/errors#not-found","title":"Not Found","status":404,"code":"address.not_found","detail":"address not found","instance":"/traces/0123456789abcdef0123456789abcdef"},"key":"address_not_found","summary":"The address does not exist in this project","id":"paths/~1balances~1{family}~1actions~1refresh/post/responses/404/content/application~1problem+json/examples/address_not_found"},"paths/~1balances~1{family}~1actions~1refresh/post/responses/404/content/application~1problem+json/examples/invoice_not_found":{"value":{"type":"https://docs.vilna.io/apis/errors#not-found","title":"Not Found","status":404,"code":"invoice.not_found","detail":"invoice not found","instance":"/traces/0123456789abcdef0123456789abcdef"},"key":"invoice_not_found","summary":"The invoice does not exist in this project","id":"paths/~1balances~1{family}~1actions~1refresh/post/responses/404/content/application~1problem+json/examples/invoice_not_found"},"paths/~1balances~1{family}~1actions~1refresh/post/responses/409/content/application~1problem+json/examples/address_occupied":{"value":{"type":"https://docs.vilna.io/apis/errors#conflict","title":"Conflict","status":409,"code":"invoice.address_occupied","detail":"address already has an active invoice with different parameters","instance":"/traces/0123456789abcdef0123456789abcdef"},"key":"address_occupied","summary":"The address already has an active invoice","id":"paths/~1balances~1{family}~1actions~1refresh/post/responses/409/content/application~1problem+json/examples/address_occupied"},"paths/~1balances~1{family}~1actions~1refresh/post/responses/409/content/application~1problem+json/examples/address_in_use":{"value":{"type":"https://docs.vilna.io/apis/errors#conflict","title":"Conflict","status":409,"code":"address.in_use","detail":"address has an active invoice and cannot be deleted","instance":"/traces/0123456789abcdef0123456789abcdef"},"key":"address_in_use","summary":"The address cannot be deleted while in use","id":"paths/~1balances~1{family}~1actions~1refresh/post/responses/409/content/application~1problem+json/examples/address_in_use"},"paths/~1balances~1{family}~1actions~1refresh/post/responses/409/content/application~1problem+json/examples/subscription_v1_conflict":{"value":{"type":"https://docs.vilna.io/apis/errors#conflict","title":"Conflict","status":409,"code":"notification.subscription_v1_conflict","detail":"a subscription created through v1 accepts name and availability changes only","instance":"/traces/0123456789abcdef0123456789abcdef"},"key":"subscription_v1_conflict","summary":"A v1-created subscription rejects trigger, filter or noise changes","id":"paths/~1balances~1{family}~1actions~1refresh/post/responses/409/content/application~1problem+json/examples/subscription_v1_conflict"},"paths/~1balances~1{family}~1actions~1refresh/post/responses/409/content/application~1problem+json/examples/notification_send_in_progress":{"value":{"type":"https://docs.vilna.io/apis/errors#conflict","title":"Conflict","status":409,"code":"notification.send_in_progress","detail":"notification send is in progress","instance":"/traces/0123456789abcdef0123456789abcdef"},"key":"notification_send_in_progress","summary":"The notification already has a manual attempt queued or in flight","id":"paths/~1balances~1{family}~1actions~1refresh/post/responses/409/content/application~1problem+json/examples/notification_send_in_progress"},"paths/~1balances~1{family}~1actions~1refresh/post/responses/409/content/application~1problem+json/examples/notification_payload_unavailable":{"value":{"type":"https://docs.vilna.io/apis/errors#conflict","title":"Conflict","status":409,"code":"notification.payload_unavailable","detail":"notification payload is no longer available","instance":"/traces/0123456789abcdef0123456789abcdef"},"key":"notification_payload_unavailable","summary":"Retention has cleared the content, so there is nothing to resend","id":"paths/~1balances~1{family}~1actions~1refresh/post/responses/409/content/application~1problem+json/examples/notification_payload_unavailable"},"paths/~1balances~1{family}~1actions~1refresh/post/responses/409/content/application~1problem+json/examples/notification_test_resend_not_allowed":{"value":{"type":"https://docs.vilna.io/apis/errors#conflict","title":"Conflict","status":409,"code":"notification.test_resend_not_allowed","detail":"test notifications cannot be resent","instance":"/traces/0123456789abcdef0123456789abcdef"},"key":"notification_test_resend_not_allowed","summary":"The notification is a channel test","id":"paths/~1balances~1{family}~1actions~1refresh/post/responses/409/content/application~1problem+json/examples/notification_test_resend_not_allowed"},"paths/~1balances~1{family}~1actions~1refresh/post/responses/422/content/application~1problem+json/examples/invoice_not_cancellable":{"value":{"type":"https://docs.vilna.io/apis/errors#precondition","title":"Precondition Failed","status":422,"code":"invoice.not_cancellable","detail":"invoice cannot be cancelled in current status","instance":"/traces/0123456789abcdef0123456789abcdef","fields":[{"name":"status","reason":"confirmed"}]},"key":"invoice_not_cancellable","summary":"A confirmed invoice cannot be cancelled","id":"paths/~1balances~1{family}~1actions~1refresh/post/responses/422/content/application~1problem+json/examples/invoice_not_cancellable"},"paths/~1balances~1{family}~1actions~1refresh/post/responses/429/content/application~1problem+json/examples/refresh_window_full":{"value":{"type":"https://docs.vilna.io/apis/errors#too-many-requests","title":"Too Many Requests","status":429,"code":"balance.refresh_rate_exceeded","detail":"the project has reached its balance refresh rate limit","max":1,"window_seconds":60},"key":"refresh_window_full","summary":"The project's rolling refresh window is full","id":"paths/~1balances~1{family}~1actions~1refresh/post/responses/429/content/application~1problem+json/examples/refresh_window_full"},"paths/~1balances~1{family}~1actions~1refresh/post/responses/429/content/application~1problem+json/examples/refresh_prohibited":{"value":{"type":"https://docs.vilna.io/apis/errors#too-many-requests","title":"Too Many Requests","status":429,"code":"balance.refresh_rate_exceeded","detail":"the project has reached its balance refresh rate limit","max":0,"window_seconds":60},"key":"refresh_prohibited","summary":"A zero limit prohibits refresh and has no Retry-After","id":"paths/~1balances~1{family}~1actions~1refresh/post/responses/429/content/application~1problem+json/examples/refresh_prohibited"},"paths/~1balances~1{family}~1actions~1refresh/post/responses/503/content/application~1problem+json/examples/temporarily_unavailable":{"value":{"type":"https://docs.vilna.io/apis/errors#service-unavailable","title":"Service Unavailable","status":503,"code":"service.temporarily_unavailable","detail":"The operation is temporarily unavailable. Please try again later."},"key":"temporarily_unavailable","summary":"The operation cannot be completed at present","id":"paths/~1balances~1{family}~1actions~1refresh/post/responses/503/content/application~1problem+json/examples/temporarily_unavailable"},"paths/~1public-keys~1{public_key_id}~1addresses/get/responses/400/content/application~1problem+json/examples/malformed_json":{"value":{"type":"https://docs.vilna.io/apis/errors#invalid-request","title":"Invalid Request","status":400,"code":"request.malformed","detail":"The request could not be decoded.","instance":"/traces/0123456789abcdef0123456789abcdef"},"key":"malformed_json","summary":"The request body contains malformed JSON","id":"paths/~1public-keys~1{public_key_id}~1addresses/get/responses/400/content/application~1problem+json/examples/malformed_json"},"paths/~1public-keys~1{public_key_id}~1addresses/get/responses/401/content/application~1problem+json/examples/service_authentication_denied":{"value":{"type":"https://docs.vilna.io/apis/errors#unauthorized","title":"Unauthorized","status":401,"code":"unspecified","detail":"You are not authorized to access this resource. If the problem persists, please contact our support team.","instance":"/unauthorized?method=createInvoice"},"key":"service_authentication_denied","summary":"The API service refused authentication","id":"paths/~1public-keys~1{public_key_id}~1addresses/get/responses/401/content/application~1problem+json/examples/service_authentication_denied"},"paths/~1public-keys~1{public_key_id}~1addresses/get/responses/403/content/application~1problem+json/examples/insufficient_permissions":{"value":{"type":"https://docs.vilna.io/apis/errors#forbidden","title":"Forbidden","status":403,"code":"unspecified","detail":"Your credentials are valid but don't include the permission this operation needs. Check the API key permissions in the dashboard. Permissions are set when the key is created and can't be edited later. To change them, create a new key.","instance":"/forbidden?method=createInvoice"},"key":"insufficient_permissions","summary":"The API key lacks the required permission","id":"paths/~1public-keys~1{public_key_id}~1addresses/get/responses/403/content/application~1problem+json/examples/insufficient_permissions"},"paths/~1public-keys~1{public_key_id}~1addresses/get/responses/404/content/application~1problem+json/examples/address_not_found":{"value":{"type":"https://docs.vilna.io/apis/errors#not-found","title":"Not Found","status":404,"code":"address.not_found","detail":"address not found","instance":"/traces/0123456789abcdef0123456789abcdef"},"key":"address_not_found","summary":"The address does not exist in this project","id":"paths/~1public-keys~1{public_key_id}~1addresses/get/responses/404/content/application~1problem+json/examples/address_not_found"},"paths/~1public-keys~1{public_key_id}~1addresses/get/responses/404/content/application~1problem+json/examples/invoice_not_found":{"value":{"type":"https://docs.vilna.io/apis/errors#not-found","title":"Not Found","status":404,"code":"invoice.not_found","detail":"invoice not found","instance":"/traces/0123456789abcdef0123456789abcdef"},"key":"invoice_not_found","summary":"The invoice does not exist in this project","id":"paths/~1public-keys~1{public_key_id}~1addresses/get/responses/404/content/application~1problem+json/examples/invoice_not_found"},"paths/~1public-keys~1{public_key_id}~1addresses/get/responses/503/content/application~1problem+json/examples/temporarily_unavailable":{"value":{"type":"https://docs.vilna.io/apis/errors#service-unavailable","title":"Service Unavailable","status":503,"code":"service.temporarily_unavailable","detail":"The operation is temporarily unavailable. Please try again later."},"key":"temporarily_unavailable","summary":"The operation cannot be completed at present","id":"paths/~1public-keys~1{public_key_id}~1addresses/get/responses/503/content/application~1problem+json/examples/temporarily_unavailable"},"paths/~1public-keys~1{public_key_id}~1addresses/post/requestBody/content/application~1json/examples/next_address":{"value":{"chain_family":"evm","selection":{"kind":"next"},"meta":{"user_id":"100","type":"deposit"}},"key":"next_address","summary":"Generate the next unused address","id":"paths/~1public-keys~1{public_key_id}~1addresses/post/requestBody/content/application~1json/examples/next_address"},"paths/~1public-keys~1{public_key_id}~1addresses/post/requestBody/content/application~1json/examples/index_range":{"value":{"chain_family":"evm","selection":{"kind":"range","start_index":100,"count":50}},"key":"index_range","summary":"Generate a range of addresses","id":"paths/~1public-keys~1{public_key_id}~1addresses/post/requestBody/content/application~1json/examples/index_range"},"paths/~1public-keys~1{public_key_id}~1addresses/post/responses/400/content/application~1problem+json/examples/malformed_json":{"value":{"type":"https://docs.vilna.io/apis/errors#invalid-request","title":"Invalid Request","status":400,"code":"request.malformed","detail":"The request could not be decoded.","instance":"/traces/0123456789abcdef0123456789abcdef"},"key":"malformed_json","summary":"The request body contains malformed JSON","id":"paths/~1public-keys~1{public_key_id}~1addresses/post/responses/400/content/application~1problem+json/examples/malformed_json"},"paths/~1public-keys~1{public_key_id}~1addresses/post/responses/401/content/application~1problem+json/examples/service_authentication_denied":{"value":{"type":"https://docs.vilna.io/apis/errors#unauthorized","title":"Unauthorized","status":401,"code":"unspecified","detail":"You are not authorized to access this resource. If the problem persists, please contact our support team.","instance":"/unauthorized?method=createInvoice"},"key":"service_authentication_denied","summary":"The API service refused authentication","id":"paths/~1public-keys~1{public_key_id}~1addresses/post/responses/401/content/application~1problem+json/examples/service_authentication_denied"},"paths/~1public-keys~1{public_key_id}~1addresses/post/responses/403/content/application~1problem+json/examples/insufficient_permissions":{"value":{"type":"https://docs.vilna.io/apis/errors#forbidden","title":"Forbidden","status":403,"code":"unspecified","detail":"Your credentials are valid but don't include the permission this operation needs. Check the API key permissions in the dashboard. Permissions are set when the key is created and can't be edited later. To change them, create a new key.","instance":"/forbidden?method=createInvoice"},"key":"insufficient_permissions","summary":"The API key lacks the required permission","id":"paths/~1public-keys~1{public_key_id}~1addresses/post/responses/403/content/application~1problem+json/examples/insufficient_permissions"},"paths/~1public-keys~1{public_key_id}~1addresses/post/responses/404/content/application~1problem+json/examples/address_not_found":{"value":{"type":"https://docs.vilna.io/apis/errors#not-found","title":"Not Found","status":404,"code":"address.not_found","detail":"address not found","instance":"/traces/0123456789abcdef0123456789abcdef"},"key":"address_not_found","summary":"The address does not exist in this project","id":"paths/~1public-keys~1{public_key_id}~1addresses/post/responses/404/content/application~1problem+json/examples/address_not_found"},"paths/~1public-keys~1{public_key_id}~1addresses/post/responses/404/content/application~1problem+json/examples/invoice_not_found":{"value":{"type":"https://docs.vilna.io/apis/errors#not-found","title":"Not Found","status":404,"code":"invoice.not_found","detail":"invoice not found","instance":"/traces/0123456789abcdef0123456789abcdef"},"key":"invoice_not_found","summary":"The invoice does not exist in this project","id":"paths/~1public-keys~1{public_key_id}~1addresses/post/responses/404/content/application~1problem+json/examples/invoice_not_found"},"paths/~1public-keys~1{public_key_id}~1addresses/post/responses/409/content/application~1problem+json/examples/address_occupied":{"value":{"type":"https://docs.vilna.io/apis/errors#conflict","title":"Conflict","status":409,"code":"invoice.address_occupied","detail":"address already has an active invoice with different parameters","instance":"/traces/0123456789abcdef0123456789abcdef"},"key":"address_occupied","summary":"The address already has an active invoice","id":"paths/~1public-keys~1{public_key_id}~1addresses/post/responses/409/content/application~1problem+json/examples/address_occupied"},"paths/~1public-keys~1{public_key_id}~1addresses/post/responses/409/content/application~1problem+json/examples/address_in_use":{"value":{"type":"https://docs.vilna.io/apis/errors#conflict","title":"Conflict","status":409,"code":"address.in_use","detail":"address has an active invoice and cannot be deleted","instance":"/traces/0123456789abcdef0123456789abcdef"},"key":"address_in_use","summary":"The address cannot be deleted while in use","id":"paths/~1public-keys~1{public_key_id}~1addresses/post/responses/409/content/application~1problem+json/examples/address_in_use"},"paths/~1public-keys~1{public_key_id}~1addresses/post/responses/409/content/application~1problem+json/examples/subscription_v1_conflict":{"value":{"type":"https://docs.vilna.io/apis/errors#conflict","title":"Conflict","status":409,"code":"notification.subscription_v1_conflict","detail":"a subscription created through v1 accepts name and availability changes only","instance":"/traces/0123456789abcdef0123456789abcdef"},"key":"subscription_v1_conflict","summary":"A v1-created subscription rejects trigger, filter or noise changes","id":"paths/~1public-keys~1{public_key_id}~1addresses/post/responses/409/content/application~1problem+json/examples/subscription_v1_conflict"},"paths/~1public-keys~1{public_key_id}~1addresses/post/responses/409/content/application~1problem+json/examples/notification_send_in_progress":{"value":{"type":"https://docs.vilna.io/apis/errors#conflict","title":"Conflict","status":409,"code":"notification.send_in_progress","detail":"notification send is in progress","instance":"/traces/0123456789abcdef0123456789abcdef"},"key":"notification_send_in_progress","summary":"The notification already has a manual attempt queued or in flight","id":"paths/~1public-keys~1{public_key_id}~1addresses/post/responses/409/content/application~1problem+json/examples/notification_send_in_progress"},"paths/~1public-keys~1{public_key_id}~1addresses/post/responses/409/content/application~1problem+json/examples/notification_payload_unavailable":{"value":{"type":"https://docs.vilna.io/apis/errors#conflict","title":"Conflict","status":409,"code":"notification.payload_unavailable","detail":"notification payload is no longer available","instance":"/traces/0123456789abcdef0123456789abcdef"},"key":"notification_payload_unavailable","summary":"Retention has cleared the content, so there is nothing to resend","id":"paths/~1public-keys~1{public_key_id}~1addresses/post/responses/409/content/application~1problem+json/examples/notification_payload_unavailable"},"paths/~1public-keys~1{public_key_id}~1addresses/post/responses/409/content/application~1problem+json/examples/notification_test_resend_not_allowed":{"value":{"type":"https://docs.vilna.io/apis/errors#conflict","title":"Conflict","status":409,"code":"notification.test_resend_not_allowed","detail":"test notifications cannot be resent","instance":"/traces/0123456789abcdef0123456789abcdef"},"key":"notification_test_resend_not_allowed","summary":"The notification is a channel test","id":"paths/~1public-keys~1{public_key_id}~1addresses/post/responses/409/content/application~1problem+json/examples/notification_test_resend_not_allowed"},"paths/~1public-keys~1{public_key_id}~1addresses/post/responses/422/content/application~1problem+json/examples/invoice_not_cancellable":{"value":{"type":"https://docs.vilna.io/apis/errors#precondition","title":"Precondition Failed","status":422,"code":"invoice.not_cancellable","detail":"invoice cannot be cancelled in current status","instance":"/traces/0123456789abcdef0123456789abcdef","fields":[{"name":"status","reason":"confirmed"}]},"key":"invoice_not_cancellable","summary":"A confirmed invoice cannot be cancelled","id":"paths/~1public-keys~1{public_key_id}~1addresses/post/responses/422/content/application~1problem+json/examples/invoice_not_cancellable"},"paths/~1public-keys~1{public_key_id}~1addresses/post/responses/429/content/application~1problem+json/examples/address_quota":{"value":{"type":"https://docs.vilna.io/apis/errors#too-many-requests","title":"Too Many Requests","status":429,"code":"address.quota_exceeded","detail":"the project has reached its address limit","max":100},"key":"address_quota","summary":"The project has reached its address quota","id":"paths/~1public-keys~1{public_key_id}~1addresses/post/responses/429/content/application~1problem+json/examples/address_quota"},"paths/~1public-keys~1{public_key_id}~1addresses/post/responses/429/content/application~1problem+json/examples/creation_prohibited":{"value":{"type":"https://docs.vilna.io/apis/errors#too-many-requests","title":"Too Many Requests","status":429,"code":"channel.quota_exceeded","detail":"the project has reached its channel limit","max":0},"key":"creation_prohibited","summary":"A zero effective limit prohibits new resources","id":"paths/~1public-keys~1{public_key_id}~1addresses/post/responses/429/content/application~1problem+json/examples/creation_prohibited"},"paths/~1public-keys~1{public_key_id}~1addresses/post/responses/503/content/application~1problem+json/examples/temporarily_unavailable":{"value":{"type":"https://docs.vilna.io/apis/errors#service-unavailable","title":"Service Unavailable","status":503,"code":"service.temporarily_unavailable","detail":"The operation is temporarily unavailable. Please try again later."},"key":"temporarily_unavailable","summary":"The operation cannot be completed at present","id":"paths/~1public-keys~1{public_key_id}~1addresses/post/responses/503/content/application~1problem+json/examples/temporarily_unavailable"},"paths/~1addresses/get/responses/400/content/application~1problem+json/examples/malformed_json":{"value":{"type":"https://docs.vilna.io/apis/errors#invalid-request","title":"Invalid Request","status":400,"code":"request.malformed","detail":"The request could not be decoded.","instance":"/traces/0123456789abcdef0123456789abcdef"},"key":"malformed_json","summary":"The request body contains malformed JSON","id":"paths/~1addresses/get/responses/400/content/application~1problem+json/examples/malformed_json"},"paths/~1addresses/get/responses/401/content/application~1problem+json/examples/service_authentication_denied":{"value":{"type":"https://docs.vilna.io/apis/errors#unauthorized","title":"Unauthorized","status":401,"code":"unspecified","detail":"You are not authorized to access this resource. If the problem persists, please contact our support team.","instance":"/unauthorized?method=createInvoice"},"key":"service_authentication_denied","summary":"The API service refused authentication","id":"paths/~1addresses/get/responses/401/content/application~1problem+json/examples/service_authentication_denied"},"paths/~1addresses/get/responses/403/content/application~1problem+json/examples/insufficient_permissions":{"value":{"type":"https://docs.vilna.io/apis/errors#forbidden","title":"Forbidden","status":403,"code":"unspecified","detail":"Your credentials are valid but don't include the permission this operation needs. Check the API key permissions in the dashboard. Permissions are set when the key is created and can't be edited later. To change them, create a new key.","instance":"/forbidden?method=createInvoice"},"key":"insufficient_permissions","summary":"The API key lacks the required permission","id":"paths/~1addresses/get/responses/403/content/application~1problem+json/examples/insufficient_permissions"},"paths/~1addresses/get/responses/503/content/application~1problem+json/examples/temporarily_unavailable":{"value":{"type":"https://docs.vilna.io/apis/errors#service-unavailable","title":"Service Unavailable","status":503,"code":"service.temporarily_unavailable","detail":"The operation is temporarily unavailable. Please try again later."},"key":"temporarily_unavailable","summary":"The operation cannot be completed at present","id":"paths/~1addresses/get/responses/503/content/application~1problem+json/examples/temporarily_unavailable"},"paths/~1addresses~1external/post/requestBody/content/application~1json/examples/from_address":{"value":{"input":{"source":"address","value":"0xCa79F73628E5D46Cc2c0F6CcD3a3F934d3cE66B7","chain_family":"evm"},"label":"cold_wallet"},"key":"from_address","summary":"Import an address","id":"paths/~1addresses~1external/post/requestBody/content/application~1json/examples/from_address"},"paths/~1addresses~1external/post/requestBody/content/application~1json/examples/from_public_key":{"value":{"input":{"source":"public_key","public_key":"02c6047f9441ed7d6d3045406e95c07cd85c778e4b8cef3ca7abac09b95c709ee5","address_format":"evm"},"label":"cold_wallet"},"key":"from_public_key","summary":"Import the address a public key derives to","id":"paths/~1addresses~1external/post/requestBody/content/application~1json/examples/from_public_key"},"paths/~1addresses~1external/post/responses/400/content/application~1problem+json/examples/malformed_json":{"value":{"type":"https://docs.vilna.io/apis/errors#invalid-request","title":"Invalid Request","status":400,"code":"request.malformed","detail":"The request could not be decoded.","instance":"/traces/0123456789abcdef0123456789abcdef"},"key":"malformed_json","summary":"The request body contains malformed JSON","id":"paths/~1addresses~1external/post/responses/400/content/application~1problem+json/examples/malformed_json"},"paths/~1addresses~1external/post/responses/401/content/application~1problem+json/examples/service_authentication_denied":{"value":{"type":"https://docs.vilna.io/apis/errors#unauthorized","title":"Unauthorized","status":401,"code":"unspecified","detail":"You are not authorized to access this resource. If the problem persists, please contact our support team.","instance":"/unauthorized?method=createInvoice"},"key":"service_authentication_denied","summary":"The API service refused authentication","id":"paths/~1addresses~1external/post/responses/401/content/application~1problem+json/examples/service_authentication_denied"},"paths/~1addresses~1external/post/responses/403/content/application~1problem+json/examples/insufficient_permissions":{"value":{"type":"https://docs.vilna.io/apis/errors#forbidden","title":"Forbidden","status":403,"code":"unspecified","detail":"Your credentials are valid but don't include the permission this operation needs. Check the API key permissions in the dashboard. Permissions are set when the key is created and can't be edited later. To change them, create a new key.","instance":"/forbidden?method=createInvoice"},"key":"insufficient_permissions","summary":"The API key lacks the required permission","id":"paths/~1addresses~1external/post/responses/403/content/application~1problem+json/examples/insufficient_permissions"},"paths/~1addresses~1external/post/responses/409/content/application~1problem+json/examples/address_occupied":{"value":{"type":"https://docs.vilna.io/apis/errors#conflict","title":"Conflict","status":409,"code":"invoice.address_occupied","detail":"address already has an active invoice with different parameters","instance":"/traces/0123456789abcdef0123456789abcdef"},"key":"address_occupied","summary":"The address already has an active invoice","id":"paths/~1addresses~1external/post/responses/409/content/application~1problem+json/examples/address_occupied"},"paths/~1addresses~1external/post/responses/409/content/application~1problem+json/examples/address_in_use":{"value":{"type":"https://docs.vilna.io/apis/errors#conflict","title":"Conflict","status":409,"code":"address.in_use","detail":"address has an active invoice and cannot be deleted","instance":"/traces/0123456789abcdef0123456789abcdef"},"key":"address_in_use","summary":"The address cannot be deleted while in use","id":"paths/~1addresses~1external/post/responses/409/content/application~1problem+json/examples/address_in_use"},"paths/~1addresses~1external/post/responses/409/content/application~1problem+json/examples/subscription_v1_conflict":{"value":{"type":"https://docs.vilna.io/apis/errors#conflict","title":"Conflict","status":409,"code":"notification.subscription_v1_conflict","detail":"a subscription created through v1 accepts name and availability changes only","instance":"/traces/0123456789abcdef0123456789abcdef"},"key":"subscription_v1_conflict","summary":"A v1-created subscription rejects trigger, filter or noise changes","id":"paths/~1addresses~1external/post/responses/409/content/application~1problem+json/examples/subscription_v1_conflict"},"paths/~1addresses~1external/post/responses/409/content/application~1problem+json/examples/notification_send_in_progress":{"value":{"type":"https://docs.vilna.io/apis/errors#conflict","title":"Conflict","status":409,"code":"notification.send_in_progress","detail":"notification send is in progress","instance":"/traces/0123456789abcdef0123456789abcdef"},"key":"notification_send_in_progress","summary":"The notification already has a manual attempt queued or in flight","id":"paths/~1addresses~1external/post/responses/409/content/application~1problem+json/examples/notification_send_in_progress"},"paths/~1addresses~1external/post/responses/409/content/application~1problem+json/examples/notification_payload_unavailable":{"value":{"type":"https://docs.vilna.io/apis/errors#conflict","title":"Conflict","status":409,"code":"notification.payload_unavailable","detail":"notification payload is no longer available","instance":"/traces/0123456789abcdef0123456789abcdef"},"key":"notification_payload_unavailable","summary":"Retention has cleared the content, so there is nothing to resend","id":"paths/~1addresses~1external/post/responses/409/content/application~1problem+json/examples/notification_payload_unavailable"},"paths/~1addresses~1external/post/responses/409/content/application~1problem+json/examples/notification_test_resend_not_allowed":{"value":{"type":"https://docs.vilna.io/apis/errors#conflict","title":"Conflict","status":409,"code":"notification.test_resend_not_allowed","detail":"test notifications cannot be resent","instance":"/traces/0123456789abcdef0123456789abcdef"},"key":"notification_test_resend_not_allowed","summary":"The notification is a channel test","id":"paths/~1addresses~1external/post/responses/409/content/application~1problem+json/examples/notification_test_resend_not_allowed"},"paths/~1addresses~1external/post/responses/429/content/application~1problem+json/examples/address_quota":{"value":{"type":"https://docs.vilna.io/apis/errors#too-many-requests","title":"Too Many Requests","status":429,"code":"address.quota_exceeded","detail":"the project has reached its address limit","max":100},"key":"address_quota","summary":"The project has reached its address quota","id":"paths/~1addresses~1external/post/responses/429/content/application~1problem+json/examples/address_quota"},"paths/~1addresses~1external/post/responses/429/content/application~1problem+json/examples/creation_prohibited":{"value":{"type":"https://docs.vilna.io/apis/errors#too-many-requests","title":"Too Many Requests","status":429,"code":"channel.quota_exceeded","detail":"the project has reached its channel limit","max":0},"key":"creation_prohibited","summary":"A zero effective limit prohibits new resources","id":"paths/~1addresses~1external/post/responses/429/content/application~1problem+json/examples/creation_prohibited"},"paths/~1addresses~1external/post/responses/503/content/application~1problem+json/examples/temporarily_unavailable":{"value":{"type":"https://docs.vilna.io/apis/errors#service-unavailable","title":"Service Unavailable","status":503,"code":"service.temporarily_unavailable","detail":"The operation is temporarily unavailable. Please try again later."},"key":"temporarily_unavailable","summary":"The operation cannot be completed at present","id":"paths/~1addresses~1external/post/responses/503/content/application~1problem+json/examples/temporarily_unavailable"},"paths/~1addresses~1hd/get/responses/400/content/application~1problem+json/examples/malformed_json":{"value":{"type":"https://docs.vilna.io/apis/errors#invalid-request","title":"Invalid Request","status":400,"code":"request.malformed","detail":"The request could not be decoded.","instance":"/traces/0123456789abcdef0123456789abcdef"},"key":"malformed_json","summary":"The request body contains malformed JSON","id":"paths/~1addresses~1hd/get/responses/400/content/application~1problem+json/examples/malformed_json"},"paths/~1addresses~1hd/get/responses/401/content/application~1problem+json/examples/service_authentication_denied":{"value":{"type":"https://docs.vilna.io/apis/errors#unauthorized","title":"Unauthorized","status":401,"code":"unspecified","detail":"You are not authorized to access this resource. If the problem persists, please contact our support team.","instance":"/unauthorized?method=createInvoice"},"key":"service_authentication_denied","summary":"The API service refused authentication","id":"paths/~1addresses~1hd/get/responses/401/content/application~1problem+json/examples/service_authentication_denied"},"paths/~1addresses~1hd/get/responses/403/content/application~1problem+json/examples/insufficient_permissions":{"value":{"type":"https://docs.vilna.io/apis/errors#forbidden","title":"Forbidden","status":403,"code":"unspecified","detail":"Your credentials are valid but don't include the permission this operation needs. Check the API key permissions in the dashboard. Permissions are set when the key is created and can't be edited later. To change them, create a new key.","instance":"/forbidden?method=createInvoice"},"key":"insufficient_permissions","summary":"The API key lacks the required permission","id":"paths/~1addresses~1hd/get/responses/403/content/application~1problem+json/examples/insufficient_permissions"},"paths/~1addresses~1hd/get/responses/503/content/application~1problem+json/examples/temporarily_unavailable":{"value":{"type":"https://docs.vilna.io/apis/errors#service-unavailable","title":"Service Unavailable","status":503,"code":"service.temporarily_unavailable","detail":"The operation is temporarily unavailable. Please try again later."},"key":"temporarily_unavailable","summary":"The operation cannot be completed at present","id":"paths/~1addresses~1hd/get/responses/503/content/application~1problem+json/examples/temporarily_unavailable"},"paths/~1addresses~1{address}/delete/responses/400/content/application~1problem+json/examples/malformed_json":{"value":{"type":"https://docs.vilna.io/apis/errors#invalid-request","title":"Invalid Request","status":400,"code":"request.malformed","detail":"The request could not be decoded.","instance":"/traces/0123456789abcdef0123456789abcdef"},"key":"malformed_json","summary":"The request body contains malformed JSON","id":"paths/~1addresses~1{address}/delete/responses/400/content/application~1problem+json/examples/malformed_json"},"paths/~1addresses~1{address}/delete/responses/401/content/application~1problem+json/examples/service_authentication_denied":{"value":{"type":"https://docs.vilna.io/apis/errors#unauthorized","title":"Unauthorized","status":401,"code":"unspecified","detail":"You are not authorized to access this resource. If the problem persists, please contact our support team.","instance":"/unauthorized?method=createInvoice"},"key":"service_authentication_denied","summary":"The API service refused authentication","id":"paths/~1addresses~1{address}/delete/responses/401/content/application~1problem+json/examples/service_authentication_denied"},"paths/~1addresses~1{address}/delete/responses/403/content/application~1problem+json/examples/insufficient_permissions":{"value":{"type":"https://docs.vilna.io/apis/errors#forbidden","title":"Forbidden","status":403,"code":"unspecified","detail":"Your credentials are valid but don't include the permission this operation needs. Check the API key permissions in the dashboard. Permissions are set when the key is created and can't be edited later. To change them, create a new key.","instance":"/forbidden?method=createInvoice"},"key":"insufficient_permissions","summary":"The API key lacks the required permission","id":"paths/~1addresses~1{address}/delete/responses/403/content/application~1problem+json/examples/insufficient_permissions"},"paths/~1addresses~1{address}/delete/responses/404/content/application~1problem+json/examples/address_not_found":{"value":{"type":"https://docs.vilna.io/apis/errors#not-found","title":"Not Found","status":404,"code":"address.not_found","detail":"address not found","instance":"/traces/0123456789abcdef0123456789abcdef"},"key":"address_not_found","summary":"The address does not exist in this project","id":"paths/~1addresses~1{address}/delete/responses/404/content/application~1problem+json/examples/address_not_found"},"paths/~1addresses~1{address}/delete/responses/404/content/application~1problem+json/examples/invoice_not_found":{"value":{"type":"https://docs.vilna.io/apis/errors#not-found","title":"Not Found","status":404,"code":"invoice.not_found","detail":"invoice not found","instance":"/traces/0123456789abcdef0123456789abcdef"},"key":"invoice_not_found","summary":"The invoice does not exist in this project","id":"paths/~1addresses~1{address}/delete/responses/404/content/application~1problem+json/examples/invoice_not_found"},"paths/~1addresses~1{address}/delete/responses/409/content/application~1problem+json/examples/address_occupied":{"value":{"type":"https://docs.vilna.io/apis/errors#conflict","title":"Conflict","status":409,"code":"invoice.address_occupied","detail":"address already has an active invoice with different parameters","instance":"/traces/0123456789abcdef0123456789abcdef"},"key":"address_occupied","summary":"The address already has an active invoice","id":"paths/~1addresses~1{address}/delete/responses/409/content/application~1problem+json/examples/address_occupied"},"paths/~1addresses~1{address}/delete/responses/409/content/application~1problem+json/examples/address_in_use":{"value":{"type":"https://docs.vilna.io/apis/errors#conflict","title":"Conflict","status":409,"code":"address.in_use","detail":"address has an active invoice and cannot be deleted","instance":"/traces/0123456789abcdef0123456789abcdef"},"key":"address_in_use","summary":"The address cannot be deleted while in use","id":"paths/~1addresses~1{address}/delete/responses/409/content/application~1problem+json/examples/address_in_use"},"paths/~1addresses~1{address}/delete/responses/409/content/application~1problem+json/examples/subscription_v1_conflict":{"value":{"type":"https://docs.vilna.io/apis/errors#conflict","title":"Conflict","status":409,"code":"notification.subscription_v1_conflict","detail":"a subscription created through v1 accepts name and availability changes only","instance":"/traces/0123456789abcdef0123456789abcdef"},"key":"subscription_v1_conflict","summary":"A v1-created subscription rejects trigger, filter or noise changes","id":"paths/~1addresses~1{address}/delete/responses/409/content/application~1problem+json/examples/subscription_v1_conflict"},"paths/~1addresses~1{address}/delete/responses/409/content/application~1problem+json/examples/notification_send_in_progress":{"value":{"type":"https://docs.vilna.io/apis/errors#conflict","title":"Conflict","status":409,"code":"notification.send_in_progress","detail":"notification send is in progress","instance":"/traces/0123456789abcdef0123456789abcdef"},"key":"notification_send_in_progress","summary":"The notification already has a manual attempt queued or in flight","id":"paths/~1addresses~1{address}/delete/responses/409/content/application~1problem+json/examples/notification_send_in_progress"},"paths/~1addresses~1{address}/delete/responses/409/content/application~1problem+json/examples/notification_payload_unavailable":{"value":{"type":"https://docs.vilna.io/apis/errors#conflict","title":"Conflict","status":409,"code":"notification.payload_unavailable","detail":"notification payload is no longer available","instance":"/traces/0123456789abcdef0123456789abcdef"},"key":"notification_payload_unavailable","summary":"Retention has cleared the content, so there is nothing to resend","id":"paths/~1addresses~1{address}/delete/responses/409/content/application~1problem+json/examples/notification_payload_unavailable"},"paths/~1addresses~1{address}/delete/responses/409/content/application~1problem+json/examples/notification_test_resend_not_allowed":{"value":{"type":"https://docs.vilna.io/apis/errors#conflict","title":"Conflict","status":409,"code":"notification.test_resend_not_allowed","detail":"test notifications cannot be resent","instance":"/traces/0123456789abcdef0123456789abcdef"},"key":"notification_test_resend_not_allowed","summary":"The notification is a channel test","id":"paths/~1addresses~1{address}/delete/responses/409/content/application~1problem+json/examples/notification_test_resend_not_allowed"},"paths/~1addresses~1{address}/delete/responses/503/content/application~1problem+json/examples/temporarily_unavailable":{"value":{"type":"https://docs.vilna.io/apis/errors#service-unavailable","title":"Service Unavailable","status":503,"code":"service.temporarily_unavailable","detail":"The operation is temporarily unavailable. Please try again later."},"key":"temporarily_unavailable","summary":"The operation cannot be completed at present","id":"paths/~1addresses~1{address}/delete/responses/503/content/application~1problem+json/examples/temporarily_unavailable"},"paths/~1addresses~1{address}/get/responses/400/content/application~1problem+json/examples/malformed_json":{"value":{"type":"https://docs.vilna.io/apis/errors#invalid-request","title":"Invalid Request","status":400,"code":"request.malformed","detail":"The request could not be decoded.","instance":"/traces/0123456789abcdef0123456789abcdef"},"key":"malformed_json","summary":"The request body contains malformed JSON","id":"paths/~1addresses~1{address}/get/responses/400/content/application~1problem+json/examples/malformed_json"},"paths/~1addresses~1{address}/get/responses/401/content/application~1problem+json/examples/service_authentication_denied":{"value":{"type":"https://docs.vilna.io/apis/errors#unauthorized","title":"Unauthorized","status":401,"code":"unspecified","detail":"You are not authorized to access this resource. If the problem persists, please contact our support team.","instance":"/unauthorized?method=createInvoice"},"key":"service_authentication_denied","summary":"The API service refused authentication","id":"paths/~1addresses~1{address}/get/responses/401/content/application~1problem+json/examples/service_authentication_denied"},"paths/~1addresses~1{address}/get/responses/403/content/application~1problem+json/examples/insufficient_permissions":{"value":{"type":"https://docs.vilna.io/apis/errors#forbidden","title":"Forbidden","status":403,"code":"unspecified","detail":"Your credentials are valid but don't include the permission this operation needs. Check the API key permissions in the dashboard. Permissions are set when the key is created and can't be edited later. To change them, create a new key.","instance":"/forbidden?method=createInvoice"},"key":"insufficient_permissions","summary":"The API key lacks the required permission","id":"paths/~1addresses~1{address}/get/responses/403/content/application~1problem+json/examples/insufficient_permissions"},"paths/~1addresses~1{address}/get/responses/404/content/application~1problem+json/examples/address_not_found":{"value":{"type":"https://docs.vilna.io/apis/errors#not-found","title":"Not Found","status":404,"code":"address.not_found","detail":"address not found","instance":"/traces/0123456789abcdef0123456789abcdef"},"key":"address_not_found","summary":"The address does not exist in this project","id":"paths/~1addresses~1{address}/get/responses/404/content/application~1problem+json/examples/address_not_found"},"paths/~1addresses~1{address}/get/responses/404/content/application~1problem+json/examples/invoice_not_found":{"value":{"type":"https://docs.vilna.io/apis/errors#not-found","title":"Not Found","status":404,"code":"invoice.not_found","detail":"invoice not found","instance":"/traces/0123456789abcdef0123456789abcdef"},"key":"invoice_not_found","summary":"The invoice does not exist in this project","id":"paths/~1addresses~1{address}/get/responses/404/content/application~1problem+json/examples/invoice_not_found"},"paths/~1addresses~1{address}/get/responses/503/content/application~1problem+json/examples/temporarily_unavailable":{"value":{"type":"https://docs.vilna.io/apis/errors#service-unavailable","title":"Service Unavailable","status":503,"code":"service.temporarily_unavailable","detail":"The operation is temporarily unavailable. Please try again later."},"key":"temporarily_unavailable","summary":"The operation cannot be completed at present","id":"paths/~1addresses~1{address}/get/responses/503/content/application~1problem+json/examples/temporarily_unavailable"},"paths/~1addresses~1{address}/patch/responses/400/content/application~1problem+json/examples/malformed_json":{"value":{"type":"https://docs.vilna.io/apis/errors#invalid-request","title":"Invalid Request","status":400,"code":"request.malformed","detail":"The request could not be decoded.","instance":"/traces/0123456789abcdef0123456789abcdef"},"key":"malformed_json","summary":"The request body contains malformed JSON","id":"paths/~1addresses~1{address}/patch/responses/400/content/application~1problem+json/examples/malformed_json"},"paths/~1addresses~1{address}/patch/responses/401/content/application~1problem+json/examples/service_authentication_denied":{"value":{"type":"https://docs.vilna.io/apis/errors#unauthorized","title":"Unauthorized","status":401,"code":"unspecified","detail":"You are not authorized to access this resource. If the problem persists, please contact our support team.","instance":"/unauthorized?method=createInvoice"},"key":"service_authentication_denied","summary":"The API service refused authentication","id":"paths/~1addresses~1{address}/patch/responses/401/content/application~1problem+json/examples/service_authentication_denied"},"paths/~1addresses~1{address}/patch/responses/403/content/application~1problem+json/examples/insufficient_permissions":{"value":{"type":"https://docs.vilna.io/apis/errors#forbidden","title":"Forbidden","status":403,"code":"unspecified","detail":"Your credentials are valid but don't include the permission this operation needs. Check the API key permissions in the dashboard. Permissions are set when the key is created and can't be edited later. To change them, create a new key.","instance":"/forbidden?method=createInvoice"},"key":"insufficient_permissions","summary":"The API key lacks the required permission","id":"paths/~1addresses~1{address}/patch/responses/403/content/application~1problem+json/examples/insufficient_permissions"},"paths/~1addresses~1{address}/patch/responses/404/content/application~1problem+json/examples/address_not_found":{"value":{"type":"https://docs.vilna.io/apis/errors#not-found","title":"Not Found","status":404,"code":"address.not_found","detail":"address not found","instance":"/traces/0123456789abcdef0123456789abcdef"},"key":"address_not_found","summary":"The address does not exist in this project","id":"paths/~1addresses~1{address}/patch/responses/404/content/application~1problem+json/examples/address_not_found"},"paths/~1addresses~1{address}/patch/responses/404/content/application~1problem+json/examples/invoice_not_found":{"value":{"type":"https://docs.vilna.io/apis/errors#not-found","title":"Not Found","status":404,"code":"invoice.not_found","detail":"invoice not found","instance":"/traces/0123456789abcdef0123456789abcdef"},"key":"invoice_not_found","summary":"The invoice does not exist in this project","id":"paths/~1addresses~1{address}/patch/responses/404/content/application~1problem+json/examples/invoice_not_found"},"paths/~1addresses~1{address}/patch/responses/409/content/application~1problem+json/examples/address_occupied":{"value":{"type":"https://docs.vilna.io/apis/errors#conflict","title":"Conflict","status":409,"code":"invoice.address_occupied","detail":"address already has an active invoice with different parameters","instance":"/traces/0123456789abcdef0123456789abcdef"},"key":"address_occupied","summary":"The address already has an active invoice","id":"paths/~1addresses~1{address}/patch/responses/409/content/application~1problem+json/examples/address_occupied"},"paths/~1addresses~1{address}/patch/responses/409/content/application~1problem+json/examples/address_in_use":{"value":{"type":"https://docs.vilna.io/apis/errors#conflict","title":"Conflict","status":409,"code":"address.in_use","detail":"address has an active invoice and cannot be deleted","instance":"/traces/0123456789abcdef0123456789abcdef"},"key":"address_in_use","summary":"The address cannot be deleted while in use","id":"paths/~1addresses~1{address}/patch/responses/409/content/application~1problem+json/examples/address_in_use"},"paths/~1addresses~1{address}/patch/responses/409/content/application~1problem+json/examples/subscription_v1_conflict":{"value":{"type":"https://docs.vilna.io/apis/errors#conflict","title":"Conflict","status":409,"code":"notification.subscription_v1_conflict","detail":"a subscription created through v1 accepts name and availability changes only","instance":"/traces/0123456789abcdef0123456789abcdef"},"key":"subscription_v1_conflict","summary":"A v1-created subscription rejects trigger, filter or noise changes","id":"paths/~1addresses~1{address}/patch/responses/409/content/application~1problem+json/examples/subscription_v1_conflict"},"paths/~1addresses~1{address}/patch/responses/409/content/application~1problem+json/examples/notification_send_in_progress":{"value":{"type":"https://docs.vilna.io/apis/errors#conflict","title":"Conflict","status":409,"code":"notification.send_in_progress","detail":"notification send is in progress","instance":"/traces/0123456789abcdef0123456789abcdef"},"key":"notification_send_in_progress","summary":"The notification already has a manual attempt queued or in flight","id":"paths/~1addresses~1{address}/patch/responses/409/content/application~1problem+json/examples/notification_send_in_progress"},"paths/~1addresses~1{address}/patch/responses/409/content/application~1problem+json/examples/notification_payload_unavailable":{"value":{"type":"https://docs.vilna.io/apis/errors#conflict","title":"Conflict","status":409,"code":"notification.payload_unavailable","detail":"notification payload is no longer available","instance":"/traces/0123456789abcdef0123456789abcdef"},"key":"notification_payload_unavailable","summary":"Retention has cleared the content, so there is nothing to resend","id":"paths/~1addresses~1{address}/patch/responses/409/content/application~1problem+json/examples/notification_payload_unavailable"},"paths/~1addresses~1{address}/patch/responses/409/content/application~1problem+json/examples/notification_test_resend_not_allowed":{"value":{"type":"https://docs.vilna.io/apis/errors#conflict","title":"Conflict","status":409,"code":"notification.test_resend_not_allowed","detail":"test notifications cannot be resent","instance":"/traces/0123456789abcdef0123456789abcdef"},"key":"notification_test_resend_not_allowed","summary":"The notification is a channel test","id":"paths/~1addresses~1{address}/patch/responses/409/content/application~1problem+json/examples/notification_test_resend_not_allowed"},"paths/~1addresses~1{address}/patch/responses/503/content/application~1problem+json/examples/temporarily_unavailable":{"value":{"type":"https://docs.vilna.io/apis/errors#service-unavailable","title":"Service Unavailable","status":503,"code":"service.temporarily_unavailable","detail":"The operation is temporarily unavailable. Please try again later."},"key":"temporarily_unavailable","summary":"The operation cannot be completed at present","id":"paths/~1addresses~1{address}/patch/responses/503/content/application~1problem+json/examples/temporarily_unavailable"},"paths/~1bitcoin~1utxos/get/responses/400/content/application~1problem+json/examples/malformed_json":{"value":{"type":"https://docs.vilna.io/apis/errors#invalid-request","title":"Invalid Request","status":400,"code":"request.malformed","detail":"The request could not be decoded.","instance":"/traces/0123456789abcdef0123456789abcdef"},"key":"malformed_json","summary":"The request body contains malformed JSON","id":"paths/~1bitcoin~1utxos/get/responses/400/content/application~1problem+json/examples/malformed_json"},"paths/~1bitcoin~1utxos/get/responses/401/content/application~1problem+json/examples/service_authentication_denied":{"value":{"type":"https://docs.vilna.io/apis/errors#unauthorized","title":"Unauthorized","status":401,"code":"unspecified","detail":"You are not authorized to access this resource. If the problem persists, please contact our support team.","instance":"/unauthorized?method=createInvoice"},"key":"service_authentication_denied","summary":"The API service refused authentication","id":"paths/~1bitcoin~1utxos/get/responses/401/content/application~1problem+json/examples/service_authentication_denied"},"paths/~1bitcoin~1utxos/get/responses/403/content/application~1problem+json/examples/insufficient_permissions":{"value":{"type":"https://docs.vilna.io/apis/errors#forbidden","title":"Forbidden","status":403,"code":"unspecified","detail":"Your credentials are valid but don't include the permission this operation needs. Check the API key permissions in the dashboard. Permissions are set when the key is created and can't be edited later. To change them, create a new key.","instance":"/forbidden?method=createInvoice"},"key":"insufficient_permissions","summary":"The API key lacks the required permission","id":"paths/~1bitcoin~1utxos/get/responses/403/content/application~1problem+json/examples/insufficient_permissions"},"paths/~1bitcoin~1utxos/get/responses/404/content/application~1problem+json/examples/address_not_found":{"value":{"type":"https://docs.vilna.io/apis/errors#not-found","title":"Not Found","status":404,"code":"address.not_found","detail":"address not found","instance":"/traces/0123456789abcdef0123456789abcdef"},"key":"address_not_found","summary":"The address does not exist in this project","id":"paths/~1bitcoin~1utxos/get/responses/404/content/application~1problem+json/examples/address_not_found"},"paths/~1bitcoin~1utxos/get/responses/404/content/application~1problem+json/examples/invoice_not_found":{"value":{"type":"https://docs.vilna.io/apis/errors#not-found","title":"Not Found","status":404,"code":"invoice.not_found","detail":"invoice not found","instance":"/traces/0123456789abcdef0123456789abcdef"},"key":"invoice_not_found","summary":"The invoice does not exist in this project","id":"paths/~1bitcoin~1utxos/get/responses/404/content/application~1problem+json/examples/invoice_not_found"},"paths/~1bitcoin~1utxos/get/responses/422/content/application~1problem+json/examples/invoice_not_cancellable":{"value":{"type":"https://docs.vilna.io/apis/errors#precondition","title":"Precondition Failed","status":422,"code":"invoice.not_cancellable","detail":"invoice cannot be cancelled in current status","instance":"/traces/0123456789abcdef0123456789abcdef","fields":[{"name":"status","reason":"confirmed"}]},"key":"invoice_not_cancellable","summary":"A confirmed invoice cannot be cancelled","id":"paths/~1bitcoin~1utxos/get/responses/422/content/application~1problem+json/examples/invoice_not_cancellable"},"paths/~1bitcoin~1utxos/get/responses/503/content/application~1problem+json/examples/temporarily_unavailable":{"value":{"type":"https://docs.vilna.io/apis/errors#service-unavailable","title":"Service Unavailable","status":503,"code":"service.temporarily_unavailable","detail":"The operation is temporarily unavailable. Please try again later."},"key":"temporarily_unavailable","summary":"The operation cannot be completed at present","id":"paths/~1bitcoin~1utxos/get/responses/503/content/application~1problem+json/examples/temporarily_unavailable"},"paths/~1address-tags/get/responses/400/content/application~1problem+json/examples/malformed_json":{"value":{"type":"https://docs.vilna.io/apis/errors#invalid-request","title":"Invalid Request","status":400,"code":"request.malformed","detail":"The request could not be decoded.","instance":"/traces/0123456789abcdef0123456789abcdef"},"key":"malformed_json","summary":"The request body contains malformed JSON","id":"paths/~1address-tags/get/responses/400/content/application~1problem+json/examples/malformed_json"},"paths/~1address-tags/get/responses/401/content/application~1problem+json/examples/service_authentication_denied":{"value":{"type":"https://docs.vilna.io/apis/errors#unauthorized","title":"Unauthorized","status":401,"code":"unspecified","detail":"You are not authorized to access this resource. If the problem persists, please contact our support team.","instance":"/unauthorized?method=createInvoice"},"key":"service_authentication_denied","summary":"The API service refused authentication","id":"paths/~1address-tags/get/responses/401/content/application~1problem+json/examples/service_authentication_denied"},"paths/~1address-tags/get/responses/403/content/application~1problem+json/examples/insufficient_permissions":{"value":{"type":"https://docs.vilna.io/apis/errors#forbidden","title":"Forbidden","status":403,"code":"unspecified","detail":"Your credentials are valid but don't include the permission this operation needs. Check the API key permissions in the dashboard. Permissions are set when the key is created and can't be edited later. To change them, create a new key.","instance":"/forbidden?method=createInvoice"},"key":"insufficient_permissions","summary":"The API key lacks the required permission","id":"paths/~1address-tags/get/responses/403/content/application~1problem+json/examples/insufficient_permissions"},"paths/~1address-tags/get/responses/503/content/application~1problem+json/examples/temporarily_unavailable":{"value":{"type":"https://docs.vilna.io/apis/errors#service-unavailable","title":"Service Unavailable","status":503,"code":"service.temporarily_unavailable","detail":"The operation is temporarily unavailable. Please try again later."},"key":"temporarily_unavailable","summary":"The operation cannot be completed at present","id":"paths/~1address-tags/get/responses/503/content/application~1problem+json/examples/temporarily_unavailable"},"paths/~1address-tags/post/responses/400/content/application~1problem+json/examples/malformed_json":{"value":{"type":"https://docs.vilna.io/apis/errors#invalid-request","title":"Invalid Request","status":400,"code":"request.malformed","detail":"The request could not be decoded.","instance":"/traces/0123456789abcdef0123456789abcdef"},"key":"malformed_json","summary":"The request body contains malformed JSON","id":"paths/~1address-tags/post/responses/400/content/application~1problem+json/examples/malformed_json"},"paths/~1address-tags/post/responses/401/content/application~1problem+json/examples/service_authentication_denied":{"value":{"type":"https://docs.vilna.io/apis/errors#unauthorized","title":"Unauthorized","status":401,"code":"unspecified","detail":"You are not authorized to access this resource. If the problem persists, please contact our support team.","instance":"/unauthorized?method=createInvoice"},"key":"service_authentication_denied","summary":"The API service refused authentication","id":"paths/~1address-tags/post/responses/401/content/application~1problem+json/examples/service_authentication_denied"},"paths/~1address-tags/post/responses/403/content/application~1problem+json/examples/insufficient_permissions":{"value":{"type":"https://docs.vilna.io/apis/errors#forbidden","title":"Forbidden","status":403,"code":"unspecified","detail":"Your credentials are valid but don't include the permission this operation needs. Check the API key permissions in the dashboard. Permissions are set when the key is created and can't be edited later. To change them, create a new key.","instance":"/forbidden?method=createInvoice"},"key":"insufficient_permissions","summary":"The API key lacks the required permission","id":"paths/~1address-tags/post/responses/403/content/application~1problem+json/examples/insufficient_permissions"},"paths/~1address-tags/post/responses/409/content/application~1problem+json/examples/address_occupied":{"value":{"type":"https://docs.vilna.io/apis/errors#conflict","title":"Conflict","status":409,"code":"invoice.address_occupied","detail":"address already has an active invoice with different parameters","instance":"/traces/0123456789abcdef0123456789abcdef"},"key":"address_occupied","summary":"The address already has an active invoice","id":"paths/~1address-tags/post/responses/409/content/application~1problem+json/examples/address_occupied"},"paths/~1address-tags/post/responses/409/content/application~1problem+json/examples/address_in_use":{"value":{"type":"https://docs.vilna.io/apis/errors#conflict","title":"Conflict","status":409,"code":"address.in_use","detail":"address has an active invoice and cannot be deleted","instance":"/traces/0123456789abcdef0123456789abcdef"},"key":"address_in_use","summary":"The address cannot be deleted while in use","id":"paths/~1address-tags/post/responses/409/content/application~1problem+json/examples/address_in_use"},"paths/~1address-tags/post/responses/409/content/application~1problem+json/examples/subscription_v1_conflict":{"value":{"type":"https://docs.vilna.io/apis/errors#conflict","title":"Conflict","status":409,"code":"notification.subscription_v1_conflict","detail":"a subscription created through v1 accepts name and availability changes only","instance":"/traces/0123456789abcdef0123456789abcdef"},"key":"subscription_v1_conflict","summary":"A v1-created subscription rejects trigger, filter or noise changes","id":"paths/~1address-tags/post/responses/409/content/application~1problem+json/examples/subscription_v1_conflict"},"paths/~1address-tags/post/responses/409/content/application~1problem+json/examples/notification_send_in_progress":{"value":{"type":"https://docs.vilna.io/apis/errors#conflict","title":"Conflict","status":409,"code":"notification.send_in_progress","detail":"notification send is in progress","instance":"/traces/0123456789abcdef0123456789abcdef"},"key":"notification_send_in_progress","summary":"The notification already has a manual attempt queued or in flight","id":"paths/~1address-tags/post/responses/409/content/application~1problem+json/examples/notification_send_in_progress"},"paths/~1address-tags/post/responses/409/content/application~1problem+json/examples/notification_payload_unavailable":{"value":{"type":"https://docs.vilna.io/apis/errors#conflict","title":"Conflict","status":409,"code":"notification.payload_unavailable","detail":"notification payload is no longer available","instance":"/traces/0123456789abcdef0123456789abcdef"},"key":"notification_payload_unavailable","summary":"Retention has cleared the content, so there is nothing to resend","id":"paths/~1address-tags/post/responses/409/content/application~1problem+json/examples/notification_payload_unavailable"},"paths/~1address-tags/post/responses/409/content/application~1problem+json/examples/notification_test_resend_not_allowed":{"value":{"type":"https://docs.vilna.io/apis/errors#conflict","title":"Conflict","status":409,"code":"notification.test_resend_not_allowed","detail":"test notifications cannot be resent","instance":"/traces/0123456789abcdef0123456789abcdef"},"key":"notification_test_resend_not_allowed","summary":"The notification is a channel test","id":"paths/~1address-tags/post/responses/409/content/application~1problem+json/examples/notification_test_resend_not_allowed"},"paths/~1address-tags/post/responses/429/content/application~1problem+json/examples/address_quota":{"value":{"type":"https://docs.vilna.io/apis/errors#too-many-requests","title":"Too Many Requests","status":429,"code":"address.quota_exceeded","detail":"the project has reached its address limit","max":100},"key":"address_quota","summary":"The project has reached its address quota","id":"paths/~1address-tags/post/responses/429/content/application~1problem+json/examples/address_quota"},"paths/~1address-tags/post/responses/429/content/application~1problem+json/examples/creation_prohibited":{"value":{"type":"https://docs.vilna.io/apis/errors#too-many-requests","title":"Too Many Requests","status":429,"code":"channel.quota_exceeded","detail":"the project has reached its channel limit","max":0},"key":"creation_prohibited","summary":"A zero effective limit prohibits new resources","id":"paths/~1address-tags/post/responses/429/content/application~1problem+json/examples/creation_prohibited"},"paths/~1address-tags/post/responses/503/content/application~1problem+json/examples/temporarily_unavailable":{"value":{"type":"https://docs.vilna.io/apis/errors#service-unavailable","title":"Service Unavailable","status":503,"code":"service.temporarily_unavailable","detail":"The operation is temporarily unavailable. Please try again later."},"key":"temporarily_unavailable","summary":"The operation cannot be completed at present","id":"paths/~1address-tags/post/responses/503/content/application~1problem+json/examples/temporarily_unavailable"},"paths/~1address-tags~1{address_tag_id}/get/responses/400/content/application~1problem+json/examples/malformed_json":{"value":{"type":"https://docs.vilna.io/apis/errors#invalid-request","title":"Invalid Request","status":400,"code":"request.malformed","detail":"The request could not be decoded.","instance":"/traces/0123456789abcdef0123456789abcdef"},"key":"malformed_json","summary":"The request body contains malformed JSON","id":"paths/~1address-tags~1{address_tag_id}/get/responses/400/content/application~1problem+json/examples/malformed_json"},"paths/~1address-tags~1{address_tag_id}/get/responses/401/content/application~1problem+json/examples/service_authentication_denied":{"value":{"type":"https://docs.vilna.io/apis/errors#unauthorized","title":"Unauthorized","status":401,"code":"unspecified","detail":"You are not authorized to access this resource. If the problem persists, please contact our support team.","instance":"/unauthorized?method=createInvoice"},"key":"service_authentication_denied","summary":"The API service refused authentication","id":"paths/~1address-tags~1{address_tag_id}/get/responses/401/content/application~1problem+json/examples/service_authentication_denied"},"paths/~1address-tags~1{address_tag_id}/get/responses/403/content/application~1problem+json/examples/insufficient_permissions":{"value":{"type":"https://docs.vilna.io/apis/errors#forbidden","title":"Forbidden","status":403,"code":"unspecified","detail":"Your credentials are valid but don't include the permission this operation needs. Check the API key permissions in the dashboard. Permissions are set when the key is created and can't be edited later. To change them, create a new key.","instance":"/forbidden?method=createInvoice"},"key":"insufficient_permissions","summary":"The API key lacks the required permission","id":"paths/~1address-tags~1{address_tag_id}/get/responses/403/content/application~1problem+json/examples/insufficient_permissions"},"paths/~1address-tags~1{address_tag_id}/get/responses/404/content/application~1problem+json/examples/address_not_found":{"value":{"type":"https://docs.vilna.io/apis/errors#not-found","title":"Not Found","status":404,"code":"address.not_found","detail":"address not found","instance":"/traces/0123456789abcdef0123456789abcdef"},"key":"address_not_found","summary":"The address does not exist in this project","id":"paths/~1address-tags~1{address_tag_id}/get/responses/404/content/application~1problem+json/examples/address_not_found"},"paths/~1address-tags~1{address_tag_id}/get/responses/404/content/application~1problem+json/examples/invoice_not_found":{"value":{"type":"https://docs.vilna.io/apis/errors#not-found","title":"Not Found","status":404,"code":"invoice.not_found","detail":"invoice not found","instance":"/traces/0123456789abcdef0123456789abcdef"},"key":"invoice_not_found","summary":"The invoice does not exist in this project","id":"paths/~1address-tags~1{address_tag_id}/get/responses/404/content/application~1problem+json/examples/invoice_not_found"},"paths/~1address-tags~1{address_tag_id}/get/responses/503/content/application~1problem+json/examples/temporarily_unavailable":{"value":{"type":"https://docs.vilna.io/apis/errors#service-unavailable","title":"Service Unavailable","status":503,"code":"service.temporarily_unavailable","detail":"The operation is temporarily unavailable. Please try again later."},"key":"temporarily_unavailable","summary":"The operation cannot be completed at present","id":"paths/~1address-tags~1{address_tag_id}/get/responses/503/content/application~1problem+json/examples/temporarily_unavailable"},"paths/~1address-tags~1{address_tag_id}/patch/responses/400/content/application~1problem+json/examples/malformed_json":{"value":{"type":"https://docs.vilna.io/apis/errors#invalid-request","title":"Invalid Request","status":400,"code":"request.malformed","detail":"The request could not be decoded.","instance":"/traces/0123456789abcdef0123456789abcdef"},"key":"malformed_json","summary":"The request body contains malformed JSON","id":"paths/~1address-tags~1{address_tag_id}/patch/responses/400/content/application~1problem+json/examples/malformed_json"},"paths/~1address-tags~1{address_tag_id}/patch/responses/401/content/application~1problem+json/examples/service_authentication_denied":{"value":{"type":"https://docs.vilna.io/apis/errors#unauthorized","title":"Unauthorized","status":401,"code":"unspecified","detail":"You are not authorized to access this resource. If the problem persists, please contact our support team.","instance":"/unauthorized?method=createInvoice"},"key":"service_authentication_denied","summary":"The API service refused authentication","id":"paths/~1address-tags~1{address_tag_id}/patch/responses/401/content/application~1problem+json/examples/service_authentication_denied"},"paths/~1address-tags~1{address_tag_id}/patch/responses/403/content/application~1problem+json/examples/insufficient_permissions":{"value":{"type":"https://docs.vilna.io/apis/errors#forbidden","title":"Forbidden","status":403,"code":"unspecified","detail":"Your credentials are valid but don't include the permission this operation needs. Check the API key permissions in the dashboard. Permissions are set when the key is created and can't be edited later. To change them, create a new key.","instance":"/forbidden?method=createInvoice"},"key":"insufficient_permissions","summary":"The API key lacks the required permission","id":"paths/~1address-tags~1{address_tag_id}/patch/responses/403/content/application~1problem+json/examples/insufficient_permissions"},"paths/~1address-tags~1{address_tag_id}/patch/responses/404/content/application~1problem+json/examples/address_not_found":{"value":{"type":"https://docs.vilna.io/apis/errors#not-found","title":"Not Found","status":404,"code":"address.not_found","detail":"address not found","instance":"/traces/0123456789abcdef0123456789abcdef"},"key":"address_not_found","summary":"The address does not exist in this project","id":"paths/~1address-tags~1{address_tag_id}/patch/responses/404/content/application~1problem+json/examples/address_not_found"},"paths/~1address-tags~1{address_tag_id}/patch/responses/404/content/application~1problem+json/examples/invoice_not_found":{"value":{"type":"https://docs.vilna.io/apis/errors#not-found","title":"Not Found","status":404,"code":"invoice.not_found","detail":"invoice not found","instance":"/traces/0123456789abcdef0123456789abcdef"},"key":"invoice_not_found","summary":"The invoice does not exist in this project","id":"paths/~1address-tags~1{address_tag_id}/patch/responses/404/content/application~1problem+json/examples/invoice_not_found"},"paths/~1address-tags~1{address_tag_id}/patch/responses/409/content/application~1problem+json/examples/address_occupied":{"value":{"type":"https://docs.vilna.io/apis/errors#conflict","title":"Conflict","status":409,"code":"invoice.address_occupied","detail":"address already has an active invoice with different parameters","instance":"/traces/0123456789abcdef0123456789abcdef"},"key":"address_occupied","summary":"The address already has an active invoice","id":"paths/~1address-tags~1{address_tag_id}/patch/responses/409/content/application~1problem+json/examples/address_occupied"},"paths/~1address-tags~1{address_tag_id}/patch/responses/409/content/application~1problem+json/examples/address_in_use":{"value":{"type":"https://docs.vilna.io/apis/errors#conflict","title":"Conflict","status":409,"code":"address.in_use","detail":"address has an active invoice and cannot be deleted","instance":"/traces/0123456789abcdef0123456789abcdef"},"key":"address_in_use","summary":"The address cannot be deleted while in use","id":"paths/~1address-tags~1{address_tag_id}/patch/responses/409/content/application~1problem+json/examples/address_in_use"},"paths/~1address-tags~1{address_tag_id}/patch/responses/409/content/application~1problem+json/examples/subscription_v1_conflict":{"value":{"type":"https://docs.vilna.io/apis/errors#conflict","title":"Conflict","status":409,"code":"notification.subscription_v1_conflict","detail":"a subscription created through v1 accepts name and availability changes only","instance":"/traces/0123456789abcdef0123456789abcdef"},"key":"subscription_v1_conflict","summary":"A v1-created subscription rejects trigger, filter or noise changes","id":"paths/~1address-tags~1{address_tag_id}/patch/responses/409/content/application~1problem+json/examples/subscription_v1_conflict"},"paths/~1address-tags~1{address_tag_id}/patch/responses/409/content/application~1problem+json/examples/notification_send_in_progress":{"value":{"type":"https://docs.vilna.io/apis/errors#conflict","title":"Conflict","status":409,"code":"notification.send_in_progress","detail":"notification send is in progress","instance":"/traces/0123456789abcdef0123456789abcdef"},"key":"notification_send_in_progress","summary":"The notification already has a manual attempt queued or in flight","id":"paths/~1address-tags~1{address_tag_id}/patch/responses/409/content/application~1problem+json/examples/notification_send_in_progress"},"paths/~1address-tags~1{address_tag_id}/patch/responses/409/content/application~1problem+json/examples/notification_payload_unavailable":{"value":{"type":"https://docs.vilna.io/apis/errors#conflict","title":"Conflict","status":409,"code":"notification.payload_unavailable","detail":"notification payload is no longer available","instance":"/traces/0123456789abcdef0123456789abcdef"},"key":"notification_payload_unavailable","summary":"Retention has cleared the content, so there is nothing to resend","id":"paths/~1address-tags~1{address_tag_id}/patch/responses/409/content/application~1problem+json/examples/notification_payload_unavailable"},"paths/~1address-tags~1{address_tag_id}/patch/responses/409/content/application~1problem+json/examples/notification_test_resend_not_allowed":{"value":{"type":"https://docs.vilna.io/apis/errors#conflict","title":"Conflict","status":409,"code":"notification.test_resend_not_allowed","detail":"test notifications cannot be resent","instance":"/traces/0123456789abcdef0123456789abcdef"},"key":"notification_test_resend_not_allowed","summary":"The notification is a channel test","id":"paths/~1address-tags~1{address_tag_id}/patch/responses/409/content/application~1problem+json/examples/notification_test_resend_not_allowed"},"paths/~1address-tags~1{address_tag_id}/patch/responses/503/content/application~1problem+json/examples/temporarily_unavailable":{"value":{"type":"https://docs.vilna.io/apis/errors#service-unavailable","title":"Service Unavailable","status":503,"code":"service.temporarily_unavailable","detail":"The operation is temporarily unavailable. Please try again later."},"key":"temporarily_unavailable","summary":"The operation cannot be completed at present","id":"paths/~1address-tags~1{address_tag_id}/patch/responses/503/content/application~1problem+json/examples/temporarily_unavailable"},"paths/~1address-tags~1{address_tag_id}/delete/responses/400/content/application~1problem+json/examples/malformed_json":{"value":{"type":"https://docs.vilna.io/apis/errors#invalid-request","title":"Invalid Request","status":400,"code":"request.malformed","detail":"The request could not be decoded.","instance":"/traces/0123456789abcdef0123456789abcdef"},"key":"malformed_json","summary":"The request body contains malformed JSON","id":"paths/~1address-tags~1{address_tag_id}/delete/responses/400/content/application~1problem+json/examples/malformed_json"},"paths/~1address-tags~1{address_tag_id}/delete/responses/401/content/application~1problem+json/examples/service_authentication_denied":{"value":{"type":"https://docs.vilna.io/apis/errors#unauthorized","title":"Unauthorized","status":401,"code":"unspecified","detail":"You are not authorized to access this resource. If the problem persists, please contact our support team.","instance":"/unauthorized?method=createInvoice"},"key":"service_authentication_denied","summary":"The API service refused authentication","id":"paths/~1address-tags~1{address_tag_id}/delete/responses/401/content/application~1problem+json/examples/service_authentication_denied"},"paths/~1address-tags~1{address_tag_id}/delete/responses/403/content/application~1problem+json/examples/insufficient_permissions":{"value":{"type":"https://docs.vilna.io/apis/errors#forbidden","title":"Forbidden","status":403,"code":"unspecified","detail":"Your credentials are valid but don't include the permission this operation needs. Check the API key permissions in the dashboard. Permissions are set when the key is created and can't be edited later. To change them, create a new key.","instance":"/forbidden?method=createInvoice"},"key":"insufficient_permissions","summary":"The API key lacks the required permission","id":"paths/~1address-tags~1{address_tag_id}/delete/responses/403/content/application~1problem+json/examples/insufficient_permissions"},"paths/~1address-tags~1{address_tag_id}/delete/responses/404/content/application~1problem+json/examples/address_not_found":{"value":{"type":"https://docs.vilna.io/apis/errors#not-found","title":"Not Found","status":404,"code":"address.not_found","detail":"address not found","instance":"/traces/0123456789abcdef0123456789abcdef"},"key":"address_not_found","summary":"The address does not exist in this project","id":"paths/~1address-tags~1{address_tag_id}/delete/responses/404/content/application~1problem+json/examples/address_not_found"},"paths/~1address-tags~1{address_tag_id}/delete/responses/404/content/application~1problem+json/examples/invoice_not_found":{"value":{"type":"https://docs.vilna.io/apis/errors#not-found","title":"Not Found","status":404,"code":"invoice.not_found","detail":"invoice not found","instance":"/traces/0123456789abcdef0123456789abcdef"},"key":"invoice_not_found","summary":"The invoice does not exist in this project","id":"paths/~1address-tags~1{address_tag_id}/delete/responses/404/content/application~1problem+json/examples/invoice_not_found"},"paths/~1address-tags~1{address_tag_id}/delete/responses/409/content/application~1problem+json/examples/address_occupied":{"value":{"type":"https://docs.vilna.io/apis/errors#conflict","title":"Conflict","status":409,"code":"invoice.address_occupied","detail":"address already has an active invoice with different parameters","instance":"/traces/0123456789abcdef0123456789abcdef"},"key":"address_occupied","summary":"The address already has an active invoice","id":"paths/~1address-tags~1{address_tag_id}/delete/responses/409/content/application~1problem+json/examples/address_occupied"},"paths/~1address-tags~1{address_tag_id}/delete/responses/409/content/application~1problem+json/examples/address_in_use":{"value":{"type":"https://docs.vilna.io/apis/errors#conflict","title":"Conflict","status":409,"code":"address.in_use","detail":"address has an active invoice and cannot be deleted","instance":"/traces/0123456789abcdef0123456789abcdef"},"key":"address_in_use","summary":"The address cannot be deleted while in use","id":"paths/~1address-tags~1{address_tag_id}/delete/responses/409/content/application~1problem+json/examples/address_in_use"},"paths/~1address-tags~1{address_tag_id}/delete/responses/409/content/application~1problem+json/examples/subscription_v1_conflict":{"value":{"type":"https://docs.vilna.io/apis/errors#conflict","title":"Conflict","status":409,"code":"notification.subscription_v1_conflict","detail":"a subscription created through v1 accepts name and availability changes only","instance":"/traces/0123456789abcdef0123456789abcdef"},"key":"subscription_v1_conflict","summary":"A v1-created subscription rejects trigger, filter or noise changes","id":"paths/~1address-tags~1{address_tag_id}/delete/responses/409/content/application~1problem+json/examples/subscription_v1_conflict"},"paths/~1address-tags~1{address_tag_id}/delete/responses/409/content/application~1problem+json/examples/notification_send_in_progress":{"value":{"type":"https://docs.vilna.io/apis/errors#conflict","title":"Conflict","status":409,"code":"notification.send_in_progress","detail":"notification send is in progress","instance":"/traces/0123456789abcdef0123456789abcdef"},"key":"notification_send_in_progress","summary":"The notification already has a manual attempt queued or in flight","id":"paths/~1address-tags~1{address_tag_id}/delete/responses/409/content/application~1problem+json/examples/notification_send_in_progress"},"paths/~1address-tags~1{address_tag_id}/delete/responses/409/content/application~1problem+json/examples/notification_payload_unavailable":{"value":{"type":"https://docs.vilna.io/apis/errors#conflict","title":"Conflict","status":409,"code":"notification.payload_unavailable","detail":"notification payload is no longer available","instance":"/traces/0123456789abcdef0123456789abcdef"},"key":"notification_payload_unavailable","summary":"Retention has cleared the content, so there is nothing to resend","id":"paths/~1address-tags~1{address_tag_id}/delete/responses/409/content/application~1problem+json/examples/notification_payload_unavailable"},"paths/~1address-tags~1{address_tag_id}/delete/responses/409/content/application~1problem+json/examples/notification_test_resend_not_allowed":{"value":{"type":"https://docs.vilna.io/apis/errors#conflict","title":"Conflict","status":409,"code":"notification.test_resend_not_allowed","detail":"test notifications cannot be resent","instance":"/traces/0123456789abcdef0123456789abcdef"},"key":"notification_test_resend_not_allowed","summary":"The notification is a channel test","id":"paths/~1address-tags~1{address_tag_id}/delete/responses/409/content/application~1problem+json/examples/notification_test_resend_not_allowed"},"paths/~1address-tags~1{address_tag_id}/delete/responses/503/content/application~1problem+json/examples/temporarily_unavailable":{"value":{"type":"https://docs.vilna.io/apis/errors#service-unavailable","title":"Service Unavailable","status":503,"code":"service.temporarily_unavailable","detail":"The operation is temporarily unavailable. Please try again later."},"key":"temporarily_unavailable","summary":"The operation cannot be completed at present","id":"paths/~1address-tags~1{address_tag_id}/delete/responses/503/content/application~1problem+json/examples/temporarily_unavailable"},"paths/~1address-tags~1{address_tag_id}~1actions~1add/post/responses/400/content/application~1problem+json/examples/malformed_json":{"value":{"type":"https://docs.vilna.io/apis/errors#invalid-request","title":"Invalid Request","status":400,"code":"request.malformed","detail":"The request could not be decoded.","instance":"/traces/0123456789abcdef0123456789abcdef"},"key":"malformed_json","summary":"The request body contains malformed JSON","id":"paths/~1address-tags~1{address_tag_id}~1actions~1add/post/responses/400/content/application~1problem+json/examples/malformed_json"},"paths/~1address-tags~1{address_tag_id}~1actions~1add/post/responses/401/content/application~1problem+json/examples/service_authentication_denied":{"value":{"type":"https://docs.vilna.io/apis/errors#unauthorized","title":"Unauthorized","status":401,"code":"unspecified","detail":"You are not authorized to access this resource. If the problem persists, please contact our support team.","instance":"/unauthorized?method=createInvoice"},"key":"service_authentication_denied","summary":"The API service refused authentication","id":"paths/~1address-tags~1{address_tag_id}~1actions~1add/post/responses/401/content/application~1problem+json/examples/service_authentication_denied"},"paths/~1address-tags~1{address_tag_id}~1actions~1add/post/responses/403/content/application~1problem+json/examples/insufficient_permissions":{"value":{"type":"https://docs.vilna.io/apis/errors#forbidden","title":"Forbidden","status":403,"code":"unspecified","detail":"Your credentials are valid but don't include the permission this operation needs. Check the API key permissions in the dashboard. Permissions are set when the key is created and can't be edited later. To change them, create a new key.","instance":"/forbidden?method=createInvoice"},"key":"insufficient_permissions","summary":"The API key lacks the required permission","id":"paths/~1address-tags~1{address_tag_id}~1actions~1add/post/responses/403/content/application~1problem+json/examples/insufficient_permissions"},"paths/~1address-tags~1{address_tag_id}~1actions~1add/post/responses/404/content/application~1problem+json/examples/address_not_found":{"value":{"type":"https://docs.vilna.io/apis/errors#not-found","title":"Not Found","status":404,"code":"address.not_found","detail":"address not found","instance":"/traces/0123456789abcdef0123456789abcdef"},"key":"address_not_found","summary":"The address does not exist in this project","id":"paths/~1address-tags~1{address_tag_id}~1actions~1add/post/responses/404/content/application~1problem+json/examples/address_not_found"},"paths/~1address-tags~1{address_tag_id}~1actions~1add/post/responses/404/content/application~1problem+json/examples/invoice_not_found":{"value":{"type":"https://docs.vilna.io/apis/errors#not-found","title":"Not Found","status":404,"code":"invoice.not_found","detail":"invoice not found","instance":"/traces/0123456789abcdef0123456789abcdef"},"key":"invoice_not_found","summary":"The invoice does not exist in this project","id":"paths/~1address-tags~1{address_tag_id}~1actions~1add/post/responses/404/content/application~1problem+json/examples/invoice_not_found"},"paths/~1address-tags~1{address_tag_id}~1actions~1add/post/responses/409/content/application~1problem+json/examples/address_occupied":{"value":{"type":"https://docs.vilna.io/apis/errors#conflict","title":"Conflict","status":409,"code":"invoice.address_occupied","detail":"address already has an active invoice with different parameters","instance":"/traces/0123456789abcdef0123456789abcdef"},"key":"address_occupied","summary":"The address already has an active invoice","id":"paths/~1address-tags~1{address_tag_id}~1actions~1add/post/responses/409/content/application~1problem+json/examples/address_occupied"},"paths/~1address-tags~1{address_tag_id}~1actions~1add/post/responses/409/content/application~1problem+json/examples/address_in_use":{"value":{"type":"https://docs.vilna.io/apis/errors#conflict","title":"Conflict","status":409,"code":"address.in_use","detail":"address has an active invoice and cannot be deleted","instance":"/traces/0123456789abcdef0123456789abcdef"},"key":"address_in_use","summary":"The address cannot be deleted while in use","id":"paths/~1address-tags~1{address_tag_id}~1actions~1add/post/responses/409/content/application~1problem+json/examples/address_in_use"},"paths/~1address-tags~1{address_tag_id}~1actions~1add/post/responses/409/content/application~1problem+json/examples/subscription_v1_conflict":{"value":{"type":"https://docs.vilna.io/apis/errors#conflict","title":"Conflict","status":409,"code":"notification.subscription_v1_conflict","detail":"a subscription created through v1 accepts name and availability changes only","instance":"/traces/0123456789abcdef0123456789abcdef"},"key":"subscription_v1_conflict","summary":"A v1-created subscription rejects trigger, filter or noise changes","id":"paths/~1address-tags~1{address_tag_id}~1actions~1add/post/responses/409/content/application~1problem+json/examples/subscription_v1_conflict"},"paths/~1address-tags~1{address_tag_id}~1actions~1add/post/responses/409/content/application~1problem+json/examples/notification_send_in_progress":{"value":{"type":"https://docs.vilna.io/apis/errors#conflict","title":"Conflict","status":409,"code":"notification.send_in_progress","detail":"notification send is in progress","instance":"/traces/0123456789abcdef0123456789abcdef"},"key":"notification_send_in_progress","summary":"The notification already has a manual attempt queued or in flight","id":"paths/~1address-tags~1{address_tag_id}~1actions~1add/post/responses/409/content/application~1problem+json/examples/notification_send_in_progress"},"paths/~1address-tags~1{address_tag_id}~1actions~1add/post/responses/409/content/application~1problem+json/examples/notification_payload_unavailable":{"value":{"type":"https://docs.vilna.io/apis/errors#conflict","title":"Conflict","status":409,"code":"notification.payload_unavailable","detail":"notification payload is no longer available","instance":"/traces/0123456789abcdef0123456789abcdef"},"key":"notification_payload_unavailable","summary":"Retention has cleared the content, so there is nothing to resend","id":"paths/~1address-tags~1{address_tag_id}~1actions~1add/post/responses/409/content/application~1problem+json/examples/notification_payload_unavailable"},"paths/~1address-tags~1{address_tag_id}~1actions~1add/post/responses/409/content/application~1problem+json/examples/notification_test_resend_not_allowed":{"value":{"type":"https://docs.vilna.io/apis/errors#conflict","title":"Conflict","status":409,"code":"notification.test_resend_not_allowed","detail":"test notifications cannot be resent","instance":"/traces/0123456789abcdef0123456789abcdef"},"key":"notification_test_resend_not_allowed","summary":"The notification is a channel test","id":"paths/~1address-tags~1{address_tag_id}~1actions~1add/post/responses/409/content/application~1problem+json/examples/notification_test_resend_not_allowed"},"paths/~1address-tags~1{address_tag_id}~1actions~1add/post/responses/503/content/application~1problem+json/examples/temporarily_unavailable":{"value":{"type":"https://docs.vilna.io/apis/errors#service-unavailable","title":"Service Unavailable","status":503,"code":"service.temporarily_unavailable","detail":"The operation is temporarily unavailable. Please try again later."},"key":"temporarily_unavailable","summary":"The operation cannot be completed at present","id":"paths/~1address-tags~1{address_tag_id}~1actions~1add/post/responses/503/content/application~1problem+json/examples/temporarily_unavailable"},"paths/~1address-tags~1{address_tag_id}~1actions~1remove/post/responses/400/content/application~1problem+json/examples/malformed_json":{"value":{"type":"https://docs.vilna.io/apis/errors#invalid-request","title":"Invalid Request","status":400,"code":"request.malformed","detail":"The request could not be decoded.","instance":"/traces/0123456789abcdef0123456789abcdef"},"key":"malformed_json","summary":"The request body contains malformed JSON","id":"paths/~1address-tags~1{address_tag_id}~1actions~1remove/post/responses/400/content/application~1problem+json/examples/malformed_json"},"paths/~1address-tags~1{address_tag_id}~1actions~1remove/post/responses/401/content/application~1problem+json/examples/service_authentication_denied":{"value":{"type":"https://docs.vilna.io/apis/errors#unauthorized","title":"Unauthorized","status":401,"code":"unspecified","detail":"You are not authorized to access this resource. If the problem persists, please contact our support team.","instance":"/unauthorized?method=createInvoice"},"key":"service_authentication_denied","summary":"The API service refused authentication","id":"paths/~1address-tags~1{address_tag_id}~1actions~1remove/post/responses/401/content/application~1problem+json/examples/service_authentication_denied"},"paths/~1address-tags~1{address_tag_id}~1actions~1remove/post/responses/403/content/application~1problem+json/examples/insufficient_permissions":{"value":{"type":"https://docs.vilna.io/apis/errors#forbidden","title":"Forbidden","status":403,"code":"unspecified","detail":"Your credentials are valid but don't include the permission this operation needs. Check the API key permissions in the dashboard. Permissions are set when the key is created and can't be edited later. To change them, create a new key.","instance":"/forbidden?method=createInvoice"},"key":"insufficient_permissions","summary":"The API key lacks the required permission","id":"paths/~1address-tags~1{address_tag_id}~1actions~1remove/post/responses/403/content/application~1problem+json/examples/insufficient_permissions"},"paths/~1address-tags~1{address_tag_id}~1actions~1remove/post/responses/404/content/application~1problem+json/examples/address_not_found":{"value":{"type":"https://docs.vilna.io/apis/errors#not-found","title":"Not Found","status":404,"code":"address.not_found","detail":"address not found","instance":"/traces/0123456789abcdef0123456789abcdef"},"key":"address_not_found","summary":"The address does not exist in this project","id":"paths/~1address-tags~1{address_tag_id}~1actions~1remove/post/responses/404/content/application~1problem+json/examples/address_not_found"},"paths/~1address-tags~1{address_tag_id}~1actions~1remove/post/responses/404/content/application~1problem+json/examples/invoice_not_found":{"value":{"type":"https://docs.vilna.io/apis/errors#not-found","title":"Not Found","status":404,"code":"invoice.not_found","detail":"invoice not found","instance":"/traces/0123456789abcdef0123456789abcdef"},"key":"invoice_not_found","summary":"The invoice does not exist in this project","id":"paths/~1address-tags~1{address_tag_id}~1actions~1remove/post/responses/404/content/application~1problem+json/examples/invoice_not_found"},"paths/~1address-tags~1{address_tag_id}~1actions~1remove/post/responses/409/content/application~1problem+json/examples/address_occupied":{"value":{"type":"https://docs.vilna.io/apis/errors#conflict","title":"Conflict","status":409,"code":"invoice.address_occupied","detail":"address already has an active invoice with different parameters","instance":"/traces/0123456789abcdef0123456789abcdef"},"key":"address_occupied","summary":"The address already has an active invoice","id":"paths/~1address-tags~1{address_tag_id}~1actions~1remove/post/responses/409/content/application~1problem+json/examples/address_occupied"},"paths/~1address-tags~1{address_tag_id}~1actions~1remove/post/responses/409/content/application~1problem+json/examples/address_in_use":{"value":{"type":"https://docs.vilna.io/apis/errors#conflict","title":"Conflict","status":409,"code":"address.in_use","detail":"address has an active invoice and cannot be deleted","instance":"/traces/0123456789abcdef0123456789abcdef"},"key":"address_in_use","summary":"The address cannot be deleted while in use","id":"paths/~1address-tags~1{address_tag_id}~1actions~1remove/post/responses/409/content/application~1problem+json/examples/address_in_use"},"paths/~1address-tags~1{address_tag_id}~1actions~1remove/post/responses/409/content/application~1problem+json/examples/subscription_v1_conflict":{"value":{"type":"https://docs.vilna.io/apis/errors#conflict","title":"Conflict","status":409,"code":"notification.subscription_v1_conflict","detail":"a subscription created through v1 accepts name and availability changes only","instance":"/traces/0123456789abcdef0123456789abcdef"},"key":"subscription_v1_conflict","summary":"A v1-created subscription rejects trigger, filter or noise changes","id":"paths/~1address-tags~1{address_tag_id}~1actions~1remove/post/responses/409/content/application~1problem+json/examples/subscription_v1_conflict"},"paths/~1address-tags~1{address_tag_id}~1actions~1remove/post/responses/409/content/application~1problem+json/examples/notification_send_in_progress":{"value":{"type":"https://docs.vilna.io/apis/errors#conflict","title":"Conflict","status":409,"code":"notification.send_in_progress","detail":"notification send is in progress","instance":"/traces/0123456789abcdef0123456789abcdef"},"key":"notification_send_in_progress","summary":"The notification already has a manual attempt queued or in flight","id":"paths/~1address-tags~1{address_tag_id}~1actions~1remove/post/responses/409/content/application~1problem+json/examples/notification_send_in_progress"},"paths/~1address-tags~1{address_tag_id}~1actions~1remove/post/responses/409/content/application~1problem+json/examples/notification_payload_unavailable":{"value":{"type":"https://docs.vilna.io/apis/errors#conflict","title":"Conflict","status":409,"code":"notification.payload_unavailable","detail":"notification payload is no longer available","instance":"/traces/0123456789abcdef0123456789abcdef"},"key":"notification_payload_unavailable","summary":"Retention has cleared the content, so there is nothing to resend","id":"paths/~1address-tags~1{address_tag_id}~1actions~1remove/post/responses/409/content/application~1problem+json/examples/notification_payload_unavailable"},"paths/~1address-tags~1{address_tag_id}~1actions~1remove/post/responses/409/content/application~1problem+json/examples/notification_test_resend_not_allowed":{"value":{"type":"https://docs.vilna.io/apis/errors#conflict","title":"Conflict","status":409,"code":"notification.test_resend_not_allowed","detail":"test notifications cannot be resent","instance":"/traces/0123456789abcdef0123456789abcdef"},"key":"notification_test_resend_not_allowed","summary":"The notification is a channel test","id":"paths/~1address-tags~1{address_tag_id}~1actions~1remove/post/responses/409/content/application~1problem+json/examples/notification_test_resend_not_allowed"},"paths/~1address-tags~1{address_tag_id}~1actions~1remove/post/responses/503/content/application~1problem+json/examples/temporarily_unavailable":{"value":{"type":"https://docs.vilna.io/apis/errors#service-unavailable","title":"Service Unavailable","status":503,"code":"service.temporarily_unavailable","detail":"The operation is temporarily unavailable. Please try again later."},"key":"temporarily_unavailable","summary":"The operation cannot be completed at present","id":"paths/~1address-tags~1{address_tag_id}~1actions~1remove/post/responses/503/content/application~1problem+json/examples/temporarily_unavailable"},"paths/~1public-keys/get/responses/400/content/application~1problem+json/examples/malformed_json":{"value":{"type":"https://docs.vilna.io/apis/errors#invalid-request","title":"Invalid Request","status":400,"code":"request.malformed","detail":"The request could not be decoded.","instance":"/traces/0123456789abcdef0123456789abcdef"},"key":"malformed_json","summary":"The request body contains malformed JSON","id":"paths/~1public-keys/get/responses/400/content/application~1problem+json/examples/malformed_json"},"paths/~1public-keys/get/responses/401/content/application~1problem+json/examples/service_authentication_denied":{"value":{"type":"https://docs.vilna.io/apis/errors#unauthorized","title":"Unauthorized","status":401,"code":"unspecified","detail":"You are not authorized to access this resource. If the problem persists, please contact our support team.","instance":"/unauthorized?method=createInvoice"},"key":"service_authentication_denied","summary":"The API service refused authentication","id":"paths/~1public-keys/get/responses/401/content/application~1problem+json/examples/service_authentication_denied"},"paths/~1public-keys/get/responses/403/content/application~1problem+json/examples/insufficient_permissions":{"value":{"type":"https://docs.vilna.io/apis/errors#forbidden","title":"Forbidden","status":403,"code":"unspecified","detail":"Your credentials are valid but don't include the permission this operation needs. Check the API key permissions in the dashboard. Permissions are set when the key is created and can't be edited later. To change them, create a new key.","instance":"/forbidden?method=createInvoice"},"key":"insufficient_permissions","summary":"The API key lacks the required permission","id":"paths/~1public-keys/get/responses/403/content/application~1problem+json/examples/insufficient_permissions"},"paths/~1public-keys/get/responses/503/content/application~1problem+json/examples/temporarily_unavailable":{"value":{"type":"https://docs.vilna.io/apis/errors#service-unavailable","title":"Service Unavailable","status":503,"code":"service.temporarily_unavailable","detail":"The operation is temporarily unavailable. Please try again later."},"key":"temporarily_unavailable","summary":"The operation cannot be completed at present","id":"paths/~1public-keys/get/responses/503/content/application~1problem+json/examples/temporarily_unavailable"},"paths/~1public-keys/post/requestBody/content/application~1json/examples/xpub_example":{"value":{"derivation_path":"m/44'/0'/0'/0","label":"My Legacy Wallet","value":"xpub6F7C1ZtQ411zykk6KTEoQMqfNdxiSA4uxAwAoqFanijnAavqQvVmh5zZCH6Swhdbzt2HuMRLx4chEVRZu9ic4Cnkkq5AsQcmjeMASk6FLqf"},"key":"xpub_example","summary":"BIP44 public key","id":"paths/~1public-keys/post/requestBody/content/application~1json/examples/xpub_example"},"paths/~1public-keys/post/requestBody/content/application~1json/examples/ypub_example":{"value":{"derivation_path":"m/49'/0'/0'/0","label":"My SegWit Wallet","value":"ypub6ZtCaoXpd9GqsJMiFThRchS8RXiyRBD3WxyoZhhnKF9n198VSV8U38TPrrhMenYSXZGU4N8Q5J1XYEjc4JKr8Dj1BtvhCjNTRxPimrfCN4T"},"key":"ypub_example","summary":"BIP49 public key","id":"paths/~1public-keys/post/requestBody/content/application~1json/examples/ypub_example"},"paths/~1public-keys/post/requestBody/content/application~1json/examples/zpub_example":{"value":{"derivation_path":"m/84'/0'/0'/0","label":"My Native SegWit Wallet","value":"zpub6svdUH71uTR9YXumEJroNo51GfHdASMmzKFafeBr51yEzf4gj4cPBafQDjk18AGTZSfhXi8uMuuZKpSdmzHjZDTDCVK3KjVYj1NKUTFfCkk"},"key":"zpub_example","summary":"BIP84 public key","id":"paths/~1public-keys/post/requestBody/content/application~1json/examples/zpub_example"},"paths/~1public-keys/post/requestBody/content/application~1json/examples/taproot_example":{"value":{"derivation_path":"m/86'/0'/0'/0","label":"My Taproot Wallet","value":"xpub6DiEBECiexRBYEYhTgzmGn7UaGvG7yEPMgNgdib3iwHHJd7HPSnfniQ2mBamKVBLWYPbM7MqCVBHiTnFuLwNrZCbk2eY8N7hT4vV89XSJfH"},"key":"taproot_example","summary":"BIP86 public key (Taproot)","id":"paths/~1public-keys/post/requestBody/content/application~1json/examples/taproot_example"},"paths/~1public-keys/post/responses/400/content/application~1problem+json/examples/malformed_json":{"value":{"type":"https://docs.vilna.io/apis/errors#invalid-request","title":"Invalid Request","status":400,"code":"request.malformed","detail":"The request could not be decoded.","instance":"/traces/0123456789abcdef0123456789abcdef"},"key":"malformed_json","summary":"The request body contains malformed JSON","id":"paths/~1public-keys/post/responses/400/content/application~1problem+json/examples/malformed_json"},"paths/~1public-keys/post/responses/401/content/application~1problem+json/examples/service_authentication_denied":{"value":{"type":"https://docs.vilna.io/apis/errors#unauthorized","title":"Unauthorized","status":401,"code":"unspecified","detail":"You are not authorized to access this resource. If the problem persists, please contact our support team.","instance":"/unauthorized?method=createInvoice"},"key":"service_authentication_denied","summary":"The API service refused authentication","id":"paths/~1public-keys/post/responses/401/content/application~1problem+json/examples/service_authentication_denied"},"paths/~1public-keys/post/responses/403/content/application~1problem+json/examples/insufficient_permissions":{"value":{"type":"https://docs.vilna.io/apis/errors#forbidden","title":"Forbidden","status":403,"code":"unspecified","detail":"Your credentials are valid but don't include the permission this operation needs. Check the API key permissions in the dashboard. Permissions are set when the key is created and can't be edited later. To change them, create a new key.","instance":"/forbidden?method=createInvoice"},"key":"insufficient_permissions","summary":"The API key lacks the required permission","id":"paths/~1public-keys/post/responses/403/content/application~1problem+json/examples/insufficient_permissions"},"paths/~1public-keys/post/responses/409/content/application~1problem+json/examples/address_occupied":{"value":{"type":"https://docs.vilna.io/apis/errors#conflict","title":"Conflict","status":409,"code":"invoice.address_occupied","detail":"address already has an active invoice with different parameters","instance":"/traces/0123456789abcdef0123456789abcdef"},"key":"address_occupied","summary":"The address already has an active invoice","id":"paths/~1public-keys/post/responses/409/content/application~1problem+json/examples/address_occupied"},"paths/~1public-keys/post/responses/409/content/application~1problem+json/examples/address_in_use":{"value":{"type":"https://docs.vilna.io/apis/errors#conflict","title":"Conflict","status":409,"code":"address.in_use","detail":"address has an active invoice and cannot be deleted","instance":"/traces/0123456789abcdef0123456789abcdef"},"key":"address_in_use","summary":"The address cannot be deleted while in use","id":"paths/~1public-keys/post/responses/409/content/application~1problem+json/examples/address_in_use"},"paths/~1public-keys/post/responses/409/content/application~1problem+json/examples/subscription_v1_conflict":{"value":{"type":"https://docs.vilna.io/apis/errors#conflict","title":"Conflict","status":409,"code":"notification.subscription_v1_conflict","detail":"a subscription created through v1 accepts name and availability changes only","instance":"/traces/0123456789abcdef0123456789abcdef"},"key":"subscription_v1_conflict","summary":"A v1-created subscription rejects trigger, filter or noise changes","id":"paths/~1public-keys/post/responses/409/content/application~1problem+json/examples/subscription_v1_conflict"},"paths/~1public-keys/post/responses/409/content/application~1problem+json/examples/notification_send_in_progress":{"value":{"type":"https://docs.vilna.io/apis/errors#conflict","title":"Conflict","status":409,"code":"notification.send_in_progress","detail":"notification send is in progress","instance":"/traces/0123456789abcdef0123456789abcdef"},"key":"notification_send_in_progress","summary":"The notification already has a manual attempt queued or in flight","id":"paths/~1public-keys/post/responses/409/content/application~1problem+json/examples/notification_send_in_progress"},"paths/~1public-keys/post/responses/409/content/application~1problem+json/examples/notification_payload_unavailable":{"value":{"type":"https://docs.vilna.io/apis/errors#conflict","title":"Conflict","status":409,"code":"notification.payload_unavailable","detail":"notification payload is no longer available","instance":"/traces/0123456789abcdef0123456789abcdef"},"key":"notification_payload_unavailable","summary":"Retention has cleared the content, so there is nothing to resend","id":"paths/~1public-keys/post/responses/409/content/application~1problem+json/examples/notification_payload_unavailable"},"paths/~1public-keys/post/responses/409/content/application~1problem+json/examples/notification_test_resend_not_allowed":{"value":{"type":"https://docs.vilna.io/apis/errors#conflict","title":"Conflict","status":409,"code":"notification.test_resend_not_allowed","detail":"test notifications cannot be resent","instance":"/traces/0123456789abcdef0123456789abcdef"},"key":"notification_test_resend_not_allowed","summary":"The notification is a channel test","id":"paths/~1public-keys/post/responses/409/content/application~1problem+json/examples/notification_test_resend_not_allowed"},"paths/~1public-keys/post/responses/422/content/application~1problem+json/examples/invoice_not_cancellable":{"value":{"type":"https://docs.vilna.io/apis/errors#precondition","title":"Precondition Failed","status":422,"code":"invoice.not_cancellable","detail":"invoice cannot be cancelled in current status","instance":"/traces/0123456789abcdef0123456789abcdef","fields":[{"name":"status","reason":"confirmed"}]},"key":"invoice_not_cancellable","summary":"A confirmed invoice cannot be cancelled","id":"paths/~1public-keys/post/responses/422/content/application~1problem+json/examples/invoice_not_cancellable"},"paths/~1public-keys/post/responses/429/content/application~1problem+json/examples/address_quota":{"value":{"type":"https://docs.vilna.io/apis/errors#too-many-requests","title":"Too Many Requests","status":429,"code":"address.quota_exceeded","detail":"the project has reached its address limit","max":100},"key":"address_quota","summary":"The project has reached its address quota","id":"paths/~1public-keys/post/responses/429/content/application~1problem+json/examples/address_quota"},"paths/~1public-keys/post/responses/429/content/application~1problem+json/examples/creation_prohibited":{"value":{"type":"https://docs.vilna.io/apis/errors#too-many-requests","title":"Too Many Requests","status":429,"code":"channel.quota_exceeded","detail":"the project has reached its channel limit","max":0},"key":"creation_prohibited","summary":"A zero effective limit prohibits new resources","id":"paths/~1public-keys/post/responses/429/content/application~1problem+json/examples/creation_prohibited"},"paths/~1public-keys/post/responses/503/content/application~1problem+json/examples/temporarily_unavailable":{"value":{"type":"https://docs.vilna.io/apis/errors#service-unavailable","title":"Service Unavailable","status":503,"code":"service.temporarily_unavailable","detail":"The operation is temporarily unavailable. Please try again later."},"key":"temporarily_unavailable","summary":"The operation cannot be completed at present","id":"paths/~1public-keys/post/responses/503/content/application~1problem+json/examples/temporarily_unavailable"},"paths/~1public-keys~1{public_key_id}/delete/responses/400/content/application~1problem+json/examples/malformed_json":{"value":{"type":"https://docs.vilna.io/apis/errors#invalid-request","title":"Invalid Request","status":400,"code":"request.malformed","detail":"The request could not be decoded.","instance":"/traces/0123456789abcdef0123456789abcdef"},"key":"malformed_json","summary":"The request body contains malformed JSON","id":"paths/~1public-keys~1{public_key_id}/delete/responses/400/content/application~1problem+json/examples/malformed_json"},"paths/~1public-keys~1{public_key_id}/delete/responses/401/content/application~1problem+json/examples/service_authentication_denied":{"value":{"type":"https://docs.vilna.io/apis/errors#unauthorized","title":"Unauthorized","status":401,"code":"unspecified","detail":"You are not authorized to access this resource. If the problem persists, please contact our support team.","instance":"/unauthorized?method=createInvoice"},"key":"service_authentication_denied","summary":"The API service refused authentication","id":"paths/~1public-keys~1{public_key_id}/delete/responses/401/content/application~1problem+json/examples/service_authentication_denied"},"paths/~1public-keys~1{public_key_id}/delete/responses/403/content/application~1problem+json/examples/insufficient_permissions":{"value":{"type":"https://docs.vilna.io/apis/errors#forbidden","title":"Forbidden","status":403,"code":"unspecified","detail":"Your credentials are valid but don't include the permission this operation needs. Check the API key permissions in the dashboard. Permissions are set when the key is created and can't be edited later. To change them, create a new key.","instance":"/forbidden?method=createInvoice"},"key":"insufficient_permissions","summary":"The API key lacks the required permission","id":"paths/~1public-keys~1{public_key_id}/delete/responses/403/content/application~1problem+json/examples/insufficient_permissions"},"paths/~1public-keys~1{public_key_id}/delete/responses/404/content/application~1problem+json/examples/address_not_found":{"value":{"type":"https://docs.vilna.io/apis/errors#not-found","title":"Not Found","status":404,"code":"address.not_found","detail":"address not found","instance":"/traces/0123456789abcdef0123456789abcdef"},"key":"address_not_found","summary":"The address does not exist in this project","id":"paths/~1public-keys~1{public_key_id}/delete/responses/404/content/application~1problem+json/examples/address_not_found"},"paths/~1public-keys~1{public_key_id}/delete/responses/404/content/application~1problem+json/examples/invoice_not_found":{"value":{"type":"https://docs.vilna.io/apis/errors#not-found","title":"Not Found","status":404,"code":"invoice.not_found","detail":"invoice not found","instance":"/traces/0123456789abcdef0123456789abcdef"},"key":"invoice_not_found","summary":"The invoice does not exist in this project","id":"paths/~1public-keys~1{public_key_id}/delete/responses/404/content/application~1problem+json/examples/invoice_not_found"},"paths/~1public-keys~1{public_key_id}/delete/responses/409/content/application~1problem+json/examples/address_occupied":{"value":{"type":"https://docs.vilna.io/apis/errors#conflict","title":"Conflict","status":409,"code":"invoice.address_occupied","detail":"address already has an active invoice with different parameters","instance":"/traces/0123456789abcdef0123456789abcdef"},"key":"address_occupied","summary":"The address already has an active invoice","id":"paths/~1public-keys~1{public_key_id}/delete/responses/409/content/application~1problem+json/examples/address_occupied"},"paths/~1public-keys~1{public_key_id}/delete/responses/409/content/application~1problem+json/examples/address_in_use":{"value":{"type":"https://docs.vilna.io/apis/errors#conflict","title":"Conflict","status":409,"code":"address.in_use","detail":"address has an active invoice and cannot be deleted","instance":"/traces/0123456789abcdef0123456789abcdef"},"key":"address_in_use","summary":"The address cannot be deleted while in use","id":"paths/~1public-keys~1{public_key_id}/delete/responses/409/content/application~1problem+json/examples/address_in_use"},"paths/~1public-keys~1{public_key_id}/delete/responses/409/content/application~1problem+json/examples/subscription_v1_conflict":{"value":{"type":"https://docs.vilna.io/apis/errors#conflict","title":"Conflict","status":409,"code":"notification.subscription_v1_conflict","detail":"a subscription created through v1 accepts name and availability changes only","instance":"/traces/0123456789abcdef0123456789abcdef"},"key":"subscription_v1_conflict","summary":"A v1-created subscription rejects trigger, filter or noise changes","id":"paths/~1public-keys~1{public_key_id}/delete/responses/409/content/application~1problem+json/examples/subscription_v1_conflict"},"paths/~1public-keys~1{public_key_id}/delete/responses/409/content/application~1problem+json/examples/notification_send_in_progress":{"value":{"type":"https://docs.vilna.io/apis/errors#conflict","title":"Conflict","status":409,"code":"notification.send_in_progress","detail":"notification send is in progress","instance":"/traces/0123456789abcdef0123456789abcdef"},"key":"notification_send_in_progress","summary":"The notification already has a manual attempt queued or in flight","id":"paths/~1public-keys~1{public_key_id}/delete/responses/409/content/application~1problem+json/examples/notification_send_in_progress"},"paths/~1public-keys~1{public_key_id}/delete/responses/409/content/application~1problem+json/examples/notification_payload_unavailable":{"value":{"type":"https://docs.vilna.io/apis/errors#conflict","title":"Conflict","status":409,"code":"notification.payload_unavailable","detail":"notification payload is no longer available","instance":"/traces/0123456789abcdef0123456789abcdef"},"key":"notification_payload_unavailable","summary":"Retention has cleared the content, so there is nothing to resend","id":"paths/~1public-keys~1{public_key_id}/delete/responses/409/content/application~1problem+json/examples/notification_payload_unavailable"},"paths/~1public-keys~1{public_key_id}/delete/responses/409/content/application~1problem+json/examples/notification_test_resend_not_allowed":{"value":{"type":"https://docs.vilna.io/apis/errors#conflict","title":"Conflict","status":409,"code":"notification.test_resend_not_allowed","detail":"test notifications cannot be resent","instance":"/traces/0123456789abcdef0123456789abcdef"},"key":"notification_test_resend_not_allowed","summary":"The notification is a channel test","id":"paths/~1public-keys~1{public_key_id}/delete/responses/409/content/application~1problem+json/examples/notification_test_resend_not_allowed"},"paths/~1public-keys~1{public_key_id}/delete/responses/503/content/application~1problem+json/examples/temporarily_unavailable":{"value":{"type":"https://docs.vilna.io/apis/errors#service-unavailable","title":"Service Unavailable","status":503,"code":"service.temporarily_unavailable","detail":"The operation is temporarily unavailable. Please try again later."},"key":"temporarily_unavailable","summary":"The operation cannot be completed at present","id":"paths/~1public-keys~1{public_key_id}/delete/responses/503/content/application~1problem+json/examples/temporarily_unavailable"},"paths/~1public-keys~1{public_key_id}/get/responses/400/content/application~1problem+json/examples/malformed_json":{"value":{"type":"https://docs.vilna.io/apis/errors#invalid-request","title":"Invalid Request","status":400,"code":"request.malformed","detail":"The request could not be decoded.","instance":"/traces/0123456789abcdef0123456789abcdef"},"key":"malformed_json","summary":"The request body contains malformed JSON","id":"paths/~1public-keys~1{public_key_id}/get/responses/400/content/application~1problem+json/examples/malformed_json"},"paths/~1public-keys~1{public_key_id}/get/responses/401/content/application~1problem+json/examples/service_authentication_denied":{"value":{"type":"https://docs.vilna.io/apis/errors#unauthorized","title":"Unauthorized","status":401,"code":"unspecified","detail":"You are not authorized to access this resource. If the problem persists, please contact our support team.","instance":"/unauthorized?method=createInvoice"},"key":"service_authentication_denied","summary":"The API service refused authentication","id":"paths/~1public-keys~1{public_key_id}/get/responses/401/content/application~1problem+json/examples/service_authentication_denied"},"paths/~1public-keys~1{public_key_id}/get/responses/403/content/application~1problem+json/examples/insufficient_permissions":{"value":{"type":"https://docs.vilna.io/apis/errors#forbidden","title":"Forbidden","status":403,"code":"unspecified","detail":"Your credentials are valid but don't include the permission this operation needs. Check the API key permissions in the dashboard. Permissions are set when the key is created and can't be edited later. To change them, create a new key.","instance":"/forbidden?method=createInvoice"},"key":"insufficient_permissions","summary":"The API key lacks the required permission","id":"paths/~1public-keys~1{public_key_id}/get/responses/403/content/application~1problem+json/examples/insufficient_permissions"},"paths/~1public-keys~1{public_key_id}/get/responses/404/content/application~1problem+json/examples/address_not_found":{"value":{"type":"https://docs.vilna.io/apis/errors#not-found","title":"Not Found","status":404,"code":"address.not_found","detail":"address not found","instance":"/traces/0123456789abcdef0123456789abcdef"},"key":"address_not_found","summary":"The address does not exist in this project","id":"paths/~1public-keys~1{public_key_id}/get/responses/404/content/application~1problem+json/examples/address_not_found"},"paths/~1public-keys~1{public_key_id}/get/responses/404/content/application~1problem+json/examples/invoice_not_found":{"value":{"type":"https://docs.vilna.io/apis/errors#not-found","title":"Not Found","status":404,"code":"invoice.not_found","detail":"invoice not found","instance":"/traces/0123456789abcdef0123456789abcdef"},"key":"invoice_not_found","summary":"The invoice does not exist in this project","id":"paths/~1public-keys~1{public_key_id}/get/responses/404/content/application~1problem+json/examples/invoice_not_found"},"paths/~1public-keys~1{public_key_id}/get/responses/503/content/application~1problem+json/examples/temporarily_unavailable":{"value":{"type":"https://docs.vilna.io/apis/errors#service-unavailable","title":"Service Unavailable","status":503,"code":"service.temporarily_unavailable","detail":"The operation is temporarily unavailable. Please try again later."},"key":"temporarily_unavailable","summary":"The operation cannot be completed at present","id":"paths/~1public-keys~1{public_key_id}/get/responses/503/content/application~1problem+json/examples/temporarily_unavailable"},"paths/~1public-keys~1{public_key_id}/patch/responses/400/content/application~1problem+json/examples/malformed_json":{"value":{"type":"https://docs.vilna.io/apis/errors#invalid-request","title":"Invalid Request","status":400,"code":"request.malformed","detail":"The request could not be decoded.","instance":"/traces/0123456789abcdef0123456789abcdef"},"key":"malformed_json","summary":"The request body contains malformed JSON","id":"paths/~1public-keys~1{public_key_id}/patch/responses/400/content/application~1problem+json/examples/malformed_json"},"paths/~1public-keys~1{public_key_id}/patch/responses/401/content/application~1problem+json/examples/service_authentication_denied":{"value":{"type":"https://docs.vilna.io/apis/errors#unauthorized","title":"Unauthorized","status":401,"code":"unspecified","detail":"You are not authorized to access this resource. If the problem persists, please contact our support team.","instance":"/unauthorized?method=createInvoice"},"key":"service_authentication_denied","summary":"The API service refused authentication","id":"paths/~1public-keys~1{public_key_id}/patch/responses/401/content/application~1problem+json/examples/service_authentication_denied"},"paths/~1public-keys~1{public_key_id}/patch/responses/403/content/application~1problem+json/examples/insufficient_permissions":{"value":{"type":"https://docs.vilna.io/apis/errors#forbidden","title":"Forbidden","status":403,"code":"unspecified","detail":"Your credentials are valid but don't include the permission this operation needs. Check the API key permissions in the dashboard. Permissions are set when the key is created and can't be edited later. To change them, create a new key.","instance":"/forbidden?method=createInvoice"},"key":"insufficient_permissions","summary":"The API key lacks the required permission","id":"paths/~1public-keys~1{public_key_id}/patch/responses/403/content/application~1problem+json/examples/insufficient_permissions"},"paths/~1public-keys~1{public_key_id}/patch/responses/404/content/application~1problem+json/examples/address_not_found":{"value":{"type":"https://docs.vilna.io/apis/errors#not-found","title":"Not Found","status":404,"code":"address.not_found","detail":"address not found","instance":"/traces/0123456789abcdef0123456789abcdef"},"key":"address_not_found","summary":"The address does not exist in this project","id":"paths/~1public-keys~1{public_key_id}/patch/responses/404/content/application~1problem+json/examples/address_not_found"},"paths/~1public-keys~1{public_key_id}/patch/responses/404/content/application~1problem+json/examples/invoice_not_found":{"value":{"type":"https://docs.vilna.io/apis/errors#not-found","title":"Not Found","status":404,"code":"invoice.not_found","detail":"invoice not found","instance":"/traces/0123456789abcdef0123456789abcdef"},"key":"invoice_not_found","summary":"The invoice does not exist in this project","id":"paths/~1public-keys~1{public_key_id}/patch/responses/404/content/application~1problem+json/examples/invoice_not_found"},"paths/~1public-keys~1{public_key_id}/patch/responses/409/content/application~1problem+json/examples/address_occupied":{"value":{"type":"https://docs.vilna.io/apis/errors#conflict","title":"Conflict","status":409,"code":"invoice.address_occupied","detail":"address already has an active invoice with different parameters","instance":"/traces/0123456789abcdef0123456789abcdef"},"key":"address_occupied","summary":"The address already has an active invoice","id":"paths/~1public-keys~1{public_key_id}/patch/responses/409/content/application~1problem+json/examples/address_occupied"},"paths/~1public-keys~1{public_key_id}/patch/responses/409/content/application~1problem+json/examples/address_in_use":{"value":{"type":"https://docs.vilna.io/apis/errors#conflict","title":"Conflict","status":409,"code":"address.in_use","detail":"address has an active invoice and cannot be deleted","instance":"/traces/0123456789abcdef0123456789abcdef"},"key":"address_in_use","summary":"The address cannot be deleted while in use","id":"paths/~1public-keys~1{public_key_id}/patch/responses/409/content/application~1problem+json/examples/address_in_use"},"paths/~1public-keys~1{public_key_id}/patch/responses/409/content/application~1problem+json/examples/subscription_v1_conflict":{"value":{"type":"https://docs.vilna.io/apis/errors#conflict","title":"Conflict","status":409,"code":"notification.subscription_v1_conflict","detail":"a subscription created through v1 accepts name and availability changes only","instance":"/traces/0123456789abcdef0123456789abcdef"},"key":"subscription_v1_conflict","summary":"A v1-created subscription rejects trigger, filter or noise changes","id":"paths/~1public-keys~1{public_key_id}/patch/responses/409/content/application~1problem+json/examples/subscription_v1_conflict"},"paths/~1public-keys~1{public_key_id}/patch/responses/409/content/application~1problem+json/examples/notification_send_in_progress":{"value":{"type":"https://docs.vilna.io/apis/errors#conflict","title":"Conflict","status":409,"code":"notification.send_in_progress","detail":"notification send is in progress","instance":"/traces/0123456789abcdef0123456789abcdef"},"key":"notification_send_in_progress","summary":"The notification already has a manual attempt queued or in flight","id":"paths/~1public-keys~1{public_key_id}/patch/responses/409/content/application~1problem+json/examples/notification_send_in_progress"},"paths/~1public-keys~1{public_key_id}/patch/responses/409/content/application~1problem+json/examples/notification_payload_unavailable":{"value":{"type":"https://docs.vilna.io/apis/errors#conflict","title":"Conflict","status":409,"code":"notification.payload_unavailable","detail":"notification payload is no longer available","instance":"/traces/0123456789abcdef0123456789abcdef"},"key":"notification_payload_unavailable","summary":"Retention has cleared the content, so there is nothing to resend","id":"paths/~1public-keys~1{public_key_id}/patch/responses/409/content/application~1problem+json/examples/notification_payload_unavailable"},"paths/~1public-keys~1{public_key_id}/patch/responses/409/content/application~1problem+json/examples/notification_test_resend_not_allowed":{"value":{"type":"https://docs.vilna.io/apis/errors#conflict","title":"Conflict","status":409,"code":"notification.test_resend_not_allowed","detail":"test notifications cannot be resent","instance":"/traces/0123456789abcdef0123456789abcdef"},"key":"notification_test_resend_not_allowed","summary":"The notification is a channel test","id":"paths/~1public-keys~1{public_key_id}/patch/responses/409/content/application~1problem+json/examples/notification_test_resend_not_allowed"},"paths/~1public-keys~1{public_key_id}/patch/responses/503/content/application~1problem+json/examples/temporarily_unavailable":{"value":{"type":"https://docs.vilna.io/apis/errors#service-unavailable","title":"Service Unavailable","status":503,"code":"service.temporarily_unavailable","detail":"The operation is temporarily unavailable. Please try again later."},"key":"temporarily_unavailable","summary":"The operation cannot be completed at present","id":"paths/~1public-keys~1{public_key_id}/patch/responses/503/content/application~1problem+json/examples/temporarily_unavailable"},"paths/~1public-keys~1{public_key_id}~1children/post/requestBody/content/application~1json/examples/external_child":{"value":{"change":0,"label":"BTC Receiving"},"key":"external_child","summary":"External chain (receiving addresses)","id":"paths/~1public-keys~1{public_key_id}~1children/post/requestBody/content/application~1json/examples/external_child"},"paths/~1public-keys~1{public_key_id}~1children/post/requestBody/content/application~1json/examples/internal_child":{"value":{"change":1,"label":"BTC Change"},"key":"internal_child","summary":"Internal chain (change addresses)","id":"paths/~1public-keys~1{public_key_id}~1children/post/requestBody/content/application~1json/examples/internal_child"},"paths/~1public-keys~1{public_key_id}~1children/post/responses/400/content/application~1problem+json/examples/malformed_json":{"value":{"type":"https://docs.vilna.io/apis/errors#invalid-request","title":"Invalid Request","status":400,"code":"request.malformed","detail":"The request could not be decoded.","instance":"/traces/0123456789abcdef0123456789abcdef"},"key":"malformed_json","summary":"The request body contains malformed JSON","id":"paths/~1public-keys~1{public_key_id}~1children/post/responses/400/content/application~1problem+json/examples/malformed_json"},"paths/~1public-keys~1{public_key_id}~1children/post/responses/401/content/application~1problem+json/examples/service_authentication_denied":{"value":{"type":"https://docs.vilna.io/apis/errors#unauthorized","title":"Unauthorized","status":401,"code":"unspecified","detail":"You are not authorized to access this resource. If the problem persists, please contact our support team.","instance":"/unauthorized?method=createInvoice"},"key":"service_authentication_denied","summary":"The API service refused authentication","id":"paths/~1public-keys~1{public_key_id}~1children/post/responses/401/content/application~1problem+json/examples/service_authentication_denied"},"paths/~1public-keys~1{public_key_id}~1children/post/responses/403/content/application~1problem+json/examples/insufficient_permissions":{"value":{"type":"https://docs.vilna.io/apis/errors#forbidden","title":"Forbidden","status":403,"code":"unspecified","detail":"Your credentials are valid but don't include the permission this operation needs. Check the API key permissions in the dashboard. Permissions are set when the key is created and can't be edited later. To change them, create a new key.","instance":"/forbidden?method=createInvoice"},"key":"insufficient_permissions","summary":"The API key lacks the required permission","id":"paths/~1public-keys~1{public_key_id}~1children/post/responses/403/content/application~1problem+json/examples/insufficient_permissions"},"paths/~1public-keys~1{public_key_id}~1children/post/responses/404/content/application~1problem+json/examples/address_not_found":{"value":{"type":"https://docs.vilna.io/apis/errors#not-found","title":"Not Found","status":404,"code":"address.not_found","detail":"address not found","instance":"/traces/0123456789abcdef0123456789abcdef"},"key":"address_not_found","summary":"The address does not exist in this project","id":"paths/~1public-keys~1{public_key_id}~1children/post/responses/404/content/application~1problem+json/examples/address_not_found"},"paths/~1public-keys~1{public_key_id}~1children/post/responses/404/content/application~1problem+json/examples/invoice_not_found":{"value":{"type":"https://docs.vilna.io/apis/errors#not-found","title":"Not Found","status":404,"code":"invoice.not_found","detail":"invoice not found","instance":"/traces/0123456789abcdef0123456789abcdef"},"key":"invoice_not_found","summary":"The invoice does not exist in this project","id":"paths/~1public-keys~1{public_key_id}~1children/post/responses/404/content/application~1problem+json/examples/invoice_not_found"},"paths/~1public-keys~1{public_key_id}~1children/post/responses/409/content/application~1problem+json/examples/address_occupied":{"value":{"type":"https://docs.vilna.io/apis/errors#conflict","title":"Conflict","status":409,"code":"invoice.address_occupied","detail":"address already has an active invoice with different parameters","instance":"/traces/0123456789abcdef0123456789abcdef"},"key":"address_occupied","summary":"The address already has an active invoice","id":"paths/~1public-keys~1{public_key_id}~1children/post/responses/409/content/application~1problem+json/examples/address_occupied"},"paths/~1public-keys~1{public_key_id}~1children/post/responses/409/content/application~1problem+json/examples/address_in_use":{"value":{"type":"https://docs.vilna.io/apis/errors#conflict","title":"Conflict","status":409,"code":"address.in_use","detail":"address has an active invoice and cannot be deleted","instance":"/traces/0123456789abcdef0123456789abcdef"},"key":"address_in_use","summary":"The address cannot be deleted while in use","id":"paths/~1public-keys~1{public_key_id}~1children/post/responses/409/content/application~1problem+json/examples/address_in_use"},"paths/~1public-keys~1{public_key_id}~1children/post/responses/409/content/application~1problem+json/examples/subscription_v1_conflict":{"value":{"type":"https://docs.vilna.io/apis/errors#conflict","title":"Conflict","status":409,"code":"notification.subscription_v1_conflict","detail":"a subscription created through v1 accepts name and availability changes only","instance":"/traces/0123456789abcdef0123456789abcdef"},"key":"subscription_v1_conflict","summary":"A v1-created subscription rejects trigger, filter or noise changes","id":"paths/~1public-keys~1{public_key_id}~1children/post/responses/409/content/application~1problem+json/examples/subscription_v1_conflict"},"paths/~1public-keys~1{public_key_id}~1children/post/responses/409/content/application~1problem+json/examples/notification_send_in_progress":{"value":{"type":"https://docs.vilna.io/apis/errors#conflict","title":"Conflict","status":409,"code":"notification.send_in_progress","detail":"notification send is in progress","instance":"/traces/0123456789abcdef0123456789abcdef"},"key":"notification_send_in_progress","summary":"The notification already has a manual attempt queued or in flight","id":"paths/~1public-keys~1{public_key_id}~1children/post/responses/409/content/application~1problem+json/examples/notification_send_in_progress"},"paths/~1public-keys~1{public_key_id}~1children/post/responses/409/content/application~1problem+json/examples/notification_payload_unavailable":{"value":{"type":"https://docs.vilna.io/apis/errors#conflict","title":"Conflict","status":409,"code":"notification.payload_unavailable","detail":"notification payload is no longer available","instance":"/traces/0123456789abcdef0123456789abcdef"},"key":"notification_payload_unavailable","summary":"Retention has cleared the content, so there is nothing to resend","id":"paths/~1public-keys~1{public_key_id}~1children/post/responses/409/content/application~1problem+json/examples/notification_payload_unavailable"},"paths/~1public-keys~1{public_key_id}~1children/post/responses/409/content/application~1problem+json/examples/notification_test_resend_not_allowed":{"value":{"type":"https://docs.vilna.io/apis/errors#conflict","title":"Conflict","status":409,"code":"notification.test_resend_not_allowed","detail":"test notifications cannot be resent","instance":"/traces/0123456789abcdef0123456789abcdef"},"key":"notification_test_resend_not_allowed","summary":"The notification is a channel test","id":"paths/~1public-keys~1{public_key_id}~1children/post/responses/409/content/application~1problem+json/examples/notification_test_resend_not_allowed"},"paths/~1public-keys~1{public_key_id}~1children/post/responses/422/content/application~1problem+json/examples/invoice_not_cancellable":{"value":{"type":"https://docs.vilna.io/apis/errors#precondition","title":"Precondition Failed","status":422,"code":"invoice.not_cancellable","detail":"invoice cannot be cancelled in current status","instance":"/traces/0123456789abcdef0123456789abcdef","fields":[{"name":"status","reason":"confirmed"}]},"key":"invoice_not_cancellable","summary":"A confirmed invoice cannot be cancelled","id":"paths/~1public-keys~1{public_key_id}~1children/post/responses/422/content/application~1problem+json/examples/invoice_not_cancellable"},"paths/~1public-keys~1{public_key_id}~1children/post/responses/429/content/application~1problem+json/examples/address_quota":{"value":{"type":"https://docs.vilna.io/apis/errors#too-many-requests","title":"Too Many Requests","status":429,"code":"address.quota_exceeded","detail":"the project has reached its address limit","max":100},"key":"address_quota","summary":"The project has reached its address quota","id":"paths/~1public-keys~1{public_key_id}~1children/post/responses/429/content/application~1problem+json/examples/address_quota"},"paths/~1public-keys~1{public_key_id}~1children/post/responses/429/content/application~1problem+json/examples/creation_prohibited":{"value":{"type":"https://docs.vilna.io/apis/errors#too-many-requests","title":"Too Many Requests","status":429,"code":"channel.quota_exceeded","detail":"the project has reached its channel limit","max":0},"key":"creation_prohibited","summary":"A zero effective limit prohibits new resources","id":"paths/~1public-keys~1{public_key_id}~1children/post/responses/429/content/application~1problem+json/examples/creation_prohibited"},"paths/~1public-keys~1{public_key_id}~1children/post/responses/503/content/application~1problem+json/examples/temporarily_unavailable":{"value":{"type":"https://docs.vilna.io/apis/errors#service-unavailable","title":"Service Unavailable","status":503,"code":"service.temporarily_unavailable","detail":"The operation is temporarily unavailable. Please try again later."},"key":"temporarily_unavailable","summary":"The operation cannot be completed at present","id":"paths/~1public-keys~1{public_key_id}~1children/post/responses/503/content/application~1problem+json/examples/temporarily_unavailable"},"paths/~1transactions/get/responses/200/content/application~1json/example":{"value":{"items":[{"chain_gid":"eip155:1","txid":"0x1234567890abcdef1234567890abcdef1234567890abcdef1234567890abcdef","created_at":"2024-01-15T10:30:00Z","details":{"family":"evm","block_height":18500000,"is_success":true}},{"chain_gid":"tron:728126428","txid":"3f1c9e2d4b5a6978c0d1e2f3a4b5c6d7e8f90a1b2c3d4e5f60718293a4b5c6d7","created_at":"2024-01-15T10:28:00Z","details":{"family":"tron","block_height":67635453,"is_success":true}},{"chain_gid":"bip122:000000000019d6689c085ae165831e93","txid":"4a5e1e4baab89f3a32518a88c31bc87f618f76673e2cc77ab2127b7afdeda33b","created_at":"2024-01-15T10:20:00Z","details":{"family":"bitcoin","block_height":820000}}],"references":{"tokens":{"eip155:1/erc20:0xdAC17F958D2ee523a2206206994597C13D831ec7":{"gid":"eip155:1/erc20:0xdAC17F958D2ee523a2206206994597C13D831ec7","symbol":"USDT","name":"Tether USD","decimals":6}},"blockchains":{"eip155:1":{"gid":"eip155:1","name":"ethereum","short_name":"eth","image_url":"https://raw.githubusercontent.com/vilna-io/icons/refs/heads/main/chains/ethereum.svg"}},"addresses":{"0x742d35cc6634c0532925a3b8d1e1d78d8E15e5c4":"Hot wallet"}},"meta":{"limit":20,"page":1,"total":3,"total_pages":1}},"id":"paths/~1transactions/get/responses/200/content/application~1json/example"},"paths/~1transactions/get/responses/400/content/application~1problem+json/examples/malformed_json":{"value":{"type":"https://docs.vilna.io/apis/errors#invalid-request","title":"Invalid Request","status":400,"code":"request.malformed","detail":"The request could not be decoded.","instance":"/traces/0123456789abcdef0123456789abcdef"},"key":"malformed_json","summary":"The request body contains malformed JSON","id":"paths/~1transactions/get/responses/400/content/application~1problem+json/examples/malformed_json"},"paths/~1transactions/get/responses/401/content/application~1problem+json/examples/service_authentication_denied":{"value":{"type":"https://docs.vilna.io/apis/errors#unauthorized","title":"Unauthorized","status":401,"code":"unspecified","detail":"You are not authorized to access this resource. If the problem persists, please contact our support team.","instance":"/unauthorized?method=createInvoice"},"key":"service_authentication_denied","summary":"The API service refused authentication","id":"paths/~1transactions/get/responses/401/content/application~1problem+json/examples/service_authentication_denied"},"paths/~1transactions/get/responses/403/content/application~1problem+json/examples/insufficient_permissions":{"value":{"type":"https://docs.vilna.io/apis/errors#forbidden","title":"Forbidden","status":403,"code":"unspecified","detail":"Your credentials are valid but don't include the permission this operation needs. Check the API key permissions in the dashboard. Permissions are set when the key is created and can't be edited later. To change them, create a new key.","instance":"/forbidden?method=createInvoice"},"key":"insufficient_permissions","summary":"The API key lacks the required permission","id":"paths/~1transactions/get/responses/403/content/application~1problem+json/examples/insufficient_permissions"},"paths/~1transactions/get/responses/503/content/application~1problem+json/examples/temporarily_unavailable":{"value":{"type":"https://docs.vilna.io/apis/errors#service-unavailable","title":"Service Unavailable","status":503,"code":"service.temporarily_unavailable","detail":"The operation is temporarily unavailable. Please try again later."},"key":"temporarily_unavailable","summary":"The operation cannot be completed at present","id":"paths/~1transactions/get/responses/503/content/application~1problem+json/examples/temporarily_unavailable"},"paths/~1transactions~1{chain_gid}~1{txid}/get/responses/200/content/application~1json/example":{"value":{"item":{"chain_gid":"eip155:1","txid":"0x1234567890abcdef1234567890abcdef1234567890abcdef1234567890abcdef","created_at":"2024-01-15T10:30:00Z","activity":[{"chain_gid":"eip155:1","txid":"0x1234567890abcdef1234567890abcdef1234567890abcdef1234567890abcdef","address":"0x742d35cc6634c0532925a3b8d1e1d78d8E15e5c4","asset_gid":"eip155:1/erc20:0xdAC17F958D2ee523a2206206994597C13D831ec7","direction":"out","delta":{"base":"-1000000","formatted":"-1.0"},"created_at":"2024-01-15T10:30:00Z","entry_kind":"token_transfer"},{"chain_gid":"eip155:1","txid":"0x1234567890abcdef1234567890abcdef1234567890abcdef1234567890abcdef","address":"0x742d35cc6634c0532925a3b8d1e1d78d8E15e5c4","asset_gid":"eip155:1/slip44:60","direction":"out","delta":{"base":"-21000000000000000","formatted":"-0.021"},"created_at":"2024-01-15T10:30:00Z","entry_kind":"network_fee"}],"details":{"family":"evm","events":[{"event_index":0,"kind":"transfer","asset_gid":"eip155:1/erc20:0xdAC17F958D2ee523a2206206994597C13D831ec7","amount":{"base":"1000000","formatted":"1.0"},"operation":"transfer","from_address":"0x742d35cc6634c0532925a3b8d1e1d78d8E15e5c4","to_address":"0x95212290dd7278aa3ddd389cc1e1d165cc4bafe5"},{"event_index":1,"kind":"interaction","target_address":"0xdAC17F958D2ee523a2206206994597C13D831ec7","caller_address":"0x742d35cc6634c0532925a3b8d1e1d78d8E15e5c4","outcome":"succeeded"}],"is_success":true,"fee":{"base":"21000000000000000","formatted":"0.021"},"block":{"block_hash":"0x9f1c2a3b4d5e6f708192a3b4c5d6e7f8091a2b3c4d5e6f708192a3b4c5d6e7f8","block_height":18500000},"transaction_index":42,"from_address":"0x742d35cc6634c0532925a3b8d1e1d78d8E15e5c4","to_address":"0xdAC17F958D2ee523a2206206994597C13D831ec7","gas_used":65000}},"references":{"tokens":{"eip155:1/erc20:0xdAC17F958D2ee523a2206206994597C13D831ec7":{"gid":"eip155:1/erc20:0xdAC17F958D2ee523a2206206994597C13D831ec7","symbol":"USDT","name":"Tether USD","decimals":6}},"blockchains":{"eip155:1":{"gid":"eip155:1","name":"ethereum","short_name":"eth","image_url":"https://raw.githubusercontent.com/vilna-io/icons/refs/heads/main/chains/ethereum.svg"}},"addresses":{"0x742d35cc6634c0532925a3b8d1e1d78d8E15e5c4":"Hot wallet"}}},"id":"paths/~1transactions~1{chain_gid}~1{txid}/get/responses/200/content/application~1json/example"},"paths/~1transactions~1{chain_gid}~1{txid}/get/responses/400/content/application~1problem+json/examples/malformed_json":{"value":{"type":"https://docs.vilna.io/apis/errors#invalid-request","title":"Invalid Request","status":400,"code":"request.malformed","detail":"The request could not be decoded.","instance":"/traces/0123456789abcdef0123456789abcdef"},"key":"malformed_json","summary":"The request body contains malformed JSON","id":"paths/~1transactions~1{chain_gid}~1{txid}/get/responses/400/content/application~1problem+json/examples/malformed_json"},"paths/~1transactions~1{chain_gid}~1{txid}/get/responses/401/content/application~1problem+json/examples/service_authentication_denied":{"value":{"type":"https://docs.vilna.io/apis/errors#unauthorized","title":"Unauthorized","status":401,"code":"unspecified","detail":"You are not authorized to access this resource. If the problem persists, please contact our support team.","instance":"/unauthorized?method=createInvoice"},"key":"service_authentication_denied","summary":"The API service refused authentication","id":"paths/~1transactions~1{chain_gid}~1{txid}/get/responses/401/content/application~1problem+json/examples/service_authentication_denied"},"paths/~1transactions~1{chain_gid}~1{txid}/get/responses/403/content/application~1problem+json/examples/insufficient_permissions":{"value":{"type":"https://docs.vilna.io/apis/errors#forbidden","title":"Forbidden","status":403,"code":"unspecified","detail":"Your credentials are valid but don't include the permission this operation needs. Check the API key permissions in the dashboard. Permissions are set when the key is created and can't be edited later. To change them, create a new key.","instance":"/forbidden?method=createInvoice"},"key":"insufficient_permissions","summary":"The API key lacks the required permission","id":"paths/~1transactions~1{chain_gid}~1{txid}/get/responses/403/content/application~1problem+json/examples/insufficient_permissions"},"paths/~1transactions~1{chain_gid}~1{txid}/get/responses/404/content/application~1problem+json/examples/address_not_found":{"value":{"type":"https://docs.vilna.io/apis/errors#not-found","title":"Not Found","status":404,"code":"address.not_found","detail":"address not found","instance":"/traces/0123456789abcdef0123456789abcdef"},"key":"address_not_found","summary":"The address does not exist in this project","id":"paths/~1transactions~1{chain_gid}~1{txid}/get/responses/404/content/application~1problem+json/examples/address_not_found"},"paths/~1transactions~1{chain_gid}~1{txid}/get/responses/404/content/application~1problem+json/examples/invoice_not_found":{"value":{"type":"https://docs.vilna.io/apis/errors#not-found","title":"Not Found","status":404,"code":"invoice.not_found","detail":"invoice not found","instance":"/traces/0123456789abcdef0123456789abcdef"},"key":"invoice_not_found","summary":"The invoice does not exist in this project","id":"paths/~1transactions~1{chain_gid}~1{txid}/get/responses/404/content/application~1problem+json/examples/invoice_not_found"},"paths/~1transactions~1{chain_gid}~1{txid}/get/responses/503/content/application~1problem+json/examples/temporarily_unavailable":{"value":{"type":"https://docs.vilna.io/apis/errors#service-unavailable","title":"Service Unavailable","status":503,"code":"service.temporarily_unavailable","detail":"The operation is temporarily unavailable. Please try again later."},"key":"temporarily_unavailable","summary":"The operation cannot be completed at present","id":"paths/~1transactions~1{chain_gid}~1{txid}/get/responses/503/content/application~1problem+json/examples/temporarily_unavailable"},"paths/~1invoices/get/responses/400/content/application~1problem+json/examples/malformed_json":{"value":{"type":"https://docs.vilna.io/apis/errors#invalid-request","title":"Invalid Request","status":400,"code":"request.malformed","detail":"The request could not be decoded.","instance":"/traces/0123456789abcdef0123456789abcdef"},"key":"malformed_json","summary":"The request body contains malformed JSON","id":"paths/~1invoices/get/responses/400/content/application~1problem+json/examples/malformed_json"},"paths/~1invoices/get/responses/401/content/application~1problem+json/examples/service_authentication_denied":{"value":{"type":"https://docs.vilna.io/apis/errors#unauthorized","title":"Unauthorized","status":401,"code":"unspecified","detail":"You are not authorized to access this resource. If the problem persists, please contact our support team.","instance":"/unauthorized?method=createInvoice"},"key":"service_authentication_denied","summary":"The API service refused authentication","id":"paths/~1invoices/get/responses/401/content/application~1problem+json/examples/service_authentication_denied"},"paths/~1invoices/get/responses/403/content/application~1problem+json/examples/insufficient_permissions":{"value":{"type":"https://docs.vilna.io/apis/errors#forbidden","title":"Forbidden","status":403,"code":"unspecified","detail":"Your credentials are valid but don't include the permission this operation needs. Check the API key permissions in the dashboard. Permissions are set when the key is created and can't be edited later. To change them, create a new key.","instance":"/forbidden?method=createInvoice"},"key":"insufficient_permissions","summary":"The API key lacks the required permission","id":"paths/~1invoices/get/responses/403/content/application~1problem+json/examples/insufficient_permissions"},"paths/~1invoices/get/responses/503/content/application~1problem+json/examples/temporarily_unavailable":{"value":{"type":"https://docs.vilna.io/apis/errors#service-unavailable","title":"Service Unavailable","status":503,"code":"service.temporarily_unavailable","detail":"The operation is temporarily unavailable. Please try again later."},"key":"temporarily_unavailable","summary":"The operation cannot be completed at present","id":"paths/~1invoices/get/responses/503/content/application~1problem+json/examples/temporarily_unavailable"},"paths/~1invoices/post/requestBody/content/application~1json/examples/create_usdt_invoice":{"value":{"address":"0x742d35Cc6634C0532925a3b844Bc9e7595f2bD18","asset_gid":"eip155:56/erc20:0x55d398326f99059fF775485246999027B3197955","amount":"42500000","expires_at":"2024-01-15T13:00:00Z","metadata":{"order_id":"1234"}},"key":"create_usdt_invoice","summary":"USDT invoice on BNB Smart Chain","id":"paths/~1invoices/post/requestBody/content/application~1json/examples/create_usdt_invoice"},"paths/~1invoices/post/responses/200/content/application~1json/examples/open_invoice":{"value":{"item":{"id":"550e8400-e29b-41d4-a716-446655440000","address":"0x742d35Cc6634C0532925a3b844Bc9e7595f2bD18","asset_gid":"eip155:56/erc20:0x55d398326f99059fF775485246999027B3197955","amount":"42500000","received_amount":"0","confirmed_amount":"0","status":"open","expires_at":"2024-01-15T13:00:00Z","metadata":{"order_id":"1234"},"created_at":"2024-01-15T10:30:00Z","updated_at":"2024-01-15T10:30:00Z","status_logs":[{"status":"open","comment":null,"changed_at":"2024-01-15T10:30:00Z"}],"transactions":[]},"references":{"tokens":{},"blockchains":{},"transactions":{}}},"key":"open_invoice","summary":"Just created, awaiting payment","id":"paths/~1invoices/post/responses/200/content/application~1json/examples/open_invoice"},"paths/~1invoices/post/responses/200/content/application~1json/examples/confirmed_invoice":{"value":{"item":{"id":"550e8400-e29b-41d4-a716-446655440000","address":"0x742d35Cc6634C0532925a3b844Bc9e7595f2bD18","asset_gid":"eip155:56/erc20:0x55d398326f99059fF775485246999027B3197955","amount":"42500000","received_amount":"42500000","confirmed_amount":"42500000","status":"confirmed","expires_at":"2024-01-15T13:00:00Z","metadata":{"order_id":"1234"},"created_at":"2024-01-15T10:30:00Z","updated_at":"2024-01-15T12:15:00Z","status_logs":[{"status":"open","comment":null,"changed_at":"2024-01-15T10:30:00Z"},{"status":"confirmed","comment":null,"changed_at":"2024-01-15T12:15:00Z"}],"transactions":[{"chain_gid":"eip155:56","txid":"0xabc123def456789012345678901234567890123456789012345678901234abcd","is_active":true,"deposits":[{"asset_gid":"eip155:56/erc20:0x55d398326f99059fF775485246999027B3197955","amount":"42500000","is_matched":true}]},{"chain_gid":"eip155:56","txid":"0x9876543210fedcba9876543210fedcba9876543210fedcba9876543210fedc","is_active":false,"deposits":[]}]},"references":{"tokens":{},"blockchains":{},"transactions":{"eip155:56":{"0xabc123def456789012345678901234567890123456789012345678901234abcd":{"chain_gid":"eip155:56","txid":"0xabc123def456789012345678901234567890123456789012345678901234abcd","created_at":"2024-01-15T12:05:00Z","details":{"family":"evm","block_height":12345678,"is_success":true}}}}}},"key":"confirmed_invoice","summary":"Paid in full and confirmed on-chain","id":"paths/~1invoices/post/responses/200/content/application~1json/examples/confirmed_invoice"},"paths/~1invoices/post/responses/201/content/application~1json/examples/open_invoice":{"value":{"item":{"id":"550e8400-e29b-41d4-a716-446655440000","address":"0x742d35Cc6634C0532925a3b844Bc9e7595f2bD18","asset_gid":"eip155:56/erc20:0x55d398326f99059fF775485246999027B3197955","amount":"42500000","received_amount":"0","confirmed_amount":"0","status":"open","expires_at":"2024-01-15T13:00:00Z","metadata":{"order_id":"1234"},"created_at":"2024-01-15T10:30:00Z","updated_at":"2024-01-15T10:30:00Z","status_logs":[{"status":"open","comment":null,"changed_at":"2024-01-15T10:30:00Z"}],"transactions":[]},"references":{"tokens":{},"blockchains":{},"transactions":{}}},"key":"open_invoice","summary":"Just created, awaiting payment","id":"paths/~1invoices/post/responses/201/content/application~1json/examples/open_invoice"},"paths/~1invoices/post/responses/201/content/application~1json/examples/confirmed_invoice":{"value":{"item":{"id":"550e8400-e29b-41d4-a716-446655440000","address":"0x742d35Cc6634C0532925a3b844Bc9e7595f2bD18","asset_gid":"eip155:56/erc20:0x55d398326f99059fF775485246999027B3197955","amount":"42500000","received_amount":"42500000","confirmed_amount":"42500000","status":"confirmed","expires_at":"2024-01-15T13:00:00Z","metadata":{"order_id":"1234"},"created_at":"2024-01-15T10:30:00Z","updated_at":"2024-01-15T12:15:00Z","status_logs":[{"status":"open","comment":null,"changed_at":"2024-01-15T10:30:00Z"},{"status":"confirmed","comment":null,"changed_at":"2024-01-15T12:15:00Z"}],"transactions":[{"chain_gid":"eip155:56","txid":"0xabc123def456789012345678901234567890123456789012345678901234abcd","is_active":true,"deposits":[{"asset_gid":"eip155:56/erc20:0x55d398326f99059fF775485246999027B3197955","amount":"42500000","is_matched":true}]},{"chain_gid":"eip155:56","txid":"0x9876543210fedcba9876543210fedcba9876543210fedcba9876543210fedc","is_active":false,"deposits":[]}]},"references":{"tokens":{},"blockchains":{},"transactions":{"eip155:56":{"0xabc123def456789012345678901234567890123456789012345678901234abcd":{"chain_gid":"eip155:56","txid":"0xabc123def456789012345678901234567890123456789012345678901234abcd","created_at":"2024-01-15T12:05:00Z","details":{"family":"evm","block_height":12345678,"is_success":true}}}}}},"key":"confirmed_invoice","summary":"Paid in full and confirmed on-chain","id":"paths/~1invoices/post/responses/201/content/application~1json/examples/confirmed_invoice"},"paths/~1invoices/post/responses/400/content/application~1problem+json/examples/malformed_json":{"value":{"type":"https://docs.vilna.io/apis/errors#invalid-request","title":"Invalid Request","status":400,"code":"request.malformed","detail":"The request could not be decoded.","instance":"/traces/0123456789abcdef0123456789abcdef"},"key":"malformed_json","summary":"The request body contains malformed JSON","id":"paths/~1invoices/post/responses/400/content/application~1problem+json/examples/malformed_json"},"paths/~1invoices/post/responses/401/content/application~1problem+json/examples/service_authentication_denied":{"value":{"type":"https://docs.vilna.io/apis/errors#unauthorized","title":"Unauthorized","status":401,"code":"unspecified","detail":"You are not authorized to access this resource. If the problem persists, please contact our support team.","instance":"/unauthorized?method=createInvoice"},"key":"service_authentication_denied","summary":"The API service refused authentication","id":"paths/~1invoices/post/responses/401/content/application~1problem+json/examples/service_authentication_denied"},"paths/~1invoices/post/responses/403/content/application~1problem+json/examples/insufficient_permissions":{"value":{"type":"https://docs.vilna.io/apis/errors#forbidden","title":"Forbidden","status":403,"code":"unspecified","detail":"Your credentials are valid but don't include the permission this operation needs. Check the API key permissions in the dashboard. Permissions are set when the key is created and can't be edited later. To change them, create a new key.","instance":"/forbidden?method=createInvoice"},"key":"insufficient_permissions","summary":"The API key lacks the required permission","id":"paths/~1invoices/post/responses/403/content/application~1problem+json/examples/insufficient_permissions"},"paths/~1invoices/post/responses/404/content/application~1problem+json/examples/address_not_found":{"value":{"type":"https://docs.vilna.io/apis/errors#not-found","title":"Not Found","status":404,"code":"address.not_found","detail":"address not found","instance":"/traces/0123456789abcdef0123456789abcdef"},"key":"address_not_found","summary":"The address does not exist in this project","id":"paths/~1invoices/post/responses/404/content/application~1problem+json/examples/address_not_found"},"paths/~1invoices/post/responses/404/content/application~1problem+json/examples/invoice_not_found":{"value":{"type":"https://docs.vilna.io/apis/errors#not-found","title":"Not Found","status":404,"code":"invoice.not_found","detail":"invoice not found","instance":"/traces/0123456789abcdef0123456789abcdef"},"key":"invoice_not_found","summary":"The invoice does not exist in this project","id":"paths/~1invoices/post/responses/404/content/application~1problem+json/examples/invoice_not_found"},"paths/~1invoices/post/responses/409/content/application~1problem+json/examples/address_occupied":{"value":{"type":"https://docs.vilna.io/apis/errors#conflict","title":"Conflict","status":409,"code":"invoice.address_occupied","detail":"address already has an active invoice with different parameters","instance":"/traces/0123456789abcdef0123456789abcdef"},"key":"address_occupied","summary":"The address already has an active invoice","id":"paths/~1invoices/post/responses/409/content/application~1problem+json/examples/address_occupied"},"paths/~1invoices/post/responses/409/content/application~1problem+json/examples/address_in_use":{"value":{"type":"https://docs.vilna.io/apis/errors#conflict","title":"Conflict","status":409,"code":"address.in_use","detail":"address has an active invoice and cannot be deleted","instance":"/traces/0123456789abcdef0123456789abcdef"},"key":"address_in_use","summary":"The address cannot be deleted while in use","id":"paths/~1invoices/post/responses/409/content/application~1problem+json/examples/address_in_use"},"paths/~1invoices/post/responses/409/content/application~1problem+json/examples/subscription_v1_conflict":{"value":{"type":"https://docs.vilna.io/apis/errors#conflict","title":"Conflict","status":409,"code":"notification.subscription_v1_conflict","detail":"a subscription created through v1 accepts name and availability changes only","instance":"/traces/0123456789abcdef0123456789abcdef"},"key":"subscription_v1_conflict","summary":"A v1-created subscription rejects trigger, filter or noise changes","id":"paths/~1invoices/post/responses/409/content/application~1problem+json/examples/subscription_v1_conflict"},"paths/~1invoices/post/responses/409/content/application~1problem+json/examples/notification_send_in_progress":{"value":{"type":"https://docs.vilna.io/apis/errors#conflict","title":"Conflict","status":409,"code":"notification.send_in_progress","detail":"notification send is in progress","instance":"/traces/0123456789abcdef0123456789abcdef"},"key":"notification_send_in_progress","summary":"The notification already has a manual attempt queued or in flight","id":"paths/~1invoices/post/responses/409/content/application~1problem+json/examples/notification_send_in_progress"},"paths/~1invoices/post/responses/409/content/application~1problem+json/examples/notification_payload_unavailable":{"value":{"type":"https://docs.vilna.io/apis/errors#conflict","title":"Conflict","status":409,"code":"notification.payload_unavailable","detail":"notification payload is no longer available","instance":"/traces/0123456789abcdef0123456789abcdef"},"key":"notification_payload_unavailable","summary":"Retention has cleared the content, so there is nothing to resend","id":"paths/~1invoices/post/responses/409/content/application~1problem+json/examples/notification_payload_unavailable"},"paths/~1invoices/post/responses/409/content/application~1problem+json/examples/notification_test_resend_not_allowed":{"value":{"type":"https://docs.vilna.io/apis/errors#conflict","title":"Conflict","status":409,"code":"notification.test_resend_not_allowed","detail":"test notifications cannot be resent","instance":"/traces/0123456789abcdef0123456789abcdef"},"key":"notification_test_resend_not_allowed","summary":"The notification is a channel test","id":"paths/~1invoices/post/responses/409/content/application~1problem+json/examples/notification_test_resend_not_allowed"},"paths/~1invoices/post/responses/422/content/application~1problem+json/examples/invoice_not_cancellable":{"value":{"type":"https://docs.vilna.io/apis/errors#precondition","title":"Precondition Failed","status":422,"code":"invoice.not_cancellable","detail":"invoice cannot be cancelled in current status","instance":"/traces/0123456789abcdef0123456789abcdef","fields":[{"name":"status","reason":"confirmed"}]},"key":"invoice_not_cancellable","summary":"A confirmed invoice cannot be cancelled","id":"paths/~1invoices/post/responses/422/content/application~1problem+json/examples/invoice_not_cancellable"},"paths/~1invoices/post/responses/429/content/application~1problem+json/examples/address_quota":{"value":{"type":"https://docs.vilna.io/apis/errors#too-many-requests","title":"Too Many Requests","status":429,"code":"address.quota_exceeded","detail":"the project has reached its address limit","max":100},"key":"address_quota","summary":"The project has reached its address quota","id":"paths/~1invoices/post/responses/429/content/application~1problem+json/examples/address_quota"},"paths/~1invoices/post/responses/429/content/application~1problem+json/examples/creation_prohibited":{"value":{"type":"https://docs.vilna.io/apis/errors#too-many-requests","title":"Too Many Requests","status":429,"code":"channel.quota_exceeded","detail":"the project has reached its channel limit","max":0},"key":"creation_prohibited","summary":"A zero effective limit prohibits new resources","id":"paths/~1invoices/post/responses/429/content/application~1problem+json/examples/creation_prohibited"},"paths/~1invoices/post/responses/503/content/application~1problem+json/examples/temporarily_unavailable":{"value":{"type":"https://docs.vilna.io/apis/errors#service-unavailable","title":"Service Unavailable","status":503,"code":"service.temporarily_unavailable","detail":"The operation is temporarily unavailable. Please try again later."},"key":"temporarily_unavailable","summary":"The operation cannot be completed at present","id":"paths/~1invoices/post/responses/503/content/application~1problem+json/examples/temporarily_unavailable"},"paths/~1invoices~1{invoice_id}/get/responses/200/content/application~1json/examples/open_invoice":{"value":{"item":{"id":"550e8400-e29b-41d4-a716-446655440000","address":"0x742d35Cc6634C0532925a3b844Bc9e7595f2bD18","asset_gid":"eip155:56/erc20:0x55d398326f99059fF775485246999027B3197955","amount":"42500000","received_amount":"0","confirmed_amount":"0","status":"open","expires_at":"2024-01-15T13:00:00Z","metadata":{"order_id":"1234"},"created_at":"2024-01-15T10:30:00Z","updated_at":"2024-01-15T10:30:00Z","status_logs":[{"status":"open","comment":null,"changed_at":"2024-01-15T10:30:00Z"}],"transactions":[]},"references":{"tokens":{},"blockchains":{},"transactions":{}}},"key":"open_invoice","summary":"Just created, awaiting payment","id":"paths/~1invoices~1{invoice_id}/get/responses/200/content/application~1json/examples/open_invoice"},"paths/~1invoices~1{invoice_id}/get/responses/200/content/application~1json/examples/confirmed_invoice":{"value":{"item":{"id":"550e8400-e29b-41d4-a716-446655440000","address":"0x742d35Cc6634C0532925a3b844Bc9e7595f2bD18","asset_gid":"eip155:56/erc20:0x55d398326f99059fF775485246999027B3197955","amount":"42500000","received_amount":"42500000","confirmed_amount":"42500000","status":"confirmed","expires_at":"2024-01-15T13:00:00Z","metadata":{"order_id":"1234"},"created_at":"2024-01-15T10:30:00Z","updated_at":"2024-01-15T12:15:00Z","status_logs":[{"status":"open","comment":null,"changed_at":"2024-01-15T10:30:00Z"},{"status":"confirmed","comment":null,"changed_at":"2024-01-15T12:15:00Z"}],"transactions":[{"chain_gid":"eip155:56","txid":"0xabc123def456789012345678901234567890123456789012345678901234abcd","is_active":true,"deposits":[{"asset_gid":"eip155:56/erc20:0x55d398326f99059fF775485246999027B3197955","amount":"42500000","is_matched":true}]},{"chain_gid":"eip155:56","txid":"0x9876543210fedcba9876543210fedcba9876543210fedcba9876543210fedc","is_active":false,"deposits":[]}]},"references":{"tokens":{},"blockchains":{},"transactions":{"eip155:56":{"0xabc123def456789012345678901234567890123456789012345678901234abcd":{"chain_gid":"eip155:56","txid":"0xabc123def456789012345678901234567890123456789012345678901234abcd","created_at":"2024-01-15T12:05:00Z","details":{"family":"evm","block_height":12345678,"is_success":true}}}}}},"key":"confirmed_invoice","summary":"Paid in full and confirmed on-chain","id":"paths/~1invoices~1{invoice_id}/get/responses/200/content/application~1json/examples/confirmed_invoice"},"paths/~1invoices~1{invoice_id}/get/responses/400/content/application~1problem+json/examples/malformed_json":{"value":{"type":"https://docs.vilna.io/apis/errors#invalid-request","title":"Invalid Request","status":400,"code":"request.malformed","detail":"The request could not be decoded.","instance":"/traces/0123456789abcdef0123456789abcdef"},"key":"malformed_json","summary":"The request body contains malformed JSON","id":"paths/~1invoices~1{invoice_id}/get/responses/400/content/application~1problem+json/examples/malformed_json"},"paths/~1invoices~1{invoice_id}/get/responses/401/content/application~1problem+json/examples/service_authentication_denied":{"value":{"type":"https://docs.vilna.io/apis/errors#unauthorized","title":"Unauthorized","status":401,"code":"unspecified","detail":"You are not authorized to access this resource. If the problem persists, please contact our support team.","instance":"/unauthorized?method=createInvoice"},"key":"service_authentication_denied","summary":"The API service refused authentication","id":"paths/~1invoices~1{invoice_id}/get/responses/401/content/application~1problem+json/examples/service_authentication_denied"},"paths/~1invoices~1{invoice_id}/get/responses/403/content/application~1problem+json/examples/insufficient_permissions":{"value":{"type":"https://docs.vilna.io/apis/errors#forbidden","title":"Forbidden","status":403,"code":"unspecified","detail":"Your credentials are valid but don't include the permission this operation needs. Check the API key permissions in the dashboard. Permissions are set when the key is created and can't be edited later. To change them, create a new key.","instance":"/forbidden?method=createInvoice"},"key":"insufficient_permissions","summary":"The API key lacks the required permission","id":"paths/~1invoices~1{invoice_id}/get/responses/403/content/application~1problem+json/examples/insufficient_permissions"},"paths/~1invoices~1{invoice_id}/get/responses/404/content/application~1problem+json/examples/address_not_found":{"value":{"type":"https://docs.vilna.io/apis/errors#not-found","title":"Not Found","status":404,"code":"address.not_found","detail":"address not found","instance":"/traces/0123456789abcdef0123456789abcdef"},"key":"address_not_found","summary":"The address does not exist in this project","id":"paths/~1invoices~1{invoice_id}/get/responses/404/content/application~1problem+json/examples/address_not_found"},"paths/~1invoices~1{invoice_id}/get/responses/404/content/application~1problem+json/examples/invoice_not_found":{"value":{"type":"https://docs.vilna.io/apis/errors#not-found","title":"Not Found","status":404,"code":"invoice.not_found","detail":"invoice not found","instance":"/traces/0123456789abcdef0123456789abcdef"},"key":"invoice_not_found","summary":"The invoice does not exist in this project","id":"paths/~1invoices~1{invoice_id}/get/responses/404/content/application~1problem+json/examples/invoice_not_found"},"paths/~1invoices~1{invoice_id}/get/responses/503/content/application~1problem+json/examples/temporarily_unavailable":{"value":{"type":"https://docs.vilna.io/apis/errors#service-unavailable","title":"Service Unavailable","status":503,"code":"service.temporarily_unavailable","detail":"The operation is temporarily unavailable. Please try again later."},"key":"temporarily_unavailable","summary":"The operation cannot be completed at present","id":"paths/~1invoices~1{invoice_id}/get/responses/503/content/application~1problem+json/examples/temporarily_unavailable"},"paths/~1invoices~1{invoice_id}/delete/responses/400/content/application~1problem+json/examples/malformed_json":{"value":{"type":"https://docs.vilna.io/apis/errors#invalid-request","title":"Invalid Request","status":400,"code":"request.malformed","detail":"The request could not be decoded.","instance":"/traces/0123456789abcdef0123456789abcdef"},"key":"malformed_json","summary":"The request body contains malformed JSON","id":"paths/~1invoices~1{invoice_id}/delete/responses/400/content/application~1problem+json/examples/malformed_json"},"paths/~1invoices~1{invoice_id}/delete/responses/401/content/application~1problem+json/examples/service_authentication_denied":{"value":{"type":"https://docs.vilna.io/apis/errors#unauthorized","title":"Unauthorized","status":401,"code":"unspecified","detail":"You are not authorized to access this resource. If the problem persists, please contact our support team.","instance":"/unauthorized?method=createInvoice"},"key":"service_authentication_denied","summary":"The API service refused authentication","id":"paths/~1invoices~1{invoice_id}/delete/responses/401/content/application~1problem+json/examples/service_authentication_denied"},"paths/~1invoices~1{invoice_id}/delete/responses/403/content/application~1problem+json/examples/insufficient_permissions":{"value":{"type":"https://docs.vilna.io/apis/errors#forbidden","title":"Forbidden","status":403,"code":"unspecified","detail":"Your credentials are valid but don't include the permission this operation needs. Check the API key permissions in the dashboard. Permissions are set when the key is created and can't be edited later. To change them, create a new key.","instance":"/forbidden?method=createInvoice"},"key":"insufficient_permissions","summary":"The API key lacks the required permission","id":"paths/~1invoices~1{invoice_id}/delete/responses/403/content/application~1problem+json/examples/insufficient_permissions"},"paths/~1invoices~1{invoice_id}/delete/responses/404/content/application~1problem+json/examples/address_not_found":{"value":{"type":"https://docs.vilna.io/apis/errors#not-found","title":"Not Found","status":404,"code":"address.not_found","detail":"address not found","instance":"/traces/0123456789abcdef0123456789abcdef"},"key":"address_not_found","summary":"The address does not exist in this project","id":"paths/~1invoices~1{invoice_id}/delete/responses/404/content/application~1problem+json/examples/address_not_found"},"paths/~1invoices~1{invoice_id}/delete/responses/404/content/application~1problem+json/examples/invoice_not_found":{"value":{"type":"https://docs.vilna.io/apis/errors#not-found","title":"Not Found","status":404,"code":"invoice.not_found","detail":"invoice not found","instance":"/traces/0123456789abcdef0123456789abcdef"},"key":"invoice_not_found","summary":"The invoice does not exist in this project","id":"paths/~1invoices~1{invoice_id}/delete/responses/404/content/application~1problem+json/examples/invoice_not_found"},"paths/~1invoices~1{invoice_id}/delete/responses/409/content/application~1problem+json/examples/address_occupied":{"value":{"type":"https://docs.vilna.io/apis/errors#conflict","title":"Conflict","status":409,"code":"invoice.address_occupied","detail":"address already has an active invoice with different parameters","instance":"/traces/0123456789abcdef0123456789abcdef"},"key":"address_occupied","summary":"The address already has an active invoice","id":"paths/~1invoices~1{invoice_id}/delete/responses/409/content/application~1problem+json/examples/address_occupied"},"paths/~1invoices~1{invoice_id}/delete/responses/409/content/application~1problem+json/examples/address_in_use":{"value":{"type":"https://docs.vilna.io/apis/errors#conflict","title":"Conflict","status":409,"code":"address.in_use","detail":"address has an active invoice and cannot be deleted","instance":"/traces/0123456789abcdef0123456789abcdef"},"key":"address_in_use","summary":"The address cannot be deleted while in use","id":"paths/~1invoices~1{invoice_id}/delete/responses/409/content/application~1problem+json/examples/address_in_use"},"paths/~1invoices~1{invoice_id}/delete/responses/409/content/application~1problem+json/examples/subscription_v1_conflict":{"value":{"type":"https://docs.vilna.io/apis/errors#conflict","title":"Conflict","status":409,"code":"notification.subscription_v1_conflict","detail":"a subscription created through v1 accepts name and availability changes only","instance":"/traces/0123456789abcdef0123456789abcdef"},"key":"subscription_v1_conflict","summary":"A v1-created subscription rejects trigger, filter or noise changes","id":"paths/~1invoices~1{invoice_id}/delete/responses/409/content/application~1problem+json/examples/subscription_v1_conflict"},"paths/~1invoices~1{invoice_id}/delete/responses/409/content/application~1problem+json/examples/notification_send_in_progress":{"value":{"type":"https://docs.vilna.io/apis/errors#conflict","title":"Conflict","status":409,"code":"notification.send_in_progress","detail":"notification send is in progress","instance":"/traces/0123456789abcdef0123456789abcdef"},"key":"notification_send_in_progress","summary":"The notification already has a manual attempt queued or in flight","id":"paths/~1invoices~1{invoice_id}/delete/responses/409/content/application~1problem+json/examples/notification_send_in_progress"},"paths/~1invoices~1{invoice_id}/delete/responses/409/content/application~1problem+json/examples/notification_payload_unavailable":{"value":{"type":"https://docs.vilna.io/apis/errors#conflict","title":"Conflict","status":409,"code":"notification.payload_unavailable","detail":"notification payload is no longer available","instance":"/traces/0123456789abcdef0123456789abcdef"},"key":"notification_payload_unavailable","summary":"Retention has cleared the content, so there is nothing to resend","id":"paths/~1invoices~1{invoice_id}/delete/responses/409/content/application~1problem+json/examples/notification_payload_unavailable"},"paths/~1invoices~1{invoice_id}/delete/responses/409/content/application~1problem+json/examples/notification_test_resend_not_allowed":{"value":{"type":"https://docs.vilna.io/apis/errors#conflict","title":"Conflict","status":409,"code":"notification.test_resend_not_allowed","detail":"test notifications cannot be resent","instance":"/traces/0123456789abcdef0123456789abcdef"},"key":"notification_test_resend_not_allowed","summary":"The notification is a channel test","id":"paths/~1invoices~1{invoice_id}/delete/responses/409/content/application~1problem+json/examples/notification_test_resend_not_allowed"},"paths/~1invoices~1{invoice_id}/delete/responses/422/content/application~1problem+json/examples/invoice_not_cancellable":{"value":{"type":"https://docs.vilna.io/apis/errors#precondition","title":"Precondition Failed","status":422,"code":"invoice.not_cancellable","detail":"invoice cannot be cancelled in current status","instance":"/traces/0123456789abcdef0123456789abcdef","fields":[{"name":"status","reason":"confirmed"}]},"key":"invoice_not_cancellable","summary":"A confirmed invoice cannot be cancelled","id":"paths/~1invoices~1{invoice_id}/delete/responses/422/content/application~1problem+json/examples/invoice_not_cancellable"},"paths/~1invoices~1{invoice_id}/delete/responses/503/content/application~1problem+json/examples/temporarily_unavailable":{"value":{"type":"https://docs.vilna.io/apis/errors#service-unavailable","title":"Service Unavailable","status":503,"code":"service.temporarily_unavailable","detail":"The operation is temporarily unavailable. Please try again later."},"key":"temporarily_unavailable","summary":"The operation cannot be completed at present","id":"paths/~1invoices~1{invoice_id}/delete/responses/503/content/application~1problem+json/examples/temporarily_unavailable"},"paths/~1invoices~1{invoice_id}~1actions~1cancel/post/requestBody/content/application~1json/examples/with_comment":{"value":{"comment":"Cancelled by merchant"},"key":"with_comment","summary":"Cancel with reason","id":"paths/~1invoices~1{invoice_id}~1actions~1cancel/post/requestBody/content/application~1json/examples/with_comment"},"paths/~1invoices~1{invoice_id}~1actions~1cancel/post/requestBody/content/application~1json/examples/without_comment":{"value":{},"key":"without_comment","summary":"Cancel without reason","id":"paths/~1invoices~1{invoice_id}~1actions~1cancel/post/requestBody/content/application~1json/examples/without_comment"},"paths/~1invoices~1{invoice_id}~1actions~1cancel/post/responses/400/content/application~1problem+json/examples/malformed_json":{"value":{"type":"https://docs.vilna.io/apis/errors#invalid-request","title":"Invalid Request","status":400,"code":"request.malformed","detail":"The request could not be decoded.","instance":"/traces/0123456789abcdef0123456789abcdef"},"key":"malformed_json","summary":"The request body contains malformed JSON","id":"paths/~1invoices~1{invoice_id}~1actions~1cancel/post/responses/400/content/application~1problem+json/examples/malformed_json"},"paths/~1invoices~1{invoice_id}~1actions~1cancel/post/responses/401/content/application~1problem+json/examples/service_authentication_denied":{"value":{"type":"https://docs.vilna.io/apis/errors#unauthorized","title":"Unauthorized","status":401,"code":"unspecified","detail":"You are not authorized to access this resource. If the problem persists, please contact our support team.","instance":"/unauthorized?method=createInvoice"},"key":"service_authentication_denied","summary":"The API service refused authentication","id":"paths/~1invoices~1{invoice_id}~1actions~1cancel/post/responses/401/content/application~1problem+json/examples/service_authentication_denied"},"paths/~1invoices~1{invoice_id}~1actions~1cancel/post/responses/403/content/application~1problem+json/examples/insufficient_permissions":{"value":{"type":"https://docs.vilna.io/apis/errors#forbidden","title":"Forbidden","status":403,"code":"unspecified","detail":"Your credentials are valid but don't include the permission this operation needs. Check the API key permissions in the dashboard. Permissions are set when the key is created and can't be edited later. To change them, create a new key.","instance":"/forbidden?method=createInvoice"},"key":"insufficient_permissions","summary":"The API key lacks the required permission","id":"paths/~1invoices~1{invoice_id}~1actions~1cancel/post/responses/403/content/application~1problem+json/examples/insufficient_permissions"},"paths/~1invoices~1{invoice_id}~1actions~1cancel/post/responses/404/content/application~1problem+json/examples/address_not_found":{"value":{"type":"https://docs.vilna.io/apis/errors#not-found","title":"Not Found","status":404,"code":"address.not_found","detail":"address not found","instance":"/traces/0123456789abcdef0123456789abcdef"},"key":"address_not_found","summary":"The address does not exist in this project","id":"paths/~1invoices~1{invoice_id}~1actions~1cancel/post/responses/404/content/application~1problem+json/examples/address_not_found"},"paths/~1invoices~1{invoice_id}~1actions~1cancel/post/responses/404/content/application~1problem+json/examples/invoice_not_found":{"value":{"type":"https://docs.vilna.io/apis/errors#not-found","title":"Not Found","status":404,"code":"invoice.not_found","detail":"invoice not found","instance":"/traces/0123456789abcdef0123456789abcdef"},"key":"invoice_not_found","summary":"The invoice does not exist in this project","id":"paths/~1invoices~1{invoice_id}~1actions~1cancel/post/responses/404/content/application~1problem+json/examples/invoice_not_found"},"paths/~1invoices~1{invoice_id}~1actions~1cancel/post/responses/409/content/application~1problem+json/examples/address_occupied":{"value":{"type":"https://docs.vilna.io/apis/errors#conflict","title":"Conflict","status":409,"code":"invoice.address_occupied","detail":"address already has an active invoice with different parameters","instance":"/traces/0123456789abcdef0123456789abcdef"},"key":"address_occupied","summary":"The address already has an active invoice","id":"paths/~1invoices~1{invoice_id}~1actions~1cancel/post/responses/409/content/application~1problem+json/examples/address_occupied"},"paths/~1invoices~1{invoice_id}~1actions~1cancel/post/responses/409/content/application~1problem+json/examples/address_in_use":{"value":{"type":"https://docs.vilna.io/apis/errors#conflict","title":"Conflict","status":409,"code":"address.in_use","detail":"address has an active invoice and cannot be deleted","instance":"/traces/0123456789abcdef0123456789abcdef"},"key":"address_in_use","summary":"The address cannot be deleted while in use","id":"paths/~1invoices~1{invoice_id}~1actions~1cancel/post/responses/409/content/application~1problem+json/examples/address_in_use"},"paths/~1invoices~1{invoice_id}~1actions~1cancel/post/responses/409/content/application~1problem+json/examples/subscription_v1_conflict":{"value":{"type":"https://docs.vilna.io/apis/errors#conflict","title":"Conflict","status":409,"code":"notification.subscription_v1_conflict","detail":"a subscription created through v1 accepts name and availability changes only","instance":"/traces/0123456789abcdef0123456789abcdef"},"key":"subscription_v1_conflict","summary":"A v1-created subscription rejects trigger, filter or noise changes","id":"paths/~1invoices~1{invoice_id}~1actions~1cancel/post/responses/409/content/application~1problem+json/examples/subscription_v1_conflict"},"paths/~1invoices~1{invoice_id}~1actions~1cancel/post/responses/409/content/application~1problem+json/examples/notification_send_in_progress":{"value":{"type":"https://docs.vilna.io/apis/errors#conflict","title":"Conflict","status":409,"code":"notification.send_in_progress","detail":"notification send is in progress","instance":"/traces/0123456789abcdef0123456789abcdef"},"key":"notification_send_in_progress","summary":"The notification already has a manual attempt queued or in flight","id":"paths/~1invoices~1{invoice_id}~1actions~1cancel/post/responses/409/content/application~1problem+json/examples/notification_send_in_progress"},"paths/~1invoices~1{invoice_id}~1actions~1cancel/post/responses/409/content/application~1problem+json/examples/notification_payload_unavailable":{"value":{"type":"https://docs.vilna.io/apis/errors#conflict","title":"Conflict","status":409,"code":"notification.payload_unavailable","detail":"notification payload is no longer available","instance":"/traces/0123456789abcdef0123456789abcdef"},"key":"notification_payload_unavailable","summary":"Retention has cleared the content, so there is nothing to resend","id":"paths/~1invoices~1{invoice_id}~1actions~1cancel/post/responses/409/content/application~1problem+json/examples/notification_payload_unavailable"},"paths/~1invoices~1{invoice_id}~1actions~1cancel/post/responses/409/content/application~1problem+json/examples/notification_test_resend_not_allowed":{"value":{"type":"https://docs.vilna.io/apis/errors#conflict","title":"Conflict","status":409,"code":"notification.test_resend_not_allowed","detail":"test notifications cannot be resent","instance":"/traces/0123456789abcdef0123456789abcdef"},"key":"notification_test_resend_not_allowed","summary":"The notification is a channel test","id":"paths/~1invoices~1{invoice_id}~1actions~1cancel/post/responses/409/content/application~1problem+json/examples/notification_test_resend_not_allowed"},"paths/~1invoices~1{invoice_id}~1actions~1cancel/post/responses/422/content/application~1problem+json/examples/invoice_not_cancellable":{"value":{"type":"https://docs.vilna.io/apis/errors#precondition","title":"Precondition Failed","status":422,"code":"invoice.not_cancellable","detail":"invoice cannot be cancelled in current status","instance":"/traces/0123456789abcdef0123456789abcdef","fields":[{"name":"status","reason":"confirmed"}]},"key":"invoice_not_cancellable","summary":"A confirmed invoice cannot be cancelled","id":"paths/~1invoices~1{invoice_id}~1actions~1cancel/post/responses/422/content/application~1problem+json/examples/invoice_not_cancellable"},"paths/~1invoices~1{invoice_id}~1actions~1cancel/post/responses/503/content/application~1problem+json/examples/temporarily_unavailable":{"value":{"type":"https://docs.vilna.io/apis/errors#service-unavailable","title":"Service Unavailable","status":503,"code":"service.temporarily_unavailable","detail":"The operation is temporarily unavailable. Please try again later."},"key":"temporarily_unavailable","summary":"The operation cannot be completed at present","id":"paths/~1invoices~1{invoice_id}~1actions~1cancel/post/responses/503/content/application~1problem+json/examples/temporarily_unavailable"},"paths/~1public~1invoices~1{invoice_id}/get/responses/400/content/application~1problem+json/examples/malformed_json":{"value":{"type":"https://docs.vilna.io/apis/errors#invalid-request","title":"Invalid Request","status":400,"code":"request.malformed","detail":"The request could not be decoded.","instance":"/traces/0123456789abcdef0123456789abcdef"},"key":"malformed_json","summary":"The request body contains malformed JSON","id":"paths/~1public~1invoices~1{invoice_id}/get/responses/400/content/application~1problem+json/examples/malformed_json"},"paths/~1public~1invoices~1{invoice_id}/get/responses/404/content/application~1problem+json/examples/address_not_found":{"value":{"type":"https://docs.vilna.io/apis/errors#not-found","title":"Not Found","status":404,"code":"address.not_found","detail":"address not found","instance":"/traces/0123456789abcdef0123456789abcdef"},"key":"address_not_found","summary":"The address does not exist in this project","id":"paths/~1public~1invoices~1{invoice_id}/get/responses/404/content/application~1problem+json/examples/address_not_found"},"paths/~1public~1invoices~1{invoice_id}/get/responses/404/content/application~1problem+json/examples/invoice_not_found":{"value":{"type":"https://docs.vilna.io/apis/errors#not-found","title":"Not Found","status":404,"code":"invoice.not_found","detail":"invoice not found","instance":"/traces/0123456789abcdef0123456789abcdef"},"key":"invoice_not_found","summary":"The invoice does not exist in this project","id":"paths/~1public~1invoices~1{invoice_id}/get/responses/404/content/application~1problem+json/examples/invoice_not_found"},"paths/~1public~1invoices~1{invoice_id}/get/responses/503/content/application~1problem+json/examples/temporarily_unavailable":{"value":{"type":"https://docs.vilna.io/apis/errors#service-unavailable","title":"Service Unavailable","status":503,"code":"service.temporarily_unavailable","detail":"The operation is temporarily unavailable. Please try again later."},"key":"temporarily_unavailable","summary":"The operation cannot be completed at present","id":"paths/~1public~1invoices~1{invoice_id}/get/responses/503/content/application~1problem+json/examples/temporarily_unavailable"},"paths/~1channels/get/responses/400/content/application~1problem+json/examples/malformed_json":{"value":{"type":"https://docs.vilna.io/apis/errors#invalid-request","title":"Invalid Request","status":400,"code":"request.malformed","detail":"The request could not be decoded.","instance":"/traces/0123456789abcdef0123456789abcdef"},"key":"malformed_json","summary":"The request body contains malformed JSON","id":"paths/~1channels/get/responses/400/content/application~1problem+json/examples/malformed_json"},"paths/~1channels/get/responses/401/content/application~1problem+json/examples/service_authentication_denied":{"value":{"type":"https://docs.vilna.io/apis/errors#unauthorized","title":"Unauthorized","status":401,"code":"unspecified","detail":"You are not authorized to access this resource. If the problem persists, please contact our support team.","instance":"/unauthorized?method=createInvoice"},"key":"service_authentication_denied","summary":"The API service refused authentication","id":"paths/~1channels/get/responses/401/content/application~1problem+json/examples/service_authentication_denied"},"paths/~1channels/get/responses/403/content/application~1problem+json/examples/insufficient_permissions":{"value":{"type":"https://docs.vilna.io/apis/errors#forbidden","title":"Forbidden","status":403,"code":"unspecified","detail":"Your credentials are valid but don't include the permission this operation needs. Check the API key permissions in the dashboard. Permissions are set when the key is created and can't be edited later. To change them, create a new key.","instance":"/forbidden?method=createInvoice"},"key":"insufficient_permissions","summary":"The API key lacks the required permission","id":"paths/~1channels/get/responses/403/content/application~1problem+json/examples/insufficient_permissions"},"paths/~1channels/get/responses/503/content/application~1problem+json/examples/temporarily_unavailable":{"value":{"type":"https://docs.vilna.io/apis/errors#service-unavailable","title":"Service Unavailable","status":503,"code":"service.temporarily_unavailable","detail":"The operation is temporarily unavailable. Please try again later."},"key":"temporarily_unavailable","summary":"The operation cannot be completed at present","id":"paths/~1channels/get/responses/503/content/application~1problem+json/examples/temporarily_unavailable"},"paths/~1channels/post/requestBody/content/application~1json/examples/create_telegram_channel":{"value":{"name":"Production Alerts","config":{"kind":"telegram","bot_token":"987654321:ABCDEFGHIJKLMNOPQRSTUVWXYZ123456789","chat_id":-1001234567890,"language":"en","thread_id":0},"max_attempts":3},"key":"create_telegram_channel","summary":"Telegram channel","id":"paths/~1channels/post/requestBody/content/application~1json/examples/create_telegram_channel"},"paths/~1channels/post/requestBody/content/application~1json/examples/create_webhook_channel":{"value":{"name":"Alert Webhook","config":{"kind":"webhook","url":"https://hooks.slack.com/services/T00000000/B00000000/XXXXXXXXXXXXXXXXXXXXXXXX","headers":{"Content-Type":"application/json","X-Tenant-Id":"acme"},"payload_version":"v2"},"max_attempts":5},"key":"create_webhook_channel","summary":"Webhook channel","id":"paths/~1channels/post/requestBody/content/application~1json/examples/create_webhook_channel"},"paths/~1channels/post/requestBody/content/application~1json/examples/create_disabled_channel":{"value":{"name":"Staging Webhook","config":{"kind":"webhook","url":"https://staging.example.com/webhooks/notifications","payload_version":"v1"},"max_attempts":3,"is_enabled":false},"key":"create_disabled_channel","summary":"Webhook channel created switched off","id":"paths/~1channels/post/requestBody/content/application~1json/examples/create_disabled_channel"},"paths/~1channels/post/responses/400/content/application~1problem+json/examples/malformed_json":{"value":{"type":"https://docs.vilna.io/apis/errors#invalid-request","title":"Invalid Request","status":400,"code":"request.malformed","detail":"The request could not be decoded.","instance":"/traces/0123456789abcdef0123456789abcdef"},"key":"malformed_json","summary":"The request body contains malformed JSON","id":"paths/~1channels/post/responses/400/content/application~1problem+json/examples/malformed_json"},"paths/~1channels/post/responses/401/content/application~1problem+json/examples/service_authentication_denied":{"value":{"type":"https://docs.vilna.io/apis/errors#unauthorized","title":"Unauthorized","status":401,"code":"unspecified","detail":"You are not authorized to access this resource. If the problem persists, please contact our support team.","instance":"/unauthorized?method=createInvoice"},"key":"service_authentication_denied","summary":"The API service refused authentication","id":"paths/~1channels/post/responses/401/content/application~1problem+json/examples/service_authentication_denied"},"paths/~1channels/post/responses/403/content/application~1problem+json/examples/insufficient_permissions":{"value":{"type":"https://docs.vilna.io/apis/errors#forbidden","title":"Forbidden","status":403,"code":"unspecified","detail":"Your credentials are valid but don't include the permission this operation needs. Check the API key permissions in the dashboard. Permissions are set when the key is created and can't be edited later. To change them, create a new key.","instance":"/forbidden?method=createInvoice"},"key":"insufficient_permissions","summary":"The API key lacks the required permission","id":"paths/~1channels/post/responses/403/content/application~1problem+json/examples/insufficient_permissions"},"paths/~1channels/post/responses/409/content/application~1problem+json/examples/address_occupied":{"value":{"type":"https://docs.vilna.io/apis/errors#conflict","title":"Conflict","status":409,"code":"invoice.address_occupied","detail":"address already has an active invoice with different parameters","instance":"/traces/0123456789abcdef0123456789abcdef"},"key":"address_occupied","summary":"The address already has an active invoice","id":"paths/~1channels/post/responses/409/content/application~1problem+json/examples/address_occupied"},"paths/~1channels/post/responses/409/content/application~1problem+json/examples/address_in_use":{"value":{"type":"https://docs.vilna.io/apis/errors#conflict","title":"Conflict","status":409,"code":"address.in_use","detail":"address has an active invoice and cannot be deleted","instance":"/traces/0123456789abcdef0123456789abcdef"},"key":"address_in_use","summary":"The address cannot be deleted while in use","id":"paths/~1channels/post/responses/409/content/application~1problem+json/examples/address_in_use"},"paths/~1channels/post/responses/409/content/application~1problem+json/examples/subscription_v1_conflict":{"value":{"type":"https://docs.vilna.io/apis/errors#conflict","title":"Conflict","status":409,"code":"notification.subscription_v1_conflict","detail":"a subscription created through v1 accepts name and availability changes only","instance":"/traces/0123456789abcdef0123456789abcdef"},"key":"subscription_v1_conflict","summary":"A v1-created subscription rejects trigger, filter or noise changes","id":"paths/~1channels/post/responses/409/content/application~1problem+json/examples/subscription_v1_conflict"},"paths/~1channels/post/responses/409/content/application~1problem+json/examples/notification_send_in_progress":{"value":{"type":"https://docs.vilna.io/apis/errors#conflict","title":"Conflict","status":409,"code":"notification.send_in_progress","detail":"notification send is in progress","instance":"/traces/0123456789abcdef0123456789abcdef"},"key":"notification_send_in_progress","summary":"The notification already has a manual attempt queued or in flight","id":"paths/~1channels/post/responses/409/content/application~1problem+json/examples/notification_send_in_progress"},"paths/~1channels/post/responses/409/content/application~1problem+json/examples/notification_payload_unavailable":{"value":{"type":"https://docs.vilna.io/apis/errors#conflict","title":"Conflict","status":409,"code":"notification.payload_unavailable","detail":"notification payload is no longer available","instance":"/traces/0123456789abcdef0123456789abcdef"},"key":"notification_payload_unavailable","summary":"Retention has cleared the content, so there is nothing to resend","id":"paths/~1channels/post/responses/409/content/application~1problem+json/examples/notification_payload_unavailable"},"paths/~1channels/post/responses/409/content/application~1problem+json/examples/notification_test_resend_not_allowed":{"value":{"type":"https://docs.vilna.io/apis/errors#conflict","title":"Conflict","status":409,"code":"notification.test_resend_not_allowed","detail":"test notifications cannot be resent","instance":"/traces/0123456789abcdef0123456789abcdef"},"key":"notification_test_resend_not_allowed","summary":"The notification is a channel test","id":"paths/~1channels/post/responses/409/content/application~1problem+json/examples/notification_test_resend_not_allowed"},"paths/~1channels/post/responses/429/content/application~1problem+json/examples/address_quota":{"value":{"type":"https://docs.vilna.io/apis/errors#too-many-requests","title":"Too Many Requests","status":429,"code":"address.quota_exceeded","detail":"the project has reached its address limit","max":100},"key":"address_quota","summary":"The project has reached its address quota","id":"paths/~1channels/post/responses/429/content/application~1problem+json/examples/address_quota"},"paths/~1channels/post/responses/429/content/application~1problem+json/examples/creation_prohibited":{"value":{"type":"https://docs.vilna.io/apis/errors#too-many-requests","title":"Too Many Requests","status":429,"code":"channel.quota_exceeded","detail":"the project has reached its channel limit","max":0},"key":"creation_prohibited","summary":"A zero effective limit prohibits new resources","id":"paths/~1channels/post/responses/429/content/application~1problem+json/examples/creation_prohibited"},"paths/~1channels/post/responses/503/content/application~1problem+json/examples/temporarily_unavailable":{"value":{"type":"https://docs.vilna.io/apis/errors#service-unavailable","title":"Service Unavailable","status":503,"code":"service.temporarily_unavailable","detail":"The operation is temporarily unavailable. Please try again later."},"key":"temporarily_unavailable","summary":"The operation cannot be completed at present","id":"paths/~1channels/post/responses/503/content/application~1problem+json/examples/temporarily_unavailable"},"paths/~1channels~1{channel_id}/get/responses/400/content/application~1problem+json/examples/malformed_json":{"value":{"type":"https://docs.vilna.io/apis/errors#invalid-request","title":"Invalid Request","status":400,"code":"request.malformed","detail":"The request could not be decoded.","instance":"/traces/0123456789abcdef0123456789abcdef"},"key":"malformed_json","summary":"The request body contains malformed JSON","id":"paths/~1channels~1{channel_id}/get/responses/400/content/application~1problem+json/examples/malformed_json"},"paths/~1channels~1{channel_id}/get/responses/401/content/application~1problem+json/examples/service_authentication_denied":{"value":{"type":"https://docs.vilna.io/apis/errors#unauthorized","title":"Unauthorized","status":401,"code":"unspecified","detail":"You are not authorized to access this resource. If the problem persists, please contact our support team.","instance":"/unauthorized?method=createInvoice"},"key":"service_authentication_denied","summary":"The API service refused authentication","id":"paths/~1channels~1{channel_id}/get/responses/401/content/application~1problem+json/examples/service_authentication_denied"},"paths/~1channels~1{channel_id}/get/responses/403/content/application~1problem+json/examples/insufficient_permissions":{"value":{"type":"https://docs.vilna.io/apis/errors#forbidden","title":"Forbidden","status":403,"code":"unspecified","detail":"Your credentials are valid but don't include the permission this operation needs. Check the API key permissions in the dashboard. Permissions are set when the key is created and can't be edited later. To change them, create a new key.","instance":"/forbidden?method=createInvoice"},"key":"insufficient_permissions","summary":"The API key lacks the required permission","id":"paths/~1channels~1{channel_id}/get/responses/403/content/application~1problem+json/examples/insufficient_permissions"},"paths/~1channels~1{channel_id}/get/responses/404/content/application~1problem+json/examples/address_not_found":{"value":{"type":"https://docs.vilna.io/apis/errors#not-found","title":"Not Found","status":404,"code":"address.not_found","detail":"address not found","instance":"/traces/0123456789abcdef0123456789abcdef"},"key":"address_not_found","summary":"The address does not exist in this project","id":"paths/~1channels~1{channel_id}/get/responses/404/content/application~1problem+json/examples/address_not_found"},"paths/~1channels~1{channel_id}/get/responses/404/content/application~1problem+json/examples/invoice_not_found":{"value":{"type":"https://docs.vilna.io/apis/errors#not-found","title":"Not Found","status":404,"code":"invoice.not_found","detail":"invoice not found","instance":"/traces/0123456789abcdef0123456789abcdef"},"key":"invoice_not_found","summary":"The invoice does not exist in this project","id":"paths/~1channels~1{channel_id}/get/responses/404/content/application~1problem+json/examples/invoice_not_found"},"paths/~1channels~1{channel_id}/get/responses/503/content/application~1problem+json/examples/temporarily_unavailable":{"value":{"type":"https://docs.vilna.io/apis/errors#service-unavailable","title":"Service Unavailable","status":503,"code":"service.temporarily_unavailable","detail":"The operation is temporarily unavailable. Please try again later."},"key":"temporarily_unavailable","summary":"The operation cannot be completed at present","id":"paths/~1channels~1{channel_id}/get/responses/503/content/application~1problem+json/examples/temporarily_unavailable"},"paths/~1channels~1{channel_id}/delete/responses/400/content/application~1problem+json/examples/malformed_json":{"value":{"type":"https://docs.vilna.io/apis/errors#invalid-request","title":"Invalid Request","status":400,"code":"request.malformed","detail":"The request could not be decoded.","instance":"/traces/0123456789abcdef0123456789abcdef"},"key":"malformed_json","summary":"The request body contains malformed JSON","id":"paths/~1channels~1{channel_id}/delete/responses/400/content/application~1problem+json/examples/malformed_json"},"paths/~1channels~1{channel_id}/delete/responses/401/content/application~1problem+json/examples/service_authentication_denied":{"value":{"type":"https://docs.vilna.io/apis/errors#unauthorized","title":"Unauthorized","status":401,"code":"unspecified","detail":"You are not authorized to access this resource. If the problem persists, please contact our support team.","instance":"/unauthorized?method=createInvoice"},"key":"service_authentication_denied","summary":"The API service refused authentication","id":"paths/~1channels~1{channel_id}/delete/responses/401/content/application~1problem+json/examples/service_authentication_denied"},"paths/~1channels~1{channel_id}/delete/responses/403/content/application~1problem+json/examples/insufficient_permissions":{"value":{"type":"https://docs.vilna.io/apis/errors#forbidden","title":"Forbidden","status":403,"code":"unspecified","detail":"Your credentials are valid but don't include the permission this operation needs. Check the API key permissions in the dashboard. Permissions are set when the key is created and can't be edited later. To change them, create a new key.","instance":"/forbidden?method=createInvoice"},"key":"insufficient_permissions","summary":"The API key lacks the required permission","id":"paths/~1channels~1{channel_id}/delete/responses/403/content/application~1problem+json/examples/insufficient_permissions"},"paths/~1channels~1{channel_id}/delete/responses/404/content/application~1problem+json/examples/address_not_found":{"value":{"type":"https://docs.vilna.io/apis/errors#not-found","title":"Not Found","status":404,"code":"address.not_found","detail":"address not found","instance":"/traces/0123456789abcdef0123456789abcdef"},"key":"address_not_found","summary":"The address does not exist in this project","id":"paths/~1channels~1{channel_id}/delete/responses/404/content/application~1problem+json/examples/address_not_found"},"paths/~1channels~1{channel_id}/delete/responses/404/content/application~1problem+json/examples/invoice_not_found":{"value":{"type":"https://docs.vilna.io/apis/errors#not-found","title":"Not Found","status":404,"code":"invoice.not_found","detail":"invoice not found","instance":"/traces/0123456789abcdef0123456789abcdef"},"key":"invoice_not_found","summary":"The invoice does not exist in this project","id":"paths/~1channels~1{channel_id}/delete/responses/404/content/application~1problem+json/examples/invoice_not_found"},"paths/~1channels~1{channel_id}/delete/responses/409/content/application~1problem+json/examples/address_occupied":{"value":{"type":"https://docs.vilna.io/apis/errors#conflict","title":"Conflict","status":409,"code":"invoice.address_occupied","detail":"address already has an active invoice with different parameters","instance":"/traces/0123456789abcdef0123456789abcdef"},"key":"address_occupied","summary":"The address already has an active invoice","id":"paths/~1channels~1{channel_id}/delete/responses/409/content/application~1problem+json/examples/address_occupied"},"paths/~1channels~1{channel_id}/delete/responses/409/content/application~1problem+json/examples/address_in_use":{"value":{"type":"https://docs.vilna.io/apis/errors#conflict","title":"Conflict","status":409,"code":"address.in_use","detail":"address has an active invoice and cannot be deleted","instance":"/traces/0123456789abcdef0123456789abcdef"},"key":"address_in_use","summary":"The address cannot be deleted while in use","id":"paths/~1channels~1{channel_id}/delete/responses/409/content/application~1problem+json/examples/address_in_use"},"paths/~1channels~1{channel_id}/delete/responses/409/content/application~1problem+json/examples/subscription_v1_conflict":{"value":{"type":"https://docs.vilna.io/apis/errors#conflict","title":"Conflict","status":409,"code":"notification.subscription_v1_conflict","detail":"a subscription created through v1 accepts name and availability changes only","instance":"/traces/0123456789abcdef0123456789abcdef"},"key":"subscription_v1_conflict","summary":"A v1-created subscription rejects trigger, filter or noise changes","id":"paths/~1channels~1{channel_id}/delete/responses/409/content/application~1problem+json/examples/subscription_v1_conflict"},"paths/~1channels~1{channel_id}/delete/responses/409/content/application~1problem+json/examples/notification_send_in_progress":{"value":{"type":"https://docs.vilna.io/apis/errors#conflict","title":"Conflict","status":409,"code":"notification.send_in_progress","detail":"notification send is in progress","instance":"/traces/0123456789abcdef0123456789abcdef"},"key":"notification_send_in_progress","summary":"The notification already has a manual attempt queued or in flight","id":"paths/~1channels~1{channel_id}/delete/responses/409/content/application~1problem+json/examples/notification_send_in_progress"},"paths/~1channels~1{channel_id}/delete/responses/409/content/application~1problem+json/examples/notification_payload_unavailable":{"value":{"type":"https://docs.vilna.io/apis/errors#conflict","title":"Conflict","status":409,"code":"notification.payload_unavailable","detail":"notification payload is no longer available","instance":"/traces/0123456789abcdef0123456789abcdef"},"key":"notification_payload_unavailable","summary":"Retention has cleared the content, so there is nothing to resend","id":"paths/~1channels~1{channel_id}/delete/responses/409/content/application~1problem+json/examples/notification_payload_unavailable"},"paths/~1channels~1{channel_id}/delete/responses/409/content/application~1problem+json/examples/notification_test_resend_not_allowed":{"value":{"type":"https://docs.vilna.io/apis/errors#conflict","title":"Conflict","status":409,"code":"notification.test_resend_not_allowed","detail":"test notifications cannot be resent","instance":"/traces/0123456789abcdef0123456789abcdef"},"key":"notification_test_resend_not_allowed","summary":"The notification is a channel test","id":"paths/~1channels~1{channel_id}/delete/responses/409/content/application~1problem+json/examples/notification_test_resend_not_allowed"},"paths/~1channels~1{channel_id}/delete/responses/503/content/application~1problem+json/examples/temporarily_unavailable":{"value":{"type":"https://docs.vilna.io/apis/errors#service-unavailable","title":"Service Unavailable","status":503,"code":"service.temporarily_unavailable","detail":"The operation is temporarily unavailable. Please try again later."},"key":"temporarily_unavailable","summary":"The operation cannot be completed at present","id":"paths/~1channels~1{channel_id}/delete/responses/503/content/application~1problem+json/examples/temporarily_unavailable"},"paths/~1channels~1{channel_id}/patch/requestBody/content/application~1json/examples/update_telegram_keep_token":{"value":{"name":"Updated Production Alerts","config":{"kind":"telegram","chat_id":-1001234567891,"language":"ru","thread_id":42}},"key":"update_telegram_keep_token","summary":"Telegram update, keep stored bot_token","id":"paths/~1channels~1{channel_id}/patch/requestBody/content/application~1json/examples/update_telegram_keep_token"},"paths/~1channels~1{channel_id}/patch/requestBody/content/application~1json/examples/update_telegram_rotate_token":{"value":{"config":{"kind":"telegram","bot_token":"123456789:ABCDEFGHIJKLMNOPQRSTUVWXYZabcdefghi","chat_id":-1001234567890,"language":"en","thread_id":0}},"key":"update_telegram_rotate_token","summary":"Telegram update, rotate bot_token","id":"paths/~1channels~1{channel_id}/patch/requestBody/content/application~1json/examples/update_telegram_rotate_token"},"paths/~1channels~1{channel_id}/patch/requestBody/content/application~1json/examples/update_webhook_keep_headers":{"value":{"name":"Updated Alert Webhook","config":{"kind":"webhook","url":"https://hooks.slack.com/services/T11111111/B11111111/YYYYYYYYYYYYYYYYYYYYYYYY"}},"key":"update_webhook_keep_headers","summary":"Webhook update, keep stored headers","id":"paths/~1channels~1{channel_id}/patch/requestBody/content/application~1json/examples/update_webhook_keep_headers"},"paths/~1channels~1{channel_id}/patch/requestBody/content/application~1json/examples/update_webhook_replace_headers":{"value":{"config":{"kind":"webhook","url":"https://hooks.slack.com/services/T11111111/B11111111/YYYYYYYYYYYYYYYYYYYYYYYY","headers":{"Content-Type":"application/json","X-Tenant-Id":"acme"}}},"key":"update_webhook_replace_headers","summary":"Webhook update, replace headers","id":"paths/~1channels~1{channel_id}/patch/requestBody/content/application~1json/examples/update_webhook_replace_headers"},"paths/~1channels~1{channel_id}/patch/requestBody/content/application~1json/examples/update_webhook_clear_headers":{"value":{"config":{"kind":"webhook","url":"https://hooks.slack.com/services/T11111111/B11111111/YYYYYYYYYYYYYYYYYYYYYYYY","headers":{}}},"key":"update_webhook_clear_headers","summary":"Webhook update, clear all headers","id":"paths/~1channels~1{channel_id}/patch/requestBody/content/application~1json/examples/update_webhook_clear_headers"},"paths/~1channels~1{channel_id}/patch/requestBody/content/application~1json/examples/update_webhook_payload_version":{"value":{"config":{"kind":"webhook","url":"https://hooks.slack.com/services/T11111111/B11111111/YYYYYYYYYYYYYYYYYYYYYYYY","payload_version":"v2"}},"key":"update_webhook_payload_version","summary":"Webhook update, move the body to v2","id":"paths/~1channels~1{channel_id}/patch/requestBody/content/application~1json/examples/update_webhook_payload_version"},"paths/~1channels~1{channel_id}/patch/requestBody/content/application~1json/examples/update_name_only":{"value":{"name":"New Channel Name"},"key":"update_name_only","summary":"Name-only update","id":"paths/~1channels~1{channel_id}/patch/requestBody/content/application~1json/examples/update_name_only"},"paths/~1channels~1{channel_id}/patch/requestBody/content/application~1json/examples/reenable_channel":{"value":{"is_enabled":true,"max_attempts":5},"key":"reenable_channel","summary":"Switch a disabled channel back on and raise its attempt budget","id":"paths/~1channels~1{channel_id}/patch/requestBody/content/application~1json/examples/reenable_channel"},"paths/~1channels~1{channel_id}/patch/responses/400/content/application~1problem+json/examples/malformed_json":{"value":{"type":"https://docs.vilna.io/apis/errors#invalid-request","title":"Invalid Request","status":400,"code":"request.malformed","detail":"The request could not be decoded.","instance":"/traces/0123456789abcdef0123456789abcdef"},"key":"malformed_json","summary":"The request body contains malformed JSON","id":"paths/~1channels~1{channel_id}/patch/responses/400/content/application~1problem+json/examples/malformed_json"},"paths/~1channels~1{channel_id}/patch/responses/401/content/application~1problem+json/examples/service_authentication_denied":{"value":{"type":"https://docs.vilna.io/apis/errors#unauthorized","title":"Unauthorized","status":401,"code":"unspecified","detail":"You are not authorized to access this resource. If the problem persists, please contact our support team.","instance":"/unauthorized?method=createInvoice"},"key":"service_authentication_denied","summary":"The API service refused authentication","id":"paths/~1channels~1{channel_id}/patch/responses/401/content/application~1problem+json/examples/service_authentication_denied"},"paths/~1channels~1{channel_id}/patch/responses/403/content/application~1problem+json/examples/insufficient_permissions":{"value":{"type":"https://docs.vilna.io/apis/errors#forbidden","title":"Forbidden","status":403,"code":"unspecified","detail":"Your credentials are valid but don't include the permission this operation needs. Check the API key permissions in the dashboard. Permissions are set when the key is created and can't be edited later. To change them, create a new key.","instance":"/forbidden?method=createInvoice"},"key":"insufficient_permissions","summary":"The API key lacks the required permission","id":"paths/~1channels~1{channel_id}/patch/responses/403/content/application~1problem+json/examples/insufficient_permissions"},"paths/~1channels~1{channel_id}/patch/responses/404/content/application~1problem+json/examples/address_not_found":{"value":{"type":"https://docs.vilna.io/apis/errors#not-found","title":"Not Found","status":404,"code":"address.not_found","detail":"address not found","instance":"/traces/0123456789abcdef0123456789abcdef"},"key":"address_not_found","summary":"The address does not exist in this project","id":"paths/~1channels~1{channel_id}/patch/responses/404/content/application~1problem+json/examples/address_not_found"},"paths/~1channels~1{channel_id}/patch/responses/404/content/application~1problem+json/examples/invoice_not_found":{"value":{"type":"https://docs.vilna.io/apis/errors#not-found","title":"Not Found","status":404,"code":"invoice.not_found","detail":"invoice not found","instance":"/traces/0123456789abcdef0123456789abcdef"},"key":"invoice_not_found","summary":"The invoice does not exist in this project","id":"paths/~1channels~1{channel_id}/patch/responses/404/content/application~1problem+json/examples/invoice_not_found"},"paths/~1channels~1{channel_id}/patch/responses/409/content/application~1problem+json/examples/address_occupied":{"value":{"type":"https://docs.vilna.io/apis/errors#conflict","title":"Conflict","status":409,"code":"invoice.address_occupied","detail":"address already has an active invoice with different parameters","instance":"/traces/0123456789abcdef0123456789abcdef"},"key":"address_occupied","summary":"The address already has an active invoice","id":"paths/~1channels~1{channel_id}/patch/responses/409/content/application~1problem+json/examples/address_occupied"},"paths/~1channels~1{channel_id}/patch/responses/409/content/application~1problem+json/examples/address_in_use":{"value":{"type":"https://docs.vilna.io/apis/errors#conflict","title":"Conflict","status":409,"code":"address.in_use","detail":"address has an active invoice and cannot be deleted","instance":"/traces/0123456789abcdef0123456789abcdef"},"key":"address_in_use","summary":"The address cannot be deleted while in use","id":"paths/~1channels~1{channel_id}/patch/responses/409/content/application~1problem+json/examples/address_in_use"},"paths/~1channels~1{channel_id}/patch/responses/409/content/application~1problem+json/examples/subscription_v1_conflict":{"value":{"type":"https://docs.vilna.io/apis/errors#conflict","title":"Conflict","status":409,"code":"notification.subscription_v1_conflict","detail":"a subscription created through v1 accepts name and availability changes only","instance":"/traces/0123456789abcdef0123456789abcdef"},"key":"subscription_v1_conflict","summary":"A v1-created subscription rejects trigger, filter or noise changes","id":"paths/~1channels~1{channel_id}/patch/responses/409/content/application~1problem+json/examples/subscription_v1_conflict"},"paths/~1channels~1{channel_id}/patch/responses/409/content/application~1problem+json/examples/notification_send_in_progress":{"value":{"type":"https://docs.vilna.io/apis/errors#conflict","title":"Conflict","status":409,"code":"notification.send_in_progress","detail":"notification send is in progress","instance":"/traces/0123456789abcdef0123456789abcdef"},"key":"notification_send_in_progress","summary":"The notification already has a manual attempt queued or in flight","id":"paths/~1channels~1{channel_id}/patch/responses/409/content/application~1problem+json/examples/notification_send_in_progress"},"paths/~1channels~1{channel_id}/patch/responses/409/content/application~1problem+json/examples/notification_payload_unavailable":{"value":{"type":"https://docs.vilna.io/apis/errors#conflict","title":"Conflict","status":409,"code":"notification.payload_unavailable","detail":"notification payload is no longer available","instance":"/traces/0123456789abcdef0123456789abcdef"},"key":"notification_payload_unavailable","summary":"Retention has cleared the content, so there is nothing to resend","id":"paths/~1channels~1{channel_id}/patch/responses/409/content/application~1problem+json/examples/notification_payload_unavailable"},"paths/~1channels~1{channel_id}/patch/responses/409/content/application~1problem+json/examples/notification_test_resend_not_allowed":{"value":{"type":"https://docs.vilna.io/apis/errors#conflict","title":"Conflict","status":409,"code":"notification.test_resend_not_allowed","detail":"test notifications cannot be resent","instance":"/traces/0123456789abcdef0123456789abcdef"},"key":"notification_test_resend_not_allowed","summary":"The notification is a channel test","id":"paths/~1channels~1{channel_id}/patch/responses/409/content/application~1problem+json/examples/notification_test_resend_not_allowed"},"paths/~1channels~1{channel_id}/patch/responses/503/content/application~1problem+json/examples/temporarily_unavailable":{"value":{"type":"https://docs.vilna.io/apis/errors#service-unavailable","title":"Service Unavailable","status":503,"code":"service.temporarily_unavailable","detail":"The operation is temporarily unavailable. Please try again later."},"key":"temporarily_unavailable","summary":"The operation cannot be completed at present","id":"paths/~1channels~1{channel_id}/patch/responses/503/content/application~1problem+json/examples/temporarily_unavailable"},"paths/~1channels~1{channel_id}~1actions~1test/post/requestBody/content/application~1json/examples/evm_test":{"value":{"family":"evm"},"key":"evm_test","summary":"EVM test message","id":"paths/~1channels~1{channel_id}~1actions~1test/post/requestBody/content/application~1json/examples/evm_test"},"paths/~1channels~1{channel_id}~1actions~1test/post/requestBody/content/application~1json/examples/bitcoin_test":{"value":{"family":"bitcoin"},"key":"bitcoin_test","summary":"Bitcoin test message","id":"paths/~1channels~1{channel_id}~1actions~1test/post/requestBody/content/application~1json/examples/bitcoin_test"},"paths/~1channels~1{channel_id}~1actions~1test/post/responses/400/content/application~1problem+json/examples/malformed_json":{"value":{"type":"https://docs.vilna.io/apis/errors#invalid-request","title":"Invalid Request","status":400,"code":"request.malformed","detail":"The request could not be decoded.","instance":"/traces/0123456789abcdef0123456789abcdef"},"key":"malformed_json","summary":"The request body contains malformed JSON","id":"paths/~1channels~1{channel_id}~1actions~1test/post/responses/400/content/application~1problem+json/examples/malformed_json"},"paths/~1channels~1{channel_id}~1actions~1test/post/responses/401/content/application~1problem+json/examples/service_authentication_denied":{"value":{"type":"https://docs.vilna.io/apis/errors#unauthorized","title":"Unauthorized","status":401,"code":"unspecified","detail":"You are not authorized to access this resource. If the problem persists, please contact our support team.","instance":"/unauthorized?method=createInvoice"},"key":"service_authentication_denied","summary":"The API service refused authentication","id":"paths/~1channels~1{channel_id}~1actions~1test/post/responses/401/content/application~1problem+json/examples/service_authentication_denied"},"paths/~1channels~1{channel_id}~1actions~1test/post/responses/403/content/application~1problem+json/examples/insufficient_permissions":{"value":{"type":"https://docs.vilna.io/apis/errors#forbidden","title":"Forbidden","status":403,"code":"unspecified","detail":"Your credentials are valid but don't include the permission this operation needs. Check the API key permissions in the dashboard. Permissions are set when the key is created and can't be edited later. To change them, create a new key.","instance":"/forbidden?method=createInvoice"},"key":"insufficient_permissions","summary":"The API key lacks the required permission","id":"paths/~1channels~1{channel_id}~1actions~1test/post/responses/403/content/application~1problem+json/examples/insufficient_permissions"},"paths/~1channels~1{channel_id}~1actions~1test/post/responses/404/content/application~1problem+json/examples/address_not_found":{"value":{"type":"https://docs.vilna.io/apis/errors#not-found","title":"Not Found","status":404,"code":"address.not_found","detail":"address not found","instance":"/traces/0123456789abcdef0123456789abcdef"},"key":"address_not_found","summary":"The address does not exist in this project","id":"paths/~1channels~1{channel_id}~1actions~1test/post/responses/404/content/application~1problem+json/examples/address_not_found"},"paths/~1channels~1{channel_id}~1actions~1test/post/responses/404/content/application~1problem+json/examples/invoice_not_found":{"value":{"type":"https://docs.vilna.io/apis/errors#not-found","title":"Not Found","status":404,"code":"invoice.not_found","detail":"invoice not found","instance":"/traces/0123456789abcdef0123456789abcdef"},"key":"invoice_not_found","summary":"The invoice does not exist in this project","id":"paths/~1channels~1{channel_id}~1actions~1test/post/responses/404/content/application~1problem+json/examples/invoice_not_found"},"paths/~1channels~1{channel_id}~1actions~1test/post/responses/409/content/application~1problem+json/examples/address_occupied":{"value":{"type":"https://docs.vilna.io/apis/errors#conflict","title":"Conflict","status":409,"code":"invoice.address_occupied","detail":"address already has an active invoice with different parameters","instance":"/traces/0123456789abcdef0123456789abcdef"},"key":"address_occupied","summary":"The address already has an active invoice","id":"paths/~1channels~1{channel_id}~1actions~1test/post/responses/409/content/application~1problem+json/examples/address_occupied"},"paths/~1channels~1{channel_id}~1actions~1test/post/responses/409/content/application~1problem+json/examples/address_in_use":{"value":{"type":"https://docs.vilna.io/apis/errors#conflict","title":"Conflict","status":409,"code":"address.in_use","detail":"address has an active invoice and cannot be deleted","instance":"/traces/0123456789abcdef0123456789abcdef"},"key":"address_in_use","summary":"The address cannot be deleted while in use","id":"paths/~1channels~1{channel_id}~1actions~1test/post/responses/409/content/application~1problem+json/examples/address_in_use"},"paths/~1channels~1{channel_id}~1actions~1test/post/responses/409/content/application~1problem+json/examples/subscription_v1_conflict":{"value":{"type":"https://docs.vilna.io/apis/errors#conflict","title":"Conflict","status":409,"code":"notification.subscription_v1_conflict","detail":"a subscription created through v1 accepts name and availability changes only","instance":"/traces/0123456789abcdef0123456789abcdef"},"key":"subscription_v1_conflict","summary":"A v1-created subscription rejects trigger, filter or noise changes","id":"paths/~1channels~1{channel_id}~1actions~1test/post/responses/409/content/application~1problem+json/examples/subscription_v1_conflict"},"paths/~1channels~1{channel_id}~1actions~1test/post/responses/409/content/application~1problem+json/examples/notification_send_in_progress":{"value":{"type":"https://docs.vilna.io/apis/errors#conflict","title":"Conflict","status":409,"code":"notification.send_in_progress","detail":"notification send is in progress","instance":"/traces/0123456789abcdef0123456789abcdef"},"key":"notification_send_in_progress","summary":"The notification already has a manual attempt queued or in flight","id":"paths/~1channels~1{channel_id}~1actions~1test/post/responses/409/content/application~1problem+json/examples/notification_send_in_progress"},"paths/~1channels~1{channel_id}~1actions~1test/post/responses/409/content/application~1problem+json/examples/notification_payload_unavailable":{"value":{"type":"https://docs.vilna.io/apis/errors#conflict","title":"Conflict","status":409,"code":"notification.payload_unavailable","detail":"notification payload is no longer available","instance":"/traces/0123456789abcdef0123456789abcdef"},"key":"notification_payload_unavailable","summary":"Retention has cleared the content, so there is nothing to resend","id":"paths/~1channels~1{channel_id}~1actions~1test/post/responses/409/content/application~1problem+json/examples/notification_payload_unavailable"},"paths/~1channels~1{channel_id}~1actions~1test/post/responses/409/content/application~1problem+json/examples/notification_test_resend_not_allowed":{"value":{"type":"https://docs.vilna.io/apis/errors#conflict","title":"Conflict","status":409,"code":"notification.test_resend_not_allowed","detail":"test notifications cannot be resent","instance":"/traces/0123456789abcdef0123456789abcdef"},"key":"notification_test_resend_not_allowed","summary":"The notification is a channel test","id":"paths/~1channels~1{channel_id}~1actions~1test/post/responses/409/content/application~1problem+json/examples/notification_test_resend_not_allowed"},"paths/~1channels~1{channel_id}~1actions~1test/post/responses/422/content/application~1problem+json/examples/invoice_not_cancellable":{"value":{"type":"https://docs.vilna.io/apis/errors#precondition","title":"Precondition Failed","status":422,"code":"invoice.not_cancellable","detail":"invoice cannot be cancelled in current status","instance":"/traces/0123456789abcdef0123456789abcdef","fields":[{"name":"status","reason":"confirmed"}]},"key":"invoice_not_cancellable","summary":"A confirmed invoice cannot be cancelled","id":"paths/~1channels~1{channel_id}~1actions~1test/post/responses/422/content/application~1problem+json/examples/invoice_not_cancellable"},"paths/~1channels~1{channel_id}~1actions~1test/post/responses/503/content/application~1problem+json/examples/temporarily_unavailable":{"value":{"type":"https://docs.vilna.io/apis/errors#service-unavailable","title":"Service Unavailable","status":503,"code":"service.temporarily_unavailable","detail":"The operation is temporarily unavailable. Please try again later."},"key":"temporarily_unavailable","summary":"The operation cannot be completed at present","id":"paths/~1channels~1{channel_id}~1actions~1test/post/responses/503/content/application~1problem+json/examples/temporarily_unavailable"},"paths/~1channels~1{channel_id}~1webhook-secrets/get/responses/400/content/application~1problem+json/examples/malformed_json":{"value":{"type":"https://docs.vilna.io/apis/errors#invalid-request","title":"Invalid Request","status":400,"code":"request.malformed","detail":"The request could not be decoded.","instance":"/traces/0123456789abcdef0123456789abcdef"},"key":"malformed_json","summary":"The request body contains malformed JSON","id":"paths/~1channels~1{channel_id}~1webhook-secrets/get/responses/400/content/application~1problem+json/examples/malformed_json"},"paths/~1channels~1{channel_id}~1webhook-secrets/get/responses/401/content/application~1problem+json/examples/service_authentication_denied":{"value":{"type":"https://docs.vilna.io/apis/errors#unauthorized","title":"Unauthorized","status":401,"code":"unspecified","detail":"You are not authorized to access this resource. If the problem persists, please contact our support team.","instance":"/unauthorized?method=createInvoice"},"key":"service_authentication_denied","summary":"The API service refused authentication","id":"paths/~1channels~1{channel_id}~1webhook-secrets/get/responses/401/content/application~1problem+json/examples/service_authentication_denied"},"paths/~1channels~1{channel_id}~1webhook-secrets/get/responses/403/content/application~1problem+json/examples/insufficient_permissions":{"value":{"type":"https://docs.vilna.io/apis/errors#forbidden","title":"Forbidden","status":403,"code":"unspecified","detail":"Your credentials are valid but don't include the permission this operation needs. Check the API key permissions in the dashboard. Permissions are set when the key is created and can't be edited later. To change them, create a new key.","instance":"/forbidden?method=createInvoice"},"key":"insufficient_permissions","summary":"The API key lacks the required permission","id":"paths/~1channels~1{channel_id}~1webhook-secrets/get/responses/403/content/application~1problem+json/examples/insufficient_permissions"},"paths/~1channels~1{channel_id}~1webhook-secrets/get/responses/404/content/application~1problem+json/examples/address_not_found":{"value":{"type":"https://docs.vilna.io/apis/errors#not-found","title":"Not Found","status":404,"code":"address.not_found","detail":"address not found","instance":"/traces/0123456789abcdef0123456789abcdef"},"key":"address_not_found","summary":"The address does not exist in this project","id":"paths/~1channels~1{channel_id}~1webhook-secrets/get/responses/404/content/application~1problem+json/examples/address_not_found"},"paths/~1channels~1{channel_id}~1webhook-secrets/get/responses/404/content/application~1problem+json/examples/invoice_not_found":{"value":{"type":"https://docs.vilna.io/apis/errors#not-found","title":"Not Found","status":404,"code":"invoice.not_found","detail":"invoice not found","instance":"/traces/0123456789abcdef0123456789abcdef"},"key":"invoice_not_found","summary":"The invoice does not exist in this project","id":"paths/~1channels~1{channel_id}~1webhook-secrets/get/responses/404/content/application~1problem+json/examples/invoice_not_found"},"paths/~1channels~1{channel_id}~1webhook-secrets/get/responses/503/content/application~1problem+json/examples/temporarily_unavailable":{"value":{"type":"https://docs.vilna.io/apis/errors#service-unavailable","title":"Service Unavailable","status":503,"code":"service.temporarily_unavailable","detail":"The operation is temporarily unavailable. Please try again later."},"key":"temporarily_unavailable","summary":"The operation cannot be completed at present","id":"paths/~1channels~1{channel_id}~1webhook-secrets/get/responses/503/content/application~1problem+json/examples/temporarily_unavailable"},"paths/~1channels~1{channel_id}~1webhook-secrets~1actions~1rotate/post/responses/400/content/application~1problem+json/examples/malformed_json":{"value":{"type":"https://docs.vilna.io/apis/errors#invalid-request","title":"Invalid Request","status":400,"code":"request.malformed","detail":"The request could not be decoded.","instance":"/traces/0123456789abcdef0123456789abcdef"},"key":"malformed_json","summary":"The request body contains malformed JSON","id":"paths/~1channels~1{channel_id}~1webhook-secrets~1actions~1rotate/post/responses/400/content/application~1problem+json/examples/malformed_json"},"paths/~1channels~1{channel_id}~1webhook-secrets~1actions~1rotate/post/responses/401/content/application~1problem+json/examples/service_authentication_denied":{"value":{"type":"https://docs.vilna.io/apis/errors#unauthorized","title":"Unauthorized","status":401,"code":"unspecified","detail":"You are not authorized to access this resource. If the problem persists, please contact our support team.","instance":"/unauthorized?method=createInvoice"},"key":"service_authentication_denied","summary":"The API service refused authentication","id":"paths/~1channels~1{channel_id}~1webhook-secrets~1actions~1rotate/post/responses/401/content/application~1problem+json/examples/service_authentication_denied"},"paths/~1channels~1{channel_id}~1webhook-secrets~1actions~1rotate/post/responses/403/content/application~1problem+json/examples/insufficient_permissions":{"value":{"type":"https://docs.vilna.io/apis/errors#forbidden","title":"Forbidden","status":403,"code":"unspecified","detail":"Your credentials are valid but don't include the permission this operation needs. Check the API key permissions in the dashboard. Permissions are set when the key is created and can't be edited later. To change them, create a new key.","instance":"/forbidden?method=createInvoice"},"key":"insufficient_permissions","summary":"The API key lacks the required permission","id":"paths/~1channels~1{channel_id}~1webhook-secrets~1actions~1rotate/post/responses/403/content/application~1problem+json/examples/insufficient_permissions"},"paths/~1channels~1{channel_id}~1webhook-secrets~1actions~1rotate/post/responses/404/content/application~1problem+json/examples/address_not_found":{"value":{"type":"https://docs.vilna.io/apis/errors#not-found","title":"Not Found","status":404,"code":"address.not_found","detail":"address not found","instance":"/traces/0123456789abcdef0123456789abcdef"},"key":"address_not_found","summary":"The address does not exist in this project","id":"paths/~1channels~1{channel_id}~1webhook-secrets~1actions~1rotate/post/responses/404/content/application~1problem+json/examples/address_not_found"},"paths/~1channels~1{channel_id}~1webhook-secrets~1actions~1rotate/post/responses/404/content/application~1problem+json/examples/invoice_not_found":{"value":{"type":"https://docs.vilna.io/apis/errors#not-found","title":"Not Found","status":404,"code":"invoice.not_found","detail":"invoice not found","instance":"/traces/0123456789abcdef0123456789abcdef"},"key":"invoice_not_found","summary":"The invoice does not exist in this project","id":"paths/~1channels~1{channel_id}~1webhook-secrets~1actions~1rotate/post/responses/404/content/application~1problem+json/examples/invoice_not_found"},"paths/~1channels~1{channel_id}~1webhook-secrets~1actions~1rotate/post/responses/409/content/application~1problem+json/examples/address_occupied":{"value":{"type":"https://docs.vilna.io/apis/errors#conflict","title":"Conflict","status":409,"code":"invoice.address_occupied","detail":"address already has an active invoice with different parameters","instance":"/traces/0123456789abcdef0123456789abcdef"},"key":"address_occupied","summary":"The address already has an active invoice","id":"paths/~1channels~1{channel_id}~1webhook-secrets~1actions~1rotate/post/responses/409/content/application~1problem+json/examples/address_occupied"},"paths/~1channels~1{channel_id}~1webhook-secrets~1actions~1rotate/post/responses/409/content/application~1problem+json/examples/address_in_use":{"value":{"type":"https://docs.vilna.io/apis/errors#conflict","title":"Conflict","status":409,"code":"address.in_use","detail":"address has an active invoice and cannot be deleted","instance":"/traces/0123456789abcdef0123456789abcdef"},"key":"address_in_use","summary":"The address cannot be deleted while in use","id":"paths/~1channels~1{channel_id}~1webhook-secrets~1actions~1rotate/post/responses/409/content/application~1problem+json/examples/address_in_use"},"paths/~1channels~1{channel_id}~1webhook-secrets~1actions~1rotate/post/responses/409/content/application~1problem+json/examples/subscription_v1_conflict":{"value":{"type":"https://docs.vilna.io/apis/errors#conflict","title":"Conflict","status":409,"code":"notification.subscription_v1_conflict","detail":"a subscription created through v1 accepts name and availability changes only","instance":"/traces/0123456789abcdef0123456789abcdef"},"key":"subscription_v1_conflict","summary":"A v1-created subscription rejects trigger, filter or noise changes","id":"paths/~1channels~1{channel_id}~1webhook-secrets~1actions~1rotate/post/responses/409/content/application~1problem+json/examples/subscription_v1_conflict"},"paths/~1channels~1{channel_id}~1webhook-secrets~1actions~1rotate/post/responses/409/content/application~1problem+json/examples/notification_send_in_progress":{"value":{"type":"https://docs.vilna.io/apis/errors#conflict","title":"Conflict","status":409,"code":"notification.send_in_progress","detail":"notification send is in progress","instance":"/traces/0123456789abcdef0123456789abcdef"},"key":"notification_send_in_progress","summary":"The notification already has a manual attempt queued or in flight","id":"paths/~1channels~1{channel_id}~1webhook-secrets~1actions~1rotate/post/responses/409/content/application~1problem+json/examples/notification_send_in_progress"},"paths/~1channels~1{channel_id}~1webhook-secrets~1actions~1rotate/post/responses/409/content/application~1problem+json/examples/notification_payload_unavailable":{"value":{"type":"https://docs.vilna.io/apis/errors#conflict","title":"Conflict","status":409,"code":"notification.payload_unavailable","detail":"notification payload is no longer available","instance":"/traces/0123456789abcdef0123456789abcdef"},"key":"notification_payload_unavailable","summary":"Retention has cleared the content, so there is nothing to resend","id":"paths/~1channels~1{channel_id}~1webhook-secrets~1actions~1rotate/post/responses/409/content/application~1problem+json/examples/notification_payload_unavailable"},"paths/~1channels~1{channel_id}~1webhook-secrets~1actions~1rotate/post/responses/409/content/application~1problem+json/examples/notification_test_resend_not_allowed":{"value":{"type":"https://docs.vilna.io/apis/errors#conflict","title":"Conflict","status":409,"code":"notification.test_resend_not_allowed","detail":"test notifications cannot be resent","instance":"/traces/0123456789abcdef0123456789abcdef"},"key":"notification_test_resend_not_allowed","summary":"The notification is a channel test","id":"paths/~1channels~1{channel_id}~1webhook-secrets~1actions~1rotate/post/responses/409/content/application~1problem+json/examples/notification_test_resend_not_allowed"},"paths/~1channels~1{channel_id}~1webhook-secrets~1actions~1rotate/post/responses/503/content/application~1problem+json/examples/temporarily_unavailable":{"value":{"type":"https://docs.vilna.io/apis/errors#service-unavailable","title":"Service Unavailable","status":503,"code":"service.temporarily_unavailable","detail":"The operation is temporarily unavailable. Please try again later."},"key":"temporarily_unavailable","summary":"The operation cannot be completed at present","id":"paths/~1channels~1{channel_id}~1webhook-secrets~1actions~1rotate/post/responses/503/content/application~1problem+json/examples/temporarily_unavailable"},"paths/~1channels~1{channel_id}~1webhook-secrets~1previous/delete/responses/400/content/application~1problem+json/examples/malformed_json":{"value":{"type":"https://docs.vilna.io/apis/errors#invalid-request","title":"Invalid Request","status":400,"code":"request.malformed","detail":"The request could not be decoded.","instance":"/traces/0123456789abcdef0123456789abcdef"},"key":"malformed_json","summary":"The request body contains malformed JSON","id":"paths/~1channels~1{channel_id}~1webhook-secrets~1previous/delete/responses/400/content/application~1problem+json/examples/malformed_json"},"paths/~1channels~1{channel_id}~1webhook-secrets~1previous/delete/responses/401/content/application~1problem+json/examples/service_authentication_denied":{"value":{"type":"https://docs.vilna.io/apis/errors#unauthorized","title":"Unauthorized","status":401,"code":"unspecified","detail":"You are not authorized to access this resource. If the problem persists, please contact our support team.","instance":"/unauthorized?method=createInvoice"},"key":"service_authentication_denied","summary":"The API service refused authentication","id":"paths/~1channels~1{channel_id}~1webhook-secrets~1previous/delete/responses/401/content/application~1problem+json/examples/service_authentication_denied"},"paths/~1channels~1{channel_id}~1webhook-secrets~1previous/delete/responses/403/content/application~1problem+json/examples/insufficient_permissions":{"value":{"type":"https://docs.vilna.io/apis/errors#forbidden","title":"Forbidden","status":403,"code":"unspecified","detail":"Your credentials are valid but don't include the permission this operation needs. Check the API key permissions in the dashboard. Permissions are set when the key is created and can't be edited later. To change them, create a new key.","instance":"/forbidden?method=createInvoice"},"key":"insufficient_permissions","summary":"The API key lacks the required permission","id":"paths/~1channels~1{channel_id}~1webhook-secrets~1previous/delete/responses/403/content/application~1problem+json/examples/insufficient_permissions"},"paths/~1channels~1{channel_id}~1webhook-secrets~1previous/delete/responses/404/content/application~1problem+json/examples/address_not_found":{"value":{"type":"https://docs.vilna.io/apis/errors#not-found","title":"Not Found","status":404,"code":"address.not_found","detail":"address not found","instance":"/traces/0123456789abcdef0123456789abcdef"},"key":"address_not_found","summary":"The address does not exist in this project","id":"paths/~1channels~1{channel_id}~1webhook-secrets~1previous/delete/responses/404/content/application~1problem+json/examples/address_not_found"},"paths/~1channels~1{channel_id}~1webhook-secrets~1previous/delete/responses/404/content/application~1problem+json/examples/invoice_not_found":{"value":{"type":"https://docs.vilna.io/apis/errors#not-found","title":"Not Found","status":404,"code":"invoice.not_found","detail":"invoice not found","instance":"/traces/0123456789abcdef0123456789abcdef"},"key":"invoice_not_found","summary":"The invoice does not exist in this project","id":"paths/~1channels~1{channel_id}~1webhook-secrets~1previous/delete/responses/404/content/application~1problem+json/examples/invoice_not_found"},"paths/~1channels~1{channel_id}~1webhook-secrets~1previous/delete/responses/409/content/application~1problem+json/examples/address_occupied":{"value":{"type":"https://docs.vilna.io/apis/errors#conflict","title":"Conflict","status":409,"code":"invoice.address_occupied","detail":"address already has an active invoice with different parameters","instance":"/traces/0123456789abcdef0123456789abcdef"},"key":"address_occupied","summary":"The address already has an active invoice","id":"paths/~1channels~1{channel_id}~1webhook-secrets~1previous/delete/responses/409/content/application~1problem+json/examples/address_occupied"},"paths/~1channels~1{channel_id}~1webhook-secrets~1previous/delete/responses/409/content/application~1problem+json/examples/address_in_use":{"value":{"type":"https://docs.vilna.io/apis/errors#conflict","title":"Conflict","status":409,"code":"address.in_use","detail":"address has an active invoice and cannot be deleted","instance":"/traces/0123456789abcdef0123456789abcdef"},"key":"address_in_use","summary":"The address cannot be deleted while in use","id":"paths/~1channels~1{channel_id}~1webhook-secrets~1previous/delete/responses/409/content/application~1problem+json/examples/address_in_use"},"paths/~1channels~1{channel_id}~1webhook-secrets~1previous/delete/responses/409/content/application~1problem+json/examples/subscription_v1_conflict":{"value":{"type":"https://docs.vilna.io/apis/errors#conflict","title":"Conflict","status":409,"code":"notification.subscription_v1_conflict","detail":"a subscription created through v1 accepts name and availability changes only","instance":"/traces/0123456789abcdef0123456789abcdef"},"key":"subscription_v1_conflict","summary":"A v1-created subscription rejects trigger, filter or noise changes","id":"paths/~1channels~1{channel_id}~1webhook-secrets~1previous/delete/responses/409/content/application~1problem+json/examples/subscription_v1_conflict"},"paths/~1channels~1{channel_id}~1webhook-secrets~1previous/delete/responses/409/content/application~1problem+json/examples/notification_send_in_progress":{"value":{"type":"https://docs.vilna.io/apis/errors#conflict","title":"Conflict","status":409,"code":"notification.send_in_progress","detail":"notification send is in progress","instance":"/traces/0123456789abcdef0123456789abcdef"},"key":"notification_send_in_progress","summary":"The notification already has a manual attempt queued or in flight","id":"paths/~1channels~1{channel_id}~1webhook-secrets~1previous/delete/responses/409/content/application~1problem+json/examples/notification_send_in_progress"},"paths/~1channels~1{channel_id}~1webhook-secrets~1previous/delete/responses/409/content/application~1problem+json/examples/notification_payload_unavailable":{"value":{"type":"https://docs.vilna.io/apis/errors#conflict","title":"Conflict","status":409,"code":"notification.payload_unavailable","detail":"notification payload is no longer available","instance":"/traces/0123456789abcdef0123456789abcdef"},"key":"notification_payload_unavailable","summary":"Retention has cleared the content, so there is nothing to resend","id":"paths/~1channels~1{channel_id}~1webhook-secrets~1previous/delete/responses/409/content/application~1problem+json/examples/notification_payload_unavailable"},"paths/~1channels~1{channel_id}~1webhook-secrets~1previous/delete/responses/409/content/application~1problem+json/examples/notification_test_resend_not_allowed":{"value":{"type":"https://docs.vilna.io/apis/errors#conflict","title":"Conflict","status":409,"code":"notification.test_resend_not_allowed","detail":"test notifications cannot be resent","instance":"/traces/0123456789abcdef0123456789abcdef"},"key":"notification_test_resend_not_allowed","summary":"The notification is a channel test","id":"paths/~1channels~1{channel_id}~1webhook-secrets~1previous/delete/responses/409/content/application~1problem+json/examples/notification_test_resend_not_allowed"},"paths/~1channels~1{channel_id}~1webhook-secrets~1previous/delete/responses/503/content/application~1problem+json/examples/temporarily_unavailable":{"value":{"type":"https://docs.vilna.io/apis/errors#service-unavailable","title":"Service Unavailable","status":503,"code":"service.temporarily_unavailable","detail":"The operation is temporarily unavailable. Please try again later."},"key":"temporarily_unavailable","summary":"The operation cannot be completed at present","id":"paths/~1channels~1{channel_id}~1webhook-secrets~1previous/delete/responses/503/content/application~1problem+json/examples/temporarily_unavailable"},"paths/~1subscriptions/get/responses/400/content/application~1problem+json/examples/malformed_json":{"value":{"type":"https://docs.vilna.io/apis/errors#invalid-request","title":"Invalid Request","status":400,"code":"request.malformed","detail":"The request could not be decoded.","instance":"/traces/0123456789abcdef0123456789abcdef"},"key":"malformed_json","summary":"The request body contains malformed JSON","id":"paths/~1subscriptions/get/responses/400/content/application~1problem+json/examples/malformed_json"},"paths/~1subscriptions/get/responses/401/content/application~1problem+json/examples/service_authentication_denied":{"value":{"type":"https://docs.vilna.io/apis/errors#unauthorized","title":"Unauthorized","status":401,"code":"unspecified","detail":"You are not authorized to access this resource. If the problem persists, please contact our support team.","instance":"/unauthorized?method=createInvoice"},"key":"service_authentication_denied","summary":"The API service refused authentication","id":"paths/~1subscriptions/get/responses/401/content/application~1problem+json/examples/service_authentication_denied"},"paths/~1subscriptions/get/responses/403/content/application~1problem+json/examples/insufficient_permissions":{"value":{"type":"https://docs.vilna.io/apis/errors#forbidden","title":"Forbidden","status":403,"code":"unspecified","detail":"Your credentials are valid but don't include the permission this operation needs. Check the API key permissions in the dashboard. Permissions are set when the key is created and can't be edited later. To change them, create a new key.","instance":"/forbidden?method=createInvoice"},"key":"insufficient_permissions","summary":"The API key lacks the required permission","id":"paths/~1subscriptions/get/responses/403/content/application~1problem+json/examples/insufficient_permissions"},"paths/~1subscriptions/get/responses/503/content/application~1problem+json/examples/temporarily_unavailable":{"value":{"type":"https://docs.vilna.io/apis/errors#service-unavailable","title":"Service Unavailable","status":503,"code":"service.temporarily_unavailable","detail":"The operation is temporarily unavailable. Please try again later."},"key":"temporarily_unavailable","summary":"The operation cannot be completed at present","id":"paths/~1subscriptions/get/responses/503/content/application~1problem+json/examples/temporarily_unavailable"},"paths/~1subscriptions/post/requestBody/content/application~1json/examples/create_block_trigger_subscription":{"value":{"name":"Customer payments","channel_id":"550e8400-e29b-41d4-a716-446655440001","family":"evm","trigger":{"kind":"block","after_blocks":3},"filters":{"chain_gids":["eip155:1","eip155:56"],"address_tag_ids":["550e8400-e29b-41d4-a716-446655440020"]},"is_noise_filtered":true},"key":"create_block_trigger_subscription","summary":"Notify 3 blocks after inclusion on selected networks and tags","id":"paths/~1subscriptions/post/requestBody/content/application~1json/examples/create_block_trigger_subscription"},"paths/~1subscriptions/post/requestBody/content/application~1json/examples/create_mempool_trigger_subscription":{"value":{"name":"Bitcoin mempool watch","channel_id":"550e8400-e29b-41d4-a716-446655440001","family":"bitcoin","trigger":{"kind":"mempool"}},"key":"create_mempool_trigger_subscription","summary":"Notify from the Bitcoin mempool with no scope restriction","id":"paths/~1subscriptions/post/requestBody/content/application~1json/examples/create_mempool_trigger_subscription"},"paths/~1subscriptions/post/responses/400/content/application~1problem+json/examples/malformed_json":{"value":{"type":"https://docs.vilna.io/apis/errors#invalid-request","title":"Invalid Request","status":400,"code":"request.malformed","detail":"The request could not be decoded.","instance":"/traces/0123456789abcdef0123456789abcdef"},"key":"malformed_json","summary":"The request body contains malformed JSON","id":"paths/~1subscriptions/post/responses/400/content/application~1problem+json/examples/malformed_json"},"paths/~1subscriptions/post/responses/401/content/application~1problem+json/examples/service_authentication_denied":{"value":{"type":"https://docs.vilna.io/apis/errors#unauthorized","title":"Unauthorized","status":401,"code":"unspecified","detail":"You are not authorized to access this resource. If the problem persists, please contact our support team.","instance":"/unauthorized?method=createInvoice"},"key":"service_authentication_denied","summary":"The API service refused authentication","id":"paths/~1subscriptions/post/responses/401/content/application~1problem+json/examples/service_authentication_denied"},"paths/~1subscriptions/post/responses/403/content/application~1problem+json/examples/insufficient_permissions":{"value":{"type":"https://docs.vilna.io/apis/errors#forbidden","title":"Forbidden","status":403,"code":"unspecified","detail":"Your credentials are valid but don't include the permission this operation needs. Check the API key permissions in the dashboard. Permissions are set when the key is created and can't be edited later. To change them, create a new key.","instance":"/forbidden?method=createInvoice"},"key":"insufficient_permissions","summary":"The API key lacks the required permission","id":"paths/~1subscriptions/post/responses/403/content/application~1problem+json/examples/insufficient_permissions"},"paths/~1subscriptions/post/responses/404/content/application~1problem+json/examples/address_not_found":{"value":{"type":"https://docs.vilna.io/apis/errors#not-found","title":"Not Found","status":404,"code":"address.not_found","detail":"address not found","instance":"/traces/0123456789abcdef0123456789abcdef"},"key":"address_not_found","summary":"The address does not exist in this project","id":"paths/~1subscriptions/post/responses/404/content/application~1problem+json/examples/address_not_found"},"paths/~1subscriptions/post/responses/404/content/application~1problem+json/examples/invoice_not_found":{"value":{"type":"https://docs.vilna.io/apis/errors#not-found","title":"Not Found","status":404,"code":"invoice.not_found","detail":"invoice not found","instance":"/traces/0123456789abcdef0123456789abcdef"},"key":"invoice_not_found","summary":"The invoice does not exist in this project","id":"paths/~1subscriptions/post/responses/404/content/application~1problem+json/examples/invoice_not_found"},"paths/~1subscriptions/post/responses/409/content/application~1problem+json/examples/address_occupied":{"value":{"type":"https://docs.vilna.io/apis/errors#conflict","title":"Conflict","status":409,"code":"invoice.address_occupied","detail":"address already has an active invoice with different parameters","instance":"/traces/0123456789abcdef0123456789abcdef"},"key":"address_occupied","summary":"The address already has an active invoice","id":"paths/~1subscriptions/post/responses/409/content/application~1problem+json/examples/address_occupied"},"paths/~1subscriptions/post/responses/409/content/application~1problem+json/examples/address_in_use":{"value":{"type":"https://docs.vilna.io/apis/errors#conflict","title":"Conflict","status":409,"code":"address.in_use","detail":"address has an active invoice and cannot be deleted","instance":"/traces/0123456789abcdef0123456789abcdef"},"key":"address_in_use","summary":"The address cannot be deleted while in use","id":"paths/~1subscriptions/post/responses/409/content/application~1problem+json/examples/address_in_use"},"paths/~1subscriptions/post/responses/409/content/application~1problem+json/examples/subscription_v1_conflict":{"value":{"type":"https://docs.vilna.io/apis/errors#conflict","title":"Conflict","status":409,"code":"notification.subscription_v1_conflict","detail":"a subscription created through v1 accepts name and availability changes only","instance":"/traces/0123456789abcdef0123456789abcdef"},"key":"subscription_v1_conflict","summary":"A v1-created subscription rejects trigger, filter or noise changes","id":"paths/~1subscriptions/post/responses/409/content/application~1problem+json/examples/subscription_v1_conflict"},"paths/~1subscriptions/post/responses/409/content/application~1problem+json/examples/notification_send_in_progress":{"value":{"type":"https://docs.vilna.io/apis/errors#conflict","title":"Conflict","status":409,"code":"notification.send_in_progress","detail":"notification send is in progress","instance":"/traces/0123456789abcdef0123456789abcdef"},"key":"notification_send_in_progress","summary":"The notification already has a manual attempt queued or in flight","id":"paths/~1subscriptions/post/responses/409/content/application~1problem+json/examples/notification_send_in_progress"},"paths/~1subscriptions/post/responses/409/content/application~1problem+json/examples/notification_payload_unavailable":{"value":{"type":"https://docs.vilna.io/apis/errors#conflict","title":"Conflict","status":409,"code":"notification.payload_unavailable","detail":"notification payload is no longer available","instance":"/traces/0123456789abcdef0123456789abcdef"},"key":"notification_payload_unavailable","summary":"Retention has cleared the content, so there is nothing to resend","id":"paths/~1subscriptions/post/responses/409/content/application~1problem+json/examples/notification_payload_unavailable"},"paths/~1subscriptions/post/responses/409/content/application~1problem+json/examples/notification_test_resend_not_allowed":{"value":{"type":"https://docs.vilna.io/apis/errors#conflict","title":"Conflict","status":409,"code":"notification.test_resend_not_allowed","detail":"test notifications cannot be resent","instance":"/traces/0123456789abcdef0123456789abcdef"},"key":"notification_test_resend_not_allowed","summary":"The notification is a channel test","id":"paths/~1subscriptions/post/responses/409/content/application~1problem+json/examples/notification_test_resend_not_allowed"},"paths/~1subscriptions/post/responses/429/content/application~1problem+json/examples/address_quota":{"value":{"type":"https://docs.vilna.io/apis/errors#too-many-requests","title":"Too Many Requests","status":429,"code":"address.quota_exceeded","detail":"the project has reached its address limit","max":100},"key":"address_quota","summary":"The project has reached its address quota","id":"paths/~1subscriptions/post/responses/429/content/application~1problem+json/examples/address_quota"},"paths/~1subscriptions/post/responses/429/content/application~1problem+json/examples/creation_prohibited":{"value":{"type":"https://docs.vilna.io/apis/errors#too-many-requests","title":"Too Many Requests","status":429,"code":"channel.quota_exceeded","detail":"the project has reached its channel limit","max":0},"key":"creation_prohibited","summary":"A zero effective limit prohibits new resources","id":"paths/~1subscriptions/post/responses/429/content/application~1problem+json/examples/creation_prohibited"},"paths/~1subscriptions/post/responses/503/content/application~1problem+json/examples/temporarily_unavailable":{"value":{"type":"https://docs.vilna.io/apis/errors#service-unavailable","title":"Service Unavailable","status":503,"code":"service.temporarily_unavailable","detail":"The operation is temporarily unavailable. Please try again later."},"key":"temporarily_unavailable","summary":"The operation cannot be completed at present","id":"paths/~1subscriptions/post/responses/503/content/application~1problem+json/examples/temporarily_unavailable"},"paths/~1subscriptions~1{subscription_id}/get/responses/400/content/application~1problem+json/examples/malformed_json":{"value":{"type":"https://docs.vilna.io/apis/errors#invalid-request","title":"Invalid Request","status":400,"code":"request.malformed","detail":"The request could not be decoded.","instance":"/traces/0123456789abcdef0123456789abcdef"},"key":"malformed_json","summary":"The request body contains malformed JSON","id":"paths/~1subscriptions~1{subscription_id}/get/responses/400/content/application~1problem+json/examples/malformed_json"},"paths/~1subscriptions~1{subscription_id}/get/responses/401/content/application~1problem+json/examples/service_authentication_denied":{"value":{"type":"https://docs.vilna.io/apis/errors#unauthorized","title":"Unauthorized","status":401,"code":"unspecified","detail":"You are not authorized to access this resource. If the problem persists, please contact our support team.","instance":"/unauthorized?method=createInvoice"},"key":"service_authentication_denied","summary":"The API service refused authentication","id":"paths/~1subscriptions~1{subscription_id}/get/responses/401/content/application~1problem+json/examples/service_authentication_denied"},"paths/~1subscriptions~1{subscription_id}/get/responses/403/content/application~1problem+json/examples/insufficient_permissions":{"value":{"type":"https://docs.vilna.io/apis/errors#forbidden","title":"Forbidden","status":403,"code":"unspecified","detail":"Your credentials are valid but don't include the permission this operation needs. Check the API key permissions in the dashboard. Permissions are set when the key is created and can't be edited later. To change them, create a new key.","instance":"/forbidden?method=createInvoice"},"key":"insufficient_permissions","summary":"The API key lacks the required permission","id":"paths/~1subscriptions~1{subscription_id}/get/responses/403/content/application~1problem+json/examples/insufficient_permissions"},"paths/~1subscriptions~1{subscription_id}/get/responses/404/content/application~1problem+json/examples/address_not_found":{"value":{"type":"https://docs.vilna.io/apis/errors#not-found","title":"Not Found","status":404,"code":"address.not_found","detail":"address not found","instance":"/traces/0123456789abcdef0123456789abcdef"},"key":"address_not_found","summary":"The address does not exist in this project","id":"paths/~1subscriptions~1{subscription_id}/get/responses/404/content/application~1problem+json/examples/address_not_found"},"paths/~1subscriptions~1{subscription_id}/get/responses/404/content/application~1problem+json/examples/invoice_not_found":{"value":{"type":"https://docs.vilna.io/apis/errors#not-found","title":"Not Found","status":404,"code":"invoice.not_found","detail":"invoice not found","instance":"/traces/0123456789abcdef0123456789abcdef"},"key":"invoice_not_found","summary":"The invoice does not exist in this project","id":"paths/~1subscriptions~1{subscription_id}/get/responses/404/content/application~1problem+json/examples/invoice_not_found"},"paths/~1subscriptions~1{subscription_id}/get/responses/503/content/application~1problem+json/examples/temporarily_unavailable":{"value":{"type":"https://docs.vilna.io/apis/errors#service-unavailable","title":"Service Unavailable","status":503,"code":"service.temporarily_unavailable","detail":"The operation is temporarily unavailable. Please try again later."},"key":"temporarily_unavailable","summary":"The operation cannot be completed at present","id":"paths/~1subscriptions~1{subscription_id}/get/responses/503/content/application~1problem+json/examples/temporarily_unavailable"},"paths/~1subscriptions~1{subscription_id}/delete/responses/400/content/application~1problem+json/examples/malformed_json":{"value":{"type":"https://docs.vilna.io/apis/errors#invalid-request","title":"Invalid Request","status":400,"code":"request.malformed","detail":"The request could not be decoded.","instance":"/traces/0123456789abcdef0123456789abcdef"},"key":"malformed_json","summary":"The request body contains malformed JSON","id":"paths/~1subscriptions~1{subscription_id}/delete/responses/400/content/application~1problem+json/examples/malformed_json"},"paths/~1subscriptions~1{subscription_id}/delete/responses/401/content/application~1problem+json/examples/service_authentication_denied":{"value":{"type":"https://docs.vilna.io/apis/errors#unauthorized","title":"Unauthorized","status":401,"code":"unspecified","detail":"You are not authorized to access this resource. If the problem persists, please contact our support team.","instance":"/unauthorized?method=createInvoice"},"key":"service_authentication_denied","summary":"The API service refused authentication","id":"paths/~1subscriptions~1{subscription_id}/delete/responses/401/content/application~1problem+json/examples/service_authentication_denied"},"paths/~1subscriptions~1{subscription_id}/delete/responses/403/content/application~1problem+json/examples/insufficient_permissions":{"value":{"type":"https://docs.vilna.io/apis/errors#forbidden","title":"Forbidden","status":403,"code":"unspecified","detail":"Your credentials are valid but don't include the permission this operation needs. Check the API key permissions in the dashboard. Permissions are set when the key is created and can't be edited later. To change them, create a new key.","instance":"/forbidden?method=createInvoice"},"key":"insufficient_permissions","summary":"The API key lacks the required permission","id":"paths/~1subscriptions~1{subscription_id}/delete/responses/403/content/application~1problem+json/examples/insufficient_permissions"},"paths/~1subscriptions~1{subscription_id}/delete/responses/404/content/application~1problem+json/examples/address_not_found":{"value":{"type":"https://docs.vilna.io/apis/errors#not-found","title":"Not Found","status":404,"code":"address.not_found","detail":"address not found","instance":"/traces/0123456789abcdef0123456789abcdef"},"key":"address_not_found","summary":"The address does not exist in this project","id":"paths/~1subscriptions~1{subscription_id}/delete/responses/404/content/application~1problem+json/examples/address_not_found"},"paths/~1subscriptions~1{subscription_id}/delete/responses/404/content/application~1problem+json/examples/invoice_not_found":{"value":{"type":"https://docs.vilna.io/apis/errors#not-found","title":"Not Found","status":404,"code":"invoice.not_found","detail":"invoice not found","instance":"/traces/0123456789abcdef0123456789abcdef"},"key":"invoice_not_found","summary":"The invoice does not exist in this project","id":"paths/~1subscriptions~1{subscription_id}/delete/responses/404/content/application~1problem+json/examples/invoice_not_found"},"paths/~1subscriptions~1{subscription_id}/delete/responses/409/content/application~1problem+json/examples/address_occupied":{"value":{"type":"https://docs.vilna.io/apis/errors#conflict","title":"Conflict","status":409,"code":"invoice.address_occupied","detail":"address already has an active invoice with different parameters","instance":"/traces/0123456789abcdef0123456789abcdef"},"key":"address_occupied","summary":"The address already has an active invoice","id":"paths/~1subscriptions~1{subscription_id}/delete/responses/409/content/application~1problem+json/examples/address_occupied"},"paths/~1subscriptions~1{subscription_id}/delete/responses/409/content/application~1problem+json/examples/address_in_use":{"value":{"type":"https://docs.vilna.io/apis/errors#conflict","title":"Conflict","status":409,"code":"address.in_use","detail":"address has an active invoice and cannot be deleted","instance":"/traces/0123456789abcdef0123456789abcdef"},"key":"address_in_use","summary":"The address cannot be deleted while in use","id":"paths/~1subscriptions~1{subscription_id}/delete/responses/409/content/application~1problem+json/examples/address_in_use"},"paths/~1subscriptions~1{subscription_id}/delete/responses/409/content/application~1problem+json/examples/subscription_v1_conflict":{"value":{"type":"https://docs.vilna.io/apis/errors#conflict","title":"Conflict","status":409,"code":"notification.subscription_v1_conflict","detail":"a subscription created through v1 accepts name and availability changes only","instance":"/traces/0123456789abcdef0123456789abcdef"},"key":"subscription_v1_conflict","summary":"A v1-created subscription rejects trigger, filter or noise changes","id":"paths/~1subscriptions~1{subscription_id}/delete/responses/409/content/application~1problem+json/examples/subscription_v1_conflict"},"paths/~1subscriptions~1{subscription_id}/delete/responses/409/content/application~1problem+json/examples/notification_send_in_progress":{"value":{"type":"https://docs.vilna.io/apis/errors#conflict","title":"Conflict","status":409,"code":"notification.send_in_progress","detail":"notification send is in progress","instance":"/traces/0123456789abcdef0123456789abcdef"},"key":"notification_send_in_progress","summary":"The notification already has a manual attempt queued or in flight","id":"paths/~1subscriptions~1{subscription_id}/delete/responses/409/content/application~1problem+json/examples/notification_send_in_progress"},"paths/~1subscriptions~1{subscription_id}/delete/responses/409/content/application~1problem+json/examples/notification_payload_unavailable":{"value":{"type":"https://docs.vilna.io/apis/errors#conflict","title":"Conflict","status":409,"code":"notification.payload_unavailable","detail":"notification payload is no longer available","instance":"/traces/0123456789abcdef0123456789abcdef"},"key":"notification_payload_unavailable","summary":"Retention has cleared the content, so there is nothing to resend","id":"paths/~1subscriptions~1{subscription_id}/delete/responses/409/content/application~1problem+json/examples/notification_payload_unavailable"},"paths/~1subscriptions~1{subscription_id}/delete/responses/409/content/application~1problem+json/examples/notification_test_resend_not_allowed":{"value":{"type":"https://docs.vilna.io/apis/errors#conflict","title":"Conflict","status":409,"code":"notification.test_resend_not_allowed","detail":"test notifications cannot be resent","instance":"/traces/0123456789abcdef0123456789abcdef"},"key":"notification_test_resend_not_allowed","summary":"The notification is a channel test","id":"paths/~1subscriptions~1{subscription_id}/delete/responses/409/content/application~1problem+json/examples/notification_test_resend_not_allowed"},"paths/~1subscriptions~1{subscription_id}/delete/responses/503/content/application~1problem+json/examples/temporarily_unavailable":{"value":{"type":"https://docs.vilna.io/apis/errors#service-unavailable","title":"Service Unavailable","status":503,"code":"service.temporarily_unavailable","detail":"The operation is temporarily unavailable. Please try again later."},"key":"temporarily_unavailable","summary":"The operation cannot be completed at present","id":"paths/~1subscriptions~1{subscription_id}/delete/responses/503/content/application~1problem+json/examples/temporarily_unavailable"},"paths/~1subscriptions~1{subscription_id}/patch/requestBody/content/application~1json/examples/update_delay":{"value":{"trigger":{"kind":"block","after_blocks":5}},"key":"update_delay","summary":"Change the confirmation delay","id":"paths/~1subscriptions~1{subscription_id}/patch/requestBody/content/application~1json/examples/update_delay"},"paths/~1subscriptions~1{subscription_id}/patch/requestBody/content/application~1json/examples/clear_filters":{"value":{"filters":{}},"key":"clear_filters","summary":"Remove network and tag restrictions","id":"paths/~1subscriptions~1{subscription_id}/patch/requestBody/content/application~1json/examples/clear_filters"},"paths/~1subscriptions~1{subscription_id}/patch/requestBody/content/application~1json/examples/disable_subscription":{"value":{"enabled":false},"key":"disable_subscription","summary":"Disable subscription","id":"paths/~1subscriptions~1{subscription_id}/patch/requestBody/content/application~1json/examples/disable_subscription"},"paths/~1subscriptions~1{subscription_id}/patch/responses/400/content/application~1problem+json/examples/malformed_json":{"value":{"type":"https://docs.vilna.io/apis/errors#invalid-request","title":"Invalid Request","status":400,"code":"request.malformed","detail":"The request could not be decoded.","instance":"/traces/0123456789abcdef0123456789abcdef"},"key":"malformed_json","summary":"The request body contains malformed JSON","id":"paths/~1subscriptions~1{subscription_id}/patch/responses/400/content/application~1problem+json/examples/malformed_json"},"paths/~1subscriptions~1{subscription_id}/patch/responses/401/content/application~1problem+json/examples/service_authentication_denied":{"value":{"type":"https://docs.vilna.io/apis/errors#unauthorized","title":"Unauthorized","status":401,"code":"unspecified","detail":"You are not authorized to access this resource. If the problem persists, please contact our support team.","instance":"/unauthorized?method=createInvoice"},"key":"service_authentication_denied","summary":"The API service refused authentication","id":"paths/~1subscriptions~1{subscription_id}/patch/responses/401/content/application~1problem+json/examples/service_authentication_denied"},"paths/~1subscriptions~1{subscription_id}/patch/responses/403/content/application~1problem+json/examples/insufficient_permissions":{"value":{"type":"https://docs.vilna.io/apis/errors#forbidden","title":"Forbidden","status":403,"code":"unspecified","detail":"Your credentials are valid but don't include the permission this operation needs. Check the API key permissions in the dashboard. Permissions are set when the key is created and can't be edited later. To change them, create a new key.","instance":"/forbidden?method=createInvoice"},"key":"insufficient_permissions","summary":"The API key lacks the required permission","id":"paths/~1subscriptions~1{subscription_id}/patch/responses/403/content/application~1problem+json/examples/insufficient_permissions"},"paths/~1subscriptions~1{subscription_id}/patch/responses/404/content/application~1problem+json/examples/address_not_found":{"value":{"type":"https://docs.vilna.io/apis/errors#not-found","title":"Not Found","status":404,"code":"address.not_found","detail":"address not found","instance":"/traces/0123456789abcdef0123456789abcdef"},"key":"address_not_found","summary":"The address does not exist in this project","id":"paths/~1subscriptions~1{subscription_id}/patch/responses/404/content/application~1problem+json/examples/address_not_found"},"paths/~1subscriptions~1{subscription_id}/patch/responses/404/content/application~1problem+json/examples/invoice_not_found":{"value":{"type":"https://docs.vilna.io/apis/errors#not-found","title":"Not Found","status":404,"code":"invoice.not_found","detail":"invoice not found","instance":"/traces/0123456789abcdef0123456789abcdef"},"key":"invoice_not_found","summary":"The invoice does not exist in this project","id":"paths/~1subscriptions~1{subscription_id}/patch/responses/404/content/application~1problem+json/examples/invoice_not_found"},"paths/~1subscriptions~1{subscription_id}/patch/responses/409/content/application~1problem+json/examples/address_occupied":{"value":{"type":"https://docs.vilna.io/apis/errors#conflict","title":"Conflict","status":409,"code":"invoice.address_occupied","detail":"address already has an active invoice with different parameters","instance":"/traces/0123456789abcdef0123456789abcdef"},"key":"address_occupied","summary":"The address already has an active invoice","id":"paths/~1subscriptions~1{subscription_id}/patch/responses/409/content/application~1problem+json/examples/address_occupied"},"paths/~1subscriptions~1{subscription_id}/patch/responses/409/content/application~1problem+json/examples/address_in_use":{"value":{"type":"https://docs.vilna.io/apis/errors#conflict","title":"Conflict","status":409,"code":"address.in_use","detail":"address has an active invoice and cannot be deleted","instance":"/traces/0123456789abcdef0123456789abcdef"},"key":"address_in_use","summary":"The address cannot be deleted while in use","id":"paths/~1subscriptions~1{subscription_id}/patch/responses/409/content/application~1problem+json/examples/address_in_use"},"paths/~1subscriptions~1{subscription_id}/patch/responses/409/content/application~1problem+json/examples/subscription_v1_conflict":{"value":{"type":"https://docs.vilna.io/apis/errors#conflict","title":"Conflict","status":409,"code":"notification.subscription_v1_conflict","detail":"a subscription created through v1 accepts name and availability changes only","instance":"/traces/0123456789abcdef0123456789abcdef"},"key":"subscription_v1_conflict","summary":"A v1-created subscription rejects trigger, filter or noise changes","id":"paths/~1subscriptions~1{subscription_id}/patch/responses/409/content/application~1problem+json/examples/subscription_v1_conflict"},"paths/~1subscriptions~1{subscription_id}/patch/responses/409/content/application~1problem+json/examples/notification_send_in_progress":{"value":{"type":"https://docs.vilna.io/apis/errors#conflict","title":"Conflict","status":409,"code":"notification.send_in_progress","detail":"notification send is in progress","instance":"/traces/0123456789abcdef0123456789abcdef"},"key":"notification_send_in_progress","summary":"The notification already has a manual attempt queued or in flight","id":"paths/~1subscriptions~1{subscription_id}/patch/responses/409/content/application~1problem+json/examples/notification_send_in_progress"},"paths/~1subscriptions~1{subscription_id}/patch/responses/409/content/application~1problem+json/examples/notification_payload_unavailable":{"value":{"type":"https://docs.vilna.io/apis/errors#conflict","title":"Conflict","status":409,"code":"notification.payload_unavailable","detail":"notification payload is no longer available","instance":"/traces/0123456789abcdef0123456789abcdef"},"key":"notification_payload_unavailable","summary":"Retention has cleared the content, so there is nothing to resend","id":"paths/~1subscriptions~1{subscription_id}/patch/responses/409/content/application~1problem+json/examples/notification_payload_unavailable"},"paths/~1subscriptions~1{subscription_id}/patch/responses/409/content/application~1problem+json/examples/notification_test_resend_not_allowed":{"value":{"type":"https://docs.vilna.io/apis/errors#conflict","title":"Conflict","status":409,"code":"notification.test_resend_not_allowed","detail":"test notifications cannot be resent","instance":"/traces/0123456789abcdef0123456789abcdef"},"key":"notification_test_resend_not_allowed","summary":"The notification is a channel test","id":"paths/~1subscriptions~1{subscription_id}/patch/responses/409/content/application~1problem+json/examples/notification_test_resend_not_allowed"},"paths/~1subscriptions~1{subscription_id}/patch/responses/503/content/application~1problem+json/examples/temporarily_unavailable":{"value":{"type":"https://docs.vilna.io/apis/errors#service-unavailable","title":"Service Unavailable","status":503,"code":"service.temporarily_unavailable","detail":"The operation is temporarily unavailable. Please try again later."},"key":"temporarily_unavailable","summary":"The operation cannot be completed at present","id":"paths/~1subscriptions~1{subscription_id}/patch/responses/503/content/application~1problem+json/examples/temporarily_unavailable"},"paths/~1notifications/get/responses/400/content/application~1problem+json/examples/malformed_json":{"value":{"type":"https://docs.vilna.io/apis/errors#invalid-request","title":"Invalid Request","status":400,"code":"request.malformed","detail":"The request could not be decoded.","instance":"/traces/0123456789abcdef0123456789abcdef"},"key":"malformed_json","summary":"The request body contains malformed JSON","id":"paths/~1notifications/get/responses/400/content/application~1problem+json/examples/malformed_json"},"paths/~1notifications/get/responses/401/content/application~1problem+json/examples/service_authentication_denied":{"value":{"type":"https://docs.vilna.io/apis/errors#unauthorized","title":"Unauthorized","status":401,"code":"unspecified","detail":"You are not authorized to access this resource. If the problem persists, please contact our support team.","instance":"/unauthorized?method=createInvoice"},"key":"service_authentication_denied","summary":"The API service refused authentication","id":"paths/~1notifications/get/responses/401/content/application~1problem+json/examples/service_authentication_denied"},"paths/~1notifications/get/responses/403/content/application~1problem+json/examples/insufficient_permissions":{"value":{"type":"https://docs.vilna.io/apis/errors#forbidden","title":"Forbidden","status":403,"code":"unspecified","detail":"Your credentials are valid but don't include the permission this operation needs. Check the API key permissions in the dashboard. Permissions are set when the key is created and can't be edited later. To change them, create a new key.","instance":"/forbidden?method=createInvoice"},"key":"insufficient_permissions","summary":"The API key lacks the required permission","id":"paths/~1notifications/get/responses/403/content/application~1problem+json/examples/insufficient_permissions"},"paths/~1notifications/get/responses/503/content/application~1problem+json/examples/temporarily_unavailable":{"value":{"type":"https://docs.vilna.io/apis/errors#service-unavailable","title":"Service Unavailable","status":503,"code":"service.temporarily_unavailable","detail":"The operation is temporarily unavailable. Please try again later."},"key":"temporarily_unavailable","summary":"The operation cannot be completed at present","id":"paths/~1notifications/get/responses/503/content/application~1problem+json/examples/temporarily_unavailable"},"paths/~1notifications~1{notification_id}/get/responses/400/content/application~1problem+json/examples/malformed_json":{"value":{"type":"https://docs.vilna.io/apis/errors#invalid-request","title":"Invalid Request","status":400,"code":"request.malformed","detail":"The request could not be decoded.","instance":"/traces/0123456789abcdef0123456789abcdef"},"key":"malformed_json","summary":"The request body contains malformed JSON","id":"paths/~1notifications~1{notification_id}/get/responses/400/content/application~1problem+json/examples/malformed_json"},"paths/~1notifications~1{notification_id}/get/responses/401/content/application~1problem+json/examples/service_authentication_denied":{"value":{"type":"https://docs.vilna.io/apis/errors#unauthorized","title":"Unauthorized","status":401,"code":"unspecified","detail":"You are not authorized to access this resource. If the problem persists, please contact our support team.","instance":"/unauthorized?method=createInvoice"},"key":"service_authentication_denied","summary":"The API service refused authentication","id":"paths/~1notifications~1{notification_id}/get/responses/401/content/application~1problem+json/examples/service_authentication_denied"},"paths/~1notifications~1{notification_id}/get/responses/403/content/application~1problem+json/examples/insufficient_permissions":{"value":{"type":"https://docs.vilna.io/apis/errors#forbidden","title":"Forbidden","status":403,"code":"unspecified","detail":"Your credentials are valid but don't include the permission this operation needs. Check the API key permissions in the dashboard. Permissions are set when the key is created and can't be edited later. To change them, create a new key.","instance":"/forbidden?method=createInvoice"},"key":"insufficient_permissions","summary":"The API key lacks the required permission","id":"paths/~1notifications~1{notification_id}/get/responses/403/content/application~1problem+json/examples/insufficient_permissions"},"paths/~1notifications~1{notification_id}/get/responses/404/content/application~1problem+json/examples/address_not_found":{"value":{"type":"https://docs.vilna.io/apis/errors#not-found","title":"Not Found","status":404,"code":"address.not_found","detail":"address not found","instance":"/traces/0123456789abcdef0123456789abcdef"},"key":"address_not_found","summary":"The address does not exist in this project","id":"paths/~1notifications~1{notification_id}/get/responses/404/content/application~1problem+json/examples/address_not_found"},"paths/~1notifications~1{notification_id}/get/responses/404/content/application~1problem+json/examples/invoice_not_found":{"value":{"type":"https://docs.vilna.io/apis/errors#not-found","title":"Not Found","status":404,"code":"invoice.not_found","detail":"invoice not found","instance":"/traces/0123456789abcdef0123456789abcdef"},"key":"invoice_not_found","summary":"The invoice does not exist in this project","id":"paths/~1notifications~1{notification_id}/get/responses/404/content/application~1problem+json/examples/invoice_not_found"},"paths/~1notifications~1{notification_id}/get/responses/503/content/application~1problem+json/examples/temporarily_unavailable":{"value":{"type":"https://docs.vilna.io/apis/errors#service-unavailable","title":"Service Unavailable","status":503,"code":"service.temporarily_unavailable","detail":"The operation is temporarily unavailable. Please try again later."},"key":"temporarily_unavailable","summary":"The operation cannot be completed at present","id":"paths/~1notifications~1{notification_id}/get/responses/503/content/application~1problem+json/examples/temporarily_unavailable"},"paths/~1notifications~1{notification_id}~1logs/get/responses/400/content/application~1problem+json/examples/malformed_json":{"value":{"type":"https://docs.vilna.io/apis/errors#invalid-request","title":"Invalid Request","status":400,"code":"request.malformed","detail":"The request could not be decoded.","instance":"/traces/0123456789abcdef0123456789abcdef"},"key":"malformed_json","summary":"The request body contains malformed JSON","id":"paths/~1notifications~1{notification_id}~1logs/get/responses/400/content/application~1problem+json/examples/malformed_json"},"paths/~1notifications~1{notification_id}~1logs/get/responses/401/content/application~1problem+json/examples/service_authentication_denied":{"value":{"type":"https://docs.vilna.io/apis/errors#unauthorized","title":"Unauthorized","status":401,"code":"unspecified","detail":"You are not authorized to access this resource. If the problem persists, please contact our support team.","instance":"/unauthorized?method=createInvoice"},"key":"service_authentication_denied","summary":"The API service refused authentication","id":"paths/~1notifications~1{notification_id}~1logs/get/responses/401/content/application~1problem+json/examples/service_authentication_denied"},"paths/~1notifications~1{notification_id}~1logs/get/responses/403/content/application~1problem+json/examples/insufficient_permissions":{"value":{"type":"https://docs.vilna.io/apis/errors#forbidden","title":"Forbidden","status":403,"code":"unspecified","detail":"Your credentials are valid but don't include the permission this operation needs. Check the API key permissions in the dashboard. Permissions are set when the key is created and can't be edited later. To change them, create a new key.","instance":"/forbidden?method=createInvoice"},"key":"insufficient_permissions","summary":"The API key lacks the required permission","id":"paths/~1notifications~1{notification_id}~1logs/get/responses/403/content/application~1problem+json/examples/insufficient_permissions"},"paths/~1notifications~1{notification_id}~1logs/get/responses/404/content/application~1problem+json/examples/address_not_found":{"value":{"type":"https://docs.vilna.io/apis/errors#not-found","title":"Not Found","status":404,"code":"address.not_found","detail":"address not found","instance":"/traces/0123456789abcdef0123456789abcdef"},"key":"address_not_found","summary":"The address does not exist in this project","id":"paths/~1notifications~1{notification_id}~1logs/get/responses/404/content/application~1problem+json/examples/address_not_found"},"paths/~1notifications~1{notification_id}~1logs/get/responses/404/content/application~1problem+json/examples/invoice_not_found":{"value":{"type":"https://docs.vilna.io/apis/errors#not-found","title":"Not Found","status":404,"code":"invoice.not_found","detail":"invoice not found","instance":"/traces/0123456789abcdef0123456789abcdef"},"key":"invoice_not_found","summary":"The invoice does not exist in this project","id":"paths/~1notifications~1{notification_id}~1logs/get/responses/404/content/application~1problem+json/examples/invoice_not_found"},"paths/~1notifications~1{notification_id}~1logs/get/responses/503/content/application~1problem+json/examples/temporarily_unavailable":{"value":{"type":"https://docs.vilna.io/apis/errors#service-unavailable","title":"Service Unavailable","status":503,"code":"service.temporarily_unavailable","detail":"The operation is temporarily unavailable. Please try again later."},"key":"temporarily_unavailable","summary":"The operation cannot be completed at present","id":"paths/~1notifications~1{notification_id}~1logs/get/responses/503/content/application~1problem+json/examples/temporarily_unavailable"},"paths/~1notifications~1{notification_id}~1actions~1resend/post/responses/400/content/application~1problem+json/examples/malformed_json":{"value":{"type":"https://docs.vilna.io/apis/errors#invalid-request","title":"Invalid Request","status":400,"code":"request.malformed","detail":"The request could not be decoded.","instance":"/traces/0123456789abcdef0123456789abcdef"},"key":"malformed_json","summary":"The request body contains malformed JSON","id":"paths/~1notifications~1{notification_id}~1actions~1resend/post/responses/400/content/application~1problem+json/examples/malformed_json"},"paths/~1notifications~1{notification_id}~1actions~1resend/post/responses/401/content/application~1problem+json/examples/service_authentication_denied":{"value":{"type":"https://docs.vilna.io/apis/errors#unauthorized","title":"Unauthorized","status":401,"code":"unspecified","detail":"You are not authorized to access this resource. If the problem persists, please contact our support team.","instance":"/unauthorized?method=createInvoice"},"key":"service_authentication_denied","summary":"The API service refused authentication","id":"paths/~1notifications~1{notification_id}~1actions~1resend/post/responses/401/content/application~1problem+json/examples/service_authentication_denied"},"paths/~1notifications~1{notification_id}~1actions~1resend/post/responses/403/content/application~1problem+json/examples/insufficient_permissions":{"value":{"type":"https://docs.vilna.io/apis/errors#forbidden","title":"Forbidden","status":403,"code":"unspecified","detail":"Your credentials are valid but don't include the permission this operation needs. Check the API key permissions in the dashboard. Permissions are set when the key is created and can't be edited later. To change them, create a new key.","instance":"/forbidden?method=createInvoice"},"key":"insufficient_permissions","summary":"The API key lacks the required permission","id":"paths/~1notifications~1{notification_id}~1actions~1resend/post/responses/403/content/application~1problem+json/examples/insufficient_permissions"},"paths/~1notifications~1{notification_id}~1actions~1resend/post/responses/404/content/application~1problem+json/examples/address_not_found":{"value":{"type":"https://docs.vilna.io/apis/errors#not-found","title":"Not Found","status":404,"code":"address.not_found","detail":"address not found","instance":"/traces/0123456789abcdef0123456789abcdef"},"key":"address_not_found","summary":"The address does not exist in this project","id":"paths/~1notifications~1{notification_id}~1actions~1resend/post/responses/404/content/application~1problem+json/examples/address_not_found"},"paths/~1notifications~1{notification_id}~1actions~1resend/post/responses/404/content/application~1problem+json/examples/invoice_not_found":{"value":{"type":"https://docs.vilna.io/apis/errors#not-found","title":"Not Found","status":404,"code":"invoice.not_found","detail":"invoice not found","instance":"/traces/0123456789abcdef0123456789abcdef"},"key":"invoice_not_found","summary":"The invoice does not exist in this project","id":"paths/~1notifications~1{notification_id}~1actions~1resend/post/responses/404/content/application~1problem+json/examples/invoice_not_found"},"paths/~1notifications~1{notification_id}~1actions~1resend/post/responses/409/content/application~1problem+json/examples/address_occupied":{"value":{"type":"https://docs.vilna.io/apis/errors#conflict","title":"Conflict","status":409,"code":"invoice.address_occupied","detail":"address already has an active invoice with different parameters","instance":"/traces/0123456789abcdef0123456789abcdef"},"key":"address_occupied","summary":"The address already has an active invoice","id":"paths/~1notifications~1{notification_id}~1actions~1resend/post/responses/409/content/application~1problem+json/examples/address_occupied"},"paths/~1notifications~1{notification_id}~1actions~1resend/post/responses/409/content/application~1problem+json/examples/address_in_use":{"value":{"type":"https://docs.vilna.io/apis/errors#conflict","title":"Conflict","status":409,"code":"address.in_use","detail":"address has an active invoice and cannot be deleted","instance":"/traces/0123456789abcdef0123456789abcdef"},"key":"address_in_use","summary":"The address cannot be deleted while in use","id":"paths/~1notifications~1{notification_id}~1actions~1resend/post/responses/409/content/application~1problem+json/examples/address_in_use"},"paths/~1notifications~1{notification_id}~1actions~1resend/post/responses/409/content/application~1problem+json/examples/subscription_v1_conflict":{"value":{"type":"https://docs.vilna.io/apis/errors#conflict","title":"Conflict","status":409,"code":"notification.subscription_v1_conflict","detail":"a subscription created through v1 accepts name and availability changes only","instance":"/traces/0123456789abcdef0123456789abcdef"},"key":"subscription_v1_conflict","summary":"A v1-created subscription rejects trigger, filter or noise changes","id":"paths/~1notifications~1{notification_id}~1actions~1resend/post/responses/409/content/application~1problem+json/examples/subscription_v1_conflict"},"paths/~1notifications~1{notification_id}~1actions~1resend/post/responses/409/content/application~1problem+json/examples/notification_send_in_progress":{"value":{"type":"https://docs.vilna.io/apis/errors#conflict","title":"Conflict","status":409,"code":"notification.send_in_progress","detail":"notification send is in progress","instance":"/traces/0123456789abcdef0123456789abcdef"},"key":"notification_send_in_progress","summary":"The notification already has a manual attempt queued or in flight","id":"paths/~1notifications~1{notification_id}~1actions~1resend/post/responses/409/content/application~1problem+json/examples/notification_send_in_progress"},"paths/~1notifications~1{notification_id}~1actions~1resend/post/responses/409/content/application~1problem+json/examples/notification_payload_unavailable":{"value":{"type":"https://docs.vilna.io/apis/errors#conflict","title":"Conflict","status":409,"code":"notification.payload_unavailable","detail":"notification payload is no longer available","instance":"/traces/0123456789abcdef0123456789abcdef"},"key":"notification_payload_unavailable","summary":"Retention has cleared the content, so there is nothing to resend","id":"paths/~1notifications~1{notification_id}~1actions~1resend/post/responses/409/content/application~1problem+json/examples/notification_payload_unavailable"},"paths/~1notifications~1{notification_id}~1actions~1resend/post/responses/409/content/application~1problem+json/examples/notification_test_resend_not_allowed":{"value":{"type":"https://docs.vilna.io/apis/errors#conflict","title":"Conflict","status":409,"code":"notification.test_resend_not_allowed","detail":"test notifications cannot be resent","instance":"/traces/0123456789abcdef0123456789abcdef"},"key":"notification_test_resend_not_allowed","summary":"The notification is a channel test","id":"paths/~1notifications~1{notification_id}~1actions~1resend/post/responses/409/content/application~1problem+json/examples/notification_test_resend_not_allowed"},"paths/~1notifications~1{notification_id}~1actions~1resend/post/responses/429/content/application~1problem+json/examples/resend_delayed":{"value":{"type":"https://docs.vilna.io/apis/errors#too-many-requests","title":"Too Many Requests","status":429,"code":"notification.resend_delayed","detail":"notification resend is delayed","instance":"/traces/0123456789abcdef0123456789abcdef"},"key":"resend_delayed","summary":"A manual resend is still inside its cooldown","id":"paths/~1notifications~1{notification_id}~1actions~1resend/post/responses/429/content/application~1problem+json/examples/resend_delayed"},"paths/~1notifications~1{notification_id}~1actions~1resend/post/responses/503/content/application~1problem+json/examples/temporarily_unavailable":{"value":{"type":"https://docs.vilna.io/apis/errors#service-unavailable","title":"Service Unavailable","status":503,"code":"service.temporarily_unavailable","detail":"The operation is temporarily unavailable. Please try again later."},"key":"temporarily_unavailable","summary":"The operation cannot be completed at present","id":"paths/~1notifications~1{notification_id}~1actions~1resend/post/responses/503/content/application~1problem+json/examples/temporarily_unavailable"},"paths/~1blockchains/get/responses/400/content/application~1problem+json/examples/malformed_json":{"value":{"type":"https://docs.vilna.io/apis/errors#invalid-request","title":"Invalid Request","status":400,"code":"request.malformed","detail":"The request could not be decoded.","instance":"/traces/0123456789abcdef0123456789abcdef"},"key":"malformed_json","summary":"The request body contains malformed JSON","id":"paths/~1blockchains/get/responses/400/content/application~1problem+json/examples/malformed_json"},"paths/~1blockchains/get/responses/401/content/application~1problem+json/examples/service_authentication_denied":{"value":{"type":"https://docs.vilna.io/apis/errors#unauthorized","title":"Unauthorized","status":401,"code":"unspecified","detail":"You are not authorized to access this resource. If the problem persists, please contact our support team.","instance":"/unauthorized?method=createInvoice"},"key":"service_authentication_denied","summary":"The API service refused authentication","id":"paths/~1blockchains/get/responses/401/content/application~1problem+json/examples/service_authentication_denied"},"paths/~1blockchains/get/responses/403/content/application~1problem+json/examples/insufficient_permissions":{"value":{"type":"https://docs.vilna.io/apis/errors#forbidden","title":"Forbidden","status":403,"code":"unspecified","detail":"Your credentials are valid but don't include the permission this operation needs. Check the API key permissions in the dashboard. Permissions are set when the key is created and can't be edited later. To change them, create a new key.","instance":"/forbidden?method=createInvoice"},"key":"insufficient_permissions","summary":"The API key lacks the required permission","id":"paths/~1blockchains/get/responses/403/content/application~1problem+json/examples/insufficient_permissions"},"paths/~1blockchains/get/responses/503/content/application~1problem+json/examples/temporarily_unavailable":{"value":{"type":"https://docs.vilna.io/apis/errors#service-unavailable","title":"Service Unavailable","status":503,"code":"service.temporarily_unavailable","detail":"The operation is temporarily unavailable. Please try again later."},"key":"temporarily_unavailable","summary":"The operation cannot be completed at present","id":"paths/~1blockchains/get/responses/503/content/application~1problem+json/examples/temporarily_unavailable"},"paths/~1blockchains~1{chain_gid}/get/responses/400/content/application~1problem+json/examples/malformed_json":{"value":{"type":"https://docs.vilna.io/apis/errors#invalid-request","title":"Invalid Request","status":400,"code":"request.malformed","detail":"The request could not be decoded.","instance":"/traces/0123456789abcdef0123456789abcdef"},"key":"malformed_json","summary":"The request body contains malformed JSON","id":"paths/~1blockchains~1{chain_gid}/get/responses/400/content/application~1problem+json/examples/malformed_json"},"paths/~1blockchains~1{chain_gid}/get/responses/401/content/application~1problem+json/examples/service_authentication_denied":{"value":{"type":"https://docs.vilna.io/apis/errors#unauthorized","title":"Unauthorized","status":401,"code":"unspecified","detail":"You are not authorized to access this resource. If the problem persists, please contact our support team.","instance":"/unauthorized?method=createInvoice"},"key":"service_authentication_denied","summary":"The API service refused authentication","id":"paths/~1blockchains~1{chain_gid}/get/responses/401/content/application~1problem+json/examples/service_authentication_denied"},"paths/~1blockchains~1{chain_gid}/get/responses/403/content/application~1problem+json/examples/insufficient_permissions":{"value":{"type":"https://docs.vilna.io/apis/errors#forbidden","title":"Forbidden","status":403,"code":"unspecified","detail":"Your credentials are valid but don't include the permission this operation needs. Check the API key permissions in the dashboard. Permissions are set when the key is created and can't be edited later. To change them, create a new key.","instance":"/forbidden?method=createInvoice"},"key":"insufficient_permissions","summary":"The API key lacks the required permission","id":"paths/~1blockchains~1{chain_gid}/get/responses/403/content/application~1problem+json/examples/insufficient_permissions"},"paths/~1blockchains~1{chain_gid}/get/responses/404/content/application~1problem+json/examples/address_not_found":{"value":{"type":"https://docs.vilna.io/apis/errors#not-found","title":"Not Found","status":404,"code":"address.not_found","detail":"address not found","instance":"/traces/0123456789abcdef0123456789abcdef"},"key":"address_not_found","summary":"The address does not exist in this project","id":"paths/~1blockchains~1{chain_gid}/get/responses/404/content/application~1problem+json/examples/address_not_found"},"paths/~1blockchains~1{chain_gid}/get/responses/404/content/application~1problem+json/examples/invoice_not_found":{"value":{"type":"https://docs.vilna.io/apis/errors#not-found","title":"Not Found","status":404,"code":"invoice.not_found","detail":"invoice not found","instance":"/traces/0123456789abcdef0123456789abcdef"},"key":"invoice_not_found","summary":"The invoice does not exist in this project","id":"paths/~1blockchains~1{chain_gid}/get/responses/404/content/application~1problem+json/examples/invoice_not_found"},"paths/~1blockchains~1{chain_gid}/get/responses/503/content/application~1problem+json/examples/temporarily_unavailable":{"value":{"type":"https://docs.vilna.io/apis/errors#service-unavailable","title":"Service Unavailable","status":503,"code":"service.temporarily_unavailable","detail":"The operation is temporarily unavailable. Please try again later."},"key":"temporarily_unavailable","summary":"The operation cannot be completed at present","id":"paths/~1blockchains~1{chain_gid}/get/responses/503/content/application~1problem+json/examples/temporarily_unavailable"},"paths/~1tokens/get/responses/200/content/application~1json/example":{"value":{"items":[{"gid":"eip155:1/erc20:0x0000000000000000000000000000000000000100","status":"supported","is_trusted":true,"is_verified":false,"name":"Example token","symbol":"EXAMPLE","decimals":0},{"gid":"eip155:1/erc20:0x0000000000000000000000000000000000000200","status":"pending","is_trusted":false,"is_verified":false}],"meta":{"limit":20,"page":1,"total":2,"total_pages":1}},"id":"paths/~1tokens/get/responses/200/content/application~1json/example"},"paths/~1tokens/get/responses/400/content/application~1problem+json/examples/malformed_json":{"value":{"type":"https://docs.vilna.io/apis/errors#invalid-request","title":"Invalid Request","status":400,"code":"request.malformed","detail":"The request could not be decoded.","instance":"/traces/0123456789abcdef0123456789abcdef"},"key":"malformed_json","summary":"The request body contains malformed JSON","id":"paths/~1tokens/get/responses/400/content/application~1problem+json/examples/malformed_json"},"paths/~1tokens/get/responses/401/content/application~1problem+json/examples/service_authentication_denied":{"value":{"type":"https://docs.vilna.io/apis/errors#unauthorized","title":"Unauthorized","status":401,"code":"unspecified","detail":"You are not authorized to access this resource. If the problem persists, please contact our support team.","instance":"/unauthorized?method=createInvoice"},"key":"service_authentication_denied","summary":"The API service refused authentication","id":"paths/~1tokens/get/responses/401/content/application~1problem+json/examples/service_authentication_denied"},"paths/~1tokens/get/responses/403/content/application~1problem+json/examples/insufficient_permissions":{"value":{"type":"https://docs.vilna.io/apis/errors#forbidden","title":"Forbidden","status":403,"code":"unspecified","detail":"Your credentials are valid but don't include the permission this operation needs. Check the API key permissions in the dashboard. Permissions are set when the key is created and can't be edited later. To change them, create a new key.","instance":"/forbidden?method=createInvoice"},"key":"insufficient_permissions","summary":"The API key lacks the required permission","id":"paths/~1tokens/get/responses/403/content/application~1problem+json/examples/insufficient_permissions"},"paths/~1tokens/get/responses/503/content/application~1problem+json/examples/temporarily_unavailable":{"value":{"type":"https://docs.vilna.io/apis/errors#service-unavailable","title":"Service Unavailable","status":503,"code":"service.temporarily_unavailable","detail":"The operation is temporarily unavailable. Please try again later."},"key":"temporarily_unavailable","summary":"The operation cannot be completed at present","id":"paths/~1tokens/get/responses/503/content/application~1problem+json/examples/temporarily_unavailable"},"paths/~1tokens~1{chain_gid}~1{asset_path}/post/responses/200/content/application~1json/example":{"value":{"item":{"gid":"eip155:1/erc20:0x0000000000000000000000000000000000000100","status":"supported","is_trusted":true,"is_verified":false,"name":"Example token","symbol":"EXAMPLE","decimals":0}},"id":"paths/~1tokens~1{chain_gid}~1{asset_path}/post/responses/200/content/application~1json/example"},"paths/~1tokens~1{chain_gid}~1{asset_path}/post/responses/201/content/application~1json/example":{"value":{"item":{"gid":"eip155:1/erc20:0x0000000000000000000000000000000000000100","status":"supported","is_trusted":true,"is_verified":false,"name":"Example token","symbol":"EXAMPLE","decimals":0}},"id":"paths/~1tokens~1{chain_gid}~1{asset_path}/post/responses/201/content/application~1json/example"},"paths/~1tokens~1{chain_gid}~1{asset_path}/post/responses/400/content/application~1problem+json/examples/malformed_json":{"value":{"type":"https://docs.vilna.io/apis/errors#invalid-request","title":"Invalid Request","status":400,"code":"request.malformed","detail":"The request could not be decoded.","instance":"/traces/0123456789abcdef0123456789abcdef"},"key":"malformed_json","summary":"The request body contains malformed JSON","id":"paths/~1tokens~1{chain_gid}~1{asset_path}/post/responses/400/content/application~1problem+json/examples/malformed_json"},"paths/~1tokens~1{chain_gid}~1{asset_path}/post/responses/401/content/application~1problem+json/examples/service_authentication_denied":{"value":{"type":"https://docs.vilna.io/apis/errors#unauthorized","title":"Unauthorized","status":401,"code":"unspecified","detail":"You are not authorized to access this resource. If the problem persists, please contact our support team.","instance":"/unauthorized?method=createInvoice"},"key":"service_authentication_denied","summary":"The API service refused authentication","id":"paths/~1tokens~1{chain_gid}~1{asset_path}/post/responses/401/content/application~1problem+json/examples/service_authentication_denied"},"paths/~1tokens~1{chain_gid}~1{asset_path}/post/responses/403/content/application~1problem+json/examples/insufficient_permissions":{"value":{"type":"https://docs.vilna.io/apis/errors#forbidden","title":"Forbidden","status":403,"code":"unspecified","detail":"Your credentials are valid but don't include the permission this operation needs. Check the API key permissions in the dashboard. Permissions are set when the key is created and can't be edited later. To change them, create a new key.","instance":"/forbidden?method=createInvoice"},"key":"insufficient_permissions","summary":"The API key lacks the required permission","id":"paths/~1tokens~1{chain_gid}~1{asset_path}/post/responses/403/content/application~1problem+json/examples/insufficient_permissions"},"paths/~1tokens~1{chain_gid}~1{asset_path}/post/responses/404/content/application~1problem+json/examples/address_not_found":{"value":{"type":"https://docs.vilna.io/apis/errors#not-found","title":"Not Found","status":404,"code":"address.not_found","detail":"address not found","instance":"/traces/0123456789abcdef0123456789abcdef"},"key":"address_not_found","summary":"The address does not exist in this project","id":"paths/~1tokens~1{chain_gid}~1{asset_path}/post/responses/404/content/application~1problem+json/examples/address_not_found"},"paths/~1tokens~1{chain_gid}~1{asset_path}/post/responses/404/content/application~1problem+json/examples/invoice_not_found":{"value":{"type":"https://docs.vilna.io/apis/errors#not-found","title":"Not Found","status":404,"code":"invoice.not_found","detail":"invoice not found","instance":"/traces/0123456789abcdef0123456789abcdef"},"key":"invoice_not_found","summary":"The invoice does not exist in this project","id":"paths/~1tokens~1{chain_gid}~1{asset_path}/post/responses/404/content/application~1problem+json/examples/invoice_not_found"},"paths/~1tokens~1{chain_gid}~1{asset_path}/post/responses/409/content/application~1problem+json/examples/address_occupied":{"value":{"type":"https://docs.vilna.io/apis/errors#conflict","title":"Conflict","status":409,"code":"invoice.address_occupied","detail":"address already has an active invoice with different parameters","instance":"/traces/0123456789abcdef0123456789abcdef"},"key":"address_occupied","summary":"The address already has an active invoice","id":"paths/~1tokens~1{chain_gid}~1{asset_path}/post/responses/409/content/application~1problem+json/examples/address_occupied"},"paths/~1tokens~1{chain_gid}~1{asset_path}/post/responses/409/content/application~1problem+json/examples/address_in_use":{"value":{"type":"https://docs.vilna.io/apis/errors#conflict","title":"Conflict","status":409,"code":"address.in_use","detail":"address has an active invoice and cannot be deleted","instance":"/traces/0123456789abcdef0123456789abcdef"},"key":"address_in_use","summary":"The address cannot be deleted while in use","id":"paths/~1tokens~1{chain_gid}~1{asset_path}/post/responses/409/content/application~1problem+json/examples/address_in_use"},"paths/~1tokens~1{chain_gid}~1{asset_path}/post/responses/409/content/application~1problem+json/examples/subscription_v1_conflict":{"value":{"type":"https://docs.vilna.io/apis/errors#conflict","title":"Conflict","status":409,"code":"notification.subscription_v1_conflict","detail":"a subscription created through v1 accepts name and availability changes only","instance":"/traces/0123456789abcdef0123456789abcdef"},"key":"subscription_v1_conflict","summary":"A v1-created subscription rejects trigger, filter or noise changes","id":"paths/~1tokens~1{chain_gid}~1{asset_path}/post/responses/409/content/application~1problem+json/examples/subscription_v1_conflict"},"paths/~1tokens~1{chain_gid}~1{asset_path}/post/responses/409/content/application~1problem+json/examples/notification_send_in_progress":{"value":{"type":"https://docs.vilna.io/apis/errors#conflict","title":"Conflict","status":409,"code":"notification.send_in_progress","detail":"notification send is in progress","instance":"/traces/0123456789abcdef0123456789abcdef"},"key":"notification_send_in_progress","summary":"The notification already has a manual attempt queued or in flight","id":"paths/~1tokens~1{chain_gid}~1{asset_path}/post/responses/409/content/application~1problem+json/examples/notification_send_in_progress"},"paths/~1tokens~1{chain_gid}~1{asset_path}/post/responses/409/content/application~1problem+json/examples/notification_payload_unavailable":{"value":{"type":"https://docs.vilna.io/apis/errors#conflict","title":"Conflict","status":409,"code":"notification.payload_unavailable","detail":"notification payload is no longer available","instance":"/traces/0123456789abcdef0123456789abcdef"},"key":"notification_payload_unavailable","summary":"Retention has cleared the content, so there is nothing to resend","id":"paths/~1tokens~1{chain_gid}~1{asset_path}/post/responses/409/content/application~1problem+json/examples/notification_payload_unavailable"},"paths/~1tokens~1{chain_gid}~1{asset_path}/post/responses/409/content/application~1problem+json/examples/notification_test_resend_not_allowed":{"value":{"type":"https://docs.vilna.io/apis/errors#conflict","title":"Conflict","status":409,"code":"notification.test_resend_not_allowed","detail":"test notifications cannot be resent","instance":"/traces/0123456789abcdef0123456789abcdef"},"key":"notification_test_resend_not_allowed","summary":"The notification is a channel test","id":"paths/~1tokens~1{chain_gid}~1{asset_path}/post/responses/409/content/application~1problem+json/examples/notification_test_resend_not_allowed"},"paths/~1tokens~1{chain_gid}~1{asset_path}/post/responses/422/content/application~1problem+json/examples/invoice_not_cancellable":{"value":{"type":"https://docs.vilna.io/apis/errors#precondition","title":"Precondition Failed","status":422,"code":"invoice.not_cancellable","detail":"invoice cannot be cancelled in current status","instance":"/traces/0123456789abcdef0123456789abcdef","fields":[{"name":"status","reason":"confirmed"}]},"key":"invoice_not_cancellable","summary":"A confirmed invoice cannot be cancelled","id":"paths/~1tokens~1{chain_gid}~1{asset_path}/post/responses/422/content/application~1problem+json/examples/invoice_not_cancellable"},"paths/~1tokens~1{chain_gid}~1{asset_path}/post/responses/503/content/application~1problem+json/examples/temporarily_unavailable":{"value":{"type":"https://docs.vilna.io/apis/errors#service-unavailable","title":"Service Unavailable","status":503,"code":"service.temporarily_unavailable","detail":"The operation is temporarily unavailable. Please try again later."},"key":"temporarily_unavailable","summary":"The operation cannot be completed at present","id":"paths/~1tokens~1{chain_gid}~1{asset_path}/post/responses/503/content/application~1problem+json/examples/temporarily_unavailable"},"paths/~1tokens~1{chain_gid}~1{asset_path}/get/responses/200/content/application~1json/example":{"value":{"item":{"gid":"eip155:1/erc20:0x0000000000000000000000000000000000000100","status":"supported","is_trusted":true,"is_verified":false,"name":"Example token","symbol":"EXAMPLE","decimals":0}},"id":"paths/~1tokens~1{chain_gid}~1{asset_path}/get/responses/200/content/application~1json/example"},"paths/~1tokens~1{chain_gid}~1{asset_path}/get/responses/400/content/application~1problem+json/examples/malformed_json":{"value":{"type":"https://docs.vilna.io/apis/errors#invalid-request","title":"Invalid Request","status":400,"code":"request.malformed","detail":"The request could not be decoded.","instance":"/traces/0123456789abcdef0123456789abcdef"},"key":"malformed_json","summary":"The request body contains malformed JSON","id":"paths/~1tokens~1{chain_gid}~1{asset_path}/get/responses/400/content/application~1problem+json/examples/malformed_json"},"paths/~1tokens~1{chain_gid}~1{asset_path}/get/responses/401/content/application~1problem+json/examples/service_authentication_denied":{"value":{"type":"https://docs.vilna.io/apis/errors#unauthorized","title":"Unauthorized","status":401,"code":"unspecified","detail":"You are not authorized to access this resource. If the problem persists, please contact our support team.","instance":"/unauthorized?method=createInvoice"},"key":"service_authentication_denied","summary":"The API service refused authentication","id":"paths/~1tokens~1{chain_gid}~1{asset_path}/get/responses/401/content/application~1problem+json/examples/service_authentication_denied"},"paths/~1tokens~1{chain_gid}~1{asset_path}/get/responses/403/content/application~1problem+json/examples/insufficient_permissions":{"value":{"type":"https://docs.vilna.io/apis/errors#forbidden","title":"Forbidden","status":403,"code":"unspecified","detail":"Your credentials are valid but don't include the permission this operation needs. Check the API key permissions in the dashboard. Permissions are set when the key is created and can't be edited later. To change them, create a new key.","instance":"/forbidden?method=createInvoice"},"key":"insufficient_permissions","summary":"The API key lacks the required permission","id":"paths/~1tokens~1{chain_gid}~1{asset_path}/get/responses/403/content/application~1problem+json/examples/insufficient_permissions"},"paths/~1tokens~1{chain_gid}~1{asset_path}/get/responses/404/content/application~1problem+json/examples/address_not_found":{"value":{"type":"https://docs.vilna.io/apis/errors#not-found","title":"Not Found","status":404,"code":"address.not_found","detail":"address not found","instance":"/traces/0123456789abcdef0123456789abcdef"},"key":"address_not_found","summary":"The address does not exist in this project","id":"paths/~1tokens~1{chain_gid}~1{asset_path}/get/responses/404/content/application~1problem+json/examples/address_not_found"},"paths/~1tokens~1{chain_gid}~1{asset_path}/get/responses/404/content/application~1problem+json/examples/invoice_not_found":{"value":{"type":"https://docs.vilna.io/apis/errors#not-found","title":"Not Found","status":404,"code":"invoice.not_found","detail":"invoice not found","instance":"/traces/0123456789abcdef0123456789abcdef"},"key":"invoice_not_found","summary":"The invoice does not exist in this project","id":"paths/~1tokens~1{chain_gid}~1{asset_path}/get/responses/404/content/application~1problem+json/examples/invoice_not_found"},"paths/~1tokens~1{chain_gid}~1{asset_path}/get/responses/503/content/application~1problem+json/examples/temporarily_unavailable":{"value":{"type":"https://docs.vilna.io/apis/errors#service-unavailable","title":"Service Unavailable","status":503,"code":"service.temporarily_unavailable","detail":"The operation is temporarily unavailable. Please try again later."},"key":"temporarily_unavailable","summary":"The operation cannot be completed at present","id":"paths/~1tokens~1{chain_gid}~1{asset_path}/get/responses/503/content/application~1problem+json/examples/temporarily_unavailable"},"paths/~1tokens~1{chain_gid}~1{asset_path}~1actions~1trust/post/responses/200/content/application~1json/example":{"value":{"item":{"gid":"eip155:1/erc20:0x0000000000000000000000000000000000000100","status":"supported","is_trusted":true,"is_verified":false,"name":"Example token","symbol":"EXAMPLE","decimals":0}},"id":"paths/~1tokens~1{chain_gid}~1{asset_path}~1actions~1trust/post/responses/200/content/application~1json/example"},"paths/~1tokens~1{chain_gid}~1{asset_path}~1actions~1trust/post/responses/400/content/application~1problem+json/examples/malformed_json":{"value":{"type":"https://docs.vilna.io/apis/errors#invalid-request","title":"Invalid Request","status":400,"code":"request.malformed","detail":"The request could not be decoded.","instance":"/traces/0123456789abcdef0123456789abcdef"},"key":"malformed_json","summary":"The request body contains malformed JSON","id":"paths/~1tokens~1{chain_gid}~1{asset_path}~1actions~1trust/post/responses/400/content/application~1problem+json/examples/malformed_json"},"paths/~1tokens~1{chain_gid}~1{asset_path}~1actions~1trust/post/responses/401/content/application~1problem+json/examples/service_authentication_denied":{"value":{"type":"https://docs.vilna.io/apis/errors#unauthorized","title":"Unauthorized","status":401,"code":"unspecified","detail":"You are not authorized to access this resource. If the problem persists, please contact our support team.","instance":"/unauthorized?method=createInvoice"},"key":"service_authentication_denied","summary":"The API service refused authentication","id":"paths/~1tokens~1{chain_gid}~1{asset_path}~1actions~1trust/post/responses/401/content/application~1problem+json/examples/service_authentication_denied"},"paths/~1tokens~1{chain_gid}~1{asset_path}~1actions~1trust/post/responses/403/content/application~1problem+json/examples/insufficient_permissions":{"value":{"type":"https://docs.vilna.io/apis/errors#forbidden","title":"Forbidden","status":403,"code":"unspecified","detail":"Your credentials are valid but don't include the permission this operation needs. Check the API key permissions in the dashboard. Permissions are set when the key is created and can't be edited later. To change them, create a new key.","instance":"/forbidden?method=createInvoice"},"key":"insufficient_permissions","summary":"The API key lacks the required permission","id":"paths/~1tokens~1{chain_gid}~1{asset_path}~1actions~1trust/post/responses/403/content/application~1problem+json/examples/insufficient_permissions"},"paths/~1tokens~1{chain_gid}~1{asset_path}~1actions~1trust/post/responses/404/content/application~1problem+json/examples/address_not_found":{"value":{"type":"https://docs.vilna.io/apis/errors#not-found","title":"Not Found","status":404,"code":"address.not_found","detail":"address not found","instance":"/traces/0123456789abcdef0123456789abcdef"},"key":"address_not_found","summary":"The address does not exist in this project","id":"paths/~1tokens~1{chain_gid}~1{asset_path}~1actions~1trust/post/responses/404/content/application~1problem+json/examples/address_not_found"},"paths/~1tokens~1{chain_gid}~1{asset_path}~1actions~1trust/post/responses/404/content/application~1problem+json/examples/invoice_not_found":{"value":{"type":"https://docs.vilna.io/apis/errors#not-found","title":"Not Found","status":404,"code":"invoice.not_found","detail":"invoice not found","instance":"/traces/0123456789abcdef0123456789abcdef"},"key":"invoice_not_found","summary":"The invoice does not exist in this project","id":"paths/~1tokens~1{chain_gid}~1{asset_path}~1actions~1trust/post/responses/404/content/application~1problem+json/examples/invoice_not_found"},"paths/~1tokens~1{chain_gid}~1{asset_path}~1actions~1trust/post/responses/409/content/application~1problem+json/examples/address_occupied":{"value":{"type":"https://docs.vilna.io/apis/errors#conflict","title":"Conflict","status":409,"code":"invoice.address_occupied","detail":"address already has an active invoice with different parameters","instance":"/traces/0123456789abcdef0123456789abcdef"},"key":"address_occupied","summary":"The address already has an active invoice","id":"paths/~1tokens~1{chain_gid}~1{asset_path}~1actions~1trust/post/responses/409/content/application~1problem+json/examples/address_occupied"},"paths/~1tokens~1{chain_gid}~1{asset_path}~1actions~1trust/post/responses/409/content/application~1problem+json/examples/address_in_use":{"value":{"type":"https://docs.vilna.io/apis/errors#conflict","title":"Conflict","status":409,"code":"address.in_use","detail":"address has an active invoice and cannot be deleted","instance":"/traces/0123456789abcdef0123456789abcdef"},"key":"address_in_use","summary":"The address cannot be deleted while in use","id":"paths/~1tokens~1{chain_gid}~1{asset_path}~1actions~1trust/post/responses/409/content/application~1problem+json/examples/address_in_use"},"paths/~1tokens~1{chain_gid}~1{asset_path}~1actions~1trust/post/responses/409/content/application~1problem+json/examples/subscription_v1_conflict":{"value":{"type":"https://docs.vilna.io/apis/errors#conflict","title":"Conflict","status":409,"code":"notification.subscription_v1_conflict","detail":"a subscription created through v1 accepts name and availability changes only","instance":"/traces/0123456789abcdef0123456789abcdef"},"key":"subscription_v1_conflict","summary":"A v1-created subscription rejects trigger, filter or noise changes","id":"paths/~1tokens~1{chain_gid}~1{asset_path}~1actions~1trust/post/responses/409/content/application~1problem+json/examples/subscription_v1_conflict"},"paths/~1tokens~1{chain_gid}~1{asset_path}~1actions~1trust/post/responses/409/content/application~1problem+json/examples/notification_send_in_progress":{"value":{"type":"https://docs.vilna.io/apis/errors#conflict","title":"Conflict","status":409,"code":"notification.send_in_progress","detail":"notification send is in progress","instance":"/traces/0123456789abcdef0123456789abcdef"},"key":"notification_send_in_progress","summary":"The notification already has a manual attempt queued or in flight","id":"paths/~1tokens~1{chain_gid}~1{asset_path}~1actions~1trust/post/responses/409/content/application~1problem+json/examples/notification_send_in_progress"},"paths/~1tokens~1{chain_gid}~1{asset_path}~1actions~1trust/post/responses/409/content/application~1problem+json/examples/notification_payload_unavailable":{"value":{"type":"https://docs.vilna.io/apis/errors#conflict","title":"Conflict","status":409,"code":"notification.payload_unavailable","detail":"notification payload is no longer available","instance":"/traces/0123456789abcdef0123456789abcdef"},"key":"notification_payload_unavailable","summary":"Retention has cleared the content, so there is nothing to resend","id":"paths/~1tokens~1{chain_gid}~1{asset_path}~1actions~1trust/post/responses/409/content/application~1problem+json/examples/notification_payload_unavailable"},"paths/~1tokens~1{chain_gid}~1{asset_path}~1actions~1trust/post/responses/409/content/application~1problem+json/examples/notification_test_resend_not_allowed":{"value":{"type":"https://docs.vilna.io/apis/errors#conflict","title":"Conflict","status":409,"code":"notification.test_resend_not_allowed","detail":"test notifications cannot be resent","instance":"/traces/0123456789abcdef0123456789abcdef"},"key":"notification_test_resend_not_allowed","summary":"The notification is a channel test","id":"paths/~1tokens~1{chain_gid}~1{asset_path}~1actions~1trust/post/responses/409/content/application~1problem+json/examples/notification_test_resend_not_allowed"},"paths/~1tokens~1{chain_gid}~1{asset_path}~1actions~1trust/post/responses/422/content/application~1problem+json/examples/invoice_not_cancellable":{"value":{"type":"https://docs.vilna.io/apis/errors#precondition","title":"Precondition Failed","status":422,"code":"invoice.not_cancellable","detail":"invoice cannot be cancelled in current status","instance":"/traces/0123456789abcdef0123456789abcdef","fields":[{"name":"status","reason":"confirmed"}]},"key":"invoice_not_cancellable","summary":"A confirmed invoice cannot be cancelled","id":"paths/~1tokens~1{chain_gid}~1{asset_path}~1actions~1trust/post/responses/422/content/application~1problem+json/examples/invoice_not_cancellable"},"paths/~1tokens~1{chain_gid}~1{asset_path}~1actions~1trust/post/responses/429/content/application~1problem+json/examples/address_quota":{"value":{"type":"https://docs.vilna.io/apis/errors#too-many-requests","title":"Too Many Requests","status":429,"code":"address.quota_exceeded","detail":"the project has reached its address limit","max":100},"key":"address_quota","summary":"The project has reached its address quota","id":"paths/~1tokens~1{chain_gid}~1{asset_path}~1actions~1trust/post/responses/429/content/application~1problem+json/examples/address_quota"},"paths/~1tokens~1{chain_gid}~1{asset_path}~1actions~1trust/post/responses/429/content/application~1problem+json/examples/creation_prohibited":{"value":{"type":"https://docs.vilna.io/apis/errors#too-many-requests","title":"Too Many Requests","status":429,"code":"channel.quota_exceeded","detail":"the project has reached its channel limit","max":0},"key":"creation_prohibited","summary":"A zero effective limit prohibits new resources","id":"paths/~1tokens~1{chain_gid}~1{asset_path}~1actions~1trust/post/responses/429/content/application~1problem+json/examples/creation_prohibited"},"paths/~1tokens~1{chain_gid}~1{asset_path}~1actions~1trust/post/responses/503/content/application~1problem+json/examples/temporarily_unavailable":{"value":{"type":"https://docs.vilna.io/apis/errors#service-unavailable","title":"Service Unavailable","status":503,"code":"service.temporarily_unavailable","detail":"The operation is temporarily unavailable. Please try again later."},"key":"temporarily_unavailable","summary":"The operation cannot be completed at present","id":"paths/~1tokens~1{chain_gid}~1{asset_path}~1actions~1trust/post/responses/503/content/application~1problem+json/examples/temporarily_unavailable"},"paths/~1tokens~1{chain_gid}~1{asset_path}~1actions~1untrust/post/responses/400/content/application~1problem+json/examples/malformed_json":{"value":{"type":"https://docs.vilna.io/apis/errors#invalid-request","title":"Invalid Request","status":400,"code":"request.malformed","detail":"The request could not be decoded.","instance":"/traces/0123456789abcdef0123456789abcdef"},"key":"malformed_json","summary":"The request body contains malformed JSON","id":"paths/~1tokens~1{chain_gid}~1{asset_path}~1actions~1untrust/post/responses/400/content/application~1problem+json/examples/malformed_json"},"paths/~1tokens~1{chain_gid}~1{asset_path}~1actions~1untrust/post/responses/401/content/application~1problem+json/examples/service_authentication_denied":{"value":{"type":"https://docs.vilna.io/apis/errors#unauthorized","title":"Unauthorized","status":401,"code":"unspecified","detail":"You are not authorized to access this resource. If the problem persists, please contact our support team.","instance":"/unauthorized?method=createInvoice"},"key":"service_authentication_denied","summary":"The API service refused authentication","id":"paths/~1tokens~1{chain_gid}~1{asset_path}~1actions~1untrust/post/responses/401/content/application~1problem+json/examples/service_authentication_denied"},"paths/~1tokens~1{chain_gid}~1{asset_path}~1actions~1untrust/post/responses/403/content/application~1problem+json/examples/insufficient_permissions":{"value":{"type":"https://docs.vilna.io/apis/errors#forbidden","title":"Forbidden","status":403,"code":"unspecified","detail":"Your credentials are valid but don't include the permission this operation needs. Check the API key permissions in the dashboard. Permissions are set when the key is created and can't be edited later. To change them, create a new key.","instance":"/forbidden?method=createInvoice"},"key":"insufficient_permissions","summary":"The API key lacks the required permission","id":"paths/~1tokens~1{chain_gid}~1{asset_path}~1actions~1untrust/post/responses/403/content/application~1problem+json/examples/insufficient_permissions"},"paths/~1tokens~1{chain_gid}~1{asset_path}~1actions~1untrust/post/responses/404/content/application~1problem+json/examples/address_not_found":{"value":{"type":"https://docs.vilna.io/apis/errors#not-found","title":"Not Found","status":404,"code":"address.not_found","detail":"address not found","instance":"/traces/0123456789abcdef0123456789abcdef"},"key":"address_not_found","summary":"The address does not exist in this project","id":"paths/~1tokens~1{chain_gid}~1{asset_path}~1actions~1untrust/post/responses/404/content/application~1problem+json/examples/address_not_found"},"paths/~1tokens~1{chain_gid}~1{asset_path}~1actions~1untrust/post/responses/404/content/application~1problem+json/examples/invoice_not_found":{"value":{"type":"https://docs.vilna.io/apis/errors#not-found","title":"Not Found","status":404,"code":"invoice.not_found","detail":"invoice not found","instance":"/traces/0123456789abcdef0123456789abcdef"},"key":"invoice_not_found","summary":"The invoice does not exist in this project","id":"paths/~1tokens~1{chain_gid}~1{asset_path}~1actions~1untrust/post/responses/404/content/application~1problem+json/examples/invoice_not_found"},"paths/~1tokens~1{chain_gid}~1{asset_path}~1actions~1untrust/post/responses/409/content/application~1problem+json/examples/address_occupied":{"value":{"type":"https://docs.vilna.io/apis/errors#conflict","title":"Conflict","status":409,"code":"invoice.address_occupied","detail":"address already has an active invoice with different parameters","instance":"/traces/0123456789abcdef0123456789abcdef"},"key":"address_occupied","summary":"The address already has an active invoice","id":"paths/~1tokens~1{chain_gid}~1{asset_path}~1actions~1untrust/post/responses/409/content/application~1problem+json/examples/address_occupied"},"paths/~1tokens~1{chain_gid}~1{asset_path}~1actions~1untrust/post/responses/409/content/application~1problem+json/examples/address_in_use":{"value":{"type":"https://docs.vilna.io/apis/errors#conflict","title":"Conflict","status":409,"code":"address.in_use","detail":"address has an active invoice and cannot be deleted","instance":"/traces/0123456789abcdef0123456789abcdef"},"key":"address_in_use","summary":"The address cannot be deleted while in use","id":"paths/~1tokens~1{chain_gid}~1{asset_path}~1actions~1untrust/post/responses/409/content/application~1problem+json/examples/address_in_use"},"paths/~1tokens~1{chain_gid}~1{asset_path}~1actions~1untrust/post/responses/409/content/application~1problem+json/examples/subscription_v1_conflict":{"value":{"type":"https://docs.vilna.io/apis/errors#conflict","title":"Conflict","status":409,"code":"notification.subscription_v1_conflict","detail":"a subscription created through v1 accepts name and availability changes only","instance":"/traces/0123456789abcdef0123456789abcdef"},"key":"subscription_v1_conflict","summary":"A v1-created subscription rejects trigger, filter or noise changes","id":"paths/~1tokens~1{chain_gid}~1{asset_path}~1actions~1untrust/post/responses/409/content/application~1problem+json/examples/subscription_v1_conflict"},"paths/~1tokens~1{chain_gid}~1{asset_path}~1actions~1untrust/post/responses/409/content/application~1problem+json/examples/notification_send_in_progress":{"value":{"type":"https://docs.vilna.io/apis/errors#conflict","title":"Conflict","status":409,"code":"notification.send_in_progress","detail":"notification send is in progress","instance":"/traces/0123456789abcdef0123456789abcdef"},"key":"notification_send_in_progress","summary":"The notification already has a manual attempt queued or in flight","id":"paths/~1tokens~1{chain_gid}~1{asset_path}~1actions~1untrust/post/responses/409/content/application~1problem+json/examples/notification_send_in_progress"},"paths/~1tokens~1{chain_gid}~1{asset_path}~1actions~1untrust/post/responses/409/content/application~1problem+json/examples/notification_payload_unavailable":{"value":{"type":"https://docs.vilna.io/apis/errors#conflict","title":"Conflict","status":409,"code":"notification.payload_unavailable","detail":"notification payload is no longer available","instance":"/traces/0123456789abcdef0123456789abcdef"},"key":"notification_payload_unavailable","summary":"Retention has cleared the content, so there is nothing to resend","id":"paths/~1tokens~1{chain_gid}~1{asset_path}~1actions~1untrust/post/responses/409/content/application~1problem+json/examples/notification_payload_unavailable"},"paths/~1tokens~1{chain_gid}~1{asset_path}~1actions~1untrust/post/responses/409/content/application~1problem+json/examples/notification_test_resend_not_allowed":{"value":{"type":"https://docs.vilna.io/apis/errors#conflict","title":"Conflict","status":409,"code":"notification.test_resend_not_allowed","detail":"test notifications cannot be resent","instance":"/traces/0123456789abcdef0123456789abcdef"},"key":"notification_test_resend_not_allowed","summary":"The notification is a channel test","id":"paths/~1tokens~1{chain_gid}~1{asset_path}~1actions~1untrust/post/responses/409/content/application~1problem+json/examples/notification_test_resend_not_allowed"},"paths/~1tokens~1{chain_gid}~1{asset_path}~1actions~1untrust/post/responses/422/content/application~1problem+json/examples/invoice_not_cancellable":{"value":{"type":"https://docs.vilna.io/apis/errors#precondition","title":"Precondition Failed","status":422,"code":"invoice.not_cancellable","detail":"invoice cannot be cancelled in current status","instance":"/traces/0123456789abcdef0123456789abcdef","fields":[{"name":"status","reason":"confirmed"}]},"key":"invoice_not_cancellable","summary":"A confirmed invoice cannot be cancelled","id":"paths/~1tokens~1{chain_gid}~1{asset_path}~1actions~1untrust/post/responses/422/content/application~1problem+json/examples/invoice_not_cancellable"},"paths/~1tokens~1{chain_gid}~1{asset_path}~1actions~1untrust/post/responses/503/content/application~1problem+json/examples/temporarily_unavailable":{"value":{"type":"https://docs.vilna.io/apis/errors#service-unavailable","title":"Service Unavailable","status":503,"code":"service.temporarily_unavailable","detail":"The operation is temporarily unavailable. Please try again later."},"key":"temporarily_unavailable","summary":"The operation cannot be completed at present","id":"paths/~1tokens~1{chain_gid}~1{asset_path}~1actions~1untrust/post/responses/503/content/application~1problem+json/examples/temporarily_unavailable"},"paths/~1token-tags/get/responses/400/content/application~1problem+json/examples/malformed_json":{"value":{"type":"https://docs.vilna.io/apis/errors#invalid-request","title":"Invalid Request","status":400,"code":"request.malformed","detail":"The request could not be decoded.","instance":"/traces/0123456789abcdef0123456789abcdef"},"key":"malformed_json","summary":"The request body contains malformed JSON","id":"paths/~1token-tags/get/responses/400/content/application~1problem+json/examples/malformed_json"},"paths/~1token-tags/get/responses/401/content/application~1problem+json/examples/service_authentication_denied":{"value":{"type":"https://docs.vilna.io/apis/errors#unauthorized","title":"Unauthorized","status":401,"code":"unspecified","detail":"You are not authorized to access this resource. If the problem persists, please contact our support team.","instance":"/unauthorized?method=createInvoice"},"key":"service_authentication_denied","summary":"The API service refused authentication","id":"paths/~1token-tags/get/responses/401/content/application~1problem+json/examples/service_authentication_denied"},"paths/~1token-tags/get/responses/403/content/application~1problem+json/examples/insufficient_permissions":{"value":{"type":"https://docs.vilna.io/apis/errors#forbidden","title":"Forbidden","status":403,"code":"unspecified","detail":"Your credentials are valid but don't include the permission this operation needs. Check the API key permissions in the dashboard. Permissions are set when the key is created and can't be edited later. To change them, create a new key.","instance":"/forbidden?method=createInvoice"},"key":"insufficient_permissions","summary":"The API key lacks the required permission","id":"paths/~1token-tags/get/responses/403/content/application~1problem+json/examples/insufficient_permissions"},"paths/~1token-tags/get/responses/503/content/application~1problem+json/examples/temporarily_unavailable":{"value":{"type":"https://docs.vilna.io/apis/errors#service-unavailable","title":"Service Unavailable","status":503,"code":"service.temporarily_unavailable","detail":"The operation is temporarily unavailable. Please try again later."},"key":"temporarily_unavailable","summary":"The operation cannot be completed at present","id":"paths/~1token-tags/get/responses/503/content/application~1problem+json/examples/temporarily_unavailable"},"paths/~1token-tags/post/responses/400/content/application~1problem+json/examples/malformed_json":{"value":{"type":"https://docs.vilna.io/apis/errors#invalid-request","title":"Invalid Request","status":400,"code":"request.malformed","detail":"The request could not be decoded.","instance":"/traces/0123456789abcdef0123456789abcdef"},"key":"malformed_json","summary":"The request body contains malformed JSON","id":"paths/~1token-tags/post/responses/400/content/application~1problem+json/examples/malformed_json"},"paths/~1token-tags/post/responses/401/content/application~1problem+json/examples/service_authentication_denied":{"value":{"type":"https://docs.vilna.io/apis/errors#unauthorized","title":"Unauthorized","status":401,"code":"unspecified","detail":"You are not authorized to access this resource. If the problem persists, please contact our support team.","instance":"/unauthorized?method=createInvoice"},"key":"service_authentication_denied","summary":"The API service refused authentication","id":"paths/~1token-tags/post/responses/401/content/application~1problem+json/examples/service_authentication_denied"},"paths/~1token-tags/post/responses/403/content/application~1problem+json/examples/insufficient_permissions":{"value":{"type":"https://docs.vilna.io/apis/errors#forbidden","title":"Forbidden","status":403,"code":"unspecified","detail":"Your credentials are valid but don't include the permission this operation needs. Check the API key permissions in the dashboard. Permissions are set when the key is created and can't be edited later. To change them, create a new key.","instance":"/forbidden?method=createInvoice"},"key":"insufficient_permissions","summary":"The API key lacks the required permission","id":"paths/~1token-tags/post/responses/403/content/application~1problem+json/examples/insufficient_permissions"},"paths/~1token-tags/post/responses/409/content/application~1problem+json/examples/address_occupied":{"value":{"type":"https://docs.vilna.io/apis/errors#conflict","title":"Conflict","status":409,"code":"invoice.address_occupied","detail":"address already has an active invoice with different parameters","instance":"/traces/0123456789abcdef0123456789abcdef"},"key":"address_occupied","summary":"The address already has an active invoice","id":"paths/~1token-tags/post/responses/409/content/application~1problem+json/examples/address_occupied"},"paths/~1token-tags/post/responses/409/content/application~1problem+json/examples/address_in_use":{"value":{"type":"https://docs.vilna.io/apis/errors#conflict","title":"Conflict","status":409,"code":"address.in_use","detail":"address has an active invoice and cannot be deleted","instance":"/traces/0123456789abcdef0123456789abcdef"},"key":"address_in_use","summary":"The address cannot be deleted while in use","id":"paths/~1token-tags/post/responses/409/content/application~1problem+json/examples/address_in_use"},"paths/~1token-tags/post/responses/409/content/application~1problem+json/examples/subscription_v1_conflict":{"value":{"type":"https://docs.vilna.io/apis/errors#conflict","title":"Conflict","status":409,"code":"notification.subscription_v1_conflict","detail":"a subscription created through v1 accepts name and availability changes only","instance":"/traces/0123456789abcdef0123456789abcdef"},"key":"subscription_v1_conflict","summary":"A v1-created subscription rejects trigger, filter or noise changes","id":"paths/~1token-tags/post/responses/409/content/application~1problem+json/examples/subscription_v1_conflict"},"paths/~1token-tags/post/responses/409/content/application~1problem+json/examples/notification_send_in_progress":{"value":{"type":"https://docs.vilna.io/apis/errors#conflict","title":"Conflict","status":409,"code":"notification.send_in_progress","detail":"notification send is in progress","instance":"/traces/0123456789abcdef0123456789abcdef"},"key":"notification_send_in_progress","summary":"The notification already has a manual attempt queued or in flight","id":"paths/~1token-tags/post/responses/409/content/application~1problem+json/examples/notification_send_in_progress"},"paths/~1token-tags/post/responses/409/content/application~1problem+json/examples/notification_payload_unavailable":{"value":{"type":"https://docs.vilna.io/apis/errors#conflict","title":"Conflict","status":409,"code":"notification.payload_unavailable","detail":"notification payload is no longer available","instance":"/traces/0123456789abcdef0123456789abcdef"},"key":"notification_payload_unavailable","summary":"Retention has cleared the content, so there is nothing to resend","id":"paths/~1token-tags/post/responses/409/content/application~1problem+json/examples/notification_payload_unavailable"},"paths/~1token-tags/post/responses/409/content/application~1problem+json/examples/notification_test_resend_not_allowed":{"value":{"type":"https://docs.vilna.io/apis/errors#conflict","title":"Conflict","status":409,"code":"notification.test_resend_not_allowed","detail":"test notifications cannot be resent","instance":"/traces/0123456789abcdef0123456789abcdef"},"key":"notification_test_resend_not_allowed","summary":"The notification is a channel test","id":"paths/~1token-tags/post/responses/409/content/application~1problem+json/examples/notification_test_resend_not_allowed"},"paths/~1token-tags/post/responses/429/content/application~1problem+json/examples/address_quota":{"value":{"type":"https://docs.vilna.io/apis/errors#too-many-requests","title":"Too Many Requests","status":429,"code":"address.quota_exceeded","detail":"the project has reached its address limit","max":100},"key":"address_quota","summary":"The project has reached its address quota","id":"paths/~1token-tags/post/responses/429/content/application~1problem+json/examples/address_quota"},"paths/~1token-tags/post/responses/429/content/application~1problem+json/examples/creation_prohibited":{"value":{"type":"https://docs.vilna.io/apis/errors#too-many-requests","title":"Too Many Requests","status":429,"code":"channel.quota_exceeded","detail":"the project has reached its channel limit","max":0},"key":"creation_prohibited","summary":"A zero effective limit prohibits new resources","id":"paths/~1token-tags/post/responses/429/content/application~1problem+json/examples/creation_prohibited"},"paths/~1token-tags/post/responses/503/content/application~1problem+json/examples/temporarily_unavailable":{"value":{"type":"https://docs.vilna.io/apis/errors#service-unavailable","title":"Service Unavailable","status":503,"code":"service.temporarily_unavailable","detail":"The operation is temporarily unavailable. Please try again later."},"key":"temporarily_unavailable","summary":"The operation cannot be completed at present","id":"paths/~1token-tags/post/responses/503/content/application~1problem+json/examples/temporarily_unavailable"},"paths/~1token-tags~1{token_tag_id}/get/responses/400/content/application~1problem+json/examples/malformed_json":{"value":{"type":"https://docs.vilna.io/apis/errors#invalid-request","title":"Invalid Request","status":400,"code":"request.malformed","detail":"The request could not be decoded.","instance":"/traces/0123456789abcdef0123456789abcdef"},"key":"malformed_json","summary":"The request body contains malformed JSON","id":"paths/~1token-tags~1{token_tag_id}/get/responses/400/content/application~1problem+json/examples/malformed_json"},"paths/~1token-tags~1{token_tag_id}/get/responses/401/content/application~1problem+json/examples/service_authentication_denied":{"value":{"type":"https://docs.vilna.io/apis/errors#unauthorized","title":"Unauthorized","status":401,"code":"unspecified","detail":"You are not authorized to access this resource. If the problem persists, please contact our support team.","instance":"/unauthorized?method=createInvoice"},"key":"service_authentication_denied","summary":"The API service refused authentication","id":"paths/~1token-tags~1{token_tag_id}/get/responses/401/content/application~1problem+json/examples/service_authentication_denied"},"paths/~1token-tags~1{token_tag_id}/get/responses/403/content/application~1problem+json/examples/insufficient_permissions":{"value":{"type":"https://docs.vilna.io/apis/errors#forbidden","title":"Forbidden","status":403,"code":"unspecified","detail":"Your credentials are valid but don't include the permission this operation needs. Check the API key permissions in the dashboard. Permissions are set when the key is created and can't be edited later. To change them, create a new key.","instance":"/forbidden?method=createInvoice"},"key":"insufficient_permissions","summary":"The API key lacks the required permission","id":"paths/~1token-tags~1{token_tag_id}/get/responses/403/content/application~1problem+json/examples/insufficient_permissions"},"paths/~1token-tags~1{token_tag_id}/get/responses/404/content/application~1problem+json/examples/address_not_found":{"value":{"type":"https://docs.vilna.io/apis/errors#not-found","title":"Not Found","status":404,"code":"address.not_found","detail":"address not found","instance":"/traces/0123456789abcdef0123456789abcdef"},"key":"address_not_found","summary":"The address does not exist in this project","id":"paths/~1token-tags~1{token_tag_id}/get/responses/404/content/application~1problem+json/examples/address_not_found"},"paths/~1token-tags~1{token_tag_id}/get/responses/404/content/application~1problem+json/examples/invoice_not_found":{"value":{"type":"https://docs.vilna.io/apis/errors#not-found","title":"Not Found","status":404,"code":"invoice.not_found","detail":"invoice not found","instance":"/traces/0123456789abcdef0123456789abcdef"},"key":"invoice_not_found","summary":"The invoice does not exist in this project","id":"paths/~1token-tags~1{token_tag_id}/get/responses/404/content/application~1problem+json/examples/invoice_not_found"},"paths/~1token-tags~1{token_tag_id}/get/responses/503/content/application~1problem+json/examples/temporarily_unavailable":{"value":{"type":"https://docs.vilna.io/apis/errors#service-unavailable","title":"Service Unavailable","status":503,"code":"service.temporarily_unavailable","detail":"The operation is temporarily unavailable. Please try again later."},"key":"temporarily_unavailable","summary":"The operation cannot be completed at present","id":"paths/~1token-tags~1{token_tag_id}/get/responses/503/content/application~1problem+json/examples/temporarily_unavailable"},"paths/~1token-tags~1{token_tag_id}/patch/responses/400/content/application~1problem+json/examples/malformed_json":{"value":{"type":"https://docs.vilna.io/apis/errors#invalid-request","title":"Invalid Request","status":400,"code":"request.malformed","detail":"The request could not be decoded.","instance":"/traces/0123456789abcdef0123456789abcdef"},"key":"malformed_json","summary":"The request body contains malformed JSON","id":"paths/~1token-tags~1{token_tag_id}/patch/responses/400/content/application~1problem+json/examples/malformed_json"},"paths/~1token-tags~1{token_tag_id}/patch/responses/401/content/application~1problem+json/examples/service_authentication_denied":{"value":{"type":"https://docs.vilna.io/apis/errors#unauthorized","title":"Unauthorized","status":401,"code":"unspecified","detail":"You are not authorized to access this resource. If the problem persists, please contact our support team.","instance":"/unauthorized?method=createInvoice"},"key":"service_authentication_denied","summary":"The API service refused authentication","id":"paths/~1token-tags~1{token_tag_id}/patch/responses/401/content/application~1problem+json/examples/service_authentication_denied"},"paths/~1token-tags~1{token_tag_id}/patch/responses/403/content/application~1problem+json/examples/insufficient_permissions":{"value":{"type":"https://docs.vilna.io/apis/errors#forbidden","title":"Forbidden","status":403,"code":"unspecified","detail":"Your credentials are valid but don't include the permission this operation needs. Check the API key permissions in the dashboard. Permissions are set when the key is created and can't be edited later. To change them, create a new key.","instance":"/forbidden?method=createInvoice"},"key":"insufficient_permissions","summary":"The API key lacks the required permission","id":"paths/~1token-tags~1{token_tag_id}/patch/responses/403/content/application~1problem+json/examples/insufficient_permissions"},"paths/~1token-tags~1{token_tag_id}/patch/responses/404/content/application~1problem+json/examples/address_not_found":{"value":{"type":"https://docs.vilna.io/apis/errors#not-found","title":"Not Found","status":404,"code":"address.not_found","detail":"address not found","instance":"/traces/0123456789abcdef0123456789abcdef"},"key":"address_not_found","summary":"The address does not exist in this project","id":"paths/~1token-tags~1{token_tag_id}/patch/responses/404/content/application~1problem+json/examples/address_not_found"},"paths/~1token-tags~1{token_tag_id}/patch/responses/404/content/application~1problem+json/examples/invoice_not_found":{"value":{"type":"https://docs.vilna.io/apis/errors#not-found","title":"Not Found","status":404,"code":"invoice.not_found","detail":"invoice not found","instance":"/traces/0123456789abcdef0123456789abcdef"},"key":"invoice_not_found","summary":"The invoice does not exist in this project","id":"paths/~1token-tags~1{token_tag_id}/patch/responses/404/content/application~1problem+json/examples/invoice_not_found"},"paths/~1token-tags~1{token_tag_id}/patch/responses/409/content/application~1problem+json/examples/address_occupied":{"value":{"type":"https://docs.vilna.io/apis/errors#conflict","title":"Conflict","status":409,"code":"invoice.address_occupied","detail":"address already has an active invoice with different parameters","instance":"/traces/0123456789abcdef0123456789abcdef"},"key":"address_occupied","summary":"The address already has an active invoice","id":"paths/~1token-tags~1{token_tag_id}/patch/responses/409/content/application~1problem+json/examples/address_occupied"},"paths/~1token-tags~1{token_tag_id}/patch/responses/409/content/application~1problem+json/examples/address_in_use":{"value":{"type":"https://docs.vilna.io/apis/errors#conflict","title":"Conflict","status":409,"code":"address.in_use","detail":"address has an active invoice and cannot be deleted","instance":"/traces/0123456789abcdef0123456789abcdef"},"key":"address_in_use","summary":"The address cannot be deleted while in use","id":"paths/~1token-tags~1{token_tag_id}/patch/responses/409/content/application~1problem+json/examples/address_in_use"},"paths/~1token-tags~1{token_tag_id}/patch/responses/409/content/application~1problem+json/examples/subscription_v1_conflict":{"value":{"type":"https://docs.vilna.io/apis/errors#conflict","title":"Conflict","status":409,"code":"notification.subscription_v1_conflict","detail":"a subscription created through v1 accepts name and availability changes only","instance":"/traces/0123456789abcdef0123456789abcdef"},"key":"subscription_v1_conflict","summary":"A v1-created subscription rejects trigger, filter or noise changes","id":"paths/~1token-tags~1{token_tag_id}/patch/responses/409/content/application~1problem+json/examples/subscription_v1_conflict"},"paths/~1token-tags~1{token_tag_id}/patch/responses/409/content/application~1problem+json/examples/notification_send_in_progress":{"value":{"type":"https://docs.vilna.io/apis/errors#conflict","title":"Conflict","status":409,"code":"notification.send_in_progress","detail":"notification send is in progress","instance":"/traces/0123456789abcdef0123456789abcdef"},"key":"notification_send_in_progress","summary":"The notification already has a manual attempt queued or in flight","id":"paths/~1token-tags~1{token_tag_id}/patch/responses/409/content/application~1problem+json/examples/notification_send_in_progress"},"paths/~1token-tags~1{token_tag_id}/patch/responses/409/content/application~1problem+json/examples/notification_payload_unavailable":{"value":{"type":"https://docs.vilna.io/apis/errors#conflict","title":"Conflict","status":409,"code":"notification.payload_unavailable","detail":"notification payload is no longer available","instance":"/traces/0123456789abcdef0123456789abcdef"},"key":"notification_payload_unavailable","summary":"Retention has cleared the content, so there is nothing to resend","id":"paths/~1token-tags~1{token_tag_id}/patch/responses/409/content/application~1problem+json/examples/notification_payload_unavailable"},"paths/~1token-tags~1{token_tag_id}/patch/responses/409/content/application~1problem+json/examples/notification_test_resend_not_allowed":{"value":{"type":"https://docs.vilna.io/apis/errors#conflict","title":"Conflict","status":409,"code":"notification.test_resend_not_allowed","detail":"test notifications cannot be resent","instance":"/traces/0123456789abcdef0123456789abcdef"},"key":"notification_test_resend_not_allowed","summary":"The notification is a channel test","id":"paths/~1token-tags~1{token_tag_id}/patch/responses/409/content/application~1problem+json/examples/notification_test_resend_not_allowed"},"paths/~1token-tags~1{token_tag_id}/patch/responses/503/content/application~1problem+json/examples/temporarily_unavailable":{"value":{"type":"https://docs.vilna.io/apis/errors#service-unavailable","title":"Service Unavailable","status":503,"code":"service.temporarily_unavailable","detail":"The operation is temporarily unavailable. Please try again later."},"key":"temporarily_unavailable","summary":"The operation cannot be completed at present","id":"paths/~1token-tags~1{token_tag_id}/patch/responses/503/content/application~1problem+json/examples/temporarily_unavailable"},"paths/~1token-tags~1{token_tag_id}/delete/responses/400/content/application~1problem+json/examples/malformed_json":{"value":{"type":"https://docs.vilna.io/apis/errors#invalid-request","title":"Invalid Request","status":400,"code":"request.malformed","detail":"The request could not be decoded.","instance":"/traces/0123456789abcdef0123456789abcdef"},"key":"malformed_json","summary":"The request body contains malformed JSON","id":"paths/~1token-tags~1{token_tag_id}/delete/responses/400/content/application~1problem+json/examples/malformed_json"},"paths/~1token-tags~1{token_tag_id}/delete/responses/401/content/application~1problem+json/examples/service_authentication_denied":{"value":{"type":"https://docs.vilna.io/apis/errors#unauthorized","title":"Unauthorized","status":401,"code":"unspecified","detail":"You are not authorized to access this resource. If the problem persists, please contact our support team.","instance":"/unauthorized?method=createInvoice"},"key":"service_authentication_denied","summary":"The API service refused authentication","id":"paths/~1token-tags~1{token_tag_id}/delete/responses/401/content/application~1problem+json/examples/service_authentication_denied"},"paths/~1token-tags~1{token_tag_id}/delete/responses/403/content/application~1problem+json/examples/insufficient_permissions":{"value":{"type":"https://docs.vilna.io/apis/errors#forbidden","title":"Forbidden","status":403,"code":"unspecified","detail":"Your credentials are valid but don't include the permission this operation needs. Check the API key permissions in the dashboard. Permissions are set when the key is created and can't be edited later. To change them, create a new key.","instance":"/forbidden?method=createInvoice"},"key":"insufficient_permissions","summary":"The API key lacks the required permission","id":"paths/~1token-tags~1{token_tag_id}/delete/responses/403/content/application~1problem+json/examples/insufficient_permissions"},"paths/~1token-tags~1{token_tag_id}/delete/responses/404/content/application~1problem+json/examples/address_not_found":{"value":{"type":"https://docs.vilna.io/apis/errors#not-found","title":"Not Found","status":404,"code":"address.not_found","detail":"address not found","instance":"/traces/0123456789abcdef0123456789abcdef"},"key":"address_not_found","summary":"The address does not exist in this project","id":"paths/~1token-tags~1{token_tag_id}/delete/responses/404/content/application~1problem+json/examples/address_not_found"},"paths/~1token-tags~1{token_tag_id}/delete/responses/404/content/application~1problem+json/examples/invoice_not_found":{"value":{"type":"https://docs.vilna.io/apis/errors#not-found","title":"Not Found","status":404,"code":"invoice.not_found","detail":"invoice not found","instance":"/traces/0123456789abcdef0123456789abcdef"},"key":"invoice_not_found","summary":"The invoice does not exist in this project","id":"paths/~1token-tags~1{token_tag_id}/delete/responses/404/content/application~1problem+json/examples/invoice_not_found"},"paths/~1token-tags~1{token_tag_id}/delete/responses/409/content/application~1problem+json/examples/address_occupied":{"value":{"type":"https://docs.vilna.io/apis/errors#conflict","title":"Conflict","status":409,"code":"invoice.address_occupied","detail":"address already has an active invoice with different parameters","instance":"/traces/0123456789abcdef0123456789abcdef"},"key":"address_occupied","summary":"The address already has an active invoice","id":"paths/~1token-tags~1{token_tag_id}/delete/responses/409/content/application~1problem+json/examples/address_occupied"},"paths/~1token-tags~1{token_tag_id}/delete/responses/409/content/application~1problem+json/examples/address_in_use":{"value":{"type":"https://docs.vilna.io/apis/errors#conflict","title":"Conflict","status":409,"code":"address.in_use","detail":"address has an active invoice and cannot be deleted","instance":"/traces/0123456789abcdef0123456789abcdef"},"key":"address_in_use","summary":"The address cannot be deleted while in use","id":"paths/~1token-tags~1{token_tag_id}/delete/responses/409/content/application~1problem+json/examples/address_in_use"},"paths/~1token-tags~1{token_tag_id}/delete/responses/409/content/application~1problem+json/examples/subscription_v1_conflict":{"value":{"type":"https://docs.vilna.io/apis/errors#conflict","title":"Conflict","status":409,"code":"notification.subscription_v1_conflict","detail":"a subscription created through v1 accepts name and availability changes only","instance":"/traces/0123456789abcdef0123456789abcdef"},"key":"subscription_v1_conflict","summary":"A v1-created subscription rejects trigger, filter or noise changes","id":"paths/~1token-tags~1{token_tag_id}/delete/responses/409/content/application~1problem+json/examples/subscription_v1_conflict"},"paths/~1token-tags~1{token_tag_id}/delete/responses/409/content/application~1problem+json/examples/notification_send_in_progress":{"value":{"type":"https://docs.vilna.io/apis/errors#conflict","title":"Conflict","status":409,"code":"notification.send_in_progress","detail":"notification send is in progress","instance":"/traces/0123456789abcdef0123456789abcdef"},"key":"notification_send_in_progress","summary":"The notification already has a manual attempt queued or in flight","id":"paths/~1token-tags~1{token_tag_id}/delete/responses/409/content/application~1problem+json/examples/notification_send_in_progress"},"paths/~1token-tags~1{token_tag_id}/delete/responses/409/content/application~1problem+json/examples/notification_payload_unavailable":{"value":{"type":"https://docs.vilna.io/apis/errors#conflict","title":"Conflict","status":409,"code":"notification.payload_unavailable","detail":"notification payload is no longer available","instance":"/traces/0123456789abcdef0123456789abcdef"},"key":"notification_payload_unavailable","summary":"Retention has cleared the content, so there is nothing to resend","id":"paths/~1token-tags~1{token_tag_id}/delete/responses/409/content/application~1problem+json/examples/notification_payload_unavailable"},"paths/~1token-tags~1{token_tag_id}/delete/responses/409/content/application~1problem+json/examples/notification_test_resend_not_allowed":{"value":{"type":"https://docs.vilna.io/apis/errors#conflict","title":"Conflict","status":409,"code":"notification.test_resend_not_allowed","detail":"test notifications cannot be resent","instance":"/traces/0123456789abcdef0123456789abcdef"},"key":"notification_test_resend_not_allowed","summary":"The notification is a channel test","id":"paths/~1token-tags~1{token_tag_id}/delete/responses/409/content/application~1problem+json/examples/notification_test_resend_not_allowed"},"paths/~1token-tags~1{token_tag_id}/delete/responses/503/content/application~1problem+json/examples/temporarily_unavailable":{"value":{"type":"https://docs.vilna.io/apis/errors#service-unavailable","title":"Service Unavailable","status":503,"code":"service.temporarily_unavailable","detail":"The operation is temporarily unavailable. Please try again later."},"key":"temporarily_unavailable","summary":"The operation cannot be completed at present","id":"paths/~1token-tags~1{token_tag_id}/delete/responses/503/content/application~1problem+json/examples/temporarily_unavailable"},"paths/~1token-tags~1{token_tag_id}~1actions~1add/post/responses/400/content/application~1problem+json/examples/malformed_json":{"value":{"type":"https://docs.vilna.io/apis/errors#invalid-request","title":"Invalid Request","status":400,"code":"request.malformed","detail":"The request could not be decoded.","instance":"/traces/0123456789abcdef0123456789abcdef"},"key":"malformed_json","summary":"The request body contains malformed JSON","id":"paths/~1token-tags~1{token_tag_id}~1actions~1add/post/responses/400/content/application~1problem+json/examples/malformed_json"},"paths/~1token-tags~1{token_tag_id}~1actions~1add/post/responses/401/content/application~1problem+json/examples/service_authentication_denied":{"value":{"type":"https://docs.vilna.io/apis/errors#unauthorized","title":"Unauthorized","status":401,"code":"unspecified","detail":"You are not authorized to access this resource. If the problem persists, please contact our support team.","instance":"/unauthorized?method=createInvoice"},"key":"service_authentication_denied","summary":"The API service refused authentication","id":"paths/~1token-tags~1{token_tag_id}~1actions~1add/post/responses/401/content/application~1problem+json/examples/service_authentication_denied"},"paths/~1token-tags~1{token_tag_id}~1actions~1add/post/responses/403/content/application~1problem+json/examples/insufficient_permissions":{"value":{"type":"https://docs.vilna.io/apis/errors#forbidden","title":"Forbidden","status":403,"code":"unspecified","detail":"Your credentials are valid but don't include the permission this operation needs. Check the API key permissions in the dashboard. Permissions are set when the key is created and can't be edited later. To change them, create a new key.","instance":"/forbidden?method=createInvoice"},"key":"insufficient_permissions","summary":"The API key lacks the required permission","id":"paths/~1token-tags~1{token_tag_id}~1actions~1add/post/responses/403/content/application~1problem+json/examples/insufficient_permissions"},"paths/~1token-tags~1{token_tag_id}~1actions~1add/post/responses/404/content/application~1problem+json/examples/address_not_found":{"value":{"type":"https://docs.vilna.io/apis/errors#not-found","title":"Not Found","status":404,"code":"address.not_found","detail":"address not found","instance":"/traces/0123456789abcdef0123456789abcdef"},"key":"address_not_found","summary":"The address does not exist in this project","id":"paths/~1token-tags~1{token_tag_id}~1actions~1add/post/responses/404/content/application~1problem+json/examples/address_not_found"},"paths/~1token-tags~1{token_tag_id}~1actions~1add/post/responses/404/content/application~1problem+json/examples/invoice_not_found":{"value":{"type":"https://docs.vilna.io/apis/errors#not-found","title":"Not Found","status":404,"code":"invoice.not_found","detail":"invoice not found","instance":"/traces/0123456789abcdef0123456789abcdef"},"key":"invoice_not_found","summary":"The invoice does not exist in this project","id":"paths/~1token-tags~1{token_tag_id}~1actions~1add/post/responses/404/content/application~1problem+json/examples/invoice_not_found"},"paths/~1token-tags~1{token_tag_id}~1actions~1add/post/responses/409/content/application~1problem+json/examples/address_occupied":{"value":{"type":"https://docs.vilna.io/apis/errors#conflict","title":"Conflict","status":409,"code":"invoice.address_occupied","detail":"address already has an active invoice with different parameters","instance":"/traces/0123456789abcdef0123456789abcdef"},"key":"address_occupied","summary":"The address already has an active invoice","id":"paths/~1token-tags~1{token_tag_id}~1actions~1add/post/responses/409/content/application~1problem+json/examples/address_occupied"},"paths/~1token-tags~1{token_tag_id}~1actions~1add/post/responses/409/content/application~1problem+json/examples/address_in_use":{"value":{"type":"https://docs.vilna.io/apis/errors#conflict","title":"Conflict","status":409,"code":"address.in_use","detail":"address has an active invoice and cannot be deleted","instance":"/traces/0123456789abcdef0123456789abcdef"},"key":"address_in_use","summary":"The address cannot be deleted while in use","id":"paths/~1token-tags~1{token_tag_id}~1actions~1add/post/responses/409/content/application~1problem+json/examples/address_in_use"},"paths/~1token-tags~1{token_tag_id}~1actions~1add/post/responses/409/content/application~1problem+json/examples/subscription_v1_conflict":{"value":{"type":"https://docs.vilna.io/apis/errors#conflict","title":"Conflict","status":409,"code":"notification.subscription_v1_conflict","detail":"a subscription created through v1 accepts name and availability changes only","instance":"/traces/0123456789abcdef0123456789abcdef"},"key":"subscription_v1_conflict","summary":"A v1-created subscription rejects trigger, filter or noise changes","id":"paths/~1token-tags~1{token_tag_id}~1actions~1add/post/responses/409/content/application~1problem+json/examples/subscription_v1_conflict"},"paths/~1token-tags~1{token_tag_id}~1actions~1add/post/responses/409/content/application~1problem+json/examples/notification_send_in_progress":{"value":{"type":"https://docs.vilna.io/apis/errors#conflict","title":"Conflict","status":409,"code":"notification.send_in_progress","detail":"notification send is in progress","instance":"/traces/0123456789abcdef0123456789abcdef"},"key":"notification_send_in_progress","summary":"The notification already has a manual attempt queued or in flight","id":"paths/~1token-tags~1{token_tag_id}~1actions~1add/post/responses/409/content/application~1problem+json/examples/notification_send_in_progress"},"paths/~1token-tags~1{token_tag_id}~1actions~1add/post/responses/409/content/application~1problem+json/examples/notification_payload_unavailable":{"value":{"type":"https://docs.vilna.io/apis/errors#conflict","title":"Conflict","status":409,"code":"notification.payload_unavailable","detail":"notification payload is no longer available","instance":"/traces/0123456789abcdef0123456789abcdef"},"key":"notification_payload_unavailable","summary":"Retention has cleared the content, so there is nothing to resend","id":"paths/~1token-tags~1{token_tag_id}~1actions~1add/post/responses/409/content/application~1problem+json/examples/notification_payload_unavailable"},"paths/~1token-tags~1{token_tag_id}~1actions~1add/post/responses/409/content/application~1problem+json/examples/notification_test_resend_not_allowed":{"value":{"type":"https://docs.vilna.io/apis/errors#conflict","title":"Conflict","status":409,"code":"notification.test_resend_not_allowed","detail":"test notifications cannot be resent","instance":"/traces/0123456789abcdef0123456789abcdef"},"key":"notification_test_resend_not_allowed","summary":"The notification is a channel test","id":"paths/~1token-tags~1{token_tag_id}~1actions~1add/post/responses/409/content/application~1problem+json/examples/notification_test_resend_not_allowed"},"paths/~1token-tags~1{token_tag_id}~1actions~1add/post/responses/503/content/application~1problem+json/examples/temporarily_unavailable":{"value":{"type":"https://docs.vilna.io/apis/errors#service-unavailable","title":"Service Unavailable","status":503,"code":"service.temporarily_unavailable","detail":"The operation is temporarily unavailable. Please try again later."},"key":"temporarily_unavailable","summary":"The operation cannot be completed at present","id":"paths/~1token-tags~1{token_tag_id}~1actions~1add/post/responses/503/content/application~1problem+json/examples/temporarily_unavailable"},"paths/~1token-tags~1{token_tag_id}~1actions~1remove/post/responses/400/content/application~1problem+json/examples/malformed_json":{"value":{"type":"https://docs.vilna.io/apis/errors#invalid-request","title":"Invalid Request","status":400,"code":"request.malformed","detail":"The request could not be decoded.","instance":"/traces/0123456789abcdef0123456789abcdef"},"key":"malformed_json","summary":"The request body contains malformed JSON","id":"paths/~1token-tags~1{token_tag_id}~1actions~1remove/post/responses/400/content/application~1problem+json/examples/malformed_json"},"paths/~1token-tags~1{token_tag_id}~1actions~1remove/post/responses/401/content/application~1problem+json/examples/service_authentication_denied":{"value":{"type":"https://docs.vilna.io/apis/errors#unauthorized","title":"Unauthorized","status":401,"code":"unspecified","detail":"You are not authorized to access this resource. If the problem persists, please contact our support team.","instance":"/unauthorized?method=createInvoice"},"key":"service_authentication_denied","summary":"The API service refused authentication","id":"paths/~1token-tags~1{token_tag_id}~1actions~1remove/post/responses/401/content/application~1problem+json/examples/service_authentication_denied"},"paths/~1token-tags~1{token_tag_id}~1actions~1remove/post/responses/403/content/application~1problem+json/examples/insufficient_permissions":{"value":{"type":"https://docs.vilna.io/apis/errors#forbidden","title":"Forbidden","status":403,"code":"unspecified","detail":"Your credentials are valid but don't include the permission this operation needs. Check the API key permissions in the dashboard. Permissions are set when the key is created and can't be edited later. To change them, create a new key.","instance":"/forbidden?method=createInvoice"},"key":"insufficient_permissions","summary":"The API key lacks the required permission","id":"paths/~1token-tags~1{token_tag_id}~1actions~1remove/post/responses/403/content/application~1problem+json/examples/insufficient_permissions"},"paths/~1token-tags~1{token_tag_id}~1actions~1remove/post/responses/404/content/application~1problem+json/examples/address_not_found":{"value":{"type":"https://docs.vilna.io/apis/errors#not-found","title":"Not Found","status":404,"code":"address.not_found","detail":"address not found","instance":"/traces/0123456789abcdef0123456789abcdef"},"key":"address_not_found","summary":"The address does not exist in this project","id":"paths/~1token-tags~1{token_tag_id}~1actions~1remove/post/responses/404/content/application~1problem+json/examples/address_not_found"},"paths/~1token-tags~1{token_tag_id}~1actions~1remove/post/responses/404/content/application~1problem+json/examples/invoice_not_found":{"value":{"type":"https://docs.vilna.io/apis/errors#not-found","title":"Not Found","status":404,"code":"invoice.not_found","detail":"invoice not found","instance":"/traces/0123456789abcdef0123456789abcdef"},"key":"invoice_not_found","summary":"The invoice does not exist in this project","id":"paths/~1token-tags~1{token_tag_id}~1actions~1remove/post/responses/404/content/application~1problem+json/examples/invoice_not_found"},"paths/~1token-tags~1{token_tag_id}~1actions~1remove/post/responses/409/content/application~1problem+json/examples/address_occupied":{"value":{"type":"https://docs.vilna.io/apis/errors#conflict","title":"Conflict","status":409,"code":"invoice.address_occupied","detail":"address already has an active invoice with different parameters","instance":"/traces/0123456789abcdef0123456789abcdef"},"key":"address_occupied","summary":"The address already has an active invoice","id":"paths/~1token-tags~1{token_tag_id}~1actions~1remove/post/responses/409/content/application~1problem+json/examples/address_occupied"},"paths/~1token-tags~1{token_tag_id}~1actions~1remove/post/responses/409/content/application~1problem+json/examples/address_in_use":{"value":{"type":"https://docs.vilna.io/apis/errors#conflict","title":"Conflict","status":409,"code":"address.in_use","detail":"address has an active invoice and cannot be deleted","instance":"/traces/0123456789abcdef0123456789abcdef"},"key":"address_in_use","summary":"The address cannot be deleted while in use","id":"paths/~1token-tags~1{token_tag_id}~1actions~1remove/post/responses/409/content/application~1problem+json/examples/address_in_use"},"paths/~1token-tags~1{token_tag_id}~1actions~1remove/post/responses/409/content/application~1problem+json/examples/subscription_v1_conflict":{"value":{"type":"https://docs.vilna.io/apis/errors#conflict","title":"Conflict","status":409,"code":"notification.subscription_v1_conflict","detail":"a subscription created through v1 accepts name and availability changes only","instance":"/traces/0123456789abcdef0123456789abcdef"},"key":"subscription_v1_conflict","summary":"A v1-created subscription rejects trigger, filter or noise changes","id":"paths/~1token-tags~1{token_tag_id}~1actions~1remove/post/responses/409/content/application~1problem+json/examples/subscription_v1_conflict"},"paths/~1token-tags~1{token_tag_id}~1actions~1remove/post/responses/409/content/application~1problem+json/examples/notification_send_in_progress":{"value":{"type":"https://docs.vilna.io/apis/errors#conflict","title":"Conflict","status":409,"code":"notification.send_in_progress","detail":"notification send is in progress","instance":"/traces/0123456789abcdef0123456789abcdef"},"key":"notification_send_in_progress","summary":"The notification already has a manual attempt queued or in flight","id":"paths/~1token-tags~1{token_tag_id}~1actions~1remove/post/responses/409/content/application~1problem+json/examples/notification_send_in_progress"},"paths/~1token-tags~1{token_tag_id}~1actions~1remove/post/responses/409/content/application~1problem+json/examples/notification_payload_unavailable":{"value":{"type":"https://docs.vilna.io/apis/errors#conflict","title":"Conflict","status":409,"code":"notification.payload_unavailable","detail":"notification payload is no longer available","instance":"/traces/0123456789abcdef0123456789abcdef"},"key":"notification_payload_unavailable","summary":"Retention has cleared the content, so there is nothing to resend","id":"paths/~1token-tags~1{token_tag_id}~1actions~1remove/post/responses/409/content/application~1problem+json/examples/notification_payload_unavailable"},"paths/~1token-tags~1{token_tag_id}~1actions~1remove/post/responses/409/content/application~1problem+json/examples/notification_test_resend_not_allowed":{"value":{"type":"https://docs.vilna.io/apis/errors#conflict","title":"Conflict","status":409,"code":"notification.test_resend_not_allowed","detail":"test notifications cannot be resent","instance":"/traces/0123456789abcdef0123456789abcdef"},"key":"notification_test_resend_not_allowed","summary":"The notification is a channel test","id":"paths/~1token-tags~1{token_tag_id}~1actions~1remove/post/responses/409/content/application~1problem+json/examples/notification_test_resend_not_allowed"},"paths/~1token-tags~1{token_tag_id}~1actions~1remove/post/responses/503/content/application~1problem+json/examples/temporarily_unavailable":{"value":{"type":"https://docs.vilna.io/apis/errors#service-unavailable","title":"Service Unavailable","status":503,"code":"service.temporarily_unavailable","detail":"The operation is temporarily unavailable. Please try again later."},"key":"temporarily_unavailable","summary":"The operation cannot be completed at present","id":"paths/~1token-tags~1{token_tag_id}~1actions~1remove/post/responses/503/content/application~1problem+json/examples/temporarily_unavailable"},"paths/~1limits/get/responses/400/content/application~1problem+json/examples/malformed_json":{"value":{"type":"https://docs.vilna.io/apis/errors#invalid-request","title":"Invalid Request","status":400,"code":"request.malformed","detail":"The request could not be decoded.","instance":"/traces/0123456789abcdef0123456789abcdef"},"key":"malformed_json","summary":"The request body contains malformed JSON","id":"paths/~1limits/get/responses/400/content/application~1problem+json/examples/malformed_json"},"paths/~1limits/get/responses/401/content/application~1problem+json/examples/service_authentication_denied":{"value":{"type":"https://docs.vilna.io/apis/errors#unauthorized","title":"Unauthorized","status":401,"code":"unspecified","detail":"You are not authorized to access this resource. If the problem persists, please contact our support team.","instance":"/unauthorized?method=createInvoice"},"key":"service_authentication_denied","summary":"The API service refused authentication","id":"paths/~1limits/get/responses/401/content/application~1problem+json/examples/service_authentication_denied"},"paths/~1limits/get/responses/403/content/application~1problem+json/examples/insufficient_permissions":{"value":{"type":"https://docs.vilna.io/apis/errors#forbidden","title":"Forbidden","status":403,"code":"unspecified","detail":"Your credentials are valid but don't include the permission this operation needs. Check the API key permissions in the dashboard. Permissions are set when the key is created and can't be edited later. To change them, create a new key.","instance":"/forbidden?method=createInvoice"},"key":"insufficient_permissions","summary":"The API key lacks the required permission","id":"paths/~1limits/get/responses/403/content/application~1problem+json/examples/insufficient_permissions"},"paths/~1limits/get/responses/503/content/application~1problem+json/examples/temporarily_unavailable":{"value":{"type":"https://docs.vilna.io/apis/errors#service-unavailable","title":"Service Unavailable","status":503,"code":"service.temporarily_unavailable","detail":"The operation is temporarily unavailable. Please try again later."},"key":"temporarily_unavailable","summary":"The operation cannot be completed at present","id":"paths/~1limits/get/responses/503/content/application~1problem+json/examples/temporarily_unavailable"},"paths/~1evm~1simulations/post/requestBody/content/application~1json/examples/multi_transaction_simulation":{"value":{"chain_gid":"eip155:1","block_state_calls":[{"calls":[{"from":"0x974caa59e49682cda0ad2bbe82983419a2ecc400","to":"0xd0930a8fc56fd94038250bb93dbac0e13da4eb99","value":"10000000000000000","data":"0x"},{"from":"0x974caa59e49682cda0ad2bbe82983419a2ecc400","to":"0xdAC17F958D2ee523a2206206994597C13D831ec7","value":"0","data":"0x095ea7b3000000000000000000000000d0930a8fc56fd94038250bb93dbac0e13da4eb99000000000000000000000000000000000000000000000000000000003b9aca00"},{"from":"0x974caa59e49682cda0ad2bbe82983419a2ecc400","to":"0xdAC17F958D2ee523a2206206994597C13D831ec7","value":"0","data":"0xa9059cbb000000000000000000000000d0930a8fc56fd94038250bb93dbac0e13da4eb99000000000000000000000000000000000000000000000000000000003b9aca00"}]}]},"key":"multi_transaction_simulation","summary":"Multi-call simulation","id":"paths/~1evm~1simulations/post/requestBody/content/application~1json/examples/multi_transaction_simulation"},"paths/~1evm~1simulations/post/requestBody/content/application~1json/examples/simple_transfer":{"value":{"chain_gid":"eip155:1","block_state_calls":[{"calls":[{"from":"0x974caa59e49682cda0ad2bbe82983419a2ecc400","to":"0xd0930a8fc56fd94038250bb93dbac0e13da4eb99","value":"1000000000000000000","data":"0x"}]}]},"key":"simple_transfer","summary":"Native transfer","id":"paths/~1evm~1simulations/post/requestBody/content/application~1json/examples/simple_transfer"},"paths/~1evm~1simulations/post/requestBody/content/application~1json/examples/strict_validation":{"value":{"chain_gid":"eip155:1","validation":true,"block_state_calls":[{"calls":[{"from":"0x974caa59e49682cda0ad2bbe82983419a2ecc400","to":"0xdAC17F958D2ee523a2206206994597C13D831ec7","value":"0","data":"0xa9059cbb000000000000000000000000d0930a8fc56fd94038250bb93dbac0e13da4eb99000000000000000000000000000000000000000000000000000000003b9aca00","nonce":"1","gas":"60000","max_fee_per_gas":"2000000000","max_priority_fee_per_gas":"1000000000"}]}]},"key":"strict_validation","summary":"Pre-send validation with EIP-1559 fees","id":"paths/~1evm~1simulations/post/requestBody/content/application~1json/examples/strict_validation"},"paths/~1evm~1simulations/post/responses/400/content/application~1problem+json/examples/malformed_json":{"value":{"type":"https://docs.vilna.io/apis/errors#invalid-request","title":"Invalid Request","status":400,"code":"request.malformed","detail":"The request could not be decoded.","instance":"/traces/0123456789abcdef0123456789abcdef"},"key":"malformed_json","summary":"The request body contains malformed JSON","id":"paths/~1evm~1simulations/post/responses/400/content/application~1problem+json/examples/malformed_json"},"paths/~1evm~1simulations/post/responses/401/content/application~1problem+json/examples/service_authentication_denied":{"value":{"type":"https://docs.vilna.io/apis/errors#unauthorized","title":"Unauthorized","status":401,"code":"unspecified","detail":"You are not authorized to access this resource. If the problem persists, please contact our support team.","instance":"/unauthorized?method=createInvoice"},"key":"service_authentication_denied","summary":"The API service refused authentication","id":"paths/~1evm~1simulations/post/responses/401/content/application~1problem+json/examples/service_authentication_denied"},"paths/~1evm~1simulations/post/responses/403/content/application~1problem+json/examples/insufficient_permissions":{"value":{"type":"https://docs.vilna.io/apis/errors#forbidden","title":"Forbidden","status":403,"code":"unspecified","detail":"Your credentials are valid but don't include the permission this operation needs. Check the API key permissions in the dashboard. Permissions are set when the key is created and can't be edited later. To change them, create a new key.","instance":"/forbidden?method=createInvoice"},"key":"insufficient_permissions","summary":"The API key lacks the required permission","id":"paths/~1evm~1simulations/post/responses/403/content/application~1problem+json/examples/insufficient_permissions"},"paths/~1evm~1simulations/post/responses/404/content/application~1problem+json/examples/address_not_found":{"value":{"type":"https://docs.vilna.io/apis/errors#not-found","title":"Not Found","status":404,"code":"address.not_found","detail":"address not found","instance":"/traces/0123456789abcdef0123456789abcdef"},"key":"address_not_found","summary":"The address does not exist in this project","id":"paths/~1evm~1simulations/post/responses/404/content/application~1problem+json/examples/address_not_found"},"paths/~1evm~1simulations/post/responses/404/content/application~1problem+json/examples/invoice_not_found":{"value":{"type":"https://docs.vilna.io/apis/errors#not-found","title":"Not Found","status":404,"code":"invoice.not_found","detail":"invoice not found","instance":"/traces/0123456789abcdef0123456789abcdef"},"key":"invoice_not_found","summary":"The invoice does not exist in this project","id":"paths/~1evm~1simulations/post/responses/404/content/application~1problem+json/examples/invoice_not_found"},"paths/~1evm~1simulations/post/responses/422/content/application~1problem+json/examples/invoice_not_cancellable":{"value":{"type":"https://docs.vilna.io/apis/errors#precondition","title":"Precondition Failed","status":422,"code":"invoice.not_cancellable","detail":"invoice cannot be cancelled in current status","instance":"/traces/0123456789abcdef0123456789abcdef","fields":[{"name":"status","reason":"confirmed"}]},"key":"invoice_not_cancellable","summary":"A confirmed invoice cannot be cancelled","id":"paths/~1evm~1simulations/post/responses/422/content/application~1problem+json/examples/invoice_not_cancellable"},"paths/~1evm~1simulations/post/responses/503/content/application~1problem+json/examples/temporarily_unavailable":{"value":{"type":"https://docs.vilna.io/apis/errors#service-unavailable","title":"Service Unavailable","status":503,"code":"service.temporarily_unavailable","detail":"The operation is temporarily unavailable. Please try again later."},"key":"temporarily_unavailable","summary":"The operation cannot be completed at present","id":"paths/~1evm~1simulations/post/responses/503/content/application~1problem+json/examples/temporarily_unavailable"},"paths/~1version/get/responses/200/content/application~1json/example":{"value":{"item":{"version":"2.0.0"}},"id":"paths/~1version/get/responses/200/content/application~1json/example"},"paths/~1version/get/responses/400/content/application~1problem+json/examples/malformed_json":{"value":{"type":"https://docs.vilna.io/apis/errors#invalid-request","title":"Invalid Request","status":400,"code":"request.malformed","detail":"The request could not be decoded.","instance":"/traces/0123456789abcdef0123456789abcdef"},"key":"malformed_json","summary":"The request body contains malformed JSON","id":"paths/~1version/get/responses/400/content/application~1problem+json/examples/malformed_json"},"paths/~1version/get/responses/503/content/application~1problem+json/examples/temporarily_unavailable":{"value":{"type":"https://docs.vilna.io/apis/errors#service-unavailable","title":"Service Unavailable","status":503,"code":"service.temporarily_unavailable","detail":"The operation is temporarily unavailable. Please try again later."},"key":"temporarily_unavailable","summary":"The operation cannot be completed at present","id":"paths/~1version/get/responses/503/content/application~1problem+json/examples/temporarily_unavailable"}},"securitySchemeStore":{"Auth":{"id":"Auth","type":"apiKey","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"API key for authenticating requests. Include your key in the "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"X-Api-Key"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" header. Keys can be created in the Vilna Dashboard or via the Management API. The scopes listed per operation indicate which permissions the key must have."},"children":[]}]}]}],"in":"header","paramName":"X-Api-Key"}},"specVersion":"3.1.0","servers":[{"url":"/_mock/apis/platform/api","isMockServer":true,"description":"Mock server"},{"url":"https://api.vilna.io/v2","description":"Vilna API."}],"specType":"openapi"},"options":{"schemasExpansionLevel":2,"codeSamples":{"languages":[{"lang":"curl"},{"lang":"JavaScript"},{"lang":"Python"},{"lang":"Go"}]},"mockServer":{"url":"/_mock/apis/platform/api","position":"first","description":"Mock server"},"disableRouter":true,"downloadUrls":[{"url":"/_bundle/apis/platform/@v2/api.json?download"},{"url":"/_bundle/apis/platform/@v2/api.yaml?download"}],"excludeFromSearch":false,"replayFeatures":{"graphql":false},"specType":"openapi","markdocOptions":{"tags":{},"nodes":{},"components":{}},"metadata":{"title":"Platform API","description":"Monitor blockchain activity at addresses you provide or derive from your extended public key. Read balances and transactions, reconcile invoice receipts and configure notifications across supported networks.\n\nSee the [Platform overview](https://docs.vilna.io/apis/platform) for capabilities, [authentication](https://docs.vilna.io/apis/authentication) for API keys, and [idempotency](https://docs.vilna.io/apis/idempotency) for mutation retries. Each operation declares its required permissions, headers and parameters.\n"}},"baseSlug":"/apis/platform/api","routesMapping":{}}