A settlement is a proposal to move assets between wallets owned by two participants.
When the settlement status is ActionNeeded, refer to your participant's settlement side (proposerSide or acceptorSide) for more detailed information. Fields on the settlement side reflect the individual actions needed.
Show child attributes
Was this page helpful?
{"docsConfig":{"theme":"mint","$schema":"https://mintlify.com/docs.json","name":"Anchorage Digital","colors":{"primary":"#5580F6","light":"#5580F6","dark":"#5580F6"},"logo":{"light":"https://mintcdn.com/deployment-4/ikVMLMsizDmk_7Sw/knowledge-base/images/logo-lockup-dark.svg?fit=max\u0026auto=format\u0026n=ikVMLMsizDmk_7Sw\u0026q=85\u0026s=87028c6755f355e278de66991913b91c","dark":"https://mintcdn.com/deployment-4/ikVMLMsizDmk_7Sw/knowledge-base/images/logo-lockup-light.svg?fit=max\u0026auto=format\u0026n=ikVMLMsizDmk_7Sw\u0026q=85\u0026s=1b56e9a2511c5c765bb60eb80f10491d","href":"/"},"favicon":{"light":"https://mintcdn.com/deployment-4/GSah06OFrRxxO1iB/knowledge-base/favicon-symbol.svg?fit=max\u0026auto=format\u0026n=GSah06OFrRxxO1iB\u0026q=85\u0026s=dbc56a4b9970aa0cc3b83e27e2063715","dark":"https://mintcdn.com/deployment-4/GSah06OFrRxxO1iB/knowledge-base/favicon-symbol.svg?fit=max\u0026auto=format\u0026n=GSah06OFrRxxO1iB\u0026q=85\u0026s=dbc56a4b9970aa0cc3b83e27e2063715"},"api":{"playground":{"display":"interactive"},"examples":{"languages":["curl","python","javascript"]}},"appearance":{"default":"system"},"background":{"color":{"light":"#F4F5F5","dark":"#000"}},"navbar":{"links":[{"href":"/knowledge-base/login","label":"Log in"},{"href":"https://www.anchorage.com","label":"Anchorage.com"},{"href":"https://www.anchorage.com/get-in-touch","label":"Contact"}]},"footer":{"socials":{"x":"https://x.com/Anchorage","linkedin":"https://www.linkedin.com/company/anchorage","youtube":"https://www.youtube.com/c/AnchorageDigital"}},"styling":{"eyebrows":"breadcrumbs","latex":true},"errors":{"404":{"redirect":true,"title":"Oops, something went wrong","description":"The content you're looking for is missing. Contact Anchorage Digital for support."}},"contextual":{"options":["claude","mcp","add-mcp","copy","view","assistant","chatgpt","perplexity","grok","aistudio","devin","windsurf","cursor","vscode","devin-mcp"],"display":"header"},"navigation":{"pages":[]}},"deployment":{"deploymentMetadataValue":{"subdomain":"deployment-4","hasAudioNarration":false,"actualSubdomain":"deployment-4","customDomains":["docs.anchorage.com"],"gitSource":{"_id":"6ad7fa92692c7c940ff17a2f","type":"github","owner":"anchorlabsinc","repo":"knowledge-base","deployBranch":"main","contentDirectory":"","isPrivate":true,"mountPath":"knowledge-base","label":""},"feedback":{"agentFeedback":true,"contextualFeedback":{"allowEmail":true},"thumbs":true},"entitlements":{"AI_CHAT":{"status":"ENABLED"},"REMOVE_BRANDING":{"status":"ENABLED"},"CONTEXTUAL_FEEDBACK":{"status":"ENABLED"},"CODE_SNIPPET_FEEDBACK":{"status":"ENABLED"},"WEB_MCP":{"status":"ENABLED"},"NARRATION":{"status":"ENABLED"}},"buildId":"6aef8d2759edac7bace6f9b1","clientVersion":"0.0.4087","searchFilterCounts":[{"language":"default","tag":"Anchorage Digital","count":348},{"language":"default","tag":"API reference","count":325},{"language":"default","tag":"v2","count":304},{"language":"default","tag":"Porto","count":248},{"language":"default","tag":"User guides","count":161},{"language":"default","tag":"Developer guides","count":100},{"language":"default","tag":"Wealth Management \u0026 ETF","count":88},{"language":"default","tag":"Trading","count":87},{"language":"default","tag":"Move money","count":78},{"language":"default","tag":"Platform","count":65}],"searchSettings":{"isFiltersEnabled":true}},"assistantConfig":{"enableAskAiButton":false,"enableStarterQuestions":false,"enableContextualStarterQuestions":false,"enableAskAiSearchBar":true},"basePath":"","hasChatPermissions":true,"hasWebMcpPermissions":true,"toggles":[{"name":"kill-isr","enabled":true,"variant":{"name":"disabled","enabled":false,"feature_enabled":true},"impressionData":false},{"name":"agent-mintlify-slack","enabled":true,"variant":{"name":"disabled","enabled":false,"feature_enabled":true},"impressionData":false},{"name":"agent-integrations-settings","enabled":true,"variant":{"name":"disabled","enabled":false,"feature_enabled":true},"impressionData":false},{"name":"rbac-expansion","enabled":true,"variant":{"name":"disabled","enabled":false,"feature_enabled":true},"impressionData":false},{"name":"automations-pr-grouping","enabled":true,"variant":{"name":"disabled","enabled":false,"feature_enabled":true},"impressionData":false},{"name":"custom-prefix","enabled":true,"variant":{"name":"disabled","enabled":false,"feature_enabled":true},"impressionData":false},{"name":"analytics-v7","enabled":true,"variant":{"name":"disabled","enabled":false,"feature_enabled":true},"impressionData":false},{"name":"user-flows-analytics","enabled":true,"variant":{"name":"disabled","enabled":false,"feature_enabled":true},"impressionData":false},{"name":"no-publish-flow","enabled":true,"variant":{"name":"disabled","enabled":false,"feature_enabled":true},"impressionData":false},{"name":"workos-onboarding","enabled":true,"variant":{"name":"disabled","enabled":false,"feature_enabled":true},"impressionData":false},{"name":"llms-txt-v2","enabled":true,"variant":{"name":"disabled","enabled":false,"feature_enabled":true},"impressionData":false},{"name":"snapshot-serving-live","enabled":true,"variant":{"name":"disabled","enabled":false,"feature_enabled":true},"impressionData":false},{"name":"stripTemperatureMiddleware","enabled":true,"variant":{"name":"disabled","enabled":false,"feature_enabled":true},"impressionData":false},{"name":"support-platform-pylon-zendesk","enabled":true,"variant":{"name":"disabled","enabled":false,"feature_enabled":true},"impressionData":false},{"name":"snapshot-serving","enabled":true,"variant":{"name":"disabled","enabled":false,"feature_enabled":true},"impressionData":false},{"name":"instant-rollback","enabled":true,"variant":{"name":"disabled","enabled":false,"feature_enabled":true},"impressionData":false},{"name":"granular-notifications-server","enabled":true,"variant":{"name":"disabled","enabled":false,"feature_enabled":true},"impressionData":false},{"name":"granular-notifications","enabled":true,"variant":{"name":"disabled","enabled":false,"feature_enabled":true},"impressionData":false},{"name":"automations-fable","enabled":true,"variant":{"name":"disabled","enabled":false,"feature_enabled":true},"impressionData":false},{"name":"fixed-ai-action-pricing","enabled":true,"variant":{"name":"disabled","enabled":false,"feature_enabled":true},"impressionData":false},{"name":"automation-resolve-merge-conflict","enabled":true,"variant":{"name":"disabled","enabled":false,"feature_enabled":true},"impressionData":false},{"name":"scoped-publishing","enabled":true,"variant":{"name":"disabled","enabled":false,"feature_enabled":true},"impressionData":false},{"name":"mintql","enabled":true,"variant":{"name":"disabled","enabled":false,"feature_enabled":true},"impressionData":false},{"name":"page-level-analytics","enabled":true,"variant":{"name":"disabled","enabled":false,"feature_enabled":true},"impressionData":false},{"name":"editor-version-history-v2","enabled":true,"variant":{"name":"disabled","enabled":false,"feature_enabled":true},"impressionData":false},{"name":"billing-page-v2","enabled":true,"variant":{"name":"disabled","enabled":false,"feature_enabled":true},"impressionData":false},{"name":"full-page-search","enabled":true,"variant":{"name":"disabled","enabled":false,"feature_enabled":true},"impressionData":false},{"name":"workspace-projects","enabled":true,"variant":{"name":"disabled","enabled":false,"feature_enabled":true},"impressionData":false},{"name":"assistant-v5","enabled":true,"variant":{"name":"disabled","enabled":false,"feature_enabled":true},"impressionData":false},{"name":"fork-pr-previews","enabled":true,"variant":{"name":"disabled","enabled":false,"feature_enabled":true},"impressionData":false},{"name":"revalidation-jwt","enabled":true,"variant":{"name":"disabled","enabled":false,"feature_enabled":true},"impressionData":false},{"name":"workos-sso-scim","enabled":true,"variant":{"name":"disabled","enabled":false,"feature_enabled":true},"impressionData":false},{"name":"hobby-abuse-scan","enabled":true,"variant":{"name":"disabled","enabled":false,"feature_enabled":true},"impressionData":false},{"name":"dashboard-inbox","enabled":true,"variant":{"name":"disabled","enabled":false,"feature_enabled":true},"impressionData":false},{"name":"workos-signup","enabled":true,"variant":{"name":"disabled","enabled":false,"feature_enabled":true},"impressionData":false},{"name":"turbopuffer-dual-write","enabled":true,"variant":{"name":"disabled","enabled":false,"feature_enabled":true},"impressionData":false},{"name":"workos-enabled","enabled":true,"variant":{"name":"disabled","enabled":false,"feature_enabled":true},"impressionData":false},{"name":"approve-review-flow","enabled":true,"variant":{"name":"disabled","enabled":false,"feature_enabled":true},"impressionData":false},{"name":"editor-metadata","enabled":true,"variant":{"name":"disabled","enabled":false,"feature_enabled":true},"impressionData":false},{"name":"sso-setup-deadline-banner","enabled":true,"variant":{"name":"disabled","enabled":false,"feature_enabled":true},"impressionData":false},{"name":"turbopuffer-serve","enabled":true,"variant":{"name":"disabled","enabled":false,"feature_enabled":true},"impressionData":false},{"name":"live-agents","enabled":true,"variant":{"name":"disabled","enabled":false,"feature_enabled":true},"impressionData":false},{"name":"comment-mode","enabled":true,"variant":{"name":"disabled","enabled":false,"feature_enabled":true},"impressionData":false}],"googleFontsInlined":false},"customCss":[{"filePath":"knowledge-base/custom.css","href":"/_mintlify/custom/deployment-4/3851477207c6fc6b/knowledge-base/custom.css"}],"page":{"pagePath":"knowledge-base/porto/api-reference/v2/atlas-settlement-network/get-a-settlement-by-id","slug":"/knowledge-base/porto/api-reference/v2/atlas-settlement-network/get-a-settlement-by-id","pageMetadata":{"title":"Get a settlement by ID","description":"Permissions required: **Read vault activity**\n\n\nGet a single settlement by its ID.","deprecated":null,"version":null,"openapi":"/knowledge-base/openapi/v2.yaml get /atlas/settlements/{settlementId}","href":"/knowledge-base/porto/api-reference/v2/atlas-settlement-network/get-a-settlement-by-id","autogeneratedByOpenApi":true},"description":{"compiledSource":"\"use strict\";\nconst {Fragment: _Fragment, jsx: _jsx, jsxs: _jsxs} = arguments[0];\nconst {useMDXComponents: _provideComponents} = arguments[0];\nfunction _createMdxContent(props) {\n const _components = {\n p: \"p\",\n strong: \"strong\",\n ..._provideComponents(),\n ...props.components\n };\n return _jsxs(_Fragment, {\n children: [_jsxs(_components.p, {\n children: [\"Permissions required: \", _jsx(_components.strong, {\n children: \"Read vault activity\"\n })]\n }), \"\\n\", _jsx(_components.p, {\n children: \"Get a single settlement by its ID.\"\n })]\n });\n}\nfunction MDXContent(props = {}) {\n const {wrapper: MDXLayout} = {\n ..._provideComponents(),\n ...props.components\n };\n return MDXLayout ? _jsx(MDXLayout, {\n ...props,\n children: _jsx(_createMdxContent, {\n ...props\n })\n }) : _createMdxContent(props);\n}\nreturn {\n default: MDXContent\n};\n","frontmatter":{},"scope":{}},"pageType":"default","mdx":{"mdxSource":{"compiledSource":"\"use strict\";const{Fragment:_Fragment,jsx:_jsx}=arguments[0];const{useMDXComponents:_provideComponents}=arguments[0];function _createMdxContent(props){return _jsx(_Fragment,{})}function MDXContent(props={}){const{wrapper:MDXLayout}={..._provideComponents(),...props.components};return MDXLayout?_jsx(MDXLayout,{...props,children:_jsx(_createMdxContent,{...props})}):_createMdxContent(props)}return{default:MDXContent}","frontmatter":{},"scope":{"config":{},"pageMetadata":{"title":"Get a settlement by ID","description":"Permissions required: **Read vault activity**\n\n\nGet a single settlement by its ID.","deprecated":null,"version":null,"openapi":"/knowledge-base/openapi/v2.yaml get /atlas/settlements/{settlementId}","href":"/knowledge-base/porto/api-reference/v2/atlas-settlement-network/get-a-settlement-by-id","autogeneratedByOpenApi":true}}},"mdxSourceWithNoJs":null},"mdxExtracts":{"tableOfContents":[],"codeExamples":{}},"jsLinks":[],"openApiReferenceData":{"operation":{"operationId":"getSNSettlement","summary":"Get a settlement by ID","description":"Permissions required: **Read vault activity**\n\n\nGet a single settlement by its ID.","parameters":["c1129092-3b89-434a-ba59-ef135b78ee31"],"responses":{"200":"b6310b71-5c5e-4220-9a86-9ed3fa6bea4d","401":"6aae6d67-02f5-4d49-b8e6-7fecf80c49f9","403":"7bb08d85-56ee-48db-8f46-8efacf4a6fb5","404":"a9c531e0-a62e-4100-b61f-f5896bfe72c2","429":"7e0d7b9a-ed28-452e-97f0-e0dcf0803620","500":"de37b532-0142-4db2-a6b7-7c7c68d56f3a"},"tags":["Atlas Settlement Network"],"method":"get","type":"path","servers":["7397ebb6-50b3-4fc6-8917-b19efb878ee2"],"security":["5b3cf261-712a-4610-9947-c09c584c7a47"],"path":"/atlas/settlements/{settlementId}","baseUrlOptions":["https://api.anchorage-staging.com/v2"],"title":"Get a settlement by ID","codeSamples":[],"requestExampleLanguages":["bash","python","javascript"],"requiredOnlyExamples":false,"requestExampleType":"generated","responseExampleType":"generated"},"dependencies":{"parameters":{"c1129092-3b89-434a-ba59-ef135b78ee31":{"name":"settlementId","in":"path","description":"ID of settlement to fetch","required":true,"schema":{"type":"string","minLength":1,"isRequired":true,"description":"ID of settlement to fetch","uniqueKey":"","typeLabel":"string"}}},"responses":{"b6310b71-5c5e-4220-9a86-9ed3fa6bea4d":{"description":"settlement","content":{"application/json":{"schema":{"type":"object","properties":{"settlement":{"description":"A settlement is a proposal to move assets between wallets owned by two participants.\n\nWhen the settlement status is `ActionNeeded`, refer to your participant's settlement side (`proposerSide` or `acceptorSide`) for more detailed information. Fields on the settlement side reflect the individual actions needed.","type":"object","properties":{"acceptorSide":{"type":"object","properties":{"participantId":{"type":"string","isRequired":true,"uniqueKey":"settlement.acceptorSide.participantId","typeLabel":"string"},"authorized":{"description":"This can be null if authorization is not required or if the caller doesn't have access to this information.","type":"boolean","uniqueKey":"settlement.acceptorSide.authorized","typeLabel":"boolean"},"feesFunded":{"description":"This can be null if the caller doesn't have access to this information. Fees funded status is based on the same fee logic as transfers and is checked independently of any other settlements. It takes into account only the current available balance for the relevant wallet. If the primary amount and fee amount are the of same asset, the primary amount is also taken into account when calculating this.","type":"boolean","uniqueKey":"settlement.acceptorSide.feesFunded","typeLabel":"boolean"},"funded":{"description":"This can be null if the caller doesn't have access to this information. The funded status does not include fees and is checked independently of any other settlements. It takes into account only the current available balance for the relevant wallet.","type":"boolean","uniqueKey":"settlement.acceptorSide.funded","typeLabel":"boolean"},"gasStationEnabled":{"description":"Indicates the Gas Station is enabled to cover fees for this participant. This can be null if the caller doesn't have access to this information.","type":"boolean","uniqueKey":"settlement.acceptorSide.gasStationEnabled","typeLabel":"boolean"},"walletAmounts":{"type":"array","items":{"type":"object","properties":{"assetType":{"description":"A string representing a type of crypto-asset, which usually corresponds to the crypto asset's ticker symbol.\nUse `/asset-types` to list all of the supported asset types for your organization.","type":"string","example":"BTC","isRequired":true,"uniqueKey":"settlement.acceptorSide.walletAmounts.items.[INDEX].assetType","typeLabel":"string"},"quantity":{"description":"The numeric value of this amount, excluding units. Use positive numbers for receiving and negative for sending assets. Amounts never include fees.","type":"string","example":"10.45234733","isRequired":true,"uniqueKey":"settlement.acceptorSide.walletAmounts.items.[INDEX].quantity","typeLabel":"string"},"walletId":{"type":"string","uniqueKey":"settlement.acceptorSide.walletAmounts.items.[INDEX].walletId","typeLabel":"string"}},"required":["assetType","quantity"],"uniqueKey":"settlement.acceptorSide.walletAmounts.items.[INDEX]","typeLabel":"object"},"uniqueKey":"settlement.acceptorSide.walletAmounts","typeLabel":"object[]"}},"required":["participantId"],"isRequired":true,"uniqueKey":"settlement.acceptorSide","typeLabel":"object"},"clientReferenceId":{"description":"An ID, set by the proposer, visible to both sides, to uniquely identify the purpose of the settlement so that both sides can account for it correctly.","type":"string","isRequired":true,"uniqueKey":"settlement.clientReferenceId","typeLabel":"string"},"pendingAcceptorReview":{"description":"a flag indicating whether the settlement is awaiting acceptor selection","type":"boolean","isRequired":true,"uniqueKey":"settlement.pendingAcceptorReview","typeLabel":"boolean"},"proposerSide":{"type":"object","properties":{"participantId":{"type":"string","isRequired":true,"uniqueKey":"settlement.proposerSide.participantId","typeLabel":"string"},"authorized":{"description":"This can be null if authorization is not required or if the caller doesn't have access to this information.","type":"boolean","uniqueKey":"settlement.proposerSide.authorized","typeLabel":"boolean"},"feesFunded":{"description":"This can be null if the caller doesn't have access to this information. Fees funded status is based on the same fee logic as transfers and is checked independently of any other settlements. It takes into account only the current available balance for the relevant wallet. If the primary amount and fee amount are the of same asset, the primary amount is also taken into account when calculating this.","type":"boolean","uniqueKey":"settlement.proposerSide.feesFunded","typeLabel":"boolean"},"funded":{"description":"This can be null if the caller doesn't have access to this information. The funded status does not include fees and is checked independently of any other settlements. It takes into account only the current available balance for the relevant wallet.","type":"boolean","uniqueKey":"settlement.proposerSide.funded","typeLabel":"boolean"},"gasStationEnabled":{"description":"Indicates the Gas Station is enabled to cover fees for this participant. This can be null if the caller doesn't have access to this information.","type":"boolean","uniqueKey":"settlement.proposerSide.gasStationEnabled","typeLabel":"boolean"},"walletAmounts":{"type":"array","items":{"type":"object","properties":{"assetType":{"description":"A string representing a type of crypto-asset, which usually corresponds to the crypto asset's ticker symbol.\nUse `/asset-types` to list all of the supported asset types for your organization.","type":"string","example":"BTC","isRequired":true,"uniqueKey":"settlement.proposerSide.walletAmounts.items.[INDEX].assetType","typeLabel":"string"},"quantity":{"description":"The numeric value of this amount, excluding units. Use positive numbers for receiving and negative for sending assets. Amounts never include fees.","type":"string","example":"10.45234733","isRequired":true,"uniqueKey":"settlement.proposerSide.walletAmounts.items.[INDEX].quantity","typeLabel":"string"},"walletId":{"type":"string","uniqueKey":"settlement.proposerSide.walletAmounts.items.[INDEX].walletId","typeLabel":"string"}},"required":["assetType","quantity"],"uniqueKey":"settlement.proposerSide.walletAmounts.items.[INDEX]","typeLabel":"object"},"uniqueKey":"settlement.proposerSide.walletAmounts","typeLabel":"object[]"}},"required":["participantId"],"isRequired":true,"uniqueKey":"settlement.proposerSide","typeLabel":"object"},"settlementId":{"type":"string","isRequired":true,"uniqueKey":"settlement.settlementId","typeLabel":"string"},"state":{"type":"string","enum":["ActionNeeded","CounterpartyActionNeeded","Executing","TimedOut","Rejected","Executed","Failed"],"isRequired":true,"uniqueKey":"settlement.state","typeLabel":"enum\u003cstring>"}},"required":["settlementId","proposerSide","acceptorSide","state","clientReferenceId","pendingAcceptorReview"],"isRequired":true,"uniqueKey":"settlement","typeLabel":"object"}},"required":["settlement"],"uniqueKey":"","typeLabel":"object"},"examples":{"Example":{"title":"Example","value":{"settlement":{"acceptorSide":{"participantId":"\u003cstring>","authorized":true,"feesFunded":true,"funded":true,"gasStationEnabled":true,"walletAmounts":[{"assetType":"BTC","quantity":"10.45234733","walletId":"\u003cstring>"}]},"clientReferenceId":"\u003cstring>","pendingAcceptorReview":true,"proposerSide":{"participantId":"\u003cstring>","authorized":true,"feesFunded":true,"funded":true,"gasStationEnabled":true,"walletAmounts":[{"assetType":"BTC","quantity":"10.45234733","walletId":"\u003cstring>"}]},"settlementId":"\u003cstring>","state":"ActionNeeded"}}}},"exampleType":"generated"}},"exampleType":"generated"},"6aae6d67-02f5-4d49-b8e6-7fecf80c49f9":{"description":"Unauthenticated","content":{"application/json":{"schema":{"type":"object","properties":{"errorType":{"description":"The type of error returned.","type":"string","enum":["InternalError","InvalidRequest","Unauthenticated","Forbidden","NotFound","Conflict","UnprocessableEntity","TooManyRequests","ServiceUnavailable","QuoteExpired","InsufficientFunds","NotImplemented","MissingControlKey","InvalidControlKeyFormat"],"title":"ErrorType","isRequired":true,"uniqueKey":"errorType","typeLabel":"enum\u003cstring>"},"message":{"description":"A human-readable message providing more details about the error.","type":"string","example":"Missing required field 'amount'.","isRequired":true,"uniqueKey":"message","typeLabel":"string"}},"required":["errorType","message"],"title":"ErrorDetails","uniqueKey":"","typeLabel":"ErrorDetails · object"},"examples":{"Example":{"title":"Example","value":{"errorType":"InternalError","message":"Missing required field 'amount'."}}},"exampleType":"generated"}},"exampleType":"generated"},"7bb08d85-56ee-48db-8f46-8efacf4a6fb5":{"description":"Forbidden","content":{"application/json":{"schema":{"type":"object","properties":{"errorType":{"description":"The type of error returned.","type":"string","enum":["InternalError","InvalidRequest","Unauthenticated","Forbidden","NotFound","Conflict","UnprocessableEntity","TooManyRequests","ServiceUnavailable","QuoteExpired","InsufficientFunds","NotImplemented","MissingControlKey","InvalidControlKeyFormat"],"title":"ErrorType","isRequired":true,"uniqueKey":"errorType","typeLabel":"enum\u003cstring>"},"message":{"description":"A human-readable message providing more details about the error.","type":"string","example":"Missing required field 'amount'.","isRequired":true,"uniqueKey":"message","typeLabel":"string"}},"required":["errorType","message"],"title":"ErrorDetails","uniqueKey":"","typeLabel":"ErrorDetails · object"},"examples":{"Example":{"title":"Example","value":{"errorType":"InternalError","message":"Missing required field 'amount'."}}},"exampleType":"generated"}},"exampleType":"generated"},"a9c531e0-a62e-4100-b61f-f5896bfe72c2":{"description":"Not Found","content":{"application/json":{"schema":{"type":"object","properties":{"errorType":{"description":"The type of error returned.","type":"string","enum":["InternalError","InvalidRequest","Unauthenticated","Forbidden","NotFound","Conflict","UnprocessableEntity","TooManyRequests","ServiceUnavailable","QuoteExpired","InsufficientFunds","NotImplemented","MissingControlKey","InvalidControlKeyFormat"],"title":"ErrorType","isRequired":true,"uniqueKey":"errorType","typeLabel":"enum\u003cstring>"},"message":{"description":"A human-readable message providing more details about the error.","type":"string","example":"Missing required field 'amount'.","isRequired":true,"uniqueKey":"message","typeLabel":"string"}},"required":["errorType","message"],"title":"ErrorDetails","uniqueKey":"","typeLabel":"ErrorDetails · object"},"examples":{"Example":{"title":"Example","value":{"errorType":"InternalError","message":"Missing required field 'amount'."}}},"exampleType":"generated"}},"exampleType":"generated"},"7e0d7b9a-ed28-452e-97f0-e0dcf0803620":{"description":"Too Many Requests","content":{"application/json":{"schema":{"type":"object","properties":{"errorType":{"description":"The type of error returned.","type":"string","enum":["InternalError","InvalidRequest","Unauthenticated","Forbidden","NotFound","Conflict","UnprocessableEntity","TooManyRequests","ServiceUnavailable","QuoteExpired","InsufficientFunds","NotImplemented","MissingControlKey","InvalidControlKeyFormat"],"title":"ErrorType","isRequired":true,"uniqueKey":"errorType","typeLabel":"enum\u003cstring>"},"message":{"description":"A human-readable message providing more details about the error.","type":"string","example":"Missing required field 'amount'.","isRequired":true,"uniqueKey":"message","typeLabel":"string"}},"required":["errorType","message"],"title":"ErrorDetails","uniqueKey":"","typeLabel":"ErrorDetails · object"},"examples":{"Example":{"title":"Example","value":{"errorType":"InternalError","message":"Missing required field 'amount'."}}},"exampleType":"generated"}},"exampleType":"generated"},"de37b532-0142-4db2-a6b7-7c7c68d56f3a":{"description":"Internal Server Error","content":{"application/json":{"schema":{"type":"object","properties":{"errorType":{"description":"The type of error returned.","type":"string","enum":["InternalError","InvalidRequest","Unauthenticated","Forbidden","NotFound","Conflict","UnprocessableEntity","TooManyRequests","ServiceUnavailable","QuoteExpired","InsufficientFunds","NotImplemented","MissingControlKey","InvalidControlKeyFormat"],"title":"ErrorType","isRequired":true,"uniqueKey":"errorType","typeLabel":"enum\u003cstring>"},"message":{"description":"A human-readable message providing more details about the error.","type":"string","example":"Missing required field 'amount'.","isRequired":true,"uniqueKey":"message","typeLabel":"string"}},"required":["errorType","message"],"title":"ErrorDetails","uniqueKey":"","typeLabel":"ErrorDetails · object"},"examples":{"Example":{"title":"Example","value":{"errorType":"InternalError","message":"Missing required field 'amount'."}}},"exampleType":"generated"}},"exampleType":"generated"}},"security":{"5b3cf261-712a-4610-9947-c09c584c7a47":{"Api-Access-Key":{"type":"apiKey","name":"Api-Access-Key","in":"header","description":"An API key associated with a security role","scopes":[],"schemeName":"Api-Access-Key"}}},"servers":{"7397ebb6-50b3-4fc6-8917-b19efb878ee2":{"url":"https://api.anchorage-staging.com/v2"}},"processedSecurityOptions":[{"schemes":[{"scheme":{"type":"apiKey","name":"Api-Access-Key","in":"header","description":"An API key associated with a security role","scopes":[],"schemeName":"Api-Access-Key"},"schema":{"title":"Api-Access-Key","type":"string","description":"An API key associated with a security role","isRequired":true,"typeLabel":"string","deprecated":false},"schemeName":"Api-Access-Key","name":"Api-Access-Key"}],"title":"Api-Access-Key"}]},"originalFileLocation":"knowledge-base/openapi/v2.yaml"},"subdomain":"deployment-4","siteName":"Anchorage Digital","title":"Get a settlement by ID - Anchorage Digital","relatedPagesConfig":{"enabled":true,"limit":5,"mode":"automatic"},"navMaps":{"firstHrefInVersion":{},"firstHrefInLanguage":{}},"lastModified":"2026-11-05T17:20:13.805Z","originalFileLocation":"knowledge-base/porto/api-reference/v2/atlas-settlement-network/get-a-settlement-by-id.mdx"},"headHtml":"\u003cscript data-mint-head>(function(){var d=document.documentElement,p=null;if(!p){try{p=localStorage.getItem(\"isDarkMode\")}catch(e){}if(p==='true')p='dark';else if(p==='false')p='light';if(p!=='light'\u0026\u0026p!=='dark'\u0026\u0026p!=='system')p=\"system\"}var r=p==='system'?(matchMedia(\"(prefers-color-scheme: dark)\").matches?'dark':'light'):p;d.classList.remove(r==='dark'?'light':'dark');d.classList.add(r);d.setAttribute(\"data-theme-preference\",p)})();\u003c/script>\u003cmeta data-mint-head name=\"description\" content=\"Permissions required: Read vault activity Get a single settlement by its ID.\">\u003cmeta data-mint-head name=\"application-name\" content=\"Anchorage Digital\">\u003cmeta data-mint-head name=\"generator\" content=\"Mintlify\">\u003clink data-mint-head rel=\"apple-touch-icon\" type=\"image/svg+xml\" sizes=\"180x180\" href=\"https://mintcdn.com/deployment-4/GSah06OFrRxxO1iB/knowledge-base/favicon-symbol.svg?fit=max\u0026amp;auto=format\u0026amp;n=GSah06OFrRxxO1iB\u0026amp;q=85\u0026amp;s=dbc56a4b9970aa0cc3b83e27e2063715\">\u003clink data-mint-head rel=\"icon\" type=\"image/svg+xml\" sizes=\"32x32\" href=\"https://mintcdn.com/deployment-4/GSah06OFrRxxO1iB/knowledge-base/favicon-symbol.svg?fit=max\u0026amp;auto=format\u0026amp;n=GSah06OFrRxxO1iB\u0026amp;q=85\u0026amp;s=dbc56a4b9970aa0cc3b83e27e2063715\" media=\"(prefers-color-scheme: light)\">\u003clink data-mint-head rel=\"icon\" type=\"image/svg+xml\" sizes=\"16x16\" href=\"https://mintcdn.com/deployment-4/GSah06OFrRxxO1iB/knowledge-base/favicon-symbol.svg?fit=max\u0026amp;auto=format\u0026amp;n=GSah06OFrRxxO1iB\u0026amp;q=85\u0026amp;s=dbc56a4b9970aa0cc3b83e27e2063715\" media=\"(prefers-color-scheme: light)\">\u003clink data-mint-head rel=\"shortcut icon\" type=\"image/svg+xml\" href=\"https://mintcdn.com/deployment-4/GSah06OFrRxxO1iB/knowledge-base/favicon-symbol.svg?fit=max\u0026amp;auto=format\u0026amp;n=GSah06OFrRxxO1iB\u0026amp;q=85\u0026amp;s=dbc56a4b9970aa0cc3b83e27e2063715\" media=\"(prefers-color-scheme: light)\">\u003clink data-mint-head rel=\"icon\" type=\"image/svg+xml\" sizes=\"32x32\" href=\"https://mintcdn.com/deployment-4/GSah06OFrRxxO1iB/knowledge-base/favicon-symbol.svg?fit=max\u0026amp;auto=format\u0026amp;n=GSah06OFrRxxO1iB\u0026amp;q=85\u0026amp;s=dbc56a4b9970aa0cc3b83e27e2063715\" media=\"(prefers-color-scheme: dark)\">\u003clink data-mint-head rel=\"icon\" type=\"image/svg+xml\" sizes=\"16x16\" href=\"https://mintcdn.com/deployment-4/GSah06OFrRxxO1iB/knowledge-base/favicon-symbol.svg?fit=max\u0026amp;auto=format\u0026amp;n=GSah06OFrRxxO1iB\u0026amp;q=85\u0026amp;s=dbc56a4b9970aa0cc3b83e27e2063715\" media=\"(prefers-color-scheme: dark)\">\u003clink data-mint-head rel=\"shortcut icon\" type=\"image/svg+xml\" href=\"https://mintcdn.com/deployment-4/GSah06OFrRxxO1iB/knowledge-base/favicon-symbol.svg?fit=max\u0026amp;auto=format\u0026amp;n=GSah06OFrRxxO1iB\u0026amp;q=85\u0026amp;s=dbc56a4b9970aa0cc3b83e27e2063715\" media=\"(prefers-color-scheme: dark)\">\u003cmeta data-mint-head property=\"og:title\" content=\"Get a settlement by ID - Anchorage Digital\">\u003cmeta data-mint-head property=\"og:description\" content=\"Permissions required: Read vault activity Get a single settlement by its ID.\">\u003cmeta data-mint-head property=\"og:site_name\" content=\"Anchorage Digital\">\u003cmeta data-mint-head property=\"og:url\" content=\"https://docs.anchorage.com/knowledge-base/porto/api-reference/v2/atlas-settlement-network/get-a-settlement-by-id\">\u003cmeta data-mint-head property=\"og:type\" content=\"website\">\u003cmeta data-mint-head property=\"og:image\" content=\"https://deployment-4.mintlify.site/_mintlify/api/og/v2?division=Settlement+network\u0026amp;title=Get+a+settlement+by+ID\u0026amp;description=Permissions+required%3A+**Read+vault+activity**%0A%0A%0AGet+a+single+settlement+by+its+ID.\u0026amp;theme=487dee285ee7666877db2151\u0026amp;signature=7c3890d8d95f6da80b6d5ebd370a0cdf843256aeb29cb4ff445df188084f4001\">\u003cmeta data-mint-head property=\"og:image:width\" content=\"1200\">\u003cmeta data-mint-head property=\"og:image:height\" content=\"630\">\u003cmeta data-mint-head name=\"twitter:card\" content=\"summary_large_image\">\u003cmeta data-mint-head name=\"twitter:title\" content=\"Get a settlement by ID - Anchorage Digital\">\u003cmeta data-mint-head name=\"twitter:description\" content=\"Permissions required: Read vault activity Get a single settlement by its ID.\">\u003cmeta data-mint-head name=\"twitter:image\" content=\"https://deployment-4.mintlify.site/_mintlify/api/og/v2?division=Settlement+network\u0026amp;title=Get+a+settlement+by+ID\u0026amp;description=Permissions+required%3A+**Read+vault+activity**%0A%0A%0AGet+a+single+settlement+by+its+ID.\u0026amp;theme=487dee285ee7666877db2151\u0026amp;signature=7c3890d8d95f6da80b6d5ebd370a0cdf843256aeb29cb4ff445df188084f4001\">\u003cmeta data-mint-head name=\"twitter:image:width\" content=\"1200\">\u003cmeta data-mint-head name=\"twitter:image:height\" content=\"630\">\u003cmeta data-mint-head name=\"msapplication-config\" content=\"https://mintlify.s3.us-west-1.amazonaws.com/deployment-4/_generated/favicon/browserconfig.xml?v=3\">\u003cmeta data-mint-head name=\"apple-mobile-web-app-title\" content=\"Anchorage Digital\">\u003cmeta data-mint-head name=\"msapplication-TileColor\" content=\"#5580F6\">\u003clink data-mint-head rel=\"canonical\" href=\"https://docs.anchorage.com/knowledge-base/porto/api-reference/v2/atlas-settlement-network/get-a-settlement-by-id\">\u003clink data-mint-head rel=\"alternate\" type=\"application/xml\" href=\"/sitemap.xml\">\u003clink data-mint-head rel=\"alternate\" type=\"text/markdown\" href=\"/knowledge-base/porto/api-reference/v2/atlas-settlement-network/get-a-settlement-by-id.md\">\u003cscript data-mint-head type=\"application/ld+json\">{\"@context\":\"https://schema.org\",\"@graph\":[{\"@type\":\"Organization\",\"@id\":\"https://docs.anchorage.com/#organization\",\"name\":\"Anchorage Digital\",\"url\":\"https://docs.anchorage.com\",\"logo\":{\"@type\":\"ImageObject\",\"url\":\"https://mintcdn.com/deployment-4/ikVMLMsizDmk_7Sw/knowledge-base/images/logo-lockup-dark.svg?fit=max\u0026auto=format\u0026n=ikVMLMsizDmk_7Sw\u0026q=85\u0026s=87028c6755f355e278de66991913b91c\"}},{\"@type\":\"WebSite\",\"@id\":\"https://docs.anchorage.com#website\",\"name\":\"Anchorage Digital\",\"url\":\"https://docs.anchorage.com\",\"publisher\":{\"@id\":\"https://docs.anchorage.com/#organization\"}},{\"@type\":\"WebPage\",\"@id\":\"https://docs.anchorage.com/knowledge-base/porto/api-reference/v2/atlas-settlement-network/get-a-settlement-by-id#webpage\",\"url\":\"https://docs.anchorage.com/knowledge-base/porto/api-reference/v2/atlas-settlement-network/get-a-settlement-by-id\",\"name\":\"Get a settlement by ID\",\"description\":\"Permissions required: Read vault activity Get a single settlement by its ID.\",\"dateModified\":\"2026-11-05T17:20:13.805Z\",\"isPartOf\":{\"@id\":\"https://docs.anchorage.com#website\"},\"breadcrumb\":{\"@id\":\"https://docs.anchorage.com/knowledge-base/porto/api-reference/v2/atlas-settlement-network/get-a-settlement-by-id#breadcrumb\"}},{\"@type\":\"BreadcrumbList\",\"@id\":\"https://docs.anchorage.com/knowledge-base/porto/api-reference/v2/atlas-settlement-network/get-a-settlement-by-id#breadcrumb\",\"itemListElement\":[{\"@type\":\"ListItem\",\"position\":1,\"name\":\"Atlas\",\"item\":\"https://docs.anchorage.com/knowledge-base/porto/api-reference/v2/atlas-settlement-network/propose-a-settlement\"},{\"@type\":\"ListItem\",\"position\":2,\"name\":\"Settlement network\",\"item\":\"https://docs.anchorage.com/knowledge-base/porto/api-reference/v2/atlas-settlement-network/propose-a-settlement\"},{\"@type\":\"ListItem\",\"position\":3,\"name\":\"Get a settlement by ID\",\"item\":\"https://docs.anchorage.com/knowledge-base/porto/api-reference/v2/atlas-settlement-network/get-a-settlement-by-id\"}]},{\"@type\":[\"TechArticle\",\"APIReference\"],\"@id\":\"https://docs.anchorage.com/knowledge-base/porto/api-reference/v2/atlas-settlement-network/get-a-settlement-by-id#apireference\",\"headline\":\"Get a settlement by ID\",\"name\":\"Get a settlement by ID\",\"description\":\"Permissions required: Read vault activity Get a single settlement by its ID.\",\"url\":\"https://docs.anchorage.com/knowledge-base/porto/api-reference/v2/atlas-settlement-network/get-a-settlement-by-id\",\"mainEntityOfPage\":{\"@id\":\"https://docs.anchorage.com/knowledge-base/porto/api-reference/v2/atlas-settlement-network/get-a-settlement-by-id#webpage\"},\"dateModified\":\"2026-11-05T17:20:13.805Z\",\"publisher\":{\"@id\":\"https://docs.anchorage.com/#organization\"},\"isPartOf\":{\"@id\":\"https://docs.anchorage.com#website\"}}]}\u003c/script>","siteName":"Anchorage Digital","nav":{"global":null,"products":[{"product":"Home","icon":"house","pages":[{"title":"Home","href":"/knowledge-base"}]},{"product":"Anchorage Digital","icon":"https://mintlify.s3.us-west-1.amazonaws.com/deployment-4/knowledge-base/images/icons/anchorage.svg","pages":[{"title":"Anchorage Digital","href":"/knowledge-base/platform/users/overview"}]},{"product":"Porto","icon":"https://mintlify.s3.us-west-1.amazonaws.com/deployment-4/knowledge-base/images/icons/porto.svg","color":{"light":"#ac96ff","dark":"#ac96ff"},"tabs":[{"tab":"User guides","pages":[{"title":"User guides","href":"/knowledge-base/porto/overview"}]},{"tab":"Developer guides","pages":[{"title":"Developer guides","href":"/knowledge-base/porto/developers/setting-up"}]},{"tab":"API reference","menu":[{"item":"v2","groups":[{"group":"Getting started","public":true,"icon":"book-open","pages":[{"title":"Introduction","href":"/knowledge-base/porto/api-reference/introduction"},{"title":"Authentication","href":"/knowledge-base/porto/api-reference/authentication"},{"title":"Errors, rate limits, and pagination","href":"/knowledge-base/porto/api-reference/errors-pagination"},{"title":"Verifying addresses","href":"/knowledge-base/porto/api-reference/address-verification"},{"title":"API Changelog","href":"/knowledge-base/porto/api-reference/changelog"}]},{"group":"Anchorage custody","icon":"building","pages":[{"group":"API key","expanded":false,"pages":[{"title":"List information for current API key","deprecated":null,"version":null,"openapi":"/knowledge-base/openapi/v2.yaml get /apikey","href":"/knowledge-base/porto/api-reference/v2/api-key/list-information-for-current-api-key"}]},{"group":"Asset types","expanded":false,"pages":[{"title":"List supported asset types","deprecated":null,"version":null,"openapi":"/knowledge-base/openapi/v2.yaml get /asset-types","href":"/knowledge-base/porto/api-reference/v2/asset-types/list-supported-asset-types"}]},{"group":"Vaults","expanded":false,"pages":[{"title":"List vaults","deprecated":null,"version":null,"openapi":"/knowledge-base/openapi/v2.yaml get /vaults","href":"/knowledge-base/porto/api-reference/v2/vaults/list-vaults"},{"title":"Get vault by ID","deprecated":null,"version":null,"openapi":"/knowledge-base/openapi/v2.yaml get /vaults/{vaultId}","href":"/knowledge-base/porto/api-reference/v2/vaults/get-vault-by-id"},{"title":"List all addresses for an asset","deprecated":null,"version":null,"openapi":"/knowledge-base/openapi/v2.yaml get /vaults/{vaultId}/addresses","href":"/knowledge-base/porto/api-reference/v2/addresses/list-all-addresses-for-an-asset"}]},{"group":"Wallets","expanded":false,"pages":[{"title":"List all wallets for all vaults","deprecated":null,"version":null,"openapi":"/knowledge-base/openapi/v2.yaml get /wallets","href":"/knowledge-base/porto/api-reference/v2/wallets/list-all-wallets-for-all-vaults"},{"title":"Wallet details for a wallet","deprecated":null,"version":null,"openapi":"/knowledge-base/openapi/v2.yaml get /wallets/{walletId}","href":"/knowledge-base/porto/api-reference/v2/wallets/wallet-details-for-a-wallet"},{"title":"Activate an existing wallet on additional networks","deprecated":null,"version":null,"openapi":"/knowledge-base/openapi/v2.yaml post /wallets/{walletId}/activate","href":"/knowledge-base/porto/api-reference/v2/wallets/activate-an-existing-wallet-on-additional-networks"},{"title":"Provision a deposit address for a wallet","deprecated":null,"version":null,"openapi":"/knowledge-base/openapi/v2.yaml post /wallets/{walletId}/addresses","href":"/knowledge-base/porto/api-reference/v2/addresses/provision-a-deposit-address-for-a-wallet"},{"title":"Staking rewards for a wallet","deprecated":null,"version":null,"openapi":"/knowledge-base/openapi/v2.yaml get /wallets/{walletId}/staking/rewards","href":"/knowledge-base/porto/api-reference/v2/wallets/staking-rewards-for-a-wallet"},{"title":"Staking positions for a wallet","deprecated":null,"version":null,"openapi":"/knowledge-base/openapi/v2.yaml get /wallets/{walletId}/staking/positions","href":"/knowledge-base/porto/api-reference/v2/wallets/staking-positions-for-a-wallet"},{"title":"List all wallets for a vault","deprecated":null,"version":null,"openapi":"/knowledge-base/openapi/v2.yaml get /vaults/{vaultId}/wallets","href":"/knowledge-base/porto/api-reference/v2/wallets/list-all-wallets-for-a-vault"},{"title":"Create a new wallet in a vault","deprecated":null,"version":null,"openapi":"/knowledge-base/openapi/v2.yaml post /vaults/{vaultId}/wallets","href":"/knowledge-base/porto/api-reference/v2/wallets/create-a-new-wallet-in-a-vault"}]},{"group":"Deposit attribution","expanded":false,"pages":[{"title":"List deposit attributions","deprecated":null,"version":null,"openapi":"/knowledge-base/openapi/v2.yaml get /deposit-attributions/attributions","href":"/knowledge-base/porto/api-reference/v2/deposit-attribution/list-deposit-attributions"},{"title":"Attribute a deposit","deprecated":null,"version":null,"openapi":"/knowledge-base/openapi/v2.yaml patch /deposit-attributions/{depositTransactionId}","href":"/knowledge-base/porto/api-reference/v2/deposit-attribution/attribute-a-deposit"},{"title":"Attribute a deposit as spam","deprecated":null,"version":null,"openapi":"/knowledge-base/openapi/v2.yaml post /deposit-attributions/{depositTransactionId}/spam","href":"/knowledge-base/porto/api-reference/v2/deposit-attribution/attribute-a-deposit-as-spam"}]},{"group":"Vesting","expanded":false,"pages":[{"title":"Get vesting balances","openapi":"POST /vesting/balances","tag":"BETA","href":"/knowledge-base/porto/api-reference/v2/vesting-balances-batch"},{"title":"Get vesting balances for an allocation","deprecated":null,"version":null,"openapi":"/knowledge-base/openapi/v2.yaml get /vesting/balances/{allocationId}","href":"/knowledge-base/porto/api-reference/v2/vesting/get-vesting-balances-for-an-allocation"},{"title":"Off-chain vesting schedules","openapi":"GET /offchainvesting/schedules","tag":"BETA","href":"/knowledge-base/porto/api-reference/v2/offchainvesting-schedules"}]},{"group":"Statements","expanded":false,"pages":[{"title":"List statements","openapi":"GET /statements","tag":"BETA","href":"/knowledge-base/porto/api-reference/v2/statements-list"},{"title":"Get statement","openapi":"GET /statements/{statementId}","tag":"BETA","href":"/knowledge-base/porto/api-reference/v2/statement-get"},{"title":"Download a statement","openapi":"GET /statements/{statementId}/download","tag":"BETA","href":"/knowledge-base/porto/api-reference/v2/statement-download"},{"title":"List statement types","openapi":"GET /statement-types","tag":"BETA","href":"/knowledge-base/porto/api-reference/v2/statement-types"}]},{"group":"Tags","expanded":false,"pages":[{"title":"List tags","deprecated":null,"version":null,"openapi":"/knowledge-base/openapi/v2.yaml get /tags","href":"/knowledge-base/porto/api-reference/v2/tagging/list-tags"},{"title":"Create a tag","openapi":"POST /tags","hidden":true,"href":"/knowledge-base/porto/api-reference/v2/tags/create-a-tag"},{"title":"Apply tags to an entity","deprecated":null,"version":null,"openapi":"/knowledge-base/openapi/v2.yaml post /tags/apply","href":"/knowledge-base/porto/api-reference/v2/tagging/apply-tags-to-an-entity"},{"title":"Remove a tag from an entity","deprecated":null,"version":null,"openapi":"/knowledge-base/openapi/v2.yaml delete /tags/apply/{entityId}/{tagName}","href":"/knowledge-base/porto/api-reference/v2/tagging/remove-a-tag-from-an-entity"},{"title":"Search entities by tag","deprecated":null,"version":null,"openapi":"/knowledge-base/openapi/v2.yaml get /tags/search","href":"/knowledge-base/porto/api-reference/v2/tagging/search-entities-by-tag"}]}]},{"group":"Move money","icon":"money-bill-transfer","pages":[{"group":"Transfers","expanded":false,"pages":[{"title":"List transfers","deprecated":null,"version":null,"openapi":"/knowledge-base/openapi/v2.yaml get /transfers","href":"/knowledge-base/porto/api-reference/v2/transfers/list-transfers"},{"title":"Create a transfer request","deprecated":null,"version":null,"openapi":"/knowledge-base/openapi/v2.yaml post /transfers","href":"/knowledge-base/porto/api-reference/v2/transfers/create-a-transfer-request"},{"title":"Get transfer by ID","deprecated":null,"version":null,"openapi":"/knowledge-base/openapi/v2.yaml get /transfers/{transferId}","href":"/knowledge-base/porto/api-reference/v2/transfers/get-transfer-by-id"},{"title":"Cancel a transfer request","deprecated":null,"version":null,"openapi":"/knowledge-base/openapi/v2.yaml delete /transfers/{transferId}","href":"/knowledge-base/porto/api-reference/v2/transfers/cancel-a-transfer-request"}]},{"group":"Transactions","expanded":false,"pages":[{"title":"Create a withdrawal request","deprecated":null,"version":null,"openapi":"/knowledge-base/openapi/v2.yaml post /transactions/withdrawal","href":"/knowledge-base/porto/api-reference/v2/transactions/create-a-withdrawal-request"},{"title":"List transactions","deprecated":null,"version":null,"openapi":"/knowledge-base/openapi/v2.yaml get /transactions","href":"/knowledge-base/porto/api-reference/v2/transactions/list-transactions"},{"title":"Get transaction by ID","deprecated":null,"version":null,"openapi":"/knowledge-base/openapi/v2.yaml get /transactions/{transactionId}","href":"/knowledge-base/porto/api-reference/v2/transactions/get-transaction-by-id"},{"title":"Create a stake request","deprecated":null,"version":null,"openapi":"/knowledge-base/openapi/v2.yaml post /transactions/stake","href":"/knowledge-base/porto/api-reference/v2/transactions/create-a-stake-request"},{"title":"Create an unstake request","deprecated":null,"version":null,"openapi":"/knowledge-base/openapi/v2.yaml post /transactions/unstake","href":"/knowledge-base/porto/api-reference/v2/transactions/create-an-unstake-request"},{"title":"Create a collect request","deprecated":null,"version":null,"openapi":"/knowledge-base/openapi/v2.yaml post /transactions/collect","href":"/knowledge-base/porto/api-reference/v2/transactions/create-a-collect-request"},{"title":"Create a consolidate stake request","deprecated":null,"version":null,"openapi":"/knowledge-base/openapi/v2.yaml post /transactions/consolidate-stake","href":"/knowledge-base/porto/api-reference/v2/transactions/create-a-consolidate-stake-request"},{"title":"Reject a transaction","deprecated":null,"version":null,"sidebarTitle":"Reject a transaction","openapi":"/knowledge-base/openapi/v2.yaml post /transactions/{transactionId}/reject","href":"/knowledge-base/api-reference/v2/transactions/reject-a-transaction"},{"title":"List supported delegation addresses","deprecated":null,"version":null,"openapi":"/knowledge-base/openapi/v2.yaml get /delegation-addresses/{assetType}","href":"/knowledge-base/porto/api-reference/v2/transactions/list-supported-delegation-addresses"}]},{"group":"Trusted destinations","expanded":false,"pages":[{"title":"List trusted destinations","deprecated":null,"version":null,"openapi":"/knowledge-base/openapi/v2.yaml get /trusted_destinations","href":"/knowledge-base/porto/api-reference/v2/trusted-destinations/list-trusted-destinations"},{"title":"Create new Trusted Destinations","deprecated":null,"version":null,"openapi":"/knowledge-base/openapi/v2.yaml post /trusted_destinations","href":"/knowledge-base/porto/api-reference/v2/trusted-destinations/create-new-trusted-destinations"},{"title":"Check status of Trusted Destinations","deprecated":null,"version":null,"openapi":"/knowledge-base/openapi/v2.yaml get /trusted_destinations/{creationRequestId}/status","href":"/knowledge-base/porto/api-reference/v2/trusted-destinations/check-status-of-trusted-destinations"},{"title":"Cancel Trusted Destination creation","deprecated":null,"version":null,"openapi":"/knowledge-base/openapi/v2.yaml delete /trusted_destinations/{creationRequestId}/cancel","href":"/knowledge-base/porto/api-reference/v2/trusted-destinations/cancel-trusted-destination-creation"},{"title":"Delete Trusted Destination","deprecated":null,"version":null,"openapi":"/knowledge-base/openapi/v2.yaml delete /trusted_destinations/{trustedDestinationId}","href":"/knowledge-base/porto/api-reference/v2/trusted-destinations/delete-trusted-destination"}]},{"group":"Stablecoins","expanded":false,"pages":[{"title":"Create a Stablecoin Conversion","deprecated":null,"version":null,"openapi":"/knowledge-base/openapi/v2.yaml post /stablecoins/conversion","href":"/knowledge-base/porto/api-reference/v2/stablecoins/create-a-stablecoin-conversion"},{"title":"Get Issue/Redeem History","deprecated":null,"version":null,"openapi":"/knowledge-base/openapi/v2.yaml get /stablecoins/history","href":"/knowledge-base/porto/api-reference/v2/stablecoins/get-issueredeem-history"},{"title":"Get Stablecoin Reserves History","deprecated":null,"version":null,"openapi":"/knowledge-base/openapi/v2.yaml get /stablecoins/reserves","href":"/knowledge-base/porto/api-reference/v2/stablecoins/get-stablecoin-reserves-history"},{"title":"Get Stablecoin Reserves Entitled Stablecoins","deprecated":null,"version":null,"openapi":"/knowledge-base/openapi/v2.yaml get /stablecoins/reserves/entitled-stablecoins","href":"/knowledge-base/porto/api-reference/v2/stablecoins/get-stablecoin-reserves-entitled-stablecoins"}]}]},{"group":"Atlas","icon":"code","pages":[{"group":"Settlement network","expanded":false,"pages":[{"title":"Propose a settlement","deprecated":null,"version":null,"openapi":"/knowledge-base/openapi/v2.yaml post /atlas/settlements","href":"/knowledge-base/porto/api-reference/v2/atlas-settlement-network/propose-a-settlement"},{"title":"List settlements","deprecated":null,"version":null,"openapi":"/knowledge-base/openapi/v2.yaml get /atlas/settlements","href":"/knowledge-base/porto/api-reference/v2/atlas-settlement-network/list-settlements"},{"title":"Reject a settlement proposal","deprecated":null,"version":null,"openapi":"/knowledge-base/openapi/v2.yaml post /atlas/settlements/{settlementId}/reject","href":"/knowledge-base/porto/api-reference/v2/atlas-settlement-network/reject-a-settlement-proposal"},{"title":"Authorize a settlement","deprecated":null,"version":null,"openapi":"/knowledge-base/openapi/v2.yaml post /atlas/settlements/{settlementId}/authorize","href":"/knowledge-base/porto/api-reference/v2/atlas-settlement-network/authorize-a-settlement"},{"title":"Accept a settlement","description":"Permissions required: **Propose and Accept settlements** and **Read vault activity**\n\n\nAccept a proposed settlement and select wallets to receive funds to and/or send funds from.","deprecated":null,"version":null,"openapi":"/knowledge-base/openapi/v2.yaml post /atlas/settlements/{settlementId}/accept","href":"/knowledge-base/porto/api-reference/v2/atlas-settlement-network/accept-a-settlement"},{"title":"Get a settlement by ID","deprecated":null,"version":null,"openapi":"/knowledge-base/openapi/v2.yaml get /atlas/settlements/{settlementId}","href":"/knowledge-base/porto/api-reference/v2/atlas-settlement-network/get-a-settlement-by-id"},{"title":"Propose a trusted counterparty","description":"Permissions required: **Propose Trusted Counterparty**\n\n\nPropose adding a new trusted counterparty for a participant.","deprecated":null,"version":null,"openapi":"/knowledge-base/openapi/v2.yaml post /atlas/directory/counterparties","href":"/knowledge-base/porto/api-reference/v2/atlas-settlement-network/propose-a-trusted-counterparty"},{"title":"List trusted counterparties","deprecated":null,"version":null,"openapi":"/knowledge-base/openapi/v2.yaml get /atlas/directory/counterparties","href":"/knowledge-base/porto/api-reference/v2/atlas-settlement-network/list-trusted-counterparties"},{"title":"Get a counterparty by ID","deprecated":null,"version":null,"openapi":"/knowledge-base/openapi/v2.yaml get /atlas/directory/counterparties/{counterpartyId}","href":"/knowledge-base/porto/api-reference/v2/atlas-settlement-network/get-a-counterparty-by-id"},{"title":"Get a participant by ID","deprecated":null,"version":null,"openapi":"/knowledge-base/openapi/v2.yaml get /atlas/directory/participants/{participantId}","href":"/knowledge-base/porto/api-reference/v2/atlas-settlement-network/get-a-participant-by-id"},{"title":"List participants","deprecated":null,"version":null,"openapi":"/knowledge-base/openapi/v2.yaml get /atlas/directory/participants","href":"/knowledge-base/porto/api-reference/v2/atlas-settlement-network/list-participants"}]},{"group":"Collateral Management","expanded":false,"pages":[{"title":"List packages","deprecated":null,"version":null,"openapi":"/knowledge-base/openapi/v2.yaml get /collateral_management/packages","href":"/knowledge-base/porto/api-reference/v2/collateral-management/list-packages"},{"title":"Create a new collateral package","deprecated":null,"version":null,"openapi":"/knowledge-base/openapi/v2.yaml post /collateral_management/packages","href":"/knowledge-base/porto/api-reference/v2/collateral-management/create-a-new-collateral-package"},{"title":"Update a collateral package","deprecated":null,"version":null,"openapi":"/knowledge-base/openapi/v2.yaml patch /collateral_management/packages/{packageId}","href":"/knowledge-base/porto/api-reference/v2/collateral-management/update-a-collateral-package"},{"title":"List exposures","deprecated":null,"version":null,"openapi":"/knowledge-base/openapi/v2.yaml get /collateral_management/exposures","href":"/knowledge-base/porto/api-reference/v2/collateral-management/list-exposures"},{"title":"Create a new exposure","deprecated":null,"version":null,"openapi":"/knowledge-base/openapi/v2.yaml post /collateral_management/exposures","href":"/knowledge-base/porto/api-reference/v2/collateral-management/create-a-new-exposure"},{"title":"Update an operation","deprecated":null,"version":null,"openapi":"/knowledge-base/openapi/v2.yaml patch /collateral_management/operations/{operationId}","href":"/knowledge-base/porto/api-reference/v2/collateral-management/update-an-operation"},{"title":"Create a new operation","deprecated":null,"version":null,"openapi":"/knowledge-base/openapi/v2.yaml post /collateral_management/operations","href":"/knowledge-base/porto/api-reference/v2/collateral-management/create-a-new-operation"},{"title":"List collateral and exposure operations","deprecated":null,"version":null,"openapi":"/knowledge-base/openapi/v2.yaml get /collateral_management/operations","href":"/knowledge-base/porto/api-reference/v2/collateral-management/list-collateral-and-exposure-operations"},{"title":"Get collateral price sources","openapi":"GET /collateral_management/price_sources","tag":"BETA","href":"/knowledge-base/porto/api-reference/v2/collateral-price-sources"},{"title":"Request a collateral decrease","openapi":"POST /collateral_management/packages/{packageId}/collateral-decrease","tag":"BETA","href":"/knowledge-base/porto/api-reference/v2/collateral-decrease"}]}]},{"group":"Wealth Management \u0026 ETF","icon":"building-columns","pages":[{"group":"Onboarding","expanded":false,"pages":[{"title":"Begin new customer onboarding application","deprecated":null,"version":null,"openapi":"/knowledge-base/openapi/v2.yaml post /onboarding/customers","href":"/knowledge-base/porto/api-reference/v2/onboarding/begin-new-customer-onboarding-application"},{"title":"Retrieve uploaded data and status of all customers onboarding","deprecated":null,"version":null,"openapi":"/knowledge-base/openapi/v2.yaml get /onboarding/customers","href":"/knowledge-base/porto/api-reference/v2/onboarding/retrieve-uploaded-data-and-status-of-all-customers-onboarding"},{"title":"Retrieve uploaded data and status of customer onboarding","deprecated":null,"version":null,"openapi":"/knowledge-base/openapi/v2.yaml get /onboarding/customers/{customerId}","href":"/knowledge-base/porto/api-reference/v2/onboarding/retrieve-uploaded-data-and-status-of-customer-onboarding"},{"title":"Update customer onboarding application","deprecated":null,"version":null,"openapi":"/knowledge-base/openapi/v2.yaml put /onboarding/customers/{customerId}","href":"/knowledge-base/porto/api-reference/v2/onboarding/update-customer-onboarding-application"},{"title":"Request a signed URL for document image upload","deprecated":null,"version":null,"openapi":"/knowledge-base/openapi/v2.yaml post /onboarding/customers/{customerId}/document","href":"/knowledge-base/porto/api-reference/v2/onboarding/request-a-signed-url-for-document-image-upload"},{"title":"Submit a completed customer onboarding application","deprecated":null,"version":null,"openapi":"/knowledge-base/openapi/v2.yaml post /onboarding/customers/{customerId}/submit","href":"/knowledge-base/porto/api-reference/v2/onboarding/submit-a-completed-customer-onboarding-application"},{"title":"Creates a new agreement questionnaire of the given agreementType","deprecated":null,"version":null,"openapi":"/knowledge-base/openapi/v2.yaml post /onboarding/agreements/{agreementType}","href":"/knowledge-base/porto/api-reference/v2/onboarding/creates-a-new-agreement-questionnaire-of-the-given-agreementtype"},{"title":"Retrieves all the agreements questionnaires for the specified agreement type","deprecated":null,"version":null,"openapi":"/knowledge-base/openapi/v2.yaml get /onboarding/agreements/{agreementType}","href":"/knowledge-base/porto/api-reference/v2/onboarding/retrieves-all-the-agreements-questionnaires-for-the-specified-agreement-type"},{"title":"Retrieves the agreement questionnaire of the given agreement type and agreement ID","deprecated":null,"version":null,"openapi":"/knowledge-base/openapi/v2.yaml get /onboarding/agreements/{agreementType}/{agreementId}","href":"/knowledge-base/porto/api-reference/v2/onboarding/retrieves-the-agreement-questionnaire-of-the-given-agreement-type-and-agreement-id"},{"title":"Begin new customer subaccount onboarding application","deprecated":null,"version":null,"openapi":"/knowledge-base/openapi/v2.yaml post /onboarding/subaccounts","href":"/knowledge-base/porto/api-reference/v2/onboarding/begin-new-customer-subaccount-onboarding-application"},{"title":"Retrieve uploaded data and status of all onboarding customer subaccounts","deprecated":null,"version":null,"openapi":"/knowledge-base/openapi/v2.yaml get /onboarding/subaccounts","href":"/knowledge-base/porto/api-reference/v2/onboarding/retrieve-uploaded-data-and-status-of-all-onboarding-customer-subaccounts"},{"title":"Retrieve uploaded data and status of customer subaccount onboarding","deprecated":null,"version":null,"openapi":"/knowledge-base/openapi/v2.yaml get /onboarding/subaccounts/{subaccountId}","href":"/knowledge-base/porto/api-reference/v2/onboarding/retrieve-uploaded-data-and-status-of-customer-subaccount-onboarding"},{"title":"Update customer subaccount onboarding application","deprecated":null,"version":null,"openapi":"/knowledge-base/openapi/v2.yaml put /onboarding/subaccounts/{subaccountId}","href":"/knowledge-base/porto/api-reference/v2/onboarding/update-customer-subaccount-onboarding-application"},{"title":"Submit a completed customer subaccount onboarding application","deprecated":null,"version":null,"openapi":"/knowledge-base/openapi/v2.yaml post /onboarding/subaccounts/{subaccountId}/submit","href":"/knowledge-base/porto/api-reference/v2/onboarding/submit-a-completed-customer-subaccount-onboarding-application"}]},{"group":"Subaccounts","expanded":false,"pages":[{"title":"Return wallets linked to a subaccount","deprecated":null,"version":null,"openapi":"/knowledge-base/openapi/v2.yaml get /subaccounts/accounts/{subaccountId}/wallets","href":"/knowledge-base/porto/api-reference/v2/subaccounts/return-wallets-linked-to-a-subaccount"},{"title":"Return bank information for a subaccount","deprecated":null,"version":null,"openapi":"/knowledge-base/openapi/v2.yaml get /subaccounts/accounts/{subaccountId}/bank-info","href":"/knowledge-base/porto/api-reference/v2/subaccounts/return-bank-information-for-a-subaccount"},{"title":"Create a new subaccount for a given program customer","deprecated":true,"version":null,"openapi":"/knowledge-base/openapi/v2.yaml post /subaccounts/customers/{customerId}/accounts","href":"/knowledge-base/porto/api-reference/v2/subaccounts/create-a-new-subaccount-for-a-given-program-customer"},{"title":"List subaccounts","deprecated":null,"version":null,"openapi":"/knowledge-base/openapi/v2.yaml get /subaccounts/customers/{customerId}/accounts","href":"/knowledge-base/porto/api-reference/v2/subaccounts/list-subaccounts"},{"title":"List all subaccounts","deprecated":null,"version":null,"openapi":"/knowledge-base/openapi/v2.yaml get /subaccounts/customers/accounts","href":"/knowledge-base/porto/api-reference/v2/subaccounts/list-all-subaccounts"},{"title":"Update an existing subaccount","deprecated":null,"version":null,"openapi":"/knowledge-base/openapi/v2.yaml patch /subaccounts/accounts/{subaccountId}","href":"/knowledge-base/porto/api-reference/v2/subaccounts/update-an-existing-subaccount"},{"title":"Create new transactions","deprecated":null,"version":null,"openapi":"/knowledge-base/openapi/v2.yaml post /subaccounts/transactions","href":"/knowledge-base/porto/api-reference/v2/subaccounts/create-new-transactions"},{"title":"List all transactions","deprecated":null,"version":null,"openapi":"/knowledge-base/openapi/v2.yaml get /subaccounts/transactions","href":"/knowledge-base/porto/api-reference/v2/subaccounts/list-all-transactions"},{"title":"Get list of transactions filter by ID","deprecated":null,"version":null,"openapi":"/knowledge-base/openapi/v2.yaml get /subaccounts/transactions/{transactionsIds}","href":"/knowledge-base/porto/api-reference/v2/subaccounts/get-list-of-transactions-filter-by-id"},{"title":"Create new allocations","deprecated":null,"version":null,"openapi":"/knowledge-base/openapi/v2.yaml post /subaccounts/transactions/allocations","href":"/knowledge-base/porto/api-reference/v2/subaccounts/create-new-allocations"},{"title":"Fetches a set of filtered transactions allocations","deprecated":null,"version":null,"openapi":"/knowledge-base/openapi/v2.yaml get /subaccounts/transactions/allocations","href":"/knowledge-base/porto/api-reference/v2/subaccounts/fetches-a-set-of-filtered-transactions-allocations"},{"title":"Create a USD Withdrawal Request for a subaccount","deprecated":null,"version":null,"openapi":"/knowledge-base/openapi/v2.yaml post /subaccounts/{subaccountId}/fiat/withdrawals","href":"/knowledge-base/porto/api-reference/v2/subaccounts/create-a-usd-withdrawal-request-for-a-subaccount"},{"title":"Fetches a set of Withdrawals Requests for a subaccount","deprecated":null,"version":null,"openapi":"/knowledge-base/openapi/v2.yaml get /subaccounts/{subaccountId}/fiat/withdrawals","href":"/knowledge-base/porto/api-reference/v2/subaccounts/fetches-a-set-of-withdrawals-requests-for-a-subaccount"},{"title":"Cancels a Withdrawal Request for a subaccount","deprecated":null,"version":null,"openapi":"/knowledge-base/openapi/v2.yaml delete /subaccounts/{subaccountId}/fiat/withdrawals/{transactionId}","href":"/knowledge-base/porto/api-reference/v2/subaccounts/cancels-a-withdrawal-request-for-a-subaccount"},{"title":"Get USD Withdrawal Request for a subaccount","deprecated":null,"version":null,"openapi":"/knowledge-base/openapi/v2.yaml get /subaccounts/{subaccountId}/fiat/withdrawals/{transactionId}","href":"/knowledge-base/porto/api-reference/v2/subaccounts/get-usd-withdrawal-request-for-a-subaccount"},{"title":"Create Manual Billing Charge","deprecated":null,"version":null,"openapi":"/knowledge-base/openapi/v2.yaml post /subaccounts/billing/charges","href":"/knowledge-base/porto/api-reference/v2/subaccounts/create-manual-billing-charge"},{"title":"Cancel Manual Billing Charge","deprecated":null,"version":null,"openapi":"/knowledge-base/openapi/v2.yaml delete /subaccounts/billing/charges/{chargeId}","href":"/knowledge-base/porto/api-reference/v2/subaccounts/cancel-manual-billing-charge"}]},{"group":"Tax","expanded":false,"pages":[{"title":"List tax accounts","openapi":"GET /tax/accounts","tag":"BETA","href":"/knowledge-base/porto/api-reference/v2/tax-accounts"},{"title":"List deposit transactions for account","openapi":"GET /tax/accounts/{accountId}/transactions","tag":"BETA","href":"/knowledge-base/porto/api-reference/v2/tax-account-transactions"},{"title":"Update deposit transaction cost basis","openapi":"PATCH /tax/accounts/{accountId}/transactions/{transactionId}","tag":"BETA","href":"/knowledge-base/porto/api-reference/v2/tax-transaction-cost-basis"},{"title":"List Transactions","deprecated":null,"version":null,"openapi":"/knowledge-base/openapi/v2.yaml get /tax/transactions/{subaccountId}","href":"/knowledge-base/porto/api-reference/v2/tax/list-transactions"},{"title":"Update Transaction Cost Basis","deprecated":null,"version":null,"openapi":"/knowledge-base/openapi/v2.yaml patch /tax/transaction/{transactionId}","href":"/knowledge-base/porto/api-reference/v2/tax/update-transaction-cost-basis"},{"title":"Add Tag to Transaction","deprecated":null,"version":null,"openapi":"/knowledge-base/openapi/v2.yaml post /tax/transaction/{transactionId}/tag","href":"/knowledge-base/porto/api-reference/v2/tax/add-tag-to-transaction"},{"title":"Remove Tag from Transaction","deprecated":null,"version":null,"openapi":"/knowledge-base/openapi/v2.yaml delete /tax/transaction/{transactionId}/tag","href":"/knowledge-base/porto/api-reference/v2/tax/remove-tag-from-transaction"},{"title":"List of the Inventory for an asset","deprecated":null,"version":null,"openapi":"/knowledge-base/openapi/v2.yaml get /tax/inventory/{subaccountId}/{assetTypeId}","href":"/knowledge-base/porto/api-reference/v2/tax/list-of-the-inventory-for-an-asset"},{"title":"List summary of Inventory","deprecated":null,"version":null,"openapi":"/knowledge-base/openapi/v2.yaml get /tax/inventory/summary/{subaccountId}","href":"/knowledge-base/porto/api-reference/v2/tax/list-summary-of-inventory"},{"title":"List Gains Cost Basis","deprecated":null,"version":null,"openapi":"/knowledge-base/openapi/v2.yaml get /tax/gains/costbasis/{subaccountId}","href":"/knowledge-base/porto/api-reference/v2/tax/list-gains-cost-basis"},{"title":"List Gains","deprecated":null,"version":null,"openapi":"/knowledge-base/openapi/v2.yaml get /tax/gains/summary/{subaccountId}","href":"/knowledge-base/porto/api-reference/v2/tax/list-gains"},{"title":"Get Subaccount Tax Forms","deprecated":null,"version":null,"openapi":"/knowledge-base/openapi/v2.yaml get /tax/subaccounts/{subaccountId}/forms","href":"/knowledge-base/porto/api-reference/v2/tax/get-subaccount-tax-forms"},{"title":"Get Program Customer Tax Forms","deprecated":null,"version":null,"openapi":"/knowledge-base/openapi/v2.yaml get /tax/clients/{customerId}/forms","href":"/knowledge-base/porto/api-reference/v2/tax/get-program-customer-tax-forms"}]}]},{"group":"Trading","icon":"money-bill-trend-up","pages":[{"group":"Trading","expanded":false,"pages":[{"title":"Request a quote","deprecated":null,"version":null,"openapi":"/knowledge-base/openapi/v2.yaml post /trading/quote","href":"/knowledge-base/porto/api-reference/v2/trading/request-a-quote"},{"title":"Accept a quote","deprecated":null,"version":null,"openapi":"/knowledge-base/openapi/v2.yaml post /trading/quote/accept","href":"/knowledge-base/porto/api-reference/v2/trading/accept-a-quote"},{"title":"Place an order","deprecated":null,"version":null,"openapi":"/knowledge-base/openapi/v2.yaml post /trading/order","href":"/knowledge-base/porto/api-reference/v2/trading/place-an-order"},{"title":"List orders","deprecated":null,"version":null,"openapi":"/knowledge-base/openapi/v2.yaml get /trading/orders","href":"/knowledge-base/porto/api-reference/v2/trading/list-orders"},{"title":"Get order by ID","deprecated":null,"version":null,"openapi":"/knowledge-base/openapi/v2.yaml get /trading/orders/{orderId}","href":"/knowledge-base/porto/api-reference/v2/trading/get-order-by-id"},{"title":"List trades","deprecated":null,"version":null,"openapi":"/knowledge-base/openapi/v2.yaml get /trading/trades","href":"/knowledge-base/porto/api-reference/v2/trading/list-trades"},{"title":"Get trade by ID","deprecated":null,"version":null,"openapi":"/knowledge-base/openapi/v2.yaml get /trading/trades/{tradeId}","href":"/knowledge-base/porto/api-reference/v2/trading/get-trade-by-id"},{"title":"List outstanding trading positions","deprecated":null,"version":null,"openapi":"/knowledge-base/openapi/v2.yaml get /trading/positions","href":"/knowledge-base/porto/api-reference/v2/trading/list-outstanding-trading-positions"},{"title":"List settlements","deprecated":null,"version":null,"openapi":"/knowledge-base/openapi/v2.yaml get /trading/settlements","href":"/knowledge-base/porto/api-reference/v2/trading/list-settlements"},{"title":"Get settlement by ID","deprecated":null,"version":null,"openapi":"/knowledge-base/openapi/v2.yaml get /trading/settlements/{settlementId}","href":"/knowledge-base/porto/api-reference/v2/trading/get-settlement-by-id"},{"title":"List trades by settlement","deprecated":null,"version":null,"openapi":"/knowledge-base/openapi/v2.yaml get /trading/settlements/{settlementId}/trades","href":"/knowledge-base/porto/api-reference/v2/trading/list-trades-by-settlement"},{"title":"List trading accounts","deprecated":null,"version":null,"openapi":"/knowledge-base/openapi/v2.yaml get /trading/accounts","href":"/knowledge-base/porto/api-reference/v2/trading/list-trading-accounts"},{"title":"Get a trading account by id","deprecated":null,"version":null,"openapi":"/knowledge-base/openapi/v2.yaml get /trading/accounts/{accountId}","href":"/knowledge-base/porto/api-reference/v2/trading/get-a-trading-account-by-id"},{"title":"List trading account balances","deprecated":null,"version":null,"openapi":"/knowledge-base/openapi/v2.yaml get /trading/accounts/{accountId}/balances","href":"/knowledge-base/porto/api-reference/v2/trading/list-trading-account-balances"},{"title":"Get trading account credit limit and usage","deprecated":null,"version":null,"openapi":"/knowledge-base/openapi/v2.yaml get /trading/accounts/{accountId}/credit","href":"/knowledge-base/porto/api-reference/v2/trading/get-trading-account-credit-limit-and-usage"},{"title":"Get market data snapshot","deprecated":null,"version":null,"openapi":"/knowledge-base/openapi/v2.yaml get /trading/marketdata","href":"/knowledge-base/porto/api-reference/v2/trading/get-market-data-snapshot"},{"title":"List supported trading pairs","deprecated":null,"version":null,"openapi":"/knowledge-base/openapi/v2.yaml get /trading/pairs","href":"/knowledge-base/porto/api-reference/v2/trading/list-supported-trading-pairs"},{"title":"Place an async order","deprecated":null,"version":null,"openapi":"/knowledge-base/openapi/v2.yaml post /trading/async-order","href":"/knowledge-base/porto/api-reference/v2/trading/place-an-async-order"},{"title":"Cancel an async order","deprecated":null,"version":null,"openapi":"/knowledge-base/openapi/v2.yaml post /trading/async-order/cancel","href":"/knowledge-base/porto/api-reference/v2/trading/cancel-an-async-order"}]}]},{"group":"Webhooks","icon":"webhook","pages":[{"group":"Webhooks","expanded":false,"pages":[{"title":"Get webhook validation key","deprecated":null,"version":null,"openapi":"/knowledge-base/openapi/v2.yaml get /webhook/validation-key","href":"/knowledge-base/porto/api-reference/v2/webhook-notifications/get-webhook-validation-key"},{"title":"List webhook event types","deprecated":null,"version":null,"openapi":"/knowledge-base/openapi/v2.yaml get /webhook/event-types","href":"/knowledge-base/porto/api-reference/v2/webhook-notifications/list-webhook-event-types"},{"title":"Create webhook endpoint","deprecated":null,"version":null,"openapi":"/knowledge-base/openapi/v2.yaml post /webhook/endpoints","href":"/knowledge-base/porto/api-reference/v2/webhook-notifications/create-webhook-endpoint"},{"title":"List webhook endpoint","deprecated":null,"version":null,"openapi":"/knowledge-base/openapi/v2.yaml get /webhook/endpoints","href":"/knowledge-base/porto/api-reference/v2/webhook-notifications/list-webhook-endpoint"},{"title":"Get webhook endpoint config","deprecated":null,"version":null,"openapi":"/knowledge-base/openapi/v2.yaml get /webhook/endpoints/{endpointId}","href":"/knowledge-base/porto/api-reference/v2/webhook-notifications/get-webhook-endpoint-config"},{"title":"Update webhook endpoint","deprecated":null,"version":null,"openapi":"/knowledge-base/openapi/v2.yaml patch /webhook/endpoints/{endpointId}","href":"/knowledge-base/porto/api-reference/v2/webhook-notifications/update-webhook-endpoint"},{"title":"Create webhook subscriptions","deprecated":null,"version":null,"openapi":"/knowledge-base/openapi/v2.yaml post /webhook/endpoints/{endpointId}/subscriptions","href":"/knowledge-base/porto/api-reference/v2/webhook-notifications/create-webhook-subscriptions"},{"title":"List webhook endpoint subscriptions","deprecated":null,"version":null,"openapi":"/knowledge-base/openapi/v2.yaml get /webhook/endpoints/{endpointId}/subscriptions","href":"/knowledge-base/porto/api-reference/v2/webhook-notifications/list-webhook-endpoint-subscriptions"},{"title":"Cancel webhook subscription","deprecated":null,"version":null,"openapi":"/knowledge-base/openapi/v2.yaml delete /webhook/endpoints/{endpointId}/subscriptions/{eventTypeId}","href":"/knowledge-base/porto/api-reference/v2/webhook-notifications/cancel-webhook-subscription"}]}]}]},{"item":"v3","hidden":false,"pages":[{"title":"v3","href":"/knowledge-base/porto/api-reference/v3/introduction"}]}]},{"tab":"Build with AI","pages":[{"title":"Build with AI","href":"/knowledge-base/porto/build-with-ai/overview"}]}]},{"product":"Anchorage Digital Wealth (For Advisors)","icon":"building-columns","color":{"light":"#C9A227","dark":"#C9A227"},"hidden":true,"pages":[{"title":"Anchorage Digital Wealth (For Advisors)","href":"/knowledge-base/adw/overview"}]},{"product":"Trading","icon":"chart-line","hidden":true,"pages":[{"title":"Trading","href":"/knowledge-base/a1-trading/developer-guide/overview"}]},{"product":"Agentic Banking","icon":"robot","pages":[{"title":"Agentic Banking","href":"/agentic-banking/overview"}]}]},"basePath":"","title":"Get a settlement by ID - Anchorage Digital","buildId":"dpl_FWZhTb2vab28gFGFH4ojka6qEznQ","deploymentId":"dpl_FWZhTb2vab28gFGFH4ojka6qEznQ","dynamics":["c2aa737661","2b790eda92","b0f84f53ff","a9bb46feb3"],"chunks":["OpenApiReferenceProvider-CBsVopKK.js","utils-DZAk68jJ.js","cloneDeep-izs3Hzxb.js","_Uint8Array-BVIqJ90l.js","isObjectLike-C8vmzPEN.js","isArray-Dcu1dQ5t.js","utils-D32AYZrP.js","toString-BX-iyh8G.js","isSymbol-CSH9U2Gm.js","addUniqueKeysToSchema-D_A5_cny.js","snippetPresets-xNRfS9th.js","style-to-object-BY3JEAdk.js","v4-DIgz8zy6.js","conditional-requirements-CFM0id0Q.js","ApiExamples-BIB25-tq.js","isEqual-BfaiBbcl.js","usePlaygroundInputsStore-CydJ4w4j.js","shallow-CYPBeQSG.js","getApiPlaygroundDisplay-A5xJVBOu.js","CodeSnippet-BVRTgi3m.js","CodeSnippets-DjD6BSlt.js","Page-Dr40SSJq.js","getPastedJson-D4V4JyrR.js","icon-uhcnG22T.js","MethodPill-CM-ZQdGH.js","DuplicateIcon-B_WnOiNf.js","createIcon-CJsb8utt.js","DynamicMarkdown-D-2HDKEp.js","SectionHeading-KP5xmMgQ.js","axios-vUo_bRtp.js","Markdown-D_k0dg6k.js","clsx-DK3K4Z1S.js","lib-DuNMoZ05.js","lib-B8HbPgcC.js","html-void-elements-mCSPHezU.js","dist-DE3EVdvd.js","katex-YMM-FMeD.js","marked.esm-CZWythHk.js","AssistantPageLink-fN9H9n9g.js"]}