Integration API key. Send as Bearer copby_live_pk_….
Path Parameters
orderId
string
required
Response
Organization-owned settlement order
order
object
required
Hide child attributes
order.orderId
string
required
order.quoteId
string
required
order.organizationId
string
required
order.sourceAddress
string
required
Pattern: ^0x[a-fA-F0-9]{40}$
Example:
"0x2222222222222222222222222222222222222222"
order.destinationAddress
string
required
Pattern: ^0x[a-fA-F0-9]{40}$
Example:
"0x2222222222222222222222222222222222222222"
order.status
enum<string>
required
Available options:
CREATED,
BURNED,
ATTESTED,
MINTED,
ROUTING,
ROUTED,
DELIVERED,
REFUND_PENDING,
REFUNDING,
REFUNDED,
FAILED
order.health
enum<string>
required
Available options:
HEALTHY,
STUCK
order.fundsStatus
enum<string>
required
Available options:
IN_USER_WALLET,
BURNED_ON_ARC,
AWAITING_ATTESTATION,
USDC_ON_ARBITRUM,
IN_TRANSIT_TO_CELO,
USDM_ON_CELO,
COPM_ON_CELO,
DELIVERED_TO_DESTINATION,
REFUND_IN_TRANSIT,
REFUNDED_TO_SOURCE,
UNKNOWN
order.createdAt
string<date-time>
required
order.updatedAt
string<date-time>
required
order.reference
string | null
order.burnTxHash
string | null
order.messageHash
string | null
order.burnNonce
string | null
order.burnedAt
string<date-time> | null
order.stuckReason
string | null
{"docsConfig":{"theme":"palm","$schema":"https://mintlify.com/docs.json","name":"COP By Integrations","colors":{"primary":"#1B4D3E","light":"#3D8B6E","dark":"#0F2E25"},"api":{"openapi":"openapi.yaml","params":{"expanded":"all"},"playground":{"display":"interactive","proxy":true},"examples":{"defaults":"required","languages":["bash","javascript","python"],"prefill":true,"autogenerate":true},"url":"full"},"styling":{"latex":false},"navigation":{"pages":[]}},"deployment":{"deploymentMetadataValue":{"subdomain":"cop-by","hasAudioNarration":false,"actualSubdomain":"cop-by","customDomains":["docs.copby.digitalcop.shop"],"gitSource":{"type":"github","owner":"cop-by","repo":"cop_by","deployBranch":"main","contentDirectory":"apps/docs","isPrivate":true,"mountPath":"","label":""},"entitlements":{"AI_CHAT":{"status":"DISABLED"},"WEB_MCP":{"status":"DISABLED"},"NARRATION":{"status":"DISABLED"}},"buildId":"6ac2c04fe76a8e73f703b1ba","clientVersion":"0.0.4227","searchFilterCounts":[{"language":"default","tag":"API reference","count":19},{"language":"default","tag":"BRE-B","count":9},{"language":"default","tag":"Guides","count":8},{"language":"default","tag":"Settlement","count":4},{"language":"default","tag":"Start here","count":3},{"language":"default","tag":"Products","count":3},{"language":"default","tag":"Swaps","count":3},{"language":"default","tag":"Webhooks","count":3},{"language":"default","tag":"Operations","count":2}]},"assistantConfig":{"enableAskAiButton":false,"enableStarterQuestions":false,"enableContextualStarterQuestions":false,"enableAskAiSearchBar":true},"basePath":"","hasChatPermissions":false,"hasWebMcpPermissions":false,"toggles":[{"name":"kill-isr","enabled":true,"variant":{"name":"disabled","enabled":false,"feature_enabled":true},"impressionData":false},{"name":"custom-rbac-roles","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":"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":"site-roles","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":"starter-pricing","enabled":true,"variant":{"name":"treatment","enabled":true,"payload":{"type":"string","value":"treatment"},"feature_enabled":true},"impressionData":false},{"name":"llms-txt-v2","enabled":true,"variant":{"name":"disabled","enabled":false,"feature_enabled":true},"impressionData":false},{"name":"wildcard-email-auth","enabled":true,"variant":{"name":"disabled","enabled":false,"feature_enabled":true},"impressionData":false}],"googleFontsInlined":false},"customCss":[]}
{"page":{"pagePath":"api-reference/settlement/get-a-settlement-order","slug":"/api-reference/settlement/get-a-settlement-order","pageMetadata":{"title":"Get a settlement order","description":null,"deprecated":null,"version":null,"openapi":"/openapi.yaml get /api/integrations/settlements/orders/{orderId}","href":"/api-reference/settlement/get-a-settlement-order","autogeneratedByOpenApi":true},"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 order","description":null,"deprecated":null,"version":null,"openapi":"/openapi.yaml get /api/integrations/settlements/orders/{orderId}","href":"/api-reference/settlement/get-a-settlement-order","autogeneratedByOpenApi":true}}},"mdxSourceWithNoJs":null},"mdxExtracts":{"tableOfContents":[],"codeExamples":{}},"jsLinks":[],"openApiReferenceData":{"operation":{"tags":["Settlement"],"operationId":"getSettlementOrder","summary":"Get a settlement order","parameters":["1e579cb4-5092-4dd3-a425-9680f9ec5dde"],"responses":{"200":"684f7dd3-d1b7-4ffc-bba0-8b83416ca725","401":"c56b9c0a-7417-4f98-a2d9-017fdaaea9e2","404":"49f22909-eed5-496f-80f9-477752b95405","429":"bb0f7f7c-4871-47ef-af37-571b81807551"},"method":"get","type":"path","servers":["4ae65532-7c1a-4bf3-93e3-d489fa18fbf6"],"security":["1171e2fd-4dac-4570-8d32-297b4dcbef89"],"path":"/api/integrations/settlements/orders/{orderId}","baseUrlOptions":["https://api.copby.digitalcop.shop"],"title":"Get a settlement order","description":"","codeSamples":[],"requestExampleLanguages":["bash","javascript","python"],"requiredOnlyExamples":true,"requestExampleType":"generated","responseExampleType":"generated","prefillPlaygroundWithExample":true,"prefillPlaygroundExamples":[],"urlDisplay":"full"},"dependencies":{"parameters":{"1e579cb4-5092-4dd3-a425-9680f9ec5dde":{"name":"orderId","in":"path","required":true,"schema":{"type":"string","isRequired":true,"uniqueKey":"","typeLabel":"string"}}},"responses":{"684f7dd3-d1b7-4ffc-bba0-8b83416ca725":{"description":"Organization-owned settlement order","content":{"application/json":{"schema":{"type":"object","required":["order"],"properties":{"order":{"type":"object","required":["orderId","quoteId","organizationId","sourceAddress","destinationAddress","status","health","fundsStatus","createdAt","updatedAt"],"properties":{"orderId":{"type":"string","isRequired":true,"uniqueKey":"order.orderId","typeLabel":"string"},"quoteId":{"type":"string","isRequired":true,"uniqueKey":"order.quoteId","typeLabel":"string"},"organizationId":{"type":"string","isRequired":true,"uniqueKey":"order.organizationId","typeLabel":"string"},"sourceAddress":{"type":"string","pattern":"^0x[a-fA-F0-9]{40}$","example":"0x2222222222222222222222222222222222222222","isRequired":true,"uniqueKey":"order.sourceAddress","typeLabel":"string"},"destinationAddress":{"type":"string","pattern":"^0x[a-fA-F0-9]{40}$","example":"0x2222222222222222222222222222222222222222","isRequired":true,"uniqueKey":"order.destinationAddress","typeLabel":"string"},"status":{"type":"string","enum":["CREATED","BURNED","ATTESTED","MINTED","ROUTING","ROUTED","DELIVERED","REFUND_PENDING","REFUNDING","REFUNDED","FAILED"],"isRequired":true,"uniqueKey":"order.status","typeLabel":"enum\u003cstring>"},"health":{"type":"string","enum":["HEALTHY","STUCK"],"isRequired":true,"uniqueKey":"order.health","typeLabel":"enum\u003cstring>"},"fundsStatus":{"type":"string","enum":["IN_USER_WALLET","BURNED_ON_ARC","AWAITING_ATTESTATION","USDC_ON_ARBITRUM","IN_TRANSIT_TO_CELO","USDM_ON_CELO","COPM_ON_CELO","DELIVERED_TO_DESTINATION","REFUND_IN_TRANSIT","REFUNDED_TO_SOURCE","UNKNOWN"],"isRequired":true,"uniqueKey":"order.fundsStatus","typeLabel":"enum\u003cstring>"},"createdAt":{"type":"string","format":"date-time","isRequired":true,"uniqueKey":"order.createdAt","typeLabel":"string\u003cdate-time>"},"updatedAt":{"type":"string","format":"date-time","isRequired":true,"uniqueKey":"order.updatedAt","typeLabel":"string\u003cdate-time>"},"reference":{"oneOf":[{"type":"string","uniqueKey":"order.reference.oneOf.0","typeLabel":"string"},{"type":"null","uniqueKey":"order.reference.oneOf.1","typeLabel":"null"}],"uniqueKey":"order.reference","typeLabel":"string | null"},"burnTxHash":{"oneOf":[{"type":"string","uniqueKey":"order.burnTxHash.oneOf.0","typeLabel":"string"},{"type":"null","uniqueKey":"order.burnTxHash.oneOf.1","typeLabel":"null"}],"uniqueKey":"order.burnTxHash","typeLabel":"string | null"},"messageHash":{"oneOf":[{"type":"string","uniqueKey":"order.messageHash.oneOf.0","typeLabel":"string"},{"type":"null","uniqueKey":"order.messageHash.oneOf.1","typeLabel":"null"}],"uniqueKey":"order.messageHash","typeLabel":"string | null"},"burnNonce":{"oneOf":[{"type":"string","uniqueKey":"order.burnNonce.oneOf.0","typeLabel":"string"},{"type":"null","uniqueKey":"order.burnNonce.oneOf.1","typeLabel":"null"}],"uniqueKey":"order.burnNonce","typeLabel":"string | null"},"burnedAt":{"oneOf":[{"type":"string","format":"date-time","uniqueKey":"order.burnedAt.oneOf.0","typeLabel":"string\u003cdate-time>"},{"type":"null","format":"date-time","uniqueKey":"order.burnedAt.oneOf.1","typeLabel":"null"}],"uniqueKey":"order.burnedAt","typeLabel":"string\u003cdate-time> | null"},"stuckReason":{"oneOf":[{"type":"string","uniqueKey":"order.stuckReason.oneOf.0","typeLabel":"string"},{"type":"null","uniqueKey":"order.stuckReason.oneOf.1","typeLabel":"null"}],"uniqueKey":"order.stuckReason","typeLabel":"string | null"}},"isRequired":true,"uniqueKey":"order","typeLabel":"object"}},"uniqueKey":"","typeLabel":"object"},"examples":{"Example":{"title":"Example","value":{"order":{"orderId":"\u003cstring>","quoteId":"\u003cstring>","organizationId":"\u003cstring>","sourceAddress":"0x2222222222222222222222222222222222222222","destinationAddress":"0x2222222222222222222222222222222222222222","status":"CREATED","health":"HEALTHY","fundsStatus":"IN_USER_WALLET","createdAt":"2023-11-07T05:31:56Z","updatedAt":"2023-11-07T05:31:56Z","reference":"\u003cstring>","burnTxHash":"\u003cstring>","messageHash":"\u003cstring>","burnNonce":"\u003cstring>","burnedAt":"2023-11-07T05:31:56Z","stuckReason":"\u003cstring>"}}}},"exampleType":"generated"}},"exampleType":"generated"},"c56b9c0a-7417-4f98-a2d9-017fdaaea9e2":{"description":"Missing or invalid integration API key","content":{"application/json":{"schema":{"type":"object","properties":{"error":{"type":"string","uniqueKey":"error","typeLabel":"string"}},"uniqueKey":"","typeLabel":"object"},"examples":{"Example":{"title":"Example","value":{"error":"\u003cstring>"}}},"exampleType":"generated"}},"exampleType":"generated"},"49f22909-eed5-496f-80f9-477752b95405":{"description":"Settlement lifecycle error","content":{"application/json":{"schema":{"type":"object","required":["error"],"properties":{"error":{"type":"object","required":["code","message","stage","fundsStatus","fundsMoved","retryable","nextAction"],"properties":{"code":{"type":"string","enum":["INVALID_REQUEST","RATE_LIMITED","INVALID_AMOUNT","INVALID_SOURCE_ADDRESS","INVALID_DESTINATION_ADDRESS","BELOW_MINIMUM","ABOVE_MAXIMUM","QUOTE_EXPIRED","QUOTE_NOT_FOUND","ROUTE_UNAVAILABLE","SLIPPAGE_LIMIT_EXCEEDED","MENTO_CAPACITY_EXCEEDED","IDEMPOTENCY_CONFLICT","QUOTE_ALREADY_USED","INVALID_BURN","BURN_ALREADY_USED","INVALID_IDEMPOTENCY_KEY","ORDER_NOT_FOUND","PROVIDER_UNAVAILABLE","INTERNAL_ERROR","INTAKE_PAUSED","SETTLEMENT_ACCOUNT_INACTIVE"],"isRequired":true,"uniqueKey":"error.code","typeLabel":"enum\u003cstring>"},"message":{"type":"string","isRequired":true,"uniqueKey":"error.message","typeLabel":"string"},"stage":{"type":"string","isRequired":true,"uniqueKey":"error.stage","typeLabel":"string"},"fundsStatus":{"type":"string","isRequired":true,"uniqueKey":"error.fundsStatus","typeLabel":"string"},"fundsMoved":{"type":"boolean","isRequired":true,"uniqueKey":"error.fundsMoved","typeLabel":"boolean"},"retryable":{"type":"boolean","isRequired":true,"uniqueKey":"error.retryable","typeLabel":"boolean"},"nextAction":{"type":"string","isRequired":true,"uniqueKey":"error.nextAction","typeLabel":"string"},"requestId":{"type":"string","uniqueKey":"error.requestId","typeLabel":"string"}},"isRequired":true,"uniqueKey":"error","typeLabel":"object"}},"uniqueKey":"","typeLabel":"object"},"examples":{"Example":{"title":"Example","value":{"error":{"code":"INVALID_REQUEST","message":"\u003cstring>","stage":"\u003cstring>","fundsStatus":"\u003cstring>","fundsMoved":true,"retryable":true,"nextAction":"\u003cstring>","requestId":"\u003cstring>"}}}},"exampleType":"generated"}},"exampleType":"generated"},"bb0f7f7c-4871-47ef-af37-571b81807551":{"description":"Settlement lifecycle error","content":{"application/json":{"schema":{"type":"object","required":["error"],"properties":{"error":{"type":"object","required":["code","message","stage","fundsStatus","fundsMoved","retryable","nextAction"],"properties":{"code":{"type":"string","enum":["INVALID_REQUEST","RATE_LIMITED","INVALID_AMOUNT","INVALID_SOURCE_ADDRESS","INVALID_DESTINATION_ADDRESS","BELOW_MINIMUM","ABOVE_MAXIMUM","QUOTE_EXPIRED","QUOTE_NOT_FOUND","ROUTE_UNAVAILABLE","SLIPPAGE_LIMIT_EXCEEDED","MENTO_CAPACITY_EXCEEDED","IDEMPOTENCY_CONFLICT","QUOTE_ALREADY_USED","INVALID_BURN","BURN_ALREADY_USED","INVALID_IDEMPOTENCY_KEY","ORDER_NOT_FOUND","PROVIDER_UNAVAILABLE","INTERNAL_ERROR","INTAKE_PAUSED","SETTLEMENT_ACCOUNT_INACTIVE"],"isRequired":true,"uniqueKey":"error.code","typeLabel":"enum\u003cstring>"},"message":{"type":"string","isRequired":true,"uniqueKey":"error.message","typeLabel":"string"},"stage":{"type":"string","isRequired":true,"uniqueKey":"error.stage","typeLabel":"string"},"fundsStatus":{"type":"string","isRequired":true,"uniqueKey":"error.fundsStatus","typeLabel":"string"},"fundsMoved":{"type":"boolean","isRequired":true,"uniqueKey":"error.fundsMoved","typeLabel":"boolean"},"retryable":{"type":"boolean","isRequired":true,"uniqueKey":"error.retryable","typeLabel":"boolean"},"nextAction":{"type":"string","isRequired":true,"uniqueKey":"error.nextAction","typeLabel":"string"},"requestId":{"type":"string","uniqueKey":"error.requestId","typeLabel":"string"}},"isRequired":true,"uniqueKey":"error","typeLabel":"object"}},"uniqueKey":"","typeLabel":"object"},"examples":{"Example":{"title":"Example","value":{"error":{"code":"INVALID_REQUEST","message":"\u003cstring>","stage":"\u003cstring>","fundsStatus":"\u003cstring>","fundsMoved":true,"retryable":true,"nextAction":"\u003cstring>","requestId":"\u003cstring>"}}}},"exampleType":"generated"}},"exampleType":"generated"}},"security":{"1171e2fd-4dac-4570-8d32-297b4dcbef89":{"bearerAuth":{"type":"http","scheme":"bearer","description":"Integration API key. Send as `Bearer copby_live_pk_…`.","scopes":[]}}},"servers":{"4ae65532-7c1a-4bf3-93e3-d489fa18fbf6":{"url":"https://api.copby.digitalcop.shop","description":"Production API"}},"processedSecurityOptions":[{"schemes":[{"scheme":{"type":"http","scheme":"bearer","description":"Integration API key. Send as `Bearer copby_live_pk_…`.","scopes":[]},"schema":{"title":"Bearer Auth","type":"string","isRequired":true,"description":"Integration API key. Send as `Bearer copby_live_pk_…`.","format":"bearer","typeLabel":"string\u003cbearer>","deprecated":false},"schemeName":"bearerAuth","name":"Authorization"}],"title":"bearerAuth"}]},"originalFileLocation":"openapi.yaml"},"subdomain":"cop-by","siteName":"COP By Integrations","title":"Get a settlement order - COP By Integrations","navMaps":{"firstHrefInVersion":{},"firstHrefInLanguage":{}},"lastModified":"2026-10-04T21:08:36.103Z","originalFileLocation":"api-reference/settlement/get-a-settlement-order.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=\"application-name\" content=\"COP By Integrations\">\u003cmeta data-mint-head name=\"generator\" content=\"Mintlify\">\u003clink data-mint-head rel=\"apple-touch-icon\" type=\"image/png\" sizes=\"180x180\" href=\"https://mintlify.s3.us-west-1.amazonaws.com/cop-by/_generated/favicon/apple-touch-icon.png?v=3\">\u003clink data-mint-head rel=\"icon\" type=\"image/png\" sizes=\"32x32\" href=\"https://mintlify.s3.us-west-1.amazonaws.com/cop-by/_generated/favicon/favicon-32x32.png?v=3\">\u003clink data-mint-head rel=\"icon\" type=\"image/png\" sizes=\"16x16\" href=\"https://mintlify.s3.us-west-1.amazonaws.com/cop-by/_generated/favicon/favicon-16x16.png?v=3\">\u003clink data-mint-head rel=\"shortcut icon\" type=\"image/x-icon\" href=\"https://mintlify.s3.us-west-1.amazonaws.com/cop-by/_generated/favicon/favicon.ico?v=3\">\u003cmeta data-mint-head property=\"og:title\" content=\"Get a settlement order - COP By Integrations\">\u003cmeta data-mint-head property=\"og:site_name\" content=\"COP By Integrations\">\u003cmeta data-mint-head property=\"og:url\" content=\"https://docs.copby.digitalcop.shop/api-reference/settlement/get-a-settlement-order\">\u003cmeta data-mint-head property=\"og:type\" content=\"website\">\u003cmeta data-mint-head property=\"og:image\" content=\"https://cop-by.mintlify.site/_mintlify/api/og/v2?division=Settlement\u0026amp;title=Get+a+settlement+order\u0026amp;theme=98a17941bf9968fb666b281f\u0026amp;signature=f8f0764b31c9044b6841348c1ad4af5a9d908df198e011de862a8edc30a16ce1\">\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 order - COP By Integrations\">\u003cmeta data-mint-head name=\"twitter:image\" content=\"https://cop-by.mintlify.site/_mintlify/api/og/v2?division=Settlement\u0026amp;title=Get+a+settlement+order\u0026amp;theme=98a17941bf9968fb666b281f\u0026amp;signature=f8f0764b31c9044b6841348c1ad4af5a9d908df198e011de862a8edc30a16ce1\">\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/cop-by/_generated/favicon/browserconfig.xml?v=3\">\u003cmeta data-mint-head name=\"apple-mobile-web-app-title\" content=\"COP By Integrations\">\u003cmeta data-mint-head name=\"msapplication-TileColor\" content=\"#1B4D3E\">\u003clink data-mint-head rel=\"canonical\" href=\"https://docs.copby.digitalcop.shop/api-reference/settlement/get-a-settlement-order\">\u003clink data-mint-head rel=\"alternate\" type=\"application/xml\" href=\"/sitemap.xml\">\u003clink data-mint-head rel=\"alternate\" type=\"text/markdown\" href=\"/api-reference/settlement/get-a-settlement-order.md\">\u003cscript data-mint-head type=\"application/ld+json\">{\"@context\":\"https://schema.org\",\"@graph\":[{\"@type\":\"Organization\",\"@id\":\"https://docs.copby.digitalcop.shop/#organization\",\"name\":\"COP By Integrations\",\"url\":\"https://docs.copby.digitalcop.shop\"},{\"@type\":\"WebSite\",\"@id\":\"https://docs.copby.digitalcop.shop#website\",\"name\":\"COP By Integrations\",\"url\":\"https://docs.copby.digitalcop.shop\",\"publisher\":{\"@id\":\"https://docs.copby.digitalcop.shop/#organization\"}},{\"@type\":\"WebPage\",\"@id\":\"https://docs.copby.digitalcop.shop/api-reference/settlement/get-a-settlement-order#webpage\",\"url\":\"https://docs.copby.digitalcop.shop/api-reference/settlement/get-a-settlement-order\",\"name\":\"Get a settlement order\",\"dateModified\":\"2026-10-04T21:08:36.103Z\",\"isPartOf\":{\"@id\":\"https://docs.copby.digitalcop.shop#website\"},\"breadcrumb\":{\"@id\":\"https://docs.copby.digitalcop.shop/api-reference/settlement/get-a-settlement-order#breadcrumb\"}},{\"@type\":\"BreadcrumbList\",\"@id\":\"https://docs.copby.digitalcop.shop/api-reference/settlement/get-a-settlement-order#breadcrumb\",\"itemListElement\":[{\"@type\":\"ListItem\",\"position\":1,\"name\":\"Settlement\",\"item\":\"https://docs.copby.digitalcop.shop/api-reference/settlement/create-an-arc-usdc-to-celo-copm-quote\"},{\"@type\":\"ListItem\",\"position\":2,\"name\":\"Get a settlement order\",\"item\":\"https://docs.copby.digitalcop.shop/api-reference/settlement/get-a-settlement-order\"}]},{\"@type\":[\"TechArticle\",\"APIReference\"],\"@id\":\"https://docs.copby.digitalcop.shop/api-reference/settlement/get-a-settlement-order#apireference\",\"headline\":\"Get a settlement order\",\"name\":\"Get a settlement order\",\"url\":\"https://docs.copby.digitalcop.shop/api-reference/settlement/get-a-settlement-order\",\"mainEntityOfPage\":{\"@id\":\"https://docs.copby.digitalcop.shop/api-reference/settlement/get-a-settlement-order#webpage\"},\"dateModified\":\"2026-10-04T21:08:36.103Z\",\"publisher\":{\"@id\":\"https://docs.copby.digitalcop.shop/#organization\"},\"isPartOf\":{\"@id\":\"https://docs.copby.digitalcop.shop#website\"}}]}\u003c/script>\u003cscript data-mint-head type=\"application/ld+json\">{\"@context\":\"https://schema.org\",\"@type\":\"WebSite\",\"name\":\"COP By Integrations\",\"publisher\":{\"@type\":\"Organization\",\"name\":\"COP By Integrations\"},\"provider\":{\"@type\":\"Organization\",\"name\":\"Mintlify\",\"url\":\"https://mintlify.com\"}}\u003c/script>","agentPointerHref":"/api-reference/settlement/get-a-settlement-order.md","siteName":"COP By Integrations","nav":{"global":null,"tabs":[{"tab":"Guides","icon":"book-open","pages":[{"title":"Guides","href":""}]},{"tab":"API reference","icon":"square-terminal","groups":[{"group":"BRE-B","pages":[{"title":"Get a BRE-B quote","deprecated":null,"version":null,"openapi":"/openapi.yaml get /api/integrations/breb/quote","href":"/api-reference/bre-b/get-a-bre-b-quote"},{"title":"Get KYC status","deprecated":null,"version":null,"openapi":"/openapi.yaml get /api/integrations/breb/kyc","href":"/api-reference/bre-b/get-kyc-status"},{"title":"Start KYC","deprecated":null,"version":null,"openapi":"/openapi.yaml post /api/integrations/breb/kyc","href":"/api-reference/bre-b/start-kyc"},{"title":"Send KYC email OTP","deprecated":null,"version":null,"openapi":"/openapi.yaml post /api/integrations/breb/kyc/otp/send","href":"/api-reference/bre-b/send-kyc-email-otp"},{"title":"Verify KYC email OTP","deprecated":null,"version":null,"openapi":"/openapi.yaml post /api/integrations/breb/kyc/otp/verify","href":"/api-reference/bre-b/verify-kyc-email-otp"},{"title":"List payouts for this integration","deprecated":null,"version":null,"openapi":"/openapi.yaml get /api/integrations/breb/payouts","href":"/api-reference/bre-b/list-payouts-for-this-integration"},{"title":"Create a BRE-B payout","deprecated":null,"version":null,"openapi":"/openapi.yaml post /api/integrations/breb/payouts","href":"/api-reference/bre-b/create-a-bre-b-payout"},{"title":"Get a payout","deprecated":null,"version":null,"openapi":"/openapi.yaml get /api/integrations/breb/payouts/{payoutId}","href":"/api-reference/bre-b/get-a-payout"},{"title":"Confirm a payout deposit","deprecated":null,"version":null,"openapi":"/openapi.yaml post /api/integrations/breb/payouts/{payoutId}/confirm","href":"/api-reference/bre-b/confirm-a-payout-deposit"}]},{"group":"Webhooks","pages":[{"title":"Bridge webhook","deprecated":null,"version":null,"openapi":"/openapi.yaml post /api/breb/webhook","href":"/api-reference/webhooks/bridge-webhook"},{"title":"Retry due partner webhook deliveries","deprecated":null,"version":null,"openapi":"/openapi.yaml post /api/integrations/webhooks/deliver","href":"/api-reference/webhooks/retry-due-partner-webhook-deliveries"},{"title":"Partner payout status outbound","version":null,"deprecated":null,"openapi":"/openapi.yaml webhook partnerPayoutStatus","href":"/api-reference/webhooks/partner-payout-status-outbound"}]},{"group":"Swaps","pages":[{"title":"Prepare a swap","deprecated":null,"version":null,"openapi":"/openapi.yaml post /api/integrations/swaps/prepare","href":"/api-reference/swaps/prepare-a-swap"},{"title":"Confirm a swap","deprecated":null,"version":null,"openapi":"/openapi.yaml post /api/integrations/swaps/{intentId}/confirm","href":"/api-reference/swaps/confirm-a-swap"},{"title":"List confirmed swaps","deprecated":null,"version":null,"openapi":"/openapi.yaml get /api/integrations/swaps","href":"/api-reference/swaps/list-confirmed-swaps"}]},{"group":"Settlement","pages":[{"title":"Create an Arc USDC to Celo COPm quote","deprecated":null,"version":null,"openapi":"/openapi.yaml post /api/integrations/settlements/quotes","href":"/api-reference/settlement/create-an-arc-usdc-to-celo-copm-quote"},{"title":"Create an idempotent settlement order","description":"Reserves an unexpired quote for this organization. Creating the order\ndoes not move funds. The response contains the Arc approval and CCTP\nburn calls for the user wallet. The organization must have an active,\nfunded Arbitrum settlement account.\n","deprecated":null,"version":null,"openapi":"/openapi.yaml post /api/integrations/settlements/orders","href":"/api-reference/settlement/create-an-idempotent-settlement-order"},{"title":"Get a settlement order","deprecated":null,"version":null,"openapi":"/openapi.yaml get /api/integrations/settlements/orders/{orderId}","href":"/api-reference/settlement/get-a-settlement-order"},{"title":"Verify an Arc CCTP burn and start settlement","description":"Submit the confirmed Arc transaction hash after executing the order's\nburn plan. COP By verifies the CCTP events against the order, then\nstarts the asynchronous CCTP, Squid, and Celo delivery flow.\n","deprecated":null,"version":null,"openapi":"/openapi.yaml post /api/integrations/settlements/orders/{orderId}/burn","href":"/api-reference/settlement/verify-an-arc-cctp-burn-and-start-settlement"}]}]}]},"basePath":"","title":"Get a settlement order - COP By Integrations","deploymentId":"dpl_vSEmv961Ncyvz1psVwgUnTXQMSYk","buildId":"dpl_vSEmv961Ncyvz1psVwgUnTXQMSYk","dynamics":["c2aa737661","2b790eda92","b0f84f53ff","a9bb46feb3"],"chunks":["OpenApiReferenceProvider-CrDfRf61.js","snippetPresets-Dv-cOUrx.js","utils-BUTreAgv.js","style-to-object-BY3JEAdk.js","utils-wsznt9RM.js","v4-DIgz8zy6.js","addUniqueKeysToSchema-DEsMlaPy.js","conditional-requirements-CFM0id0Q.js","cloneDeep-DontW4xJ.js","_Uint8Array-pP7X6_RM.js","isObject-FP1Yky1u.js","ApiExamples-CU_aGGP0.js","usePlaygroundInputsStore-7dNmUIbS.js","shallow-fTtruD8x.js","isEqual-BRfNFpSD.js","CodeSnippets-52884wUJ.js","CodeSnippet-eoRjC4Le.js","getApiPlaygroundDisplay-CZyAPlR2.js","Page-Cr9IwkK7.js","DynamicMarkdown-NFqqduU7.js","SectionHeading-DQ-mJoAt.js","icon-DXTBUt6s.js","MethodPill-2v-b3js5.js","getPastedJson-v_8Y1_4v.js","DuplicateIcon-DXIkhZIo.js","createIcon-DRpYuPZs.js","axios-CsQoIw0U.js","Markdown-CwtoSfEf.js","AssistantPageLink-CTqa3eoi.js","dist-DIfYWxfm.js","lib-DMeTj1gb.js","lib-B8HbPgcC.js","katex-Dbtb6Wk7.js","html-void-elements-mCSPHezU.js","marked.esm-CZWythHk.js"]}