{ "openapi": "3.0.1", "info": { "title": "Ishtaran API", "description": "Programmable financial transaction infrastructure via API -- virtual accounts, conditional release workflows and settlements.", "version": "v1" }, "paths": { "/v1/organizations/{organizationId}/account-holder-invitations": { "post": { "tags": [ "AccountHolders" ], "operationId": "CreateAccountHolderInvitation", "parameters": [ { "name": "organizationId", "in": "path", "required": true, "schema": { "type": "string", "format": "uuid" } } ], "requestBody": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Accounts.Contracts.Requests.CreateAccountHolderInvitationRequest" } } }, "required": true }, "responses": { "201": { "description": "Created", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Accounts.Contracts.Commands.CreateAccountHolderInvitationResult" } } } } } } }, "/v1/organizations/{organizationId}/relationships/{relationshipId}/revoke": { "post": { "tags": [ "AccountHolders" ], "operationId": "RevokeRelationship", "parameters": [ { "name": "organizationId", "in": "path", "required": true, "schema": { "type": "string", "format": "uuid" } }, { "name": "relationshipId", "in": "path", "required": true, "schema": { "type": "string", "format": "uuid" } } ], "responses": { "204": { "description": "No Content" } } } }, "/v1/account-holders/signup": { "post": { "tags": [ "AccountHolders" ], "operationId": "SignUpAccountHolder", "requestBody": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Accounts.Contracts.Requests.SignUpAccountHolderRequest" } } }, "required": true }, "responses": { "200": { "description": "OK", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Accounts.Contracts.Responses.TokenResult" } } } } } } }, "/v1/account-holders/login": { "post": { "tags": [ "AccountHolders" ], "operationId": "LoginAccountHolder", "requestBody": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Accounts.Contracts.Requests.LoginAccountHolderRequest" } } }, "required": true }, "responses": { "200": { "description": "OK", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Accounts.Contracts.Responses.TokenResult" } } } }, "401": { "description": "Unauthorized" } } } }, "/v1/account-holders/me": { "get": { "tags": [ "AccountHolders" ], "operationId": "GetAccountHolderMe", "responses": { "200": { "description": "OK", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Accounts.Contracts.Responses.AccountHolderResponse" } } } }, "404": { "description": "Not Found" } } } }, "/v1/account-holders/invitations/claim": { "post": { "tags": [ "AccountHolders" ], "operationId": "ClaimAccountHolderInvitation", "requestBody": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Accounts.Contracts.Requests.ClaimAccountHolderInvitationRequest" } } }, "required": true }, "responses": { "200": { "description": "OK", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Accounts.Contracts.Commands.ClaimAccountHolderInvitationResult" } } } } } } }, "/v1/account-holders/invitations/signup-and-claim": { "post": { "tags": [ "AccountHolders" ], "operationId": "SignUpAndClaimAccountHolderInvitation", "requestBody": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Accounts.Contracts.Requests.SignUpAndClaimAccountHolderInvitationRequest" } } }, "required": true }, "responses": { "200": { "description": "OK", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Accounts.Contracts.Commands.SignUpAndClaimAccountHolderInvitationResult" } } } } } } }, "/v1/organizations/{organizationId}/accounts": { "post": { "tags": [ "Accounts" ], "operationId": "CreateAccount", "parameters": [ { "name": "organizationId", "in": "path", "required": true, "schema": { "type": "string", "format": "uuid" } } ], "requestBody": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Accounts.Contracts.Requests.CreateAccountRequest" } } }, "required": true }, "responses": { "201": { "description": "Created" } } }, "get": { "tags": [ "Accounts" ], "operationId": "ListAccountsByOrganization", "parameters": [ { "name": "organizationId", "in": "path", "required": true, "schema": { "type": "string", "format": "uuid" } } ], "responses": { "200": { "description": "OK", "content": { "application/json": { "schema": { "type": "array", "items": { "$ref": "#/components/schemas/Accounts.Contracts.Responses.OrganizationAccountResponse" } } } } } } } }, "/v1/organizations/{organizationId}/accounts/{accountId}/authorize-application": { "post": { "tags": [ "Accounts" ], "operationId": "AuthorizeAccountForApplication", "parameters": [ { "name": "organizationId", "in": "path", "required": true, "schema": { "type": "string", "format": "uuid" } }, { "name": "accountId", "in": "path", "required": true, "schema": { "type": "string", "format": "uuid" } } ], "requestBody": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Accounts.Contracts.Requests.AuthorizeApplicationRequest" } } }, "required": true }, "responses": { "204": { "description": "No Content" } } } }, "/v1/accounts/{accountId}": { "get": { "tags": [ "Accounts" ], "operationId": "GetAccount", "parameters": [ { "name": "accountId", "in": "path", "required": true, "schema": { "type": "string", "format": "uuid" } } ], "responses": { "200": { "description": "OK", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Accounts.Contracts.Responses.AccountResponse" } } } }, "404": { "description": "Not Found" } } }, "delete": { "tags": [ "Accounts" ], "operationId": "CloseAccount", "parameters": [ { "name": "accountId", "in": "path", "required": true, "schema": { "type": "string", "format": "uuid" } } ], "responses": { "204": { "description": "No Content" } } } }, "/v1/accounts/{accountId}/freeze": { "post": { "tags": [ "Accounts" ], "operationId": "FreezeAccount", "parameters": [ { "name": "accountId", "in": "path", "required": true, "schema": { "type": "string", "format": "uuid" } } ], "requestBody": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Accounts.Contracts.Requests.FreezeAccountRequest" } } }, "required": true }, "responses": { "204": { "description": "No Content" } } } }, "/v1/accounts/{accountId}/unfreeze": { "post": { "tags": [ "Accounts" ], "operationId": "UnfreezeAccount", "parameters": [ { "name": "accountId", "in": "path", "required": true, "schema": { "type": "string", "format": "uuid" } } ], "responses": { "204": { "description": "No Content" } } } }, "/v1/admin/audit-log": { "get": { "tags": [ "AdministrationAudit" ], "operationId": "SearchAuditLog", "parameters": [ { "name": "organizationId", "in": "query", "schema": { "type": "string", "format": "uuid" } }, { "name": "entityType", "in": "query", "schema": { "type": "string" } }, { "name": "entityId", "in": "query", "schema": { "type": "string", "format": "uuid" } }, { "name": "actionType", "in": "query", "schema": { "type": "string" } }, { "name": "skip", "in": "query", "schema": { "type": "integer", "format": "int32" } }, { "name": "take", "in": "query", "schema": { "type": "integer", "format": "int32" } } ], "responses": { "200": { "description": "OK" } } } }, "/v1/admin/audit-log/{auditLogEntryId}": { "get": { "tags": [ "AdministrationAudit" ], "operationId": "GetAuditLogEntry", "parameters": [ { "name": "auditLogEntryId", "in": "path", "required": true, "schema": { "type": "string", "format": "uuid" } } ], "responses": { "200": { "description": "OK", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/AdministrationAudit.Contracts.Responses.AuditLogEntryResponse" } } } }, "404": { "description": "Not Found" } } } }, "/v1/admin/dashboard": { "get": { "tags": [ "AdministrationAudit" ], "operationId": "GetPlatformDashboard", "responses": { "200": { "description": "OK" } } } }, "/v1/admin/treasury-overview": { "get": { "tags": [ "AdministrationAudit" ], "operationId": "GetTreasuryOverview", "responses": { "200": { "description": "OK" } } } }, "/v1/admin/treasury/{assetNetworkId}/controlled-addresses": { "get": { "tags": [ "AdministrationAudit" ], "operationId": "GetTreasuryControlledAddresses", "parameters": [ { "name": "assetNetworkId", "in": "path", "required": true, "schema": { "type": "string", "format": "uuid" } }, { "name": "activeOnly", "in": "query", "schema": { "type": "boolean" } } ], "responses": { "200": { "description": "OK" } } } }, "/v1/admin/treasury/{assetNetworkId}/rebalance-plan": { "get": { "tags": [ "AdministrationAudit" ], "operationId": "GetTreasuryRebalancePlan", "parameters": [ { "name": "assetNetworkId", "in": "path", "required": true, "schema": { "type": "string", "format": "uuid" } } ], "responses": { "200": { "description": "OK" } } } }, "/v1/admin/treasury/sweeps": { "get": { "tags": [ "AdministrationAudit" ], "operationId": "SearchTreasurySweeps", "parameters": [ { "name": "assetNetworkId", "in": "query", "schema": { "type": "string", "format": "uuid" } }, { "name": "skip", "in": "query", "schema": { "type": "integer", "format": "int32" } }, { "name": "take", "in": "query", "schema": { "type": "integer", "format": "int32" } } ], "responses": { "200": { "description": "OK" } } }, "post": { "tags": [ "AdministrationAudit" ], "operationId": "AdminExecuteSandboxSweep", "requestBody": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/AdministrationAudit.Contracts.Commands.AdminExecuteSandboxSweepCommand" } } }, "required": true }, "responses": { "201": { "description": "Created" } } } }, "/v1/admin/network-resource-reserve/{assetNetworkId}/balance": { "get": { "tags": [ "AdministrationAudit" ], "operationId": "AdminGetNetworkResourceReserveBalance", "parameters": [ { "name": "assetNetworkId", "in": "path", "required": true, "schema": { "type": "string", "format": "uuid" } } ], "responses": { "200": { "description": "OK", "content": { "application/json": { "schema": { } } } } } } }, "/v1/admin/ledger-entries": { "get": { "tags": [ "AdministrationAudit" ], "operationId": "SearchLedgerEntriesAdmin", "parameters": [ { "name": "assetNetworkId", "in": "query", "schema": { "type": "string", "format": "uuid" } }, { "name": "nature", "in": "query", "schema": { "type": "string" } }, { "name": "from", "in": "query", "schema": { "type": "string", "format": "date-time" } }, { "name": "to", "in": "query", "schema": { "type": "string", "format": "date-time" } }, { "name": "skip", "in": "query", "schema": { "type": "integer", "format": "int32" } }, { "name": "take", "in": "query", "schema": { "type": "integer", "format": "int32" } } ], "responses": { "200": { "description": "OK" } } } }, "/v1/admin/withdrawals/{withdrawalId}/approve": { "post": { "tags": [ "AdministrationAudit" ], "operationId": "AdminApproveWithdrawal", "parameters": [ { "name": "withdrawalId", "in": "path", "required": true, "schema": { "type": "string", "format": "uuid" } } ], "responses": { "204": { "description": "No Content" } } } }, "/v1/admin/withdrawals/{withdrawalId}/reject": { "post": { "tags": [ "AdministrationAudit" ], "operationId": "AdminRejectWithdrawal", "parameters": [ { "name": "withdrawalId", "in": "path", "required": true, "schema": { "type": "string", "format": "uuid" } } ], "requestBody": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/AdministrationAudit.Contracts.Requests.AdminRejectWithdrawalRequest" } } }, "required": true }, "responses": { "204": { "description": "No Content" } } } }, "/v1/admin/withdrawal-destinations/{withdrawalDestinationId}/block": { "post": { "tags": [ "AdministrationAudit" ], "operationId": "AdminBlockWithdrawalDestination", "parameters": [ { "name": "withdrawalDestinationId", "in": "path", "required": true, "schema": { "type": "string", "format": "uuid" } } ], "requestBody": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/AdministrationAudit.Contracts.Requests.AdminBlockWithdrawalDestinationRequest" } } }, "required": true }, "responses": { "204": { "description": "No Content" } } } }, "/v1/admin/organizations/{organizationId}/withdrawal-policy": { "post": { "tags": [ "AdministrationAudit" ], "operationId": "AdminConfigureWithdrawalPolicy", "parameters": [ { "name": "organizationId", "in": "path", "required": true, "schema": { "type": "string", "format": "uuid" } } ], "requestBody": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/AdministrationAudit.Contracts.Requests.AdminConfigureWithdrawalPolicyRequest" } } }, "required": true }, "responses": { "204": { "description": "No Content" } } } }, "/v1/admin/organizations/{organizationId}/payout-policy": { "post": { "tags": [ "AdministrationAudit" ], "operationId": "AdminConfigurePayoutPolicy", "parameters": [ { "name": "organizationId", "in": "path", "required": true, "schema": { "type": "string", "format": "uuid" } } ], "requestBody": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/AdministrationAudit.Contracts.Requests.AdminConfigurePayoutPolicyRequest" } } }, "required": true }, "responses": { "204": { "description": "No Content" } } } }, "/v1/admin/deposits/{depositId}/resolve-under-review": { "post": { "tags": [ "AdministrationAudit" ], "operationId": "AdminResolveDepositUnderReview", "parameters": [ { "name": "depositId", "in": "path", "required": true, "schema": { "type": "string", "format": "uuid" } } ], "requestBody": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/AdministrationAudit.Contracts.Requests.AdminResolveDepositUnderReviewRequest" } } }, "required": true }, "responses": { "204": { "description": "No Content" } } } }, "/v1/admin/deposits/{depositId}/resolve-reorg": { "post": { "tags": [ "AdministrationAudit" ], "operationId": "AdminResolveDepositReorg", "parameters": [ { "name": "depositId", "in": "path", "required": true, "schema": { "type": "string", "format": "uuid" } } ], "requestBody": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/AdministrationAudit.Contracts.Requests.AdminResolveDepositReorgRequest" } } }, "required": true }, "responses": { "204": { "description": "No Content" } } } }, "/v1/admin/settlements/{settlementId}/retry": { "post": { "tags": [ "AdministrationAudit" ], "operationId": "AdminRetrySettlement", "parameters": [ { "name": "settlementId", "in": "path", "required": true, "schema": { "type": "string", "format": "uuid" } } ], "responses": { "204": { "description": "No Content" } } } }, "/v1/admin/pricing-policy": { "post": { "tags": [ "AdministrationAudit" ], "operationId": "AdminConfigurePricingPolicy", "requestBody": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/AdministrationAudit.Contracts.Commands.AdminConfigurePricingPolicyCommand" } } }, "required": true }, "responses": { "204": { "description": "No Content" } } } }, "/v1/admin/global-revenue-account/execution-destination": { "post": { "tags": [ "AdministrationAudit" ], "operationId": "AdminRegisterGlobalRevenueAccountExecutionDestination", "requestBody": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/AdministrationAudit.Contracts.Commands.AdminRegisterGlobalRevenueAccountExecutionDestinationCommand" } } }, "required": true }, "responses": { "204": { "description": "No Content" } } } }, "/v1/admin/tron-resource-cost-table": { "post": { "tags": [ "AdministrationAudit" ], "operationId": "AdminConfigureTronResourceCostTable", "requestBody": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/AdministrationAudit.Contracts.Commands.AdminConfigureTronResourceCostTableCommand" } } }, "required": true }, "responses": { "204": { "description": "No Content" } } } }, "/v1/admin/network-execution-margin-policy": { "post": { "tags": [ "AdministrationAudit" ], "operationId": "AdminConfigureNetworkExecutionMarginPolicy", "requestBody": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/AdministrationAudit.Contracts.Commands.AdminConfigureNetworkExecutionMarginPolicyCommand" } } }, "required": true }, "responses": { "204": { "description": "No Content" } } } }, "/v1/admin/network-resource-reserve/seed": { "post": { "tags": [ "AdministrationAudit" ], "operationId": "AdminSeedNetworkResourceReserve", "requestBody": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/AdministrationAudit.Contracts.Commands.AdminSeedNetworkResourceReserveCommand" } } }, "required": true }, "responses": { "200": { "description": "OK", "content": { "application/json": { "schema": { } } } } } } }, "/v1/admin/network-resource-reserve/policy": { "post": { "tags": [ "AdministrationAudit" ], "operationId": "AdminConfigureResourceReservePolicy", "requestBody": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/AdministrationAudit.Contracts.Commands.AdminConfigureResourceReservePolicyCommand" } } }, "required": true }, "responses": { "204": { "description": "No Content" } } } }, "/v1/admin/network-resource-reserve/replenishment-route": { "post": { "tags": [ "AdministrationAudit" ], "operationId": "AdminConfigureReplenishmentRoute", "requestBody": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/AdministrationAudit.Contracts.Commands.AdminConfigureReplenishmentRouteCommand" } } }, "required": true }, "responses": { "204": { "description": "No Content" } } } }, "/v1/admin/refund-fee-policy": { "post": { "tags": [ "AdministrationAudit" ], "operationId": "AdminConfigureRefundFeePolicy", "requestBody": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/AdministrationAudit.Contracts.Commands.AdminConfigureRefundFeePolicyCommand" } } }, "required": true }, "responses": { "204": { "description": "No Content" } } } }, "/v1/admin/reconciliations/execute": { "post": { "tags": [ "AdministrationAudit" ], "operationId": "AdminExecuteReconciliation", "responses": { "201": { "description": "Created" } } } }, "/v1/admin/reconciliations/{reconciliationId}/resolve-divergence": { "post": { "tags": [ "AdministrationAudit" ], "operationId": "AdminResolveReconciliationDivergence", "parameters": [ { "name": "reconciliationId", "in": "path", "required": true, "schema": { "type": "string", "format": "uuid" } } ], "requestBody": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/AdministrationAudit.Contracts.Requests.AdminResolveReconciliationDivergenceRequest" } } }, "required": true }, "responses": { "204": { "description": "No Content" } } } }, "/v1/admin/ledger-corrections": { "post": { "tags": [ "AdministrationAudit" ], "operationId": "AdminRecordLedgerCorrection", "requestBody": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/AdministrationAudit.Contracts.Commands.RecordAdministrativeLedgerCorrectionCommand" } } }, "required": true }, "responses": { "201": { "description": "Created" } } } }, "/v1/admin/treasury/controlled-addresses": { "post": { "tags": [ "AdministrationAudit" ], "operationId": "AdminRegisterControlledAddress", "requestBody": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/AdministrationAudit.Contracts.Commands.AdminRegisterControlledAddressCommand" } } }, "required": true }, "responses": { "201": { "description": "Created" } } } }, "/v1/admin/treasury/liquidity-policy": { "post": { "tags": [ "AdministrationAudit" ], "operationId": "AdminConfigureTreasuryLiquidityPolicy", "requestBody": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/AdministrationAudit.Contracts.Commands.AdminConfigureTreasuryLiquidityPolicyCommand" } } }, "required": true }, "responses": { "204": { "description": "No Content" } } } }, "/v1/api-keys/{apiKeyId}/rotate": { "post": { "tags": [ "ApiKeys" ], "operationId": "RotateApiKey", "parameters": [ { "name": "apiKeyId", "in": "path", "required": true, "schema": { "type": "string", "format": "uuid" } } ], "requestBody": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/OrganizationTenancy.Contracts.Requests.RotateApiKeyRequest" } } }, "required": true }, "responses": { "200": { "description": "OK", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/OrganizationTenancy.Contracts.Responses.RotateApiKeyResult" } } } } } } }, "/v1/api-keys/{apiKeyId}": { "delete": { "tags": [ "ApiKeys" ], "operationId": "RevokeApiKey", "parameters": [ { "name": "apiKeyId", "in": "path", "required": true, "schema": { "type": "string", "format": "uuid" } } ], "responses": { "204": { "description": "No Content" } } } }, "/v1/applications/{applicationId}/environments": { "post": { "tags": [ "Applications" ], "operationId": "CreateEnvironment", "parameters": [ { "name": "applicationId", "in": "path", "required": true, "schema": { "type": "string", "format": "uuid" } } ], "requestBody": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/OrganizationTenancy.Contracts.Requests.CreateEnvironmentRequest" } } }, "required": true }, "responses": { "201": { "description": "Created", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/OrganizationTenancy.Contracts.Responses.CreatedResourceResponse" } } } } } }, "get": { "tags": [ "Applications" ], "operationId": "ListEnvironments", "parameters": [ { "name": "applicationId", "in": "path", "required": true, "schema": { "type": "string", "format": "uuid" } } ], "responses": { "200": { "description": "OK", "content": { "application/json": { "schema": { "type": "array", "items": { "$ref": "#/components/schemas/OrganizationTenancy.Contracts.Responses.EnvironmentResponse" } } } } } } } }, "/v1/applications/{applicationId}/archive": { "post": { "tags": [ "Applications" ], "operationId": "ArchiveApplication", "parameters": [ { "name": "applicationId", "in": "path", "required": true, "schema": { "type": "string", "format": "uuid" } } ], "responses": { "204": { "description": "No Content" } } } }, "/v1/applications/{applicationId}/suspend": { "post": { "tags": [ "Applications" ], "operationId": "SuspendApplication", "parameters": [ { "name": "applicationId", "in": "path", "required": true, "schema": { "type": "string", "format": "uuid" } } ], "requestBody": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/OrganizationTenancy.Contracts.Requests.SuspendRequest" } } }, "required": true }, "responses": { "204": { "description": "No Content" } } } }, "/v1/applications/{applicationId}/reactivate": { "post": { "tags": [ "Applications" ], "operationId": "ReactivateApplication", "parameters": [ { "name": "applicationId", "in": "path", "required": true, "schema": { "type": "string", "format": "uuid" } } ], "responses": { "204": { "description": "No Content" } } } }, "/v1/assets": { "get": { "tags": [ "AssetNetworkCatalog" ], "operationId": "ListAssets", "responses": { "200": { "description": "OK", "content": { "application/json": { "schema": { "type": "array", "items": { "$ref": "#/components/schemas/AssetNetworkCatalog.Contracts.Responses.AssetResponse" } } } } } } } }, "/v1/assets/{assetId}": { "get": { "tags": [ "AssetNetworkCatalog" ], "operationId": "GetAsset", "parameters": [ { "name": "assetId", "in": "path", "required": true, "schema": { "type": "string", "format": "uuid" } } ], "responses": { "200": { "description": "OK", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/AssetNetworkCatalog.Contracts.Responses.AssetResponse" } } } }, "404": { "description": "Not Found" } } } }, "/v1/networks": { "get": { "tags": [ "AssetNetworkCatalog" ], "operationId": "ListNetworks", "responses": { "200": { "description": "OK", "content": { "application/json": { "schema": { "type": "array", "items": { "$ref": "#/components/schemas/AssetNetworkCatalog.Contracts.Responses.NetworkResponse" } } } } } } } }, "/v1/networks/{networkId}": { "get": { "tags": [ "AssetNetworkCatalog" ], "operationId": "GetNetwork", "parameters": [ { "name": "networkId", "in": "path", "required": true, "schema": { "type": "string", "format": "uuid" } } ], "responses": { "200": { "description": "OK", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/AssetNetworkCatalog.Contracts.Responses.NetworkResponse" } } } }, "404": { "description": "Not Found" } } } }, "/v1/asset-networks": { "get": { "tags": [ "AssetNetworkCatalog" ], "operationId": "ListAssetNetworks", "parameters": [ { "name": "status", "in": "query", "schema": { "$ref": "#/components/schemas/AssetNetworkCatalog.Contracts.Enums.AssetNetworkStatus" } } ], "responses": { "200": { "description": "OK", "content": { "application/json": { "schema": { "type": "array", "items": { "$ref": "#/components/schemas/AssetNetworkCatalog.Contracts.Responses.AssetNetworkResponse" } } } } } } } }, "/v1/asset-networks/{assetNetworkId}": { "get": { "tags": [ "AssetNetworkCatalog" ], "operationId": "GetAssetNetwork", "parameters": [ { "name": "assetNetworkId", "in": "path", "required": true, "schema": { "type": "string", "format": "uuid" } } ], "responses": { "200": { "description": "OK", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/AssetNetworkCatalog.Contracts.Responses.AssetNetworkResponse" } } } }, "404": { "description": "Not Found" } } } }, "/v1/platform/assets": { "post": { "tags": [ "AssetNetworkCatalog" ], "operationId": "CreateAsset", "requestBody": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/AssetNetworkCatalog.Contracts.Requests.CreateAssetRequest" } } }, "required": true }, "responses": { "201": { "description": "Created" } } } }, "/v1/platform/networks": { "post": { "tags": [ "AssetNetworkCatalog" ], "operationId": "CreateNetwork", "requestBody": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/AssetNetworkCatalog.Contracts.Requests.CreateNetworkRequest" } } }, "required": true }, "responses": { "201": { "description": "Created" } } } }, "/v1/platform/asset-networks": { "post": { "tags": [ "AssetNetworkCatalog" ], "operationId": "CreateAssetNetwork", "requestBody": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/AssetNetworkCatalog.Contracts.Requests.CreateAssetNetworkRequest" } } }, "required": true }, "responses": { "201": { "description": "Created" } } } }, "/v1/platform/asset-networks/{assetNetworkId}/enable": { "post": { "tags": [ "AssetNetworkCatalog" ], "operationId": "EnableAssetNetwork", "parameters": [ { "name": "assetNetworkId", "in": "path", "required": true, "schema": { "type": "string", "format": "uuid" } } ], "responses": { "204": { "description": "No Content" } } } }, "/v1/platform/asset-networks/{assetNetworkId}/pause": { "post": { "tags": [ "AssetNetworkCatalog" ], "operationId": "PauseAssetNetwork", "parameters": [ { "name": "assetNetworkId", "in": "path", "required": true, "schema": { "type": "string", "format": "uuid" } } ], "requestBody": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/AssetNetworkCatalog.Contracts.Requests.PauseAssetNetworkRequest" } } }, "required": true }, "responses": { "204": { "description": "No Content" } } } }, "/v1/platform/asset-networks/{assetNetworkId}/disable": { "post": { "tags": [ "AssetNetworkCatalog" ], "operationId": "DisableAssetNetwork", "parameters": [ { "name": "assetNetworkId", "in": "path", "required": true, "schema": { "type": "string", "format": "uuid" } } ], "responses": { "204": { "description": "No Content" } } } }, "/v1/auth/login": { "post": { "tags": [ "Auth" ], "operationId": "Login", "requestBody": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/IdentityAccess.Contracts.Requests.LoginRequest" } } }, "required": true }, "responses": { "200": { "description": "OK", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/IdentityAccess.Contracts.Responses.TokenResult" } } } }, "401": { "description": "Unauthorized", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/IdentityAccess.Contracts.Responses.TokenResult" } } } } } } }, "/v1/auth/refresh": { "post": { "tags": [ "Auth" ], "operationId": "RefreshToken", "requestBody": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/IdentityAccess.Contracts.Requests.RefreshTokenRequest" } } }, "required": true }, "responses": { "200": { "description": "OK", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/IdentityAccess.Contracts.Responses.TokenResult" } } } }, "401": { "description": "Unauthorized", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/IdentityAccess.Contracts.Responses.TokenResult" } } } } } } }, "/v1/auth/password-reset/request": { "post": { "tags": [ "Auth" ], "operationId": "RequestPasswordReset", "requestBody": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/IdentityAccess.Contracts.Requests.RequestPasswordResetRequest" } } }, "required": true }, "responses": { "204": { "description": "No Content" } } } }, "/v1/auth/password-reset/confirm": { "post": { "tags": [ "Auth" ], "operationId": "ConfirmPasswordReset", "requestBody": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/IdentityAccess.Contracts.Requests.ResetPasswordRequest" } } }, "required": true }, "responses": { "204": { "description": "No Content" } } } }, "/v1/auth/signup": { "post": { "tags": [ "Auth" ], "operationId": "SignUp", "parameters": [ { "name": "Idempotency-Key", "in": "header", "schema": { "type": "string" } } ], "requestBody": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/CompositionRoot.EndpointMapping.SignUpRequest" } } }, "required": true }, "responses": { "201": { "description": "Created", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/CompositionRoot.EndpointMapping.SignUpResponse" } } } }, "400": { "description": "Bad Request" }, "409": { "description": "Conflict" } } } }, "/v1/organizations/{organizationId}/payment-intents": { "post": { "tags": [ "Deposits" ], "operationId": "CreatePaymentIntent", "parameters": [ { "name": "organizationId", "in": "path", "required": true, "schema": { "type": "string", "format": "uuid" } } ], "requestBody": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Deposits.Contracts.Requests.CreatePaymentIntentRequest" } } }, "required": true }, "responses": { "201": { "description": "Created" } } } }, "/v1/payment-intents/{paymentIntentId}": { "get": { "tags": [ "Deposits" ], "operationId": "GetPaymentIntent", "parameters": [ { "name": "paymentIntentId", "in": "path", "required": true, "schema": { "type": "string", "format": "uuid" } } ], "responses": { "200": { "description": "OK", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Deposits.Contracts.Responses.PaymentIntentResponse" } } } }, "404": { "description": "Not Found" } } } }, "/v1/deposits/{depositId}": { "get": { "tags": [ "Deposits" ], "operationId": "GetDeposit", "parameters": [ { "name": "depositId", "in": "path", "required": true, "schema": { "type": "string", "format": "uuid" } } ], "responses": { "200": { "description": "OK", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Deposits.Contracts.Responses.DepositResponse" } } } }, "404": { "description": "Not Found" } } } }, "/v1/environments/{environmentId}/api-keys": { "post": { "tags": [ "Environments" ], "operationId": "GenerateApiKey", "parameters": [ { "name": "environmentId", "in": "path", "required": true, "schema": { "type": "string", "format": "uuid" } } ], "responses": { "201": { "description": "Created", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/OrganizationTenancy.Contracts.Responses.GenerateApiKeyResult" } } } } } }, "get": { "tags": [ "Environments" ], "operationId": "ListApiKeys", "parameters": [ { "name": "environmentId", "in": "path", "required": true, "schema": { "type": "string", "format": "uuid" } } ], "responses": { "200": { "description": "OK", "content": { "application/json": { "schema": { "type": "array", "items": { "$ref": "#/components/schemas/OrganizationTenancy.Contracts.Responses.ApiKeyMetadataResponse" } } } } } } } }, "/v1/applications/{applicationId}/wallets": { "post": { "tags": [ "ExecutionCustody" ], "operationId": "RegisterWallet", "parameters": [ { "name": "applicationId", "in": "path", "required": true, "schema": { "type": "string", "format": "uuid" } } ], "requestBody": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ExecutionCustody.Contracts.Requests.RegisterWalletRequest" } } }, "required": true }, "responses": { "201": { "description": "Created" } } } }, "/v1/applications/{applicationId}/wallets/deposit-addresses": { "post": { "tags": [ "ExecutionCustody" ], "operationId": "AllocateDepositAddress", "parameters": [ { "name": "applicationId", "in": "path", "required": true, "schema": { "type": "string", "format": "uuid" } } ], "requestBody": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ExecutionCustody.Contracts.Requests.AllocateDepositAddressRequest" } } }, "required": true }, "responses": { "200": { "description": "OK", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ExecutionCustody.Contracts.Responses.AllocatedDepositAddressResponse" } } } } } } }, "/v1/wallets/{walletId}": { "get": { "tags": [ "ExecutionCustody" ], "operationId": "GetWallet", "parameters": [ { "name": "walletId", "in": "path", "required": true, "schema": { "type": "string", "format": "uuid" } } ], "responses": { "200": { "description": "OK", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ExecutionCustody.Contracts.Responses.WalletResponse" } } } }, "404": { "description": "Not Found" } } } }, "/v1/wallets/{walletId}/public-material": { "get": { "tags": [ "ExecutionCustody" ], "operationId": "GetWalletPublicMaterial", "parameters": [ { "name": "walletId", "in": "path", "required": true, "schema": { "type": "string", "format": "uuid" } } ], "responses": { "404": { "description": "Not Found" } } } }, "/v1/environments/{environmentId}/signing-requests": { "post": { "tags": [ "ExecutionCustody" ], "operationId": "CreateSigningRequest", "parameters": [ { "name": "environmentId", "in": "path", "required": true, "schema": { "type": "string", "format": "uuid" } } ], "requestBody": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ExecutionCustody.Contracts.Requests.CreateSigningRequestRequest" } } }, "required": true }, "responses": { "201": { "description": "Created" } } } }, "/v1/environments/{environmentId}/network-execution-quote": { "post": { "tags": [ "ExecutionCustody" ], "operationId": "GetNetworkExecutionQuote", "parameters": [ { "name": "environmentId", "in": "path", "required": true, "schema": { "type": "string", "format": "uuid" } } ], "requestBody": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ExecutionCustody.Contracts.Requests.NetworkExecutionQuoteRequest" } } }, "required": true }, "responses": { "200": { "description": "OK", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ExecutionCustody.Contracts.Responses.NetworkExecutionQuoteResponse" } } } } } } }, "/v1/signing-requests/{signingRequestId}": { "get": { "tags": [ "ExecutionCustody" ], "operationId": "GetSigningRequest", "parameters": [ { "name": "signingRequestId", "in": "path", "required": true, "schema": { "type": "string", "format": "uuid" } } ], "responses": { "200": { "description": "OK", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ExecutionCustody.Contracts.Responses.SigningRequestResponse" } } } }, "404": { "description": "Not Found" } } } }, "/v1/signing-requests/{signingRequestId}/legs/{executionLegId}/submit": { "post": { "tags": [ "ExecutionCustody" ], "operationId": "SubmitSignedTransaction", "parameters": [ { "name": "signingRequestId", "in": "path", "required": true, "schema": { "type": "string", "format": "uuid" } }, { "name": "executionLegId", "in": "path", "required": true, "schema": { "type": "string", "format": "uuid" } } ], "requestBody": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ExecutionCustody.Contracts.Requests.SubmitSignedTransactionRequest" } } }, "required": true }, "responses": { "200": { "description": "OK", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ExecutionCustody.Contracts.Responses.SubmitSignedTransactionResult" } } } } } } }, "/v1/organizations/{organizationId}/execution-destinations": { "post": { "tags": [ "ExecutionCustody" ], "operationId": "RegisterExecutionDestination", "parameters": [ { "name": "organizationId", "in": "path", "required": true, "schema": { "type": "string", "format": "uuid" } } ], "requestBody": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ExecutionCustody.Contracts.Requests.RegisterExecutionDestinationRequest" } } }, "required": true }, "responses": { "201": { "description": "Created" } } } }, "/v1/organizations/{organizationId}/execution-sources": { "post": { "tags": [ "ExecutionCustody" ], "operationId": "RegisterExecutionSource", "parameters": [ { "name": "organizationId", "in": "path", "required": true, "schema": { "type": "string", "format": "uuid" } } ], "requestBody": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ExecutionCustody.Contracts.Requests.RegisterExecutionSourceRequest" } } }, "required": true }, "responses": { "201": { "description": "Created" } } } }, "/v1/organizations/{organizationId}/execution-sources/{executionSourceId}/resource-stake": { "post": { "tags": [ "ExecutionCustody" ], "operationId": "SyncCustomerResourceStake", "parameters": [ { "name": "organizationId", "in": "path", "required": true, "schema": { "type": "string", "format": "uuid" } }, { "name": "executionSourceId", "in": "path", "required": true, "schema": { "type": "string", "format": "uuid" } } ], "requestBody": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ExecutionCustody.Contracts.Requests.SyncCustomerResourceStakeRequest" } } }, "required": true }, "responses": { "204": { "description": "No Content" } } } }, "/v1/organizations/{organizationId}/network-cost-payer-accounts": { "post": { "tags": [ "ExecutionCustody" ], "operationId": "RegisterNetworkCostPayerAccount", "parameters": [ { "name": "organizationId", "in": "path", "required": true, "schema": { "type": "string", "format": "uuid" } } ], "requestBody": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ExecutionCustody.Contracts.Requests.RegisterNetworkCostPayerAccountRequest" } } }, "required": true }, "responses": { "201": { "description": "Created" } } } }, "/v1/organizations/{organizationId}/network-cost-payer-accounts/{assetNetworkId}/resource-preference": { "patch": { "tags": [ "ExecutionCustody" ], "operationId": "UpdateNetworkResourcePreference", "parameters": [ { "name": "organizationId", "in": "path", "required": true, "schema": { "type": "string", "format": "uuid" } }, { "name": "assetNetworkId", "in": "path", "required": true, "schema": { "type": "string", "format": "uuid" } } ], "requestBody": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ExecutionCustody.Contracts.Requests.UpdateNetworkResourcePreferenceRequest" } } }, "required": true }, "responses": { "204": { "description": "No Content" } } } }, "/v1/accounts/{accountId}/balance": { "get": { "tags": [ "Ledger" ], "operationId": "GetAccountBalance", "parameters": [ { "name": "accountId", "in": "path", "required": true, "schema": { "type": "string", "format": "uuid" } }, { "name": "assetNetworkId", "in": "query", "required": true, "schema": { "type": "string", "format": "uuid" } } ], "responses": { "200": { "description": "OK" } } } }, "/v1/accounts/{accountId}/ledger-entries": { "get": { "tags": [ "Ledger" ], "operationId": "GetAccountLedgerEntries", "parameters": [ { "name": "accountId", "in": "path", "required": true, "schema": { "type": "string", "format": "uuid" } }, { "name": "assetNetworkId", "in": "query", "required": true, "schema": { "type": "string", "format": "uuid" } }, { "name": "nature", "in": "query", "schema": { "$ref": "#/components/schemas/Ledger.Contracts.Enums.EntryNature" } }, { "name": "from", "in": "query", "schema": { "type": "string", "format": "date-time" } }, { "name": "to", "in": "query", "schema": { "type": "string", "format": "date-time" } }, { "name": "skip", "in": "query", "required": true, "schema": { "type": "integer", "format": "int32" } }, { "name": "take", "in": "query", "required": true, "schema": { "type": "integer", "format": "int32" } } ], "responses": { "200": { "description": "OK" } } } }, "/v1/members/accept-invite": { "post": { "tags": [ "Members" ], "operationId": "AcceptInvite", "requestBody": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/IdentityAccess.Contracts.Requests.AcceptInviteRequest" } } }, "required": true }, "responses": { "200": { "description": "OK" } } } }, "/v1/organizations/{organizationId}/members": { "post": { "tags": [ "Members" ], "operationId": "InviteMember", "parameters": [ { "name": "organizationId", "in": "path", "required": true, "schema": { "type": "string", "format": "uuid" } } ], "requestBody": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/IdentityAccess.Contracts.Requests.InviteMemberRequest" } } }, "required": true }, "responses": { "201": { "description": "Created", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/IdentityAccess.Contracts.Responses.InviteMemberResult" } } } } } }, "get": { "tags": [ "Members" ], "operationId": "ListMembers", "parameters": [ { "name": "organizationId", "in": "path", "required": true, "schema": { "type": "string", "format": "uuid" } } ], "responses": { "200": { "description": "OK", "content": { "application/json": { "schema": { "type": "array", "items": { "$ref": "#/components/schemas/IdentityAccess.Contracts.Responses.MemberResponse" } } } } } } } }, "/v1/members/{memberId}/role": { "post": { "tags": [ "Members" ], "operationId": "AssignMemberRole", "parameters": [ { "name": "memberId", "in": "path", "required": true, "schema": { "type": "string", "format": "uuid" } } ], "requestBody": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/IdentityAccess.Contracts.Requests.AssignRoleRequest" } } }, "required": true }, "responses": { "204": { "description": "No Content" } } } }, "/v1/members/{memberId}/suspend": { "post": { "tags": [ "Members" ], "operationId": "SuspendMember", "parameters": [ { "name": "memberId", "in": "path", "required": true, "schema": { "type": "string", "format": "uuid" } } ], "requestBody": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/IdentityAccess.Contracts.Requests.SuspendMemberRequest" } } }, "required": true }, "responses": { "204": { "description": "No Content" } } } }, "/v1/members/{memberId}/reactivate": { "post": { "tags": [ "Members" ], "operationId": "ReactivateMember", "parameters": [ { "name": "memberId", "in": "path", "required": true, "schema": { "type": "string", "format": "uuid" } } ], "responses": { "204": { "description": "No Content" } } } }, "/v1/members/{memberId}": { "delete": { "tags": [ "Members" ], "operationId": "RemoveMember", "parameters": [ { "name": "memberId", "in": "path", "required": true, "schema": { "type": "string", "format": "uuid" } } ], "responses": { "204": { "description": "No Content" } } } }, "/v1/organizations/{organizationId}/webhook-endpoints": { "post": { "tags": [ "Notifications" ], "operationId": "ConfigureWebhookEndpoint", "parameters": [ { "name": "organizationId", "in": "path", "required": true, "schema": { "type": "string", "format": "uuid" } } ], "requestBody": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Notifications.Contracts.Requests.ConfigureWebhookEndpointRequest" } } }, "required": true }, "responses": { "201": { "description": "Created" } } }, "get": { "tags": [ "Notifications" ], "operationId": "SearchWebhookEndpoints", "parameters": [ { "name": "organizationId", "in": "path", "required": true, "schema": { "type": "string", "format": "uuid" } } ], "responses": { "200": { "description": "OK" } } } }, "/v1/webhook-endpoints/{webhookEndpointId}": { "get": { "tags": [ "Notifications" ], "operationId": "GetWebhookEndpoint", "parameters": [ { "name": "webhookEndpointId", "in": "path", "required": true, "schema": { "type": "string", "format": "uuid" } } ], "responses": { "200": { "description": "OK", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Notifications.Contracts.Responses.WebhookEndpointResponse" } } } }, "404": { "description": "Not Found" } } } }, "/v1/webhook-endpoints/{webhookEndpointId}/rotate-secret": { "post": { "tags": [ "Notifications" ], "operationId": "RotateWebhookEndpointSecret", "parameters": [ { "name": "webhookEndpointId", "in": "path", "required": true, "schema": { "type": "string", "format": "uuid" } } ], "responses": { "200": { "description": "OK" } } } }, "/v1/webhook-endpoints/{webhookEndpointId}/deactivate": { "post": { "tags": [ "Notifications" ], "operationId": "DeactivateWebhookEndpoint", "parameters": [ { "name": "webhookEndpointId", "in": "path", "required": true, "schema": { "type": "string", "format": "uuid" } } ], "responses": { "204": { "description": "No Content" } } } }, "/v1/webhook-endpoints/{webhookEndpointId}/deliveries": { "get": { "tags": [ "Notifications" ], "operationId": "SearchWebhookDeliveries", "parameters": [ { "name": "webhookEndpointId", "in": "path", "required": true, "schema": { "type": "string", "format": "uuid" } }, { "name": "eventType", "in": "query", "schema": { "type": "string" } }, { "name": "status", "in": "query", "schema": { "type": "string" } } ], "responses": { "200": { "description": "OK" } } } }, "/v1/webhook-deliveries/{webhookDeliveryId}": { "get": { "tags": [ "Notifications" ], "operationId": "GetWebhookDelivery", "parameters": [ { "name": "webhookDeliveryId", "in": "path", "required": true, "schema": { "type": "string", "format": "uuid" } } ], "responses": { "200": { "description": "OK", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Notifications.Contracts.Responses.WebhookDeliveryResponse" } } } }, "404": { "description": "Not Found" } } } }, "/v1/webhook-deliveries/{webhookDeliveryId}/redeliver": { "post": { "tags": [ "Notifications" ], "operationId": "RedeliverWebhook", "parameters": [ { "name": "webhookDeliveryId", "in": "path", "required": true, "schema": { "type": "string", "format": "uuid" } } ], "responses": { "201": { "description": "Created" } } } }, "/v1/organizations": { "post": { "tags": [ "Organizations" ], "operationId": "CreateOrganization", "parameters": [ { "name": "Idempotency-Key", "in": "header", "schema": { "type": "string" } } ], "requestBody": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/OrganizationTenancy.Contracts.Requests.CreateOrganizationRequest" } } }, "required": true }, "responses": { "201": { "description": "Created", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/OrganizationTenancy.Contracts.Responses.CreatedResourceResponse" } } } } } } }, "/v1/organizations/{organizationId}": { "get": { "tags": [ "Organizations" ], "operationId": "GetOrganization", "parameters": [ { "name": "organizationId", "in": "path", "required": true, "schema": { "type": "string", "format": "uuid" } } ], "responses": { "200": { "description": "OK", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/OrganizationTenancy.Contracts.Responses.OrganizationResponse" } } } }, "404": { "description": "Not Found" } } } }, "/v1/organizations/{organizationId}/suspend": { "post": { "tags": [ "Organizations" ], "operationId": "SuspendOrganization", "parameters": [ { "name": "organizationId", "in": "path", "required": true, "schema": { "type": "string", "format": "uuid" } } ], "requestBody": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/OrganizationTenancy.Contracts.Requests.SuspendRequest" } } }, "required": true }, "responses": { "204": { "description": "No Content" } } } }, "/v1/organizations/{organizationId}/reactivate": { "post": { "tags": [ "Organizations" ], "operationId": "ReactivateOrganization", "parameters": [ { "name": "organizationId", "in": "path", "required": true, "schema": { "type": "string", "format": "uuid" } } ], "responses": { "204": { "description": "No Content" } } } }, "/v1/organizations/{organizationId}/applications": { "post": { "tags": [ "Organizations" ], "operationId": "CreateApplication", "parameters": [ { "name": "organizationId", "in": "path", "required": true, "schema": { "type": "string", "format": "uuid" } }, { "name": "Idempotency-Key", "in": "header", "schema": { "type": "string" } } ], "requestBody": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/OrganizationTenancy.Contracts.Requests.CreateApplicationRequest" } } }, "required": true }, "responses": { "201": { "description": "Created", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/OrganizationTenancy.Contracts.Responses.CreatedResourceResponse" } } } } } }, "get": { "tags": [ "Organizations" ], "operationId": "ListApplications", "parameters": [ { "name": "organizationId", "in": "path", "required": true, "schema": { "type": "string", "format": "uuid" } } ], "responses": { "200": { "description": "OK", "content": { "application/json": { "schema": { "type": "array", "items": { "$ref": "#/components/schemas/OrganizationTenancy.Contracts.Responses.ApplicationResponse" } } } } } } } }, "/v1/accounts/{accountId}/payable-summary": { "get": { "tags": [ "Payout" ], "operationId": "GetPayableSummary", "parameters": [ { "name": "accountId", "in": "path", "required": true, "schema": { "type": "string", "format": "uuid" } }, { "name": "assetNetworkId", "in": "query", "required": true, "schema": { "type": "string", "format": "uuid" } } ], "responses": { "200": { "description": "OK", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Payout.Contracts.Queries.PayableSummaryResponse" } } } } } } }, "/v1/organizations/{organizationId}/payout-batches": { "post": { "tags": [ "Payout" ], "operationId": "CreatePayoutBatch", "parameters": [ { "name": "organizationId", "in": "path", "required": true, "schema": { "type": "string", "format": "uuid" } } ], "requestBody": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Payout.Contracts.Requests.CreatePayoutBatchRequest" } } }, "required": true }, "responses": { "201": { "description": "Created" }, "204": { "description": "No Content" } } } }, "/v1/organizations/{organizationId}/payout-batches/{payoutBatchId}": { "get": { "tags": [ "Payout" ], "operationId": "GetPayoutBatch", "parameters": [ { "name": "organizationId", "in": "path", "required": true, "schema": { "type": "string", "format": "uuid" } }, { "name": "payoutBatchId", "in": "path", "required": true, "schema": { "type": "string", "format": "uuid" } } ], "responses": { "200": { "description": "OK", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Payout.Contracts.Queries.PayoutBatchResponse" } } } }, "404": { "description": "Not Found" } } } }, "/v1/environments/{environmentId}/sandbox/faucet": { "post": { "tags": [ "Sandbox" ], "operationId": "SandboxFaucet", "parameters": [ { "name": "environmentId", "in": "path", "required": true, "schema": { "type": "string", "format": "uuid" } } ], "requestBody": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Sandbox.Contracts.Requests.FaucetRequest" } } }, "required": true }, "responses": { "201": { "description": "Created" }, "422": { "description": "Unprocessable Content" } } } }, "/v1/environments/{environmentId}/sandbox/simulate-deposit": { "post": { "tags": [ "Sandbox" ], "operationId": "SandboxSimulateDeposit", "parameters": [ { "name": "environmentId", "in": "path", "required": true, "schema": { "type": "string", "format": "uuid" } } ], "requestBody": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Sandbox.Contracts.Requests.SimulateDepositRequest" } } }, "required": true }, "responses": { "201": { "description": "Created" }, "422": { "description": "Unprocessable Content" } } } }, "/v1/environments/{environmentId}/sandbox/simulate-confirmation": { "post": { "tags": [ "Sandbox" ], "operationId": "SandboxSimulateConfirmation", "parameters": [ { "name": "environmentId", "in": "path", "required": true, "schema": { "type": "string", "format": "uuid" } } ], "requestBody": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Sandbox.Contracts.Requests.SimulateConfirmationRequest" } } }, "required": true }, "responses": { "204": { "description": "No Content" }, "422": { "description": "Unprocessable Content" } } } }, "/v1/environments/{environmentId}/sandbox/simulate-broadcast-confirmation": { "post": { "tags": [ "Sandbox" ], "operationId": "SandboxSimulateBroadcastConfirmation", "parameters": [ { "name": "environmentId", "in": "path", "required": true, "schema": { "type": "string", "format": "uuid" } } ], "requestBody": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Sandbox.Contracts.Requests.SimulateBroadcastConfirmationRequest" } } }, "required": true }, "responses": { "204": { "description": "No Content" }, "422": { "description": "Unprocessable Content" } } } }, "/v1/environments/{environmentId}/sandbox/simulate-withdrawal": { "post": { "tags": [ "Sandbox" ], "operationId": "SandboxSimulateWithdrawal", "parameters": [ { "name": "environmentId", "in": "path", "required": true, "schema": { "type": "string", "format": "uuid" } } ], "requestBody": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Sandbox.Contracts.Requests.SimulateWithdrawalRequest" } } }, "required": true }, "responses": { "201": { "description": "Created" }, "422": { "description": "Unprocessable Content" } } } }, "/v1/environments/{environmentId}/sandbox/treasury-balance": { "post": { "tags": [ "Sandbox" ], "operationId": "SandboxSetObservedTreasuryBalance", "parameters": [ { "name": "environmentId", "in": "path", "required": true, "schema": { "type": "string", "format": "uuid" } } ], "requestBody": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Sandbox.Contracts.Requests.SetObservedTreasuryBalanceRequest" } } }, "required": true }, "responses": { "204": { "description": "No Content" }, "422": { "description": "Unprocessable Content" } } } }, "/v1/environments/{environmentId}/sandbox/treasury-balance/{assetNetworkId}": { "get": { "tags": [ "Sandbox" ], "operationId": "GetSandboxObservedTreasuryBalance", "parameters": [ { "name": "environmentId", "in": "path", "required": true, "schema": { "type": "string", "format": "uuid" } }, { "name": "assetNetworkId", "in": "path", "required": true, "schema": { "type": "string", "format": "uuid" } } ], "responses": { "200": { "description": "OK", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Sandbox.Contracts.Responses.SandboxTreasuryObservedBalanceResponse" } } } }, "404": { "description": "Not Found" } } } }, "/v1/environments/{environmentId}/sandbox/wallet-balance/credit": { "post": { "tags": [ "Sandbox" ], "operationId": "SandboxCreditWalletBalance", "parameters": [ { "name": "environmentId", "in": "path", "required": true, "schema": { "type": "string", "format": "uuid" } } ], "requestBody": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Sandbox.Contracts.Requests.CreditSandboxWalletBalanceRequest" } } }, "required": true }, "responses": { "200": { "description": "OK", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Sandbox.Contracts.Responses.SandboxWalletBalanceResponse" } } } }, "422": { "description": "Unprocessable Content" } } } }, "/v1/environments/{environmentId}/sandbox/wallet-balance/transfer": { "post": { "tags": [ "Sandbox" ], "operationId": "SandboxTransferWalletBalance", "parameters": [ { "name": "environmentId", "in": "path", "required": true, "schema": { "type": "string", "format": "uuid" } } ], "requestBody": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Sandbox.Contracts.Requests.TransferSandboxWalletBalanceRequest" } } }, "required": true }, "responses": { "200": { "description": "OK", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Sandbox.Contracts.Responses.SandboxWalletTransferResponse" } } } }, "422": { "description": "Unprocessable Content" } } } }, "/v1/environments/{environmentId}/sandbox/wallet-balance": { "get": { "tags": [ "Sandbox" ], "operationId": "GetSandboxWalletBalance", "parameters": [ { "name": "environmentId", "in": "path", "required": true, "schema": { "type": "string", "format": "uuid" } }, { "name": "assetNetworkId", "in": "query", "required": true, "schema": { "type": "string", "format": "uuid" } }, { "name": "address", "in": "query", "required": true, "schema": { "type": "string" } } ], "responses": { "200": { "description": "OK", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Sandbox.Contracts.Responses.SandboxWalletBalanceResponse" } } } }, "422": { "description": "Unprocessable Content" } } } }, "/v1/environments/{environmentId}/sandbox/observed-addresses/{id}": { "get": { "tags": [ "Sandbox" ], "operationId": "GetSandboxObservedAddress", "parameters": [ { "name": "environmentId", "in": "path", "required": true, "schema": { "type": "string", "format": "uuid" } }, { "name": "id", "in": "path", "required": true, "schema": { "type": "string", "format": "uuid" } } ], "responses": { "200": { "description": "OK", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Sandbox.Contracts.Responses.SandboxObservedAddressResponse" } } } }, "404": { "description": "Not Found" } } } }, "/v1/environments/{environmentId}/sandbox/broadcast-attempts/{id}": { "get": { "tags": [ "Sandbox" ], "operationId": "GetSandboxBroadcastAttempt", "parameters": [ { "name": "environmentId", "in": "path", "required": true, "schema": { "type": "string", "format": "uuid" } }, { "name": "id", "in": "path", "required": true, "schema": { "type": "string", "format": "uuid" } } ], "responses": { "200": { "description": "OK", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Sandbox.Contracts.Responses.SandboxBroadcastAttemptResponse" } } } }, "404": { "description": "Not Found" } } } }, "/v1/transactions/{transactionId}/settlements": { "post": { "tags": [ "Settlement" ], "operationId": "ExecuteSettlement", "parameters": [ { "name": "transactionId", "in": "path", "required": true, "schema": { "type": "string", "format": "uuid" } } ], "requestBody": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Settlement.Contracts.Requests.ExecuteSettlementRequest" } } }, "required": true }, "responses": { "201": { "description": "Created" } } }, "get": { "tags": [ "Settlement" ], "operationId": "SearchSettlements", "parameters": [ { "name": "transactionId", "in": "path", "required": true, "schema": { "type": "string", "format": "uuid" } } ], "responses": { "200": { "description": "OK" } } } }, "/v1/settlements/{settlementId}": { "get": { "tags": [ "Settlement" ], "operationId": "GetSettlement", "parameters": [ { "name": "settlementId", "in": "path", "required": true, "schema": { "type": "string", "format": "uuid" } } ], "responses": { "200": { "description": "OK", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Settlement.Contracts.Responses.SettlementResponse" } } } }, "404": { "description": "Not Found" } } } }, "/v1/settlements/{settlementId}/split-allocations/{allocationId}/release": { "post": { "tags": [ "Settlement" ], "operationId": "ReleaseRetainedSplit", "parameters": [ { "name": "settlementId", "in": "path", "required": true, "schema": { "type": "string", "format": "uuid" } }, { "name": "allocationId", "in": "path", "required": true, "schema": { "type": "string", "format": "uuid" } } ], "requestBody": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Settlement.Contracts.Requests.ReleaseRetainedSplitRequest" } } }, "required": true }, "responses": { "204": { "description": "No Content" } } } }, "/v1/transactions/{transactionId}/refunds": { "post": { "tags": [ "Settlement" ], "operationId": "ExecuteRefund", "parameters": [ { "name": "transactionId", "in": "path", "required": true, "schema": { "type": "string", "format": "uuid" } } ], "requestBody": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Settlement.Contracts.Requests.ExecuteRefundRequest" } } }, "required": true }, "responses": { "201": { "description": "Created" } } }, "get": { "tags": [ "Settlement" ], "operationId": "SearchRefunds", "parameters": [ { "name": "transactionId", "in": "path", "required": true, "schema": { "type": "string", "format": "uuid" } } ], "responses": { "200": { "description": "OK" } } } }, "/v1/refunds/{refundId}": { "get": { "tags": [ "Settlement" ], "operationId": "GetRefund", "parameters": [ { "name": "refundId", "in": "path", "required": true, "schema": { "type": "string", "format": "uuid" } } ], "responses": { "200": { "description": "OK", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Settlement.Contracts.Responses.RefundResponse" } } } }, "404": { "description": "Not Found" } } } }, "/v1/transactions/{transactionId}/settlement-summary": { "get": { "tags": [ "Settlement" ], "operationId": "GetTransactionSettlementSummary", "parameters": [ { "name": "transactionId", "in": "path", "required": true, "schema": { "type": "string", "format": "uuid" } } ], "responses": { "200": { "description": "OK" } } } }, "/v1/organizations/{organizationId}/transactions": { "post": { "tags": [ "Transactions" ], "operationId": "CreateTransaction", "parameters": [ { "name": "organizationId", "in": "path", "required": true, "schema": { "type": "string", "format": "uuid" } } ], "requestBody": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Transactions.Contracts.Requests.CreateTransactionRequest" } } }, "required": true }, "responses": { "201": { "description": "Created" } } } }, "/v1/organizations/{organizationId}/executions": { "get": { "tags": [ "Transactions" ], "operationId": "SearchExecutions", "parameters": [ { "name": "organizationId", "in": "path", "required": true, "schema": { "type": "string", "format": "uuid" } }, { "name": "status", "in": "query", "schema": { "$ref": "#/components/schemas/Transactions.Contracts.Enums.ExecutionStatus" } }, { "name": "transactionId", "in": "query", "schema": { "type": "string", "format": "uuid" } }, { "name": "settlementId", "in": "query", "schema": { "type": "string", "format": "uuid" } }, { "name": "from", "in": "query", "schema": { "type": "string", "format": "date-time" } }, { "name": "to", "in": "query", "schema": { "type": "string", "format": "date-time" } }, { "name": "skip", "in": "query", "required": true, "schema": { "type": "integer", "format": "int32" } }, { "name": "take", "in": "query", "required": true, "schema": { "type": "integer", "format": "int32" } } ], "responses": { "200": { "description": "OK", "content": { "application/json": { "schema": { "type": "array", "items": { "$ref": "#/components/schemas/Transactions.Contracts.Responses.ExecutionResponse" } } } } } } } }, "/v1/transactions/{transactionId}": { "get": { "tags": [ "Transactions" ], "operationId": "GetTransaction", "parameters": [ { "name": "transactionId", "in": "path", "required": true, "schema": { "type": "string", "format": "uuid" } } ], "responses": { "200": { "description": "OK", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Transactions.Contracts.Responses.TransactionResponse" } } } }, "404": { "description": "Not Found" } } } }, "/v1/transactions/{transactionId}/state": { "get": { "tags": [ "Transactions" ], "operationId": "GetTransactionState", "parameters": [ { "name": "transactionId", "in": "path", "required": true, "schema": { "type": "string", "format": "uuid" } } ], "responses": { "200": { "description": "OK", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Transactions.Contracts.Responses.TransactionStateResponse" } } } }, "404": { "description": "Not Found" } } } }, "/v1/transactions/{transactionId}/reserve": { "post": { "tags": [ "Transactions" ], "operationId": "ReserveTransactionBalance", "parameters": [ { "name": "transactionId", "in": "path", "required": true, "schema": { "type": "string", "format": "uuid" } } ], "responses": { "200": { "description": "OK" } } } }, "/v1/transactions/{transactionId}/cancel": { "post": { "tags": [ "Transactions" ], "operationId": "CancelTransaction", "parameters": [ { "name": "transactionId", "in": "path", "required": true, "schema": { "type": "string", "format": "uuid" } } ], "requestBody": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Transactions.Contracts.Requests.CancelTransactionRequest" } } }, "required": true }, "responses": { "204": { "description": "No Content" } } } }, "/v1/transactions/{transactionId}/freeze": { "post": { "tags": [ "Transactions" ], "operationId": "FreezeTransaction", "parameters": [ { "name": "transactionId", "in": "path", "required": true, "schema": { "type": "string", "format": "uuid" } } ], "requestBody": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Transactions.Contracts.Requests.FreezeTransactionRequest" } } }, "required": true }, "responses": { "204": { "description": "No Content" } } } }, "/v1/transactions/{transactionId}/unfreeze": { "post": { "tags": [ "Transactions" ], "operationId": "UnfreezeTransaction", "parameters": [ { "name": "transactionId", "in": "path", "required": true, "schema": { "type": "string", "format": "uuid" } } ], "responses": { "204": { "description": "No Content" } } } }, "/v1/accounts/{accountId}/wallet-balances": { "get": { "tags": [ "WalletBalance" ], "operationId": "GetWalletBalance", "parameters": [ { "name": "accountId", "in": "path", "required": true, "schema": { "type": "string", "format": "uuid" } }, { "name": "environmentId", "in": "query", "required": true, "schema": { "type": "string", "format": "uuid" } }, { "name": "assetNetworkId", "in": "query", "required": true, "schema": { "type": "string", "format": "uuid" } } ], "responses": { "200": { "description": "OK" } } } }, "/v1/accounts/{accountId}/wallet-balances/refresh": { "post": { "tags": [ "WalletBalance" ], "operationId": "RefreshWalletBalance", "parameters": [ { "name": "accountId", "in": "path", "required": true, "schema": { "type": "string", "format": "uuid" } }, { "name": "environmentId", "in": "query", "required": true, "schema": { "type": "string", "format": "uuid" } }, { "name": "assetNetworkId", "in": "query", "required": true, "schema": { "type": "string", "format": "uuid" } } ], "responses": { "200": { "description": "OK" } } } }, "/v1/accounts/{accountId}/wallet-balances/aggregate": { "get": { "tags": [ "WalletBalance" ], "operationId": "GetWalletAssetBalances", "parameters": [ { "name": "accountId", "in": "path", "required": true, "schema": { "type": "string", "format": "uuid" } }, { "name": "environmentId", "in": "query", "required": true, "schema": { "type": "string", "format": "uuid" } }, { "name": "assetNetworkIds", "in": "query", "required": true, "schema": { "type": "string" } } ], "responses": { "200": { "description": "OK" } } } }, "/v1/organizations/{organizationId}/withdrawal-destinations": { "post": { "tags": [ "Withdrawals" ], "operationId": "CreateWithdrawalDestination", "parameters": [ { "name": "organizationId", "in": "path", "required": true, "schema": { "type": "string", "format": "uuid" } } ], "requestBody": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Withdrawals.Contracts.Requests.CreateWithdrawalDestinationRequest" } } }, "required": true }, "responses": { "201": { "description": "Created" } } } }, "/v1/organizations/{organizationId}/withdrawals": { "post": { "tags": [ "Withdrawals" ], "operationId": "RequestWithdrawal", "parameters": [ { "name": "organizationId", "in": "path", "required": true, "schema": { "type": "string", "format": "uuid" } } ], "requestBody": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Withdrawals.Contracts.Requests.RequestWithdrawalRequest" } } }, "required": true }, "responses": { "201": { "description": "Created" } } }, "get": { "tags": [ "Withdrawals" ], "operationId": "SearchWithdrawals", "parameters": [ { "name": "organizationId", "in": "path", "required": true, "schema": { "type": "string", "format": "uuid" } }, { "name": "status", "in": "query", "schema": { "$ref": "#/components/schemas/Withdrawals.Contracts.Enums.WithdrawalStatus" } }, { "name": "from", "in": "query", "schema": { "type": "string", "format": "date-time" } }, { "name": "to", "in": "query", "schema": { "type": "string", "format": "date-time" } }, { "name": "skip", "in": "query", "required": true, "schema": { "type": "integer", "format": "int32" } }, { "name": "take", "in": "query", "required": true, "schema": { "type": "integer", "format": "int32" } } ], "responses": { "200": { "description": "OK" } } } }, "/v1/organizations/{organizationId}/withdrawals/quote": { "post": { "tags": [ "Withdrawals" ], "operationId": "GetWithdrawalQuote", "parameters": [ { "name": "organizationId", "in": "path", "required": true, "schema": { "type": "string", "format": "uuid" } } ], "requestBody": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Withdrawals.Contracts.Requests.WithdrawalQuoteRequest" } } }, "required": true }, "responses": { "200": { "description": "OK", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Withdrawals.Contracts.Responses.WithdrawalQuoteResponse" } } } } } } }, "/v1/withdrawals/{withdrawalId}": { "get": { "tags": [ "Withdrawals" ], "operationId": "GetWithdrawal", "parameters": [ { "name": "withdrawalId", "in": "path", "required": true, "schema": { "type": "string", "format": "uuid" } } ], "responses": { "200": { "description": "OK", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Withdrawals.Contracts.Responses.WithdrawalResponse" } } } }, "404": { "description": "Not Found" } } } }, "/v1/withdrawals/{withdrawalId}/cancel": { "post": { "tags": [ "Withdrawals" ], "operationId": "CancelWithdrawal", "parameters": [ { "name": "withdrawalId", "in": "path", "required": true, "schema": { "type": "string", "format": "uuid" } } ], "requestBody": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Withdrawals.Contracts.Requests.CancelWithdrawalRequest" } } }, "required": true }, "responses": { "204": { "description": "No Content" } } } }, "/v1/withdrawals/{withdrawalId}/retry-broadcast": { "post": { "tags": [ "Withdrawals" ], "operationId": "RetryWithdrawalBroadcast", "parameters": [ { "name": "withdrawalId", "in": "path", "required": true, "schema": { "type": "string", "format": "uuid" } } ], "responses": { "204": { "description": "No Content" } } } }, "/v1/organizations/{organizationId}/workflows": { "post": { "tags": [ "WorkflowRules" ], "operationId": "CreateWorkflow", "parameters": [ { "name": "organizationId", "in": "path", "required": true, "schema": { "type": "string", "format": "uuid" } } ], "requestBody": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/WorkflowRules.Contracts.Requests.CreateWorkflowRequest" } } }, "required": true }, "responses": { "201": { "description": "Created" } } }, "get": { "tags": [ "WorkflowRules" ], "operationId": "ListWorkflowsByOrganization", "parameters": [ { "name": "organizationId", "in": "path", "required": true, "schema": { "type": "string", "format": "uuid" } } ], "responses": { "200": { "description": "OK", "content": { "application/json": { "schema": { "type": "array", "items": { "$ref": "#/components/schemas/WorkflowRules.Contracts.Responses.WorkflowResponse" } } } } } } } }, "/v1/workflows/{workflowId}": { "get": { "tags": [ "WorkflowRules" ], "operationId": "GetWorkflow", "parameters": [ { "name": "workflowId", "in": "path", "required": true, "schema": { "type": "string", "format": "uuid" } } ], "responses": { "200": { "description": "OK", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/WorkflowRules.Contracts.Responses.WorkflowResponse" } } } }, "404": { "description": "Not Found" } } } }, "/v1/workflows/{workflowId}/versions": { "post": { "tags": [ "WorkflowRules" ], "operationId": "CreateWorkflowVersion", "parameters": [ { "name": "workflowId", "in": "path", "required": true, "schema": { "type": "string", "format": "uuid" } } ], "requestBody": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/WorkflowRules.Contracts.Requests.CreateWorkflowVersionRequest" } } }, "required": true }, "responses": { "201": { "description": "Created" } } } }, "/v1/workflows/{workflowId}/versions/{workflowVersionId}": { "get": { "tags": [ "WorkflowRules" ], "operationId": "GetWorkflowVersion", "parameters": [ { "name": "workflowId", "in": "path", "required": true, "schema": { "type": "string", "format": "uuid" } }, { "name": "workflowVersionId", "in": "path", "required": true, "schema": { "type": "string", "format": "uuid" } } ], "responses": { "200": { "description": "OK", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/WorkflowRules.Contracts.Responses.WorkflowVersionResponse" } } } }, "404": { "description": "Not Found" } } } }, "/v1/workflows/{workflowId}/versions/{workflowVersionId}/publish": { "post": { "tags": [ "WorkflowRules" ], "operationId": "PublishWorkflowVersion", "parameters": [ { "name": "workflowId", "in": "path", "required": true, "schema": { "type": "string", "format": "uuid" } }, { "name": "workflowVersionId", "in": "path", "required": true, "schema": { "type": "string", "format": "uuid" } } ], "responses": { "204": { "description": "No Content" } } } }, "/v1/workflows/{workflowId}/versions/{workflowVersionId}/rules": { "post": { "tags": [ "WorkflowRules" ], "operationId": "CreateRule", "parameters": [ { "name": "workflowId", "in": "path", "required": true, "schema": { "type": "string", "format": "uuid" } }, { "name": "workflowVersionId", "in": "path", "required": true, "schema": { "type": "string", "format": "uuid" } } ], "requestBody": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/WorkflowRules.Contracts.Requests.CreateRuleRequest" } } }, "required": true }, "responses": { "201": { "description": "Created" } } } }, "/v1/organizations/{organizationId}/event-types": { "post": { "tags": [ "WorkflowRules" ], "operationId": "CreateEventType", "parameters": [ { "name": "organizationId", "in": "path", "required": true, "schema": { "type": "string", "format": "uuid" } } ], "requestBody": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/WorkflowRules.Contracts.Requests.CreateEventTypeRequest" } } }, "required": true }, "responses": { "201": { "description": "Created" } } }, "get": { "tags": [ "WorkflowRules" ], "operationId": "ListEventTypes", "parameters": [ { "name": "organizationId", "in": "path", "required": true, "schema": { "type": "string", "format": "uuid" } } ], "responses": { "200": { "description": "OK", "content": { "application/json": { "schema": { "type": "array", "items": { "$ref": "#/components/schemas/WorkflowRules.Contracts.Responses.EventTypeResponse" } } } } } } } }, "/v1/applications/{applicationId}/events": { "post": { "tags": [ "WorkflowRules" ], "operationId": "IngestEvent", "parameters": [ { "name": "applicationId", "in": "path", "required": true, "schema": { "type": "string", "format": "uuid" } } ], "requestBody": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/WorkflowRules.Contracts.Requests.IngestEventRequest" } } }, "required": true }, "responses": { "200": { "description": "OK", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/WorkflowRules.Contracts.Responses.EventIngestionResult" } } } }, "404": { "description": "Not Found" }, "422": { "description": "Unprocessable Content" } } } } }, "components": { "schemas": { "Accounts.Contracts.Commands.ClaimAccountHolderInvitationResult": { "type": "object", "properties": { "success": { "type": "boolean" }, "relationshipId": { "type": "string", "format": "uuid", "nullable": true }, "errorCode": { "type": "string", "nullable": true } }, "additionalProperties": false }, "Accounts.Contracts.Commands.CreateAccountHolderInvitationResult": { "type": "object", "properties": { "invitationId": { "type": "string", "format": "uuid" }, "plainTextToken": { "type": "string", "nullable": true }, "expiresAt": { "type": "string", "format": "date-time" } }, "additionalProperties": false }, "Accounts.Contracts.Commands.SignUpAndClaimAccountHolderInvitationResult": { "type": "object", "properties": { "success": { "type": "boolean" }, "relationshipId": { "type": "string", "format": "uuid", "nullable": true }, "token": { "$ref": "#/components/schemas/Accounts.Contracts.Responses.TokenResult" }, "errorCode": { "type": "string", "nullable": true } }, "additionalProperties": false }, "Accounts.Contracts.Requests.AuthorizeApplicationRequest": { "type": "object", "properties": { "applicationId": { "type": "string", "format": "uuid" } }, "additionalProperties": false }, "Accounts.Contracts.Requests.ClaimAccountHolderInvitationRequest": { "type": "object", "properties": { "plainTextToken": { "type": "string", "nullable": true } }, "additionalProperties": false }, "Accounts.Contracts.Requests.CreateAccountHolderInvitationRequest": { "type": "object", "properties": { "externalId": { "type": "string", "nullable": true } }, "additionalProperties": false }, "Accounts.Contracts.Requests.CreateAccountRequest": { "type": "object", "properties": { "externalId": { "type": "string", "nullable": true } }, "additionalProperties": false }, "Accounts.Contracts.Requests.FreezeAccountRequest": { "type": "object", "properties": { "reason": { "type": "string", "nullable": true } }, "additionalProperties": false }, "Accounts.Contracts.Requests.LoginAccountHolderRequest": { "type": "object", "properties": { "email": { "type": "string", "nullable": true }, "password": { "type": "string", "nullable": true } }, "additionalProperties": false }, "Accounts.Contracts.Requests.SignUpAccountHolderRequest": { "type": "object", "properties": { "email": { "type": "string", "nullable": true }, "password": { "type": "string", "nullable": true } }, "additionalProperties": false }, "Accounts.Contracts.Requests.SignUpAndClaimAccountHolderInvitationRequest": { "type": "object", "properties": { "plainTextToken": { "type": "string", "nullable": true }, "email": { "type": "string", "nullable": true }, "password": { "type": "string", "nullable": true } }, "additionalProperties": false }, "Accounts.Contracts.Responses.AccountHolderResponse": { "type": "object", "properties": { "accountHolderId": { "type": "string", "format": "uuid" }, "accountId": { "type": "string", "format": "uuid" }, "email": { "type": "string", "nullable": true }, "hasCredentials": { "type": "boolean" }, "status": { "type": "string", "nullable": true }, "createdAt": { "type": "string", "format": "date-time" }, "lastLoginAt": { "type": "string", "format": "date-time", "nullable": true } }, "additionalProperties": false }, "Accounts.Contracts.Responses.AccountResponse": { "type": "object", "properties": { "accountId": { "type": "string", "format": "uuid" }, "accountHolderId": { "type": "string", "format": "uuid" }, "status": { "type": "string", "nullable": true }, "createdAt": { "type": "string", "format": "date-time" } }, "additionalProperties": false }, "Accounts.Contracts.Responses.OrganizationAccountResponse": { "type": "object", "properties": { "relationshipId": { "type": "string", "format": "uuid" }, "accountId": { "type": "string", "format": "uuid" }, "accountHolderId": { "type": "string", "format": "uuid" }, "externalId": { "type": "string", "nullable": true }, "relationshipStatus": { "type": "string", "nullable": true }, "accountStatus": { "type": "string", "nullable": true }, "createdAt": { "type": "string", "format": "date-time" }, "authorizedApplicationIds": { "type": "array", "items": { "type": "string", "format": "uuid" }, "nullable": true } }, "additionalProperties": false }, "Accounts.Contracts.Responses.TokenResult": { "type": "object", "properties": { "success": { "type": "boolean" }, "accessToken": { "type": "string", "nullable": true }, "expiresAt": { "type": "string", "format": "date-time", "nullable": true }, "errorCode": { "type": "string", "nullable": true } }, "additionalProperties": false }, "AdministrationAudit.Contracts.Commands.AdminConfigureNetworkExecutionMarginPolicyCommand": { "type": "object", "properties": { "marginPercentage": { "type": "number", "format": "double" } }, "additionalProperties": false }, "AdministrationAudit.Contracts.Commands.AdminConfigurePricingPolicyCommand": { "type": "object", "properties": { "organizationId": { "type": "string", "format": "uuid", "nullable": true }, "feePercentage": { "type": "number", "format": "double" }, "platformRevenueAccountId": { "type": "string", "format": "uuid", "nullable": true }, "minimumFeeAmount": { "type": "number", "format": "double", "nullable": true } }, "additionalProperties": false }, "AdministrationAudit.Contracts.Commands.AdminConfigureRefundFeePolicyCommand": { "type": "object", "properties": { "organizationId": { "type": "string", "format": "uuid", "nullable": true }, "mode": { "$ref": "#/components/schemas/AdministrationAudit.Contracts.Enums.RefundFeePolicyMode" } }, "additionalProperties": false }, "AdministrationAudit.Contracts.Commands.AdminConfigureReplenishmentRouteCommand": { "type": "object", "properties": { "targetAssetNetworkId": { "type": "string", "format": "uuid" }, "sourceAssetNetworkId": { "type": "string", "format": "uuid" }, "providerIdentifier": { "type": "string", "nullable": true }, "maxSlippageBps": { "type": "integer", "format": "int32" }, "batchSourceAmount": { "type": "number", "format": "double" } }, "additionalProperties": false }, "AdministrationAudit.Contracts.Commands.AdminConfigureResourceReservePolicyCommand": { "type": "object", "properties": { "assetNetworkId": { "type": "string", "format": "uuid" }, "targetReserve": { "type": "number", "format": "double" }, "warningThreshold": { "type": "number", "format": "double" }, "criticalThreshold": { "type": "number", "format": "double" }, "minimumOperationalReserve": { "type": "number", "format": "double" }, "replenishmentThreshold": { "type": "number", "format": "double" }, "growthMode": { "$ref": "#/components/schemas/ExecutionCustody.Contracts.Enums.ReserveGrowthMode" }, "growthRate": { "type": "number", "format": "double" } }, "additionalProperties": false }, "AdministrationAudit.Contracts.Commands.AdminConfigureTreasuryLiquidityPolicyCommand": { "type": "object", "properties": { "assetNetworkId": { "type": "string", "format": "uuid" }, "enabled": { "type": "boolean" }, "hotWalletTargetMin": { "type": "number", "format": "double" }, "hotWalletTargetMax": { "type": "number", "format": "double" }, "sweepMinimumAmount": { "type": "number", "format": "double" }, "forceSweepThreshold": { "type": "number", "format": "double" }, "maxSweepNetworkFee": { "type": "number", "format": "double", "nullable": true } }, "additionalProperties": false }, "AdministrationAudit.Contracts.Commands.AdminConfigureTronResourceCostTableCommand": { "type": "object", "properties": { "resourceAssetNetworkId": { "type": "string", "format": "uuid" }, "energyPerTrc20Transfer": { "type": "integer", "format": "int64" }, "bandwidthPerSignedTx": { "type": "integer", "format": "int64" }, "trxPerEnergyUnit": { "type": "number", "format": "double" }, "trxPerBandwidthUnit": { "type": "number", "format": "double" }, "fxTrxToChargeAsset": { "type": "number", "format": "double" } }, "additionalProperties": false }, "AdministrationAudit.Contracts.Commands.AdminEntryLine": { "type": "object", "properties": { "ownerType": { "$ref": "#/components/schemas/AdministrationAudit.Contracts.Enums.LedgerAccountOwnerType" }, "ownerId": { "type": "string", "format": "uuid" }, "assetNetworkId": { "type": "string", "format": "uuid" }, "nature": { "$ref": "#/components/schemas/AdministrationAudit.Contracts.Enums.EntryNature" }, "amount": { "type": "number", "format": "double" }, "organizationId": { "type": "string", "format": "uuid" } }, "additionalProperties": false }, "AdministrationAudit.Contracts.Commands.AdminExecuteSandboxSweepCommand": { "type": "object", "properties": { "assetNetworkId": { "type": "string", "format": "uuid" }, "sourceControlledAddressId": { "type": "string", "format": "uuid" }, "destinationControlledAddressId": { "type": "string", "format": "uuid" }, "amount": { "type": "number", "format": "double" }, "reason": { "$ref": "#/components/schemas/AdministrationAudit.Contracts.Enums.TreasurySweepReason" }, "idempotencyKey": { "type": "string", "nullable": true } }, "additionalProperties": false }, "AdministrationAudit.Contracts.Commands.AdminRegisterControlledAddressCommand": { "type": "object", "properties": { "assetNetworkId": { "type": "string", "format": "uuid" }, "address": { "type": "string", "nullable": true }, "addressType": { "$ref": "#/components/schemas/AdministrationAudit.Contracts.Enums.ControlledAddressType" } }, "additionalProperties": false }, "AdministrationAudit.Contracts.Commands.AdminRegisterGlobalRevenueAccountExecutionDestinationCommand": { "type": "object", "properties": { "assetNetworkId": { "type": "string", "format": "uuid" }, "address": { "type": "string", "nullable": true } }, "additionalProperties": false }, "AdministrationAudit.Contracts.Commands.AdminSeedNetworkResourceReserveCommand": { "type": "object", "properties": { "assetNetworkId": { "type": "string", "format": "uuid" }, "amount": { "type": "number", "format": "double" }, "notes": { "type": "string", "nullable": true }, "idempotencyKey": { "type": "string", "nullable": true } }, "additionalProperties": false }, "AdministrationAudit.Contracts.Commands.RecordAdministrativeLedgerCorrectionCommand": { "type": "object", "properties": { "entries": { "type": "array", "items": { "$ref": "#/components/schemas/AdministrationAudit.Contracts.Commands.AdminEntryLine" }, "nullable": true }, "reversalOfEntryGroupId": { "type": "string", "format": "uuid", "nullable": true }, "reason": { "type": "string", "nullable": true }, "idempotencyKey": { "type": "string", "nullable": true } }, "additionalProperties": false }, "AdministrationAudit.Contracts.Enums.ControlledAddressType": { "enum": [ 0, 1, 2 ], "type": "integer", "format": "int32" }, "AdministrationAudit.Contracts.Enums.DepositReorgResolution": { "enum": [ 0, 1, 2 ], "type": "integer", "format": "int32" }, "AdministrationAudit.Contracts.Enums.EntryNature": { "enum": [ 0, 1, 2 ], "type": "integer", "format": "int32" }, "AdministrationAudit.Contracts.Enums.LedgerAccountOwnerType": { "enum": [ 0, 1, 2 ], "type": "integer", "format": "int32" }, "AdministrationAudit.Contracts.Enums.ReconciliationResolutionAction": { "enum": [ 0, 1 ], "type": "integer", "format": "int32" }, "AdministrationAudit.Contracts.Enums.RefundFeePolicyMode": { "enum": [ 0, 1 ], "type": "integer", "format": "int32" }, "AdministrationAudit.Contracts.Enums.SupportedPayoutPolicyMode": { "enum": [ 0, 3 ], "type": "integer", "format": "int32" }, "AdministrationAudit.Contracts.Enums.TreasurySweepReason": { "enum": [ 0, 1, 2 ], "type": "integer", "format": "int32" }, "AdministrationAudit.Contracts.Requests.AdminBlockWithdrawalDestinationRequest": { "type": "object", "properties": { "reason": { "type": "string", "nullable": true } }, "additionalProperties": false }, "AdministrationAudit.Contracts.Requests.AdminConfigurePayoutPolicyRequest": { "type": "object", "properties": { "assetNetworkId": { "type": "string", "format": "uuid" }, "mode": { "$ref": "#/components/schemas/AdministrationAudit.Contracts.Enums.SupportedPayoutPolicyMode" } }, "additionalProperties": false }, "AdministrationAudit.Contracts.Requests.AdminConfigureWithdrawalPolicyRequest": { "type": "object", "properties": { "whitelistEnabled": { "type": "boolean" }, "cooldownHours": { "type": "integer", "format": "int32" }, "destinationChangeCooldownHours": { "type": "integer", "format": "int32" }, "approvalThresholdAmount": { "type": "number", "format": "double", "nullable": true } }, "additionalProperties": false }, "AdministrationAudit.Contracts.Requests.AdminRejectWithdrawalRequest": { "type": "object", "properties": { "reason": { "type": "string", "nullable": true } }, "additionalProperties": false }, "AdministrationAudit.Contracts.Requests.AdminResolveDepositReorgRequest": { "type": "object", "properties": { "resolution": { "$ref": "#/components/schemas/AdministrationAudit.Contracts.Enums.DepositReorgResolution" }, "reason": { "type": "string", "nullable": true } }, "additionalProperties": false }, "AdministrationAudit.Contracts.Requests.AdminResolveDepositUnderReviewRequest": { "type": "object", "properties": { "approve": { "type": "boolean" }, "reason": { "type": "string", "nullable": true } }, "additionalProperties": false }, "AdministrationAudit.Contracts.Requests.AdminResolveReconciliationDivergenceRequest": { "type": "object", "properties": { "action": { "$ref": "#/components/schemas/AdministrationAudit.Contracts.Enums.ReconciliationResolutionAction" }, "entryLines": { "type": "array", "items": { "$ref": "#/components/schemas/AdministrationAudit.Contracts.Commands.AdminEntryLine" }, "nullable": true }, "notes": { "type": "string", "nullable": true } }, "additionalProperties": false }, "AdministrationAudit.Contracts.Responses.AuditLogEntryResponse": { "type": "object", "properties": { "auditLogEntryId": { "type": "string", "format": "uuid" }, "occurredAt": { "type": "string", "format": "date-time" }, "actorType": { "type": "string", "nullable": true }, "actorReference": { "type": "string", "nullable": true }, "actionType": { "type": "string", "nullable": true }, "entityType": { "type": "string", "nullable": true }, "entityId": { "type": "string", "format": "uuid" }, "organizationId": { "type": "string", "format": "uuid", "nullable": true }, "details": { "type": "string", "nullable": true } }, "additionalProperties": false }, "AssetNetworkCatalog.Contracts.Enums.AssetKind": { "enum": [ 1, 2 ], "type": "integer", "format": "int32" }, "AssetNetworkCatalog.Contracts.Enums.AssetNetworkStatus": { "enum": [ 1, 2, 3 ], "type": "integer", "format": "int32" }, "AssetNetworkCatalog.Contracts.Requests.CreateAssetNetworkRequest": { "type": "object", "properties": { "assetId": { "type": "string", "format": "uuid" }, "networkId": { "type": "string", "format": "uuid" }, "minConfirmations": { "type": "integer", "format": "int32" }, "minAmount": { "type": "number", "format": "double", "nullable": true }, "maxAmount": { "type": "number", "format": "double", "nullable": true }, "estimatedFee": { "type": "number", "format": "double", "nullable": true }, "contractAddress": { "type": "string", "nullable": true } }, "additionalProperties": false }, "AssetNetworkCatalog.Contracts.Requests.CreateAssetRequest": { "type": "object", "properties": { "symbol": { "type": "string", "nullable": true }, "name": { "type": "string", "nullable": true }, "decimals": { "type": "integer", "format": "int32" }, "kind": { "$ref": "#/components/schemas/AssetNetworkCatalog.Contracts.Enums.AssetKind" } }, "additionalProperties": false }, "AssetNetworkCatalog.Contracts.Requests.CreateNetworkRequest": { "type": "object", "properties": { "code": { "type": "string", "nullable": true }, "name": { "type": "string", "nullable": true }, "chainId": { "type": "integer", "format": "int32", "nullable": true }, "isTestnet": { "type": "boolean" } }, "additionalProperties": false }, "AssetNetworkCatalog.Contracts.Requests.PauseAssetNetworkRequest": { "type": "object", "properties": { "reason": { "type": "string", "nullable": true } }, "additionalProperties": false }, "AssetNetworkCatalog.Contracts.Responses.AssetNetworkResponse": { "type": "object", "properties": { "assetNetworkId": { "type": "string", "format": "uuid" }, "assetId": { "type": "string", "format": "uuid" }, "networkId": { "type": "string", "format": "uuid" }, "minConfirmations": { "type": "integer", "format": "int32" }, "minAmount": { "type": "number", "format": "double", "nullable": true }, "maxAmount": { "type": "number", "format": "double", "nullable": true }, "estimatedFee": { "type": "number", "format": "double", "nullable": true }, "contractAddress": { "type": "string", "nullable": true }, "status": { "type": "string", "nullable": true }, "createdAt": { "type": "string", "format": "date-time" } }, "additionalProperties": false }, "AssetNetworkCatalog.Contracts.Responses.AssetResponse": { "type": "object", "properties": { "assetId": { "type": "string", "format": "uuid" }, "symbol": { "type": "string", "nullable": true }, "name": { "type": "string", "nullable": true }, "decimals": { "type": "integer", "format": "int32" }, "kind": { "type": "string", "nullable": true }, "status": { "type": "string", "nullable": true }, "createdAt": { "type": "string", "format": "date-time" } }, "additionalProperties": false }, "AssetNetworkCatalog.Contracts.Responses.NetworkResponse": { "type": "object", "properties": { "networkId": { "type": "string", "format": "uuid" }, "code": { "type": "string", "nullable": true }, "name": { "type": "string", "nullable": true }, "chainId": { "type": "integer", "format": "int32", "nullable": true }, "isTestnet": { "type": "boolean" }, "status": { "type": "string", "nullable": true }, "createdAt": { "type": "string", "format": "date-time" } }, "additionalProperties": false }, "CompositionRoot.EndpointMapping.SignUpRequest": { "type": "object", "properties": { "organizationName": { "type": "string", "nullable": true }, "email": { "type": "string", "nullable": true }, "password": { "type": "string", "nullable": true } }, "additionalProperties": false }, "CompositionRoot.EndpointMapping.SignUpResponse": { "type": "object", "properties": { "organizationId": { "type": "string", "format": "uuid" }, "memberId": { "type": "string", "format": "uuid" }, "token": { "$ref": "#/components/schemas/IdentityAccess.Contracts.Responses.TokenResult" }, "applicationId": { "type": "string", "format": "uuid" }, "environmentId": { "type": "string", "format": "uuid" }, "apiKeyPlainText": { "type": "string", "nullable": true } }, "additionalProperties": false }, "Deposits.Contracts.Enums.DepositStatus": { "enum": [ 0, 1, 2, 3, 4, 5 ], "type": "integer", "format": "int32" }, "Deposits.Contracts.Enums.PaymentIntentStatus": { "enum": [ 0, 1, 2, 3, 4 ], "type": "integer", "format": "int32" }, "Deposits.Contracts.Requests.CreatePaymentIntentRequest": { "type": "object", "properties": { "transactionId": { "type": "string", "format": "uuid" }, "assetNetworkId": { "type": "string", "format": "uuid" }, "amount": { "type": "number", "format": "double" }, "expiresAt": { "type": "string", "format": "date-time", "nullable": true }, "idempotencyKey": { "type": "string", "nullable": true } }, "additionalProperties": false }, "Deposits.Contracts.Responses.DepositResponse": { "type": "object", "properties": { "depositId": { "type": "string", "format": "uuid" }, "paymentIntentId": { "type": "string", "format": "uuid" }, "technicalReference": { "type": "string", "nullable": true }, "amount": { "type": "number", "format": "double" }, "status": { "$ref": "#/components/schemas/Deposits.Contracts.Enums.DepositStatus" }, "confirmationCount": { "type": "integer", "format": "int32" }, "wasConfirmedBeforeReorg": { "type": "boolean" }, "isLate": { "type": "boolean" }, "createdAt": { "type": "string", "format": "date-time" } }, "additionalProperties": false }, "Deposits.Contracts.Responses.PaymentIntentResponse": { "type": "object", "properties": { "paymentIntentId": { "type": "string", "format": "uuid" }, "organizationId": { "type": "string", "format": "uuid" }, "transactionId": { "type": "string", "format": "uuid" }, "assetNetworkId": { "type": "string", "format": "uuid" }, "amount": { "type": "number", "format": "double" }, "status": { "$ref": "#/components/schemas/Deposits.Contracts.Enums.PaymentIntentStatus" }, "expiresAt": { "type": "string", "format": "date-time", "nullable": true }, "depositAddress": { "type": "string", "nullable": true }, "deposits": { "type": "array", "items": { "$ref": "#/components/schemas/Deposits.Contracts.Responses.DepositResponse" }, "nullable": true }, "createdAt": { "type": "string", "format": "date-time" } }, "additionalProperties": false }, "ExecutionCustody.Contracts.Commands.ExecutionLegInput": { "type": "object", "properties": { "role": { "type": "string", "nullable": true }, "destinationAddress": { "type": "string", "nullable": true }, "amount": { "type": "number", "format": "double" } }, "additionalProperties": false }, "ExecutionCustody.Contracts.Enums.DerivationScheme": { "enum": [ 1 ], "type": "integer", "format": "int32" }, "ExecutionCustody.Contracts.Enums.NetworkCostPayer": { "enum": [ 0, 1 ], "type": "integer", "format": "int32" }, "ExecutionCustody.Contracts.Enums.NetworkOperationKind": { "enum": [ 0, 1, 2, 3, 4, 5 ], "type": "integer", "format": "int32" }, "ExecutionCustody.Contracts.Enums.NetworkResourceSource": { "enum": [ 0, 1, 2, 3, 4 ], "type": "integer", "format": "int32" }, "ExecutionCustody.Contracts.Enums.ReserveGrowthMode": { "enum": [ 0, 1 ], "type": "integer", "format": "int32" }, "ExecutionCustody.Contracts.Queries.NetworkExecutionOperationRequest": { "type": "object", "properties": { "destinationAddress": { "type": "string", "nullable": true }, "amount": { "type": "number", "format": "double" }, "kind": { "$ref": "#/components/schemas/ExecutionCustody.Contracts.Enums.NetworkOperationKind" }, "reference": { "type": "string", "nullable": true } }, "additionalProperties": false }, "ExecutionCustody.Contracts.Requests.AllocateDepositAddressRequest": { "type": "object", "properties": { "networkId": { "type": "string", "format": "uuid" } }, "additionalProperties": false }, "ExecutionCustody.Contracts.Requests.CreateSigningRequestRequest": { "type": "object", "properties": { "walletId": { "type": "string", "format": "uuid" }, "derivationReference": { "type": "integer", "format": "int64" }, "originReference": { "type": "string", "nullable": true }, "assetNetworkId": { "type": "string", "format": "uuid" }, "sourceAddress": { "type": "string", "nullable": true }, "legs": { "type": "array", "items": { "$ref": "#/components/schemas/ExecutionCustody.Contracts.Commands.ExecutionLegInput" }, "nullable": true }, "expiresAt": { "type": "string", "format": "date-time" }, "idempotencyKey": { "type": "string", "nullable": true } }, "additionalProperties": false }, "ExecutionCustody.Contracts.Requests.NetworkExecutionQuoteRequest": { "type": "object", "properties": { "assetNetworkId": { "type": "string", "format": "uuid" }, "operations": { "type": "array", "items": { "$ref": "#/components/schemas/ExecutionCustody.Contracts.Queries.NetworkExecutionOperationRequest" }, "nullable": true }, "networkCostPayer": { "$ref": "#/components/schemas/ExecutionCustody.Contracts.Enums.NetworkCostPayer" } }, "additionalProperties": false }, "ExecutionCustody.Contracts.Requests.RegisterExecutionDestinationRequest": { "type": "object", "properties": { "accountId": { "type": "string", "format": "uuid" }, "assetNetworkId": { "type": "string", "format": "uuid" }, "address": { "type": "string", "nullable": true } }, "additionalProperties": false }, "ExecutionCustody.Contracts.Requests.RegisterExecutionSourceRequest": { "type": "object", "properties": { "environmentId": { "type": "string", "format": "uuid" }, "assetNetworkId": { "type": "string", "format": "uuid" }, "walletId": { "type": "string", "format": "uuid" }, "derivationReference": { "type": "integer", "format": "int64" }, "address": { "type": "string", "nullable": true } }, "additionalProperties": false }, "ExecutionCustody.Contracts.Requests.RegisterNetworkCostPayerAccountRequest": { "type": "object", "properties": { "assetNetworkId": { "type": "string", "format": "uuid" }, "accountId": { "type": "string", "format": "uuid" } }, "additionalProperties": false }, "ExecutionCustody.Contracts.Requests.RegisterWalletRequest": { "type": "object", "properties": { "networkId": { "type": "string", "format": "uuid" }, "scheme": { "$ref": "#/components/schemas/ExecutionCustody.Contracts.Enums.DerivationScheme" }, "publicDerivationMaterial": { "type": "string", "nullable": true }, "idempotencyKey": { "type": "string", "nullable": true } }, "additionalProperties": false }, "ExecutionCustody.Contracts.Requests.SubmitSignedTransactionRequest": { "type": "object", "properties": { "submittedCanonicalHash": { "type": "string", "nullable": true }, "signature": { "type": "string", "nullable": true } }, "additionalProperties": false }, "ExecutionCustody.Contracts.Requests.SyncCustomerResourceStakeRequest": { "type": "object", "properties": { "availableNativeAmount": { "type": "number", "format": "double" }, "availableEnergy": { "type": "number", "format": "double" }, "availableBandwidth": { "type": "number", "format": "double" } }, "additionalProperties": false }, "ExecutionCustody.Contracts.Requests.UpdateNetworkResourcePreferenceRequest": { "type": "object", "properties": { "resourcePreference": { "$ref": "#/components/schemas/ExecutionCustody.Contracts.Enums.NetworkResourceSource" }, "allowFallbackToIshtaranResources": { "type": "boolean" } }, "additionalProperties": false }, "ExecutionCustody.Contracts.Responses.AllocatedDepositAddressResponse": { "type": "object", "properties": { "walletId": { "type": "string", "format": "uuid" }, "address": { "type": "string", "nullable": true }, "derivationReference": { "type": "integer", "format": "int64" } }, "additionalProperties": false }, "ExecutionCustody.Contracts.Responses.ExecutionLegResponse": { "type": "object", "properties": { "executionLegId": { "type": "string", "format": "uuid" }, "role": { "type": "string", "nullable": true }, "destinationAddress": { "type": "string", "nullable": true }, "amount": { "type": "number", "format": "double" }, "canonicalHash": { "type": "string", "nullable": true }, "status": { "type": "string", "nullable": true }, "mismatchReason": { "type": "string", "nullable": true }, "broadcastReference": { "type": "string", "nullable": true } }, "additionalProperties": false }, "ExecutionCustody.Contracts.Responses.NetworkExecutionPlanResponse": { "type": "object", "properties": { "assetNetworkId": { "type": "string", "format": "uuid" }, "transactions": { "type": "array", "items": { "$ref": "#/components/schemas/ExecutionCustody.Contracts.Responses.NetworkExecutionTransactionResponse" }, "nullable": true } }, "additionalProperties": false }, "ExecutionCustody.Contracts.Responses.NetworkExecutionQuoteResponse": { "type": "object", "properties": { "network": { "type": "string", "nullable": true }, "plan": { "$ref": "#/components/schemas/ExecutionCustody.Contracts.Responses.NetworkExecutionPlanResponse" }, "estimatedResources": { "$ref": "#/components/schemas/ExecutionCustody.Contracts.Responses.NetworkResourceEstimateResponse" }, "nativeExecutionCost": { "type": "number", "format": "double" }, "resourceAssetNetworkId": { "type": "string", "format": "uuid", "nullable": true }, "quoteCurrency": { "type": "string", "nullable": true }, "fx": { "type": "number", "format": "double" }, "safetyBuffer": { "type": "number", "format": "double" }, "resourceSource": { "$ref": "#/components/schemas/ExecutionCustody.Contracts.Enums.NetworkResourceSource" }, "replenishmentRequirement": { "type": "number", "format": "double", "nullable": true }, "conversionOverhead": { "type": "number", "format": "double" }, "expiresAt": { "type": "string", "format": "date-time" }, "totalCharged": { "type": "number", "format": "double" }, "networkCostPayer": { "$ref": "#/components/schemas/ExecutionCustody.Contracts.Enums.NetworkCostPayer" }, "authorizedNativeCost": { "type": "number", "format": "double" }, "margin": { "type": "number", "format": "double" } }, "additionalProperties": false }, "ExecutionCustody.Contracts.Responses.NetworkExecutionTransactionResponse": { "type": "object", "properties": { "transfers": { "type": "array", "items": { "$ref": "#/components/schemas/ExecutionCustody.Contracts.Responses.NetworkExecutionTransferResponse" }, "nullable": true } }, "additionalProperties": false }, "ExecutionCustody.Contracts.Responses.NetworkExecutionTransferResponse": { "type": "object", "properties": { "destinationAddress": { "type": "string", "nullable": true }, "amount": { "type": "number", "format": "double" }, "sourceOperationReference": { "type": "string", "nullable": true } }, "additionalProperties": false }, "ExecutionCustody.Contracts.Responses.NetworkResourceEstimateResponse": { "type": "object", "properties": { "lines": { "type": "array", "items": { "$ref": "#/components/schemas/ExecutionCustody.Contracts.Responses.NetworkResourceLineResponse" }, "nullable": true } }, "additionalProperties": false }, "ExecutionCustody.Contracts.Responses.NetworkResourceLineResponse": { "type": "object", "properties": { "resourceCode": { "type": "string", "nullable": true }, "quantity": { "type": "number", "format": "double" }, "unit": { "type": "string", "nullable": true } }, "additionalProperties": false }, "ExecutionCustody.Contracts.Responses.SigningRequestResponse": { "type": "object", "properties": { "signingRequestId": { "type": "string", "format": "uuid" }, "applicationId": { "type": "string", "format": "uuid" }, "environmentId": { "type": "string", "format": "uuid" }, "networkId": { "type": "string", "format": "uuid" }, "walletId": { "type": "string", "format": "uuid" }, "derivationReference": { "type": "integer", "format": "int64" }, "originReference": { "type": "string", "nullable": true }, "assetNetworkId": { "type": "string", "format": "uuid" }, "sourceAddress": { "type": "string", "nullable": true }, "protocolVersion": { "type": "integer", "format": "int32" }, "legs": { "type": "array", "items": { "$ref": "#/components/schemas/ExecutionCustody.Contracts.Responses.ExecutionLegResponse" }, "nullable": true }, "createdAt": { "type": "string", "format": "date-time" }, "expiresAt": { "type": "string", "format": "date-time" }, "isExpired": { "type": "boolean" } }, "additionalProperties": false }, "ExecutionCustody.Contracts.Responses.SubmitSignedTransactionResult": { "type": "object", "properties": { "executionLegId": { "type": "string", "format": "uuid" }, "verified": { "type": "boolean" }, "mismatchReason": { "type": "string", "nullable": true }, "allLegsVerified": { "type": "boolean" } }, "additionalProperties": false }, "ExecutionCustody.Contracts.Responses.WalletResponse": { "type": "object", "properties": { "walletId": { "type": "string", "format": "uuid" }, "applicationId": { "type": "string", "format": "uuid" }, "networkId": { "type": "string", "format": "uuid" }, "scheme": { "$ref": "#/components/schemas/ExecutionCustody.Contracts.Enums.DerivationScheme" }, "nextDerivationIndex": { "type": "integer", "format": "int64" }, "registeredAt": { "type": "string", "format": "date-time" } }, "additionalProperties": false }, "IdentityAccess.Contracts.Enums.MemberRole": { "enum": [ 1, 2, 3, 4 ], "type": "integer", "format": "int32" }, "IdentityAccess.Contracts.Requests.AcceptInviteRequest": { "type": "object", "properties": { "inviteToken": { "type": "string", "nullable": true }, "password": { "type": "string", "nullable": true } }, "additionalProperties": false }, "IdentityAccess.Contracts.Requests.AssignRoleRequest": { "type": "object", "properties": { "newRole": { "$ref": "#/components/schemas/IdentityAccess.Contracts.Enums.MemberRole" } }, "additionalProperties": false }, "IdentityAccess.Contracts.Requests.InviteMemberRequest": { "type": "object", "properties": { "email": { "type": "string", "nullable": true }, "role": { "$ref": "#/components/schemas/IdentityAccess.Contracts.Enums.MemberRole" } }, "additionalProperties": false }, "IdentityAccess.Contracts.Requests.LoginRequest": { "type": "object", "properties": { "email": { "type": "string", "nullable": true }, "password": { "type": "string", "nullable": true } }, "additionalProperties": false }, "IdentityAccess.Contracts.Requests.RefreshTokenRequest": { "type": "object", "properties": { "refreshToken": { "type": "string", "nullable": true } }, "additionalProperties": false }, "IdentityAccess.Contracts.Requests.RequestPasswordResetRequest": { "type": "object", "properties": { "email": { "type": "string", "nullable": true } }, "additionalProperties": false }, "IdentityAccess.Contracts.Requests.ResetPasswordRequest": { "type": "object", "properties": { "resetToken": { "type": "string", "nullable": true }, "newPassword": { "type": "string", "nullable": true } }, "additionalProperties": false }, "IdentityAccess.Contracts.Requests.SuspendMemberRequest": { "type": "object", "properties": { "reason": { "type": "string", "nullable": true } }, "additionalProperties": false }, "IdentityAccess.Contracts.Responses.InviteMemberResult": { "type": "object", "properties": { "memberId": { "type": "string", "format": "uuid" }, "plainTextInviteToken": { "type": "string", "nullable": true } }, "additionalProperties": false }, "IdentityAccess.Contracts.Responses.MemberResponse": { "type": "object", "properties": { "memberId": { "type": "string", "format": "uuid" }, "organizationId": { "type": "string", "format": "uuid" }, "email": { "type": "string", "nullable": true }, "role": { "type": "string", "nullable": true }, "status": { "type": "string", "nullable": true }, "createdAt": { "type": "string", "format": "date-time" }, "activatedAt": { "type": "string", "format": "date-time", "nullable": true }, "lastLoginAt": { "type": "string", "format": "date-time", "nullable": true } }, "additionalProperties": false }, "IdentityAccess.Contracts.Responses.TokenResult": { "type": "object", "properties": { "success": { "type": "boolean" }, "accessToken": { "type": "string", "nullable": true }, "refreshToken": { "type": "string", "nullable": true }, "expiresAt": { "type": "string", "format": "date-time", "nullable": true }, "errorCode": { "type": "string", "nullable": true } }, "additionalProperties": false }, "Ledger.Contracts.Enums.EntryNature": { "enum": [ 0, 1, 2, 3, 4, 5 ], "type": "integer", "format": "int32" }, "Notifications.Contracts.Enums.WebhookDeliveryStatus": { "enum": [ 0, 1, 2, 3, 4, 5 ], "type": "integer", "format": "int32" }, "Notifications.Contracts.Enums.WebhookEndpointStatus": { "enum": [ 0, 1 ], "type": "integer", "format": "int32" }, "Notifications.Contracts.Requests.ConfigureWebhookEndpointRequest": { "type": "object", "properties": { "url": { "type": "string", "nullable": true } }, "additionalProperties": false }, "Notifications.Contracts.Responses.WebhookDeliveryResponse": { "type": "object", "properties": { "webhookDeliveryId": { "type": "string", "format": "uuid" }, "webhookEndpointId": { "type": "string", "format": "uuid" }, "eventType": { "type": "string", "nullable": true }, "sequenceNumber": { "type": "integer", "format": "int64" }, "status": { "$ref": "#/components/schemas/Notifications.Contracts.Enums.WebhookDeliveryStatus" }, "attemptCount": { "type": "integer", "format": "int32" }, "maxAttempts": { "type": "integer", "format": "int32" }, "nextAttemptAt": { "type": "string", "format": "date-time", "nullable": true }, "lastAttemptAt": { "type": "string", "format": "date-time", "nullable": true }, "lastError": { "type": "string", "nullable": true }, "redeliveredFromId": { "type": "string", "format": "uuid", "nullable": true }, "createdAt": { "type": "string", "format": "date-time" } }, "additionalProperties": false }, "Notifications.Contracts.Responses.WebhookEndpointResponse": { "type": "object", "properties": { "webhookEndpointId": { "type": "string", "format": "uuid" }, "organizationId": { "type": "string", "format": "uuid" }, "url": { "type": "string", "nullable": true }, "status": { "$ref": "#/components/schemas/Notifications.Contracts.Enums.WebhookEndpointStatus" }, "createdAt": { "type": "string", "format": "date-time" } }, "additionalProperties": false }, "OrganizationTenancy.Contracts.Enums.EnvironmentType": { "enum": [ 1, 2 ], "type": "integer", "format": "int32" }, "OrganizationTenancy.Contracts.Requests.CreateApplicationRequest": { "type": "object", "properties": { "name": { "type": "string", "nullable": true } }, "additionalProperties": false }, "OrganizationTenancy.Contracts.Requests.CreateEnvironmentRequest": { "type": "object", "properties": { "type": { "$ref": "#/components/schemas/OrganizationTenancy.Contracts.Enums.EnvironmentType" } }, "additionalProperties": false }, "OrganizationTenancy.Contracts.Requests.CreateOrganizationRequest": { "type": "object", "properties": { "name": { "type": "string", "nullable": true } }, "additionalProperties": false }, "OrganizationTenancy.Contracts.Requests.RotateApiKeyRequest": { "type": "object", "properties": { "overlapWindow": { "type": "string", "format": "date-span" } }, "additionalProperties": false }, "OrganizationTenancy.Contracts.Requests.SuspendRequest": { "type": "object", "properties": { "reason": { "type": "string", "nullable": true } }, "additionalProperties": false }, "OrganizationTenancy.Contracts.Responses.ApiKeyMetadataResponse": { "type": "object", "properties": { "apiKeyId": { "type": "string", "format": "uuid" }, "createdAt": { "type": "string", "format": "date-time" }, "lastUsedAt": { "type": "string", "format": "date-time", "nullable": true } }, "additionalProperties": false }, "OrganizationTenancy.Contracts.Responses.ApplicationResponse": { "type": "object", "properties": { "applicationId": { "type": "string", "format": "uuid" }, "organizationId": { "type": "string", "format": "uuid" }, "name": { "type": "string", "nullable": true }, "status": { "type": "string", "nullable": true } }, "additionalProperties": false }, "OrganizationTenancy.Contracts.Responses.CreatedResourceResponse": { "type": "object", "properties": { "id": { "type": "string", "format": "uuid" } }, "additionalProperties": false }, "OrganizationTenancy.Contracts.Responses.EnvironmentResponse": { "type": "object", "properties": { "environmentId": { "type": "string", "format": "uuid" }, "applicationId": { "type": "string", "format": "uuid" }, "organizationId": { "type": "string", "format": "uuid" }, "type": { "$ref": "#/components/schemas/OrganizationTenancy.Contracts.Enums.EnvironmentType" }, "status": { "type": "string", "nullable": true } }, "additionalProperties": false }, "OrganizationTenancy.Contracts.Responses.GenerateApiKeyResult": { "type": "object", "properties": { "apiKeyId": { "type": "string", "format": "uuid" }, "plainTextKey": { "type": "string", "nullable": true } }, "additionalProperties": false }, "OrganizationTenancy.Contracts.Responses.OrganizationResponse": { "type": "object", "properties": { "organizationId": { "type": "string", "format": "uuid" }, "name": { "type": "string", "nullable": true }, "status": { "type": "string", "nullable": true }, "createdAt": { "type": "string", "format": "date-time" } }, "additionalProperties": false }, "OrganizationTenancy.Contracts.Responses.RotateApiKeyResult": { "type": "object", "properties": { "newApiKeyId": { "type": "string", "format": "uuid" }, "plainTextKey": { "type": "string", "nullable": true } }, "additionalProperties": false }, "Payout.Contracts.Enums.PayoutBatchObligationStatus": { "enum": [ 0, 1, 2, 3 ], "type": "integer", "format": "int32" }, "Payout.Contracts.Enums.PayoutBatchStatus": { "enum": [ 0, 1, 2, 3, 4, 5 ], "type": "integer", "format": "int32" }, "Payout.Contracts.Enums.PayoutBatchTrigger": { "enum": [ 0, 1, 2 ], "type": "integer", "format": "int32" }, "Payout.Contracts.Queries.NetworkExecutionQuoteSnapshotResponse": { "type": "object", "properties": { "network": { "type": "string", "nullable": true }, "nativeExecutionCost": { "type": "number", "format": "double" }, "resourceAssetNetworkId": { "type": "string", "format": "uuid", "nullable": true }, "quoteCurrency": { "type": "string", "nullable": true }, "fx": { "type": "number", "format": "double" }, "totalCharged": { "type": "number", "format": "double" }, "authorizedNativeCost": { "type": "number", "format": "double" }, "expiresAt": { "type": "string", "format": "date-time" } }, "additionalProperties": false }, "Payout.Contracts.Queries.PayableSummaryResponse": { "type": "object", "properties": { "accrued": { "type": "number", "format": "double" }, "reservedForPayout": { "type": "number", "format": "double" }, "paid": { "type": "number", "format": "double" } }, "additionalProperties": false }, "Payout.Contracts.Queries.PayoutBatchObligationResponse": { "type": "object", "properties": { "ownerId": { "type": "string", "format": "uuid" }, "amount": { "type": "number", "format": "double" }, "sourceObligations": { "type": "array", "items": { "$ref": "#/components/schemas/Payout.Contracts.Queries.PayoutBatchSourceObligationResponse" }, "nullable": true }, "destinationAddress": { "type": "string", "nullable": true }, "status": { "$ref": "#/components/schemas/Payout.Contracts.Enums.PayoutBatchObligationStatus" } }, "additionalProperties": false }, "Payout.Contracts.Queries.PayoutBatchResponse": { "type": "object", "properties": { "payoutBatchId": { "type": "string", "format": "uuid" }, "organizationId": { "type": "string", "format": "uuid" }, "environmentId": { "type": "string", "format": "uuid" }, "assetNetworkId": { "type": "string", "format": "uuid" }, "trigger": { "$ref": "#/components/schemas/Payout.Contracts.Enums.PayoutBatchTrigger" }, "status": { "$ref": "#/components/schemas/Payout.Contracts.Enums.PayoutBatchStatus" }, "obligations": { "type": "array", "items": { "$ref": "#/components/schemas/Payout.Contracts.Queries.PayoutBatchObligationResponse" }, "nullable": true }, "networkExecutionQuoteSnapshot": { "$ref": "#/components/schemas/Payout.Contracts.Queries.NetworkExecutionQuoteSnapshotResponse" }, "signingRequestId": { "type": "string", "format": "uuid", "nullable": true }, "createdAt": { "type": "string", "format": "date-time" } }, "additionalProperties": false }, "Payout.Contracts.Queries.PayoutBatchSourceObligationResponse": { "type": "object", "properties": { "originReference": { "type": "string", "nullable": true }, "amount": { "type": "number", "format": "double" } }, "additionalProperties": false }, "Payout.Contracts.Requests.CreatePayoutBatchRequest": { "type": "object", "properties": { "environmentId": { "type": "string", "format": "uuid" }, "assetNetworkId": { "type": "string", "format": "uuid" }, "explicitOwnerIds": { "type": "array", "items": { "type": "string", "format": "uuid" }, "nullable": true }, "idempotencyKey": { "type": "string", "nullable": true } }, "additionalProperties": false }, "Sandbox.Contracts.Enums.SimulatedBroadcastOutcome": { "enum": [ 1, 2 ], "type": "integer", "format": "int32" }, "Sandbox.Contracts.Requests.CreditSandboxWalletBalanceRequest": { "type": "object", "properties": { "address": { "type": "string", "nullable": true }, "assetNetworkId": { "type": "string", "format": "uuid" }, "amount": { "type": "number", "format": "double" }, "idempotencyKey": { "type": "string", "nullable": true } }, "additionalProperties": false }, "Sandbox.Contracts.Requests.FaucetRequest": { "type": "object", "properties": { "depositAddress": { "type": "string", "nullable": true }, "assetNetworkId": { "type": "string", "format": "uuid" }, "amount": { "type": "number", "format": "double" } }, "additionalProperties": false }, "Sandbox.Contracts.Requests.SetObservedTreasuryBalanceRequest": { "type": "object", "properties": { "assetNetworkId": { "type": "string", "format": "uuid" }, "balance": { "type": "number", "format": "double" } }, "additionalProperties": false }, "Sandbox.Contracts.Requests.SimulateBroadcastConfirmationRequest": { "type": "object", "properties": { "broadcastAttemptId": { "type": "string", "format": "uuid" }, "additionalConfirmations": { "type": "integer", "format": "int32" }, "isFinal": { "type": "boolean" } }, "additionalProperties": false }, "Sandbox.Contracts.Requests.SimulateConfirmationRequest": { "type": "object", "properties": { "sandboxObservedAddressId": { "type": "string", "format": "uuid" }, "additionalConfirmations": { "type": "integer", "format": "int32" }, "isFinal": { "type": "boolean" } }, "additionalProperties": false }, "Sandbox.Contracts.Requests.SimulateDepositRequest": { "type": "object", "properties": { "depositAddress": { "type": "string", "nullable": true }, "assetNetworkId": { "type": "string", "format": "uuid" }, "amount": { "type": "number", "format": "double" } }, "additionalProperties": false }, "Sandbox.Contracts.Requests.SimulateWithdrawalRequest": { "type": "object", "properties": { "destinationAddress": { "type": "string", "nullable": true }, "amount": { "type": "number", "format": "double" }, "assetNetworkId": { "type": "string", "format": "uuid" }, "outcome": { "$ref": "#/components/schemas/Sandbox.Contracts.Enums.SimulatedBroadcastOutcome" }, "failureReason": { "type": "string", "nullable": true } }, "additionalProperties": false }, "Sandbox.Contracts.Requests.TransferSandboxWalletBalanceRequest": { "type": "object", "properties": { "fromAddress": { "type": "string", "nullable": true }, "toAddress": { "type": "string", "nullable": true }, "assetNetworkId": { "type": "string", "format": "uuid" }, "amount": { "type": "number", "format": "double" }, "idempotencyKey": { "type": "string", "nullable": true } }, "additionalProperties": false }, "Sandbox.Contracts.Responses.SandboxBroadcastAttemptResponse": { "type": "object", "properties": { "sandboxBroadcastAttemptId": { "type": "string", "format": "uuid" }, "destinationAddress": { "type": "string", "nullable": true }, "amount": { "type": "number", "format": "double" }, "assetNetworkId": { "type": "string", "format": "uuid" }, "status": { "type": "string", "nullable": true }, "technicalReference": { "type": "string", "nullable": true }, "createdAt": { "type": "string", "format": "date-time" } }, "additionalProperties": false }, "Sandbox.Contracts.Responses.SandboxObservedAddressResponse": { "type": "object", "properties": { "sandboxObservedAddressId": { "type": "string", "format": "uuid" }, "address": { "type": "string", "nullable": true }, "assetNetworkId": { "type": "string", "format": "uuid" }, "lastObservedReference": { "type": "string", "nullable": true }, "lastConfirmationCount": { "type": "integer", "format": "int32", "nullable": true }, "createdAt": { "type": "string", "format": "date-time" } }, "additionalProperties": false }, "Sandbox.Contracts.Responses.SandboxTreasuryObservedBalanceResponse": { "type": "object", "properties": { "assetNetworkId": { "type": "string", "format": "uuid" }, "balance": { "type": "number", "format": "double" }, "updatedAt": { "type": "string", "format": "date-time" } }, "additionalProperties": false }, "Sandbox.Contracts.Responses.SandboxWalletBalanceResponse": { "type": "object", "properties": { "environmentId": { "type": "string", "format": "uuid" }, "assetNetworkId": { "type": "string", "format": "uuid" }, "address": { "type": "string", "nullable": true }, "balance": { "type": "number", "format": "double" }, "updatedAt": { "type": "string", "format": "date-time" } }, "additionalProperties": false }, "Sandbox.Contracts.Responses.SandboxWalletTransferResponse": { "type": "object", "properties": { "fromAddress": { "type": "string", "nullable": true }, "fromBalanceAfter": { "type": "number", "format": "double" }, "toAddress": { "type": "string", "nullable": true }, "toBalanceAfter": { "type": "number", "format": "double" }, "occurredAt": { "type": "string", "format": "date-time" } }, "additionalProperties": false }, "Settlement.Contracts.Enums.RefundStatus": { "enum": [ 0, 1, 2, 3 ], "type": "integer", "format": "int32" }, "Settlement.Contracts.Enums.SettlementStatus": { "enum": [ 0, 1, 2, 3 ], "type": "integer", "format": "int32" }, "Settlement.Contracts.Enums.SplitAllocationStatus": { "enum": [ 0, 1, 2 ], "type": "integer", "format": "int32" }, "Settlement.Contracts.Enums.SplitRetentionReason": { "enum": [ 0, 1, 2 ], "type": "integer", "format": "int32" }, "Settlement.Contracts.Requests.ExecuteRefundRequest": { "type": "object", "properties": { "amount": { "type": "number", "format": "double", "nullable": true }, "reason": { "type": "string", "nullable": true }, "idempotencyKey": { "type": "string", "nullable": true } }, "additionalProperties": false }, "Settlement.Contracts.Requests.ExecuteSettlementRequest": { "type": "object", "properties": { "idempotencyKey": { "type": "string", "nullable": true }, "amount": { "type": "number", "format": "double", "nullable": true } }, "additionalProperties": false }, "Settlement.Contracts.Requests.ReleaseRetainedSplitRequest": { "type": "object", "properties": { "idempotencyKey": { "type": "string", "nullable": true } }, "additionalProperties": false }, "Settlement.Contracts.Responses.RefundResponse": { "type": "object", "properties": { "refundId": { "type": "string", "format": "uuid" }, "transactionId": { "type": "string", "format": "uuid" }, "organizationId": { "type": "string", "format": "uuid" }, "amount": { "type": "number", "format": "double" }, "reason": { "type": "string", "nullable": true }, "status": { "$ref": "#/components/schemas/Settlement.Contracts.Enums.RefundStatus" }, "entryGroupId": { "type": "string", "format": "uuid", "nullable": true }, "createdAt": { "type": "string", "format": "date-time" }, "executedAt": { "type": "string", "format": "date-time", "nullable": true } }, "additionalProperties": false }, "Settlement.Contracts.Responses.SettlementResponse": { "type": "object", "properties": { "settlementId": { "type": "string", "format": "uuid" }, "transactionId": { "type": "string", "format": "uuid" }, "organizationId": { "type": "string", "format": "uuid" }, "applicationId": { "type": "string", "format": "uuid" }, "assetNetworkId": { "type": "string", "format": "uuid" }, "grossAmount": { "type": "number", "format": "double" }, "platformFeeAmount": { "type": "number", "format": "double" }, "distributableAmount": { "type": "number", "format": "double" }, "feePercentageApplied": { "type": "number", "format": "double" }, "platformRevenueAccountId": { "type": "string", "format": "uuid" }, "pricingPolicyId": { "type": "string", "format": "uuid" }, "status": { "$ref": "#/components/schemas/Settlement.Contracts.Enums.SettlementStatus" }, "entryGroupId": { "type": "string", "format": "uuid", "nullable": true }, "signingRequestId": { "type": "string", "format": "uuid", "nullable": true }, "splitAllocations": { "type": "array", "items": { "$ref": "#/components/schemas/Settlement.Contracts.Responses.SettlementSplitAllocationResponse" }, "nullable": true }, "createdAt": { "type": "string", "format": "date-time" }, "executedAt": { "type": "string", "format": "date-time", "nullable": true }, "signingRequestIds": { "type": "array", "items": { "type": "string", "format": "uuid" }, "nullable": true } }, "additionalProperties": false }, "Settlement.Contracts.Responses.SettlementSplitAllocationResponse": { "type": "object", "properties": { "splitAllocationId": { "type": "string", "format": "uuid" }, "participantId": { "type": "string", "format": "uuid" }, "accountId": { "type": "string", "format": "uuid" }, "amount": { "type": "number", "format": "double" }, "status": { "$ref": "#/components/schemas/Settlement.Contracts.Enums.SplitAllocationStatus" }, "retentionReason": { "$ref": "#/components/schemas/Settlement.Contracts.Enums.SplitRetentionReason" }, "releasedAt": { "type": "string", "format": "date-time", "nullable": true } }, "additionalProperties": false }, "Transactions.Contracts.Commands.ParticipantInput": { "type": "object", "properties": { "accountId": { "type": "string", "format": "uuid" }, "role": { "type": "string", "nullable": true }, "isPayer": { "type": "boolean" }, "splitPercentage": { "type": "number", "format": "double", "nullable": true } }, "additionalProperties": false }, "Transactions.Contracts.Enums.ExecutionStatus": { "enum": [ 0, 1, 2, 3, 4, 5 ], "type": "integer", "format": "int32" }, "Transactions.Contracts.Enums.TransactionStatus": { "enum": [ 0, 1, 2, 3, 4, 5, 6, 7, 8, 9 ], "type": "integer", "format": "int32" }, "Transactions.Contracts.Requests.CancelTransactionRequest": { "type": "object", "properties": { "reason": { "type": "string", "nullable": true } }, "additionalProperties": false }, "Transactions.Contracts.Requests.CreateTransactionRequest": { "type": "object", "properties": { "applicationId": { "type": "string", "format": "uuid" }, "environmentId": { "type": "string", "format": "uuid" }, "workflowVersionId": { "type": "string", "format": "uuid", "nullable": true }, "assetNetworkId": { "type": "string", "format": "uuid" }, "amount": { "type": "number", "format": "double" }, "participants": { "type": "array", "items": { "$ref": "#/components/schemas/Transactions.Contracts.Commands.ParticipantInput" }, "nullable": true }, "idempotencyKey": { "type": "string", "nullable": true } }, "additionalProperties": false }, "Transactions.Contracts.Requests.FreezeTransactionRequest": { "type": "object", "properties": { "reason": { "type": "string", "nullable": true } }, "additionalProperties": false }, "Transactions.Contracts.Responses.ExecutionResponse": { "type": "object", "properties": { "executionId": { "type": "string", "format": "uuid" }, "transactionId": { "type": "string", "format": "uuid" }, "organizationId": { "type": "string", "format": "uuid" }, "status": { "$ref": "#/components/schemas/Transactions.Contracts.Enums.ExecutionStatus" }, "preparedAt": { "type": "string", "format": "date-time" }, "gracePeriodExpiresAt": { "type": "string", "format": "date-time" }, "executedAt": { "type": "string", "format": "date-time", "nullable": true }, "settlementId": { "type": "string", "format": "uuid", "nullable": true } }, "additionalProperties": false }, "Transactions.Contracts.Responses.ParticipantResponse": { "type": "object", "properties": { "participantId": { "type": "string", "format": "uuid" }, "accountId": { "type": "string", "format": "uuid" }, "role": { "type": "string", "nullable": true }, "isPayer": { "type": "boolean" }, "splitPercentage": { "type": "number", "format": "double", "nullable": true } }, "additionalProperties": false }, "Transactions.Contracts.Responses.TransactionResponse": { "type": "object", "properties": { "transactionId": { "type": "string", "format": "uuid" }, "organizationId": { "type": "string", "format": "uuid" }, "applicationId": { "type": "string", "format": "uuid" }, "environmentId": { "type": "string", "format": "uuid" }, "workflowVersionId": { "type": "string", "format": "uuid", "nullable": true }, "currentWorkflowStateId": { "type": "string", "format": "uuid", "nullable": true }, "assetNetworkId": { "type": "string", "format": "uuid" }, "amount": { "type": "number", "format": "double" }, "status": { "$ref": "#/components/schemas/Transactions.Contracts.Enums.TransactionStatus" }, "payerAccountId": { "type": "string", "format": "uuid" }, "participants": { "type": "array", "items": { "$ref": "#/components/schemas/Transactions.Contracts.Responses.ParticipantResponse" }, "nullable": true }, "createdAt": { "type": "string", "format": "date-time" }, "settledAmount": { "type": "number", "format": "double" }, "refundedAmount": { "type": "number", "format": "double" } }, "additionalProperties": false }, "Transactions.Contracts.Responses.TransactionStateResponse": { "type": "object", "properties": { "status": { "$ref": "#/components/schemas/Transactions.Contracts.Enums.TransactionStatus" }, "workflowVersionId": { "type": "string", "format": "uuid", "nullable": true }, "currentWorkflowStateId": { "type": "string", "format": "uuid", "nullable": true } }, "additionalProperties": false }, "Withdrawals.Contracts.Enums.NetworkExecutionCostStatus": { "enum": [ 0, 1, 2, 3 ], "type": "integer", "format": "int32" }, "Withdrawals.Contracts.Enums.WithdrawalStatus": { "enum": [ 0, 1, 2, 3, 4, 5, 6, 7, 8, 9, 10, 11 ], "type": "integer", "format": "int32" }, "Withdrawals.Contracts.Requests.CancelWithdrawalRequest": { "type": "object", "properties": { "reason": { "type": "string", "nullable": true } }, "additionalProperties": false }, "Withdrawals.Contracts.Requests.CreateWithdrawalDestinationRequest": { "type": "object", "properties": { "address": { "type": "string", "nullable": true }, "assetNetworkId": { "type": "string", "format": "uuid" } }, "additionalProperties": false }, "Withdrawals.Contracts.Requests.RequestWithdrawalRequest": { "type": "object", "properties": { "environmentId": { "type": "string", "format": "uuid" }, "accountId": { "type": "string", "format": "uuid" }, "withdrawalDestinationId": { "type": "string", "format": "uuid" }, "assetNetworkId": { "type": "string", "format": "uuid" }, "amount": { "type": "number", "format": "double" }, "idempotencyKey": { "type": "string", "nullable": true } }, "additionalProperties": false }, "Withdrawals.Contracts.Requests.WithdrawalQuoteRequest": { "type": "object", "properties": { "environmentId": { "type": "string", "format": "uuid" }, "accountId": { "type": "string", "format": "uuid" }, "withdrawalDestinationId": { "type": "string", "format": "uuid" }, "assetNetworkId": { "type": "string", "format": "uuid" }, "amount": { "type": "number", "format": "double" } }, "additionalProperties": false }, "Withdrawals.Contracts.Responses.WithdrawalQuoteResponse": { "type": "object", "properties": { "accountId": { "type": "string", "format": "uuid" }, "withdrawalDestinationId": { "type": "string", "format": "uuid" }, "assetNetworkId": { "type": "string", "format": "uuid" }, "requestedAmount": { "type": "number", "format": "double" }, "estimatedNetworkFee": { "type": "number", "format": "double", "nullable": true, "deprecated": true }, "estimatedRecipientAmount": { "type": "number", "format": "double" }, "networkExecutionCost": { "type": "number", "format": "double" }, "expiresAt": { "type": "string", "format": "date-time" } }, "additionalProperties": false }, "Withdrawals.Contracts.Responses.WithdrawalResponse": { "type": "object", "properties": { "withdrawalId": { "type": "string", "format": "uuid" }, "organizationId": { "type": "string", "format": "uuid" }, "environmentId": { "type": "string", "format": "uuid" }, "accountId": { "type": "string", "format": "uuid" }, "withdrawalDestinationId": { "type": "string", "format": "uuid" }, "assetNetworkId": { "type": "string", "format": "uuid" }, "amount": { "type": "number", "format": "double" }, "estimatedNetworkFee": { "type": "number", "format": "double", "nullable": true, "deprecated": true }, "estimatedRecipientAmount": { "type": "number", "format": "double" }, "finalNetworkFee": { "type": "number", "format": "double", "nullable": true, "deprecated": true }, "finalRecipientAmount": { "type": "number", "format": "double", "nullable": true }, "status": { "$ref": "#/components/schemas/Withdrawals.Contracts.Enums.WithdrawalStatus" }, "entryGroupId": { "type": "string", "format": "uuid", "nullable": true }, "technicalReference": { "type": "string", "nullable": true }, "signingRequestId": { "type": "string", "format": "uuid", "nullable": true }, "networkExecutionCost": { "type": "number", "format": "double", "nullable": true }, "networkExecutionCostStatus": { "$ref": "#/components/schemas/Withdrawals.Contracts.Enums.NetworkExecutionCostStatus" }, "createdAt": { "type": "string", "format": "date-time" } }, "additionalProperties": false }, "WorkflowRules.Contracts.Commands.ConditionInput": { "type": "object", "properties": { "field": { "type": "string", "nullable": true }, "operator": { "$ref": "#/components/schemas/WorkflowRules.Contracts.Enums.ConditionOperator" }, "expectedValue": { "type": "string", "nullable": true } }, "additionalProperties": false }, "WorkflowRules.Contracts.Commands.StateInput": { "type": "object", "properties": { "id": { "type": "string", "format": "uuid" }, "name": { "type": "string", "nullable": true }, "isInitial": { "type": "boolean" }, "isFinal": { "type": "boolean" } }, "additionalProperties": false }, "WorkflowRules.Contracts.Commands.TransitionInput": { "type": "object", "properties": { "id": { "type": "string", "format": "uuid" }, "fromStateId": { "type": "string", "format": "uuid" }, "toStateId": { "type": "string", "format": "uuid" } }, "additionalProperties": false }, "WorkflowRules.Contracts.Enums.ConditionOperator": { "enum": [ 1, 2, 3 ], "type": "integer", "format": "int32" }, "WorkflowRules.Contracts.Enums.EventSource": { "enum": [ 1, 2, 3 ], "type": "integer", "format": "int32" }, "WorkflowRules.Contracts.Requests.CreateEventTypeRequest": { "type": "object", "properties": { "name": { "type": "string", "nullable": true } }, "additionalProperties": false }, "WorkflowRules.Contracts.Requests.CreateRuleRequest": { "type": "object", "properties": { "fromStateId": { "type": "string", "format": "uuid" }, "toStateId": { "type": "string", "format": "uuid" }, "eventTypeId": { "type": "string", "format": "uuid" }, "conditions": { "type": "array", "items": { "$ref": "#/components/schemas/WorkflowRules.Contracts.Commands.ConditionInput" }, "nullable": true } }, "additionalProperties": false }, "WorkflowRules.Contracts.Requests.CreateWorkflowRequest": { "type": "object", "properties": { "name": { "type": "string", "nullable": true } }, "additionalProperties": false }, "WorkflowRules.Contracts.Requests.CreateWorkflowVersionRequest": { "type": "object", "properties": { "states": { "type": "array", "items": { "$ref": "#/components/schemas/WorkflowRules.Contracts.Commands.StateInput" }, "nullable": true }, "transitions": { "type": "array", "items": { "$ref": "#/components/schemas/WorkflowRules.Contracts.Commands.TransitionInput" }, "nullable": true } }, "additionalProperties": false }, "WorkflowRules.Contracts.Requests.IngestEventRequest": { "type": "object", "properties": { "workflowVersionId": { "type": "string", "format": "uuid" }, "currentStateId": { "type": "string", "format": "uuid" }, "transactionReference": { "type": "string", "format": "uuid" }, "eventTypeId": { "type": "string", "format": "uuid" }, "idempotencyKey": { "type": "string", "nullable": true }, "payload": { "type": "object", "additionalProperties": { "type": "string" }, "nullable": true }, "eventSource": { "$ref": "#/components/schemas/WorkflowRules.Contracts.Enums.EventSource" } }, "additionalProperties": false }, "WorkflowRules.Contracts.Responses.ConditionResponse": { "type": "object", "properties": { "field": { "type": "string", "nullable": true }, "operator": { "$ref": "#/components/schemas/WorkflowRules.Contracts.Enums.ConditionOperator" }, "expectedValue": { "type": "string", "nullable": true } }, "additionalProperties": false }, "WorkflowRules.Contracts.Responses.EventIngestionResult": { "type": "object", "properties": { "eventId": { "type": "string", "format": "uuid" }, "outcome": { "type": "string", "nullable": true }, "rejectionReason": { "type": "string", "nullable": true }, "fromStateId": { "type": "string", "format": "uuid", "nullable": true }, "toStateId": { "type": "string", "format": "uuid", "nullable": true }, "ruleId": { "type": "string", "format": "uuid", "nullable": true } }, "additionalProperties": false }, "WorkflowRules.Contracts.Responses.EventTypeResponse": { "type": "object", "properties": { "eventTypeId": { "type": "string", "format": "uuid" }, "organizationId": { "type": "string", "format": "uuid", "nullable": true }, "name": { "type": "string", "nullable": true }, "createdAt": { "type": "string", "format": "date-time" } }, "additionalProperties": false }, "WorkflowRules.Contracts.Responses.RuleResponse": { "type": "object", "properties": { "ruleId": { "type": "string", "format": "uuid" }, "fromStateId": { "type": "string", "format": "uuid" }, "toStateId": { "type": "string", "format": "uuid" }, "eventTypeId": { "type": "string", "format": "uuid" }, "conditions": { "type": "array", "items": { "$ref": "#/components/schemas/WorkflowRules.Contracts.Responses.ConditionResponse" }, "nullable": true } }, "additionalProperties": false }, "WorkflowRules.Contracts.Responses.StateResponse": { "type": "object", "properties": { "stateId": { "type": "string", "format": "uuid" }, "name": { "type": "string", "nullable": true }, "isInitial": { "type": "boolean" }, "isFinal": { "type": "boolean" } }, "additionalProperties": false }, "WorkflowRules.Contracts.Responses.TransitionResponse": { "type": "object", "properties": { "transitionId": { "type": "string", "format": "uuid" }, "fromStateId": { "type": "string", "format": "uuid" }, "toStateId": { "type": "string", "format": "uuid" } }, "additionalProperties": false }, "WorkflowRules.Contracts.Responses.WorkflowResponse": { "type": "object", "properties": { "workflowId": { "type": "string", "format": "uuid" }, "organizationId": { "type": "string", "format": "uuid" }, "name": { "type": "string", "nullable": true }, "status": { "type": "string", "nullable": true }, "createdAt": { "type": "string", "format": "date-time" }, "versionIds": { "type": "array", "items": { "type": "string", "format": "uuid" }, "nullable": true } }, "additionalProperties": false }, "WorkflowRules.Contracts.Responses.WorkflowVersionResponse": { "type": "object", "properties": { "workflowVersionId": { "type": "string", "format": "uuid" }, "workflowId": { "type": "string", "format": "uuid" }, "status": { "type": "string", "nullable": true }, "createdAt": { "type": "string", "format": "date-time" }, "publishedAt": { "type": "string", "format": "date-time", "nullable": true }, "states": { "type": "array", "items": { "$ref": "#/components/schemas/WorkflowRules.Contracts.Responses.StateResponse" }, "nullable": true }, "transitions": { "type": "array", "items": { "$ref": "#/components/schemas/WorkflowRules.Contracts.Responses.TransitionResponse" }, "nullable": true }, "rules": { "type": "array", "items": { "$ref": "#/components/schemas/WorkflowRules.Contracts.Responses.RuleResponse" }, "nullable": true } }, "additionalProperties": false } } } }