Reserves an unexpired quote for this organization. Creating the order
does not move funds. The response contains the Arc approval and CCTP
burn calls for the user wallet. The organization must have an active,
funded Arbitrum settlement account.
Integration API key. Send as Bearer copby_live_pk_….
Headers
Idempotency-Key
string
required
Unique key for one logical order
Maximum string length: 200
Body
application/json
quoteId
string
required
Maximum string length: 40
reference
string
Maximum string length: 200
Response
Settlement order created
orderId
string
required
Example:
"ord_example"
status
enum<string>
required
Available options:
CREATED
health
enum<string>
required
Available options:
HEALTHY
fundsStatus
enum<string>
required
Available options:
IN_USER_WALLET
execution
object
required
Hide child attributes
execution.chainId
enum<integer>
required
Available options:
5042
execution.atomicBatch
object
required
Hide child attributes
execution.atomicBatch.calls
object[]
required
Required array length: 1 - 2 elements
Hide child attributes
execution.atomicBatch.calls.to
string
required
Pattern: ^0x[a-fA-F0-9]{40}$
Example:
"0x2222222222222222222222222222222222222222"
execution.atomicBatch.calls.data
string
required
Encoded contract calldata
execution.atomicBatch.calls.value
enum<string>
required
Available options:
0
execution.atomicBatch.estimatedUserConfirmations
integer
required
Required range: 1 <= x <= 2
execution.atomicBatch.mode
enum<string>
required
Available options:
atomic_batch,
sequential,
burn_only
execution.sequential
object
required
Hide child attributes
execution.sequential.calls
object[]
required
Required array length: 1 - 2 elements
Hide child attributes
execution.sequential.calls.to
string
required
Pattern: ^0x[a-fA-F0-9]{40}$
Example:
"0x2222222222222222222222222222222222222222"
execution.sequential.calls.data
string
required
Encoded contract calldata
execution.sequential.calls.value
enum<string>
required
Available options:
0
execution.sequential.estimatedUserConfirmations
integer
required
Required range: 1 <= x <= 2
execution.sequential.mode
enum<string>
required
Available options:
atomic_batch,
sequential,
burn_only
{"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":"control","enabled":true,"payload":{"type":"string","value":"control"},"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/create-an-idempotent-settlement-order","slug":"/api-reference/settlement/create-an-idempotent-settlement-order","pageMetadata":{"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","autogeneratedByOpenApi":true},"description":{"compiledSource":"\"use strict\";\nconst {jsx: _jsx} = arguments[0];\nconst {useMDXComponents: _provideComponents} = arguments[0];\nfunction _createMdxContent(props) {\n const _components = {\n p: \"p\",\n ..._provideComponents(),\n ...props.components\n };\n return _jsx(_components.p, {\n children: \"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 });\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":"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","autogeneratedByOpenApi":true}}},"mdxSourceWithNoJs":null},"mdxExtracts":{"tableOfContents":[],"codeExamples":{}},"jsLinks":[],"openApiReferenceData":{"operation":{"tags":["Settlement"],"operationId":"createSettlementOrder","summary":"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","parameters":["640b07d8-4d29-4f60-aa54-e189de8923b4"],"requestBody":"b4791af2-5007-46ad-bfe3-4a4713764cb6","responses":{"201":"3de27c6f-ee37-47e1-b736-32de4915b098","400":"965ab4d2-925e-4465-835a-441c4e68be9d","401":"097fa079-6ccb-4f12-8c76-7f200f5a2845","404":"dccb2427-a4bb-4b18-9769-8cd1ac303091","409":"75f6d726-9f28-436f-a67b-5fc9f33fad6f","429":"cba5486d-e7da-4643-9205-49b52c9da47f"},"method":"post","type":"path","servers":["4ae65532-7c1a-4bf3-93e3-d489fa18fbf6"],"security":["1171e2fd-4dac-4570-8d32-297b4dcbef89"],"path":"/api/integrations/settlements/orders","baseUrlOptions":["https://api.copby.digitalcop.shop"],"title":"Create an idempotent settlement order","codeSamples":[],"requestExampleLanguages":["bash","javascript","python"],"requiredOnlyExamples":true,"requestExampleType":"generated","responseExampleType":"generated","prefillPlaygroundWithExample":true,"prefillPlaygroundExamples":[{"body.quoteId":"qst_example","body.reference":"customer-deposit-1042"}],"urlDisplay":"full"},"dependencies":{"parameters":{"640b07d8-4d29-4f60-aa54-e189de8923b4":{"name":"Idempotency-Key","in":"header","required":true,"schema":{"type":"string","maxLength":200,"isRequired":true,"description":"Unique key for one logical order","uniqueKey":"","typeLabel":"string"},"description":"Unique key for one logical order"}},"requestBody":{"required":true,"content":{"application/json":{"schema":{"type":"object","required":["quoteId"],"properties":{"quoteId":{"type":"string","maxLength":40,"isRequired":true,"uniqueKey":"quoteId","typeLabel":"string"},"reference":{"type":"string","maxLength":200,"uniqueKey":"reference","typeLabel":"string"}},"uniqueKey":"","typeLabel":"object"},"example":{"quoteId":"qst_example","reference":"customer-deposit-1042"},"examples":{"Example":{"title":"Example","value":{"quoteId":"qst_example","reference":"customer-deposit-1042"}}},"exampleType":"examples"}},"exampleType":"examples"},"responses":{"3de27c6f-ee37-47e1-b736-32de4915b098":{"description":"Settlement order created","content":{"application/json":{"schema":{"type":"object","required":["orderId","status","health","fundsStatus","execution"],"properties":{"orderId":{"type":"string","example":"ord_example","isRequired":true,"uniqueKey":"orderId","typeLabel":"string"},"status":{"type":"string","enum":["CREATED"],"isRequired":true,"uniqueKey":"status","typeLabel":"enum\u003cstring>"},"health":{"type":"string","enum":["HEALTHY"],"isRequired":true,"uniqueKey":"health","typeLabel":"enum\u003cstring>"},"fundsStatus":{"type":"string","enum":["IN_USER_WALLET"],"isRequired":true,"uniqueKey":"fundsStatus","typeLabel":"enum\u003cstring>"},"execution":{"type":"object","required":["chainId","atomicBatch","sequential"],"properties":{"chainId":{"type":"integer","enum":[5042],"isRequired":true,"uniqueKey":"execution.chainId","typeLabel":"enum\u003cinteger>"},"atomicBatch":{"type":"object","required":["calls","estimatedUserConfirmations","mode"],"properties":{"calls":{"type":"array","minItems":1,"maxItems":2,"items":{"type":"object","required":["to","data","value"],"properties":{"to":{"type":"string","pattern":"^0x[a-fA-F0-9]{40}$","example":"0x2222222222222222222222222222222222222222","isRequired":true,"uniqueKey":"execution.atomicBatch.calls.items.[INDEX].to","typeLabel":"string"},"data":{"type":"string","description":"Encoded contract calldata","isRequired":true,"uniqueKey":"execution.atomicBatch.calls.items.[INDEX].data","typeLabel":"string"},"value":{"type":"string","enum":["0"],"isRequired":true,"uniqueKey":"execution.atomicBatch.calls.items.[INDEX].value","typeLabel":"enum\u003cstring>"}},"uniqueKey":"execution.atomicBatch.calls.items.[INDEX]","typeLabel":"object"},"isRequired":true,"uniqueKey":"execution.atomicBatch.calls","typeLabel":"object[]"},"estimatedUserConfirmations":{"type":"integer","minimum":1,"maximum":2,"isRequired":true,"uniqueKey":"execution.atomicBatch.estimatedUserConfirmations","typeLabel":"integer"},"mode":{"type":"string","enum":["atomic_batch","sequential","burn_only"],"isRequired":true,"uniqueKey":"execution.atomicBatch.mode","typeLabel":"enum\u003cstring>"}},"isRequired":true,"uniqueKey":"execution.atomicBatch","typeLabel":"object"},"sequential":{"type":"object","required":["calls","estimatedUserConfirmations","mode"],"properties":{"calls":{"type":"array","minItems":1,"maxItems":2,"items":{"type":"object","required":["to","data","value"],"properties":{"to":{"type":"string","pattern":"^0x[a-fA-F0-9]{40}$","example":"0x2222222222222222222222222222222222222222","isRequired":true,"uniqueKey":"execution.sequential.calls.items.[INDEX].to","typeLabel":"string"},"data":{"type":"string","description":"Encoded contract calldata","isRequired":true,"uniqueKey":"execution.sequential.calls.items.[INDEX].data","typeLabel":"string"},"value":{"type":"string","enum":["0"],"isRequired":true,"uniqueKey":"execution.sequential.calls.items.[INDEX].value","typeLabel":"enum\u003cstring>"}},"uniqueKey":"execution.sequential.calls.items.[INDEX]","typeLabel":"object"},"isRequired":true,"uniqueKey":"execution.sequential.calls","typeLabel":"object[]"},"estimatedUserConfirmations":{"type":"integer","minimum":1,"maximum":2,"isRequired":true,"uniqueKey":"execution.sequential.estimatedUserConfirmations","typeLabel":"integer"},"mode":{"type":"string","enum":["atomic_batch","sequential","burn_only"],"isRequired":true,"uniqueKey":"execution.sequential.mode","typeLabel":"enum\u003cstring>"}},"isRequired":true,"uniqueKey":"execution.sequential","typeLabel":"object"}},"isRequired":true,"uniqueKey":"execution","typeLabel":"object"}},"uniqueKey":"","typeLabel":"object"},"examples":{"Example":{"title":"Example","value":{"orderId":"ord_example","status":"CREATED","health":"HEALTHY","fundsStatus":"IN_USER_WALLET","execution":{"chainId":5042,"atomicBatch":{"calls":[{"to":"0x2222222222222222222222222222222222222222","data":"\u003cstring>","value":"0"}],"estimatedUserConfirmations":1,"mode":"atomic_batch"},"sequential":{"calls":[{"to":"0x2222222222222222222222222222222222222222","data":"\u003cstring>","value":"0"}],"estimatedUserConfirmations":1,"mode":"atomic_batch"}}}}},"exampleType":"generated"}},"exampleType":"generated"},"965ab4d2-925e-4465-835a-441c4e68be9d":{"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"},"097fa079-6ccb-4f12-8c76-7f200f5a2845":{"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"},"dccb2427-a4bb-4b18-9769-8cd1ac303091":{"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"},"75f6d726-9f28-436f-a67b-5fc9f33fad6f":{"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"},"cba5486d-e7da-4643-9205-49b52c9da47f":{"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":"Create an idempotent settlement order - COP By Integrations","navMaps":{"firstHrefInVersion":{},"firstHrefInLanguage":{}},"lastModified":"2026-10-04T21:08:36.090Z","originalFileLocation":"api-reference/settlement/create-an-idempotent-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=\"description\" content=\"Reserves an unexpired quote for this organization. Creating the order does not move funds. The response contains the Arc approval and CCTP burn calls for the user wallet. The organization must have an active, funded Arbitrum settlement account.\">\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=\"Create an idempotent settlement order - COP By Integrations\">\u003cmeta data-mint-head property=\"og:description\" content=\"Reserves an unexpired quote for this organization. Creating the order does not move funds. The response contains the Arc approval and CCTP burn calls for the user wallet. The organization must have an active, funded Arbitrum settlement account.\">\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/create-an-idempotent-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=Create+an+idempotent+settlement+order\u0026amp;description=Reserves+an+unexpired+quote+for+this+organization.+Creating+the+order%0Adoes+not+move+funds.+The+response+contains+the+Arc+approval+and+CCTP%0Aburn+calls+for+the+us\u0026amp;theme=98a17941bf9968fb666b281f\u0026amp;signature=d314a4c27fb33f037b37e501f2d198e5cfcf3505be2809169928c056ab1f79e1\">\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=\"Create an idempotent settlement order - COP By Integrations\">\u003cmeta data-mint-head name=\"twitter:description\" content=\"Reserves an unexpired quote for this organization. Creating the order does not move funds. The response contains the Arc approval and CCTP burn calls for the user wallet. The organization must have an active, funded Arbitrum settlement account.\">\u003cmeta data-mint-head name=\"twitter:image\" content=\"https://cop-by.mintlify.site/_mintlify/api/og/v2?division=Settlement\u0026amp;title=Create+an+idempotent+settlement+order\u0026amp;description=Reserves+an+unexpired+quote+for+this+organization.+Creating+the+order%0Adoes+not+move+funds.+The+response+contains+the+Arc+approval+and+CCTP%0Aburn+calls+for+the+us\u0026amp;theme=98a17941bf9968fb666b281f\u0026amp;signature=d314a4c27fb33f037b37e501f2d198e5cfcf3505be2809169928c056ab1f79e1\">\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/create-an-idempotent-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/create-an-idempotent-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/create-an-idempotent-settlement-order#webpage\",\"url\":\"https://docs.copby.digitalcop.shop/api-reference/settlement/create-an-idempotent-settlement-order\",\"name\":\"Create an idempotent settlement order\",\"description\":\"Reserves an unexpired quote for this organization. Creating the order does not move funds. The response contains the Arc approval and CCTP burn calls for the user wallet. The organization must have an active, funded Arbitrum settlement account.\",\"dateModified\":\"2026-10-04T21:08:36.090Z\",\"isPartOf\":{\"@id\":\"https://docs.copby.digitalcop.shop#website\"},\"breadcrumb\":{\"@id\":\"https://docs.copby.digitalcop.shop/api-reference/settlement/create-an-idempotent-settlement-order#breadcrumb\"}},{\"@type\":\"BreadcrumbList\",\"@id\":\"https://docs.copby.digitalcop.shop/api-reference/settlement/create-an-idempotent-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\":\"Create an idempotent settlement order\",\"item\":\"https://docs.copby.digitalcop.shop/api-reference/settlement/create-an-idempotent-settlement-order\"}]},{\"@type\":[\"TechArticle\",\"APIReference\"],\"@id\":\"https://docs.copby.digitalcop.shop/api-reference/settlement/create-an-idempotent-settlement-order#apireference\",\"headline\":\"Create an idempotent settlement order\",\"name\":\"Create an idempotent settlement order\",\"description\":\"Reserves an unexpired quote for this organization. Creating the order does not move funds. The response contains the Arc approval and CCTP burn calls for the user wallet. The organization must have an active, funded Arbitrum settlement account.\",\"url\":\"https://docs.copby.digitalcop.shop/api-reference/settlement/create-an-idempotent-settlement-order\",\"mainEntityOfPage\":{\"@id\":\"https://docs.copby.digitalcop.shop/api-reference/settlement/create-an-idempotent-settlement-order#webpage\"},\"dateModified\":\"2026-10-04T21:08:36.090Z\",\"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/create-an-idempotent-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","description":"Returns a 60-second quote for a 10 to 1,000 USDC principal. The Circle\nforwarding fee is additional. No funds move while creating a quote.\n","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","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","description":null,"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","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":"Create an idempotent 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"]}