{"openapi":"3.0.1","info":{"title":"DcWallet API","description":"DcWallet REST API for enterprise integrations.\n\nEvery API key belongs to its issuing user, brand and environment. Existing keys retain v1 signing for their original enterprise and can use the same key and secret with v2 signing to select an authorized personal or enterprise workspace. New keys accept v2 only. Published machine routes accept v2 with explicit workspace selection; new routes require v2. Personal receiving operations require approved KYC. An enterprise needs a prior KYB approval for business access; EDD and renewal review do not remove that approval, while rejection and explicit AML restrictions still apply. Each operation lists its accepted signature versions in `x-dcwallet-signature-versions`.\n\n## Enterprise verification and receiving-account onboarding flow\n\nUse v2 signatures throughout. A live key with `kyb:read` and `kyb:write` can complete KYB onboarding; these calls do not consume the monthly API quota. KYB is shared across environments, so sandbox keys may read field requirements but cannot create or change KYB applications.\n\n1. Select `X-Workspace: personal`. Call `GET /api/v1/enterprise-applications/requirements?registrationCountry=HK&businessType=ecommerce` in live or sandbox. Its `fixedFieldOptions` lists valid company and person values. `businessTypeSuggestions` are suggestions; `businessScope` is required free text. Dates including `establishedDate` use `YYYY-MM-DD`. Register a user-level HTTPS callback now with `POST /api/v1/webhook-endpoints`, `webhook:write` and `Idempotency-Key` to receive the first submission event; save its signing secret.\n2. In live, upload PDF/JPEG/PNG documents through `POST /api/v1/enterprise-applications/documents/{documentType}`. Submit one `relatedParties[]` entry per person or organization with all applicable roles, then call `POST /api/v1/enterprise-applications` once with complete KYB fields and document IDs. CN needs exactly one legal representative; HK needs at least one director. The response contains the enterprise ID; failed validation leaves no enterprise application. `handheldDocumentRequired` means KYB itself requires a handheld image for each representative or director.\n3. The applicant is linked to the new enterprise automatically. To link an existing enterprise to the same callback, select its enterprise workspace and call `POST /api/v1/webhook-endpoints/enterprise-links/{enterpriseId}/link` with enterprise developer management permission. Select `X-Workspace: enterprise:<applicationId>` to poll `GET /api/v1/enterprise-applications/{applicationId}` for status and required corrections. If rejected or explicitly asked for corrections, EDD or renewal, upload new documents as needed and call `POST /api/v1/enterprise-applications/{applicationId}/resubmit` with the complete corrected KYB body.\n4. With an approved enterprise and `account:read` / `account:write`, call `GET /api/v1/bank-options/{bankId}/requirements`. Submit `POST /api/v1/bank-account-applications` with `bankId`, `currencies` (for example `[\"SGD\"]` for DBS), `purpose`, the returned `requirementsVersion`, and `Idempotency-Key`. Put missing KYB materials in `supplements[]`; a DBS handheld image uses `requirementCode=director_or_ubo_handheld_id`, `personId` from eligiblePeople and `documentId` from the KYB upload route. Supplements require `kyb:write`. For each `applicationDocuments[]` requirement, upload the stated number of PDF/JPEG/PNG files with `POST /api/v1/bank-application-documents`, then include each `code` and returned `documentId` in the application. Poll the application and list issued accounts. Currency Cloud, DBS and CFSB create synthetic accounts immediately in sandbox; live applications await manual review.\n5. To generate a chain receiving address, call `POST /api/v1/blockchain-addresses` with `chain` and an `Idempotency-Key`; the server selects the workspace's default receiving wallet. Retain the active address and verify it with `GET /api/v1/blockchain-addresses`. Add `account:read` to poll `GET /api/v1/payment-records` for receipts. In sandbox only, `POST /api/v1/sandbox/crypto-deposits` or `/fiat-deposits` credits a selected receiving instrument and emits a settlement event.\n\n## Transfer business integration flow\n\nUse these endpoints to check funds, submit one transfer, reconcile its status and receive its final result:\n\n1. `GET /api/v1/accounts` — select an account and read its `availableBalance`; retain `accountId` as `sourceAccountId`.\n2. `POST /api/v1/transfers` — submit one transfer with an `Idempotency-Key`; retain the returned transfer `id`.\n3. `GET /api/v1/transfers/{transferId}` — query until status is `succeeded`, `failed`, `rejected` or `cancelled`.\n4. `POST /api/v1/webhook-endpoints` — register once with `transfer.succeeded`, `transfer.failed`, `transfer.rejected` and `transfer.cancelled` to receive asynchronous final results.\n\nA direct mainland CNY payout does not require a contact or beneficiary identity number. Use a CNH source account, set `recipientCurrency` to `CNY`, omit `destinationAccountId`, and provide `recipientBankName`, `recipientAccountHolder` and `recipientAccountNo`. CNH and CNY settle at the platform-fixed 1:1 rule without an external FX quote. The bank country defaults to `CN` and beneficiary type defaults to `individual` when omitted.\n\nFor a business beneficiary, set `recipientBeneficiaryType` to `business`. `recipientRegistrationNumber` is optional and accepts identifiers used across regions; set `recipientRegistrationType` to values such as `brn`, `business_registration`, `company_number`, `vat` or `ein`. Hong Kong local payments use `HK`/`CHATS`/`bank_code`, euro-area payments use IBAN/`SEPA`, UK local payments use `GB`/`CHAPS`/`sort_code`, and US local payments use `US`/`FEDWIRE`/`aba`. Availability still depends on the enterprise policy and configured payout channel.\n\n`GET /api/v1/transfers/requirements` returns country/currency field suggestions. `suggestedRails` is not a closed enum or proof of channel support. `configuredRails` lists rails advertised by eligible channels; query each rail with amount to check policy and route availability. `available=true` on automatic routes requires explicit rail support; an unverified automatic route yields `rail_support_unverified`. Manual routes report `executionMode=manual` without asserting bank-rail support. The platform CNY sandbox simulator reports `executionMode=api` and `simulated=true`; live CNY remains manual. Provider-defined rails have `fieldRulesKnown=false`, so the generic fields and provider requirements apply. Submission rechecks the same rail-aware route and policy gates. `recipientPaymentRail` is optional and can be inferred, as can `recipientAccountIdentifierType` and common `recipientRoutingCodeType`; direct CNY bank country defaults to `CN`. The API reference marks closed enums with all accepted values and labels provider-specific values as dynamic. Use `GET /api/v1/bank-options/{bankId}/requirements` for bank currencies and documents, `GET /api/v1/enterprise-applications/requirements` for KYB options, and `GET /api/v1/webhook-endpoints/event-types` for the current sandbox test event list.\n\nKYB `kybStatus` can be `not_submitted`, `pending`, `approved`, `rejected`, `review_required`, `edd_required` or `renewal_required`; none is permanently terminal because renewal or resubmission can follow. Bank applications use `pending`, `reviewing`, `approved` and `rejected`; the last two are terminal. Payments use `pending_payment`, `paying`, `pending_settlement`, `settled`, `failed`, `refunded` and `reversed`; settled funds may later be refunded or reversed. Terminal transfer states are `succeeded`, `failed`, `rejected` and `cancelled`. Webhook `previousStatus` and `currentStatus` use the status values for their resource; `delivered` and `dead_letter` are terminal delivery states. See the developer guide for meanings and defaults.\n\n## Exchange flows\n\n`GET /api/v1/exchange/rates` is indicative. To execute a cross-chain conversion, select source and target IDs from `GET /api/v1/blockchain-addresses`, then `POST /api/v1/exchange/quotes` with `sourceAddressId`, `targetAddressId`, `sellCurrency`, `buyCurrency` and `sellAmount`. The returned `id` and `quoteExpiresAt` identify a quote that has not moved funds. Confirm with `POST /api/v1/exchange/orders` containing `quoteId` and a new `Idempotency-Key`. Poll `GET /api/v1/exchange/orders/{orderId}` or list orders. `POST /api/v1/exchange/orders/{orderId}/cancel` is allowed only before an irreversible cross-chain step. These writes require v2 enterprise workspace and `exchange:write`; fiat exchange rates are still indicative only.\n\nFor crypto-to-fiat, choose `sourceAddressId` from `GET /api/v1/blockchain-addresses` and a fiat `targetAccountId` from `GET /api/v1/accounts?assetType=fiat`. Submit `POST /api/v1/exchange/crypto-fiat-orders` with both currencies, `sellAmount`, and `minimumBuyAmount`. Sandbox settles atomically. In Live the crypto balance is locked and the collection workflow starts; fiat settlement remains pending reconciliation. Poll the order for `collectionStatus`, `collectionTxHash`, `actualBuyAmount`, `actualBuyCurrency`, and `nextStep`. Use a new `Idempotency-Key` per order and reuse it only for an exact retry.\n\n## Card issuing business integration flow\n\nUse these endpoints, in order, to issue, fund, cancel and reconcile a card:\n\n1. `GET /api/v1/accounts` — select and retain the funding `accountId`.\n2. `POST /api/v1/contacts` — create the cardholder and retain `contactId`.\n3. `POST /api/v1/contacts/{contactId}/documents/{role}` — upload raw JPG/PNG bytes. Use `passport` once for a passport, or both `identity_front` and `identity_back` for an identity card.\n4. `GET /api/v1/contacts/{contactId}` — continue only when `cardIssuingStatus` is `ready` and `missingFields` is empty.\n5. `GET /api/v1/card-products` — select an eligible `productId`.\n6. `POST /api/v1/card-applications` — issue the card using `contactId`, `productId` and `sourceAccountId`.\n7. `POST /api/v1/cards/{cardId}/top-ups` — add funds to the issued card.\n8. `POST /api/v1/cards/{cardId}/cancel` — cancel the card and return its confirmed refund transaction when available.\n9. `GET /api/v1/cards/{cardId}/transactions` — list top-ups, purchases, refunds and other card activity.\n\nIf issuance or a top-up returns HTTP `202` or code `9003`, do not create a replacement request. Poll `GET /api/v1/card-applications/{applicationId}` or `GET /api/v1/cards/{cardId}/top-ups/{topUpId}` with the returned ID. To reconcile funding debits and cancellation refunds, also query `GET /api/v1/accounts/{accountId}/transactions`.\n\n`POST /api/v1/card-applications/quote`, webhooks and hosted card reveal sessions are recommended but are not required for this minimum lifecycle.\n\n## Shared-card budget flow\n\nShared cards spend from a common budget ledger. Use `GET /api/v1/card-budgets/options` to select a currency, then `POST /api/v1/card-budgets` with `currency`, `name` and an `Idempotency-Key`. Upstream routing is selected internally and is never returned by the public API. If allocation is pending, check `GET /api/v1/card-budgets/{budgetId}` and retry `POST /api/v1/card-budgets/{budgetId}/allocate` when inventory becomes available. Fund the active budget with `POST /api/v1/card-budgets/{budgetId}/fund` using `sourceAccountId`, `amount`, `Idempotency-Key`, and `twoFaCode` in the signed JSON body for live v2 requests. Historical v1 requests continue to send `X-2FA-Code`. Funding and withdrawal require both `card:write` and `transfer:write` scopes and enterprise transfer permission; use `GET /api/v1/card-budgets/{budgetId}/transfers` to reconcile results.\n\nSelect a product from `GET /api/v1/card-budgets/{budgetId}/products`. Quote and issue with `POST /api/v1/card-applications/quote` and `POST /api/v1/card-applications`: include `budgetId`, set `initialAmount` to `0`, retain a `sourceAccountId` for issuance fees, and provide `sharedCardQuota` when the product says `supportsSharedCardQuota`. The `singleTransactionLimit` field is reserved and must be omitted. Use `GET /api/v1/cards?budgetId=...` to list shared cards. Their `balance` is not the shared budget balance; read the budget detail for available and locked amounts. Do not call card top-ups for shared cards. Return unused funds with `POST /api/v1/card-budgets/{budgetId}/withdraw`.\n","contact":{"name":"DcWallet Engineering"},"license":{"name":"Private"},"version":"1.0.0"},"servers":[{"url":"/","description":"Current host"}],"security":[{"apiKeyAuth":[]}],"tags":[{"name":"0. Workspaces","description":"With a v2-signed request, discover personal and accessible enterprise workspaces."},{"name":"0. Enterprise verification","description":"Apply for, supplement, submit and query KYB in the selected workspace."},{"name":"1. Assets and accounts","description":"Inspect asset accounts, balances and transactions in the signed workspace. Personal reads require a v2-signed request and approved KYC."},{"name":"2. Receiving accounts","description":"Apply for a bank account, generate a blockchain receiving address, and list receiving resources in the signed workspace. Writes require v2 signatures, account:write and Idempotency-Key."},{"name":"3. Contacts","description":"Create or reuse the same dashboard contact for invoices, payment links and cardholders."},{"name":"4. Receivables","description":"Create and manage invoices and payment links, then query received payments."},{"name":"5. Transfers","description":"Submit and query single or batch transfers."},{"name":"6. Card issuing","description":"Complete contact readiness, select a product, issue and manage cards, and query card transactions."},{"name":"7. Webhooks","description":"Register callbacks after the core flow works; the webhook signing secret is returned once."},{"name":"8. Treasury Agent","description":"Optional final module for discovering capabilities and managing asynchronous Agent tasks."}],"paths":{"/api/v1/webhook-endpoints":{"get":{"tags":["7. Webhooks"],"summary":"List webhook endpoints owned by the API key user","description":"Signature versions: v1 and v2.","operationId":"getWebhookEndpoints","parameters":[{"name":"X-Timestamp","in":"header","description":"Current Unix epoch time in seconds. Requests older or newer than five minutes are rejected.","required":true,"schema":{"pattern":"[0-9]{10}","type":"string","example":"1787562000"}},{"name":"X-Request-ID","in":"header","description":"Unique 16-128 character request identifier used for replay protection; never reuse it for a different HTTP request.","required":true,"schema":{"pattern":"[A-Za-z0-9._:-]{16,128}","type":"string","example":"018f6f4e-8f62-7fc2-9c4b-7be2f4203b6a"}},{"name":"X-Content-SHA256","in":"header","description":"Lowercase hexadecimal SHA-256 digest of the exact raw request body; use the digest of zero bytes when no body is sent.","required":true,"schema":{"pattern":"[0-9a-f]{64}","type":"string","example":"e3b0c44298fc1c149afbf4c8996fb92427ae41e4649b934ca495991b7852b855"}},{"name":"X-Workspace","in":"header","description":"Enterprise reads are available on this route. For enterprise access, copy your own enterprise:<id> from GET /api/v1/workspaces. Required for v2 requests. V1 requests use the historical key's fixed enterprise.","required":false,"schema":{"pattern":"personal|enterprise:[1-9][0-9]*","type":"string","example":"personal"}},{"name":"X-Environment","in":"header","description":"Required and signed for v2 requests: live or sandbox. Optional for v1 requests.","required":false,"schema":{"pattern":"live|sandbox","type":"string","example":"live"}},{"name":"X-Signature","in":"header","description":"Existing keys accept v1 for their fixed enterprise or v2 for a signed workspace; new keys accept v2 only.","required":true,"schema":{"pattern":"v[12]=[0-9a-f]{64}","type":"string","example":"v2=0123456789abcdef0123456789abcdef0123456789abcdef0123456789abcdef"}},{"name":"Accept-Language","in":"header","description":"Response language: en-US = English (default); zh-CN = Simplified Chinese; zh-TW = Traditional Chinese. Numeric error codes are language-neutral.","required":false,"schema":{"type":"string","enum":["en-US","zh-CN","zh-TW"],"default":"en-US"}}],"responses":{"400":{"description":"Malformed JSON, missing header or invalid request parameter","headers":{"X-Request-ID":{"description":"Request identifier echoed for support and reconciliation.","schema":{"type":"string"}}},"content":{"application/json":{"schema":{"$ref":"#/components/schemas/ApiResponseVoid"}}}},"500":{"description":"Unexpected internal error; contact support with X-Request-ID","headers":{"X-Request-ID":{"description":"Request identifier echoed for support and reconciliation.","schema":{"type":"string"}}},"content":{"application/json":{"schema":{"$ref":"#/components/schemas/ApiResponseVoid"}}}},"403":{"description":"API-key scope, subscription, tenant or policy does not allow the operation","headers":{"X-Request-ID":{"description":"Request identifier echoed for support and reconciliation.","schema":{"type":"string"}}},"content":{"application/json":{"schema":{"$ref":"#/components/schemas/ApiResponseVoid"}}}},"200":{"description":"OK","headers":{"X-Request-ID":{"description":"Request identifier echoed for support and reconciliation.","schema":{"type":"string"}},"X-Quota-Limit":{"description":"Monthly API request allowance for the subscription.","schema":{"type":"integer","format":"int64"}},"X-Quota-Remaining":{"description":"Requests remaining in the current monthly allowance after this request.","schema":{"type":"integer","format":"int64"}},"X-Quota-Reset":{"description":"Unix epoch time in seconds when the monthly allowance resets.","schema":{"type":"integer","format":"int64"}},"X-Quota-Workspace":{"description":"Verified workspace owning this allowance: personal or enterprise:<id>.","schema":{"type":"string"}},"X-Quota-Environment":{"description":"Environment owning the allowance: sandbox or live.","schema":{"type":"string"}}},"content":{"application/json":{"schema":{"$ref":"#/components/schemas/ApiResponseListWebhookEndpointResponse"}}}},"401":{"description":"Invalid API key, content hash, signature, timestamp or request ID","headers":{"X-Request-ID":{"description":"Request identifier echoed for support and reconciliation.","schema":{"type":"string"}}},"content":{"application/json":{"schema":{"$ref":"#/components/schemas/ApiResponseVoid"}}}},"404":{"description":"Resource not found in this enterprise and environment","headers":{"X-Request-ID":{"description":"Request identifier echoed for support and reconciliation.","schema":{"type":"string"}}},"content":{"application/json":{"schema":{"$ref":"#/components/schemas/ApiResponseVoid"}}}},"422":{"description":"Business rule rejected the request","headers":{"X-Request-ID":{"description":"Request identifier echoed for support and reconciliation.","schema":{"type":"string"}}},"content":{"application/json":{"schema":{"$ref":"#/components/schemas/ApiResponseVoid"}}}},"503":{"description":"A required platform service is temporarily unavailable","headers":{"X-Request-ID":{"description":"Request identifier echoed for support and reconciliation.","schema":{"type":"string"}}},"content":{"application/json":{"schema":{"$ref":"#/components/schemas/ApiResponseVoid"}}}},"409":{"description":"Idempotency or resource-state conflict","headers":{"X-Request-ID":{"description":"Request identifier echoed for support and reconciliation.","schema":{"type":"string"}}},"content":{"application/json":{"schema":{"$ref":"#/components/schemas/ApiResponseVoid"}}}},"429":{"description":"Per-minute rate limit or monthly quota exceeded","headers":{"X-Request-ID":{"description":"Request identifier echoed for support and reconciliation.","schema":{"type":"string"}},"X-Quota-Limit":{"description":"Monthly API request allowance for the subscription.","schema":{"type":"integer","format":"int64"}},"X-Quota-Remaining":{"description":"Requests remaining in the current monthly allowance after this request.","schema":{"type":"integer","format":"int64"}},"X-Quota-Reset":{"description":"Unix epoch time in seconds when the monthly allowance resets.","schema":{"type":"integer","format":"int64"}},"X-Quota-Workspace":{"description":"Verified workspace owning this allowance: personal or enterprise:<id>.","schema":{"type":"string"}},"X-Quota-Environment":{"description":"Environment owning the allowance: sandbox or live.","schema":{"type":"string"}},"Retry-After":{"description":"Seconds until the exhausted quota or rate window resets. Sign retries with a new X-Request-ID.","schema":{"type":"integer","format":"int64"}},"X-RateLimit-Scope":{"description":"Rate counter scope: workspace, or user for enterprise verification calls.","schema":{"type":"string"}},"X-RateLimit-Limit":{"description":"Per-minute request limit when rate-limited.","schema":{"type":"integer","format":"int64"}},"X-RateLimit-Remaining":{"description":"Zero when the minute limit is exhausted.","schema":{"type":"integer","format":"int64"}},"X-RateLimit-Reset":{"description":"Unix epoch seconds when the minute limit resets.","schema":{"type":"integer","format":"int64"}}},"content":{"application/json":{"schema":{"$ref":"#/components/schemas/ApiResponseVoid"}}}},"413":{"description":"Request body is too large","headers":{"X-Request-ID":{"description":"Request identifier echoed for support and reconciliation.","schema":{"type":"string"}}},"content":{"application/json":{"schema":{"$ref":"#/components/schemas/ApiResponseVoid"}}}}},"x-dcwallet-signature-versions":["v1","v2"]},"post":{"tags":["7. Webhooks"],"summary":"Register an account-level v2 webhook endpoint; the secret is returned once","description":"A v2 endpoint belongs to the API key owner, brand, and environment, and receives subscribed events from the personal workspace and every actively linked enterprise. X-Workspace and enterprise IDs in the callback URL do not bind it to one enterprise; route deliveries by enterpriseId in the verified body. Send Idempotency-Key with v2 requests and reuse it with the same body when retrying. Historical v1 requests retain enterprise-scoped endpoints.\n\nSignature versions: v1 and v2.","operationId":"postWebhookEndpoints","parameters":[{"name":"Idempotency-Key","in":"header","description":"Required for v2 signed POST/PATCH requests, including read-only previews; optional for historical v1 requests. Reuse the same value when retrying the same operation.","required":false,"schema":{"type":"string"}},{"name":"X-Content-SHA256","in":"header","description":"The x-content-sha256 value for this resource.","required":true,"schema":{"type":"string"}},{"name":"X-Timestamp","in":"header","description":"Current Unix epoch time in seconds. Requests older or newer than five minutes are rejected.","required":true,"schema":{"pattern":"[0-9]{10}","type":"string","example":"1787562000"}},{"name":"X-Request-ID","in":"header","description":"Unique 16-128 character request identifier used for replay protection; never reuse it for a different HTTP request.","required":true,"schema":{"pattern":"[A-Za-z0-9._:-]{16,128}","type":"string","example":"018f6f4e-8f62-7fc2-9c4b-7be2f4203b6a"}},{"name":"X-Workspace","in":"header","description":"Enterprise writes are available on this route. For enterprise access, copy your own enterprise:<id> from GET /api/v1/workspaces. Required for v2 requests. V1 requests use the historical key's fixed enterprise.","required":false,"schema":{"pattern":"personal|enterprise:[1-9][0-9]*","type":"string","example":"personal"}},{"name":"X-Environment","in":"header","description":"Required and signed for v2 requests: live or sandbox. Optional for v1 requests.","required":false,"schema":{"pattern":"live|sandbox","type":"string","example":"live"}},{"name":"X-Signature","in":"header","description":"Existing keys accept v1 for their fixed enterprise or v2 for a signed workspace; new keys accept v2 only.","required":true,"schema":{"pattern":"v[12]=[0-9a-f]{64}","type":"string","example":"v2=0123456789abcdef0123456789abcdef0123456789abcdef0123456789abcdef"}},{"name":"Accept-Language","in":"header","description":"Response language: en-US = English (default); zh-CN = Simplified Chinese; zh-TW = Traditional Chinese. Numeric error codes are language-neutral.","required":false,"schema":{"type":"string","enum":["en-US","zh-CN","zh-TW"],"default":"en-US"}}],"requestBody":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/WebhookEndpointRequest"}}},"required":true},"responses":{"400":{"description":"Malformed JSON, missing header or invalid request parameter","headers":{"X-Request-ID":{"description":"Request identifier echoed for support and reconciliation.","schema":{"type":"string"}}},"content":{"application/json":{"schema":{"$ref":"#/components/schemas/ApiResponseVoid"}}}},"500":{"description":"Unexpected internal error; contact support with X-Request-ID","headers":{"X-Request-ID":{"description":"Request identifier echoed for support and reconciliation.","schema":{"type":"string"}}},"content":{"application/json":{"schema":{"$ref":"#/components/schemas/ApiResponseVoid"}}}},"403":{"description":"API-key scope, subscription, tenant or policy does not allow the operation","headers":{"X-Request-ID":{"description":"Request identifier echoed for support and reconciliation.","schema":{"type":"string"}}},"content":{"application/json":{"schema":{"$ref":"#/components/schemas/ApiResponseVoid"}}}},"200":{"description":"OK","headers":{"X-Request-ID":{"description":"Request identifier echoed for support and reconciliation.","schema":{"type":"string"}},"X-Quota-Limit":{"description":"Monthly API request allowance for the subscription.","schema":{"type":"integer","format":"int64"}},"X-Quota-Remaining":{"description":"Requests remaining in the current monthly allowance after this request.","schema":{"type":"integer","format":"int64"}},"X-Quota-Reset":{"description":"Unix epoch time in seconds when the monthly allowance resets.","schema":{"type":"integer","format":"int64"}},"X-Quota-Workspace":{"description":"Verified workspace owning this allowance: personal or enterprise:<id>.","schema":{"type":"string"}},"X-Quota-Environment":{"description":"Environment owning the allowance: sandbox or live.","schema":{"type":"string"}}},"content":{"application/json":{"schema":{"$ref":"#/components/schemas/ApiResponseWebhookEndpointResponse"}}}},"401":{"description":"Invalid API key, content hash, signature, timestamp or request ID","headers":{"X-Request-ID":{"description":"Request identifier echoed for support and reconciliation.","schema":{"type":"string"}}},"content":{"application/json":{"schema":{"$ref":"#/components/schemas/ApiResponseVoid"}}}},"404":{"description":"Resource not found in this enterprise and environment","headers":{"X-Request-ID":{"description":"Request identifier echoed for support and reconciliation.","schema":{"type":"string"}}},"content":{"application/json":{"schema":{"$ref":"#/components/schemas/ApiResponseVoid"}}}},"422":{"description":"Business rule rejected the request","headers":{"X-Request-ID":{"description":"Request identifier echoed for support and reconciliation.","schema":{"type":"string"}}},"content":{"application/json":{"schema":{"$ref":"#/components/schemas/ApiResponseVoid"}}}},"503":{"description":"A required platform service is temporarily unavailable","headers":{"X-Request-ID":{"description":"Request identifier echoed for support and reconciliation.","schema":{"type":"string"}}},"content":{"application/json":{"schema":{"$ref":"#/components/schemas/ApiResponseVoid"}}}},"409":{"description":"Idempotency or resource-state conflict","headers":{"X-Request-ID":{"description":"Request identifier echoed for support and reconciliation.","schema":{"type":"string"}}},"content":{"application/json":{"schema":{"$ref":"#/components/schemas/ApiResponseVoid"}}}},"429":{"description":"Per-minute rate limit or monthly quota exceeded","headers":{"X-Request-ID":{"description":"Request identifier echoed for support and reconciliation.","schema":{"type":"string"}},"X-Quota-Limit":{"description":"Monthly API request allowance for the subscription.","schema":{"type":"integer","format":"int64"}},"X-Quota-Remaining":{"description":"Requests remaining in the current monthly allowance after this request.","schema":{"type":"integer","format":"int64"}},"X-Quota-Reset":{"description":"Unix epoch time in seconds when the monthly allowance resets.","schema":{"type":"integer","format":"int64"}},"X-Quota-Workspace":{"description":"Verified workspace owning this allowance: personal or enterprise:<id>.","schema":{"type":"string"}},"X-Quota-Environment":{"description":"Environment owning the allowance: sandbox or live.","schema":{"type":"string"}},"Retry-After":{"description":"Seconds until the exhausted quota or rate window resets. Sign retries with a new X-Request-ID.","schema":{"type":"integer","format":"int64"}},"X-RateLimit-Scope":{"description":"Rate counter scope: workspace, or user for enterprise verification calls.","schema":{"type":"string"}},"X-RateLimit-Limit":{"description":"Per-minute request limit when rate-limited.","schema":{"type":"integer","format":"int64"}},"X-RateLimit-Remaining":{"description":"Zero when the minute limit is exhausted.","schema":{"type":"integer","format":"int64"}},"X-RateLimit-Reset":{"description":"Unix epoch seconds when the minute limit resets.","schema":{"type":"integer","format":"int64"}}},"content":{"application/json":{"schema":{"$ref":"#/components/schemas/ApiResponseVoid"}}}},"413":{"description":"Request body is too large","headers":{"X-Request-ID":{"description":"Request identifier echoed for support and reconciliation.","schema":{"type":"string"}}},"content":{"application/json":{"schema":{"$ref":"#/components/schemas/ApiResponseVoid"}}}}},"callbacks":{"eventDelivery":{"{$request.body#/url}":{"post":{"summary":"Receive a signed event","description":"Return any 2xx to accept delivery. Verify X-Webhook-Signature as HMAC-SHA256(secret, X-Webhook-Timestamp + '.' + exact raw JSON body) before processing. X-Workspace repeats the workspaceType/enterpriseId inside the signed body. Deduplicate retries by eventId.","requestBody":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/WebhookEventPayload"}}}},"responses":{"200":{"description":"Any 2xx accepts the delivery"}}}}}},"x-dcwallet-signature-versions":["v1","v2"]}},"/api/v1/webhook-endpoints/{endpointId}/test":{"post":{"tags":["7. Webhooks"],"summary":"Enqueue one signed sandbox test event for this endpoint","description":"Sandbox only. Query GET /api/v1/webhook-endpoints/event-types for current event names. Uses the normal asynchronous signing, retry and delivery-log pipeline, does not mutate cards or funds, and sends only to this endpoint. The signed JSON payload contains eventType, previousStatus, currentStatus, workspaceType and enterpriseId; status values follow the matching transfer, payment, bank or KYB response contract.\n\nSignature versions: v1 and v2.","operationId":"postWebhookEndpointsByEndpointIdTest","parameters":[{"name":"endpointId","in":"path","description":"Webhook endpoint ID returned by /api/v1/webhook-endpoints. Keep IDs as strings.","required":true,"schema":{"pattern":"[0-9]+","type":"string","example":"337893979704000512"}},{"name":"X-Timestamp","in":"header","description":"Current Unix epoch time in seconds. Requests older or newer than five minutes are rejected.","required":true,"schema":{"pattern":"[0-9]{10}","type":"string","example":"1787562000"}},{"name":"X-Request-ID","in":"header","description":"Unique 16-128 character request identifier used for replay protection; never reuse it for a different HTTP request.","required":true,"schema":{"pattern":"[A-Za-z0-9._:-]{16,128}","type":"string","example":"018f6f4e-8f62-7fc2-9c4b-7be2f4203b6a"}},{"name":"X-Content-SHA256","in":"header","description":"Lowercase hexadecimal SHA-256 digest of the exact raw request body; use the digest of zero bytes when no body is sent.","required":true,"schema":{"pattern":"[0-9a-f]{64}","type":"string","example":"e3b0c44298fc1c149afbf4c8996fb92427ae41e4649b934ca495991b7852b855"}},{"name":"X-Workspace","in":"header","description":"Enterprise writes are available on this route. For enterprise access, copy your own enterprise:<id> from GET /api/v1/workspaces. Required for v2 requests. V1 requests use the historical key's fixed enterprise.","required":false,"schema":{"pattern":"personal|enterprise:[1-9][0-9]*","type":"string","example":"personal"}},{"name":"X-Environment","in":"header","description":"Required and signed for v2 requests: live or sandbox. Optional for v1 requests.","required":false,"schema":{"pattern":"live|sandbox","type":"string","example":"live"}},{"name":"X-Signature","in":"header","description":"Existing keys accept v1 for their fixed enterprise or v2 for a signed workspace; new keys accept v2 only.","required":true,"schema":{"pattern":"v[12]=[0-9a-f]{64}","type":"string","example":"v2=0123456789abcdef0123456789abcdef0123456789abcdef0123456789abcdef"}},{"name":"Accept-Language","in":"header","description":"Response language: en-US = English (default); zh-CN = Simplified Chinese; zh-TW = Traditional Chinese. Numeric error codes are language-neutral.","required":false,"schema":{"type":"string","enum":["en-US","zh-CN","zh-TW"],"default":"en-US"}}],"requestBody":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/WebhookTestRequest"}}},"required":true},"responses":{"400":{"description":"Malformed JSON, missing header or invalid request parameter","headers":{"X-Request-ID":{"description":"Request identifier echoed for support and reconciliation.","schema":{"type":"string"}}},"content":{"application/json":{"schema":{"$ref":"#/components/schemas/ApiResponseVoid"}}}},"500":{"description":"Unexpected internal error; contact support with X-Request-ID","headers":{"X-Request-ID":{"description":"Request identifier echoed for support and reconciliation.","schema":{"type":"string"}}},"content":{"application/json":{"schema":{"$ref":"#/components/schemas/ApiResponseVoid"}}}},"403":{"description":"API-key scope, subscription, tenant or policy does not allow the operation","headers":{"X-Request-ID":{"description":"Request identifier echoed for support and reconciliation.","schema":{"type":"string"}}},"content":{"application/json":{"schema":{"$ref":"#/components/schemas/ApiResponseVoid"}}}},"202":{"description":"Test event accepted for asynchronous delivery","headers":{"X-Request-ID":{"description":"Request identifier echoed for support and reconciliation.","schema":{"type":"string"}},"X-Quota-Limit":{"description":"Monthly API request allowance for the subscription.","schema":{"type":"integer","format":"int64"}},"X-Quota-Remaining":{"description":"Requests remaining in the current monthly allowance after this request.","schema":{"type":"integer","format":"int64"}},"X-Quota-Reset":{"description":"Unix epoch time in seconds when the monthly allowance resets.","schema":{"type":"integer","format":"int64"}},"X-Quota-Workspace":{"description":"Verified workspace owning this allowance: personal or enterprise:<id>.","schema":{"type":"string"}},"X-Quota-Environment":{"description":"Environment owning the allowance: sandbox or live.","schema":{"type":"string"}}},"content":{"application/json":{"schema":{"$ref":"#/components/schemas/ApiResponseWebhookTestResponse"}}}},"401":{"description":"Invalid API key, content hash, signature, timestamp or request ID","headers":{"X-Request-ID":{"description":"Request identifier echoed for support and reconciliation.","schema":{"type":"string"}}},"content":{"application/json":{"schema":{"$ref":"#/components/schemas/ApiResponseVoid"}}}},"404":{"description":"Resource not found in this enterprise and environment","headers":{"X-Request-ID":{"description":"Request identifier echoed for support and reconciliation.","schema":{"type":"string"}}},"content":{"application/json":{"schema":{"$ref":"#/components/schemas/ApiResponseVoid"}}}},"422":{"description":"Business rule rejected the request","headers":{"X-Request-ID":{"description":"Request identifier echoed for support and reconciliation.","schema":{"type":"string"}}},"content":{"application/json":{"schema":{"$ref":"#/components/schemas/ApiResponseVoid"}}}},"503":{"description":"A required platform service is temporarily unavailable","headers":{"X-Request-ID":{"description":"Request identifier echoed for support and reconciliation.","schema":{"type":"string"}}},"content":{"application/json":{"schema":{"$ref":"#/components/schemas/ApiResponseVoid"}}}},"409":{"description":"Idempotency or resource-state conflict","headers":{"X-Request-ID":{"description":"Request identifier echoed for support and reconciliation.","schema":{"type":"string"}}},"content":{"application/json":{"schema":{"$ref":"#/components/schemas/ApiResponseVoid"}}}},"429":{"description":"Per-minute rate limit or monthly quota exceeded","headers":{"X-Request-ID":{"description":"Request identifier echoed for support and reconciliation.","schema":{"type":"string"}},"X-Quota-Limit":{"description":"Monthly API request allowance for the subscription.","schema":{"type":"integer","format":"int64"}},"X-Quota-Remaining":{"description":"Requests remaining in the current monthly allowance after this request.","schema":{"type":"integer","format":"int64"}},"X-Quota-Reset":{"description":"Unix epoch time in seconds when the monthly allowance resets.","schema":{"type":"integer","format":"int64"}},"X-Quota-Workspace":{"description":"Verified workspace owning this allowance: personal or enterprise:<id>.","schema":{"type":"string"}},"X-Quota-Environment":{"description":"Environment owning the allowance: sandbox or live.","schema":{"type":"string"}},"Retry-After":{"description":"Seconds until the exhausted quota or rate window resets. Sign retries with a new X-Request-ID.","schema":{"type":"integer","format":"int64"}},"X-RateLimit-Scope":{"description":"Rate counter scope: workspace, or user for enterprise verification calls.","schema":{"type":"string"}},"X-RateLimit-Limit":{"description":"Per-minute request limit when rate-limited.","schema":{"type":"integer","format":"int64"}},"X-RateLimit-Remaining":{"description":"Zero when the minute limit is exhausted.","schema":{"type":"integer","format":"int64"}},"X-RateLimit-Reset":{"description":"Unix epoch seconds when the minute limit resets.","schema":{"type":"integer","format":"int64"}}},"content":{"application/json":{"schema":{"$ref":"#/components/schemas/ApiResponseVoid"}}}},"413":{"description":"Request body is too large","headers":{"X-Request-ID":{"description":"Request identifier echoed for support and reconciliation.","schema":{"type":"string"}}},"content":{"application/json":{"schema":{"$ref":"#/components/schemas/ApiResponseVoid"}}}}},"x-dcwallet-signature-versions":["v1","v2"]}},"/api/v1/webhook-endpoints/{endpointId}/disable":{"post":{"tags":["7. Webhooks"],"summary":"Disable a webhook endpoint owned by this user","description":"Signature versions: v1 and v2.","operationId":"postWebhookEndpointsByEndpointIdDisable","parameters":[{"name":"endpointId","in":"path","description":"Webhook endpoint ID returned by /api/v1/webhook-endpoints. Keep IDs as strings.","required":true,"schema":{"pattern":"[0-9]+","type":"string","example":"337893979704000512"}},{"name":"X-Timestamp","in":"header","description":"Current Unix epoch time in seconds. Requests older or newer than five minutes are rejected.","required":true,"schema":{"pattern":"[0-9]{10}","type":"string","example":"1787562000"}},{"name":"X-Request-ID","in":"header","description":"Unique 16-128 character request identifier used for replay protection; never reuse it for a different HTTP request.","required":true,"schema":{"pattern":"[A-Za-z0-9._:-]{16,128}","type":"string","example":"018f6f4e-8f62-7fc2-9c4b-7be2f4203b6a"}},{"name":"X-Content-SHA256","in":"header","description":"Lowercase hexadecimal SHA-256 digest of the exact raw request body; use the digest of zero bytes when no body is sent.","required":true,"schema":{"pattern":"[0-9a-f]{64}","type":"string","example":"e3b0c44298fc1c149afbf4c8996fb92427ae41e4649b934ca495991b7852b855"}},{"name":"X-Workspace","in":"header","description":"Enterprise writes are available on this route. For enterprise access, copy your own enterprise:<id> from GET /api/v1/workspaces. Required for v2 requests. V1 requests use the historical key's fixed enterprise.","required":false,"schema":{"pattern":"personal|enterprise:[1-9][0-9]*","type":"string","example":"personal"}},{"name":"X-Environment","in":"header","description":"Required and signed for v2 requests: live or sandbox. Optional for v1 requests.","required":false,"schema":{"pattern":"live|sandbox","type":"string","example":"live"}},{"name":"X-Signature","in":"header","description":"Existing keys accept v1 for their fixed enterprise or v2 for a signed workspace; new keys accept v2 only.","required":true,"schema":{"pattern":"v[12]=[0-9a-f]{64}","type":"string","example":"v2=0123456789abcdef0123456789abcdef0123456789abcdef0123456789abcdef"}},{"name":"Accept-Language","in":"header","description":"Response language: en-US = English (default); zh-CN = Simplified Chinese; zh-TW = Traditional Chinese. Numeric error codes are language-neutral.","required":false,"schema":{"type":"string","enum":["en-US","zh-CN","zh-TW"],"default":"en-US"}}],"responses":{"400":{"description":"Malformed JSON, missing header or invalid request parameter","headers":{"X-Request-ID":{"description":"Request identifier echoed for support and reconciliation.","schema":{"type":"string"}}},"content":{"application/json":{"schema":{"$ref":"#/components/schemas/ApiResponseVoid"}}}},"500":{"description":"Unexpected internal error; contact support with X-Request-ID","headers":{"X-Request-ID":{"description":"Request identifier echoed for support and reconciliation.","schema":{"type":"string"}}},"content":{"application/json":{"schema":{"$ref":"#/components/schemas/ApiResponseVoid"}}}},"403":{"description":"API-key scope, subscription, tenant or policy does not allow the operation","headers":{"X-Request-ID":{"description":"Request identifier echoed for support and reconciliation.","schema":{"type":"string"}}},"content":{"application/json":{"schema":{"$ref":"#/components/schemas/ApiResponseVoid"}}}},"200":{"description":"OK","headers":{"X-Request-ID":{"description":"Request identifier echoed for support and reconciliation.","schema":{"type":"string"}},"X-Quota-Limit":{"description":"Monthly API request allowance for the subscription.","schema":{"type":"integer","format":"int64"}},"X-Quota-Remaining":{"description":"Requests remaining in the current monthly allowance after this request.","schema":{"type":"integer","format":"int64"}},"X-Quota-Reset":{"description":"Unix epoch time in seconds when the monthly allowance resets.","schema":{"type":"integer","format":"int64"}},"X-Quota-Workspace":{"description":"Verified workspace owning this allowance: personal or enterprise:<id>.","schema":{"type":"string"}},"X-Quota-Environment":{"description":"Environment owning the allowance: sandbox or live.","schema":{"type":"string"}}},"content":{"application/json":{"schema":{"$ref":"#/components/schemas/ApiResponseVoid"}}}},"401":{"description":"Invalid API key, content hash, signature, timestamp or request ID","headers":{"X-Request-ID":{"description":"Request identifier echoed for support and reconciliation.","schema":{"type":"string"}}},"content":{"application/json":{"schema":{"$ref":"#/components/schemas/ApiResponseVoid"}}}},"404":{"description":"Resource not found in this enterprise and environment","headers":{"X-Request-ID":{"description":"Request identifier echoed for support and reconciliation.","schema":{"type":"string"}}},"content":{"application/json":{"schema":{"$ref":"#/components/schemas/ApiResponseVoid"}}}},"422":{"description":"Business rule rejected the request","headers":{"X-Request-ID":{"description":"Request identifier echoed for support and reconciliation.","schema":{"type":"string"}}},"content":{"application/json":{"schema":{"$ref":"#/components/schemas/ApiResponseVoid"}}}},"503":{"description":"A required platform service is temporarily unavailable","headers":{"X-Request-ID":{"description":"Request identifier echoed for support and reconciliation.","schema":{"type":"string"}}},"content":{"application/json":{"schema":{"$ref":"#/components/schemas/ApiResponseVoid"}}}},"409":{"description":"Idempotency or resource-state conflict","headers":{"X-Request-ID":{"description":"Request identifier echoed for support and reconciliation.","schema":{"type":"string"}}},"content":{"application/json":{"schema":{"$ref":"#/components/schemas/ApiResponseVoid"}}}},"429":{"description":"Per-minute rate limit or monthly quota exceeded","headers":{"X-Request-ID":{"description":"Request identifier echoed for support and reconciliation.","schema":{"type":"string"}},"X-Quota-Limit":{"description":"Monthly API request allowance for the subscription.","schema":{"type":"integer","format":"int64"}},"X-Quota-Remaining":{"description":"Requests remaining in the current monthly allowance after this request.","schema":{"type":"integer","format":"int64"}},"X-Quota-Reset":{"description":"Unix epoch time in seconds when the monthly allowance resets.","schema":{"type":"integer","format":"int64"}},"X-Quota-Workspace":{"description":"Verified workspace owning this allowance: personal or enterprise:<id>.","schema":{"type":"string"}},"X-Quota-Environment":{"description":"Environment owning the allowance: sandbox or live.","schema":{"type":"string"}},"Retry-After":{"description":"Seconds until the exhausted quota or rate window resets. Sign retries with a new X-Request-ID.","schema":{"type":"integer","format":"int64"}},"X-RateLimit-Scope":{"description":"Rate counter scope: workspace, or user for enterprise verification calls.","schema":{"type":"string"}},"X-RateLimit-Limit":{"description":"Per-minute request limit when rate-limited.","schema":{"type":"integer","format":"int64"}},"X-RateLimit-Remaining":{"description":"Zero when the minute limit is exhausted.","schema":{"type":"integer","format":"int64"}},"X-RateLimit-Reset":{"description":"Unix epoch seconds when the minute limit resets.","schema":{"type":"integer","format":"int64"}}},"content":{"application/json":{"schema":{"$ref":"#/components/schemas/ApiResponseVoid"}}}},"413":{"description":"Request body is too large","headers":{"X-Request-ID":{"description":"Request identifier echoed for support and reconciliation.","schema":{"type":"string"}}},"content":{"application/json":{"schema":{"$ref":"#/components/schemas/ApiResponseVoid"}}}}},"x-dcwallet-signature-versions":["v1","v2"]}},"/api/v1/webhook-endpoints/enterprise-links/{enterpriseId}/revoke":{"post":{"tags":["7. Webhooks"],"summary":"Stop future deliveries and retries for this enterprise association","description":"Signature versions: v2 only.","operationId":"postWebhookEndpointsEnterpriseLinksByEnterpriseIdRevoke","parameters":[{"name":"enterpriseId","in":"path","description":"The enterprise id value for this resource.","required":true,"schema":{"pattern":"[0-9]+","type":"string","example":"337893979704000512"}},{"name":"X-Timestamp","in":"header","description":"Current Unix epoch time in seconds. Requests older or newer than five minutes are rejected.","required":true,"schema":{"pattern":"[0-9]{10}","type":"string","example":"1787562000"}},{"name":"X-Request-ID","in":"header","description":"Unique 16-128 character request identifier used for replay protection; never reuse it for a different HTTP request.","required":true,"schema":{"pattern":"[A-Za-z0-9._:-]{16,128}","type":"string","example":"018f6f4e-8f62-7fc2-9c4b-7be2f4203b6a"}},{"name":"X-Content-SHA256","in":"header","description":"Lowercase hexadecimal SHA-256 digest of the exact raw request body; use the digest of zero bytes when no body is sent.","required":true,"schema":{"pattern":"[0-9a-f]{64}","type":"string","example":"e3b0c44298fc1c149afbf4c8996fb92427ae41e4649b934ca495991b7852b855"}},{"name":"X-Workspace","in":"header","description":"Select enterprise:<id> using your own ID from GET /api/v1/workspaces; personal is unavailable for this operation.","required":true,"schema":{"pattern":"personal|enterprise:[1-9][0-9]*","type":"string","example":null}},{"name":"X-Environment","in":"header","description":"Signed key environment: live or sandbox.","required":true,"schema":{"pattern":"live|sandbox","type":"string","example":"live"}},{"name":"X-Signature","in":"header","description":"v2-prefixed lowercase HMAC-SHA256 signature; existing and new keys can use v2 when enabled.","required":true,"schema":{"pattern":"v2=[0-9a-f]{64}","type":"string","example":"v2=0123456789abcdef0123456789abcdef0123456789abcdef0123456789abcdef"}},{"name":"Accept-Language","in":"header","description":"Response language: en-US = English (default); zh-CN = Simplified Chinese; zh-TW = Traditional Chinese. Numeric error codes are language-neutral.","required":false,"schema":{"type":"string","enum":["en-US","zh-CN","zh-TW"],"default":"en-US"}}],"responses":{"400":{"description":"Malformed JSON, missing header or invalid request parameter","headers":{"X-Request-ID":{"description":"Request identifier echoed for support and reconciliation.","schema":{"type":"string"}}},"content":{"application/json":{"schema":{"$ref":"#/components/schemas/ApiResponseVoid"}}}},"500":{"description":"Unexpected internal error; contact support with X-Request-ID","headers":{"X-Request-ID":{"description":"Request identifier echoed for support and reconciliation.","schema":{"type":"string"}}},"content":{"application/json":{"schema":{"$ref":"#/components/schemas/ApiResponseVoid"}}}},"403":{"description":"API-key scope, subscription, tenant or policy does not allow the operation","headers":{"X-Request-ID":{"description":"Request identifier echoed for support and reconciliation.","schema":{"type":"string"}}},"content":{"application/json":{"schema":{"$ref":"#/components/schemas/ApiResponseVoid"}}}},"200":{"description":"OK","headers":{"X-Request-ID":{"description":"Request identifier echoed for support and reconciliation.","schema":{"type":"string"}},"X-Quota-Limit":{"description":"Monthly API request allowance for the subscription.","schema":{"type":"integer","format":"int64"}},"X-Quota-Remaining":{"description":"Requests remaining in the current monthly allowance after this request.","schema":{"type":"integer","format":"int64"}},"X-Quota-Reset":{"description":"Unix epoch time in seconds when the monthly allowance resets.","schema":{"type":"integer","format":"int64"}},"X-Quota-Workspace":{"description":"Verified workspace owning this allowance: personal or enterprise:<id>.","schema":{"type":"string"}},"X-Quota-Environment":{"description":"Environment owning the allowance: sandbox or live.","schema":{"type":"string"}}},"content":{"application/json":{"schema":{"$ref":"#/components/schemas/ApiResponseVoid"}}}},"401":{"description":"Invalid API key, content hash, signature, timestamp or request ID","headers":{"X-Request-ID":{"description":"Request identifier echoed for support and reconciliation.","schema":{"type":"string"}}},"content":{"application/json":{"schema":{"$ref":"#/components/schemas/ApiResponseVoid"}}}},"404":{"description":"Resource not found in this enterprise and environment","headers":{"X-Request-ID":{"description":"Request identifier echoed for support and reconciliation.","schema":{"type":"string"}}},"content":{"application/json":{"schema":{"$ref":"#/components/schemas/ApiResponseVoid"}}}},"422":{"description":"Business rule rejected the request","headers":{"X-Request-ID":{"description":"Request identifier echoed for support and reconciliation.","schema":{"type":"string"}}},"content":{"application/json":{"schema":{"$ref":"#/components/schemas/ApiResponseVoid"}}}},"503":{"description":"A required platform service is temporarily unavailable","headers":{"X-Request-ID":{"description":"Request identifier echoed for support and reconciliation.","schema":{"type":"string"}}},"content":{"application/json":{"schema":{"$ref":"#/components/schemas/ApiResponseVoid"}}}},"409":{"description":"Idempotency or resource-state conflict","headers":{"X-Request-ID":{"description":"Request identifier echoed for support and reconciliation.","schema":{"type":"string"}}},"content":{"application/json":{"schema":{"$ref":"#/components/schemas/ApiResponseVoid"}}}},"429":{"description":"Per-minute rate limit or monthly quota exceeded","headers":{"X-Request-ID":{"description":"Request identifier echoed for support and reconciliation.","schema":{"type":"string"}},"X-Quota-Limit":{"description":"Monthly API request allowance for the subscription.","schema":{"type":"integer","format":"int64"}},"X-Quota-Remaining":{"description":"Requests remaining in the current monthly allowance after this request.","schema":{"type":"integer","format":"int64"}},"X-Quota-Reset":{"description":"Unix epoch time in seconds when the monthly allowance resets.","schema":{"type":"integer","format":"int64"}},"X-Quota-Workspace":{"description":"Verified workspace owning this allowance: personal or enterprise:<id>.","schema":{"type":"string"}},"X-Quota-Environment":{"description":"Environment owning the allowance: sandbox or live.","schema":{"type":"string"}},"Retry-After":{"description":"Seconds until the exhausted quota or rate window resets. Sign retries with a new X-Request-ID.","schema":{"type":"integer","format":"int64"}},"X-RateLimit-Scope":{"description":"Rate counter scope: workspace, or user for enterprise verification calls.","schema":{"type":"string"}},"X-RateLimit-Limit":{"description":"Per-minute request limit when rate-limited.","schema":{"type":"integer","format":"int64"}},"X-RateLimit-Remaining":{"description":"Zero when the minute limit is exhausted.","schema":{"type":"integer","format":"int64"}},"X-RateLimit-Reset":{"description":"Unix epoch seconds when the minute limit resets.","schema":{"type":"integer","format":"int64"}}},"content":{"application/json":{"schema":{"$ref":"#/components/schemas/ApiResponseVoid"}}}},"413":{"description":"Request body is too large","headers":{"X-Request-ID":{"description":"Request identifier echoed for support and reconciliation.","schema":{"type":"string"}}},"content":{"application/json":{"schema":{"$ref":"#/components/schemas/ApiResponseVoid"}}}}},"x-dcwallet-signature-versions":["v2"]}},"/api/v1/webhook-endpoints/enterprise-links/{enterpriseId}/link":{"post":{"tags":["7. Webhooks"],"summary":"Authorize enterprise event delivery to user endpoints","description":"Select X-Workspace: enterprise:<enterpriseId>. Requires enterprise developer management permission. First KYB submission links the applicant automatically.\n\nSignature versions: v2 only.","operationId":"postWebhookEndpointsEnterpriseLinksByEnterpriseIdLink","parameters":[{"name":"enterpriseId","in":"path","description":"The enterprise id value for this resource.","required":true,"schema":{"pattern":"[0-9]+","type":"string","example":"337893979704000512"}},{"name":"X-Timestamp","in":"header","description":"Current Unix epoch time in seconds. Requests older or newer than five minutes are rejected.","required":true,"schema":{"pattern":"[0-9]{10}","type":"string","example":"1787562000"}},{"name":"X-Request-ID","in":"header","description":"Unique 16-128 character request identifier used for replay protection; never reuse it for a different HTTP request.","required":true,"schema":{"pattern":"[A-Za-z0-9._:-]{16,128}","type":"string","example":"018f6f4e-8f62-7fc2-9c4b-7be2f4203b6a"}},{"name":"X-Content-SHA256","in":"header","description":"Lowercase hexadecimal SHA-256 digest of the exact raw request body; use the digest of zero bytes when no body is sent.","required":true,"schema":{"pattern":"[0-9a-f]{64}","type":"string","example":"e3b0c44298fc1c149afbf4c8996fb92427ae41e4649b934ca495991b7852b855"}},{"name":"X-Workspace","in":"header","description":"Select enterprise:<id> using your own ID from GET /api/v1/workspaces; personal is unavailable for this operation.","required":true,"schema":{"pattern":"personal|enterprise:[1-9][0-9]*","type":"string","example":null}},{"name":"X-Environment","in":"header","description":"Signed key environment: live or sandbox.","required":true,"schema":{"pattern":"live|sandbox","type":"string","example":"live"}},{"name":"X-Signature","in":"header","description":"v2-prefixed lowercase HMAC-SHA256 signature; existing and new keys can use v2 when enabled.","required":true,"schema":{"pattern":"v2=[0-9a-f]{64}","type":"string","example":"v2=0123456789abcdef0123456789abcdef0123456789abcdef0123456789abcdef"}},{"name":"Accept-Language","in":"header","description":"Response language: en-US = English (default); zh-CN = Simplified Chinese; zh-TW = Traditional Chinese. Numeric error codes are language-neutral.","required":false,"schema":{"type":"string","enum":["en-US","zh-CN","zh-TW"],"default":"en-US"}}],"responses":{"400":{"description":"Malformed JSON, missing header or invalid request parameter","headers":{"X-Request-ID":{"description":"Request identifier echoed for support and reconciliation.","schema":{"type":"string"}}},"content":{"application/json":{"schema":{"$ref":"#/components/schemas/ApiResponseVoid"}}}},"500":{"description":"Unexpected internal error; contact support with X-Request-ID","headers":{"X-Request-ID":{"description":"Request identifier echoed for support and reconciliation.","schema":{"type":"string"}}},"content":{"application/json":{"schema":{"$ref":"#/components/schemas/ApiResponseVoid"}}}},"403":{"description":"API-key scope, subscription, tenant or policy does not allow the operation","headers":{"X-Request-ID":{"description":"Request identifier echoed for support and reconciliation.","schema":{"type":"string"}}},"content":{"application/json":{"schema":{"$ref":"#/components/schemas/ApiResponseVoid"}}}},"200":{"description":"OK","headers":{"X-Request-ID":{"description":"Request identifier echoed for support and reconciliation.","schema":{"type":"string"}},"X-Quota-Limit":{"description":"Monthly API request allowance for the subscription.","schema":{"type":"integer","format":"int64"}},"X-Quota-Remaining":{"description":"Requests remaining in the current monthly allowance after this request.","schema":{"type":"integer","format":"int64"}},"X-Quota-Reset":{"description":"Unix epoch time in seconds when the monthly allowance resets.","schema":{"type":"integer","format":"int64"}},"X-Quota-Workspace":{"description":"Verified workspace owning this allowance: personal or enterprise:<id>.","schema":{"type":"string"}},"X-Quota-Environment":{"description":"Environment owning the allowance: sandbox or live.","schema":{"type":"string"}}},"content":{"application/json":{"schema":{"$ref":"#/components/schemas/ApiResponseVoid"}}}},"401":{"description":"Invalid API key, content hash, signature, timestamp or request ID","headers":{"X-Request-ID":{"description":"Request identifier echoed for support and reconciliation.","schema":{"type":"string"}}},"content":{"application/json":{"schema":{"$ref":"#/components/schemas/ApiResponseVoid"}}}},"404":{"description":"Resource not found in this enterprise and environment","headers":{"X-Request-ID":{"description":"Request identifier echoed for support and reconciliation.","schema":{"type":"string"}}},"content":{"application/json":{"schema":{"$ref":"#/components/schemas/ApiResponseVoid"}}}},"422":{"description":"Business rule rejected the request","headers":{"X-Request-ID":{"description":"Request identifier echoed for support and reconciliation.","schema":{"type":"string"}}},"content":{"application/json":{"schema":{"$ref":"#/components/schemas/ApiResponseVoid"}}}},"503":{"description":"A required platform service is temporarily unavailable","headers":{"X-Request-ID":{"description":"Request identifier echoed for support and reconciliation.","schema":{"type":"string"}}},"content":{"application/json":{"schema":{"$ref":"#/components/schemas/ApiResponseVoid"}}}},"409":{"description":"Idempotency or resource-state conflict","headers":{"X-Request-ID":{"description":"Request identifier echoed for support and reconciliation.","schema":{"type":"string"}}},"content":{"application/json":{"schema":{"$ref":"#/components/schemas/ApiResponseVoid"}}}},"429":{"description":"Per-minute rate limit or monthly quota exceeded","headers":{"X-Request-ID":{"description":"Request identifier echoed for support and reconciliation.","schema":{"type":"string"}},"X-Quota-Limit":{"description":"Monthly API request allowance for the subscription.","schema":{"type":"integer","format":"int64"}},"X-Quota-Remaining":{"description":"Requests remaining in the current monthly allowance after this request.","schema":{"type":"integer","format":"int64"}},"X-Quota-Reset":{"description":"Unix epoch time in seconds when the monthly allowance resets.","schema":{"type":"integer","format":"int64"}},"X-Quota-Workspace":{"description":"Verified workspace owning this allowance: personal or enterprise:<id>.","schema":{"type":"string"}},"X-Quota-Environment":{"description":"Environment owning the allowance: sandbox or live.","schema":{"type":"string"}},"Retry-After":{"description":"Seconds until the exhausted quota or rate window resets. Sign retries with a new X-Request-ID.","schema":{"type":"integer","format":"int64"}},"X-RateLimit-Scope":{"description":"Rate counter scope: workspace, or user for enterprise verification calls.","schema":{"type":"string"}},"X-RateLimit-Limit":{"description":"Per-minute request limit when rate-limited.","schema":{"type":"integer","format":"int64"}},"X-RateLimit-Remaining":{"description":"Zero when the minute limit is exhausted.","schema":{"type":"integer","format":"int64"}},"X-RateLimit-Reset":{"description":"Unix epoch seconds when the minute limit resets.","schema":{"type":"integer","format":"int64"}}},"content":{"application/json":{"schema":{"$ref":"#/components/schemas/ApiResponseVoid"}}}},"413":{"description":"Request body is too large","headers":{"X-Request-ID":{"description":"Request identifier echoed for support and reconciliation.","schema":{"type":"string"}}},"content":{"application/json":{"schema":{"$ref":"#/components/schemas/ApiResponseVoid"}}}}},"x-dcwallet-signature-versions":["v2"]}},"/api/v1/transfers":{"get":{"tags":["5. Transfers"],"summary":"List enterprise transfers","description":"Signature versions: v1 and v2.","operationId":"getTransfers","parameters":[{"name":"status","in":"query","description":"Optional filter. Transfer state: pending = queued; draft = saved before submission; pending_approval = generic approval; pending_batch_approval = batch approval; pending_enterprise_approval = enterprise approval; enterprise_approved = enterprise approved; pending_platform_approval = platform approval; pending_compliance = compliance review; approved = authorized; signature_pending = awaiting signature; external_verifying = external verification; processing = executing; confirming = awaiting confirmation; pending_manual = queued for operator; manual_processing = operator executing; failed_unknown = outcome under investigation. Terminal: succeeded = paid, failed = failed, rejected = denied, cancelled = cancelled. No fixed submission default; the first returned state depends on approval and execution rules.","required":false,"schema":{"type":"string","enum":["pending","draft","pending_approval","pending_batch_approval","pending_enterprise_approval","enterprise_approved","pending_platform_approval","pending_compliance","approved","signature_pending","external_verifying","processing","confirming","pending_manual","manual_processing","failed_unknown","succeeded","failed","rejected","cancelled"]}},{"name":"startDate","in":"query","description":"Inclusive start date in YYYY-MM-DD format.","required":false,"schema":{"type":"string"}},{"name":"endDate","in":"query","description":"Inclusive end date in YYYY-MM-DD format.","required":false,"schema":{"type":"string"}},{"name":"page","in":"query","description":"One-based result page number.","required":false,"schema":{"type":"integer","format":"int32","default":1}},{"name":"pageSize","in":"query","description":"Maximum records returned per page; values above 100 are capped.","required":false,"schema":{"type":"integer","format":"int32","default":20}},{"name":"X-Timestamp","in":"header","description":"Current Unix epoch time in seconds. Requests older or newer than five minutes are rejected.","required":true,"schema":{"pattern":"[0-9]{10}","type":"string","example":"1787562000"}},{"name":"X-Request-ID","in":"header","description":"Unique 16-128 character request identifier used for replay protection; never reuse it for a different HTTP request.","required":true,"schema":{"pattern":"[A-Za-z0-9._:-]{16,128}","type":"string","example":"018f6f4e-8f62-7fc2-9c4b-7be2f4203b6a"}},{"name":"X-Content-SHA256","in":"header","description":"Lowercase hexadecimal SHA-256 digest of the exact raw request body; use the digest of zero bytes when no body is sent.","required":true,"schema":{"pattern":"[0-9a-f]{64}","type":"string","example":"e3b0c44298fc1c149afbf4c8996fb92427ae41e4649b934ca495991b7852b855"}},{"name":"X-Workspace","in":"header","description":"Enterprise reads are available on this route. For enterprise access, copy your own enterprise:<id> from GET /api/v1/workspaces. Required for v2 requests. V1 requests use the historical key's fixed enterprise.","required":false,"schema":{"pattern":"personal|enterprise:[1-9][0-9]*","type":"string","example":null}},{"name":"X-Environment","in":"header","description":"Required and signed for v2 requests: live or sandbox. Optional for v1 requests.","required":false,"schema":{"pattern":"live|sandbox","type":"string","example":"live"}},{"name":"X-Signature","in":"header","description":"Existing keys accept v1 for their fixed enterprise or v2 for a signed workspace; new keys accept v2 only.","required":true,"schema":{"pattern":"v[12]=[0-9a-f]{64}","type":"string","example":"v2=0123456789abcdef0123456789abcdef0123456789abcdef0123456789abcdef"}},{"name":"Accept-Language","in":"header","description":"Response language: en-US = English (default); zh-CN = Simplified Chinese; zh-TW = Traditional Chinese. Numeric error codes are language-neutral.","required":false,"schema":{"type":"string","enum":["en-US","zh-CN","zh-TW"],"default":"en-US"}}],"responses":{"400":{"description":"Malformed JSON, missing header or invalid request parameter","headers":{"X-Request-ID":{"description":"Request identifier echoed for support and reconciliation.","schema":{"type":"string"}}},"content":{"application/json":{"schema":{"$ref":"#/components/schemas/ApiResponseVoid"}}}},"500":{"description":"Unexpected internal error; contact support with X-Request-ID","headers":{"X-Request-ID":{"description":"Request identifier echoed for support and reconciliation.","schema":{"type":"string"}}},"content":{"application/json":{"schema":{"$ref":"#/components/schemas/ApiResponseVoid"}}}},"403":{"description":"API-key scope, subscription, tenant or policy does not allow the operation","headers":{"X-Request-ID":{"description":"Request identifier echoed for support and reconciliation.","schema":{"type":"string"}}},"content":{"application/json":{"schema":{"$ref":"#/components/schemas/ApiResponseVoid"}}}},"200":{"description":"OK","headers":{"X-Request-ID":{"description":"Request identifier echoed for support and reconciliation.","schema":{"type":"string"}},"X-Quota-Limit":{"description":"Monthly API request allowance for the subscription.","schema":{"type":"integer","format":"int64"}},"X-Quota-Remaining":{"description":"Requests remaining in the current monthly allowance after this request.","schema":{"type":"integer","format":"int64"}},"X-Quota-Reset":{"description":"Unix epoch time in seconds when the monthly allowance resets.","schema":{"type":"integer","format":"int64"}},"X-Quota-Workspace":{"description":"Verified workspace owning this allowance: personal or enterprise:<id>.","schema":{"type":"string"}},"X-Quota-Environment":{"description":"Environment owning the allowance: sandbox or live.","schema":{"type":"string"}}},"content":{"application/json":{"schema":{"$ref":"#/components/schemas/ApiResponsePageDataTransferResponse"}}}},"401":{"description":"Invalid API key, content hash, signature, timestamp or request ID","headers":{"X-Request-ID":{"description":"Request identifier echoed for support and reconciliation.","schema":{"type":"string"}}},"content":{"application/json":{"schema":{"$ref":"#/components/schemas/ApiResponseVoid"}}}},"404":{"description":"Resource not found in this enterprise and environment","headers":{"X-Request-ID":{"description":"Request identifier echoed for support and reconciliation.","schema":{"type":"string"}}},"content":{"application/json":{"schema":{"$ref":"#/components/schemas/ApiResponseVoid"}}}},"422":{"description":"Business rule rejected the request","headers":{"X-Request-ID":{"description":"Request identifier echoed for support and reconciliation.","schema":{"type":"string"}}},"content":{"application/json":{"schema":{"$ref":"#/components/schemas/ApiResponseVoid"}}}},"503":{"description":"A required platform service is temporarily unavailable","headers":{"X-Request-ID":{"description":"Request identifier echoed for support and reconciliation.","schema":{"type":"string"}}},"content":{"application/json":{"schema":{"$ref":"#/components/schemas/ApiResponseVoid"}}}},"409":{"description":"Idempotency or resource-state conflict","headers":{"X-Request-ID":{"description":"Request identifier echoed for support and reconciliation.","schema":{"type":"string"}}},"content":{"application/json":{"schema":{"$ref":"#/components/schemas/ApiResponseVoid"}}}},"429":{"description":"Per-minute rate limit or monthly quota exceeded","headers":{"X-Request-ID":{"description":"Request identifier echoed for support and reconciliation.","schema":{"type":"string"}},"X-Quota-Limit":{"description":"Monthly API request allowance for the subscription.","schema":{"type":"integer","format":"int64"}},"X-Quota-Remaining":{"description":"Requests remaining in the current monthly allowance after this request.","schema":{"type":"integer","format":"int64"}},"X-Quota-Reset":{"description":"Unix epoch time in seconds when the monthly allowance resets.","schema":{"type":"integer","format":"int64"}},"X-Quota-Workspace":{"description":"Verified workspace owning this allowance: personal or enterprise:<id>.","schema":{"type":"string"}},"X-Quota-Environment":{"description":"Environment owning the allowance: sandbox or live.","schema":{"type":"string"}},"Retry-After":{"description":"Seconds until the exhausted quota or rate window resets. Sign retries with a new X-Request-ID.","schema":{"type":"integer","format":"int64"}},"X-RateLimit-Scope":{"description":"Rate counter scope: workspace, or user for enterprise verification calls.","schema":{"type":"string"}},"X-RateLimit-Limit":{"description":"Per-minute request limit when rate-limited.","schema":{"type":"integer","format":"int64"}},"X-RateLimit-Remaining":{"description":"Zero when the minute limit is exhausted.","schema":{"type":"integer","format":"int64"}},"X-RateLimit-Reset":{"description":"Unix epoch seconds when the minute limit resets.","schema":{"type":"integer","format":"int64"}}},"content":{"application/json":{"schema":{"$ref":"#/components/schemas/ApiResponseVoid"}}}},"413":{"description":"Request body is too large","headers":{"X-Request-ID":{"description":"Request identifier echoed for support and reconciliation.","schema":{"type":"string"}}},"content":{"application/json":{"schema":{"$ref":"#/components/schemas/ApiResponseVoid"}}}}},"x-dcwallet-signature-versions":["v1","v2"]},"post":{"tags":["5. Transfers"],"summary":"Submit one transfer","description":"The signed API-key request authorizes submission. Use destinationAccountId for a saved contact account, or omit it and provide recipientAddress for crypto or direct bank fields for fiat. A direct mainland CNY payout uses a CNH source account with fixed 1:1 CNH/CNY settlement and requires recipientCurrency=CNY, recipientBankName, recipientAccountHolder and recipientAccountNo; no external FX quote, contact, or beneficiary identity number is required. For a business beneficiary set recipientBeneficiaryType=business and optionally provide recipientRegistrationType and recipientRegistrationNumber. The transfer still follows the configured approval, compliance and balance-locking gates. Reuse Idempotency-Key when retrying the same request.\n\nSignature versions: v1 and v2.","operationId":"postTransfers","parameters":[{"name":"Idempotency-Key","in":"header","description":"Unique key for one mutating request. Reuse the same value only when retrying the same operation.","required":true,"schema":{"type":"string"}},{"name":"X-Timestamp","in":"header","description":"Current Unix epoch time in seconds. Requests older or newer than five minutes are rejected.","required":true,"schema":{"pattern":"[0-9]{10}","type":"string","example":"1787562000"}},{"name":"X-Request-ID","in":"header","description":"Unique 16-128 character request identifier used for replay protection; never reuse it for a different HTTP request.","required":true,"schema":{"pattern":"[A-Za-z0-9._:-]{16,128}","type":"string","example":"018f6f4e-8f62-7fc2-9c4b-7be2f4203b6a"}},{"name":"X-Content-SHA256","in":"header","description":"Lowercase hexadecimal SHA-256 digest of the exact raw request body; use the digest of zero bytes when no body is sent.","required":true,"schema":{"pattern":"[0-9a-f]{64}","type":"string","example":"e3b0c44298fc1c149afbf4c8996fb92427ae41e4649b934ca495991b7852b855"}},{"name":"X-Workspace","in":"header","description":"Enterprise writes are available on this route. For enterprise access, copy your own enterprise:<id> from GET /api/v1/workspaces. Required for v2 requests. V1 requests use the historical key's fixed enterprise.","required":false,"schema":{"pattern":"personal|enterprise:[1-9][0-9]*","type":"string","example":null}},{"name":"X-Environment","in":"header","description":"Required and signed for v2 requests: live or sandbox. Optional for v1 requests.","required":false,"schema":{"pattern":"live|sandbox","type":"string","example":"live"}},{"name":"X-Signature","in":"header","description":"Existing keys accept v1 for their fixed enterprise or v2 for a signed workspace; new keys accept v2 only.","required":true,"schema":{"pattern":"v[12]=[0-9a-f]{64}","type":"string","example":"v2=0123456789abcdef0123456789abcdef0123456789abcdef0123456789abcdef"}},{"name":"Accept-Language","in":"header","description":"Response language: en-US = English (default); zh-CN = Simplified Chinese; zh-TW = Traditional Chinese. Numeric error codes are language-neutral.","required":false,"schema":{"type":"string","enum":["en-US","zh-CN","zh-TW"],"default":"en-US"}}],"requestBody":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/TransferRequest"}}},"required":true},"responses":{"400":{"description":"Malformed JSON, missing header or invalid request parameter","headers":{"X-Request-ID":{"description":"Request identifier echoed for support and reconciliation.","schema":{"type":"string"}}},"content":{"application/json":{"schema":{"$ref":"#/components/schemas/ApiResponseVoid"}}}},"500":{"description":"Unexpected internal error; contact support with X-Request-ID","headers":{"X-Request-ID":{"description":"Request identifier echoed for support and reconciliation.","schema":{"type":"string"}}},"content":{"application/json":{"schema":{"$ref":"#/components/schemas/ApiResponseVoid"}}}},"403":{"description":"API-key scope, subscription, tenant or policy does not allow the operation","headers":{"X-Request-ID":{"description":"Request identifier echoed for support and reconciliation.","schema":{"type":"string"}}},"content":{"application/json":{"schema":{"$ref":"#/components/schemas/ApiResponseVoid"}}}},"200":{"description":"OK","headers":{"X-Request-ID":{"description":"Request identifier echoed for support and reconciliation.","schema":{"type":"string"}},"X-Quota-Limit":{"description":"Monthly API request allowance for the subscription.","schema":{"type":"integer","format":"int64"}},"X-Quota-Remaining":{"description":"Requests remaining in the current monthly allowance after this request.","schema":{"type":"integer","format":"int64"}},"X-Quota-Reset":{"description":"Unix epoch time in seconds when the monthly allowance resets.","schema":{"type":"integer","format":"int64"}},"X-Quota-Workspace":{"description":"Verified workspace owning this allowance: personal or enterprise:<id>.","schema":{"type":"string"}},"X-Quota-Environment":{"description":"Environment owning the allowance: sandbox or live.","schema":{"type":"string"}}},"content":{"application/json":{"schema":{"$ref":"#/components/schemas/ApiResponseTransferResponse"}}}},"401":{"description":"Invalid API key, content hash, signature, timestamp or request ID","headers":{"X-Request-ID":{"description":"Request identifier echoed for support and reconciliation.","schema":{"type":"string"}}},"content":{"application/json":{"schema":{"$ref":"#/components/schemas/ApiResponseVoid"}}}},"404":{"description":"Resource not found in this enterprise and environment","headers":{"X-Request-ID":{"description":"Request identifier echoed for support and reconciliation.","schema":{"type":"string"}}},"content":{"application/json":{"schema":{"$ref":"#/components/schemas/ApiResponseVoid"}}}},"422":{"description":"Business rule rejected the request","headers":{"X-Request-ID":{"description":"Request identifier echoed for support and reconciliation.","schema":{"type":"string"}}},"content":{"application/json":{"schema":{"$ref":"#/components/schemas/ApiResponseVoid"}}}},"503":{"description":"A required platform service is temporarily unavailable","headers":{"X-Request-ID":{"description":"Request identifier echoed for support and reconciliation.","schema":{"type":"string"}}},"content":{"application/json":{"schema":{"$ref":"#/components/schemas/ApiResponseVoid"}}}},"409":{"description":"Idempotency or resource-state conflict","headers":{"X-Request-ID":{"description":"Request identifier echoed for support and reconciliation.","schema":{"type":"string"}}},"content":{"application/json":{"schema":{"$ref":"#/components/schemas/ApiResponseVoid"}}}},"429":{"description":"Per-minute rate limit or monthly quota exceeded","headers":{"X-Request-ID":{"description":"Request identifier echoed for support and reconciliation.","schema":{"type":"string"}},"X-Quota-Limit":{"description":"Monthly API request allowance for the subscription.","schema":{"type":"integer","format":"int64"}},"X-Quota-Remaining":{"description":"Requests remaining in the current monthly allowance after this request.","schema":{"type":"integer","format":"int64"}},"X-Quota-Reset":{"description":"Unix epoch time in seconds when the monthly allowance resets.","schema":{"type":"integer","format":"int64"}},"X-Quota-Workspace":{"description":"Verified workspace owning this allowance: personal or enterprise:<id>.","schema":{"type":"string"}},"X-Quota-Environment":{"description":"Environment owning the allowance: sandbox or live.","schema":{"type":"string"}},"Retry-After":{"description":"Seconds until the exhausted quota or rate window resets. Sign retries with a new X-Request-ID.","schema":{"type":"integer","format":"int64"}},"X-RateLimit-Scope":{"description":"Rate counter scope: workspace, or user for enterprise verification calls.","schema":{"type":"string"}},"X-RateLimit-Limit":{"description":"Per-minute request limit when rate-limited.","schema":{"type":"integer","format":"int64"}},"X-RateLimit-Remaining":{"description":"Zero when the minute limit is exhausted.","schema":{"type":"integer","format":"int64"}},"X-RateLimit-Reset":{"description":"Unix epoch seconds when the minute limit resets.","schema":{"type":"integer","format":"int64"}}},"content":{"application/json":{"schema":{"$ref":"#/components/schemas/ApiResponseVoid"}}}},"413":{"description":"Request body is too large","headers":{"X-Request-ID":{"description":"Request identifier echoed for support and reconciliation.","schema":{"type":"string"}}},"content":{"application/json":{"schema":{"$ref":"#/components/schemas/ApiResponseVoid"}}}}},"x-dcwallet-signature-versions":["v1","v2"]}},"/api/v1/transfers/documents/{role}":{"post":{"tags":["5. Transfers"],"summary":"Upload a payment document using raw file bytes","description":"Upload the file first, then include the returned documentId and role in a single or batch transfer item. PDF, JPG and PNG are supported up to 10 MiB. V2 requests require a stable Idempotency-Key for retries.\n\nSignature versions: v1 and v2.","operationId":"postTransfersDocumentsByRole","parameters":[{"name":"role","in":"path","description":"Transfer evidence category, with no default: supplier_contract = vendor agreement; service_contract = services agreement; employment_contract = employment terms; cooperation_agreement = partnership agreement; proforma_invoice = preliminary invoice; commercial_invoice = issued trade invoice; purchase_order = buyer order; delivery_proof = fulfillment evidence; other_trade_proof = another trade document.","required":true,"schema":{"type":"string","enum":["supplier_contract","service_contract","employment_contract","cooperation_agreement","proforma_invoice","commercial_invoice","purchase_order","delivery_proof","other_trade_proof"]}},{"name":"Idempotency-Key","in":"header","description":"Required for v2 signed POST/PATCH requests, including read-only previews; optional for historical v1 requests. Reuse the same value when retrying the same operation.","required":false,"schema":{"type":"string"}},{"name":"X-Content-SHA256","in":"header","description":"The x-content-sha256 value for this resource.","required":true,"schema":{"type":"string"}},{"name":"X-File-Name","in":"header","description":"Original file name with an extension supported by this upload endpoint.","required":false,"schema":{"type":"string"}},{"name":"Content-Type","in":"header","description":"Raw upload media type supported by this endpoint's request body.","required":false,"schema":{"type":"string","default":"application/octet-stream"}},{"name":"X-Timestamp","in":"header","description":"Current Unix epoch time in seconds. Requests older or newer than five minutes are rejected.","required":true,"schema":{"pattern":"[0-9]{10}","type":"string","example":"1787562000"}},{"name":"X-Request-ID","in":"header","description":"Unique 16-128 character request identifier used for replay protection; never reuse it for a different HTTP request.","required":true,"schema":{"pattern":"[A-Za-z0-9._:-]{16,128}","type":"string","example":"018f6f4e-8f62-7fc2-9c4b-7be2f4203b6a"}},{"name":"X-Workspace","in":"header","description":"Enterprise writes are available on this route. For enterprise access, copy your own enterprise:<id> from GET /api/v1/workspaces. Required for v2 requests. V1 requests use the historical key's fixed enterprise.","required":false,"schema":{"pattern":"personal|enterprise:[1-9][0-9]*","type":"string","example":null}},{"name":"X-Environment","in":"header","description":"Required and signed for v2 requests: live or sandbox. Optional for v1 requests.","required":false,"schema":{"pattern":"live|sandbox","type":"string","example":"live"}},{"name":"X-Signature","in":"header","description":"Existing keys accept v1 for their fixed enterprise or v2 for a signed workspace; new keys accept v2 only.","required":true,"schema":{"pattern":"v[12]=[0-9a-f]{64}","type":"string","example":"v2=0123456789abcdef0123456789abcdef0123456789abcdef0123456789abcdef"}},{"name":"Accept-Language","in":"header","description":"Response language: en-US = English (default); zh-CN = Simplified Chinese; zh-TW = Traditional Chinese. Numeric error codes are language-neutral.","required":false,"schema":{"type":"string","enum":["en-US","zh-CN","zh-TW"],"default":"en-US"}}],"requestBody":{"content":{"application/octet-stream":{"schema":{"type":"string","format":"binary"}}},"required":true},"responses":{"400":{"description":"Malformed JSON, missing header or invalid request parameter","headers":{"X-Request-ID":{"description":"Request identifier echoed for support and reconciliation.","schema":{"type":"string"}}},"content":{"application/json":{"schema":{"$ref":"#/components/schemas/ApiResponseVoid"}}}},"500":{"description":"Unexpected internal error; contact support with X-Request-ID","headers":{"X-Request-ID":{"description":"Request identifier echoed for support and reconciliation.","schema":{"type":"string"}}},"content":{"application/json":{"schema":{"$ref":"#/components/schemas/ApiResponseVoid"}}}},"403":{"description":"API-key scope, subscription, tenant or policy does not allow the operation","headers":{"X-Request-ID":{"description":"Request identifier echoed for support and reconciliation.","schema":{"type":"string"}}},"content":{"application/json":{"schema":{"$ref":"#/components/schemas/ApiResponseVoid"}}}},"200":{"description":"OK","headers":{"X-Request-ID":{"description":"Request identifier echoed for support and reconciliation.","schema":{"type":"string"}},"X-Quota-Limit":{"description":"Monthly API request allowance for the subscription.","schema":{"type":"integer","format":"int64"}},"X-Quota-Remaining":{"description":"Requests remaining in the current monthly allowance after this request.","schema":{"type":"integer","format":"int64"}},"X-Quota-Reset":{"description":"Unix epoch time in seconds when the monthly allowance resets.","schema":{"type":"integer","format":"int64"}},"X-Quota-Workspace":{"description":"Verified workspace owning this allowance: personal or enterprise:<id>.","schema":{"type":"string"}},"X-Quota-Environment":{"description":"Environment owning the allowance: sandbox or live.","schema":{"type":"string"}}},"content":{"application/json":{"schema":{"$ref":"#/components/schemas/ApiResponseTransferDocumentUploadResponse"}}}},"401":{"description":"Invalid API key, content hash, signature, timestamp or request ID","headers":{"X-Request-ID":{"description":"Request identifier echoed for support and reconciliation.","schema":{"type":"string"}}},"content":{"application/json":{"schema":{"$ref":"#/components/schemas/ApiResponseVoid"}}}},"404":{"description":"Resource not found in this enterprise and environment","headers":{"X-Request-ID":{"description":"Request identifier echoed for support and reconciliation.","schema":{"type":"string"}}},"content":{"application/json":{"schema":{"$ref":"#/components/schemas/ApiResponseVoid"}}}},"422":{"description":"Business rule rejected the request","headers":{"X-Request-ID":{"description":"Request identifier echoed for support and reconciliation.","schema":{"type":"string"}}},"content":{"application/json":{"schema":{"$ref":"#/components/schemas/ApiResponseVoid"}}}},"503":{"description":"A required platform service is temporarily unavailable","headers":{"X-Request-ID":{"description":"Request identifier echoed for support and reconciliation.","schema":{"type":"string"}}},"content":{"application/json":{"schema":{"$ref":"#/components/schemas/ApiResponseVoid"}}}},"409":{"description":"Idempotency or resource-state conflict","headers":{"X-Request-ID":{"description":"Request identifier echoed for support and reconciliation.","schema":{"type":"string"}}},"content":{"application/json":{"schema":{"$ref":"#/components/schemas/ApiResponseVoid"}}}},"429":{"description":"Per-minute rate limit or monthly quota exceeded","headers":{"X-Request-ID":{"description":"Request identifier echoed for support and reconciliation.","schema":{"type":"string"}},"X-Quota-Limit":{"description":"Monthly API request allowance for the subscription.","schema":{"type":"integer","format":"int64"}},"X-Quota-Remaining":{"description":"Requests remaining in the current monthly allowance after this request.","schema":{"type":"integer","format":"int64"}},"X-Quota-Reset":{"description":"Unix epoch time in seconds when the monthly allowance resets.","schema":{"type":"integer","format":"int64"}},"X-Quota-Workspace":{"description":"Verified workspace owning this allowance: personal or enterprise:<id>.","schema":{"type":"string"}},"X-Quota-Environment":{"description":"Environment owning the allowance: sandbox or live.","schema":{"type":"string"}},"Retry-After":{"description":"Seconds until the exhausted quota or rate window resets. Sign retries with a new X-Request-ID.","schema":{"type":"integer","format":"int64"}},"X-RateLimit-Scope":{"description":"Rate counter scope: workspace, or user for enterprise verification calls.","schema":{"type":"string"}},"X-RateLimit-Limit":{"description":"Per-minute request limit when rate-limited.","schema":{"type":"integer","format":"int64"}},"X-RateLimit-Remaining":{"description":"Zero when the minute limit is exhausted.","schema":{"type":"integer","format":"int64"}},"X-RateLimit-Reset":{"description":"Unix epoch seconds when the minute limit resets.","schema":{"type":"integer","format":"int64"}}},"content":{"application/json":{"schema":{"$ref":"#/components/schemas/ApiResponseVoid"}}}},"413":{"description":"Request body is too large","headers":{"X-Request-ID":{"description":"Request identifier echoed for support and reconciliation.","schema":{"type":"string"}}},"content":{"application/json":{"schema":{"$ref":"#/components/schemas/ApiResponseVoid"}}}}},"x-dcwallet-signature-versions":["v1","v2"]}},"/api/v1/transfers/document-requirements/preview":{"post":{"tags":["5. Transfers"],"summary":"Preview payment-document requirements","description":"Use this before submission to identify missing document-role groups. Submission always evaluates the rules again using the stored transfer and linked documents.\n\nSignature versions: v1 and v2.","operationId":"postTransfersDocumentRequirementsPreview","parameters":[{"name":"X-Timestamp","in":"header","description":"Current Unix epoch time in seconds. Requests older or newer than five minutes are rejected.","required":true,"schema":{"pattern":"[0-9]{10}","type":"string","example":"1787562000"}},{"name":"X-Request-ID","in":"header","description":"Unique 16-128 character request identifier used for replay protection; never reuse it for a different HTTP request.","required":true,"schema":{"pattern":"[A-Za-z0-9._:-]{16,128}","type":"string","example":"018f6f4e-8f62-7fc2-9c4b-7be2f4203b6a"}},{"name":"X-Content-SHA256","in":"header","description":"Lowercase hexadecimal SHA-256 digest of the exact raw request body; use the digest of zero bytes when no body is sent.","required":true,"schema":{"pattern":"[0-9a-f]{64}","type":"string","example":"e3b0c44298fc1c149afbf4c8996fb92427ae41e4649b934ca495991b7852b855"}},{"name":"X-Workspace","in":"header","description":"Enterprise writes are available on this route. For enterprise access, copy your own enterprise:<id> from GET /api/v1/workspaces. Required for v2 requests. V1 requests use the historical key's fixed enterprise.","required":false,"schema":{"pattern":"personal|enterprise:[1-9][0-9]*","type":"string","example":null}},{"name":"X-Environment","in":"header","description":"Required and signed for v2 requests: live or sandbox. Optional for v1 requests.","required":false,"schema":{"pattern":"live|sandbox","type":"string","example":"live"}},{"name":"X-Signature","in":"header","description":"Existing keys accept v1 for their fixed enterprise or v2 for a signed workspace; new keys accept v2 only.","required":true,"schema":{"pattern":"v[12]=[0-9a-f]{64}","type":"string","example":"v2=0123456789abcdef0123456789abcdef0123456789abcdef0123456789abcdef"}},{"name":"Accept-Language","in":"header","description":"Response language: en-US = English (default); zh-CN = Simplified Chinese; zh-TW = Traditional Chinese. Numeric error codes are language-neutral.","required":false,"schema":{"type":"string","enum":["en-US","zh-CN","zh-TW"],"default":"en-US"}}],"requestBody":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/TransferDocumentRequirementRequest"}}},"required":true},"responses":{"400":{"description":"Malformed JSON, missing header or invalid request parameter","headers":{"X-Request-ID":{"description":"Request identifier echoed for support and reconciliation.","schema":{"type":"string"}}},"content":{"application/json":{"schema":{"$ref":"#/components/schemas/ApiResponseVoid"}}}},"500":{"description":"Unexpected internal error; contact support with X-Request-ID","headers":{"X-Request-ID":{"description":"Request identifier echoed for support and reconciliation.","schema":{"type":"string"}}},"content":{"application/json":{"schema":{"$ref":"#/components/schemas/ApiResponseVoid"}}}},"403":{"description":"API-key scope, subscription, tenant or policy does not allow the operation","headers":{"X-Request-ID":{"description":"Request identifier echoed for support and reconciliation.","schema":{"type":"string"}}},"content":{"application/json":{"schema":{"$ref":"#/components/schemas/ApiResponseVoid"}}}},"200":{"description":"OK","headers":{"X-Request-ID":{"description":"Request identifier echoed for support and reconciliation.","schema":{"type":"string"}},"X-Quota-Limit":{"description":"Monthly API request allowance for the subscription.","schema":{"type":"integer","format":"int64"}},"X-Quota-Remaining":{"description":"Requests remaining in the current monthly allowance after this request.","schema":{"type":"integer","format":"int64"}},"X-Quota-Reset":{"description":"Unix epoch time in seconds when the monthly allowance resets.","schema":{"type":"integer","format":"int64"}},"X-Quota-Workspace":{"description":"Verified workspace owning this allowance: personal or enterprise:<id>.","schema":{"type":"string"}},"X-Quota-Environment":{"description":"Environment owning the allowance: sandbox or live.","schema":{"type":"string"}}},"content":{"application/json":{"schema":{"$ref":"#/components/schemas/ApiResponseTransferDocumentRequirementResponse"}}}},"401":{"description":"Invalid API key, content hash, signature, timestamp or request ID","headers":{"X-Request-ID":{"description":"Request identifier echoed for support and reconciliation.","schema":{"type":"string"}}},"content":{"application/json":{"schema":{"$ref":"#/components/schemas/ApiResponseVoid"}}}},"404":{"description":"Resource not found in this enterprise and environment","headers":{"X-Request-ID":{"description":"Request identifier echoed for support and reconciliation.","schema":{"type":"string"}}},"content":{"application/json":{"schema":{"$ref":"#/components/schemas/ApiResponseVoid"}}}},"422":{"description":"Business rule rejected the request","headers":{"X-Request-ID":{"description":"Request identifier echoed for support and reconciliation.","schema":{"type":"string"}}},"content":{"application/json":{"schema":{"$ref":"#/components/schemas/ApiResponseVoid"}}}},"503":{"description":"A required platform service is temporarily unavailable","headers":{"X-Request-ID":{"description":"Request identifier echoed for support and reconciliation.","schema":{"type":"string"}}},"content":{"application/json":{"schema":{"$ref":"#/components/schemas/ApiResponseVoid"}}}},"409":{"description":"Idempotency or resource-state conflict","headers":{"X-Request-ID":{"description":"Request identifier echoed for support and reconciliation.","schema":{"type":"string"}}},"content":{"application/json":{"schema":{"$ref":"#/components/schemas/ApiResponseVoid"}}}},"429":{"description":"Per-minute rate limit or monthly quota exceeded","headers":{"X-Request-ID":{"description":"Request identifier echoed for support and reconciliation.","schema":{"type":"string"}},"X-Quota-Limit":{"description":"Monthly API request allowance for the subscription.","schema":{"type":"integer","format":"int64"}},"X-Quota-Remaining":{"description":"Requests remaining in the current monthly allowance after this request.","schema":{"type":"integer","format":"int64"}},"X-Quota-Reset":{"description":"Unix epoch time in seconds when the monthly allowance resets.","schema":{"type":"integer","format":"int64"}},"X-Quota-Workspace":{"description":"Verified workspace owning this allowance: personal or enterprise:<id>.","schema":{"type":"string"}},"X-Quota-Environment":{"description":"Environment owning the allowance: sandbox or live.","schema":{"type":"string"}},"Retry-After":{"description":"Seconds until the exhausted quota or rate window resets. Sign retries with a new X-Request-ID.","schema":{"type":"integer","format":"int64"}},"X-RateLimit-Scope":{"description":"Rate counter scope: workspace, or user for enterprise verification calls.","schema":{"type":"string"}},"X-RateLimit-Limit":{"description":"Per-minute request limit when rate-limited.","schema":{"type":"integer","format":"int64"}},"X-RateLimit-Remaining":{"description":"Zero when the minute limit is exhausted.","schema":{"type":"integer","format":"int64"}},"X-RateLimit-Reset":{"description":"Unix epoch seconds when the minute limit resets.","schema":{"type":"integer","format":"int64"}}},"content":{"application/json":{"schema":{"$ref":"#/components/schemas/ApiResponseVoid"}}}},"413":{"description":"Request body is too large","headers":{"X-Request-ID":{"description":"Request identifier echoed for support and reconciliation.","schema":{"type":"string"}}},"content":{"application/json":{"schema":{"$ref":"#/components/schemas/ApiResponseVoid"}}}}},"x-dcwallet-signature-versions":["v1","v2"]}},"/api/v1/transfer-batches":{"get":{"tags":["5. Transfers"],"summary":"List enterprise transfer batches","description":"Signature versions: v1 and v2.","operationId":"getTransferBatches","parameters":[{"name":"status","in":"query","description":"Optional filter. Batch state: draft = prepared; pending_approval = awaiting enterprise approval; approved = ready; processing = items running; completed = finalized; rejected = denied; cancelled = cancelled. Terminal: completed, rejected, cancelled.","required":false,"schema":{"type":"string","enum":["draft","pending_approval","approved","processing","completed","rejected","cancelled"]}},{"name":"result","in":"query","description":"Optional filter. Final batch outcome, null until finalized: succeeded = all items succeeded; partial_failed = mixed item outcomes; failed = no item succeeded. All three values are final outcomes.","required":false,"schema":{"type":"string","enum":["succeeded","partial_failed","failed"]}},{"name":"startDate","in":"query","description":"Inclusive start date in YYYY-MM-DD format.","required":false,"schema":{"type":"string"}},{"name":"endDate","in":"query","description":"Inclusive end date in YYYY-MM-DD format.","required":false,"schema":{"type":"string"}},{"name":"page","in":"query","description":"One-based result page number.","required":false,"schema":{"type":"integer","format":"int32","default":1}},{"name":"pageSize","in":"query","description":"Maximum records returned per page; values above 100 are capped.","required":false,"schema":{"type":"integer","format":"int32","default":20}},{"name":"X-Timestamp","in":"header","description":"Current Unix epoch time in seconds. Requests older or newer than five minutes are rejected.","required":true,"schema":{"pattern":"[0-9]{10}","type":"string","example":"1787562000"}},{"name":"X-Request-ID","in":"header","description":"Unique 16-128 character request identifier used for replay protection; never reuse it for a different HTTP request.","required":true,"schema":{"pattern":"[A-Za-z0-9._:-]{16,128}","type":"string","example":"018f6f4e-8f62-7fc2-9c4b-7be2f4203b6a"}},{"name":"X-Content-SHA256","in":"header","description":"Lowercase hexadecimal SHA-256 digest of the exact raw request body; use the digest of zero bytes when no body is sent.","required":true,"schema":{"pattern":"[0-9a-f]{64}","type":"string","example":"e3b0c44298fc1c149afbf4c8996fb92427ae41e4649b934ca495991b7852b855"}},{"name":"X-Workspace","in":"header","description":"Enterprise reads are available on this route. For enterprise access, copy your own enterprise:<id> from GET /api/v1/workspaces. Required for v2 requests. V1 requests use the historical key's fixed enterprise.","required":false,"schema":{"pattern":"personal|enterprise:[1-9][0-9]*","type":"string","example":null}},{"name":"X-Environment","in":"header","description":"Required and signed for v2 requests: live or sandbox. Optional for v1 requests.","required":false,"schema":{"pattern":"live|sandbox","type":"string","example":"live"}},{"name":"X-Signature","in":"header","description":"Existing keys accept v1 for their fixed enterprise or v2 for a signed workspace; new keys accept v2 only.","required":true,"schema":{"pattern":"v[12]=[0-9a-f]{64}","type":"string","example":"v2=0123456789abcdef0123456789abcdef0123456789abcdef0123456789abcdef"}},{"name":"Accept-Language","in":"header","description":"Response language: en-US = English (default); zh-CN = Simplified Chinese; zh-TW = Traditional Chinese. Numeric error codes are language-neutral.","required":false,"schema":{"type":"string","enum":["en-US","zh-CN","zh-TW"],"default":"en-US"}}],"responses":{"400":{"description":"Malformed JSON, missing header or invalid request parameter","headers":{"X-Request-ID":{"description":"Request identifier echoed for support and reconciliation.","schema":{"type":"string"}}},"content":{"application/json":{"schema":{"$ref":"#/components/schemas/ApiResponseVoid"}}}},"500":{"description":"Unexpected internal error; contact support with X-Request-ID","headers":{"X-Request-ID":{"description":"Request identifier echoed for support and reconciliation.","schema":{"type":"string"}}},"content":{"application/json":{"schema":{"$ref":"#/components/schemas/ApiResponseVoid"}}}},"403":{"description":"API-key scope, subscription, tenant or policy does not allow the operation","headers":{"X-Request-ID":{"description":"Request identifier echoed for support and reconciliation.","schema":{"type":"string"}}},"content":{"application/json":{"schema":{"$ref":"#/components/schemas/ApiResponseVoid"}}}},"200":{"description":"OK","headers":{"X-Request-ID":{"description":"Request identifier echoed for support and reconciliation.","schema":{"type":"string"}},"X-Quota-Limit":{"description":"Monthly API request allowance for the subscription.","schema":{"type":"integer","format":"int64"}},"X-Quota-Remaining":{"description":"Requests remaining in the current monthly allowance after this request.","schema":{"type":"integer","format":"int64"}},"X-Quota-Reset":{"description":"Unix epoch time in seconds when the monthly allowance resets.","schema":{"type":"integer","format":"int64"}},"X-Quota-Workspace":{"description":"Verified workspace owning this allowance: personal or enterprise:<id>.","schema":{"type":"string"}},"X-Quota-Environment":{"description":"Environment owning the allowance: sandbox or live.","schema":{"type":"string"}}},"content":{"application/json":{"schema":{"$ref":"#/components/schemas/ApiResponsePageDataTransferBatchResponse"}}}},"401":{"description":"Invalid API key, content hash, signature, timestamp or request ID","headers":{"X-Request-ID":{"description":"Request identifier echoed for support and reconciliation.","schema":{"type":"string"}}},"content":{"application/json":{"schema":{"$ref":"#/components/schemas/ApiResponseVoid"}}}},"404":{"description":"Resource not found in this enterprise and environment","headers":{"X-Request-ID":{"description":"Request identifier echoed for support and reconciliation.","schema":{"type":"string"}}},"content":{"application/json":{"schema":{"$ref":"#/components/schemas/ApiResponseVoid"}}}},"422":{"description":"Business rule rejected the request","headers":{"X-Request-ID":{"description":"Request identifier echoed for support and reconciliation.","schema":{"type":"string"}}},"content":{"application/json":{"schema":{"$ref":"#/components/schemas/ApiResponseVoid"}}}},"503":{"description":"A required platform service is temporarily unavailable","headers":{"X-Request-ID":{"description":"Request identifier echoed for support and reconciliation.","schema":{"type":"string"}}},"content":{"application/json":{"schema":{"$ref":"#/components/schemas/ApiResponseVoid"}}}},"409":{"description":"Idempotency or resource-state conflict","headers":{"X-Request-ID":{"description":"Request identifier echoed for support and reconciliation.","schema":{"type":"string"}}},"content":{"application/json":{"schema":{"$ref":"#/components/schemas/ApiResponseVoid"}}}},"429":{"description":"Per-minute rate limit or monthly quota exceeded","headers":{"X-Request-ID":{"description":"Request identifier echoed for support and reconciliation.","schema":{"type":"string"}},"X-Quota-Limit":{"description":"Monthly API request allowance for the subscription.","schema":{"type":"integer","format":"int64"}},"X-Quota-Remaining":{"description":"Requests remaining in the current monthly allowance after this request.","schema":{"type":"integer","format":"int64"}},"X-Quota-Reset":{"description":"Unix epoch time in seconds when the monthly allowance resets.","schema":{"type":"integer","format":"int64"}},"X-Quota-Workspace":{"description":"Verified workspace owning this allowance: personal or enterprise:<id>.","schema":{"type":"string"}},"X-Quota-Environment":{"description":"Environment owning the allowance: sandbox or live.","schema":{"type":"string"}},"Retry-After":{"description":"Seconds until the exhausted quota or rate window resets. Sign retries with a new X-Request-ID.","schema":{"type":"integer","format":"int64"}},"X-RateLimit-Scope":{"description":"Rate counter scope: workspace, or user for enterprise verification calls.","schema":{"type":"string"}},"X-RateLimit-Limit":{"description":"Per-minute request limit when rate-limited.","schema":{"type":"integer","format":"int64"}},"X-RateLimit-Remaining":{"description":"Zero when the minute limit is exhausted.","schema":{"type":"integer","format":"int64"}},"X-RateLimit-Reset":{"description":"Unix epoch seconds when the minute limit resets.","schema":{"type":"integer","format":"int64"}}},"content":{"application/json":{"schema":{"$ref":"#/components/schemas/ApiResponseVoid"}}}},"413":{"description":"Request body is too large","headers":{"X-Request-ID":{"description":"Request identifier echoed for support and reconciliation.","schema":{"type":"string"}}},"content":{"application/json":{"schema":{"$ref":"#/components/schemas/ApiResponseVoid"}}}}},"x-dcwallet-signature-versions":["v1","v2"]},"post":{"tags":["5. Transfers"],"summary":"Submit up to 500 transfers as one batch","description":"The signed API-key request authorizes submission. Each row may reference a saved destinationAccountId or provide an ad-hoc blockchain address or bank account. All rows must use the same payment method, currency and blockchain network. Existing approval, compliance and balance-locking gates apply to the batch.\n\nSignature versions: v1 and v2.","operationId":"postTransferBatches","parameters":[{"name":"Idempotency-Key","in":"header","description":"Unique key for one mutating request. Reuse the same value only when retrying the same operation.","required":true,"schema":{"type":"string"}},{"name":"X-Timestamp","in":"header","description":"Current Unix epoch time in seconds. Requests older or newer than five minutes are rejected.","required":true,"schema":{"pattern":"[0-9]{10}","type":"string","example":"1787562000"}},{"name":"X-Request-ID","in":"header","description":"Unique 16-128 character request identifier used for replay protection; never reuse it for a different HTTP request.","required":true,"schema":{"pattern":"[A-Za-z0-9._:-]{16,128}","type":"string","example":"018f6f4e-8f62-7fc2-9c4b-7be2f4203b6a"}},{"name":"X-Content-SHA256","in":"header","description":"Lowercase hexadecimal SHA-256 digest of the exact raw request body; use the digest of zero bytes when no body is sent.","required":true,"schema":{"pattern":"[0-9a-f]{64}","type":"string","example":"e3b0c44298fc1c149afbf4c8996fb92427ae41e4649b934ca495991b7852b855"}},{"name":"X-Workspace","in":"header","description":"Enterprise writes are available on this route. For enterprise access, copy your own enterprise:<id> from GET /api/v1/workspaces. Required for v2 requests. V1 requests use the historical key's fixed enterprise.","required":false,"schema":{"pattern":"personal|enterprise:[1-9][0-9]*","type":"string","example":null}},{"name":"X-Environment","in":"header","description":"Required and signed for v2 requests: live or sandbox. Optional for v1 requests.","required":false,"schema":{"pattern":"live|sandbox","type":"string","example":"live"}},{"name":"X-Signature","in":"header","description":"Existing keys accept v1 for their fixed enterprise or v2 for a signed workspace; new keys accept v2 only.","required":true,"schema":{"pattern":"v[12]=[0-9a-f]{64}","type":"string","example":"v2=0123456789abcdef0123456789abcdef0123456789abcdef0123456789abcdef"}},{"name":"Accept-Language","in":"header","description":"Response language: en-US = English (default); zh-CN = Simplified Chinese; zh-TW = Traditional Chinese. Numeric error codes are language-neutral.","required":false,"schema":{"type":"string","enum":["en-US","zh-CN","zh-TW"],"default":"en-US"}}],"requestBody":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/TransferBatchRequest"}}},"required":true},"responses":{"400":{"description":"Malformed JSON, missing header or invalid request parameter","headers":{"X-Request-ID":{"description":"Request identifier echoed for support and reconciliation.","schema":{"type":"string"}}},"content":{"application/json":{"schema":{"$ref":"#/components/schemas/ApiResponseVoid"}}}},"500":{"description":"Unexpected internal error; contact support with X-Request-ID","headers":{"X-Request-ID":{"description":"Request identifier echoed for support and reconciliation.","schema":{"type":"string"}}},"content":{"application/json":{"schema":{"$ref":"#/components/schemas/ApiResponseVoid"}}}},"403":{"description":"API-key scope, subscription, tenant or policy does not allow the operation","headers":{"X-Request-ID":{"description":"Request identifier echoed for support and reconciliation.","schema":{"type":"string"}}},"content":{"application/json":{"schema":{"$ref":"#/components/schemas/ApiResponseVoid"}}}},"200":{"description":"OK","headers":{"X-Request-ID":{"description":"Request identifier echoed for support and reconciliation.","schema":{"type":"string"}},"X-Quota-Limit":{"description":"Monthly API request allowance for the subscription.","schema":{"type":"integer","format":"int64"}},"X-Quota-Remaining":{"description":"Requests remaining in the current monthly allowance after this request.","schema":{"type":"integer","format":"int64"}},"X-Quota-Reset":{"description":"Unix epoch time in seconds when the monthly allowance resets.","schema":{"type":"integer","format":"int64"}},"X-Quota-Workspace":{"description":"Verified workspace owning this allowance: personal or enterprise:<id>.","schema":{"type":"string"}},"X-Quota-Environment":{"description":"Environment owning the allowance: sandbox or live.","schema":{"type":"string"}}},"content":{"application/json":{"schema":{"$ref":"#/components/schemas/ApiResponseTransferBatchResponse"}}}},"401":{"description":"Invalid API key, content hash, signature, timestamp or request ID","headers":{"X-Request-ID":{"description":"Request identifier echoed for support and reconciliation.","schema":{"type":"string"}}},"content":{"application/json":{"schema":{"$ref":"#/components/schemas/ApiResponseVoid"}}}},"404":{"description":"Resource not found in this enterprise and environment","headers":{"X-Request-ID":{"description":"Request identifier echoed for support and reconciliation.","schema":{"type":"string"}}},"content":{"application/json":{"schema":{"$ref":"#/components/schemas/ApiResponseVoid"}}}},"422":{"description":"Business rule rejected the request","headers":{"X-Request-ID":{"description":"Request identifier echoed for support and reconciliation.","schema":{"type":"string"}}},"content":{"application/json":{"schema":{"$ref":"#/components/schemas/ApiResponseVoid"}}}},"503":{"description":"A required platform service is temporarily unavailable","headers":{"X-Request-ID":{"description":"Request identifier echoed for support and reconciliation.","schema":{"type":"string"}}},"content":{"application/json":{"schema":{"$ref":"#/components/schemas/ApiResponseVoid"}}}},"409":{"description":"Idempotency or resource-state conflict","headers":{"X-Request-ID":{"description":"Request identifier echoed for support and reconciliation.","schema":{"type":"string"}}},"content":{"application/json":{"schema":{"$ref":"#/components/schemas/ApiResponseVoid"}}}},"429":{"description":"Per-minute rate limit or monthly quota exceeded","headers":{"X-Request-ID":{"description":"Request identifier echoed for support and reconciliation.","schema":{"type":"string"}},"X-Quota-Limit":{"description":"Monthly API request allowance for the subscription.","schema":{"type":"integer","format":"int64"}},"X-Quota-Remaining":{"description":"Requests remaining in the current monthly allowance after this request.","schema":{"type":"integer","format":"int64"}},"X-Quota-Reset":{"description":"Unix epoch time in seconds when the monthly allowance resets.","schema":{"type":"integer","format":"int64"}},"X-Quota-Workspace":{"description":"Verified workspace owning this allowance: personal or enterprise:<id>.","schema":{"type":"string"}},"X-Quota-Environment":{"description":"Environment owning the allowance: sandbox or live.","schema":{"type":"string"}},"Retry-After":{"description":"Seconds until the exhausted quota or rate window resets. Sign retries with a new X-Request-ID.","schema":{"type":"integer","format":"int64"}},"X-RateLimit-Scope":{"description":"Rate counter scope: workspace, or user for enterprise verification calls.","schema":{"type":"string"}},"X-RateLimit-Limit":{"description":"Per-minute request limit when rate-limited.","schema":{"type":"integer","format":"int64"}},"X-RateLimit-Remaining":{"description":"Zero when the minute limit is exhausted.","schema":{"type":"integer","format":"int64"}},"X-RateLimit-Reset":{"description":"Unix epoch seconds when the minute limit resets.","schema":{"type":"integer","format":"int64"}}},"content":{"application/json":{"schema":{"$ref":"#/components/schemas/ApiResponseVoid"}}}},"413":{"description":"Request body is too large","headers":{"X-Request-ID":{"description":"Request identifier echoed for support and reconciliation.","schema":{"type":"string"}}},"content":{"application/json":{"schema":{"$ref":"#/components/schemas/ApiResponseVoid"}}}}},"x-dcwallet-signature-versions":["v1","v2"]}},"/api/v1/sandbox/fiat-deposits":{"post":{"tags":["2. Receiving accounts"],"summary":"Simulate a fiat receipt outcome in sandbox","description":"Requires a v2 signed sandbox request, account:write and Idempotency-Key. The bank account must belong to the selected workspace. status defaults to settled; pending_settlement, refunded and reversed are uncredited synthetic outcomes.\n\nSignature versions: v2 only.","operationId":"postSandboxFiatDeposits","parameters":[{"name":"Idempotency-Key","in":"header","description":"Unique key for one mutating request. Reuse the same value only when retrying the same operation.","required":true,"schema":{"type":"string"}},{"name":"X-Timestamp","in":"header","description":"Current Unix epoch time in seconds. Requests older or newer than five minutes are rejected.","required":true,"schema":{"pattern":"[0-9]{10}","type":"string","example":"1787562000"}},{"name":"X-Request-ID","in":"header","description":"Unique 16-128 character request identifier used for replay protection; never reuse it for a different HTTP request.","required":true,"schema":{"pattern":"[A-Za-z0-9._:-]{16,128}","type":"string","example":"018f6f4e-8f62-7fc2-9c4b-7be2f4203b6a"}},{"name":"X-Content-SHA256","in":"header","description":"Lowercase hexadecimal SHA-256 digest of the exact raw request body; use the digest of zero bytes when no body is sent.","required":true,"schema":{"pattern":"[0-9a-f]{64}","type":"string","example":"e3b0c44298fc1c149afbf4c8996fb92427ae41e4649b934ca495991b7852b855"}},{"name":"X-Workspace","in":"header","description":"Signed workspace selector: personal or enterprise:<id>. Get your enterprise ID from GET /api/v1/workspaces.","required":true,"schema":{"pattern":"personal|enterprise:[1-9][0-9]*","type":"string","example":"personal"}},{"name":"X-Environment","in":"header","description":"Signed key environment: live or sandbox.","required":true,"schema":{"pattern":"live|sandbox","type":"string","example":"live"}},{"name":"X-Signature","in":"header","description":"v2-prefixed lowercase HMAC-SHA256 signature; existing and new keys can use v2 when enabled.","required":true,"schema":{"pattern":"v2=[0-9a-f]{64}","type":"string","example":"v2=0123456789abcdef0123456789abcdef0123456789abcdef0123456789abcdef"}},{"name":"Accept-Language","in":"header","description":"Response language: en-US = English (default); zh-CN = Simplified Chinese; zh-TW = Traditional Chinese. Numeric error codes are language-neutral.","required":false,"schema":{"type":"string","enum":["en-US","zh-CN","zh-TW"],"default":"en-US"}}],"requestBody":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/SandboxFiatDepositRequest"}}},"required":true},"responses":{"400":{"description":"Malformed JSON, missing header or invalid request parameter","headers":{"X-Request-ID":{"description":"Request identifier echoed for support and reconciliation.","schema":{"type":"string"}}},"content":{"application/json":{"schema":{"$ref":"#/components/schemas/ApiResponseVoid"}}}},"500":{"description":"Unexpected internal error; contact support with X-Request-ID","headers":{"X-Request-ID":{"description":"Request identifier echoed for support and reconciliation.","schema":{"type":"string"}}},"content":{"application/json":{"schema":{"$ref":"#/components/schemas/ApiResponseVoid"}}}},"403":{"description":"API-key scope, subscription, tenant or policy does not allow the operation","headers":{"X-Request-ID":{"description":"Request identifier echoed for support and reconciliation.","schema":{"type":"string"}}},"content":{"application/json":{"schema":{"$ref":"#/components/schemas/ApiResponseVoid"}}}},"200":{"description":"OK","headers":{"X-Request-ID":{"description":"Request identifier echoed for support and reconciliation.","schema":{"type":"string"}},"X-Quota-Limit":{"description":"Monthly API request allowance for the subscription.","schema":{"type":"integer","format":"int64"}},"X-Quota-Remaining":{"description":"Requests remaining in the current monthly allowance after this request.","schema":{"type":"integer","format":"int64"}},"X-Quota-Reset":{"description":"Unix epoch time in seconds when the monthly allowance resets.","schema":{"type":"integer","format":"int64"}},"X-Quota-Workspace":{"description":"Verified workspace owning this allowance: personal or enterprise:<id>.","schema":{"type":"string"}},"X-Quota-Environment":{"description":"Environment owning the allowance: sandbox or live.","schema":{"type":"string"}}},"content":{"application/json":{"schema":{"$ref":"#/components/schemas/ApiResponseSandboxFiatDepositResponse"}}}},"401":{"description":"Invalid API key, content hash, signature, timestamp or request ID","headers":{"X-Request-ID":{"description":"Request identifier echoed for support and reconciliation.","schema":{"type":"string"}}},"content":{"application/json":{"schema":{"$ref":"#/components/schemas/ApiResponseVoid"}}}},"404":{"description":"Resource not found in this enterprise and environment","headers":{"X-Request-ID":{"description":"Request identifier echoed for support and reconciliation.","schema":{"type":"string"}}},"content":{"application/json":{"schema":{"$ref":"#/components/schemas/ApiResponseVoid"}}}},"422":{"description":"Business rule rejected the request","headers":{"X-Request-ID":{"description":"Request identifier echoed for support and reconciliation.","schema":{"type":"string"}}},"content":{"application/json":{"schema":{"$ref":"#/components/schemas/ApiResponseVoid"}}}},"503":{"description":"A required platform service is temporarily unavailable","headers":{"X-Request-ID":{"description":"Request identifier echoed for support and reconciliation.","schema":{"type":"string"}}},"content":{"application/json":{"schema":{"$ref":"#/components/schemas/ApiResponseVoid"}}}},"409":{"description":"Idempotency or resource-state conflict","headers":{"X-Request-ID":{"description":"Request identifier echoed for support and reconciliation.","schema":{"type":"string"}}},"content":{"application/json":{"schema":{"$ref":"#/components/schemas/ApiResponseVoid"}}}},"429":{"description":"Per-minute rate limit or monthly quota exceeded","headers":{"X-Request-ID":{"description":"Request identifier echoed for support and reconciliation.","schema":{"type":"string"}},"X-Quota-Limit":{"description":"Monthly API request allowance for the subscription.","schema":{"type":"integer","format":"int64"}},"X-Quota-Remaining":{"description":"Requests remaining in the current monthly allowance after this request.","schema":{"type":"integer","format":"int64"}},"X-Quota-Reset":{"description":"Unix epoch time in seconds when the monthly allowance resets.","schema":{"type":"integer","format":"int64"}},"X-Quota-Workspace":{"description":"Verified workspace owning this allowance: personal or enterprise:<id>.","schema":{"type":"string"}},"X-Quota-Environment":{"description":"Environment owning the allowance: sandbox or live.","schema":{"type":"string"}},"Retry-After":{"description":"Seconds until the exhausted quota or rate window resets. Sign retries with a new X-Request-ID.","schema":{"type":"integer","format":"int64"}},"X-RateLimit-Scope":{"description":"Rate counter scope: workspace, or user for enterprise verification calls.","schema":{"type":"string"}},"X-RateLimit-Limit":{"description":"Per-minute request limit when rate-limited.","schema":{"type":"integer","format":"int64"}},"X-RateLimit-Remaining":{"description":"Zero when the minute limit is exhausted.","schema":{"type":"integer","format":"int64"}},"X-RateLimit-Reset":{"description":"Unix epoch seconds when the minute limit resets.","schema":{"type":"integer","format":"int64"}}},"content":{"application/json":{"schema":{"$ref":"#/components/schemas/ApiResponseVoid"}}}},"413":{"description":"Request body is too large","headers":{"X-Request-ID":{"description":"Request identifier echoed for support and reconciliation.","schema":{"type":"string"}}},"content":{"application/json":{"schema":{"$ref":"#/components/schemas/ApiResponseVoid"}}}}},"x-dcwallet-signature-versions":["v2"]}},"/api/v1/sandbox/enterprise-samples":{"post":{"tags":["0. Workspaces"],"summary":"Get or create an isolated sandbox enterprise sample","description":"Sign with a sandbox v2 Key and X-Workspace: personal. The returned synthetic Hong Kong enterprise is approved only in sandbox. It can be selected for simulator bank openings, addresses and receipts, but it is never legal KYB and cannot be used in live.\n\nSignature versions: v2 only.","operationId":"postSandboxEnterpriseSamples","parameters":[{"name":"Idempotency-Key","in":"header","description":"Unique key for one mutating request. Reuse the same value only when retrying the same operation.","required":true,"schema":{"type":"string"}},{"name":"X-Timestamp","in":"header","description":"Current Unix epoch time in seconds. Requests older or newer than five minutes are rejected.","required":true,"schema":{"pattern":"[0-9]{10}","type":"string","example":"1787562000"}},{"name":"X-Request-ID","in":"header","description":"Unique 16-128 character request identifier used for replay protection; never reuse it for a different HTTP request.","required":true,"schema":{"pattern":"[A-Za-z0-9._:-]{16,128}","type":"string","example":"018f6f4e-8f62-7fc2-9c4b-7be2f4203b6a"}},{"name":"X-Content-SHA256","in":"header","description":"Lowercase hexadecimal SHA-256 digest of the exact raw request body; use the digest of zero bytes when no body is sent.","required":true,"schema":{"pattern":"[0-9a-f]{64}","type":"string","example":"e3b0c44298fc1c149afbf4c8996fb92427ae41e4649b934ca495991b7852b855"}},{"name":"X-Workspace","in":"header","description":"Signed workspace selector: personal or enterprise:<id>. Get your enterprise ID from GET /api/v1/workspaces.","required":true,"schema":{"pattern":"personal|enterprise:[1-9][0-9]*","type":"string","example":"personal"}},{"name":"X-Environment","in":"header","description":"Signed key environment: live or sandbox.","required":true,"schema":{"pattern":"live|sandbox","type":"string","example":"live"}},{"name":"X-Signature","in":"header","description":"v2-prefixed lowercase HMAC-SHA256 signature; existing and new keys can use v2 when enabled.","required":true,"schema":{"pattern":"v2=[0-9a-f]{64}","type":"string","example":"v2=0123456789abcdef0123456789abcdef0123456789abcdef0123456789abcdef"}},{"name":"Accept-Language","in":"header","description":"Response language: en-US = English (default); zh-CN = Simplified Chinese; zh-TW = Traditional Chinese. Numeric error codes are language-neutral.","required":false,"schema":{"type":"string","enum":["en-US","zh-CN","zh-TW"],"default":"en-US"}}],"responses":{"400":{"description":"Malformed JSON, missing header or invalid request parameter","headers":{"X-Request-ID":{"description":"Request identifier echoed for support and reconciliation.","schema":{"type":"string"}}},"content":{"application/json":{"schema":{"$ref":"#/components/schemas/ApiResponseVoid"}}}},"500":{"description":"Unexpected internal error; contact support with X-Request-ID","headers":{"X-Request-ID":{"description":"Request identifier echoed for support and reconciliation.","schema":{"type":"string"}}},"content":{"application/json":{"schema":{"$ref":"#/components/schemas/ApiResponseVoid"}}}},"403":{"description":"API-key scope, subscription, tenant or policy does not allow the operation","headers":{"X-Request-ID":{"description":"Request identifier echoed for support and reconciliation.","schema":{"type":"string"}}},"content":{"application/json":{"schema":{"$ref":"#/components/schemas/ApiResponseVoid"}}}},"200":{"description":"OK","headers":{"X-Request-ID":{"description":"Request identifier echoed for support and reconciliation.","schema":{"type":"string"}},"X-Quota-Limit":{"description":"Monthly API request allowance for the subscription.","schema":{"type":"integer","format":"int64"}},"X-Quota-Remaining":{"description":"Requests remaining in the current monthly allowance after this request.","schema":{"type":"integer","format":"int64"}},"X-Quota-Reset":{"description":"Unix epoch time in seconds when the monthly allowance resets.","schema":{"type":"integer","format":"int64"}},"X-Quota-Workspace":{"description":"Verified workspace owning this allowance: personal or enterprise:<id>.","schema":{"type":"string"}},"X-Quota-Environment":{"description":"Environment owning the allowance: sandbox or live.","schema":{"type":"string"}}},"content":{"application/json":{"schema":{"$ref":"#/components/schemas/ApiResponseSampleResponse"}}}},"401":{"description":"Invalid API key, content hash, signature, timestamp or request ID","headers":{"X-Request-ID":{"description":"Request identifier echoed for support and reconciliation.","schema":{"type":"string"}}},"content":{"application/json":{"schema":{"$ref":"#/components/schemas/ApiResponseVoid"}}}},"404":{"description":"Resource not found in this enterprise and environment","headers":{"X-Request-ID":{"description":"Request identifier echoed for support and reconciliation.","schema":{"type":"string"}}},"content":{"application/json":{"schema":{"$ref":"#/components/schemas/ApiResponseVoid"}}}},"422":{"description":"Business rule rejected the request","headers":{"X-Request-ID":{"description":"Request identifier echoed for support and reconciliation.","schema":{"type":"string"}}},"content":{"application/json":{"schema":{"$ref":"#/components/schemas/ApiResponseVoid"}}}},"503":{"description":"A required platform service is temporarily unavailable","headers":{"X-Request-ID":{"description":"Request identifier echoed for support and reconciliation.","schema":{"type":"string"}}},"content":{"application/json":{"schema":{"$ref":"#/components/schemas/ApiResponseVoid"}}}},"409":{"description":"Idempotency or resource-state conflict","headers":{"X-Request-ID":{"description":"Request identifier echoed for support and reconciliation.","schema":{"type":"string"}}},"content":{"application/json":{"schema":{"$ref":"#/components/schemas/ApiResponseVoid"}}}},"429":{"description":"Per-minute rate limit or monthly quota exceeded","headers":{"X-Request-ID":{"description":"Request identifier echoed for support and reconciliation.","schema":{"type":"string"}},"X-Quota-Limit":{"description":"Monthly API request allowance for the subscription.","schema":{"type":"integer","format":"int64"}},"X-Quota-Remaining":{"description":"Requests remaining in the current monthly allowance after this request.","schema":{"type":"integer","format":"int64"}},"X-Quota-Reset":{"description":"Unix epoch time in seconds when the monthly allowance resets.","schema":{"type":"integer","format":"int64"}},"X-Quota-Workspace":{"description":"Verified workspace owning this allowance: personal or enterprise:<id>.","schema":{"type":"string"}},"X-Quota-Environment":{"description":"Environment owning the allowance: sandbox or live.","schema":{"type":"string"}},"Retry-After":{"description":"Seconds until the exhausted quota or rate window resets. Sign retries with a new X-Request-ID.","schema":{"type":"integer","format":"int64"}},"X-RateLimit-Scope":{"description":"Rate counter scope: workspace, or user for enterprise verification calls.","schema":{"type":"string"}},"X-RateLimit-Limit":{"description":"Per-minute request limit when rate-limited.","schema":{"type":"integer","format":"int64"}},"X-RateLimit-Remaining":{"description":"Zero when the minute limit is exhausted.","schema":{"type":"integer","format":"int64"}},"X-RateLimit-Reset":{"description":"Unix epoch seconds when the minute limit resets.","schema":{"type":"integer","format":"int64"}}},"content":{"application/json":{"schema":{"$ref":"#/components/schemas/ApiResponseVoid"}}}},"413":{"description":"Request body is too large","headers":{"X-Request-ID":{"description":"Request identifier echoed for support and reconciliation.","schema":{"type":"string"}}},"content":{"application/json":{"schema":{"$ref":"#/components/schemas/ApiResponseVoid"}}}}},"x-dcwallet-signature-versions":["v2"]}},"/api/v1/sandbox/crypto-deposits":{"post":{"tags":["2. Receiving accounts"],"summary":"Simulate a crypto receipt outcome in sandbox","description":"Requires a v2 signed sandbox request, account:write and Idempotency-Key. The address must belong to the selected workspace. The resulting payment record can be queried through the normal receiving APIs. status defaults to settled; pending_settlement, refunded and reversed are uncredited synthetic outcomes.\n\nSignature versions: v2 only.","operationId":"postSandboxCryptoDeposits","parameters":[{"name":"Idempotency-Key","in":"header","description":"Unique key for one mutating request. Reuse the same value only when retrying the same operation.","required":true,"schema":{"type":"string"}},{"name":"X-Timestamp","in":"header","description":"Current Unix epoch time in seconds. Requests older or newer than five minutes are rejected.","required":true,"schema":{"pattern":"[0-9]{10}","type":"string","example":"1787562000"}},{"name":"X-Request-ID","in":"header","description":"Unique 16-128 character request identifier used for replay protection; never reuse it for a different HTTP request.","required":true,"schema":{"pattern":"[A-Za-z0-9._:-]{16,128}","type":"string","example":"018f6f4e-8f62-7fc2-9c4b-7be2f4203b6a"}},{"name":"X-Content-SHA256","in":"header","description":"Lowercase hexadecimal SHA-256 digest of the exact raw request body; use the digest of zero bytes when no body is sent.","required":true,"schema":{"pattern":"[0-9a-f]{64}","type":"string","example":"e3b0c44298fc1c149afbf4c8996fb92427ae41e4649b934ca495991b7852b855"}},{"name":"X-Workspace","in":"header","description":"Signed workspace selector: personal or enterprise:<id>. Get your enterprise ID from GET /api/v1/workspaces.","required":true,"schema":{"pattern":"personal|enterprise:[1-9][0-9]*","type":"string","example":"personal"}},{"name":"X-Environment","in":"header","description":"Signed key environment: live or sandbox.","required":true,"schema":{"pattern":"live|sandbox","type":"string","example":"live"}},{"name":"X-Signature","in":"header","description":"v2-prefixed lowercase HMAC-SHA256 signature; existing and new keys can use v2 when enabled.","required":true,"schema":{"pattern":"v2=[0-9a-f]{64}","type":"string","example":"v2=0123456789abcdef0123456789abcdef0123456789abcdef0123456789abcdef"}},{"name":"Accept-Language","in":"header","description":"Response language: en-US = English (default); zh-CN = Simplified Chinese; zh-TW = Traditional Chinese. Numeric error codes are language-neutral.","required":false,"schema":{"type":"string","enum":["en-US","zh-CN","zh-TW"],"default":"en-US"}}],"requestBody":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/SandboxCryptoDepositRequest"}}},"required":true},"responses":{"400":{"description":"Malformed JSON, missing header or invalid request parameter","headers":{"X-Request-ID":{"description":"Request identifier echoed for support and reconciliation.","schema":{"type":"string"}}},"content":{"application/json":{"schema":{"$ref":"#/components/schemas/ApiResponseVoid"}}}},"500":{"description":"Unexpected internal error; contact support with X-Request-ID","headers":{"X-Request-ID":{"description":"Request identifier echoed for support and reconciliation.","schema":{"type":"string"}}},"content":{"application/json":{"schema":{"$ref":"#/components/schemas/ApiResponseVoid"}}}},"403":{"description":"API-key scope, subscription, tenant or policy does not allow the operation","headers":{"X-Request-ID":{"description":"Request identifier echoed for support and reconciliation.","schema":{"type":"string"}}},"content":{"application/json":{"schema":{"$ref":"#/components/schemas/ApiResponseVoid"}}}},"200":{"description":"OK","headers":{"X-Request-ID":{"description":"Request identifier echoed for support and reconciliation.","schema":{"type":"string"}},"X-Quota-Limit":{"description":"Monthly API request allowance for the subscription.","schema":{"type":"integer","format":"int64"}},"X-Quota-Remaining":{"description":"Requests remaining in the current monthly allowance after this request.","schema":{"type":"integer","format":"int64"}},"X-Quota-Reset":{"description":"Unix epoch time in seconds when the monthly allowance resets.","schema":{"type":"integer","format":"int64"}},"X-Quota-Workspace":{"description":"Verified workspace owning this allowance: personal or enterprise:<id>.","schema":{"type":"string"}},"X-Quota-Environment":{"description":"Environment owning the allowance: sandbox or live.","schema":{"type":"string"}}},"content":{"application/json":{"schema":{"$ref":"#/components/schemas/ApiResponseSandboxDepositResponse"}}}},"401":{"description":"Invalid API key, content hash, signature, timestamp or request ID","headers":{"X-Request-ID":{"description":"Request identifier echoed for support and reconciliation.","schema":{"type":"string"}}},"content":{"application/json":{"schema":{"$ref":"#/components/schemas/ApiResponseVoid"}}}},"404":{"description":"Resource not found in this enterprise and environment","headers":{"X-Request-ID":{"description":"Request identifier echoed for support and reconciliation.","schema":{"type":"string"}}},"content":{"application/json":{"schema":{"$ref":"#/components/schemas/ApiResponseVoid"}}}},"422":{"description":"Business rule rejected the request","headers":{"X-Request-ID":{"description":"Request identifier echoed for support and reconciliation.","schema":{"type":"string"}}},"content":{"application/json":{"schema":{"$ref":"#/components/schemas/ApiResponseVoid"}}}},"503":{"description":"A required platform service is temporarily unavailable","headers":{"X-Request-ID":{"description":"Request identifier echoed for support and reconciliation.","schema":{"type":"string"}}},"content":{"application/json":{"schema":{"$ref":"#/components/schemas/ApiResponseVoid"}}}},"409":{"description":"Idempotency or resource-state conflict","headers":{"X-Request-ID":{"description":"Request identifier echoed for support and reconciliation.","schema":{"type":"string"}}},"content":{"application/json":{"schema":{"$ref":"#/components/schemas/ApiResponseVoid"}}}},"429":{"description":"Per-minute rate limit or monthly quota exceeded","headers":{"X-Request-ID":{"description":"Request identifier echoed for support and reconciliation.","schema":{"type":"string"}},"X-Quota-Limit":{"description":"Monthly API request allowance for the subscription.","schema":{"type":"integer","format":"int64"}},"X-Quota-Remaining":{"description":"Requests remaining in the current monthly allowance after this request.","schema":{"type":"integer","format":"int64"}},"X-Quota-Reset":{"description":"Unix epoch time in seconds when the monthly allowance resets.","schema":{"type":"integer","format":"int64"}},"X-Quota-Workspace":{"description":"Verified workspace owning this allowance: personal or enterprise:<id>.","schema":{"type":"string"}},"X-Quota-Environment":{"description":"Environment owning the allowance: sandbox or live.","schema":{"type":"string"}},"Retry-After":{"description":"Seconds until the exhausted quota or rate window resets. Sign retries with a new X-Request-ID.","schema":{"type":"integer","format":"int64"}},"X-RateLimit-Scope":{"description":"Rate counter scope: workspace, or user for enterprise verification calls.","schema":{"type":"string"}},"X-RateLimit-Limit":{"description":"Per-minute request limit when rate-limited.","schema":{"type":"integer","format":"int64"}},"X-RateLimit-Remaining":{"description":"Zero when the minute limit is exhausted.","schema":{"type":"integer","format":"int64"}},"X-RateLimit-Reset":{"description":"Unix epoch seconds when the minute limit resets.","schema":{"type":"integer","format":"int64"}}},"content":{"application/json":{"schema":{"$ref":"#/components/schemas/ApiResponseVoid"}}}},"413":{"description":"Request body is too large","headers":{"X-Request-ID":{"description":"Request identifier echoed for support and reconciliation.","schema":{"type":"string"}}},"content":{"application/json":{"schema":{"$ref":"#/components/schemas/ApiResponseVoid"}}}}},"x-dcwallet-signature-versions":["v2"]}},"/api/v1/invoices/{invoiceId}/send":{"post":{"tags":["4. Receivables"],"summary":"Activate a receivable and create its checkout URL","description":"For v2 requests, send Idempotency-Key and reuse it when retrying this activation.\n\nSignature versions: v1 and v2.","operationId":"postInvoicesByInvoiceIdSend","parameters":[{"name":"invoiceId","in":"path","description":"Invoice ID returned by /api/v1/invoices. Keep IDs as strings.","required":true,"schema":{"pattern":"[0-9]+","type":"string","example":"337893979704000512"}},{"name":"Idempotency-Key","in":"header","description":"Required for v2 signed POST/PATCH requests, including read-only previews; optional for historical v1 requests. Reuse the same value when retrying the same operation.","required":false,"schema":{"type":"string"}},{"name":"X-Content-SHA256","in":"header","description":"The x-content-sha256 value for this resource.","required":true,"schema":{"type":"string"}},{"name":"X-Timestamp","in":"header","description":"Current Unix epoch time in seconds. Requests older or newer than five minutes are rejected.","required":true,"schema":{"pattern":"[0-9]{10}","type":"string","example":"1787562000"}},{"name":"X-Request-ID","in":"header","description":"Unique 16-128 character request identifier used for replay protection; never reuse it for a different HTTP request.","required":true,"schema":{"pattern":"[A-Za-z0-9._:-]{16,128}","type":"string","example":"018f6f4e-8f62-7fc2-9c4b-7be2f4203b6a"}},{"name":"X-Workspace","in":"header","description":"Enterprise writes are available on this route. For enterprise access, copy your own enterprise:<id> from GET /api/v1/workspaces. Required for v2 requests. V1 requests use the historical key's fixed enterprise.","required":false,"schema":{"pattern":"personal|enterprise:[1-9][0-9]*","type":"string","example":null}},{"name":"X-Environment","in":"header","description":"Required and signed for v2 requests: live or sandbox. Optional for v1 requests.","required":false,"schema":{"pattern":"live|sandbox","type":"string","example":"live"}},{"name":"X-Signature","in":"header","description":"Existing keys accept v1 for their fixed enterprise or v2 for a signed workspace; new keys accept v2 only.","required":true,"schema":{"pattern":"v[12]=[0-9a-f]{64}","type":"string","example":"v2=0123456789abcdef0123456789abcdef0123456789abcdef0123456789abcdef"}},{"name":"Accept-Language","in":"header","description":"Response language: en-US = English (default); zh-CN = Simplified Chinese; zh-TW = Traditional Chinese. Numeric error codes are language-neutral.","required":false,"schema":{"type":"string","enum":["en-US","zh-CN","zh-TW"],"default":"en-US"}}],"responses":{"400":{"description":"Malformed JSON, missing header or invalid request parameter","headers":{"X-Request-ID":{"description":"Request identifier echoed for support and reconciliation.","schema":{"type":"string"}}},"content":{"application/json":{"schema":{"$ref":"#/components/schemas/ApiResponseVoid"}}}},"500":{"description":"Unexpected internal error; contact support with X-Request-ID","headers":{"X-Request-ID":{"description":"Request identifier echoed for support and reconciliation.","schema":{"type":"string"}}},"content":{"application/json":{"schema":{"$ref":"#/components/schemas/ApiResponseVoid"}}}},"403":{"description":"API-key scope, subscription, tenant or policy does not allow the operation","headers":{"X-Request-ID":{"description":"Request identifier echoed for support and reconciliation.","schema":{"type":"string"}}},"content":{"application/json":{"schema":{"$ref":"#/components/schemas/ApiResponseVoid"}}}},"200":{"description":"OK","headers":{"X-Request-ID":{"description":"Request identifier echoed for support and reconciliation.","schema":{"type":"string"}},"X-Quota-Limit":{"description":"Monthly API request allowance for the subscription.","schema":{"type":"integer","format":"int64"}},"X-Quota-Remaining":{"description":"Requests remaining in the current monthly allowance after this request.","schema":{"type":"integer","format":"int64"}},"X-Quota-Reset":{"description":"Unix epoch time in seconds when the monthly allowance resets.","schema":{"type":"integer","format":"int64"}},"X-Quota-Workspace":{"description":"Verified workspace owning this allowance: personal or enterprise:<id>.","schema":{"type":"string"}},"X-Quota-Environment":{"description":"Environment owning the allowance: sandbox or live.","schema":{"type":"string"}}},"content":{"application/json":{"schema":{"$ref":"#/components/schemas/ApiResponseInvoiceResponse"}}}},"401":{"description":"Invalid API key, content hash, signature, timestamp or request ID","headers":{"X-Request-ID":{"description":"Request identifier echoed for support and reconciliation.","schema":{"type":"string"}}},"content":{"application/json":{"schema":{"$ref":"#/components/schemas/ApiResponseVoid"}}}},"404":{"description":"Resource not found in this enterprise and environment","headers":{"X-Request-ID":{"description":"Request identifier echoed for support and reconciliation.","schema":{"type":"string"}}},"content":{"application/json":{"schema":{"$ref":"#/components/schemas/ApiResponseVoid"}}}},"422":{"description":"Business rule rejected the request","headers":{"X-Request-ID":{"description":"Request identifier echoed for support and reconciliation.","schema":{"type":"string"}}},"content":{"application/json":{"schema":{"$ref":"#/components/schemas/ApiResponseVoid"}}}},"503":{"description":"A required platform service is temporarily unavailable","headers":{"X-Request-ID":{"description":"Request identifier echoed for support and reconciliation.","schema":{"type":"string"}}},"content":{"application/json":{"schema":{"$ref":"#/components/schemas/ApiResponseVoid"}}}},"409":{"description":"Idempotency or resource-state conflict","headers":{"X-Request-ID":{"description":"Request identifier echoed for support and reconciliation.","schema":{"type":"string"}}},"content":{"application/json":{"schema":{"$ref":"#/components/schemas/ApiResponseVoid"}}}},"429":{"description":"Per-minute rate limit or monthly quota exceeded","headers":{"X-Request-ID":{"description":"Request identifier echoed for support and reconciliation.","schema":{"type":"string"}},"X-Quota-Limit":{"description":"Monthly API request allowance for the subscription.","schema":{"type":"integer","format":"int64"}},"X-Quota-Remaining":{"description":"Requests remaining in the current monthly allowance after this request.","schema":{"type":"integer","format":"int64"}},"X-Quota-Reset":{"description":"Unix epoch time in seconds when the monthly allowance resets.","schema":{"type":"integer","format":"int64"}},"X-Quota-Workspace":{"description":"Verified workspace owning this allowance: personal or enterprise:<id>.","schema":{"type":"string"}},"X-Quota-Environment":{"description":"Environment owning the allowance: sandbox or live.","schema":{"type":"string"}},"Retry-After":{"description":"Seconds until the exhausted quota or rate window resets. Sign retries with a new X-Request-ID.","schema":{"type":"integer","format":"int64"}},"X-RateLimit-Scope":{"description":"Rate counter scope: workspace, or user for enterprise verification calls.","schema":{"type":"string"}},"X-RateLimit-Limit":{"description":"Per-minute request limit when rate-limited.","schema":{"type":"integer","format":"int64"}},"X-RateLimit-Remaining":{"description":"Zero when the minute limit is exhausted.","schema":{"type":"integer","format":"int64"}},"X-RateLimit-Reset":{"description":"Unix epoch seconds when the minute limit resets.","schema":{"type":"integer","format":"int64"}}},"content":{"application/json":{"schema":{"$ref":"#/components/schemas/ApiResponseVoid"}}}},"413":{"description":"Request body is too large","headers":{"X-Request-ID":{"description":"Request identifier echoed for support and reconciliation.","schema":{"type":"string"}}},"content":{"application/json":{"schema":{"$ref":"#/components/schemas/ApiResponseVoid"}}}}},"x-dcwallet-signature-versions":["v1","v2"]}},"/api/v1/receivables/{invoiceId}/send":{"post":{"tags":["4. Receivables"],"summary":"Activate a receivable and create its checkout URL","description":"For v2 requests, send Idempotency-Key and reuse it when retrying this activation.\n\nSignature versions: v1 and v2.","operationId":"postReceivablesByInvoiceIdSend","parameters":[{"name":"invoiceId","in":"path","description":"Invoice ID returned by /api/v1/invoices. Keep IDs as strings.","required":true,"schema":{"pattern":"[0-9]+","type":"string","example":"337893979704000512"}},{"name":"Idempotency-Key","in":"header","description":"Required for v2 signed POST/PATCH requests, including read-only previews; optional for historical v1 requests. Reuse the same value when retrying the same operation.","required":false,"schema":{"type":"string"}},{"name":"X-Content-SHA256","in":"header","description":"The x-content-sha256 value for this resource.","required":true,"schema":{"type":"string"}},{"name":"X-Timestamp","in":"header","description":"Current Unix epoch time in seconds. Requests older or newer than five minutes are rejected.","required":true,"schema":{"pattern":"[0-9]{10}","type":"string","example":"1787562000"}},{"name":"X-Request-ID","in":"header","description":"Unique 16-128 character request identifier used for replay protection; never reuse it for a different HTTP request.","required":true,"schema":{"pattern":"[A-Za-z0-9._:-]{16,128}","type":"string","example":"018f6f4e-8f62-7fc2-9c4b-7be2f4203b6a"}},{"name":"X-Workspace","in":"header","description":"Enterprise writes are available on this route. For enterprise access, copy your own enterprise:<id> from GET /api/v1/workspaces. Required for v2 requests. V1 requests use the historical key's fixed enterprise.","required":false,"schema":{"pattern":"personal|enterprise:[1-9][0-9]*","type":"string","example":null}},{"name":"X-Environment","in":"header","description":"Required and signed for v2 requests: live or sandbox. Optional for v1 requests.","required":false,"schema":{"pattern":"live|sandbox","type":"string","example":"live"}},{"name":"X-Signature","in":"header","description":"Existing keys accept v1 for their fixed enterprise or v2 for a signed workspace; new keys accept v2 only.","required":true,"schema":{"pattern":"v[12]=[0-9a-f]{64}","type":"string","example":"v2=0123456789abcdef0123456789abcdef0123456789abcdef0123456789abcdef"}},{"name":"Accept-Language","in":"header","description":"Response language: en-US = English (default); zh-CN = Simplified Chinese; zh-TW = Traditional Chinese. Numeric error codes are language-neutral.","required":false,"schema":{"type":"string","enum":["en-US","zh-CN","zh-TW"],"default":"en-US"}}],"responses":{"400":{"description":"Malformed JSON, missing header or invalid request parameter","headers":{"X-Request-ID":{"description":"Request identifier echoed for support and reconciliation.","schema":{"type":"string"}}},"content":{"application/json":{"schema":{"$ref":"#/components/schemas/ApiResponseVoid"}}}},"500":{"description":"Unexpected internal error; contact support with X-Request-ID","headers":{"X-Request-ID":{"description":"Request identifier echoed for support and reconciliation.","schema":{"type":"string"}}},"content":{"application/json":{"schema":{"$ref":"#/components/schemas/ApiResponseVoid"}}}},"403":{"description":"API-key scope, subscription, tenant or policy does not allow the operation","headers":{"X-Request-ID":{"description":"Request identifier echoed for support and reconciliation.","schema":{"type":"string"}}},"content":{"application/json":{"schema":{"$ref":"#/components/schemas/ApiResponseVoid"}}}},"200":{"description":"OK","headers":{"X-Request-ID":{"description":"Request identifier echoed for support and reconciliation.","schema":{"type":"string"}},"X-Quota-Limit":{"description":"Monthly API request allowance for the subscription.","schema":{"type":"integer","format":"int64"}},"X-Quota-Remaining":{"description":"Requests remaining in the current monthly allowance after this request.","schema":{"type":"integer","format":"int64"}},"X-Quota-Reset":{"description":"Unix epoch time in seconds when the monthly allowance resets.","schema":{"type":"integer","format":"int64"}},"X-Quota-Workspace":{"description":"Verified workspace owning this allowance: personal or enterprise:<id>.","schema":{"type":"string"}},"X-Quota-Environment":{"description":"Environment owning the allowance: sandbox or live.","schema":{"type":"string"}}},"content":{"application/json":{"schema":{"$ref":"#/components/schemas/ApiResponseInvoiceResponse"}}}},"401":{"description":"Invalid API key, content hash, signature, timestamp or request ID","headers":{"X-Request-ID":{"description":"Request identifier echoed for support and reconciliation.","schema":{"type":"string"}}},"content":{"application/json":{"schema":{"$ref":"#/components/schemas/ApiResponseVoid"}}}},"404":{"description":"Resource not found in this enterprise and environment","headers":{"X-Request-ID":{"description":"Request identifier echoed for support and reconciliation.","schema":{"type":"string"}}},"content":{"application/json":{"schema":{"$ref":"#/components/schemas/ApiResponseVoid"}}}},"422":{"description":"Business rule rejected the request","headers":{"X-Request-ID":{"description":"Request identifier echoed for support and reconciliation.","schema":{"type":"string"}}},"content":{"application/json":{"schema":{"$ref":"#/components/schemas/ApiResponseVoid"}}}},"503":{"description":"A required platform service is temporarily unavailable","headers":{"X-Request-ID":{"description":"Request identifier echoed for support and reconciliation.","schema":{"type":"string"}}},"content":{"application/json":{"schema":{"$ref":"#/components/schemas/ApiResponseVoid"}}}},"409":{"description":"Idempotency or resource-state conflict","headers":{"X-Request-ID":{"description":"Request identifier echoed for support and reconciliation.","schema":{"type":"string"}}},"content":{"application/json":{"schema":{"$ref":"#/components/schemas/ApiResponseVoid"}}}},"429":{"description":"Per-minute rate limit or monthly quota exceeded","headers":{"X-Request-ID":{"description":"Request identifier echoed for support and reconciliation.","schema":{"type":"string"}},"X-Quota-Limit":{"description":"Monthly API request allowance for the subscription.","schema":{"type":"integer","format":"int64"}},"X-Quota-Remaining":{"description":"Requests remaining in the current monthly allowance after this request.","schema":{"type":"integer","format":"int64"}},"X-Quota-Reset":{"description":"Unix epoch time in seconds when the monthly allowance resets.","schema":{"type":"integer","format":"int64"}},"X-Quota-Workspace":{"description":"Verified workspace owning this allowance: personal or enterprise:<id>.","schema":{"type":"string"}},"X-Quota-Environment":{"description":"Environment owning the allowance: sandbox or live.","schema":{"type":"string"}},"Retry-After":{"description":"Seconds until the exhausted quota or rate window resets. Sign retries with a new X-Request-ID.","schema":{"type":"integer","format":"int64"}},"X-RateLimit-Scope":{"description":"Rate counter scope: workspace, or user for enterprise verification calls.","schema":{"type":"string"}},"X-RateLimit-Limit":{"description":"Per-minute request limit when rate-limited.","schema":{"type":"integer","format":"int64"}},"X-RateLimit-Remaining":{"description":"Zero when the minute limit is exhausted.","schema":{"type":"integer","format":"int64"}},"X-RateLimit-Reset":{"description":"Unix epoch seconds when the minute limit resets.","schema":{"type":"integer","format":"int64"}}},"content":{"application/json":{"schema":{"$ref":"#/components/schemas/ApiResponseVoid"}}}},"413":{"description":"Request body is too large","headers":{"X-Request-ID":{"description":"Request identifier echoed for support and reconciliation.","schema":{"type":"string"}}},"content":{"application/json":{"schema":{"$ref":"#/components/schemas/ApiResponseVoid"}}}}},"x-dcwallet-signature-versions":["v1","v2"]}},"/api/v1/receivables/{invoiceId}/cancel":{"post":{"tags":["4. Receivables"],"summary":"Cancel an unpaid enterprise receivable","description":"For v2 requests, send Idempotency-Key and reuse it when retrying this cancellation.\n\nSignature versions: v1 and v2.","operationId":"postReceivablesByInvoiceIdCancel","parameters":[{"name":"invoiceId","in":"path","description":"Invoice ID returned by /api/v1/invoices. Keep IDs as strings.","required":true,"schema":{"pattern":"[0-9]+","type":"string","example":"337893979704000512"}},{"name":"Idempotency-Key","in":"header","description":"Required for v2 signed POST/PATCH requests, including read-only previews; optional for historical v1 requests. Reuse the same value when retrying the same operation.","required":false,"schema":{"type":"string"}},{"name":"X-Content-SHA256","in":"header","description":"The x-content-sha256 value for this resource.","required":true,"schema":{"type":"string"}},{"name":"X-Timestamp","in":"header","description":"Current Unix epoch time in seconds. Requests older or newer than five minutes are rejected.","required":true,"schema":{"pattern":"[0-9]{10}","type":"string","example":"1787562000"}},{"name":"X-Request-ID","in":"header","description":"Unique 16-128 character request identifier used for replay protection; never reuse it for a different HTTP request.","required":true,"schema":{"pattern":"[A-Za-z0-9._:-]{16,128}","type":"string","example":"018f6f4e-8f62-7fc2-9c4b-7be2f4203b6a"}},{"name":"X-Workspace","in":"header","description":"Enterprise writes are available on this route. For enterprise access, copy your own enterprise:<id> from GET /api/v1/workspaces. Required for v2 requests. V1 requests use the historical key's fixed enterprise.","required":false,"schema":{"pattern":"personal|enterprise:[1-9][0-9]*","type":"string","example":null}},{"name":"X-Environment","in":"header","description":"Required and signed for v2 requests: live or sandbox. Optional for v1 requests.","required":false,"schema":{"pattern":"live|sandbox","type":"string","example":"live"}},{"name":"X-Signature","in":"header","description":"Existing keys accept v1 for their fixed enterprise or v2 for a signed workspace; new keys accept v2 only.","required":true,"schema":{"pattern":"v[12]=[0-9a-f]{64}","type":"string","example":"v2=0123456789abcdef0123456789abcdef0123456789abcdef0123456789abcdef"}},{"name":"Accept-Language","in":"header","description":"Response language: en-US = English (default); zh-CN = Simplified Chinese; zh-TW = Traditional Chinese. Numeric error codes are language-neutral.","required":false,"schema":{"type":"string","enum":["en-US","zh-CN","zh-TW"],"default":"en-US"}}],"responses":{"400":{"description":"Malformed JSON, missing header or invalid request parameter","headers":{"X-Request-ID":{"description":"Request identifier echoed for support and reconciliation.","schema":{"type":"string"}}},"content":{"application/json":{"schema":{"$ref":"#/components/schemas/ApiResponseVoid"}}}},"500":{"description":"Unexpected internal error; contact support with X-Request-ID","headers":{"X-Request-ID":{"description":"Request identifier echoed for support and reconciliation.","schema":{"type":"string"}}},"content":{"application/json":{"schema":{"$ref":"#/components/schemas/ApiResponseVoid"}}}},"403":{"description":"API-key scope, subscription, tenant or policy does not allow the operation","headers":{"X-Request-ID":{"description":"Request identifier echoed for support and reconciliation.","schema":{"type":"string"}}},"content":{"application/json":{"schema":{"$ref":"#/components/schemas/ApiResponseVoid"}}}},"200":{"description":"OK","headers":{"X-Request-ID":{"description":"Request identifier echoed for support and reconciliation.","schema":{"type":"string"}},"X-Quota-Limit":{"description":"Monthly API request allowance for the subscription.","schema":{"type":"integer","format":"int64"}},"X-Quota-Remaining":{"description":"Requests remaining in the current monthly allowance after this request.","schema":{"type":"integer","format":"int64"}},"X-Quota-Reset":{"description":"Unix epoch time in seconds when the monthly allowance resets.","schema":{"type":"integer","format":"int64"}},"X-Quota-Workspace":{"description":"Verified workspace owning this allowance: personal or enterprise:<id>.","schema":{"type":"string"}},"X-Quota-Environment":{"description":"Environment owning the allowance: sandbox or live.","schema":{"type":"string"}}},"content":{"application/json":{"schema":{"$ref":"#/components/schemas/ApiResponseInvoiceResponse"}}}},"401":{"description":"Invalid API key, content hash, signature, timestamp or request ID","headers":{"X-Request-ID":{"description":"Request identifier echoed for support and reconciliation.","schema":{"type":"string"}}},"content":{"application/json":{"schema":{"$ref":"#/components/schemas/ApiResponseVoid"}}}},"404":{"description":"Resource not found in this enterprise and environment","headers":{"X-Request-ID":{"description":"Request identifier echoed for support and reconciliation.","schema":{"type":"string"}}},"content":{"application/json":{"schema":{"$ref":"#/components/schemas/ApiResponseVoid"}}}},"422":{"description":"Business rule rejected the request","headers":{"X-Request-ID":{"description":"Request identifier echoed for support and reconciliation.","schema":{"type":"string"}}},"content":{"application/json":{"schema":{"$ref":"#/components/schemas/ApiResponseVoid"}}}},"503":{"description":"A required platform service is temporarily unavailable","headers":{"X-Request-ID":{"description":"Request identifier echoed for support and reconciliation.","schema":{"type":"string"}}},"content":{"application/json":{"schema":{"$ref":"#/components/schemas/ApiResponseVoid"}}}},"409":{"description":"Idempotency or resource-state conflict","headers":{"X-Request-ID":{"description":"Request identifier echoed for support and reconciliation.","schema":{"type":"string"}}},"content":{"application/json":{"schema":{"$ref":"#/components/schemas/ApiResponseVoid"}}}},"429":{"description":"Per-minute rate limit or monthly quota exceeded","headers":{"X-Request-ID":{"description":"Request identifier echoed for support and reconciliation.","schema":{"type":"string"}},"X-Quota-Limit":{"description":"Monthly API request allowance for the subscription.","schema":{"type":"integer","format":"int64"}},"X-Quota-Remaining":{"description":"Requests remaining in the current monthly allowance after this request.","schema":{"type":"integer","format":"int64"}},"X-Quota-Reset":{"description":"Unix epoch time in seconds when the monthly allowance resets.","schema":{"type":"integer","format":"int64"}},"X-Quota-Workspace":{"description":"Verified workspace owning this allowance: personal or enterprise:<id>.","schema":{"type":"string"}},"X-Quota-Environment":{"description":"Environment owning the allowance: sandbox or live.","schema":{"type":"string"}},"Retry-After":{"description":"Seconds until the exhausted quota or rate window resets. Sign retries with a new X-Request-ID.","schema":{"type":"integer","format":"int64"}},"X-RateLimit-Scope":{"description":"Rate counter scope: workspace, or user for enterprise verification calls.","schema":{"type":"string"}},"X-RateLimit-Limit":{"description":"Per-minute request limit when rate-limited.","schema":{"type":"integer","format":"int64"}},"X-RateLimit-Remaining":{"description":"Zero when the minute limit is exhausted.","schema":{"type":"integer","format":"int64"}},"X-RateLimit-Reset":{"description":"Unix epoch seconds when the minute limit resets.","schema":{"type":"integer","format":"int64"}}},"content":{"application/json":{"schema":{"$ref":"#/components/schemas/ApiResponseVoid"}}}},"413":{"description":"Request body is too large","headers":{"X-Request-ID":{"description":"Request identifier echoed for support and reconciliation.","schema":{"type":"string"}}},"content":{"application/json":{"schema":{"$ref":"#/components/schemas/ApiResponseVoid"}}}}},"x-dcwallet-signature-versions":["v1","v2"]}},"/api/v1/invoices/{invoiceId}/cancel":{"post":{"tags":["4. Receivables"],"summary":"Cancel an unpaid enterprise receivable","description":"For v2 requests, send Idempotency-Key and reuse it when retrying this cancellation.\n\nSignature versions: v1 and v2.","operationId":"postInvoicesByInvoiceIdCancel","parameters":[{"name":"invoiceId","in":"path","description":"Invoice ID returned by /api/v1/invoices. Keep IDs as strings.","required":true,"schema":{"pattern":"[0-9]+","type":"string","example":"337893979704000512"}},{"name":"Idempotency-Key","in":"header","description":"Required for v2 signed POST/PATCH requests, including read-only previews; optional for historical v1 requests. Reuse the same value when retrying the same operation.","required":false,"schema":{"type":"string"}},{"name":"X-Content-SHA256","in":"header","description":"The x-content-sha256 value for this resource.","required":true,"schema":{"type":"string"}},{"name":"X-Timestamp","in":"header","description":"Current Unix epoch time in seconds. Requests older or newer than five minutes are rejected.","required":true,"schema":{"pattern":"[0-9]{10}","type":"string","example":"1787562000"}},{"name":"X-Request-ID","in":"header","description":"Unique 16-128 character request identifier used for replay protection; never reuse it for a different HTTP request.","required":true,"schema":{"pattern":"[A-Za-z0-9._:-]{16,128}","type":"string","example":"018f6f4e-8f62-7fc2-9c4b-7be2f4203b6a"}},{"name":"X-Workspace","in":"header","description":"Enterprise writes are available on this route. For enterprise access, copy your own enterprise:<id> from GET /api/v1/workspaces. Required for v2 requests. V1 requests use the historical key's fixed enterprise.","required":false,"schema":{"pattern":"personal|enterprise:[1-9][0-9]*","type":"string","example":null}},{"name":"X-Environment","in":"header","description":"Required and signed for v2 requests: live or sandbox. Optional for v1 requests.","required":false,"schema":{"pattern":"live|sandbox","type":"string","example":"live"}},{"name":"X-Signature","in":"header","description":"Existing keys accept v1 for their fixed enterprise or v2 for a signed workspace; new keys accept v2 only.","required":true,"schema":{"pattern":"v[12]=[0-9a-f]{64}","type":"string","example":"v2=0123456789abcdef0123456789abcdef0123456789abcdef0123456789abcdef"}},{"name":"Accept-Language","in":"header","description":"Response language: en-US = English (default); zh-CN = Simplified Chinese; zh-TW = Traditional Chinese. Numeric error codes are language-neutral.","required":false,"schema":{"type":"string","enum":["en-US","zh-CN","zh-TW"],"default":"en-US"}}],"responses":{"400":{"description":"Malformed JSON, missing header or invalid request parameter","headers":{"X-Request-ID":{"description":"Request identifier echoed for support and reconciliation.","schema":{"type":"string"}}},"content":{"application/json":{"schema":{"$ref":"#/components/schemas/ApiResponseVoid"}}}},"500":{"description":"Unexpected internal error; contact support with X-Request-ID","headers":{"X-Request-ID":{"description":"Request identifier echoed for support and reconciliation.","schema":{"type":"string"}}},"content":{"application/json":{"schema":{"$ref":"#/components/schemas/ApiResponseVoid"}}}},"403":{"description":"API-key scope, subscription, tenant or policy does not allow the operation","headers":{"X-Request-ID":{"description":"Request identifier echoed for support and reconciliation.","schema":{"type":"string"}}},"content":{"application/json":{"schema":{"$ref":"#/components/schemas/ApiResponseVoid"}}}},"200":{"description":"OK","headers":{"X-Request-ID":{"description":"Request identifier echoed for support and reconciliation.","schema":{"type":"string"}},"X-Quota-Limit":{"description":"Monthly API request allowance for the subscription.","schema":{"type":"integer","format":"int64"}},"X-Quota-Remaining":{"description":"Requests remaining in the current monthly allowance after this request.","schema":{"type":"integer","format":"int64"}},"X-Quota-Reset":{"description":"Unix epoch time in seconds when the monthly allowance resets.","schema":{"type":"integer","format":"int64"}},"X-Quota-Workspace":{"description":"Verified workspace owning this allowance: personal or enterprise:<id>.","schema":{"type":"string"}},"X-Quota-Environment":{"description":"Environment owning the allowance: sandbox or live.","schema":{"type":"string"}}},"content":{"application/json":{"schema":{"$ref":"#/components/schemas/ApiResponseInvoiceResponse"}}}},"401":{"description":"Invalid API key, content hash, signature, timestamp or request ID","headers":{"X-Request-ID":{"description":"Request identifier echoed for support and reconciliation.","schema":{"type":"string"}}},"content":{"application/json":{"schema":{"$ref":"#/components/schemas/ApiResponseVoid"}}}},"404":{"description":"Resource not found in this enterprise and environment","headers":{"X-Request-ID":{"description":"Request identifier echoed for support and reconciliation.","schema":{"type":"string"}}},"content":{"application/json":{"schema":{"$ref":"#/components/schemas/ApiResponseVoid"}}}},"422":{"description":"Business rule rejected the request","headers":{"X-Request-ID":{"description":"Request identifier echoed for support and reconciliation.","schema":{"type":"string"}}},"content":{"application/json":{"schema":{"$ref":"#/components/schemas/ApiResponseVoid"}}}},"503":{"description":"A required platform service is temporarily unavailable","headers":{"X-Request-ID":{"description":"Request identifier echoed for support and reconciliation.","schema":{"type":"string"}}},"content":{"application/json":{"schema":{"$ref":"#/components/schemas/ApiResponseVoid"}}}},"409":{"description":"Idempotency or resource-state conflict","headers":{"X-Request-ID":{"description":"Request identifier echoed for support and reconciliation.","schema":{"type":"string"}}},"content":{"application/json":{"schema":{"$ref":"#/components/schemas/ApiResponseVoid"}}}},"429":{"description":"Per-minute rate limit or monthly quota exceeded","headers":{"X-Request-ID":{"description":"Request identifier echoed for support and reconciliation.","schema":{"type":"string"}},"X-Quota-Limit":{"description":"Monthly API request allowance for the subscription.","schema":{"type":"integer","format":"int64"}},"X-Quota-Remaining":{"description":"Requests remaining in the current monthly allowance after this request.","schema":{"type":"integer","format":"int64"}},"X-Quota-Reset":{"description":"Unix epoch time in seconds when the monthly allowance resets.","schema":{"type":"integer","format":"int64"}},"X-Quota-Workspace":{"description":"Verified workspace owning this allowance: personal or enterprise:<id>.","schema":{"type":"string"}},"X-Quota-Environment":{"description":"Environment owning the allowance: sandbox or live.","schema":{"type":"string"}},"Retry-After":{"description":"Seconds until the exhausted quota or rate window resets. Sign retries with a new X-Request-ID.","schema":{"type":"integer","format":"int64"}},"X-RateLimit-Scope":{"description":"Rate counter scope: workspace, or user for enterprise verification calls.","schema":{"type":"string"}},"X-RateLimit-Limit":{"description":"Per-minute request limit when rate-limited.","schema":{"type":"integer","format":"int64"}},"X-RateLimit-Remaining":{"description":"Zero when the minute limit is exhausted.","schema":{"type":"integer","format":"int64"}},"X-RateLimit-Reset":{"description":"Unix epoch seconds when the minute limit resets.","schema":{"type":"integer","format":"int64"}}},"content":{"application/json":{"schema":{"$ref":"#/components/schemas/ApiResponseVoid"}}}},"413":{"description":"Request body is too large","headers":{"X-Request-ID":{"description":"Request identifier echoed for support and reconciliation.","schema":{"type":"string"}}},"content":{"application/json":{"schema":{"$ref":"#/components/schemas/ApiResponseVoid"}}}}},"x-dcwallet-signature-versions":["v1","v2"]}},"/api/v1/receivables":{"get":{"tags":["4. Receivables"],"summary":"List enterprise receivables","description":"Signature versions: v1 and v2.","operationId":"getReceivables","parameters":[{"name":"status","in":"query","description":"Optional filter. Invoice state: draft = editable (default on creation); sent = issued and awaiting payment; partial_paid = some amount received; fully_paid = target amount received; overpaid = amount exceeds target; overdue = unpaid after due date; cancelled = voided (terminal); refunded = collected funds returned (terminal). Paid states may later change after another payment or refund.","required":false,"schema":{"type":"string","enum":["draft","sent","partial_paid","fully_paid","overpaid","overdue","cancelled","refunded"]}},{"name":"page","in":"query","description":"One-based result page number.","required":false,"schema":{"type":"integer","format":"int32","default":1}},{"name":"pageSize","in":"query","description":"Maximum records returned per page; values above 100 are capped.","required":false,"schema":{"type":"integer","format":"int32","default":20}},{"name":"X-Timestamp","in":"header","description":"Current Unix epoch time in seconds. Requests older or newer than five minutes are rejected.","required":true,"schema":{"pattern":"[0-9]{10}","type":"string","example":"1787562000"}},{"name":"X-Request-ID","in":"header","description":"Unique 16-128 character request identifier used for replay protection; never reuse it for a different HTTP request.","required":true,"schema":{"pattern":"[A-Za-z0-9._:-]{16,128}","type":"string","example":"018f6f4e-8f62-7fc2-9c4b-7be2f4203b6a"}},{"name":"X-Content-SHA256","in":"header","description":"Lowercase hexadecimal SHA-256 digest of the exact raw request body; use the digest of zero bytes when no body is sent.","required":true,"schema":{"pattern":"[0-9a-f]{64}","type":"string","example":"e3b0c44298fc1c149afbf4c8996fb92427ae41e4649b934ca495991b7852b855"}},{"name":"X-Workspace","in":"header","description":"Enterprise reads are available on this route. For enterprise access, copy your own enterprise:<id> from GET /api/v1/workspaces. Required for v2 requests. V1 requests use the historical key's fixed enterprise.","required":false,"schema":{"pattern":"personal|enterprise:[1-9][0-9]*","type":"string","example":null}},{"name":"X-Environment","in":"header","description":"Required and signed for v2 requests: live or sandbox. Optional for v1 requests.","required":false,"schema":{"pattern":"live|sandbox","type":"string","example":"live"}},{"name":"X-Signature","in":"header","description":"Existing keys accept v1 for their fixed enterprise or v2 for a signed workspace; new keys accept v2 only.","required":true,"schema":{"pattern":"v[12]=[0-9a-f]{64}","type":"string","example":"v2=0123456789abcdef0123456789abcdef0123456789abcdef0123456789abcdef"}},{"name":"Accept-Language","in":"header","description":"Response language: en-US = English (default); zh-CN = Simplified Chinese; zh-TW = Traditional Chinese. Numeric error codes are language-neutral.","required":false,"schema":{"type":"string","enum":["en-US","zh-CN","zh-TW"],"default":"en-US"}}],"responses":{"400":{"description":"Malformed JSON, missing header or invalid request parameter","headers":{"X-Request-ID":{"description":"Request identifier echoed for support and reconciliation.","schema":{"type":"string"}}},"content":{"application/json":{"schema":{"$ref":"#/components/schemas/ApiResponseVoid"}}}},"500":{"description":"Unexpected internal error; contact support with X-Request-ID","headers":{"X-Request-ID":{"description":"Request identifier echoed for support and reconciliation.","schema":{"type":"string"}}},"content":{"application/json":{"schema":{"$ref":"#/components/schemas/ApiResponseVoid"}}}},"403":{"description":"API-key scope, subscription, tenant or policy does not allow the operation","headers":{"X-Request-ID":{"description":"Request identifier echoed for support and reconciliation.","schema":{"type":"string"}}},"content":{"application/json":{"schema":{"$ref":"#/components/schemas/ApiResponseVoid"}}}},"200":{"description":"OK","headers":{"X-Request-ID":{"description":"Request identifier echoed for support and reconciliation.","schema":{"type":"string"}},"X-Quota-Limit":{"description":"Monthly API request allowance for the subscription.","schema":{"type":"integer","format":"int64"}},"X-Quota-Remaining":{"description":"Requests remaining in the current monthly allowance after this request.","schema":{"type":"integer","format":"int64"}},"X-Quota-Reset":{"description":"Unix epoch time in seconds when the monthly allowance resets.","schema":{"type":"integer","format":"int64"}},"X-Quota-Workspace":{"description":"Verified workspace owning this allowance: personal or enterprise:<id>.","schema":{"type":"string"}},"X-Quota-Environment":{"description":"Environment owning the allowance: sandbox or live.","schema":{"type":"string"}}},"content":{"application/json":{"schema":{"$ref":"#/components/schemas/ApiResponsePageDataInvoiceResponse"}}}},"401":{"description":"Invalid API key, content hash, signature, timestamp or request ID","headers":{"X-Request-ID":{"description":"Request identifier echoed for support and reconciliation.","schema":{"type":"string"}}},"content":{"application/json":{"schema":{"$ref":"#/components/schemas/ApiResponseVoid"}}}},"404":{"description":"Resource not found in this enterprise and environment","headers":{"X-Request-ID":{"description":"Request identifier echoed for support and reconciliation.","schema":{"type":"string"}}},"content":{"application/json":{"schema":{"$ref":"#/components/schemas/ApiResponseVoid"}}}},"422":{"description":"Business rule rejected the request","headers":{"X-Request-ID":{"description":"Request identifier echoed for support and reconciliation.","schema":{"type":"string"}}},"content":{"application/json":{"schema":{"$ref":"#/components/schemas/ApiResponseVoid"}}}},"503":{"description":"A required platform service is temporarily unavailable","headers":{"X-Request-ID":{"description":"Request identifier echoed for support and reconciliation.","schema":{"type":"string"}}},"content":{"application/json":{"schema":{"$ref":"#/components/schemas/ApiResponseVoid"}}}},"409":{"description":"Idempotency or resource-state conflict","headers":{"X-Request-ID":{"description":"Request identifier echoed for support and reconciliation.","schema":{"type":"string"}}},"content":{"application/json":{"schema":{"$ref":"#/components/schemas/ApiResponseVoid"}}}},"429":{"description":"Per-minute rate limit or monthly quota exceeded","headers":{"X-Request-ID":{"description":"Request identifier echoed for support and reconciliation.","schema":{"type":"string"}},"X-Quota-Limit":{"description":"Monthly API request allowance for the subscription.","schema":{"type":"integer","format":"int64"}},"X-Quota-Remaining":{"description":"Requests remaining in the current monthly allowance after this request.","schema":{"type":"integer","format":"int64"}},"X-Quota-Reset":{"description":"Unix epoch time in seconds when the monthly allowance resets.","schema":{"type":"integer","format":"int64"}},"X-Quota-Workspace":{"description":"Verified workspace owning this allowance: personal or enterprise:<id>.","schema":{"type":"string"}},"X-Quota-Environment":{"description":"Environment owning the allowance: sandbox or live.","schema":{"type":"string"}},"Retry-After":{"description":"Seconds until the exhausted quota or rate window resets. Sign retries with a new X-Request-ID.","schema":{"type":"integer","format":"int64"}},"X-RateLimit-Scope":{"description":"Rate counter scope: workspace, or user for enterprise verification calls.","schema":{"type":"string"}},"X-RateLimit-Limit":{"description":"Per-minute request limit when rate-limited.","schema":{"type":"integer","format":"int64"}},"X-RateLimit-Remaining":{"description":"Zero when the minute limit is exhausted.","schema":{"type":"integer","format":"int64"}},"X-RateLimit-Reset":{"description":"Unix epoch seconds when the minute limit resets.","schema":{"type":"integer","format":"int64"}}},"content":{"application/json":{"schema":{"$ref":"#/components/schemas/ApiResponseVoid"}}}},"413":{"description":"Request body is too large","headers":{"X-Request-ID":{"description":"Request identifier echoed for support and reconciliation.","schema":{"type":"string"}}},"content":{"application/json":{"schema":{"$ref":"#/components/schemas/ApiResponseVoid"}}}}},"x-dcwallet-signature-versions":["v1","v2"]},"post":{"tags":["4. Receivables"],"summary":"Create a draft receivable","description":"contactId is optional. Without a contact, the receivable is a consumer checkout and uses a platform-routed collection address. /invoices remains a compatibility alias.\n\nSignature versions: v1 and v2.","operationId":"postReceivables","parameters":[{"name":"Idempotency-Key","in":"header","description":"Unique key for one mutating request. Reuse the same value only when retrying the same operation.","required":true,"schema":{"type":"string"}},{"name":"X-Timestamp","in":"header","description":"Current Unix epoch time in seconds. Requests older or newer than five minutes are rejected.","required":true,"schema":{"pattern":"[0-9]{10}","type":"string","example":"1787562000"}},{"name":"X-Request-ID","in":"header","description":"Unique 16-128 character request identifier used for replay protection; never reuse it for a different HTTP request.","required":true,"schema":{"pattern":"[A-Za-z0-9._:-]{16,128}","type":"string","example":"018f6f4e-8f62-7fc2-9c4b-7be2f4203b6a"}},{"name":"X-Content-SHA256","in":"header","description":"Lowercase hexadecimal SHA-256 digest of the exact raw request body; use the digest of zero bytes when no body is sent.","required":true,"schema":{"pattern":"[0-9a-f]{64}","type":"string","example":"e3b0c44298fc1c149afbf4c8996fb92427ae41e4649b934ca495991b7852b855"}},{"name":"X-Workspace","in":"header","description":"Enterprise writes are available on this route. For enterprise access, copy your own enterprise:<id> from GET /api/v1/workspaces. Required for v2 requests. V1 requests use the historical key's fixed enterprise.","required":false,"schema":{"pattern":"personal|enterprise:[1-9][0-9]*","type":"string","example":null}},{"name":"X-Environment","in":"header","description":"Required and signed for v2 requests: live or sandbox. Optional for v1 requests.","required":false,"schema":{"pattern":"live|sandbox","type":"string","example":"live"}},{"name":"X-Signature","in":"header","description":"Existing keys accept v1 for their fixed enterprise or v2 for a signed workspace; new keys accept v2 only.","required":true,"schema":{"pattern":"v[12]=[0-9a-f]{64}","type":"string","example":"v2=0123456789abcdef0123456789abcdef0123456789abcdef0123456789abcdef"}},{"name":"Accept-Language","in":"header","description":"Response language: en-US = English (default); zh-CN = Simplified Chinese; zh-TW = Traditional Chinese. Numeric error codes are language-neutral.","required":false,"schema":{"type":"string","enum":["en-US","zh-CN","zh-TW"],"default":"en-US"}}],"requestBody":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/InvoiceRequest"}}},"required":true},"responses":{"400":{"description":"Malformed JSON, missing header or invalid request parameter","headers":{"X-Request-ID":{"description":"Request identifier echoed for support and reconciliation.","schema":{"type":"string"}}},"content":{"application/json":{"schema":{"$ref":"#/components/schemas/ApiResponseVoid"}}}},"500":{"description":"Unexpected internal error; contact support with X-Request-ID","headers":{"X-Request-ID":{"description":"Request identifier echoed for support and reconciliation.","schema":{"type":"string"}}},"content":{"application/json":{"schema":{"$ref":"#/components/schemas/ApiResponseVoid"}}}},"403":{"description":"API-key scope, subscription, tenant or policy does not allow the operation","headers":{"X-Request-ID":{"description":"Request identifier echoed for support and reconciliation.","schema":{"type":"string"}}},"content":{"application/json":{"schema":{"$ref":"#/components/schemas/ApiResponseVoid"}}}},"200":{"description":"OK","headers":{"X-Request-ID":{"description":"Request identifier echoed for support and reconciliation.","schema":{"type":"string"}},"X-Quota-Limit":{"description":"Monthly API request allowance for the subscription.","schema":{"type":"integer","format":"int64"}},"X-Quota-Remaining":{"description":"Requests remaining in the current monthly allowance after this request.","schema":{"type":"integer","format":"int64"}},"X-Quota-Reset":{"description":"Unix epoch time in seconds when the monthly allowance resets.","schema":{"type":"integer","format":"int64"}},"X-Quota-Workspace":{"description":"Verified workspace owning this allowance: personal or enterprise:<id>.","schema":{"type":"string"}},"X-Quota-Environment":{"description":"Environment owning the allowance: sandbox or live.","schema":{"type":"string"}}},"content":{"application/json":{"schema":{"$ref":"#/components/schemas/ApiResponseInvoiceResponse"}}}},"401":{"description":"Invalid API key, content hash, signature, timestamp or request ID","headers":{"X-Request-ID":{"description":"Request identifier echoed for support and reconciliation.","schema":{"type":"string"}}},"content":{"application/json":{"schema":{"$ref":"#/components/schemas/ApiResponseVoid"}}}},"404":{"description":"Resource not found in this enterprise and environment","headers":{"X-Request-ID":{"description":"Request identifier echoed for support and reconciliation.","schema":{"type":"string"}}},"content":{"application/json":{"schema":{"$ref":"#/components/schemas/ApiResponseVoid"}}}},"422":{"description":"Business rule rejected the request","headers":{"X-Request-ID":{"description":"Request identifier echoed for support and reconciliation.","schema":{"type":"string"}}},"content":{"application/json":{"schema":{"$ref":"#/components/schemas/ApiResponseVoid"}}}},"503":{"description":"A required platform service is temporarily unavailable","headers":{"X-Request-ID":{"description":"Request identifier echoed for support and reconciliation.","schema":{"type":"string"}}},"content":{"application/json":{"schema":{"$ref":"#/components/schemas/ApiResponseVoid"}}}},"409":{"description":"Idempotency or resource-state conflict","headers":{"X-Request-ID":{"description":"Request identifier echoed for support and reconciliation.","schema":{"type":"string"}}},"content":{"application/json":{"schema":{"$ref":"#/components/schemas/ApiResponseVoid"}}}},"429":{"description":"Per-minute rate limit or monthly quota exceeded","headers":{"X-Request-ID":{"description":"Request identifier echoed for support and reconciliation.","schema":{"type":"string"}},"X-Quota-Limit":{"description":"Monthly API request allowance for the subscription.","schema":{"type":"integer","format":"int64"}},"X-Quota-Remaining":{"description":"Requests remaining in the current monthly allowance after this request.","schema":{"type":"integer","format":"int64"}},"X-Quota-Reset":{"description":"Unix epoch time in seconds when the monthly allowance resets.","schema":{"type":"integer","format":"int64"}},"X-Quota-Workspace":{"description":"Verified workspace owning this allowance: personal or enterprise:<id>.","schema":{"type":"string"}},"X-Quota-Environment":{"description":"Environment owning the allowance: sandbox or live.","schema":{"type":"string"}},"Retry-After":{"description":"Seconds until the exhausted quota or rate window resets. Sign retries with a new X-Request-ID.","schema":{"type":"integer","format":"int64"}},"X-RateLimit-Scope":{"description":"Rate counter scope: workspace, or user for enterprise verification calls.","schema":{"type":"string"}},"X-RateLimit-Limit":{"description":"Per-minute request limit when rate-limited.","schema":{"type":"integer","format":"int64"}},"X-RateLimit-Remaining":{"description":"Zero when the minute limit is exhausted.","schema":{"type":"integer","format":"int64"}},"X-RateLimit-Reset":{"description":"Unix epoch seconds when the minute limit resets.","schema":{"type":"integer","format":"int64"}}},"content":{"application/json":{"schema":{"$ref":"#/components/schemas/ApiResponseVoid"}}}},"413":{"description":"Request body is too large","headers":{"X-Request-ID":{"description":"Request identifier echoed for support and reconciliation.","schema":{"type":"string"}}},"content":{"application/json":{"schema":{"$ref":"#/components/schemas/ApiResponseVoid"}}}}},"x-dcwallet-signature-versions":["v1","v2"]}},"/api/v1/invoices":{"get":{"tags":["4. Receivables"],"summary":"List enterprise receivables","description":"Signature versions: v1 and v2.","operationId":"getInvoices","parameters":[{"name":"status","in":"query","description":"Optional filter. Invoice state: draft = editable (default on creation); sent = issued and awaiting payment; partial_paid = some amount received; fully_paid = target amount received; overpaid = amount exceeds target; overdue = unpaid after due date; cancelled = voided (terminal); refunded = collected funds returned (terminal). Paid states may later change after another payment or refund.","required":false,"schema":{"type":"string","enum":["draft","sent","partial_paid","fully_paid","overpaid","overdue","cancelled","refunded"]}},{"name":"page","in":"query","description":"One-based result page number.","required":false,"schema":{"type":"integer","format":"int32","default":1}},{"name":"pageSize","in":"query","description":"Maximum records returned per page; values above 100 are capped.","required":false,"schema":{"type":"integer","format":"int32","default":20}},{"name":"X-Timestamp","in":"header","description":"Current Unix epoch time in seconds. Requests older or newer than five minutes are rejected.","required":true,"schema":{"pattern":"[0-9]{10}","type":"string","example":"1787562000"}},{"name":"X-Request-ID","in":"header","description":"Unique 16-128 character request identifier used for replay protection; never reuse it for a different HTTP request.","required":true,"schema":{"pattern":"[A-Za-z0-9._:-]{16,128}","type":"string","example":"018f6f4e-8f62-7fc2-9c4b-7be2f4203b6a"}},{"name":"X-Content-SHA256","in":"header","description":"Lowercase hexadecimal SHA-256 digest of the exact raw request body; use the digest of zero bytes when no body is sent.","required":true,"schema":{"pattern":"[0-9a-f]{64}","type":"string","example":"e3b0c44298fc1c149afbf4c8996fb92427ae41e4649b934ca495991b7852b855"}},{"name":"X-Workspace","in":"header","description":"Enterprise reads are available on this route. For enterprise access, copy your own enterprise:<id> from GET /api/v1/workspaces. Required for v2 requests. V1 requests use the historical key's fixed enterprise.","required":false,"schema":{"pattern":"personal|enterprise:[1-9][0-9]*","type":"string","example":null}},{"name":"X-Environment","in":"header","description":"Required and signed for v2 requests: live or sandbox. Optional for v1 requests.","required":false,"schema":{"pattern":"live|sandbox","type":"string","example":"live"}},{"name":"X-Signature","in":"header","description":"Existing keys accept v1 for their fixed enterprise or v2 for a signed workspace; new keys accept v2 only.","required":true,"schema":{"pattern":"v[12]=[0-9a-f]{64}","type":"string","example":"v2=0123456789abcdef0123456789abcdef0123456789abcdef0123456789abcdef"}},{"name":"Accept-Language","in":"header","description":"Response language: en-US = English (default); zh-CN = Simplified Chinese; zh-TW = Traditional Chinese. Numeric error codes are language-neutral.","required":false,"schema":{"type":"string","enum":["en-US","zh-CN","zh-TW"],"default":"en-US"}}],"responses":{"400":{"description":"Malformed JSON, missing header or invalid request parameter","headers":{"X-Request-ID":{"description":"Request identifier echoed for support and reconciliation.","schema":{"type":"string"}}},"content":{"application/json":{"schema":{"$ref":"#/components/schemas/ApiResponseVoid"}}}},"500":{"description":"Unexpected internal error; contact support with X-Request-ID","headers":{"X-Request-ID":{"description":"Request identifier echoed for support and reconciliation.","schema":{"type":"string"}}},"content":{"application/json":{"schema":{"$ref":"#/components/schemas/ApiResponseVoid"}}}},"403":{"description":"API-key scope, subscription, tenant or policy does not allow the operation","headers":{"X-Request-ID":{"description":"Request identifier echoed for support and reconciliation.","schema":{"type":"string"}}},"content":{"application/json":{"schema":{"$ref":"#/components/schemas/ApiResponseVoid"}}}},"200":{"description":"OK","headers":{"X-Request-ID":{"description":"Request identifier echoed for support and reconciliation.","schema":{"type":"string"}},"X-Quota-Limit":{"description":"Monthly API request allowance for the subscription.","schema":{"type":"integer","format":"int64"}},"X-Quota-Remaining":{"description":"Requests remaining in the current monthly allowance after this request.","schema":{"type":"integer","format":"int64"}},"X-Quota-Reset":{"description":"Unix epoch time in seconds when the monthly allowance resets.","schema":{"type":"integer","format":"int64"}},"X-Quota-Workspace":{"description":"Verified workspace owning this allowance: personal or enterprise:<id>.","schema":{"type":"string"}},"X-Quota-Environment":{"description":"Environment owning the allowance: sandbox or live.","schema":{"type":"string"}}},"content":{"application/json":{"schema":{"$ref":"#/components/schemas/ApiResponsePageDataInvoiceResponse"}}}},"401":{"description":"Invalid API key, content hash, signature, timestamp or request ID","headers":{"X-Request-ID":{"description":"Request identifier echoed for support and reconciliation.","schema":{"type":"string"}}},"content":{"application/json":{"schema":{"$ref":"#/components/schemas/ApiResponseVoid"}}}},"404":{"description":"Resource not found in this enterprise and environment","headers":{"X-Request-ID":{"description":"Request identifier echoed for support and reconciliation.","schema":{"type":"string"}}},"content":{"application/json":{"schema":{"$ref":"#/components/schemas/ApiResponseVoid"}}}},"422":{"description":"Business rule rejected the request","headers":{"X-Request-ID":{"description":"Request identifier echoed for support and reconciliation.","schema":{"type":"string"}}},"content":{"application/json":{"schema":{"$ref":"#/components/schemas/ApiResponseVoid"}}}},"503":{"description":"A required platform service is temporarily unavailable","headers":{"X-Request-ID":{"description":"Request identifier echoed for support and reconciliation.","schema":{"type":"string"}}},"content":{"application/json":{"schema":{"$ref":"#/components/schemas/ApiResponseVoid"}}}},"409":{"description":"Idempotency or resource-state conflict","headers":{"X-Request-ID":{"description":"Request identifier echoed for support and reconciliation.","schema":{"type":"string"}}},"content":{"application/json":{"schema":{"$ref":"#/components/schemas/ApiResponseVoid"}}}},"429":{"description":"Per-minute rate limit or monthly quota exceeded","headers":{"X-Request-ID":{"description":"Request identifier echoed for support and reconciliation.","schema":{"type":"string"}},"X-Quota-Limit":{"description":"Monthly API request allowance for the subscription.","schema":{"type":"integer","format":"int64"}},"X-Quota-Remaining":{"description":"Requests remaining in the current monthly allowance after this request.","schema":{"type":"integer","format":"int64"}},"X-Quota-Reset":{"description":"Unix epoch time in seconds when the monthly allowance resets.","schema":{"type":"integer","format":"int64"}},"X-Quota-Workspace":{"description":"Verified workspace owning this allowance: personal or enterprise:<id>.","schema":{"type":"string"}},"X-Quota-Environment":{"description":"Environment owning the allowance: sandbox or live.","schema":{"type":"string"}},"Retry-After":{"description":"Seconds until the exhausted quota or rate window resets. Sign retries with a new X-Request-ID.","schema":{"type":"integer","format":"int64"}},"X-RateLimit-Scope":{"description":"Rate counter scope: workspace, or user for enterprise verification calls.","schema":{"type":"string"}},"X-RateLimit-Limit":{"description":"Per-minute request limit when rate-limited.","schema":{"type":"integer","format":"int64"}},"X-RateLimit-Remaining":{"description":"Zero when the minute limit is exhausted.","schema":{"type":"integer","format":"int64"}},"X-RateLimit-Reset":{"description":"Unix epoch seconds when the minute limit resets.","schema":{"type":"integer","format":"int64"}}},"content":{"application/json":{"schema":{"$ref":"#/components/schemas/ApiResponseVoid"}}}},"413":{"description":"Request body is too large","headers":{"X-Request-ID":{"description":"Request identifier echoed for support and reconciliation.","schema":{"type":"string"}}},"content":{"application/json":{"schema":{"$ref":"#/components/schemas/ApiResponseVoid"}}}}},"x-dcwallet-signature-versions":["v1","v2"]},"post":{"tags":["4. Receivables"],"summary":"Create a draft receivable","description":"contactId is optional. Without a contact, the receivable is a consumer checkout and uses a platform-routed collection address. /invoices remains a compatibility alias.\n\nSignature versions: v1 and v2.","operationId":"postInvoices","parameters":[{"name":"Idempotency-Key","in":"header","description":"Unique key for one mutating request. Reuse the same value only when retrying the same operation.","required":true,"schema":{"type":"string"}},{"name":"X-Timestamp","in":"header","description":"Current Unix epoch time in seconds. Requests older or newer than five minutes are rejected.","required":true,"schema":{"pattern":"[0-9]{10}","type":"string","example":"1787562000"}},{"name":"X-Request-ID","in":"header","description":"Unique 16-128 character request identifier used for replay protection; never reuse it for a different HTTP request.","required":true,"schema":{"pattern":"[A-Za-z0-9._:-]{16,128}","type":"string","example":"018f6f4e-8f62-7fc2-9c4b-7be2f4203b6a"}},{"name":"X-Content-SHA256","in":"header","description":"Lowercase hexadecimal SHA-256 digest of the exact raw request body; use the digest of zero bytes when no body is sent.","required":true,"schema":{"pattern":"[0-9a-f]{64}","type":"string","example":"e3b0c44298fc1c149afbf4c8996fb92427ae41e4649b934ca495991b7852b855"}},{"name":"X-Workspace","in":"header","description":"Enterprise writes are available on this route. For enterprise access, copy your own enterprise:<id> from GET /api/v1/workspaces. Required for v2 requests. V1 requests use the historical key's fixed enterprise.","required":false,"schema":{"pattern":"personal|enterprise:[1-9][0-9]*","type":"string","example":null}},{"name":"X-Environment","in":"header","description":"Required and signed for v2 requests: live or sandbox. Optional for v1 requests.","required":false,"schema":{"pattern":"live|sandbox","type":"string","example":"live"}},{"name":"X-Signature","in":"header","description":"Existing keys accept v1 for their fixed enterprise or v2 for a signed workspace; new keys accept v2 only.","required":true,"schema":{"pattern":"v[12]=[0-9a-f]{64}","type":"string","example":"v2=0123456789abcdef0123456789abcdef0123456789abcdef0123456789abcdef"}},{"name":"Accept-Language","in":"header","description":"Response language: en-US = English (default); zh-CN = Simplified Chinese; zh-TW = Traditional Chinese. Numeric error codes are language-neutral.","required":false,"schema":{"type":"string","enum":["en-US","zh-CN","zh-TW"],"default":"en-US"}}],"requestBody":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/InvoiceRequest"}}},"required":true},"responses":{"400":{"description":"Malformed JSON, missing header or invalid request parameter","headers":{"X-Request-ID":{"description":"Request identifier echoed for support and reconciliation.","schema":{"type":"string"}}},"content":{"application/json":{"schema":{"$ref":"#/components/schemas/ApiResponseVoid"}}}},"500":{"description":"Unexpected internal error; contact support with X-Request-ID","headers":{"X-Request-ID":{"description":"Request identifier echoed for support and reconciliation.","schema":{"type":"string"}}},"content":{"application/json":{"schema":{"$ref":"#/components/schemas/ApiResponseVoid"}}}},"403":{"description":"API-key scope, subscription, tenant or policy does not allow the operation","headers":{"X-Request-ID":{"description":"Request identifier echoed for support and reconciliation.","schema":{"type":"string"}}},"content":{"application/json":{"schema":{"$ref":"#/components/schemas/ApiResponseVoid"}}}},"200":{"description":"OK","headers":{"X-Request-ID":{"description":"Request identifier echoed for support and reconciliation.","schema":{"type":"string"}},"X-Quota-Limit":{"description":"Monthly API request allowance for the subscription.","schema":{"type":"integer","format":"int64"}},"X-Quota-Remaining":{"description":"Requests remaining in the current monthly allowance after this request.","schema":{"type":"integer","format":"int64"}},"X-Quota-Reset":{"description":"Unix epoch time in seconds when the monthly allowance resets.","schema":{"type":"integer","format":"int64"}},"X-Quota-Workspace":{"description":"Verified workspace owning this allowance: personal or enterprise:<id>.","schema":{"type":"string"}},"X-Quota-Environment":{"description":"Environment owning the allowance: sandbox or live.","schema":{"type":"string"}}},"content":{"application/json":{"schema":{"$ref":"#/components/schemas/ApiResponseInvoiceResponse"}}}},"401":{"description":"Invalid API key, content hash, signature, timestamp or request ID","headers":{"X-Request-ID":{"description":"Request identifier echoed for support and reconciliation.","schema":{"type":"string"}}},"content":{"application/json":{"schema":{"$ref":"#/components/schemas/ApiResponseVoid"}}}},"404":{"description":"Resource not found in this enterprise and environment","headers":{"X-Request-ID":{"description":"Request identifier echoed for support and reconciliation.","schema":{"type":"string"}}},"content":{"application/json":{"schema":{"$ref":"#/components/schemas/ApiResponseVoid"}}}},"422":{"description":"Business rule rejected the request","headers":{"X-Request-ID":{"description":"Request identifier echoed for support and reconciliation.","schema":{"type":"string"}}},"content":{"application/json":{"schema":{"$ref":"#/components/schemas/ApiResponseVoid"}}}},"503":{"description":"A required platform service is temporarily unavailable","headers":{"X-Request-ID":{"description":"Request identifier echoed for support and reconciliation.","schema":{"type":"string"}}},"content":{"application/json":{"schema":{"$ref":"#/components/schemas/ApiResponseVoid"}}}},"409":{"description":"Idempotency or resource-state conflict","headers":{"X-Request-ID":{"description":"Request identifier echoed for support and reconciliation.","schema":{"type":"string"}}},"content":{"application/json":{"schema":{"$ref":"#/components/schemas/ApiResponseVoid"}}}},"429":{"description":"Per-minute rate limit or monthly quota exceeded","headers":{"X-Request-ID":{"description":"Request identifier echoed for support and reconciliation.","schema":{"type":"string"}},"X-Quota-Limit":{"description":"Monthly API request allowance for the subscription.","schema":{"type":"integer","format":"int64"}},"X-Quota-Remaining":{"description":"Requests remaining in the current monthly allowance after this request.","schema":{"type":"integer","format":"int64"}},"X-Quota-Reset":{"description":"Unix epoch time in seconds when the monthly allowance resets.","schema":{"type":"integer","format":"int64"}},"X-Quota-Workspace":{"description":"Verified workspace owning this allowance: personal or enterprise:<id>.","schema":{"type":"string"}},"X-Quota-Environment":{"description":"Environment owning the allowance: sandbox or live.","schema":{"type":"string"}},"Retry-After":{"description":"Seconds until the exhausted quota or rate window resets. Sign retries with a new X-Request-ID.","schema":{"type":"integer","format":"int64"}},"X-RateLimit-Scope":{"description":"Rate counter scope: workspace, or user for enterprise verification calls.","schema":{"type":"string"}},"X-RateLimit-Limit":{"description":"Per-minute request limit when rate-limited.","schema":{"type":"integer","format":"int64"}},"X-RateLimit-Remaining":{"description":"Zero when the minute limit is exhausted.","schema":{"type":"integer","format":"int64"}},"X-RateLimit-Reset":{"description":"Unix epoch seconds when the minute limit resets.","schema":{"type":"integer","format":"int64"}}},"content":{"application/json":{"schema":{"$ref":"#/components/schemas/ApiResponseVoid"}}}},"413":{"description":"Request body is too large","headers":{"X-Request-ID":{"description":"Request identifier echoed for support and reconciliation.","schema":{"type":"string"}}},"content":{"application/json":{"schema":{"$ref":"#/components/schemas/ApiResponseVoid"}}}}},"x-dcwallet-signature-versions":["v1","v2"]}},"/api/v1/payment-links":{"get":{"tags":["4. Receivables"],"summary":"List enterprise payment links","description":"Signature versions: v1 and v2.","operationId":"getPaymentLinks","parameters":[{"name":"status","in":"query","description":"Optional filter. Payment-link state: active = accepts payment (default on creation); paid = target payment completed (terminal for this link); expired = expiry reached (terminal); cancelled = disabled by owner (terminal).","required":false,"schema":{"type":"string","enum":["active","paid","cancelled","expired"]}},{"name":"page","in":"query","description":"One-based result page number.","required":false,"schema":{"type":"integer","format":"int32","default":1}},{"name":"pageSize","in":"query","description":"Maximum records returned per page; values above 100 are capped.","required":false,"schema":{"type":"integer","format":"int32","default":20}},{"name":"X-Timestamp","in":"header","description":"Current Unix epoch time in seconds. Requests older or newer than five minutes are rejected.","required":true,"schema":{"pattern":"[0-9]{10}","type":"string","example":"1787562000"}},{"name":"X-Request-ID","in":"header","description":"Unique 16-128 character request identifier used for replay protection; never reuse it for a different HTTP request.","required":true,"schema":{"pattern":"[A-Za-z0-9._:-]{16,128}","type":"string","example":"018f6f4e-8f62-7fc2-9c4b-7be2f4203b6a"}},{"name":"X-Content-SHA256","in":"header","description":"Lowercase hexadecimal SHA-256 digest of the exact raw request body; use the digest of zero bytes when no body is sent.","required":true,"schema":{"pattern":"[0-9a-f]{64}","type":"string","example":"e3b0c44298fc1c149afbf4c8996fb92427ae41e4649b934ca495991b7852b855"}},{"name":"X-Workspace","in":"header","description":"Enterprise reads are available on this route. For enterprise access, copy your own enterprise:<id> from GET /api/v1/workspaces. Required for v2 requests. V1 requests use the historical key's fixed enterprise.","required":false,"schema":{"pattern":"personal|enterprise:[1-9][0-9]*","type":"string","example":null}},{"name":"X-Environment","in":"header","description":"Required and signed for v2 requests: live or sandbox. Optional for v1 requests.","required":false,"schema":{"pattern":"live|sandbox","type":"string","example":"live"}},{"name":"X-Signature","in":"header","description":"Existing keys accept v1 for their fixed enterprise or v2 for a signed workspace; new keys accept v2 only.","required":true,"schema":{"pattern":"v[12]=[0-9a-f]{64}","type":"string","example":"v2=0123456789abcdef0123456789abcdef0123456789abcdef0123456789abcdef"}},{"name":"Accept-Language","in":"header","description":"Response language: en-US = English (default); zh-CN = Simplified Chinese; zh-TW = Traditional Chinese. Numeric error codes are language-neutral.","required":false,"schema":{"type":"string","enum":["en-US","zh-CN","zh-TW"],"default":"en-US"}}],"responses":{"400":{"description":"Malformed JSON, missing header or invalid request parameter","headers":{"X-Request-ID":{"description":"Request identifier echoed for support and reconciliation.","schema":{"type":"string"}}},"content":{"application/json":{"schema":{"$ref":"#/components/schemas/ApiResponseVoid"}}}},"500":{"description":"Unexpected internal error; contact support with X-Request-ID","headers":{"X-Request-ID":{"description":"Request identifier echoed for support and reconciliation.","schema":{"type":"string"}}},"content":{"application/json":{"schema":{"$ref":"#/components/schemas/ApiResponseVoid"}}}},"403":{"description":"API-key scope, subscription, tenant or policy does not allow the operation","headers":{"X-Request-ID":{"description":"Request identifier echoed for support and reconciliation.","schema":{"type":"string"}}},"content":{"application/json":{"schema":{"$ref":"#/components/schemas/ApiResponseVoid"}}}},"200":{"description":"OK","headers":{"X-Request-ID":{"description":"Request identifier echoed for support and reconciliation.","schema":{"type":"string"}},"X-Quota-Limit":{"description":"Monthly API request allowance for the subscription.","schema":{"type":"integer","format":"int64"}},"X-Quota-Remaining":{"description":"Requests remaining in the current monthly allowance after this request.","schema":{"type":"integer","format":"int64"}},"X-Quota-Reset":{"description":"Unix epoch time in seconds when the monthly allowance resets.","schema":{"type":"integer","format":"int64"}},"X-Quota-Workspace":{"description":"Verified workspace owning this allowance: personal or enterprise:<id>.","schema":{"type":"string"}},"X-Quota-Environment":{"description":"Environment owning the allowance: sandbox or live.","schema":{"type":"string"}}},"content":{"application/json":{"schema":{"$ref":"#/components/schemas/ApiResponsePageDataPaymentLinkResponse"}}}},"401":{"description":"Invalid API key, content hash, signature, timestamp or request ID","headers":{"X-Request-ID":{"description":"Request identifier echoed for support and reconciliation.","schema":{"type":"string"}}},"content":{"application/json":{"schema":{"$ref":"#/components/schemas/ApiResponseVoid"}}}},"404":{"description":"Resource not found in this enterprise and environment","headers":{"X-Request-ID":{"description":"Request identifier echoed for support and reconciliation.","schema":{"type":"string"}}},"content":{"application/json":{"schema":{"$ref":"#/components/schemas/ApiResponseVoid"}}}},"422":{"description":"Business rule rejected the request","headers":{"X-Request-ID":{"description":"Request identifier echoed for support and reconciliation.","schema":{"type":"string"}}},"content":{"application/json":{"schema":{"$ref":"#/components/schemas/ApiResponseVoid"}}}},"503":{"description":"A required platform service is temporarily unavailable","headers":{"X-Request-ID":{"description":"Request identifier echoed for support and reconciliation.","schema":{"type":"string"}}},"content":{"application/json":{"schema":{"$ref":"#/components/schemas/ApiResponseVoid"}}}},"409":{"description":"Idempotency or resource-state conflict","headers":{"X-Request-ID":{"description":"Request identifier echoed for support and reconciliation.","schema":{"type":"string"}}},"content":{"application/json":{"schema":{"$ref":"#/components/schemas/ApiResponseVoid"}}}},"429":{"description":"Per-minute rate limit or monthly quota exceeded","headers":{"X-Request-ID":{"description":"Request identifier echoed for support and reconciliation.","schema":{"type":"string"}},"X-Quota-Limit":{"description":"Monthly API request allowance for the subscription.","schema":{"type":"integer","format":"int64"}},"X-Quota-Remaining":{"description":"Requests remaining in the current monthly allowance after this request.","schema":{"type":"integer","format":"int64"}},"X-Quota-Reset":{"description":"Unix epoch time in seconds when the monthly allowance resets.","schema":{"type":"integer","format":"int64"}},"X-Quota-Workspace":{"description":"Verified workspace owning this allowance: personal or enterprise:<id>.","schema":{"type":"string"}},"X-Quota-Environment":{"description":"Environment owning the allowance: sandbox or live.","schema":{"type":"string"}},"Retry-After":{"description":"Seconds until the exhausted quota or rate window resets. Sign retries with a new X-Request-ID.","schema":{"type":"integer","format":"int64"}},"X-RateLimit-Scope":{"description":"Rate counter scope: workspace, or user for enterprise verification calls.","schema":{"type":"string"}},"X-RateLimit-Limit":{"description":"Per-minute request limit when rate-limited.","schema":{"type":"integer","format":"int64"}},"X-RateLimit-Remaining":{"description":"Zero when the minute limit is exhausted.","schema":{"type":"integer","format":"int64"}},"X-RateLimit-Reset":{"description":"Unix epoch seconds when the minute limit resets.","schema":{"type":"integer","format":"int64"}}},"content":{"application/json":{"schema":{"$ref":"#/components/schemas/ApiResponseVoid"}}}},"413":{"description":"Request body is too large","headers":{"X-Request-ID":{"description":"Request identifier echoed for support and reconciliation.","schema":{"type":"string"}}},"content":{"application/json":{"schema":{"$ref":"#/components/schemas/ApiResponseVoid"}}}}},"x-dcwallet-signature-versions":["v1","v2"]},"post":{"tags":["4. Receivables"],"summary":"Create a standalone or invoice-backed payment link","description":"Provide invoiceId, or provide currency and amount for a standalone link. Reuse the same Idempotency-Key when retrying the same request.\n\nSignature versions: v1 and v2.","operationId":"postPaymentLinks","parameters":[{"name":"Idempotency-Key","in":"header","description":"Unique key for one mutating request. Reuse the same value only when retrying the same operation.","required":true,"schema":{"type":"string"}},{"name":"X-Timestamp","in":"header","description":"Current Unix epoch time in seconds. Requests older or newer than five minutes are rejected.","required":true,"schema":{"pattern":"[0-9]{10}","type":"string","example":"1787562000"}},{"name":"X-Request-ID","in":"header","description":"Unique 16-128 character request identifier used for replay protection; never reuse it for a different HTTP request.","required":true,"schema":{"pattern":"[A-Za-z0-9._:-]{16,128}","type":"string","example":"018f6f4e-8f62-7fc2-9c4b-7be2f4203b6a"}},{"name":"X-Content-SHA256","in":"header","description":"Lowercase hexadecimal SHA-256 digest of the exact raw request body; use the digest of zero bytes when no body is sent.","required":true,"schema":{"pattern":"[0-9a-f]{64}","type":"string","example":"e3b0c44298fc1c149afbf4c8996fb92427ae41e4649b934ca495991b7852b855"}},{"name":"X-Workspace","in":"header","description":"Enterprise writes are available on this route. For enterprise access, copy your own enterprise:<id> from GET /api/v1/workspaces. Required for v2 requests. V1 requests use the historical key's fixed enterprise.","required":false,"schema":{"pattern":"personal|enterprise:[1-9][0-9]*","type":"string","example":null}},{"name":"X-Environment","in":"header","description":"Required and signed for v2 requests: live or sandbox. Optional for v1 requests.","required":false,"schema":{"pattern":"live|sandbox","type":"string","example":"live"}},{"name":"X-Signature","in":"header","description":"Existing keys accept v1 for their fixed enterprise or v2 for a signed workspace; new keys accept v2 only.","required":true,"schema":{"pattern":"v[12]=[0-9a-f]{64}","type":"string","example":"v2=0123456789abcdef0123456789abcdef0123456789abcdef0123456789abcdef"}},{"name":"Accept-Language","in":"header","description":"Response language: en-US = English (default); zh-CN = Simplified Chinese; zh-TW = Traditional Chinese. Numeric error codes are language-neutral.","required":false,"schema":{"type":"string","enum":["en-US","zh-CN","zh-TW"],"default":"en-US"}}],"requestBody":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/PaymentLinkRequest"}}},"required":true},"responses":{"400":{"description":"Malformed JSON, missing header or invalid request parameter","headers":{"X-Request-ID":{"description":"Request identifier echoed for support and reconciliation.","schema":{"type":"string"}}},"content":{"application/json":{"schema":{"$ref":"#/components/schemas/ApiResponseVoid"}}}},"500":{"description":"Unexpected internal error; contact support with X-Request-ID","headers":{"X-Request-ID":{"description":"Request identifier echoed for support and reconciliation.","schema":{"type":"string"}}},"content":{"application/json":{"schema":{"$ref":"#/components/schemas/ApiResponseVoid"}}}},"403":{"description":"API-key scope, subscription, tenant or policy does not allow the operation","headers":{"X-Request-ID":{"description":"Request identifier echoed for support and reconciliation.","schema":{"type":"string"}}},"content":{"application/json":{"schema":{"$ref":"#/components/schemas/ApiResponseVoid"}}}},"200":{"description":"OK","headers":{"X-Request-ID":{"description":"Request identifier echoed for support and reconciliation.","schema":{"type":"string"}},"X-Quota-Limit":{"description":"Monthly API request allowance for the subscription.","schema":{"type":"integer","format":"int64"}},"X-Quota-Remaining":{"description":"Requests remaining in the current monthly allowance after this request.","schema":{"type":"integer","format":"int64"}},"X-Quota-Reset":{"description":"Unix epoch time in seconds when the monthly allowance resets.","schema":{"type":"integer","format":"int64"}},"X-Quota-Workspace":{"description":"Verified workspace owning this allowance: personal or enterprise:<id>.","schema":{"type":"string"}},"X-Quota-Environment":{"description":"Environment owning the allowance: sandbox or live.","schema":{"type":"string"}}},"content":{"application/json":{"schema":{"$ref":"#/components/schemas/ApiResponsePaymentLinkResponse"}}}},"401":{"description":"Invalid API key, content hash, signature, timestamp or request ID","headers":{"X-Request-ID":{"description":"Request identifier echoed for support and reconciliation.","schema":{"type":"string"}}},"content":{"application/json":{"schema":{"$ref":"#/components/schemas/ApiResponseVoid"}}}},"404":{"description":"Resource not found in this enterprise and environment","headers":{"X-Request-ID":{"description":"Request identifier echoed for support and reconciliation.","schema":{"type":"string"}}},"content":{"application/json":{"schema":{"$ref":"#/components/schemas/ApiResponseVoid"}}}},"422":{"description":"Business rule rejected the request","headers":{"X-Request-ID":{"description":"Request identifier echoed for support and reconciliation.","schema":{"type":"string"}}},"content":{"application/json":{"schema":{"$ref":"#/components/schemas/ApiResponseVoid"}}}},"503":{"description":"A required platform service is temporarily unavailable","headers":{"X-Request-ID":{"description":"Request identifier echoed for support and reconciliation.","schema":{"type":"string"}}},"content":{"application/json":{"schema":{"$ref":"#/components/schemas/ApiResponseVoid"}}}},"409":{"description":"Idempotency or resource-state conflict","headers":{"X-Request-ID":{"description":"Request identifier echoed for support and reconciliation.","schema":{"type":"string"}}},"content":{"application/json":{"schema":{"$ref":"#/components/schemas/ApiResponseVoid"}}}},"429":{"description":"Per-minute rate limit or monthly quota exceeded","headers":{"X-Request-ID":{"description":"Request identifier echoed for support and reconciliation.","schema":{"type":"string"}},"X-Quota-Limit":{"description":"Monthly API request allowance for the subscription.","schema":{"type":"integer","format":"int64"}},"X-Quota-Remaining":{"description":"Requests remaining in the current monthly allowance after this request.","schema":{"type":"integer","format":"int64"}},"X-Quota-Reset":{"description":"Unix epoch time in seconds when the monthly allowance resets.","schema":{"type":"integer","format":"int64"}},"X-Quota-Workspace":{"description":"Verified workspace owning this allowance: personal or enterprise:<id>.","schema":{"type":"string"}},"X-Quota-Environment":{"description":"Environment owning the allowance: sandbox or live.","schema":{"type":"string"}},"Retry-After":{"description":"Seconds until the exhausted quota or rate window resets. Sign retries with a new X-Request-ID.","schema":{"type":"integer","format":"int64"}},"X-RateLimit-Scope":{"description":"Rate counter scope: workspace, or user for enterprise verification calls.","schema":{"type":"string"}},"X-RateLimit-Limit":{"description":"Per-minute request limit when rate-limited.","schema":{"type":"integer","format":"int64"}},"X-RateLimit-Remaining":{"description":"Zero when the minute limit is exhausted.","schema":{"type":"integer","format":"int64"}},"X-RateLimit-Reset":{"description":"Unix epoch seconds when the minute limit resets.","schema":{"type":"integer","format":"int64"}}},"content":{"application/json":{"schema":{"$ref":"#/components/schemas/ApiResponseVoid"}}}},"413":{"description":"Request body is too large","headers":{"X-Request-ID":{"description":"Request identifier echoed for support and reconciliation.","schema":{"type":"string"}}},"content":{"application/json":{"schema":{"$ref":"#/components/schemas/ApiResponseVoid"}}}}},"x-dcwallet-signature-versions":["v1","v2"]}},"/api/v1/payment-links/{linkId}/deactivate":{"post":{"tags":["4. Receivables"],"summary":"Deactivate an enterprise payment link","description":"Signature versions: v1 and v2.","operationId":"postPaymentLinksByLinkIdDeactivate","parameters":[{"name":"linkId","in":"path","description":"Payment-link ID returned by /api/v1/payment-links. Keep IDs as strings.","required":true,"schema":{"pattern":"[0-9]+","type":"string","example":"337893979704000512"}},{"name":"X-Timestamp","in":"header","description":"Current Unix epoch time in seconds. Requests older or newer than five minutes are rejected.","required":true,"schema":{"pattern":"[0-9]{10}","type":"string","example":"1787562000"}},{"name":"X-Request-ID","in":"header","description":"Unique 16-128 character request identifier used for replay protection; never reuse it for a different HTTP request.","required":true,"schema":{"pattern":"[A-Za-z0-9._:-]{16,128}","type":"string","example":"018f6f4e-8f62-7fc2-9c4b-7be2f4203b6a"}},{"name":"X-Content-SHA256","in":"header","description":"Lowercase hexadecimal SHA-256 digest of the exact raw request body; use the digest of zero bytes when no body is sent.","required":true,"schema":{"pattern":"[0-9a-f]{64}","type":"string","example":"e3b0c44298fc1c149afbf4c8996fb92427ae41e4649b934ca495991b7852b855"}},{"name":"X-Workspace","in":"header","description":"Enterprise writes are available on this route. For enterprise access, copy your own enterprise:<id> from GET /api/v1/workspaces. Required for v2 requests. V1 requests use the historical key's fixed enterprise.","required":false,"schema":{"pattern":"personal|enterprise:[1-9][0-9]*","type":"string","example":null}},{"name":"X-Environment","in":"header","description":"Required and signed for v2 requests: live or sandbox. Optional for v1 requests.","required":false,"schema":{"pattern":"live|sandbox","type":"string","example":"live"}},{"name":"X-Signature","in":"header","description":"Existing keys accept v1 for their fixed enterprise or v2 for a signed workspace; new keys accept v2 only.","required":true,"schema":{"pattern":"v[12]=[0-9a-f]{64}","type":"string","example":"v2=0123456789abcdef0123456789abcdef0123456789abcdef0123456789abcdef"}},{"name":"Accept-Language","in":"header","description":"Response language: en-US = English (default); zh-CN = Simplified Chinese; zh-TW = Traditional Chinese. Numeric error codes are language-neutral.","required":false,"schema":{"type":"string","enum":["en-US","zh-CN","zh-TW"],"default":"en-US"}}],"responses":{"400":{"description":"Malformed JSON, missing header or invalid request parameter","headers":{"X-Request-ID":{"description":"Request identifier echoed for support and reconciliation.","schema":{"type":"string"}}},"content":{"application/json":{"schema":{"$ref":"#/components/schemas/ApiResponseVoid"}}}},"500":{"description":"Unexpected internal error; contact support with X-Request-ID","headers":{"X-Request-ID":{"description":"Request identifier echoed for support and reconciliation.","schema":{"type":"string"}}},"content":{"application/json":{"schema":{"$ref":"#/components/schemas/ApiResponseVoid"}}}},"403":{"description":"API-key scope, subscription, tenant or policy does not allow the operation","headers":{"X-Request-ID":{"description":"Request identifier echoed for support and reconciliation.","schema":{"type":"string"}}},"content":{"application/json":{"schema":{"$ref":"#/components/schemas/ApiResponseVoid"}}}},"200":{"description":"OK","headers":{"X-Request-ID":{"description":"Request identifier echoed for support and reconciliation.","schema":{"type":"string"}},"X-Quota-Limit":{"description":"Monthly API request allowance for the subscription.","schema":{"type":"integer","format":"int64"}},"X-Quota-Remaining":{"description":"Requests remaining in the current monthly allowance after this request.","schema":{"type":"integer","format":"int64"}},"X-Quota-Reset":{"description":"Unix epoch time in seconds when the monthly allowance resets.","schema":{"type":"integer","format":"int64"}},"X-Quota-Workspace":{"description":"Verified workspace owning this allowance: personal or enterprise:<id>.","schema":{"type":"string"}},"X-Quota-Environment":{"description":"Environment owning the allowance: sandbox or live.","schema":{"type":"string"}}},"content":{"application/json":{"schema":{"$ref":"#/components/schemas/ApiResponsePaymentLinkResponse"}}}},"401":{"description":"Invalid API key, content hash, signature, timestamp or request ID","headers":{"X-Request-ID":{"description":"Request identifier echoed for support and reconciliation.","schema":{"type":"string"}}},"content":{"application/json":{"schema":{"$ref":"#/components/schemas/ApiResponseVoid"}}}},"404":{"description":"Resource not found in this enterprise and environment","headers":{"X-Request-ID":{"description":"Request identifier echoed for support and reconciliation.","schema":{"type":"string"}}},"content":{"application/json":{"schema":{"$ref":"#/components/schemas/ApiResponseVoid"}}}},"422":{"description":"Business rule rejected the request","headers":{"X-Request-ID":{"description":"Request identifier echoed for support and reconciliation.","schema":{"type":"string"}}},"content":{"application/json":{"schema":{"$ref":"#/components/schemas/ApiResponseVoid"}}}},"503":{"description":"A required platform service is temporarily unavailable","headers":{"X-Request-ID":{"description":"Request identifier echoed for support and reconciliation.","schema":{"type":"string"}}},"content":{"application/json":{"schema":{"$ref":"#/components/schemas/ApiResponseVoid"}}}},"409":{"description":"Idempotency or resource-state conflict","headers":{"X-Request-ID":{"description":"Request identifier echoed for support and reconciliation.","schema":{"type":"string"}}},"content":{"application/json":{"schema":{"$ref":"#/components/schemas/ApiResponseVoid"}}}},"429":{"description":"Per-minute rate limit or monthly quota exceeded","headers":{"X-Request-ID":{"description":"Request identifier echoed for support and reconciliation.","schema":{"type":"string"}},"X-Quota-Limit":{"description":"Monthly API request allowance for the subscription.","schema":{"type":"integer","format":"int64"}},"X-Quota-Remaining":{"description":"Requests remaining in the current monthly allowance after this request.","schema":{"type":"integer","format":"int64"}},"X-Quota-Reset":{"description":"Unix epoch time in seconds when the monthly allowance resets.","schema":{"type":"integer","format":"int64"}},"X-Quota-Workspace":{"description":"Verified workspace owning this allowance: personal or enterprise:<id>.","schema":{"type":"string"}},"X-Quota-Environment":{"description":"Environment owning the allowance: sandbox or live.","schema":{"type":"string"}},"Retry-After":{"description":"Seconds until the exhausted quota or rate window resets. Sign retries with a new X-Request-ID.","schema":{"type":"integer","format":"int64"}},"X-RateLimit-Scope":{"description":"Rate counter scope: workspace, or user for enterprise verification calls.","schema":{"type":"string"}},"X-RateLimit-Limit":{"description":"Per-minute request limit when rate-limited.","schema":{"type":"integer","format":"int64"}},"X-RateLimit-Remaining":{"description":"Zero when the minute limit is exhausted.","schema":{"type":"integer","format":"int64"}},"X-RateLimit-Reset":{"description":"Unix epoch seconds when the minute limit resets.","schema":{"type":"integer","format":"int64"}}},"content":{"application/json":{"schema":{"$ref":"#/components/schemas/ApiResponseVoid"}}}},"413":{"description":"Request body is too large","headers":{"X-Request-ID":{"description":"Request identifier echoed for support and reconciliation.","schema":{"type":"string"}}},"content":{"application/json":{"schema":{"$ref":"#/components/schemas/ApiResponseVoid"}}}}},"x-dcwallet-signature-versions":["v1","v2"]}},"/api/v1/exchange/quotes":{"post":{"tags":["4a. Exchange"],"summary":"Quote a cross-chain exchange","description":"Use the source and target IDs from GET /blockchain-addresses. This creates a short-lived quote without moving funds. Requires a v2 signed enterprise workspace, exchange:write and Idempotency-Key. A retry with the same key returns the original quote, even if it has since expired.\n\nSignature versions: v2 only.","operationId":"postExchangeQuotes","parameters":[{"name":"Idempotency-Key","in":"header","description":"Unique key for one mutating request. Reuse the same value only when retrying the same operation.","required":true,"schema":{"type":"string"}},{"name":"X-Content-SHA256","in":"header","description":"The x-content-sha256 value for this resource.","required":true,"schema":{"type":"string"}},{"name":"X-Timestamp","in":"header","description":"Current Unix epoch time in seconds. Requests older or newer than five minutes are rejected.","required":true,"schema":{"pattern":"[0-9]{10}","type":"string","example":"1787562000"}},{"name":"X-Request-ID","in":"header","description":"Unique 16-128 character request identifier used for replay protection; never reuse it for a different HTTP request.","required":true,"schema":{"pattern":"[A-Za-z0-9._:-]{16,128}","type":"string","example":"018f6f4e-8f62-7fc2-9c4b-7be2f4203b6a"}},{"name":"X-Workspace","in":"header","description":"Select enterprise:<id> using your own ID from GET /api/v1/workspaces; personal is unavailable for this operation.","required":true,"schema":{"pattern":"personal|enterprise:[1-9][0-9]*","type":"string","example":null}},{"name":"X-Environment","in":"header","description":"Signed key environment: live or sandbox.","required":true,"schema":{"pattern":"live|sandbox","type":"string","example":"live"}},{"name":"X-Signature","in":"header","description":"v2-prefixed lowercase HMAC-SHA256 signature; existing and new keys can use v2 when enabled.","required":true,"schema":{"pattern":"v2=[0-9a-f]{64}","type":"string","example":"v2=0123456789abcdef0123456789abcdef0123456789abcdef0123456789abcdef"}},{"name":"Accept-Language","in":"header","description":"Response language: en-US = English (default); zh-CN = Simplified Chinese; zh-TW = Traditional Chinese. Numeric error codes are language-neutral.","required":false,"schema":{"type":"string","enum":["en-US","zh-CN","zh-TW"],"default":"en-US"}}],"requestBody":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/CrossChainQuoteRequest"}}},"required":true},"responses":{"400":{"description":"Malformed JSON, missing header or invalid request parameter","headers":{"X-Request-ID":{"description":"Request identifier echoed for support and reconciliation.","schema":{"type":"string"}}},"content":{"application/json":{"schema":{"$ref":"#/components/schemas/ApiResponseVoid"}}}},"500":{"description":"Unexpected internal error; contact support with X-Request-ID","headers":{"X-Request-ID":{"description":"Request identifier echoed for support and reconciliation.","schema":{"type":"string"}}},"content":{"application/json":{"schema":{"$ref":"#/components/schemas/ApiResponseVoid"}}}},"403":{"description":"API-key scope, subscription, tenant or policy does not allow the operation","headers":{"X-Request-ID":{"description":"Request identifier echoed for support and reconciliation.","schema":{"type":"string"}}},"content":{"application/json":{"schema":{"$ref":"#/components/schemas/ApiResponseVoid"}}}},"200":{"description":"OK","headers":{"X-Request-ID":{"description":"Request identifier echoed for support and reconciliation.","schema":{"type":"string"}},"X-Quota-Limit":{"description":"Monthly API request allowance for the subscription.","schema":{"type":"integer","format":"int64"}},"X-Quota-Remaining":{"description":"Requests remaining in the current monthly allowance after this request.","schema":{"type":"integer","format":"int64"}},"X-Quota-Reset":{"description":"Unix epoch time in seconds when the monthly allowance resets.","schema":{"type":"integer","format":"int64"}},"X-Quota-Workspace":{"description":"Verified workspace owning this allowance: personal or enterprise:<id>.","schema":{"type":"string"}},"X-Quota-Environment":{"description":"Environment owning the allowance: sandbox or live.","schema":{"type":"string"}}},"content":{"application/json":{"schema":{"$ref":"#/components/schemas/ApiResponseOrderResponse"}}}},"401":{"description":"Invalid API key, content hash, signature, timestamp or request ID","headers":{"X-Request-ID":{"description":"Request identifier echoed for support and reconciliation.","schema":{"type":"string"}}},"content":{"application/json":{"schema":{"$ref":"#/components/schemas/ApiResponseVoid"}}}},"404":{"description":"Resource not found in this enterprise and environment","headers":{"X-Request-ID":{"description":"Request identifier echoed for support and reconciliation.","schema":{"type":"string"}}},"content":{"application/json":{"schema":{"$ref":"#/components/schemas/ApiResponseVoid"}}}},"422":{"description":"Business rule rejected the request","headers":{"X-Request-ID":{"description":"Request identifier echoed for support and reconciliation.","schema":{"type":"string"}}},"content":{"application/json":{"schema":{"$ref":"#/components/schemas/ApiResponseVoid"}}}},"503":{"description":"A required platform service is temporarily unavailable","headers":{"X-Request-ID":{"description":"Request identifier echoed for support and reconciliation.","schema":{"type":"string"}}},"content":{"application/json":{"schema":{"$ref":"#/components/schemas/ApiResponseVoid"}}}},"409":{"description":"Idempotency or resource-state conflict","headers":{"X-Request-ID":{"description":"Request identifier echoed for support and reconciliation.","schema":{"type":"string"}}},"content":{"application/json":{"schema":{"$ref":"#/components/schemas/ApiResponseVoid"}}}},"429":{"description":"Per-minute rate limit or monthly quota exceeded","headers":{"X-Request-ID":{"description":"Request identifier echoed for support and reconciliation.","schema":{"type":"string"}},"X-Quota-Limit":{"description":"Monthly API request allowance for the subscription.","schema":{"type":"integer","format":"int64"}},"X-Quota-Remaining":{"description":"Requests remaining in the current monthly allowance after this request.","schema":{"type":"integer","format":"int64"}},"X-Quota-Reset":{"description":"Unix epoch time in seconds when the monthly allowance resets.","schema":{"type":"integer","format":"int64"}},"X-Quota-Workspace":{"description":"Verified workspace owning this allowance: personal or enterprise:<id>.","schema":{"type":"string"}},"X-Quota-Environment":{"description":"Environment owning the allowance: sandbox or live.","schema":{"type":"string"}},"Retry-After":{"description":"Seconds until the exhausted quota or rate window resets. Sign retries with a new X-Request-ID.","schema":{"type":"integer","format":"int64"}},"X-RateLimit-Scope":{"description":"Rate counter scope: workspace, or user for enterprise verification calls.","schema":{"type":"string"}},"X-RateLimit-Limit":{"description":"Per-minute request limit when rate-limited.","schema":{"type":"integer","format":"int64"}},"X-RateLimit-Remaining":{"description":"Zero when the minute limit is exhausted.","schema":{"type":"integer","format":"int64"}},"X-RateLimit-Reset":{"description":"Unix epoch seconds when the minute limit resets.","schema":{"type":"integer","format":"int64"}}},"content":{"application/json":{"schema":{"$ref":"#/components/schemas/ApiResponseVoid"}}}},"413":{"description":"Request body is too large","headers":{"X-Request-ID":{"description":"Request identifier echoed for support and reconciliation.","schema":{"type":"string"}}},"content":{"application/json":{"schema":{"$ref":"#/components/schemas/ApiResponseVoid"}}}}},"x-dcwallet-signature-versions":["v2"]}},"/api/v1/exchange/orders":{"get":{"tags":["4a. Exchange"],"summary":"List exchange orders in the selected workspace","description":"Signature versions: v2 only.","operationId":"getExchangeOrders","parameters":[{"name":"page","in":"query","description":"One-based result page number.","required":false,"schema":{"type":"integer","format":"int32","default":1}},{"name":"pageSize","in":"query","description":"Maximum records returned per page; values above 100 are capped.","required":false,"schema":{"type":"integer","format":"int32","default":20}},{"name":"X-Timestamp","in":"header","description":"Current Unix epoch time in seconds. Requests older or newer than five minutes are rejected.","required":true,"schema":{"pattern":"[0-9]{10}","type":"string","example":"1787562000"}},{"name":"X-Request-ID","in":"header","description":"Unique 16-128 character request identifier used for replay protection; never reuse it for a different HTTP request.","required":true,"schema":{"pattern":"[A-Za-z0-9._:-]{16,128}","type":"string","example":"018f6f4e-8f62-7fc2-9c4b-7be2f4203b6a"}},{"name":"X-Content-SHA256","in":"header","description":"Lowercase hexadecimal SHA-256 digest of the exact raw request body; use the digest of zero bytes when no body is sent.","required":true,"schema":{"pattern":"[0-9a-f]{64}","type":"string","example":"e3b0c44298fc1c149afbf4c8996fb92427ae41e4649b934ca495991b7852b855"}},{"name":"X-Workspace","in":"header","description":"Select enterprise:<id> using your own ID from GET /api/v1/workspaces; personal is unavailable for this operation.","required":true,"schema":{"pattern":"personal|enterprise:[1-9][0-9]*","type":"string","example":null}},{"name":"X-Environment","in":"header","description":"Signed key environment: live or sandbox.","required":true,"schema":{"pattern":"live|sandbox","type":"string","example":"live"}},{"name":"X-Signature","in":"header","description":"v2-prefixed lowercase HMAC-SHA256 signature; existing and new keys can use v2 when enabled.","required":true,"schema":{"pattern":"v2=[0-9a-f]{64}","type":"string","example":"v2=0123456789abcdef0123456789abcdef0123456789abcdef0123456789abcdef"}},{"name":"Accept-Language","in":"header","description":"Response language: en-US = English (default); zh-CN = Simplified Chinese; zh-TW = Traditional Chinese. Numeric error codes are language-neutral.","required":false,"schema":{"type":"string","enum":["en-US","zh-CN","zh-TW"],"default":"en-US"}}],"responses":{"400":{"description":"Malformed JSON, missing header or invalid request parameter","headers":{"X-Request-ID":{"description":"Request identifier echoed for support and reconciliation.","schema":{"type":"string"}}},"content":{"application/json":{"schema":{"$ref":"#/components/schemas/ApiResponseVoid"}}}},"500":{"description":"Unexpected internal error; contact support with X-Request-ID","headers":{"X-Request-ID":{"description":"Request identifier echoed for support and reconciliation.","schema":{"type":"string"}}},"content":{"application/json":{"schema":{"$ref":"#/components/schemas/ApiResponseVoid"}}}},"403":{"description":"API-key scope, subscription, tenant or policy does not allow the operation","headers":{"X-Request-ID":{"description":"Request identifier echoed for support and reconciliation.","schema":{"type":"string"}}},"content":{"application/json":{"schema":{"$ref":"#/components/schemas/ApiResponseVoid"}}}},"200":{"description":"OK","headers":{"X-Request-ID":{"description":"Request identifier echoed for support and reconciliation.","schema":{"type":"string"}},"X-Quota-Limit":{"description":"Monthly API request allowance for the subscription.","schema":{"type":"integer","format":"int64"}},"X-Quota-Remaining":{"description":"Requests remaining in the current monthly allowance after this request.","schema":{"type":"integer","format":"int64"}},"X-Quota-Reset":{"description":"Unix epoch time in seconds when the monthly allowance resets.","schema":{"type":"integer","format":"int64"}},"X-Quota-Workspace":{"description":"Verified workspace owning this allowance: personal or enterprise:<id>.","schema":{"type":"string"}},"X-Quota-Environment":{"description":"Environment owning the allowance: sandbox or live.","schema":{"type":"string"}}},"content":{"application/json":{"schema":{"$ref":"#/components/schemas/ApiResponsePageDataOrderResponse"}}}},"401":{"description":"Invalid API key, content hash, signature, timestamp or request ID","headers":{"X-Request-ID":{"description":"Request identifier echoed for support and reconciliation.","schema":{"type":"string"}}},"content":{"application/json":{"schema":{"$ref":"#/components/schemas/ApiResponseVoid"}}}},"404":{"description":"Resource not found in this enterprise and environment","headers":{"X-Request-ID":{"description":"Request identifier echoed for support and reconciliation.","schema":{"type":"string"}}},"content":{"application/json":{"schema":{"$ref":"#/components/schemas/ApiResponseVoid"}}}},"422":{"description":"Business rule rejected the request","headers":{"X-Request-ID":{"description":"Request identifier echoed for support and reconciliation.","schema":{"type":"string"}}},"content":{"application/json":{"schema":{"$ref":"#/components/schemas/ApiResponseVoid"}}}},"503":{"description":"A required platform service is temporarily unavailable","headers":{"X-Request-ID":{"description":"Request identifier echoed for support and reconciliation.","schema":{"type":"string"}}},"content":{"application/json":{"schema":{"$ref":"#/components/schemas/ApiResponseVoid"}}}},"409":{"description":"Idempotency or resource-state conflict","headers":{"X-Request-ID":{"description":"Request identifier echoed for support and reconciliation.","schema":{"type":"string"}}},"content":{"application/json":{"schema":{"$ref":"#/components/schemas/ApiResponseVoid"}}}},"429":{"description":"Per-minute rate limit or monthly quota exceeded","headers":{"X-Request-ID":{"description":"Request identifier echoed for support and reconciliation.","schema":{"type":"string"}},"X-Quota-Limit":{"description":"Monthly API request allowance for the subscription.","schema":{"type":"integer","format":"int64"}},"X-Quota-Remaining":{"description":"Requests remaining in the current monthly allowance after this request.","schema":{"type":"integer","format":"int64"}},"X-Quota-Reset":{"description":"Unix epoch time in seconds when the monthly allowance resets.","schema":{"type":"integer","format":"int64"}},"X-Quota-Workspace":{"description":"Verified workspace owning this allowance: personal or enterprise:<id>.","schema":{"type":"string"}},"X-Quota-Environment":{"description":"Environment owning the allowance: sandbox or live.","schema":{"type":"string"}},"Retry-After":{"description":"Seconds until the exhausted quota or rate window resets. Sign retries with a new X-Request-ID.","schema":{"type":"integer","format":"int64"}},"X-RateLimit-Scope":{"description":"Rate counter scope: workspace, or user for enterprise verification calls.","schema":{"type":"string"}},"X-RateLimit-Limit":{"description":"Per-minute request limit when rate-limited.","schema":{"type":"integer","format":"int64"}},"X-RateLimit-Remaining":{"description":"Zero when the minute limit is exhausted.","schema":{"type":"integer","format":"int64"}},"X-RateLimit-Reset":{"description":"Unix epoch seconds when the minute limit resets.","schema":{"type":"integer","format":"int64"}}},"content":{"application/json":{"schema":{"$ref":"#/components/schemas/ApiResponseVoid"}}}},"413":{"description":"Request body is too large","headers":{"X-Request-ID":{"description":"Request identifier echoed for support and reconciliation.","schema":{"type":"string"}}},"content":{"application/json":{"schema":{"$ref":"#/components/schemas/ApiResponseVoid"}}}}},"x-dcwallet-signature-versions":["v2"]},"post":{"tags":["4a. Exchange"],"summary":"Confirm a cross-chain exchange quote","description":"Confirm a quote returned by POST /quotes. In sandbox, funds settle atomically; in live, the approved route locks funds and continues through compliance and execution. Reuse Idempotency-Key only to retry this exact request.\n\nSignature versions: v2 only.","operationId":"postExchangeOrders","parameters":[{"name":"Idempotency-Key","in":"header","description":"Unique key for one mutating request. Reuse the same value only when retrying the same operation.","required":true,"schema":{"type":"string"}},{"name":"X-Content-SHA256","in":"header","description":"The x-content-sha256 value for this resource.","required":true,"schema":{"type":"string"}},{"name":"X-Timestamp","in":"header","description":"Current Unix epoch time in seconds. Requests older or newer than five minutes are rejected.","required":true,"schema":{"pattern":"[0-9]{10}","type":"string","example":"1787562000"}},{"name":"X-Request-ID","in":"header","description":"Unique 16-128 character request identifier used for replay protection; never reuse it for a different HTTP request.","required":true,"schema":{"pattern":"[A-Za-z0-9._:-]{16,128}","type":"string","example":"018f6f4e-8f62-7fc2-9c4b-7be2f4203b6a"}},{"name":"X-Workspace","in":"header","description":"Select enterprise:<id> using your own ID from GET /api/v1/workspaces; personal is unavailable for this operation.","required":true,"schema":{"pattern":"personal|enterprise:[1-9][0-9]*","type":"string","example":null}},{"name":"X-Environment","in":"header","description":"Signed key environment: live or sandbox.","required":true,"schema":{"pattern":"live|sandbox","type":"string","example":"live"}},{"name":"X-Signature","in":"header","description":"v2-prefixed lowercase HMAC-SHA256 signature; existing and new keys can use v2 when enabled.","required":true,"schema":{"pattern":"v2=[0-9a-f]{64}","type":"string","example":"v2=0123456789abcdef0123456789abcdef0123456789abcdef0123456789abcdef"}},{"name":"Accept-Language","in":"header","description":"Response language: en-US = English (default); zh-CN = Simplified Chinese; zh-TW = Traditional Chinese. Numeric error codes are language-neutral.","required":false,"schema":{"type":"string","enum":["en-US","zh-CN","zh-TW"],"default":"en-US"}}],"requestBody":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/ConfirmQuoteRequest"}}},"required":true},"responses":{"400":{"description":"Malformed JSON, missing header or invalid request parameter","headers":{"X-Request-ID":{"description":"Request identifier echoed for support and reconciliation.","schema":{"type":"string"}}},"content":{"application/json":{"schema":{"$ref":"#/components/schemas/ApiResponseVoid"}}}},"500":{"description":"Unexpected internal error; contact support with X-Request-ID","headers":{"X-Request-ID":{"description":"Request identifier echoed for support and reconciliation.","schema":{"type":"string"}}},"content":{"application/json":{"schema":{"$ref":"#/components/schemas/ApiResponseVoid"}}}},"403":{"description":"API-key scope, subscription, tenant or policy does not allow the operation","headers":{"X-Request-ID":{"description":"Request identifier echoed for support and reconciliation.","schema":{"type":"string"}}},"content":{"application/json":{"schema":{"$ref":"#/components/schemas/ApiResponseVoid"}}}},"200":{"description":"OK","headers":{"X-Request-ID":{"description":"Request identifier echoed for support and reconciliation.","schema":{"type":"string"}},"X-Quota-Limit":{"description":"Monthly API request allowance for the subscription.","schema":{"type":"integer","format":"int64"}},"X-Quota-Remaining":{"description":"Requests remaining in the current monthly allowance after this request.","schema":{"type":"integer","format":"int64"}},"X-Quota-Reset":{"description":"Unix epoch time in seconds when the monthly allowance resets.","schema":{"type":"integer","format":"int64"}},"X-Quota-Workspace":{"description":"Verified workspace owning this allowance: personal or enterprise:<id>.","schema":{"type":"string"}},"X-Quota-Environment":{"description":"Environment owning the allowance: sandbox or live.","schema":{"type":"string"}}},"content":{"application/json":{"schema":{"$ref":"#/components/schemas/ApiResponseOrderResponse"}}}},"401":{"description":"Invalid API key, content hash, signature, timestamp or request ID","headers":{"X-Request-ID":{"description":"Request identifier echoed for support and reconciliation.","schema":{"type":"string"}}},"content":{"application/json":{"schema":{"$ref":"#/components/schemas/ApiResponseVoid"}}}},"404":{"description":"Resource not found in this enterprise and environment","headers":{"X-Request-ID":{"description":"Request identifier echoed for support and reconciliation.","schema":{"type":"string"}}},"content":{"application/json":{"schema":{"$ref":"#/components/schemas/ApiResponseVoid"}}}},"422":{"description":"Business rule rejected the request","headers":{"X-Request-ID":{"description":"Request identifier echoed for support and reconciliation.","schema":{"type":"string"}}},"content":{"application/json":{"schema":{"$ref":"#/components/schemas/ApiResponseVoid"}}}},"503":{"description":"A required platform service is temporarily unavailable","headers":{"X-Request-ID":{"description":"Request identifier echoed for support and reconciliation.","schema":{"type":"string"}}},"content":{"application/json":{"schema":{"$ref":"#/components/schemas/ApiResponseVoid"}}}},"409":{"description":"Idempotency or resource-state conflict","headers":{"X-Request-ID":{"description":"Request identifier echoed for support and reconciliation.","schema":{"type":"string"}}},"content":{"application/json":{"schema":{"$ref":"#/components/schemas/ApiResponseVoid"}}}},"429":{"description":"Per-minute rate limit or monthly quota exceeded","headers":{"X-Request-ID":{"description":"Request identifier echoed for support and reconciliation.","schema":{"type":"string"}},"X-Quota-Limit":{"description":"Monthly API request allowance for the subscription.","schema":{"type":"integer","format":"int64"}},"X-Quota-Remaining":{"description":"Requests remaining in the current monthly allowance after this request.","schema":{"type":"integer","format":"int64"}},"X-Quota-Reset":{"description":"Unix epoch time in seconds when the monthly allowance resets.","schema":{"type":"integer","format":"int64"}},"X-Quota-Workspace":{"description":"Verified workspace owning this allowance: personal or enterprise:<id>.","schema":{"type":"string"}},"X-Quota-Environment":{"description":"Environment owning the allowance: sandbox or live.","schema":{"type":"string"}},"Retry-After":{"description":"Seconds until the exhausted quota or rate window resets. Sign retries with a new X-Request-ID.","schema":{"type":"integer","format":"int64"}},"X-RateLimit-Scope":{"description":"Rate counter scope: workspace, or user for enterprise verification calls.","schema":{"type":"string"}},"X-RateLimit-Limit":{"description":"Per-minute request limit when rate-limited.","schema":{"type":"integer","format":"int64"}},"X-RateLimit-Remaining":{"description":"Zero when the minute limit is exhausted.","schema":{"type":"integer","format":"int64"}},"X-RateLimit-Reset":{"description":"Unix epoch seconds when the minute limit resets.","schema":{"type":"integer","format":"int64"}}},"content":{"application/json":{"schema":{"$ref":"#/components/schemas/ApiResponseVoid"}}}},"413":{"description":"Request body is too large","headers":{"X-Request-ID":{"description":"Request identifier echoed for support and reconciliation.","schema":{"type":"string"}}},"content":{"application/json":{"schema":{"$ref":"#/components/schemas/ApiResponseVoid"}}}}},"x-dcwallet-signature-versions":["v2"]}},"/api/v1/exchange/orders/{orderId}/cancel":{"post":{"tags":["4a. Exchange"],"summary":"Cancel an eligible exchange order","description":"An unbroadcast cross-chain order or a pending manual fiat or crypto-to-fiat order can be cancelled while the business state allows it. Reuse Idempotency-Key for a retry.\n\nSignature versions: v2 only.","operationId":"postExchangeOrdersByOrderIdCancel","parameters":[{"name":"orderId","in":"path","description":"The order id value for this resource.","required":true,"schema":{"pattern":"[0-9]+","type":"string","example":"337893979704000512"}},{"name":"Idempotency-Key","in":"header","description":"Unique key for one mutating request. Reuse the same value only when retrying the same operation.","required":true,"schema":{"type":"string"}},{"name":"X-Content-SHA256","in":"header","description":"The x-content-sha256 value for this resource.","required":true,"schema":{"type":"string"}},{"name":"X-Timestamp","in":"header","description":"Current Unix epoch time in seconds. Requests older or newer than five minutes are rejected.","required":true,"schema":{"pattern":"[0-9]{10}","type":"string","example":"1787562000"}},{"name":"X-Request-ID","in":"header","description":"Unique 16-128 character request identifier used for replay protection; never reuse it for a different HTTP request.","required":true,"schema":{"pattern":"[A-Za-z0-9._:-]{16,128}","type":"string","example":"018f6f4e-8f62-7fc2-9c4b-7be2f4203b6a"}},{"name":"X-Workspace","in":"header","description":"Select enterprise:<id> using your own ID from GET /api/v1/workspaces; personal is unavailable for this operation.","required":true,"schema":{"pattern":"personal|enterprise:[1-9][0-9]*","type":"string","example":null}},{"name":"X-Environment","in":"header","description":"Signed key environment: live or sandbox.","required":true,"schema":{"pattern":"live|sandbox","type":"string","example":"live"}},{"name":"X-Signature","in":"header","description":"v2-prefixed lowercase HMAC-SHA256 signature; existing and new keys can use v2 when enabled.","required":true,"schema":{"pattern":"v2=[0-9a-f]{64}","type":"string","example":"v2=0123456789abcdef0123456789abcdef0123456789abcdef0123456789abcdef"}},{"name":"Accept-Language","in":"header","description":"Response language: en-US = English (default); zh-CN = Simplified Chinese; zh-TW = Traditional Chinese. Numeric error codes are language-neutral.","required":false,"schema":{"type":"string","enum":["en-US","zh-CN","zh-TW"],"default":"en-US"}}],"responses":{"400":{"description":"Malformed JSON, missing header or invalid request parameter","headers":{"X-Request-ID":{"description":"Request identifier echoed for support and reconciliation.","schema":{"type":"string"}}},"content":{"application/json":{"schema":{"$ref":"#/components/schemas/ApiResponseVoid"}}}},"500":{"description":"Unexpected internal error; contact support with X-Request-ID","headers":{"X-Request-ID":{"description":"Request identifier echoed for support and reconciliation.","schema":{"type":"string"}}},"content":{"application/json":{"schema":{"$ref":"#/components/schemas/ApiResponseVoid"}}}},"403":{"description":"API-key scope, subscription, tenant or policy does not allow the operation","headers":{"X-Request-ID":{"description":"Request identifier echoed for support and reconciliation.","schema":{"type":"string"}}},"content":{"application/json":{"schema":{"$ref":"#/components/schemas/ApiResponseVoid"}}}},"200":{"description":"OK","headers":{"X-Request-ID":{"description":"Request identifier echoed for support and reconciliation.","schema":{"type":"string"}},"X-Quota-Limit":{"description":"Monthly API request allowance for the subscription.","schema":{"type":"integer","format":"int64"}},"X-Quota-Remaining":{"description":"Requests remaining in the current monthly allowance after this request.","schema":{"type":"integer","format":"int64"}},"X-Quota-Reset":{"description":"Unix epoch time in seconds when the monthly allowance resets.","schema":{"type":"integer","format":"int64"}},"X-Quota-Workspace":{"description":"Verified workspace owning this allowance: personal or enterprise:<id>.","schema":{"type":"string"}},"X-Quota-Environment":{"description":"Environment owning the allowance: sandbox or live.","schema":{"type":"string"}}},"content":{"application/json":{"schema":{"$ref":"#/components/schemas/ApiResponseOrderResponse"}}}},"401":{"description":"Invalid API key, content hash, signature, timestamp or request ID","headers":{"X-Request-ID":{"description":"Request identifier echoed for support and reconciliation.","schema":{"type":"string"}}},"content":{"application/json":{"schema":{"$ref":"#/components/schemas/ApiResponseVoid"}}}},"404":{"description":"Resource not found in this enterprise and environment","headers":{"X-Request-ID":{"description":"Request identifier echoed for support and reconciliation.","schema":{"type":"string"}}},"content":{"application/json":{"schema":{"$ref":"#/components/schemas/ApiResponseVoid"}}}},"422":{"description":"Business rule rejected the request","headers":{"X-Request-ID":{"description":"Request identifier echoed for support and reconciliation.","schema":{"type":"string"}}},"content":{"application/json":{"schema":{"$ref":"#/components/schemas/ApiResponseVoid"}}}},"503":{"description":"A required platform service is temporarily unavailable","headers":{"X-Request-ID":{"description":"Request identifier echoed for support and reconciliation.","schema":{"type":"string"}}},"content":{"application/json":{"schema":{"$ref":"#/components/schemas/ApiResponseVoid"}}}},"409":{"description":"Idempotency or resource-state conflict","headers":{"X-Request-ID":{"description":"Request identifier echoed for support and reconciliation.","schema":{"type":"string"}}},"content":{"application/json":{"schema":{"$ref":"#/components/schemas/ApiResponseVoid"}}}},"429":{"description":"Per-minute rate limit or monthly quota exceeded","headers":{"X-Request-ID":{"description":"Request identifier echoed for support and reconciliation.","schema":{"type":"string"}},"X-Quota-Limit":{"description":"Monthly API request allowance for the subscription.","schema":{"type":"integer","format":"int64"}},"X-Quota-Remaining":{"description":"Requests remaining in the current monthly allowance after this request.","schema":{"type":"integer","format":"int64"}},"X-Quota-Reset":{"description":"Unix epoch time in seconds when the monthly allowance resets.","schema":{"type":"integer","format":"int64"}},"X-Quota-Workspace":{"description":"Verified workspace owning this allowance: personal or enterprise:<id>.","schema":{"type":"string"}},"X-Quota-Environment":{"description":"Environment owning the allowance: sandbox or live.","schema":{"type":"string"}},"Retry-After":{"description":"Seconds until the exhausted quota or rate window resets. Sign retries with a new X-Request-ID.","schema":{"type":"integer","format":"int64"}},"X-RateLimit-Scope":{"description":"Rate counter scope: workspace, or user for enterprise verification calls.","schema":{"type":"string"}},"X-RateLimit-Limit":{"description":"Per-minute request limit when rate-limited.","schema":{"type":"integer","format":"int64"}},"X-RateLimit-Remaining":{"description":"Zero when the minute limit is exhausted.","schema":{"type":"integer","format":"int64"}},"X-RateLimit-Reset":{"description":"Unix epoch seconds when the minute limit resets.","schema":{"type":"integer","format":"int64"}}},"content":{"application/json":{"schema":{"$ref":"#/components/schemas/ApiResponseVoid"}}}},"413":{"description":"Request body is too large","headers":{"X-Request-ID":{"description":"Request identifier echoed for support and reconciliation.","schema":{"type":"string"}}},"content":{"application/json":{"schema":{"$ref":"#/components/schemas/ApiResponseVoid"}}}}},"x-dcwallet-signature-versions":["v2"]}},"/api/v1/exchange/fiat-orders":{"post":{"tags":["4a. Exchange"],"summary":"Submit a fiat-to-fiat exchange","description":"Use fiat account IDs from GET /accounts. The current rate is checked when the order is submitted; minimumBuyAmount rejects a worse rate without moving funds. Sandbox settles atomically. Live locks the source balance and returns pending_manual until an administrator records actual settlement. Requires v2, an enterprise workspace, exchange:write and Idempotency-Key.\n\nSignature versions: v2 only.","operationId":"postExchangeFiatOrders","parameters":[{"name":"Idempotency-Key","in":"header","description":"Unique key for one mutating request. Reuse the same value only when retrying the same operation.","required":true,"schema":{"type":"string"}},{"name":"X-Content-SHA256","in":"header","description":"The x-content-sha256 value for this resource.","required":true,"schema":{"type":"string"}},{"name":"X-Timestamp","in":"header","description":"Current Unix epoch time in seconds. Requests older or newer than five minutes are rejected.","required":true,"schema":{"pattern":"[0-9]{10}","type":"string","example":"1787562000"}},{"name":"X-Request-ID","in":"header","description":"Unique 16-128 character request identifier used for replay protection; never reuse it for a different HTTP request.","required":true,"schema":{"pattern":"[A-Za-z0-9._:-]{16,128}","type":"string","example":"018f6f4e-8f62-7fc2-9c4b-7be2f4203b6a"}},{"name":"X-Workspace","in":"header","description":"Select enterprise:<id> using your own ID from GET /api/v1/workspaces; personal is unavailable for this operation.","required":true,"schema":{"pattern":"personal|enterprise:[1-9][0-9]*","type":"string","example":null}},{"name":"X-Environment","in":"header","description":"Signed key environment: live or sandbox.","required":true,"schema":{"pattern":"live|sandbox","type":"string","example":"live"}},{"name":"X-Signature","in":"header","description":"v2-prefixed lowercase HMAC-SHA256 signature; existing and new keys can use v2 when enabled.","required":true,"schema":{"pattern":"v2=[0-9a-f]{64}","type":"string","example":"v2=0123456789abcdef0123456789abcdef0123456789abcdef0123456789abcdef"}},{"name":"Accept-Language","in":"header","description":"Response language: en-US = English (default); zh-CN = Simplified Chinese; zh-TW = Traditional Chinese. Numeric error codes are language-neutral.","required":false,"schema":{"type":"string","enum":["en-US","zh-CN","zh-TW"],"default":"en-US"}}],"requestBody":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/FiatOrderRequest"}}},"required":true},"responses":{"400":{"description":"Malformed JSON, missing header or invalid request parameter","headers":{"X-Request-ID":{"description":"Request identifier echoed for support and reconciliation.","schema":{"type":"string"}}},"content":{"application/json":{"schema":{"$ref":"#/components/schemas/ApiResponseVoid"}}}},"500":{"description":"Unexpected internal error; contact support with X-Request-ID","headers":{"X-Request-ID":{"description":"Request identifier echoed for support and reconciliation.","schema":{"type":"string"}}},"content":{"application/json":{"schema":{"$ref":"#/components/schemas/ApiResponseVoid"}}}},"403":{"description":"API-key scope, subscription, tenant or policy does not allow the operation","headers":{"X-Request-ID":{"description":"Request identifier echoed for support and reconciliation.","schema":{"type":"string"}}},"content":{"application/json":{"schema":{"$ref":"#/components/schemas/ApiResponseVoid"}}}},"200":{"description":"OK","headers":{"X-Request-ID":{"description":"Request identifier echoed for support and reconciliation.","schema":{"type":"string"}},"X-Quota-Limit":{"description":"Monthly API request allowance for the subscription.","schema":{"type":"integer","format":"int64"}},"X-Quota-Remaining":{"description":"Requests remaining in the current monthly allowance after this request.","schema":{"type":"integer","format":"int64"}},"X-Quota-Reset":{"description":"Unix epoch time in seconds when the monthly allowance resets.","schema":{"type":"integer","format":"int64"}},"X-Quota-Workspace":{"description":"Verified workspace owning this allowance: personal or enterprise:<id>.","schema":{"type":"string"}},"X-Quota-Environment":{"description":"Environment owning the allowance: sandbox or live.","schema":{"type":"string"}}},"content":{"application/json":{"schema":{"$ref":"#/components/schemas/ApiResponseOrderResponse"}}}},"401":{"description":"Invalid API key, content hash, signature, timestamp or request ID","headers":{"X-Request-ID":{"description":"Request identifier echoed for support and reconciliation.","schema":{"type":"string"}}},"content":{"application/json":{"schema":{"$ref":"#/components/schemas/ApiResponseVoid"}}}},"404":{"description":"Resource not found in this enterprise and environment","headers":{"X-Request-ID":{"description":"Request identifier echoed for support and reconciliation.","schema":{"type":"string"}}},"content":{"application/json":{"schema":{"$ref":"#/components/schemas/ApiResponseVoid"}}}},"422":{"description":"Business rule rejected the request","headers":{"X-Request-ID":{"description":"Request identifier echoed for support and reconciliation.","schema":{"type":"string"}}},"content":{"application/json":{"schema":{"$ref":"#/components/schemas/ApiResponseVoid"}}}},"503":{"description":"A required platform service is temporarily unavailable","headers":{"X-Request-ID":{"description":"Request identifier echoed for support and reconciliation.","schema":{"type":"string"}}},"content":{"application/json":{"schema":{"$ref":"#/components/schemas/ApiResponseVoid"}}}},"409":{"description":"Idempotency or resource-state conflict","headers":{"X-Request-ID":{"description":"Request identifier echoed for support and reconciliation.","schema":{"type":"string"}}},"content":{"application/json":{"schema":{"$ref":"#/components/schemas/ApiResponseVoid"}}}},"429":{"description":"Per-minute rate limit or monthly quota exceeded","headers":{"X-Request-ID":{"description":"Request identifier echoed for support and reconciliation.","schema":{"type":"string"}},"X-Quota-Limit":{"description":"Monthly API request allowance for the subscription.","schema":{"type":"integer","format":"int64"}},"X-Quota-Remaining":{"description":"Requests remaining in the current monthly allowance after this request.","schema":{"type":"integer","format":"int64"}},"X-Quota-Reset":{"description":"Unix epoch time in seconds when the monthly allowance resets.","schema":{"type":"integer","format":"int64"}},"X-Quota-Workspace":{"description":"Verified workspace owning this allowance: personal or enterprise:<id>.","schema":{"type":"string"}},"X-Quota-Environment":{"description":"Environment owning the allowance: sandbox or live.","schema":{"type":"string"}},"Retry-After":{"description":"Seconds until the exhausted quota or rate window resets. Sign retries with a new X-Request-ID.","schema":{"type":"integer","format":"int64"}},"X-RateLimit-Scope":{"description":"Rate counter scope: workspace, or user for enterprise verification calls.","schema":{"type":"string"}},"X-RateLimit-Limit":{"description":"Per-minute request limit when rate-limited.","schema":{"type":"integer","format":"int64"}},"X-RateLimit-Remaining":{"description":"Zero when the minute limit is exhausted.","schema":{"type":"integer","format":"int64"}},"X-RateLimit-Reset":{"description":"Unix epoch seconds when the minute limit resets.","schema":{"type":"integer","format":"int64"}}},"content":{"application/json":{"schema":{"$ref":"#/components/schemas/ApiResponseVoid"}}}},"413":{"description":"Request body is too large","headers":{"X-Request-ID":{"description":"Request identifier echoed for support and reconciliation.","schema":{"type":"string"}}},"content":{"application/json":{"schema":{"$ref":"#/components/schemas/ApiResponseVoid"}}}}},"x-dcwallet-signature-versions":["v2"]}},"/api/v1/exchange/crypto-fiat-orders":{"post":{"tags":["4a. Exchange"],"summary":"Submit a crypto-to-fiat exchange","description":"Use sourceAddressId from GET /blockchain-addresses and targetAccountId from GET /accounts?assetType=fiat. minimumBuyAmount rejects an unfavorable rate before funds are moved. Sandbox settles atomically. Live locks the selected crypto balance and starts the existing collection workflow; channel fiat settlement remains pending manual reconciliation. Requires a v2 signed enterprise workspace, exchange:write and Idempotency-Key.\n\nSignature versions: v2 only.","operationId":"postExchangeCryptoFiatOrders","parameters":[{"name":"Idempotency-Key","in":"header","description":"Unique key for one mutating request. Reuse the same value only when retrying the same operation.","required":true,"schema":{"type":"string"}},{"name":"X-Content-SHA256","in":"header","description":"The x-content-sha256 value for this resource.","required":true,"schema":{"type":"string"}},{"name":"X-Timestamp","in":"header","description":"Current Unix epoch time in seconds. Requests older or newer than five minutes are rejected.","required":true,"schema":{"pattern":"[0-9]{10}","type":"string","example":"1787562000"}},{"name":"X-Request-ID","in":"header","description":"Unique 16-128 character request identifier used for replay protection; never reuse it for a different HTTP request.","required":true,"schema":{"pattern":"[A-Za-z0-9._:-]{16,128}","type":"string","example":"018f6f4e-8f62-7fc2-9c4b-7be2f4203b6a"}},{"name":"X-Workspace","in":"header","description":"Select enterprise:<id> using your own ID from GET /api/v1/workspaces; personal is unavailable for this operation.","required":true,"schema":{"pattern":"personal|enterprise:[1-9][0-9]*","type":"string","example":null}},{"name":"X-Environment","in":"header","description":"Signed key environment: live or sandbox.","required":true,"schema":{"pattern":"live|sandbox","type":"string","example":"live"}},{"name":"X-Signature","in":"header","description":"v2-prefixed lowercase HMAC-SHA256 signature; existing and new keys can use v2 when enabled.","required":true,"schema":{"pattern":"v2=[0-9a-f]{64}","type":"string","example":"v2=0123456789abcdef0123456789abcdef0123456789abcdef0123456789abcdef"}},{"name":"Accept-Language","in":"header","description":"Response language: en-US = English (default); zh-CN = Simplified Chinese; zh-TW = Traditional Chinese. Numeric error codes are language-neutral.","required":false,"schema":{"type":"string","enum":["en-US","zh-CN","zh-TW"],"default":"en-US"}}],"requestBody":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/CryptoFiatOrderRequest"}}},"required":true},"responses":{"400":{"description":"Malformed JSON, missing header or invalid request parameter","headers":{"X-Request-ID":{"description":"Request identifier echoed for support and reconciliation.","schema":{"type":"string"}}},"content":{"application/json":{"schema":{"$ref":"#/components/schemas/ApiResponseVoid"}}}},"500":{"description":"Unexpected internal error; contact support with X-Request-ID","headers":{"X-Request-ID":{"description":"Request identifier echoed for support and reconciliation.","schema":{"type":"string"}}},"content":{"application/json":{"schema":{"$ref":"#/components/schemas/ApiResponseVoid"}}}},"403":{"description":"API-key scope, subscription, tenant or policy does not allow the operation","headers":{"X-Request-ID":{"description":"Request identifier echoed for support and reconciliation.","schema":{"type":"string"}}},"content":{"application/json":{"schema":{"$ref":"#/components/schemas/ApiResponseVoid"}}}},"200":{"description":"OK","headers":{"X-Request-ID":{"description":"Request identifier echoed for support and reconciliation.","schema":{"type":"string"}},"X-Quota-Limit":{"description":"Monthly API request allowance for the subscription.","schema":{"type":"integer","format":"int64"}},"X-Quota-Remaining":{"description":"Requests remaining in the current monthly allowance after this request.","schema":{"type":"integer","format":"int64"}},"X-Quota-Reset":{"description":"Unix epoch time in seconds when the monthly allowance resets.","schema":{"type":"integer","format":"int64"}},"X-Quota-Workspace":{"description":"Verified workspace owning this allowance: personal or enterprise:<id>.","schema":{"type":"string"}},"X-Quota-Environment":{"description":"Environment owning the allowance: sandbox or live.","schema":{"type":"string"}}},"content":{"application/json":{"schema":{"$ref":"#/components/schemas/ApiResponseOrderResponse"}}}},"401":{"description":"Invalid API key, content hash, signature, timestamp or request ID","headers":{"X-Request-ID":{"description":"Request identifier echoed for support and reconciliation.","schema":{"type":"string"}}},"content":{"application/json":{"schema":{"$ref":"#/components/schemas/ApiResponseVoid"}}}},"404":{"description":"Resource not found in this enterprise and environment","headers":{"X-Request-ID":{"description":"Request identifier echoed for support and reconciliation.","schema":{"type":"string"}}},"content":{"application/json":{"schema":{"$ref":"#/components/schemas/ApiResponseVoid"}}}},"422":{"description":"Business rule rejected the request","headers":{"X-Request-ID":{"description":"Request identifier echoed for support and reconciliation.","schema":{"type":"string"}}},"content":{"application/json":{"schema":{"$ref":"#/components/schemas/ApiResponseVoid"}}}},"503":{"description":"A required platform service is temporarily unavailable","headers":{"X-Request-ID":{"description":"Request identifier echoed for support and reconciliation.","schema":{"type":"string"}}},"content":{"application/json":{"schema":{"$ref":"#/components/schemas/ApiResponseVoid"}}}},"409":{"description":"Idempotency or resource-state conflict","headers":{"X-Request-ID":{"description":"Request identifier echoed for support and reconciliation.","schema":{"type":"string"}}},"content":{"application/json":{"schema":{"$ref":"#/components/schemas/ApiResponseVoid"}}}},"429":{"description":"Per-minute rate limit or monthly quota exceeded","headers":{"X-Request-ID":{"description":"Request identifier echoed for support and reconciliation.","schema":{"type":"string"}},"X-Quota-Limit":{"description":"Monthly API request allowance for the subscription.","schema":{"type":"integer","format":"int64"}},"X-Quota-Remaining":{"description":"Requests remaining in the current monthly allowance after this request.","schema":{"type":"integer","format":"int64"}},"X-Quota-Reset":{"description":"Unix epoch time in seconds when the monthly allowance resets.","schema":{"type":"integer","format":"int64"}},"X-Quota-Workspace":{"description":"Verified workspace owning this allowance: personal or enterprise:<id>.","schema":{"type":"string"}},"X-Quota-Environment":{"description":"Environment owning the allowance: sandbox or live.","schema":{"type":"string"}},"Retry-After":{"description":"Seconds until the exhausted quota or rate window resets. Sign retries with a new X-Request-ID.","schema":{"type":"integer","format":"int64"}},"X-RateLimit-Scope":{"description":"Rate counter scope: workspace, or user for enterprise verification calls.","schema":{"type":"string"}},"X-RateLimit-Limit":{"description":"Per-minute request limit when rate-limited.","schema":{"type":"integer","format":"int64"}},"X-RateLimit-Remaining":{"description":"Zero when the minute limit is exhausted.","schema":{"type":"integer","format":"int64"}},"X-RateLimit-Reset":{"description":"Unix epoch seconds when the minute limit resets.","schema":{"type":"integer","format":"int64"}}},"content":{"application/json":{"schema":{"$ref":"#/components/schemas/ApiResponseVoid"}}}},"413":{"description":"Request body is too large","headers":{"X-Request-ID":{"description":"Request identifier echoed for support and reconciliation.","schema":{"type":"string"}}},"content":{"application/json":{"schema":{"$ref":"#/components/schemas/ApiResponseVoid"}}}}},"x-dcwallet-signature-versions":["v2"]}},"/api/v1/enterprise-applications":{"get":{"tags":["0. Enterprise verification"],"summary":"List enterprise verification applications owned by this user","description":"Signature versions: v2 only.","operationId":"getEnterpriseApplications","parameters":[{"name":"X-Timestamp","in":"header","description":"Current Unix epoch time in seconds. Requests older or newer than five minutes are rejected.","required":true,"schema":{"pattern":"[0-9]{10}","type":"string","example":"1787562000"}},{"name":"X-Request-ID","in":"header","description":"Unique 16-128 character request identifier used for replay protection; never reuse it for a different HTTP request.","required":true,"schema":{"pattern":"[A-Za-z0-9._:-]{16,128}","type":"string","example":"018f6f4e-8f62-7fc2-9c4b-7be2f4203b6a"}},{"name":"X-Content-SHA256","in":"header","description":"Lowercase hexadecimal SHA-256 digest of the exact raw request body; use the digest of zero bytes when no body is sent.","required":true,"schema":{"pattern":"[0-9a-f]{64}","type":"string","example":"e3b0c44298fc1c149afbf4c8996fb92427ae41e4649b934ca495991b7852b855"}},{"name":"X-Workspace","in":"header","description":"Signed workspace selector: personal or enterprise:<id>. Get your enterprise ID from GET /api/v1/workspaces.","required":true,"schema":{"pattern":"personal|enterprise:[1-9][0-9]*","type":"string","example":"personal"}},{"name":"X-Environment","in":"header","description":"Signed key environment: live or sandbox.","required":true,"schema":{"pattern":"live|sandbox","type":"string","example":"live"}},{"name":"X-Signature","in":"header","description":"v2-prefixed lowercase HMAC-SHA256 signature; existing and new keys can use v2 when enabled.","required":true,"schema":{"pattern":"v2=[0-9a-f]{64}","type":"string","example":"v2=0123456789abcdef0123456789abcdef0123456789abcdef0123456789abcdef"}},{"name":"Accept-Language","in":"header","description":"Response language: en-US = English (default); zh-CN = Simplified Chinese; zh-TW = Traditional Chinese. Numeric error codes are language-neutral.","required":false,"schema":{"type":"string","enum":["en-US","zh-CN","zh-TW"],"default":"en-US"}}],"responses":{"400":{"description":"Malformed JSON, missing header or invalid request parameter","headers":{"X-Request-ID":{"description":"Request identifier echoed for support and reconciliation.","schema":{"type":"string"}}},"content":{"application/json":{"schema":{"$ref":"#/components/schemas/ApiResponseVoid"}}}},"500":{"description":"Unexpected internal error; contact support with X-Request-ID","headers":{"X-Request-ID":{"description":"Request identifier echoed for support and reconciliation.","schema":{"type":"string"}}},"content":{"application/json":{"schema":{"$ref":"#/components/schemas/ApiResponseVoid"}}}},"403":{"description":"API-key scope, subscription, tenant or policy does not allow the operation","headers":{"X-Request-ID":{"description":"Request identifier echoed for support and reconciliation.","schema":{"type":"string"}}},"content":{"application/json":{"schema":{"$ref":"#/components/schemas/ApiResponseVoid"}}}},"200":{"description":"OK","headers":{"X-Request-ID":{"description":"Request identifier echoed for support and reconciliation.","schema":{"type":"string"}},"X-Quota-Limit":{"description":"Monthly API request allowance for the subscription.","schema":{"type":"integer","format":"int64"}},"X-Quota-Remaining":{"description":"Requests remaining in the current monthly allowance after this request.","schema":{"type":"integer","format":"int64"}},"X-Quota-Reset":{"description":"Unix epoch time in seconds when the monthly allowance resets.","schema":{"type":"integer","format":"int64"}},"X-Quota-Workspace":{"description":"Verified workspace owning this allowance: personal or enterprise:<id>.","schema":{"type":"string"}},"X-Quota-Environment":{"description":"Environment owning the allowance: sandbox or live.","schema":{"type":"string"}}},"content":{"application/json":{"schema":{"$ref":"#/components/schemas/ApiResponseListPortfolioItem"}}}},"401":{"description":"Invalid API key, content hash, signature, timestamp or request ID","headers":{"X-Request-ID":{"description":"Request identifier echoed for support and reconciliation.","schema":{"type":"string"}}},"content":{"application/json":{"schema":{"$ref":"#/components/schemas/ApiResponseVoid"}}}},"404":{"description":"Resource not found in this enterprise and environment","headers":{"X-Request-ID":{"description":"Request identifier echoed for support and reconciliation.","schema":{"type":"string"}}},"content":{"application/json":{"schema":{"$ref":"#/components/schemas/ApiResponseVoid"}}}},"422":{"description":"Business rule rejected the request","headers":{"X-Request-ID":{"description":"Request identifier echoed for support and reconciliation.","schema":{"type":"string"}}},"content":{"application/json":{"schema":{"$ref":"#/components/schemas/ApiResponseVoid"}}}},"503":{"description":"A required platform service is temporarily unavailable","headers":{"X-Request-ID":{"description":"Request identifier echoed for support and reconciliation.","schema":{"type":"string"}}},"content":{"application/json":{"schema":{"$ref":"#/components/schemas/ApiResponseVoid"}}}},"409":{"description":"Idempotency or resource-state conflict","headers":{"X-Request-ID":{"description":"Request identifier echoed for support and reconciliation.","schema":{"type":"string"}}},"content":{"application/json":{"schema":{"$ref":"#/components/schemas/ApiResponseVoid"}}}},"429":{"description":"Per-minute rate limit or monthly quota exceeded","headers":{"X-Request-ID":{"description":"Request identifier echoed for support and reconciliation.","schema":{"type":"string"}},"X-Quota-Limit":{"description":"Monthly API request allowance for the subscription.","schema":{"type":"integer","format":"int64"}},"X-Quota-Remaining":{"description":"Requests remaining in the current monthly allowance after this request.","schema":{"type":"integer","format":"int64"}},"X-Quota-Reset":{"description":"Unix epoch time in seconds when the monthly allowance resets.","schema":{"type":"integer","format":"int64"}},"X-Quota-Workspace":{"description":"Verified workspace owning this allowance: personal or enterprise:<id>.","schema":{"type":"string"}},"X-Quota-Environment":{"description":"Environment owning the allowance: sandbox or live.","schema":{"type":"string"}},"Retry-After":{"description":"Seconds until the exhausted quota or rate window resets. Sign retries with a new X-Request-ID.","schema":{"type":"integer","format":"int64"}},"X-RateLimit-Scope":{"description":"Rate counter scope: workspace, or user for enterprise verification calls.","schema":{"type":"string"}},"X-RateLimit-Limit":{"description":"Per-minute request limit when rate-limited.","schema":{"type":"integer","format":"int64"}},"X-RateLimit-Remaining":{"description":"Zero when the minute limit is exhausted.","schema":{"type":"integer","format":"int64"}},"X-RateLimit-Reset":{"description":"Unix epoch seconds when the minute limit resets.","schema":{"type":"integer","format":"int64"}}},"content":{"application/json":{"schema":{"$ref":"#/components/schemas/ApiResponseVoid"}}}},"413":{"description":"Request body is too large","headers":{"X-Request-ID":{"description":"Request identifier echoed for support and reconciliation.","schema":{"type":"string"}}},"content":{"application/json":{"schema":{"$ref":"#/components/schemas/ApiResponseVoid"}}}}},"x-dcwallet-signature-versions":["v2"]},"post":{"tags":["0. Enterprise verification"],"summary":"Submit complete KYB and create an enterprise in one request","description":"Select the personal workspace. Upload documents first through /enterprise-applications/documents/{documentType}, then submit all KYB fields and document IDs. A failed validation creates no enterprise.\n\nSignature versions: v2 only.","operationId":"postEnterpriseApplications","parameters":[{"name":"Idempotency-Key","in":"header","description":"Unique key for one mutating request. Reuse the same value only when retrying the same operation.","required":true,"schema":{"type":"string"}},{"name":"X-Content-SHA256","in":"header","description":"The x-content-sha256 value for this resource.","required":true,"schema":{"type":"string"}},{"name":"X-Timestamp","in":"header","description":"Current Unix epoch time in seconds. Requests older or newer than five minutes are rejected.","required":true,"schema":{"pattern":"[0-9]{10}","type":"string","example":"1787562000"}},{"name":"X-Request-ID","in":"header","description":"Unique 16-128 character request identifier used for replay protection; never reuse it for a different HTTP request.","required":true,"schema":{"pattern":"[A-Za-z0-9._:-]{16,128}","type":"string","example":"018f6f4e-8f62-7fc2-9c4b-7be2f4203b6a"}},{"name":"X-Workspace","in":"header","description":"Signed workspace selector: personal or enterprise:<id>. Get your enterprise ID from GET /api/v1/workspaces.","required":true,"schema":{"pattern":"personal|enterprise:[1-9][0-9]*","type":"string","example":"personal"}},{"name":"X-Environment","in":"header","description":"Signed key environment: live or sandbox.","required":true,"schema":{"pattern":"live|sandbox","type":"string","example":"live"}},{"name":"X-Signature","in":"header","description":"v2-prefixed lowercase HMAC-SHA256 signature; existing and new keys can use v2 when enabled.","required":true,"schema":{"pattern":"v2=[0-9a-f]{64}","type":"string","example":"v2=0123456789abcdef0123456789abcdef0123456789abcdef0123456789abcdef"}},{"name":"Accept-Language","in":"header","description":"Response language: en-US = English (default); zh-CN = Simplified Chinese; zh-TW = Traditional Chinese. Numeric error codes are language-neutral.","required":false,"schema":{"type":"string","enum":["en-US","zh-CN","zh-TW"],"default":"en-US"}}],"requestBody":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/MachineKybSubmissionRequest"}}},"required":true},"responses":{"400":{"description":"Malformed JSON, missing header or invalid request parameter","headers":{"X-Request-ID":{"description":"Request identifier echoed for support and reconciliation.","schema":{"type":"string"}}},"content":{"application/json":{"schema":{"$ref":"#/components/schemas/ApiResponseVoid"}}}},"500":{"description":"Unexpected internal error; contact support with X-Request-ID","headers":{"X-Request-ID":{"description":"Request identifier echoed for support and reconciliation.","schema":{"type":"string"}}},"content":{"application/json":{"schema":{"$ref":"#/components/schemas/ApiResponseVoid"}}}},"403":{"description":"API-key scope, subscription, tenant or policy does not allow the operation","headers":{"X-Request-ID":{"description":"Request identifier echoed for support and reconciliation.","schema":{"type":"string"}}},"content":{"application/json":{"schema":{"$ref":"#/components/schemas/ApiResponseVoid"}}}},"200":{"description":"OK","headers":{"X-Request-ID":{"description":"Request identifier echoed for support and reconciliation.","schema":{"type":"string"}},"X-Quota-Limit":{"description":"Monthly API request allowance for the subscription.","schema":{"type":"integer","format":"int64"}},"X-Quota-Remaining":{"description":"Requests remaining in the current monthly allowance after this request.","schema":{"type":"integer","format":"int64"}},"X-Quota-Reset":{"description":"Unix epoch time in seconds when the monthly allowance resets.","schema":{"type":"integer","format":"int64"}},"X-Quota-Workspace":{"description":"Verified workspace owning this allowance: personal or enterprise:<id>.","schema":{"type":"string"}},"X-Quota-Environment":{"description":"Environment owning the allowance: sandbox or live.","schema":{"type":"string"}}},"content":{"application/json":{"schema":{"$ref":"#/components/schemas/ApiResponsePortfolioItem"}}}},"401":{"description":"Invalid API key, content hash, signature, timestamp or request ID","headers":{"X-Request-ID":{"description":"Request identifier echoed for support and reconciliation.","schema":{"type":"string"}}},"content":{"application/json":{"schema":{"$ref":"#/components/schemas/ApiResponseVoid"}}}},"404":{"description":"Resource not found in this enterprise and environment","headers":{"X-Request-ID":{"description":"Request identifier echoed for support and reconciliation.","schema":{"type":"string"}}},"content":{"application/json":{"schema":{"$ref":"#/components/schemas/ApiResponseVoid"}}}},"422":{"description":"Business rule rejected the request","headers":{"X-Request-ID":{"description":"Request identifier echoed for support and reconciliation.","schema":{"type":"string"}}},"content":{"application/json":{"schema":{"$ref":"#/components/schemas/ApiResponseVoid"}}}},"503":{"description":"A required platform service is temporarily unavailable","headers":{"X-Request-ID":{"description":"Request identifier echoed for support and reconciliation.","schema":{"type":"string"}}},"content":{"application/json":{"schema":{"$ref":"#/components/schemas/ApiResponseVoid"}}}},"409":{"description":"Idempotency or resource-state conflict","headers":{"X-Request-ID":{"description":"Request identifier echoed for support and reconciliation.","schema":{"type":"string"}}},"content":{"application/json":{"schema":{"$ref":"#/components/schemas/ApiResponseVoid"}}}},"429":{"description":"Per-minute rate limit or monthly quota exceeded","headers":{"X-Request-ID":{"description":"Request identifier echoed for support and reconciliation.","schema":{"type":"string"}},"X-Quota-Limit":{"description":"Monthly API request allowance for the subscription.","schema":{"type":"integer","format":"int64"}},"X-Quota-Remaining":{"description":"Requests remaining in the current monthly allowance after this request.","schema":{"type":"integer","format":"int64"}},"X-Quota-Reset":{"description":"Unix epoch time in seconds when the monthly allowance resets.","schema":{"type":"integer","format":"int64"}},"X-Quota-Workspace":{"description":"Verified workspace owning this allowance: personal or enterprise:<id>.","schema":{"type":"string"}},"X-Quota-Environment":{"description":"Environment owning the allowance: sandbox or live.","schema":{"type":"string"}},"Retry-After":{"description":"Seconds until the exhausted quota or rate window resets. Sign retries with a new X-Request-ID.","schema":{"type":"integer","format":"int64"}},"X-RateLimit-Scope":{"description":"Rate counter scope: workspace, or user for enterprise verification calls.","schema":{"type":"string"}},"X-RateLimit-Limit":{"description":"Per-minute request limit when rate-limited.","schema":{"type":"integer","format":"int64"}},"X-RateLimit-Remaining":{"description":"Zero when the minute limit is exhausted.","schema":{"type":"integer","format":"int64"}},"X-RateLimit-Reset":{"description":"Unix epoch seconds when the minute limit resets.","schema":{"type":"integer","format":"int64"}}},"content":{"application/json":{"schema":{"$ref":"#/components/schemas/ApiResponseVoid"}}}},"413":{"description":"Request body is too large","headers":{"X-Request-ID":{"description":"Request identifier echoed for support and reconciliation.","schema":{"type":"string"}}},"content":{"application/json":{"schema":{"$ref":"#/components/schemas/ApiResponseVoid"}}}}},"x-dcwallet-signature-versions":["v2"]}},"/api/v1/enterprise-applications/{applicationId}/resubmit":{"post":{"tags":["0. Enterprise verification"],"summary":"Resubmit KYB after rejection, EDD or renewal request","description":"Signature versions: v2 only.","operationId":"postEnterpriseApplicationsByApplicationIdResubmit","parameters":[{"name":"applicationId","in":"path","description":"Card application ID returned by /api/v1/card-applications. Keep IDs as strings.","required":true,"schema":{"pattern":"[0-9]+","type":"string","example":"337893979704000512"}},{"name":"Idempotency-Key","in":"header","description":"Unique key for one mutating request. Reuse the same value only when retrying the same operation.","required":true,"schema":{"type":"string"}},{"name":"X-Content-SHA256","in":"header","description":"The x-content-sha256 value for this resource.","required":true,"schema":{"type":"string"}},{"name":"X-Timestamp","in":"header","description":"Current Unix epoch time in seconds. Requests older or newer than five minutes are rejected.","required":true,"schema":{"pattern":"[0-9]{10}","type":"string","example":"1787562000"}},{"name":"X-Request-ID","in":"header","description":"Unique 16-128 character request identifier used for replay protection; never reuse it for a different HTTP request.","required":true,"schema":{"pattern":"[A-Za-z0-9._:-]{16,128}","type":"string","example":"018f6f4e-8f62-7fc2-9c4b-7be2f4203b6a"}},{"name":"X-Workspace","in":"header","description":"Select enterprise:<id> using your own ID from GET /api/v1/workspaces; personal is unavailable for this operation.","required":true,"schema":{"pattern":"personal|enterprise:[1-9][0-9]*","type":"string","example":null}},{"name":"X-Environment","in":"header","description":"Signed key environment: live or sandbox.","required":true,"schema":{"pattern":"live|sandbox","type":"string","example":"live"}},{"name":"X-Signature","in":"header","description":"v2-prefixed lowercase HMAC-SHA256 signature; existing and new keys can use v2 when enabled.","required":true,"schema":{"pattern":"v2=[0-9a-f]{64}","type":"string","example":"v2=0123456789abcdef0123456789abcdef0123456789abcdef0123456789abcdef"}},{"name":"Accept-Language","in":"header","description":"Response language: en-US = English (default); zh-CN = Simplified Chinese; zh-TW = Traditional Chinese. Numeric error codes are language-neutral.","required":false,"schema":{"type":"string","enum":["en-US","zh-CN","zh-TW"],"default":"en-US"}}],"requestBody":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/MachineKybSubmissionRequest"}}},"required":true},"responses":{"400":{"description":"Malformed JSON, missing header or invalid request parameter","headers":{"X-Request-ID":{"description":"Request identifier echoed for support and reconciliation.","schema":{"type":"string"}}},"content":{"application/json":{"schema":{"$ref":"#/components/schemas/ApiResponseVoid"}}}},"500":{"description":"Unexpected internal error; contact support with X-Request-ID","headers":{"X-Request-ID":{"description":"Request identifier echoed for support and reconciliation.","schema":{"type":"string"}}},"content":{"application/json":{"schema":{"$ref":"#/components/schemas/ApiResponseVoid"}}}},"403":{"description":"API-key scope, subscription, tenant or policy does not allow the operation","headers":{"X-Request-ID":{"description":"Request identifier echoed for support and reconciliation.","schema":{"type":"string"}}},"content":{"application/json":{"schema":{"$ref":"#/components/schemas/ApiResponseVoid"}}}},"200":{"description":"OK","headers":{"X-Request-ID":{"description":"Request identifier echoed for support and reconciliation.","schema":{"type":"string"}},"X-Quota-Limit":{"description":"Monthly API request allowance for the subscription.","schema":{"type":"integer","format":"int64"}},"X-Quota-Remaining":{"description":"Requests remaining in the current monthly allowance after this request.","schema":{"type":"integer","format":"int64"}},"X-Quota-Reset":{"description":"Unix epoch time in seconds when the monthly allowance resets.","schema":{"type":"integer","format":"int64"}},"X-Quota-Workspace":{"description":"Verified workspace owning this allowance: personal or enterprise:<id>.","schema":{"type":"string"}},"X-Quota-Environment":{"description":"Environment owning the allowance: sandbox or live.","schema":{"type":"string"}}},"content":{"application/json":{"schema":{"$ref":"#/components/schemas/ApiResponsePortfolioItem"}}}},"401":{"description":"Invalid API key, content hash, signature, timestamp or request ID","headers":{"X-Request-ID":{"description":"Request identifier echoed for support and reconciliation.","schema":{"type":"string"}}},"content":{"application/json":{"schema":{"$ref":"#/components/schemas/ApiResponseVoid"}}}},"404":{"description":"Resource not found in this enterprise and environment","headers":{"X-Request-ID":{"description":"Request identifier echoed for support and reconciliation.","schema":{"type":"string"}}},"content":{"application/json":{"schema":{"$ref":"#/components/schemas/ApiResponseVoid"}}}},"422":{"description":"Business rule rejected the request","headers":{"X-Request-ID":{"description":"Request identifier echoed for support and reconciliation.","schema":{"type":"string"}}},"content":{"application/json":{"schema":{"$ref":"#/components/schemas/ApiResponseVoid"}}}},"503":{"description":"A required platform service is temporarily unavailable","headers":{"X-Request-ID":{"description":"Request identifier echoed for support and reconciliation.","schema":{"type":"string"}}},"content":{"application/json":{"schema":{"$ref":"#/components/schemas/ApiResponseVoid"}}}},"409":{"description":"Idempotency or resource-state conflict","headers":{"X-Request-ID":{"description":"Request identifier echoed for support and reconciliation.","schema":{"type":"string"}}},"content":{"application/json":{"schema":{"$ref":"#/components/schemas/ApiResponseVoid"}}}},"429":{"description":"Per-minute rate limit or monthly quota exceeded","headers":{"X-Request-ID":{"description":"Request identifier echoed for support and reconciliation.","schema":{"type":"string"}},"X-Quota-Limit":{"description":"Monthly API request allowance for the subscription.","schema":{"type":"integer","format":"int64"}},"X-Quota-Remaining":{"description":"Requests remaining in the current monthly allowance after this request.","schema":{"type":"integer","format":"int64"}},"X-Quota-Reset":{"description":"Unix epoch time in seconds when the monthly allowance resets.","schema":{"type":"integer","format":"int64"}},"X-Quota-Workspace":{"description":"Verified workspace owning this allowance: personal or enterprise:<id>.","schema":{"type":"string"}},"X-Quota-Environment":{"description":"Environment owning the allowance: sandbox or live.","schema":{"type":"string"}},"Retry-After":{"description":"Seconds until the exhausted quota or rate window resets. Sign retries with a new X-Request-ID.","schema":{"type":"integer","format":"int64"}},"X-RateLimit-Scope":{"description":"Rate counter scope: workspace, or user for enterprise verification calls.","schema":{"type":"string"}},"X-RateLimit-Limit":{"description":"Per-minute request limit when rate-limited.","schema":{"type":"integer","format":"int64"}},"X-RateLimit-Remaining":{"description":"Zero when the minute limit is exhausted.","schema":{"type":"integer","format":"int64"}},"X-RateLimit-Reset":{"description":"Unix epoch seconds when the minute limit resets.","schema":{"type":"integer","format":"int64"}}},"content":{"application/json":{"schema":{"$ref":"#/components/schemas/ApiResponseVoid"}}}},"413":{"description":"Request body is too large","headers":{"X-Request-ID":{"description":"Request identifier echoed for support and reconciliation.","schema":{"type":"string"}}},"content":{"application/json":{"schema":{"$ref":"#/components/schemas/ApiResponseVoid"}}}}},"x-dcwallet-signature-versions":["v2"]}},"/api/v1/enterprise-applications/{applicationId}/documents/{documentType}":{"post":{"tags":["0. Enterprise verification"],"summary":"Upload a KYB document as raw PDF, JPEG or PNG bytes","description":"Use a fixed documentTypes value or an active file fieldKey from requirements as the documentType path value.\n\nSignature versions: v2 only.","operationId":"postEnterpriseApplicationsByApplicationIdDocumentsByDocumentType","parameters":[{"name":"applicationId","in":"path","description":"Card application ID returned by /api/v1/card-applications. Keep IDs as strings.","required":true,"schema":{"pattern":"[0-9]+","type":"string","example":"337893979704000512"}},{"name":"documentType","in":"path","description":"The document type value for this resource.","required":true,"schema":{"type":"string"}},{"name":"Idempotency-Key","in":"header","description":"Unique key for one mutating request. Reuse the same value only when retrying the same operation.","required":true,"schema":{"type":"string"}},{"name":"X-Content-SHA256","in":"header","description":"The x-content-sha256 value for this resource.","required":true,"schema":{"type":"string"}},{"name":"X-File-Name","in":"header","description":"Original file name with an extension supported by this upload endpoint.","required":false,"schema":{"type":"string"}},{"name":"Content-Type","in":"header","description":"Raw upload media type supported by this endpoint's request body.","required":true,"schema":{"type":"string"}},{"name":"X-Timestamp","in":"header","description":"Current Unix epoch time in seconds. Requests older or newer than five minutes are rejected.","required":true,"schema":{"pattern":"[0-9]{10}","type":"string","example":"1787562000"}},{"name":"X-Request-ID","in":"header","description":"Unique 16-128 character request identifier used for replay protection; never reuse it for a different HTTP request.","required":true,"schema":{"pattern":"[A-Za-z0-9._:-]{16,128}","type":"string","example":"018f6f4e-8f62-7fc2-9c4b-7be2f4203b6a"}},{"name":"X-Workspace","in":"header","description":"Select enterprise:<id> using your own ID from GET /api/v1/workspaces; personal is unavailable for this operation.","required":true,"schema":{"pattern":"personal|enterprise:[1-9][0-9]*","type":"string","example":null}},{"name":"X-Environment","in":"header","description":"Signed key environment: live or sandbox.","required":true,"schema":{"pattern":"live|sandbox","type":"string","example":"live"}},{"name":"X-Signature","in":"header","description":"v2-prefixed lowercase HMAC-SHA256 signature; existing and new keys can use v2 when enabled.","required":true,"schema":{"pattern":"v2=[0-9a-f]{64}","type":"string","example":"v2=0123456789abcdef0123456789abcdef0123456789abcdef0123456789abcdef"}},{"name":"Accept-Language","in":"header","description":"Response language: en-US = English (default); zh-CN = Simplified Chinese; zh-TW = Traditional Chinese. Numeric error codes are language-neutral.","required":false,"schema":{"type":"string","enum":["en-US","zh-CN","zh-TW"],"default":"en-US"}}],"requestBody":{"content":{"image/png":{"schema":{"type":"string","format":"byte"}},"application/pdf":{"schema":{"type":"string","format":"byte"}},"image/jpeg":{"schema":{"type":"string","format":"byte"}}},"required":true},"responses":{"400":{"description":"Malformed JSON, missing header or invalid request parameter","headers":{"X-Request-ID":{"description":"Request identifier echoed for support and reconciliation.","schema":{"type":"string"}}},"content":{"application/json":{"schema":{"$ref":"#/components/schemas/ApiResponseVoid"}}}},"500":{"description":"Unexpected internal error; contact support with X-Request-ID","headers":{"X-Request-ID":{"description":"Request identifier echoed for support and reconciliation.","schema":{"type":"string"}}},"content":{"application/json":{"schema":{"$ref":"#/components/schemas/ApiResponseVoid"}}}},"403":{"description":"API-key scope, subscription, tenant or policy does not allow the operation","headers":{"X-Request-ID":{"description":"Request identifier echoed for support and reconciliation.","schema":{"type":"string"}}},"content":{"application/json":{"schema":{"$ref":"#/components/schemas/ApiResponseVoid"}}}},"200":{"description":"OK","headers":{"X-Request-ID":{"description":"Request identifier echoed for support and reconciliation.","schema":{"type":"string"}},"X-Quota-Limit":{"description":"Monthly API request allowance for the subscription.","schema":{"type":"integer","format":"int64"}},"X-Quota-Remaining":{"description":"Requests remaining in the current monthly allowance after this request.","schema":{"type":"integer","format":"int64"}},"X-Quota-Reset":{"description":"Unix epoch time in seconds when the monthly allowance resets.","schema":{"type":"integer","format":"int64"}},"X-Quota-Workspace":{"description":"Verified workspace owning this allowance: personal or enterprise:<id>.","schema":{"type":"string"}},"X-Quota-Environment":{"description":"Environment owning the allowance: sandbox or live.","schema":{"type":"string"}}},"content":{"application/json":{"schema":{"$ref":"#/components/schemas/ApiResponseDocumentUpload"}}}},"401":{"description":"Invalid API key, content hash, signature, timestamp or request ID","headers":{"X-Request-ID":{"description":"Request identifier echoed for support and reconciliation.","schema":{"type":"string"}}},"content":{"application/json":{"schema":{"$ref":"#/components/schemas/ApiResponseVoid"}}}},"404":{"description":"Resource not found in this enterprise and environment","headers":{"X-Request-ID":{"description":"Request identifier echoed for support and reconciliation.","schema":{"type":"string"}}},"content":{"application/json":{"schema":{"$ref":"#/components/schemas/ApiResponseVoid"}}}},"422":{"description":"Business rule rejected the request","headers":{"X-Request-ID":{"description":"Request identifier echoed for support and reconciliation.","schema":{"type":"string"}}},"content":{"application/json":{"schema":{"$ref":"#/components/schemas/ApiResponseVoid"}}}},"503":{"description":"A required platform service is temporarily unavailable","headers":{"X-Request-ID":{"description":"Request identifier echoed for support and reconciliation.","schema":{"type":"string"}}},"content":{"application/json":{"schema":{"$ref":"#/components/schemas/ApiResponseVoid"}}}},"409":{"description":"Idempotency or resource-state conflict","headers":{"X-Request-ID":{"description":"Request identifier echoed for support and reconciliation.","schema":{"type":"string"}}},"content":{"application/json":{"schema":{"$ref":"#/components/schemas/ApiResponseVoid"}}}},"429":{"description":"Per-minute rate limit or monthly quota exceeded","headers":{"X-Request-ID":{"description":"Request identifier echoed for support and reconciliation.","schema":{"type":"string"}},"X-Quota-Limit":{"description":"Monthly API request allowance for the subscription.","schema":{"type":"integer","format":"int64"}},"X-Quota-Remaining":{"description":"Requests remaining in the current monthly allowance after this request.","schema":{"type":"integer","format":"int64"}},"X-Quota-Reset":{"description":"Unix epoch time in seconds when the monthly allowance resets.","schema":{"type":"integer","format":"int64"}},"X-Quota-Workspace":{"description":"Verified workspace owning this allowance: personal or enterprise:<id>.","schema":{"type":"string"}},"X-Quota-Environment":{"description":"Environment owning the allowance: sandbox or live.","schema":{"type":"string"}},"Retry-After":{"description":"Seconds until the exhausted quota or rate window resets. Sign retries with a new X-Request-ID.","schema":{"type":"integer","format":"int64"}},"X-RateLimit-Scope":{"description":"Rate counter scope: workspace, or user for enterprise verification calls.","schema":{"type":"string"}},"X-RateLimit-Limit":{"description":"Per-minute request limit when rate-limited.","schema":{"type":"integer","format":"int64"}},"X-RateLimit-Remaining":{"description":"Zero when the minute limit is exhausted.","schema":{"type":"integer","format":"int64"}},"X-RateLimit-Reset":{"description":"Unix epoch seconds when the minute limit resets.","schema":{"type":"integer","format":"int64"}}},"content":{"application/json":{"schema":{"$ref":"#/components/schemas/ApiResponseVoid"}}}},"413":{"description":"Request body is too large","headers":{"X-Request-ID":{"description":"Request identifier echoed for support and reconciliation.","schema":{"type":"string"}}},"content":{"application/json":{"schema":{"$ref":"#/components/schemas/ApiResponseVoid"}}}}},"x-dcwallet-signature-versions":["v2"]}},"/api/v1/enterprise-applications/documents/{documentType}":{"post":{"tags":["0. Enterprise verification"],"summary":"Upload a KYB document before the first enterprise submission","description":"Use a fixed documentTypes value or an active file fieldKey from requirements as the documentType path value. Select the personal workspace and sign the raw PDF, JPEG or PNG bytes. The returned documentId is bound to the user and environment and can be used once in the complete KYB submission.\n\nSignature versions: v2 only.","operationId":"postEnterpriseApplicationsDocumentsByDocumentType","parameters":[{"name":"documentType","in":"path","description":"The document type value for this resource.","required":true,"schema":{"type":"string"}},{"name":"Idempotency-Key","in":"header","description":"Unique key for one mutating request. Reuse the same value only when retrying the same operation.","required":true,"schema":{"type":"string"}},{"name":"X-Content-SHA256","in":"header","description":"The x-content-sha256 value for this resource.","required":true,"schema":{"type":"string"}},{"name":"X-File-Name","in":"header","description":"Original file name with an extension supported by this upload endpoint.","required":false,"schema":{"type":"string"}},{"name":"Content-Type","in":"header","description":"Raw upload media type supported by this endpoint's request body.","required":true,"schema":{"type":"string"}},{"name":"X-Timestamp","in":"header","description":"Current Unix epoch time in seconds. Requests older or newer than five minutes are rejected.","required":true,"schema":{"pattern":"[0-9]{10}","type":"string","example":"1787562000"}},{"name":"X-Request-ID","in":"header","description":"Unique 16-128 character request identifier used for replay protection; never reuse it for a different HTTP request.","required":true,"schema":{"pattern":"[A-Za-z0-9._:-]{16,128}","type":"string","example":"018f6f4e-8f62-7fc2-9c4b-7be2f4203b6a"}},{"name":"X-Workspace","in":"header","description":"Signed workspace selector: personal or enterprise:<id>. Get your enterprise ID from GET /api/v1/workspaces.","required":true,"schema":{"pattern":"personal|enterprise:[1-9][0-9]*","type":"string","example":"personal"}},{"name":"X-Environment","in":"header","description":"Signed key environment: live or sandbox.","required":true,"schema":{"pattern":"live|sandbox","type":"string","example":"live"}},{"name":"X-Signature","in":"header","description":"v2-prefixed lowercase HMAC-SHA256 signature; existing and new keys can use v2 when enabled.","required":true,"schema":{"pattern":"v2=[0-9a-f]{64}","type":"string","example":"v2=0123456789abcdef0123456789abcdef0123456789abcdef0123456789abcdef"}},{"name":"Accept-Language","in":"header","description":"Response language: en-US = English (default); zh-CN = Simplified Chinese; zh-TW = Traditional Chinese. Numeric error codes are language-neutral.","required":false,"schema":{"type":"string","enum":["en-US","zh-CN","zh-TW"],"default":"en-US"}}],"requestBody":{"content":{"image/png":{"schema":{"type":"string","format":"byte"}},"application/octet-stream":{"schema":{"type":"string","format":"byte"}},"application/pdf":{"schema":{"type":"string","format":"byte"}},"image/jpeg":{"schema":{"type":"string","format":"byte"}}},"required":true},"responses":{"400":{"description":"Malformed JSON, missing header or invalid request parameter","headers":{"X-Request-ID":{"description":"Request identifier echoed for support and reconciliation.","schema":{"type":"string"}}},"content":{"application/json":{"schema":{"$ref":"#/components/schemas/ApiResponseVoid"}}}},"500":{"description":"Unexpected internal error; contact support with X-Request-ID","headers":{"X-Request-ID":{"description":"Request identifier echoed for support and reconciliation.","schema":{"type":"string"}}},"content":{"application/json":{"schema":{"$ref":"#/components/schemas/ApiResponseVoid"}}}},"403":{"description":"API-key scope, subscription, tenant or policy does not allow the operation","headers":{"X-Request-ID":{"description":"Request identifier echoed for support and reconciliation.","schema":{"type":"string"}}},"content":{"application/json":{"schema":{"$ref":"#/components/schemas/ApiResponseVoid"}}}},"200":{"description":"OK","headers":{"X-Request-ID":{"description":"Request identifier echoed for support and reconciliation.","schema":{"type":"string"}},"X-Quota-Limit":{"description":"Monthly API request allowance for the subscription.","schema":{"type":"integer","format":"int64"}},"X-Quota-Remaining":{"description":"Requests remaining in the current monthly allowance after this request.","schema":{"type":"integer","format":"int64"}},"X-Quota-Reset":{"description":"Unix epoch time in seconds when the monthly allowance resets.","schema":{"type":"integer","format":"int64"}},"X-Quota-Workspace":{"description":"Verified workspace owning this allowance: personal or enterprise:<id>.","schema":{"type":"string"}},"X-Quota-Environment":{"description":"Environment owning the allowance: sandbox or live.","schema":{"type":"string"}}},"content":{"application/json":{"schema":{"$ref":"#/components/schemas/ApiResponseDocumentUpload"}}}},"401":{"description":"Invalid API key, content hash, signature, timestamp or request ID","headers":{"X-Request-ID":{"description":"Request identifier echoed for support and reconciliation.","schema":{"type":"string"}}},"content":{"application/json":{"schema":{"$ref":"#/components/schemas/ApiResponseVoid"}}}},"404":{"description":"Resource not found in this enterprise and environment","headers":{"X-Request-ID":{"description":"Request identifier echoed for support and reconciliation.","schema":{"type":"string"}}},"content":{"application/json":{"schema":{"$ref":"#/components/schemas/ApiResponseVoid"}}}},"422":{"description":"Business rule rejected the request","headers":{"X-Request-ID":{"description":"Request identifier echoed for support and reconciliation.","schema":{"type":"string"}}},"content":{"application/json":{"schema":{"$ref":"#/components/schemas/ApiResponseVoid"}}}},"503":{"description":"A required platform service is temporarily unavailable","headers":{"X-Request-ID":{"description":"Request identifier echoed for support and reconciliation.","schema":{"type":"string"}}},"content":{"application/json":{"schema":{"$ref":"#/components/schemas/ApiResponseVoid"}}}},"409":{"description":"Idempotency or resource-state conflict","headers":{"X-Request-ID":{"description":"Request identifier echoed for support and reconciliation.","schema":{"type":"string"}}},"content":{"application/json":{"schema":{"$ref":"#/components/schemas/ApiResponseVoid"}}}},"429":{"description":"Per-minute rate limit or monthly quota exceeded","headers":{"X-Request-ID":{"description":"Request identifier echoed for support and reconciliation.","schema":{"type":"string"}},"X-Quota-Limit":{"description":"Monthly API request allowance for the subscription.","schema":{"type":"integer","format":"int64"}},"X-Quota-Remaining":{"description":"Requests remaining in the current monthly allowance after this request.","schema":{"type":"integer","format":"int64"}},"X-Quota-Reset":{"description":"Unix epoch time in seconds when the monthly allowance resets.","schema":{"type":"integer","format":"int64"}},"X-Quota-Workspace":{"description":"Verified workspace owning this allowance: personal or enterprise:<id>.","schema":{"type":"string"}},"X-Quota-Environment":{"description":"Environment owning the allowance: sandbox or live.","schema":{"type":"string"}},"Retry-After":{"description":"Seconds until the exhausted quota or rate window resets. Sign retries with a new X-Request-ID.","schema":{"type":"integer","format":"int64"}},"X-RateLimit-Scope":{"description":"Rate counter scope: workspace, or user for enterprise verification calls.","schema":{"type":"string"}},"X-RateLimit-Limit":{"description":"Per-minute request limit when rate-limited.","schema":{"type":"integer","format":"int64"}},"X-RateLimit-Remaining":{"description":"Zero when the minute limit is exhausted.","schema":{"type":"integer","format":"int64"}},"X-RateLimit-Reset":{"description":"Unix epoch seconds when the minute limit resets.","schema":{"type":"integer","format":"int64"}}},"content":{"application/json":{"schema":{"$ref":"#/components/schemas/ApiResponseVoid"}}}},"413":{"description":"Request body is too large","headers":{"X-Request-ID":{"description":"Request identifier echoed for support and reconciliation.","schema":{"type":"string"}}},"content":{"application/json":{"schema":{"$ref":"#/components/schemas/ApiResponseVoid"}}}}},"x-dcwallet-signature-versions":["v2"]}},"/api/v1/contacts":{"get":{"tags":["3. Contacts"],"summary":"List enterprise contacts","description":"Omit filters to list all contacts. Enum filters show their accepted values in the online console.\n\nSignature versions: v1 and v2.","operationId":"getContacts","parameters":[{"name":"keyword","in":"query","description":"Case-insensitive search text for the fields named by this operation.","required":false,"schema":{"type":"string"}},{"name":"type","in":"query","description":"Optional filter. Contact role: customer = buyer; supplier = vendor; employee = staff; partner = business partner; contractor = external worker; investor = capital provider; subsidiary = controlled company; self = own entity; other = another relationship.","required":false,"schema":{"type":"string","enum":["customer","supplier","employee","partner","contractor","investor","subsidiary","self","other"]}},{"name":"entityType","in":"query","description":"Optional filter. Legal entity type: individual = natural person; company = organization.","required":false,"schema":{"type":"string","enum":["individual","company"]}},{"name":"externalReference","in":"query","description":"Stable contact reference assigned by the API customer.","required":false,"schema":{"type":"string"}},{"name":"complianceStatus","in":"query","description":"Optional filter. AML result: pending = not finished; clear = no blocking match; review_required = manual review needed; blocked = issuing and payment use is prohibited. This is a current screening result and can be re-evaluated; no permanent terminal value.","required":false,"schema":{"type":"string","enum":["pending","clear","review_required","blocked"]}},{"name":"page","in":"query","description":"One-based result page number.","required":false,"schema":{"type":"integer","format":"int32","default":1}},{"name":"pageSize","in":"query","description":"Maximum records returned per page; values above 100 are capped.","required":false,"schema":{"type":"integer","format":"int32","default":20}},{"name":"X-Timestamp","in":"header","description":"Current Unix epoch time in seconds. Requests older or newer than five minutes are rejected.","required":true,"schema":{"pattern":"[0-9]{10}","type":"string","example":"1787562000"}},{"name":"X-Request-ID","in":"header","description":"Unique 16-128 character request identifier used for replay protection; never reuse it for a different HTTP request.","required":true,"schema":{"pattern":"[A-Za-z0-9._:-]{16,128}","type":"string","example":"018f6f4e-8f62-7fc2-9c4b-7be2f4203b6a"}},{"name":"X-Content-SHA256","in":"header","description":"Lowercase hexadecimal SHA-256 digest of the exact raw request body; use the digest of zero bytes when no body is sent.","required":true,"schema":{"pattern":"[0-9a-f]{64}","type":"string","example":"e3b0c44298fc1c149afbf4c8996fb92427ae41e4649b934ca495991b7852b855"}},{"name":"X-Workspace","in":"header","description":"Enterprise reads are available on this route. For enterprise access, copy your own enterprise:<id> from GET /api/v1/workspaces. Required for v2 requests. V1 requests use the historical key's fixed enterprise.","required":false,"schema":{"pattern":"personal|enterprise:[1-9][0-9]*","type":"string","example":null}},{"name":"X-Environment","in":"header","description":"Required and signed for v2 requests: live or sandbox. Optional for v1 requests.","required":false,"schema":{"pattern":"live|sandbox","type":"string","example":"live"}},{"name":"X-Signature","in":"header","description":"Existing keys accept v1 for their fixed enterprise or v2 for a signed workspace; new keys accept v2 only.","required":true,"schema":{"pattern":"v[12]=[0-9a-f]{64}","type":"string","example":"v2=0123456789abcdef0123456789abcdef0123456789abcdef0123456789abcdef"}},{"name":"Accept-Language","in":"header","description":"Response language: en-US = English (default); zh-CN = Simplified Chinese; zh-TW = Traditional Chinese. Numeric error codes are language-neutral.","required":false,"schema":{"type":"string","enum":["en-US","zh-CN","zh-TW"],"default":"en-US"}}],"responses":{"400":{"description":"Malformed JSON, missing header or invalid request parameter","headers":{"X-Request-ID":{"description":"Request identifier echoed for support and reconciliation.","schema":{"type":"string"}}},"content":{"application/json":{"schema":{"$ref":"#/components/schemas/ApiResponseVoid"}}}},"500":{"description":"Unexpected internal error; contact support with X-Request-ID","headers":{"X-Request-ID":{"description":"Request identifier echoed for support and reconciliation.","schema":{"type":"string"}}},"content":{"application/json":{"schema":{"$ref":"#/components/schemas/ApiResponseVoid"}}}},"403":{"description":"API-key scope, subscription, tenant or policy does not allow the operation","headers":{"X-Request-ID":{"description":"Request identifier echoed for support and reconciliation.","schema":{"type":"string"}}},"content":{"application/json":{"schema":{"$ref":"#/components/schemas/ApiResponseVoid"}}}},"200":{"description":"OK","headers":{"X-Request-ID":{"description":"Request identifier echoed for support and reconciliation.","schema":{"type":"string"}},"X-Quota-Limit":{"description":"Monthly API request allowance for the subscription.","schema":{"type":"integer","format":"int64"}},"X-Quota-Remaining":{"description":"Requests remaining in the current monthly allowance after this request.","schema":{"type":"integer","format":"int64"}},"X-Quota-Reset":{"description":"Unix epoch time in seconds when the monthly allowance resets.","schema":{"type":"integer","format":"int64"}},"X-Quota-Workspace":{"description":"Verified workspace owning this allowance: personal or enterprise:<id>.","schema":{"type":"string"}},"X-Quota-Environment":{"description":"Environment owning the allowance: sandbox or live.","schema":{"type":"string"}}},"content":{"application/json":{"schema":{"$ref":"#/components/schemas/ApiResponsePageDataContactResponse"}}}},"401":{"description":"Invalid API key, content hash, signature, timestamp or request ID","headers":{"X-Request-ID":{"description":"Request identifier echoed for support and reconciliation.","schema":{"type":"string"}}},"content":{"application/json":{"schema":{"$ref":"#/components/schemas/ApiResponseVoid"}}}},"404":{"description":"Resource not found in this enterprise and environment","headers":{"X-Request-ID":{"description":"Request identifier echoed for support and reconciliation.","schema":{"type":"string"}}},"content":{"application/json":{"schema":{"$ref":"#/components/schemas/ApiResponseVoid"}}}},"422":{"description":"Business rule rejected the request","headers":{"X-Request-ID":{"description":"Request identifier echoed for support and reconciliation.","schema":{"type":"string"}}},"content":{"application/json":{"schema":{"$ref":"#/components/schemas/ApiResponseVoid"}}}},"503":{"description":"A required platform service is temporarily unavailable","headers":{"X-Request-ID":{"description":"Request identifier echoed for support and reconciliation.","schema":{"type":"string"}}},"content":{"application/json":{"schema":{"$ref":"#/components/schemas/ApiResponseVoid"}}}},"409":{"description":"Idempotency or resource-state conflict","headers":{"X-Request-ID":{"description":"Request identifier echoed for support and reconciliation.","schema":{"type":"string"}}},"content":{"application/json":{"schema":{"$ref":"#/components/schemas/ApiResponseVoid"}}}},"429":{"description":"Per-minute rate limit or monthly quota exceeded","headers":{"X-Request-ID":{"description":"Request identifier echoed for support and reconciliation.","schema":{"type":"string"}},"X-Quota-Limit":{"description":"Monthly API request allowance for the subscription.","schema":{"type":"integer","format":"int64"}},"X-Quota-Remaining":{"description":"Requests remaining in the current monthly allowance after this request.","schema":{"type":"integer","format":"int64"}},"X-Quota-Reset":{"description":"Unix epoch time in seconds when the monthly allowance resets.","schema":{"type":"integer","format":"int64"}},"X-Quota-Workspace":{"description":"Verified workspace owning this allowance: personal or enterprise:<id>.","schema":{"type":"string"}},"X-Quota-Environment":{"description":"Environment owning the allowance: sandbox or live.","schema":{"type":"string"}},"Retry-After":{"description":"Seconds until the exhausted quota or rate window resets. Sign retries with a new X-Request-ID.","schema":{"type":"integer","format":"int64"}},"X-RateLimit-Scope":{"description":"Rate counter scope: workspace, or user for enterprise verification calls.","schema":{"type":"string"}},"X-RateLimit-Limit":{"description":"Per-minute request limit when rate-limited.","schema":{"type":"integer","format":"int64"}},"X-RateLimit-Remaining":{"description":"Zero when the minute limit is exhausted.","schema":{"type":"integer","format":"int64"}},"X-RateLimit-Reset":{"description":"Unix epoch seconds when the minute limit resets.","schema":{"type":"integer","format":"int64"}}},"content":{"application/json":{"schema":{"$ref":"#/components/schemas/ApiResponseVoid"}}}},"413":{"description":"Request body is too large","headers":{"X-Request-ID":{"description":"Request identifier echoed for support and reconciliation.","schema":{"type":"string"}}},"content":{"application/json":{"schema":{"$ref":"#/components/schemas/ApiResponseVoid"}}}}},"x-dcwallet-signature-versions":["v1","v2"]},"post":{"tags":["3. Contacts"],"summary":"Create an enterprise contact","description":"Create one shared contact for receivables and card issuing. Reuse externalReference and the same Idempotency-Key when retrying the same request.\n\nSignature versions: v1 and v2.","operationId":"postContacts","parameters":[{"name":"Idempotency-Key","in":"header","description":"Unique key for one mutating request. Reuse the same value only when retrying the same operation.","required":true,"schema":{"type":"string"}},{"name":"X-Timestamp","in":"header","description":"Current Unix epoch time in seconds. Requests older or newer than five minutes are rejected.","required":true,"schema":{"pattern":"[0-9]{10}","type":"string","example":"1787562000"}},{"name":"X-Request-ID","in":"header","description":"Unique 16-128 character request identifier used for replay protection; never reuse it for a different HTTP request.","required":true,"schema":{"pattern":"[A-Za-z0-9._:-]{16,128}","type":"string","example":"018f6f4e-8f62-7fc2-9c4b-7be2f4203b6a"}},{"name":"X-Content-SHA256","in":"header","description":"Lowercase hexadecimal SHA-256 digest of the exact raw request body; use the digest of zero bytes when no body is sent.","required":true,"schema":{"pattern":"[0-9a-f]{64}","type":"string","example":"e3b0c44298fc1c149afbf4c8996fb92427ae41e4649b934ca495991b7852b855"}},{"name":"X-Workspace","in":"header","description":"Enterprise writes are available on this route. For enterprise access, copy your own enterprise:<id> from GET /api/v1/workspaces. Required for v2 requests. V1 requests use the historical key's fixed enterprise.","required":false,"schema":{"pattern":"personal|enterprise:[1-9][0-9]*","type":"string","example":null}},{"name":"X-Environment","in":"header","description":"Required and signed for v2 requests: live or sandbox. Optional for v1 requests.","required":false,"schema":{"pattern":"live|sandbox","type":"string","example":"live"}},{"name":"X-Signature","in":"header","description":"Existing keys accept v1 for their fixed enterprise or v2 for a signed workspace; new keys accept v2 only.","required":true,"schema":{"pattern":"v[12]=[0-9a-f]{64}","type":"string","example":"v2=0123456789abcdef0123456789abcdef0123456789abcdef0123456789abcdef"}},{"name":"Accept-Language","in":"header","description":"Response language: en-US = English (default); zh-CN = Simplified Chinese; zh-TW = Traditional Chinese. Numeric error codes are language-neutral.","required":false,"schema":{"type":"string","enum":["en-US","zh-CN","zh-TW"],"default":"en-US"}}],"requestBody":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/ContactRequest"}}},"required":true},"responses":{"400":{"description":"Malformed JSON, missing header or invalid request parameter","headers":{"X-Request-ID":{"description":"Request identifier echoed for support and reconciliation.","schema":{"type":"string"}}},"content":{"application/json":{"schema":{"$ref":"#/components/schemas/ApiResponseVoid"}}}},"500":{"description":"Unexpected internal error; contact support with X-Request-ID","headers":{"X-Request-ID":{"description":"Request identifier echoed for support and reconciliation.","schema":{"type":"string"}}},"content":{"application/json":{"schema":{"$ref":"#/components/schemas/ApiResponseVoid"}}}},"403":{"description":"API-key scope, subscription, tenant or policy does not allow the operation","headers":{"X-Request-ID":{"description":"Request identifier echoed for support and reconciliation.","schema":{"type":"string"}}},"content":{"application/json":{"schema":{"$ref":"#/components/schemas/ApiResponseVoid"}}}},"200":{"description":"OK","headers":{"X-Request-ID":{"description":"Request identifier echoed for support and reconciliation.","schema":{"type":"string"}},"X-Quota-Limit":{"description":"Monthly API request allowance for the subscription.","schema":{"type":"integer","format":"int64"}},"X-Quota-Remaining":{"description":"Requests remaining in the current monthly allowance after this request.","schema":{"type":"integer","format":"int64"}},"X-Quota-Reset":{"description":"Unix epoch time in seconds when the monthly allowance resets.","schema":{"type":"integer","format":"int64"}},"X-Quota-Workspace":{"description":"Verified workspace owning this allowance: personal or enterprise:<id>.","schema":{"type":"string"}},"X-Quota-Environment":{"description":"Environment owning the allowance: sandbox or live.","schema":{"type":"string"}}},"content":{"application/json":{"schema":{"$ref":"#/components/schemas/ApiResponseContactResponse"}}}},"401":{"description":"Invalid API key, content hash, signature, timestamp or request ID","headers":{"X-Request-ID":{"description":"Request identifier echoed for support and reconciliation.","schema":{"type":"string"}}},"content":{"application/json":{"schema":{"$ref":"#/components/schemas/ApiResponseVoid"}}}},"404":{"description":"Resource not found in this enterprise and environment","headers":{"X-Request-ID":{"description":"Request identifier echoed for support and reconciliation.","schema":{"type":"string"}}},"content":{"application/json":{"schema":{"$ref":"#/components/schemas/ApiResponseVoid"}}}},"422":{"description":"Business rule rejected the request","headers":{"X-Request-ID":{"description":"Request identifier echoed for support and reconciliation.","schema":{"type":"string"}}},"content":{"application/json":{"schema":{"$ref":"#/components/schemas/ApiResponseVoid"}}}},"503":{"description":"A required platform service is temporarily unavailable","headers":{"X-Request-ID":{"description":"Request identifier echoed for support and reconciliation.","schema":{"type":"string"}}},"content":{"application/json":{"schema":{"$ref":"#/components/schemas/ApiResponseVoid"}}}},"409":{"description":"Idempotency or resource-state conflict","headers":{"X-Request-ID":{"description":"Request identifier echoed for support and reconciliation.","schema":{"type":"string"}}},"content":{"application/json":{"schema":{"$ref":"#/components/schemas/ApiResponseVoid"}}}},"429":{"description":"Per-minute rate limit or monthly quota exceeded","headers":{"X-Request-ID":{"description":"Request identifier echoed for support and reconciliation.","schema":{"type":"string"}},"X-Quota-Limit":{"description":"Monthly API request allowance for the subscription.","schema":{"type":"integer","format":"int64"}},"X-Quota-Remaining":{"description":"Requests remaining in the current monthly allowance after this request.","schema":{"type":"integer","format":"int64"}},"X-Quota-Reset":{"description":"Unix epoch time in seconds when the monthly allowance resets.","schema":{"type":"integer","format":"int64"}},"X-Quota-Workspace":{"description":"Verified workspace owning this allowance: personal or enterprise:<id>.","schema":{"type":"string"}},"X-Quota-Environment":{"description":"Environment owning the allowance: sandbox or live.","schema":{"type":"string"}},"Retry-After":{"description":"Seconds until the exhausted quota or rate window resets. Sign retries with a new X-Request-ID.","schema":{"type":"integer","format":"int64"}},"X-RateLimit-Scope":{"description":"Rate counter scope: workspace, or user for enterprise verification calls.","schema":{"type":"string"}},"X-RateLimit-Limit":{"description":"Per-minute request limit when rate-limited.","schema":{"type":"integer","format":"int64"}},"X-RateLimit-Remaining":{"description":"Zero when the minute limit is exhausted.","schema":{"type":"integer","format":"int64"}},"X-RateLimit-Reset":{"description":"Unix epoch seconds when the minute limit resets.","schema":{"type":"integer","format":"int64"}}},"content":{"application/json":{"schema":{"$ref":"#/components/schemas/ApiResponseVoid"}}}},"413":{"description":"Request body is too large","headers":{"X-Request-ID":{"description":"Request identifier echoed for support and reconciliation.","schema":{"type":"string"}}},"content":{"application/json":{"schema":{"$ref":"#/components/schemas/ApiResponseVoid"}}}}},"x-dcwallet-signature-versions":["v1","v2"]}},"/api/v1/contacts/{contactId}/documents/{role}":{"post":{"tags":["3. Contacts"],"summary":"Upload an identity document using the raw file bytes","description":"Use role passport for a passport, or upload both identity_front and identity_back for an identity card. Send the exact file bytes, not JSON or base64.\n\nSignature versions: v1 and v2.","operationId":"postContactsByContactIdDocumentsByRole","parameters":[{"name":"contactId","in":"path","description":"Enterprise contact ID returned by /api/v1/contacts. Keep IDs as strings.","required":true,"schema":{"pattern":"[0-9]+","type":"string","example":"337893979704000512"}},{"name":"Idempotency-Key","in":"header","description":"Required for v2 signed POST/PATCH requests, including read-only previews; optional for historical v1 requests. Reuse the same value when retrying the same operation.","required":false,"schema":{"type":"string"}},{"name":"X-Content-SHA256","in":"header","description":"The x-content-sha256 value for this resource.","required":true,"schema":{"type":"string"}},{"name":"role","in":"path","description":"Identity document image role, with no default: passport = passport image; identity_front = front of identity card; identity_back = back of identity card.","required":true,"schema":{"type":"string","enum":["passport","identity_front","identity_back"]}},{"name":"X-File-Name","in":"header","description":"Original file name","required":false,"schema":{"type":"string"}},{"name":"Content-Type","in":"header","description":"Raw upload media type supported by this endpoint's request body.","required":false,"schema":{"type":"string","default":"application/octet-stream"}},{"name":"X-Timestamp","in":"header","description":"Current Unix epoch time in seconds. Requests older or newer than five minutes are rejected.","required":true,"schema":{"pattern":"[0-9]{10}","type":"string","example":"1787562000"}},{"name":"X-Request-ID","in":"header","description":"Unique 16-128 character request identifier used for replay protection; never reuse it for a different HTTP request.","required":true,"schema":{"pattern":"[A-Za-z0-9._:-]{16,128}","type":"string","example":"018f6f4e-8f62-7fc2-9c4b-7be2f4203b6a"}},{"name":"X-Workspace","in":"header","description":"Enterprise writes are available on this route. For enterprise access, copy your own enterprise:<id> from GET /api/v1/workspaces. Required for v2 requests. V1 requests use the historical key's fixed enterprise.","required":false,"schema":{"pattern":"personal|enterprise:[1-9][0-9]*","type":"string","example":null}},{"name":"X-Environment","in":"header","description":"Required and signed for v2 requests: live or sandbox. Optional for v1 requests.","required":false,"schema":{"pattern":"live|sandbox","type":"string","example":"live"}},{"name":"X-Signature","in":"header","description":"Existing keys accept v1 for their fixed enterprise or v2 for a signed workspace; new keys accept v2 only.","required":true,"schema":{"pattern":"v[12]=[0-9a-f]{64}","type":"string","example":"v2=0123456789abcdef0123456789abcdef0123456789abcdef0123456789abcdef"}},{"name":"Accept-Language","in":"header","description":"Response language: en-US = English (default); zh-CN = Simplified Chinese; zh-TW = Traditional Chinese. Numeric error codes are language-neutral.","required":false,"schema":{"type":"string","enum":["en-US","zh-CN","zh-TW"],"default":"en-US"}}],"requestBody":{"content":{"application/octet-stream":{"schema":{"type":"string","format":"binary"}},"image/jpeg":{"schema":{"type":"string","format":"binary"}},"image/png":{"schema":{"type":"string","format":"binary"}}},"required":true},"responses":{"400":{"description":"Malformed JSON, missing header or invalid request parameter","headers":{"X-Request-ID":{"description":"Request identifier echoed for support and reconciliation.","schema":{"type":"string"}}},"content":{"application/json":{"schema":{"$ref":"#/components/schemas/ApiResponseVoid"}}}},"500":{"description":"Unexpected internal error; contact support with X-Request-ID","headers":{"X-Request-ID":{"description":"Request identifier echoed for support and reconciliation.","schema":{"type":"string"}}},"content":{"application/json":{"schema":{"$ref":"#/components/schemas/ApiResponseVoid"}}}},"403":{"description":"API-key scope, subscription, tenant or policy does not allow the operation","headers":{"X-Request-ID":{"description":"Request identifier echoed for support and reconciliation.","schema":{"type":"string"}}},"content":{"application/json":{"schema":{"$ref":"#/components/schemas/ApiResponseVoid"}}}},"200":{"description":"OK","headers":{"X-Request-ID":{"description":"Request identifier echoed for support and reconciliation.","schema":{"type":"string"}},"X-Quota-Limit":{"description":"Monthly API request allowance for the subscription.","schema":{"type":"integer","format":"int64"}},"X-Quota-Remaining":{"description":"Requests remaining in the current monthly allowance after this request.","schema":{"type":"integer","format":"int64"}},"X-Quota-Reset":{"description":"Unix epoch time in seconds when the monthly allowance resets.","schema":{"type":"integer","format":"int64"}},"X-Quota-Workspace":{"description":"Verified workspace owning this allowance: personal or enterprise:<id>.","schema":{"type":"string"}},"X-Quota-Environment":{"description":"Environment owning the allowance: sandbox or live.","schema":{"type":"string"}}},"content":{"application/json":{"schema":{"$ref":"#/components/schemas/ApiResponseDocumentResponse"}}}},"401":{"description":"Invalid API key, content hash, signature, timestamp or request ID","headers":{"X-Request-ID":{"description":"Request identifier echoed for support and reconciliation.","schema":{"type":"string"}}},"content":{"application/json":{"schema":{"$ref":"#/components/schemas/ApiResponseVoid"}}}},"404":{"description":"Resource not found in this enterprise and environment","headers":{"X-Request-ID":{"description":"Request identifier echoed for support and reconciliation.","schema":{"type":"string"}}},"content":{"application/json":{"schema":{"$ref":"#/components/schemas/ApiResponseVoid"}}}},"422":{"description":"Business rule rejected the request","headers":{"X-Request-ID":{"description":"Request identifier echoed for support and reconciliation.","schema":{"type":"string"}}},"content":{"application/json":{"schema":{"$ref":"#/components/schemas/ApiResponseVoid"}}}},"503":{"description":"A required platform service is temporarily unavailable","headers":{"X-Request-ID":{"description":"Request identifier echoed for support and reconciliation.","schema":{"type":"string"}}},"content":{"application/json":{"schema":{"$ref":"#/components/schemas/ApiResponseVoid"}}}},"409":{"description":"Idempotency or resource-state conflict","headers":{"X-Request-ID":{"description":"Request identifier echoed for support and reconciliation.","schema":{"type":"string"}}},"content":{"application/json":{"schema":{"$ref":"#/components/schemas/ApiResponseVoid"}}}},"429":{"description":"Per-minute rate limit or monthly quota exceeded","headers":{"X-Request-ID":{"description":"Request identifier echoed for support and reconciliation.","schema":{"type":"string"}},"X-Quota-Limit":{"description":"Monthly API request allowance for the subscription.","schema":{"type":"integer","format":"int64"}},"X-Quota-Remaining":{"description":"Requests remaining in the current monthly allowance after this request.","schema":{"type":"integer","format":"int64"}},"X-Quota-Reset":{"description":"Unix epoch time in seconds when the monthly allowance resets.","schema":{"type":"integer","format":"int64"}},"X-Quota-Workspace":{"description":"Verified workspace owning this allowance: personal or enterprise:<id>.","schema":{"type":"string"}},"X-Quota-Environment":{"description":"Environment owning the allowance: sandbox or live.","schema":{"type":"string"}},"Retry-After":{"description":"Seconds until the exhausted quota or rate window resets. Sign retries with a new X-Request-ID.","schema":{"type":"integer","format":"int64"}},"X-RateLimit-Scope":{"description":"Rate counter scope: workspace, or user for enterprise verification calls.","schema":{"type":"string"}},"X-RateLimit-Limit":{"description":"Per-minute request limit when rate-limited.","schema":{"type":"integer","format":"int64"}},"X-RateLimit-Remaining":{"description":"Zero when the minute limit is exhausted.","schema":{"type":"integer","format":"int64"}},"X-RateLimit-Reset":{"description":"Unix epoch seconds when the minute limit resets.","schema":{"type":"integer","format":"int64"}}},"content":{"application/json":{"schema":{"$ref":"#/components/schemas/ApiResponseVoid"}}}},"413":{"description":"Request body is too large","headers":{"X-Request-ID":{"description":"Request identifier echoed for support and reconciliation.","schema":{"type":"string"}}},"content":{"application/json":{"schema":{"$ref":"#/components/schemas/ApiResponseVoid"}}}}},"x-dcwallet-signature-versions":["v1","v2"]}},"/api/v1/contacts/{contactId}/accounts":{"get":{"tags":["3. Contacts"],"summary":"List contact destination accounts","description":"Returns the bank accounts and blockchain addresses maintained under this contact. Internal platform account and wallet identifiers are not exposed.\n\nSignature versions: v1 and v2.","operationId":"getContactsByContactIdAccounts","parameters":[{"name":"contactId","in":"path","description":"Enterprise contact ID returned by /api/v1/contacts. Keep IDs as strings.","required":true,"schema":{"pattern":"[0-9]+","type":"string","example":"337893979704000512"}},{"name":"X-Timestamp","in":"header","description":"Current Unix epoch time in seconds. Requests older or newer than five minutes are rejected.","required":true,"schema":{"pattern":"[0-9]{10}","type":"string","example":"1787562000"}},{"name":"X-Request-ID","in":"header","description":"Unique 16-128 character request identifier used for replay protection; never reuse it for a different HTTP request.","required":true,"schema":{"pattern":"[A-Za-z0-9._:-]{16,128}","type":"string","example":"018f6f4e-8f62-7fc2-9c4b-7be2f4203b6a"}},{"name":"X-Content-SHA256","in":"header","description":"Lowercase hexadecimal SHA-256 digest of the exact raw request body; use the digest of zero bytes when no body is sent.","required":true,"schema":{"pattern":"[0-9a-f]{64}","type":"string","example":"e3b0c44298fc1c149afbf4c8996fb92427ae41e4649b934ca495991b7852b855"}},{"name":"X-Workspace","in":"header","description":"Enterprise reads are available on this route. For enterprise access, copy your own enterprise:<id> from GET /api/v1/workspaces. Required for v2 requests. V1 requests use the historical key's fixed enterprise.","required":false,"schema":{"pattern":"personal|enterprise:[1-9][0-9]*","type":"string","example":null}},{"name":"X-Environment","in":"header","description":"Required and signed for v2 requests: live or sandbox. Optional for v1 requests.","required":false,"schema":{"pattern":"live|sandbox","type":"string","example":"live"}},{"name":"X-Signature","in":"header","description":"Existing keys accept v1 for their fixed enterprise or v2 for a signed workspace; new keys accept v2 only.","required":true,"schema":{"pattern":"v[12]=[0-9a-f]{64}","type":"string","example":"v2=0123456789abcdef0123456789abcdef0123456789abcdef0123456789abcdef"}},{"name":"Accept-Language","in":"header","description":"Response language: en-US = English (default); zh-CN = Simplified Chinese; zh-TW = Traditional Chinese. Numeric error codes are language-neutral.","required":false,"schema":{"type":"string","enum":["en-US","zh-CN","zh-TW"],"default":"en-US"}}],"responses":{"400":{"description":"Malformed JSON, missing header or invalid request parameter","headers":{"X-Request-ID":{"description":"Request identifier echoed for support and reconciliation.","schema":{"type":"string"}}},"content":{"application/json":{"schema":{"$ref":"#/components/schemas/ApiResponseVoid"}}}},"500":{"description":"Unexpected internal error; contact support with X-Request-ID","headers":{"X-Request-ID":{"description":"Request identifier echoed for support and reconciliation.","schema":{"type":"string"}}},"content":{"application/json":{"schema":{"$ref":"#/components/schemas/ApiResponseVoid"}}}},"403":{"description":"API-key scope, subscription, tenant or policy does not allow the operation","headers":{"X-Request-ID":{"description":"Request identifier echoed for support and reconciliation.","schema":{"type":"string"}}},"content":{"application/json":{"schema":{"$ref":"#/components/schemas/ApiResponseVoid"}}}},"200":{"description":"OK","headers":{"X-Request-ID":{"description":"Request identifier echoed for support and reconciliation.","schema":{"type":"string"}},"X-Quota-Limit":{"description":"Monthly API request allowance for the subscription.","schema":{"type":"integer","format":"int64"}},"X-Quota-Remaining":{"description":"Requests remaining in the current monthly allowance after this request.","schema":{"type":"integer","format":"int64"}},"X-Quota-Reset":{"description":"Unix epoch time in seconds when the monthly allowance resets.","schema":{"type":"integer","format":"int64"}},"X-Quota-Workspace":{"description":"Verified workspace owning this allowance: personal or enterprise:<id>.","schema":{"type":"string"}},"X-Quota-Environment":{"description":"Environment owning the allowance: sandbox or live.","schema":{"type":"string"}}},"content":{"application/json":{"schema":{"$ref":"#/components/schemas/ApiResponseListContactAccountResponse"}}}},"401":{"description":"Invalid API key, content hash, signature, timestamp or request ID","headers":{"X-Request-ID":{"description":"Request identifier echoed for support and reconciliation.","schema":{"type":"string"}}},"content":{"application/json":{"schema":{"$ref":"#/components/schemas/ApiResponseVoid"}}}},"404":{"description":"Resource not found in this enterprise and environment","headers":{"X-Request-ID":{"description":"Request identifier echoed for support and reconciliation.","schema":{"type":"string"}}},"content":{"application/json":{"schema":{"$ref":"#/components/schemas/ApiResponseVoid"}}}},"422":{"description":"Business rule rejected the request","headers":{"X-Request-ID":{"description":"Request identifier echoed for support and reconciliation.","schema":{"type":"string"}}},"content":{"application/json":{"schema":{"$ref":"#/components/schemas/ApiResponseVoid"}}}},"503":{"description":"A required platform service is temporarily unavailable","headers":{"X-Request-ID":{"description":"Request identifier echoed for support and reconciliation.","schema":{"type":"string"}}},"content":{"application/json":{"schema":{"$ref":"#/components/schemas/ApiResponseVoid"}}}},"409":{"description":"Idempotency or resource-state conflict","headers":{"X-Request-ID":{"description":"Request identifier echoed for support and reconciliation.","schema":{"type":"string"}}},"content":{"application/json":{"schema":{"$ref":"#/components/schemas/ApiResponseVoid"}}}},"429":{"description":"Per-minute rate limit or monthly quota exceeded","headers":{"X-Request-ID":{"description":"Request identifier echoed for support and reconciliation.","schema":{"type":"string"}},"X-Quota-Limit":{"description":"Monthly API request allowance for the subscription.","schema":{"type":"integer","format":"int64"}},"X-Quota-Remaining":{"description":"Requests remaining in the current monthly allowance after this request.","schema":{"type":"integer","format":"int64"}},"X-Quota-Reset":{"description":"Unix epoch time in seconds when the monthly allowance resets.","schema":{"type":"integer","format":"int64"}},"X-Quota-Workspace":{"description":"Verified workspace owning this allowance: personal or enterprise:<id>.","schema":{"type":"string"}},"X-Quota-Environment":{"description":"Environment owning the allowance: sandbox or live.","schema":{"type":"string"}},"Retry-After":{"description":"Seconds until the exhausted quota or rate window resets. Sign retries with a new X-Request-ID.","schema":{"type":"integer","format":"int64"}},"X-RateLimit-Scope":{"description":"Rate counter scope: workspace, or user for enterprise verification calls.","schema":{"type":"string"}},"X-RateLimit-Limit":{"description":"Per-minute request limit when rate-limited.","schema":{"type":"integer","format":"int64"}},"X-RateLimit-Remaining":{"description":"Zero when the minute limit is exhausted.","schema":{"type":"integer","format":"int64"}},"X-RateLimit-Reset":{"description":"Unix epoch seconds when the minute limit resets.","schema":{"type":"integer","format":"int64"}}},"content":{"application/json":{"schema":{"$ref":"#/components/schemas/ApiResponseVoid"}}}},"413":{"description":"Request body is too large","headers":{"X-Request-ID":{"description":"Request identifier echoed for support and reconciliation.","schema":{"type":"string"}}},"content":{"application/json":{"schema":{"$ref":"#/components/schemas/ApiResponseVoid"}}}}},"x-dcwallet-signature-versions":["v1","v2"]},"post":{"tags":["3. Contacts"],"summary":"Add a contact destination account","description":"Use type blockchain with network and address. For type bank, bankName, bankCountryCode, bankAddress, accountNumber, accountHolder and currency are required; mainland CNY accounts may omit bankAddress. Blockchain networks come from GET /api/v1/assets.\n\nSignature versions: v1 and v2.","operationId":"postContactsByContactIdAccounts","parameters":[{"name":"contactId","in":"path","description":"Enterprise contact ID returned by /api/v1/contacts. Keep IDs as strings.","required":true,"schema":{"pattern":"[0-9]+","type":"string","example":"337893979704000512"}},{"name":"Idempotency-Key","in":"header","description":"Required for v2 signed POST/PATCH requests, including read-only previews; optional for historical v1 requests. Reuse the same value when retrying the same operation.","required":false,"schema":{"type":"string"}},{"name":"X-Content-SHA256","in":"header","description":"The x-content-sha256 value for this resource.","required":true,"schema":{"type":"string"}},{"name":"X-Timestamp","in":"header","description":"Current Unix epoch time in seconds. Requests older or newer than five minutes are rejected.","required":true,"schema":{"pattern":"[0-9]{10}","type":"string","example":"1787562000"}},{"name":"X-Request-ID","in":"header","description":"Unique 16-128 character request identifier used for replay protection; never reuse it for a different HTTP request.","required":true,"schema":{"pattern":"[A-Za-z0-9._:-]{16,128}","type":"string","example":"018f6f4e-8f62-7fc2-9c4b-7be2f4203b6a"}},{"name":"X-Workspace","in":"header","description":"Enterprise writes are available on this route. For enterprise access, copy your own enterprise:<id> from GET /api/v1/workspaces. Required for v2 requests. V1 requests use the historical key's fixed enterprise.","required":false,"schema":{"pattern":"personal|enterprise:[1-9][0-9]*","type":"string","example":null}},{"name":"X-Environment","in":"header","description":"Required and signed for v2 requests: live or sandbox. Optional for v1 requests.","required":false,"schema":{"pattern":"live|sandbox","type":"string","example":"live"}},{"name":"X-Signature","in":"header","description":"Existing keys accept v1 for their fixed enterprise or v2 for a signed workspace; new keys accept v2 only.","required":true,"schema":{"pattern":"v[12]=[0-9a-f]{64}","type":"string","example":"v2=0123456789abcdef0123456789abcdef0123456789abcdef0123456789abcdef"}},{"name":"Accept-Language","in":"header","description":"Response language: en-US = English (default); zh-CN = Simplified Chinese; zh-TW = Traditional Chinese. Numeric error codes are language-neutral.","required":false,"schema":{"type":"string","enum":["en-US","zh-CN","zh-TW"],"default":"en-US"}}],"requestBody":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/ContactAccountRequest"}}},"required":true},"responses":{"400":{"description":"Malformed JSON, missing header or invalid request parameter","headers":{"X-Request-ID":{"description":"Request identifier echoed for support and reconciliation.","schema":{"type":"string"}}},"content":{"application/json":{"schema":{"$ref":"#/components/schemas/ApiResponseVoid"}}}},"500":{"description":"Unexpected internal error; contact support with X-Request-ID","headers":{"X-Request-ID":{"description":"Request identifier echoed for support and reconciliation.","schema":{"type":"string"}}},"content":{"application/json":{"schema":{"$ref":"#/components/schemas/ApiResponseVoid"}}}},"403":{"description":"API-key scope, subscription, tenant or policy does not allow the operation","headers":{"X-Request-ID":{"description":"Request identifier echoed for support and reconciliation.","schema":{"type":"string"}}},"content":{"application/json":{"schema":{"$ref":"#/components/schemas/ApiResponseVoid"}}}},"200":{"description":"OK","headers":{"X-Request-ID":{"description":"Request identifier echoed for support and reconciliation.","schema":{"type":"string"}},"X-Quota-Limit":{"description":"Monthly API request allowance for the subscription.","schema":{"type":"integer","format":"int64"}},"X-Quota-Remaining":{"description":"Requests remaining in the current monthly allowance after this request.","schema":{"type":"integer","format":"int64"}},"X-Quota-Reset":{"description":"Unix epoch time in seconds when the monthly allowance resets.","schema":{"type":"integer","format":"int64"}},"X-Quota-Workspace":{"description":"Verified workspace owning this allowance: personal or enterprise:<id>.","schema":{"type":"string"}},"X-Quota-Environment":{"description":"Environment owning the allowance: sandbox or live.","schema":{"type":"string"}}},"content":{"application/json":{"schema":{"$ref":"#/components/schemas/ApiResponseContactAccountResponse"}}}},"401":{"description":"Invalid API key, content hash, signature, timestamp or request ID","headers":{"X-Request-ID":{"description":"Request identifier echoed for support and reconciliation.","schema":{"type":"string"}}},"content":{"application/json":{"schema":{"$ref":"#/components/schemas/ApiResponseVoid"}}}},"404":{"description":"Resource not found in this enterprise and environment","headers":{"X-Request-ID":{"description":"Request identifier echoed for support and reconciliation.","schema":{"type":"string"}}},"content":{"application/json":{"schema":{"$ref":"#/components/schemas/ApiResponseVoid"}}}},"422":{"description":"Business rule rejected the request","headers":{"X-Request-ID":{"description":"Request identifier echoed for support and reconciliation.","schema":{"type":"string"}}},"content":{"application/json":{"schema":{"$ref":"#/components/schemas/ApiResponseVoid"}}}},"503":{"description":"A required platform service is temporarily unavailable","headers":{"X-Request-ID":{"description":"Request identifier echoed for support and reconciliation.","schema":{"type":"string"}}},"content":{"application/json":{"schema":{"$ref":"#/components/schemas/ApiResponseVoid"}}}},"409":{"description":"Idempotency or resource-state conflict","headers":{"X-Request-ID":{"description":"Request identifier echoed for support and reconciliation.","schema":{"type":"string"}}},"content":{"application/json":{"schema":{"$ref":"#/components/schemas/ApiResponseVoid"}}}},"429":{"description":"Per-minute rate limit or monthly quota exceeded","headers":{"X-Request-ID":{"description":"Request identifier echoed for support and reconciliation.","schema":{"type":"string"}},"X-Quota-Limit":{"description":"Monthly API request allowance for the subscription.","schema":{"type":"integer","format":"int64"}},"X-Quota-Remaining":{"description":"Requests remaining in the current monthly allowance after this request.","schema":{"type":"integer","format":"int64"}},"X-Quota-Reset":{"description":"Unix epoch time in seconds when the monthly allowance resets.","schema":{"type":"integer","format":"int64"}},"X-Quota-Workspace":{"description":"Verified workspace owning this allowance: personal or enterprise:<id>.","schema":{"type":"string"}},"X-Quota-Environment":{"description":"Environment owning the allowance: sandbox or live.","schema":{"type":"string"}},"Retry-After":{"description":"Seconds until the exhausted quota or rate window resets. Sign retries with a new X-Request-ID.","schema":{"type":"integer","format":"int64"}},"X-RateLimit-Scope":{"description":"Rate counter scope: workspace, or user for enterprise verification calls.","schema":{"type":"string"}},"X-RateLimit-Limit":{"description":"Per-minute request limit when rate-limited.","schema":{"type":"integer","format":"int64"}},"X-RateLimit-Remaining":{"description":"Zero when the minute limit is exhausted.","schema":{"type":"integer","format":"int64"}},"X-RateLimit-Reset":{"description":"Unix epoch seconds when the minute limit resets.","schema":{"type":"integer","format":"int64"}}},"content":{"application/json":{"schema":{"$ref":"#/components/schemas/ApiResponseVoid"}}}},"413":{"description":"Request body is too large","headers":{"X-Request-ID":{"description":"Request identifier echoed for support and reconciliation.","schema":{"type":"string"}}},"content":{"application/json":{"schema":{"$ref":"#/components/schemas/ApiResponseVoid"}}}}},"x-dcwallet-signature-versions":["v1","v2"]}},"/api/v1/contacts/{contactId}/accounts/{accountId}/deactivate":{"post":{"tags":["3. Contacts"],"summary":"Deactivate a contact destination account","description":"The account remains in history but cannot be selected for new payments.\n\nSignature versions: v1 and v2.","operationId":"postContactsByContactIdAccountsByAccountIdDeactivate","parameters":[{"name":"contactId","in":"path","description":"Enterprise contact ID returned by /api/v1/contacts. Keep IDs as strings.","required":true,"schema":{"pattern":"[0-9]+","type":"string","example":"337893979704000512"}},{"name":"accountId","in":"path","description":"Account ID returned by the corresponding account list endpoint. Keep IDs as strings.","required":true,"schema":{"pattern":"[0-9]+","type":"string","example":"337893979704000512"}},{"name":"X-Timestamp","in":"header","description":"Current Unix epoch time in seconds. Requests older or newer than five minutes are rejected.","required":true,"schema":{"pattern":"[0-9]{10}","type":"string","example":"1787562000"}},{"name":"X-Request-ID","in":"header","description":"Unique 16-128 character request identifier used for replay protection; never reuse it for a different HTTP request.","required":true,"schema":{"pattern":"[A-Za-z0-9._:-]{16,128}","type":"string","example":"018f6f4e-8f62-7fc2-9c4b-7be2f4203b6a"}},{"name":"X-Content-SHA256","in":"header","description":"Lowercase hexadecimal SHA-256 digest of the exact raw request body; use the digest of zero bytes when no body is sent.","required":true,"schema":{"pattern":"[0-9a-f]{64}","type":"string","example":"e3b0c44298fc1c149afbf4c8996fb92427ae41e4649b934ca495991b7852b855"}},{"name":"X-Workspace","in":"header","description":"Enterprise writes are available on this route. For enterprise access, copy your own enterprise:<id> from GET /api/v1/workspaces. Required for v2 requests. V1 requests use the historical key's fixed enterprise.","required":false,"schema":{"pattern":"personal|enterprise:[1-9][0-9]*","type":"string","example":null}},{"name":"X-Environment","in":"header","description":"Required and signed for v2 requests: live or sandbox. Optional for v1 requests.","required":false,"schema":{"pattern":"live|sandbox","type":"string","example":"live"}},{"name":"X-Signature","in":"header","description":"Existing keys accept v1 for their fixed enterprise or v2 for a signed workspace; new keys accept v2 only.","required":true,"schema":{"pattern":"v[12]=[0-9a-f]{64}","type":"string","example":"v2=0123456789abcdef0123456789abcdef0123456789abcdef0123456789abcdef"}},{"name":"Accept-Language","in":"header","description":"Response language: en-US = English (default); zh-CN = Simplified Chinese; zh-TW = Traditional Chinese. Numeric error codes are language-neutral.","required":false,"schema":{"type":"string","enum":["en-US","zh-CN","zh-TW"],"default":"en-US"}}],"responses":{"400":{"description":"Malformed JSON, missing header or invalid request parameter","headers":{"X-Request-ID":{"description":"Request identifier echoed for support and reconciliation.","schema":{"type":"string"}}},"content":{"application/json":{"schema":{"$ref":"#/components/schemas/ApiResponseVoid"}}}},"500":{"description":"Unexpected internal error; contact support with X-Request-ID","headers":{"X-Request-ID":{"description":"Request identifier echoed for support and reconciliation.","schema":{"type":"string"}}},"content":{"application/json":{"schema":{"$ref":"#/components/schemas/ApiResponseVoid"}}}},"403":{"description":"API-key scope, subscription, tenant or policy does not allow the operation","headers":{"X-Request-ID":{"description":"Request identifier echoed for support and reconciliation.","schema":{"type":"string"}}},"content":{"application/json":{"schema":{"$ref":"#/components/schemas/ApiResponseVoid"}}}},"200":{"description":"OK","headers":{"X-Request-ID":{"description":"Request identifier echoed for support and reconciliation.","schema":{"type":"string"}},"X-Quota-Limit":{"description":"Monthly API request allowance for the subscription.","schema":{"type":"integer","format":"int64"}},"X-Quota-Remaining":{"description":"Requests remaining in the current monthly allowance after this request.","schema":{"type":"integer","format":"int64"}},"X-Quota-Reset":{"description":"Unix epoch time in seconds when the monthly allowance resets.","schema":{"type":"integer","format":"int64"}},"X-Quota-Workspace":{"description":"Verified workspace owning this allowance: personal or enterprise:<id>.","schema":{"type":"string"}},"X-Quota-Environment":{"description":"Environment owning the allowance: sandbox or live.","schema":{"type":"string"}}},"content":{"application/json":{"schema":{"$ref":"#/components/schemas/ApiResponseContactAccountResponse"}}}},"401":{"description":"Invalid API key, content hash, signature, timestamp or request ID","headers":{"X-Request-ID":{"description":"Request identifier echoed for support and reconciliation.","schema":{"type":"string"}}},"content":{"application/json":{"schema":{"$ref":"#/components/schemas/ApiResponseVoid"}}}},"404":{"description":"Resource not found in this enterprise and environment","headers":{"X-Request-ID":{"description":"Request identifier echoed for support and reconciliation.","schema":{"type":"string"}}},"content":{"application/json":{"schema":{"$ref":"#/components/schemas/ApiResponseVoid"}}}},"422":{"description":"Business rule rejected the request","headers":{"X-Request-ID":{"description":"Request identifier echoed for support and reconciliation.","schema":{"type":"string"}}},"content":{"application/json":{"schema":{"$ref":"#/components/schemas/ApiResponseVoid"}}}},"503":{"description":"A required platform service is temporarily unavailable","headers":{"X-Request-ID":{"description":"Request identifier echoed for support and reconciliation.","schema":{"type":"string"}}},"content":{"application/json":{"schema":{"$ref":"#/components/schemas/ApiResponseVoid"}}}},"409":{"description":"Idempotency or resource-state conflict","headers":{"X-Request-ID":{"description":"Request identifier echoed for support and reconciliation.","schema":{"type":"string"}}},"content":{"application/json":{"schema":{"$ref":"#/components/schemas/ApiResponseVoid"}}}},"429":{"description":"Per-minute rate limit or monthly quota exceeded","headers":{"X-Request-ID":{"description":"Request identifier echoed for support and reconciliation.","schema":{"type":"string"}},"X-Quota-Limit":{"description":"Monthly API request allowance for the subscription.","schema":{"type":"integer","format":"int64"}},"X-Quota-Remaining":{"description":"Requests remaining in the current monthly allowance after this request.","schema":{"type":"integer","format":"int64"}},"X-Quota-Reset":{"description":"Unix epoch time in seconds when the monthly allowance resets.","schema":{"type":"integer","format":"int64"}},"X-Quota-Workspace":{"description":"Verified workspace owning this allowance: personal or enterprise:<id>.","schema":{"type":"string"}},"X-Quota-Environment":{"description":"Environment owning the allowance: sandbox or live.","schema":{"type":"string"}},"Retry-After":{"description":"Seconds until the exhausted quota or rate window resets. Sign retries with a new X-Request-ID.","schema":{"type":"integer","format":"int64"}},"X-RateLimit-Scope":{"description":"Rate counter scope: workspace, or user for enterprise verification calls.","schema":{"type":"string"}},"X-RateLimit-Limit":{"description":"Per-minute request limit when rate-limited.","schema":{"type":"integer","format":"int64"}},"X-RateLimit-Remaining":{"description":"Zero when the minute limit is exhausted.","schema":{"type":"integer","format":"int64"}},"X-RateLimit-Reset":{"description":"Unix epoch seconds when the minute limit resets.","schema":{"type":"integer","format":"int64"}}},"content":{"application/json":{"schema":{"$ref":"#/components/schemas/ApiResponseVoid"}}}},"413":{"description":"Request body is too large","headers":{"X-Request-ID":{"description":"Request identifier echoed for support and reconciliation.","schema":{"type":"string"}}},"content":{"application/json":{"schema":{"$ref":"#/components/schemas/ApiResponseVoid"}}}}},"x-dcwallet-signature-versions":["v1","v2"]}},"/api/v1/cards/{cardId}/unfreeze":{"post":{"tags":["6. Card issuing"],"summary":"Unfreeze an enterprise virtual card","description":"May temporarily return through the unfreezing reconciliation state after an unknown channel outcome.\n\nSignature versions: v1 and v2.","operationId":"postCardsByCardIdUnfreeze","parameters":[{"name":"cardId","in":"path","description":"Issued-card ID returned by /api/v1/cards. Keep IDs as strings.","required":true,"schema":{"pattern":"[0-9]+","type":"string","example":"337893979704000512"}},{"name":"Idempotency-Key","in":"header","description":"Unique key for one mutating request. Reuse the same value only when retrying the same operation.","required":true,"schema":{"type":"string"}},{"name":"X-Timestamp","in":"header","description":"Current Unix epoch time in seconds. Requests older or newer than five minutes are rejected.","required":true,"schema":{"pattern":"[0-9]{10}","type":"string","example":"1787562000"}},{"name":"X-Request-ID","in":"header","description":"Unique 16-128 character request identifier used for replay protection; never reuse it for a different HTTP request.","required":true,"schema":{"pattern":"[A-Za-z0-9._:-]{16,128}","type":"string","example":"018f6f4e-8f62-7fc2-9c4b-7be2f4203b6a"}},{"name":"X-Content-SHA256","in":"header","description":"Lowercase hexadecimal SHA-256 digest of the exact raw request body; use the digest of zero bytes when no body is sent.","required":true,"schema":{"pattern":"[0-9a-f]{64}","type":"string","example":"e3b0c44298fc1c149afbf4c8996fb92427ae41e4649b934ca495991b7852b855"}},{"name":"X-Workspace","in":"header","description":"Enterprise writes are available on this route. For enterprise access, copy your own enterprise:<id> from GET /api/v1/workspaces. Required for v2 requests. V1 requests use the historical key's fixed enterprise.","required":false,"schema":{"pattern":"personal|enterprise:[1-9][0-9]*","type":"string","example":null}},{"name":"X-Environment","in":"header","description":"Required and signed for v2 requests: live or sandbox. Optional for v1 requests.","required":false,"schema":{"pattern":"live|sandbox","type":"string","example":"live"}},{"name":"X-Signature","in":"header","description":"Existing keys accept v1 for their fixed enterprise or v2 for a signed workspace; new keys accept v2 only.","required":true,"schema":{"pattern":"v[12]=[0-9a-f]{64}","type":"string","example":"v2=0123456789abcdef0123456789abcdef0123456789abcdef0123456789abcdef"}},{"name":"Accept-Language","in":"header","description":"Response language: en-US = English (default); zh-CN = Simplified Chinese; zh-TW = Traditional Chinese. Numeric error codes are language-neutral.","required":false,"schema":{"type":"string","enum":["en-US","zh-CN","zh-TW"],"default":"en-US"}}],"responses":{"400":{"description":"Malformed JSON, missing header or invalid request parameter","headers":{"X-Request-ID":{"description":"Request identifier echoed for support and reconciliation.","schema":{"type":"string"}}},"content":{"application/json":{"schema":{"$ref":"#/components/schemas/ApiResponseVoid"}}}},"500":{"description":"Unexpected internal error; contact support with X-Request-ID","headers":{"X-Request-ID":{"description":"Request identifier echoed for support and reconciliation.","schema":{"type":"string"}}},"content":{"application/json":{"schema":{"$ref":"#/components/schemas/ApiResponseVoid"}}}},"403":{"description":"API-key scope, subscription, tenant or policy does not allow the operation","headers":{"X-Request-ID":{"description":"Request identifier echoed for support and reconciliation.","schema":{"type":"string"}}},"content":{"application/json":{"schema":{"$ref":"#/components/schemas/ApiResponseVoid"}}}},"200":{"description":"OK","headers":{"X-Request-ID":{"description":"Request identifier echoed for support and reconciliation.","schema":{"type":"string"}},"X-Quota-Limit":{"description":"Monthly API request allowance for the subscription.","schema":{"type":"integer","format":"int64"}},"X-Quota-Remaining":{"description":"Requests remaining in the current monthly allowance after this request.","schema":{"type":"integer","format":"int64"}},"X-Quota-Reset":{"description":"Unix epoch time in seconds when the monthly allowance resets.","schema":{"type":"integer","format":"int64"}},"X-Quota-Workspace":{"description":"Verified workspace owning this allowance: personal or enterprise:<id>.","schema":{"type":"string"}},"X-Quota-Environment":{"description":"Environment owning the allowance: sandbox or live.","schema":{"type":"string"}}},"content":{"application/json":{"schema":{"$ref":"#/components/schemas/ApiResponseCardResponse"}}}},"401":{"description":"Invalid API key, content hash, signature, timestamp or request ID","headers":{"X-Request-ID":{"description":"Request identifier echoed for support and reconciliation.","schema":{"type":"string"}}},"content":{"application/json":{"schema":{"$ref":"#/components/schemas/ApiResponseVoid"}}}},"404":{"description":"Resource not found in this enterprise and environment","headers":{"X-Request-ID":{"description":"Request identifier echoed for support and reconciliation.","schema":{"type":"string"}}},"content":{"application/json":{"schema":{"$ref":"#/components/schemas/ApiResponseVoid"}}}},"422":{"description":"Business rule rejected the request","headers":{"X-Request-ID":{"description":"Request identifier echoed for support and reconciliation.","schema":{"type":"string"}}},"content":{"application/json":{"schema":{"$ref":"#/components/schemas/ApiResponseVoid"}}}},"503":{"description":"A required platform service is temporarily unavailable","headers":{"X-Request-ID":{"description":"Request identifier echoed for support and reconciliation.","schema":{"type":"string"}}},"content":{"application/json":{"schema":{"$ref":"#/components/schemas/ApiResponseVoid"}}}},"409":{"description":"Idempotency or resource-state conflict","headers":{"X-Request-ID":{"description":"Request identifier echoed for support and reconciliation.","schema":{"type":"string"}}},"content":{"application/json":{"schema":{"$ref":"#/components/schemas/ApiResponseVoid"}}}},"429":{"description":"Per-minute rate limit or monthly quota exceeded","headers":{"X-Request-ID":{"description":"Request identifier echoed for support and reconciliation.","schema":{"type":"string"}},"X-Quota-Limit":{"description":"Monthly API request allowance for the subscription.","schema":{"type":"integer","format":"int64"}},"X-Quota-Remaining":{"description":"Requests remaining in the current monthly allowance after this request.","schema":{"type":"integer","format":"int64"}},"X-Quota-Reset":{"description":"Unix epoch time in seconds when the monthly allowance resets.","schema":{"type":"integer","format":"int64"}},"X-Quota-Workspace":{"description":"Verified workspace owning this allowance: personal or enterprise:<id>.","schema":{"type":"string"}},"X-Quota-Environment":{"description":"Environment owning the allowance: sandbox or live.","schema":{"type":"string"}},"Retry-After":{"description":"Seconds until the exhausted quota or rate window resets. Sign retries with a new X-Request-ID.","schema":{"type":"integer","format":"int64"}},"X-RateLimit-Scope":{"description":"Rate counter scope: workspace, or user for enterprise verification calls.","schema":{"type":"string"}},"X-RateLimit-Limit":{"description":"Per-minute request limit when rate-limited.","schema":{"type":"integer","format":"int64"}},"X-RateLimit-Remaining":{"description":"Zero when the minute limit is exhausted.","schema":{"type":"integer","format":"int64"}},"X-RateLimit-Reset":{"description":"Unix epoch seconds when the minute limit resets.","schema":{"type":"integer","format":"int64"}}},"content":{"application/json":{"schema":{"$ref":"#/components/schemas/ApiResponseVoid"}}}},"413":{"description":"Request body is too large","headers":{"X-Request-ID":{"description":"Request identifier echoed for support and reconciliation.","schema":{"type":"string"}}},"content":{"application/json":{"schema":{"$ref":"#/components/schemas/ApiResponseVoid"}}}}},"x-dcwallet-signature-versions":["v1","v2"]}},"/api/v1/cards/{cardId}/top-ups":{"get":{"tags":["6. Card issuing"],"summary":"List card top-ups","description":"Signature versions: v1 and v2.","operationId":"getCardsByCardIdTopUps","parameters":[{"name":"cardId","in":"path","description":"Issued-card ID returned by /api/v1/cards. Keep IDs as strings.","required":true,"schema":{"pattern":"[0-9]+","type":"string","example":"337893979704000512"}},{"name":"page","in":"query","description":"One-based result page number.","required":false,"schema":{"type":"integer","format":"int32","default":1}},{"name":"pageSize","in":"query","description":"Maximum records returned per page; values above 100 are capped.","required":false,"schema":{"type":"integer","format":"int32","default":20}},{"name":"X-Timestamp","in":"header","description":"Current Unix epoch time in seconds. Requests older or newer than five minutes are rejected.","required":true,"schema":{"pattern":"[0-9]{10}","type":"string","example":"1787562000"}},{"name":"X-Request-ID","in":"header","description":"Unique 16-128 character request identifier used for replay protection; never reuse it for a different HTTP request.","required":true,"schema":{"pattern":"[A-Za-z0-9._:-]{16,128}","type":"string","example":"018f6f4e-8f62-7fc2-9c4b-7be2f4203b6a"}},{"name":"X-Content-SHA256","in":"header","description":"Lowercase hexadecimal SHA-256 digest of the exact raw request body; use the digest of zero bytes when no body is sent.","required":true,"schema":{"pattern":"[0-9a-f]{64}","type":"string","example":"e3b0c44298fc1c149afbf4c8996fb92427ae41e4649b934ca495991b7852b855"}},{"name":"X-Workspace","in":"header","description":"Enterprise reads are available on this route. For enterprise access, copy your own enterprise:<id> from GET /api/v1/workspaces. Required for v2 requests. V1 requests use the historical key's fixed enterprise.","required":false,"schema":{"pattern":"personal|enterprise:[1-9][0-9]*","type":"string","example":null}},{"name":"X-Environment","in":"header","description":"Required and signed for v2 requests: live or sandbox. Optional for v1 requests.","required":false,"schema":{"pattern":"live|sandbox","type":"string","example":"live"}},{"name":"X-Signature","in":"header","description":"Existing keys accept v1 for their fixed enterprise or v2 for a signed workspace; new keys accept v2 only.","required":true,"schema":{"pattern":"v[12]=[0-9a-f]{64}","type":"string","example":"v2=0123456789abcdef0123456789abcdef0123456789abcdef0123456789abcdef"}},{"name":"Accept-Language","in":"header","description":"Response language: en-US = English (default); zh-CN = Simplified Chinese; zh-TW = Traditional Chinese. Numeric error codes are language-neutral.","required":false,"schema":{"type":"string","enum":["en-US","zh-CN","zh-TW"],"default":"en-US"}}],"responses":{"400":{"description":"Malformed JSON, missing header or invalid request parameter","headers":{"X-Request-ID":{"description":"Request identifier echoed for support and reconciliation.","schema":{"type":"string"}}},"content":{"application/json":{"schema":{"$ref":"#/components/schemas/ApiResponseVoid"}}}},"500":{"description":"Unexpected internal error; contact support with X-Request-ID","headers":{"X-Request-ID":{"description":"Request identifier echoed for support and reconciliation.","schema":{"type":"string"}}},"content":{"application/json":{"schema":{"$ref":"#/components/schemas/ApiResponseVoid"}}}},"403":{"description":"API-key scope, subscription, tenant or policy does not allow the operation","headers":{"X-Request-ID":{"description":"Request identifier echoed for support and reconciliation.","schema":{"type":"string"}}},"content":{"application/json":{"schema":{"$ref":"#/components/schemas/ApiResponseVoid"}}}},"200":{"description":"OK","headers":{"X-Request-ID":{"description":"Request identifier echoed for support and reconciliation.","schema":{"type":"string"}},"X-Quota-Limit":{"description":"Monthly API request allowance for the subscription.","schema":{"type":"integer","format":"int64"}},"X-Quota-Remaining":{"description":"Requests remaining in the current monthly allowance after this request.","schema":{"type":"integer","format":"int64"}},"X-Quota-Reset":{"description":"Unix epoch time in seconds when the monthly allowance resets.","schema":{"type":"integer","format":"int64"}},"X-Quota-Workspace":{"description":"Verified workspace owning this allowance: personal or enterprise:<id>.","schema":{"type":"string"}},"X-Quota-Environment":{"description":"Environment owning the allowance: sandbox or live.","schema":{"type":"string"}}},"content":{"application/json":{"schema":{"$ref":"#/components/schemas/ApiResponsePageDataCardTransactionResponse"}}}},"401":{"description":"Invalid API key, content hash, signature, timestamp or request ID","headers":{"X-Request-ID":{"description":"Request identifier echoed for support and reconciliation.","schema":{"type":"string"}}},"content":{"application/json":{"schema":{"$ref":"#/components/schemas/ApiResponseVoid"}}}},"404":{"description":"Resource not found in this enterprise and environment","headers":{"X-Request-ID":{"description":"Request identifier echoed for support and reconciliation.","schema":{"type":"string"}}},"content":{"application/json":{"schema":{"$ref":"#/components/schemas/ApiResponseVoid"}}}},"422":{"description":"Business rule rejected the request","headers":{"X-Request-ID":{"description":"Request identifier echoed for support and reconciliation.","schema":{"type":"string"}}},"content":{"application/json":{"schema":{"$ref":"#/components/schemas/ApiResponseVoid"}}}},"503":{"description":"A required platform service is temporarily unavailable","headers":{"X-Request-ID":{"description":"Request identifier echoed for support and reconciliation.","schema":{"type":"string"}}},"content":{"application/json":{"schema":{"$ref":"#/components/schemas/ApiResponseVoid"}}}},"409":{"description":"Idempotency or resource-state conflict","headers":{"X-Request-ID":{"description":"Request identifier echoed for support and reconciliation.","schema":{"type":"string"}}},"content":{"application/json":{"schema":{"$ref":"#/components/schemas/ApiResponseVoid"}}}},"429":{"description":"Per-minute rate limit or monthly quota exceeded","headers":{"X-Request-ID":{"description":"Request identifier echoed for support and reconciliation.","schema":{"type":"string"}},"X-Quota-Limit":{"description":"Monthly API request allowance for the subscription.","schema":{"type":"integer","format":"int64"}},"X-Quota-Remaining":{"description":"Requests remaining in the current monthly allowance after this request.","schema":{"type":"integer","format":"int64"}},"X-Quota-Reset":{"description":"Unix epoch time in seconds when the monthly allowance resets.","schema":{"type":"integer","format":"int64"}},"X-Quota-Workspace":{"description":"Verified workspace owning this allowance: personal or enterprise:<id>.","schema":{"type":"string"}},"X-Quota-Environment":{"description":"Environment owning the allowance: sandbox or live.","schema":{"type":"string"}},"Retry-After":{"description":"Seconds until the exhausted quota or rate window resets. Sign retries with a new X-Request-ID.","schema":{"type":"integer","format":"int64"}},"X-RateLimit-Scope":{"description":"Rate counter scope: workspace, or user for enterprise verification calls.","schema":{"type":"string"}},"X-RateLimit-Limit":{"description":"Per-minute request limit when rate-limited.","schema":{"type":"integer","format":"int64"}},"X-RateLimit-Remaining":{"description":"Zero when the minute limit is exhausted.","schema":{"type":"integer","format":"int64"}},"X-RateLimit-Reset":{"description":"Unix epoch seconds when the minute limit resets.","schema":{"type":"integer","format":"int64"}}},"content":{"application/json":{"schema":{"$ref":"#/components/schemas/ApiResponseVoid"}}}},"413":{"description":"Request body is too large","headers":{"X-Request-ID":{"description":"Request identifier echoed for support and reconciliation.","schema":{"type":"string"}}},"content":{"application/json":{"schema":{"$ref":"#/components/schemas/ApiResponseVoid"}}}}},"x-dcwallet-signature-versions":["v1","v2"]},"post":{"tags":["6. Card issuing"],"summary":"Top up an enterprise card","description":"Uses the card's original funding account. Code 9003 leaves the transaction processing and funds locked until reconciliation.\n\nSignature versions: v1 and v2.","operationId":"postCardsByCardIdTopUps","parameters":[{"name":"cardId","in":"path","description":"Issued-card ID returned by /api/v1/cards. Keep IDs as strings.","required":true,"schema":{"pattern":"[0-9]+","type":"string","example":"337893979704000512"}},{"name":"Idempotency-Key","in":"header","description":"Unique key for one mutating request. Reuse the same value only when retrying the same operation.","required":true,"schema":{"type":"string"}},{"name":"X-Timestamp","in":"header","description":"Current Unix epoch time in seconds. Requests older or newer than five minutes are rejected.","required":true,"schema":{"pattern":"[0-9]{10}","type":"string","example":"1787562000"}},{"name":"X-Request-ID","in":"header","description":"Unique 16-128 character request identifier used for replay protection; never reuse it for a different HTTP request.","required":true,"schema":{"pattern":"[A-Za-z0-9._:-]{16,128}","type":"string","example":"018f6f4e-8f62-7fc2-9c4b-7be2f4203b6a"}},{"name":"X-Content-SHA256","in":"header","description":"Lowercase hexadecimal SHA-256 digest of the exact raw request body; use the digest of zero bytes when no body is sent.","required":true,"schema":{"pattern":"[0-9a-f]{64}","type":"string","example":"e3b0c44298fc1c149afbf4c8996fb92427ae41e4649b934ca495991b7852b855"}},{"name":"X-Workspace","in":"header","description":"Enterprise writes are available on this route. For enterprise access, copy your own enterprise:<id> from GET /api/v1/workspaces. Required for v2 requests. V1 requests use the historical key's fixed enterprise.","required":false,"schema":{"pattern":"personal|enterprise:[1-9][0-9]*","type":"string","example":null}},{"name":"X-Environment","in":"header","description":"Required and signed for v2 requests: live or sandbox. Optional for v1 requests.","required":false,"schema":{"pattern":"live|sandbox","type":"string","example":"live"}},{"name":"X-Signature","in":"header","description":"Existing keys accept v1 for their fixed enterprise or v2 for a signed workspace; new keys accept v2 only.","required":true,"schema":{"pattern":"v[12]=[0-9a-f]{64}","type":"string","example":"v2=0123456789abcdef0123456789abcdef0123456789abcdef0123456789abcdef"}},{"name":"Accept-Language","in":"header","description":"Response language: en-US = English (default); zh-CN = Simplified Chinese; zh-TW = Traditional Chinese. Numeric error codes are language-neutral.","required":false,"schema":{"type":"string","enum":["en-US","zh-CN","zh-TW"],"default":"en-US"}}],"requestBody":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/CardTopUpRequest"}}},"required":true},"responses":{"400":{"description":"Malformed JSON, missing header or invalid request parameter","headers":{"X-Request-ID":{"description":"Request identifier echoed for support and reconciliation.","schema":{"type":"string"}}},"content":{"application/json":{"schema":{"$ref":"#/components/schemas/ApiResponseVoid"}}}},"500":{"description":"Unexpected internal error; contact support with X-Request-ID","headers":{"X-Request-ID":{"description":"Request identifier echoed for support and reconciliation.","schema":{"type":"string"}}},"content":{"application/json":{"schema":{"$ref":"#/components/schemas/ApiResponseVoid"}}}},"403":{"description":"API-key scope, subscription, tenant or policy does not allow the operation","headers":{"X-Request-ID":{"description":"Request identifier echoed for support and reconciliation.","schema":{"type":"string"}}},"content":{"application/json":{"schema":{"$ref":"#/components/schemas/ApiResponseVoid"}}}},"200":{"description":"OK","headers":{"X-Request-ID":{"description":"Request identifier echoed for support and reconciliation.","schema":{"type":"string"}},"X-Quota-Limit":{"description":"Monthly API request allowance for the subscription.","schema":{"type":"integer","format":"int64"}},"X-Quota-Remaining":{"description":"Requests remaining in the current monthly allowance after this request.","schema":{"type":"integer","format":"int64"}},"X-Quota-Reset":{"description":"Unix epoch time in seconds when the monthly allowance resets.","schema":{"type":"integer","format":"int64"}},"X-Quota-Workspace":{"description":"Verified workspace owning this allowance: personal or enterprise:<id>.","schema":{"type":"string"}},"X-Quota-Environment":{"description":"Environment owning the allowance: sandbox or live.","schema":{"type":"string"}}},"content":{"application/json":{"schema":{"$ref":"#/components/schemas/ApiResponseCardTransactionResponse"}}}},"401":{"description":"Invalid API key, content hash, signature, timestamp or request ID","headers":{"X-Request-ID":{"description":"Request identifier echoed for support and reconciliation.","schema":{"type":"string"}}},"content":{"application/json":{"schema":{"$ref":"#/components/schemas/ApiResponseVoid"}}}},"404":{"description":"Resource not found in this enterprise and environment","headers":{"X-Request-ID":{"description":"Request identifier echoed for support and reconciliation.","schema":{"type":"string"}}},"content":{"application/json":{"schema":{"$ref":"#/components/schemas/ApiResponseVoid"}}}},"422":{"description":"Business rule rejected the request","headers":{"X-Request-ID":{"description":"Request identifier echoed for support and reconciliation.","schema":{"type":"string"}}},"content":{"application/json":{"schema":{"$ref":"#/components/schemas/ApiResponseVoid"}}}},"503":{"description":"A required platform service is temporarily unavailable","headers":{"X-Request-ID":{"description":"Request identifier echoed for support and reconciliation.","schema":{"type":"string"}}},"content":{"application/json":{"schema":{"$ref":"#/components/schemas/ApiResponseVoid"}}}},"409":{"description":"Idempotency or resource-state conflict","headers":{"X-Request-ID":{"description":"Request identifier echoed for support and reconciliation.","schema":{"type":"string"}}},"content":{"application/json":{"schema":{"$ref":"#/components/schemas/ApiResponseVoid"}}}},"429":{"description":"Per-minute rate limit or monthly quota exceeded","headers":{"X-Request-ID":{"description":"Request identifier echoed for support and reconciliation.","schema":{"type":"string"}},"X-Quota-Limit":{"description":"Monthly API request allowance for the subscription.","schema":{"type":"integer","format":"int64"}},"X-Quota-Remaining":{"description":"Requests remaining in the current monthly allowance after this request.","schema":{"type":"integer","format":"int64"}},"X-Quota-Reset":{"description":"Unix epoch time in seconds when the monthly allowance resets.","schema":{"type":"integer","format":"int64"}},"X-Quota-Workspace":{"description":"Verified workspace owning this allowance: personal or enterprise:<id>.","schema":{"type":"string"}},"X-Quota-Environment":{"description":"Environment owning the allowance: sandbox or live.","schema":{"type":"string"}},"Retry-After":{"description":"Seconds until the exhausted quota or rate window resets. Sign retries with a new X-Request-ID.","schema":{"type":"integer","format":"int64"}},"X-RateLimit-Scope":{"description":"Rate counter scope: workspace, or user for enterprise verification calls.","schema":{"type":"string"}},"X-RateLimit-Limit":{"description":"Per-minute request limit when rate-limited.","schema":{"type":"integer","format":"int64"}},"X-RateLimit-Remaining":{"description":"Zero when the minute limit is exhausted.","schema":{"type":"integer","format":"int64"}},"X-RateLimit-Reset":{"description":"Unix epoch seconds when the minute limit resets.","schema":{"type":"integer","format":"int64"}}},"content":{"application/json":{"schema":{"$ref":"#/components/schemas/ApiResponseVoid"}}}},"413":{"description":"Request body is too large","headers":{"X-Request-ID":{"description":"Request identifier echoed for support and reconciliation.","schema":{"type":"string"}}},"content":{"application/json":{"schema":{"$ref":"#/components/schemas/ApiResponseVoid"}}}},"202":{"description":"Accepted because the channel outcome is pending reconciliation. The body contains the persisted top-up transaction; query it instead of creating another request.","headers":{"X-Request-ID":{"description":"Request identifier echoed for support and reconciliation.","schema":{"type":"string"}},"X-Quota-Limit":{"description":"Monthly API request allowance for the subscription.","schema":{"type":"integer","format":"int64"}},"X-Quota-Remaining":{"description":"Requests remaining in the current monthly allowance after this request.","schema":{"type":"integer","format":"int64"}},"X-Quota-Reset":{"description":"Unix epoch time in seconds when the monthly allowance resets.","schema":{"type":"integer","format":"int64"}},"X-Quota-Workspace":{"description":"Verified workspace owning this allowance: personal or enterprise:<id>.","schema":{"type":"string"}},"X-Quota-Environment":{"description":"Environment owning the allowance: sandbox or live.","schema":{"type":"string"}}},"content":{"application/json":{"schema":{"$ref":"#/components/schemas/ApiResponseCardTransactionResponse"}}}}},"x-dcwallet-signature-versions":["v1","v2"]}},"/api/v1/cards/{cardId}/sandbox/purchases":{"post":{"tags":["6. Card issuing"],"summary":"Simulate a card purchase in sandbox","description":"Signature versions: v1 and v2.","operationId":"postCardsByCardIdSandboxPurchases","parameters":[{"name":"cardId","in":"path","description":"Issued-card ID returned by /api/v1/cards. Keep IDs as strings.","required":true,"schema":{"pattern":"[0-9]+","type":"string","example":"337893979704000512"}},{"name":"Idempotency-Key","in":"header","description":"Unique key for one mutating request. Reuse the same value only when retrying the same operation.","required":true,"schema":{"type":"string"}},{"name":"X-Timestamp","in":"header","description":"Current Unix epoch time in seconds. Requests older or newer than five minutes are rejected.","required":true,"schema":{"pattern":"[0-9]{10}","type":"string","example":"1787562000"}},{"name":"X-Request-ID","in":"header","description":"Unique 16-128 character request identifier used for replay protection; never reuse it for a different HTTP request.","required":true,"schema":{"pattern":"[A-Za-z0-9._:-]{16,128}","type":"string","example":"018f6f4e-8f62-7fc2-9c4b-7be2f4203b6a"}},{"name":"X-Content-SHA256","in":"header","description":"Lowercase hexadecimal SHA-256 digest of the exact raw request body; use the digest of zero bytes when no body is sent.","required":true,"schema":{"pattern":"[0-9a-f]{64}","type":"string","example":"e3b0c44298fc1c149afbf4c8996fb92427ae41e4649b934ca495991b7852b855"}},{"name":"X-Workspace","in":"header","description":"Enterprise writes are available on this route. For enterprise access, copy your own enterprise:<id> from GET /api/v1/workspaces. Required for v2 requests. V1 requests use the historical key's fixed enterprise.","required":false,"schema":{"pattern":"personal|enterprise:[1-9][0-9]*","type":"string","example":null}},{"name":"X-Environment","in":"header","description":"Required and signed for v2 requests: live or sandbox. Optional for v1 requests.","required":false,"schema":{"pattern":"live|sandbox","type":"string","example":"live"}},{"name":"X-Signature","in":"header","description":"Existing keys accept v1 for their fixed enterprise or v2 for a signed workspace; new keys accept v2 only.","required":true,"schema":{"pattern":"v[12]=[0-9a-f]{64}","type":"string","example":"v2=0123456789abcdef0123456789abcdef0123456789abcdef0123456789abcdef"}},{"name":"Accept-Language","in":"header","description":"Response language: en-US = English (default); zh-CN = Simplified Chinese; zh-TW = Traditional Chinese. Numeric error codes are language-neutral.","required":false,"schema":{"type":"string","enum":["en-US","zh-CN","zh-TW"],"default":"en-US"}}],"requestBody":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/SandboxCardPurchaseRequest"}}},"required":true},"responses":{"400":{"description":"Malformed JSON, missing header or invalid request parameter","headers":{"X-Request-ID":{"description":"Request identifier echoed for support and reconciliation.","schema":{"type":"string"}}},"content":{"application/json":{"schema":{"$ref":"#/components/schemas/ApiResponseVoid"}}}},"500":{"description":"Unexpected internal error; contact support with X-Request-ID","headers":{"X-Request-ID":{"description":"Request identifier echoed for support and reconciliation.","schema":{"type":"string"}}},"content":{"application/json":{"schema":{"$ref":"#/components/schemas/ApiResponseVoid"}}}},"403":{"description":"API-key scope, subscription, tenant or policy does not allow the operation","headers":{"X-Request-ID":{"description":"Request identifier echoed for support and reconciliation.","schema":{"type":"string"}}},"content":{"application/json":{"schema":{"$ref":"#/components/schemas/ApiResponseVoid"}}}},"200":{"description":"OK","headers":{"X-Request-ID":{"description":"Request identifier echoed for support and reconciliation.","schema":{"type":"string"}},"X-Quota-Limit":{"description":"Monthly API request allowance for the subscription.","schema":{"type":"integer","format":"int64"}},"X-Quota-Remaining":{"description":"Requests remaining in the current monthly allowance after this request.","schema":{"type":"integer","format":"int64"}},"X-Quota-Reset":{"description":"Unix epoch time in seconds when the monthly allowance resets.","schema":{"type":"integer","format":"int64"}},"X-Quota-Workspace":{"description":"Verified workspace owning this allowance: personal or enterprise:<id>.","schema":{"type":"string"}},"X-Quota-Environment":{"description":"Environment owning the allowance: sandbox or live.","schema":{"type":"string"}}},"content":{"application/json":{"schema":{"$ref":"#/components/schemas/ApiResponseCardResponse"}}}},"401":{"description":"Invalid API key, content hash, signature, timestamp or request ID","headers":{"X-Request-ID":{"description":"Request identifier echoed for support and reconciliation.","schema":{"type":"string"}}},"content":{"application/json":{"schema":{"$ref":"#/components/schemas/ApiResponseVoid"}}}},"404":{"description":"Resource not found in this enterprise and environment","headers":{"X-Request-ID":{"description":"Request identifier echoed for support and reconciliation.","schema":{"type":"string"}}},"content":{"application/json":{"schema":{"$ref":"#/components/schemas/ApiResponseVoid"}}}},"422":{"description":"Business rule rejected the request","headers":{"X-Request-ID":{"description":"Request identifier echoed for support and reconciliation.","schema":{"type":"string"}}},"content":{"application/json":{"schema":{"$ref":"#/components/schemas/ApiResponseVoid"}}}},"503":{"description":"A required platform service is temporarily unavailable","headers":{"X-Request-ID":{"description":"Request identifier echoed for support and reconciliation.","schema":{"type":"string"}}},"content":{"application/json":{"schema":{"$ref":"#/components/schemas/ApiResponseVoid"}}}},"409":{"description":"Idempotency or resource-state conflict","headers":{"X-Request-ID":{"description":"Request identifier echoed for support and reconciliation.","schema":{"type":"string"}}},"content":{"application/json":{"schema":{"$ref":"#/components/schemas/ApiResponseVoid"}}}},"429":{"description":"Per-minute rate limit or monthly quota exceeded","headers":{"X-Request-ID":{"description":"Request identifier echoed for support and reconciliation.","schema":{"type":"string"}},"X-Quota-Limit":{"description":"Monthly API request allowance for the subscription.","schema":{"type":"integer","format":"int64"}},"X-Quota-Remaining":{"description":"Requests remaining in the current monthly allowance after this request.","schema":{"type":"integer","format":"int64"}},"X-Quota-Reset":{"description":"Unix epoch time in seconds when the monthly allowance resets.","schema":{"type":"integer","format":"int64"}},"X-Quota-Workspace":{"description":"Verified workspace owning this allowance: personal or enterprise:<id>.","schema":{"type":"string"}},"X-Quota-Environment":{"description":"Environment owning the allowance: sandbox or live.","schema":{"type":"string"}},"Retry-After":{"description":"Seconds until the exhausted quota or rate window resets. Sign retries with a new X-Request-ID.","schema":{"type":"integer","format":"int64"}},"X-RateLimit-Scope":{"description":"Rate counter scope: workspace, or user for enterprise verification calls.","schema":{"type":"string"}},"X-RateLimit-Limit":{"description":"Per-minute request limit when rate-limited.","schema":{"type":"integer","format":"int64"}},"X-RateLimit-Remaining":{"description":"Zero when the minute limit is exhausted.","schema":{"type":"integer","format":"int64"}},"X-RateLimit-Reset":{"description":"Unix epoch seconds when the minute limit resets.","schema":{"type":"integer","format":"int64"}}},"content":{"application/json":{"schema":{"$ref":"#/components/schemas/ApiResponseVoid"}}}},"413":{"description":"Request body is too large","headers":{"X-Request-ID":{"description":"Request identifier echoed for support and reconciliation.","schema":{"type":"string"}}},"content":{"application/json":{"schema":{"$ref":"#/components/schemas/ApiResponseVoid"}}}}},"x-dcwallet-signature-versions":["v1","v2"]}},"/api/v1/cards/{cardId}/reveal-sessions":{"post":{"tags":["6. Card issuing"],"summary":"Create a one-time hosted card reveal session","description":"Call only after the customer has authenticated the cardholder and completed its own second-factor verification. The returned URL expires after two minutes, works once, and must be opened in a top-level browser window. PAN, expiry and CVV are rendered only by the hosted page and are never returned to the machine integration.\n\nSignature versions: v1 and v2.","operationId":"postCardsByCardIdRevealSessions","parameters":[{"name":"cardId","in":"path","description":"Issued-card ID returned by /api/v1/cards. Keep IDs as strings.","required":true,"schema":{"pattern":"[0-9]+","type":"string","example":"337893979704000512"}},{"name":"X-Timestamp","in":"header","description":"Current Unix epoch time in seconds. Requests older or newer than five minutes are rejected.","required":true,"schema":{"pattern":"[0-9]{10}","type":"string","example":"1787562000"}},{"name":"X-Request-ID","in":"header","description":"Unique 16-128 character request identifier used for replay protection; never reuse it for a different HTTP request.","required":true,"schema":{"pattern":"[A-Za-z0-9._:-]{16,128}","type":"string","example":"018f6f4e-8f62-7fc2-9c4b-7be2f4203b6a"}},{"name":"X-Content-SHA256","in":"header","description":"Lowercase hexadecimal SHA-256 digest of the exact raw request body; use the digest of zero bytes when no body is sent.","required":true,"schema":{"pattern":"[0-9a-f]{64}","type":"string","example":"e3b0c44298fc1c149afbf4c8996fb92427ae41e4649b934ca495991b7852b855"}},{"name":"X-Workspace","in":"header","description":"Enterprise writes are available on this route. For enterprise access, copy your own enterprise:<id> from GET /api/v1/workspaces. Required for v2 requests. V1 requests use the historical key's fixed enterprise.","required":false,"schema":{"pattern":"personal|enterprise:[1-9][0-9]*","type":"string","example":null}},{"name":"X-Environment","in":"header","description":"Required and signed for v2 requests: live or sandbox. Optional for v1 requests.","required":false,"schema":{"pattern":"live|sandbox","type":"string","example":"live"}},{"name":"X-Signature","in":"header","description":"Existing keys accept v1 for their fixed enterprise or v2 for a signed workspace; new keys accept v2 only.","required":true,"schema":{"pattern":"v[12]=[0-9a-f]{64}","type":"string","example":"v2=0123456789abcdef0123456789abcdef0123456789abcdef0123456789abcdef"}},{"name":"Accept-Language","in":"header","description":"Response language: en-US = English (default); zh-CN = Simplified Chinese; zh-TW = Traditional Chinese. Numeric error codes are language-neutral.","required":false,"schema":{"type":"string","enum":["en-US","zh-CN","zh-TW"],"default":"en-US"}}],"requestBody":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/HostedCardRevealSessionRequest"}}},"required":true},"responses":{"400":{"description":"Malformed JSON, missing header or invalid request parameter","headers":{"X-Request-ID":{"description":"Request identifier echoed for support and reconciliation.","schema":{"type":"string"}}},"content":{"application/json":{"schema":{"$ref":"#/components/schemas/ApiResponseVoid"}}}},"500":{"description":"Unexpected internal error; contact support with X-Request-ID","headers":{"X-Request-ID":{"description":"Request identifier echoed for support and reconciliation.","schema":{"type":"string"}}},"content":{"application/json":{"schema":{"$ref":"#/components/schemas/ApiResponseVoid"}}}},"403":{"description":"API-key scope, subscription, tenant or policy does not allow the operation","headers":{"X-Request-ID":{"description":"Request identifier echoed for support and reconciliation.","schema":{"type":"string"}}},"content":{"application/json":{"schema":{"$ref":"#/components/schemas/ApiResponseVoid"}}}},"200":{"description":"OK","headers":{"X-Request-ID":{"description":"Request identifier echoed for support and reconciliation.","schema":{"type":"string"}},"X-Quota-Limit":{"description":"Monthly API request allowance for the subscription.","schema":{"type":"integer","format":"int64"}},"X-Quota-Remaining":{"description":"Requests remaining in the current monthly allowance after this request.","schema":{"type":"integer","format":"int64"}},"X-Quota-Reset":{"description":"Unix epoch time in seconds when the monthly allowance resets.","schema":{"type":"integer","format":"int64"}},"X-Quota-Workspace":{"description":"Verified workspace owning this allowance: personal or enterprise:<id>.","schema":{"type":"string"}},"X-Quota-Environment":{"description":"Environment owning the allowance: sandbox or live.","schema":{"type":"string"}}},"content":{"application/json":{"schema":{"$ref":"#/components/schemas/ApiResponseHostedCardRevealSessionResponse"}}}},"401":{"description":"Invalid API key, content hash, signature, timestamp or request ID","headers":{"X-Request-ID":{"description":"Request identifier echoed for support and reconciliation.","schema":{"type":"string"}}},"content":{"application/json":{"schema":{"$ref":"#/components/schemas/ApiResponseVoid"}}}},"404":{"description":"Resource not found in this enterprise and environment","headers":{"X-Request-ID":{"description":"Request identifier echoed for support and reconciliation.","schema":{"type":"string"}}},"content":{"application/json":{"schema":{"$ref":"#/components/schemas/ApiResponseVoid"}}}},"422":{"description":"Business rule rejected the request","headers":{"X-Request-ID":{"description":"Request identifier echoed for support and reconciliation.","schema":{"type":"string"}}},"content":{"application/json":{"schema":{"$ref":"#/components/schemas/ApiResponseVoid"}}}},"503":{"description":"A required platform service is temporarily unavailable","headers":{"X-Request-ID":{"description":"Request identifier echoed for support and reconciliation.","schema":{"type":"string"}}},"content":{"application/json":{"schema":{"$ref":"#/components/schemas/ApiResponseVoid"}}}},"409":{"description":"Idempotency or resource-state conflict","headers":{"X-Request-ID":{"description":"Request identifier echoed for support and reconciliation.","schema":{"type":"string"}}},"content":{"application/json":{"schema":{"$ref":"#/components/schemas/ApiResponseVoid"}}}},"429":{"description":"Per-minute rate limit or monthly quota exceeded","headers":{"X-Request-ID":{"description":"Request identifier echoed for support and reconciliation.","schema":{"type":"string"}},"X-Quota-Limit":{"description":"Monthly API request allowance for the subscription.","schema":{"type":"integer","format":"int64"}},"X-Quota-Remaining":{"description":"Requests remaining in the current monthly allowance after this request.","schema":{"type":"integer","format":"int64"}},"X-Quota-Reset":{"description":"Unix epoch time in seconds when the monthly allowance resets.","schema":{"type":"integer","format":"int64"}},"X-Quota-Workspace":{"description":"Verified workspace owning this allowance: personal or enterprise:<id>.","schema":{"type":"string"}},"X-Quota-Environment":{"description":"Environment owning the allowance: sandbox or live.","schema":{"type":"string"}},"Retry-After":{"description":"Seconds until the exhausted quota or rate window resets. Sign retries with a new X-Request-ID.","schema":{"type":"integer","format":"int64"}},"X-RateLimit-Scope":{"description":"Rate counter scope: workspace, or user for enterprise verification calls.","schema":{"type":"string"}},"X-RateLimit-Limit":{"description":"Per-minute request limit when rate-limited.","schema":{"type":"integer","format":"int64"}},"X-RateLimit-Remaining":{"description":"Zero when the minute limit is exhausted.","schema":{"type":"integer","format":"int64"}},"X-RateLimit-Reset":{"description":"Unix epoch seconds when the minute limit resets.","schema":{"type":"integer","format":"int64"}}},"content":{"application/json":{"schema":{"$ref":"#/components/schemas/ApiResponseVoid"}}}},"413":{"description":"Request body is too large","headers":{"X-Request-ID":{"description":"Request identifier echoed for support and reconciliation.","schema":{"type":"string"}}},"content":{"application/json":{"schema":{"$ref":"#/components/schemas/ApiResponseVoid"}}}}},"x-dcwallet-signature-versions":["v1","v2"]}},"/api/v1/cards/{cardId}/freeze":{"post":{"tags":["6. Card issuing"],"summary":"Freeze an enterprise virtual card","description":"May temporarily return through the freezing reconciliation state after an unknown channel outcome.\n\nSignature versions: v1 and v2.","operationId":"postCardsByCardIdFreeze","parameters":[{"name":"cardId","in":"path","description":"Issued-card ID returned by /api/v1/cards. Keep IDs as strings.","required":true,"schema":{"pattern":"[0-9]+","type":"string","example":"337893979704000512"}},{"name":"Idempotency-Key","in":"header","description":"Unique key for one mutating request. Reuse the same value only when retrying the same operation.","required":true,"schema":{"type":"string"}},{"name":"X-Timestamp","in":"header","description":"Current Unix epoch time in seconds. Requests older or newer than five minutes are rejected.","required":true,"schema":{"pattern":"[0-9]{10}","type":"string","example":"1787562000"}},{"name":"X-Request-ID","in":"header","description":"Unique 16-128 character request identifier used for replay protection; never reuse it for a different HTTP request.","required":true,"schema":{"pattern":"[A-Za-z0-9._:-]{16,128}","type":"string","example":"018f6f4e-8f62-7fc2-9c4b-7be2f4203b6a"}},{"name":"X-Content-SHA256","in":"header","description":"Lowercase hexadecimal SHA-256 digest of the exact raw request body; use the digest of zero bytes when no body is sent.","required":true,"schema":{"pattern":"[0-9a-f]{64}","type":"string","example":"e3b0c44298fc1c149afbf4c8996fb92427ae41e4649b934ca495991b7852b855"}},{"name":"X-Workspace","in":"header","description":"Enterprise writes are available on this route. For enterprise access, copy your own enterprise:<id> from GET /api/v1/workspaces. Required for v2 requests. V1 requests use the historical key's fixed enterprise.","required":false,"schema":{"pattern":"personal|enterprise:[1-9][0-9]*","type":"string","example":null}},{"name":"X-Environment","in":"header","description":"Required and signed for v2 requests: live or sandbox. Optional for v1 requests.","required":false,"schema":{"pattern":"live|sandbox","type":"string","example":"live"}},{"name":"X-Signature","in":"header","description":"Existing keys accept v1 for their fixed enterprise or v2 for a signed workspace; new keys accept v2 only.","required":true,"schema":{"pattern":"v[12]=[0-9a-f]{64}","type":"string","example":"v2=0123456789abcdef0123456789abcdef0123456789abcdef0123456789abcdef"}},{"name":"Accept-Language","in":"header","description":"Response language: en-US = English (default); zh-CN = Simplified Chinese; zh-TW = Traditional Chinese. Numeric error codes are language-neutral.","required":false,"schema":{"type":"string","enum":["en-US","zh-CN","zh-TW"],"default":"en-US"}}],"responses":{"400":{"description":"Malformed JSON, missing header or invalid request parameter","headers":{"X-Request-ID":{"description":"Request identifier echoed for support and reconciliation.","schema":{"type":"string"}}},"content":{"application/json":{"schema":{"$ref":"#/components/schemas/ApiResponseVoid"}}}},"500":{"description":"Unexpected internal error; contact support with X-Request-ID","headers":{"X-Request-ID":{"description":"Request identifier echoed for support and reconciliation.","schema":{"type":"string"}}},"content":{"application/json":{"schema":{"$ref":"#/components/schemas/ApiResponseVoid"}}}},"403":{"description":"API-key scope, subscription, tenant or policy does not allow the operation","headers":{"X-Request-ID":{"description":"Request identifier echoed for support and reconciliation.","schema":{"type":"string"}}},"content":{"application/json":{"schema":{"$ref":"#/components/schemas/ApiResponseVoid"}}}},"200":{"description":"OK","headers":{"X-Request-ID":{"description":"Request identifier echoed for support and reconciliation.","schema":{"type":"string"}},"X-Quota-Limit":{"description":"Monthly API request allowance for the subscription.","schema":{"type":"integer","format":"int64"}},"X-Quota-Remaining":{"description":"Requests remaining in the current monthly allowance after this request.","schema":{"type":"integer","format":"int64"}},"X-Quota-Reset":{"description":"Unix epoch time in seconds when the monthly allowance resets.","schema":{"type":"integer","format":"int64"}},"X-Quota-Workspace":{"description":"Verified workspace owning this allowance: personal or enterprise:<id>.","schema":{"type":"string"}},"X-Quota-Environment":{"description":"Environment owning the allowance: sandbox or live.","schema":{"type":"string"}}},"content":{"application/json":{"schema":{"$ref":"#/components/schemas/ApiResponseCardResponse"}}}},"401":{"description":"Invalid API key, content hash, signature, timestamp or request ID","headers":{"X-Request-ID":{"description":"Request identifier echoed for support and reconciliation.","schema":{"type":"string"}}},"content":{"application/json":{"schema":{"$ref":"#/components/schemas/ApiResponseVoid"}}}},"404":{"description":"Resource not found in this enterprise and environment","headers":{"X-Request-ID":{"description":"Request identifier echoed for support and reconciliation.","schema":{"type":"string"}}},"content":{"application/json":{"schema":{"$ref":"#/components/schemas/ApiResponseVoid"}}}},"422":{"description":"Business rule rejected the request","headers":{"X-Request-ID":{"description":"Request identifier echoed for support and reconciliation.","schema":{"type":"string"}}},"content":{"application/json":{"schema":{"$ref":"#/components/schemas/ApiResponseVoid"}}}},"503":{"description":"A required platform service is temporarily unavailable","headers":{"X-Request-ID":{"description":"Request identifier echoed for support and reconciliation.","schema":{"type":"string"}}},"content":{"application/json":{"schema":{"$ref":"#/components/schemas/ApiResponseVoid"}}}},"409":{"description":"Idempotency or resource-state conflict","headers":{"X-Request-ID":{"description":"Request identifier echoed for support and reconciliation.","schema":{"type":"string"}}},"content":{"application/json":{"schema":{"$ref":"#/components/schemas/ApiResponseVoid"}}}},"429":{"description":"Per-minute rate limit or monthly quota exceeded","headers":{"X-Request-ID":{"description":"Request identifier echoed for support and reconciliation.","schema":{"type":"string"}},"X-Quota-Limit":{"description":"Monthly API request allowance for the subscription.","schema":{"type":"integer","format":"int64"}},"X-Quota-Remaining":{"description":"Requests remaining in the current monthly allowance after this request.","schema":{"type":"integer","format":"int64"}},"X-Quota-Reset":{"description":"Unix epoch time in seconds when the monthly allowance resets.","schema":{"type":"integer","format":"int64"}},"X-Quota-Workspace":{"description":"Verified workspace owning this allowance: personal or enterprise:<id>.","schema":{"type":"string"}},"X-Quota-Environment":{"description":"Environment owning the allowance: sandbox or live.","schema":{"type":"string"}},"Retry-After":{"description":"Seconds until the exhausted quota or rate window resets. Sign retries with a new X-Request-ID.","schema":{"type":"integer","format":"int64"}},"X-RateLimit-Scope":{"description":"Rate counter scope: workspace, or user for enterprise verification calls.","schema":{"type":"string"}},"X-RateLimit-Limit":{"description":"Per-minute request limit when rate-limited.","schema":{"type":"integer","format":"int64"}},"X-RateLimit-Remaining":{"description":"Zero when the minute limit is exhausted.","schema":{"type":"integer","format":"int64"}},"X-RateLimit-Reset":{"description":"Unix epoch seconds when the minute limit resets.","schema":{"type":"integer","format":"int64"}}},"content":{"application/json":{"schema":{"$ref":"#/components/schemas/ApiResponseVoid"}}}},"413":{"description":"Request body is too large","headers":{"X-Request-ID":{"description":"Request identifier echoed for support and reconciliation.","schema":{"type":"string"}}},"content":{"application/json":{"schema":{"$ref":"#/components/schemas/ApiResponseVoid"}}}}},"x-dcwallet-signature-versions":["v1","v2"]}},"/api/v1/cards/{cardId}/cancel":{"post":{"tags":["6. Card issuing"],"summary":"Cancel an enterprise virtual card","description":"Rejects non-terminal transactions and may remain cancelling until channel/refund reconciliation completes.\n\nSignature versions: v1 and v2.","operationId":"postCardsByCardIdCancel","parameters":[{"name":"cardId","in":"path","description":"Issued-card ID returned by /api/v1/cards. Keep IDs as strings.","required":true,"schema":{"pattern":"[0-9]+","type":"string","example":"337893979704000512"}},{"name":"Idempotency-Key","in":"header","description":"Unique key for one mutating request. Reuse the same value only when retrying the same operation.","required":true,"schema":{"type":"string"}},{"name":"X-Timestamp","in":"header","description":"Current Unix epoch time in seconds. Requests older or newer than five minutes are rejected.","required":true,"schema":{"pattern":"[0-9]{10}","type":"string","example":"1787562000"}},{"name":"X-Request-ID","in":"header","description":"Unique 16-128 character request identifier used for replay protection; never reuse it for a different HTTP request.","required":true,"schema":{"pattern":"[A-Za-z0-9._:-]{16,128}","type":"string","example":"018f6f4e-8f62-7fc2-9c4b-7be2f4203b6a"}},{"name":"X-Content-SHA256","in":"header","description":"Lowercase hexadecimal SHA-256 digest of the exact raw request body; use the digest of zero bytes when no body is sent.","required":true,"schema":{"pattern":"[0-9a-f]{64}","type":"string","example":"e3b0c44298fc1c149afbf4c8996fb92427ae41e4649b934ca495991b7852b855"}},{"name":"X-Workspace","in":"header","description":"Enterprise writes are available on this route. For enterprise access, copy your own enterprise:<id> from GET /api/v1/workspaces. Required for v2 requests. V1 requests use the historical key's fixed enterprise.","required":false,"schema":{"pattern":"personal|enterprise:[1-9][0-9]*","type":"string","example":null}},{"name":"X-Environment","in":"header","description":"Required and signed for v2 requests: live or sandbox. Optional for v1 requests.","required":false,"schema":{"pattern":"live|sandbox","type":"string","example":"live"}},{"name":"X-Signature","in":"header","description":"Existing keys accept v1 for their fixed enterprise or v2 for a signed workspace; new keys accept v2 only.","required":true,"schema":{"pattern":"v[12]=[0-9a-f]{64}","type":"string","example":"v2=0123456789abcdef0123456789abcdef0123456789abcdef0123456789abcdef"}},{"name":"Accept-Language","in":"header","description":"Response language: en-US = English (default); zh-CN = Simplified Chinese; zh-TW = Traditional Chinese. Numeric error codes are language-neutral.","required":false,"schema":{"type":"string","enum":["en-US","zh-CN","zh-TW"],"default":"en-US"}}],"responses":{"400":{"description":"Malformed JSON, missing header or invalid request parameter","headers":{"X-Request-ID":{"description":"Request identifier echoed for support and reconciliation.","schema":{"type":"string"}}},"content":{"application/json":{"schema":{"$ref":"#/components/schemas/ApiResponseVoid"}}}},"500":{"description":"Unexpected internal error; contact support with X-Request-ID","headers":{"X-Request-ID":{"description":"Request identifier echoed for support and reconciliation.","schema":{"type":"string"}}},"content":{"application/json":{"schema":{"$ref":"#/components/schemas/ApiResponseVoid"}}}},"403":{"description":"API-key scope, subscription, tenant or policy does not allow the operation","headers":{"X-Request-ID":{"description":"Request identifier echoed for support and reconciliation.","schema":{"type":"string"}}},"content":{"application/json":{"schema":{"$ref":"#/components/schemas/ApiResponseVoid"}}}},"200":{"description":"OK","headers":{"X-Request-ID":{"description":"Request identifier echoed for support and reconciliation.","schema":{"type":"string"}},"X-Quota-Limit":{"description":"Monthly API request allowance for the subscription.","schema":{"type":"integer","format":"int64"}},"X-Quota-Remaining":{"description":"Requests remaining in the current monthly allowance after this request.","schema":{"type":"integer","format":"int64"}},"X-Quota-Reset":{"description":"Unix epoch time in seconds when the monthly allowance resets.","schema":{"type":"integer","format":"int64"}},"X-Quota-Workspace":{"description":"Verified workspace owning this allowance: personal or enterprise:<id>.","schema":{"type":"string"}},"X-Quota-Environment":{"description":"Environment owning the allowance: sandbox or live.","schema":{"type":"string"}}},"content":{"application/json":{"schema":{"$ref":"#/components/schemas/ApiResponseCardCancellationResponse"}}}},"401":{"description":"Invalid API key, content hash, signature, timestamp or request ID","headers":{"X-Request-ID":{"description":"Request identifier echoed for support and reconciliation.","schema":{"type":"string"}}},"content":{"application/json":{"schema":{"$ref":"#/components/schemas/ApiResponseVoid"}}}},"404":{"description":"Resource not found in this enterprise and environment","headers":{"X-Request-ID":{"description":"Request identifier echoed for support and reconciliation.","schema":{"type":"string"}}},"content":{"application/json":{"schema":{"$ref":"#/components/schemas/ApiResponseVoid"}}}},"422":{"description":"Business rule rejected the request","headers":{"X-Request-ID":{"description":"Request identifier echoed for support and reconciliation.","schema":{"type":"string"}}},"content":{"application/json":{"schema":{"$ref":"#/components/schemas/ApiResponseVoid"}}}},"503":{"description":"A required platform service is temporarily unavailable","headers":{"X-Request-ID":{"description":"Request identifier echoed for support and reconciliation.","schema":{"type":"string"}}},"content":{"application/json":{"schema":{"$ref":"#/components/schemas/ApiResponseVoid"}}}},"409":{"description":"Idempotency or resource-state conflict","headers":{"X-Request-ID":{"description":"Request identifier echoed for support and reconciliation.","schema":{"type":"string"}}},"content":{"application/json":{"schema":{"$ref":"#/components/schemas/ApiResponseVoid"}}}},"429":{"description":"Per-minute rate limit or monthly quota exceeded","headers":{"X-Request-ID":{"description":"Request identifier echoed for support and reconciliation.","schema":{"type":"string"}},"X-Quota-Limit":{"description":"Monthly API request allowance for the subscription.","schema":{"type":"integer","format":"int64"}},"X-Quota-Remaining":{"description":"Requests remaining in the current monthly allowance after this request.","schema":{"type":"integer","format":"int64"}},"X-Quota-Reset":{"description":"Unix epoch time in seconds when the monthly allowance resets.","schema":{"type":"integer","format":"int64"}},"X-Quota-Workspace":{"description":"Verified workspace owning this allowance: personal or enterprise:<id>.","schema":{"type":"string"}},"X-Quota-Environment":{"description":"Environment owning the allowance: sandbox or live.","schema":{"type":"string"}},"Retry-After":{"description":"Seconds until the exhausted quota or rate window resets. Sign retries with a new X-Request-ID.","schema":{"type":"integer","format":"int64"}},"X-RateLimit-Scope":{"description":"Rate counter scope: workspace, or user for enterprise verification calls.","schema":{"type":"string"}},"X-RateLimit-Limit":{"description":"Per-minute request limit when rate-limited.","schema":{"type":"integer","format":"int64"}},"X-RateLimit-Remaining":{"description":"Zero when the minute limit is exhausted.","schema":{"type":"integer","format":"int64"}},"X-RateLimit-Reset":{"description":"Unix epoch seconds when the minute limit resets.","schema":{"type":"integer","format":"int64"}}},"content":{"application/json":{"schema":{"$ref":"#/components/schemas/ApiResponseVoid"}}}},"413":{"description":"Request body is too large","headers":{"X-Request-ID":{"description":"Request identifier echoed for support and reconciliation.","schema":{"type":"string"}}},"content":{"application/json":{"schema":{"$ref":"#/components/schemas/ApiResponseVoid"}}}}},"x-dcwallet-signature-versions":["v1","v2"]}},"/api/v1/card-budgets":{"get":{"tags":["6. Card issuing"],"summary":"List enterprise shared-card budgets","description":"Signature versions: v1 and v2.","operationId":"getCardBudgets","parameters":[{"name":"X-Timestamp","in":"header","description":"Current Unix epoch time in seconds. Requests older or newer than five minutes are rejected.","required":true,"schema":{"pattern":"[0-9]{10}","type":"string","example":"1787562000"}},{"name":"X-Request-ID","in":"header","description":"Unique 16-128 character request identifier used for replay protection; never reuse it for a different HTTP request.","required":true,"schema":{"pattern":"[A-Za-z0-9._:-]{16,128}","type":"string","example":"018f6f4e-8f62-7fc2-9c4b-7be2f4203b6a"}},{"name":"X-Content-SHA256","in":"header","description":"Lowercase hexadecimal SHA-256 digest of the exact raw request body; use the digest of zero bytes when no body is sent.","required":true,"schema":{"pattern":"[0-9a-f]{64}","type":"string","example":"e3b0c44298fc1c149afbf4c8996fb92427ae41e4649b934ca495991b7852b855"}},{"name":"X-Workspace","in":"header","description":"Enterprise reads are available on this route. For enterprise access, copy your own enterprise:<id> from GET /api/v1/workspaces. Required for v2 requests. V1 requests use the historical key's fixed enterprise.","required":false,"schema":{"pattern":"personal|enterprise:[1-9][0-9]*","type":"string","example":null}},{"name":"X-Environment","in":"header","description":"Required and signed for v2 requests: live or sandbox. Optional for v1 requests.","required":false,"schema":{"pattern":"live|sandbox","type":"string","example":"live"}},{"name":"X-Signature","in":"header","description":"Existing keys accept v1 for their fixed enterprise or v2 for a signed workspace; new keys accept v2 only.","required":true,"schema":{"pattern":"v[12]=[0-9a-f]{64}","type":"string","example":"v2=0123456789abcdef0123456789abcdef0123456789abcdef0123456789abcdef"}},{"name":"Accept-Language","in":"header","description":"Response language: en-US = English (default); zh-CN = Simplified Chinese; zh-TW = Traditional Chinese. Numeric error codes are language-neutral.","required":false,"schema":{"type":"string","enum":["en-US","zh-CN","zh-TW"],"default":"en-US"}}],"responses":{"400":{"description":"Malformed JSON, missing header or invalid request parameter","headers":{"X-Request-ID":{"description":"Request identifier echoed for support and reconciliation.","schema":{"type":"string"}}},"content":{"application/json":{"schema":{"$ref":"#/components/schemas/ApiResponseVoid"}}}},"500":{"description":"Unexpected internal error; contact support with X-Request-ID","headers":{"X-Request-ID":{"description":"Request identifier echoed for support and reconciliation.","schema":{"type":"string"}}},"content":{"application/json":{"schema":{"$ref":"#/components/schemas/ApiResponseVoid"}}}},"403":{"description":"API-key scope, subscription, tenant or policy does not allow the operation","headers":{"X-Request-ID":{"description":"Request identifier echoed for support and reconciliation.","schema":{"type":"string"}}},"content":{"application/json":{"schema":{"$ref":"#/components/schemas/ApiResponseVoid"}}}},"200":{"description":"OK","headers":{"X-Request-ID":{"description":"Request identifier echoed for support and reconciliation.","schema":{"type":"string"}},"X-Quota-Limit":{"description":"Monthly API request allowance for the subscription.","schema":{"type":"integer","format":"int64"}},"X-Quota-Remaining":{"description":"Requests remaining in the current monthly allowance after this request.","schema":{"type":"integer","format":"int64"}},"X-Quota-Reset":{"description":"Unix epoch time in seconds when the monthly allowance resets.","schema":{"type":"integer","format":"int64"}},"X-Quota-Workspace":{"description":"Verified workspace owning this allowance: personal or enterprise:<id>.","schema":{"type":"string"}},"X-Quota-Environment":{"description":"Environment owning the allowance: sandbox or live.","schema":{"type":"string"}}},"content":{"application/json":{"schema":{"$ref":"#/components/schemas/ApiResponseListBudgetResponse"}}}},"401":{"description":"Invalid API key, content hash, signature, timestamp or request ID","headers":{"X-Request-ID":{"description":"Request identifier echoed for support and reconciliation.","schema":{"type":"string"}}},"content":{"application/json":{"schema":{"$ref":"#/components/schemas/ApiResponseVoid"}}}},"404":{"description":"Resource not found in this enterprise and environment","headers":{"X-Request-ID":{"description":"Request identifier echoed for support and reconciliation.","schema":{"type":"string"}}},"content":{"application/json":{"schema":{"$ref":"#/components/schemas/ApiResponseVoid"}}}},"422":{"description":"Business rule rejected the request","headers":{"X-Request-ID":{"description":"Request identifier echoed for support and reconciliation.","schema":{"type":"string"}}},"content":{"application/json":{"schema":{"$ref":"#/components/schemas/ApiResponseVoid"}}}},"503":{"description":"A required platform service is temporarily unavailable","headers":{"X-Request-ID":{"description":"Request identifier echoed for support and reconciliation.","schema":{"type":"string"}}},"content":{"application/json":{"schema":{"$ref":"#/components/schemas/ApiResponseVoid"}}}},"409":{"description":"Idempotency or resource-state conflict","headers":{"X-Request-ID":{"description":"Request identifier echoed for support and reconciliation.","schema":{"type":"string"}}},"content":{"application/json":{"schema":{"$ref":"#/components/schemas/ApiResponseVoid"}}}},"429":{"description":"Per-minute rate limit or monthly quota exceeded","headers":{"X-Request-ID":{"description":"Request identifier echoed for support and reconciliation.","schema":{"type":"string"}},"X-Quota-Limit":{"description":"Monthly API request allowance for the subscription.","schema":{"type":"integer","format":"int64"}},"X-Quota-Remaining":{"description":"Requests remaining in the current monthly allowance after this request.","schema":{"type":"integer","format":"int64"}},"X-Quota-Reset":{"description":"Unix epoch time in seconds when the monthly allowance resets.","schema":{"type":"integer","format":"int64"}},"X-Quota-Workspace":{"description":"Verified workspace owning this allowance: personal or enterprise:<id>.","schema":{"type":"string"}},"X-Quota-Environment":{"description":"Environment owning the allowance: sandbox or live.","schema":{"type":"string"}},"Retry-After":{"description":"Seconds until the exhausted quota or rate window resets. Sign retries with a new X-Request-ID.","schema":{"type":"integer","format":"int64"}},"X-RateLimit-Scope":{"description":"Rate counter scope: workspace, or user for enterprise verification calls.","schema":{"type":"string"}},"X-RateLimit-Limit":{"description":"Per-minute request limit when rate-limited.","schema":{"type":"integer","format":"int64"}},"X-RateLimit-Remaining":{"description":"Zero when the minute limit is exhausted.","schema":{"type":"integer","format":"int64"}},"X-RateLimit-Reset":{"description":"Unix epoch seconds when the minute limit resets.","schema":{"type":"integer","format":"int64"}}},"content":{"application/json":{"schema":{"$ref":"#/components/schemas/ApiResponseVoid"}}}},"413":{"description":"Request body is too large","headers":{"X-Request-ID":{"description":"Request identifier echoed for support and reconciliation.","schema":{"type":"string"}}},"content":{"application/json":{"schema":{"$ref":"#/components/schemas/ApiResponseVoid"}}}}},"x-dcwallet-signature-versions":["v1","v2"]},"post":{"tags":["6. Card issuing"],"summary":"Create a shared-card budget","description":"Choose a currency from /card-budgets/options. The platform selects its upstream internally. Allocation may remain pending until an account is available. Reuse Idempotency-Key for retries.\n\nSignature versions: v1 and v2.","operationId":"postCardBudgets","parameters":[{"name":"Idempotency-Key","in":"header","description":"Unique key for one mutating request. Reuse the same value only when retrying the same operation.","required":true,"schema":{"type":"string"}},{"name":"X-Timestamp","in":"header","description":"Current Unix epoch time in seconds. Requests older or newer than five minutes are rejected.","required":true,"schema":{"pattern":"[0-9]{10}","type":"string","example":"1787562000"}},{"name":"X-Request-ID","in":"header","description":"Unique 16-128 character request identifier used for replay protection; never reuse it for a different HTTP request.","required":true,"schema":{"pattern":"[A-Za-z0-9._:-]{16,128}","type":"string","example":"018f6f4e-8f62-7fc2-9c4b-7be2f4203b6a"}},{"name":"X-Content-SHA256","in":"header","description":"Lowercase hexadecimal SHA-256 digest of the exact raw request body; use the digest of zero bytes when no body is sent.","required":true,"schema":{"pattern":"[0-9a-f]{64}","type":"string","example":"e3b0c44298fc1c149afbf4c8996fb92427ae41e4649b934ca495991b7852b855"}},{"name":"X-Workspace","in":"header","description":"Enterprise writes are available on this route. For enterprise access, copy your own enterprise:<id> from GET /api/v1/workspaces. Required for v2 requests. V1 requests use the historical key's fixed enterprise.","required":false,"schema":{"pattern":"personal|enterprise:[1-9][0-9]*","type":"string","example":null}},{"name":"X-Environment","in":"header","description":"Required and signed for v2 requests: live or sandbox. Optional for v1 requests.","required":false,"schema":{"pattern":"live|sandbox","type":"string","example":"live"}},{"name":"X-Signature","in":"header","description":"Existing keys accept v1 for their fixed enterprise or v2 for a signed workspace; new keys accept v2 only.","required":true,"schema":{"pattern":"v[12]=[0-9a-f]{64}","type":"string","example":"v2=0123456789abcdef0123456789abcdef0123456789abcdef0123456789abcdef"}},{"name":"Accept-Language","in":"header","description":"Response language: en-US = English (default); zh-CN = Simplified Chinese; zh-TW = Traditional Chinese. Numeric error codes are language-neutral.","required":false,"schema":{"type":"string","enum":["en-US","zh-CN","zh-TW"],"default":"en-US"}}],"requestBody":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/CreateBudgetRequest"}}},"required":true},"responses":{"400":{"description":"Malformed JSON, missing header or invalid request parameter","headers":{"X-Request-ID":{"description":"Request identifier echoed for support and reconciliation.","schema":{"type":"string"}}},"content":{"application/json":{"schema":{"$ref":"#/components/schemas/ApiResponseVoid"}}}},"500":{"description":"Unexpected internal error; contact support with X-Request-ID","headers":{"X-Request-ID":{"description":"Request identifier echoed for support and reconciliation.","schema":{"type":"string"}}},"content":{"application/json":{"schema":{"$ref":"#/components/schemas/ApiResponseVoid"}}}},"403":{"description":"API-key scope, subscription, tenant or policy does not allow the operation","headers":{"X-Request-ID":{"description":"Request identifier echoed for support and reconciliation.","schema":{"type":"string"}}},"content":{"application/json":{"schema":{"$ref":"#/components/schemas/ApiResponseVoid"}}}},"200":{"description":"OK","headers":{"X-Request-ID":{"description":"Request identifier echoed for support and reconciliation.","schema":{"type":"string"}},"X-Quota-Limit":{"description":"Monthly API request allowance for the subscription.","schema":{"type":"integer","format":"int64"}},"X-Quota-Remaining":{"description":"Requests remaining in the current monthly allowance after this request.","schema":{"type":"integer","format":"int64"}},"X-Quota-Reset":{"description":"Unix epoch time in seconds when the monthly allowance resets.","schema":{"type":"integer","format":"int64"}},"X-Quota-Workspace":{"description":"Verified workspace owning this allowance: personal or enterprise:<id>.","schema":{"type":"string"}},"X-Quota-Environment":{"description":"Environment owning the allowance: sandbox or live.","schema":{"type":"string"}}},"content":{"application/json":{"schema":{"$ref":"#/components/schemas/ApiResponseBudgetResponse"}}}},"401":{"description":"Invalid API key, content hash, signature, timestamp or request ID","headers":{"X-Request-ID":{"description":"Request identifier echoed for support and reconciliation.","schema":{"type":"string"}}},"content":{"application/json":{"schema":{"$ref":"#/components/schemas/ApiResponseVoid"}}}},"404":{"description":"Resource not found in this enterprise and environment","headers":{"X-Request-ID":{"description":"Request identifier echoed for support and reconciliation.","schema":{"type":"string"}}},"content":{"application/json":{"schema":{"$ref":"#/components/schemas/ApiResponseVoid"}}}},"422":{"description":"Business rule rejected the request","headers":{"X-Request-ID":{"description":"Request identifier echoed for support and reconciliation.","schema":{"type":"string"}}},"content":{"application/json":{"schema":{"$ref":"#/components/schemas/ApiResponseVoid"}}}},"503":{"description":"A required platform service is temporarily unavailable","headers":{"X-Request-ID":{"description":"Request identifier echoed for support and reconciliation.","schema":{"type":"string"}}},"content":{"application/json":{"schema":{"$ref":"#/components/schemas/ApiResponseVoid"}}}},"409":{"description":"Idempotency or resource-state conflict","headers":{"X-Request-ID":{"description":"Request identifier echoed for support and reconciliation.","schema":{"type":"string"}}},"content":{"application/json":{"schema":{"$ref":"#/components/schemas/ApiResponseVoid"}}}},"429":{"description":"Per-minute rate limit or monthly quota exceeded","headers":{"X-Request-ID":{"description":"Request identifier echoed for support and reconciliation.","schema":{"type":"string"}},"X-Quota-Limit":{"description":"Monthly API request allowance for the subscription.","schema":{"type":"integer","format":"int64"}},"X-Quota-Remaining":{"description":"Requests remaining in the current monthly allowance after this request.","schema":{"type":"integer","format":"int64"}},"X-Quota-Reset":{"description":"Unix epoch time in seconds when the monthly allowance resets.","schema":{"type":"integer","format":"int64"}},"X-Quota-Workspace":{"description":"Verified workspace owning this allowance: personal or enterprise:<id>.","schema":{"type":"string"}},"X-Quota-Environment":{"description":"Environment owning the allowance: sandbox or live.","schema":{"type":"string"}},"Retry-After":{"description":"Seconds until the exhausted quota or rate window resets. Sign retries with a new X-Request-ID.","schema":{"type":"integer","format":"int64"}},"X-RateLimit-Scope":{"description":"Rate counter scope: workspace, or user for enterprise verification calls.","schema":{"type":"string"}},"X-RateLimit-Limit":{"description":"Per-minute request limit when rate-limited.","schema":{"type":"integer","format":"int64"}},"X-RateLimit-Remaining":{"description":"Zero when the minute limit is exhausted.","schema":{"type":"integer","format":"int64"}},"X-RateLimit-Reset":{"description":"Unix epoch seconds when the minute limit resets.","schema":{"type":"integer","format":"int64"}}},"content":{"application/json":{"schema":{"$ref":"#/components/schemas/ApiResponseVoid"}}}},"413":{"description":"Request body is too large","headers":{"X-Request-ID":{"description":"Request identifier echoed for support and reconciliation.","schema":{"type":"string"}}},"content":{"application/json":{"schema":{"$ref":"#/components/schemas/ApiResponseVoid"}}}}},"x-dcwallet-signature-versions":["v1","v2"]}},"/api/v1/card-budgets/{budgetId}/withdraw":{"post":{"tags":["6. Card issuing"],"summary":"Return funds from a shared-card budget to a platform account","description":"Requires transfer:write and card:write API scopes, enterprise transfer permission and X-2FA-Code in live mode. Reuse Idempotency-Key for retries.\n\nSignature versions: v1 and v2.","operationId":"postCardBudgetsByBudgetIdWithdraw","parameters":[{"name":"budgetId","in":"path","description":"The budget id value for this resource.","required":true,"schema":{"pattern":"[0-9]+","type":"string","example":"337893979704000512"}},{"name":"Idempotency-Key","in":"header","description":"Unique key for one mutating request. Reuse the same value only when retrying the same operation.","required":true,"schema":{"type":"string"}},{"name":"X-2FA-Code","in":"header","description":"The x-2 fa-code value for this resource.","required":false,"schema":{"type":"string"}},{"name":"X-Timestamp","in":"header","description":"Current Unix epoch time in seconds. Requests older or newer than five minutes are rejected.","required":true,"schema":{"pattern":"[0-9]{10}","type":"string","example":"1787562000"}},{"name":"X-Request-ID","in":"header","description":"Unique 16-128 character request identifier used for replay protection; never reuse it for a different HTTP request.","required":true,"schema":{"pattern":"[A-Za-z0-9._:-]{16,128}","type":"string","example":"018f6f4e-8f62-7fc2-9c4b-7be2f4203b6a"}},{"name":"X-Content-SHA256","in":"header","description":"Lowercase hexadecimal SHA-256 digest of the exact raw request body; use the digest of zero bytes when no body is sent.","required":true,"schema":{"pattern":"[0-9a-f]{64}","type":"string","example":"e3b0c44298fc1c149afbf4c8996fb92427ae41e4649b934ca495991b7852b855"}},{"name":"X-Workspace","in":"header","description":"Enterprise writes are available on this route. For enterprise access, copy your own enterprise:<id> from GET /api/v1/workspaces. Required for v2 requests. V1 requests use the historical key's fixed enterprise.","required":false,"schema":{"pattern":"personal|enterprise:[1-9][0-9]*","type":"string","example":null}},{"name":"X-Environment","in":"header","description":"Required and signed for v2 requests: live or sandbox. Optional for v1 requests.","required":false,"schema":{"pattern":"live|sandbox","type":"string","example":"live"}},{"name":"X-Signature","in":"header","description":"Existing keys accept v1 for their fixed enterprise or v2 for a signed workspace; new keys accept v2 only.","required":true,"schema":{"pattern":"v[12]=[0-9a-f]{64}","type":"string","example":"v2=0123456789abcdef0123456789abcdef0123456789abcdef0123456789abcdef"}},{"name":"Accept-Language","in":"header","description":"Response language: en-US = English (default); zh-CN = Simplified Chinese; zh-TW = Traditional Chinese. Numeric error codes are language-neutral.","required":false,"schema":{"type":"string","enum":["en-US","zh-CN","zh-TW"],"default":"en-US"}}],"requestBody":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/WithdrawBudgetRequest"}}},"required":true},"responses":{"400":{"description":"Malformed JSON, missing header or invalid request parameter","headers":{"X-Request-ID":{"description":"Request identifier echoed for support and reconciliation.","schema":{"type":"string"}}},"content":{"application/json":{"schema":{"$ref":"#/components/schemas/ApiResponseVoid"}}}},"500":{"description":"Unexpected internal error; contact support with X-Request-ID","headers":{"X-Request-ID":{"description":"Request identifier echoed for support and reconciliation.","schema":{"type":"string"}}},"content":{"application/json":{"schema":{"$ref":"#/components/schemas/ApiResponseVoid"}}}},"403":{"description":"API-key scope, subscription, tenant or policy does not allow the operation","headers":{"X-Request-ID":{"description":"Request identifier echoed for support and reconciliation.","schema":{"type":"string"}}},"content":{"application/json":{"schema":{"$ref":"#/components/schemas/ApiResponseVoid"}}}},"200":{"description":"OK","headers":{"X-Request-ID":{"description":"Request identifier echoed for support and reconciliation.","schema":{"type":"string"}},"X-Quota-Limit":{"description":"Monthly API request allowance for the subscription.","schema":{"type":"integer","format":"int64"}},"X-Quota-Remaining":{"description":"Requests remaining in the current monthly allowance after this request.","schema":{"type":"integer","format":"int64"}},"X-Quota-Reset":{"description":"Unix epoch time in seconds when the monthly allowance resets.","schema":{"type":"integer","format":"int64"}},"X-Quota-Workspace":{"description":"Verified workspace owning this allowance: personal or enterprise:<id>.","schema":{"type":"string"}},"X-Quota-Environment":{"description":"Environment owning the allowance: sandbox or live.","schema":{"type":"string"}}},"content":{"application/json":{"schema":{"$ref":"#/components/schemas/ApiResponseBudgetTransferResponse"}}}},"401":{"description":"Invalid API key, content hash, signature, timestamp or request ID","headers":{"X-Request-ID":{"description":"Request identifier echoed for support and reconciliation.","schema":{"type":"string"}}},"content":{"application/json":{"schema":{"$ref":"#/components/schemas/ApiResponseVoid"}}}},"404":{"description":"Resource not found in this enterprise and environment","headers":{"X-Request-ID":{"description":"Request identifier echoed for support and reconciliation.","schema":{"type":"string"}}},"content":{"application/json":{"schema":{"$ref":"#/components/schemas/ApiResponseVoid"}}}},"422":{"description":"Business rule rejected the request","headers":{"X-Request-ID":{"description":"Request identifier echoed for support and reconciliation.","schema":{"type":"string"}}},"content":{"application/json":{"schema":{"$ref":"#/components/schemas/ApiResponseVoid"}}}},"503":{"description":"A required platform service is temporarily unavailable","headers":{"X-Request-ID":{"description":"Request identifier echoed for support and reconciliation.","schema":{"type":"string"}}},"content":{"application/json":{"schema":{"$ref":"#/components/schemas/ApiResponseVoid"}}}},"409":{"description":"Idempotency or resource-state conflict","headers":{"X-Request-ID":{"description":"Request identifier echoed for support and reconciliation.","schema":{"type":"string"}}},"content":{"application/json":{"schema":{"$ref":"#/components/schemas/ApiResponseVoid"}}}},"429":{"description":"Per-minute rate limit or monthly quota exceeded","headers":{"X-Request-ID":{"description":"Request identifier echoed for support and reconciliation.","schema":{"type":"string"}},"X-Quota-Limit":{"description":"Monthly API request allowance for the subscription.","schema":{"type":"integer","format":"int64"}},"X-Quota-Remaining":{"description":"Requests remaining in the current monthly allowance after this request.","schema":{"type":"integer","format":"int64"}},"X-Quota-Reset":{"description":"Unix epoch time in seconds when the monthly allowance resets.","schema":{"type":"integer","format":"int64"}},"X-Quota-Workspace":{"description":"Verified workspace owning this allowance: personal or enterprise:<id>.","schema":{"type":"string"}},"X-Quota-Environment":{"description":"Environment owning the allowance: sandbox or live.","schema":{"type":"string"}},"Retry-After":{"description":"Seconds until the exhausted quota or rate window resets. Sign retries with a new X-Request-ID.","schema":{"type":"integer","format":"int64"}},"X-RateLimit-Scope":{"description":"Rate counter scope: workspace, or user for enterprise verification calls.","schema":{"type":"string"}},"X-RateLimit-Limit":{"description":"Per-minute request limit when rate-limited.","schema":{"type":"integer","format":"int64"}},"X-RateLimit-Remaining":{"description":"Zero when the minute limit is exhausted.","schema":{"type":"integer","format":"int64"}},"X-RateLimit-Reset":{"description":"Unix epoch seconds when the minute limit resets.","schema":{"type":"integer","format":"int64"}}},"content":{"application/json":{"schema":{"$ref":"#/components/schemas/ApiResponseVoid"}}}},"413":{"description":"Request body is too large","headers":{"X-Request-ID":{"description":"Request identifier echoed for support and reconciliation.","schema":{"type":"string"}}},"content":{"application/json":{"schema":{"$ref":"#/components/schemas/ApiResponseVoid"}}}}},"x-dcwallet-signature-versions":["v1","v2"]}},"/api/v1/card-budgets/{budgetId}/fund":{"post":{"tags":["6. Card issuing"],"summary":"Move funds from a platform account into a shared-card budget","description":"Requires transfer:write and card:write API scopes, enterprise transfer permission and X-2FA-Code in live mode. The existing approval, compliance and ledger flow applies. Reuse Idempotency-Key for retries.\n\nSignature versions: v1 and v2.","operationId":"postCardBudgetsByBudgetIdFund","parameters":[{"name":"budgetId","in":"path","description":"The budget id value for this resource.","required":true,"schema":{"pattern":"[0-9]+","type":"string","example":"337893979704000512"}},{"name":"Idempotency-Key","in":"header","description":"Unique key for one mutating request. Reuse the same value only when retrying the same operation.","required":true,"schema":{"type":"string"}},{"name":"X-2FA-Code","in":"header","description":"The x-2 fa-code value for this resource.","required":false,"schema":{"type":"string"}},{"name":"X-Timestamp","in":"header","description":"Current Unix epoch time in seconds. Requests older or newer than five minutes are rejected.","required":true,"schema":{"pattern":"[0-9]{10}","type":"string","example":"1787562000"}},{"name":"X-Request-ID","in":"header","description":"Unique 16-128 character request identifier used for replay protection; never reuse it for a different HTTP request.","required":true,"schema":{"pattern":"[A-Za-z0-9._:-]{16,128}","type":"string","example":"018f6f4e-8f62-7fc2-9c4b-7be2f4203b6a"}},{"name":"X-Content-SHA256","in":"header","description":"Lowercase hexadecimal SHA-256 digest of the exact raw request body; use the digest of zero bytes when no body is sent.","required":true,"schema":{"pattern":"[0-9a-f]{64}","type":"string","example":"e3b0c44298fc1c149afbf4c8996fb92427ae41e4649b934ca495991b7852b855"}},{"name":"X-Workspace","in":"header","description":"Enterprise writes are available on this route. For enterprise access, copy your own enterprise:<id> from GET /api/v1/workspaces. Required for v2 requests. V1 requests use the historical key's fixed enterprise.","required":false,"schema":{"pattern":"personal|enterprise:[1-9][0-9]*","type":"string","example":null}},{"name":"X-Environment","in":"header","description":"Required and signed for v2 requests: live or sandbox. Optional for v1 requests.","required":false,"schema":{"pattern":"live|sandbox","type":"string","example":"live"}},{"name":"X-Signature","in":"header","description":"Existing keys accept v1 for their fixed enterprise or v2 for a signed workspace; new keys accept v2 only.","required":true,"schema":{"pattern":"v[12]=[0-9a-f]{64}","type":"string","example":"v2=0123456789abcdef0123456789abcdef0123456789abcdef0123456789abcdef"}},{"name":"Accept-Language","in":"header","description":"Response language: en-US = English (default); zh-CN = Simplified Chinese; zh-TW = Traditional Chinese. Numeric error codes are language-neutral.","required":false,"schema":{"type":"string","enum":["en-US","zh-CN","zh-TW"],"default":"en-US"}}],"requestBody":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/FundBudgetRequest"}}},"required":true},"responses":{"400":{"description":"Malformed JSON, missing header or invalid request parameter","headers":{"X-Request-ID":{"description":"Request identifier echoed for support and reconciliation.","schema":{"type":"string"}}},"content":{"application/json":{"schema":{"$ref":"#/components/schemas/ApiResponseVoid"}}}},"500":{"description":"Unexpected internal error; contact support with X-Request-ID","headers":{"X-Request-ID":{"description":"Request identifier echoed for support and reconciliation.","schema":{"type":"string"}}},"content":{"application/json":{"schema":{"$ref":"#/components/schemas/ApiResponseVoid"}}}},"403":{"description":"API-key scope, subscription, tenant or policy does not allow the operation","headers":{"X-Request-ID":{"description":"Request identifier echoed for support and reconciliation.","schema":{"type":"string"}}},"content":{"application/json":{"schema":{"$ref":"#/components/schemas/ApiResponseVoid"}}}},"200":{"description":"OK","headers":{"X-Request-ID":{"description":"Request identifier echoed for support and reconciliation.","schema":{"type":"string"}},"X-Quota-Limit":{"description":"Monthly API request allowance for the subscription.","schema":{"type":"integer","format":"int64"}},"X-Quota-Remaining":{"description":"Requests remaining in the current monthly allowance after this request.","schema":{"type":"integer","format":"int64"}},"X-Quota-Reset":{"description":"Unix epoch time in seconds when the monthly allowance resets.","schema":{"type":"integer","format":"int64"}},"X-Quota-Workspace":{"description":"Verified workspace owning this allowance: personal or enterprise:<id>.","schema":{"type":"string"}},"X-Quota-Environment":{"description":"Environment owning the allowance: sandbox or live.","schema":{"type":"string"}}},"content":{"application/json":{"schema":{"$ref":"#/components/schemas/ApiResponseBudgetTransferResponse"}}}},"401":{"description":"Invalid API key, content hash, signature, timestamp or request ID","headers":{"X-Request-ID":{"description":"Request identifier echoed for support and reconciliation.","schema":{"type":"string"}}},"content":{"application/json":{"schema":{"$ref":"#/components/schemas/ApiResponseVoid"}}}},"404":{"description":"Resource not found in this enterprise and environment","headers":{"X-Request-ID":{"description":"Request identifier echoed for support and reconciliation.","schema":{"type":"string"}}},"content":{"application/json":{"schema":{"$ref":"#/components/schemas/ApiResponseVoid"}}}},"422":{"description":"Business rule rejected the request","headers":{"X-Request-ID":{"description":"Request identifier echoed for support and reconciliation.","schema":{"type":"string"}}},"content":{"application/json":{"schema":{"$ref":"#/components/schemas/ApiResponseVoid"}}}},"503":{"description":"A required platform service is temporarily unavailable","headers":{"X-Request-ID":{"description":"Request identifier echoed for support and reconciliation.","schema":{"type":"string"}}},"content":{"application/json":{"schema":{"$ref":"#/components/schemas/ApiResponseVoid"}}}},"409":{"description":"Idempotency or resource-state conflict","headers":{"X-Request-ID":{"description":"Request identifier echoed for support and reconciliation.","schema":{"type":"string"}}},"content":{"application/json":{"schema":{"$ref":"#/components/schemas/ApiResponseVoid"}}}},"429":{"description":"Per-minute rate limit or monthly quota exceeded","headers":{"X-Request-ID":{"description":"Request identifier echoed for support and reconciliation.","schema":{"type":"string"}},"X-Quota-Limit":{"description":"Monthly API request allowance for the subscription.","schema":{"type":"integer","format":"int64"}},"X-Quota-Remaining":{"description":"Requests remaining in the current monthly allowance after this request.","schema":{"type":"integer","format":"int64"}},"X-Quota-Reset":{"description":"Unix epoch time in seconds when the monthly allowance resets.","schema":{"type":"integer","format":"int64"}},"X-Quota-Workspace":{"description":"Verified workspace owning this allowance: personal or enterprise:<id>.","schema":{"type":"string"}},"X-Quota-Environment":{"description":"Environment owning the allowance: sandbox or live.","schema":{"type":"string"}},"Retry-After":{"description":"Seconds until the exhausted quota or rate window resets. Sign retries with a new X-Request-ID.","schema":{"type":"integer","format":"int64"}},"X-RateLimit-Scope":{"description":"Rate counter scope: workspace, or user for enterprise verification calls.","schema":{"type":"string"}},"X-RateLimit-Limit":{"description":"Per-minute request limit when rate-limited.","schema":{"type":"integer","format":"int64"}},"X-RateLimit-Remaining":{"description":"Zero when the minute limit is exhausted.","schema":{"type":"integer","format":"int64"}},"X-RateLimit-Reset":{"description":"Unix epoch seconds when the minute limit resets.","schema":{"type":"integer","format":"int64"}}},"content":{"application/json":{"schema":{"$ref":"#/components/schemas/ApiResponseVoid"}}}},"413":{"description":"Request body is too large","headers":{"X-Request-ID":{"description":"Request identifier echoed for support and reconciliation.","schema":{"type":"string"}}},"content":{"application/json":{"schema":{"$ref":"#/components/schemas/ApiResponseVoid"}}}}},"x-dcwallet-signature-versions":["v1","v2"]}},"/api/v1/card-budgets/{budgetId}/allocate":{"post":{"tags":["6. Card issuing"],"summary":"Retry pending budget account allocation","description":"Signature versions: v1 and v2.","operationId":"postCardBudgetsByBudgetIdAllocate","parameters":[{"name":"budgetId","in":"path","description":"The budget id value for this resource.","required":true,"schema":{"pattern":"[0-9]+","type":"string","example":"337893979704000512"}},{"name":"X-Timestamp","in":"header","description":"Current Unix epoch time in seconds. Requests older or newer than five minutes are rejected.","required":true,"schema":{"pattern":"[0-9]{10}","type":"string","example":"1787562000"}},{"name":"X-Request-ID","in":"header","description":"Unique 16-128 character request identifier used for replay protection; never reuse it for a different HTTP request.","required":true,"schema":{"pattern":"[A-Za-z0-9._:-]{16,128}","type":"string","example":"018f6f4e-8f62-7fc2-9c4b-7be2f4203b6a"}},{"name":"X-Content-SHA256","in":"header","description":"Lowercase hexadecimal SHA-256 digest of the exact raw request body; use the digest of zero bytes when no body is sent.","required":true,"schema":{"pattern":"[0-9a-f]{64}","type":"string","example":"e3b0c44298fc1c149afbf4c8996fb92427ae41e4649b934ca495991b7852b855"}},{"name":"X-Workspace","in":"header","description":"Enterprise writes are available on this route. For enterprise access, copy your own enterprise:<id> from GET /api/v1/workspaces. Required for v2 requests. V1 requests use the historical key's fixed enterprise.","required":false,"schema":{"pattern":"personal|enterprise:[1-9][0-9]*","type":"string","example":null}},{"name":"X-Environment","in":"header","description":"Required and signed for v2 requests: live or sandbox. Optional for v1 requests.","required":false,"schema":{"pattern":"live|sandbox","type":"string","example":"live"}},{"name":"X-Signature","in":"header","description":"Existing keys accept v1 for their fixed enterprise or v2 for a signed workspace; new keys accept v2 only.","required":true,"schema":{"pattern":"v[12]=[0-9a-f]{64}","type":"string","example":"v2=0123456789abcdef0123456789abcdef0123456789abcdef0123456789abcdef"}},{"name":"Accept-Language","in":"header","description":"Response language: en-US = English (default); zh-CN = Simplified Chinese; zh-TW = Traditional Chinese. Numeric error codes are language-neutral.","required":false,"schema":{"type":"string","enum":["en-US","zh-CN","zh-TW"],"default":"en-US"}}],"responses":{"400":{"description":"Malformed JSON, missing header or invalid request parameter","headers":{"X-Request-ID":{"description":"Request identifier echoed for support and reconciliation.","schema":{"type":"string"}}},"content":{"application/json":{"schema":{"$ref":"#/components/schemas/ApiResponseVoid"}}}},"500":{"description":"Unexpected internal error; contact support with X-Request-ID","headers":{"X-Request-ID":{"description":"Request identifier echoed for support and reconciliation.","schema":{"type":"string"}}},"content":{"application/json":{"schema":{"$ref":"#/components/schemas/ApiResponseVoid"}}}},"403":{"description":"API-key scope, subscription, tenant or policy does not allow the operation","headers":{"X-Request-ID":{"description":"Request identifier echoed for support and reconciliation.","schema":{"type":"string"}}},"content":{"application/json":{"schema":{"$ref":"#/components/schemas/ApiResponseVoid"}}}},"200":{"description":"OK","headers":{"X-Request-ID":{"description":"Request identifier echoed for support and reconciliation.","schema":{"type":"string"}},"X-Quota-Limit":{"description":"Monthly API request allowance for the subscription.","schema":{"type":"integer","format":"int64"}},"X-Quota-Remaining":{"description":"Requests remaining in the current monthly allowance after this request.","schema":{"type":"integer","format":"int64"}},"X-Quota-Reset":{"description":"Unix epoch time in seconds when the monthly allowance resets.","schema":{"type":"integer","format":"int64"}},"X-Quota-Workspace":{"description":"Verified workspace owning this allowance: personal or enterprise:<id>.","schema":{"type":"string"}},"X-Quota-Environment":{"description":"Environment owning the allowance: sandbox or live.","schema":{"type":"string"}}},"content":{"application/json":{"schema":{"$ref":"#/components/schemas/ApiResponseBudgetResponse"}}}},"401":{"description":"Invalid API key, content hash, signature, timestamp or request ID","headers":{"X-Request-ID":{"description":"Request identifier echoed for support and reconciliation.","schema":{"type":"string"}}},"content":{"application/json":{"schema":{"$ref":"#/components/schemas/ApiResponseVoid"}}}},"404":{"description":"Resource not found in this enterprise and environment","headers":{"X-Request-ID":{"description":"Request identifier echoed for support and reconciliation.","schema":{"type":"string"}}},"content":{"application/json":{"schema":{"$ref":"#/components/schemas/ApiResponseVoid"}}}},"422":{"description":"Business rule rejected the request","headers":{"X-Request-ID":{"description":"Request identifier echoed for support and reconciliation.","schema":{"type":"string"}}},"content":{"application/json":{"schema":{"$ref":"#/components/schemas/ApiResponseVoid"}}}},"503":{"description":"A required platform service is temporarily unavailable","headers":{"X-Request-ID":{"description":"Request identifier echoed for support and reconciliation.","schema":{"type":"string"}}},"content":{"application/json":{"schema":{"$ref":"#/components/schemas/ApiResponseVoid"}}}},"409":{"description":"Idempotency or resource-state conflict","headers":{"X-Request-ID":{"description":"Request identifier echoed for support and reconciliation.","schema":{"type":"string"}}},"content":{"application/json":{"schema":{"$ref":"#/components/schemas/ApiResponseVoid"}}}},"429":{"description":"Per-minute rate limit or monthly quota exceeded","headers":{"X-Request-ID":{"description":"Request identifier echoed for support and reconciliation.","schema":{"type":"string"}},"X-Quota-Limit":{"description":"Monthly API request allowance for the subscription.","schema":{"type":"integer","format":"int64"}},"X-Quota-Remaining":{"description":"Requests remaining in the current monthly allowance after this request.","schema":{"type":"integer","format":"int64"}},"X-Quota-Reset":{"description":"Unix epoch time in seconds when the monthly allowance resets.","schema":{"type":"integer","format":"int64"}},"X-Quota-Workspace":{"description":"Verified workspace owning this allowance: personal or enterprise:<id>.","schema":{"type":"string"}},"X-Quota-Environment":{"description":"Environment owning the allowance: sandbox or live.","schema":{"type":"string"}},"Retry-After":{"description":"Seconds until the exhausted quota or rate window resets. Sign retries with a new X-Request-ID.","schema":{"type":"integer","format":"int64"}},"X-RateLimit-Scope":{"description":"Rate counter scope: workspace, or user for enterprise verification calls.","schema":{"type":"string"}},"X-RateLimit-Limit":{"description":"Per-minute request limit when rate-limited.","schema":{"type":"integer","format":"int64"}},"X-RateLimit-Remaining":{"description":"Zero when the minute limit is exhausted.","schema":{"type":"integer","format":"int64"}},"X-RateLimit-Reset":{"description":"Unix epoch seconds when the minute limit resets.","schema":{"type":"integer","format":"int64"}}},"content":{"application/json":{"schema":{"$ref":"#/components/schemas/ApiResponseVoid"}}}},"413":{"description":"Request body is too large","headers":{"X-Request-ID":{"description":"Request identifier echoed for support and reconciliation.","schema":{"type":"string"}}},"content":{"application/json":{"schema":{"$ref":"#/components/schemas/ApiResponseVoid"}}}}},"x-dcwallet-signature-versions":["v1","v2"]}},"/api/v1/card-applications":{"get":{"tags":["6. Card issuing"],"summary":"List enterprise card applications","description":"Signature versions: v1 and v2.","operationId":"getCardApplications","parameters":[{"name":"status","in":"query","description":"Optional filter. Application state: validating = checking eligibility (initial); funds_locking = reserving funds; funds_locked = funds reserved; issuing = channel request in progress; reconciling = channel outcome is unknown and being checked; succeeded = card issued (terminal); failed = issuance failed (terminal).","required":false,"schema":{"type":"string","enum":["validating","funds_locking","funds_locked","issuing","succeeded","reconciling","failed"]}},{"name":"page","in":"query","description":"One-based result page number.","required":false,"schema":{"type":"integer","format":"int32","default":1}},{"name":"pageSize","in":"query","description":"Maximum records returned per page; values above 100 are capped.","required":false,"schema":{"type":"integer","format":"int32","default":20}},{"name":"X-Timestamp","in":"header","description":"Current Unix epoch time in seconds. Requests older or newer than five minutes are rejected.","required":true,"schema":{"pattern":"[0-9]{10}","type":"string","example":"1787562000"}},{"name":"X-Request-ID","in":"header","description":"Unique 16-128 character request identifier used for replay protection; never reuse it for a different HTTP request.","required":true,"schema":{"pattern":"[A-Za-z0-9._:-]{16,128}","type":"string","example":"018f6f4e-8f62-7fc2-9c4b-7be2f4203b6a"}},{"name":"X-Content-SHA256","in":"header","description":"Lowercase hexadecimal SHA-256 digest of the exact raw request body; use the digest of zero bytes when no body is sent.","required":true,"schema":{"pattern":"[0-9a-f]{64}","type":"string","example":"e3b0c44298fc1c149afbf4c8996fb92427ae41e4649b934ca495991b7852b855"}},{"name":"X-Workspace","in":"header","description":"Enterprise reads are available on this route. For enterprise access, copy your own enterprise:<id> from GET /api/v1/workspaces. Required for v2 requests. V1 requests use the historical key's fixed enterprise.","required":false,"schema":{"pattern":"personal|enterprise:[1-9][0-9]*","type":"string","example":null}},{"name":"X-Environment","in":"header","description":"Required and signed for v2 requests: live or sandbox. Optional for v1 requests.","required":false,"schema":{"pattern":"live|sandbox","type":"string","example":"live"}},{"name":"X-Signature","in":"header","description":"Existing keys accept v1 for their fixed enterprise or v2 for a signed workspace; new keys accept v2 only.","required":true,"schema":{"pattern":"v[12]=[0-9a-f]{64}","type":"string","example":"v2=0123456789abcdef0123456789abcdef0123456789abcdef0123456789abcdef"}},{"name":"Accept-Language","in":"header","description":"Response language: en-US = English (default); zh-CN = Simplified Chinese; zh-TW = Traditional Chinese. Numeric error codes are language-neutral.","required":false,"schema":{"type":"string","enum":["en-US","zh-CN","zh-TW"],"default":"en-US"}}],"responses":{"400":{"description":"Malformed JSON, missing header or invalid request parameter","headers":{"X-Request-ID":{"description":"Request identifier echoed for support and reconciliation.","schema":{"type":"string"}}},"content":{"application/json":{"schema":{"$ref":"#/components/schemas/ApiResponseVoid"}}}},"500":{"description":"Unexpected internal error; contact support with X-Request-ID","headers":{"X-Request-ID":{"description":"Request identifier echoed for support and reconciliation.","schema":{"type":"string"}}},"content":{"application/json":{"schema":{"$ref":"#/components/schemas/ApiResponseVoid"}}}},"403":{"description":"API-key scope, subscription, tenant or policy does not allow the operation","headers":{"X-Request-ID":{"description":"Request identifier echoed for support and reconciliation.","schema":{"type":"string"}}},"content":{"application/json":{"schema":{"$ref":"#/components/schemas/ApiResponseVoid"}}}},"200":{"description":"OK","headers":{"X-Request-ID":{"description":"Request identifier echoed for support and reconciliation.","schema":{"type":"string"}},"X-Quota-Limit":{"description":"Monthly API request allowance for the subscription.","schema":{"type":"integer","format":"int64"}},"X-Quota-Remaining":{"description":"Requests remaining in the current monthly allowance after this request.","schema":{"type":"integer","format":"int64"}},"X-Quota-Reset":{"description":"Unix epoch time in seconds when the monthly allowance resets.","schema":{"type":"integer","format":"int64"}},"X-Quota-Workspace":{"description":"Verified workspace owning this allowance: personal or enterprise:<id>.","schema":{"type":"string"}},"X-Quota-Environment":{"description":"Environment owning the allowance: sandbox or live.","schema":{"type":"string"}}},"content":{"application/json":{"schema":{"$ref":"#/components/schemas/ApiResponsePageDataCardApplicationResponse"}}}},"401":{"description":"Invalid API key, content hash, signature, timestamp or request ID","headers":{"X-Request-ID":{"description":"Request identifier echoed for support and reconciliation.","schema":{"type":"string"}}},"content":{"application/json":{"schema":{"$ref":"#/components/schemas/ApiResponseVoid"}}}},"404":{"description":"Resource not found in this enterprise and environment","headers":{"X-Request-ID":{"description":"Request identifier echoed for support and reconciliation.","schema":{"type":"string"}}},"content":{"application/json":{"schema":{"$ref":"#/components/schemas/ApiResponseVoid"}}}},"422":{"description":"Business rule rejected the request","headers":{"X-Request-ID":{"description":"Request identifier echoed for support and reconciliation.","schema":{"type":"string"}}},"content":{"application/json":{"schema":{"$ref":"#/components/schemas/ApiResponseVoid"}}}},"503":{"description":"A required platform service is temporarily unavailable","headers":{"X-Request-ID":{"description":"Request identifier echoed for support and reconciliation.","schema":{"type":"string"}}},"content":{"application/json":{"schema":{"$ref":"#/components/schemas/ApiResponseVoid"}}}},"409":{"description":"Idempotency or resource-state conflict","headers":{"X-Request-ID":{"description":"Request identifier echoed for support and reconciliation.","schema":{"type":"string"}}},"content":{"application/json":{"schema":{"$ref":"#/components/schemas/ApiResponseVoid"}}}},"429":{"description":"Per-minute rate limit or monthly quota exceeded","headers":{"X-Request-ID":{"description":"Request identifier echoed for support and reconciliation.","schema":{"type":"string"}},"X-Quota-Limit":{"description":"Monthly API request allowance for the subscription.","schema":{"type":"integer","format":"int64"}},"X-Quota-Remaining":{"description":"Requests remaining in the current monthly allowance after this request.","schema":{"type":"integer","format":"int64"}},"X-Quota-Reset":{"description":"Unix epoch time in seconds when the monthly allowance resets.","schema":{"type":"integer","format":"int64"}},"X-Quota-Workspace":{"description":"Verified workspace owning this allowance: personal or enterprise:<id>.","schema":{"type":"string"}},"X-Quota-Environment":{"description":"Environment owning the allowance: sandbox or live.","schema":{"type":"string"}},"Retry-After":{"description":"Seconds until the exhausted quota or rate window resets. Sign retries with a new X-Request-ID.","schema":{"type":"integer","format":"int64"}},"X-RateLimit-Scope":{"description":"Rate counter scope: workspace, or user for enterprise verification calls.","schema":{"type":"string"}},"X-RateLimit-Limit":{"description":"Per-minute request limit when rate-limited.","schema":{"type":"integer","format":"int64"}},"X-RateLimit-Remaining":{"description":"Zero when the minute limit is exhausted.","schema":{"type":"integer","format":"int64"}},"X-RateLimit-Reset":{"description":"Unix epoch seconds when the minute limit resets.","schema":{"type":"integer","format":"int64"}}},"content":{"application/json":{"schema":{"$ref":"#/components/schemas/ApiResponseVoid"}}}},"413":{"description":"Request body is too large","headers":{"X-Request-ID":{"description":"Request identifier echoed for support and reconciliation.","schema":{"type":"string"}}},"content":{"application/json":{"schema":{"$ref":"#/components/schemas/ApiResponseVoid"}}}}},"x-dcwallet-signature-versions":["v1","v2"]},"post":{"tags":["6. Card issuing"],"summary":"Create a virtual card application","description":"Use IDs returned by contacts, card-products and accounts. For products whose channel requires identity verification, first upload the contact's passport or identity-card images through /contacts/{contactId}/documents/{role}; the platform securely forwards those stored files to the issuing channel, so this request does not repeat document bytes. Requires approved enterprise KYB when specified by the product. A supplied contact must have clear AML status; omitting it requires an explicitly selected BIN with contactRequired=false and verified account-owner eligibility. Code 9003 means the channel outcome is pending reconciliation; query the same application instead of creating a replacement request.\n\nSignature versions: v1 and v2.","operationId":"postCardApplications","parameters":[{"name":"Idempotency-Key","in":"header","description":"Unique key for one mutating request. Reuse the same value only when retrying the same operation.","required":true,"schema":{"type":"string"}},{"name":"X-Timestamp","in":"header","description":"Current Unix epoch time in seconds. Requests older or newer than five minutes are rejected.","required":true,"schema":{"pattern":"[0-9]{10}","type":"string","example":"1787562000"}},{"name":"X-Request-ID","in":"header","description":"Unique 16-128 character request identifier used for replay protection; never reuse it for a different HTTP request.","required":true,"schema":{"pattern":"[A-Za-z0-9._:-]{16,128}","type":"string","example":"018f6f4e-8f62-7fc2-9c4b-7be2f4203b6a"}},{"name":"X-Content-SHA256","in":"header","description":"Lowercase hexadecimal SHA-256 digest of the exact raw request body; use the digest of zero bytes when no body is sent.","required":true,"schema":{"pattern":"[0-9a-f]{64}","type":"string","example":"e3b0c44298fc1c149afbf4c8996fb92427ae41e4649b934ca495991b7852b855"}},{"name":"X-Workspace","in":"header","description":"Enterprise writes are available on this route. For enterprise access, copy your own enterprise:<id> from GET /api/v1/workspaces. Required for v2 requests. V1 requests use the historical key's fixed enterprise.","required":false,"schema":{"pattern":"personal|enterprise:[1-9][0-9]*","type":"string","example":null}},{"name":"X-Environment","in":"header","description":"Required and signed for v2 requests: live or sandbox. Optional for v1 requests.","required":false,"schema":{"pattern":"live|sandbox","type":"string","example":"live"}},{"name":"X-Signature","in":"header","description":"Existing keys accept v1 for their fixed enterprise or v2 for a signed workspace; new keys accept v2 only.","required":true,"schema":{"pattern":"v[12]=[0-9a-f]{64}","type":"string","example":"v2=0123456789abcdef0123456789abcdef0123456789abcdef0123456789abcdef"}},{"name":"Accept-Language","in":"header","description":"Response language: en-US = English (default); zh-CN = Simplified Chinese; zh-TW = Traditional Chinese. Numeric error codes are language-neutral.","required":false,"schema":{"type":"string","enum":["en-US","zh-CN","zh-TW"],"default":"en-US"}}],"requestBody":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/CardApplicationRequest"}}},"required":true},"responses":{"400":{"description":"Malformed JSON, missing header or invalid request parameter","headers":{"X-Request-ID":{"description":"Request identifier echoed for support and reconciliation.","schema":{"type":"string"}}},"content":{"application/json":{"schema":{"$ref":"#/components/schemas/ApiResponseVoid"}}}},"500":{"description":"Unexpected internal error; contact support with X-Request-ID","headers":{"X-Request-ID":{"description":"Request identifier echoed for support and reconciliation.","schema":{"type":"string"}}},"content":{"application/json":{"schema":{"$ref":"#/components/schemas/ApiResponseVoid"}}}},"403":{"description":"API-key scope, subscription, tenant or policy does not allow the operation","headers":{"X-Request-ID":{"description":"Request identifier echoed for support and reconciliation.","schema":{"type":"string"}}},"content":{"application/json":{"schema":{"$ref":"#/components/schemas/ApiResponseVoid"}}}},"200":{"description":"OK","headers":{"X-Request-ID":{"description":"Request identifier echoed for support and reconciliation.","schema":{"type":"string"}},"X-Quota-Limit":{"description":"Monthly API request allowance for the subscription.","schema":{"type":"integer","format":"int64"}},"X-Quota-Remaining":{"description":"Requests remaining in the current monthly allowance after this request.","schema":{"type":"integer","format":"int64"}},"X-Quota-Reset":{"description":"Unix epoch time in seconds when the monthly allowance resets.","schema":{"type":"integer","format":"int64"}},"X-Quota-Workspace":{"description":"Verified workspace owning this allowance: personal or enterprise:<id>.","schema":{"type":"string"}},"X-Quota-Environment":{"description":"Environment owning the allowance: sandbox or live.","schema":{"type":"string"}}},"content":{"application/json":{"schema":{"$ref":"#/components/schemas/ApiResponseCardApplicationResponse"}}}},"401":{"description":"Invalid API key, content hash, signature, timestamp or request ID","headers":{"X-Request-ID":{"description":"Request identifier echoed for support and reconciliation.","schema":{"type":"string"}}},"content":{"application/json":{"schema":{"$ref":"#/components/schemas/ApiResponseVoid"}}}},"404":{"description":"Resource not found in this enterprise and environment","headers":{"X-Request-ID":{"description":"Request identifier echoed for support and reconciliation.","schema":{"type":"string"}}},"content":{"application/json":{"schema":{"$ref":"#/components/schemas/ApiResponseVoid"}}}},"422":{"description":"Business rule rejected the request","headers":{"X-Request-ID":{"description":"Request identifier echoed for support and reconciliation.","schema":{"type":"string"}}},"content":{"application/json":{"schema":{"$ref":"#/components/schemas/ApiResponseVoid"}}}},"503":{"description":"A required platform service is temporarily unavailable","headers":{"X-Request-ID":{"description":"Request identifier echoed for support and reconciliation.","schema":{"type":"string"}}},"content":{"application/json":{"schema":{"$ref":"#/components/schemas/ApiResponseVoid"}}}},"409":{"description":"Idempotency or resource-state conflict","headers":{"X-Request-ID":{"description":"Request identifier echoed for support and reconciliation.","schema":{"type":"string"}}},"content":{"application/json":{"schema":{"$ref":"#/components/schemas/ApiResponseVoid"}}}},"429":{"description":"Per-minute rate limit or monthly quota exceeded","headers":{"X-Request-ID":{"description":"Request identifier echoed for support and reconciliation.","schema":{"type":"string"}},"X-Quota-Limit":{"description":"Monthly API request allowance for the subscription.","schema":{"type":"integer","format":"int64"}},"X-Quota-Remaining":{"description":"Requests remaining in the current monthly allowance after this request.","schema":{"type":"integer","format":"int64"}},"X-Quota-Reset":{"description":"Unix epoch time in seconds when the monthly allowance resets.","schema":{"type":"integer","format":"int64"}},"X-Quota-Workspace":{"description":"Verified workspace owning this allowance: personal or enterprise:<id>.","schema":{"type":"string"}},"X-Quota-Environment":{"description":"Environment owning the allowance: sandbox or live.","schema":{"type":"string"}},"Retry-After":{"description":"Seconds until the exhausted quota or rate window resets. Sign retries with a new X-Request-ID.","schema":{"type":"integer","format":"int64"}},"X-RateLimit-Scope":{"description":"Rate counter scope: workspace, or user for enterprise verification calls.","schema":{"type":"string"}},"X-RateLimit-Limit":{"description":"Per-minute request limit when rate-limited.","schema":{"type":"integer","format":"int64"}},"X-RateLimit-Remaining":{"description":"Zero when the minute limit is exhausted.","schema":{"type":"integer","format":"int64"}},"X-RateLimit-Reset":{"description":"Unix epoch seconds when the minute limit resets.","schema":{"type":"integer","format":"int64"}}},"content":{"application/json":{"schema":{"$ref":"#/components/schemas/ApiResponseVoid"}}}},"413":{"description":"Request body is too large","headers":{"X-Request-ID":{"description":"Request identifier echoed for support and reconciliation.","schema":{"type":"string"}}},"content":{"application/json":{"schema":{"$ref":"#/components/schemas/ApiResponseVoid"}}}},"202":{"description":"Accepted because the channel outcome is pending reconciliation. The body contains the persisted application; query it instead of creating another request.","headers":{"X-Request-ID":{"description":"Request identifier echoed for support and reconciliation.","schema":{"type":"string"}},"X-Quota-Limit":{"description":"Monthly API request allowance for the subscription.","schema":{"type":"integer","format":"int64"}},"X-Quota-Remaining":{"description":"Requests remaining in the current monthly allowance after this request.","schema":{"type":"integer","format":"int64"}},"X-Quota-Reset":{"description":"Unix epoch time in seconds when the monthly allowance resets.","schema":{"type":"integer","format":"int64"}},"X-Quota-Workspace":{"description":"Verified workspace owning this allowance: personal or enterprise:<id>.","schema":{"type":"string"}},"X-Quota-Environment":{"description":"Environment owning the allowance: sandbox or live.","schema":{"type":"string"}}},"content":{"application/json":{"schema":{"$ref":"#/components/schemas/ApiResponseCardApplicationResponse"}}}}},"x-dcwallet-signature-versions":["v1","v2"]}},"/api/v1/card-applications/quote":{"post":{"tags":["6. Card issuing"],"summary":"Validate and quote a virtual card application","description":"Runs the same product, country, KYB, contact, document, source-account and fee checks as issuance without creating an application or debiting funds.\n\nSignature versions: v1 and v2.","operationId":"postCardApplicationsQuote","parameters":[{"name":"X-Timestamp","in":"header","description":"Current Unix epoch time in seconds. Requests older or newer than five minutes are rejected.","required":true,"schema":{"pattern":"[0-9]{10}","type":"string","example":"1787562000"}},{"name":"X-Request-ID","in":"header","description":"Unique 16-128 character request identifier used for replay protection; never reuse it for a different HTTP request.","required":true,"schema":{"pattern":"[A-Za-z0-9._:-]{16,128}","type":"string","example":"018f6f4e-8f62-7fc2-9c4b-7be2f4203b6a"}},{"name":"X-Content-SHA256","in":"header","description":"Lowercase hexadecimal SHA-256 digest of the exact raw request body; use the digest of zero bytes when no body is sent.","required":true,"schema":{"pattern":"[0-9a-f]{64}","type":"string","example":"e3b0c44298fc1c149afbf4c8996fb92427ae41e4649b934ca495991b7852b855"}},{"name":"X-Workspace","in":"header","description":"Enterprise writes are available on this route. For enterprise access, copy your own enterprise:<id> from GET /api/v1/workspaces. Required for v2 requests. V1 requests use the historical key's fixed enterprise.","required":false,"schema":{"pattern":"personal|enterprise:[1-9][0-9]*","type":"string","example":null}},{"name":"X-Environment","in":"header","description":"Required and signed for v2 requests: live or sandbox. Optional for v1 requests.","required":false,"schema":{"pattern":"live|sandbox","type":"string","example":"live"}},{"name":"X-Signature","in":"header","description":"Existing keys accept v1 for their fixed enterprise or v2 for a signed workspace; new keys accept v2 only.","required":true,"schema":{"pattern":"v[12]=[0-9a-f]{64}","type":"string","example":"v2=0123456789abcdef0123456789abcdef0123456789abcdef0123456789abcdef"}},{"name":"Accept-Language","in":"header","description":"Response language: en-US = English (default); zh-CN = Simplified Chinese; zh-TW = Traditional Chinese. Numeric error codes are language-neutral.","required":false,"schema":{"type":"string","enum":["en-US","zh-CN","zh-TW"],"default":"en-US"}}],"requestBody":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/CardApplicationRequest"}}},"required":true},"responses":{"400":{"description":"Malformed JSON, missing header or invalid request parameter","headers":{"X-Request-ID":{"description":"Request identifier echoed for support and reconciliation.","schema":{"type":"string"}}},"content":{"application/json":{"schema":{"$ref":"#/components/schemas/ApiResponseVoid"}}}},"500":{"description":"Unexpected internal error; contact support with X-Request-ID","headers":{"X-Request-ID":{"description":"Request identifier echoed for support and reconciliation.","schema":{"type":"string"}}},"content":{"application/json":{"schema":{"$ref":"#/components/schemas/ApiResponseVoid"}}}},"403":{"description":"API-key scope, subscription, tenant or policy does not allow the operation","headers":{"X-Request-ID":{"description":"Request identifier echoed for support and reconciliation.","schema":{"type":"string"}}},"content":{"application/json":{"schema":{"$ref":"#/components/schemas/ApiResponseVoid"}}}},"200":{"description":"OK","headers":{"X-Request-ID":{"description":"Request identifier echoed for support and reconciliation.","schema":{"type":"string"}},"X-Quota-Limit":{"description":"Monthly API request allowance for the subscription.","schema":{"type":"integer","format":"int64"}},"X-Quota-Remaining":{"description":"Requests remaining in the current monthly allowance after this request.","schema":{"type":"integer","format":"int64"}},"X-Quota-Reset":{"description":"Unix epoch time in seconds when the monthly allowance resets.","schema":{"type":"integer","format":"int64"}},"X-Quota-Workspace":{"description":"Verified workspace owning this allowance: personal or enterprise:<id>.","schema":{"type":"string"}},"X-Quota-Environment":{"description":"Environment owning the allowance: sandbox or live.","schema":{"type":"string"}}},"content":{"application/json":{"schema":{"$ref":"#/components/schemas/ApiResponseCardApplicationQuoteResponse"}}}},"401":{"description":"Invalid API key, content hash, signature, timestamp or request ID","headers":{"X-Request-ID":{"description":"Request identifier echoed for support and reconciliation.","schema":{"type":"string"}}},"content":{"application/json":{"schema":{"$ref":"#/components/schemas/ApiResponseVoid"}}}},"404":{"description":"Resource not found in this enterprise and environment","headers":{"X-Request-ID":{"description":"Request identifier echoed for support and reconciliation.","schema":{"type":"string"}}},"content":{"application/json":{"schema":{"$ref":"#/components/schemas/ApiResponseVoid"}}}},"422":{"description":"Business rule rejected the request","headers":{"X-Request-ID":{"description":"Request identifier echoed for support and reconciliation.","schema":{"type":"string"}}},"content":{"application/json":{"schema":{"$ref":"#/components/schemas/ApiResponseVoid"}}}},"503":{"description":"A required platform service is temporarily unavailable","headers":{"X-Request-ID":{"description":"Request identifier echoed for support and reconciliation.","schema":{"type":"string"}}},"content":{"application/json":{"schema":{"$ref":"#/components/schemas/ApiResponseVoid"}}}},"409":{"description":"Idempotency or resource-state conflict","headers":{"X-Request-ID":{"description":"Request identifier echoed for support and reconciliation.","schema":{"type":"string"}}},"content":{"application/json":{"schema":{"$ref":"#/components/schemas/ApiResponseVoid"}}}},"429":{"description":"Per-minute rate limit or monthly quota exceeded","headers":{"X-Request-ID":{"description":"Request identifier echoed for support and reconciliation.","schema":{"type":"string"}},"X-Quota-Limit":{"description":"Monthly API request allowance for the subscription.","schema":{"type":"integer","format":"int64"}},"X-Quota-Remaining":{"description":"Requests remaining in the current monthly allowance after this request.","schema":{"type":"integer","format":"int64"}},"X-Quota-Reset":{"description":"Unix epoch time in seconds when the monthly allowance resets.","schema":{"type":"integer","format":"int64"}},"X-Quota-Workspace":{"description":"Verified workspace owning this allowance: personal or enterprise:<id>.","schema":{"type":"string"}},"X-Quota-Environment":{"description":"Environment owning the allowance: sandbox or live.","schema":{"type":"string"}},"Retry-After":{"description":"Seconds until the exhausted quota or rate window resets. Sign retries with a new X-Request-ID.","schema":{"type":"integer","format":"int64"}},"X-RateLimit-Scope":{"description":"Rate counter scope: workspace, or user for enterprise verification calls.","schema":{"type":"string"}},"X-RateLimit-Limit":{"description":"Per-minute request limit when rate-limited.","schema":{"type":"integer","format":"int64"}},"X-RateLimit-Remaining":{"description":"Zero when the minute limit is exhausted.","schema":{"type":"integer","format":"int64"}},"X-RateLimit-Reset":{"description":"Unix epoch seconds when the minute limit resets.","schema":{"type":"integer","format":"int64"}}},"content":{"application/json":{"schema":{"$ref":"#/components/schemas/ApiResponseVoid"}}}},"413":{"description":"Request body is too large","headers":{"X-Request-ID":{"description":"Request identifier echoed for support and reconciliation.","schema":{"type":"string"}}},"content":{"application/json":{"schema":{"$ref":"#/components/schemas/ApiResponseVoid"}}}}},"x-dcwallet-signature-versions":["v1","v2"]}},"/api/v1/blockchain-addresses":{"get":{"tags":["2. Receiving accounts"],"summary":"List blockchain receiving addresses in the selected workspace","description":"The returned ID identifies a blockchain receiving address in this workspace. Enterprise v1 clients may use it as blockchainAddressId when creating an invoice.\n\nSignature versions: v1 and v2.","operationId":"getBlockchainAddresses","parameters":[{"name":"X-Timestamp","in":"header","description":"Current Unix epoch time in seconds. Requests older or newer than five minutes are rejected.","required":true,"schema":{"pattern":"[0-9]{10}","type":"string","example":"1787562000"}},{"name":"X-Request-ID","in":"header","description":"Unique 16-128 character request identifier used for replay protection; never reuse it for a different HTTP request.","required":true,"schema":{"pattern":"[A-Za-z0-9._:-]{16,128}","type":"string","example":"018f6f4e-8f62-7fc2-9c4b-7be2f4203b6a"}},{"name":"X-Content-SHA256","in":"header","description":"Lowercase hexadecimal SHA-256 digest of the exact raw request body; use the digest of zero bytes when no body is sent.","required":true,"schema":{"pattern":"[0-9a-f]{64}","type":"string","example":"e3b0c44298fc1c149afbf4c8996fb92427ae41e4649b934ca495991b7852b855"}},{"name":"X-Workspace","in":"header","description":"Personal and enterprise reads are available on this route. For enterprise access, copy your own enterprise:<id> from GET /api/v1/workspaces. Required for v2 requests. V1 requests use the historical key's fixed enterprise.","required":false,"schema":{"pattern":"personal|enterprise:[1-9][0-9]*","type":"string","example":"personal"}},{"name":"X-Environment","in":"header","description":"Required and signed for v2 requests: live or sandbox. Optional for v1 requests.","required":false,"schema":{"pattern":"live|sandbox","type":"string","example":"live"}},{"name":"X-Signature","in":"header","description":"Existing keys accept v1 for their fixed enterprise or v2 for a signed workspace; new keys accept v2 only.","required":true,"schema":{"pattern":"v[12]=[0-9a-f]{64}","type":"string","example":"v2=0123456789abcdef0123456789abcdef0123456789abcdef0123456789abcdef"}},{"name":"Accept-Language","in":"header","description":"Response language: en-US = English (default); zh-CN = Simplified Chinese; zh-TW = Traditional Chinese. Numeric error codes are language-neutral.","required":false,"schema":{"type":"string","enum":["en-US","zh-CN","zh-TW"],"default":"en-US"}}],"responses":{"400":{"description":"Malformed JSON, missing header or invalid request parameter","headers":{"X-Request-ID":{"description":"Request identifier echoed for support and reconciliation.","schema":{"type":"string"}}},"content":{"application/json":{"schema":{"$ref":"#/components/schemas/ApiResponseVoid"}}}},"500":{"description":"Unexpected internal error; contact support with X-Request-ID","headers":{"X-Request-ID":{"description":"Request identifier echoed for support and reconciliation.","schema":{"type":"string"}}},"content":{"application/json":{"schema":{"$ref":"#/components/schemas/ApiResponseVoid"}}}},"403":{"description":"API-key scope, subscription, tenant or policy does not allow the operation","headers":{"X-Request-ID":{"description":"Request identifier echoed for support and reconciliation.","schema":{"type":"string"}}},"content":{"application/json":{"schema":{"$ref":"#/components/schemas/ApiResponseVoid"}}}},"200":{"description":"OK","headers":{"X-Request-ID":{"description":"Request identifier echoed for support and reconciliation.","schema":{"type":"string"}},"X-Quota-Limit":{"description":"Monthly API request allowance for the subscription.","schema":{"type":"integer","format":"int64"}},"X-Quota-Remaining":{"description":"Requests remaining in the current monthly allowance after this request.","schema":{"type":"integer","format":"int64"}},"X-Quota-Reset":{"description":"Unix epoch time in seconds when the monthly allowance resets.","schema":{"type":"integer","format":"int64"}},"X-Quota-Workspace":{"description":"Verified workspace owning this allowance: personal or enterprise:<id>.","schema":{"type":"string"}},"X-Quota-Environment":{"description":"Environment owning the allowance: sandbox or live.","schema":{"type":"string"}}},"content":{"application/json":{"schema":{"$ref":"#/components/schemas/ApiResponseListBlockchainAddressResponse"}}}},"401":{"description":"Invalid API key, content hash, signature, timestamp or request ID","headers":{"X-Request-ID":{"description":"Request identifier echoed for support and reconciliation.","schema":{"type":"string"}}},"content":{"application/json":{"schema":{"$ref":"#/components/schemas/ApiResponseVoid"}}}},"404":{"description":"Resource not found in this enterprise and environment","headers":{"X-Request-ID":{"description":"Request identifier echoed for support and reconciliation.","schema":{"type":"string"}}},"content":{"application/json":{"schema":{"$ref":"#/components/schemas/ApiResponseVoid"}}}},"422":{"description":"Business rule rejected the request","headers":{"X-Request-ID":{"description":"Request identifier echoed for support and reconciliation.","schema":{"type":"string"}}},"content":{"application/json":{"schema":{"$ref":"#/components/schemas/ApiResponseVoid"}}}},"503":{"description":"A required platform service is temporarily unavailable","headers":{"X-Request-ID":{"description":"Request identifier echoed for support and reconciliation.","schema":{"type":"string"}}},"content":{"application/json":{"schema":{"$ref":"#/components/schemas/ApiResponseVoid"}}}},"409":{"description":"Idempotency or resource-state conflict","headers":{"X-Request-ID":{"description":"Request identifier echoed for support and reconciliation.","schema":{"type":"string"}}},"content":{"application/json":{"schema":{"$ref":"#/components/schemas/ApiResponseVoid"}}}},"429":{"description":"Per-minute rate limit or monthly quota exceeded","headers":{"X-Request-ID":{"description":"Request identifier echoed for support and reconciliation.","schema":{"type":"string"}},"X-Quota-Limit":{"description":"Monthly API request allowance for the subscription.","schema":{"type":"integer","format":"int64"}},"X-Quota-Remaining":{"description":"Requests remaining in the current monthly allowance after this request.","schema":{"type":"integer","format":"int64"}},"X-Quota-Reset":{"description":"Unix epoch time in seconds when the monthly allowance resets.","schema":{"type":"integer","format":"int64"}},"X-Quota-Workspace":{"description":"Verified workspace owning this allowance: personal or enterprise:<id>.","schema":{"type":"string"}},"X-Quota-Environment":{"description":"Environment owning the allowance: sandbox or live.","schema":{"type":"string"}},"Retry-After":{"description":"Seconds until the exhausted quota or rate window resets. Sign retries with a new X-Request-ID.","schema":{"type":"integer","format":"int64"}},"X-RateLimit-Scope":{"description":"Rate counter scope: workspace, or user for enterprise verification calls.","schema":{"type":"string"}},"X-RateLimit-Limit":{"description":"Per-minute request limit when rate-limited.","schema":{"type":"integer","format":"int64"}},"X-RateLimit-Remaining":{"description":"Zero when the minute limit is exhausted.","schema":{"type":"integer","format":"int64"}},"X-RateLimit-Reset":{"description":"Unix epoch seconds when the minute limit resets.","schema":{"type":"integer","format":"int64"}}},"content":{"application/json":{"schema":{"$ref":"#/components/schemas/ApiResponseVoid"}}}},"413":{"description":"Request body is too large","headers":{"X-Request-ID":{"description":"Request identifier echoed for support and reconciliation.","schema":{"type":"string"}}},"content":{"application/json":{"schema":{"$ref":"#/components/schemas/ApiResponseVoid"}}}}},"x-dcwallet-signature-versions":["v1","v2"]},"post":{"tags":["2. Receiving accounts"],"summary":"Create a blockchain receiving address","description":"Requires a v2 signed workspace request and Idempotency-Key. Send a chain; the receiving wallet is selected or created automatically. Retry with the same key to obtain the same address. An existing walletId remains optional.\n\nSignature versions: v2 only.","operationId":"postBlockchainAddresses","parameters":[{"name":"Idempotency-Key","in":"header","description":"Unique key for one mutating request. Reuse the same value only when retrying the same operation.","required":true,"schema":{"type":"string"}},{"name":"X-Timestamp","in":"header","description":"Current Unix epoch time in seconds. Requests older or newer than five minutes are rejected.","required":true,"schema":{"pattern":"[0-9]{10}","type":"string","example":"1787562000"}},{"name":"X-Request-ID","in":"header","description":"Unique 16-128 character request identifier used for replay protection; never reuse it for a different HTTP request.","required":true,"schema":{"pattern":"[A-Za-z0-9._:-]{16,128}","type":"string","example":"018f6f4e-8f62-7fc2-9c4b-7be2f4203b6a"}},{"name":"X-Content-SHA256","in":"header","description":"Lowercase hexadecimal SHA-256 digest of the exact raw request body; use the digest of zero bytes when no body is sent.","required":true,"schema":{"pattern":"[0-9a-f]{64}","type":"string","example":"e3b0c44298fc1c149afbf4c8996fb92427ae41e4649b934ca495991b7852b855"}},{"name":"X-Workspace","in":"header","description":"Signed workspace selector: personal or enterprise:<id>. Get your enterprise ID from GET /api/v1/workspaces.","required":true,"schema":{"pattern":"personal|enterprise:[1-9][0-9]*","type":"string","example":"personal"}},{"name":"X-Environment","in":"header","description":"Signed key environment: live or sandbox.","required":true,"schema":{"pattern":"live|sandbox","type":"string","example":"live"}},{"name":"X-Signature","in":"header","description":"v2-prefixed lowercase HMAC-SHA256 signature; existing and new keys can use v2 when enabled.","required":true,"schema":{"pattern":"v2=[0-9a-f]{64}","type":"string","example":"v2=0123456789abcdef0123456789abcdef0123456789abcdef0123456789abcdef"}},{"name":"Accept-Language","in":"header","description":"Response language: en-US = English (default); zh-CN = Simplified Chinese; zh-TW = Traditional Chinese. Numeric error codes are language-neutral.","required":false,"schema":{"type":"string","enum":["en-US","zh-CN","zh-TW"],"default":"en-US"}}],"requestBody":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/CreateBlockchainAddressRequest"}}},"required":true},"responses":{"400":{"description":"Malformed JSON, missing header or invalid request parameter","headers":{"X-Request-ID":{"description":"Request identifier echoed for support and reconciliation.","schema":{"type":"string"}}},"content":{"application/json":{"schema":{"$ref":"#/components/schemas/ApiResponseVoid"}}}},"500":{"description":"Unexpected internal error; contact support with X-Request-ID","headers":{"X-Request-ID":{"description":"Request identifier echoed for support and reconciliation.","schema":{"type":"string"}}},"content":{"application/json":{"schema":{"$ref":"#/components/schemas/ApiResponseVoid"}}}},"403":{"description":"API-key scope, subscription, tenant or policy does not allow the operation","headers":{"X-Request-ID":{"description":"Request identifier echoed for support and reconciliation.","schema":{"type":"string"}}},"content":{"application/json":{"schema":{"$ref":"#/components/schemas/ApiResponseVoid"}}}},"200":{"description":"OK","headers":{"X-Request-ID":{"description":"Request identifier echoed for support and reconciliation.","schema":{"type":"string"}},"X-Quota-Limit":{"description":"Monthly API request allowance for the subscription.","schema":{"type":"integer","format":"int64"}},"X-Quota-Remaining":{"description":"Requests remaining in the current monthly allowance after this request.","schema":{"type":"integer","format":"int64"}},"X-Quota-Reset":{"description":"Unix epoch time in seconds when the monthly allowance resets.","schema":{"type":"integer","format":"int64"}},"X-Quota-Workspace":{"description":"Verified workspace owning this allowance: personal or enterprise:<id>.","schema":{"type":"string"}},"X-Quota-Environment":{"description":"Environment owning the allowance: sandbox or live.","schema":{"type":"string"}}},"content":{"application/json":{"schema":{"$ref":"#/components/schemas/ApiResponseBlockchainAddressResponse"}}}},"401":{"description":"Invalid API key, content hash, signature, timestamp or request ID","headers":{"X-Request-ID":{"description":"Request identifier echoed for support and reconciliation.","schema":{"type":"string"}}},"content":{"application/json":{"schema":{"$ref":"#/components/schemas/ApiResponseVoid"}}}},"404":{"description":"Resource not found in this enterprise and environment","headers":{"X-Request-ID":{"description":"Request identifier echoed for support and reconciliation.","schema":{"type":"string"}}},"content":{"application/json":{"schema":{"$ref":"#/components/schemas/ApiResponseVoid"}}}},"422":{"description":"Business rule rejected the request","headers":{"X-Request-ID":{"description":"Request identifier echoed for support and reconciliation.","schema":{"type":"string"}}},"content":{"application/json":{"schema":{"$ref":"#/components/schemas/ApiResponseVoid"}}}},"503":{"description":"A required platform service is temporarily unavailable","headers":{"X-Request-ID":{"description":"Request identifier echoed for support and reconciliation.","schema":{"type":"string"}}},"content":{"application/json":{"schema":{"$ref":"#/components/schemas/ApiResponseVoid"}}}},"409":{"description":"Idempotency or resource-state conflict","headers":{"X-Request-ID":{"description":"Request identifier echoed for support and reconciliation.","schema":{"type":"string"}}},"content":{"application/json":{"schema":{"$ref":"#/components/schemas/ApiResponseVoid"}}}},"429":{"description":"Per-minute rate limit or monthly quota exceeded","headers":{"X-Request-ID":{"description":"Request identifier echoed for support and reconciliation.","schema":{"type":"string"}},"X-Quota-Limit":{"description":"Monthly API request allowance for the subscription.","schema":{"type":"integer","format":"int64"}},"X-Quota-Remaining":{"description":"Requests remaining in the current monthly allowance after this request.","schema":{"type":"integer","format":"int64"}},"X-Quota-Reset":{"description":"Unix epoch time in seconds when the monthly allowance resets.","schema":{"type":"integer","format":"int64"}},"X-Quota-Workspace":{"description":"Verified workspace owning this allowance: personal or enterprise:<id>.","schema":{"type":"string"}},"X-Quota-Environment":{"description":"Environment owning the allowance: sandbox or live.","schema":{"type":"string"}},"Retry-After":{"description":"Seconds until the exhausted quota or rate window resets. Sign retries with a new X-Request-ID.","schema":{"type":"integer","format":"int64"}},"X-RateLimit-Scope":{"description":"Rate counter scope: workspace, or user for enterprise verification calls.","schema":{"type":"string"}},"X-RateLimit-Limit":{"description":"Per-minute request limit when rate-limited.","schema":{"type":"integer","format":"int64"}},"X-RateLimit-Remaining":{"description":"Zero when the minute limit is exhausted.","schema":{"type":"integer","format":"int64"}},"X-RateLimit-Reset":{"description":"Unix epoch seconds when the minute limit resets.","schema":{"type":"integer","format":"int64"}}},"content":{"application/json":{"schema":{"$ref":"#/components/schemas/ApiResponseVoid"}}}},"413":{"description":"Request body is too large","headers":{"X-Request-ID":{"description":"Request identifier echoed for support and reconciliation.","schema":{"type":"string"}}},"content":{"application/json":{"schema":{"$ref":"#/components/schemas/ApiResponseVoid"}}}}},"x-dcwallet-signature-versions":["v2"]}},"/api/v1/bank-application-documents":{"post":{"tags":["2. Receiving accounts"],"summary":"Upload a bank application document","description":"Sign the raw PDF, JPEG or PNG bytes. Use its documentId in POST /bank-account-applications under applicationDocuments.\n\nSignature versions: v2 only.","operationId":"postBankApplicationDocuments","parameters":[{"name":"Idempotency-Key","in":"header","description":"Unique key for one mutating request. Reuse the same value only when retrying the same operation.","required":true,"schema":{"type":"string"}},{"name":"X-Content-SHA256","in":"header","description":"The x-content-sha256 value for this resource.","required":true,"schema":{"type":"string"}},{"name":"X-File-Name","in":"header","description":"Original file name with an extension supported by this upload endpoint.","required":false,"schema":{"type":"string"}},{"name":"Content-Type","in":"header","description":"Raw upload media type supported by this endpoint's request body.","required":true,"schema":{"type":"string"}},{"name":"X-Timestamp","in":"header","description":"Current Unix epoch time in seconds. Requests older or newer than five minutes are rejected.","required":true,"schema":{"pattern":"[0-9]{10}","type":"string","example":"1787562000"}},{"name":"X-Request-ID","in":"header","description":"Unique 16-128 character request identifier used for replay protection; never reuse it for a different HTTP request.","required":true,"schema":{"pattern":"[A-Za-z0-9._:-]{16,128}","type":"string","example":"018f6f4e-8f62-7fc2-9c4b-7be2f4203b6a"}},{"name":"X-Workspace","in":"header","description":"Signed workspace selector: personal or enterprise:<id>. Get your enterprise ID from GET /api/v1/workspaces.","required":true,"schema":{"pattern":"personal|enterprise:[1-9][0-9]*","type":"string","example":"personal"}},{"name":"X-Environment","in":"header","description":"Signed key environment: live or sandbox.","required":true,"schema":{"pattern":"live|sandbox","type":"string","example":"live"}},{"name":"X-Signature","in":"header","description":"v2-prefixed lowercase HMAC-SHA256 signature; existing and new keys can use v2 when enabled.","required":true,"schema":{"pattern":"v2=[0-9a-f]{64}","type":"string","example":"v2=0123456789abcdef0123456789abcdef0123456789abcdef0123456789abcdef"}},{"name":"Accept-Language","in":"header","description":"Response language: en-US = English (default); zh-CN = Simplified Chinese; zh-TW = Traditional Chinese. Numeric error codes are language-neutral.","required":false,"schema":{"type":"string","enum":["en-US","zh-CN","zh-TW"],"default":"en-US"}}],"requestBody":{"content":{"image/png":{"schema":{"type":"string","format":"byte"}},"application/pdf":{"schema":{"type":"string","format":"byte"}},"image/jpeg":{"schema":{"type":"string","format":"byte"}}},"required":true},"responses":{"400":{"description":"Malformed JSON, missing header or invalid request parameter","headers":{"X-Request-ID":{"description":"Request identifier echoed for support and reconciliation.","schema":{"type":"string"}}},"content":{"application/json":{"schema":{"$ref":"#/components/schemas/ApiResponseVoid"}}}},"500":{"description":"Unexpected internal error; contact support with X-Request-ID","headers":{"X-Request-ID":{"description":"Request identifier echoed for support and reconciliation.","schema":{"type":"string"}}},"content":{"application/json":{"schema":{"$ref":"#/components/schemas/ApiResponseVoid"}}}},"403":{"description":"API-key scope, subscription, tenant or policy does not allow the operation","headers":{"X-Request-ID":{"description":"Request identifier echoed for support and reconciliation.","schema":{"type":"string"}}},"content":{"application/json":{"schema":{"$ref":"#/components/schemas/ApiResponseVoid"}}}},"200":{"description":"OK","headers":{"X-Request-ID":{"description":"Request identifier echoed for support and reconciliation.","schema":{"type":"string"}},"X-Quota-Limit":{"description":"Monthly API request allowance for the subscription.","schema":{"type":"integer","format":"int64"}},"X-Quota-Remaining":{"description":"Requests remaining in the current monthly allowance after this request.","schema":{"type":"integer","format":"int64"}},"X-Quota-Reset":{"description":"Unix epoch time in seconds when the monthly allowance resets.","schema":{"type":"integer","format":"int64"}},"X-Quota-Workspace":{"description":"Verified workspace owning this allowance: personal or enterprise:<id>.","schema":{"type":"string"}},"X-Quota-Environment":{"description":"Environment owning the allowance: sandbox or live.","schema":{"type":"string"}}},"content":{"application/json":{"schema":{"$ref":"#/components/schemas/ApiResponseMapStringString"}}}},"401":{"description":"Invalid API key, content hash, signature, timestamp or request ID","headers":{"X-Request-ID":{"description":"Request identifier echoed for support and reconciliation.","schema":{"type":"string"}}},"content":{"application/json":{"schema":{"$ref":"#/components/schemas/ApiResponseVoid"}}}},"404":{"description":"Resource not found in this enterprise and environment","headers":{"X-Request-ID":{"description":"Request identifier echoed for support and reconciliation.","schema":{"type":"string"}}},"content":{"application/json":{"schema":{"$ref":"#/components/schemas/ApiResponseVoid"}}}},"422":{"description":"Business rule rejected the request","headers":{"X-Request-ID":{"description":"Request identifier echoed for support and reconciliation.","schema":{"type":"string"}}},"content":{"application/json":{"schema":{"$ref":"#/components/schemas/ApiResponseVoid"}}}},"503":{"description":"A required platform service is temporarily unavailable","headers":{"X-Request-ID":{"description":"Request identifier echoed for support and reconciliation.","schema":{"type":"string"}}},"content":{"application/json":{"schema":{"$ref":"#/components/schemas/ApiResponseVoid"}}}},"409":{"description":"Idempotency or resource-state conflict","headers":{"X-Request-ID":{"description":"Request identifier echoed for support and reconciliation.","schema":{"type":"string"}}},"content":{"application/json":{"schema":{"$ref":"#/components/schemas/ApiResponseVoid"}}}},"429":{"description":"Per-minute rate limit or monthly quota exceeded","headers":{"X-Request-ID":{"description":"Request identifier echoed for support and reconciliation.","schema":{"type":"string"}},"X-Quota-Limit":{"description":"Monthly API request allowance for the subscription.","schema":{"type":"integer","format":"int64"}},"X-Quota-Remaining":{"description":"Requests remaining in the current monthly allowance after this request.","schema":{"type":"integer","format":"int64"}},"X-Quota-Reset":{"description":"Unix epoch time in seconds when the monthly allowance resets.","schema":{"type":"integer","format":"int64"}},"X-Quota-Workspace":{"description":"Verified workspace owning this allowance: personal or enterprise:<id>.","schema":{"type":"string"}},"X-Quota-Environment":{"description":"Environment owning the allowance: sandbox or live.","schema":{"type":"string"}},"Retry-After":{"description":"Seconds until the exhausted quota or rate window resets. Sign retries with a new X-Request-ID.","schema":{"type":"integer","format":"int64"}},"X-RateLimit-Scope":{"description":"Rate counter scope: workspace, or user for enterprise verification calls.","schema":{"type":"string"}},"X-RateLimit-Limit":{"description":"Per-minute request limit when rate-limited.","schema":{"type":"integer","format":"int64"}},"X-RateLimit-Remaining":{"description":"Zero when the minute limit is exhausted.","schema":{"type":"integer","format":"int64"}},"X-RateLimit-Reset":{"description":"Unix epoch seconds when the minute limit resets.","schema":{"type":"integer","format":"int64"}}},"content":{"application/json":{"schema":{"$ref":"#/components/schemas/ApiResponseVoid"}}}},"413":{"description":"Request body is too large","headers":{"X-Request-ID":{"description":"Request identifier echoed for support and reconciliation.","schema":{"type":"string"}}},"content":{"application/json":{"schema":{"$ref":"#/components/schemas/ApiResponseVoid"}}}}},"x-dcwallet-signature-versions":["v2"]}},"/api/v1/bank-account-applications":{"get":{"tags":["2. Receiving accounts"],"summary":"List bank account applications for this enterprise","description":"Signature versions: v1 and v2.","operationId":"getBankAccountApplications","parameters":[{"name":"page","in":"query","description":"One-based result page number.","required":false,"schema":{"type":"integer","format":"int32","default":1}},{"name":"pageSize","in":"query","description":"Maximum records returned per page; values above 100 are capped.","required":false,"schema":{"type":"integer","format":"int32","default":20}},{"name":"X-Timestamp","in":"header","description":"Current Unix epoch time in seconds. Requests older or newer than five minutes are rejected.","required":true,"schema":{"pattern":"[0-9]{10}","type":"string","example":"1787562000"}},{"name":"X-Request-ID","in":"header","description":"Unique 16-128 character request identifier used for replay protection; never reuse it for a different HTTP request.","required":true,"schema":{"pattern":"[A-Za-z0-9._:-]{16,128}","type":"string","example":"018f6f4e-8f62-7fc2-9c4b-7be2f4203b6a"}},{"name":"X-Content-SHA256","in":"header","description":"Lowercase hexadecimal SHA-256 digest of the exact raw request body; use the digest of zero bytes when no body is sent.","required":true,"schema":{"pattern":"[0-9a-f]{64}","type":"string","example":"e3b0c44298fc1c149afbf4c8996fb92427ae41e4649b934ca495991b7852b855"}},{"name":"X-Workspace","in":"header","description":"Personal and enterprise reads are available on this route. For enterprise access, copy your own enterprise:<id> from GET /api/v1/workspaces. Required for v2 requests. V1 requests use the historical key's fixed enterprise.","required":false,"schema":{"pattern":"personal|enterprise:[1-9][0-9]*","type":"string","example":"personal"}},{"name":"X-Environment","in":"header","description":"Required and signed for v2 requests: live or sandbox. Optional for v1 requests.","required":false,"schema":{"pattern":"live|sandbox","type":"string","example":"live"}},{"name":"X-Signature","in":"header","description":"Existing keys accept v1 for their fixed enterprise or v2 for a signed workspace; new keys accept v2 only.","required":true,"schema":{"pattern":"v[12]=[0-9a-f]{64}","type":"string","example":"v2=0123456789abcdef0123456789abcdef0123456789abcdef0123456789abcdef"}},{"name":"Accept-Language","in":"header","description":"Response language: en-US = English (default); zh-CN = Simplified Chinese; zh-TW = Traditional Chinese. Numeric error codes are language-neutral.","required":false,"schema":{"type":"string","enum":["en-US","zh-CN","zh-TW"],"default":"en-US"}}],"responses":{"400":{"description":"Malformed JSON, missing header or invalid request parameter","headers":{"X-Request-ID":{"description":"Request identifier echoed for support and reconciliation.","schema":{"type":"string"}}},"content":{"application/json":{"schema":{"$ref":"#/components/schemas/ApiResponseVoid"}}}},"500":{"description":"Unexpected internal error; contact support with X-Request-ID","headers":{"X-Request-ID":{"description":"Request identifier echoed for support and reconciliation.","schema":{"type":"string"}}},"content":{"application/json":{"schema":{"$ref":"#/components/schemas/ApiResponseVoid"}}}},"403":{"description":"API-key scope, subscription, tenant or policy does not allow the operation","headers":{"X-Request-ID":{"description":"Request identifier echoed for support and reconciliation.","schema":{"type":"string"}}},"content":{"application/json":{"schema":{"$ref":"#/components/schemas/ApiResponseVoid"}}}},"200":{"description":"OK","headers":{"X-Request-ID":{"description":"Request identifier echoed for support and reconciliation.","schema":{"type":"string"}},"X-Quota-Limit":{"description":"Monthly API request allowance for the subscription.","schema":{"type":"integer","format":"int64"}},"X-Quota-Remaining":{"description":"Requests remaining in the current monthly allowance after this request.","schema":{"type":"integer","format":"int64"}},"X-Quota-Reset":{"description":"Unix epoch time in seconds when the monthly allowance resets.","schema":{"type":"integer","format":"int64"}},"X-Quota-Workspace":{"description":"Verified workspace owning this allowance: personal or enterprise:<id>.","schema":{"type":"string"}},"X-Quota-Environment":{"description":"Environment owning the allowance: sandbox or live.","schema":{"type":"string"}}},"content":{"application/json":{"schema":{"$ref":"#/components/schemas/ApiResponsePageDataApplicationResponse"}}}},"401":{"description":"Invalid API key, content hash, signature, timestamp or request ID","headers":{"X-Request-ID":{"description":"Request identifier echoed for support and reconciliation.","schema":{"type":"string"}}},"content":{"application/json":{"schema":{"$ref":"#/components/schemas/ApiResponseVoid"}}}},"404":{"description":"Resource not found in this enterprise and environment","headers":{"X-Request-ID":{"description":"Request identifier echoed for support and reconciliation.","schema":{"type":"string"}}},"content":{"application/json":{"schema":{"$ref":"#/components/schemas/ApiResponseVoid"}}}},"422":{"description":"Business rule rejected the request","headers":{"X-Request-ID":{"description":"Request identifier echoed for support and reconciliation.","schema":{"type":"string"}}},"content":{"application/json":{"schema":{"$ref":"#/components/schemas/ApiResponseVoid"}}}},"503":{"description":"A required platform service is temporarily unavailable","headers":{"X-Request-ID":{"description":"Request identifier echoed for support and reconciliation.","schema":{"type":"string"}}},"content":{"application/json":{"schema":{"$ref":"#/components/schemas/ApiResponseVoid"}}}},"409":{"description":"Idempotency or resource-state conflict","headers":{"X-Request-ID":{"description":"Request identifier echoed for support and reconciliation.","schema":{"type":"string"}}},"content":{"application/json":{"schema":{"$ref":"#/components/schemas/ApiResponseVoid"}}}},"429":{"description":"Per-minute rate limit or monthly quota exceeded","headers":{"X-Request-ID":{"description":"Request identifier echoed for support and reconciliation.","schema":{"type":"string"}},"X-Quota-Limit":{"description":"Monthly API request allowance for the subscription.","schema":{"type":"integer","format":"int64"}},"X-Quota-Remaining":{"description":"Requests remaining in the current monthly allowance after this request.","schema":{"type":"integer","format":"int64"}},"X-Quota-Reset":{"description":"Unix epoch time in seconds when the monthly allowance resets.","schema":{"type":"integer","format":"int64"}},"X-Quota-Workspace":{"description":"Verified workspace owning this allowance: personal or enterprise:<id>.","schema":{"type":"string"}},"X-Quota-Environment":{"description":"Environment owning the allowance: sandbox or live.","schema":{"type":"string"}},"Retry-After":{"description":"Seconds until the exhausted quota or rate window resets. Sign retries with a new X-Request-ID.","schema":{"type":"integer","format":"int64"}},"X-RateLimit-Scope":{"description":"Rate counter scope: workspace, or user for enterprise verification calls.","schema":{"type":"string"}},"X-RateLimit-Limit":{"description":"Per-minute request limit when rate-limited.","schema":{"type":"integer","format":"int64"}},"X-RateLimit-Remaining":{"description":"Zero when the minute limit is exhausted.","schema":{"type":"integer","format":"int64"}},"X-RateLimit-Reset":{"description":"Unix epoch seconds when the minute limit resets.","schema":{"type":"integer","format":"int64"}}},"content":{"application/json":{"schema":{"$ref":"#/components/schemas/ApiResponseVoid"}}}},"413":{"description":"Request body is too large","headers":{"X-Request-ID":{"description":"Request identifier echoed for support and reconciliation.","schema":{"type":"string"}}},"content":{"application/json":{"schema":{"$ref":"#/components/schemas/ApiResponseVoid"}}}}},"x-dcwallet-signature-versions":["v1","v2"]},"post":{"tags":["2. Receiving accounts"],"summary":"Apply for a bank receiving account","description":"Requires a v2 signed workspace request and Idempotency-Key. Live returns a pending application for manual operator processing. Sandbox Currency Cloud, DBS and CFSB use explicit simulator routes and immediately return an approved application with a synthetic account. Live KYB materials can be supplied through the enterprise verification API. Use GET to follow review and then list bank accounts.\n\nSignature versions: v2 only.","operationId":"postBankAccountApplications","parameters":[{"name":"Idempotency-Key","in":"header","description":"Unique key for one mutating request. Reuse the same value only when retrying the same operation.","required":true,"schema":{"type":"string"}},{"name":"X-Timestamp","in":"header","description":"Current Unix epoch time in seconds. Requests older or newer than five minutes are rejected.","required":true,"schema":{"pattern":"[0-9]{10}","type":"string","example":"1787562000"}},{"name":"X-Request-ID","in":"header","description":"Unique 16-128 character request identifier used for replay protection; never reuse it for a different HTTP request.","required":true,"schema":{"pattern":"[A-Za-z0-9._:-]{16,128}","type":"string","example":"018f6f4e-8f62-7fc2-9c4b-7be2f4203b6a"}},{"name":"X-Content-SHA256","in":"header","description":"Lowercase hexadecimal SHA-256 digest of the exact raw request body; use the digest of zero bytes when no body is sent.","required":true,"schema":{"pattern":"[0-9a-f]{64}","type":"string","example":"e3b0c44298fc1c149afbf4c8996fb92427ae41e4649b934ca495991b7852b855"}},{"name":"X-Workspace","in":"header","description":"Signed workspace selector: personal or enterprise:<id>. Get your enterprise ID from GET /api/v1/workspaces.","required":true,"schema":{"pattern":"personal|enterprise:[1-9][0-9]*","type":"string","example":"personal"}},{"name":"X-Environment","in":"header","description":"Signed key environment: live or sandbox.","required":true,"schema":{"pattern":"live|sandbox","type":"string","example":"live"}},{"name":"X-Signature","in":"header","description":"v2-prefixed lowercase HMAC-SHA256 signature; existing and new keys can use v2 when enabled.","required":true,"schema":{"pattern":"v2=[0-9a-f]{64}","type":"string","example":"v2=0123456789abcdef0123456789abcdef0123456789abcdef0123456789abcdef"}},{"name":"Accept-Language","in":"header","description":"Response language: en-US = English (default); zh-CN = Simplified Chinese; zh-TW = Traditional Chinese. Numeric error codes are language-neutral.","required":false,"schema":{"type":"string","enum":["en-US","zh-CN","zh-TW"],"default":"en-US"}}],"requestBody":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/BankApplicationRequest"}}},"required":true},"responses":{"400":{"description":"Malformed JSON, missing header or invalid request parameter","headers":{"X-Request-ID":{"description":"Request identifier echoed for support and reconciliation.","schema":{"type":"string"}}},"content":{"application/json":{"schema":{"$ref":"#/components/schemas/ApiResponseVoid"}}}},"500":{"description":"Unexpected internal error; contact support with X-Request-ID","headers":{"X-Request-ID":{"description":"Request identifier echoed for support and reconciliation.","schema":{"type":"string"}}},"content":{"application/json":{"schema":{"$ref":"#/components/schemas/ApiResponseVoid"}}}},"403":{"description":"API-key scope, subscription, tenant or policy does not allow the operation","headers":{"X-Request-ID":{"description":"Request identifier echoed for support and reconciliation.","schema":{"type":"string"}}},"content":{"application/json":{"schema":{"$ref":"#/components/schemas/ApiResponseVoid"}}}},"200":{"description":"OK","headers":{"X-Request-ID":{"description":"Request identifier echoed for support and reconciliation.","schema":{"type":"string"}},"X-Quota-Limit":{"description":"Monthly API request allowance for the subscription.","schema":{"type":"integer","format":"int64"}},"X-Quota-Remaining":{"description":"Requests remaining in the current monthly allowance after this request.","schema":{"type":"integer","format":"int64"}},"X-Quota-Reset":{"description":"Unix epoch time in seconds when the monthly allowance resets.","schema":{"type":"integer","format":"int64"}},"X-Quota-Workspace":{"description":"Verified workspace owning this allowance: personal or enterprise:<id>.","schema":{"type":"string"}},"X-Quota-Environment":{"description":"Environment owning the allowance: sandbox or live.","schema":{"type":"string"}}},"content":{"application/json":{"schema":{"$ref":"#/components/schemas/ApiResponseApplicationResponse"}}}},"401":{"description":"Invalid API key, content hash, signature, timestamp or request ID","headers":{"X-Request-ID":{"description":"Request identifier echoed for support and reconciliation.","schema":{"type":"string"}}},"content":{"application/json":{"schema":{"$ref":"#/components/schemas/ApiResponseVoid"}}}},"404":{"description":"Resource not found in this enterprise and environment","headers":{"X-Request-ID":{"description":"Request identifier echoed for support and reconciliation.","schema":{"type":"string"}}},"content":{"application/json":{"schema":{"$ref":"#/components/schemas/ApiResponseVoid"}}}},"422":{"description":"Business rule rejected the request","headers":{"X-Request-ID":{"description":"Request identifier echoed for support and reconciliation.","schema":{"type":"string"}}},"content":{"application/json":{"schema":{"$ref":"#/components/schemas/ApiResponseVoid"}}}},"503":{"description":"A required platform service is temporarily unavailable","headers":{"X-Request-ID":{"description":"Request identifier echoed for support and reconciliation.","schema":{"type":"string"}}},"content":{"application/json":{"schema":{"$ref":"#/components/schemas/ApiResponseVoid"}}}},"409":{"description":"Idempotency or resource-state conflict","headers":{"X-Request-ID":{"description":"Request identifier echoed for support and reconciliation.","schema":{"type":"string"}}},"content":{"application/json":{"schema":{"$ref":"#/components/schemas/ApiResponseVoid"}}}},"429":{"description":"Per-minute rate limit or monthly quota exceeded","headers":{"X-Request-ID":{"description":"Request identifier echoed for support and reconciliation.","schema":{"type":"string"}},"X-Quota-Limit":{"description":"Monthly API request allowance for the subscription.","schema":{"type":"integer","format":"int64"}},"X-Quota-Remaining":{"description":"Requests remaining in the current monthly allowance after this request.","schema":{"type":"integer","format":"int64"}},"X-Quota-Reset":{"description":"Unix epoch time in seconds when the monthly allowance resets.","schema":{"type":"integer","format":"int64"}},"X-Quota-Workspace":{"description":"Verified workspace owning this allowance: personal or enterprise:<id>.","schema":{"type":"string"}},"X-Quota-Environment":{"description":"Environment owning the allowance: sandbox or live.","schema":{"type":"string"}},"Retry-After":{"description":"Seconds until the exhausted quota or rate window resets. Sign retries with a new X-Request-ID.","schema":{"type":"integer","format":"int64"}},"X-RateLimit-Scope":{"description":"Rate counter scope: workspace, or user for enterprise verification calls.","schema":{"type":"string"}},"X-RateLimit-Limit":{"description":"Per-minute request limit when rate-limited.","schema":{"type":"integer","format":"int64"}},"X-RateLimit-Remaining":{"description":"Zero when the minute limit is exhausted.","schema":{"type":"integer","format":"int64"}},"X-RateLimit-Reset":{"description":"Unix epoch seconds when the minute limit resets.","schema":{"type":"integer","format":"int64"}}},"content":{"application/json":{"schema":{"$ref":"#/components/schemas/ApiResponseVoid"}}}},"413":{"description":"Request body is too large","headers":{"X-Request-ID":{"description":"Request identifier echoed for support and reconciliation.","schema":{"type":"string"}}},"content":{"application/json":{"schema":{"$ref":"#/components/schemas/ApiResponseVoid"}}}}},"x-dcwallet-signature-versions":["v2"]}},"/api/v1/agent/tasks":{"post":{"tags":["8. Treasury Agent"],"summary":"Create an asynchronous Treasury Agent task","description":"Signature versions: v1 and v2.","operationId":"postAgentTasks","parameters":[{"name":"Idempotency-Key","in":"header","description":"Unique key for one mutating request. Reuse the same value only when retrying the same operation.","required":true,"schema":{"type":"string"}},{"name":"X-Timestamp","in":"header","description":"Current Unix epoch time in seconds. Requests older or newer than five minutes are rejected.","required":true,"schema":{"pattern":"[0-9]{10}","type":"string","example":"1787562000"}},{"name":"X-Request-ID","in":"header","description":"Unique 16-128 character request identifier used for replay protection; never reuse it for a different HTTP request.","required":true,"schema":{"pattern":"[A-Za-z0-9._:-]{16,128}","type":"string","example":"018f6f4e-8f62-7fc2-9c4b-7be2f4203b6a"}},{"name":"X-Content-SHA256","in":"header","description":"Lowercase hexadecimal SHA-256 digest of the exact raw request body; use the digest of zero bytes when no body is sent.","required":true,"schema":{"pattern":"[0-9a-f]{64}","type":"string","example":"e3b0c44298fc1c149afbf4c8996fb92427ae41e4649b934ca495991b7852b855"}},{"name":"X-Workspace","in":"header","description":"Enterprise writes are available on this route. For enterprise access, copy your own enterprise:<id> from GET /api/v1/workspaces. Required for v2 requests. V1 requests use the historical key's fixed enterprise.","required":false,"schema":{"pattern":"personal|enterprise:[1-9][0-9]*","type":"string","example":null}},{"name":"X-Environment","in":"header","description":"Required and signed for v2 requests: live or sandbox. Optional for v1 requests.","required":false,"schema":{"pattern":"live|sandbox","type":"string","example":"live"}},{"name":"X-Signature","in":"header","description":"Existing keys accept v1 for their fixed enterprise or v2 for a signed workspace; new keys accept v2 only.","required":true,"schema":{"pattern":"v[12]=[0-9a-f]{64}","type":"string","example":"v2=0123456789abcdef0123456789abcdef0123456789abcdef0123456789abcdef"}},{"name":"Accept-Language","in":"header","description":"Response language: en-US = English (default); zh-CN = Simplified Chinese; zh-TW = Traditional Chinese. Numeric error codes are language-neutral.","required":false,"schema":{"type":"string","enum":["en-US","zh-CN","zh-TW"],"default":"en-US"}}],"requestBody":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/AgentTaskRequest"}}},"required":true},"responses":{"400":{"description":"Malformed JSON, missing header or invalid request parameter","headers":{"X-Request-ID":{"description":"Request identifier echoed for support and reconciliation.","schema":{"type":"string"}}},"content":{"application/json":{"schema":{"$ref":"#/components/schemas/ApiResponseVoid"}}}},"500":{"description":"Unexpected internal error; contact support with X-Request-ID","headers":{"X-Request-ID":{"description":"Request identifier echoed for support and reconciliation.","schema":{"type":"string"}}},"content":{"application/json":{"schema":{"$ref":"#/components/schemas/ApiResponseVoid"}}}},"403":{"description":"API-key scope, subscription, tenant or policy does not allow the operation","headers":{"X-Request-ID":{"description":"Request identifier echoed for support and reconciliation.","schema":{"type":"string"}}},"content":{"application/json":{"schema":{"$ref":"#/components/schemas/ApiResponseVoid"}}}},"202":{"description":"Task accepted for asynchronous processing","headers":{"X-Request-ID":{"description":"Request identifier echoed for support and reconciliation.","schema":{"type":"string"}},"X-Quota-Limit":{"description":"Monthly API request allowance for the subscription.","schema":{"type":"integer","format":"int64"}},"X-Quota-Remaining":{"description":"Requests remaining in the current monthly allowance after this request.","schema":{"type":"integer","format":"int64"}},"X-Quota-Reset":{"description":"Unix epoch time in seconds when the monthly allowance resets.","schema":{"type":"integer","format":"int64"}},"X-Quota-Workspace":{"description":"Verified workspace owning this allowance: personal or enterprise:<id>.","schema":{"type":"string"}},"X-Quota-Environment":{"description":"Environment owning the allowance: sandbox or live.","schema":{"type":"string"}}},"content":{"application/json":{"schema":{"$ref":"#/components/schemas/ApiResponseAgentTaskResponse"}}}},"401":{"description":"Invalid API key, content hash, signature, timestamp or request ID","headers":{"X-Request-ID":{"description":"Request identifier echoed for support and reconciliation.","schema":{"type":"string"}}},"content":{"application/json":{"schema":{"$ref":"#/components/schemas/ApiResponseVoid"}}}},"404":{"description":"Resource not found in this enterprise and environment","headers":{"X-Request-ID":{"description":"Request identifier echoed for support and reconciliation.","schema":{"type":"string"}}},"content":{"application/json":{"schema":{"$ref":"#/components/schemas/ApiResponseVoid"}}}},"422":{"description":"Business rule rejected the request","headers":{"X-Request-ID":{"description":"Request identifier echoed for support and reconciliation.","schema":{"type":"string"}}},"content":{"application/json":{"schema":{"$ref":"#/components/schemas/ApiResponseVoid"}}}},"503":{"description":"A required platform service is temporarily unavailable","headers":{"X-Request-ID":{"description":"Request identifier echoed for support and reconciliation.","schema":{"type":"string"}}},"content":{"application/json":{"schema":{"$ref":"#/components/schemas/ApiResponseVoid"}}}},"409":{"description":"Idempotency or resource-state conflict","headers":{"X-Request-ID":{"description":"Request identifier echoed for support and reconciliation.","schema":{"type":"string"}}},"content":{"application/json":{"schema":{"$ref":"#/components/schemas/ApiResponseVoid"}}}},"429":{"description":"Per-minute rate limit or monthly quota exceeded","headers":{"X-Request-ID":{"description":"Request identifier echoed for support and reconciliation.","schema":{"type":"string"}},"X-Quota-Limit":{"description":"Monthly API request allowance for the subscription.","schema":{"type":"integer","format":"int64"}},"X-Quota-Remaining":{"description":"Requests remaining in the current monthly allowance after this request.","schema":{"type":"integer","format":"int64"}},"X-Quota-Reset":{"description":"Unix epoch time in seconds when the monthly allowance resets.","schema":{"type":"integer","format":"int64"}},"X-Quota-Workspace":{"description":"Verified workspace owning this allowance: personal or enterprise:<id>.","schema":{"type":"string"}},"X-Quota-Environment":{"description":"Environment owning the allowance: sandbox or live.","schema":{"type":"string"}},"Retry-After":{"description":"Seconds until the exhausted quota or rate window resets. Sign retries with a new X-Request-ID.","schema":{"type":"integer","format":"int64"}},"X-RateLimit-Scope":{"description":"Rate counter scope: workspace, or user for enterprise verification calls.","schema":{"type":"string"}},"X-RateLimit-Limit":{"description":"Per-minute request limit when rate-limited.","schema":{"type":"integer","format":"int64"}},"X-RateLimit-Remaining":{"description":"Zero when the minute limit is exhausted.","schema":{"type":"integer","format":"int64"}},"X-RateLimit-Reset":{"description":"Unix epoch seconds when the minute limit resets.","schema":{"type":"integer","format":"int64"}}},"content":{"application/json":{"schema":{"$ref":"#/components/schemas/ApiResponseVoid"}}}},"413":{"description":"Request body is too large","headers":{"X-Request-ID":{"description":"Request identifier echoed for support and reconciliation.","schema":{"type":"string"}}},"content":{"application/json":{"schema":{"$ref":"#/components/schemas/ApiResponseVoid"}}}}},"x-dcwallet-signature-versions":["v1","v2"]}},"/api/v1/agent/tasks/{taskId}/cancel":{"post":{"tags":["8. Treasury Agent"],"summary":"Cancel a Treasury Agent task","description":"Signature versions: v1 and v2.","operationId":"postAgentTasksByTaskIdCancel","parameters":[{"name":"taskId","in":"path","description":"Treasury Agent task ID returned when the task is created. Keep IDs as strings.","required":true,"schema":{"type":"string"}},{"name":"X-Timestamp","in":"header","description":"Current Unix epoch time in seconds. Requests older or newer than five minutes are rejected.","required":true,"schema":{"pattern":"[0-9]{10}","type":"string","example":"1787562000"}},{"name":"X-Request-ID","in":"header","description":"Unique 16-128 character request identifier used for replay protection; never reuse it for a different HTTP request.","required":true,"schema":{"pattern":"[A-Za-z0-9._:-]{16,128}","type":"string","example":"018f6f4e-8f62-7fc2-9c4b-7be2f4203b6a"}},{"name":"X-Content-SHA256","in":"header","description":"Lowercase hexadecimal SHA-256 digest of the exact raw request body; use the digest of zero bytes when no body is sent.","required":true,"schema":{"pattern":"[0-9a-f]{64}","type":"string","example":"e3b0c44298fc1c149afbf4c8996fb92427ae41e4649b934ca495991b7852b855"}},{"name":"X-Workspace","in":"header","description":"Enterprise writes are available on this route. For enterprise access, copy your own enterprise:<id> from GET /api/v1/workspaces. Required for v2 requests. V1 requests use the historical key's fixed enterprise.","required":false,"schema":{"pattern":"personal|enterprise:[1-9][0-9]*","type":"string","example":null}},{"name":"X-Environment","in":"header","description":"Required and signed for v2 requests: live or sandbox. Optional for v1 requests.","required":false,"schema":{"pattern":"live|sandbox","type":"string","example":"live"}},{"name":"X-Signature","in":"header","description":"Existing keys accept v1 for their fixed enterprise or v2 for a signed workspace; new keys accept v2 only.","required":true,"schema":{"pattern":"v[12]=[0-9a-f]{64}","type":"string","example":"v2=0123456789abcdef0123456789abcdef0123456789abcdef0123456789abcdef"}},{"name":"Accept-Language","in":"header","description":"Response language: en-US = English (default); zh-CN = Simplified Chinese; zh-TW = Traditional Chinese. Numeric error codes are language-neutral.","required":false,"schema":{"type":"string","enum":["en-US","zh-CN","zh-TW"],"default":"en-US"}}],"responses":{"400":{"description":"Malformed JSON, missing header or invalid request parameter","headers":{"X-Request-ID":{"description":"Request identifier echoed for support and reconciliation.","schema":{"type":"string"}}},"content":{"application/json":{"schema":{"$ref":"#/components/schemas/ApiResponseVoid"}}}},"500":{"description":"Unexpected internal error; contact support with X-Request-ID","headers":{"X-Request-ID":{"description":"Request identifier echoed for support and reconciliation.","schema":{"type":"string"}}},"content":{"application/json":{"schema":{"$ref":"#/components/schemas/ApiResponseVoid"}}}},"403":{"description":"API-key scope, subscription, tenant or policy does not allow the operation","headers":{"X-Request-ID":{"description":"Request identifier echoed for support and reconciliation.","schema":{"type":"string"}}},"content":{"application/json":{"schema":{"$ref":"#/components/schemas/ApiResponseVoid"}}}},"200":{"description":"OK","headers":{"X-Request-ID":{"description":"Request identifier echoed for support and reconciliation.","schema":{"type":"string"}},"X-Quota-Limit":{"description":"Monthly API request allowance for the subscription.","schema":{"type":"integer","format":"int64"}},"X-Quota-Remaining":{"description":"Requests remaining in the current monthly allowance after this request.","schema":{"type":"integer","format":"int64"}},"X-Quota-Reset":{"description":"Unix epoch time in seconds when the monthly allowance resets.","schema":{"type":"integer","format":"int64"}},"X-Quota-Workspace":{"description":"Verified workspace owning this allowance: personal or enterprise:<id>.","schema":{"type":"string"}},"X-Quota-Environment":{"description":"Environment owning the allowance: sandbox or live.","schema":{"type":"string"}}},"content":{"application/json":{"schema":{"$ref":"#/components/schemas/ApiResponseAgentTaskResponse"}}}},"401":{"description":"Invalid API key, content hash, signature, timestamp or request ID","headers":{"X-Request-ID":{"description":"Request identifier echoed for support and reconciliation.","schema":{"type":"string"}}},"content":{"application/json":{"schema":{"$ref":"#/components/schemas/ApiResponseVoid"}}}},"404":{"description":"Resource not found in this enterprise and environment","headers":{"X-Request-ID":{"description":"Request identifier echoed for support and reconciliation.","schema":{"type":"string"}}},"content":{"application/json":{"schema":{"$ref":"#/components/schemas/ApiResponseVoid"}}}},"422":{"description":"Business rule rejected the request","headers":{"X-Request-ID":{"description":"Request identifier echoed for support and reconciliation.","schema":{"type":"string"}}},"content":{"application/json":{"schema":{"$ref":"#/components/schemas/ApiResponseVoid"}}}},"503":{"description":"A required platform service is temporarily unavailable","headers":{"X-Request-ID":{"description":"Request identifier echoed for support and reconciliation.","schema":{"type":"string"}}},"content":{"application/json":{"schema":{"$ref":"#/components/schemas/ApiResponseVoid"}}}},"409":{"description":"Idempotency or resource-state conflict","headers":{"X-Request-ID":{"description":"Request identifier echoed for support and reconciliation.","schema":{"type":"string"}}},"content":{"application/json":{"schema":{"$ref":"#/components/schemas/ApiResponseVoid"}}}},"429":{"description":"Per-minute rate limit or monthly quota exceeded","headers":{"X-Request-ID":{"description":"Request identifier echoed for support and reconciliation.","schema":{"type":"string"}},"X-Quota-Limit":{"description":"Monthly API request allowance for the subscription.","schema":{"type":"integer","format":"int64"}},"X-Quota-Remaining":{"description":"Requests remaining in the current monthly allowance after this request.","schema":{"type":"integer","format":"int64"}},"X-Quota-Reset":{"description":"Unix epoch time in seconds when the monthly allowance resets.","schema":{"type":"integer","format":"int64"}},"X-Quota-Workspace":{"description":"Verified workspace owning this allowance: personal or enterprise:<id>.","schema":{"type":"string"}},"X-Quota-Environment":{"description":"Environment owning the allowance: sandbox or live.","schema":{"type":"string"}},"Retry-After":{"description":"Seconds until the exhausted quota or rate window resets. Sign retries with a new X-Request-ID.","schema":{"type":"integer","format":"int64"}},"X-RateLimit-Scope":{"description":"Rate counter scope: workspace, or user for enterprise verification calls.","schema":{"type":"string"}},"X-RateLimit-Limit":{"description":"Per-minute request limit when rate-limited.","schema":{"type":"integer","format":"int64"}},"X-RateLimit-Remaining":{"description":"Zero when the minute limit is exhausted.","schema":{"type":"integer","format":"int64"}},"X-RateLimit-Reset":{"description":"Unix epoch seconds when the minute limit resets.","schema":{"type":"integer","format":"int64"}}},"content":{"application/json":{"schema":{"$ref":"#/components/schemas/ApiResponseVoid"}}}},"413":{"description":"Request body is too large","headers":{"X-Request-ID":{"description":"Request identifier echoed for support and reconciliation.","schema":{"type":"string"}}},"content":{"application/json":{"schema":{"$ref":"#/components/schemas/ApiResponseVoid"}}}}},"x-dcwallet-signature-versions":["v1","v2"]}},"/api/v1/webhook-endpoints/{endpointId}":{"get":{"tags":["7. Webhooks"],"summary":"Get a webhook endpoint owned by this user","description":"Signature versions: v1 and v2.","operationId":"getWebhookEndpointsByEndpointId","parameters":[{"name":"endpointId","in":"path","description":"Webhook endpoint ID returned by /api/v1/webhook-endpoints. Keep IDs as strings.","required":true,"schema":{"pattern":"[0-9]+","type":"string","example":"337893979704000512"}},{"name":"X-Timestamp","in":"header","description":"Current Unix epoch time in seconds. Requests older or newer than five minutes are rejected.","required":true,"schema":{"pattern":"[0-9]{10}","type":"string","example":"1787562000"}},{"name":"X-Request-ID","in":"header","description":"Unique 16-128 character request identifier used for replay protection; never reuse it for a different HTTP request.","required":true,"schema":{"pattern":"[A-Za-z0-9._:-]{16,128}","type":"string","example":"018f6f4e-8f62-7fc2-9c4b-7be2f4203b6a"}},{"name":"X-Content-SHA256","in":"header","description":"Lowercase hexadecimal SHA-256 digest of the exact raw request body; use the digest of zero bytes when no body is sent.","required":true,"schema":{"pattern":"[0-9a-f]{64}","type":"string","example":"e3b0c44298fc1c149afbf4c8996fb92427ae41e4649b934ca495991b7852b855"}},{"name":"X-Workspace","in":"header","description":"Enterprise reads are available on this route. For enterprise access, copy your own enterprise:<id> from GET /api/v1/workspaces. Required for v2 requests. V1 requests use the historical key's fixed enterprise.","required":false,"schema":{"pattern":"personal|enterprise:[1-9][0-9]*","type":"string","example":"personal"}},{"name":"X-Environment","in":"header","description":"Required and signed for v2 requests: live or sandbox. Optional for v1 requests.","required":false,"schema":{"pattern":"live|sandbox","type":"string","example":"live"}},{"name":"X-Signature","in":"header","description":"Existing keys accept v1 for their fixed enterprise or v2 for a signed workspace; new keys accept v2 only.","required":true,"schema":{"pattern":"v[12]=[0-9a-f]{64}","type":"string","example":"v2=0123456789abcdef0123456789abcdef0123456789abcdef0123456789abcdef"}},{"name":"Accept-Language","in":"header","description":"Response language: en-US = English (default); zh-CN = Simplified Chinese; zh-TW = Traditional Chinese. Numeric error codes are language-neutral.","required":false,"schema":{"type":"string","enum":["en-US","zh-CN","zh-TW"],"default":"en-US"}}],"responses":{"400":{"description":"Malformed JSON, missing header or invalid request parameter","headers":{"X-Request-ID":{"description":"Request identifier echoed for support and reconciliation.","schema":{"type":"string"}}},"content":{"application/json":{"schema":{"$ref":"#/components/schemas/ApiResponseVoid"}}}},"500":{"description":"Unexpected internal error; contact support with X-Request-ID","headers":{"X-Request-ID":{"description":"Request identifier echoed for support and reconciliation.","schema":{"type":"string"}}},"content":{"application/json":{"schema":{"$ref":"#/components/schemas/ApiResponseVoid"}}}},"403":{"description":"API-key scope, subscription, tenant or policy does not allow the operation","headers":{"X-Request-ID":{"description":"Request identifier echoed for support and reconciliation.","schema":{"type":"string"}}},"content":{"application/json":{"schema":{"$ref":"#/components/schemas/ApiResponseVoid"}}}},"200":{"description":"OK","headers":{"X-Request-ID":{"description":"Request identifier echoed for support and reconciliation.","schema":{"type":"string"}},"X-Quota-Limit":{"description":"Monthly API request allowance for the subscription.","schema":{"type":"integer","format":"int64"}},"X-Quota-Remaining":{"description":"Requests remaining in the current monthly allowance after this request.","schema":{"type":"integer","format":"int64"}},"X-Quota-Reset":{"description":"Unix epoch time in seconds when the monthly allowance resets.","schema":{"type":"integer","format":"int64"}},"X-Quota-Workspace":{"description":"Verified workspace owning this allowance: personal or enterprise:<id>.","schema":{"type":"string"}},"X-Quota-Environment":{"description":"Environment owning the allowance: sandbox or live.","schema":{"type":"string"}}},"content":{"application/json":{"schema":{"$ref":"#/components/schemas/ApiResponseWebhookEndpointResponse"}}}},"401":{"description":"Invalid API key, content hash, signature, timestamp or request ID","headers":{"X-Request-ID":{"description":"Request identifier echoed for support and reconciliation.","schema":{"type":"string"}}},"content":{"application/json":{"schema":{"$ref":"#/components/schemas/ApiResponseVoid"}}}},"404":{"description":"Resource not found in this enterprise and environment","headers":{"X-Request-ID":{"description":"Request identifier echoed for support and reconciliation.","schema":{"type":"string"}}},"content":{"application/json":{"schema":{"$ref":"#/components/schemas/ApiResponseVoid"}}}},"422":{"description":"Business rule rejected the request","headers":{"X-Request-ID":{"description":"Request identifier echoed for support and reconciliation.","schema":{"type":"string"}}},"content":{"application/json":{"schema":{"$ref":"#/components/schemas/ApiResponseVoid"}}}},"503":{"description":"A required platform service is temporarily unavailable","headers":{"X-Request-ID":{"description":"Request identifier echoed for support and reconciliation.","schema":{"type":"string"}}},"content":{"application/json":{"schema":{"$ref":"#/components/schemas/ApiResponseVoid"}}}},"409":{"description":"Idempotency or resource-state conflict","headers":{"X-Request-ID":{"description":"Request identifier echoed for support and reconciliation.","schema":{"type":"string"}}},"content":{"application/json":{"schema":{"$ref":"#/components/schemas/ApiResponseVoid"}}}},"429":{"description":"Per-minute rate limit or monthly quota exceeded","headers":{"X-Request-ID":{"description":"Request identifier echoed for support and reconciliation.","schema":{"type":"string"}},"X-Quota-Limit":{"description":"Monthly API request allowance for the subscription.","schema":{"type":"integer","format":"int64"}},"X-Quota-Remaining":{"description":"Requests remaining in the current monthly allowance after this request.","schema":{"type":"integer","format":"int64"}},"X-Quota-Reset":{"description":"Unix epoch time in seconds when the monthly allowance resets.","schema":{"type":"integer","format":"int64"}},"X-Quota-Workspace":{"description":"Verified workspace owning this allowance: personal or enterprise:<id>.","schema":{"type":"string"}},"X-Quota-Environment":{"description":"Environment owning the allowance: sandbox or live.","schema":{"type":"string"}},"Retry-After":{"description":"Seconds until the exhausted quota or rate window resets. Sign retries with a new X-Request-ID.","schema":{"type":"integer","format":"int64"}},"X-RateLimit-Scope":{"description":"Rate counter scope: workspace, or user for enterprise verification calls.","schema":{"type":"string"}},"X-RateLimit-Limit":{"description":"Per-minute request limit when rate-limited.","schema":{"type":"integer","format":"int64"}},"X-RateLimit-Remaining":{"description":"Zero when the minute limit is exhausted.","schema":{"type":"integer","format":"int64"}},"X-RateLimit-Reset":{"description":"Unix epoch seconds when the minute limit resets.","schema":{"type":"integer","format":"int64"}}},"content":{"application/json":{"schema":{"$ref":"#/components/schemas/ApiResponseVoid"}}}},"413":{"description":"Request body is too large","headers":{"X-Request-ID":{"description":"Request identifier echoed for support and reconciliation.","schema":{"type":"string"}}},"content":{"application/json":{"schema":{"$ref":"#/components/schemas/ApiResponseVoid"}}}}},"x-dcwallet-signature-versions":["v1","v2"]},"patch":{"tags":["7. Webhooks"],"summary":"Update a webhook endpoint owned by this user","description":"Signature versions: v1 and v2.","operationId":"patchWebhookEndpointsByEndpointId","parameters":[{"name":"endpointId","in":"path","description":"Webhook endpoint ID returned by /api/v1/webhook-endpoints. Keep IDs as strings.","required":true,"schema":{"pattern":"[0-9]+","type":"string","example":"337893979704000512"}},{"name":"X-Timestamp","in":"header","description":"Current Unix epoch time in seconds. Requests older or newer than five minutes are rejected.","required":true,"schema":{"pattern":"[0-9]{10}","type":"string","example":"1787562000"}},{"name":"X-Request-ID","in":"header","description":"Unique 16-128 character request identifier used for replay protection; never reuse it for a different HTTP request.","required":true,"schema":{"pattern":"[A-Za-z0-9._:-]{16,128}","type":"string","example":"018f6f4e-8f62-7fc2-9c4b-7be2f4203b6a"}},{"name":"X-Content-SHA256","in":"header","description":"Lowercase hexadecimal SHA-256 digest of the exact raw request body; use the digest of zero bytes when no body is sent.","required":true,"schema":{"pattern":"[0-9a-f]{64}","type":"string","example":"e3b0c44298fc1c149afbf4c8996fb92427ae41e4649b934ca495991b7852b855"}},{"name":"X-Workspace","in":"header","description":"Enterprise writes are available on this route. For enterprise access, copy your own enterprise:<id> from GET /api/v1/workspaces. Required for v2 requests. V1 requests use the historical key's fixed enterprise.","required":false,"schema":{"pattern":"personal|enterprise:[1-9][0-9]*","type":"string","example":"personal"}},{"name":"X-Environment","in":"header","description":"Required and signed for v2 requests: live or sandbox. Optional for v1 requests.","required":false,"schema":{"pattern":"live|sandbox","type":"string","example":"live"}},{"name":"X-Signature","in":"header","description":"Existing keys accept v1 for their fixed enterprise or v2 for a signed workspace; new keys accept v2 only.","required":true,"schema":{"pattern":"v[12]=[0-9a-f]{64}","type":"string","example":"v2=0123456789abcdef0123456789abcdef0123456789abcdef0123456789abcdef"}},{"name":"Accept-Language","in":"header","description":"Response language: en-US = English (default); zh-CN = Simplified Chinese; zh-TW = Traditional Chinese. Numeric error codes are language-neutral.","required":false,"schema":{"type":"string","enum":["en-US","zh-CN","zh-TW"],"default":"en-US"}}],"requestBody":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/WebhookEndpointUpdateRequest"}}},"required":true},"responses":{"400":{"description":"Malformed JSON, missing header or invalid request parameter","headers":{"X-Request-ID":{"description":"Request identifier echoed for support and reconciliation.","schema":{"type":"string"}}},"content":{"application/json":{"schema":{"$ref":"#/components/schemas/ApiResponseVoid"}}}},"500":{"description":"Unexpected internal error; contact support with X-Request-ID","headers":{"X-Request-ID":{"description":"Request identifier echoed for support and reconciliation.","schema":{"type":"string"}}},"content":{"application/json":{"schema":{"$ref":"#/components/schemas/ApiResponseVoid"}}}},"403":{"description":"API-key scope, subscription, tenant or policy does not allow the operation","headers":{"X-Request-ID":{"description":"Request identifier echoed for support and reconciliation.","schema":{"type":"string"}}},"content":{"application/json":{"schema":{"$ref":"#/components/schemas/ApiResponseVoid"}}}},"200":{"description":"OK","headers":{"X-Request-ID":{"description":"Request identifier echoed for support and reconciliation.","schema":{"type":"string"}},"X-Quota-Limit":{"description":"Monthly API request allowance for the subscription.","schema":{"type":"integer","format":"int64"}},"X-Quota-Remaining":{"description":"Requests remaining in the current monthly allowance after this request.","schema":{"type":"integer","format":"int64"}},"X-Quota-Reset":{"description":"Unix epoch time in seconds when the monthly allowance resets.","schema":{"type":"integer","format":"int64"}},"X-Quota-Workspace":{"description":"Verified workspace owning this allowance: personal or enterprise:<id>.","schema":{"type":"string"}},"X-Quota-Environment":{"description":"Environment owning the allowance: sandbox or live.","schema":{"type":"string"}}},"content":{"application/json":{"schema":{"$ref":"#/components/schemas/ApiResponseWebhookEndpointResponse"}}}},"401":{"description":"Invalid API key, content hash, signature, timestamp or request ID","headers":{"X-Request-ID":{"description":"Request identifier echoed for support and reconciliation.","schema":{"type":"string"}}},"content":{"application/json":{"schema":{"$ref":"#/components/schemas/ApiResponseVoid"}}}},"404":{"description":"Resource not found in this enterprise and environment","headers":{"X-Request-ID":{"description":"Request identifier echoed for support and reconciliation.","schema":{"type":"string"}}},"content":{"application/json":{"schema":{"$ref":"#/components/schemas/ApiResponseVoid"}}}},"422":{"description":"Business rule rejected the request","headers":{"X-Request-ID":{"description":"Request identifier echoed for support and reconciliation.","schema":{"type":"string"}}},"content":{"application/json":{"schema":{"$ref":"#/components/schemas/ApiResponseVoid"}}}},"503":{"description":"A required platform service is temporarily unavailable","headers":{"X-Request-ID":{"description":"Request identifier echoed for support and reconciliation.","schema":{"type":"string"}}},"content":{"application/json":{"schema":{"$ref":"#/components/schemas/ApiResponseVoid"}}}},"409":{"description":"Idempotency or resource-state conflict","headers":{"X-Request-ID":{"description":"Request identifier echoed for support and reconciliation.","schema":{"type":"string"}}},"content":{"application/json":{"schema":{"$ref":"#/components/schemas/ApiResponseVoid"}}}},"429":{"description":"Per-minute rate limit or monthly quota exceeded","headers":{"X-Request-ID":{"description":"Request identifier echoed for support and reconciliation.","schema":{"type":"string"}},"X-Quota-Limit":{"description":"Monthly API request allowance for the subscription.","schema":{"type":"integer","format":"int64"}},"X-Quota-Remaining":{"description":"Requests remaining in the current monthly allowance after this request.","schema":{"type":"integer","format":"int64"}},"X-Quota-Reset":{"description":"Unix epoch time in seconds when the monthly allowance resets.","schema":{"type":"integer","format":"int64"}},"X-Quota-Workspace":{"description":"Verified workspace owning this allowance: personal or enterprise:<id>.","schema":{"type":"string"}},"X-Quota-Environment":{"description":"Environment owning the allowance: sandbox or live.","schema":{"type":"string"}},"Retry-After":{"description":"Seconds until the exhausted quota or rate window resets. Sign retries with a new X-Request-ID.","schema":{"type":"integer","format":"int64"}},"X-RateLimit-Scope":{"description":"Rate counter scope: workspace, or user for enterprise verification calls.","schema":{"type":"string"}},"X-RateLimit-Limit":{"description":"Per-minute request limit when rate-limited.","schema":{"type":"integer","format":"int64"}},"X-RateLimit-Remaining":{"description":"Zero when the minute limit is exhausted.","schema":{"type":"integer","format":"int64"}},"X-RateLimit-Reset":{"description":"Unix epoch seconds when the minute limit resets.","schema":{"type":"integer","format":"int64"}}},"content":{"application/json":{"schema":{"$ref":"#/components/schemas/ApiResponseVoid"}}}},"413":{"description":"Request body is too large","headers":{"X-Request-ID":{"description":"Request identifier echoed for support and reconciliation.","schema":{"type":"string"}}},"content":{"application/json":{"schema":{"$ref":"#/components/schemas/ApiResponseVoid"}}}}},"x-dcwallet-signature-versions":["v1","v2"]}},"/api/v1/receivables/{invoiceId}":{"get":{"tags":["4. Receivables"],"summary":"Get an enterprise receivable","description":"Signature versions: v1 and v2.","operationId":"getReceivablesByInvoiceId","parameters":[{"name":"invoiceId","in":"path","description":"Invoice ID returned by /api/v1/invoices. Keep IDs as strings.","required":true,"schema":{"pattern":"[0-9]+","type":"string","example":"337893979704000512"}},{"name":"X-Timestamp","in":"header","description":"Current Unix epoch time in seconds. Requests older or newer than five minutes are rejected.","required":true,"schema":{"pattern":"[0-9]{10}","type":"string","example":"1787562000"}},{"name":"X-Request-ID","in":"header","description":"Unique 16-128 character request identifier used for replay protection; never reuse it for a different HTTP request.","required":true,"schema":{"pattern":"[A-Za-z0-9._:-]{16,128}","type":"string","example":"018f6f4e-8f62-7fc2-9c4b-7be2f4203b6a"}},{"name":"X-Content-SHA256","in":"header","description":"Lowercase hexadecimal SHA-256 digest of the exact raw request body; use the digest of zero bytes when no body is sent.","required":true,"schema":{"pattern":"[0-9a-f]{64}","type":"string","example":"e3b0c44298fc1c149afbf4c8996fb92427ae41e4649b934ca495991b7852b855"}},{"name":"X-Workspace","in":"header","description":"Enterprise reads are available on this route. For enterprise access, copy your own enterprise:<id> from GET /api/v1/workspaces. Required for v2 requests. V1 requests use the historical key's fixed enterprise.","required":false,"schema":{"pattern":"personal|enterprise:[1-9][0-9]*","type":"string","example":null}},{"name":"X-Environment","in":"header","description":"Required and signed for v2 requests: live or sandbox. Optional for v1 requests.","required":false,"schema":{"pattern":"live|sandbox","type":"string","example":"live"}},{"name":"X-Signature","in":"header","description":"Existing keys accept v1 for their fixed enterprise or v2 for a signed workspace; new keys accept v2 only.","required":true,"schema":{"pattern":"v[12]=[0-9a-f]{64}","type":"string","example":"v2=0123456789abcdef0123456789abcdef0123456789abcdef0123456789abcdef"}},{"name":"Accept-Language","in":"header","description":"Response language: en-US = English (default); zh-CN = Simplified Chinese; zh-TW = Traditional Chinese. Numeric error codes are language-neutral.","required":false,"schema":{"type":"string","enum":["en-US","zh-CN","zh-TW"],"default":"en-US"}}],"responses":{"400":{"description":"Malformed JSON, missing header or invalid request parameter","headers":{"X-Request-ID":{"description":"Request identifier echoed for support and reconciliation.","schema":{"type":"string"}}},"content":{"application/json":{"schema":{"$ref":"#/components/schemas/ApiResponseVoid"}}}},"500":{"description":"Unexpected internal error; contact support with X-Request-ID","headers":{"X-Request-ID":{"description":"Request identifier echoed for support and reconciliation.","schema":{"type":"string"}}},"content":{"application/json":{"schema":{"$ref":"#/components/schemas/ApiResponseVoid"}}}},"403":{"description":"API-key scope, subscription, tenant or policy does not allow the operation","headers":{"X-Request-ID":{"description":"Request identifier echoed for support and reconciliation.","schema":{"type":"string"}}},"content":{"application/json":{"schema":{"$ref":"#/components/schemas/ApiResponseVoid"}}}},"200":{"description":"OK","headers":{"X-Request-ID":{"description":"Request identifier echoed for support and reconciliation.","schema":{"type":"string"}},"X-Quota-Limit":{"description":"Monthly API request allowance for the subscription.","schema":{"type":"integer","format":"int64"}},"X-Quota-Remaining":{"description":"Requests remaining in the current monthly allowance after this request.","schema":{"type":"integer","format":"int64"}},"X-Quota-Reset":{"description":"Unix epoch time in seconds when the monthly allowance resets.","schema":{"type":"integer","format":"int64"}},"X-Quota-Workspace":{"description":"Verified workspace owning this allowance: personal or enterprise:<id>.","schema":{"type":"string"}},"X-Quota-Environment":{"description":"Environment owning the allowance: sandbox or live.","schema":{"type":"string"}}},"content":{"application/json":{"schema":{"$ref":"#/components/schemas/ApiResponseInvoiceResponse"}}}},"401":{"description":"Invalid API key, content hash, signature, timestamp or request ID","headers":{"X-Request-ID":{"description":"Request identifier echoed for support and reconciliation.","schema":{"type":"string"}}},"content":{"application/json":{"schema":{"$ref":"#/components/schemas/ApiResponseVoid"}}}},"404":{"description":"Resource not found in this enterprise and environment","headers":{"X-Request-ID":{"description":"Request identifier echoed for support and reconciliation.","schema":{"type":"string"}}},"content":{"application/json":{"schema":{"$ref":"#/components/schemas/ApiResponseVoid"}}}},"422":{"description":"Business rule rejected the request","headers":{"X-Request-ID":{"description":"Request identifier echoed for support and reconciliation.","schema":{"type":"string"}}},"content":{"application/json":{"schema":{"$ref":"#/components/schemas/ApiResponseVoid"}}}},"503":{"description":"A required platform service is temporarily unavailable","headers":{"X-Request-ID":{"description":"Request identifier echoed for support and reconciliation.","schema":{"type":"string"}}},"content":{"application/json":{"schema":{"$ref":"#/components/schemas/ApiResponseVoid"}}}},"409":{"description":"Idempotency or resource-state conflict","headers":{"X-Request-ID":{"description":"Request identifier echoed for support and reconciliation.","schema":{"type":"string"}}},"content":{"application/json":{"schema":{"$ref":"#/components/schemas/ApiResponseVoid"}}}},"429":{"description":"Per-minute rate limit or monthly quota exceeded","headers":{"X-Request-ID":{"description":"Request identifier echoed for support and reconciliation.","schema":{"type":"string"}},"X-Quota-Limit":{"description":"Monthly API request allowance for the subscription.","schema":{"type":"integer","format":"int64"}},"X-Quota-Remaining":{"description":"Requests remaining in the current monthly allowance after this request.","schema":{"type":"integer","format":"int64"}},"X-Quota-Reset":{"description":"Unix epoch time in seconds when the monthly allowance resets.","schema":{"type":"integer","format":"int64"}},"X-Quota-Workspace":{"description":"Verified workspace owning this allowance: personal or enterprise:<id>.","schema":{"type":"string"}},"X-Quota-Environment":{"description":"Environment owning the allowance: sandbox or live.","schema":{"type":"string"}},"Retry-After":{"description":"Seconds until the exhausted quota or rate window resets. Sign retries with a new X-Request-ID.","schema":{"type":"integer","format":"int64"}},"X-RateLimit-Scope":{"description":"Rate counter scope: workspace, or user for enterprise verification calls.","schema":{"type":"string"}},"X-RateLimit-Limit":{"description":"Per-minute request limit when rate-limited.","schema":{"type":"integer","format":"int64"}},"X-RateLimit-Remaining":{"description":"Zero when the minute limit is exhausted.","schema":{"type":"integer","format":"int64"}},"X-RateLimit-Reset":{"description":"Unix epoch seconds when the minute limit resets.","schema":{"type":"integer","format":"int64"}}},"content":{"application/json":{"schema":{"$ref":"#/components/schemas/ApiResponseVoid"}}}},"413":{"description":"Request body is too large","headers":{"X-Request-ID":{"description":"Request identifier echoed for support and reconciliation.","schema":{"type":"string"}}},"content":{"application/json":{"schema":{"$ref":"#/components/schemas/ApiResponseVoid"}}}}},"x-dcwallet-signature-versions":["v1","v2"]},"patch":{"tags":["4. Receivables"],"summary":"Update a draft enterprise receivable","description":"Signature versions: v1 and v2.","operationId":"patchReceivablesByInvoiceId","parameters":[{"name":"invoiceId","in":"path","description":"Invoice ID returned by /api/v1/invoices. Keep IDs as strings.","required":true,"schema":{"pattern":"[0-9]+","type":"string","example":"337893979704000512"}},{"name":"X-Timestamp","in":"header","description":"Current Unix epoch time in seconds. Requests older or newer than five minutes are rejected.","required":true,"schema":{"pattern":"[0-9]{10}","type":"string","example":"1787562000"}},{"name":"X-Request-ID","in":"header","description":"Unique 16-128 character request identifier used for replay protection; never reuse it for a different HTTP request.","required":true,"schema":{"pattern":"[A-Za-z0-9._:-]{16,128}","type":"string","example":"018f6f4e-8f62-7fc2-9c4b-7be2f4203b6a"}},{"name":"X-Content-SHA256","in":"header","description":"Lowercase hexadecimal SHA-256 digest of the exact raw request body; use the digest of zero bytes when no body is sent.","required":true,"schema":{"pattern":"[0-9a-f]{64}","type":"string","example":"e3b0c44298fc1c149afbf4c8996fb92427ae41e4649b934ca495991b7852b855"}},{"name":"X-Workspace","in":"header","description":"Enterprise writes are available on this route. For enterprise access, copy your own enterprise:<id> from GET /api/v1/workspaces. Required for v2 requests. V1 requests use the historical key's fixed enterprise.","required":false,"schema":{"pattern":"personal|enterprise:[1-9][0-9]*","type":"string","example":null}},{"name":"X-Environment","in":"header","description":"Required and signed for v2 requests: live or sandbox. Optional for v1 requests.","required":false,"schema":{"pattern":"live|sandbox","type":"string","example":"live"}},{"name":"X-Signature","in":"header","description":"Existing keys accept v1 for their fixed enterprise or v2 for a signed workspace; new keys accept v2 only.","required":true,"schema":{"pattern":"v[12]=[0-9a-f]{64}","type":"string","example":"v2=0123456789abcdef0123456789abcdef0123456789abcdef0123456789abcdef"}},{"name":"Accept-Language","in":"header","description":"Response language: en-US = English (default); zh-CN = Simplified Chinese; zh-TW = Traditional Chinese. Numeric error codes are language-neutral.","required":false,"schema":{"type":"string","enum":["en-US","zh-CN","zh-TW"],"default":"en-US"}}],"requestBody":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/InvoiceUpdateRequest"}}},"required":true},"responses":{"400":{"description":"Malformed JSON, missing header or invalid request parameter","headers":{"X-Request-ID":{"description":"Request identifier echoed for support and reconciliation.","schema":{"type":"string"}}},"content":{"application/json":{"schema":{"$ref":"#/components/schemas/ApiResponseVoid"}}}},"500":{"description":"Unexpected internal error; contact support with X-Request-ID","headers":{"X-Request-ID":{"description":"Request identifier echoed for support and reconciliation.","schema":{"type":"string"}}},"content":{"application/json":{"schema":{"$ref":"#/components/schemas/ApiResponseVoid"}}}},"403":{"description":"API-key scope, subscription, tenant or policy does not allow the operation","headers":{"X-Request-ID":{"description":"Request identifier echoed for support and reconciliation.","schema":{"type":"string"}}},"content":{"application/json":{"schema":{"$ref":"#/components/schemas/ApiResponseVoid"}}}},"200":{"description":"OK","headers":{"X-Request-ID":{"description":"Request identifier echoed for support and reconciliation.","schema":{"type":"string"}},"X-Quota-Limit":{"description":"Monthly API request allowance for the subscription.","schema":{"type":"integer","format":"int64"}},"X-Quota-Remaining":{"description":"Requests remaining in the current monthly allowance after this request.","schema":{"type":"integer","format":"int64"}},"X-Quota-Reset":{"description":"Unix epoch time in seconds when the monthly allowance resets.","schema":{"type":"integer","format":"int64"}},"X-Quota-Workspace":{"description":"Verified workspace owning this allowance: personal or enterprise:<id>.","schema":{"type":"string"}},"X-Quota-Environment":{"description":"Environment owning the allowance: sandbox or live.","schema":{"type":"string"}}},"content":{"application/json":{"schema":{"$ref":"#/components/schemas/ApiResponseInvoiceResponse"}}}},"401":{"description":"Invalid API key, content hash, signature, timestamp or request ID","headers":{"X-Request-ID":{"description":"Request identifier echoed for support and reconciliation.","schema":{"type":"string"}}},"content":{"application/json":{"schema":{"$ref":"#/components/schemas/ApiResponseVoid"}}}},"404":{"description":"Resource not found in this enterprise and environment","headers":{"X-Request-ID":{"description":"Request identifier echoed for support and reconciliation.","schema":{"type":"string"}}},"content":{"application/json":{"schema":{"$ref":"#/components/schemas/ApiResponseVoid"}}}},"422":{"description":"Business rule rejected the request","headers":{"X-Request-ID":{"description":"Request identifier echoed for support and reconciliation.","schema":{"type":"string"}}},"content":{"application/json":{"schema":{"$ref":"#/components/schemas/ApiResponseVoid"}}}},"503":{"description":"A required platform service is temporarily unavailable","headers":{"X-Request-ID":{"description":"Request identifier echoed for support and reconciliation.","schema":{"type":"string"}}},"content":{"application/json":{"schema":{"$ref":"#/components/schemas/ApiResponseVoid"}}}},"409":{"description":"Idempotency or resource-state conflict","headers":{"X-Request-ID":{"description":"Request identifier echoed for support and reconciliation.","schema":{"type":"string"}}},"content":{"application/json":{"schema":{"$ref":"#/components/schemas/ApiResponseVoid"}}}},"429":{"description":"Per-minute rate limit or monthly quota exceeded","headers":{"X-Request-ID":{"description":"Request identifier echoed for support and reconciliation.","schema":{"type":"string"}},"X-Quota-Limit":{"description":"Monthly API request allowance for the subscription.","schema":{"type":"integer","format":"int64"}},"X-Quota-Remaining":{"description":"Requests remaining in the current monthly allowance after this request.","schema":{"type":"integer","format":"int64"}},"X-Quota-Reset":{"description":"Unix epoch time in seconds when the monthly allowance resets.","schema":{"type":"integer","format":"int64"}},"X-Quota-Workspace":{"description":"Verified workspace owning this allowance: personal or enterprise:<id>.","schema":{"type":"string"}},"X-Quota-Environment":{"description":"Environment owning the allowance: sandbox or live.","schema":{"type":"string"}},"Retry-After":{"description":"Seconds until the exhausted quota or rate window resets. Sign retries with a new X-Request-ID.","schema":{"type":"integer","format":"int64"}},"X-RateLimit-Scope":{"description":"Rate counter scope: workspace, or user for enterprise verification calls.","schema":{"type":"string"}},"X-RateLimit-Limit":{"description":"Per-minute request limit when rate-limited.","schema":{"type":"integer","format":"int64"}},"X-RateLimit-Remaining":{"description":"Zero when the minute limit is exhausted.","schema":{"type":"integer","format":"int64"}},"X-RateLimit-Reset":{"description":"Unix epoch seconds when the minute limit resets.","schema":{"type":"integer","format":"int64"}}},"content":{"application/json":{"schema":{"$ref":"#/components/schemas/ApiResponseVoid"}}}},"413":{"description":"Request body is too large","headers":{"X-Request-ID":{"description":"Request identifier echoed for support and reconciliation.","schema":{"type":"string"}}},"content":{"application/json":{"schema":{"$ref":"#/components/schemas/ApiResponseVoid"}}}}},"x-dcwallet-signature-versions":["v1","v2"]}},"/api/v1/invoices/{invoiceId}":{"get":{"tags":["4. Receivables"],"summary":"Get an enterprise receivable","description":"Signature versions: v1 and v2.","operationId":"getInvoicesByInvoiceId","parameters":[{"name":"invoiceId","in":"path","description":"Invoice ID returned by /api/v1/invoices. Keep IDs as strings.","required":true,"schema":{"pattern":"[0-9]+","type":"string","example":"337893979704000512"}},{"name":"X-Timestamp","in":"header","description":"Current Unix epoch time in seconds. Requests older or newer than five minutes are rejected.","required":true,"schema":{"pattern":"[0-9]{10}","type":"string","example":"1787562000"}},{"name":"X-Request-ID","in":"header","description":"Unique 16-128 character request identifier used for replay protection; never reuse it for a different HTTP request.","required":true,"schema":{"pattern":"[A-Za-z0-9._:-]{16,128}","type":"string","example":"018f6f4e-8f62-7fc2-9c4b-7be2f4203b6a"}},{"name":"X-Content-SHA256","in":"header","description":"Lowercase hexadecimal SHA-256 digest of the exact raw request body; use the digest of zero bytes when no body is sent.","required":true,"schema":{"pattern":"[0-9a-f]{64}","type":"string","example":"e3b0c44298fc1c149afbf4c8996fb92427ae41e4649b934ca495991b7852b855"}},{"name":"X-Workspace","in":"header","description":"Enterprise reads are available on this route. For enterprise access, copy your own enterprise:<id> from GET /api/v1/workspaces. Required for v2 requests. V1 requests use the historical key's fixed enterprise.","required":false,"schema":{"pattern":"personal|enterprise:[1-9][0-9]*","type":"string","example":null}},{"name":"X-Environment","in":"header","description":"Required and signed for v2 requests: live or sandbox. Optional for v1 requests.","required":false,"schema":{"pattern":"live|sandbox","type":"string","example":"live"}},{"name":"X-Signature","in":"header","description":"Existing keys accept v1 for their fixed enterprise or v2 for a signed workspace; new keys accept v2 only.","required":true,"schema":{"pattern":"v[12]=[0-9a-f]{64}","type":"string","example":"v2=0123456789abcdef0123456789abcdef0123456789abcdef0123456789abcdef"}},{"name":"Accept-Language","in":"header","description":"Response language: en-US = English (default); zh-CN = Simplified Chinese; zh-TW = Traditional Chinese. Numeric error codes are language-neutral.","required":false,"schema":{"type":"string","enum":["en-US","zh-CN","zh-TW"],"default":"en-US"}}],"responses":{"400":{"description":"Malformed JSON, missing header or invalid request parameter","headers":{"X-Request-ID":{"description":"Request identifier echoed for support and reconciliation.","schema":{"type":"string"}}},"content":{"application/json":{"schema":{"$ref":"#/components/schemas/ApiResponseVoid"}}}},"500":{"description":"Unexpected internal error; contact support with X-Request-ID","headers":{"X-Request-ID":{"description":"Request identifier echoed for support and reconciliation.","schema":{"type":"string"}}},"content":{"application/json":{"schema":{"$ref":"#/components/schemas/ApiResponseVoid"}}}},"403":{"description":"API-key scope, subscription, tenant or policy does not allow the operation","headers":{"X-Request-ID":{"description":"Request identifier echoed for support and reconciliation.","schema":{"type":"string"}}},"content":{"application/json":{"schema":{"$ref":"#/components/schemas/ApiResponseVoid"}}}},"200":{"description":"OK","headers":{"X-Request-ID":{"description":"Request identifier echoed for support and reconciliation.","schema":{"type":"string"}},"X-Quota-Limit":{"description":"Monthly API request allowance for the subscription.","schema":{"type":"integer","format":"int64"}},"X-Quota-Remaining":{"description":"Requests remaining in the current monthly allowance after this request.","schema":{"type":"integer","format":"int64"}},"X-Quota-Reset":{"description":"Unix epoch time in seconds when the monthly allowance resets.","schema":{"type":"integer","format":"int64"}},"X-Quota-Workspace":{"description":"Verified workspace owning this allowance: personal or enterprise:<id>.","schema":{"type":"string"}},"X-Quota-Environment":{"description":"Environment owning the allowance: sandbox or live.","schema":{"type":"string"}}},"content":{"application/json":{"schema":{"$ref":"#/components/schemas/ApiResponseInvoiceResponse"}}}},"401":{"description":"Invalid API key, content hash, signature, timestamp or request ID","headers":{"X-Request-ID":{"description":"Request identifier echoed for support and reconciliation.","schema":{"type":"string"}}},"content":{"application/json":{"schema":{"$ref":"#/components/schemas/ApiResponseVoid"}}}},"404":{"description":"Resource not found in this enterprise and environment","headers":{"X-Request-ID":{"description":"Request identifier echoed for support and reconciliation.","schema":{"type":"string"}}},"content":{"application/json":{"schema":{"$ref":"#/components/schemas/ApiResponseVoid"}}}},"422":{"description":"Business rule rejected the request","headers":{"X-Request-ID":{"description":"Request identifier echoed for support and reconciliation.","schema":{"type":"string"}}},"content":{"application/json":{"schema":{"$ref":"#/components/schemas/ApiResponseVoid"}}}},"503":{"description":"A required platform service is temporarily unavailable","headers":{"X-Request-ID":{"description":"Request identifier echoed for support and reconciliation.","schema":{"type":"string"}}},"content":{"application/json":{"schema":{"$ref":"#/components/schemas/ApiResponseVoid"}}}},"409":{"description":"Idempotency or resource-state conflict","headers":{"X-Request-ID":{"description":"Request identifier echoed for support and reconciliation.","schema":{"type":"string"}}},"content":{"application/json":{"schema":{"$ref":"#/components/schemas/ApiResponseVoid"}}}},"429":{"description":"Per-minute rate limit or monthly quota exceeded","headers":{"X-Request-ID":{"description":"Request identifier echoed for support and reconciliation.","schema":{"type":"string"}},"X-Quota-Limit":{"description":"Monthly API request allowance for the subscription.","schema":{"type":"integer","format":"int64"}},"X-Quota-Remaining":{"description":"Requests remaining in the current monthly allowance after this request.","schema":{"type":"integer","format":"int64"}},"X-Quota-Reset":{"description":"Unix epoch time in seconds when the monthly allowance resets.","schema":{"type":"integer","format":"int64"}},"X-Quota-Workspace":{"description":"Verified workspace owning this allowance: personal or enterprise:<id>.","schema":{"type":"string"}},"X-Quota-Environment":{"description":"Environment owning the allowance: sandbox or live.","schema":{"type":"string"}},"Retry-After":{"description":"Seconds until the exhausted quota or rate window resets. Sign retries with a new X-Request-ID.","schema":{"type":"integer","format":"int64"}},"X-RateLimit-Scope":{"description":"Rate counter scope: workspace, or user for enterprise verification calls.","schema":{"type":"string"}},"X-RateLimit-Limit":{"description":"Per-minute request limit when rate-limited.","schema":{"type":"integer","format":"int64"}},"X-RateLimit-Remaining":{"description":"Zero when the minute limit is exhausted.","schema":{"type":"integer","format":"int64"}},"X-RateLimit-Reset":{"description":"Unix epoch seconds when the minute limit resets.","schema":{"type":"integer","format":"int64"}}},"content":{"application/json":{"schema":{"$ref":"#/components/schemas/ApiResponseVoid"}}}},"413":{"description":"Request body is too large","headers":{"X-Request-ID":{"description":"Request identifier echoed for support and reconciliation.","schema":{"type":"string"}}},"content":{"application/json":{"schema":{"$ref":"#/components/schemas/ApiResponseVoid"}}}}},"x-dcwallet-signature-versions":["v1","v2"]},"patch":{"tags":["4. Receivables"],"summary":"Update a draft enterprise receivable","description":"Signature versions: v1 and v2.","operationId":"patchInvoicesByInvoiceId","parameters":[{"name":"invoiceId","in":"path","description":"Invoice ID returned by /api/v1/invoices. Keep IDs as strings.","required":true,"schema":{"pattern":"[0-9]+","type":"string","example":"337893979704000512"}},{"name":"X-Timestamp","in":"header","description":"Current Unix epoch time in seconds. Requests older or newer than five minutes are rejected.","required":true,"schema":{"pattern":"[0-9]{10}","type":"string","example":"1787562000"}},{"name":"X-Request-ID","in":"header","description":"Unique 16-128 character request identifier used for replay protection; never reuse it for a different HTTP request.","required":true,"schema":{"pattern":"[A-Za-z0-9._:-]{16,128}","type":"string","example":"018f6f4e-8f62-7fc2-9c4b-7be2f4203b6a"}},{"name":"X-Content-SHA256","in":"header","description":"Lowercase hexadecimal SHA-256 digest of the exact raw request body; use the digest of zero bytes when no body is sent.","required":true,"schema":{"pattern":"[0-9a-f]{64}","type":"string","example":"e3b0c44298fc1c149afbf4c8996fb92427ae41e4649b934ca495991b7852b855"}},{"name":"X-Workspace","in":"header","description":"Enterprise writes are available on this route. For enterprise access, copy your own enterprise:<id> from GET /api/v1/workspaces. Required for v2 requests. V1 requests use the historical key's fixed enterprise.","required":false,"schema":{"pattern":"personal|enterprise:[1-9][0-9]*","type":"string","example":null}},{"name":"X-Environment","in":"header","description":"Required and signed for v2 requests: live or sandbox. Optional for v1 requests.","required":false,"schema":{"pattern":"live|sandbox","type":"string","example":"live"}},{"name":"X-Signature","in":"header","description":"Existing keys accept v1 for their fixed enterprise or v2 for a signed workspace; new keys accept v2 only.","required":true,"schema":{"pattern":"v[12]=[0-9a-f]{64}","type":"string","example":"v2=0123456789abcdef0123456789abcdef0123456789abcdef0123456789abcdef"}},{"name":"Accept-Language","in":"header","description":"Response language: en-US = English (default); zh-CN = Simplified Chinese; zh-TW = Traditional Chinese. Numeric error codes are language-neutral.","required":false,"schema":{"type":"string","enum":["en-US","zh-CN","zh-TW"],"default":"en-US"}}],"requestBody":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/InvoiceUpdateRequest"}}},"required":true},"responses":{"400":{"description":"Malformed JSON, missing header or invalid request parameter","headers":{"X-Request-ID":{"description":"Request identifier echoed for support and reconciliation.","schema":{"type":"string"}}},"content":{"application/json":{"schema":{"$ref":"#/components/schemas/ApiResponseVoid"}}}},"500":{"description":"Unexpected internal error; contact support with X-Request-ID","headers":{"X-Request-ID":{"description":"Request identifier echoed for support and reconciliation.","schema":{"type":"string"}}},"content":{"application/json":{"schema":{"$ref":"#/components/schemas/ApiResponseVoid"}}}},"403":{"description":"API-key scope, subscription, tenant or policy does not allow the operation","headers":{"X-Request-ID":{"description":"Request identifier echoed for support and reconciliation.","schema":{"type":"string"}}},"content":{"application/json":{"schema":{"$ref":"#/components/schemas/ApiResponseVoid"}}}},"200":{"description":"OK","headers":{"X-Request-ID":{"description":"Request identifier echoed for support and reconciliation.","schema":{"type":"string"}},"X-Quota-Limit":{"description":"Monthly API request allowance for the subscription.","schema":{"type":"integer","format":"int64"}},"X-Quota-Remaining":{"description":"Requests remaining in the current monthly allowance after this request.","schema":{"type":"integer","format":"int64"}},"X-Quota-Reset":{"description":"Unix epoch time in seconds when the monthly allowance resets.","schema":{"type":"integer","format":"int64"}},"X-Quota-Workspace":{"description":"Verified workspace owning this allowance: personal or enterprise:<id>.","schema":{"type":"string"}},"X-Quota-Environment":{"description":"Environment owning the allowance: sandbox or live.","schema":{"type":"string"}}},"content":{"application/json":{"schema":{"$ref":"#/components/schemas/ApiResponseInvoiceResponse"}}}},"401":{"description":"Invalid API key, content hash, signature, timestamp or request ID","headers":{"X-Request-ID":{"description":"Request identifier echoed for support and reconciliation.","schema":{"type":"string"}}},"content":{"application/json":{"schema":{"$ref":"#/components/schemas/ApiResponseVoid"}}}},"404":{"description":"Resource not found in this enterprise and environment","headers":{"X-Request-ID":{"description":"Request identifier echoed for support and reconciliation.","schema":{"type":"string"}}},"content":{"application/json":{"schema":{"$ref":"#/components/schemas/ApiResponseVoid"}}}},"422":{"description":"Business rule rejected the request","headers":{"X-Request-ID":{"description":"Request identifier echoed for support and reconciliation.","schema":{"type":"string"}}},"content":{"application/json":{"schema":{"$ref":"#/components/schemas/ApiResponseVoid"}}}},"503":{"description":"A required platform service is temporarily unavailable","headers":{"X-Request-ID":{"description":"Request identifier echoed for support and reconciliation.","schema":{"type":"string"}}},"content":{"application/json":{"schema":{"$ref":"#/components/schemas/ApiResponseVoid"}}}},"409":{"description":"Idempotency or resource-state conflict","headers":{"X-Request-ID":{"description":"Request identifier echoed for support and reconciliation.","schema":{"type":"string"}}},"content":{"application/json":{"schema":{"$ref":"#/components/schemas/ApiResponseVoid"}}}},"429":{"description":"Per-minute rate limit or monthly quota exceeded","headers":{"X-Request-ID":{"description":"Request identifier echoed for support and reconciliation.","schema":{"type":"string"}},"X-Quota-Limit":{"description":"Monthly API request allowance for the subscription.","schema":{"type":"integer","format":"int64"}},"X-Quota-Remaining":{"description":"Requests remaining in the current monthly allowance after this request.","schema":{"type":"integer","format":"int64"}},"X-Quota-Reset":{"description":"Unix epoch time in seconds when the monthly allowance resets.","schema":{"type":"integer","format":"int64"}},"X-Quota-Workspace":{"description":"Verified workspace owning this allowance: personal or enterprise:<id>.","schema":{"type":"string"}},"X-Quota-Environment":{"description":"Environment owning the allowance: sandbox or live.","schema":{"type":"string"}},"Retry-After":{"description":"Seconds until the exhausted quota or rate window resets. Sign retries with a new X-Request-ID.","schema":{"type":"integer","format":"int64"}},"X-RateLimit-Scope":{"description":"Rate counter scope: workspace, or user for enterprise verification calls.","schema":{"type":"string"}},"X-RateLimit-Limit":{"description":"Per-minute request limit when rate-limited.","schema":{"type":"integer","format":"int64"}},"X-RateLimit-Remaining":{"description":"Zero when the minute limit is exhausted.","schema":{"type":"integer","format":"int64"}},"X-RateLimit-Reset":{"description":"Unix epoch seconds when the minute limit resets.","schema":{"type":"integer","format":"int64"}}},"content":{"application/json":{"schema":{"$ref":"#/components/schemas/ApiResponseVoid"}}}},"413":{"description":"Request body is too large","headers":{"X-Request-ID":{"description":"Request identifier echoed for support and reconciliation.","schema":{"type":"string"}}},"content":{"application/json":{"schema":{"$ref":"#/components/schemas/ApiResponseVoid"}}}}},"x-dcwallet-signature-versions":["v1","v2"]}},"/api/v1/contacts/{contactId}":{"get":{"tags":["3. Contacts"],"summary":"Get an enterprise contact","description":"Before card issuance, cardIssuingStatus must be ready and missingFields must be empty.\n\nSignature versions: v1 and v2.","operationId":"getContactsByContactId","parameters":[{"name":"contactId","in":"path","description":"Enterprise contact ID returned by /api/v1/contacts. Keep IDs as strings.","required":true,"schema":{"pattern":"[0-9]+","type":"string","example":"337893979704000512"}},{"name":"X-Timestamp","in":"header","description":"Current Unix epoch time in seconds. Requests older or newer than five minutes are rejected.","required":true,"schema":{"pattern":"[0-9]{10}","type":"string","example":"1787562000"}},{"name":"X-Request-ID","in":"header","description":"Unique 16-128 character request identifier used for replay protection; never reuse it for a different HTTP request.","required":true,"schema":{"pattern":"[A-Za-z0-9._:-]{16,128}","type":"string","example":"018f6f4e-8f62-7fc2-9c4b-7be2f4203b6a"}},{"name":"X-Content-SHA256","in":"header","description":"Lowercase hexadecimal SHA-256 digest of the exact raw request body; use the digest of zero bytes when no body is sent.","required":true,"schema":{"pattern":"[0-9a-f]{64}","type":"string","example":"e3b0c44298fc1c149afbf4c8996fb92427ae41e4649b934ca495991b7852b855"}},{"name":"X-Workspace","in":"header","description":"Enterprise reads are available on this route. For enterprise access, copy your own enterprise:<id> from GET /api/v1/workspaces. Required for v2 requests. V1 requests use the historical key's fixed enterprise.","required":false,"schema":{"pattern":"personal|enterprise:[1-9][0-9]*","type":"string","example":null}},{"name":"X-Environment","in":"header","description":"Required and signed for v2 requests: live or sandbox. Optional for v1 requests.","required":false,"schema":{"pattern":"live|sandbox","type":"string","example":"live"}},{"name":"X-Signature","in":"header","description":"Existing keys accept v1 for their fixed enterprise or v2 for a signed workspace; new keys accept v2 only.","required":true,"schema":{"pattern":"v[12]=[0-9a-f]{64}","type":"string","example":"v2=0123456789abcdef0123456789abcdef0123456789abcdef0123456789abcdef"}},{"name":"Accept-Language","in":"header","description":"Response language: en-US = English (default); zh-CN = Simplified Chinese; zh-TW = Traditional Chinese. Numeric error codes are language-neutral.","required":false,"schema":{"type":"string","enum":["en-US","zh-CN","zh-TW"],"default":"en-US"}}],"responses":{"400":{"description":"Malformed JSON, missing header or invalid request parameter","headers":{"X-Request-ID":{"description":"Request identifier echoed for support and reconciliation.","schema":{"type":"string"}}},"content":{"application/json":{"schema":{"$ref":"#/components/schemas/ApiResponseVoid"}}}},"500":{"description":"Unexpected internal error; contact support with X-Request-ID","headers":{"X-Request-ID":{"description":"Request identifier echoed for support and reconciliation.","schema":{"type":"string"}}},"content":{"application/json":{"schema":{"$ref":"#/components/schemas/ApiResponseVoid"}}}},"403":{"description":"API-key scope, subscription, tenant or policy does not allow the operation","headers":{"X-Request-ID":{"description":"Request identifier echoed for support and reconciliation.","schema":{"type":"string"}}},"content":{"application/json":{"schema":{"$ref":"#/components/schemas/ApiResponseVoid"}}}},"200":{"description":"OK","headers":{"X-Request-ID":{"description":"Request identifier echoed for support and reconciliation.","schema":{"type":"string"}},"X-Quota-Limit":{"description":"Monthly API request allowance for the subscription.","schema":{"type":"integer","format":"int64"}},"X-Quota-Remaining":{"description":"Requests remaining in the current monthly allowance after this request.","schema":{"type":"integer","format":"int64"}},"X-Quota-Reset":{"description":"Unix epoch time in seconds when the monthly allowance resets.","schema":{"type":"integer","format":"int64"}},"X-Quota-Workspace":{"description":"Verified workspace owning this allowance: personal or enterprise:<id>.","schema":{"type":"string"}},"X-Quota-Environment":{"description":"Environment owning the allowance: sandbox or live.","schema":{"type":"string"}}},"content":{"application/json":{"schema":{"$ref":"#/components/schemas/ApiResponseContactResponse"}}}},"401":{"description":"Invalid API key, content hash, signature, timestamp or request ID","headers":{"X-Request-ID":{"description":"Request identifier echoed for support and reconciliation.","schema":{"type":"string"}}},"content":{"application/json":{"schema":{"$ref":"#/components/schemas/ApiResponseVoid"}}}},"404":{"description":"Resource not found in this enterprise and environment","headers":{"X-Request-ID":{"description":"Request identifier echoed for support and reconciliation.","schema":{"type":"string"}}},"content":{"application/json":{"schema":{"$ref":"#/components/schemas/ApiResponseVoid"}}}},"422":{"description":"Business rule rejected the request","headers":{"X-Request-ID":{"description":"Request identifier echoed for support and reconciliation.","schema":{"type":"string"}}},"content":{"application/json":{"schema":{"$ref":"#/components/schemas/ApiResponseVoid"}}}},"503":{"description":"A required platform service is temporarily unavailable","headers":{"X-Request-ID":{"description":"Request identifier echoed for support and reconciliation.","schema":{"type":"string"}}},"content":{"application/json":{"schema":{"$ref":"#/components/schemas/ApiResponseVoid"}}}},"409":{"description":"Idempotency or resource-state conflict","headers":{"X-Request-ID":{"description":"Request identifier echoed for support and reconciliation.","schema":{"type":"string"}}},"content":{"application/json":{"schema":{"$ref":"#/components/schemas/ApiResponseVoid"}}}},"429":{"description":"Per-minute rate limit or monthly quota exceeded","headers":{"X-Request-ID":{"description":"Request identifier echoed for support and reconciliation.","schema":{"type":"string"}},"X-Quota-Limit":{"description":"Monthly API request allowance for the subscription.","schema":{"type":"integer","format":"int64"}},"X-Quota-Remaining":{"description":"Requests remaining in the current monthly allowance after this request.","schema":{"type":"integer","format":"int64"}},"X-Quota-Reset":{"description":"Unix epoch time in seconds when the monthly allowance resets.","schema":{"type":"integer","format":"int64"}},"X-Quota-Workspace":{"description":"Verified workspace owning this allowance: personal or enterprise:<id>.","schema":{"type":"string"}},"X-Quota-Environment":{"description":"Environment owning the allowance: sandbox or live.","schema":{"type":"string"}},"Retry-After":{"description":"Seconds until the exhausted quota or rate window resets. Sign retries with a new X-Request-ID.","schema":{"type":"integer","format":"int64"}},"X-RateLimit-Scope":{"description":"Rate counter scope: workspace, or user for enterprise verification calls.","schema":{"type":"string"}},"X-RateLimit-Limit":{"description":"Per-minute request limit when rate-limited.","schema":{"type":"integer","format":"int64"}},"X-RateLimit-Remaining":{"description":"Zero when the minute limit is exhausted.","schema":{"type":"integer","format":"int64"}},"X-RateLimit-Reset":{"description":"Unix epoch seconds when the minute limit resets.","schema":{"type":"integer","format":"int64"}}},"content":{"application/json":{"schema":{"$ref":"#/components/schemas/ApiResponseVoid"}}}},"413":{"description":"Request body is too large","headers":{"X-Request-ID":{"description":"Request identifier echoed for support and reconciliation.","schema":{"type":"string"}}},"content":{"application/json":{"schema":{"$ref":"#/components/schemas/ApiResponseVoid"}}}}},"x-dcwallet-signature-versions":["v1","v2"]},"patch":{"tags":["3. Contacts"],"summary":"Update an enterprise contact","description":"Signature versions: v1 and v2.","operationId":"patchContactsByContactId","parameters":[{"name":"contactId","in":"path","description":"Enterprise contact ID returned by /api/v1/contacts. Keep IDs as strings.","required":true,"schema":{"pattern":"[0-9]+","type":"string","example":"337893979704000512"}},{"name":"X-Timestamp","in":"header","description":"Current Unix epoch time in seconds. Requests older or newer than five minutes are rejected.","required":true,"schema":{"pattern":"[0-9]{10}","type":"string","example":"1787562000"}},{"name":"X-Request-ID","in":"header","description":"Unique 16-128 character request identifier used for replay protection; never reuse it for a different HTTP request.","required":true,"schema":{"pattern":"[A-Za-z0-9._:-]{16,128}","type":"string","example":"018f6f4e-8f62-7fc2-9c4b-7be2f4203b6a"}},{"name":"X-Content-SHA256","in":"header","description":"Lowercase hexadecimal SHA-256 digest of the exact raw request body; use the digest of zero bytes when no body is sent.","required":true,"schema":{"pattern":"[0-9a-f]{64}","type":"string","example":"e3b0c44298fc1c149afbf4c8996fb92427ae41e4649b934ca495991b7852b855"}},{"name":"X-Workspace","in":"header","description":"Enterprise writes are available on this route. For enterprise access, copy your own enterprise:<id> from GET /api/v1/workspaces. Required for v2 requests. V1 requests use the historical key's fixed enterprise.","required":false,"schema":{"pattern":"personal|enterprise:[1-9][0-9]*","type":"string","example":null}},{"name":"X-Environment","in":"header","description":"Required and signed for v2 requests: live or sandbox. Optional for v1 requests.","required":false,"schema":{"pattern":"live|sandbox","type":"string","example":"live"}},{"name":"X-Signature","in":"header","description":"Existing keys accept v1 for their fixed enterprise or v2 for a signed workspace; new keys accept v2 only.","required":true,"schema":{"pattern":"v[12]=[0-9a-f]{64}","type":"string","example":"v2=0123456789abcdef0123456789abcdef0123456789abcdef0123456789abcdef"}},{"name":"Accept-Language","in":"header","description":"Response language: en-US = English (default); zh-CN = Simplified Chinese; zh-TW = Traditional Chinese. Numeric error codes are language-neutral.","required":false,"schema":{"type":"string","enum":["en-US","zh-CN","zh-TW"],"default":"en-US"}}],"requestBody":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/ContactRequest"}}},"required":true},"responses":{"400":{"description":"Malformed JSON, missing header or invalid request parameter","headers":{"X-Request-ID":{"description":"Request identifier echoed for support and reconciliation.","schema":{"type":"string"}}},"content":{"application/json":{"schema":{"$ref":"#/components/schemas/ApiResponseVoid"}}}},"500":{"description":"Unexpected internal error; contact support with X-Request-ID","headers":{"X-Request-ID":{"description":"Request identifier echoed for support and reconciliation.","schema":{"type":"string"}}},"content":{"application/json":{"schema":{"$ref":"#/components/schemas/ApiResponseVoid"}}}},"403":{"description":"API-key scope, subscription, tenant or policy does not allow the operation","headers":{"X-Request-ID":{"description":"Request identifier echoed for support and reconciliation.","schema":{"type":"string"}}},"content":{"application/json":{"schema":{"$ref":"#/components/schemas/ApiResponseVoid"}}}},"200":{"description":"OK","headers":{"X-Request-ID":{"description":"Request identifier echoed for support and reconciliation.","schema":{"type":"string"}},"X-Quota-Limit":{"description":"Monthly API request allowance for the subscription.","schema":{"type":"integer","format":"int64"}},"X-Quota-Remaining":{"description":"Requests remaining in the current monthly allowance after this request.","schema":{"type":"integer","format":"int64"}},"X-Quota-Reset":{"description":"Unix epoch time in seconds when the monthly allowance resets.","schema":{"type":"integer","format":"int64"}},"X-Quota-Workspace":{"description":"Verified workspace owning this allowance: personal or enterprise:<id>.","schema":{"type":"string"}},"X-Quota-Environment":{"description":"Environment owning the allowance: sandbox or live.","schema":{"type":"string"}}},"content":{"application/json":{"schema":{"$ref":"#/components/schemas/ApiResponseContactResponse"}}}},"401":{"description":"Invalid API key, content hash, signature, timestamp or request ID","headers":{"X-Request-ID":{"description":"Request identifier echoed for support and reconciliation.","schema":{"type":"string"}}},"content":{"application/json":{"schema":{"$ref":"#/components/schemas/ApiResponseVoid"}}}},"404":{"description":"Resource not found in this enterprise and environment","headers":{"X-Request-ID":{"description":"Request identifier echoed for support and reconciliation.","schema":{"type":"string"}}},"content":{"application/json":{"schema":{"$ref":"#/components/schemas/ApiResponseVoid"}}}},"422":{"description":"Business rule rejected the request","headers":{"X-Request-ID":{"description":"Request identifier echoed for support and reconciliation.","schema":{"type":"string"}}},"content":{"application/json":{"schema":{"$ref":"#/components/schemas/ApiResponseVoid"}}}},"503":{"description":"A required platform service is temporarily unavailable","headers":{"X-Request-ID":{"description":"Request identifier echoed for support and reconciliation.","schema":{"type":"string"}}},"content":{"application/json":{"schema":{"$ref":"#/components/schemas/ApiResponseVoid"}}}},"409":{"description":"Idempotency or resource-state conflict","headers":{"X-Request-ID":{"description":"Request identifier echoed for support and reconciliation.","schema":{"type":"string"}}},"content":{"application/json":{"schema":{"$ref":"#/components/schemas/ApiResponseVoid"}}}},"429":{"description":"Per-minute rate limit or monthly quota exceeded","headers":{"X-Request-ID":{"description":"Request identifier echoed for support and reconciliation.","schema":{"type":"string"}},"X-Quota-Limit":{"description":"Monthly API request allowance for the subscription.","schema":{"type":"integer","format":"int64"}},"X-Quota-Remaining":{"description":"Requests remaining in the current monthly allowance after this request.","schema":{"type":"integer","format":"int64"}},"X-Quota-Reset":{"description":"Unix epoch time in seconds when the monthly allowance resets.","schema":{"type":"integer","format":"int64"}},"X-Quota-Workspace":{"description":"Verified workspace owning this allowance: personal or enterprise:<id>.","schema":{"type":"string"}},"X-Quota-Environment":{"description":"Environment owning the allowance: sandbox or live.","schema":{"type":"string"}},"Retry-After":{"description":"Seconds until the exhausted quota or rate window resets. Sign retries with a new X-Request-ID.","schema":{"type":"integer","format":"int64"}},"X-RateLimit-Scope":{"description":"Rate counter scope: workspace, or user for enterprise verification calls.","schema":{"type":"string"}},"X-RateLimit-Limit":{"description":"Per-minute request limit when rate-limited.","schema":{"type":"integer","format":"int64"}},"X-RateLimit-Remaining":{"description":"Zero when the minute limit is exhausted.","schema":{"type":"integer","format":"int64"}},"X-RateLimit-Reset":{"description":"Unix epoch seconds when the minute limit resets.","schema":{"type":"integer","format":"int64"}}},"content":{"application/json":{"schema":{"$ref":"#/components/schemas/ApiResponseVoid"}}}},"413":{"description":"Request body is too large","headers":{"X-Request-ID":{"description":"Request identifier echoed for support and reconciliation.","schema":{"type":"string"}}},"content":{"application/json":{"schema":{"$ref":"#/components/schemas/ApiResponseVoid"}}}}},"x-dcwallet-signature-versions":["v1","v2"]}},"/api/v1/contacts/{contactId}/accounts/{accountId}":{"patch":{"tags":["3. Contacts"],"summary":"Update a contact destination account","description":"Send only changed fields. Changing type requires all fields required by the new type.\n\nSignature versions: v1 and v2.","operationId":"patchContactsByContactIdAccountsByAccountId","parameters":[{"name":"contactId","in":"path","description":"Enterprise contact ID returned by /api/v1/contacts. Keep IDs as strings.","required":true,"schema":{"pattern":"[0-9]+","type":"string","example":"337893979704000512"}},{"name":"accountId","in":"path","description":"Account ID returned by the corresponding account list endpoint. Keep IDs as strings.","required":true,"schema":{"pattern":"[0-9]+","type":"string","example":"337893979704000512"}},{"name":"X-Timestamp","in":"header","description":"Current Unix epoch time in seconds. Requests older or newer than five minutes are rejected.","required":true,"schema":{"pattern":"[0-9]{10}","type":"string","example":"1787562000"}},{"name":"X-Request-ID","in":"header","description":"Unique 16-128 character request identifier used for replay protection; never reuse it for a different HTTP request.","required":true,"schema":{"pattern":"[A-Za-z0-9._:-]{16,128}","type":"string","example":"018f6f4e-8f62-7fc2-9c4b-7be2f4203b6a"}},{"name":"X-Content-SHA256","in":"header","description":"Lowercase hexadecimal SHA-256 digest of the exact raw request body; use the digest of zero bytes when no body is sent.","required":true,"schema":{"pattern":"[0-9a-f]{64}","type":"string","example":"e3b0c44298fc1c149afbf4c8996fb92427ae41e4649b934ca495991b7852b855"}},{"name":"X-Workspace","in":"header","description":"Enterprise writes are available on this route. For enterprise access, copy your own enterprise:<id> from GET /api/v1/workspaces. Required for v2 requests. V1 requests use the historical key's fixed enterprise.","required":false,"schema":{"pattern":"personal|enterprise:[1-9][0-9]*","type":"string","example":null}},{"name":"X-Environment","in":"header","description":"Required and signed for v2 requests: live or sandbox. Optional for v1 requests.","required":false,"schema":{"pattern":"live|sandbox","type":"string","example":"live"}},{"name":"X-Signature","in":"header","description":"Existing keys accept v1 for their fixed enterprise or v2 for a signed workspace; new keys accept v2 only.","required":true,"schema":{"pattern":"v[12]=[0-9a-f]{64}","type":"string","example":"v2=0123456789abcdef0123456789abcdef0123456789abcdef0123456789abcdef"}},{"name":"Accept-Language","in":"header","description":"Response language: en-US = English (default); zh-CN = Simplified Chinese; zh-TW = Traditional Chinese. Numeric error codes are language-neutral.","required":false,"schema":{"type":"string","enum":["en-US","zh-CN","zh-TW"],"default":"en-US"}}],"requestBody":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/ContactAccountRequest"}}},"required":true},"responses":{"400":{"description":"Malformed JSON, missing header or invalid request parameter","headers":{"X-Request-ID":{"description":"Request identifier echoed for support and reconciliation.","schema":{"type":"string"}}},"content":{"application/json":{"schema":{"$ref":"#/components/schemas/ApiResponseVoid"}}}},"500":{"description":"Unexpected internal error; contact support with X-Request-ID","headers":{"X-Request-ID":{"description":"Request identifier echoed for support and reconciliation.","schema":{"type":"string"}}},"content":{"application/json":{"schema":{"$ref":"#/components/schemas/ApiResponseVoid"}}}},"403":{"description":"API-key scope, subscription, tenant or policy does not allow the operation","headers":{"X-Request-ID":{"description":"Request identifier echoed for support and reconciliation.","schema":{"type":"string"}}},"content":{"application/json":{"schema":{"$ref":"#/components/schemas/ApiResponseVoid"}}}},"200":{"description":"OK","headers":{"X-Request-ID":{"description":"Request identifier echoed for support and reconciliation.","schema":{"type":"string"}},"X-Quota-Limit":{"description":"Monthly API request allowance for the subscription.","schema":{"type":"integer","format":"int64"}},"X-Quota-Remaining":{"description":"Requests remaining in the current monthly allowance after this request.","schema":{"type":"integer","format":"int64"}},"X-Quota-Reset":{"description":"Unix epoch time in seconds when the monthly allowance resets.","schema":{"type":"integer","format":"int64"}},"X-Quota-Workspace":{"description":"Verified workspace owning this allowance: personal or enterprise:<id>.","schema":{"type":"string"}},"X-Quota-Environment":{"description":"Environment owning the allowance: sandbox or live.","schema":{"type":"string"}}},"content":{"application/json":{"schema":{"$ref":"#/components/schemas/ApiResponseContactAccountResponse"}}}},"401":{"description":"Invalid API key, content hash, signature, timestamp or request ID","headers":{"X-Request-ID":{"description":"Request identifier echoed for support and reconciliation.","schema":{"type":"string"}}},"content":{"application/json":{"schema":{"$ref":"#/components/schemas/ApiResponseVoid"}}}},"404":{"description":"Resource not found in this enterprise and environment","headers":{"X-Request-ID":{"description":"Request identifier echoed for support and reconciliation.","schema":{"type":"string"}}},"content":{"application/json":{"schema":{"$ref":"#/components/schemas/ApiResponseVoid"}}}},"422":{"description":"Business rule rejected the request","headers":{"X-Request-ID":{"description":"Request identifier echoed for support and reconciliation.","schema":{"type":"string"}}},"content":{"application/json":{"schema":{"$ref":"#/components/schemas/ApiResponseVoid"}}}},"503":{"description":"A required platform service is temporarily unavailable","headers":{"X-Request-ID":{"description":"Request identifier echoed for support and reconciliation.","schema":{"type":"string"}}},"content":{"application/json":{"schema":{"$ref":"#/components/schemas/ApiResponseVoid"}}}},"409":{"description":"Idempotency or resource-state conflict","headers":{"X-Request-ID":{"description":"Request identifier echoed for support and reconciliation.","schema":{"type":"string"}}},"content":{"application/json":{"schema":{"$ref":"#/components/schemas/ApiResponseVoid"}}}},"429":{"description":"Per-minute rate limit or monthly quota exceeded","headers":{"X-Request-ID":{"description":"Request identifier echoed for support and reconciliation.","schema":{"type":"string"}},"X-Quota-Limit":{"description":"Monthly API request allowance for the subscription.","schema":{"type":"integer","format":"int64"}},"X-Quota-Remaining":{"description":"Requests remaining in the current monthly allowance after this request.","schema":{"type":"integer","format":"int64"}},"X-Quota-Reset":{"description":"Unix epoch time in seconds when the monthly allowance resets.","schema":{"type":"integer","format":"int64"}},"X-Quota-Workspace":{"description":"Verified workspace owning this allowance: personal or enterprise:<id>.","schema":{"type":"string"}},"X-Quota-Environment":{"description":"Environment owning the allowance: sandbox or live.","schema":{"type":"string"}},"Retry-After":{"description":"Seconds until the exhausted quota or rate window resets. Sign retries with a new X-Request-ID.","schema":{"type":"integer","format":"int64"}},"X-RateLimit-Scope":{"description":"Rate counter scope: workspace, or user for enterprise verification calls.","schema":{"type":"string"}},"X-RateLimit-Limit":{"description":"Per-minute request limit when rate-limited.","schema":{"type":"integer","format":"int64"}},"X-RateLimit-Remaining":{"description":"Zero when the minute limit is exhausted.","schema":{"type":"integer","format":"int64"}},"X-RateLimit-Reset":{"description":"Unix epoch seconds when the minute limit resets.","schema":{"type":"integer","format":"int64"}}},"content":{"application/json":{"schema":{"$ref":"#/components/schemas/ApiResponseVoid"}}}},"413":{"description":"Request body is too large","headers":{"X-Request-ID":{"description":"Request identifier echoed for support and reconciliation.","schema":{"type":"string"}}},"content":{"application/json":{"schema":{"$ref":"#/components/schemas/ApiResponseVoid"}}}}},"x-dcwallet-signature-versions":["v1","v2"]}},"/api/v1/cards/{cardId}":{"get":{"tags":["6. Card issuing"],"summary":"Get an enterprise card","description":"Signature versions: v1 and v2.","operationId":"getCardsByCardId","parameters":[{"name":"cardId","in":"path","description":"Issued-card ID returned by /api/v1/cards. Keep IDs as strings.","required":true,"schema":{"pattern":"[0-9]+","type":"string","example":"337893979704000512"}},{"name":"X-Timestamp","in":"header","description":"Current Unix epoch time in seconds. Requests older or newer than five minutes are rejected.","required":true,"schema":{"pattern":"[0-9]{10}","type":"string","example":"1787562000"}},{"name":"X-Request-ID","in":"header","description":"Unique 16-128 character request identifier used for replay protection; never reuse it for a different HTTP request.","required":true,"schema":{"pattern":"[A-Za-z0-9._:-]{16,128}","type":"string","example":"018f6f4e-8f62-7fc2-9c4b-7be2f4203b6a"}},{"name":"X-Content-SHA256","in":"header","description":"Lowercase hexadecimal SHA-256 digest of the exact raw request body; use the digest of zero bytes when no body is sent.","required":true,"schema":{"pattern":"[0-9a-f]{64}","type":"string","example":"e3b0c44298fc1c149afbf4c8996fb92427ae41e4649b934ca495991b7852b855"}},{"name":"X-Workspace","in":"header","description":"Enterprise reads are available on this route. For enterprise access, copy your own enterprise:<id> from GET /api/v1/workspaces. Required for v2 requests. V1 requests use the historical key's fixed enterprise.","required":false,"schema":{"pattern":"personal|enterprise:[1-9][0-9]*","type":"string","example":null}},{"name":"X-Environment","in":"header","description":"Required and signed for v2 requests: live or sandbox. Optional for v1 requests.","required":false,"schema":{"pattern":"live|sandbox","type":"string","example":"live"}},{"name":"X-Signature","in":"header","description":"Existing keys accept v1 for their fixed enterprise or v2 for a signed workspace; new keys accept v2 only.","required":true,"schema":{"pattern":"v[12]=[0-9a-f]{64}","type":"string","example":"v2=0123456789abcdef0123456789abcdef0123456789abcdef0123456789abcdef"}},{"name":"Accept-Language","in":"header","description":"Response language: en-US = English (default); zh-CN = Simplified Chinese; zh-TW = Traditional Chinese. Numeric error codes are language-neutral.","required":false,"schema":{"type":"string","enum":["en-US","zh-CN","zh-TW"],"default":"en-US"}}],"responses":{"400":{"description":"Malformed JSON, missing header or invalid request parameter","headers":{"X-Request-ID":{"description":"Request identifier echoed for support and reconciliation.","schema":{"type":"string"}}},"content":{"application/json":{"schema":{"$ref":"#/components/schemas/ApiResponseVoid"}}}},"500":{"description":"Unexpected internal error; contact support with X-Request-ID","headers":{"X-Request-ID":{"description":"Request identifier echoed for support and reconciliation.","schema":{"type":"string"}}},"content":{"application/json":{"schema":{"$ref":"#/components/schemas/ApiResponseVoid"}}}},"403":{"description":"API-key scope, subscription, tenant or policy does not allow the operation","headers":{"X-Request-ID":{"description":"Request identifier echoed for support and reconciliation.","schema":{"type":"string"}}},"content":{"application/json":{"schema":{"$ref":"#/components/schemas/ApiResponseVoid"}}}},"200":{"description":"OK","headers":{"X-Request-ID":{"description":"Request identifier echoed for support and reconciliation.","schema":{"type":"string"}},"X-Quota-Limit":{"description":"Monthly API request allowance for the subscription.","schema":{"type":"integer","format":"int64"}},"X-Quota-Remaining":{"description":"Requests remaining in the current monthly allowance after this request.","schema":{"type":"integer","format":"int64"}},"X-Quota-Reset":{"description":"Unix epoch time in seconds when the monthly allowance resets.","schema":{"type":"integer","format":"int64"}},"X-Quota-Workspace":{"description":"Verified workspace owning this allowance: personal or enterprise:<id>.","schema":{"type":"string"}},"X-Quota-Environment":{"description":"Environment owning the allowance: sandbox or live.","schema":{"type":"string"}}},"content":{"application/json":{"schema":{"$ref":"#/components/schemas/ApiResponseCardResponse"}}}},"401":{"description":"Invalid API key, content hash, signature, timestamp or request ID","headers":{"X-Request-ID":{"description":"Request identifier echoed for support and reconciliation.","schema":{"type":"string"}}},"content":{"application/json":{"schema":{"$ref":"#/components/schemas/ApiResponseVoid"}}}},"404":{"description":"Resource not found in this enterprise and environment","headers":{"X-Request-ID":{"description":"Request identifier echoed for support and reconciliation.","schema":{"type":"string"}}},"content":{"application/json":{"schema":{"$ref":"#/components/schemas/ApiResponseVoid"}}}},"422":{"description":"Business rule rejected the request","headers":{"X-Request-ID":{"description":"Request identifier echoed for support and reconciliation.","schema":{"type":"string"}}},"content":{"application/json":{"schema":{"$ref":"#/components/schemas/ApiResponseVoid"}}}},"503":{"description":"A required platform service is temporarily unavailable","headers":{"X-Request-ID":{"description":"Request identifier echoed for support and reconciliation.","schema":{"type":"string"}}},"content":{"application/json":{"schema":{"$ref":"#/components/schemas/ApiResponseVoid"}}}},"409":{"description":"Idempotency or resource-state conflict","headers":{"X-Request-ID":{"description":"Request identifier echoed for support and reconciliation.","schema":{"type":"string"}}},"content":{"application/json":{"schema":{"$ref":"#/components/schemas/ApiResponseVoid"}}}},"429":{"description":"Per-minute rate limit or monthly quota exceeded","headers":{"X-Request-ID":{"description":"Request identifier echoed for support and reconciliation.","schema":{"type":"string"}},"X-Quota-Limit":{"description":"Monthly API request allowance for the subscription.","schema":{"type":"integer","format":"int64"}},"X-Quota-Remaining":{"description":"Requests remaining in the current monthly allowance after this request.","schema":{"type":"integer","format":"int64"}},"X-Quota-Reset":{"description":"Unix epoch time in seconds when the monthly allowance resets.","schema":{"type":"integer","format":"int64"}},"X-Quota-Workspace":{"description":"Verified workspace owning this allowance: personal or enterprise:<id>.","schema":{"type":"string"}},"X-Quota-Environment":{"description":"Environment owning the allowance: sandbox or live.","schema":{"type":"string"}},"Retry-After":{"description":"Seconds until the exhausted quota or rate window resets. Sign retries with a new X-Request-ID.","schema":{"type":"integer","format":"int64"}},"X-RateLimit-Scope":{"description":"Rate counter scope: workspace, or user for enterprise verification calls.","schema":{"type":"string"}},"X-RateLimit-Limit":{"description":"Per-minute request limit when rate-limited.","schema":{"type":"integer","format":"int64"}},"X-RateLimit-Remaining":{"description":"Zero when the minute limit is exhausted.","schema":{"type":"integer","format":"int64"}},"X-RateLimit-Reset":{"description":"Unix epoch seconds when the minute limit resets.","schema":{"type":"integer","format":"int64"}}},"content":{"application/json":{"schema":{"$ref":"#/components/schemas/ApiResponseVoid"}}}},"413":{"description":"Request body is too large","headers":{"X-Request-ID":{"description":"Request identifier echoed for support and reconciliation.","schema":{"type":"string"}}},"content":{"application/json":{"schema":{"$ref":"#/components/schemas/ApiResponseVoid"}}}}},"x-dcwallet-signature-versions":["v1","v2"]},"patch":{"tags":["6. Card issuing"],"summary":"Update an enterprise virtual card nickname","description":"Signature versions: v1 and v2.","operationId":"patchCardsByCardId","parameters":[{"name":"cardId","in":"path","description":"Issued-card ID returned by /api/v1/cards. Keep IDs as strings.","required":true,"schema":{"pattern":"[0-9]+","type":"string","example":"337893979704000512"}},{"name":"Idempotency-Key","in":"header","description":"Unique key for one mutating request. Reuse the same value only when retrying the same operation.","required":true,"schema":{"type":"string"}},{"name":"X-Timestamp","in":"header","description":"Current Unix epoch time in seconds. Requests older or newer than five minutes are rejected.","required":true,"schema":{"pattern":"[0-9]{10}","type":"string","example":"1787562000"}},{"name":"X-Request-ID","in":"header","description":"Unique 16-128 character request identifier used for replay protection; never reuse it for a different HTTP request.","required":true,"schema":{"pattern":"[A-Za-z0-9._:-]{16,128}","type":"string","example":"018f6f4e-8f62-7fc2-9c4b-7be2f4203b6a"}},{"name":"X-Content-SHA256","in":"header","description":"Lowercase hexadecimal SHA-256 digest of the exact raw request body; use the digest of zero bytes when no body is sent.","required":true,"schema":{"pattern":"[0-9a-f]{64}","type":"string","example":"e3b0c44298fc1c149afbf4c8996fb92427ae41e4649b934ca495991b7852b855"}},{"name":"X-Workspace","in":"header","description":"Enterprise writes are available on this route. For enterprise access, copy your own enterprise:<id> from GET /api/v1/workspaces. Required for v2 requests. V1 requests use the historical key's fixed enterprise.","required":false,"schema":{"pattern":"personal|enterprise:[1-9][0-9]*","type":"string","example":null}},{"name":"X-Environment","in":"header","description":"Required and signed for v2 requests: live or sandbox. Optional for v1 requests.","required":false,"schema":{"pattern":"live|sandbox","type":"string","example":"live"}},{"name":"X-Signature","in":"header","description":"Existing keys accept v1 for their fixed enterprise or v2 for a signed workspace; new keys accept v2 only.","required":true,"schema":{"pattern":"v[12]=[0-9a-f]{64}","type":"string","example":"v2=0123456789abcdef0123456789abcdef0123456789abcdef0123456789abcdef"}},{"name":"Accept-Language","in":"header","description":"Response language: en-US = English (default); zh-CN = Simplified Chinese; zh-TW = Traditional Chinese. Numeric error codes are language-neutral.","required":false,"schema":{"type":"string","enum":["en-US","zh-CN","zh-TW"],"default":"en-US"}}],"requestBody":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/CardUpdateRequest"}}},"required":true},"responses":{"400":{"description":"Malformed JSON, missing header or invalid request parameter","headers":{"X-Request-ID":{"description":"Request identifier echoed for support and reconciliation.","schema":{"type":"string"}}},"content":{"application/json":{"schema":{"$ref":"#/components/schemas/ApiResponseVoid"}}}},"500":{"description":"Unexpected internal error; contact support with X-Request-ID","headers":{"X-Request-ID":{"description":"Request identifier echoed for support and reconciliation.","schema":{"type":"string"}}},"content":{"application/json":{"schema":{"$ref":"#/components/schemas/ApiResponseVoid"}}}},"403":{"description":"API-key scope, subscription, tenant or policy does not allow the operation","headers":{"X-Request-ID":{"description":"Request identifier echoed for support and reconciliation.","schema":{"type":"string"}}},"content":{"application/json":{"schema":{"$ref":"#/components/schemas/ApiResponseVoid"}}}},"200":{"description":"OK","headers":{"X-Request-ID":{"description":"Request identifier echoed for support and reconciliation.","schema":{"type":"string"}},"X-Quota-Limit":{"description":"Monthly API request allowance for the subscription.","schema":{"type":"integer","format":"int64"}},"X-Quota-Remaining":{"description":"Requests remaining in the current monthly allowance after this request.","schema":{"type":"integer","format":"int64"}},"X-Quota-Reset":{"description":"Unix epoch time in seconds when the monthly allowance resets.","schema":{"type":"integer","format":"int64"}},"X-Quota-Workspace":{"description":"Verified workspace owning this allowance: personal or enterprise:<id>.","schema":{"type":"string"}},"X-Quota-Environment":{"description":"Environment owning the allowance: sandbox or live.","schema":{"type":"string"}}},"content":{"application/json":{"schema":{"$ref":"#/components/schemas/ApiResponseCardResponse"}}}},"401":{"description":"Invalid API key, content hash, signature, timestamp or request ID","headers":{"X-Request-ID":{"description":"Request identifier echoed for support and reconciliation.","schema":{"type":"string"}}},"content":{"application/json":{"schema":{"$ref":"#/components/schemas/ApiResponseVoid"}}}},"404":{"description":"Resource not found in this enterprise and environment","headers":{"X-Request-ID":{"description":"Request identifier echoed for support and reconciliation.","schema":{"type":"string"}}},"content":{"application/json":{"schema":{"$ref":"#/components/schemas/ApiResponseVoid"}}}},"422":{"description":"Business rule rejected the request","headers":{"X-Request-ID":{"description":"Request identifier echoed for support and reconciliation.","schema":{"type":"string"}}},"content":{"application/json":{"schema":{"$ref":"#/components/schemas/ApiResponseVoid"}}}},"503":{"description":"A required platform service is temporarily unavailable","headers":{"X-Request-ID":{"description":"Request identifier echoed for support and reconciliation.","schema":{"type":"string"}}},"content":{"application/json":{"schema":{"$ref":"#/components/schemas/ApiResponseVoid"}}}},"409":{"description":"Idempotency or resource-state conflict","headers":{"X-Request-ID":{"description":"Request identifier echoed for support and reconciliation.","schema":{"type":"string"}}},"content":{"application/json":{"schema":{"$ref":"#/components/schemas/ApiResponseVoid"}}}},"429":{"description":"Per-minute rate limit or monthly quota exceeded","headers":{"X-Request-ID":{"description":"Request identifier echoed for support and reconciliation.","schema":{"type":"string"}},"X-Quota-Limit":{"description":"Monthly API request allowance for the subscription.","schema":{"type":"integer","format":"int64"}},"X-Quota-Remaining":{"description":"Requests remaining in the current monthly allowance after this request.","schema":{"type":"integer","format":"int64"}},"X-Quota-Reset":{"description":"Unix epoch time in seconds when the monthly allowance resets.","schema":{"type":"integer","format":"int64"}},"X-Quota-Workspace":{"description":"Verified workspace owning this allowance: personal or enterprise:<id>.","schema":{"type":"string"}},"X-Quota-Environment":{"description":"Environment owning the allowance: sandbox or live.","schema":{"type":"string"}},"Retry-After":{"description":"Seconds until the exhausted quota or rate window resets. Sign retries with a new X-Request-ID.","schema":{"type":"integer","format":"int64"}},"X-RateLimit-Scope":{"description":"Rate counter scope: workspace, or user for enterprise verification calls.","schema":{"type":"string"}},"X-RateLimit-Limit":{"description":"Per-minute request limit when rate-limited.","schema":{"type":"integer","format":"int64"}},"X-RateLimit-Remaining":{"description":"Zero when the minute limit is exhausted.","schema":{"type":"integer","format":"int64"}},"X-RateLimit-Reset":{"description":"Unix epoch seconds when the minute limit resets.","schema":{"type":"integer","format":"int64"}}},"content":{"application/json":{"schema":{"$ref":"#/components/schemas/ApiResponseVoid"}}}},"413":{"description":"Request body is too large","headers":{"X-Request-ID":{"description":"Request identifier echoed for support and reconciliation.","schema":{"type":"string"}}},"content":{"application/json":{"schema":{"$ref":"#/components/schemas/ApiResponseVoid"}}}}},"x-dcwallet-signature-versions":["v1","v2"]}},"/api/v1/workspaces":{"get":{"tags":["0. Workspaces"],"summary":"List workspaces accessible to the API key owner","description":"Requires a v2-signed request with X-Workspace and X-Environment. An existing key may use its current secret to sign v2 requests and discover workspaces; v1-signed requests cannot call this route. Select v2 and a workspace in the online console, or sign directly.\n\nSignature versions: v2 only.","operationId":"getWorkspaces","parameters":[{"name":"X-Timestamp","in":"header","description":"Current Unix epoch time in seconds. Requests older or newer than five minutes are rejected.","required":true,"schema":{"pattern":"[0-9]{10}","type":"string","example":"1787562000"}},{"name":"X-Request-ID","in":"header","description":"Unique 16-128 character request identifier used for replay protection; never reuse it for a different HTTP request.","required":true,"schema":{"pattern":"[A-Za-z0-9._:-]{16,128}","type":"string","example":"018f6f4e-8f62-7fc2-9c4b-7be2f4203b6a"}},{"name":"X-Content-SHA256","in":"header","description":"Lowercase hexadecimal SHA-256 digest of the exact raw request body; use the digest of zero bytes when no body is sent.","required":true,"schema":{"pattern":"[0-9a-f]{64}","type":"string","example":"e3b0c44298fc1c149afbf4c8996fb92427ae41e4649b934ca495991b7852b855"}},{"name":"X-Workspace","in":"header","description":"Signed workspace selector: personal or enterprise:<id>. Get your enterprise ID from GET /api/v1/workspaces.","required":true,"schema":{"pattern":"personal|enterprise:[1-9][0-9]*","type":"string","example":"personal"}},{"name":"X-Environment","in":"header","description":"Signed key environment: live or sandbox.","required":true,"schema":{"pattern":"live|sandbox","type":"string","example":"live"}},{"name":"X-Signature","in":"header","description":"v2-prefixed lowercase HMAC-SHA256 signature; existing and new keys can use v2 when enabled.","required":true,"schema":{"pattern":"v2=[0-9a-f]{64}","type":"string","example":"v2=0123456789abcdef0123456789abcdef0123456789abcdef0123456789abcdef"}},{"name":"Accept-Language","in":"header","description":"Response language: en-US = English (default); zh-CN = Simplified Chinese; zh-TW = Traditional Chinese. Numeric error codes are language-neutral.","required":false,"schema":{"type":"string","enum":["en-US","zh-CN","zh-TW"],"default":"en-US"}}],"responses":{"400":{"description":"Malformed JSON, missing header or invalid request parameter","headers":{"X-Request-ID":{"description":"Request identifier echoed for support and reconciliation.","schema":{"type":"string"}}},"content":{"application/json":{"schema":{"$ref":"#/components/schemas/ApiResponseVoid"}}}},"500":{"description":"Unexpected internal error; contact support with X-Request-ID","headers":{"X-Request-ID":{"description":"Request identifier echoed for support and reconciliation.","schema":{"type":"string"}}},"content":{"application/json":{"schema":{"$ref":"#/components/schemas/ApiResponseVoid"}}}},"403":{"description":"API-key scope, subscription, tenant or policy does not allow the operation","headers":{"X-Request-ID":{"description":"Request identifier echoed for support and reconciliation.","schema":{"type":"string"}}},"content":{"application/json":{"schema":{"$ref":"#/components/schemas/ApiResponseVoid"}}}},"200":{"description":"OK","headers":{"X-Request-ID":{"description":"Request identifier echoed for support and reconciliation.","schema":{"type":"string"}},"X-Quota-Limit":{"description":"Monthly API request allowance for the subscription.","schema":{"type":"integer","format":"int64"}},"X-Quota-Remaining":{"description":"Requests remaining in the current monthly allowance after this request.","schema":{"type":"integer","format":"int64"}},"X-Quota-Reset":{"description":"Unix epoch time in seconds when the monthly allowance resets.","schema":{"type":"integer","format":"int64"}},"X-Quota-Workspace":{"description":"Verified workspace owning this allowance: personal or enterprise:<id>.","schema":{"type":"string"}},"X-Quota-Environment":{"description":"Environment owning the allowance: sandbox or live.","schema":{"type":"string"}}},"content":{"application/json":{"schema":{"$ref":"#/components/schemas/ApiResponseListWorkspaceItem"}}}},"401":{"description":"Invalid API key, content hash, signature, timestamp or request ID","headers":{"X-Request-ID":{"description":"Request identifier echoed for support and reconciliation.","schema":{"type":"string"}}},"content":{"application/json":{"schema":{"$ref":"#/components/schemas/ApiResponseVoid"}}}},"404":{"description":"Resource not found in this enterprise and environment","headers":{"X-Request-ID":{"description":"Request identifier echoed for support and reconciliation.","schema":{"type":"string"}}},"content":{"application/json":{"schema":{"$ref":"#/components/schemas/ApiResponseVoid"}}}},"422":{"description":"Business rule rejected the request","headers":{"X-Request-ID":{"description":"Request identifier echoed for support and reconciliation.","schema":{"type":"string"}}},"content":{"application/json":{"schema":{"$ref":"#/components/schemas/ApiResponseVoid"}}}},"503":{"description":"A required platform service is temporarily unavailable","headers":{"X-Request-ID":{"description":"Request identifier echoed for support and reconciliation.","schema":{"type":"string"}}},"content":{"application/json":{"schema":{"$ref":"#/components/schemas/ApiResponseVoid"}}}},"409":{"description":"Idempotency or resource-state conflict","headers":{"X-Request-ID":{"description":"Request identifier echoed for support and reconciliation.","schema":{"type":"string"}}},"content":{"application/json":{"schema":{"$ref":"#/components/schemas/ApiResponseVoid"}}}},"429":{"description":"Per-minute rate limit or monthly quota exceeded","headers":{"X-Request-ID":{"description":"Request identifier echoed for support and reconciliation.","schema":{"type":"string"}},"X-Quota-Limit":{"description":"Monthly API request allowance for the subscription.","schema":{"type":"integer","format":"int64"}},"X-Quota-Remaining":{"description":"Requests remaining in the current monthly allowance after this request.","schema":{"type":"integer","format":"int64"}},"X-Quota-Reset":{"description":"Unix epoch time in seconds when the monthly allowance resets.","schema":{"type":"integer","format":"int64"}},"X-Quota-Workspace":{"description":"Verified workspace owning this allowance: personal or enterprise:<id>.","schema":{"type":"string"}},"X-Quota-Environment":{"description":"Environment owning the allowance: sandbox or live.","schema":{"type":"string"}},"Retry-After":{"description":"Seconds until the exhausted quota or rate window resets. Sign retries with a new X-Request-ID.","schema":{"type":"integer","format":"int64"}},"X-RateLimit-Scope":{"description":"Rate counter scope: workspace, or user for enterprise verification calls.","schema":{"type":"string"}},"X-RateLimit-Limit":{"description":"Per-minute request limit when rate-limited.","schema":{"type":"integer","format":"int64"}},"X-RateLimit-Remaining":{"description":"Zero when the minute limit is exhausted.","schema":{"type":"integer","format":"int64"}},"X-RateLimit-Reset":{"description":"Unix epoch seconds when the minute limit resets.","schema":{"type":"integer","format":"int64"}}},"content":{"application/json":{"schema":{"$ref":"#/components/schemas/ApiResponseVoid"}}}},"413":{"description":"Request body is too large","headers":{"X-Request-ID":{"description":"Request identifier echoed for support and reconciliation.","schema":{"type":"string"}}},"content":{"application/json":{"schema":{"$ref":"#/components/schemas/ApiResponseVoid"}}}}},"x-dcwallet-signature-versions":["v2"]}},"/api/v1/webhook-endpoints/{endpointId}/deliveries":{"get":{"tags":["7. Webhooks"],"summary":"List delivery attempts for a user webhook endpoint","description":"Use deliveryId or eventId to check the asynchronous result of a sandbox test event.\n\nSignature versions: v1 and v2.","operationId":"getWebhookEndpointsByEndpointIdDeliveries","parameters":[{"name":"endpointId","in":"path","description":"Webhook endpoint ID returned by /api/v1/webhook-endpoints. Keep IDs as strings.","required":true,"schema":{"pattern":"[0-9]+","type":"string","example":"337893979704000512"}},{"name":"deliveryId","in":"query","description":"Webhook delivery identifier returned when an event is queued.","required":false,"schema":{"type":"string"}},{"name":"eventId","in":"query","description":"Webhook event identifier shared by all delivery attempts for the event.","required":false,"schema":{"type":"string"}},{"name":"status","in":"query","description":"Optional filter. Delivery state: pending = queued or scheduled for retry; delivering = claimed by a worker; delivered = receiver returned 2xx; dead_letter = retries exhausted or endpoint unavailable. Default on enqueue: pending. Terminal: delivered, dead_letter. A manual retry creates another delivery attempt.","required":false,"schema":{"type":"string","enum":["pending","delivering","delivered","dead_letter"]}},{"name":"page","in":"query","description":"One-based result page number.","required":false,"schema":{"type":"integer","format":"int32","default":1}},{"name":"pageSize","in":"query","description":"Maximum records returned per page; values above 100 are capped.","required":false,"schema":{"type":"integer","format":"int32","default":20}},{"name":"X-Timestamp","in":"header","description":"Current Unix epoch time in seconds. Requests older or newer than five minutes are rejected.","required":true,"schema":{"pattern":"[0-9]{10}","type":"string","example":"1787562000"}},{"name":"X-Request-ID","in":"header","description":"Unique 16-128 character request identifier used for replay protection; never reuse it for a different HTTP request.","required":true,"schema":{"pattern":"[A-Za-z0-9._:-]{16,128}","type":"string","example":"018f6f4e-8f62-7fc2-9c4b-7be2f4203b6a"}},{"name":"X-Content-SHA256","in":"header","description":"Lowercase hexadecimal SHA-256 digest of the exact raw request body; use the digest of zero bytes when no body is sent.","required":true,"schema":{"pattern":"[0-9a-f]{64}","type":"string","example":"e3b0c44298fc1c149afbf4c8996fb92427ae41e4649b934ca495991b7852b855"}},{"name":"X-Workspace","in":"header","description":"Enterprise reads are available on this route. For enterprise access, copy your own enterprise:<id> from GET /api/v1/workspaces. Required for v2 requests. V1 requests use the historical key's fixed enterprise.","required":false,"schema":{"pattern":"personal|enterprise:[1-9][0-9]*","type":"string","example":"personal"}},{"name":"X-Environment","in":"header","description":"Required and signed for v2 requests: live or sandbox. Optional for v1 requests.","required":false,"schema":{"pattern":"live|sandbox","type":"string","example":"live"}},{"name":"X-Signature","in":"header","description":"Existing keys accept v1 for their fixed enterprise or v2 for a signed workspace; new keys accept v2 only.","required":true,"schema":{"pattern":"v[12]=[0-9a-f]{64}","type":"string","example":"v2=0123456789abcdef0123456789abcdef0123456789abcdef0123456789abcdef"}},{"name":"Accept-Language","in":"header","description":"Response language: en-US = English (default); zh-CN = Simplified Chinese; zh-TW = Traditional Chinese. Numeric error codes are language-neutral.","required":false,"schema":{"type":"string","enum":["en-US","zh-CN","zh-TW"],"default":"en-US"}}],"responses":{"400":{"description":"Malformed JSON, missing header or invalid request parameter","headers":{"X-Request-ID":{"description":"Request identifier echoed for support and reconciliation.","schema":{"type":"string"}}},"content":{"application/json":{"schema":{"$ref":"#/components/schemas/ApiResponseVoid"}}}},"500":{"description":"Unexpected internal error; contact support with X-Request-ID","headers":{"X-Request-ID":{"description":"Request identifier echoed for support and reconciliation.","schema":{"type":"string"}}},"content":{"application/json":{"schema":{"$ref":"#/components/schemas/ApiResponseVoid"}}}},"403":{"description":"API-key scope, subscription, tenant or policy does not allow the operation","headers":{"X-Request-ID":{"description":"Request identifier echoed for support and reconciliation.","schema":{"type":"string"}}},"content":{"application/json":{"schema":{"$ref":"#/components/schemas/ApiResponseVoid"}}}},"200":{"description":"OK","headers":{"X-Request-ID":{"description":"Request identifier echoed for support and reconciliation.","schema":{"type":"string"}},"X-Quota-Limit":{"description":"Monthly API request allowance for the subscription.","schema":{"type":"integer","format":"int64"}},"X-Quota-Remaining":{"description":"Requests remaining in the current monthly allowance after this request.","schema":{"type":"integer","format":"int64"}},"X-Quota-Reset":{"description":"Unix epoch time in seconds when the monthly allowance resets.","schema":{"type":"integer","format":"int64"}},"X-Quota-Workspace":{"description":"Verified workspace owning this allowance: personal or enterprise:<id>.","schema":{"type":"string"}},"X-Quota-Environment":{"description":"Environment owning the allowance: sandbox or live.","schema":{"type":"string"}}},"content":{"application/json":{"schema":{"$ref":"#/components/schemas/ApiResponsePageDataWebhookDeliveryResponse"}}}},"401":{"description":"Invalid API key, content hash, signature, timestamp or request ID","headers":{"X-Request-ID":{"description":"Request identifier echoed for support and reconciliation.","schema":{"type":"string"}}},"content":{"application/json":{"schema":{"$ref":"#/components/schemas/ApiResponseVoid"}}}},"404":{"description":"Resource not found in this enterprise and environment","headers":{"X-Request-ID":{"description":"Request identifier echoed for support and reconciliation.","schema":{"type":"string"}}},"content":{"application/json":{"schema":{"$ref":"#/components/schemas/ApiResponseVoid"}}}},"422":{"description":"Business rule rejected the request","headers":{"X-Request-ID":{"description":"Request identifier echoed for support and reconciliation.","schema":{"type":"string"}}},"content":{"application/json":{"schema":{"$ref":"#/components/schemas/ApiResponseVoid"}}}},"503":{"description":"A required platform service is temporarily unavailable","headers":{"X-Request-ID":{"description":"Request identifier echoed for support and reconciliation.","schema":{"type":"string"}}},"content":{"application/json":{"schema":{"$ref":"#/components/schemas/ApiResponseVoid"}}}},"409":{"description":"Idempotency or resource-state conflict","headers":{"X-Request-ID":{"description":"Request identifier echoed for support and reconciliation.","schema":{"type":"string"}}},"content":{"application/json":{"schema":{"$ref":"#/components/schemas/ApiResponseVoid"}}}},"429":{"description":"Per-minute rate limit or monthly quota exceeded","headers":{"X-Request-ID":{"description":"Request identifier echoed for support and reconciliation.","schema":{"type":"string"}},"X-Quota-Limit":{"description":"Monthly API request allowance for the subscription.","schema":{"type":"integer","format":"int64"}},"X-Quota-Remaining":{"description":"Requests remaining in the current monthly allowance after this request.","schema":{"type":"integer","format":"int64"}},"X-Quota-Reset":{"description":"Unix epoch time in seconds when the monthly allowance resets.","schema":{"type":"integer","format":"int64"}},"X-Quota-Workspace":{"description":"Verified workspace owning this allowance: personal or enterprise:<id>.","schema":{"type":"string"}},"X-Quota-Environment":{"description":"Environment owning the allowance: sandbox or live.","schema":{"type":"string"}},"Retry-After":{"description":"Seconds until the exhausted quota or rate window resets. Sign retries with a new X-Request-ID.","schema":{"type":"integer","format":"int64"}},"X-RateLimit-Scope":{"description":"Rate counter scope: workspace, or user for enterprise verification calls.","schema":{"type":"string"}},"X-RateLimit-Limit":{"description":"Per-minute request limit when rate-limited.","schema":{"type":"integer","format":"int64"}},"X-RateLimit-Remaining":{"description":"Zero when the minute limit is exhausted.","schema":{"type":"integer","format":"int64"}},"X-RateLimit-Reset":{"description":"Unix epoch seconds when the minute limit resets.","schema":{"type":"integer","format":"int64"}}},"content":{"application/json":{"schema":{"$ref":"#/components/schemas/ApiResponseVoid"}}}},"413":{"description":"Request body is too large","headers":{"X-Request-ID":{"description":"Request identifier echoed for support and reconciliation.","schema":{"type":"string"}}},"content":{"application/json":{"schema":{"$ref":"#/components/schemas/ApiResponseVoid"}}}}},"x-dcwallet-signature-versions":["v1","v2"]}},"/api/v1/webhook-endpoints/event-types":{"get":{"tags":["7. Webhooks"],"summary":"List event types available for sandbox test delivery","description":"Signature versions: v1 and v2.","operationId":"getWebhookEndpointsEventTypes","parameters":[{"name":"X-Timestamp","in":"header","description":"Current Unix epoch time in seconds. Requests older or newer than five minutes are rejected.","required":true,"schema":{"pattern":"[0-9]{10}","type":"string","example":"1787562000"}},{"name":"X-Request-ID","in":"header","description":"Unique 16-128 character request identifier used for replay protection; never reuse it for a different HTTP request.","required":true,"schema":{"pattern":"[A-Za-z0-9._:-]{16,128}","type":"string","example":"018f6f4e-8f62-7fc2-9c4b-7be2f4203b6a"}},{"name":"X-Content-SHA256","in":"header","description":"Lowercase hexadecimal SHA-256 digest of the exact raw request body; use the digest of zero bytes when no body is sent.","required":true,"schema":{"pattern":"[0-9a-f]{64}","type":"string","example":"e3b0c44298fc1c149afbf4c8996fb92427ae41e4649b934ca495991b7852b855"}},{"name":"X-Workspace","in":"header","description":"Enterprise reads are available on this route. For enterprise access, copy your own enterprise:<id> from GET /api/v1/workspaces. Required for v2 requests. V1 requests use the historical key's fixed enterprise.","required":false,"schema":{"pattern":"personal|enterprise:[1-9][0-9]*","type":"string","example":"personal"}},{"name":"X-Environment","in":"header","description":"Required and signed for v2 requests: live or sandbox. Optional for v1 requests.","required":false,"schema":{"pattern":"live|sandbox","type":"string","example":"live"}},{"name":"X-Signature","in":"header","description":"Existing keys accept v1 for their fixed enterprise or v2 for a signed workspace; new keys accept v2 only.","required":true,"schema":{"pattern":"v[12]=[0-9a-f]{64}","type":"string","example":"v2=0123456789abcdef0123456789abcdef0123456789abcdef0123456789abcdef"}},{"name":"Accept-Language","in":"header","description":"Response language: en-US = English (default); zh-CN = Simplified Chinese; zh-TW = Traditional Chinese. Numeric error codes are language-neutral.","required":false,"schema":{"type":"string","enum":["en-US","zh-CN","zh-TW"],"default":"en-US"}}],"responses":{"400":{"description":"Malformed JSON, missing header or invalid request parameter","headers":{"X-Request-ID":{"description":"Request identifier echoed for support and reconciliation.","schema":{"type":"string"}}},"content":{"application/json":{"schema":{"$ref":"#/components/schemas/ApiResponseVoid"}}}},"500":{"description":"Unexpected internal error; contact support with X-Request-ID","headers":{"X-Request-ID":{"description":"Request identifier echoed for support and reconciliation.","schema":{"type":"string"}}},"content":{"application/json":{"schema":{"$ref":"#/components/schemas/ApiResponseVoid"}}}},"403":{"description":"API-key scope, subscription, tenant or policy does not allow the operation","headers":{"X-Request-ID":{"description":"Request identifier echoed for support and reconciliation.","schema":{"type":"string"}}},"content":{"application/json":{"schema":{"$ref":"#/components/schemas/ApiResponseVoid"}}}},"200":{"description":"OK","headers":{"X-Request-ID":{"description":"Request identifier echoed for support and reconciliation.","schema":{"type":"string"}},"X-Quota-Limit":{"description":"Monthly API request allowance for the subscription.","schema":{"type":"integer","format":"int64"}},"X-Quota-Remaining":{"description":"Requests remaining in the current monthly allowance after this request.","schema":{"type":"integer","format":"int64"}},"X-Quota-Reset":{"description":"Unix epoch time in seconds when the monthly allowance resets.","schema":{"type":"integer","format":"int64"}},"X-Quota-Workspace":{"description":"Verified workspace owning this allowance: personal or enterprise:<id>.","schema":{"type":"string"}},"X-Quota-Environment":{"description":"Environment owning the allowance: sandbox or live.","schema":{"type":"string"}}},"content":{"application/json":{"schema":{"$ref":"#/components/schemas/ApiResponseListString"}}}},"401":{"description":"Invalid API key, content hash, signature, timestamp or request ID","headers":{"X-Request-ID":{"description":"Request identifier echoed for support and reconciliation.","schema":{"type":"string"}}},"content":{"application/json":{"schema":{"$ref":"#/components/schemas/ApiResponseVoid"}}}},"404":{"description":"Resource not found in this enterprise and environment","headers":{"X-Request-ID":{"description":"Request identifier echoed for support and reconciliation.","schema":{"type":"string"}}},"content":{"application/json":{"schema":{"$ref":"#/components/schemas/ApiResponseVoid"}}}},"422":{"description":"Business rule rejected the request","headers":{"X-Request-ID":{"description":"Request identifier echoed for support and reconciliation.","schema":{"type":"string"}}},"content":{"application/json":{"schema":{"$ref":"#/components/schemas/ApiResponseVoid"}}}},"503":{"description":"A required platform service is temporarily unavailable","headers":{"X-Request-ID":{"description":"Request identifier echoed for support and reconciliation.","schema":{"type":"string"}}},"content":{"application/json":{"schema":{"$ref":"#/components/schemas/ApiResponseVoid"}}}},"409":{"description":"Idempotency or resource-state conflict","headers":{"X-Request-ID":{"description":"Request identifier echoed for support and reconciliation.","schema":{"type":"string"}}},"content":{"application/json":{"schema":{"$ref":"#/components/schemas/ApiResponseVoid"}}}},"429":{"description":"Per-minute rate limit or monthly quota exceeded","headers":{"X-Request-ID":{"description":"Request identifier echoed for support and reconciliation.","schema":{"type":"string"}},"X-Quota-Limit":{"description":"Monthly API request allowance for the subscription.","schema":{"type":"integer","format":"int64"}},"X-Quota-Remaining":{"description":"Requests remaining in the current monthly allowance after this request.","schema":{"type":"integer","format":"int64"}},"X-Quota-Reset":{"description":"Unix epoch time in seconds when the monthly allowance resets.","schema":{"type":"integer","format":"int64"}},"X-Quota-Workspace":{"description":"Verified workspace owning this allowance: personal or enterprise:<id>.","schema":{"type":"string"}},"X-Quota-Environment":{"description":"Environment owning the allowance: sandbox or live.","schema":{"type":"string"}},"Retry-After":{"description":"Seconds until the exhausted quota or rate window resets. Sign retries with a new X-Request-ID.","schema":{"type":"integer","format":"int64"}},"X-RateLimit-Scope":{"description":"Rate counter scope: workspace, or user for enterprise verification calls.","schema":{"type":"string"}},"X-RateLimit-Limit":{"description":"Per-minute request limit when rate-limited.","schema":{"type":"integer","format":"int64"}},"X-RateLimit-Remaining":{"description":"Zero when the minute limit is exhausted.","schema":{"type":"integer","format":"int64"}},"X-RateLimit-Reset":{"description":"Unix epoch seconds when the minute limit resets.","schema":{"type":"integer","format":"int64"}}},"content":{"application/json":{"schema":{"$ref":"#/components/schemas/ApiResponseVoid"}}}},"413":{"description":"Request body is too large","headers":{"X-Request-ID":{"description":"Request identifier echoed for support and reconciliation.","schema":{"type":"string"}}},"content":{"application/json":{"schema":{"$ref":"#/components/schemas/ApiResponseVoid"}}}}},"x-dcwallet-signature-versions":["v1","v2"]}},"/api/v1/webhook-endpoints/enterprise-links":{"get":{"tags":["7. Webhooks"],"summary":"List enterprise associations for the user webhook integration","description":"Signature versions: v2 only.","operationId":"getWebhookEndpointsEnterpriseLinks","parameters":[{"name":"X-Timestamp","in":"header","description":"Current Unix epoch time in seconds. Requests older or newer than five minutes are rejected.","required":true,"schema":{"pattern":"[0-9]{10}","type":"string","example":"1787562000"}},{"name":"X-Request-ID","in":"header","description":"Unique 16-128 character request identifier used for replay protection; never reuse it for a different HTTP request.","required":true,"schema":{"pattern":"[A-Za-z0-9._:-]{16,128}","type":"string","example":"018f6f4e-8f62-7fc2-9c4b-7be2f4203b6a"}},{"name":"X-Content-SHA256","in":"header","description":"Lowercase hexadecimal SHA-256 digest of the exact raw request body; use the digest of zero bytes when no body is sent.","required":true,"schema":{"pattern":"[0-9a-f]{64}","type":"string","example":"e3b0c44298fc1c149afbf4c8996fb92427ae41e4649b934ca495991b7852b855"}},{"name":"X-Workspace","in":"header","description":"Signed workspace selector: personal or enterprise:<id>. Get your enterprise ID from GET /api/v1/workspaces.","required":true,"schema":{"pattern":"personal|enterprise:[1-9][0-9]*","type":"string","example":"personal"}},{"name":"X-Environment","in":"header","description":"Signed key environment: live or sandbox.","required":true,"schema":{"pattern":"live|sandbox","type":"string","example":"live"}},{"name":"X-Signature","in":"header","description":"v2-prefixed lowercase HMAC-SHA256 signature; existing and new keys can use v2 when enabled.","required":true,"schema":{"pattern":"v2=[0-9a-f]{64}","type":"string","example":"v2=0123456789abcdef0123456789abcdef0123456789abcdef0123456789abcdef"}},{"name":"Accept-Language","in":"header","description":"Response language: en-US = English (default); zh-CN = Simplified Chinese; zh-TW = Traditional Chinese. Numeric error codes are language-neutral.","required":false,"schema":{"type":"string","enum":["en-US","zh-CN","zh-TW"],"default":"en-US"}}],"responses":{"400":{"description":"Malformed JSON, missing header or invalid request parameter","headers":{"X-Request-ID":{"description":"Request identifier echoed for support and reconciliation.","schema":{"type":"string"}}},"content":{"application/json":{"schema":{"$ref":"#/components/schemas/ApiResponseVoid"}}}},"500":{"description":"Unexpected internal error; contact support with X-Request-ID","headers":{"X-Request-ID":{"description":"Request identifier echoed for support and reconciliation.","schema":{"type":"string"}}},"content":{"application/json":{"schema":{"$ref":"#/components/schemas/ApiResponseVoid"}}}},"403":{"description":"API-key scope, subscription, tenant or policy does not allow the operation","headers":{"X-Request-ID":{"description":"Request identifier echoed for support and reconciliation.","schema":{"type":"string"}}},"content":{"application/json":{"schema":{"$ref":"#/components/schemas/ApiResponseVoid"}}}},"200":{"description":"OK","headers":{"X-Request-ID":{"description":"Request identifier echoed for support and reconciliation.","schema":{"type":"string"}},"X-Quota-Limit":{"description":"Monthly API request allowance for the subscription.","schema":{"type":"integer","format":"int64"}},"X-Quota-Remaining":{"description":"Requests remaining in the current monthly allowance after this request.","schema":{"type":"integer","format":"int64"}},"X-Quota-Reset":{"description":"Unix epoch time in seconds when the monthly allowance resets.","schema":{"type":"integer","format":"int64"}},"X-Quota-Workspace":{"description":"Verified workspace owning this allowance: personal or enterprise:<id>.","schema":{"type":"string"}},"X-Quota-Environment":{"description":"Environment owning the allowance: sandbox or live.","schema":{"type":"string"}}},"content":{"application/json":{"schema":{"$ref":"#/components/schemas/ApiResponseListLinkItem"}}}},"401":{"description":"Invalid API key, content hash, signature, timestamp or request ID","headers":{"X-Request-ID":{"description":"Request identifier echoed for support and reconciliation.","schema":{"type":"string"}}},"content":{"application/json":{"schema":{"$ref":"#/components/schemas/ApiResponseVoid"}}}},"404":{"description":"Resource not found in this enterprise and environment","headers":{"X-Request-ID":{"description":"Request identifier echoed for support and reconciliation.","schema":{"type":"string"}}},"content":{"application/json":{"schema":{"$ref":"#/components/schemas/ApiResponseVoid"}}}},"422":{"description":"Business rule rejected the request","headers":{"X-Request-ID":{"description":"Request identifier echoed for support and reconciliation.","schema":{"type":"string"}}},"content":{"application/json":{"schema":{"$ref":"#/components/schemas/ApiResponseVoid"}}}},"503":{"description":"A required platform service is temporarily unavailable","headers":{"X-Request-ID":{"description":"Request identifier echoed for support and reconciliation.","schema":{"type":"string"}}},"content":{"application/json":{"schema":{"$ref":"#/components/schemas/ApiResponseVoid"}}}},"409":{"description":"Idempotency or resource-state conflict","headers":{"X-Request-ID":{"description":"Request identifier echoed for support and reconciliation.","schema":{"type":"string"}}},"content":{"application/json":{"schema":{"$ref":"#/components/schemas/ApiResponseVoid"}}}},"429":{"description":"Per-minute rate limit or monthly quota exceeded","headers":{"X-Request-ID":{"description":"Request identifier echoed for support and reconciliation.","schema":{"type":"string"}},"X-Quota-Limit":{"description":"Monthly API request allowance for the subscription.","schema":{"type":"integer","format":"int64"}},"X-Quota-Remaining":{"description":"Requests remaining in the current monthly allowance after this request.","schema":{"type":"integer","format":"int64"}},"X-Quota-Reset":{"description":"Unix epoch time in seconds when the monthly allowance resets.","schema":{"type":"integer","format":"int64"}},"X-Quota-Workspace":{"description":"Verified workspace owning this allowance: personal or enterprise:<id>.","schema":{"type":"string"}},"X-Quota-Environment":{"description":"Environment owning the allowance: sandbox or live.","schema":{"type":"string"}},"Retry-After":{"description":"Seconds until the exhausted quota or rate window resets. Sign retries with a new X-Request-ID.","schema":{"type":"integer","format":"int64"}},"X-RateLimit-Scope":{"description":"Rate counter scope: workspace, or user for enterprise verification calls.","schema":{"type":"string"}},"X-RateLimit-Limit":{"description":"Per-minute request limit when rate-limited.","schema":{"type":"integer","format":"int64"}},"X-RateLimit-Remaining":{"description":"Zero when the minute limit is exhausted.","schema":{"type":"integer","format":"int64"}},"X-RateLimit-Reset":{"description":"Unix epoch seconds when the minute limit resets.","schema":{"type":"integer","format":"int64"}}},"content":{"application/json":{"schema":{"$ref":"#/components/schemas/ApiResponseVoid"}}}},"413":{"description":"Request body is too large","headers":{"X-Request-ID":{"description":"Request identifier echoed for support and reconciliation.","schema":{"type":"string"}}},"content":{"application/json":{"schema":{"$ref":"#/components/schemas/ApiResponseVoid"}}}}},"x-dcwallet-signature-versions":["v2"]}},"/api/v1/transfers/{transferId}":{"get":{"tags":["5. Transfers"],"summary":"Get an enterprise transfer","description":"Signature versions: v1 and v2.","operationId":"getTransfersByTransferId","parameters":[{"name":"transferId","in":"path","description":"Transfer ID returned by POST /api/v1/transfers. Keep IDs as strings.","required":true,"schema":{"pattern":"[0-9]+","type":"string","example":"337893979704000512"}},{"name":"X-Timestamp","in":"header","description":"Current Unix epoch time in seconds. Requests older or newer than five minutes are rejected.","required":true,"schema":{"pattern":"[0-9]{10}","type":"string","example":"1787562000"}},{"name":"X-Request-ID","in":"header","description":"Unique 16-128 character request identifier used for replay protection; never reuse it for a different HTTP request.","required":true,"schema":{"pattern":"[A-Za-z0-9._:-]{16,128}","type":"string","example":"018f6f4e-8f62-7fc2-9c4b-7be2f4203b6a"}},{"name":"X-Content-SHA256","in":"header","description":"Lowercase hexadecimal SHA-256 digest of the exact raw request body; use the digest of zero bytes when no body is sent.","required":true,"schema":{"pattern":"[0-9a-f]{64}","type":"string","example":"e3b0c44298fc1c149afbf4c8996fb92427ae41e4649b934ca495991b7852b855"}},{"name":"X-Workspace","in":"header","description":"Enterprise reads are available on this route. For enterprise access, copy your own enterprise:<id> from GET /api/v1/workspaces. Required for v2 requests. V1 requests use the historical key's fixed enterprise.","required":false,"schema":{"pattern":"personal|enterprise:[1-9][0-9]*","type":"string","example":null}},{"name":"X-Environment","in":"header","description":"Required and signed for v2 requests: live or sandbox. Optional for v1 requests.","required":false,"schema":{"pattern":"live|sandbox","type":"string","example":"live"}},{"name":"X-Signature","in":"header","description":"Existing keys accept v1 for their fixed enterprise or v2 for a signed workspace; new keys accept v2 only.","required":true,"schema":{"pattern":"v[12]=[0-9a-f]{64}","type":"string","example":"v2=0123456789abcdef0123456789abcdef0123456789abcdef0123456789abcdef"}},{"name":"Accept-Language","in":"header","description":"Response language: en-US = English (default); zh-CN = Simplified Chinese; zh-TW = Traditional Chinese. Numeric error codes are language-neutral.","required":false,"schema":{"type":"string","enum":["en-US","zh-CN","zh-TW"],"default":"en-US"}}],"responses":{"400":{"description":"Malformed JSON, missing header or invalid request parameter","headers":{"X-Request-ID":{"description":"Request identifier echoed for support and reconciliation.","schema":{"type":"string"}}},"content":{"application/json":{"schema":{"$ref":"#/components/schemas/ApiResponseVoid"}}}},"500":{"description":"Unexpected internal error; contact support with X-Request-ID","headers":{"X-Request-ID":{"description":"Request identifier echoed for support and reconciliation.","schema":{"type":"string"}}},"content":{"application/json":{"schema":{"$ref":"#/components/schemas/ApiResponseVoid"}}}},"403":{"description":"API-key scope, subscription, tenant or policy does not allow the operation","headers":{"X-Request-ID":{"description":"Request identifier echoed for support and reconciliation.","schema":{"type":"string"}}},"content":{"application/json":{"schema":{"$ref":"#/components/schemas/ApiResponseVoid"}}}},"200":{"description":"OK","headers":{"X-Request-ID":{"description":"Request identifier echoed for support and reconciliation.","schema":{"type":"string"}},"X-Quota-Limit":{"description":"Monthly API request allowance for the subscription.","schema":{"type":"integer","format":"int64"}},"X-Quota-Remaining":{"description":"Requests remaining in the current monthly allowance after this request.","schema":{"type":"integer","format":"int64"}},"X-Quota-Reset":{"description":"Unix epoch time in seconds when the monthly allowance resets.","schema":{"type":"integer","format":"int64"}},"X-Quota-Workspace":{"description":"Verified workspace owning this allowance: personal or enterprise:<id>.","schema":{"type":"string"}},"X-Quota-Environment":{"description":"Environment owning the allowance: sandbox or live.","schema":{"type":"string"}}},"content":{"application/json":{"schema":{"$ref":"#/components/schemas/ApiResponseTransferResponse"}}}},"401":{"description":"Invalid API key, content hash, signature, timestamp or request ID","headers":{"X-Request-ID":{"description":"Request identifier echoed for support and reconciliation.","schema":{"type":"string"}}},"content":{"application/json":{"schema":{"$ref":"#/components/schemas/ApiResponseVoid"}}}},"404":{"description":"Resource not found in this enterprise and environment","headers":{"X-Request-ID":{"description":"Request identifier echoed for support and reconciliation.","schema":{"type":"string"}}},"content":{"application/json":{"schema":{"$ref":"#/components/schemas/ApiResponseVoid"}}}},"422":{"description":"Business rule rejected the request","headers":{"X-Request-ID":{"description":"Request identifier echoed for support and reconciliation.","schema":{"type":"string"}}},"content":{"application/json":{"schema":{"$ref":"#/components/schemas/ApiResponseVoid"}}}},"503":{"description":"A required platform service is temporarily unavailable","headers":{"X-Request-ID":{"description":"Request identifier echoed for support and reconciliation.","schema":{"type":"string"}}},"content":{"application/json":{"schema":{"$ref":"#/components/schemas/ApiResponseVoid"}}}},"409":{"description":"Idempotency or resource-state conflict","headers":{"X-Request-ID":{"description":"Request identifier echoed for support and reconciliation.","schema":{"type":"string"}}},"content":{"application/json":{"schema":{"$ref":"#/components/schemas/ApiResponseVoid"}}}},"429":{"description":"Per-minute rate limit or monthly quota exceeded","headers":{"X-Request-ID":{"description":"Request identifier echoed for support and reconciliation.","schema":{"type":"string"}},"X-Quota-Limit":{"description":"Monthly API request allowance for the subscription.","schema":{"type":"integer","format":"int64"}},"X-Quota-Remaining":{"description":"Requests remaining in the current monthly allowance after this request.","schema":{"type":"integer","format":"int64"}},"X-Quota-Reset":{"description":"Unix epoch time in seconds when the monthly allowance resets.","schema":{"type":"integer","format":"int64"}},"X-Quota-Workspace":{"description":"Verified workspace owning this allowance: personal or enterprise:<id>.","schema":{"type":"string"}},"X-Quota-Environment":{"description":"Environment owning the allowance: sandbox or live.","schema":{"type":"string"}},"Retry-After":{"description":"Seconds until the exhausted quota or rate window resets. Sign retries with a new X-Request-ID.","schema":{"type":"integer","format":"int64"}},"X-RateLimit-Scope":{"description":"Rate counter scope: workspace, or user for enterprise verification calls.","schema":{"type":"string"}},"X-RateLimit-Limit":{"description":"Per-minute request limit when rate-limited.","schema":{"type":"integer","format":"int64"}},"X-RateLimit-Remaining":{"description":"Zero when the minute limit is exhausted.","schema":{"type":"integer","format":"int64"}},"X-RateLimit-Reset":{"description":"Unix epoch seconds when the minute limit resets.","schema":{"type":"integer","format":"int64"}}},"content":{"application/json":{"schema":{"$ref":"#/components/schemas/ApiResponseVoid"}}}},"413":{"description":"Request body is too large","headers":{"X-Request-ID":{"description":"Request identifier echoed for support and reconciliation.","schema":{"type":"string"}}},"content":{"application/json":{"schema":{"$ref":"#/components/schemas/ApiResponseVoid"}}}}},"x-dcwallet-signature-versions":["v1","v2"]}},"/api/v1/transfers/requirements":{"get":{"tags":["5. Transfers"],"summary":"Discover transfer fields and current route availability","description":"Returns field suggestions for the selected country, currency, beneficiary and rail. suggestedRails is not a list of supported rails. configuredRails lists advertised channel values; query each concrete rail here to verify policy and route availability. Automatic routes require explicit rail support; manual routes report operator execution without claiming bank-rail support. executionMode distinguishes api/manual and simulated identifies automatic platform sandbox simulation. Submission applies the same rail-aware routing plus policy and balance checks. For conditional documents call POST /transfers/document-requirements/preview.\n\nSignature versions: v2 only.","operationId":"getTransfersRequirements","parameters":[{"name":"country","in":"query","description":"The country value for this resource.","required":true,"schema":{"type":"string"}},{"name":"currency","in":"query","description":"Optional ISO currency or enabled asset-code filter.","required":true,"schema":{"type":"string"}},{"name":"beneficiaryType","in":"query","description":"individual = natural person; business = company. Defaults to individual.","required":false,"schema":{"type":"string","enum":["individual","business"],"default":"individual"}},{"name":"paymentRail","in":"query","description":"Dynamic rail identifier. Field suggestions include ACH, FEDWIRE, SWIFT, CHATS, CHAPS, SEPA and CNAPS where applicable; these examples do not prove channel support. Defaults to the first suggestedRail in this preview when omitted; POST /transfers can infer another rail from actual recipient details. Query this endpoint with a concrete rail and amount to inspect availability.","required":false,"schema":{"type":"string"}},{"name":"amount","in":"query","description":"The amount value for this resource.","required":false,"schema":{"type":"number"}},{"name":"X-Timestamp","in":"header","description":"Current Unix epoch time in seconds. Requests older or newer than five minutes are rejected.","required":true,"schema":{"pattern":"[0-9]{10}","type":"string","example":"1787562000"}},{"name":"X-Request-ID","in":"header","description":"Unique 16-128 character request identifier used for replay protection; never reuse it for a different HTTP request.","required":true,"schema":{"pattern":"[A-Za-z0-9._:-]{16,128}","type":"string","example":"018f6f4e-8f62-7fc2-9c4b-7be2f4203b6a"}},{"name":"X-Content-SHA256","in":"header","description":"Lowercase hexadecimal SHA-256 digest of the exact raw request body; use the digest of zero bytes when no body is sent.","required":true,"schema":{"pattern":"[0-9a-f]{64}","type":"string","example":"e3b0c44298fc1c149afbf4c8996fb92427ae41e4649b934ca495991b7852b855"}},{"name":"X-Workspace","in":"header","description":"Select enterprise:<id> using your own ID from GET /api/v1/workspaces; personal is unavailable for this operation.","required":true,"schema":{"pattern":"personal|enterprise:[1-9][0-9]*","type":"string","example":null}},{"name":"X-Environment","in":"header","description":"Signed key environment: live or sandbox.","required":true,"schema":{"pattern":"live|sandbox","type":"string","example":"live"}},{"name":"X-Signature","in":"header","description":"v2-prefixed lowercase HMAC-SHA256 signature; existing and new keys can use v2 when enabled.","required":true,"schema":{"pattern":"v2=[0-9a-f]{64}","type":"string","example":"v2=0123456789abcdef0123456789abcdef0123456789abcdef0123456789abcdef"}},{"name":"Accept-Language","in":"header","description":"Response language: en-US = English (default); zh-CN = Simplified Chinese; zh-TW = Traditional Chinese. Numeric error codes are language-neutral.","required":false,"schema":{"type":"string","enum":["en-US","zh-CN","zh-TW"],"default":"en-US"}}],"responses":{"400":{"description":"Malformed JSON, missing header or invalid request parameter","headers":{"X-Request-ID":{"description":"Request identifier echoed for support and reconciliation.","schema":{"type":"string"}}},"content":{"application/json":{"schema":{"$ref":"#/components/schemas/ApiResponseVoid"}}}},"500":{"description":"Unexpected internal error; contact support with X-Request-ID","headers":{"X-Request-ID":{"description":"Request identifier echoed for support and reconciliation.","schema":{"type":"string"}}},"content":{"application/json":{"schema":{"$ref":"#/components/schemas/ApiResponseVoid"}}}},"403":{"description":"API-key scope, subscription, tenant or policy does not allow the operation","headers":{"X-Request-ID":{"description":"Request identifier echoed for support and reconciliation.","schema":{"type":"string"}}},"content":{"application/json":{"schema":{"$ref":"#/components/schemas/ApiResponseVoid"}}}},"200":{"description":"OK","headers":{"X-Request-ID":{"description":"Request identifier echoed for support and reconciliation.","schema":{"type":"string"}},"X-Quota-Limit":{"description":"Monthly API request allowance for the subscription.","schema":{"type":"integer","format":"int64"}},"X-Quota-Remaining":{"description":"Requests remaining in the current monthly allowance after this request.","schema":{"type":"integer","format":"int64"}},"X-Quota-Reset":{"description":"Unix epoch time in seconds when the monthly allowance resets.","schema":{"type":"integer","format":"int64"}},"X-Quota-Workspace":{"description":"Verified workspace owning this allowance: personal or enterprise:<id>.","schema":{"type":"string"}},"X-Quota-Environment":{"description":"Environment owning the allowance: sandbox or live.","schema":{"type":"string"}}},"content":{"application/json":{"schema":{"$ref":"#/components/schemas/ApiResponseRequirements"}}}},"401":{"description":"Invalid API key, content hash, signature, timestamp or request ID","headers":{"X-Request-ID":{"description":"Request identifier echoed for support and reconciliation.","schema":{"type":"string"}}},"content":{"application/json":{"schema":{"$ref":"#/components/schemas/ApiResponseVoid"}}}},"404":{"description":"Resource not found in this enterprise and environment","headers":{"X-Request-ID":{"description":"Request identifier echoed for support and reconciliation.","schema":{"type":"string"}}},"content":{"application/json":{"schema":{"$ref":"#/components/schemas/ApiResponseVoid"}}}},"422":{"description":"Business rule rejected the request","headers":{"X-Request-ID":{"description":"Request identifier echoed for support and reconciliation.","schema":{"type":"string"}}},"content":{"application/json":{"schema":{"$ref":"#/components/schemas/ApiResponseVoid"}}}},"503":{"description":"A required platform service is temporarily unavailable","headers":{"X-Request-ID":{"description":"Request identifier echoed for support and reconciliation.","schema":{"type":"string"}}},"content":{"application/json":{"schema":{"$ref":"#/components/schemas/ApiResponseVoid"}}}},"409":{"description":"Idempotency or resource-state conflict","headers":{"X-Request-ID":{"description":"Request identifier echoed for support and reconciliation.","schema":{"type":"string"}}},"content":{"application/json":{"schema":{"$ref":"#/components/schemas/ApiResponseVoid"}}}},"429":{"description":"Per-minute rate limit or monthly quota exceeded","headers":{"X-Request-ID":{"description":"Request identifier echoed for support and reconciliation.","schema":{"type":"string"}},"X-Quota-Limit":{"description":"Monthly API request allowance for the subscription.","schema":{"type":"integer","format":"int64"}},"X-Quota-Remaining":{"description":"Requests remaining in the current monthly allowance after this request.","schema":{"type":"integer","format":"int64"}},"X-Quota-Reset":{"description":"Unix epoch time in seconds when the monthly allowance resets.","schema":{"type":"integer","format":"int64"}},"X-Quota-Workspace":{"description":"Verified workspace owning this allowance: personal or enterprise:<id>.","schema":{"type":"string"}},"X-Quota-Environment":{"description":"Environment owning the allowance: sandbox or live.","schema":{"type":"string"}},"Retry-After":{"description":"Seconds until the exhausted quota or rate window resets. Sign retries with a new X-Request-ID.","schema":{"type":"integer","format":"int64"}},"X-RateLimit-Scope":{"description":"Rate counter scope: workspace, or user for enterprise verification calls.","schema":{"type":"string"}},"X-RateLimit-Limit":{"description":"Per-minute request limit when rate-limited.","schema":{"type":"integer","format":"int64"}},"X-RateLimit-Remaining":{"description":"Zero when the minute limit is exhausted.","schema":{"type":"integer","format":"int64"}},"X-RateLimit-Reset":{"description":"Unix epoch seconds when the minute limit resets.","schema":{"type":"integer","format":"int64"}}},"content":{"application/json":{"schema":{"$ref":"#/components/schemas/ApiResponseVoid"}}}},"413":{"description":"Request body is too large","headers":{"X-Request-ID":{"description":"Request identifier echoed for support and reconciliation.","schema":{"type":"string"}}},"content":{"application/json":{"schema":{"$ref":"#/components/schemas/ApiResponseVoid"}}}}},"x-dcwallet-signature-versions":["v2"]}},"/api/v1/transfer-batches/{batchId}":{"get":{"tags":["5. Transfers"],"summary":"Get an enterprise transfer batch","description":"Signature versions: v1 and v2.","operationId":"getTransferBatchesByBatchId","parameters":[{"name":"batchId","in":"path","description":"The batch id value for this resource.","required":true,"schema":{"pattern":"[0-9]+","type":"string","example":"337893979704000512"}},{"name":"X-Timestamp","in":"header","description":"Current Unix epoch time in seconds. Requests older or newer than five minutes are rejected.","required":true,"schema":{"pattern":"[0-9]{10}","type":"string","example":"1787562000"}},{"name":"X-Request-ID","in":"header","description":"Unique 16-128 character request identifier used for replay protection; never reuse it for a different HTTP request.","required":true,"schema":{"pattern":"[A-Za-z0-9._:-]{16,128}","type":"string","example":"018f6f4e-8f62-7fc2-9c4b-7be2f4203b6a"}},{"name":"X-Content-SHA256","in":"header","description":"Lowercase hexadecimal SHA-256 digest of the exact raw request body; use the digest of zero bytes when no body is sent.","required":true,"schema":{"pattern":"[0-9a-f]{64}","type":"string","example":"e3b0c44298fc1c149afbf4c8996fb92427ae41e4649b934ca495991b7852b855"}},{"name":"X-Workspace","in":"header","description":"Enterprise reads are available on this route. For enterprise access, copy your own enterprise:<id> from GET /api/v1/workspaces. Required for v2 requests. V1 requests use the historical key's fixed enterprise.","required":false,"schema":{"pattern":"personal|enterprise:[1-9][0-9]*","type":"string","example":null}},{"name":"X-Environment","in":"header","description":"Required and signed for v2 requests: live or sandbox. Optional for v1 requests.","required":false,"schema":{"pattern":"live|sandbox","type":"string","example":"live"}},{"name":"X-Signature","in":"header","description":"Existing keys accept v1 for their fixed enterprise or v2 for a signed workspace; new keys accept v2 only.","required":true,"schema":{"pattern":"v[12]=[0-9a-f]{64}","type":"string","example":"v2=0123456789abcdef0123456789abcdef0123456789abcdef0123456789abcdef"}},{"name":"Accept-Language","in":"header","description":"Response language: en-US = English (default); zh-CN = Simplified Chinese; zh-TW = Traditional Chinese. Numeric error codes are language-neutral.","required":false,"schema":{"type":"string","enum":["en-US","zh-CN","zh-TW"],"default":"en-US"}}],"responses":{"400":{"description":"Malformed JSON, missing header or invalid request parameter","headers":{"X-Request-ID":{"description":"Request identifier echoed for support and reconciliation.","schema":{"type":"string"}}},"content":{"application/json":{"schema":{"$ref":"#/components/schemas/ApiResponseVoid"}}}},"500":{"description":"Unexpected internal error; contact support with X-Request-ID","headers":{"X-Request-ID":{"description":"Request identifier echoed for support and reconciliation.","schema":{"type":"string"}}},"content":{"application/json":{"schema":{"$ref":"#/components/schemas/ApiResponseVoid"}}}},"403":{"description":"API-key scope, subscription, tenant or policy does not allow the operation","headers":{"X-Request-ID":{"description":"Request identifier echoed for support and reconciliation.","schema":{"type":"string"}}},"content":{"application/json":{"schema":{"$ref":"#/components/schemas/ApiResponseVoid"}}}},"200":{"description":"OK","headers":{"X-Request-ID":{"description":"Request identifier echoed for support and reconciliation.","schema":{"type":"string"}},"X-Quota-Limit":{"description":"Monthly API request allowance for the subscription.","schema":{"type":"integer","format":"int64"}},"X-Quota-Remaining":{"description":"Requests remaining in the current monthly allowance after this request.","schema":{"type":"integer","format":"int64"}},"X-Quota-Reset":{"description":"Unix epoch time in seconds when the monthly allowance resets.","schema":{"type":"integer","format":"int64"}},"X-Quota-Workspace":{"description":"Verified workspace owning this allowance: personal or enterprise:<id>.","schema":{"type":"string"}},"X-Quota-Environment":{"description":"Environment owning the allowance: sandbox or live.","schema":{"type":"string"}}},"content":{"application/json":{"schema":{"$ref":"#/components/schemas/ApiResponseTransferBatchResponse"}}}},"401":{"description":"Invalid API key, content hash, signature, timestamp or request ID","headers":{"X-Request-ID":{"description":"Request identifier echoed for support and reconciliation.","schema":{"type":"string"}}},"content":{"application/json":{"schema":{"$ref":"#/components/schemas/ApiResponseVoid"}}}},"404":{"description":"Resource not found in this enterprise and environment","headers":{"X-Request-ID":{"description":"Request identifier echoed for support and reconciliation.","schema":{"type":"string"}}},"content":{"application/json":{"schema":{"$ref":"#/components/schemas/ApiResponseVoid"}}}},"422":{"description":"Business rule rejected the request","headers":{"X-Request-ID":{"description":"Request identifier echoed for support and reconciliation.","schema":{"type":"string"}}},"content":{"application/json":{"schema":{"$ref":"#/components/schemas/ApiResponseVoid"}}}},"503":{"description":"A required platform service is temporarily unavailable","headers":{"X-Request-ID":{"description":"Request identifier echoed for support and reconciliation.","schema":{"type":"string"}}},"content":{"application/json":{"schema":{"$ref":"#/components/schemas/ApiResponseVoid"}}}},"409":{"description":"Idempotency or resource-state conflict","headers":{"X-Request-ID":{"description":"Request identifier echoed for support and reconciliation.","schema":{"type":"string"}}},"content":{"application/json":{"schema":{"$ref":"#/components/schemas/ApiResponseVoid"}}}},"429":{"description":"Per-minute rate limit or monthly quota exceeded","headers":{"X-Request-ID":{"description":"Request identifier echoed for support and reconciliation.","schema":{"type":"string"}},"X-Quota-Limit":{"description":"Monthly API request allowance for the subscription.","schema":{"type":"integer","format":"int64"}},"X-Quota-Remaining":{"description":"Requests remaining in the current monthly allowance after this request.","schema":{"type":"integer","format":"int64"}},"X-Quota-Reset":{"description":"Unix epoch time in seconds when the monthly allowance resets.","schema":{"type":"integer","format":"int64"}},"X-Quota-Workspace":{"description":"Verified workspace owning this allowance: personal or enterprise:<id>.","schema":{"type":"string"}},"X-Quota-Environment":{"description":"Environment owning the allowance: sandbox or live.","schema":{"type":"string"}},"Retry-After":{"description":"Seconds until the exhausted quota or rate window resets. Sign retries with a new X-Request-ID.","schema":{"type":"integer","format":"int64"}},"X-RateLimit-Scope":{"description":"Rate counter scope: workspace, or user for enterprise verification calls.","schema":{"type":"string"}},"X-RateLimit-Limit":{"description":"Per-minute request limit when rate-limited.","schema":{"type":"integer","format":"int64"}},"X-RateLimit-Remaining":{"description":"Zero when the minute limit is exhausted.","schema":{"type":"integer","format":"int64"}},"X-RateLimit-Reset":{"description":"Unix epoch seconds when the minute limit resets.","schema":{"type":"integer","format":"int64"}}},"content":{"application/json":{"schema":{"$ref":"#/components/schemas/ApiResponseVoid"}}}},"413":{"description":"Request body is too large","headers":{"X-Request-ID":{"description":"Request identifier echoed for support and reconciliation.","schema":{"type":"string"}}},"content":{"application/json":{"schema":{"$ref":"#/components/schemas/ApiResponseVoid"}}}}},"x-dcwallet-signature-versions":["v1","v2"]}},"/api/v1/payment-records":{"get":{"tags":["4. Receivables"],"summary":"List payment records in the selected workspace","description":"Poll for direct bank and blockchain receipts as well as invoice and payment-link payments. Use paymentMethod to interpret each row: bank details apply to fiat receipts and network/txHash apply to blockchain receipts; conditional details can be null. An enterprise may also subscribe to payment.settled webhooks.\n\nSignature versions: v1 and v2.","operationId":"getPaymentRecords","parameters":[{"name":"status","in":"query","description":"Optional filter. Payment state: pending_payment = awaiting payer; paying = checkout in progress; pending_settlement = received but not yet credited, often pending AML review; settled = credited; failed = unsuccessful; refunded = returned to payer; reversed = previously credited funds reversed. Default for a new payment: pending_payment. Terminal for this payment: failed, refunded, reversed. A settled payment can later become refunded or reversed.","required":false,"schema":{"type":"string","enum":["pending_payment","paying","pending_settlement","settled","failed","refunded","reversed"]}},{"name":"paymentMethod","in":"query","description":"Optional filter. Payment method: crypto = blockchain receipt; fiat = bank receipt. The underlying record defaults to crypto when unspecified.","required":false,"schema":{"type":"string","enum":["crypto","fiat"]}},{"name":"currency","in":"query","description":"Optional ISO currency or enabled asset-code filter.","required":false,"schema":{"type":"string"}},{"name":"invoiceId","in":"query","description":"Invoice ID returned by /api/v1/invoices. Keep IDs as strings.","required":false,"schema":{"type":"string"}},{"name":"paymentLinkId","in":"query","description":"Payment-link ID returned by /api/v1/payment-links. Keep IDs as strings.","required":false,"schema":{"type":"string"}},{"name":"page","in":"query","description":"One-based result page number.","required":false,"schema":{"type":"integer","format":"int32","default":1}},{"name":"pageSize","in":"query","description":"Maximum records returned per page; values above 100 are capped.","required":false,"schema":{"type":"integer","format":"int32","default":20}},{"name":"X-Timestamp","in":"header","description":"Current Unix epoch time in seconds. Requests older or newer than five minutes are rejected.","required":true,"schema":{"pattern":"[0-9]{10}","type":"string","example":"1787562000"}},{"name":"X-Request-ID","in":"header","description":"Unique 16-128 character request identifier used for replay protection; never reuse it for a different HTTP request.","required":true,"schema":{"pattern":"[A-Za-z0-9._:-]{16,128}","type":"string","example":"018f6f4e-8f62-7fc2-9c4b-7be2f4203b6a"}},{"name":"X-Content-SHA256","in":"header","description":"Lowercase hexadecimal SHA-256 digest of the exact raw request body; use the digest of zero bytes when no body is sent.","required":true,"schema":{"pattern":"[0-9a-f]{64}","type":"string","example":"e3b0c44298fc1c149afbf4c8996fb92427ae41e4649b934ca495991b7852b855"}},{"name":"X-Workspace","in":"header","description":"Personal and enterprise reads are available on this route. For enterprise access, copy your own enterprise:<id> from GET /api/v1/workspaces. Required for v2 requests. V1 requests use the historical key's fixed enterprise.","required":false,"schema":{"pattern":"personal|enterprise:[1-9][0-9]*","type":"string","example":"personal"}},{"name":"X-Environment","in":"header","description":"Required and signed for v2 requests: live or sandbox. Optional for v1 requests.","required":false,"schema":{"pattern":"live|sandbox","type":"string","example":"live"}},{"name":"X-Signature","in":"header","description":"Existing keys accept v1 for their fixed enterprise or v2 for a signed workspace; new keys accept v2 only.","required":true,"schema":{"pattern":"v[12]=[0-9a-f]{64}","type":"string","example":"v2=0123456789abcdef0123456789abcdef0123456789abcdef0123456789abcdef"}},{"name":"Accept-Language","in":"header","description":"Response language: en-US = English (default); zh-CN = Simplified Chinese; zh-TW = Traditional Chinese. Numeric error codes are language-neutral.","required":false,"schema":{"type":"string","enum":["en-US","zh-CN","zh-TW"],"default":"en-US"}}],"responses":{"400":{"description":"Malformed JSON, missing header or invalid request parameter","headers":{"X-Request-ID":{"description":"Request identifier echoed for support and reconciliation.","schema":{"type":"string"}}},"content":{"application/json":{"schema":{"$ref":"#/components/schemas/ApiResponseVoid"}}}},"500":{"description":"Unexpected internal error; contact support with X-Request-ID","headers":{"X-Request-ID":{"description":"Request identifier echoed for support and reconciliation.","schema":{"type":"string"}}},"content":{"application/json":{"schema":{"$ref":"#/components/schemas/ApiResponseVoid"}}}},"403":{"description":"API-key scope, subscription, tenant or policy does not allow the operation","headers":{"X-Request-ID":{"description":"Request identifier echoed for support and reconciliation.","schema":{"type":"string"}}},"content":{"application/json":{"schema":{"$ref":"#/components/schemas/ApiResponseVoid"}}}},"200":{"description":"OK","headers":{"X-Request-ID":{"description":"Request identifier echoed for support and reconciliation.","schema":{"type":"string"}},"X-Quota-Limit":{"description":"Monthly API request allowance for the subscription.","schema":{"type":"integer","format":"int64"}},"X-Quota-Remaining":{"description":"Requests remaining in the current monthly allowance after this request.","schema":{"type":"integer","format":"int64"}},"X-Quota-Reset":{"description":"Unix epoch time in seconds when the monthly allowance resets.","schema":{"type":"integer","format":"int64"}},"X-Quota-Workspace":{"description":"Verified workspace owning this allowance: personal or enterprise:<id>.","schema":{"type":"string"}},"X-Quota-Environment":{"description":"Environment owning the allowance: sandbox or live.","schema":{"type":"string"}}},"content":{"application/json":{"schema":{"$ref":"#/components/schemas/ApiResponsePageDataPaymentRecordResponse"}}}},"401":{"description":"Invalid API key, content hash, signature, timestamp or request ID","headers":{"X-Request-ID":{"description":"Request identifier echoed for support and reconciliation.","schema":{"type":"string"}}},"content":{"application/json":{"schema":{"$ref":"#/components/schemas/ApiResponseVoid"}}}},"404":{"description":"Resource not found in this enterprise and environment","headers":{"X-Request-ID":{"description":"Request identifier echoed for support and reconciliation.","schema":{"type":"string"}}},"content":{"application/json":{"schema":{"$ref":"#/components/schemas/ApiResponseVoid"}}}},"422":{"description":"Business rule rejected the request","headers":{"X-Request-ID":{"description":"Request identifier echoed for support and reconciliation.","schema":{"type":"string"}}},"content":{"application/json":{"schema":{"$ref":"#/components/schemas/ApiResponseVoid"}}}},"503":{"description":"A required platform service is temporarily unavailable","headers":{"X-Request-ID":{"description":"Request identifier echoed for support and reconciliation.","schema":{"type":"string"}}},"content":{"application/json":{"schema":{"$ref":"#/components/schemas/ApiResponseVoid"}}}},"409":{"description":"Idempotency or resource-state conflict","headers":{"X-Request-ID":{"description":"Request identifier echoed for support and reconciliation.","schema":{"type":"string"}}},"content":{"application/json":{"schema":{"$ref":"#/components/schemas/ApiResponseVoid"}}}},"429":{"description":"Per-minute rate limit or monthly quota exceeded","headers":{"X-Request-ID":{"description":"Request identifier echoed for support and reconciliation.","schema":{"type":"string"}},"X-Quota-Limit":{"description":"Monthly API request allowance for the subscription.","schema":{"type":"integer","format":"int64"}},"X-Quota-Remaining":{"description":"Requests remaining in the current monthly allowance after this request.","schema":{"type":"integer","format":"int64"}},"X-Quota-Reset":{"description":"Unix epoch time in seconds when the monthly allowance resets.","schema":{"type":"integer","format":"int64"}},"X-Quota-Workspace":{"description":"Verified workspace owning this allowance: personal or enterprise:<id>.","schema":{"type":"string"}},"X-Quota-Environment":{"description":"Environment owning the allowance: sandbox or live.","schema":{"type":"string"}},"Retry-After":{"description":"Seconds until the exhausted quota or rate window resets. Sign retries with a new X-Request-ID.","schema":{"type":"integer","format":"int64"}},"X-RateLimit-Scope":{"description":"Rate counter scope: workspace, or user for enterprise verification calls.","schema":{"type":"string"}},"X-RateLimit-Limit":{"description":"Per-minute request limit when rate-limited.","schema":{"type":"integer","format":"int64"}},"X-RateLimit-Remaining":{"description":"Zero when the minute limit is exhausted.","schema":{"type":"integer","format":"int64"}},"X-RateLimit-Reset":{"description":"Unix epoch seconds when the minute limit resets.","schema":{"type":"integer","format":"int64"}}},"content":{"application/json":{"schema":{"$ref":"#/components/schemas/ApiResponseVoid"}}}},"413":{"description":"Request body is too large","headers":{"X-Request-ID":{"description":"Request identifier echoed for support and reconciliation.","schema":{"type":"string"}}},"content":{"application/json":{"schema":{"$ref":"#/components/schemas/ApiResponseVoid"}}}}},"x-dcwallet-signature-versions":["v1","v2"]}},"/api/v1/payment-records/{paymentRecordId}":{"get":{"tags":["4. Receivables"],"summary":"Get a payment record in the selected workspace","description":"Bank and blockchain details are conditional on paymentMethod and may be null.\n\nSignature versions: v1 and v2.","operationId":"getPaymentRecordsByPaymentRecordId","parameters":[{"name":"paymentRecordId","in":"path","description":"Payment-record ID returned by /api/v1/payment-records. Keep IDs as strings.","required":true,"schema":{"pattern":"[0-9]+","type":"string","example":"337893979704000512"}},{"name":"X-Timestamp","in":"header","description":"Current Unix epoch time in seconds. Requests older or newer than five minutes are rejected.","required":true,"schema":{"pattern":"[0-9]{10}","type":"string","example":"1787562000"}},{"name":"X-Request-ID","in":"header","description":"Unique 16-128 character request identifier used for replay protection; never reuse it for a different HTTP request.","required":true,"schema":{"pattern":"[A-Za-z0-9._:-]{16,128}","type":"string","example":"018f6f4e-8f62-7fc2-9c4b-7be2f4203b6a"}},{"name":"X-Content-SHA256","in":"header","description":"Lowercase hexadecimal SHA-256 digest of the exact raw request body; use the digest of zero bytes when no body is sent.","required":true,"schema":{"pattern":"[0-9a-f]{64}","type":"string","example":"e3b0c44298fc1c149afbf4c8996fb92427ae41e4649b934ca495991b7852b855"}},{"name":"X-Workspace","in":"header","description":"Personal and enterprise reads are available on this route. For enterprise access, copy your own enterprise:<id> from GET /api/v1/workspaces. Required for v2 requests. V1 requests use the historical key's fixed enterprise.","required":false,"schema":{"pattern":"personal|enterprise:[1-9][0-9]*","type":"string","example":"personal"}},{"name":"X-Environment","in":"header","description":"Required and signed for v2 requests: live or sandbox. Optional for v1 requests.","required":false,"schema":{"pattern":"live|sandbox","type":"string","example":"live"}},{"name":"X-Signature","in":"header","description":"Existing keys accept v1 for their fixed enterprise or v2 for a signed workspace; new keys accept v2 only.","required":true,"schema":{"pattern":"v[12]=[0-9a-f]{64}","type":"string","example":"v2=0123456789abcdef0123456789abcdef0123456789abcdef0123456789abcdef"}},{"name":"Accept-Language","in":"header","description":"Response language: en-US = English (default); zh-CN = Simplified Chinese; zh-TW = Traditional Chinese. Numeric error codes are language-neutral.","required":false,"schema":{"type":"string","enum":["en-US","zh-CN","zh-TW"],"default":"en-US"}}],"responses":{"400":{"description":"Malformed JSON, missing header or invalid request parameter","headers":{"X-Request-ID":{"description":"Request identifier echoed for support and reconciliation.","schema":{"type":"string"}}},"content":{"application/json":{"schema":{"$ref":"#/components/schemas/ApiResponseVoid"}}}},"500":{"description":"Unexpected internal error; contact support with X-Request-ID","headers":{"X-Request-ID":{"description":"Request identifier echoed for support and reconciliation.","schema":{"type":"string"}}},"content":{"application/json":{"schema":{"$ref":"#/components/schemas/ApiResponseVoid"}}}},"403":{"description":"API-key scope, subscription, tenant or policy does not allow the operation","headers":{"X-Request-ID":{"description":"Request identifier echoed for support and reconciliation.","schema":{"type":"string"}}},"content":{"application/json":{"schema":{"$ref":"#/components/schemas/ApiResponseVoid"}}}},"200":{"description":"OK","headers":{"X-Request-ID":{"description":"Request identifier echoed for support and reconciliation.","schema":{"type":"string"}},"X-Quota-Limit":{"description":"Monthly API request allowance for the subscription.","schema":{"type":"integer","format":"int64"}},"X-Quota-Remaining":{"description":"Requests remaining in the current monthly allowance after this request.","schema":{"type":"integer","format":"int64"}},"X-Quota-Reset":{"description":"Unix epoch time in seconds when the monthly allowance resets.","schema":{"type":"integer","format":"int64"}},"X-Quota-Workspace":{"description":"Verified workspace owning this allowance: personal or enterprise:<id>.","schema":{"type":"string"}},"X-Quota-Environment":{"description":"Environment owning the allowance: sandbox or live.","schema":{"type":"string"}}},"content":{"application/json":{"schema":{"$ref":"#/components/schemas/ApiResponsePaymentRecordResponse"}}}},"401":{"description":"Invalid API key, content hash, signature, timestamp or request ID","headers":{"X-Request-ID":{"description":"Request identifier echoed for support and reconciliation.","schema":{"type":"string"}}},"content":{"application/json":{"schema":{"$ref":"#/components/schemas/ApiResponseVoid"}}}},"404":{"description":"Resource not found in this enterprise and environment","headers":{"X-Request-ID":{"description":"Request identifier echoed for support and reconciliation.","schema":{"type":"string"}}},"content":{"application/json":{"schema":{"$ref":"#/components/schemas/ApiResponseVoid"}}}},"422":{"description":"Business rule rejected the request","headers":{"X-Request-ID":{"description":"Request identifier echoed for support and reconciliation.","schema":{"type":"string"}}},"content":{"application/json":{"schema":{"$ref":"#/components/schemas/ApiResponseVoid"}}}},"503":{"description":"A required platform service is temporarily unavailable","headers":{"X-Request-ID":{"description":"Request identifier echoed for support and reconciliation.","schema":{"type":"string"}}},"content":{"application/json":{"schema":{"$ref":"#/components/schemas/ApiResponseVoid"}}}},"409":{"description":"Idempotency or resource-state conflict","headers":{"X-Request-ID":{"description":"Request identifier echoed for support and reconciliation.","schema":{"type":"string"}}},"content":{"application/json":{"schema":{"$ref":"#/components/schemas/ApiResponseVoid"}}}},"429":{"description":"Per-minute rate limit or monthly quota exceeded","headers":{"X-Request-ID":{"description":"Request identifier echoed for support and reconciliation.","schema":{"type":"string"}},"X-Quota-Limit":{"description":"Monthly API request allowance for the subscription.","schema":{"type":"integer","format":"int64"}},"X-Quota-Remaining":{"description":"Requests remaining in the current monthly allowance after this request.","schema":{"type":"integer","format":"int64"}},"X-Quota-Reset":{"description":"Unix epoch time in seconds when the monthly allowance resets.","schema":{"type":"integer","format":"int64"}},"X-Quota-Workspace":{"description":"Verified workspace owning this allowance: personal or enterprise:<id>.","schema":{"type":"string"}},"X-Quota-Environment":{"description":"Environment owning the allowance: sandbox or live.","schema":{"type":"string"}},"Retry-After":{"description":"Seconds until the exhausted quota or rate window resets. Sign retries with a new X-Request-ID.","schema":{"type":"integer","format":"int64"}},"X-RateLimit-Scope":{"description":"Rate counter scope: workspace, or user for enterprise verification calls.","schema":{"type":"string"}},"X-RateLimit-Limit":{"description":"Per-minute request limit when rate-limited.","schema":{"type":"integer","format":"int64"}},"X-RateLimit-Remaining":{"description":"Zero when the minute limit is exhausted.","schema":{"type":"integer","format":"int64"}},"X-RateLimit-Reset":{"description":"Unix epoch seconds when the minute limit resets.","schema":{"type":"integer","format":"int64"}}},"content":{"application/json":{"schema":{"$ref":"#/components/schemas/ApiResponseVoid"}}}},"413":{"description":"Request body is too large","headers":{"X-Request-ID":{"description":"Request identifier echoed for support and reconciliation.","schema":{"type":"string"}}},"content":{"application/json":{"schema":{"$ref":"#/components/schemas/ApiResponseVoid"}}}}},"x-dcwallet-signature-versions":["v1","v2"]}},"/api/v1/payment-links/{linkId}":{"get":{"tags":["4. Receivables"],"summary":"Get an enterprise payment link","description":"Signature versions: v1 and v2.","operationId":"getPaymentLinksByLinkId","parameters":[{"name":"linkId","in":"path","description":"Payment-link ID returned by /api/v1/payment-links. Keep IDs as strings.","required":true,"schema":{"pattern":"[0-9]+","type":"string","example":"337893979704000512"}},{"name":"X-Timestamp","in":"header","description":"Current Unix epoch time in seconds. Requests older or newer than five minutes are rejected.","required":true,"schema":{"pattern":"[0-9]{10}","type":"string","example":"1787562000"}},{"name":"X-Request-ID","in":"header","description":"Unique 16-128 character request identifier used for replay protection; never reuse it for a different HTTP request.","required":true,"schema":{"pattern":"[A-Za-z0-9._:-]{16,128}","type":"string","example":"018f6f4e-8f62-7fc2-9c4b-7be2f4203b6a"}},{"name":"X-Content-SHA256","in":"header","description":"Lowercase hexadecimal SHA-256 digest of the exact raw request body; use the digest of zero bytes when no body is sent.","required":true,"schema":{"pattern":"[0-9a-f]{64}","type":"string","example":"e3b0c44298fc1c149afbf4c8996fb92427ae41e4649b934ca495991b7852b855"}},{"name":"X-Workspace","in":"header","description":"Enterprise reads are available on this route. For enterprise access, copy your own enterprise:<id> from GET /api/v1/workspaces. Required for v2 requests. V1 requests use the historical key's fixed enterprise.","required":false,"schema":{"pattern":"personal|enterprise:[1-9][0-9]*","type":"string","example":null}},{"name":"X-Environment","in":"header","description":"Required and signed for v2 requests: live or sandbox. Optional for v1 requests.","required":false,"schema":{"pattern":"live|sandbox","type":"string","example":"live"}},{"name":"X-Signature","in":"header","description":"Existing keys accept v1 for their fixed enterprise or v2 for a signed workspace; new keys accept v2 only.","required":true,"schema":{"pattern":"v[12]=[0-9a-f]{64}","type":"string","example":"v2=0123456789abcdef0123456789abcdef0123456789abcdef0123456789abcdef"}},{"name":"Accept-Language","in":"header","description":"Response language: en-US = English (default); zh-CN = Simplified Chinese; zh-TW = Traditional Chinese. Numeric error codes are language-neutral.","required":false,"schema":{"type":"string","enum":["en-US","zh-CN","zh-TW"],"default":"en-US"}}],"responses":{"400":{"description":"Malformed JSON, missing header or invalid request parameter","headers":{"X-Request-ID":{"description":"Request identifier echoed for support and reconciliation.","schema":{"type":"string"}}},"content":{"application/json":{"schema":{"$ref":"#/components/schemas/ApiResponseVoid"}}}},"500":{"description":"Unexpected internal error; contact support with X-Request-ID","headers":{"X-Request-ID":{"description":"Request identifier echoed for support and reconciliation.","schema":{"type":"string"}}},"content":{"application/json":{"schema":{"$ref":"#/components/schemas/ApiResponseVoid"}}}},"403":{"description":"API-key scope, subscription, tenant or policy does not allow the operation","headers":{"X-Request-ID":{"description":"Request identifier echoed for support and reconciliation.","schema":{"type":"string"}}},"content":{"application/json":{"schema":{"$ref":"#/components/schemas/ApiResponseVoid"}}}},"200":{"description":"OK","headers":{"X-Request-ID":{"description":"Request identifier echoed for support and reconciliation.","schema":{"type":"string"}},"X-Quota-Limit":{"description":"Monthly API request allowance for the subscription.","schema":{"type":"integer","format":"int64"}},"X-Quota-Remaining":{"description":"Requests remaining in the current monthly allowance after this request.","schema":{"type":"integer","format":"int64"}},"X-Quota-Reset":{"description":"Unix epoch time in seconds when the monthly allowance resets.","schema":{"type":"integer","format":"int64"}},"X-Quota-Workspace":{"description":"Verified workspace owning this allowance: personal or enterprise:<id>.","schema":{"type":"string"}},"X-Quota-Environment":{"description":"Environment owning the allowance: sandbox or live.","schema":{"type":"string"}}},"content":{"application/json":{"schema":{"$ref":"#/components/schemas/ApiResponsePaymentLinkResponse"}}}},"401":{"description":"Invalid API key, content hash, signature, timestamp or request ID","headers":{"X-Request-ID":{"description":"Request identifier echoed for support and reconciliation.","schema":{"type":"string"}}},"content":{"application/json":{"schema":{"$ref":"#/components/schemas/ApiResponseVoid"}}}},"404":{"description":"Resource not found in this enterprise and environment","headers":{"X-Request-ID":{"description":"Request identifier echoed for support and reconciliation.","schema":{"type":"string"}}},"content":{"application/json":{"schema":{"$ref":"#/components/schemas/ApiResponseVoid"}}}},"422":{"description":"Business rule rejected the request","headers":{"X-Request-ID":{"description":"Request identifier echoed for support and reconciliation.","schema":{"type":"string"}}},"content":{"application/json":{"schema":{"$ref":"#/components/schemas/ApiResponseVoid"}}}},"503":{"description":"A required platform service is temporarily unavailable","headers":{"X-Request-ID":{"description":"Request identifier echoed for support and reconciliation.","schema":{"type":"string"}}},"content":{"application/json":{"schema":{"$ref":"#/components/schemas/ApiResponseVoid"}}}},"409":{"description":"Idempotency or resource-state conflict","headers":{"X-Request-ID":{"description":"Request identifier echoed for support and reconciliation.","schema":{"type":"string"}}},"content":{"application/json":{"schema":{"$ref":"#/components/schemas/ApiResponseVoid"}}}},"429":{"description":"Per-minute rate limit or monthly quota exceeded","headers":{"X-Request-ID":{"description":"Request identifier echoed for support and reconciliation.","schema":{"type":"string"}},"X-Quota-Limit":{"description":"Monthly API request allowance for the subscription.","schema":{"type":"integer","format":"int64"}},"X-Quota-Remaining":{"description":"Requests remaining in the current monthly allowance after this request.","schema":{"type":"integer","format":"int64"}},"X-Quota-Reset":{"description":"Unix epoch time in seconds when the monthly allowance resets.","schema":{"type":"integer","format":"int64"}},"X-Quota-Workspace":{"description":"Verified workspace owning this allowance: personal or enterprise:<id>.","schema":{"type":"string"}},"X-Quota-Environment":{"description":"Environment owning the allowance: sandbox or live.","schema":{"type":"string"}},"Retry-After":{"description":"Seconds until the exhausted quota or rate window resets. Sign retries with a new X-Request-ID.","schema":{"type":"integer","format":"int64"}},"X-RateLimit-Scope":{"description":"Rate counter scope: workspace, or user for enterprise verification calls.","schema":{"type":"string"}},"X-RateLimit-Limit":{"description":"Per-minute request limit when rate-limited.","schema":{"type":"integer","format":"int64"}},"X-RateLimit-Remaining":{"description":"Zero when the minute limit is exhausted.","schema":{"type":"integer","format":"int64"}},"X-RateLimit-Reset":{"description":"Unix epoch seconds when the minute limit resets.","schema":{"type":"integer","format":"int64"}}},"content":{"application/json":{"schema":{"$ref":"#/components/schemas/ApiResponseVoid"}}}},"413":{"description":"Request body is too large","headers":{"X-Request-ID":{"description":"Request identifier echoed for support and reconciliation.","schema":{"type":"string"}}},"content":{"application/json":{"schema":{"$ref":"#/components/schemas/ApiResponseVoid"}}}}},"x-dcwallet-signature-versions":["v1","v2"]}},"/api/v1/exchange/rates":{"get":{"tags":["4a. Exchange"],"summary":"Get an indicative exchange rate","description":"This rate does not reserve funds or guarantee execution. Requote when submitting an exchange through an approved workflow.\n\nSignature versions: v1 and v2.","operationId":"getExchangeRates","parameters":[{"name":"from","in":"query","description":"The from value for this resource.","required":true,"schema":{"type":"string"}},{"name":"to","in":"query","description":"The to value for this resource.","required":true,"schema":{"type":"string"}},{"name":"amount","in":"query","description":"The amount value for this resource.","required":false,"schema":{"type":"number"}},{"name":"X-Timestamp","in":"header","description":"Current Unix epoch time in seconds. Requests older or newer than five minutes are rejected.","required":true,"schema":{"pattern":"[0-9]{10}","type":"string","example":"1787562000"}},{"name":"X-Request-ID","in":"header","description":"Unique 16-128 character request identifier used for replay protection; never reuse it for a different HTTP request.","required":true,"schema":{"pattern":"[A-Za-z0-9._:-]{16,128}","type":"string","example":"018f6f4e-8f62-7fc2-9c4b-7be2f4203b6a"}},{"name":"X-Content-SHA256","in":"header","description":"Lowercase hexadecimal SHA-256 digest of the exact raw request body; use the digest of zero bytes when no body is sent.","required":true,"schema":{"pattern":"[0-9a-f]{64}","type":"string","example":"e3b0c44298fc1c149afbf4c8996fb92427ae41e4649b934ca495991b7852b855"}},{"name":"X-Workspace","in":"header","description":"Enterprise reads are available on this route. For enterprise access, copy your own enterprise:<id> from GET /api/v1/workspaces. Required for v2 requests. V1 requests use the historical key's fixed enterprise.","required":false,"schema":{"pattern":"personal|enterprise:[1-9][0-9]*","type":"string","example":null}},{"name":"X-Environment","in":"header","description":"Required and signed for v2 requests: live or sandbox. Optional for v1 requests.","required":false,"schema":{"pattern":"live|sandbox","type":"string","example":"live"}},{"name":"X-Signature","in":"header","description":"Existing keys accept v1 for their fixed enterprise or v2 for a signed workspace; new keys accept v2 only.","required":true,"schema":{"pattern":"v[12]=[0-9a-f]{64}","type":"string","example":"v2=0123456789abcdef0123456789abcdef0123456789abcdef0123456789abcdef"}},{"name":"Accept-Language","in":"header","description":"Response language: en-US = English (default); zh-CN = Simplified Chinese; zh-TW = Traditional Chinese. Numeric error codes are language-neutral.","required":false,"schema":{"type":"string","enum":["en-US","zh-CN","zh-TW"],"default":"en-US"}}],"responses":{"400":{"description":"Malformed JSON, missing header or invalid request parameter","headers":{"X-Request-ID":{"description":"Request identifier echoed for support and reconciliation.","schema":{"type":"string"}}},"content":{"application/json":{"schema":{"$ref":"#/components/schemas/ApiResponseVoid"}}}},"500":{"description":"Unexpected internal error; contact support with X-Request-ID","headers":{"X-Request-ID":{"description":"Request identifier echoed for support and reconciliation.","schema":{"type":"string"}}},"content":{"application/json":{"schema":{"$ref":"#/components/schemas/ApiResponseVoid"}}}},"403":{"description":"API-key scope, subscription, tenant or policy does not allow the operation","headers":{"X-Request-ID":{"description":"Request identifier echoed for support and reconciliation.","schema":{"type":"string"}}},"content":{"application/json":{"schema":{"$ref":"#/components/schemas/ApiResponseVoid"}}}},"200":{"description":"OK","headers":{"X-Request-ID":{"description":"Request identifier echoed for support and reconciliation.","schema":{"type":"string"}},"X-Quota-Limit":{"description":"Monthly API request allowance for the subscription.","schema":{"type":"integer","format":"int64"}},"X-Quota-Remaining":{"description":"Requests remaining in the current monthly allowance after this request.","schema":{"type":"integer","format":"int64"}},"X-Quota-Reset":{"description":"Unix epoch time in seconds when the monthly allowance resets.","schema":{"type":"integer","format":"int64"}},"X-Quota-Workspace":{"description":"Verified workspace owning this allowance: personal or enterprise:<id>.","schema":{"type":"string"}},"X-Quota-Environment":{"description":"Environment owning the allowance: sandbox or live.","schema":{"type":"string"}}},"content":{"application/json":{"schema":{"$ref":"#/components/schemas/ApiResponseExchangeRateResponse"}}}},"401":{"description":"Invalid API key, content hash, signature, timestamp or request ID","headers":{"X-Request-ID":{"description":"Request identifier echoed for support and reconciliation.","schema":{"type":"string"}}},"content":{"application/json":{"schema":{"$ref":"#/components/schemas/ApiResponseVoid"}}}},"404":{"description":"Resource not found in this enterprise and environment","headers":{"X-Request-ID":{"description":"Request identifier echoed for support and reconciliation.","schema":{"type":"string"}}},"content":{"application/json":{"schema":{"$ref":"#/components/schemas/ApiResponseVoid"}}}},"422":{"description":"Business rule rejected the request","headers":{"X-Request-ID":{"description":"Request identifier echoed for support and reconciliation.","schema":{"type":"string"}}},"content":{"application/json":{"schema":{"$ref":"#/components/schemas/ApiResponseVoid"}}}},"503":{"description":"A required platform service is temporarily unavailable","headers":{"X-Request-ID":{"description":"Request identifier echoed for support and reconciliation.","schema":{"type":"string"}}},"content":{"application/json":{"schema":{"$ref":"#/components/schemas/ApiResponseVoid"}}}},"409":{"description":"Idempotency or resource-state conflict","headers":{"X-Request-ID":{"description":"Request identifier echoed for support and reconciliation.","schema":{"type":"string"}}},"content":{"application/json":{"schema":{"$ref":"#/components/schemas/ApiResponseVoid"}}}},"429":{"description":"Per-minute rate limit or monthly quota exceeded","headers":{"X-Request-ID":{"description":"Request identifier echoed for support and reconciliation.","schema":{"type":"string"}},"X-Quota-Limit":{"description":"Monthly API request allowance for the subscription.","schema":{"type":"integer","format":"int64"}},"X-Quota-Remaining":{"description":"Requests remaining in the current monthly allowance after this request.","schema":{"type":"integer","format":"int64"}},"X-Quota-Reset":{"description":"Unix epoch time in seconds when the monthly allowance resets.","schema":{"type":"integer","format":"int64"}},"X-Quota-Workspace":{"description":"Verified workspace owning this allowance: personal or enterprise:<id>.","schema":{"type":"string"}},"X-Quota-Environment":{"description":"Environment owning the allowance: sandbox or live.","schema":{"type":"string"}},"Retry-After":{"description":"Seconds until the exhausted quota or rate window resets. Sign retries with a new X-Request-ID.","schema":{"type":"integer","format":"int64"}},"X-RateLimit-Scope":{"description":"Rate counter scope: workspace, or user for enterprise verification calls.","schema":{"type":"string"}},"X-RateLimit-Limit":{"description":"Per-minute request limit when rate-limited.","schema":{"type":"integer","format":"int64"}},"X-RateLimit-Remaining":{"description":"Zero when the minute limit is exhausted.","schema":{"type":"integer","format":"int64"}},"X-RateLimit-Reset":{"description":"Unix epoch seconds when the minute limit resets.","schema":{"type":"integer","format":"int64"}}},"content":{"application/json":{"schema":{"$ref":"#/components/schemas/ApiResponseVoid"}}}},"413":{"description":"Request body is too large","headers":{"X-Request-ID":{"description":"Request identifier echoed for support and reconciliation.","schema":{"type":"string"}}},"content":{"application/json":{"schema":{"$ref":"#/components/schemas/ApiResponseVoid"}}}}},"x-dcwallet-signature-versions":["v1","v2"]}},"/api/v1/exchange/pairs":{"get":{"tags":["4a. Exchange"],"summary":"List enabled exchange pairs","description":"Signature versions: v1 and v2.","operationId":"getExchangePairs","parameters":[{"name":"X-Timestamp","in":"header","description":"Current Unix epoch time in seconds. Requests older or newer than five minutes are rejected.","required":true,"schema":{"pattern":"[0-9]{10}","type":"string","example":"1787562000"}},{"name":"X-Request-ID","in":"header","description":"Unique 16-128 character request identifier used for replay protection; never reuse it for a different HTTP request.","required":true,"schema":{"pattern":"[A-Za-z0-9._:-]{16,128}","type":"string","example":"018f6f4e-8f62-7fc2-9c4b-7be2f4203b6a"}},{"name":"X-Content-SHA256","in":"header","description":"Lowercase hexadecimal SHA-256 digest of the exact raw request body; use the digest of zero bytes when no body is sent.","required":true,"schema":{"pattern":"[0-9a-f]{64}","type":"string","example":"e3b0c44298fc1c149afbf4c8996fb92427ae41e4649b934ca495991b7852b855"}},{"name":"X-Workspace","in":"header","description":"Enterprise reads are available on this route. For enterprise access, copy your own enterprise:<id> from GET /api/v1/workspaces. Required for v2 requests. V1 requests use the historical key's fixed enterprise.","required":false,"schema":{"pattern":"personal|enterprise:[1-9][0-9]*","type":"string","example":null}},{"name":"X-Environment","in":"header","description":"Required and signed for v2 requests: live or sandbox. Optional for v1 requests.","required":false,"schema":{"pattern":"live|sandbox","type":"string","example":"live"}},{"name":"X-Signature","in":"header","description":"Existing keys accept v1 for their fixed enterprise or v2 for a signed workspace; new keys accept v2 only.","required":true,"schema":{"pattern":"v[12]=[0-9a-f]{64}","type":"string","example":"v2=0123456789abcdef0123456789abcdef0123456789abcdef0123456789abcdef"}},{"name":"Accept-Language","in":"header","description":"Response language: en-US = English (default); zh-CN = Simplified Chinese; zh-TW = Traditional Chinese. Numeric error codes are language-neutral.","required":false,"schema":{"type":"string","enum":["en-US","zh-CN","zh-TW"],"default":"en-US"}}],"responses":{"400":{"description":"Malformed JSON, missing header or invalid request parameter","headers":{"X-Request-ID":{"description":"Request identifier echoed for support and reconciliation.","schema":{"type":"string"}}},"content":{"application/json":{"schema":{"$ref":"#/components/schemas/ApiResponseVoid"}}}},"500":{"description":"Unexpected internal error; contact support with X-Request-ID","headers":{"X-Request-ID":{"description":"Request identifier echoed for support and reconciliation.","schema":{"type":"string"}}},"content":{"application/json":{"schema":{"$ref":"#/components/schemas/ApiResponseVoid"}}}},"403":{"description":"API-key scope, subscription, tenant or policy does not allow the operation","headers":{"X-Request-ID":{"description":"Request identifier echoed for support and reconciliation.","schema":{"type":"string"}}},"content":{"application/json":{"schema":{"$ref":"#/components/schemas/ApiResponseVoid"}}}},"200":{"description":"OK","headers":{"X-Request-ID":{"description":"Request identifier echoed for support and reconciliation.","schema":{"type":"string"}},"X-Quota-Limit":{"description":"Monthly API request allowance for the subscription.","schema":{"type":"integer","format":"int64"}},"X-Quota-Remaining":{"description":"Requests remaining in the current monthly allowance after this request.","schema":{"type":"integer","format":"int64"}},"X-Quota-Reset":{"description":"Unix epoch time in seconds when the monthly allowance resets.","schema":{"type":"integer","format":"int64"}},"X-Quota-Workspace":{"description":"Verified workspace owning this allowance: personal or enterprise:<id>.","schema":{"type":"string"}},"X-Quota-Environment":{"description":"Environment owning the allowance: sandbox or live.","schema":{"type":"string"}}},"content":{"application/json":{"schema":{"$ref":"#/components/schemas/ApiResponseListExchangePairResponse"}}}},"401":{"description":"Invalid API key, content hash, signature, timestamp or request ID","headers":{"X-Request-ID":{"description":"Request identifier echoed for support and reconciliation.","schema":{"type":"string"}}},"content":{"application/json":{"schema":{"$ref":"#/components/schemas/ApiResponseVoid"}}}},"404":{"description":"Resource not found in this enterprise and environment","headers":{"X-Request-ID":{"description":"Request identifier echoed for support and reconciliation.","schema":{"type":"string"}}},"content":{"application/json":{"schema":{"$ref":"#/components/schemas/ApiResponseVoid"}}}},"422":{"description":"Business rule rejected the request","headers":{"X-Request-ID":{"description":"Request identifier echoed for support and reconciliation.","schema":{"type":"string"}}},"content":{"application/json":{"schema":{"$ref":"#/components/schemas/ApiResponseVoid"}}}},"503":{"description":"A required platform service is temporarily unavailable","headers":{"X-Request-ID":{"description":"Request identifier echoed for support and reconciliation.","schema":{"type":"string"}}},"content":{"application/json":{"schema":{"$ref":"#/components/schemas/ApiResponseVoid"}}}},"409":{"description":"Idempotency or resource-state conflict","headers":{"X-Request-ID":{"description":"Request identifier echoed for support and reconciliation.","schema":{"type":"string"}}},"content":{"application/json":{"schema":{"$ref":"#/components/schemas/ApiResponseVoid"}}}},"429":{"description":"Per-minute rate limit or monthly quota exceeded","headers":{"X-Request-ID":{"description":"Request identifier echoed for support and reconciliation.","schema":{"type":"string"}},"X-Quota-Limit":{"description":"Monthly API request allowance for the subscription.","schema":{"type":"integer","format":"int64"}},"X-Quota-Remaining":{"description":"Requests remaining in the current monthly allowance after this request.","schema":{"type":"integer","format":"int64"}},"X-Quota-Reset":{"description":"Unix epoch time in seconds when the monthly allowance resets.","schema":{"type":"integer","format":"int64"}},"X-Quota-Workspace":{"description":"Verified workspace owning this allowance: personal or enterprise:<id>.","schema":{"type":"string"}},"X-Quota-Environment":{"description":"Environment owning the allowance: sandbox or live.","schema":{"type":"string"}},"Retry-After":{"description":"Seconds until the exhausted quota or rate window resets. Sign retries with a new X-Request-ID.","schema":{"type":"integer","format":"int64"}},"X-RateLimit-Scope":{"description":"Rate counter scope: workspace, or user for enterprise verification calls.","schema":{"type":"string"}},"X-RateLimit-Limit":{"description":"Per-minute request limit when rate-limited.","schema":{"type":"integer","format":"int64"}},"X-RateLimit-Remaining":{"description":"Zero when the minute limit is exhausted.","schema":{"type":"integer","format":"int64"}},"X-RateLimit-Reset":{"description":"Unix epoch seconds when the minute limit resets.","schema":{"type":"integer","format":"int64"}}},"content":{"application/json":{"schema":{"$ref":"#/components/schemas/ApiResponseVoid"}}}},"413":{"description":"Request body is too large","headers":{"X-Request-ID":{"description":"Request identifier echoed for support and reconciliation.","schema":{"type":"string"}}},"content":{"application/json":{"schema":{"$ref":"#/components/schemas/ApiResponseVoid"}}}}},"x-dcwallet-signature-versions":["v1","v2"]}},"/api/v1/exchange/orders/{orderId}":{"get":{"tags":["4a. Exchange"],"summary":"Get an enterprise exchange order","description":"Signature versions: v1 and v2.","operationId":"getExchangeOrdersByOrderId","parameters":[{"name":"orderId","in":"path","description":"The order id value for this resource.","required":true,"schema":{"pattern":"[0-9]+","type":"string","example":"337893979704000512"}},{"name":"X-Timestamp","in":"header","description":"Current Unix epoch time in seconds. Requests older or newer than five minutes are rejected.","required":true,"schema":{"pattern":"[0-9]{10}","type":"string","example":"1787562000"}},{"name":"X-Request-ID","in":"header","description":"Unique 16-128 character request identifier used for replay protection; never reuse it for a different HTTP request.","required":true,"schema":{"pattern":"[A-Za-z0-9._:-]{16,128}","type":"string","example":"018f6f4e-8f62-7fc2-9c4b-7be2f4203b6a"}},{"name":"X-Content-SHA256","in":"header","description":"Lowercase hexadecimal SHA-256 digest of the exact raw request body; use the digest of zero bytes when no body is sent.","required":true,"schema":{"pattern":"[0-9a-f]{64}","type":"string","example":"e3b0c44298fc1c149afbf4c8996fb92427ae41e4649b934ca495991b7852b855"}},{"name":"X-Workspace","in":"header","description":"Enterprise reads are available on this route. For enterprise access, copy your own enterprise:<id> from GET /api/v1/workspaces. Required for v2 requests. V1 requests use the historical key's fixed enterprise.","required":false,"schema":{"pattern":"personal|enterprise:[1-9][0-9]*","type":"string","example":null}},{"name":"X-Environment","in":"header","description":"Required and signed for v2 requests: live or sandbox. Optional for v1 requests.","required":false,"schema":{"pattern":"live|sandbox","type":"string","example":"live"}},{"name":"X-Signature","in":"header","description":"Existing keys accept v1 for their fixed enterprise or v2 for a signed workspace; new keys accept v2 only.","required":true,"schema":{"pattern":"v[12]=[0-9a-f]{64}","type":"string","example":"v2=0123456789abcdef0123456789abcdef0123456789abcdef0123456789abcdef"}},{"name":"Accept-Language","in":"header","description":"Response language: en-US = English (default); zh-CN = Simplified Chinese; zh-TW = Traditional Chinese. Numeric error codes are language-neutral.","required":false,"schema":{"type":"string","enum":["en-US","zh-CN","zh-TW"],"default":"en-US"}}],"responses":{"400":{"description":"Malformed JSON, missing header or invalid request parameter","headers":{"X-Request-ID":{"description":"Request identifier echoed for support and reconciliation.","schema":{"type":"string"}}},"content":{"application/json":{"schema":{"$ref":"#/components/schemas/ApiResponseVoid"}}}},"500":{"description":"Unexpected internal error; contact support with X-Request-ID","headers":{"X-Request-ID":{"description":"Request identifier echoed for support and reconciliation.","schema":{"type":"string"}}},"content":{"application/json":{"schema":{"$ref":"#/components/schemas/ApiResponseVoid"}}}},"403":{"description":"API-key scope, subscription, tenant or policy does not allow the operation","headers":{"X-Request-ID":{"description":"Request identifier echoed for support and reconciliation.","schema":{"type":"string"}}},"content":{"application/json":{"schema":{"$ref":"#/components/schemas/ApiResponseVoid"}}}},"200":{"description":"OK","headers":{"X-Request-ID":{"description":"Request identifier echoed for support and reconciliation.","schema":{"type":"string"}},"X-Quota-Limit":{"description":"Monthly API request allowance for the subscription.","schema":{"type":"integer","format":"int64"}},"X-Quota-Remaining":{"description":"Requests remaining in the current monthly allowance after this request.","schema":{"type":"integer","format":"int64"}},"X-Quota-Reset":{"description":"Unix epoch time in seconds when the monthly allowance resets.","schema":{"type":"integer","format":"int64"}},"X-Quota-Workspace":{"description":"Verified workspace owning this allowance: personal or enterprise:<id>.","schema":{"type":"string"}},"X-Quota-Environment":{"description":"Environment owning the allowance: sandbox or live.","schema":{"type":"string"}}},"content":{"application/json":{"schema":{"$ref":"#/components/schemas/ApiResponseOrderResponse"}}}},"401":{"description":"Invalid API key, content hash, signature, timestamp or request ID","headers":{"X-Request-ID":{"description":"Request identifier echoed for support and reconciliation.","schema":{"type":"string"}}},"content":{"application/json":{"schema":{"$ref":"#/components/schemas/ApiResponseVoid"}}}},"404":{"description":"Resource not found in this enterprise and environment","headers":{"X-Request-ID":{"description":"Request identifier echoed for support and reconciliation.","schema":{"type":"string"}}},"content":{"application/json":{"schema":{"$ref":"#/components/schemas/ApiResponseVoid"}}}},"422":{"description":"Business rule rejected the request","headers":{"X-Request-ID":{"description":"Request identifier echoed for support and reconciliation.","schema":{"type":"string"}}},"content":{"application/json":{"schema":{"$ref":"#/components/schemas/ApiResponseVoid"}}}},"503":{"description":"A required platform service is temporarily unavailable","headers":{"X-Request-ID":{"description":"Request identifier echoed for support and reconciliation.","schema":{"type":"string"}}},"content":{"application/json":{"schema":{"$ref":"#/components/schemas/ApiResponseVoid"}}}},"409":{"description":"Idempotency or resource-state conflict","headers":{"X-Request-ID":{"description":"Request identifier echoed for support and reconciliation.","schema":{"type":"string"}}},"content":{"application/json":{"schema":{"$ref":"#/components/schemas/ApiResponseVoid"}}}},"429":{"description":"Per-minute rate limit or monthly quota exceeded","headers":{"X-Request-ID":{"description":"Request identifier echoed for support and reconciliation.","schema":{"type":"string"}},"X-Quota-Limit":{"description":"Monthly API request allowance for the subscription.","schema":{"type":"integer","format":"int64"}},"X-Quota-Remaining":{"description":"Requests remaining in the current monthly allowance after this request.","schema":{"type":"integer","format":"int64"}},"X-Quota-Reset":{"description":"Unix epoch time in seconds when the monthly allowance resets.","schema":{"type":"integer","format":"int64"}},"X-Quota-Workspace":{"description":"Verified workspace owning this allowance: personal or enterprise:<id>.","schema":{"type":"string"}},"X-Quota-Environment":{"description":"Environment owning the allowance: sandbox or live.","schema":{"type":"string"}},"Retry-After":{"description":"Seconds until the exhausted quota or rate window resets. Sign retries with a new X-Request-ID.","schema":{"type":"integer","format":"int64"}},"X-RateLimit-Scope":{"description":"Rate counter scope: workspace, or user for enterprise verification calls.","schema":{"type":"string"}},"X-RateLimit-Limit":{"description":"Per-minute request limit when rate-limited.","schema":{"type":"integer","format":"int64"}},"X-RateLimit-Remaining":{"description":"Zero when the minute limit is exhausted.","schema":{"type":"integer","format":"int64"}},"X-RateLimit-Reset":{"description":"Unix epoch seconds when the minute limit resets.","schema":{"type":"integer","format":"int64"}}},"content":{"application/json":{"schema":{"$ref":"#/components/schemas/ApiResponseVoid"}}}},"413":{"description":"Request body is too large","headers":{"X-Request-ID":{"description":"Request identifier echoed for support and reconciliation.","schema":{"type":"string"}}},"content":{"application/json":{"schema":{"$ref":"#/components/schemas/ApiResponseVoid"}}}}},"x-dcwallet-signature-versions":["v1","v2"]}},"/api/v1/enterprise/verification":{"get":{"tags":["0. Enterprise verification"],"summary":"Get enterprise KYB status for this API key","description":"Legacy status route for issued enterprise keys. Use /api/v1/enterprise-applications for v2 KYB onboarding.\n\nSignature versions: v1 and v2.","operationId":"getEnterpriseVerification","parameters":[{"name":"X-Timestamp","in":"header","description":"Current Unix epoch time in seconds. Requests older or newer than five minutes are rejected.","required":true,"schema":{"pattern":"[0-9]{10}","type":"string","example":"1787562000"}},{"name":"X-Request-ID","in":"header","description":"Unique 16-128 character request identifier used for replay protection; never reuse it for a different HTTP request.","required":true,"schema":{"pattern":"[A-Za-z0-9._:-]{16,128}","type":"string","example":"018f6f4e-8f62-7fc2-9c4b-7be2f4203b6a"}},{"name":"X-Content-SHA256","in":"header","description":"Lowercase hexadecimal SHA-256 digest of the exact raw request body; use the digest of zero bytes when no body is sent.","required":true,"schema":{"pattern":"[0-9a-f]{64}","type":"string","example":"e3b0c44298fc1c149afbf4c8996fb92427ae41e4649b934ca495991b7852b855"}},{"name":"X-Workspace","in":"header","description":"Enterprise reads are available on this route. For enterprise access, copy your own enterprise:<id> from GET /api/v1/workspaces. Required for v2 requests. V1 requests use the historical key's fixed enterprise.","required":false,"schema":{"pattern":"personal|enterprise:[1-9][0-9]*","type":"string","example":null}},{"name":"X-Environment","in":"header","description":"Required and signed for v2 requests: live or sandbox. Optional for v1 requests.","required":false,"schema":{"pattern":"live|sandbox","type":"string","example":"live"}},{"name":"X-Signature","in":"header","description":"Existing keys accept v1 for their fixed enterprise or v2 for a signed workspace; new keys accept v2 only.","required":true,"schema":{"pattern":"v[12]=[0-9a-f]{64}","type":"string","example":"v2=0123456789abcdef0123456789abcdef0123456789abcdef0123456789abcdef"}},{"name":"Accept-Language","in":"header","description":"Response language: en-US = English (default); zh-CN = Simplified Chinese; zh-TW = Traditional Chinese. Numeric error codes are language-neutral.","required":false,"schema":{"type":"string","enum":["en-US","zh-CN","zh-TW"],"default":"en-US"}}],"responses":{"400":{"description":"Malformed JSON, missing header or invalid request parameter","headers":{"X-Request-ID":{"description":"Request identifier echoed for support and reconciliation.","schema":{"type":"string"}}},"content":{"application/json":{"schema":{"$ref":"#/components/schemas/ApiResponseVoid"}}}},"500":{"description":"Unexpected internal error; contact support with X-Request-ID","headers":{"X-Request-ID":{"description":"Request identifier echoed for support and reconciliation.","schema":{"type":"string"}}},"content":{"application/json":{"schema":{"$ref":"#/components/schemas/ApiResponseVoid"}}}},"403":{"description":"API-key scope, subscription, tenant or policy does not allow the operation","headers":{"X-Request-ID":{"description":"Request identifier echoed for support and reconciliation.","schema":{"type":"string"}}},"content":{"application/json":{"schema":{"$ref":"#/components/schemas/ApiResponseVoid"}}}},"200":{"description":"OK","headers":{"X-Request-ID":{"description":"Request identifier echoed for support and reconciliation.","schema":{"type":"string"}},"X-Quota-Limit":{"description":"Monthly API request allowance for the subscription.","schema":{"type":"integer","format":"int64"}},"X-Quota-Remaining":{"description":"Requests remaining in the current monthly allowance after this request.","schema":{"type":"integer","format":"int64"}},"X-Quota-Reset":{"description":"Unix epoch time in seconds when the monthly allowance resets.","schema":{"type":"integer","format":"int64"}},"X-Quota-Workspace":{"description":"Verified workspace owning this allowance: personal or enterprise:<id>.","schema":{"type":"string"}},"X-Quota-Environment":{"description":"Environment owning the allowance: sandbox or live.","schema":{"type":"string"}}},"content":{"application/json":{"schema":{"$ref":"#/components/schemas/ApiResponseVerificationResponse"}}}},"401":{"description":"Invalid API key, content hash, signature, timestamp or request ID","headers":{"X-Request-ID":{"description":"Request identifier echoed for support and reconciliation.","schema":{"type":"string"}}},"content":{"application/json":{"schema":{"$ref":"#/components/schemas/ApiResponseVoid"}}}},"404":{"description":"Resource not found in this enterprise and environment","headers":{"X-Request-ID":{"description":"Request identifier echoed for support and reconciliation.","schema":{"type":"string"}}},"content":{"application/json":{"schema":{"$ref":"#/components/schemas/ApiResponseVoid"}}}},"422":{"description":"Business rule rejected the request","headers":{"X-Request-ID":{"description":"Request identifier echoed for support and reconciliation.","schema":{"type":"string"}}},"content":{"application/json":{"schema":{"$ref":"#/components/schemas/ApiResponseVoid"}}}},"503":{"description":"A required platform service is temporarily unavailable","headers":{"X-Request-ID":{"description":"Request identifier echoed for support and reconciliation.","schema":{"type":"string"}}},"content":{"application/json":{"schema":{"$ref":"#/components/schemas/ApiResponseVoid"}}}},"409":{"description":"Idempotency or resource-state conflict","headers":{"X-Request-ID":{"description":"Request identifier echoed for support and reconciliation.","schema":{"type":"string"}}},"content":{"application/json":{"schema":{"$ref":"#/components/schemas/ApiResponseVoid"}}}},"429":{"description":"Per-minute rate limit or monthly quota exceeded","headers":{"X-Request-ID":{"description":"Request identifier echoed for support and reconciliation.","schema":{"type":"string"}},"X-Quota-Limit":{"description":"Monthly API request allowance for the subscription.","schema":{"type":"integer","format":"int64"}},"X-Quota-Remaining":{"description":"Requests remaining in the current monthly allowance after this request.","schema":{"type":"integer","format":"int64"}},"X-Quota-Reset":{"description":"Unix epoch time in seconds when the monthly allowance resets.","schema":{"type":"integer","format":"int64"}},"X-Quota-Workspace":{"description":"Verified workspace owning this allowance: personal or enterprise:<id>.","schema":{"type":"string"}},"X-Quota-Environment":{"description":"Environment owning the allowance: sandbox or live.","schema":{"type":"string"}},"Retry-After":{"description":"Seconds until the exhausted quota or rate window resets. Sign retries with a new X-Request-ID.","schema":{"type":"integer","format":"int64"}},"X-RateLimit-Scope":{"description":"Rate counter scope: workspace, or user for enterprise verification calls.","schema":{"type":"string"}},"X-RateLimit-Limit":{"description":"Per-minute request limit when rate-limited.","schema":{"type":"integer","format":"int64"}},"X-RateLimit-Remaining":{"description":"Zero when the minute limit is exhausted.","schema":{"type":"integer","format":"int64"}},"X-RateLimit-Reset":{"description":"Unix epoch seconds when the minute limit resets.","schema":{"type":"integer","format":"int64"}}},"content":{"application/json":{"schema":{"$ref":"#/components/schemas/ApiResponseVoid"}}}},"413":{"description":"Request body is too large","headers":{"X-Request-ID":{"description":"Request identifier echoed for support and reconciliation.","schema":{"type":"string"}}},"content":{"application/json":{"schema":{"$ref":"#/components/schemas/ApiResponseVoid"}}}}},"x-dcwallet-signature-versions":["v1","v2"]}},"/api/v1/enterprise-applications/{applicationId}":{"get":{"tags":["0. Enterprise verification"],"summary":"Read the saved KYB submission, people and review status","description":"Signature versions: v2 only.","operationId":"getEnterpriseApplicationsByApplicationId","parameters":[{"name":"applicationId","in":"path","description":"Card application ID returned by /api/v1/card-applications. Keep IDs as strings.","required":true,"schema":{"pattern":"[0-9]+","type":"string","example":"337893979704000512"}},{"name":"X-Timestamp","in":"header","description":"Current Unix epoch time in seconds. Requests older or newer than five minutes are rejected.","required":true,"schema":{"pattern":"[0-9]{10}","type":"string","example":"1787562000"}},{"name":"X-Request-ID","in":"header","description":"Unique 16-128 character request identifier used for replay protection; never reuse it for a different HTTP request.","required":true,"schema":{"pattern":"[A-Za-z0-9._:-]{16,128}","type":"string","example":"018f6f4e-8f62-7fc2-9c4b-7be2f4203b6a"}},{"name":"X-Content-SHA256","in":"header","description":"Lowercase hexadecimal SHA-256 digest of the exact raw request body; use the digest of zero bytes when no body is sent.","required":true,"schema":{"pattern":"[0-9a-f]{64}","type":"string","example":"e3b0c44298fc1c149afbf4c8996fb92427ae41e4649b934ca495991b7852b855"}},{"name":"X-Workspace","in":"header","description":"Select enterprise:<id> using your own ID from GET /api/v1/workspaces; personal is unavailable for this operation.","required":true,"schema":{"pattern":"personal|enterprise:[1-9][0-9]*","type":"string","example":null}},{"name":"X-Environment","in":"header","description":"Signed key environment: live or sandbox.","required":true,"schema":{"pattern":"live|sandbox","type":"string","example":"live"}},{"name":"X-Signature","in":"header","description":"v2-prefixed lowercase HMAC-SHA256 signature; existing and new keys can use v2 when enabled.","required":true,"schema":{"pattern":"v2=[0-9a-f]{64}","type":"string","example":"v2=0123456789abcdef0123456789abcdef0123456789abcdef0123456789abcdef"}},{"name":"Accept-Language","in":"header","description":"Response language: en-US = English (default); zh-CN = Simplified Chinese; zh-TW = Traditional Chinese. Numeric error codes are language-neutral.","required":false,"schema":{"type":"string","enum":["en-US","zh-CN","zh-TW"],"default":"en-US"}}],"responses":{"400":{"description":"Malformed JSON, missing header or invalid request parameter","headers":{"X-Request-ID":{"description":"Request identifier echoed for support and reconciliation.","schema":{"type":"string"}}},"content":{"application/json":{"schema":{"$ref":"#/components/schemas/ApiResponseVoid"}}}},"500":{"description":"Unexpected internal error; contact support with X-Request-ID","headers":{"X-Request-ID":{"description":"Request identifier echoed for support and reconciliation.","schema":{"type":"string"}}},"content":{"application/json":{"schema":{"$ref":"#/components/schemas/ApiResponseVoid"}}}},"403":{"description":"API-key scope, subscription, tenant or policy does not allow the operation","headers":{"X-Request-ID":{"description":"Request identifier echoed for support and reconciliation.","schema":{"type":"string"}}},"content":{"application/json":{"schema":{"$ref":"#/components/schemas/ApiResponseVoid"}}}},"200":{"description":"OK","headers":{"X-Request-ID":{"description":"Request identifier echoed for support and reconciliation.","schema":{"type":"string"}},"X-Quota-Limit":{"description":"Monthly API request allowance for the subscription.","schema":{"type":"integer","format":"int64"}},"X-Quota-Remaining":{"description":"Requests remaining in the current monthly allowance after this request.","schema":{"type":"integer","format":"int64"}},"X-Quota-Reset":{"description":"Unix epoch time in seconds when the monthly allowance resets.","schema":{"type":"integer","format":"int64"}},"X-Quota-Workspace":{"description":"Verified workspace owning this allowance: personal or enterprise:<id>.","schema":{"type":"string"}},"X-Quota-Environment":{"description":"Environment owning the allowance: sandbox or live.","schema":{"type":"string"}}},"content":{"application/json":{"schema":{"$ref":"#/components/schemas/ApiResponseApplicationDetail"}}}},"401":{"description":"Invalid API key, content hash, signature, timestamp or request ID","headers":{"X-Request-ID":{"description":"Request identifier echoed for support and reconciliation.","schema":{"type":"string"}}},"content":{"application/json":{"schema":{"$ref":"#/components/schemas/ApiResponseVoid"}}}},"404":{"description":"Resource not found in this enterprise and environment","headers":{"X-Request-ID":{"description":"Request identifier echoed for support and reconciliation.","schema":{"type":"string"}}},"content":{"application/json":{"schema":{"$ref":"#/components/schemas/ApiResponseVoid"}}}},"422":{"description":"Business rule rejected the request","headers":{"X-Request-ID":{"description":"Request identifier echoed for support and reconciliation.","schema":{"type":"string"}}},"content":{"application/json":{"schema":{"$ref":"#/components/schemas/ApiResponseVoid"}}}},"503":{"description":"A required platform service is temporarily unavailable","headers":{"X-Request-ID":{"description":"Request identifier echoed for support and reconciliation.","schema":{"type":"string"}}},"content":{"application/json":{"schema":{"$ref":"#/components/schemas/ApiResponseVoid"}}}},"409":{"description":"Idempotency or resource-state conflict","headers":{"X-Request-ID":{"description":"Request identifier echoed for support and reconciliation.","schema":{"type":"string"}}},"content":{"application/json":{"schema":{"$ref":"#/components/schemas/ApiResponseVoid"}}}},"429":{"description":"Per-minute rate limit or monthly quota exceeded","headers":{"X-Request-ID":{"description":"Request identifier echoed for support and reconciliation.","schema":{"type":"string"}},"X-Quota-Limit":{"description":"Monthly API request allowance for the subscription.","schema":{"type":"integer","format":"int64"}},"X-Quota-Remaining":{"description":"Requests remaining in the current monthly allowance after this request.","schema":{"type":"integer","format":"int64"}},"X-Quota-Reset":{"description":"Unix epoch time in seconds when the monthly allowance resets.","schema":{"type":"integer","format":"int64"}},"X-Quota-Workspace":{"description":"Verified workspace owning this allowance: personal or enterprise:<id>.","schema":{"type":"string"}},"X-Quota-Environment":{"description":"Environment owning the allowance: sandbox or live.","schema":{"type":"string"}},"Retry-After":{"description":"Seconds until the exhausted quota or rate window resets. Sign retries with a new X-Request-ID.","schema":{"type":"integer","format":"int64"}},"X-RateLimit-Scope":{"description":"Rate counter scope: workspace, or user for enterprise verification calls.","schema":{"type":"string"}},"X-RateLimit-Limit":{"description":"Per-minute request limit when rate-limited.","schema":{"type":"integer","format":"int64"}},"X-RateLimit-Remaining":{"description":"Zero when the minute limit is exhausted.","schema":{"type":"integer","format":"int64"}},"X-RateLimit-Reset":{"description":"Unix epoch seconds when the minute limit resets.","schema":{"type":"integer","format":"int64"}}},"content":{"application/json":{"schema":{"$ref":"#/components/schemas/ApiResponseVoid"}}}},"413":{"description":"Request body is too large","headers":{"X-Request-ID":{"description":"Request identifier echoed for support and reconciliation.","schema":{"type":"string"}}},"content":{"application/json":{"schema":{"$ref":"#/components/schemas/ApiResponseVoid"}}}}},"x-dcwallet-signature-versions":["v2"]}},"/api/v1/enterprise-applications/{applicationId}/documents":{"get":{"tags":["0. Enterprise verification"],"summary":"List uploaded KYB documents and review states","description":"Signature versions: v2 only.","operationId":"getEnterpriseApplicationsByApplicationIdDocuments","parameters":[{"name":"applicationId","in":"path","description":"Card application ID returned by /api/v1/card-applications. Keep IDs as strings.","required":true,"schema":{"pattern":"[0-9]+","type":"string","example":"337893979704000512"}},{"name":"X-Timestamp","in":"header","description":"Current Unix epoch time in seconds. Requests older or newer than five minutes are rejected.","required":true,"schema":{"pattern":"[0-9]{10}","type":"string","example":"1787562000"}},{"name":"X-Request-ID","in":"header","description":"Unique 16-128 character request identifier used for replay protection; never reuse it for a different HTTP request.","required":true,"schema":{"pattern":"[A-Za-z0-9._:-]{16,128}","type":"string","example":"018f6f4e-8f62-7fc2-9c4b-7be2f4203b6a"}},{"name":"X-Content-SHA256","in":"header","description":"Lowercase hexadecimal SHA-256 digest of the exact raw request body; use the digest of zero bytes when no body is sent.","required":true,"schema":{"pattern":"[0-9a-f]{64}","type":"string","example":"e3b0c44298fc1c149afbf4c8996fb92427ae41e4649b934ca495991b7852b855"}},{"name":"X-Workspace","in":"header","description":"Select enterprise:<id> using your own ID from GET /api/v1/workspaces; personal is unavailable for this operation.","required":true,"schema":{"pattern":"personal|enterprise:[1-9][0-9]*","type":"string","example":null}},{"name":"X-Environment","in":"header","description":"Signed key environment: live or sandbox.","required":true,"schema":{"pattern":"live|sandbox","type":"string","example":"live"}},{"name":"X-Signature","in":"header","description":"v2-prefixed lowercase HMAC-SHA256 signature; existing and new keys can use v2 when enabled.","required":true,"schema":{"pattern":"v2=[0-9a-f]{64}","type":"string","example":"v2=0123456789abcdef0123456789abcdef0123456789abcdef0123456789abcdef"}},{"name":"Accept-Language","in":"header","description":"Response language: en-US = English (default); zh-CN = Simplified Chinese; zh-TW = Traditional Chinese. Numeric error codes are language-neutral.","required":false,"schema":{"type":"string","enum":["en-US","zh-CN","zh-TW"],"default":"en-US"}}],"responses":{"400":{"description":"Malformed JSON, missing header or invalid request parameter","headers":{"X-Request-ID":{"description":"Request identifier echoed for support and reconciliation.","schema":{"type":"string"}}},"content":{"application/json":{"schema":{"$ref":"#/components/schemas/ApiResponseVoid"}}}},"500":{"description":"Unexpected internal error; contact support with X-Request-ID","headers":{"X-Request-ID":{"description":"Request identifier echoed for support and reconciliation.","schema":{"type":"string"}}},"content":{"application/json":{"schema":{"$ref":"#/components/schemas/ApiResponseVoid"}}}},"403":{"description":"API-key scope, subscription, tenant or policy does not allow the operation","headers":{"X-Request-ID":{"description":"Request identifier echoed for support and reconciliation.","schema":{"type":"string"}}},"content":{"application/json":{"schema":{"$ref":"#/components/schemas/ApiResponseVoid"}}}},"200":{"description":"OK","headers":{"X-Request-ID":{"description":"Request identifier echoed for support and reconciliation.","schema":{"type":"string"}},"X-Quota-Limit":{"description":"Monthly API request allowance for the subscription.","schema":{"type":"integer","format":"int64"}},"X-Quota-Remaining":{"description":"Requests remaining in the current monthly allowance after this request.","schema":{"type":"integer","format":"int64"}},"X-Quota-Reset":{"description":"Unix epoch time in seconds when the monthly allowance resets.","schema":{"type":"integer","format":"int64"}},"X-Quota-Workspace":{"description":"Verified workspace owning this allowance: personal or enterprise:<id>.","schema":{"type":"string"}},"X-Quota-Environment":{"description":"Environment owning the allowance: sandbox or live.","schema":{"type":"string"}}},"content":{"application/json":{"schema":{"$ref":"#/components/schemas/ApiResponseListDocumentUpload"}}}},"401":{"description":"Invalid API key, content hash, signature, timestamp or request ID","headers":{"X-Request-ID":{"description":"Request identifier echoed for support and reconciliation.","schema":{"type":"string"}}},"content":{"application/json":{"schema":{"$ref":"#/components/schemas/ApiResponseVoid"}}}},"404":{"description":"Resource not found in this enterprise and environment","headers":{"X-Request-ID":{"description":"Request identifier echoed for support and reconciliation.","schema":{"type":"string"}}},"content":{"application/json":{"schema":{"$ref":"#/components/schemas/ApiResponseVoid"}}}},"422":{"description":"Business rule rejected the request","headers":{"X-Request-ID":{"description":"Request identifier echoed for support and reconciliation.","schema":{"type":"string"}}},"content":{"application/json":{"schema":{"$ref":"#/components/schemas/ApiResponseVoid"}}}},"503":{"description":"A required platform service is temporarily unavailable","headers":{"X-Request-ID":{"description":"Request identifier echoed for support and reconciliation.","schema":{"type":"string"}}},"content":{"application/json":{"schema":{"$ref":"#/components/schemas/ApiResponseVoid"}}}},"409":{"description":"Idempotency or resource-state conflict","headers":{"X-Request-ID":{"description":"Request identifier echoed for support and reconciliation.","schema":{"type":"string"}}},"content":{"application/json":{"schema":{"$ref":"#/components/schemas/ApiResponseVoid"}}}},"429":{"description":"Per-minute rate limit or monthly quota exceeded","headers":{"X-Request-ID":{"description":"Request identifier echoed for support and reconciliation.","schema":{"type":"string"}},"X-Quota-Limit":{"description":"Monthly API request allowance for the subscription.","schema":{"type":"integer","format":"int64"}},"X-Quota-Remaining":{"description":"Requests remaining in the current monthly allowance after this request.","schema":{"type":"integer","format":"int64"}},"X-Quota-Reset":{"description":"Unix epoch time in seconds when the monthly allowance resets.","schema":{"type":"integer","format":"int64"}},"X-Quota-Workspace":{"description":"Verified workspace owning this allowance: personal or enterprise:<id>.","schema":{"type":"string"}},"X-Quota-Environment":{"description":"Environment owning the allowance: sandbox or live.","schema":{"type":"string"}},"Retry-After":{"description":"Seconds until the exhausted quota or rate window resets. Sign retries with a new X-Request-ID.","schema":{"type":"integer","format":"int64"}},"X-RateLimit-Scope":{"description":"Rate counter scope: workspace, or user for enterprise verification calls.","schema":{"type":"string"}},"X-RateLimit-Limit":{"description":"Per-minute request limit when rate-limited.","schema":{"type":"integer","format":"int64"}},"X-RateLimit-Remaining":{"description":"Zero when the minute limit is exhausted.","schema":{"type":"integer","format":"int64"}},"X-RateLimit-Reset":{"description":"Unix epoch seconds when the minute limit resets.","schema":{"type":"integer","format":"int64"}}},"content":{"application/json":{"schema":{"$ref":"#/components/schemas/ApiResponseVoid"}}}},"413":{"description":"Request body is too large","headers":{"X-Request-ID":{"description":"Request identifier echoed for support and reconciliation.","schema":{"type":"string"}}},"content":{"application/json":{"schema":{"$ref":"#/components/schemas/ApiResponseVoid"}}}}},"x-dcwallet-signature-versions":["v2"]}},"/api/v1/enterprise-applications/requirements":{"get":{"tags":["0. Enterprise verification"],"summary":"Read KYB field, option and country requirements","description":"Returns selectable values for fixed KYB fields, business type suggestions, country policy and dynamic field definitions. Requires a v2 key with kyb:read. Available in live and sandbox; reading sandbox requirements does not create or alter live KYB records.\n\nSignature versions: v2 only.","operationId":"getEnterpriseApplicationsRequirements","parameters":[{"name":"registrationCountry","in":"query","description":"The registration country value for this resource.","required":false,"schema":{"type":"string"}},{"name":"businessType","in":"query","description":"The business type value for this resource.","required":false,"schema":{"type":"string"}},{"name":"includeEdd","in":"query","description":"The include edd value for this resource.","required":false,"schema":{"type":"boolean","default":false}},{"name":"X-Timestamp","in":"header","description":"Current Unix epoch time in seconds. Requests older or newer than five minutes are rejected.","required":true,"schema":{"pattern":"[0-9]{10}","type":"string","example":"1787562000"}},{"name":"X-Request-ID","in":"header","description":"Unique 16-128 character request identifier used for replay protection; never reuse it for a different HTTP request.","required":true,"schema":{"pattern":"[A-Za-z0-9._:-]{16,128}","type":"string","example":"018f6f4e-8f62-7fc2-9c4b-7be2f4203b6a"}},{"name":"X-Content-SHA256","in":"header","description":"Lowercase hexadecimal SHA-256 digest of the exact raw request body; use the digest of zero bytes when no body is sent.","required":true,"schema":{"pattern":"[0-9a-f]{64}","type":"string","example":"e3b0c44298fc1c149afbf4c8996fb92427ae41e4649b934ca495991b7852b855"}},{"name":"X-Workspace","in":"header","description":"Signed workspace selector: personal or enterprise:<id>. Get your enterprise ID from GET /api/v1/workspaces.","required":true,"schema":{"pattern":"personal|enterprise:[1-9][0-9]*","type":"string","example":"personal"}},{"name":"X-Environment","in":"header","description":"Signed key environment: live or sandbox.","required":true,"schema":{"pattern":"live|sandbox","type":"string","example":"live"}},{"name":"X-Signature","in":"header","description":"v2-prefixed lowercase HMAC-SHA256 signature; existing and new keys can use v2 when enabled.","required":true,"schema":{"pattern":"v2=[0-9a-f]{64}","type":"string","example":"v2=0123456789abcdef0123456789abcdef0123456789abcdef0123456789abcdef"}},{"name":"Accept-Language","in":"header","description":"Response language: en-US = English (default); zh-CN = Simplified Chinese; zh-TW = Traditional Chinese. Numeric error codes are language-neutral.","required":false,"schema":{"type":"string","enum":["en-US","zh-CN","zh-TW"],"default":"en-US"}}],"responses":{"400":{"description":"Malformed JSON, missing header or invalid request parameter","headers":{"X-Request-ID":{"description":"Request identifier echoed for support and reconciliation.","schema":{"type":"string"}}},"content":{"application/json":{"schema":{"$ref":"#/components/schemas/ApiResponseVoid"}}}},"500":{"description":"Unexpected internal error; contact support with X-Request-ID","headers":{"X-Request-ID":{"description":"Request identifier echoed for support and reconciliation.","schema":{"type":"string"}}},"content":{"application/json":{"schema":{"$ref":"#/components/schemas/ApiResponseVoid"}}}},"403":{"description":"API-key scope, subscription, tenant or policy does not allow the operation","headers":{"X-Request-ID":{"description":"Request identifier echoed for support and reconciliation.","schema":{"type":"string"}}},"content":{"application/json":{"schema":{"$ref":"#/components/schemas/ApiResponseVoid"}}}},"200":{"description":"OK","headers":{"X-Request-ID":{"description":"Request identifier echoed for support and reconciliation.","schema":{"type":"string"}},"X-Quota-Limit":{"description":"Monthly API request allowance for the subscription.","schema":{"type":"integer","format":"int64"}},"X-Quota-Remaining":{"description":"Requests remaining in the current monthly allowance after this request.","schema":{"type":"integer","format":"int64"}},"X-Quota-Reset":{"description":"Unix epoch time in seconds when the monthly allowance resets.","schema":{"type":"integer","format":"int64"}},"X-Quota-Workspace":{"description":"Verified workspace owning this allowance: personal or enterprise:<id>.","schema":{"type":"string"}},"X-Quota-Environment":{"description":"Environment owning the allowance: sandbox or live.","schema":{"type":"string"}}},"content":{"application/json":{"schema":{"$ref":"#/components/schemas/ApiResponseMachineKybRequirementsResponse"}}}},"401":{"description":"Invalid API key, content hash, signature, timestamp or request ID","headers":{"X-Request-ID":{"description":"Request identifier echoed for support and reconciliation.","schema":{"type":"string"}}},"content":{"application/json":{"schema":{"$ref":"#/components/schemas/ApiResponseVoid"}}}},"404":{"description":"Resource not found in this enterprise and environment","headers":{"X-Request-ID":{"description":"Request identifier echoed for support and reconciliation.","schema":{"type":"string"}}},"content":{"application/json":{"schema":{"$ref":"#/components/schemas/ApiResponseVoid"}}}},"422":{"description":"Business rule rejected the request","headers":{"X-Request-ID":{"description":"Request identifier echoed for support and reconciliation.","schema":{"type":"string"}}},"content":{"application/json":{"schema":{"$ref":"#/components/schemas/ApiResponseVoid"}}}},"503":{"description":"A required platform service is temporarily unavailable","headers":{"X-Request-ID":{"description":"Request identifier echoed for support and reconciliation.","schema":{"type":"string"}}},"content":{"application/json":{"schema":{"$ref":"#/components/schemas/ApiResponseVoid"}}}},"409":{"description":"Idempotency or resource-state conflict","headers":{"X-Request-ID":{"description":"Request identifier echoed for support and reconciliation.","schema":{"type":"string"}}},"content":{"application/json":{"schema":{"$ref":"#/components/schemas/ApiResponseVoid"}}}},"429":{"description":"Per-minute rate limit or monthly quota exceeded","headers":{"X-Request-ID":{"description":"Request identifier echoed for support and reconciliation.","schema":{"type":"string"}},"X-Quota-Limit":{"description":"Monthly API request allowance for the subscription.","schema":{"type":"integer","format":"int64"}},"X-Quota-Remaining":{"description":"Requests remaining in the current monthly allowance after this request.","schema":{"type":"integer","format":"int64"}},"X-Quota-Reset":{"description":"Unix epoch time in seconds when the monthly allowance resets.","schema":{"type":"integer","format":"int64"}},"X-Quota-Workspace":{"description":"Verified workspace owning this allowance: personal or enterprise:<id>.","schema":{"type":"string"}},"X-Quota-Environment":{"description":"Environment owning the allowance: sandbox or live.","schema":{"type":"string"}},"Retry-After":{"description":"Seconds until the exhausted quota or rate window resets. Sign retries with a new X-Request-ID.","schema":{"type":"integer","format":"int64"}},"X-RateLimit-Scope":{"description":"Rate counter scope: workspace, or user for enterprise verification calls.","schema":{"type":"string"}},"X-RateLimit-Limit":{"description":"Per-minute request limit when rate-limited.","schema":{"type":"integer","format":"int64"}},"X-RateLimit-Remaining":{"description":"Zero when the minute limit is exhausted.","schema":{"type":"integer","format":"int64"}},"X-RateLimit-Reset":{"description":"Unix epoch seconds when the minute limit resets.","schema":{"type":"integer","format":"int64"}}},"content":{"application/json":{"schema":{"$ref":"#/components/schemas/ApiResponseVoid"}}}},"413":{"description":"Request body is too large","headers":{"X-Request-ID":{"description":"Request identifier echoed for support and reconciliation.","schema":{"type":"string"}}},"content":{"application/json":{"schema":{"$ref":"#/components/schemas/ApiResponseVoid"}}}}},"x-dcwallet-signature-versions":["v2"]}},"/api/v1/contacts/{contactId}/documents":{"get":{"tags":["3. Contacts"],"summary":"List contact identity documents","description":"Signature versions: v1 and v2.","operationId":"getContactsByContactIdDocuments","parameters":[{"name":"contactId","in":"path","description":"Enterprise contact ID returned by /api/v1/contacts. Keep IDs as strings.","required":true,"schema":{"pattern":"[0-9]+","type":"string","example":"337893979704000512"}},{"name":"X-Timestamp","in":"header","description":"Current Unix epoch time in seconds. Requests older or newer than five minutes are rejected.","required":true,"schema":{"pattern":"[0-9]{10}","type":"string","example":"1787562000"}},{"name":"X-Request-ID","in":"header","description":"Unique 16-128 character request identifier used for replay protection; never reuse it for a different HTTP request.","required":true,"schema":{"pattern":"[A-Za-z0-9._:-]{16,128}","type":"string","example":"018f6f4e-8f62-7fc2-9c4b-7be2f4203b6a"}},{"name":"X-Content-SHA256","in":"header","description":"Lowercase hexadecimal SHA-256 digest of the exact raw request body; use the digest of zero bytes when no body is sent.","required":true,"schema":{"pattern":"[0-9a-f]{64}","type":"string","example":"e3b0c44298fc1c149afbf4c8996fb92427ae41e4649b934ca495991b7852b855"}},{"name":"X-Workspace","in":"header","description":"Enterprise reads are available on this route. For enterprise access, copy your own enterprise:<id> from GET /api/v1/workspaces. Required for v2 requests. V1 requests use the historical key's fixed enterprise.","required":false,"schema":{"pattern":"personal|enterprise:[1-9][0-9]*","type":"string","example":null}},{"name":"X-Environment","in":"header","description":"Required and signed for v2 requests: live or sandbox. Optional for v1 requests.","required":false,"schema":{"pattern":"live|sandbox","type":"string","example":"live"}},{"name":"X-Signature","in":"header","description":"Existing keys accept v1 for their fixed enterprise or v2 for a signed workspace; new keys accept v2 only.","required":true,"schema":{"pattern":"v[12]=[0-9a-f]{64}","type":"string","example":"v2=0123456789abcdef0123456789abcdef0123456789abcdef0123456789abcdef"}},{"name":"Accept-Language","in":"header","description":"Response language: en-US = English (default); zh-CN = Simplified Chinese; zh-TW = Traditional Chinese. Numeric error codes are language-neutral.","required":false,"schema":{"type":"string","enum":["en-US","zh-CN","zh-TW"],"default":"en-US"}}],"responses":{"400":{"description":"Malformed JSON, missing header or invalid request parameter","headers":{"X-Request-ID":{"description":"Request identifier echoed for support and reconciliation.","schema":{"type":"string"}}},"content":{"application/json":{"schema":{"$ref":"#/components/schemas/ApiResponseVoid"}}}},"500":{"description":"Unexpected internal error; contact support with X-Request-ID","headers":{"X-Request-ID":{"description":"Request identifier echoed for support and reconciliation.","schema":{"type":"string"}}},"content":{"application/json":{"schema":{"$ref":"#/components/schemas/ApiResponseVoid"}}}},"403":{"description":"API-key scope, subscription, tenant or policy does not allow the operation","headers":{"X-Request-ID":{"description":"Request identifier echoed for support and reconciliation.","schema":{"type":"string"}}},"content":{"application/json":{"schema":{"$ref":"#/components/schemas/ApiResponseVoid"}}}},"200":{"description":"OK","headers":{"X-Request-ID":{"description":"Request identifier echoed for support and reconciliation.","schema":{"type":"string"}},"X-Quota-Limit":{"description":"Monthly API request allowance for the subscription.","schema":{"type":"integer","format":"int64"}},"X-Quota-Remaining":{"description":"Requests remaining in the current monthly allowance after this request.","schema":{"type":"integer","format":"int64"}},"X-Quota-Reset":{"description":"Unix epoch time in seconds when the monthly allowance resets.","schema":{"type":"integer","format":"int64"}},"X-Quota-Workspace":{"description":"Verified workspace owning this allowance: personal or enterprise:<id>.","schema":{"type":"string"}},"X-Quota-Environment":{"description":"Environment owning the allowance: sandbox or live.","schema":{"type":"string"}}},"content":{"application/json":{"schema":{"$ref":"#/components/schemas/ApiResponseListDocumentResponse"}}}},"401":{"description":"Invalid API key, content hash, signature, timestamp or request ID","headers":{"X-Request-ID":{"description":"Request identifier echoed for support and reconciliation.","schema":{"type":"string"}}},"content":{"application/json":{"schema":{"$ref":"#/components/schemas/ApiResponseVoid"}}}},"404":{"description":"Resource not found in this enterprise and environment","headers":{"X-Request-ID":{"description":"Request identifier echoed for support and reconciliation.","schema":{"type":"string"}}},"content":{"application/json":{"schema":{"$ref":"#/components/schemas/ApiResponseVoid"}}}},"422":{"description":"Business rule rejected the request","headers":{"X-Request-ID":{"description":"Request identifier echoed for support and reconciliation.","schema":{"type":"string"}}},"content":{"application/json":{"schema":{"$ref":"#/components/schemas/ApiResponseVoid"}}}},"503":{"description":"A required platform service is temporarily unavailable","headers":{"X-Request-ID":{"description":"Request identifier echoed for support and reconciliation.","schema":{"type":"string"}}},"content":{"application/json":{"schema":{"$ref":"#/components/schemas/ApiResponseVoid"}}}},"409":{"description":"Idempotency or resource-state conflict","headers":{"X-Request-ID":{"description":"Request identifier echoed for support and reconciliation.","schema":{"type":"string"}}},"content":{"application/json":{"schema":{"$ref":"#/components/schemas/ApiResponseVoid"}}}},"429":{"description":"Per-minute rate limit or monthly quota exceeded","headers":{"X-Request-ID":{"description":"Request identifier echoed for support and reconciliation.","schema":{"type":"string"}},"X-Quota-Limit":{"description":"Monthly API request allowance for the subscription.","schema":{"type":"integer","format":"int64"}},"X-Quota-Remaining":{"description":"Requests remaining in the current monthly allowance after this request.","schema":{"type":"integer","format":"int64"}},"X-Quota-Reset":{"description":"Unix epoch time in seconds when the monthly allowance resets.","schema":{"type":"integer","format":"int64"}},"X-Quota-Workspace":{"description":"Verified workspace owning this allowance: personal or enterprise:<id>.","schema":{"type":"string"}},"X-Quota-Environment":{"description":"Environment owning the allowance: sandbox or live.","schema":{"type":"string"}},"Retry-After":{"description":"Seconds until the exhausted quota or rate window resets. Sign retries with a new X-Request-ID.","schema":{"type":"integer","format":"int64"}},"X-RateLimit-Scope":{"description":"Rate counter scope: workspace, or user for enterprise verification calls.","schema":{"type":"string"}},"X-RateLimit-Limit":{"description":"Per-minute request limit when rate-limited.","schema":{"type":"integer","format":"int64"}},"X-RateLimit-Remaining":{"description":"Zero when the minute limit is exhausted.","schema":{"type":"integer","format":"int64"}},"X-RateLimit-Reset":{"description":"Unix epoch seconds when the minute limit resets.","schema":{"type":"integer","format":"int64"}}},"content":{"application/json":{"schema":{"$ref":"#/components/schemas/ApiResponseVoid"}}}},"413":{"description":"Request body is too large","headers":{"X-Request-ID":{"description":"Request identifier echoed for support and reconciliation.","schema":{"type":"string"}}},"content":{"application/json":{"schema":{"$ref":"#/components/schemas/ApiResponseVoid"}}}}},"x-dcwallet-signature-versions":["v1","v2"]}},"/api/v1/cards":{"get":{"tags":["6. Card issuing"],"summary":"List enterprise cards","description":"Signature versions: v1 and v2.","operationId":"getCards","parameters":[{"name":"status","in":"query","description":"Optional filter. Card lifecycle: normal = usable after issuance; freezing = freeze in progress; frozen = temporarily blocked; unfreezing = unfreeze in progress; cancelling = closure in progress; cancelled = permanently closed (terminal). Initial issued state: normal.","required":false,"schema":{"type":"string","enum":["normal","freezing","frozen","unfreezing","cancelling","cancelled"]}},{"name":"contactId","in":"query","description":"Contact ID returned by /contacts.","required":false,"schema":{"type":"string"},"example":337893979704000512},{"name":"productId","in":"query","description":"Product ID returned by /card-products.","required":false,"schema":{"type":"string"},"example":337893979704000513},{"name":"budgetId","in":"query","description":"Return only cards using this shared budget.","required":false,"schema":{"type":"string"}},{"name":"page","in":"query","description":"One-based result page number.","required":false,"schema":{"type":"integer","format":"int32","default":1}},{"name":"pageSize","in":"query","description":"Maximum records returned per page; values above 100 are capped.","required":false,"schema":{"type":"integer","format":"int32","default":20}},{"name":"X-Timestamp","in":"header","description":"Current Unix epoch time in seconds. Requests older or newer than five minutes are rejected.","required":true,"schema":{"pattern":"[0-9]{10}","type":"string","example":"1787562000"}},{"name":"X-Request-ID","in":"header","description":"Unique 16-128 character request identifier used for replay protection; never reuse it for a different HTTP request.","required":true,"schema":{"pattern":"[A-Za-z0-9._:-]{16,128}","type":"string","example":"018f6f4e-8f62-7fc2-9c4b-7be2f4203b6a"}},{"name":"X-Content-SHA256","in":"header","description":"Lowercase hexadecimal SHA-256 digest of the exact raw request body; use the digest of zero bytes when no body is sent.","required":true,"schema":{"pattern":"[0-9a-f]{64}","type":"string","example":"e3b0c44298fc1c149afbf4c8996fb92427ae41e4649b934ca495991b7852b855"}},{"name":"X-Workspace","in":"header","description":"Enterprise reads are available on this route. For enterprise access, copy your own enterprise:<id> from GET /api/v1/workspaces. Required for v2 requests. V1 requests use the historical key's fixed enterprise.","required":false,"schema":{"pattern":"personal|enterprise:[1-9][0-9]*","type":"string","example":null}},{"name":"X-Environment","in":"header","description":"Required and signed for v2 requests: live or sandbox. Optional for v1 requests.","required":false,"schema":{"pattern":"live|sandbox","type":"string","example":"live"}},{"name":"X-Signature","in":"header","description":"Existing keys accept v1 for their fixed enterprise or v2 for a signed workspace; new keys accept v2 only.","required":true,"schema":{"pattern":"v[12]=[0-9a-f]{64}","type":"string","example":"v2=0123456789abcdef0123456789abcdef0123456789abcdef0123456789abcdef"}},{"name":"Accept-Language","in":"header","description":"Response language: en-US = English (default); zh-CN = Simplified Chinese; zh-TW = Traditional Chinese. Numeric error codes are language-neutral.","required":false,"schema":{"type":"string","enum":["en-US","zh-CN","zh-TW"],"default":"en-US"}}],"responses":{"400":{"description":"Malformed JSON, missing header or invalid request parameter","headers":{"X-Request-ID":{"description":"Request identifier echoed for support and reconciliation.","schema":{"type":"string"}}},"content":{"application/json":{"schema":{"$ref":"#/components/schemas/ApiResponseVoid"}}}},"500":{"description":"Unexpected internal error; contact support with X-Request-ID","headers":{"X-Request-ID":{"description":"Request identifier echoed for support and reconciliation.","schema":{"type":"string"}}},"content":{"application/json":{"schema":{"$ref":"#/components/schemas/ApiResponseVoid"}}}},"403":{"description":"API-key scope, subscription, tenant or policy does not allow the operation","headers":{"X-Request-ID":{"description":"Request identifier echoed for support and reconciliation.","schema":{"type":"string"}}},"content":{"application/json":{"schema":{"$ref":"#/components/schemas/ApiResponseVoid"}}}},"200":{"description":"OK","headers":{"X-Request-ID":{"description":"Request identifier echoed for support and reconciliation.","schema":{"type":"string"}},"X-Quota-Limit":{"description":"Monthly API request allowance for the subscription.","schema":{"type":"integer","format":"int64"}},"X-Quota-Remaining":{"description":"Requests remaining in the current monthly allowance after this request.","schema":{"type":"integer","format":"int64"}},"X-Quota-Reset":{"description":"Unix epoch time in seconds when the monthly allowance resets.","schema":{"type":"integer","format":"int64"}},"X-Quota-Workspace":{"description":"Verified workspace owning this allowance: personal or enterprise:<id>.","schema":{"type":"string"}},"X-Quota-Environment":{"description":"Environment owning the allowance: sandbox or live.","schema":{"type":"string"}}},"content":{"application/json":{"schema":{"$ref":"#/components/schemas/ApiResponsePageDataCardResponse"}}}},"401":{"description":"Invalid API key, content hash, signature, timestamp or request ID","headers":{"X-Request-ID":{"description":"Request identifier echoed for support and reconciliation.","schema":{"type":"string"}}},"content":{"application/json":{"schema":{"$ref":"#/components/schemas/ApiResponseVoid"}}}},"404":{"description":"Resource not found in this enterprise and environment","headers":{"X-Request-ID":{"description":"Request identifier echoed for support and reconciliation.","schema":{"type":"string"}}},"content":{"application/json":{"schema":{"$ref":"#/components/schemas/ApiResponseVoid"}}}},"422":{"description":"Business rule rejected the request","headers":{"X-Request-ID":{"description":"Request identifier echoed for support and reconciliation.","schema":{"type":"string"}}},"content":{"application/json":{"schema":{"$ref":"#/components/schemas/ApiResponseVoid"}}}},"503":{"description":"A required platform service is temporarily unavailable","headers":{"X-Request-ID":{"description":"Request identifier echoed for support and reconciliation.","schema":{"type":"string"}}},"content":{"application/json":{"schema":{"$ref":"#/components/schemas/ApiResponseVoid"}}}},"409":{"description":"Idempotency or resource-state conflict","headers":{"X-Request-ID":{"description":"Request identifier echoed for support and reconciliation.","schema":{"type":"string"}}},"content":{"application/json":{"schema":{"$ref":"#/components/schemas/ApiResponseVoid"}}}},"429":{"description":"Per-minute rate limit or monthly quota exceeded","headers":{"X-Request-ID":{"description":"Request identifier echoed for support and reconciliation.","schema":{"type":"string"}},"X-Quota-Limit":{"description":"Monthly API request allowance for the subscription.","schema":{"type":"integer","format":"int64"}},"X-Quota-Remaining":{"description":"Requests remaining in the current monthly allowance after this request.","schema":{"type":"integer","format":"int64"}},"X-Quota-Reset":{"description":"Unix epoch time in seconds when the monthly allowance resets.","schema":{"type":"integer","format":"int64"}},"X-Quota-Workspace":{"description":"Verified workspace owning this allowance: personal or enterprise:<id>.","schema":{"type":"string"}},"X-Quota-Environment":{"description":"Environment owning the allowance: sandbox or live.","schema":{"type":"string"}},"Retry-After":{"description":"Seconds until the exhausted quota or rate window resets. Sign retries with a new X-Request-ID.","schema":{"type":"integer","format":"int64"}},"X-RateLimit-Scope":{"description":"Rate counter scope: workspace, or user for enterprise verification calls.","schema":{"type":"string"}},"X-RateLimit-Limit":{"description":"Per-minute request limit when rate-limited.","schema":{"type":"integer","format":"int64"}},"X-RateLimit-Remaining":{"description":"Zero when the minute limit is exhausted.","schema":{"type":"integer","format":"int64"}},"X-RateLimit-Reset":{"description":"Unix epoch seconds when the minute limit resets.","schema":{"type":"integer","format":"int64"}}},"content":{"application/json":{"schema":{"$ref":"#/components/schemas/ApiResponseVoid"}}}},"413":{"description":"Request body is too large","headers":{"X-Request-ID":{"description":"Request identifier echoed for support and reconciliation.","schema":{"type":"string"}}},"content":{"application/json":{"schema":{"$ref":"#/components/schemas/ApiResponseVoid"}}}}},"x-dcwallet-signature-versions":["v1","v2"]}},"/api/v1/cards/{cardId}/transactions":{"get":{"tags":["6. Card issuing"],"summary":"List card transactions","description":"Signature versions: v1 and v2.","operationId":"getCardsByCardIdTransactions","parameters":[{"name":"cardId","in":"path","description":"Issued-card ID returned by /api/v1/cards. Keep IDs as strings.","required":true,"schema":{"pattern":"[0-9]+","type":"string","example":"337893979704000512"}},{"name":"type","in":"query","description":"Optional filter. Card transaction kind: purchase = card payment; refund = merchant refund; reversal = debit reversal; topup = card funding; fee = service charge; adjustment_credit = operator credit; adjustment_debit = operator debit; verification = card check without posting; atm_inquiry = ATM balance check; atm_withdrawal = cash withdrawal; purchase_reversal = purchase void; refund_reversal = refund clawback; transfer_out = card balance returned elsewhere; unclassified = unknown provider event without assumed balance effect; authorization = hold without posting; authorization_reversal = hold release without posting. No request default; the channel event determines the type.","required":false,"schema":{"type":"string","enum":["purchase","refund","reversal","topup","fee","adjustment_credit","adjustment_debit","verification","atm_inquiry","atm_withdrawal","purchase_reversal","refund_reversal","transfer_out","unclassified","authorization","authorization_reversal"]}},{"name":"direction","in":"query","description":"Optional filter. Card balance effect: in = credit; out = debit; none = no principal balance movement.","required":false,"schema":{"type":"string","enum":["in","out","none"]}},{"name":"status","in":"query","description":"Optional filter. Transaction state: pending = received; processing = settling; authorized = approved but not settled; succeeded = completed (terminal for this transaction); failed = execution failed (terminal); declined = issuer declined (terminal); voided = authorization or transaction cancelled (terminal); cancelled = cancelled before completion (terminal). Initial state depends on the provider event; no universal default.","required":false,"schema":{"type":"string","enum":["pending","processing","authorized","succeeded","failed","declined","voided","cancelled"]}},{"name":"keyword","in":"query","description":"Merchant, transaction number or reference search text.","required":false,"schema":{"type":"string"}},{"name":"startDate","in":"query","description":"Inclusive start date in YYYY-MM-DD format.","required":false,"schema":{"type":"string"},"example":"2026-08-01"},{"name":"endDate","in":"query","description":"Inclusive end date in YYYY-MM-DD format.","required":false,"schema":{"type":"string"},"example":"2026-08-31"},{"name":"page","in":"query","description":"One-based result page number.","required":false,"schema":{"type":"integer","format":"int32","default":1}},{"name":"pageSize","in":"query","description":"Maximum records returned per page; values above 100 are capped.","required":false,"schema":{"type":"integer","format":"int32","default":20}},{"name":"X-Timestamp","in":"header","description":"Current Unix epoch time in seconds. Requests older or newer than five minutes are rejected.","required":true,"schema":{"pattern":"[0-9]{10}","type":"string","example":"1787562000"}},{"name":"X-Request-ID","in":"header","description":"Unique 16-128 character request identifier used for replay protection; never reuse it for a different HTTP request.","required":true,"schema":{"pattern":"[A-Za-z0-9._:-]{16,128}","type":"string","example":"018f6f4e-8f62-7fc2-9c4b-7be2f4203b6a"}},{"name":"X-Content-SHA256","in":"header","description":"Lowercase hexadecimal SHA-256 digest of the exact raw request body; use the digest of zero bytes when no body is sent.","required":true,"schema":{"pattern":"[0-9a-f]{64}","type":"string","example":"e3b0c44298fc1c149afbf4c8996fb92427ae41e4649b934ca495991b7852b855"}},{"name":"X-Workspace","in":"header","description":"Enterprise reads are available on this route. For enterprise access, copy your own enterprise:<id> from GET /api/v1/workspaces. Required for v2 requests. V1 requests use the historical key's fixed enterprise.","required":false,"schema":{"pattern":"personal|enterprise:[1-9][0-9]*","type":"string","example":null}},{"name":"X-Environment","in":"header","description":"Required and signed for v2 requests: live or sandbox. Optional for v1 requests.","required":false,"schema":{"pattern":"live|sandbox","type":"string","example":"live"}},{"name":"X-Signature","in":"header","description":"Existing keys accept v1 for their fixed enterprise or v2 for a signed workspace; new keys accept v2 only.","required":true,"schema":{"pattern":"v[12]=[0-9a-f]{64}","type":"string","example":"v2=0123456789abcdef0123456789abcdef0123456789abcdef0123456789abcdef"}},{"name":"Accept-Language","in":"header","description":"Response language: en-US = English (default); zh-CN = Simplified Chinese; zh-TW = Traditional Chinese. Numeric error codes are language-neutral.","required":false,"schema":{"type":"string","enum":["en-US","zh-CN","zh-TW"],"default":"en-US"}}],"responses":{"400":{"description":"Malformed JSON, missing header or invalid request parameter","headers":{"X-Request-ID":{"description":"Request identifier echoed for support and reconciliation.","schema":{"type":"string"}}},"content":{"application/json":{"schema":{"$ref":"#/components/schemas/ApiResponseVoid"}}}},"500":{"description":"Unexpected internal error; contact support with X-Request-ID","headers":{"X-Request-ID":{"description":"Request identifier echoed for support and reconciliation.","schema":{"type":"string"}}},"content":{"application/json":{"schema":{"$ref":"#/components/schemas/ApiResponseVoid"}}}},"403":{"description":"API-key scope, subscription, tenant or policy does not allow the operation","headers":{"X-Request-ID":{"description":"Request identifier echoed for support and reconciliation.","schema":{"type":"string"}}},"content":{"application/json":{"schema":{"$ref":"#/components/schemas/ApiResponseVoid"}}}},"200":{"description":"OK","headers":{"X-Request-ID":{"description":"Request identifier echoed for support and reconciliation.","schema":{"type":"string"}},"X-Quota-Limit":{"description":"Monthly API request allowance for the subscription.","schema":{"type":"integer","format":"int64"}},"X-Quota-Remaining":{"description":"Requests remaining in the current monthly allowance after this request.","schema":{"type":"integer","format":"int64"}},"X-Quota-Reset":{"description":"Unix epoch time in seconds when the monthly allowance resets.","schema":{"type":"integer","format":"int64"}},"X-Quota-Workspace":{"description":"Verified workspace owning this allowance: personal or enterprise:<id>.","schema":{"type":"string"}},"X-Quota-Environment":{"description":"Environment owning the allowance: sandbox or live.","schema":{"type":"string"}}},"content":{"application/json":{"schema":{"$ref":"#/components/schemas/ApiResponsePageDataCardTransactionResponse"}}}},"401":{"description":"Invalid API key, content hash, signature, timestamp or request ID","headers":{"X-Request-ID":{"description":"Request identifier echoed for support and reconciliation.","schema":{"type":"string"}}},"content":{"application/json":{"schema":{"$ref":"#/components/schemas/ApiResponseVoid"}}}},"404":{"description":"Resource not found in this enterprise and environment","headers":{"X-Request-ID":{"description":"Request identifier echoed for support and reconciliation.","schema":{"type":"string"}}},"content":{"application/json":{"schema":{"$ref":"#/components/schemas/ApiResponseVoid"}}}},"422":{"description":"Business rule rejected the request","headers":{"X-Request-ID":{"description":"Request identifier echoed for support and reconciliation.","schema":{"type":"string"}}},"content":{"application/json":{"schema":{"$ref":"#/components/schemas/ApiResponseVoid"}}}},"503":{"description":"A required platform service is temporarily unavailable","headers":{"X-Request-ID":{"description":"Request identifier echoed for support and reconciliation.","schema":{"type":"string"}}},"content":{"application/json":{"schema":{"$ref":"#/components/schemas/ApiResponseVoid"}}}},"409":{"description":"Idempotency or resource-state conflict","headers":{"X-Request-ID":{"description":"Request identifier echoed for support and reconciliation.","schema":{"type":"string"}}},"content":{"application/json":{"schema":{"$ref":"#/components/schemas/ApiResponseVoid"}}}},"429":{"description":"Per-minute rate limit or monthly quota exceeded","headers":{"X-Request-ID":{"description":"Request identifier echoed for support and reconciliation.","schema":{"type":"string"}},"X-Quota-Limit":{"description":"Monthly API request allowance for the subscription.","schema":{"type":"integer","format":"int64"}},"X-Quota-Remaining":{"description":"Requests remaining in the current monthly allowance after this request.","schema":{"type":"integer","format":"int64"}},"X-Quota-Reset":{"description":"Unix epoch time in seconds when the monthly allowance resets.","schema":{"type":"integer","format":"int64"}},"X-Quota-Workspace":{"description":"Verified workspace owning this allowance: personal or enterprise:<id>.","schema":{"type":"string"}},"X-Quota-Environment":{"description":"Environment owning the allowance: sandbox or live.","schema":{"type":"string"}},"Retry-After":{"description":"Seconds until the exhausted quota or rate window resets. Sign retries with a new X-Request-ID.","schema":{"type":"integer","format":"int64"}},"X-RateLimit-Scope":{"description":"Rate counter scope: workspace, or user for enterprise verification calls.","schema":{"type":"string"}},"X-RateLimit-Limit":{"description":"Per-minute request limit when rate-limited.","schema":{"type":"integer","format":"int64"}},"X-RateLimit-Remaining":{"description":"Zero when the minute limit is exhausted.","schema":{"type":"integer","format":"int64"}},"X-RateLimit-Reset":{"description":"Unix epoch seconds when the minute limit resets.","schema":{"type":"integer","format":"int64"}}},"content":{"application/json":{"schema":{"$ref":"#/components/schemas/ApiResponseVoid"}}}},"413":{"description":"Request body is too large","headers":{"X-Request-ID":{"description":"Request identifier echoed for support and reconciliation.","schema":{"type":"string"}}},"content":{"application/json":{"schema":{"$ref":"#/components/schemas/ApiResponseVoid"}}}}},"x-dcwallet-signature-versions":["v1","v2"]}},"/api/v1/cards/{cardId}/top-ups/{topUpId}":{"get":{"tags":["6. Card issuing"],"summary":"Get a card top-up","description":"Signature versions: v1 and v2.","operationId":"getCardsByCardIdTopUpsByTopUpId","parameters":[{"name":"cardId","in":"path","description":"Issued-card ID returned by /api/v1/cards. Keep IDs as strings.","required":true,"schema":{"pattern":"[0-9]+","type":"string","example":"337893979704000512"}},{"name":"topUpId","in":"path","description":"Card top-up transaction ID returned by the top-up list endpoint. Keep IDs as strings.","required":true,"schema":{"pattern":"[0-9]+","type":"string","example":"337893979704000512"}},{"name":"X-Timestamp","in":"header","description":"Current Unix epoch time in seconds. Requests older or newer than five minutes are rejected.","required":true,"schema":{"pattern":"[0-9]{10}","type":"string","example":"1787562000"}},{"name":"X-Request-ID","in":"header","description":"Unique 16-128 character request identifier used for replay protection; never reuse it for a different HTTP request.","required":true,"schema":{"pattern":"[A-Za-z0-9._:-]{16,128}","type":"string","example":"018f6f4e-8f62-7fc2-9c4b-7be2f4203b6a"}},{"name":"X-Content-SHA256","in":"header","description":"Lowercase hexadecimal SHA-256 digest of the exact raw request body; use the digest of zero bytes when no body is sent.","required":true,"schema":{"pattern":"[0-9a-f]{64}","type":"string","example":"e3b0c44298fc1c149afbf4c8996fb92427ae41e4649b934ca495991b7852b855"}},{"name":"X-Workspace","in":"header","description":"Enterprise reads are available on this route. For enterprise access, copy your own enterprise:<id> from GET /api/v1/workspaces. Required for v2 requests. V1 requests use the historical key's fixed enterprise.","required":false,"schema":{"pattern":"personal|enterprise:[1-9][0-9]*","type":"string","example":null}},{"name":"X-Environment","in":"header","description":"Required and signed for v2 requests: live or sandbox. Optional for v1 requests.","required":false,"schema":{"pattern":"live|sandbox","type":"string","example":"live"}},{"name":"X-Signature","in":"header","description":"Existing keys accept v1 for their fixed enterprise or v2 for a signed workspace; new keys accept v2 only.","required":true,"schema":{"pattern":"v[12]=[0-9a-f]{64}","type":"string","example":"v2=0123456789abcdef0123456789abcdef0123456789abcdef0123456789abcdef"}},{"name":"Accept-Language","in":"header","description":"Response language: en-US = English (default); zh-CN = Simplified Chinese; zh-TW = Traditional Chinese. Numeric error codes are language-neutral.","required":false,"schema":{"type":"string","enum":["en-US","zh-CN","zh-TW"],"default":"en-US"}}],"responses":{"400":{"description":"Malformed JSON, missing header or invalid request parameter","headers":{"X-Request-ID":{"description":"Request identifier echoed for support and reconciliation.","schema":{"type":"string"}}},"content":{"application/json":{"schema":{"$ref":"#/components/schemas/ApiResponseVoid"}}}},"500":{"description":"Unexpected internal error; contact support with X-Request-ID","headers":{"X-Request-ID":{"description":"Request identifier echoed for support and reconciliation.","schema":{"type":"string"}}},"content":{"application/json":{"schema":{"$ref":"#/components/schemas/ApiResponseVoid"}}}},"403":{"description":"API-key scope, subscription, tenant or policy does not allow the operation","headers":{"X-Request-ID":{"description":"Request identifier echoed for support and reconciliation.","schema":{"type":"string"}}},"content":{"application/json":{"schema":{"$ref":"#/components/schemas/ApiResponseVoid"}}}},"200":{"description":"OK","headers":{"X-Request-ID":{"description":"Request identifier echoed for support and reconciliation.","schema":{"type":"string"}},"X-Quota-Limit":{"description":"Monthly API request allowance for the subscription.","schema":{"type":"integer","format":"int64"}},"X-Quota-Remaining":{"description":"Requests remaining in the current monthly allowance after this request.","schema":{"type":"integer","format":"int64"}},"X-Quota-Reset":{"description":"Unix epoch time in seconds when the monthly allowance resets.","schema":{"type":"integer","format":"int64"}},"X-Quota-Workspace":{"description":"Verified workspace owning this allowance: personal or enterprise:<id>.","schema":{"type":"string"}},"X-Quota-Environment":{"description":"Environment owning the allowance: sandbox or live.","schema":{"type":"string"}}},"content":{"application/json":{"schema":{"$ref":"#/components/schemas/ApiResponseCardTransactionResponse"}}}},"401":{"description":"Invalid API key, content hash, signature, timestamp or request ID","headers":{"X-Request-ID":{"description":"Request identifier echoed for support and reconciliation.","schema":{"type":"string"}}},"content":{"application/json":{"schema":{"$ref":"#/components/schemas/ApiResponseVoid"}}}},"404":{"description":"Resource not found in this enterprise and environment","headers":{"X-Request-ID":{"description":"Request identifier echoed for support and reconciliation.","schema":{"type":"string"}}},"content":{"application/json":{"schema":{"$ref":"#/components/schemas/ApiResponseVoid"}}}},"422":{"description":"Business rule rejected the request","headers":{"X-Request-ID":{"description":"Request identifier echoed for support and reconciliation.","schema":{"type":"string"}}},"content":{"application/json":{"schema":{"$ref":"#/components/schemas/ApiResponseVoid"}}}},"503":{"description":"A required platform service is temporarily unavailable","headers":{"X-Request-ID":{"description":"Request identifier echoed for support and reconciliation.","schema":{"type":"string"}}},"content":{"application/json":{"schema":{"$ref":"#/components/schemas/ApiResponseVoid"}}}},"409":{"description":"Idempotency or resource-state conflict","headers":{"X-Request-ID":{"description":"Request identifier echoed for support and reconciliation.","schema":{"type":"string"}}},"content":{"application/json":{"schema":{"$ref":"#/components/schemas/ApiResponseVoid"}}}},"429":{"description":"Per-minute rate limit or monthly quota exceeded","headers":{"X-Request-ID":{"description":"Request identifier echoed for support and reconciliation.","schema":{"type":"string"}},"X-Quota-Limit":{"description":"Monthly API request allowance for the subscription.","schema":{"type":"integer","format":"int64"}},"X-Quota-Remaining":{"description":"Requests remaining in the current monthly allowance after this request.","schema":{"type":"integer","format":"int64"}},"X-Quota-Reset":{"description":"Unix epoch time in seconds when the monthly allowance resets.","schema":{"type":"integer","format":"int64"}},"X-Quota-Workspace":{"description":"Verified workspace owning this allowance: personal or enterprise:<id>.","schema":{"type":"string"}},"X-Quota-Environment":{"description":"Environment owning the allowance: sandbox or live.","schema":{"type":"string"}},"Retry-After":{"description":"Seconds until the exhausted quota or rate window resets. Sign retries with a new X-Request-ID.","schema":{"type":"integer","format":"int64"}},"X-RateLimit-Scope":{"description":"Rate counter scope: workspace, or user for enterprise verification calls.","schema":{"type":"string"}},"X-RateLimit-Limit":{"description":"Per-minute request limit when rate-limited.","schema":{"type":"integer","format":"int64"}},"X-RateLimit-Remaining":{"description":"Zero when the minute limit is exhausted.","schema":{"type":"integer","format":"int64"}},"X-RateLimit-Reset":{"description":"Unix epoch seconds when the minute limit resets.","schema":{"type":"integer","format":"int64"}}},"content":{"application/json":{"schema":{"$ref":"#/components/schemas/ApiResponseVoid"}}}},"413":{"description":"Request body is too large","headers":{"X-Request-ID":{"description":"Request identifier echoed for support and reconciliation.","schema":{"type":"string"}}},"content":{"application/json":{"schema":{"$ref":"#/components/schemas/ApiResponseVoid"}}}}},"x-dcwallet-signature-versions":["v1","v2"]}},"/api/v1/card-transactions":{"get":{"tags":["6. Card issuing"],"summary":"List enterprise card transactions","description":"Signature versions: v1 and v2.","operationId":"getCardTransactions","parameters":[{"name":"cardId","in":"query","description":"Card ID returned by /cards.","required":false,"schema":{"type":"string"},"example":337893979704000514},{"name":"type","in":"query","description":"Optional filter. Card transaction kind: purchase = card payment; refund = merchant refund; reversal = debit reversal; topup = card funding; fee = service charge; adjustment_credit = operator credit; adjustment_debit = operator debit; verification = card check without posting; atm_inquiry = ATM balance check; atm_withdrawal = cash withdrawal; purchase_reversal = purchase void; refund_reversal = refund clawback; transfer_out = card balance returned elsewhere; unclassified = unknown provider event without assumed balance effect; authorization = hold without posting; authorization_reversal = hold release without posting. No request default; the channel event determines the type.","required":false,"schema":{"type":"string","enum":["purchase","refund","reversal","topup","fee","adjustment_credit","adjustment_debit","verification","atm_inquiry","atm_withdrawal","purchase_reversal","refund_reversal","transfer_out","unclassified","authorization","authorization_reversal"]}},{"name":"direction","in":"query","description":"Optional filter. Card balance effect: in = credit; out = debit; none = no principal balance movement.","required":false,"schema":{"type":"string","enum":["in","out","none"]}},{"name":"status","in":"query","description":"Optional filter. Transaction state: pending = received; processing = settling; authorized = approved but not settled; succeeded = completed (terminal for this transaction); failed = execution failed (terminal); declined = issuer declined (terminal); voided = authorization or transaction cancelled (terminal); cancelled = cancelled before completion (terminal). Initial state depends on the provider event; no universal default.","required":false,"schema":{"type":"string","enum":["pending","processing","authorized","succeeded","failed","declined","voided","cancelled"]}},{"name":"keyword","in":"query","description":"Merchant, transaction number or reference search text.","required":false,"schema":{"type":"string"}},{"name":"startDate","in":"query","description":"Inclusive start date in YYYY-MM-DD format.","required":false,"schema":{"type":"string"},"example":"2026-08-01"},{"name":"endDate","in":"query","description":"Inclusive end date in YYYY-MM-DD format.","required":false,"schema":{"type":"string"},"example":"2026-08-31"},{"name":"page","in":"query","description":"One-based result page number.","required":false,"schema":{"type":"integer","format":"int32","default":1}},{"name":"pageSize","in":"query","description":"Maximum records returned per page; values above 100 are capped.","required":false,"schema":{"type":"integer","format":"int32","default":20}},{"name":"X-Timestamp","in":"header","description":"Current Unix epoch time in seconds. Requests older or newer than five minutes are rejected.","required":true,"schema":{"pattern":"[0-9]{10}","type":"string","example":"1787562000"}},{"name":"X-Request-ID","in":"header","description":"Unique 16-128 character request identifier used for replay protection; never reuse it for a different HTTP request.","required":true,"schema":{"pattern":"[A-Za-z0-9._:-]{16,128}","type":"string","example":"018f6f4e-8f62-7fc2-9c4b-7be2f4203b6a"}},{"name":"X-Content-SHA256","in":"header","description":"Lowercase hexadecimal SHA-256 digest of the exact raw request body; use the digest of zero bytes when no body is sent.","required":true,"schema":{"pattern":"[0-9a-f]{64}","type":"string","example":"e3b0c44298fc1c149afbf4c8996fb92427ae41e4649b934ca495991b7852b855"}},{"name":"X-Workspace","in":"header","description":"Enterprise reads are available on this route. For enterprise access, copy your own enterprise:<id> from GET /api/v1/workspaces. Required for v2 requests. V1 requests use the historical key's fixed enterprise.","required":false,"schema":{"pattern":"personal|enterprise:[1-9][0-9]*","type":"string","example":null}},{"name":"X-Environment","in":"header","description":"Required and signed for v2 requests: live or sandbox. Optional for v1 requests.","required":false,"schema":{"pattern":"live|sandbox","type":"string","example":"live"}},{"name":"X-Signature","in":"header","description":"Existing keys accept v1 for their fixed enterprise or v2 for a signed workspace; new keys accept v2 only.","required":true,"schema":{"pattern":"v[12]=[0-9a-f]{64}","type":"string","example":"v2=0123456789abcdef0123456789abcdef0123456789abcdef0123456789abcdef"}},{"name":"Accept-Language","in":"header","description":"Response language: en-US = English (default); zh-CN = Simplified Chinese; zh-TW = Traditional Chinese. Numeric error codes are language-neutral.","required":false,"schema":{"type":"string","enum":["en-US","zh-CN","zh-TW"],"default":"en-US"}}],"responses":{"400":{"description":"Malformed JSON, missing header or invalid request parameter","headers":{"X-Request-ID":{"description":"Request identifier echoed for support and reconciliation.","schema":{"type":"string"}}},"content":{"application/json":{"schema":{"$ref":"#/components/schemas/ApiResponseVoid"}}}},"500":{"description":"Unexpected internal error; contact support with X-Request-ID","headers":{"X-Request-ID":{"description":"Request identifier echoed for support and reconciliation.","schema":{"type":"string"}}},"content":{"application/json":{"schema":{"$ref":"#/components/schemas/ApiResponseVoid"}}}},"403":{"description":"API-key scope, subscription, tenant or policy does not allow the operation","headers":{"X-Request-ID":{"description":"Request identifier echoed for support and reconciliation.","schema":{"type":"string"}}},"content":{"application/json":{"schema":{"$ref":"#/components/schemas/ApiResponseVoid"}}}},"200":{"description":"OK","headers":{"X-Request-ID":{"description":"Request identifier echoed for support and reconciliation.","schema":{"type":"string"}},"X-Quota-Limit":{"description":"Monthly API request allowance for the subscription.","schema":{"type":"integer","format":"int64"}},"X-Quota-Remaining":{"description":"Requests remaining in the current monthly allowance after this request.","schema":{"type":"integer","format":"int64"}},"X-Quota-Reset":{"description":"Unix epoch time in seconds when the monthly allowance resets.","schema":{"type":"integer","format":"int64"}},"X-Quota-Workspace":{"description":"Verified workspace owning this allowance: personal or enterprise:<id>.","schema":{"type":"string"}},"X-Quota-Environment":{"description":"Environment owning the allowance: sandbox or live.","schema":{"type":"string"}}},"content":{"application/json":{"schema":{"$ref":"#/components/schemas/ApiResponsePageDataCardTransactionResponse"}}}},"401":{"description":"Invalid API key, content hash, signature, timestamp or request ID","headers":{"X-Request-ID":{"description":"Request identifier echoed for support and reconciliation.","schema":{"type":"string"}}},"content":{"application/json":{"schema":{"$ref":"#/components/schemas/ApiResponseVoid"}}}},"404":{"description":"Resource not found in this enterprise and environment","headers":{"X-Request-ID":{"description":"Request identifier echoed for support and reconciliation.","schema":{"type":"string"}}},"content":{"application/json":{"schema":{"$ref":"#/components/schemas/ApiResponseVoid"}}}},"422":{"description":"Business rule rejected the request","headers":{"X-Request-ID":{"description":"Request identifier echoed for support and reconciliation.","schema":{"type":"string"}}},"content":{"application/json":{"schema":{"$ref":"#/components/schemas/ApiResponseVoid"}}}},"503":{"description":"A required platform service is temporarily unavailable","headers":{"X-Request-ID":{"description":"Request identifier echoed for support and reconciliation.","schema":{"type":"string"}}},"content":{"application/json":{"schema":{"$ref":"#/components/schemas/ApiResponseVoid"}}}},"409":{"description":"Idempotency or resource-state conflict","headers":{"X-Request-ID":{"description":"Request identifier echoed for support and reconciliation.","schema":{"type":"string"}}},"content":{"application/json":{"schema":{"$ref":"#/components/schemas/ApiResponseVoid"}}}},"429":{"description":"Per-minute rate limit or monthly quota exceeded","headers":{"X-Request-ID":{"description":"Request identifier echoed for support and reconciliation.","schema":{"type":"string"}},"X-Quota-Limit":{"description":"Monthly API request allowance for the subscription.","schema":{"type":"integer","format":"int64"}},"X-Quota-Remaining":{"description":"Requests remaining in the current monthly allowance after this request.","schema":{"type":"integer","format":"int64"}},"X-Quota-Reset":{"description":"Unix epoch time in seconds when the monthly allowance resets.","schema":{"type":"integer","format":"int64"}},"X-Quota-Workspace":{"description":"Verified workspace owning this allowance: personal or enterprise:<id>.","schema":{"type":"string"}},"X-Quota-Environment":{"description":"Environment owning the allowance: sandbox or live.","schema":{"type":"string"}},"Retry-After":{"description":"Seconds until the exhausted quota or rate window resets. Sign retries with a new X-Request-ID.","schema":{"type":"integer","format":"int64"}},"X-RateLimit-Scope":{"description":"Rate counter scope: workspace, or user for enterprise verification calls.","schema":{"type":"string"}},"X-RateLimit-Limit":{"description":"Per-minute request limit when rate-limited.","schema":{"type":"integer","format":"int64"}},"X-RateLimit-Remaining":{"description":"Zero when the minute limit is exhausted.","schema":{"type":"integer","format":"int64"}},"X-RateLimit-Reset":{"description":"Unix epoch seconds when the minute limit resets.","schema":{"type":"integer","format":"int64"}}},"content":{"application/json":{"schema":{"$ref":"#/components/schemas/ApiResponseVoid"}}}},"413":{"description":"Request body is too large","headers":{"X-Request-ID":{"description":"Request identifier echoed for support and reconciliation.","schema":{"type":"string"}}},"content":{"application/json":{"schema":{"$ref":"#/components/schemas/ApiResponseVoid"}}}}},"x-dcwallet-signature-versions":["v1","v2"]}},"/api/v1/card-transactions/{transactionId}":{"get":{"tags":["6. Card issuing"],"summary":"Get an enterprise card transaction","description":"Signature versions: v1 and v2.","operationId":"getCardTransactionsByTransactionId","parameters":[{"name":"transactionId","in":"path","description":"Transaction ID returned by the corresponding transaction list endpoint. Keep IDs as strings.","required":true,"schema":{"pattern":"[0-9]+","type":"string","example":"337893979704000512"}},{"name":"X-Timestamp","in":"header","description":"Current Unix epoch time in seconds. Requests older or newer than five minutes are rejected.","required":true,"schema":{"pattern":"[0-9]{10}","type":"string","example":"1787562000"}},{"name":"X-Request-ID","in":"header","description":"Unique 16-128 character request identifier used for replay protection; never reuse it for a different HTTP request.","required":true,"schema":{"pattern":"[A-Za-z0-9._:-]{16,128}","type":"string","example":"018f6f4e-8f62-7fc2-9c4b-7be2f4203b6a"}},{"name":"X-Content-SHA256","in":"header","description":"Lowercase hexadecimal SHA-256 digest of the exact raw request body; use the digest of zero bytes when no body is sent.","required":true,"schema":{"pattern":"[0-9a-f]{64}","type":"string","example":"e3b0c44298fc1c149afbf4c8996fb92427ae41e4649b934ca495991b7852b855"}},{"name":"X-Workspace","in":"header","description":"Enterprise reads are available on this route. For enterprise access, copy your own enterprise:<id> from GET /api/v1/workspaces. Required for v2 requests. V1 requests use the historical key's fixed enterprise.","required":false,"schema":{"pattern":"personal|enterprise:[1-9][0-9]*","type":"string","example":null}},{"name":"X-Environment","in":"header","description":"Required and signed for v2 requests: live or sandbox. Optional for v1 requests.","required":false,"schema":{"pattern":"live|sandbox","type":"string","example":"live"}},{"name":"X-Signature","in":"header","description":"Existing keys accept v1 for their fixed enterprise or v2 for a signed workspace; new keys accept v2 only.","required":true,"schema":{"pattern":"v[12]=[0-9a-f]{64}","type":"string","example":"v2=0123456789abcdef0123456789abcdef0123456789abcdef0123456789abcdef"}},{"name":"Accept-Language","in":"header","description":"Response language: en-US = English (default); zh-CN = Simplified Chinese; zh-TW = Traditional Chinese. Numeric error codes are language-neutral.","required":false,"schema":{"type":"string","enum":["en-US","zh-CN","zh-TW"],"default":"en-US"}}],"responses":{"400":{"description":"Malformed JSON, missing header or invalid request parameter","headers":{"X-Request-ID":{"description":"Request identifier echoed for support and reconciliation.","schema":{"type":"string"}}},"content":{"application/json":{"schema":{"$ref":"#/components/schemas/ApiResponseVoid"}}}},"500":{"description":"Unexpected internal error; contact support with X-Request-ID","headers":{"X-Request-ID":{"description":"Request identifier echoed for support and reconciliation.","schema":{"type":"string"}}},"content":{"application/json":{"schema":{"$ref":"#/components/schemas/ApiResponseVoid"}}}},"403":{"description":"API-key scope, subscription, tenant or policy does not allow the operation","headers":{"X-Request-ID":{"description":"Request identifier echoed for support and reconciliation.","schema":{"type":"string"}}},"content":{"application/json":{"schema":{"$ref":"#/components/schemas/ApiResponseVoid"}}}},"200":{"description":"OK","headers":{"X-Request-ID":{"description":"Request identifier echoed for support and reconciliation.","schema":{"type":"string"}},"X-Quota-Limit":{"description":"Monthly API request allowance for the subscription.","schema":{"type":"integer","format":"int64"}},"X-Quota-Remaining":{"description":"Requests remaining in the current monthly allowance after this request.","schema":{"type":"integer","format":"int64"}},"X-Quota-Reset":{"description":"Unix epoch time in seconds when the monthly allowance resets.","schema":{"type":"integer","format":"int64"}},"X-Quota-Workspace":{"description":"Verified workspace owning this allowance: personal or enterprise:<id>.","schema":{"type":"string"}},"X-Quota-Environment":{"description":"Environment owning the allowance: sandbox or live.","schema":{"type":"string"}}},"content":{"application/json":{"schema":{"$ref":"#/components/schemas/ApiResponseCardTransactionResponse"}}}},"401":{"description":"Invalid API key, content hash, signature, timestamp or request ID","headers":{"X-Request-ID":{"description":"Request identifier echoed for support and reconciliation.","schema":{"type":"string"}}},"content":{"application/json":{"schema":{"$ref":"#/components/schemas/ApiResponseVoid"}}}},"404":{"description":"Resource not found in this enterprise and environment","headers":{"X-Request-ID":{"description":"Request identifier echoed for support and reconciliation.","schema":{"type":"string"}}},"content":{"application/json":{"schema":{"$ref":"#/components/schemas/ApiResponseVoid"}}}},"422":{"description":"Business rule rejected the request","headers":{"X-Request-ID":{"description":"Request identifier echoed for support and reconciliation.","schema":{"type":"string"}}},"content":{"application/json":{"schema":{"$ref":"#/components/schemas/ApiResponseVoid"}}}},"503":{"description":"A required platform service is temporarily unavailable","headers":{"X-Request-ID":{"description":"Request identifier echoed for support and reconciliation.","schema":{"type":"string"}}},"content":{"application/json":{"schema":{"$ref":"#/components/schemas/ApiResponseVoid"}}}},"409":{"description":"Idempotency or resource-state conflict","headers":{"X-Request-ID":{"description":"Request identifier echoed for support and reconciliation.","schema":{"type":"string"}}},"content":{"application/json":{"schema":{"$ref":"#/components/schemas/ApiResponseVoid"}}}},"429":{"description":"Per-minute rate limit or monthly quota exceeded","headers":{"X-Request-ID":{"description":"Request identifier echoed for support and reconciliation.","schema":{"type":"string"}},"X-Quota-Limit":{"description":"Monthly API request allowance for the subscription.","schema":{"type":"integer","format":"int64"}},"X-Quota-Remaining":{"description":"Requests remaining in the current monthly allowance after this request.","schema":{"type":"integer","format":"int64"}},"X-Quota-Reset":{"description":"Unix epoch time in seconds when the monthly allowance resets.","schema":{"type":"integer","format":"int64"}},"X-Quota-Workspace":{"description":"Verified workspace owning this allowance: personal or enterprise:<id>.","schema":{"type":"string"}},"X-Quota-Environment":{"description":"Environment owning the allowance: sandbox or live.","schema":{"type":"string"}},"Retry-After":{"description":"Seconds until the exhausted quota or rate window resets. Sign retries with a new X-Request-ID.","schema":{"type":"integer","format":"int64"}},"X-RateLimit-Scope":{"description":"Rate counter scope: workspace, or user for enterprise verification calls.","schema":{"type":"string"}},"X-RateLimit-Limit":{"description":"Per-minute request limit when rate-limited.","schema":{"type":"integer","format":"int64"}},"X-RateLimit-Remaining":{"description":"Zero when the minute limit is exhausted.","schema":{"type":"integer","format":"int64"}},"X-RateLimit-Reset":{"description":"Unix epoch seconds when the minute limit resets.","schema":{"type":"integer","format":"int64"}}},"content":{"application/json":{"schema":{"$ref":"#/components/schemas/ApiResponseVoid"}}}},"413":{"description":"Request body is too large","headers":{"X-Request-ID":{"description":"Request identifier echoed for support and reconciliation.","schema":{"type":"string"}}},"content":{"application/json":{"schema":{"$ref":"#/components/schemas/ApiResponseVoid"}}}}},"x-dcwallet-signature-versions":["v1","v2"]}},"/api/v1/card-products":{"get":{"tags":["6. Card issuing"],"summary":"List card products available for issuance","description":"Inspect bins.contactRequired. A verified account may omit contactId only with a selectedBinId whose contactRequired is false. Country, entity, KYB and inventory checks still apply.\n\nSignature versions: v1 and v2.","operationId":"getCardProducts","parameters":[{"name":"X-Timestamp","in":"header","description":"Current Unix epoch time in seconds. Requests older or newer than five minutes are rejected.","required":true,"schema":{"pattern":"[0-9]{10}","type":"string","example":"1787562000"}},{"name":"X-Request-ID","in":"header","description":"Unique 16-128 character request identifier used for replay protection; never reuse it for a different HTTP request.","required":true,"schema":{"pattern":"[A-Za-z0-9._:-]{16,128}","type":"string","example":"018f6f4e-8f62-7fc2-9c4b-7be2f4203b6a"}},{"name":"X-Content-SHA256","in":"header","description":"Lowercase hexadecimal SHA-256 digest of the exact raw request body; use the digest of zero bytes when no body is sent.","required":true,"schema":{"pattern":"[0-9a-f]{64}","type":"string","example":"e3b0c44298fc1c149afbf4c8996fb92427ae41e4649b934ca495991b7852b855"}},{"name":"X-Workspace","in":"header","description":"Enterprise reads are available on this route. For enterprise access, copy your own enterprise:<id> from GET /api/v1/workspaces. Required for v2 requests. V1 requests use the historical key's fixed enterprise.","required":false,"schema":{"pattern":"personal|enterprise:[1-9][0-9]*","type":"string","example":null}},{"name":"X-Environment","in":"header","description":"Required and signed for v2 requests: live or sandbox. Optional for v1 requests.","required":false,"schema":{"pattern":"live|sandbox","type":"string","example":"live"}},{"name":"X-Signature","in":"header","description":"Existing keys accept v1 for their fixed enterprise or v2 for a signed workspace; new keys accept v2 only.","required":true,"schema":{"pattern":"v[12]=[0-9a-f]{64}","type":"string","example":"v2=0123456789abcdef0123456789abcdef0123456789abcdef0123456789abcdef"}},{"name":"Accept-Language","in":"header","description":"Response language: en-US = English (default); zh-CN = Simplified Chinese; zh-TW = Traditional Chinese. Numeric error codes are language-neutral.","required":false,"schema":{"type":"string","enum":["en-US","zh-CN","zh-TW"],"default":"en-US"}}],"responses":{"400":{"description":"Malformed JSON, missing header or invalid request parameter","headers":{"X-Request-ID":{"description":"Request identifier echoed for support and reconciliation.","schema":{"type":"string"}}},"content":{"application/json":{"schema":{"$ref":"#/components/schemas/ApiResponseVoid"}}}},"500":{"description":"Unexpected internal error; contact support with X-Request-ID","headers":{"X-Request-ID":{"description":"Request identifier echoed for support and reconciliation.","schema":{"type":"string"}}},"content":{"application/json":{"schema":{"$ref":"#/components/schemas/ApiResponseVoid"}}}},"403":{"description":"API-key scope, subscription, tenant or policy does not allow the operation","headers":{"X-Request-ID":{"description":"Request identifier echoed for support and reconciliation.","schema":{"type":"string"}}},"content":{"application/json":{"schema":{"$ref":"#/components/schemas/ApiResponseVoid"}}}},"200":{"description":"OK","headers":{"X-Request-ID":{"description":"Request identifier echoed for support and reconciliation.","schema":{"type":"string"}},"X-Quota-Limit":{"description":"Monthly API request allowance for the subscription.","schema":{"type":"integer","format":"int64"}},"X-Quota-Remaining":{"description":"Requests remaining in the current monthly allowance after this request.","schema":{"type":"integer","format":"int64"}},"X-Quota-Reset":{"description":"Unix epoch time in seconds when the monthly allowance resets.","schema":{"type":"integer","format":"int64"}},"X-Quota-Workspace":{"description":"Verified workspace owning this allowance: personal or enterprise:<id>.","schema":{"type":"string"}},"X-Quota-Environment":{"description":"Environment owning the allowance: sandbox or live.","schema":{"type":"string"}}},"content":{"application/json":{"schema":{"$ref":"#/components/schemas/ApiResponseListCardProductResponse"}}}},"401":{"description":"Invalid API key, content hash, signature, timestamp or request ID","headers":{"X-Request-ID":{"description":"Request identifier echoed for support and reconciliation.","schema":{"type":"string"}}},"content":{"application/json":{"schema":{"$ref":"#/components/schemas/ApiResponseVoid"}}}},"404":{"description":"Resource not found in this enterprise and environment","headers":{"X-Request-ID":{"description":"Request identifier echoed for support and reconciliation.","schema":{"type":"string"}}},"content":{"application/json":{"schema":{"$ref":"#/components/schemas/ApiResponseVoid"}}}},"422":{"description":"Business rule rejected the request","headers":{"X-Request-ID":{"description":"Request identifier echoed for support and reconciliation.","schema":{"type":"string"}}},"content":{"application/json":{"schema":{"$ref":"#/components/schemas/ApiResponseVoid"}}}},"503":{"description":"A required platform service is temporarily unavailable","headers":{"X-Request-ID":{"description":"Request identifier echoed for support and reconciliation.","schema":{"type":"string"}}},"content":{"application/json":{"schema":{"$ref":"#/components/schemas/ApiResponseVoid"}}}},"409":{"description":"Idempotency or resource-state conflict","headers":{"X-Request-ID":{"description":"Request identifier echoed for support and reconciliation.","schema":{"type":"string"}}},"content":{"application/json":{"schema":{"$ref":"#/components/schemas/ApiResponseVoid"}}}},"429":{"description":"Per-minute rate limit or monthly quota exceeded","headers":{"X-Request-ID":{"description":"Request identifier echoed for support and reconciliation.","schema":{"type":"string"}},"X-Quota-Limit":{"description":"Monthly API request allowance for the subscription.","schema":{"type":"integer","format":"int64"}},"X-Quota-Remaining":{"description":"Requests remaining in the current monthly allowance after this request.","schema":{"type":"integer","format":"int64"}},"X-Quota-Reset":{"description":"Unix epoch time in seconds when the monthly allowance resets.","schema":{"type":"integer","format":"int64"}},"X-Quota-Workspace":{"description":"Verified workspace owning this allowance: personal or enterprise:<id>.","schema":{"type":"string"}},"X-Quota-Environment":{"description":"Environment owning the allowance: sandbox or live.","schema":{"type":"string"}},"Retry-After":{"description":"Seconds until the exhausted quota or rate window resets. Sign retries with a new X-Request-ID.","schema":{"type":"integer","format":"int64"}},"X-RateLimit-Scope":{"description":"Rate counter scope: workspace, or user for enterprise verification calls.","schema":{"type":"string"}},"X-RateLimit-Limit":{"description":"Per-minute request limit when rate-limited.","schema":{"type":"integer","format":"int64"}},"X-RateLimit-Remaining":{"description":"Zero when the minute limit is exhausted.","schema":{"type":"integer","format":"int64"}},"X-RateLimit-Reset":{"description":"Unix epoch seconds when the minute limit resets.","schema":{"type":"integer","format":"int64"}}},"content":{"application/json":{"schema":{"$ref":"#/components/schemas/ApiResponseVoid"}}}},"413":{"description":"Request body is too large","headers":{"X-Request-ID":{"description":"Request identifier echoed for support and reconciliation.","schema":{"type":"string"}}},"content":{"application/json":{"schema":{"$ref":"#/components/schemas/ApiResponseVoid"}}}}},"x-dcwallet-signature-versions":["v1","v2"]}},"/api/v1/card-products/{productId}":{"get":{"tags":["6. Card issuing"],"summary":"Get a card product","description":"Signature versions: v1 and v2.","operationId":"getCardProductsByProductId","parameters":[{"name":"productId","in":"path","description":"Card product ID returned by /api/v1/card-products. Keep IDs as strings.","required":true,"schema":{"pattern":"[0-9]+","type":"string","example":"337893979704000512"}},{"name":"X-Timestamp","in":"header","description":"Current Unix epoch time in seconds. Requests older or newer than five minutes are rejected.","required":true,"schema":{"pattern":"[0-9]{10}","type":"string","example":"1787562000"}},{"name":"X-Request-ID","in":"header","description":"Unique 16-128 character request identifier used for replay protection; never reuse it for a different HTTP request.","required":true,"schema":{"pattern":"[A-Za-z0-9._:-]{16,128}","type":"string","example":"018f6f4e-8f62-7fc2-9c4b-7be2f4203b6a"}},{"name":"X-Content-SHA256","in":"header","description":"Lowercase hexadecimal SHA-256 digest of the exact raw request body; use the digest of zero bytes when no body is sent.","required":true,"schema":{"pattern":"[0-9a-f]{64}","type":"string","example":"e3b0c44298fc1c149afbf4c8996fb92427ae41e4649b934ca495991b7852b855"}},{"name":"X-Workspace","in":"header","description":"Enterprise reads are available on this route. For enterprise access, copy your own enterprise:<id> from GET /api/v1/workspaces. Required for v2 requests. V1 requests use the historical key's fixed enterprise.","required":false,"schema":{"pattern":"personal|enterprise:[1-9][0-9]*","type":"string","example":null}},{"name":"X-Environment","in":"header","description":"Required and signed for v2 requests: live or sandbox. Optional for v1 requests.","required":false,"schema":{"pattern":"live|sandbox","type":"string","example":"live"}},{"name":"X-Signature","in":"header","description":"Existing keys accept v1 for their fixed enterprise or v2 for a signed workspace; new keys accept v2 only.","required":true,"schema":{"pattern":"v[12]=[0-9a-f]{64}","type":"string","example":"v2=0123456789abcdef0123456789abcdef0123456789abcdef0123456789abcdef"}},{"name":"Accept-Language","in":"header","description":"Response language: en-US = English (default); zh-CN = Simplified Chinese; zh-TW = Traditional Chinese. Numeric error codes are language-neutral.","required":false,"schema":{"type":"string","enum":["en-US","zh-CN","zh-TW"],"default":"en-US"}}],"responses":{"400":{"description":"Malformed JSON, missing header or invalid request parameter","headers":{"X-Request-ID":{"description":"Request identifier echoed for support and reconciliation.","schema":{"type":"string"}}},"content":{"application/json":{"schema":{"$ref":"#/components/schemas/ApiResponseVoid"}}}},"500":{"description":"Unexpected internal error; contact support with X-Request-ID","headers":{"X-Request-ID":{"description":"Request identifier echoed for support and reconciliation.","schema":{"type":"string"}}},"content":{"application/json":{"schema":{"$ref":"#/components/schemas/ApiResponseVoid"}}}},"403":{"description":"API-key scope, subscription, tenant or policy does not allow the operation","headers":{"X-Request-ID":{"description":"Request identifier echoed for support and reconciliation.","schema":{"type":"string"}}},"content":{"application/json":{"schema":{"$ref":"#/components/schemas/ApiResponseVoid"}}}},"200":{"description":"OK","headers":{"X-Request-ID":{"description":"Request identifier echoed for support and reconciliation.","schema":{"type":"string"}},"X-Quota-Limit":{"description":"Monthly API request allowance for the subscription.","schema":{"type":"integer","format":"int64"}},"X-Quota-Remaining":{"description":"Requests remaining in the current monthly allowance after this request.","schema":{"type":"integer","format":"int64"}},"X-Quota-Reset":{"description":"Unix epoch time in seconds when the monthly allowance resets.","schema":{"type":"integer","format":"int64"}},"X-Quota-Workspace":{"description":"Verified workspace owning this allowance: personal or enterprise:<id>.","schema":{"type":"string"}},"X-Quota-Environment":{"description":"Environment owning the allowance: sandbox or live.","schema":{"type":"string"}}},"content":{"application/json":{"schema":{"$ref":"#/components/schemas/ApiResponseCardProductResponse"}}}},"401":{"description":"Invalid API key, content hash, signature, timestamp or request ID","headers":{"X-Request-ID":{"description":"Request identifier echoed for support and reconciliation.","schema":{"type":"string"}}},"content":{"application/json":{"schema":{"$ref":"#/components/schemas/ApiResponseVoid"}}}},"404":{"description":"Resource not found in this enterprise and environment","headers":{"X-Request-ID":{"description":"Request identifier echoed for support and reconciliation.","schema":{"type":"string"}}},"content":{"application/json":{"schema":{"$ref":"#/components/schemas/ApiResponseVoid"}}}},"422":{"description":"Business rule rejected the request","headers":{"X-Request-ID":{"description":"Request identifier echoed for support and reconciliation.","schema":{"type":"string"}}},"content":{"application/json":{"schema":{"$ref":"#/components/schemas/ApiResponseVoid"}}}},"503":{"description":"A required platform service is temporarily unavailable","headers":{"X-Request-ID":{"description":"Request identifier echoed for support and reconciliation.","schema":{"type":"string"}}},"content":{"application/json":{"schema":{"$ref":"#/components/schemas/ApiResponseVoid"}}}},"409":{"description":"Idempotency or resource-state conflict","headers":{"X-Request-ID":{"description":"Request identifier echoed for support and reconciliation.","schema":{"type":"string"}}},"content":{"application/json":{"schema":{"$ref":"#/components/schemas/ApiResponseVoid"}}}},"429":{"description":"Per-minute rate limit or monthly quota exceeded","headers":{"X-Request-ID":{"description":"Request identifier echoed for support and reconciliation.","schema":{"type":"string"}},"X-Quota-Limit":{"description":"Monthly API request allowance for the subscription.","schema":{"type":"integer","format":"int64"}},"X-Quota-Remaining":{"description":"Requests remaining in the current monthly allowance after this request.","schema":{"type":"integer","format":"int64"}},"X-Quota-Reset":{"description":"Unix epoch time in seconds when the monthly allowance resets.","schema":{"type":"integer","format":"int64"}},"X-Quota-Workspace":{"description":"Verified workspace owning this allowance: personal or enterprise:<id>.","schema":{"type":"string"}},"X-Quota-Environment":{"description":"Environment owning the allowance: sandbox or live.","schema":{"type":"string"}},"Retry-After":{"description":"Seconds until the exhausted quota or rate window resets. Sign retries with a new X-Request-ID.","schema":{"type":"integer","format":"int64"}},"X-RateLimit-Scope":{"description":"Rate counter scope: workspace, or user for enterprise verification calls.","schema":{"type":"string"}},"X-RateLimit-Limit":{"description":"Per-minute request limit when rate-limited.","schema":{"type":"integer","format":"int64"}},"X-RateLimit-Remaining":{"description":"Zero when the minute limit is exhausted.","schema":{"type":"integer","format":"int64"}},"X-RateLimit-Reset":{"description":"Unix epoch seconds when the minute limit resets.","schema":{"type":"integer","format":"int64"}}},"content":{"application/json":{"schema":{"$ref":"#/components/schemas/ApiResponseVoid"}}}},"413":{"description":"Request body is too large","headers":{"X-Request-ID":{"description":"Request identifier echoed for support and reconciliation.","schema":{"type":"string"}}},"content":{"application/json":{"schema":{"$ref":"#/components/schemas/ApiResponseVoid"}}}}},"x-dcwallet-signature-versions":["v1","v2"]}},"/api/v1/card-budgets/{budgetId}":{"get":{"tags":["6. Card issuing"],"summary":"Get a shared-card budget and its ledger balance","description":"Signature versions: v1 and v2.","operationId":"getCardBudgetsByBudgetId","parameters":[{"name":"budgetId","in":"path","description":"The budget id value for this resource.","required":true,"schema":{"pattern":"[0-9]+","type":"string","example":"337893979704000512"}},{"name":"Accept-Language","in":"header","description":"The accept-language value for this resource.","required":false,"schema":{"type":"string"}},{"name":"X-Timestamp","in":"header","description":"Current Unix epoch time in seconds. Requests older or newer than five minutes are rejected.","required":true,"schema":{"pattern":"[0-9]{10}","type":"string","example":"1787562000"}},{"name":"X-Request-ID","in":"header","description":"Unique 16-128 character request identifier used for replay protection; never reuse it for a different HTTP request.","required":true,"schema":{"pattern":"[A-Za-z0-9._:-]{16,128}","type":"string","example":"018f6f4e-8f62-7fc2-9c4b-7be2f4203b6a"}},{"name":"X-Content-SHA256","in":"header","description":"Lowercase hexadecimal SHA-256 digest of the exact raw request body; use the digest of zero bytes when no body is sent.","required":true,"schema":{"pattern":"[0-9a-f]{64}","type":"string","example":"e3b0c44298fc1c149afbf4c8996fb92427ae41e4649b934ca495991b7852b855"}},{"name":"X-Workspace","in":"header","description":"Enterprise reads are available on this route. For enterprise access, copy your own enterprise:<id> from GET /api/v1/workspaces. Required for v2 requests. V1 requests use the historical key's fixed enterprise.","required":false,"schema":{"pattern":"personal|enterprise:[1-9][0-9]*","type":"string","example":null}},{"name":"X-Environment","in":"header","description":"Required and signed for v2 requests: live or sandbox. Optional for v1 requests.","required":false,"schema":{"pattern":"live|sandbox","type":"string","example":"live"}},{"name":"X-Signature","in":"header","description":"Existing keys accept v1 for their fixed enterprise or v2 for a signed workspace; new keys accept v2 only.","required":true,"schema":{"pattern":"v[12]=[0-9a-f]{64}","type":"string","example":"v2=0123456789abcdef0123456789abcdef0123456789abcdef0123456789abcdef"}}],"responses":{"400":{"description":"Malformed JSON, missing header or invalid request parameter","headers":{"X-Request-ID":{"description":"Request identifier echoed for support and reconciliation.","schema":{"type":"string"}}},"content":{"application/json":{"schema":{"$ref":"#/components/schemas/ApiResponseVoid"}}}},"500":{"description":"Unexpected internal error; contact support with X-Request-ID","headers":{"X-Request-ID":{"description":"Request identifier echoed for support and reconciliation.","schema":{"type":"string"}}},"content":{"application/json":{"schema":{"$ref":"#/components/schemas/ApiResponseVoid"}}}},"403":{"description":"API-key scope, subscription, tenant or policy does not allow the operation","headers":{"X-Request-ID":{"description":"Request identifier echoed for support and reconciliation.","schema":{"type":"string"}}},"content":{"application/json":{"schema":{"$ref":"#/components/schemas/ApiResponseVoid"}}}},"200":{"description":"OK","headers":{"X-Request-ID":{"description":"Request identifier echoed for support and reconciliation.","schema":{"type":"string"}},"X-Quota-Limit":{"description":"Monthly API request allowance for the subscription.","schema":{"type":"integer","format":"int64"}},"X-Quota-Remaining":{"description":"Requests remaining in the current monthly allowance after this request.","schema":{"type":"integer","format":"int64"}},"X-Quota-Reset":{"description":"Unix epoch time in seconds when the monthly allowance resets.","schema":{"type":"integer","format":"int64"}},"X-Quota-Workspace":{"description":"Verified workspace owning this allowance: personal or enterprise:<id>.","schema":{"type":"string"}},"X-Quota-Environment":{"description":"Environment owning the allowance: sandbox or live.","schema":{"type":"string"}}},"content":{"application/json":{"schema":{"$ref":"#/components/schemas/ApiResponseBudgetDetailResponse"}}}},"401":{"description":"Invalid API key, content hash, signature, timestamp or request ID","headers":{"X-Request-ID":{"description":"Request identifier echoed for support and reconciliation.","schema":{"type":"string"}}},"content":{"application/json":{"schema":{"$ref":"#/components/schemas/ApiResponseVoid"}}}},"404":{"description":"Resource not found in this enterprise and environment","headers":{"X-Request-ID":{"description":"Request identifier echoed for support and reconciliation.","schema":{"type":"string"}}},"content":{"application/json":{"schema":{"$ref":"#/components/schemas/ApiResponseVoid"}}}},"422":{"description":"Business rule rejected the request","headers":{"X-Request-ID":{"description":"Request identifier echoed for support and reconciliation.","schema":{"type":"string"}}},"content":{"application/json":{"schema":{"$ref":"#/components/schemas/ApiResponseVoid"}}}},"503":{"description":"A required platform service is temporarily unavailable","headers":{"X-Request-ID":{"description":"Request identifier echoed for support and reconciliation.","schema":{"type":"string"}}},"content":{"application/json":{"schema":{"$ref":"#/components/schemas/ApiResponseVoid"}}}},"409":{"description":"Idempotency or resource-state conflict","headers":{"X-Request-ID":{"description":"Request identifier echoed for support and reconciliation.","schema":{"type":"string"}}},"content":{"application/json":{"schema":{"$ref":"#/components/schemas/ApiResponseVoid"}}}},"429":{"description":"Per-minute rate limit or monthly quota exceeded","headers":{"X-Request-ID":{"description":"Request identifier echoed for support and reconciliation.","schema":{"type":"string"}},"X-Quota-Limit":{"description":"Monthly API request allowance for the subscription.","schema":{"type":"integer","format":"int64"}},"X-Quota-Remaining":{"description":"Requests remaining in the current monthly allowance after this request.","schema":{"type":"integer","format":"int64"}},"X-Quota-Reset":{"description":"Unix epoch time in seconds when the monthly allowance resets.","schema":{"type":"integer","format":"int64"}},"X-Quota-Workspace":{"description":"Verified workspace owning this allowance: personal or enterprise:<id>.","schema":{"type":"string"}},"X-Quota-Environment":{"description":"Environment owning the allowance: sandbox or live.","schema":{"type":"string"}},"Retry-After":{"description":"Seconds until the exhausted quota or rate window resets. Sign retries with a new X-Request-ID.","schema":{"type":"integer","format":"int64"}},"X-RateLimit-Scope":{"description":"Rate counter scope: workspace, or user for enterprise verification calls.","schema":{"type":"string"}},"X-RateLimit-Limit":{"description":"Per-minute request limit when rate-limited.","schema":{"type":"integer","format":"int64"}},"X-RateLimit-Remaining":{"description":"Zero when the minute limit is exhausted.","schema":{"type":"integer","format":"int64"}},"X-RateLimit-Reset":{"description":"Unix epoch seconds when the minute limit resets.","schema":{"type":"integer","format":"int64"}}},"content":{"application/json":{"schema":{"$ref":"#/components/schemas/ApiResponseVoid"}}}},"413":{"description":"Request body is too large","headers":{"X-Request-ID":{"description":"Request identifier echoed for support and reconciliation.","schema":{"type":"string"}}},"content":{"application/json":{"schema":{"$ref":"#/components/schemas/ApiResponseVoid"}}}}},"x-dcwallet-signature-versions":["v1","v2"]}},"/api/v1/card-budgets/{budgetId}/transfers":{"get":{"tags":["6. Card issuing"],"summary":"List funding and withdrawal attempts for this budget","description":"Signature versions: v1 and v2.","operationId":"getCardBudgetsByBudgetIdTransfers","parameters":[{"name":"budgetId","in":"path","description":"The budget id value for this resource.","required":true,"schema":{"pattern":"[0-9]+","type":"string","example":"337893979704000512"}},{"name":"X-Timestamp","in":"header","description":"Current Unix epoch time in seconds. Requests older or newer than five minutes are rejected.","required":true,"schema":{"pattern":"[0-9]{10}","type":"string","example":"1787562000"}},{"name":"X-Request-ID","in":"header","description":"Unique 16-128 character request identifier used for replay protection; never reuse it for a different HTTP request.","required":true,"schema":{"pattern":"[A-Za-z0-9._:-]{16,128}","type":"string","example":"018f6f4e-8f62-7fc2-9c4b-7be2f4203b6a"}},{"name":"X-Content-SHA256","in":"header","description":"Lowercase hexadecimal SHA-256 digest of the exact raw request body; use the digest of zero bytes when no body is sent.","required":true,"schema":{"pattern":"[0-9a-f]{64}","type":"string","example":"e3b0c44298fc1c149afbf4c8996fb92427ae41e4649b934ca495991b7852b855"}},{"name":"X-Workspace","in":"header","description":"Enterprise reads are available on this route. For enterprise access, copy your own enterprise:<id> from GET /api/v1/workspaces. Required for v2 requests. V1 requests use the historical key's fixed enterprise.","required":false,"schema":{"pattern":"personal|enterprise:[1-9][0-9]*","type":"string","example":null}},{"name":"X-Environment","in":"header","description":"Required and signed for v2 requests: live or sandbox. Optional for v1 requests.","required":false,"schema":{"pattern":"live|sandbox","type":"string","example":"live"}},{"name":"X-Signature","in":"header","description":"Existing keys accept v1 for their fixed enterprise or v2 for a signed workspace; new keys accept v2 only.","required":true,"schema":{"pattern":"v[12]=[0-9a-f]{64}","type":"string","example":"v2=0123456789abcdef0123456789abcdef0123456789abcdef0123456789abcdef"}},{"name":"Accept-Language","in":"header","description":"Response language: en-US = English (default); zh-CN = Simplified Chinese; zh-TW = Traditional Chinese. Numeric error codes are language-neutral.","required":false,"schema":{"type":"string","enum":["en-US","zh-CN","zh-TW"],"default":"en-US"}}],"responses":{"400":{"description":"Malformed JSON, missing header or invalid request parameter","headers":{"X-Request-ID":{"description":"Request identifier echoed for support and reconciliation.","schema":{"type":"string"}}},"content":{"application/json":{"schema":{"$ref":"#/components/schemas/ApiResponseVoid"}}}},"500":{"description":"Unexpected internal error; contact support with X-Request-ID","headers":{"X-Request-ID":{"description":"Request identifier echoed for support and reconciliation.","schema":{"type":"string"}}},"content":{"application/json":{"schema":{"$ref":"#/components/schemas/ApiResponseVoid"}}}},"403":{"description":"API-key scope, subscription, tenant or policy does not allow the operation","headers":{"X-Request-ID":{"description":"Request identifier echoed for support and reconciliation.","schema":{"type":"string"}}},"content":{"application/json":{"schema":{"$ref":"#/components/schemas/ApiResponseVoid"}}}},"200":{"description":"OK","headers":{"X-Request-ID":{"description":"Request identifier echoed for support and reconciliation.","schema":{"type":"string"}},"X-Quota-Limit":{"description":"Monthly API request allowance for the subscription.","schema":{"type":"integer","format":"int64"}},"X-Quota-Remaining":{"description":"Requests remaining in the current monthly allowance after this request.","schema":{"type":"integer","format":"int64"}},"X-Quota-Reset":{"description":"Unix epoch time in seconds when the monthly allowance resets.","schema":{"type":"integer","format":"int64"}},"X-Quota-Workspace":{"description":"Verified workspace owning this allowance: personal or enterprise:<id>.","schema":{"type":"string"}},"X-Quota-Environment":{"description":"Environment owning the allowance: sandbox or live.","schema":{"type":"string"}}},"content":{"application/json":{"schema":{"$ref":"#/components/schemas/ApiResponseListBudgetTransferResponse"}}}},"401":{"description":"Invalid API key, content hash, signature, timestamp or request ID","headers":{"X-Request-ID":{"description":"Request identifier echoed for support and reconciliation.","schema":{"type":"string"}}},"content":{"application/json":{"schema":{"$ref":"#/components/schemas/ApiResponseVoid"}}}},"404":{"description":"Resource not found in this enterprise and environment","headers":{"X-Request-ID":{"description":"Request identifier echoed for support and reconciliation.","schema":{"type":"string"}}},"content":{"application/json":{"schema":{"$ref":"#/components/schemas/ApiResponseVoid"}}}},"422":{"description":"Business rule rejected the request","headers":{"X-Request-ID":{"description":"Request identifier echoed for support and reconciliation.","schema":{"type":"string"}}},"content":{"application/json":{"schema":{"$ref":"#/components/schemas/ApiResponseVoid"}}}},"503":{"description":"A required platform service is temporarily unavailable","headers":{"X-Request-ID":{"description":"Request identifier echoed for support and reconciliation.","schema":{"type":"string"}}},"content":{"application/json":{"schema":{"$ref":"#/components/schemas/ApiResponseVoid"}}}},"409":{"description":"Idempotency or resource-state conflict","headers":{"X-Request-ID":{"description":"Request identifier echoed for support and reconciliation.","schema":{"type":"string"}}},"content":{"application/json":{"schema":{"$ref":"#/components/schemas/ApiResponseVoid"}}}},"429":{"description":"Per-minute rate limit or monthly quota exceeded","headers":{"X-Request-ID":{"description":"Request identifier echoed for support and reconciliation.","schema":{"type":"string"}},"X-Quota-Limit":{"description":"Monthly API request allowance for the subscription.","schema":{"type":"integer","format":"int64"}},"X-Quota-Remaining":{"description":"Requests remaining in the current monthly allowance after this request.","schema":{"type":"integer","format":"int64"}},"X-Quota-Reset":{"description":"Unix epoch time in seconds when the monthly allowance resets.","schema":{"type":"integer","format":"int64"}},"X-Quota-Workspace":{"description":"Verified workspace owning this allowance: personal or enterprise:<id>.","schema":{"type":"string"}},"X-Quota-Environment":{"description":"Environment owning the allowance: sandbox or live.","schema":{"type":"string"}},"Retry-After":{"description":"Seconds until the exhausted quota or rate window resets. Sign retries with a new X-Request-ID.","schema":{"type":"integer","format":"int64"}},"X-RateLimit-Scope":{"description":"Rate counter scope: workspace, or user for enterprise verification calls.","schema":{"type":"string"}},"X-RateLimit-Limit":{"description":"Per-minute request limit when rate-limited.","schema":{"type":"integer","format":"int64"}},"X-RateLimit-Remaining":{"description":"Zero when the minute limit is exhausted.","schema":{"type":"integer","format":"int64"}},"X-RateLimit-Reset":{"description":"Unix epoch seconds when the minute limit resets.","schema":{"type":"integer","format":"int64"}}},"content":{"application/json":{"schema":{"$ref":"#/components/schemas/ApiResponseVoid"}}}},"413":{"description":"Request body is too large","headers":{"X-Request-ID":{"description":"Request identifier echoed for support and reconciliation.","schema":{"type":"string"}}},"content":{"application/json":{"schema":{"$ref":"#/components/schemas/ApiResponseVoid"}}}}},"x-dcwallet-signature-versions":["v1","v2"]}},"/api/v1/card-budgets/{budgetId}/products":{"get":{"tags":["6. Card issuing"],"summary":"List shared-card products eligible for this budget","description":"Signature versions: v1 and v2.","operationId":"getCardBudgetsByBudgetIdProducts","parameters":[{"name":"budgetId","in":"path","description":"The budget id value for this resource.","required":true,"schema":{"pattern":"[0-9]+","type":"string","example":"337893979704000512"}},{"name":"X-Timestamp","in":"header","description":"Current Unix epoch time in seconds. Requests older or newer than five minutes are rejected.","required":true,"schema":{"pattern":"[0-9]{10}","type":"string","example":"1787562000"}},{"name":"X-Request-ID","in":"header","description":"Unique 16-128 character request identifier used for replay protection; never reuse it for a different HTTP request.","required":true,"schema":{"pattern":"[A-Za-z0-9._:-]{16,128}","type":"string","example":"018f6f4e-8f62-7fc2-9c4b-7be2f4203b6a"}},{"name":"X-Content-SHA256","in":"header","description":"Lowercase hexadecimal SHA-256 digest of the exact raw request body; use the digest of zero bytes when no body is sent.","required":true,"schema":{"pattern":"[0-9a-f]{64}","type":"string","example":"e3b0c44298fc1c149afbf4c8996fb92427ae41e4649b934ca495991b7852b855"}},{"name":"X-Workspace","in":"header","description":"Enterprise reads are available on this route. For enterprise access, copy your own enterprise:<id> from GET /api/v1/workspaces. Required for v2 requests. V1 requests use the historical key's fixed enterprise.","required":false,"schema":{"pattern":"personal|enterprise:[1-9][0-9]*","type":"string","example":null}},{"name":"X-Environment","in":"header","description":"Required and signed for v2 requests: live or sandbox. Optional for v1 requests.","required":false,"schema":{"pattern":"live|sandbox","type":"string","example":"live"}},{"name":"X-Signature","in":"header","description":"Existing keys accept v1 for their fixed enterprise or v2 for a signed workspace; new keys accept v2 only.","required":true,"schema":{"pattern":"v[12]=[0-9a-f]{64}","type":"string","example":"v2=0123456789abcdef0123456789abcdef0123456789abcdef0123456789abcdef"}},{"name":"Accept-Language","in":"header","description":"Response language: en-US = English (default); zh-CN = Simplified Chinese; zh-TW = Traditional Chinese. Numeric error codes are language-neutral.","required":false,"schema":{"type":"string","enum":["en-US","zh-CN","zh-TW"],"default":"en-US"}}],"responses":{"400":{"description":"Malformed JSON, missing header or invalid request parameter","headers":{"X-Request-ID":{"description":"Request identifier echoed for support and reconciliation.","schema":{"type":"string"}}},"content":{"application/json":{"schema":{"$ref":"#/components/schemas/ApiResponseVoid"}}}},"500":{"description":"Unexpected internal error; contact support with X-Request-ID","headers":{"X-Request-ID":{"description":"Request identifier echoed for support and reconciliation.","schema":{"type":"string"}}},"content":{"application/json":{"schema":{"$ref":"#/components/schemas/ApiResponseVoid"}}}},"403":{"description":"API-key scope, subscription, tenant or policy does not allow the operation","headers":{"X-Request-ID":{"description":"Request identifier echoed for support and reconciliation.","schema":{"type":"string"}}},"content":{"application/json":{"schema":{"$ref":"#/components/schemas/ApiResponseVoid"}}}},"200":{"description":"OK","headers":{"X-Request-ID":{"description":"Request identifier echoed for support and reconciliation.","schema":{"type":"string"}},"X-Quota-Limit":{"description":"Monthly API request allowance for the subscription.","schema":{"type":"integer","format":"int64"}},"X-Quota-Remaining":{"description":"Requests remaining in the current monthly allowance after this request.","schema":{"type":"integer","format":"int64"}},"X-Quota-Reset":{"description":"Unix epoch time in seconds when the monthly allowance resets.","schema":{"type":"integer","format":"int64"}},"X-Quota-Workspace":{"description":"Verified workspace owning this allowance: personal or enterprise:<id>.","schema":{"type":"string"}},"X-Quota-Environment":{"description":"Environment owning the allowance: sandbox or live.","schema":{"type":"string"}}},"content":{"application/json":{"schema":{"$ref":"#/components/schemas/ApiResponseListCardProductResponse"}}}},"401":{"description":"Invalid API key, content hash, signature, timestamp or request ID","headers":{"X-Request-ID":{"description":"Request identifier echoed for support and reconciliation.","schema":{"type":"string"}}},"content":{"application/json":{"schema":{"$ref":"#/components/schemas/ApiResponseVoid"}}}},"404":{"description":"Resource not found in this enterprise and environment","headers":{"X-Request-ID":{"description":"Request identifier echoed for support and reconciliation.","schema":{"type":"string"}}},"content":{"application/json":{"schema":{"$ref":"#/components/schemas/ApiResponseVoid"}}}},"422":{"description":"Business rule rejected the request","headers":{"X-Request-ID":{"description":"Request identifier echoed for support and reconciliation.","schema":{"type":"string"}}},"content":{"application/json":{"schema":{"$ref":"#/components/schemas/ApiResponseVoid"}}}},"503":{"description":"A required platform service is temporarily unavailable","headers":{"X-Request-ID":{"description":"Request identifier echoed for support and reconciliation.","schema":{"type":"string"}}},"content":{"application/json":{"schema":{"$ref":"#/components/schemas/ApiResponseVoid"}}}},"409":{"description":"Idempotency or resource-state conflict","headers":{"X-Request-ID":{"description":"Request identifier echoed for support and reconciliation.","schema":{"type":"string"}}},"content":{"application/json":{"schema":{"$ref":"#/components/schemas/ApiResponseVoid"}}}},"429":{"description":"Per-minute rate limit or monthly quota exceeded","headers":{"X-Request-ID":{"description":"Request identifier echoed for support and reconciliation.","schema":{"type":"string"}},"X-Quota-Limit":{"description":"Monthly API request allowance for the subscription.","schema":{"type":"integer","format":"int64"}},"X-Quota-Remaining":{"description":"Requests remaining in the current monthly allowance after this request.","schema":{"type":"integer","format":"int64"}},"X-Quota-Reset":{"description":"Unix epoch time in seconds when the monthly allowance resets.","schema":{"type":"integer","format":"int64"}},"X-Quota-Workspace":{"description":"Verified workspace owning this allowance: personal or enterprise:<id>.","schema":{"type":"string"}},"X-Quota-Environment":{"description":"Environment owning the allowance: sandbox or live.","schema":{"type":"string"}},"Retry-After":{"description":"Seconds until the exhausted quota or rate window resets. Sign retries with a new X-Request-ID.","schema":{"type":"integer","format":"int64"}},"X-RateLimit-Scope":{"description":"Rate counter scope: workspace, or user for enterprise verification calls.","schema":{"type":"string"}},"X-RateLimit-Limit":{"description":"Per-minute request limit when rate-limited.","schema":{"type":"integer","format":"int64"}},"X-RateLimit-Remaining":{"description":"Zero when the minute limit is exhausted.","schema":{"type":"integer","format":"int64"}},"X-RateLimit-Reset":{"description":"Unix epoch seconds when the minute limit resets.","schema":{"type":"integer","format":"int64"}}},"content":{"application/json":{"schema":{"$ref":"#/components/schemas/ApiResponseVoid"}}}},"413":{"description":"Request body is too large","headers":{"X-Request-ID":{"description":"Request identifier echoed for support and reconciliation.","schema":{"type":"string"}}},"content":{"application/json":{"schema":{"$ref":"#/components/schemas/ApiResponseVoid"}}}}},"x-dcwallet-signature-versions":["v1","v2"]}},"/api/v1/card-budgets/options":{"get":{"tags":["6. Card issuing"],"summary":"List currencies available for a shared-card budget","description":"Signature versions: v1 and v2.","operationId":"getCardBudgetsOptions","parameters":[{"name":"X-Timestamp","in":"header","description":"Current Unix epoch time in seconds. Requests older or newer than five minutes are rejected.","required":true,"schema":{"pattern":"[0-9]{10}","type":"string","example":"1787562000"}},{"name":"X-Request-ID","in":"header","description":"Unique 16-128 character request identifier used for replay protection; never reuse it for a different HTTP request.","required":true,"schema":{"pattern":"[A-Za-z0-9._:-]{16,128}","type":"string","example":"018f6f4e-8f62-7fc2-9c4b-7be2f4203b6a"}},{"name":"X-Content-SHA256","in":"header","description":"Lowercase hexadecimal SHA-256 digest of the exact raw request body; use the digest of zero bytes when no body is sent.","required":true,"schema":{"pattern":"[0-9a-f]{64}","type":"string","example":"e3b0c44298fc1c149afbf4c8996fb92427ae41e4649b934ca495991b7852b855"}},{"name":"X-Workspace","in":"header","description":"Enterprise reads are available on this route. For enterprise access, copy your own enterprise:<id> from GET /api/v1/workspaces. Required for v2 requests. V1 requests use the historical key's fixed enterprise.","required":false,"schema":{"pattern":"personal|enterprise:[1-9][0-9]*","type":"string","example":null}},{"name":"X-Environment","in":"header","description":"Required and signed for v2 requests: live or sandbox. Optional for v1 requests.","required":false,"schema":{"pattern":"live|sandbox","type":"string","example":"live"}},{"name":"X-Signature","in":"header","description":"Existing keys accept v1 for their fixed enterprise or v2 for a signed workspace; new keys accept v2 only.","required":true,"schema":{"pattern":"v[12]=[0-9a-f]{64}","type":"string","example":"v2=0123456789abcdef0123456789abcdef0123456789abcdef0123456789abcdef"}},{"name":"Accept-Language","in":"header","description":"Response language: en-US = English (default); zh-CN = Simplified Chinese; zh-TW = Traditional Chinese. Numeric error codes are language-neutral.","required":false,"schema":{"type":"string","enum":["en-US","zh-CN","zh-TW"],"default":"en-US"}}],"responses":{"400":{"description":"Malformed JSON, missing header or invalid request parameter","headers":{"X-Request-ID":{"description":"Request identifier echoed for support and reconciliation.","schema":{"type":"string"}}},"content":{"application/json":{"schema":{"$ref":"#/components/schemas/ApiResponseVoid"}}}},"500":{"description":"Unexpected internal error; contact support with X-Request-ID","headers":{"X-Request-ID":{"description":"Request identifier echoed for support and reconciliation.","schema":{"type":"string"}}},"content":{"application/json":{"schema":{"$ref":"#/components/schemas/ApiResponseVoid"}}}},"403":{"description":"API-key scope, subscription, tenant or policy does not allow the operation","headers":{"X-Request-ID":{"description":"Request identifier echoed for support and reconciliation.","schema":{"type":"string"}}},"content":{"application/json":{"schema":{"$ref":"#/components/schemas/ApiResponseVoid"}}}},"200":{"description":"OK","headers":{"X-Request-ID":{"description":"Request identifier echoed for support and reconciliation.","schema":{"type":"string"}},"X-Quota-Limit":{"description":"Monthly API request allowance for the subscription.","schema":{"type":"integer","format":"int64"}},"X-Quota-Remaining":{"description":"Requests remaining in the current monthly allowance after this request.","schema":{"type":"integer","format":"int64"}},"X-Quota-Reset":{"description":"Unix epoch time in seconds when the monthly allowance resets.","schema":{"type":"integer","format":"int64"}},"X-Quota-Workspace":{"description":"Verified workspace owning this allowance: personal or enterprise:<id>.","schema":{"type":"string"}},"X-Quota-Environment":{"description":"Environment owning the allowance: sandbox or live.","schema":{"type":"string"}}},"content":{"application/json":{"schema":{"$ref":"#/components/schemas/ApiResponseListBudgetOptionResponse"}}}},"401":{"description":"Invalid API key, content hash, signature, timestamp or request ID","headers":{"X-Request-ID":{"description":"Request identifier echoed for support and reconciliation.","schema":{"type":"string"}}},"content":{"application/json":{"schema":{"$ref":"#/components/schemas/ApiResponseVoid"}}}},"404":{"description":"Resource not found in this enterprise and environment","headers":{"X-Request-ID":{"description":"Request identifier echoed for support and reconciliation.","schema":{"type":"string"}}},"content":{"application/json":{"schema":{"$ref":"#/components/schemas/ApiResponseVoid"}}}},"422":{"description":"Business rule rejected the request","headers":{"X-Request-ID":{"description":"Request identifier echoed for support and reconciliation.","schema":{"type":"string"}}},"content":{"application/json":{"schema":{"$ref":"#/components/schemas/ApiResponseVoid"}}}},"503":{"description":"A required platform service is temporarily unavailable","headers":{"X-Request-ID":{"description":"Request identifier echoed for support and reconciliation.","schema":{"type":"string"}}},"content":{"application/json":{"schema":{"$ref":"#/components/schemas/ApiResponseVoid"}}}},"409":{"description":"Idempotency or resource-state conflict","headers":{"X-Request-ID":{"description":"Request identifier echoed for support and reconciliation.","schema":{"type":"string"}}},"content":{"application/json":{"schema":{"$ref":"#/components/schemas/ApiResponseVoid"}}}},"429":{"description":"Per-minute rate limit or monthly quota exceeded","headers":{"X-Request-ID":{"description":"Request identifier echoed for support and reconciliation.","schema":{"type":"string"}},"X-Quota-Limit":{"description":"Monthly API request allowance for the subscription.","schema":{"type":"integer","format":"int64"}},"X-Quota-Remaining":{"description":"Requests remaining in the current monthly allowance after this request.","schema":{"type":"integer","format":"int64"}},"X-Quota-Reset":{"description":"Unix epoch time in seconds when the monthly allowance resets.","schema":{"type":"integer","format":"int64"}},"X-Quota-Workspace":{"description":"Verified workspace owning this allowance: personal or enterprise:<id>.","schema":{"type":"string"}},"X-Quota-Environment":{"description":"Environment owning the allowance: sandbox or live.","schema":{"type":"string"}},"Retry-After":{"description":"Seconds until the exhausted quota or rate window resets. Sign retries with a new X-Request-ID.","schema":{"type":"integer","format":"int64"}},"X-RateLimit-Scope":{"description":"Rate counter scope: workspace, or user for enterprise verification calls.","schema":{"type":"string"}},"X-RateLimit-Limit":{"description":"Per-minute request limit when rate-limited.","schema":{"type":"integer","format":"int64"}},"X-RateLimit-Remaining":{"description":"Zero when the minute limit is exhausted.","schema":{"type":"integer","format":"int64"}},"X-RateLimit-Reset":{"description":"Unix epoch seconds when the minute limit resets.","schema":{"type":"integer","format":"int64"}}},"content":{"application/json":{"schema":{"$ref":"#/components/schemas/ApiResponseVoid"}}}},"413":{"description":"Request body is too large","headers":{"X-Request-ID":{"description":"Request identifier echoed for support and reconciliation.","schema":{"type":"string"}}},"content":{"application/json":{"schema":{"$ref":"#/components/schemas/ApiResponseVoid"}}}}},"x-dcwallet-signature-versions":["v1","v2"]}},"/api/v1/card-applications/{applicationId}":{"get":{"tags":["6. Card issuing"],"summary":"Get a card application","description":"Signature versions: v1 and v2.","operationId":"getCardApplicationsByApplicationId","parameters":[{"name":"applicationId","in":"path","description":"Card application ID returned by /api/v1/card-applications. Keep IDs as strings.","required":true,"schema":{"pattern":"[0-9]+","type":"string","example":"337893979704000512"}},{"name":"X-Timestamp","in":"header","description":"Current Unix epoch time in seconds. Requests older or newer than five minutes are rejected.","required":true,"schema":{"pattern":"[0-9]{10}","type":"string","example":"1787562000"}},{"name":"X-Request-ID","in":"header","description":"Unique 16-128 character request identifier used for replay protection; never reuse it for a different HTTP request.","required":true,"schema":{"pattern":"[A-Za-z0-9._:-]{16,128}","type":"string","example":"018f6f4e-8f62-7fc2-9c4b-7be2f4203b6a"}},{"name":"X-Content-SHA256","in":"header","description":"Lowercase hexadecimal SHA-256 digest of the exact raw request body; use the digest of zero bytes when no body is sent.","required":true,"schema":{"pattern":"[0-9a-f]{64}","type":"string","example":"e3b0c44298fc1c149afbf4c8996fb92427ae41e4649b934ca495991b7852b855"}},{"name":"X-Workspace","in":"header","description":"Enterprise reads are available on this route. For enterprise access, copy your own enterprise:<id> from GET /api/v1/workspaces. Required for v2 requests. V1 requests use the historical key's fixed enterprise.","required":false,"schema":{"pattern":"personal|enterprise:[1-9][0-9]*","type":"string","example":null}},{"name":"X-Environment","in":"header","description":"Required and signed for v2 requests: live or sandbox. Optional for v1 requests.","required":false,"schema":{"pattern":"live|sandbox","type":"string","example":"live"}},{"name":"X-Signature","in":"header","description":"Existing keys accept v1 for their fixed enterprise or v2 for a signed workspace; new keys accept v2 only.","required":true,"schema":{"pattern":"v[12]=[0-9a-f]{64}","type":"string","example":"v2=0123456789abcdef0123456789abcdef0123456789abcdef0123456789abcdef"}},{"name":"Accept-Language","in":"header","description":"Response language: en-US = English (default); zh-CN = Simplified Chinese; zh-TW = Traditional Chinese. Numeric error codes are language-neutral.","required":false,"schema":{"type":"string","enum":["en-US","zh-CN","zh-TW"],"default":"en-US"}}],"responses":{"400":{"description":"Malformed JSON, missing header or invalid request parameter","headers":{"X-Request-ID":{"description":"Request identifier echoed for support and reconciliation.","schema":{"type":"string"}}},"content":{"application/json":{"schema":{"$ref":"#/components/schemas/ApiResponseVoid"}}}},"500":{"description":"Unexpected internal error; contact support with X-Request-ID","headers":{"X-Request-ID":{"description":"Request identifier echoed for support and reconciliation.","schema":{"type":"string"}}},"content":{"application/json":{"schema":{"$ref":"#/components/schemas/ApiResponseVoid"}}}},"403":{"description":"API-key scope, subscription, tenant or policy does not allow the operation","headers":{"X-Request-ID":{"description":"Request identifier echoed for support and reconciliation.","schema":{"type":"string"}}},"content":{"application/json":{"schema":{"$ref":"#/components/schemas/ApiResponseVoid"}}}},"200":{"description":"OK","headers":{"X-Request-ID":{"description":"Request identifier echoed for support and reconciliation.","schema":{"type":"string"}},"X-Quota-Limit":{"description":"Monthly API request allowance for the subscription.","schema":{"type":"integer","format":"int64"}},"X-Quota-Remaining":{"description":"Requests remaining in the current monthly allowance after this request.","schema":{"type":"integer","format":"int64"}},"X-Quota-Reset":{"description":"Unix epoch time in seconds when the monthly allowance resets.","schema":{"type":"integer","format":"int64"}},"X-Quota-Workspace":{"description":"Verified workspace owning this allowance: personal or enterprise:<id>.","schema":{"type":"string"}},"X-Quota-Environment":{"description":"Environment owning the allowance: sandbox or live.","schema":{"type":"string"}}},"content":{"application/json":{"schema":{"$ref":"#/components/schemas/ApiResponseCardApplicationResponse"}}}},"401":{"description":"Invalid API key, content hash, signature, timestamp or request ID","headers":{"X-Request-ID":{"description":"Request identifier echoed for support and reconciliation.","schema":{"type":"string"}}},"content":{"application/json":{"schema":{"$ref":"#/components/schemas/ApiResponseVoid"}}}},"404":{"description":"Resource not found in this enterprise and environment","headers":{"X-Request-ID":{"description":"Request identifier echoed for support and reconciliation.","schema":{"type":"string"}}},"content":{"application/json":{"schema":{"$ref":"#/components/schemas/ApiResponseVoid"}}}},"422":{"description":"Business rule rejected the request","headers":{"X-Request-ID":{"description":"Request identifier echoed for support and reconciliation.","schema":{"type":"string"}}},"content":{"application/json":{"schema":{"$ref":"#/components/schemas/ApiResponseVoid"}}}},"503":{"description":"A required platform service is temporarily unavailable","headers":{"X-Request-ID":{"description":"Request identifier echoed for support and reconciliation.","schema":{"type":"string"}}},"content":{"application/json":{"schema":{"$ref":"#/components/schemas/ApiResponseVoid"}}}},"409":{"description":"Idempotency or resource-state conflict","headers":{"X-Request-ID":{"description":"Request identifier echoed for support and reconciliation.","schema":{"type":"string"}}},"content":{"application/json":{"schema":{"$ref":"#/components/schemas/ApiResponseVoid"}}}},"429":{"description":"Per-minute rate limit or monthly quota exceeded","headers":{"X-Request-ID":{"description":"Request identifier echoed for support and reconciliation.","schema":{"type":"string"}},"X-Quota-Limit":{"description":"Monthly API request allowance for the subscription.","schema":{"type":"integer","format":"int64"}},"X-Quota-Remaining":{"description":"Requests remaining in the current monthly allowance after this request.","schema":{"type":"integer","format":"int64"}},"X-Quota-Reset":{"description":"Unix epoch time in seconds when the monthly allowance resets.","schema":{"type":"integer","format":"int64"}},"X-Quota-Workspace":{"description":"Verified workspace owning this allowance: personal or enterprise:<id>.","schema":{"type":"string"}},"X-Quota-Environment":{"description":"Environment owning the allowance: sandbox or live.","schema":{"type":"string"}},"Retry-After":{"description":"Seconds until the exhausted quota or rate window resets. Sign retries with a new X-Request-ID.","schema":{"type":"integer","format":"int64"}},"X-RateLimit-Scope":{"description":"Rate counter scope: workspace, or user for enterprise verification calls.","schema":{"type":"string"}},"X-RateLimit-Limit":{"description":"Per-minute request limit when rate-limited.","schema":{"type":"integer","format":"int64"}},"X-RateLimit-Remaining":{"description":"Zero when the minute limit is exhausted.","schema":{"type":"integer","format":"int64"}},"X-RateLimit-Reset":{"description":"Unix epoch seconds when the minute limit resets.","schema":{"type":"integer","format":"int64"}}},"content":{"application/json":{"schema":{"$ref":"#/components/schemas/ApiResponseVoid"}}}},"413":{"description":"Request body is too large","headers":{"X-Request-ID":{"description":"Request identifier echoed for support and reconciliation.","schema":{"type":"string"}}},"content":{"application/json":{"schema":{"$ref":"#/components/schemas/ApiResponseVoid"}}}}},"x-dcwallet-signature-versions":["v1","v2"]}},"/api/v1/blockchain-addresses/{addressId}":{"get":{"tags":["2. Receiving accounts"],"summary":"Get a blockchain receiving address in the selected workspace","description":"Signature versions: v1 and v2.","operationId":"getBlockchainAddressesByAddressId","parameters":[{"name":"addressId","in":"path","description":"Blockchain receiving-address ID returned by /api/v1/blockchain-addresses. Keep IDs as strings.","required":true,"schema":{"pattern":"[0-9]+","type":"string","example":"337893979704000512"}},{"name":"X-Timestamp","in":"header","description":"Current Unix epoch time in seconds. Requests older or newer than five minutes are rejected.","required":true,"schema":{"pattern":"[0-9]{10}","type":"string","example":"1787562000"}},{"name":"X-Request-ID","in":"header","description":"Unique 16-128 character request identifier used for replay protection; never reuse it for a different HTTP request.","required":true,"schema":{"pattern":"[A-Za-z0-9._:-]{16,128}","type":"string","example":"018f6f4e-8f62-7fc2-9c4b-7be2f4203b6a"}},{"name":"X-Content-SHA256","in":"header","description":"Lowercase hexadecimal SHA-256 digest of the exact raw request body; use the digest of zero bytes when no body is sent.","required":true,"schema":{"pattern":"[0-9a-f]{64}","type":"string","example":"e3b0c44298fc1c149afbf4c8996fb92427ae41e4649b934ca495991b7852b855"}},{"name":"X-Workspace","in":"header","description":"Personal and enterprise reads are available on this route. For enterprise access, copy your own enterprise:<id> from GET /api/v1/workspaces. Required for v2 requests. V1 requests use the historical key's fixed enterprise.","required":false,"schema":{"pattern":"personal|enterprise:[1-9][0-9]*","type":"string","example":"personal"}},{"name":"X-Environment","in":"header","description":"Required and signed for v2 requests: live or sandbox. Optional for v1 requests.","required":false,"schema":{"pattern":"live|sandbox","type":"string","example":"live"}},{"name":"X-Signature","in":"header","description":"Existing keys accept v1 for their fixed enterprise or v2 for a signed workspace; new keys accept v2 only.","required":true,"schema":{"pattern":"v[12]=[0-9a-f]{64}","type":"string","example":"v2=0123456789abcdef0123456789abcdef0123456789abcdef0123456789abcdef"}},{"name":"Accept-Language","in":"header","description":"Response language: en-US = English (default); zh-CN = Simplified Chinese; zh-TW = Traditional Chinese. Numeric error codes are language-neutral.","required":false,"schema":{"type":"string","enum":["en-US","zh-CN","zh-TW"],"default":"en-US"}}],"responses":{"400":{"description":"Malformed JSON, missing header or invalid request parameter","headers":{"X-Request-ID":{"description":"Request identifier echoed for support and reconciliation.","schema":{"type":"string"}}},"content":{"application/json":{"schema":{"$ref":"#/components/schemas/ApiResponseVoid"}}}},"500":{"description":"Unexpected internal error; contact support with X-Request-ID","headers":{"X-Request-ID":{"description":"Request identifier echoed for support and reconciliation.","schema":{"type":"string"}}},"content":{"application/json":{"schema":{"$ref":"#/components/schemas/ApiResponseVoid"}}}},"403":{"description":"API-key scope, subscription, tenant or policy does not allow the operation","headers":{"X-Request-ID":{"description":"Request identifier echoed for support and reconciliation.","schema":{"type":"string"}}},"content":{"application/json":{"schema":{"$ref":"#/components/schemas/ApiResponseVoid"}}}},"200":{"description":"OK","headers":{"X-Request-ID":{"description":"Request identifier echoed for support and reconciliation.","schema":{"type":"string"}},"X-Quota-Limit":{"description":"Monthly API request allowance for the subscription.","schema":{"type":"integer","format":"int64"}},"X-Quota-Remaining":{"description":"Requests remaining in the current monthly allowance after this request.","schema":{"type":"integer","format":"int64"}},"X-Quota-Reset":{"description":"Unix epoch time in seconds when the monthly allowance resets.","schema":{"type":"integer","format":"int64"}},"X-Quota-Workspace":{"description":"Verified workspace owning this allowance: personal or enterprise:<id>.","schema":{"type":"string"}},"X-Quota-Environment":{"description":"Environment owning the allowance: sandbox or live.","schema":{"type":"string"}}},"content":{"application/json":{"schema":{"$ref":"#/components/schemas/ApiResponseBlockchainAddressResponse"}}}},"401":{"description":"Invalid API key, content hash, signature, timestamp or request ID","headers":{"X-Request-ID":{"description":"Request identifier echoed for support and reconciliation.","schema":{"type":"string"}}},"content":{"application/json":{"schema":{"$ref":"#/components/schemas/ApiResponseVoid"}}}},"404":{"description":"Resource not found in this enterprise and environment","headers":{"X-Request-ID":{"description":"Request identifier echoed for support and reconciliation.","schema":{"type":"string"}}},"content":{"application/json":{"schema":{"$ref":"#/components/schemas/ApiResponseVoid"}}}},"422":{"description":"Business rule rejected the request","headers":{"X-Request-ID":{"description":"Request identifier echoed for support and reconciliation.","schema":{"type":"string"}}},"content":{"application/json":{"schema":{"$ref":"#/components/schemas/ApiResponseVoid"}}}},"503":{"description":"A required platform service is temporarily unavailable","headers":{"X-Request-ID":{"description":"Request identifier echoed for support and reconciliation.","schema":{"type":"string"}}},"content":{"application/json":{"schema":{"$ref":"#/components/schemas/ApiResponseVoid"}}}},"409":{"description":"Idempotency or resource-state conflict","headers":{"X-Request-ID":{"description":"Request identifier echoed for support and reconciliation.","schema":{"type":"string"}}},"content":{"application/json":{"schema":{"$ref":"#/components/schemas/ApiResponseVoid"}}}},"429":{"description":"Per-minute rate limit or monthly quota exceeded","headers":{"X-Request-ID":{"description":"Request identifier echoed for support and reconciliation.","schema":{"type":"string"}},"X-Quota-Limit":{"description":"Monthly API request allowance for the subscription.","schema":{"type":"integer","format":"int64"}},"X-Quota-Remaining":{"description":"Requests remaining in the current monthly allowance after this request.","schema":{"type":"integer","format":"int64"}},"X-Quota-Reset":{"description":"Unix epoch time in seconds when the monthly allowance resets.","schema":{"type":"integer","format":"int64"}},"X-Quota-Workspace":{"description":"Verified workspace owning this allowance: personal or enterprise:<id>.","schema":{"type":"string"}},"X-Quota-Environment":{"description":"Environment owning the allowance: sandbox or live.","schema":{"type":"string"}},"Retry-After":{"description":"Seconds until the exhausted quota or rate window resets. Sign retries with a new X-Request-ID.","schema":{"type":"integer","format":"int64"}},"X-RateLimit-Scope":{"description":"Rate counter scope: workspace, or user for enterprise verification calls.","schema":{"type":"string"}},"X-RateLimit-Limit":{"description":"Per-minute request limit when rate-limited.","schema":{"type":"integer","format":"int64"}},"X-RateLimit-Remaining":{"description":"Zero when the minute limit is exhausted.","schema":{"type":"integer","format":"int64"}},"X-RateLimit-Reset":{"description":"Unix epoch seconds when the minute limit resets.","schema":{"type":"integer","format":"int64"}}},"content":{"application/json":{"schema":{"$ref":"#/components/schemas/ApiResponseVoid"}}}},"413":{"description":"Request body is too large","headers":{"X-Request-ID":{"description":"Request identifier echoed for support and reconciliation.","schema":{"type":"string"}}},"content":{"application/json":{"schema":{"$ref":"#/components/schemas/ApiResponseVoid"}}}}},"x-dcwallet-signature-versions":["v1","v2"]}},"/api/v1/bank-options":{"get":{"tags":["2. Receiving accounts"],"summary":"List banks currently available for account applications","description":"Includes eligible enterprise registration countries and required KYB materials.\n\nSignature versions: v1 and v2.","operationId":"getBankOptions","parameters":[{"name":"X-Timestamp","in":"header","description":"Current Unix epoch time in seconds. Requests older or newer than five minutes are rejected.","required":true,"schema":{"pattern":"[0-9]{10}","type":"string","example":"1787562000"}},{"name":"X-Request-ID","in":"header","description":"Unique 16-128 character request identifier used for replay protection; never reuse it for a different HTTP request.","required":true,"schema":{"pattern":"[A-Za-z0-9._:-]{16,128}","type":"string","example":"018f6f4e-8f62-7fc2-9c4b-7be2f4203b6a"}},{"name":"X-Content-SHA256","in":"header","description":"Lowercase hexadecimal SHA-256 digest of the exact raw request body; use the digest of zero bytes when no body is sent.","required":true,"schema":{"pattern":"[0-9a-f]{64}","type":"string","example":"e3b0c44298fc1c149afbf4c8996fb92427ae41e4649b934ca495991b7852b855"}},{"name":"X-Workspace","in":"header","description":"Personal and enterprise reads are available on this route. For enterprise access, copy your own enterprise:<id> from GET /api/v1/workspaces. Required for v2 requests. V1 requests use the historical key's fixed enterprise.","required":false,"schema":{"pattern":"personal|enterprise:[1-9][0-9]*","type":"string","example":"personal"}},{"name":"X-Environment","in":"header","description":"Required and signed for v2 requests: live or sandbox. Optional for v1 requests.","required":false,"schema":{"pattern":"live|sandbox","type":"string","example":"live"}},{"name":"X-Signature","in":"header","description":"Existing keys accept v1 for their fixed enterprise or v2 for a signed workspace; new keys accept v2 only.","required":true,"schema":{"pattern":"v[12]=[0-9a-f]{64}","type":"string","example":"v2=0123456789abcdef0123456789abcdef0123456789abcdef0123456789abcdef"}},{"name":"Accept-Language","in":"header","description":"Response language: en-US = English (default); zh-CN = Simplified Chinese; zh-TW = Traditional Chinese. Numeric error codes are language-neutral.","required":false,"schema":{"type":"string","enum":["en-US","zh-CN","zh-TW"],"default":"en-US"}}],"responses":{"400":{"description":"Malformed JSON, missing header or invalid request parameter","headers":{"X-Request-ID":{"description":"Request identifier echoed for support and reconciliation.","schema":{"type":"string"}}},"content":{"application/json":{"schema":{"$ref":"#/components/schemas/ApiResponseVoid"}}}},"500":{"description":"Unexpected internal error; contact support with X-Request-ID","headers":{"X-Request-ID":{"description":"Request identifier echoed for support and reconciliation.","schema":{"type":"string"}}},"content":{"application/json":{"schema":{"$ref":"#/components/schemas/ApiResponseVoid"}}}},"403":{"description":"API-key scope, subscription, tenant or policy does not allow the operation","headers":{"X-Request-ID":{"description":"Request identifier echoed for support and reconciliation.","schema":{"type":"string"}}},"content":{"application/json":{"schema":{"$ref":"#/components/schemas/ApiResponseVoid"}}}},"200":{"description":"OK","headers":{"X-Request-ID":{"description":"Request identifier echoed for support and reconciliation.","schema":{"type":"string"}},"X-Quota-Limit":{"description":"Monthly API request allowance for the subscription.","schema":{"type":"integer","format":"int64"}},"X-Quota-Remaining":{"description":"Requests remaining in the current monthly allowance after this request.","schema":{"type":"integer","format":"int64"}},"X-Quota-Reset":{"description":"Unix epoch time in seconds when the monthly allowance resets.","schema":{"type":"integer","format":"int64"}},"X-Quota-Workspace":{"description":"Verified workspace owning this allowance: personal or enterprise:<id>.","schema":{"type":"string"}},"X-Quota-Environment":{"description":"Environment owning the allowance: sandbox or live.","schema":{"type":"string"}}},"content":{"application/json":{"schema":{"$ref":"#/components/schemas/ApiResponseListBankOptionResponse"}}}},"401":{"description":"Invalid API key, content hash, signature, timestamp or request ID","headers":{"X-Request-ID":{"description":"Request identifier echoed for support and reconciliation.","schema":{"type":"string"}}},"content":{"application/json":{"schema":{"$ref":"#/components/schemas/ApiResponseVoid"}}}},"404":{"description":"Resource not found in this enterprise and environment","headers":{"X-Request-ID":{"description":"Request identifier echoed for support and reconciliation.","schema":{"type":"string"}}},"content":{"application/json":{"schema":{"$ref":"#/components/schemas/ApiResponseVoid"}}}},"422":{"description":"Business rule rejected the request","headers":{"X-Request-ID":{"description":"Request identifier echoed for support and reconciliation.","schema":{"type":"string"}}},"content":{"application/json":{"schema":{"$ref":"#/components/schemas/ApiResponseVoid"}}}},"503":{"description":"A required platform service is temporarily unavailable","headers":{"X-Request-ID":{"description":"Request identifier echoed for support and reconciliation.","schema":{"type":"string"}}},"content":{"application/json":{"schema":{"$ref":"#/components/schemas/ApiResponseVoid"}}}},"409":{"description":"Idempotency or resource-state conflict","headers":{"X-Request-ID":{"description":"Request identifier echoed for support and reconciliation.","schema":{"type":"string"}}},"content":{"application/json":{"schema":{"$ref":"#/components/schemas/ApiResponseVoid"}}}},"429":{"description":"Per-minute rate limit or monthly quota exceeded","headers":{"X-Request-ID":{"description":"Request identifier echoed for support and reconciliation.","schema":{"type":"string"}},"X-Quota-Limit":{"description":"Monthly API request allowance for the subscription.","schema":{"type":"integer","format":"int64"}},"X-Quota-Remaining":{"description":"Requests remaining in the current monthly allowance after this request.","schema":{"type":"integer","format":"int64"}},"X-Quota-Reset":{"description":"Unix epoch time in seconds when the monthly allowance resets.","schema":{"type":"integer","format":"int64"}},"X-Quota-Workspace":{"description":"Verified workspace owning this allowance: personal or enterprise:<id>.","schema":{"type":"string"}},"X-Quota-Environment":{"description":"Environment owning the allowance: sandbox or live.","schema":{"type":"string"}},"Retry-After":{"description":"Seconds until the exhausted quota or rate window resets. Sign retries with a new X-Request-ID.","schema":{"type":"integer","format":"int64"}},"X-RateLimit-Scope":{"description":"Rate counter scope: workspace, or user for enterprise verification calls.","schema":{"type":"string"}},"X-RateLimit-Limit":{"description":"Per-minute request limit when rate-limited.","schema":{"type":"integer","format":"int64"}},"X-RateLimit-Remaining":{"description":"Zero when the minute limit is exhausted.","schema":{"type":"integer","format":"int64"}},"X-RateLimit-Reset":{"description":"Unix epoch seconds when the minute limit resets.","schema":{"type":"integer","format":"int64"}}},"content":{"application/json":{"schema":{"$ref":"#/components/schemas/ApiResponseVoid"}}}},"413":{"description":"Request body is too large","headers":{"X-Request-ID":{"description":"Request identifier echoed for support and reconciliation.","schema":{"type":"string"}}},"content":{"application/json":{"schema":{"$ref":"#/components/schemas/ApiResponseVoid"}}}}},"x-dcwallet-signature-versions":["v1","v2"]}},"/api/v1/bank-options/{bankId}/requirements":{"get":{"tags":["2. Receiving accounts"],"summary":"Check bank eligibility and missing KYB materials before applying","description":"Signature versions: v2 only.","operationId":"getBankOptionsByBankIdRequirements","parameters":[{"name":"bankId","in":"path","description":"The bank id value for this resource.","required":true,"schema":{"pattern":"[0-9]+","type":"string","example":"337893979704000512"}},{"name":"X-Timestamp","in":"header","description":"Current Unix epoch time in seconds. Requests older or newer than five minutes are rejected.","required":true,"schema":{"pattern":"[0-9]{10}","type":"string","example":"1787562000"}},{"name":"X-Request-ID","in":"header","description":"Unique 16-128 character request identifier used for replay protection; never reuse it for a different HTTP request.","required":true,"schema":{"pattern":"[A-Za-z0-9._:-]{16,128}","type":"string","example":"018f6f4e-8f62-7fc2-9c4b-7be2f4203b6a"}},{"name":"X-Content-SHA256","in":"header","description":"Lowercase hexadecimal SHA-256 digest of the exact raw request body; use the digest of zero bytes when no body is sent.","required":true,"schema":{"pattern":"[0-9a-f]{64}","type":"string","example":"e3b0c44298fc1c149afbf4c8996fb92427ae41e4649b934ca495991b7852b855"}},{"name":"X-Workspace","in":"header","description":"Signed workspace selector: personal or enterprise:<id>. Get your enterprise ID from GET /api/v1/workspaces.","required":true,"schema":{"pattern":"personal|enterprise:[1-9][0-9]*","type":"string","example":"personal"}},{"name":"X-Environment","in":"header","description":"Signed key environment: live or sandbox.","required":true,"schema":{"pattern":"live|sandbox","type":"string","example":"live"}},{"name":"X-Signature","in":"header","description":"v2-prefixed lowercase HMAC-SHA256 signature; existing and new keys can use v2 when enabled.","required":true,"schema":{"pattern":"v2=[0-9a-f]{64}","type":"string","example":"v2=0123456789abcdef0123456789abcdef0123456789abcdef0123456789abcdef"}},{"name":"Accept-Language","in":"header","description":"Response language: en-US = English (default); zh-CN = Simplified Chinese; zh-TW = Traditional Chinese. Numeric error codes are language-neutral.","required":false,"schema":{"type":"string","enum":["en-US","zh-CN","zh-TW"],"default":"en-US"}}],"responses":{"400":{"description":"Malformed JSON, missing header or invalid request parameter","headers":{"X-Request-ID":{"description":"Request identifier echoed for support and reconciliation.","schema":{"type":"string"}}},"content":{"application/json":{"schema":{"$ref":"#/components/schemas/ApiResponseVoid"}}}},"500":{"description":"Unexpected internal error; contact support with X-Request-ID","headers":{"X-Request-ID":{"description":"Request identifier echoed for support and reconciliation.","schema":{"type":"string"}}},"content":{"application/json":{"schema":{"$ref":"#/components/schemas/ApiResponseVoid"}}}},"403":{"description":"API-key scope, subscription, tenant or policy does not allow the operation","headers":{"X-Request-ID":{"description":"Request identifier echoed for support and reconciliation.","schema":{"type":"string"}}},"content":{"application/json":{"schema":{"$ref":"#/components/schemas/ApiResponseVoid"}}}},"200":{"description":"OK","headers":{"X-Request-ID":{"description":"Request identifier echoed for support and reconciliation.","schema":{"type":"string"}},"X-Quota-Limit":{"description":"Monthly API request allowance for the subscription.","schema":{"type":"integer","format":"int64"}},"X-Quota-Remaining":{"description":"Requests remaining in the current monthly allowance after this request.","schema":{"type":"integer","format":"int64"}},"X-Quota-Reset":{"description":"Unix epoch time in seconds when the monthly allowance resets.","schema":{"type":"integer","format":"int64"}},"X-Quota-Workspace":{"description":"Verified workspace owning this allowance: personal or enterprise:<id>.","schema":{"type":"string"}},"X-Quota-Environment":{"description":"Environment owning the allowance: sandbox or live.","schema":{"type":"string"}}},"content":{"application/json":{"schema":{"$ref":"#/components/schemas/ApiResponseBankOptionResponse"}}}},"401":{"description":"Invalid API key, content hash, signature, timestamp or request ID","headers":{"X-Request-ID":{"description":"Request identifier echoed for support and reconciliation.","schema":{"type":"string"}}},"content":{"application/json":{"schema":{"$ref":"#/components/schemas/ApiResponseVoid"}}}},"404":{"description":"Resource not found in this enterprise and environment","headers":{"X-Request-ID":{"description":"Request identifier echoed for support and reconciliation.","schema":{"type":"string"}}},"content":{"application/json":{"schema":{"$ref":"#/components/schemas/ApiResponseVoid"}}}},"422":{"description":"Business rule rejected the request","headers":{"X-Request-ID":{"description":"Request identifier echoed for support and reconciliation.","schema":{"type":"string"}}},"content":{"application/json":{"schema":{"$ref":"#/components/schemas/ApiResponseVoid"}}}},"503":{"description":"A required platform service is temporarily unavailable","headers":{"X-Request-ID":{"description":"Request identifier echoed for support and reconciliation.","schema":{"type":"string"}}},"content":{"application/json":{"schema":{"$ref":"#/components/schemas/ApiResponseVoid"}}}},"409":{"description":"Idempotency or resource-state conflict","headers":{"X-Request-ID":{"description":"Request identifier echoed for support and reconciliation.","schema":{"type":"string"}}},"content":{"application/json":{"schema":{"$ref":"#/components/schemas/ApiResponseVoid"}}}},"429":{"description":"Per-minute rate limit or monthly quota exceeded","headers":{"X-Request-ID":{"description":"Request identifier echoed for support and reconciliation.","schema":{"type":"string"}},"X-Quota-Limit":{"description":"Monthly API request allowance for the subscription.","schema":{"type":"integer","format":"int64"}},"X-Quota-Remaining":{"description":"Requests remaining in the current monthly allowance after this request.","schema":{"type":"integer","format":"int64"}},"X-Quota-Reset":{"description":"Unix epoch time in seconds when the monthly allowance resets.","schema":{"type":"integer","format":"int64"}},"X-Quota-Workspace":{"description":"Verified workspace owning this allowance: personal or enterprise:<id>.","schema":{"type":"string"}},"X-Quota-Environment":{"description":"Environment owning the allowance: sandbox or live.","schema":{"type":"string"}},"Retry-After":{"description":"Seconds until the exhausted quota or rate window resets. Sign retries with a new X-Request-ID.","schema":{"type":"integer","format":"int64"}},"X-RateLimit-Scope":{"description":"Rate counter scope: workspace, or user for enterprise verification calls.","schema":{"type":"string"}},"X-RateLimit-Limit":{"description":"Per-minute request limit when rate-limited.","schema":{"type":"integer","format":"int64"}},"X-RateLimit-Remaining":{"description":"Zero when the minute limit is exhausted.","schema":{"type":"integer","format":"int64"}},"X-RateLimit-Reset":{"description":"Unix epoch seconds when the minute limit resets.","schema":{"type":"integer","format":"int64"}}},"content":{"application/json":{"schema":{"$ref":"#/components/schemas/ApiResponseVoid"}}}},"413":{"description":"Request body is too large","headers":{"X-Request-ID":{"description":"Request identifier echoed for support and reconciliation.","schema":{"type":"string"}}},"content":{"application/json":{"schema":{"$ref":"#/components/schemas/ApiResponseVoid"}}}}},"x-dcwallet-signature-versions":["v2"]}},"/api/v1/bank-accounts":{"get":{"tags":["2. Receiving accounts"],"summary":"List bank receiving accounts in the selected workspace","description":"The returned ID identifies a bank receiving account in this workspace. Enterprise v1 clients may use it as bankAccountId when creating an invoice.\n\nSignature versions: v1 and v2.","operationId":"getBankAccounts","parameters":[{"name":"X-Timestamp","in":"header","description":"Current Unix epoch time in seconds. Requests older or newer than five minutes are rejected.","required":true,"schema":{"pattern":"[0-9]{10}","type":"string","example":"1787562000"}},{"name":"X-Request-ID","in":"header","description":"Unique 16-128 character request identifier used for replay protection; never reuse it for a different HTTP request.","required":true,"schema":{"pattern":"[A-Za-z0-9._:-]{16,128}","type":"string","example":"018f6f4e-8f62-7fc2-9c4b-7be2f4203b6a"}},{"name":"X-Content-SHA256","in":"header","description":"Lowercase hexadecimal SHA-256 digest of the exact raw request body; use the digest of zero bytes when no body is sent.","required":true,"schema":{"pattern":"[0-9a-f]{64}","type":"string","example":"e3b0c44298fc1c149afbf4c8996fb92427ae41e4649b934ca495991b7852b855"}},{"name":"X-Workspace","in":"header","description":"Personal and enterprise reads are available on this route. For enterprise access, copy your own enterprise:<id> from GET /api/v1/workspaces. Required for v2 requests. V1 requests use the historical key's fixed enterprise.","required":false,"schema":{"pattern":"personal|enterprise:[1-9][0-9]*","type":"string","example":"personal"}},{"name":"X-Environment","in":"header","description":"Required and signed for v2 requests: live or sandbox. Optional for v1 requests.","required":false,"schema":{"pattern":"live|sandbox","type":"string","example":"live"}},{"name":"X-Signature","in":"header","description":"Existing keys accept v1 for their fixed enterprise or v2 for a signed workspace; new keys accept v2 only.","required":true,"schema":{"pattern":"v[12]=[0-9a-f]{64}","type":"string","example":"v2=0123456789abcdef0123456789abcdef0123456789abcdef0123456789abcdef"}},{"name":"Accept-Language","in":"header","description":"Response language: en-US = English (default); zh-CN = Simplified Chinese; zh-TW = Traditional Chinese. Numeric error codes are language-neutral.","required":false,"schema":{"type":"string","enum":["en-US","zh-CN","zh-TW"],"default":"en-US"}}],"responses":{"400":{"description":"Malformed JSON, missing header or invalid request parameter","headers":{"X-Request-ID":{"description":"Request identifier echoed for support and reconciliation.","schema":{"type":"string"}}},"content":{"application/json":{"schema":{"$ref":"#/components/schemas/ApiResponseVoid"}}}},"500":{"description":"Unexpected internal error; contact support with X-Request-ID","headers":{"X-Request-ID":{"description":"Request identifier echoed for support and reconciliation.","schema":{"type":"string"}}},"content":{"application/json":{"schema":{"$ref":"#/components/schemas/ApiResponseVoid"}}}},"403":{"description":"API-key scope, subscription, tenant or policy does not allow the operation","headers":{"X-Request-ID":{"description":"Request identifier echoed for support and reconciliation.","schema":{"type":"string"}}},"content":{"application/json":{"schema":{"$ref":"#/components/schemas/ApiResponseVoid"}}}},"200":{"description":"OK","headers":{"X-Request-ID":{"description":"Request identifier echoed for support and reconciliation.","schema":{"type":"string"}},"X-Quota-Limit":{"description":"Monthly API request allowance for the subscription.","schema":{"type":"integer","format":"int64"}},"X-Quota-Remaining":{"description":"Requests remaining in the current monthly allowance after this request.","schema":{"type":"integer","format":"int64"}},"X-Quota-Reset":{"description":"Unix epoch time in seconds when the monthly allowance resets.","schema":{"type":"integer","format":"int64"}},"X-Quota-Workspace":{"description":"Verified workspace owning this allowance: personal or enterprise:<id>.","schema":{"type":"string"}},"X-Quota-Environment":{"description":"Environment owning the allowance: sandbox or live.","schema":{"type":"string"}}},"content":{"application/json":{"schema":{"$ref":"#/components/schemas/ApiResponseListBankAccountResponse"}}}},"401":{"description":"Invalid API key, content hash, signature, timestamp or request ID","headers":{"X-Request-ID":{"description":"Request identifier echoed for support and reconciliation.","schema":{"type":"string"}}},"content":{"application/json":{"schema":{"$ref":"#/components/schemas/ApiResponseVoid"}}}},"404":{"description":"Resource not found in this enterprise and environment","headers":{"X-Request-ID":{"description":"Request identifier echoed for support and reconciliation.","schema":{"type":"string"}}},"content":{"application/json":{"schema":{"$ref":"#/components/schemas/ApiResponseVoid"}}}},"422":{"description":"Business rule rejected the request","headers":{"X-Request-ID":{"description":"Request identifier echoed for support and reconciliation.","schema":{"type":"string"}}},"content":{"application/json":{"schema":{"$ref":"#/components/schemas/ApiResponseVoid"}}}},"503":{"description":"A required platform service is temporarily unavailable","headers":{"X-Request-ID":{"description":"Request identifier echoed for support and reconciliation.","schema":{"type":"string"}}},"content":{"application/json":{"schema":{"$ref":"#/components/schemas/ApiResponseVoid"}}}},"409":{"description":"Idempotency or resource-state conflict","headers":{"X-Request-ID":{"description":"Request identifier echoed for support and reconciliation.","schema":{"type":"string"}}},"content":{"application/json":{"schema":{"$ref":"#/components/schemas/ApiResponseVoid"}}}},"429":{"description":"Per-minute rate limit or monthly quota exceeded","headers":{"X-Request-ID":{"description":"Request identifier echoed for support and reconciliation.","schema":{"type":"string"}},"X-Quota-Limit":{"description":"Monthly API request allowance for the subscription.","schema":{"type":"integer","format":"int64"}},"X-Quota-Remaining":{"description":"Requests remaining in the current monthly allowance after this request.","schema":{"type":"integer","format":"int64"}},"X-Quota-Reset":{"description":"Unix epoch time in seconds when the monthly allowance resets.","schema":{"type":"integer","format":"int64"}},"X-Quota-Workspace":{"description":"Verified workspace owning this allowance: personal or enterprise:<id>.","schema":{"type":"string"}},"X-Quota-Environment":{"description":"Environment owning the allowance: sandbox or live.","schema":{"type":"string"}},"Retry-After":{"description":"Seconds until the exhausted quota or rate window resets. Sign retries with a new X-Request-ID.","schema":{"type":"integer","format":"int64"}},"X-RateLimit-Scope":{"description":"Rate counter scope: workspace, or user for enterprise verification calls.","schema":{"type":"string"}},"X-RateLimit-Limit":{"description":"Per-minute request limit when rate-limited.","schema":{"type":"integer","format":"int64"}},"X-RateLimit-Remaining":{"description":"Zero when the minute limit is exhausted.","schema":{"type":"integer","format":"int64"}},"X-RateLimit-Reset":{"description":"Unix epoch seconds when the minute limit resets.","schema":{"type":"integer","format":"int64"}}},"content":{"application/json":{"schema":{"$ref":"#/components/schemas/ApiResponseVoid"}}}},"413":{"description":"Request body is too large","headers":{"X-Request-ID":{"description":"Request identifier echoed for support and reconciliation.","schema":{"type":"string"}}},"content":{"application/json":{"schema":{"$ref":"#/components/schemas/ApiResponseVoid"}}}}},"x-dcwallet-signature-versions":["v1","v2"]}},"/api/v1/bank-accounts/{accountId}":{"get":{"tags":["2. Receiving accounts"],"summary":"Get a bank receiving account in the selected workspace","description":"Signature versions: v1 and v2.","operationId":"getBankAccountsByAccountId","parameters":[{"name":"accountId","in":"path","description":"Account ID returned by the corresponding account list endpoint. Keep IDs as strings.","required":true,"schema":{"pattern":"[0-9]+","type":"string","example":"337893979704000512"}},{"name":"X-Timestamp","in":"header","description":"Current Unix epoch time in seconds. Requests older or newer than five minutes are rejected.","required":true,"schema":{"pattern":"[0-9]{10}","type":"string","example":"1787562000"}},{"name":"X-Request-ID","in":"header","description":"Unique 16-128 character request identifier used for replay protection; never reuse it for a different HTTP request.","required":true,"schema":{"pattern":"[A-Za-z0-9._:-]{16,128}","type":"string","example":"018f6f4e-8f62-7fc2-9c4b-7be2f4203b6a"}},{"name":"X-Content-SHA256","in":"header","description":"Lowercase hexadecimal SHA-256 digest of the exact raw request body; use the digest of zero bytes when no body is sent.","required":true,"schema":{"pattern":"[0-9a-f]{64}","type":"string","example":"e3b0c44298fc1c149afbf4c8996fb92427ae41e4649b934ca495991b7852b855"}},{"name":"X-Workspace","in":"header","description":"Personal and enterprise reads are available on this route. For enterprise access, copy your own enterprise:<id> from GET /api/v1/workspaces. Required for v2 requests. V1 requests use the historical key's fixed enterprise.","required":false,"schema":{"pattern":"personal|enterprise:[1-9][0-9]*","type":"string","example":"personal"}},{"name":"X-Environment","in":"header","description":"Required and signed for v2 requests: live or sandbox. Optional for v1 requests.","required":false,"schema":{"pattern":"live|sandbox","type":"string","example":"live"}},{"name":"X-Signature","in":"header","description":"Existing keys accept v1 for their fixed enterprise or v2 for a signed workspace; new keys accept v2 only.","required":true,"schema":{"pattern":"v[12]=[0-9a-f]{64}","type":"string","example":"v2=0123456789abcdef0123456789abcdef0123456789abcdef0123456789abcdef"}},{"name":"Accept-Language","in":"header","description":"Response language: en-US = English (default); zh-CN = Simplified Chinese; zh-TW = Traditional Chinese. Numeric error codes are language-neutral.","required":false,"schema":{"type":"string","enum":["en-US","zh-CN","zh-TW"],"default":"en-US"}}],"responses":{"400":{"description":"Malformed JSON, missing header or invalid request parameter","headers":{"X-Request-ID":{"description":"Request identifier echoed for support and reconciliation.","schema":{"type":"string"}}},"content":{"application/json":{"schema":{"$ref":"#/components/schemas/ApiResponseVoid"}}}},"500":{"description":"Unexpected internal error; contact support with X-Request-ID","headers":{"X-Request-ID":{"description":"Request identifier echoed for support and reconciliation.","schema":{"type":"string"}}},"content":{"application/json":{"schema":{"$ref":"#/components/schemas/ApiResponseVoid"}}}},"403":{"description":"API-key scope, subscription, tenant or policy does not allow the operation","headers":{"X-Request-ID":{"description":"Request identifier echoed for support and reconciliation.","schema":{"type":"string"}}},"content":{"application/json":{"schema":{"$ref":"#/components/schemas/ApiResponseVoid"}}}},"200":{"description":"OK","headers":{"X-Request-ID":{"description":"Request identifier echoed for support and reconciliation.","schema":{"type":"string"}},"X-Quota-Limit":{"description":"Monthly API request allowance for the subscription.","schema":{"type":"integer","format":"int64"}},"X-Quota-Remaining":{"description":"Requests remaining in the current monthly allowance after this request.","schema":{"type":"integer","format":"int64"}},"X-Quota-Reset":{"description":"Unix epoch time in seconds when the monthly allowance resets.","schema":{"type":"integer","format":"int64"}},"X-Quota-Workspace":{"description":"Verified workspace owning this allowance: personal or enterprise:<id>.","schema":{"type":"string"}},"X-Quota-Environment":{"description":"Environment owning the allowance: sandbox or live.","schema":{"type":"string"}}},"content":{"application/json":{"schema":{"$ref":"#/components/schemas/ApiResponseBankAccountResponse"}}}},"401":{"description":"Invalid API key, content hash, signature, timestamp or request ID","headers":{"X-Request-ID":{"description":"Request identifier echoed for support and reconciliation.","schema":{"type":"string"}}},"content":{"application/json":{"schema":{"$ref":"#/components/schemas/ApiResponseVoid"}}}},"404":{"description":"Resource not found in this enterprise and environment","headers":{"X-Request-ID":{"description":"Request identifier echoed for support and reconciliation.","schema":{"type":"string"}}},"content":{"application/json":{"schema":{"$ref":"#/components/schemas/ApiResponseVoid"}}}},"422":{"description":"Business rule rejected the request","headers":{"X-Request-ID":{"description":"Request identifier echoed for support and reconciliation.","schema":{"type":"string"}}},"content":{"application/json":{"schema":{"$ref":"#/components/schemas/ApiResponseVoid"}}}},"503":{"description":"A required platform service is temporarily unavailable","headers":{"X-Request-ID":{"description":"Request identifier echoed for support and reconciliation.","schema":{"type":"string"}}},"content":{"application/json":{"schema":{"$ref":"#/components/schemas/ApiResponseVoid"}}}},"409":{"description":"Idempotency or resource-state conflict","headers":{"X-Request-ID":{"description":"Request identifier echoed for support and reconciliation.","schema":{"type":"string"}}},"content":{"application/json":{"schema":{"$ref":"#/components/schemas/ApiResponseVoid"}}}},"429":{"description":"Per-minute rate limit or monthly quota exceeded","headers":{"X-Request-ID":{"description":"Request identifier echoed for support and reconciliation.","schema":{"type":"string"}},"X-Quota-Limit":{"description":"Monthly API request allowance for the subscription.","schema":{"type":"integer","format":"int64"}},"X-Quota-Remaining":{"description":"Requests remaining in the current monthly allowance after this request.","schema":{"type":"integer","format":"int64"}},"X-Quota-Reset":{"description":"Unix epoch time in seconds when the monthly allowance resets.","schema":{"type":"integer","format":"int64"}},"X-Quota-Workspace":{"description":"Verified workspace owning this allowance: personal or enterprise:<id>.","schema":{"type":"string"}},"X-Quota-Environment":{"description":"Environment owning the allowance: sandbox or live.","schema":{"type":"string"}},"Retry-After":{"description":"Seconds until the exhausted quota or rate window resets. Sign retries with a new X-Request-ID.","schema":{"type":"integer","format":"int64"}},"X-RateLimit-Scope":{"description":"Rate counter scope: workspace, or user for enterprise verification calls.","schema":{"type":"string"}},"X-RateLimit-Limit":{"description":"Per-minute request limit when rate-limited.","schema":{"type":"integer","format":"int64"}},"X-RateLimit-Remaining":{"description":"Zero when the minute limit is exhausted.","schema":{"type":"integer","format":"int64"}},"X-RateLimit-Reset":{"description":"Unix epoch seconds when the minute limit resets.","schema":{"type":"integer","format":"int64"}}},"content":{"application/json":{"schema":{"$ref":"#/components/schemas/ApiResponseVoid"}}}},"413":{"description":"Request body is too large","headers":{"X-Request-ID":{"description":"Request identifier echoed for support and reconciliation.","schema":{"type":"string"}}},"content":{"application/json":{"schema":{"$ref":"#/components/schemas/ApiResponseVoid"}}}}},"x-dcwallet-signature-versions":["v1","v2"]}},"/api/v1/bank-account-applications/{applicationId}":{"get":{"tags":["2. Receiving accounts"],"summary":"Get a bank account application","description":"Signature versions: v1 and v2.","operationId":"getBankAccountApplicationsByApplicationId","parameters":[{"name":"applicationId","in":"path","description":"Card application ID returned by /api/v1/card-applications. Keep IDs as strings.","required":true,"schema":{"pattern":"[0-9]+","type":"string","example":"337893979704000512"}},{"name":"X-Timestamp","in":"header","description":"Current Unix epoch time in seconds. Requests older or newer than five minutes are rejected.","required":true,"schema":{"pattern":"[0-9]{10}","type":"string","example":"1787562000"}},{"name":"X-Request-ID","in":"header","description":"Unique 16-128 character request identifier used for replay protection; never reuse it for a different HTTP request.","required":true,"schema":{"pattern":"[A-Za-z0-9._:-]{16,128}","type":"string","example":"018f6f4e-8f62-7fc2-9c4b-7be2f4203b6a"}},{"name":"X-Content-SHA256","in":"header","description":"Lowercase hexadecimal SHA-256 digest of the exact raw request body; use the digest of zero bytes when no body is sent.","required":true,"schema":{"pattern":"[0-9a-f]{64}","type":"string","example":"e3b0c44298fc1c149afbf4c8996fb92427ae41e4649b934ca495991b7852b855"}},{"name":"X-Workspace","in":"header","description":"Personal and enterprise reads are available on this route. For enterprise access, copy your own enterprise:<id> from GET /api/v1/workspaces. Required for v2 requests. V1 requests use the historical key's fixed enterprise.","required":false,"schema":{"pattern":"personal|enterprise:[1-9][0-9]*","type":"string","example":"personal"}},{"name":"X-Environment","in":"header","description":"Required and signed for v2 requests: live or sandbox. Optional for v1 requests.","required":false,"schema":{"pattern":"live|sandbox","type":"string","example":"live"}},{"name":"X-Signature","in":"header","description":"Existing keys accept v1 for their fixed enterprise or v2 for a signed workspace; new keys accept v2 only.","required":true,"schema":{"pattern":"v[12]=[0-9a-f]{64}","type":"string","example":"v2=0123456789abcdef0123456789abcdef0123456789abcdef0123456789abcdef"}},{"name":"Accept-Language","in":"header","description":"Response language: en-US = English (default); zh-CN = Simplified Chinese; zh-TW = Traditional Chinese. Numeric error codes are language-neutral.","required":false,"schema":{"type":"string","enum":["en-US","zh-CN","zh-TW"],"default":"en-US"}}],"responses":{"400":{"description":"Malformed JSON, missing header or invalid request parameter","headers":{"X-Request-ID":{"description":"Request identifier echoed for support and reconciliation.","schema":{"type":"string"}}},"content":{"application/json":{"schema":{"$ref":"#/components/schemas/ApiResponseVoid"}}}},"500":{"description":"Unexpected internal error; contact support with X-Request-ID","headers":{"X-Request-ID":{"description":"Request identifier echoed for support and reconciliation.","schema":{"type":"string"}}},"content":{"application/json":{"schema":{"$ref":"#/components/schemas/ApiResponseVoid"}}}},"403":{"description":"API-key scope, subscription, tenant or policy does not allow the operation","headers":{"X-Request-ID":{"description":"Request identifier echoed for support and reconciliation.","schema":{"type":"string"}}},"content":{"application/json":{"schema":{"$ref":"#/components/schemas/ApiResponseVoid"}}}},"200":{"description":"OK","headers":{"X-Request-ID":{"description":"Request identifier echoed for support and reconciliation.","schema":{"type":"string"}},"X-Quota-Limit":{"description":"Monthly API request allowance for the subscription.","schema":{"type":"integer","format":"int64"}},"X-Quota-Remaining":{"description":"Requests remaining in the current monthly allowance after this request.","schema":{"type":"integer","format":"int64"}},"X-Quota-Reset":{"description":"Unix epoch time in seconds when the monthly allowance resets.","schema":{"type":"integer","format":"int64"}},"X-Quota-Workspace":{"description":"Verified workspace owning this allowance: personal or enterprise:<id>.","schema":{"type":"string"}},"X-Quota-Environment":{"description":"Environment owning the allowance: sandbox or live.","schema":{"type":"string"}}},"content":{"application/json":{"schema":{"$ref":"#/components/schemas/ApiResponseApplicationResponse"}}}},"401":{"description":"Invalid API key, content hash, signature, timestamp or request ID","headers":{"X-Request-ID":{"description":"Request identifier echoed for support and reconciliation.","schema":{"type":"string"}}},"content":{"application/json":{"schema":{"$ref":"#/components/schemas/ApiResponseVoid"}}}},"404":{"description":"Resource not found in this enterprise and environment","headers":{"X-Request-ID":{"description":"Request identifier echoed for support and reconciliation.","schema":{"type":"string"}}},"content":{"application/json":{"schema":{"$ref":"#/components/schemas/ApiResponseVoid"}}}},"422":{"description":"Business rule rejected the request","headers":{"X-Request-ID":{"description":"Request identifier echoed for support and reconciliation.","schema":{"type":"string"}}},"content":{"application/json":{"schema":{"$ref":"#/components/schemas/ApiResponseVoid"}}}},"503":{"description":"A required platform service is temporarily unavailable","headers":{"X-Request-ID":{"description":"Request identifier echoed for support and reconciliation.","schema":{"type":"string"}}},"content":{"application/json":{"schema":{"$ref":"#/components/schemas/ApiResponseVoid"}}}},"409":{"description":"Idempotency or resource-state conflict","headers":{"X-Request-ID":{"description":"Request identifier echoed for support and reconciliation.","schema":{"type":"string"}}},"content":{"application/json":{"schema":{"$ref":"#/components/schemas/ApiResponseVoid"}}}},"429":{"description":"Per-minute rate limit or monthly quota exceeded","headers":{"X-Request-ID":{"description":"Request identifier echoed for support and reconciliation.","schema":{"type":"string"}},"X-Quota-Limit":{"description":"Monthly API request allowance for the subscription.","schema":{"type":"integer","format":"int64"}},"X-Quota-Remaining":{"description":"Requests remaining in the current monthly allowance after this request.","schema":{"type":"integer","format":"int64"}},"X-Quota-Reset":{"description":"Unix epoch time in seconds when the monthly allowance resets.","schema":{"type":"integer","format":"int64"}},"X-Quota-Workspace":{"description":"Verified workspace owning this allowance: personal or enterprise:<id>.","schema":{"type":"string"}},"X-Quota-Environment":{"description":"Environment owning the allowance: sandbox or live.","schema":{"type":"string"}},"Retry-After":{"description":"Seconds until the exhausted quota or rate window resets. Sign retries with a new X-Request-ID.","schema":{"type":"integer","format":"int64"}},"X-RateLimit-Scope":{"description":"Rate counter scope: workspace, or user for enterprise verification calls.","schema":{"type":"string"}},"X-RateLimit-Limit":{"description":"Per-minute request limit when rate-limited.","schema":{"type":"integer","format":"int64"}},"X-RateLimit-Remaining":{"description":"Zero when the minute limit is exhausted.","schema":{"type":"integer","format":"int64"}},"X-RateLimit-Reset":{"description":"Unix epoch seconds when the minute limit resets.","schema":{"type":"integer","format":"int64"}}},"content":{"application/json":{"schema":{"$ref":"#/components/schemas/ApiResponseVoid"}}}},"413":{"description":"Request body is too large","headers":{"X-Request-ID":{"description":"Request identifier echoed for support and reconciliation.","schema":{"type":"string"}}},"content":{"application/json":{"schema":{"$ref":"#/components/schemas/ApiResponseVoid"}}}}},"x-dcwallet-signature-versions":["v1","v2"]}},"/api/v1/assets":{"get":{"tags":["1. Assets and accounts"],"summary":"List assets enabled for the selected workspace","description":"Start every integration here. Select an enabled currency and network before querying accounts or creating a transaction.\n\nSignature versions: v1 and v2.","operationId":"getAssets","parameters":[{"name":"assetType","in":"query","description":"Optional filter. Asset class: fiat = government-issued currency; crypto = blockchain asset.","required":false,"schema":{"type":"string","enum":["fiat","crypto"]}},{"name":"network","in":"query","description":"Network code returned by this endpoint; omit to list every enabled network.","required":false,"schema":{"type":"string"}},{"name":"X-Timestamp","in":"header","description":"Current Unix epoch time in seconds. Requests older or newer than five minutes are rejected.","required":true,"schema":{"pattern":"[0-9]{10}","type":"string","example":"1787562000"}},{"name":"X-Request-ID","in":"header","description":"Unique 16-128 character request identifier used for replay protection; never reuse it for a different HTTP request.","required":true,"schema":{"pattern":"[A-Za-z0-9._:-]{16,128}","type":"string","example":"018f6f4e-8f62-7fc2-9c4b-7be2f4203b6a"}},{"name":"X-Content-SHA256","in":"header","description":"Lowercase hexadecimal SHA-256 digest of the exact raw request body; use the digest of zero bytes when no body is sent.","required":true,"schema":{"pattern":"[0-9a-f]{64}","type":"string","example":"e3b0c44298fc1c149afbf4c8996fb92427ae41e4649b934ca495991b7852b855"}},{"name":"X-Workspace","in":"header","description":"Enterprise reads are available on this route. For enterprise access, copy your own enterprise:<id> from GET /api/v1/workspaces. Required for v2 requests. V1 requests use the historical key's fixed enterprise.","required":false,"schema":{"pattern":"personal|enterprise:[1-9][0-9]*","type":"string","example":"personal"}},{"name":"X-Environment","in":"header","description":"Required and signed for v2 requests: live or sandbox. Optional for v1 requests.","required":false,"schema":{"pattern":"live|sandbox","type":"string","example":"live"}},{"name":"X-Signature","in":"header","description":"Existing keys accept v1 for their fixed enterprise or v2 for a signed workspace; new keys accept v2 only.","required":true,"schema":{"pattern":"v[12]=[0-9a-f]{64}","type":"string","example":"v2=0123456789abcdef0123456789abcdef0123456789abcdef0123456789abcdef"}},{"name":"Accept-Language","in":"header","description":"Response language: en-US = English (default); zh-CN = Simplified Chinese; zh-TW = Traditional Chinese. Numeric error codes are language-neutral.","required":false,"schema":{"type":"string","enum":["en-US","zh-CN","zh-TW"],"default":"en-US"}}],"responses":{"400":{"description":"Malformed JSON, missing header or invalid request parameter","headers":{"X-Request-ID":{"description":"Request identifier echoed for support and reconciliation.","schema":{"type":"string"}}},"content":{"application/json":{"schema":{"$ref":"#/components/schemas/ApiResponseVoid"}}}},"500":{"description":"Unexpected internal error; contact support with X-Request-ID","headers":{"X-Request-ID":{"description":"Request identifier echoed for support and reconciliation.","schema":{"type":"string"}}},"content":{"application/json":{"schema":{"$ref":"#/components/schemas/ApiResponseVoid"}}}},"403":{"description":"API-key scope, subscription, tenant or policy does not allow the operation","headers":{"X-Request-ID":{"description":"Request identifier echoed for support and reconciliation.","schema":{"type":"string"}}},"content":{"application/json":{"schema":{"$ref":"#/components/schemas/ApiResponseVoid"}}}},"200":{"description":"OK","headers":{"X-Request-ID":{"description":"Request identifier echoed for support and reconciliation.","schema":{"type":"string"}},"X-Quota-Limit":{"description":"Monthly API request allowance for the subscription.","schema":{"type":"integer","format":"int64"}},"X-Quota-Remaining":{"description":"Requests remaining in the current monthly allowance after this request.","schema":{"type":"integer","format":"int64"}},"X-Quota-Reset":{"description":"Unix epoch time in seconds when the monthly allowance resets.","schema":{"type":"integer","format":"int64"}},"X-Quota-Workspace":{"description":"Verified workspace owning this allowance: personal or enterprise:<id>.","schema":{"type":"string"}},"X-Quota-Environment":{"description":"Environment owning the allowance: sandbox or live.","schema":{"type":"string"}}},"content":{"application/json":{"schema":{"$ref":"#/components/schemas/ApiResponseListAssetResponse"}}}},"401":{"description":"Invalid API key, content hash, signature, timestamp or request ID","headers":{"X-Request-ID":{"description":"Request identifier echoed for support and reconciliation.","schema":{"type":"string"}}},"content":{"application/json":{"schema":{"$ref":"#/components/schemas/ApiResponseVoid"}}}},"404":{"description":"Resource not found in this enterprise and environment","headers":{"X-Request-ID":{"description":"Request identifier echoed for support and reconciliation.","schema":{"type":"string"}}},"content":{"application/json":{"schema":{"$ref":"#/components/schemas/ApiResponseVoid"}}}},"422":{"description":"Business rule rejected the request","headers":{"X-Request-ID":{"description":"Request identifier echoed for support and reconciliation.","schema":{"type":"string"}}},"content":{"application/json":{"schema":{"$ref":"#/components/schemas/ApiResponseVoid"}}}},"503":{"description":"A required platform service is temporarily unavailable","headers":{"X-Request-ID":{"description":"Request identifier echoed for support and reconciliation.","schema":{"type":"string"}}},"content":{"application/json":{"schema":{"$ref":"#/components/schemas/ApiResponseVoid"}}}},"409":{"description":"Idempotency or resource-state conflict","headers":{"X-Request-ID":{"description":"Request identifier echoed for support and reconciliation.","schema":{"type":"string"}}},"content":{"application/json":{"schema":{"$ref":"#/components/schemas/ApiResponseVoid"}}}},"429":{"description":"Per-minute rate limit or monthly quota exceeded","headers":{"X-Request-ID":{"description":"Request identifier echoed for support and reconciliation.","schema":{"type":"string"}},"X-Quota-Limit":{"description":"Monthly API request allowance for the subscription.","schema":{"type":"integer","format":"int64"}},"X-Quota-Remaining":{"description":"Requests remaining in the current monthly allowance after this request.","schema":{"type":"integer","format":"int64"}},"X-Quota-Reset":{"description":"Unix epoch time in seconds when the monthly allowance resets.","schema":{"type":"integer","format":"int64"}},"X-Quota-Workspace":{"description":"Verified workspace owning this allowance: personal or enterprise:<id>.","schema":{"type":"string"}},"X-Quota-Environment":{"description":"Environment owning the allowance: sandbox or live.","schema":{"type":"string"}},"Retry-After":{"description":"Seconds until the exhausted quota or rate window resets. Sign retries with a new X-Request-ID.","schema":{"type":"integer","format":"int64"}},"X-RateLimit-Scope":{"description":"Rate counter scope: workspace, or user for enterprise verification calls.","schema":{"type":"string"}},"X-RateLimit-Limit":{"description":"Per-minute request limit when rate-limited.","schema":{"type":"integer","format":"int64"}},"X-RateLimit-Remaining":{"description":"Zero when the minute limit is exhausted.","schema":{"type":"integer","format":"int64"}},"X-RateLimit-Reset":{"description":"Unix epoch seconds when the minute limit resets.","schema":{"type":"integer","format":"int64"}}},"content":{"application/json":{"schema":{"$ref":"#/components/schemas/ApiResponseVoid"}}}},"413":{"description":"Request body is too large","headers":{"X-Request-ID":{"description":"Request identifier echoed for support and reconciliation.","schema":{"type":"string"}}},"content":{"application/json":{"schema":{"$ref":"#/components/schemas/ApiResponseVoid"}}}}},"x-dcwallet-signature-versions":["v1","v2"]}},"/api/v1/assets/{currency}":{"get":{"tags":["1. Assets and accounts"],"summary":"Get enabled networks for an asset","description":"Signature versions: v1 and v2.","operationId":"getAssetsByCurrency","parameters":[{"name":"currency","in":"path","description":"Enabled asset code returned by /api/v1/assets.","required":true,"schema":{"type":"string"}},{"name":"X-Timestamp","in":"header","description":"Current Unix epoch time in seconds. Requests older or newer than five minutes are rejected.","required":true,"schema":{"pattern":"[0-9]{10}","type":"string","example":"1787562000"}},{"name":"X-Request-ID","in":"header","description":"Unique 16-128 character request identifier used for replay protection; never reuse it for a different HTTP request.","required":true,"schema":{"pattern":"[A-Za-z0-9._:-]{16,128}","type":"string","example":"018f6f4e-8f62-7fc2-9c4b-7be2f4203b6a"}},{"name":"X-Content-SHA256","in":"header","description":"Lowercase hexadecimal SHA-256 digest of the exact raw request body; use the digest of zero bytes when no body is sent.","required":true,"schema":{"pattern":"[0-9a-f]{64}","type":"string","example":"e3b0c44298fc1c149afbf4c8996fb92427ae41e4649b934ca495991b7852b855"}},{"name":"X-Workspace","in":"header","description":"Enterprise reads are available on this route. For enterprise access, copy your own enterprise:<id> from GET /api/v1/workspaces. Required for v2 requests. V1 requests use the historical key's fixed enterprise.","required":false,"schema":{"pattern":"personal|enterprise:[1-9][0-9]*","type":"string","example":"personal"}},{"name":"X-Environment","in":"header","description":"Required and signed for v2 requests: live or sandbox. Optional for v1 requests.","required":false,"schema":{"pattern":"live|sandbox","type":"string","example":"live"}},{"name":"X-Signature","in":"header","description":"Existing keys accept v1 for their fixed enterprise or v2 for a signed workspace; new keys accept v2 only.","required":true,"schema":{"pattern":"v[12]=[0-9a-f]{64}","type":"string","example":"v2=0123456789abcdef0123456789abcdef0123456789abcdef0123456789abcdef"}},{"name":"Accept-Language","in":"header","description":"Response language: en-US = English (default); zh-CN = Simplified Chinese; zh-TW = Traditional Chinese. Numeric error codes are language-neutral.","required":false,"schema":{"type":"string","enum":["en-US","zh-CN","zh-TW"],"default":"en-US"}}],"responses":{"400":{"description":"Malformed JSON, missing header or invalid request parameter","headers":{"X-Request-ID":{"description":"Request identifier echoed for support and reconciliation.","schema":{"type":"string"}}},"content":{"application/json":{"schema":{"$ref":"#/components/schemas/ApiResponseVoid"}}}},"500":{"description":"Unexpected internal error; contact support with X-Request-ID","headers":{"X-Request-ID":{"description":"Request identifier echoed for support and reconciliation.","schema":{"type":"string"}}},"content":{"application/json":{"schema":{"$ref":"#/components/schemas/ApiResponseVoid"}}}},"403":{"description":"API-key scope, subscription, tenant or policy does not allow the operation","headers":{"X-Request-ID":{"description":"Request identifier echoed for support and reconciliation.","schema":{"type":"string"}}},"content":{"application/json":{"schema":{"$ref":"#/components/schemas/ApiResponseVoid"}}}},"200":{"description":"OK","headers":{"X-Request-ID":{"description":"Request identifier echoed for support and reconciliation.","schema":{"type":"string"}},"X-Quota-Limit":{"description":"Monthly API request allowance for the subscription.","schema":{"type":"integer","format":"int64"}},"X-Quota-Remaining":{"description":"Requests remaining in the current monthly allowance after this request.","schema":{"type":"integer","format":"int64"}},"X-Quota-Reset":{"description":"Unix epoch time in seconds when the monthly allowance resets.","schema":{"type":"integer","format":"int64"}},"X-Quota-Workspace":{"description":"Verified workspace owning this allowance: personal or enterprise:<id>.","schema":{"type":"string"}},"X-Quota-Environment":{"description":"Environment owning the allowance: sandbox or live.","schema":{"type":"string"}}},"content":{"application/json":{"schema":{"$ref":"#/components/schemas/ApiResponseListAssetResponse"}}}},"401":{"description":"Invalid API key, content hash, signature, timestamp or request ID","headers":{"X-Request-ID":{"description":"Request identifier echoed for support and reconciliation.","schema":{"type":"string"}}},"content":{"application/json":{"schema":{"$ref":"#/components/schemas/ApiResponseVoid"}}}},"404":{"description":"Resource not found in this enterprise and environment","headers":{"X-Request-ID":{"description":"Request identifier echoed for support and reconciliation.","schema":{"type":"string"}}},"content":{"application/json":{"schema":{"$ref":"#/components/schemas/ApiResponseVoid"}}}},"422":{"description":"Business rule rejected the request","headers":{"X-Request-ID":{"description":"Request identifier echoed for support and reconciliation.","schema":{"type":"string"}}},"content":{"application/json":{"schema":{"$ref":"#/components/schemas/ApiResponseVoid"}}}},"503":{"description":"A required platform service is temporarily unavailable","headers":{"X-Request-ID":{"description":"Request identifier echoed for support and reconciliation.","schema":{"type":"string"}}},"content":{"application/json":{"schema":{"$ref":"#/components/schemas/ApiResponseVoid"}}}},"409":{"description":"Idempotency or resource-state conflict","headers":{"X-Request-ID":{"description":"Request identifier echoed for support and reconciliation.","schema":{"type":"string"}}},"content":{"application/json":{"schema":{"$ref":"#/components/schemas/ApiResponseVoid"}}}},"429":{"description":"Per-minute rate limit or monthly quota exceeded","headers":{"X-Request-ID":{"description":"Request identifier echoed for support and reconciliation.","schema":{"type":"string"}},"X-Quota-Limit":{"description":"Monthly API request allowance for the subscription.","schema":{"type":"integer","format":"int64"}},"X-Quota-Remaining":{"description":"Requests remaining in the current monthly allowance after this request.","schema":{"type":"integer","format":"int64"}},"X-Quota-Reset":{"description":"Unix epoch time in seconds when the monthly allowance resets.","schema":{"type":"integer","format":"int64"}},"X-Quota-Workspace":{"description":"Verified workspace owning this allowance: personal or enterprise:<id>.","schema":{"type":"string"}},"X-Quota-Environment":{"description":"Environment owning the allowance: sandbox or live.","schema":{"type":"string"}},"Retry-After":{"description":"Seconds until the exhausted quota or rate window resets. Sign retries with a new X-Request-ID.","schema":{"type":"integer","format":"int64"}},"X-RateLimit-Scope":{"description":"Rate counter scope: workspace, or user for enterprise verification calls.","schema":{"type":"string"}},"X-RateLimit-Limit":{"description":"Per-minute request limit when rate-limited.","schema":{"type":"integer","format":"int64"}},"X-RateLimit-Remaining":{"description":"Zero when the minute limit is exhausted.","schema":{"type":"integer","format":"int64"}},"X-RateLimit-Reset":{"description":"Unix epoch seconds when the minute limit resets.","schema":{"type":"integer","format":"int64"}}},"content":{"application/json":{"schema":{"$ref":"#/components/schemas/ApiResponseVoid"}}}},"413":{"description":"Request body is too large","headers":{"X-Request-ID":{"description":"Request identifier echoed for support and reconciliation.","schema":{"type":"string"}}},"content":{"application/json":{"schema":{"$ref":"#/components/schemas/ApiResponseVoid"}}}}},"x-dcwallet-signature-versions":["v1","v2"]}},"/api/v1/agent/tasks/{taskId}":{"get":{"tags":["8. Treasury Agent"],"summary":"Get a Treasury Agent task","description":"Signature versions: v1 and v2.","operationId":"getAgentTasksByTaskId","parameters":[{"name":"taskId","in":"path","description":"Treasury Agent task ID returned when the task is created. Keep IDs as strings.","required":true,"schema":{"type":"string"}},{"name":"X-Timestamp","in":"header","description":"Current Unix epoch time in seconds. Requests older or newer than five minutes are rejected.","required":true,"schema":{"pattern":"[0-9]{10}","type":"string","example":"1787562000"}},{"name":"X-Request-ID","in":"header","description":"Unique 16-128 character request identifier used for replay protection; never reuse it for a different HTTP request.","required":true,"schema":{"pattern":"[A-Za-z0-9._:-]{16,128}","type":"string","example":"018f6f4e-8f62-7fc2-9c4b-7be2f4203b6a"}},{"name":"X-Content-SHA256","in":"header","description":"Lowercase hexadecimal SHA-256 digest of the exact raw request body; use the digest of zero bytes when no body is sent.","required":true,"schema":{"pattern":"[0-9a-f]{64}","type":"string","example":"e3b0c44298fc1c149afbf4c8996fb92427ae41e4649b934ca495991b7852b855"}},{"name":"X-Workspace","in":"header","description":"Enterprise reads are available on this route. For enterprise access, copy your own enterprise:<id> from GET /api/v1/workspaces. Required for v2 requests. V1 requests use the historical key's fixed enterprise.","required":false,"schema":{"pattern":"personal|enterprise:[1-9][0-9]*","type":"string","example":null}},{"name":"X-Environment","in":"header","description":"Required and signed for v2 requests: live or sandbox. Optional for v1 requests.","required":false,"schema":{"pattern":"live|sandbox","type":"string","example":"live"}},{"name":"X-Signature","in":"header","description":"Existing keys accept v1 for their fixed enterprise or v2 for a signed workspace; new keys accept v2 only.","required":true,"schema":{"pattern":"v[12]=[0-9a-f]{64}","type":"string","example":"v2=0123456789abcdef0123456789abcdef0123456789abcdef0123456789abcdef"}},{"name":"Accept-Language","in":"header","description":"Response language: en-US = English (default); zh-CN = Simplified Chinese; zh-TW = Traditional Chinese. Numeric error codes are language-neutral.","required":false,"schema":{"type":"string","enum":["en-US","zh-CN","zh-TW"],"default":"en-US"}}],"responses":{"400":{"description":"Malformed JSON, missing header or invalid request parameter","headers":{"X-Request-ID":{"description":"Request identifier echoed for support and reconciliation.","schema":{"type":"string"}}},"content":{"application/json":{"schema":{"$ref":"#/components/schemas/ApiResponseVoid"}}}},"500":{"description":"Unexpected internal error; contact support with X-Request-ID","headers":{"X-Request-ID":{"description":"Request identifier echoed for support and reconciliation.","schema":{"type":"string"}}},"content":{"application/json":{"schema":{"$ref":"#/components/schemas/ApiResponseVoid"}}}},"403":{"description":"API-key scope, subscription, tenant or policy does not allow the operation","headers":{"X-Request-ID":{"description":"Request identifier echoed for support and reconciliation.","schema":{"type":"string"}}},"content":{"application/json":{"schema":{"$ref":"#/components/schemas/ApiResponseVoid"}}}},"200":{"description":"OK","headers":{"X-Request-ID":{"description":"Request identifier echoed for support and reconciliation.","schema":{"type":"string"}},"X-Quota-Limit":{"description":"Monthly API request allowance for the subscription.","schema":{"type":"integer","format":"int64"}},"X-Quota-Remaining":{"description":"Requests remaining in the current monthly allowance after this request.","schema":{"type":"integer","format":"int64"}},"X-Quota-Reset":{"description":"Unix epoch time in seconds when the monthly allowance resets.","schema":{"type":"integer","format":"int64"}},"X-Quota-Workspace":{"description":"Verified workspace owning this allowance: personal or enterprise:<id>.","schema":{"type":"string"}},"X-Quota-Environment":{"description":"Environment owning the allowance: sandbox or live.","schema":{"type":"string"}}},"content":{"application/json":{"schema":{"$ref":"#/components/schemas/ApiResponseAgentTaskResponse"}}}},"401":{"description":"Invalid API key, content hash, signature, timestamp or request ID","headers":{"X-Request-ID":{"description":"Request identifier echoed for support and reconciliation.","schema":{"type":"string"}}},"content":{"application/json":{"schema":{"$ref":"#/components/schemas/ApiResponseVoid"}}}},"404":{"description":"Resource not found in this enterprise and environment","headers":{"X-Request-ID":{"description":"Request identifier echoed for support and reconciliation.","schema":{"type":"string"}}},"content":{"application/json":{"schema":{"$ref":"#/components/schemas/ApiResponseVoid"}}}},"422":{"description":"Business rule rejected the request","headers":{"X-Request-ID":{"description":"Request identifier echoed for support and reconciliation.","schema":{"type":"string"}}},"content":{"application/json":{"schema":{"$ref":"#/components/schemas/ApiResponseVoid"}}}},"503":{"description":"A required platform service is temporarily unavailable","headers":{"X-Request-ID":{"description":"Request identifier echoed for support and reconciliation.","schema":{"type":"string"}}},"content":{"application/json":{"schema":{"$ref":"#/components/schemas/ApiResponseVoid"}}}},"409":{"description":"Idempotency or resource-state conflict","headers":{"X-Request-ID":{"description":"Request identifier echoed for support and reconciliation.","schema":{"type":"string"}}},"content":{"application/json":{"schema":{"$ref":"#/components/schemas/ApiResponseVoid"}}}},"429":{"description":"Per-minute rate limit or monthly quota exceeded","headers":{"X-Request-ID":{"description":"Request identifier echoed for support and reconciliation.","schema":{"type":"string"}},"X-Quota-Limit":{"description":"Monthly API request allowance for the subscription.","schema":{"type":"integer","format":"int64"}},"X-Quota-Remaining":{"description":"Requests remaining in the current monthly allowance after this request.","schema":{"type":"integer","format":"int64"}},"X-Quota-Reset":{"description":"Unix epoch time in seconds when the monthly allowance resets.","schema":{"type":"integer","format":"int64"}},"X-Quota-Workspace":{"description":"Verified workspace owning this allowance: personal or enterprise:<id>.","schema":{"type":"string"}},"X-Quota-Environment":{"description":"Environment owning the allowance: sandbox or live.","schema":{"type":"string"}},"Retry-After":{"description":"Seconds until the exhausted quota or rate window resets. Sign retries with a new X-Request-ID.","schema":{"type":"integer","format":"int64"}},"X-RateLimit-Scope":{"description":"Rate counter scope: workspace, or user for enterprise verification calls.","schema":{"type":"string"}},"X-RateLimit-Limit":{"description":"Per-minute request limit when rate-limited.","schema":{"type":"integer","format":"int64"}},"X-RateLimit-Remaining":{"description":"Zero when the minute limit is exhausted.","schema":{"type":"integer","format":"int64"}},"X-RateLimit-Reset":{"description":"Unix epoch seconds when the minute limit resets.","schema":{"type":"integer","format":"int64"}}},"content":{"application/json":{"schema":{"$ref":"#/components/schemas/ApiResponseVoid"}}}},"413":{"description":"Request body is too large","headers":{"X-Request-ID":{"description":"Request identifier echoed for support and reconciliation.","schema":{"type":"string"}}},"content":{"application/json":{"schema":{"$ref":"#/components/schemas/ApiResponseVoid"}}}}},"x-dcwallet-signature-versions":["v1","v2"]}},"/api/v1/agent/tasks/{taskId}/events":{"get":{"tags":["8. Treasury Agent"],"summary":"List Treasury Agent task events","description":"Signature versions: v1 and v2.","operationId":"getAgentTasksByTaskIdEvents","parameters":[{"name":"taskId","in":"path","description":"Treasury Agent task ID returned when the task is created. Keep IDs as strings.","required":true,"schema":{"type":"string"}},{"name":"X-Timestamp","in":"header","description":"Current Unix epoch time in seconds. Requests older or newer than five minutes are rejected.","required":true,"schema":{"pattern":"[0-9]{10}","type":"string","example":"1787562000"}},{"name":"X-Request-ID","in":"header","description":"Unique 16-128 character request identifier used for replay protection; never reuse it for a different HTTP request.","required":true,"schema":{"pattern":"[A-Za-z0-9._:-]{16,128}","type":"string","example":"018f6f4e-8f62-7fc2-9c4b-7be2f4203b6a"}},{"name":"X-Content-SHA256","in":"header","description":"Lowercase hexadecimal SHA-256 digest of the exact raw request body; use the digest of zero bytes when no body is sent.","required":true,"schema":{"pattern":"[0-9a-f]{64}","type":"string","example":"e3b0c44298fc1c149afbf4c8996fb92427ae41e4649b934ca495991b7852b855"}},{"name":"X-Workspace","in":"header","description":"Enterprise reads are available on this route. For enterprise access, copy your own enterprise:<id> from GET /api/v1/workspaces. Required for v2 requests. V1 requests use the historical key's fixed enterprise.","required":false,"schema":{"pattern":"personal|enterprise:[1-9][0-9]*","type":"string","example":null}},{"name":"X-Environment","in":"header","description":"Required and signed for v2 requests: live or sandbox. Optional for v1 requests.","required":false,"schema":{"pattern":"live|sandbox","type":"string","example":"live"}},{"name":"X-Signature","in":"header","description":"Existing keys accept v1 for their fixed enterprise or v2 for a signed workspace; new keys accept v2 only.","required":true,"schema":{"pattern":"v[12]=[0-9a-f]{64}","type":"string","example":"v2=0123456789abcdef0123456789abcdef0123456789abcdef0123456789abcdef"}},{"name":"Accept-Language","in":"header","description":"Response language: en-US = English (default); zh-CN = Simplified Chinese; zh-TW = Traditional Chinese. Numeric error codes are language-neutral.","required":false,"schema":{"type":"string","enum":["en-US","zh-CN","zh-TW"],"default":"en-US"}}],"responses":{"400":{"description":"Malformed JSON, missing header or invalid request parameter","headers":{"X-Request-ID":{"description":"Request identifier echoed for support and reconciliation.","schema":{"type":"string"}}},"content":{"application/json":{"schema":{"$ref":"#/components/schemas/ApiResponseVoid"}}}},"500":{"description":"Unexpected internal error; contact support with X-Request-ID","headers":{"X-Request-ID":{"description":"Request identifier echoed for support and reconciliation.","schema":{"type":"string"}}},"content":{"application/json":{"schema":{"$ref":"#/components/schemas/ApiResponseVoid"}}}},"403":{"description":"API-key scope, subscription, tenant or policy does not allow the operation","headers":{"X-Request-ID":{"description":"Request identifier echoed for support and reconciliation.","schema":{"type":"string"}}},"content":{"application/json":{"schema":{"$ref":"#/components/schemas/ApiResponseVoid"}}}},"200":{"description":"OK","headers":{"X-Request-ID":{"description":"Request identifier echoed for support and reconciliation.","schema":{"type":"string"}},"X-Quota-Limit":{"description":"Monthly API request allowance for the subscription.","schema":{"type":"integer","format":"int64"}},"X-Quota-Remaining":{"description":"Requests remaining in the current monthly allowance after this request.","schema":{"type":"integer","format":"int64"}},"X-Quota-Reset":{"description":"Unix epoch time in seconds when the monthly allowance resets.","schema":{"type":"integer","format":"int64"}},"X-Quota-Workspace":{"description":"Verified workspace owning this allowance: personal or enterprise:<id>.","schema":{"type":"string"}},"X-Quota-Environment":{"description":"Environment owning the allowance: sandbox or live.","schema":{"type":"string"}}},"content":{"application/json":{"schema":{"$ref":"#/components/schemas/ApiResponseListAgentTaskEventResponse"}}}},"401":{"description":"Invalid API key, content hash, signature, timestamp or request ID","headers":{"X-Request-ID":{"description":"Request identifier echoed for support and reconciliation.","schema":{"type":"string"}}},"content":{"application/json":{"schema":{"$ref":"#/components/schemas/ApiResponseVoid"}}}},"404":{"description":"Resource not found in this enterprise and environment","headers":{"X-Request-ID":{"description":"Request identifier echoed for support and reconciliation.","schema":{"type":"string"}}},"content":{"application/json":{"schema":{"$ref":"#/components/schemas/ApiResponseVoid"}}}},"422":{"description":"Business rule rejected the request","headers":{"X-Request-ID":{"description":"Request identifier echoed for support and reconciliation.","schema":{"type":"string"}}},"content":{"application/json":{"schema":{"$ref":"#/components/schemas/ApiResponseVoid"}}}},"503":{"description":"A required platform service is temporarily unavailable","headers":{"X-Request-ID":{"description":"Request identifier echoed for support and reconciliation.","schema":{"type":"string"}}},"content":{"application/json":{"schema":{"$ref":"#/components/schemas/ApiResponseVoid"}}}},"409":{"description":"Idempotency or resource-state conflict","headers":{"X-Request-ID":{"description":"Request identifier echoed for support and reconciliation.","schema":{"type":"string"}}},"content":{"application/json":{"schema":{"$ref":"#/components/schemas/ApiResponseVoid"}}}},"429":{"description":"Per-minute rate limit or monthly quota exceeded","headers":{"X-Request-ID":{"description":"Request identifier echoed for support and reconciliation.","schema":{"type":"string"}},"X-Quota-Limit":{"description":"Monthly API request allowance for the subscription.","schema":{"type":"integer","format":"int64"}},"X-Quota-Remaining":{"description":"Requests remaining in the current monthly allowance after this request.","schema":{"type":"integer","format":"int64"}},"X-Quota-Reset":{"description":"Unix epoch time in seconds when the monthly allowance resets.","schema":{"type":"integer","format":"int64"}},"X-Quota-Workspace":{"description":"Verified workspace owning this allowance: personal or enterprise:<id>.","schema":{"type":"string"}},"X-Quota-Environment":{"description":"Environment owning the allowance: sandbox or live.","schema":{"type":"string"}},"Retry-After":{"description":"Seconds until the exhausted quota or rate window resets. Sign retries with a new X-Request-ID.","schema":{"type":"integer","format":"int64"}},"X-RateLimit-Scope":{"description":"Rate counter scope: workspace, or user for enterprise verification calls.","schema":{"type":"string"}},"X-RateLimit-Limit":{"description":"Per-minute request limit when rate-limited.","schema":{"type":"integer","format":"int64"}},"X-RateLimit-Remaining":{"description":"Zero when the minute limit is exhausted.","schema":{"type":"integer","format":"int64"}},"X-RateLimit-Reset":{"description":"Unix epoch seconds when the minute limit resets.","schema":{"type":"integer","format":"int64"}}},"content":{"application/json":{"schema":{"$ref":"#/components/schemas/ApiResponseVoid"}}}},"413":{"description":"Request body is too large","headers":{"X-Request-ID":{"description":"Request identifier echoed for support and reconciliation.","schema":{"type":"string"}}},"content":{"application/json":{"schema":{"$ref":"#/components/schemas/ApiResponseVoid"}}}}},"x-dcwallet-signature-versions":["v1","v2"]}},"/api/v1/agent/capabilities":{"get":{"tags":["8. Treasury Agent"],"summary":"List Treasury Agent capabilities enabled for the enterprise","description":"Signature versions: v1 and v2.","operationId":"getAgentCapabilities","parameters":[{"name":"X-Timestamp","in":"header","description":"Current Unix epoch time in seconds. Requests older or newer than five minutes are rejected.","required":true,"schema":{"pattern":"[0-9]{10}","type":"string","example":"1787562000"}},{"name":"X-Request-ID","in":"header","description":"Unique 16-128 character request identifier used for replay protection; never reuse it for a different HTTP request.","required":true,"schema":{"pattern":"[A-Za-z0-9._:-]{16,128}","type":"string","example":"018f6f4e-8f62-7fc2-9c4b-7be2f4203b6a"}},{"name":"X-Content-SHA256","in":"header","description":"Lowercase hexadecimal SHA-256 digest of the exact raw request body; use the digest of zero bytes when no body is sent.","required":true,"schema":{"pattern":"[0-9a-f]{64}","type":"string","example":"e3b0c44298fc1c149afbf4c8996fb92427ae41e4649b934ca495991b7852b855"}},{"name":"X-Workspace","in":"header","description":"Enterprise reads are available on this route. For enterprise access, copy your own enterprise:<id> from GET /api/v1/workspaces. Required for v2 requests. V1 requests use the historical key's fixed enterprise.","required":false,"schema":{"pattern":"personal|enterprise:[1-9][0-9]*","type":"string","example":null}},{"name":"X-Environment","in":"header","description":"Required and signed for v2 requests: live or sandbox. Optional for v1 requests.","required":false,"schema":{"pattern":"live|sandbox","type":"string","example":"live"}},{"name":"X-Signature","in":"header","description":"Existing keys accept v1 for their fixed enterprise or v2 for a signed workspace; new keys accept v2 only.","required":true,"schema":{"pattern":"v[12]=[0-9a-f]{64}","type":"string","example":"v2=0123456789abcdef0123456789abcdef0123456789abcdef0123456789abcdef"}},{"name":"Accept-Language","in":"header","description":"Response language: en-US = English (default); zh-CN = Simplified Chinese; zh-TW = Traditional Chinese. Numeric error codes are language-neutral.","required":false,"schema":{"type":"string","enum":["en-US","zh-CN","zh-TW"],"default":"en-US"}}],"responses":{"400":{"description":"Malformed JSON, missing header or invalid request parameter","headers":{"X-Request-ID":{"description":"Request identifier echoed for support and reconciliation.","schema":{"type":"string"}}},"content":{"application/json":{"schema":{"$ref":"#/components/schemas/ApiResponseVoid"}}}},"500":{"description":"Unexpected internal error; contact support with X-Request-ID","headers":{"X-Request-ID":{"description":"Request identifier echoed for support and reconciliation.","schema":{"type":"string"}}},"content":{"application/json":{"schema":{"$ref":"#/components/schemas/ApiResponseVoid"}}}},"403":{"description":"API-key scope, subscription, tenant or policy does not allow the operation","headers":{"X-Request-ID":{"description":"Request identifier echoed for support and reconciliation.","schema":{"type":"string"}}},"content":{"application/json":{"schema":{"$ref":"#/components/schemas/ApiResponseVoid"}}}},"200":{"description":"OK","headers":{"X-Request-ID":{"description":"Request identifier echoed for support and reconciliation.","schema":{"type":"string"}},"X-Quota-Limit":{"description":"Monthly API request allowance for the subscription.","schema":{"type":"integer","format":"int64"}},"X-Quota-Remaining":{"description":"Requests remaining in the current monthly allowance after this request.","schema":{"type":"integer","format":"int64"}},"X-Quota-Reset":{"description":"Unix epoch time in seconds when the monthly allowance resets.","schema":{"type":"integer","format":"int64"}},"X-Quota-Workspace":{"description":"Verified workspace owning this allowance: personal or enterprise:<id>.","schema":{"type":"string"}},"X-Quota-Environment":{"description":"Environment owning the allowance: sandbox or live.","schema":{"type":"string"}}},"content":{"application/json":{"schema":{"$ref":"#/components/schemas/ApiResponseListAgentCapabilityResponse"}}}},"401":{"description":"Invalid API key, content hash, signature, timestamp or request ID","headers":{"X-Request-ID":{"description":"Request identifier echoed for support and reconciliation.","schema":{"type":"string"}}},"content":{"application/json":{"schema":{"$ref":"#/components/schemas/ApiResponseVoid"}}}},"404":{"description":"Resource not found in this enterprise and environment","headers":{"X-Request-ID":{"description":"Request identifier echoed for support and reconciliation.","schema":{"type":"string"}}},"content":{"application/json":{"schema":{"$ref":"#/components/schemas/ApiResponseVoid"}}}},"422":{"description":"Business rule rejected the request","headers":{"X-Request-ID":{"description":"Request identifier echoed for support and reconciliation.","schema":{"type":"string"}}},"content":{"application/json":{"schema":{"$ref":"#/components/schemas/ApiResponseVoid"}}}},"503":{"description":"A required platform service is temporarily unavailable","headers":{"X-Request-ID":{"description":"Request identifier echoed for support and reconciliation.","schema":{"type":"string"}}},"content":{"application/json":{"schema":{"$ref":"#/components/schemas/ApiResponseVoid"}}}},"409":{"description":"Idempotency or resource-state conflict","headers":{"X-Request-ID":{"description":"Request identifier echoed for support and reconciliation.","schema":{"type":"string"}}},"content":{"application/json":{"schema":{"$ref":"#/components/schemas/ApiResponseVoid"}}}},"429":{"description":"Per-minute rate limit or monthly quota exceeded","headers":{"X-Request-ID":{"description":"Request identifier echoed for support and reconciliation.","schema":{"type":"string"}},"X-Quota-Limit":{"description":"Monthly API request allowance for the subscription.","schema":{"type":"integer","format":"int64"}},"X-Quota-Remaining":{"description":"Requests remaining in the current monthly allowance after this request.","schema":{"type":"integer","format":"int64"}},"X-Quota-Reset":{"description":"Unix epoch time in seconds when the monthly allowance resets.","schema":{"type":"integer","format":"int64"}},"X-Quota-Workspace":{"description":"Verified workspace owning this allowance: personal or enterprise:<id>.","schema":{"type":"string"}},"X-Quota-Environment":{"description":"Environment owning the allowance: sandbox or live.","schema":{"type":"string"}},"Retry-After":{"description":"Seconds until the exhausted quota or rate window resets. Sign retries with a new X-Request-ID.","schema":{"type":"integer","format":"int64"}},"X-RateLimit-Scope":{"description":"Rate counter scope: workspace, or user for enterprise verification calls.","schema":{"type":"string"}},"X-RateLimit-Limit":{"description":"Per-minute request limit when rate-limited.","schema":{"type":"integer","format":"int64"}},"X-RateLimit-Remaining":{"description":"Zero when the minute limit is exhausted.","schema":{"type":"integer","format":"int64"}},"X-RateLimit-Reset":{"description":"Unix epoch seconds when the minute limit resets.","schema":{"type":"integer","format":"int64"}}},"content":{"application/json":{"schema":{"$ref":"#/components/schemas/ApiResponseVoid"}}}},"413":{"description":"Request body is too large","headers":{"X-Request-ID":{"description":"Request identifier echoed for support and reconciliation.","schema":{"type":"string"}}},"content":{"application/json":{"schema":{"$ref":"#/components/schemas/ApiResponseVoid"}}}}},"x-dcwallet-signature-versions":["v1","v2"]}},"/api/v1/accounts":{"get":{"tags":["1. Assets and accounts"],"summary":"List asset accounts in the selected workspace","description":"Keep the returned account ID as a string and use it for balances and transactions. Enterprise v1 clients may also use eligible accounts for card funding.\n\nSignature versions: v1 and v2.","operationId":"getAccounts","parameters":[{"name":"currency","in":"query","description":"Asset code returned by GET /api/v1/assets.","required":false,"schema":{"type":"string"}},{"name":"assetType","in":"query","description":"Optional filter. Asset class: fiat = government-issued currency; crypto = blockchain asset.","required":false,"schema":{"type":"string","enum":["fiat","crypto"]}},{"name":"network","in":"query","description":"Network code returned by GET /api/v1/assets.","required":false,"schema":{"type":"string"}},{"name":"X-Timestamp","in":"header","description":"Current Unix epoch time in seconds. Requests older or newer than five minutes are rejected.","required":true,"schema":{"pattern":"[0-9]{10}","type":"string","example":"1787562000"}},{"name":"X-Request-ID","in":"header","description":"Unique 16-128 character request identifier used for replay protection; never reuse it for a different HTTP request.","required":true,"schema":{"pattern":"[A-Za-z0-9._:-]{16,128}","type":"string","example":"018f6f4e-8f62-7fc2-9c4b-7be2f4203b6a"}},{"name":"X-Content-SHA256","in":"header","description":"Lowercase hexadecimal SHA-256 digest of the exact raw request body; use the digest of zero bytes when no body is sent.","required":true,"schema":{"pattern":"[0-9a-f]{64}","type":"string","example":"e3b0c44298fc1c149afbf4c8996fb92427ae41e4649b934ca495991b7852b855"}},{"name":"X-Workspace","in":"header","description":"Personal and enterprise reads are available on this route. For enterprise access, copy your own enterprise:<id> from GET /api/v1/workspaces. Required for v2 requests. V1 requests use the historical key's fixed enterprise.","required":false,"schema":{"pattern":"personal|enterprise:[1-9][0-9]*","type":"string","example":"personal"}},{"name":"X-Environment","in":"header","description":"Required and signed for v2 requests: live or sandbox. Optional for v1 requests.","required":false,"schema":{"pattern":"live|sandbox","type":"string","example":"live"}},{"name":"X-Signature","in":"header","description":"Existing keys accept v1 for their fixed enterprise or v2 for a signed workspace; new keys accept v2 only.","required":true,"schema":{"pattern":"v[12]=[0-9a-f]{64}","type":"string","example":"v2=0123456789abcdef0123456789abcdef0123456789abcdef0123456789abcdef"}},{"name":"Accept-Language","in":"header","description":"Response language: en-US = English (default); zh-CN = Simplified Chinese; zh-TW = Traditional Chinese. Numeric error codes are language-neutral.","required":false,"schema":{"type":"string","enum":["en-US","zh-CN","zh-TW"],"default":"en-US"}}],"responses":{"400":{"description":"Malformed JSON, missing header or invalid request parameter","headers":{"X-Request-ID":{"description":"Request identifier echoed for support and reconciliation.","schema":{"type":"string"}}},"content":{"application/json":{"schema":{"$ref":"#/components/schemas/ApiResponseVoid"}}}},"500":{"description":"Unexpected internal error; contact support with X-Request-ID","headers":{"X-Request-ID":{"description":"Request identifier echoed for support and reconciliation.","schema":{"type":"string"}}},"content":{"application/json":{"schema":{"$ref":"#/components/schemas/ApiResponseVoid"}}}},"403":{"description":"API-key scope, subscription, tenant or policy does not allow the operation","headers":{"X-Request-ID":{"description":"Request identifier echoed for support and reconciliation.","schema":{"type":"string"}}},"content":{"application/json":{"schema":{"$ref":"#/components/schemas/ApiResponseVoid"}}}},"200":{"description":"OK","headers":{"X-Request-ID":{"description":"Request identifier echoed for support and reconciliation.","schema":{"type":"string"}},"X-Quota-Limit":{"description":"Monthly API request allowance for the subscription.","schema":{"type":"integer","format":"int64"}},"X-Quota-Remaining":{"description":"Requests remaining in the current monthly allowance after this request.","schema":{"type":"integer","format":"int64"}},"X-Quota-Reset":{"description":"Unix epoch time in seconds when the monthly allowance resets.","schema":{"type":"integer","format":"int64"}},"X-Quota-Workspace":{"description":"Verified workspace owning this allowance: personal or enterprise:<id>.","schema":{"type":"string"}},"X-Quota-Environment":{"description":"Environment owning the allowance: sandbox or live.","schema":{"type":"string"}}},"content":{"application/json":{"schema":{"$ref":"#/components/schemas/ApiResponseListAccountResponse"}}}},"401":{"description":"Invalid API key, content hash, signature, timestamp or request ID","headers":{"X-Request-ID":{"description":"Request identifier echoed for support and reconciliation.","schema":{"type":"string"}}},"content":{"application/json":{"schema":{"$ref":"#/components/schemas/ApiResponseVoid"}}}},"404":{"description":"Resource not found in this enterprise and environment","headers":{"X-Request-ID":{"description":"Request identifier echoed for support and reconciliation.","schema":{"type":"string"}}},"content":{"application/json":{"schema":{"$ref":"#/components/schemas/ApiResponseVoid"}}}},"422":{"description":"Business rule rejected the request","headers":{"X-Request-ID":{"description":"Request identifier echoed for support and reconciliation.","schema":{"type":"string"}}},"content":{"application/json":{"schema":{"$ref":"#/components/schemas/ApiResponseVoid"}}}},"503":{"description":"A required platform service is temporarily unavailable","headers":{"X-Request-ID":{"description":"Request identifier echoed for support and reconciliation.","schema":{"type":"string"}}},"content":{"application/json":{"schema":{"$ref":"#/components/schemas/ApiResponseVoid"}}}},"409":{"description":"Idempotency or resource-state conflict","headers":{"X-Request-ID":{"description":"Request identifier echoed for support and reconciliation.","schema":{"type":"string"}}},"content":{"application/json":{"schema":{"$ref":"#/components/schemas/ApiResponseVoid"}}}},"429":{"description":"Per-minute rate limit or monthly quota exceeded","headers":{"X-Request-ID":{"description":"Request identifier echoed for support and reconciliation.","schema":{"type":"string"}},"X-Quota-Limit":{"description":"Monthly API request allowance for the subscription.","schema":{"type":"integer","format":"int64"}},"X-Quota-Remaining":{"description":"Requests remaining in the current monthly allowance after this request.","schema":{"type":"integer","format":"int64"}},"X-Quota-Reset":{"description":"Unix epoch time in seconds when the monthly allowance resets.","schema":{"type":"integer","format":"int64"}},"X-Quota-Workspace":{"description":"Verified workspace owning this allowance: personal or enterprise:<id>.","schema":{"type":"string"}},"X-Quota-Environment":{"description":"Environment owning the allowance: sandbox or live.","schema":{"type":"string"}},"Retry-After":{"description":"Seconds until the exhausted quota or rate window resets. Sign retries with a new X-Request-ID.","schema":{"type":"integer","format":"int64"}},"X-RateLimit-Scope":{"description":"Rate counter scope: workspace, or user for enterprise verification calls.","schema":{"type":"string"}},"X-RateLimit-Limit":{"description":"Per-minute request limit when rate-limited.","schema":{"type":"integer","format":"int64"}},"X-RateLimit-Remaining":{"description":"Zero when the minute limit is exhausted.","schema":{"type":"integer","format":"int64"}},"X-RateLimit-Reset":{"description":"Unix epoch seconds when the minute limit resets.","schema":{"type":"integer","format":"int64"}}},"content":{"application/json":{"schema":{"$ref":"#/components/schemas/ApiResponseVoid"}}}},"413":{"description":"Request body is too large","headers":{"X-Request-ID":{"description":"Request identifier echoed for support and reconciliation.","schema":{"type":"string"}}},"content":{"application/json":{"schema":{"$ref":"#/components/schemas/ApiResponseVoid"}}}}},"x-dcwallet-signature-versions":["v1","v2"]}},"/api/v1/accounts/{accountId}":{"get":{"tags":["1. Assets and accounts"],"summary":"Get an asset account in the selected workspace","description":"Signature versions: v1 and v2.","operationId":"getAccountsByAccountId","parameters":[{"name":"accountId","in":"path","description":"Account ID returned by the corresponding account list endpoint. Keep IDs as strings.","required":true,"schema":{"pattern":"[0-9]+","type":"string","example":"337893979704000512"}},{"name":"X-Timestamp","in":"header","description":"Current Unix epoch time in seconds. Requests older or newer than five minutes are rejected.","required":true,"schema":{"pattern":"[0-9]{10}","type":"string","example":"1787562000"}},{"name":"X-Request-ID","in":"header","description":"Unique 16-128 character request identifier used for replay protection; never reuse it for a different HTTP request.","required":true,"schema":{"pattern":"[A-Za-z0-9._:-]{16,128}","type":"string","example":"018f6f4e-8f62-7fc2-9c4b-7be2f4203b6a"}},{"name":"X-Content-SHA256","in":"header","description":"Lowercase hexadecimal SHA-256 digest of the exact raw request body; use the digest of zero bytes when no body is sent.","required":true,"schema":{"pattern":"[0-9a-f]{64}","type":"string","example":"e3b0c44298fc1c149afbf4c8996fb92427ae41e4649b934ca495991b7852b855"}},{"name":"X-Workspace","in":"header","description":"Personal and enterprise reads are available on this route. For enterprise access, copy your own enterprise:<id> from GET /api/v1/workspaces. Required for v2 requests. V1 requests use the historical key's fixed enterprise.","required":false,"schema":{"pattern":"personal|enterprise:[1-9][0-9]*","type":"string","example":"personal"}},{"name":"X-Environment","in":"header","description":"Required and signed for v2 requests: live or sandbox. Optional for v1 requests.","required":false,"schema":{"pattern":"live|sandbox","type":"string","example":"live"}},{"name":"X-Signature","in":"header","description":"Existing keys accept v1 for their fixed enterprise or v2 for a signed workspace; new keys accept v2 only.","required":true,"schema":{"pattern":"v[12]=[0-9a-f]{64}","type":"string","example":"v2=0123456789abcdef0123456789abcdef0123456789abcdef0123456789abcdef"}},{"name":"Accept-Language","in":"header","description":"Response language: en-US = English (default); zh-CN = Simplified Chinese; zh-TW = Traditional Chinese. Numeric error codes are language-neutral.","required":false,"schema":{"type":"string","enum":["en-US","zh-CN","zh-TW"],"default":"en-US"}}],"responses":{"400":{"description":"Malformed JSON, missing header or invalid request parameter","headers":{"X-Request-ID":{"description":"Request identifier echoed for support and reconciliation.","schema":{"type":"string"}}},"content":{"application/json":{"schema":{"$ref":"#/components/schemas/ApiResponseVoid"}}}},"500":{"description":"Unexpected internal error; contact support with X-Request-ID","headers":{"X-Request-ID":{"description":"Request identifier echoed for support and reconciliation.","schema":{"type":"string"}}},"content":{"application/json":{"schema":{"$ref":"#/components/schemas/ApiResponseVoid"}}}},"403":{"description":"API-key scope, subscription, tenant or policy does not allow the operation","headers":{"X-Request-ID":{"description":"Request identifier echoed for support and reconciliation.","schema":{"type":"string"}}},"content":{"application/json":{"schema":{"$ref":"#/components/schemas/ApiResponseVoid"}}}},"200":{"description":"OK","headers":{"X-Request-ID":{"description":"Request identifier echoed for support and reconciliation.","schema":{"type":"string"}},"X-Quota-Limit":{"description":"Monthly API request allowance for the subscription.","schema":{"type":"integer","format":"int64"}},"X-Quota-Remaining":{"description":"Requests remaining in the current monthly allowance after this request.","schema":{"type":"integer","format":"int64"}},"X-Quota-Reset":{"description":"Unix epoch time in seconds when the monthly allowance resets.","schema":{"type":"integer","format":"int64"}},"X-Quota-Workspace":{"description":"Verified workspace owning this allowance: personal or enterprise:<id>.","schema":{"type":"string"}},"X-Quota-Environment":{"description":"Environment owning the allowance: sandbox or live.","schema":{"type":"string"}}},"content":{"application/json":{"schema":{"$ref":"#/components/schemas/ApiResponseAccountResponse"}}}},"401":{"description":"Invalid API key, content hash, signature, timestamp or request ID","headers":{"X-Request-ID":{"description":"Request identifier echoed for support and reconciliation.","schema":{"type":"string"}}},"content":{"application/json":{"schema":{"$ref":"#/components/schemas/ApiResponseVoid"}}}},"404":{"description":"Resource not found in this enterprise and environment","headers":{"X-Request-ID":{"description":"Request identifier echoed for support and reconciliation.","schema":{"type":"string"}}},"content":{"application/json":{"schema":{"$ref":"#/components/schemas/ApiResponseVoid"}}}},"422":{"description":"Business rule rejected the request","headers":{"X-Request-ID":{"description":"Request identifier echoed for support and reconciliation.","schema":{"type":"string"}}},"content":{"application/json":{"schema":{"$ref":"#/components/schemas/ApiResponseVoid"}}}},"503":{"description":"A required platform service is temporarily unavailable","headers":{"X-Request-ID":{"description":"Request identifier echoed for support and reconciliation.","schema":{"type":"string"}}},"content":{"application/json":{"schema":{"$ref":"#/components/schemas/ApiResponseVoid"}}}},"409":{"description":"Idempotency or resource-state conflict","headers":{"X-Request-ID":{"description":"Request identifier echoed for support and reconciliation.","schema":{"type":"string"}}},"content":{"application/json":{"schema":{"$ref":"#/components/schemas/ApiResponseVoid"}}}},"429":{"description":"Per-minute rate limit or monthly quota exceeded","headers":{"X-Request-ID":{"description":"Request identifier echoed for support and reconciliation.","schema":{"type":"string"}},"X-Quota-Limit":{"description":"Monthly API request allowance for the subscription.","schema":{"type":"integer","format":"int64"}},"X-Quota-Remaining":{"description":"Requests remaining in the current monthly allowance after this request.","schema":{"type":"integer","format":"int64"}},"X-Quota-Reset":{"description":"Unix epoch time in seconds when the monthly allowance resets.","schema":{"type":"integer","format":"int64"}},"X-Quota-Workspace":{"description":"Verified workspace owning this allowance: personal or enterprise:<id>.","schema":{"type":"string"}},"X-Quota-Environment":{"description":"Environment owning the allowance: sandbox or live.","schema":{"type":"string"}},"Retry-After":{"description":"Seconds until the exhausted quota or rate window resets. Sign retries with a new X-Request-ID.","schema":{"type":"integer","format":"int64"}},"X-RateLimit-Scope":{"description":"Rate counter scope: workspace, or user for enterprise verification calls.","schema":{"type":"string"}},"X-RateLimit-Limit":{"description":"Per-minute request limit when rate-limited.","schema":{"type":"integer","format":"int64"}},"X-RateLimit-Remaining":{"description":"Zero when the minute limit is exhausted.","schema":{"type":"integer","format":"int64"}},"X-RateLimit-Reset":{"description":"Unix epoch seconds when the minute limit resets.","schema":{"type":"integer","format":"int64"}}},"content":{"application/json":{"schema":{"$ref":"#/components/schemas/ApiResponseVoid"}}}},"413":{"description":"Request body is too large","headers":{"X-Request-ID":{"description":"Request identifier echoed for support and reconciliation.","schema":{"type":"string"}}},"content":{"application/json":{"schema":{"$ref":"#/components/schemas/ApiResponseVoid"}}}}},"x-dcwallet-signature-versions":["v1","v2"]}},"/api/v1/accounts/{accountId}/transactions":{"get":{"tags":["1. Assets and accounts"],"summary":"List account transactions","description":"Signature versions: v1 and v2.","operationId":"getAccountsByAccountIdTransactions","parameters":[{"name":"accountId","in":"path","description":"Account ID returned by the corresponding account list endpoint. Keep IDs as strings.","required":true,"schema":{"pattern":"[0-9]+","type":"string","example":"337893979704000512"}},{"name":"type","in":"query","description":"Exact transaction type returned in the type field; omit to list all types.","required":false,"schema":{"type":"string"}},{"name":"direction","in":"query","description":"Optional filter. Balance effect: credit increases the account balance; debit decreases it.","required":false,"schema":{"type":"string","enum":["credit","debit"]}},{"name":"startDate","in":"query","description":"Inclusive start date in YYYY-MM-DD format.","required":false,"schema":{"type":"string"},"example":"2026-08-01"},{"name":"endDate","in":"query","description":"Inclusive end date in YYYY-MM-DD format.","required":false,"schema":{"type":"string"},"example":"2026-08-31"},{"name":"page","in":"query","description":"One-based result page number.","required":false,"schema":{"type":"integer","format":"int32","default":1}},{"name":"pageSize","in":"query","description":"Maximum records returned per page; values above 100 are capped.","required":false,"schema":{"type":"integer","format":"int32","default":20}},{"name":"X-Timestamp","in":"header","description":"Current Unix epoch time in seconds. Requests older or newer than five minutes are rejected.","required":true,"schema":{"pattern":"[0-9]{10}","type":"string","example":"1787562000"}},{"name":"X-Request-ID","in":"header","description":"Unique 16-128 character request identifier used for replay protection; never reuse it for a different HTTP request.","required":true,"schema":{"pattern":"[A-Za-z0-9._:-]{16,128}","type":"string","example":"018f6f4e-8f62-7fc2-9c4b-7be2f4203b6a"}},{"name":"X-Content-SHA256","in":"header","description":"Lowercase hexadecimal SHA-256 digest of the exact raw request body; use the digest of zero bytes when no body is sent.","required":true,"schema":{"pattern":"[0-9a-f]{64}","type":"string","example":"e3b0c44298fc1c149afbf4c8996fb92427ae41e4649b934ca495991b7852b855"}},{"name":"X-Workspace","in":"header","description":"Personal and enterprise reads are available on this route. For enterprise access, copy your own enterprise:<id> from GET /api/v1/workspaces. Required for v2 requests. V1 requests use the historical key's fixed enterprise.","required":false,"schema":{"pattern":"personal|enterprise:[1-9][0-9]*","type":"string","example":"personal"}},{"name":"X-Environment","in":"header","description":"Required and signed for v2 requests: live or sandbox. Optional for v1 requests.","required":false,"schema":{"pattern":"live|sandbox","type":"string","example":"live"}},{"name":"X-Signature","in":"header","description":"Existing keys accept v1 for their fixed enterprise or v2 for a signed workspace; new keys accept v2 only.","required":true,"schema":{"pattern":"v[12]=[0-9a-f]{64}","type":"string","example":"v2=0123456789abcdef0123456789abcdef0123456789abcdef0123456789abcdef"}},{"name":"Accept-Language","in":"header","description":"Response language: en-US = English (default); zh-CN = Simplified Chinese; zh-TW = Traditional Chinese. Numeric error codes are language-neutral.","required":false,"schema":{"type":"string","enum":["en-US","zh-CN","zh-TW"],"default":"en-US"}}],"responses":{"400":{"description":"Malformed JSON, missing header or invalid request parameter","headers":{"X-Request-ID":{"description":"Request identifier echoed for support and reconciliation.","schema":{"type":"string"}}},"content":{"application/json":{"schema":{"$ref":"#/components/schemas/ApiResponseVoid"}}}},"500":{"description":"Unexpected internal error; contact support with X-Request-ID","headers":{"X-Request-ID":{"description":"Request identifier echoed for support and reconciliation.","schema":{"type":"string"}}},"content":{"application/json":{"schema":{"$ref":"#/components/schemas/ApiResponseVoid"}}}},"403":{"description":"API-key scope, subscription, tenant or policy does not allow the operation","headers":{"X-Request-ID":{"description":"Request identifier echoed for support and reconciliation.","schema":{"type":"string"}}},"content":{"application/json":{"schema":{"$ref":"#/components/schemas/ApiResponseVoid"}}}},"200":{"description":"OK","headers":{"X-Request-ID":{"description":"Request identifier echoed for support and reconciliation.","schema":{"type":"string"}},"X-Quota-Limit":{"description":"Monthly API request allowance for the subscription.","schema":{"type":"integer","format":"int64"}},"X-Quota-Remaining":{"description":"Requests remaining in the current monthly allowance after this request.","schema":{"type":"integer","format":"int64"}},"X-Quota-Reset":{"description":"Unix epoch time in seconds when the monthly allowance resets.","schema":{"type":"integer","format":"int64"}},"X-Quota-Workspace":{"description":"Verified workspace owning this allowance: personal or enterprise:<id>.","schema":{"type":"string"}},"X-Quota-Environment":{"description":"Environment owning the allowance: sandbox or live.","schema":{"type":"string"}}},"content":{"application/json":{"schema":{"$ref":"#/components/schemas/ApiResponsePageDataAccountTransactionResponse"}}}},"401":{"description":"Invalid API key, content hash, signature, timestamp or request ID","headers":{"X-Request-ID":{"description":"Request identifier echoed for support and reconciliation.","schema":{"type":"string"}}},"content":{"application/json":{"schema":{"$ref":"#/components/schemas/ApiResponseVoid"}}}},"404":{"description":"Resource not found in this enterprise and environment","headers":{"X-Request-ID":{"description":"Request identifier echoed for support and reconciliation.","schema":{"type":"string"}}},"content":{"application/json":{"schema":{"$ref":"#/components/schemas/ApiResponseVoid"}}}},"422":{"description":"Business rule rejected the request","headers":{"X-Request-ID":{"description":"Request identifier echoed for support and reconciliation.","schema":{"type":"string"}}},"content":{"application/json":{"schema":{"$ref":"#/components/schemas/ApiResponseVoid"}}}},"503":{"description":"A required platform service is temporarily unavailable","headers":{"X-Request-ID":{"description":"Request identifier echoed for support and reconciliation.","schema":{"type":"string"}}},"content":{"application/json":{"schema":{"$ref":"#/components/schemas/ApiResponseVoid"}}}},"409":{"description":"Idempotency or resource-state conflict","headers":{"X-Request-ID":{"description":"Request identifier echoed for support and reconciliation.","schema":{"type":"string"}}},"content":{"application/json":{"schema":{"$ref":"#/components/schemas/ApiResponseVoid"}}}},"429":{"description":"Per-minute rate limit or monthly quota exceeded","headers":{"X-Request-ID":{"description":"Request identifier echoed for support and reconciliation.","schema":{"type":"string"}},"X-Quota-Limit":{"description":"Monthly API request allowance for the subscription.","schema":{"type":"integer","format":"int64"}},"X-Quota-Remaining":{"description":"Requests remaining in the current monthly allowance after this request.","schema":{"type":"integer","format":"int64"}},"X-Quota-Reset":{"description":"Unix epoch time in seconds when the monthly allowance resets.","schema":{"type":"integer","format":"int64"}},"X-Quota-Workspace":{"description":"Verified workspace owning this allowance: personal or enterprise:<id>.","schema":{"type":"string"}},"X-Quota-Environment":{"description":"Environment owning the allowance: sandbox or live.","schema":{"type":"string"}},"Retry-After":{"description":"Seconds until the exhausted quota or rate window resets. Sign retries with a new X-Request-ID.","schema":{"type":"integer","format":"int64"}},"X-RateLimit-Scope":{"description":"Rate counter scope: workspace, or user for enterprise verification calls.","schema":{"type":"string"}},"X-RateLimit-Limit":{"description":"Per-minute request limit when rate-limited.","schema":{"type":"integer","format":"int64"}},"X-RateLimit-Remaining":{"description":"Zero when the minute limit is exhausted.","schema":{"type":"integer","format":"int64"}},"X-RateLimit-Reset":{"description":"Unix epoch seconds when the minute limit resets.","schema":{"type":"integer","format":"int64"}}},"content":{"application/json":{"schema":{"$ref":"#/components/schemas/ApiResponseVoid"}}}},"413":{"description":"Request body is too large","headers":{"X-Request-ID":{"description":"Request identifier echoed for support and reconciliation.","schema":{"type":"string"}}},"content":{"application/json":{"schema":{"$ref":"#/components/schemas/ApiResponseVoid"}}}}},"x-dcwallet-signature-versions":["v1","v2"]}},"/api/v1/accounts/{accountId}/transactions/{transactionId}":{"get":{"tags":["1. Assets and accounts"],"summary":"Get an account transaction","description":"Signature versions: v1 and v2.","operationId":"getAccountsByAccountIdTransactionsByTransactionId","parameters":[{"name":"accountId","in":"path","description":"Account ID returned by the corresponding account list endpoint. Keep IDs as strings.","required":true,"schema":{"pattern":"[0-9]+","type":"string","example":"337893979704000512"}},{"name":"transactionId","in":"path","description":"Transaction ID returned by the corresponding transaction list endpoint. Keep IDs as strings.","required":true,"schema":{"pattern":"[0-9]+","type":"string","example":"337893979704000512"}},{"name":"X-Timestamp","in":"header","description":"Current Unix epoch time in seconds. Requests older or newer than five minutes are rejected.","required":true,"schema":{"pattern":"[0-9]{10}","type":"string","example":"1787562000"}},{"name":"X-Request-ID","in":"header","description":"Unique 16-128 character request identifier used for replay protection; never reuse it for a different HTTP request.","required":true,"schema":{"pattern":"[A-Za-z0-9._:-]{16,128}","type":"string","example":"018f6f4e-8f62-7fc2-9c4b-7be2f4203b6a"}},{"name":"X-Content-SHA256","in":"header","description":"Lowercase hexadecimal SHA-256 digest of the exact raw request body; use the digest of zero bytes when no body is sent.","required":true,"schema":{"pattern":"[0-9a-f]{64}","type":"string","example":"e3b0c44298fc1c149afbf4c8996fb92427ae41e4649b934ca495991b7852b855"}},{"name":"X-Workspace","in":"header","description":"Personal and enterprise reads are available on this route. For enterprise access, copy your own enterprise:<id> from GET /api/v1/workspaces. Required for v2 requests. V1 requests use the historical key's fixed enterprise.","required":false,"schema":{"pattern":"personal|enterprise:[1-9][0-9]*","type":"string","example":"personal"}},{"name":"X-Environment","in":"header","description":"Required and signed for v2 requests: live or sandbox. Optional for v1 requests.","required":false,"schema":{"pattern":"live|sandbox","type":"string","example":"live"}},{"name":"X-Signature","in":"header","description":"Existing keys accept v1 for their fixed enterprise or v2 for a signed workspace; new keys accept v2 only.","required":true,"schema":{"pattern":"v[12]=[0-9a-f]{64}","type":"string","example":"v2=0123456789abcdef0123456789abcdef0123456789abcdef0123456789abcdef"}},{"name":"Accept-Language","in":"header","description":"Response language: en-US = English (default); zh-CN = Simplified Chinese; zh-TW = Traditional Chinese. Numeric error codes are language-neutral.","required":false,"schema":{"type":"string","enum":["en-US","zh-CN","zh-TW"],"default":"en-US"}}],"responses":{"400":{"description":"Malformed JSON, missing header or invalid request parameter","headers":{"X-Request-ID":{"description":"Request identifier echoed for support and reconciliation.","schema":{"type":"string"}}},"content":{"application/json":{"schema":{"$ref":"#/components/schemas/ApiResponseVoid"}}}},"500":{"description":"Unexpected internal error; contact support with X-Request-ID","headers":{"X-Request-ID":{"description":"Request identifier echoed for support and reconciliation.","schema":{"type":"string"}}},"content":{"application/json":{"schema":{"$ref":"#/components/schemas/ApiResponseVoid"}}}},"403":{"description":"API-key scope, subscription, tenant or policy does not allow the operation","headers":{"X-Request-ID":{"description":"Request identifier echoed for support and reconciliation.","schema":{"type":"string"}}},"content":{"application/json":{"schema":{"$ref":"#/components/schemas/ApiResponseVoid"}}}},"200":{"description":"OK","headers":{"X-Request-ID":{"description":"Request identifier echoed for support and reconciliation.","schema":{"type":"string"}},"X-Quota-Limit":{"description":"Monthly API request allowance for the subscription.","schema":{"type":"integer","format":"int64"}},"X-Quota-Remaining":{"description":"Requests remaining in the current monthly allowance after this request.","schema":{"type":"integer","format":"int64"}},"X-Quota-Reset":{"description":"Unix epoch time in seconds when the monthly allowance resets.","schema":{"type":"integer","format":"int64"}},"X-Quota-Workspace":{"description":"Verified workspace owning this allowance: personal or enterprise:<id>.","schema":{"type":"string"}},"X-Quota-Environment":{"description":"Environment owning the allowance: sandbox or live.","schema":{"type":"string"}}},"content":{"application/json":{"schema":{"$ref":"#/components/schemas/ApiResponseAccountTransactionResponse"}}}},"401":{"description":"Invalid API key, content hash, signature, timestamp or request ID","headers":{"X-Request-ID":{"description":"Request identifier echoed for support and reconciliation.","schema":{"type":"string"}}},"content":{"application/json":{"schema":{"$ref":"#/components/schemas/ApiResponseVoid"}}}},"404":{"description":"Resource not found in this enterprise and environment","headers":{"X-Request-ID":{"description":"Request identifier echoed for support and reconciliation.","schema":{"type":"string"}}},"content":{"application/json":{"schema":{"$ref":"#/components/schemas/ApiResponseVoid"}}}},"422":{"description":"Business rule rejected the request","headers":{"X-Request-ID":{"description":"Request identifier echoed for support and reconciliation.","schema":{"type":"string"}}},"content":{"application/json":{"schema":{"$ref":"#/components/schemas/ApiResponseVoid"}}}},"503":{"description":"A required platform service is temporarily unavailable","headers":{"X-Request-ID":{"description":"Request identifier echoed for support and reconciliation.","schema":{"type":"string"}}},"content":{"application/json":{"schema":{"$ref":"#/components/schemas/ApiResponseVoid"}}}},"409":{"description":"Idempotency or resource-state conflict","headers":{"X-Request-ID":{"description":"Request identifier echoed for support and reconciliation.","schema":{"type":"string"}}},"content":{"application/json":{"schema":{"$ref":"#/components/schemas/ApiResponseVoid"}}}},"429":{"description":"Per-minute rate limit or monthly quota exceeded","headers":{"X-Request-ID":{"description":"Request identifier echoed for support and reconciliation.","schema":{"type":"string"}},"X-Quota-Limit":{"description":"Monthly API request allowance for the subscription.","schema":{"type":"integer","format":"int64"}},"X-Quota-Remaining":{"description":"Requests remaining in the current monthly allowance after this request.","schema":{"type":"integer","format":"int64"}},"X-Quota-Reset":{"description":"Unix epoch time in seconds when the monthly allowance resets.","schema":{"type":"integer","format":"int64"}},"X-Quota-Workspace":{"description":"Verified workspace owning this allowance: personal or enterprise:<id>.","schema":{"type":"string"}},"X-Quota-Environment":{"description":"Environment owning the allowance: sandbox or live.","schema":{"type":"string"}},"Retry-After":{"description":"Seconds until the exhausted quota or rate window resets. Sign retries with a new X-Request-ID.","schema":{"type":"integer","format":"int64"}},"X-RateLimit-Scope":{"description":"Rate counter scope: workspace, or user for enterprise verification calls.","schema":{"type":"string"}},"X-RateLimit-Limit":{"description":"Per-minute request limit when rate-limited.","schema":{"type":"integer","format":"int64"}},"X-RateLimit-Remaining":{"description":"Zero when the minute limit is exhausted.","schema":{"type":"integer","format":"int64"}},"X-RateLimit-Reset":{"description":"Unix epoch seconds when the minute limit resets.","schema":{"type":"integer","format":"int64"}}},"content":{"application/json":{"schema":{"$ref":"#/components/schemas/ApiResponseVoid"}}}},"413":{"description":"Request body is too large","headers":{"X-Request-ID":{"description":"Request identifier echoed for support and reconciliation.","schema":{"type":"string"}}},"content":{"application/json":{"schema":{"$ref":"#/components/schemas/ApiResponseVoid"}}}}},"x-dcwallet-signature-versions":["v1","v2"]}}},"components":{"schemas":{"ApiResponseVoid":{"title":"Void API response","required":["code","message"],"type":"object","properties":{"code":{"type":"integer","description":"Application result code: 0 means success; a nonzero value identifies an error.","format":"int32"},"message":{"type":"string","description":"Human-readable result message. For errors, use it together with code."},"data":{"type":"object","description":"Null."},"details":{"type":"array","description":"The details value for this resource.","items":{"$ref":"#/components/schemas/ErrorDetail"}},"requestId":{"type":"string","description":"The request id value for this resource."}},"description":"Standard response envelope: `code` is 0 on success, `message` explains the result, and `data` is null. Null envelope properties are omitted from JSON."},"ErrorDetail":{"title":"Error Detail","type":"object","properties":{"field":{"type":"string","description":"The field value for this resource.","nullable":true},"reason":{"type":"string","description":"The reason value for this resource.","nullable":true},"allowedValues":{"type":"array","description":"The allowed values value for this resource.","nullable":true,"items":{"type":"string"}},"retryable":{"type":"boolean","description":"The retryable value for this resource.","nullable":true}},"description":"Data model used by the machine REST API."},"WebhookEndpointRequest":{"title":"Webhook Endpoint request","required":["events","url"],"type":"object","properties":{"url":{"maxLength":500,"minLength":0,"type":"string","description":"Required. Public callback URL. Live endpoints must use HTTPS.","example":"https://example.com/webhooks/events"},"events":{"maxItems":32,"minItems":1,"type":"array","description":"Required. Dynamic event subscriptions. Query GET /api/v1/webhook-endpoints/event-types for concrete sandbox test names; exact names and supported prefix patterns such as transfer.* are accepted. Examples are not a complete enum.","example":["card.*","invoice.*","payment.link.*"],"items":{"type":"string","description":"Dynamic event subscriptions. Query GET /api/v1/webhook-endpoints/event-types for concrete sandbox test names; exact names and supported prefix patterns such as transfer.* are accepted. Examples are not a complete enum.","example":"[\"card.*\",\"invoice.*\",\"payment.link.*\"]"}}},"description":"Validated request body. Each field is labelled Required, Conditionally required, or Optional."},"ApiResponseWebhookEndpointResponse":{"title":"Webhook Endpoint API response","required":["code","message"],"type":"object","properties":{"code":{"type":"integer","description":"Application result code: 0 means success; a nonzero value identifies an error.","format":"int32"},"message":{"type":"string","description":"Human-readable result message. For errors, use it together with code."},"data":{"$ref":"#/components/schemas/WebhookEndpointResponse"},"details":{"type":"array","description":"The details value for this resource.","items":{"$ref":"#/components/schemas/ErrorDetail"}},"requestId":{"type":"string","description":"The request id value for this resource."}},"description":"Standard response envelope: `code` is 0 on success, `message` explains the result, and `data` is a `WebhookEndpointResponse` object. Null envelope properties are omitted from JSON."},"WebhookEndpointResponse":{"title":"Webhook Endpoint","type":"object","properties":{"id":{"type":"string","description":"Stable resource identifier. Treat IDs as opaque strings.","nullable":true},"scopeType":{"type":"string","description":"Delivery scope: account for new v2 user endpoints; enterprise for historical v1 endpoints.","nullable":true,"enum":["account","enterprise"]},"enterpriseId":{"type":"string","description":"Bound enterprise ID for a historical enterprise endpoint; null for an account-level endpoint.","nullable":true},"url":{"type":"string","description":"Public webhook callback URL.","nullable":true},"events":{"type":"array","description":"Subscribed event names or supported prefix patterns. Dynamic; GET /api/v1/webhook-endpoints/event-types lists current sandbox test event names.","nullable":true,"items":{"type":"string","description":"Subscribed event names or supported prefix patterns. Dynamic; GET /api/v1/webhook-endpoints/event-types lists current sandbox test event names."}},"status":{"type":"string","description":"Endpoint state: active = deliveries enabled; inactive = deliveries disabled. Defaults to active when created. These are configurable availability states, not terminal delivery outcomes.","nullable":true,"enum":["active","inactive"]},"secret":{"type":"string","description":"Webhook signing secret returned only when the endpoint is created; store it securely.","nullable":true},"lastStatus":{"type":"integer","description":"Most recent HTTP status returned by the webhook receiver.","format":"int32","nullable":true},"lastTriggeredAt":{"type":"string","description":"UTC date-time when the webhook endpoint was most recently triggered.","format":"date-time","nullable":true}},"description":"Fields returned in the operation's `data` property. Optional fields may be null or absent for some records or resource states."},"WebhookTestRequest":{"title":"Webhook Test request","required":["eventType"],"type":"object","properties":{"eventType":{"type":"string","description":"Required. Dynamic sandbox test event name. Query GET /api/v1/webhook-endpoints/event-types for the complete currently supported list; event subscriptions may use exact names or supported wildcard patterns.","example":"transfer.succeeded"}},"description":"Validated request body. Each field is labelled Required, Conditionally required, or Optional."},"ApiResponseWebhookTestResponse":{"title":"Webhook Test API response","required":["code","message"],"type":"object","properties":{"code":{"type":"integer","description":"Application result code: 0 means success; a nonzero value identifies an error.","format":"int32"},"message":{"type":"string","description":"Human-readable result message. For errors, use it together with code."},"data":{"$ref":"#/components/schemas/WebhookTestResponse"},"details":{"type":"array","description":"The details value for this resource.","items":{"$ref":"#/components/schemas/ErrorDetail"}},"requestId":{"type":"string","description":"The request id value for this resource."}},"description":"Standard response envelope: `code` is 0 on success, `message` explains the result, and `data` is a `WebhookTestResponse` object. Null envelope properties are omitted from JSON."},"WebhookTestResponse":{"title":"Webhook Test","type":"object","properties":{"eventId":{"type":"string","description":"Webhook event identifier shared by every attempt to deliver the same event.","nullable":true},"deliveryId":{"type":"string","description":"Unique webhook delivery-attempt identifier.","nullable":true},"endpointId":{"type":"string","description":"Webhook endpoint ID targeted by the delivery; keep IDs as strings.","nullable":true},"eventType":{"type":"string","description":"Enqueued event name from the dynamic GET /api/v1/webhook-endpoints/event-types list.","nullable":true},"status":{"type":"string","description":"Initial delivery state: pending = queued for asynchronous delivery.","nullable":true,"enum":["pending"]}},"description":"Fields returned in the operation's `data` property. Optional fields may be null or absent for some records or resource states."},"TransferDocumentRequest":{"title":"Transfer Document request","required":["documentId","role"],"type":"object","properties":{"documentId":{"type":"string","description":"Required. Document ID returned by POST /api/v1/transfers/documents/{role}."},"role":{"maxLength":64,"minLength":0,"type":"string","description":"Required. Uploaded identity-image role."},"referenceNo":{"maxLength":128,"minLength":0,"type":"string","description":"Optional. Customer-provided reference number used for reconciliation."},"counterpartyName":{"maxLength":255,"minLength":0,"type":"string","description":"Optional. The counterparty name value for this resource."},"effectiveDate":{"type":"string","description":"Optional. The effective date value for this resource.","format":"date"},"expiryDate":{"type":"string","description":"Optional. Identity document expiry date in ISO-8601 date format; null when not supplied.","format":"date"},"applicablePurposes":{"maxItems":20,"minItems":0,"type":"array","description":"Optional. The applicable purposes value for this resource.","items":{"type":"string"}}},"description":"Validated request body. Each field is labelled Required, Conditionally required, or Optional."},"TransferRequest":{"title":"Transfer request","required":["amount","sourceAccountId"],"type":"object","properties":{"sourceAccountId":{"type":"string","description":"Required. Enterprise account ID returned by GET /api/v1/accounts."},"destinationAccountId":{"maxLength":32,"minLength":0,"type":"string","description":"Conditionally required: Supply a saved destinationAccountId, or direct recipient fields when it is omitted. Saved contact account ID returned by GET /api/v1/contacts/{contactId}/accounts. Omit it when supplying a direct blockchain address or bank account, including a mainland CNY bank account."},"amount":{"minimum":0,"exclusiveMinimum":true,"type":"number","description":"Required. Decimal monetary amount represented as a string to preserve precision."},"recipientCurrency":{"maxLength":16,"minLength":0,"type":"string","description":"Conditionally required: Set CNY for a direct mainland CNY payout from a CNH source account. Currency received by the beneficiary. Set CNY for a direct mainland CNY payout from a CNH source account."},"recipientAmount":{"minimum":0,"exclusiveMinimum":true,"type":"number","description":"Optional. The recipient amount value for this resource."},"memo":{"maxLength":500,"minLength":0,"type":"string","description":"Optional. Internal contact note."},"clientOrderNo":{"maxLength":128,"minLength":0,"type":"string","description":"Optional. Caller-defined business order number. Must be unique within the enterprise and environment."},"paymentPurpose":{"maxLength":64,"minLength":0,"type":"string","description":"Optional. Free-text business purpose code used by document and channel rules. Values depend on configured policy; inspect POST /api/v1/transfers/document-requirements/preview with the same purpose. No universal closed enum or default."},"purposeNote":{"maxLength":500,"minLength":0,"type":"string","description":"Optional. The purpose note value for this resource."},"recipientAddress":{"maxLength":255,"minLength":0,"type":"string","description":"Conditionally required: Required for a direct crypto transfer when destinationAccountId is omitted. Ad-hoc blockchain destination. Required for crypto when destinationAccountId is omitted."},"recipientBankName":{"maxLength":128,"minLength":0,"type":"string","description":"Conditionally required: Required for a direct fiat transfer when destinationAccountId is omitted. Direct beneficiary bank name. Required for fiat when destinationAccountId is omitted."},"recipientBankCode":{"maxLength":64,"minLength":0,"type":"string","description":"Optional. The recipient bank code value for this resource."},"recipientBranchCode":{"maxLength":64,"minLength":0,"type":"string","description":"Optional. The recipient branch code value for this resource."},"recipientBankBranch":{"maxLength":128,"minLength":0,"type":"string","description":"Optional. The recipient bank branch value for this resource."},"recipientBankAddress":{"maxLength":500,"minLength":0,"type":"string","description":"Optional. The recipient bank address value for this resource."},"recipientBankCountryCode":{"pattern":"(?i)[A-Z]{2}","type":"string","description":"Optional. ISO 3166-1 alpha-2 bank country. Defaults to CN for a direct CNY payout."},"recipientBeneficiaryType":{"pattern":"individual|business","type":"string","description":"Optional. Beneficiary type: individual = natural person; business = company. Defaults to business when recipientRegistrationNumber is supplied; otherwise to individual for a direct bank payout.","enum":["individual","business"]},"recipientRegistrationType":{"maxLength":64,"minLength":0,"type":"string","description":"Conditionally required: Optional for a business beneficiary; defaults to business_registration when recipientRegistrationNumber is supplied. Open text business identifier type. Examples: business_registration, brn, company_number, vat, ein; these are not a complete enum. Defaults to business_registration when recipientRegistrationNumber is supplied."},"recipientRegistrationNumber":{"maxLength":128,"minLength":0,"type":"string","description":"Conditionally required: Optional business registration or tax identifier for direct or saved beneficiaries. Business registration or tax identifier. Supported for direct and saved beneficiaries across regions."},"recipientBankAccountType":{"maxLength":32,"minLength":0,"type":"string","description":"Optional. Provider-specific bank account type as free text; no universal enum or default. Supply only when the receiving bank or payout provider requires it."},"recipientAccountIdentifierType":{"maxLength":32,"minLength":0,"type":"string","description":"Optional. Account identifier type: iban = International Bank Account Number; local = domestic account number. If omitted, inferred from recipientAccountNo. Other provider-specific values are not a closed enum."},"recipientRoutingCode":{"maxLength":128,"minLength":0,"type":"string","description":"Optional. The recipient routing code value for this resource."},"recipientRoutingCodeType":{"maxLength":32,"minLength":0,"type":"string","description":"Optional. Routing-code type. Common values: aba (US), sort_code (UK), bank_code (HK), cnaps (mainland CNY). Provider-specific types are allowed; the known type is inferred from bank country when possible. Examples are not a complete enum."},"recipientPaymentRail":{"maxLength":32,"minLength":0,"type":"string","description":"Optional. Dynamic payment rail. Examples: ACH, FEDWIRE, SWIFT, CHATS, CHAPS, SEPA, CNAPS; these are not a complete enum. If omitted, inferred from IBAN, routing code, bank country or SWIFT/BIC. GET /api/v1/transfers/requirements provides field suggestions and availability for a selected country, currency, rail and amount."},"recipientAccountNo":{"maxLength":128,"minLength":0,"type":"string","description":"Conditionally required: Required for a direct fiat transfer when destinationAccountId is omitted. Direct beneficiary account number or IBAN. Required for fiat when destinationAccountId is omitted."},"recipientAccountHolder":{"maxLength":128,"minLength":0,"type":"string","description":"Conditionally required: Required for a direct CNY transfer when destinationAccountId is omitted. Direct beneficiary account-holder name. Required for a direct CNY payout; no beneficiary identity number is required."},"swiftCode":{"maxLength":32,"minLength":0,"type":"string","description":"Optional. SWIFT/BIC used for international bank routing."},"documents":{"maxItems":20,"minItems":0,"type":"array","description":"Optional. The documents value for this resource.","items":{"$ref":"#/components/schemas/TransferDocumentRequest"}}},"description":"Supply a saved destinationAccountId or direct recipient fields. A direct mainland CNY payout requires a CNH source account, recipientCurrency=CNY, recipientBankName, recipientAccountHolder and recipientAccountNo; no contact or beneficiary identity number is required. Business registration identifiers are optional."},"ApiResponseTransferResponse":{"title":"Transfer API response","required":["code","message"],"type":"object","properties":{"code":{"type":"integer","description":"Application result code: 0 means success; a nonzero value identifies an error.","format":"int32"},"message":{"type":"string","description":"Human-readable result message. For errors, use it together with code."},"data":{"$ref":"#/components/schemas/TransferResponse"},"details":{"type":"array","description":"The details value for this resource.","items":{"$ref":"#/components/schemas/ErrorDetail"}},"requestId":{"type":"string","description":"The request id value for this resource."}},"description":"Standard response envelope: `code` is 0 on success, `message` explains the result, and `data` is a `TransferResponse` object. Null envelope properties are omitted from JSON."},"TransferResponse":{"title":"Transfer","required":["id","status"],"type":"object","properties":{"id":{"type":"string","description":"Stable resource identifier. Treat IDs as opaque strings."},"transferNo":{"type":"string","description":"The transfer no value for this resource.","nullable":true},"clientOrderNo":{"type":"string","description":"The client order no value for this resource.","nullable":true},"batchId":{"type":"string","description":"The batch id value for this resource.","nullable":true},"destinationAccountId":{"type":"string","description":"The destination account id value for this resource.","nullable":true},"recipientAddress":{"type":"string","description":"The recipient address value for this resource.","nullable":true},"recipientBankName":{"type":"string","description":"The recipient bank name value for this resource.","nullable":true},"recipientBankCode":{"type":"string","description":"The recipient bank code value for this resource.","nullable":true},"recipientBranchCode":{"type":"string","description":"The recipient branch code value for this resource.","nullable":true},"recipientBankBranch":{"type":"string","description":"The recipient bank branch value for this resource.","nullable":true},"recipientBankAddress":{"type":"string","description":"The recipient bank address value for this resource.","nullable":true},"recipientBankCountryCode":{"type":"string","description":"The recipient bank country code value for this resource.","nullable":true},"recipientBeneficiaryType":{"type":"string","description":"Resolved beneficiary type: individual = natural person; business = company.","nullable":true,"enum":["individual","business"]},"recipientRegistrationType":{"type":"string","description":"Business registration type as submitted or defaulted. Provider-specific free text, not a closed enum.","nullable":true},"recipientRegistrationNumber":{"type":"string","description":"The recipient registration number value for this resource.","nullable":true},"recipientBankAccountType":{"type":"string","description":"Provider-specific bank account type as submitted; free text, possibly null.","nullable":true},"recipientAccountIdentifierType":{"type":"string","description":"Resolved account identifier type, usually iban or local. Provider-specific values remain possible; inspect GET /api/v1/transfers/requirements for suggestions.","nullable":true},"recipientAccountNo":{"type":"string","description":"The recipient account no value for this resource.","nullable":true},"recipientAccountHolder":{"type":"string","description":"The recipient account holder value for this resource.","nullable":true},"recipientRoutingCode":{"type":"string","description":"The recipient routing code value for this resource.","nullable":true},"recipientRoutingCodeType":{"type":"string","description":"Resolved routing-code type, for example aba, sort_code, bank_code or cnaps. Provider-specific values remain possible.","nullable":true},"recipientPaymentRail":{"type":"string","description":"Dynamic resolved payment rail with channel-specific values. Consult GET /api/v1/transfers/requirements for country/currency field suggestions, then inspect the returned transfer for the actual rail.","nullable":true},"swiftCode":{"type":"string","description":"SWIFT/BIC used for international bank routing.","nullable":true},"paymentMethod":{"type":"string","description":"Transfer method: fiat = bank payout; crypto = blockchain transfer.","nullable":true,"enum":["fiat","crypto"]},"network":{"type":"string","description":"Enabled blockchain network; null for fiat-only resources.","nullable":true},"txHash":{"type":"string","description":"Public blockchain transaction hash for a crypto transfer; null before broadcast and for fiat transfers.","nullable":true},"amount":{"type":"string","description":"Decimal monetary amount represented as a string to preserve precision.","nullable":true},"currency":{"type":"string","description":"ISO currency or enabled asset code used for monetary values.","nullable":true},"recipientAmount":{"type":"string","description":"The recipient amount value for this resource.","nullable":true},"recipientCurrency":{"type":"string","description":"The recipient currency value for this resource.","nullable":true},"memo":{"type":"string","description":"Internal contact note.","nullable":true},"paymentPurpose":{"type":"string","description":"The payment purpose value for this resource.","nullable":true},"purposeNote":{"type":"string","description":"The purpose note value for this resource.","nullable":true},"status":{"type":"string","description":"Transfer state: pending = queued; draft = saved before submission; pending_approval = generic approval; pending_batch_approval = batch approval; pending_enterprise_approval = enterprise approval; enterprise_approved = enterprise approved; pending_platform_approval = platform approval; pending_compliance = compliance review; approved = authorized; signature_pending = awaiting signature; external_verifying = external verification; processing = executing; confirming = awaiting confirmation; pending_manual = queued for operator; manual_processing = operator executing; failed_unknown = outcome under investigation. Terminal: succeeded = paid, failed = failed, rejected = denied, cancelled = cancelled. No fixed submission default; the first returned state depends on approval and execution rules.","enum":["pending","draft","pending_approval","pending_batch_approval","pending_enterprise_approval","enterprise_approved","pending_platform_approval","pending_compliance","approved","signature_pending","external_verifying","processing","confirming","pending_manual","manual_processing","failed_unknown","succeeded","failed","rejected","cancelled"]},"failureReason":{"type":"string","description":"Human-readable rejection or failure reason; null when the operation has not failed.","nullable":true},"createdAt":{"type":"string","description":"UTC date-time when the resource was created.","format":"date-time","nullable":true},"completedAt":{"type":"string","description":"UTC date-time when task processing completed; null while unfinished.","format":"date-time","nullable":true}},"description":"Fields returned in the operation's `data` property. Optional fields may be null or absent for some records or resource states."},"ApiResponseTransferDocumentUploadResponse":{"title":"Transfer Document Upload API response","required":["code","message"],"type":"object","properties":{"code":{"type":"integer","description":"Application result code: 0 means success; a nonzero value identifies an error.","format":"int32"},"message":{"type":"string","description":"Human-readable result message. For errors, use it together with code."},"data":{"$ref":"#/components/schemas/TransferDocumentUploadResponse"},"details":{"type":"array","description":"The details value for this resource.","items":{"$ref":"#/components/schemas/ErrorDetail"}},"requestId":{"type":"string","description":"The request id value for this resource."}},"description":"Standard response envelope: `code` is 0 on success, `message` explains the result, and `data` is a `TransferDocumentUploadResponse` object. Null envelope properties are omitted from JSON."},"TransferDocumentUploadResponse":{"title":"Transfer Document Upload","type":"object","properties":{"documentId":{"type":"string","description":"The document id value for this resource.","nullable":true},"role":{"type":"string","description":"Uploaded identity-image role.","nullable":true},"fileName":{"type":"string","description":"Original uploaded identity-document file name.","nullable":true},"mimeType":{"type":"string","description":"Detected upload media type.","nullable":true},"fileSize":{"type":"string","description":"Uploaded file size in bytes.","nullable":true},"status":{"type":"string","description":"Uploaded transfer document state: active = available for submission; deleted = no longer available. Default after successful upload: active.","nullable":true,"enum":["active","deleted"]},"precheckStatus":{"type":"string","description":"Document precheck result: skipped = precheck disabled; passed = machine check accepted; review_required = manual inspection needed; rejected = machine check rejected; error = precheck unavailable and manual review needed. This is a document check, not a transfer state.","nullable":true,"enum":["skipped","passed","review_required","rejected","error"]},"precheckMessage":{"type":"string","description":"The precheck message value for this resource.","nullable":true}},"description":"Fields returned in the operation's `data` property. Optional fields may be null or absent for some records or resource states."},"TransferDocumentRequirementRequest":{"title":"Transfer Document Requirement request","type":"object","properties":{"paymentPurpose":{"maxLength":64,"minLength":0,"type":"string","description":"Optional. Free-text business purpose. Values depend on configured document policy; query this preview with the same purpose. No fixed enum or default."},"contactType":{"maxLength":32,"minLength":0,"type":"string","description":"Optional. Dynamic saved contact role; query GET /api/v1/contacts for existing values. No universal closed enum."},"sameNameStatus":{"pattern":"same|different|unknown","type":"string","description":"Optional. Name comparison: same = payer and beneficiary match; different = mismatch; unknown = insufficient evidence. No default.","enum":["same","different","unknown"]},"paymentMethod":{"pattern":"fiat|crypto","type":"string","description":"Optional. Payment method: fiat = bank payout; crypto = blockchain transfer. No default in this preview; supply the intended method.","enum":["fiat","crypto"]},"currency":{"maxLength":16,"minLength":0,"type":"string","description":"Optional. ISO currency or enabled asset code used for monetary values."},"recipientCountry":{"pattern":"(?i)[A-Z]{2}","type":"string","description":"Optional. The recipient country value for this resource."},"amount":{"minimum":0,"exclusiveMinimum":false,"type":"number","description":"Optional. Decimal monetary amount represented as a string to preserve precision."},"contactId":{"pattern":"[0-9]+","type":"string","description":"Optional. Enterprise contact ID associated with the resource; keep IDs as strings."},"directDocumentRoles":{"maxItems":20,"minItems":0,"uniqueItems":true,"type":"array","description":"Optional. The direct document roles value for this resource.","items":{"type":"string"}},"contactDocumentRoles":{"maxItems":20,"minItems":0,"uniqueItems":true,"type":"array","description":"Optional. The contact document roles value for this resource.","items":{"type":"string"}},"approvedContactDocumentRoles":{"maxItems":20,"minItems":0,"uniqueItems":true,"type":"array","description":"Optional. The approved contact document roles value for this resource.","items":{"type":"string"}}},"description":"Validated request body. Each field is labelled Required, Conditionally required, or Optional."},"ApiResponseTransferDocumentRequirementResponse":{"title":"Transfer Document Requirement API response","required":["code","message"],"type":"object","properties":{"code":{"type":"integer","description":"Application result code: 0 means success; a nonzero value identifies an error.","format":"int32"},"message":{"type":"string","description":"Human-readable result message. For errors, use it together with code."},"data":{"$ref":"#/components/schemas/TransferDocumentRequirementResponse"},"details":{"type":"array","description":"The details value for this resource.","items":{"$ref":"#/components/schemas/ErrorDetail"}},"requestId":{"type":"string","description":"The request id value for this resource."}},"description":"Standard response envelope: `code` is 0 on success, `message` explains the result, and `data` is a `TransferDocumentRequirementResponse` object. Null envelope properties are omitted from JSON."},"TransferDocumentRequirementResponse":{"title":"Transfer Document Requirement","type":"object","properties":{"result":{"type":"string","description":"Document preview result: not_required = no rule applies; satisfied = supplied evidence meets a rule; review_required = evidence requires manual review; missing = required evidence is absent. This is a preview, not a transfer lifecycle state.","nullable":true,"enum":["not_required","satisfied","review_required","missing"]},"sameNameStatus":{"type":"string","description":"Payer and recipient name comparison: same = matched; different = mismatch; unknown = insufficient evidence.","nullable":true,"enum":["same","different","unknown"]},"matchedRuleIds":{"type":"array","description":"The matched rule ids value for this resource.","nullable":true,"items":{"type":"string"}},"satisfiedRoles":{"uniqueItems":true,"type":"array","description":"The satisfied roles value for this resource.","nullable":true,"items":{"type":"string"}},"missingGroups":{"type":"array","description":"The missing groups value for this resource.","nullable":true,"items":{"type":"array","items":{"type":"string"}}},"message":{"type":"string","description":"Human-readable result message. For errors, use it together with code.","nullable":true}},"description":"Fields returned in the operation's `data` property. Optional fields may be null or absent for some records or resource states."},"TransferBatchRequest":{"title":"Transfer Batch request","required":["items"],"type":"object","properties":{"items":{"maxItems":500,"minItems":1,"type":"array","description":"Required. Resources returned on the current result page.","items":{"$ref":"#/components/schemas/TransferRequest"}},"fileName":{"maxLength":255,"minLength":0,"type":"string","description":"Optional. Original uploaded identity-document file name."}},"description":"Validated request body. Each field is labelled Required, Conditionally required, or Optional."},"ApiResponseTransferBatchResponse":{"title":"Transfer Batch API response","required":["code","message"],"type":"object","properties":{"code":{"type":"integer","description":"Application result code: 0 means success; a nonzero value identifies an error.","format":"int32"},"message":{"type":"string","description":"Human-readable result message. For errors, use it together with code."},"data":{"$ref":"#/components/schemas/TransferBatchResponse"},"details":{"type":"array","description":"The details value for this resource.","items":{"$ref":"#/components/schemas/ErrorDetail"}},"requestId":{"type":"string","description":"The request id value for this resource."}},"description":"Standard response envelope: `code` is 0 on success, `message` explains the result, and `data` is a `TransferBatchResponse` object. Null envelope properties are omitted from JSON."},"TransferBatchResponse":{"title":"Transfer Batch","type":"object","properties":{"id":{"type":"string","description":"Stable resource identifier. Treat IDs as opaque strings.","nullable":true},"batchNumber":{"type":"string","description":"The batch number value for this resource.","nullable":true},"totalItems":{"type":"integer","description":"The total items value for this resource.","format":"int32","nullable":true},"totalAmount":{"type":"string","description":"The total amount value for this resource.","nullable":true},"status":{"type":"string","description":"Batch state: draft = prepared; pending_approval = awaiting enterprise approval; approved = ready; processing = items running; completed = finalized; rejected = denied; cancelled = cancelled. Terminal: completed, rejected, cancelled.","nullable":true,"enum":["draft","pending_approval","approved","processing","completed","rejected","cancelled"]},"result":{"type":"string","description":"Final batch outcome, null until finalized: succeeded = all items succeeded; partial_failed = mixed item outcomes; failed = no item succeeded. All three values are final outcomes.","nullable":true,"enum":["succeeded","partial_failed","failed"]},"succeededItems":{"type":"string","description":"The succeeded items value for this resource.","nullable":true},"failedItems":{"type":"string","description":"The failed items value for this resource.","nullable":true},"rejectedItems":{"type":"string","description":"The rejected items value for this resource.","nullable":true},"cancelledItems":{"type":"string","description":"The cancelled items value for this resource.","nullable":true},"pendingItems":{"type":"string","description":"The pending items value for this resource.","nullable":true},"reviewItems":{"type":"string","description":"The review items value for this resource.","nullable":true},"createdAt":{"type":"string","description":"UTC date-time when the resource was created.","format":"date-time","nullable":true},"completedAt":{"type":"string","description":"UTC date-time when task processing completed; null while unfinished.","format":"date-time","nullable":true},"items":{"type":"array","description":"Resources returned on the current result page.","nullable":true,"items":{"$ref":"#/components/schemas/TransferResponse"}}},"description":"Fields returned in the operation's `data` property. Optional fields may be null or absent for some records or resource states."},"SandboxFiatDepositRequest":{"title":"Sandbox Fiat Deposit request","required":["amount","bankAccountId","currency"],"type":"object","properties":{"bankAccountId":{"pattern":"[1-9][0-9]*","type":"string","description":"Required. The bank account id value for this resource."},"currency":{"pattern":"[A-Za-z]{3}","type":"string","description":"Required. ISO currency or enabled asset code used for monetary values."},"amount":{"type":"number","description":"Required. Decimal monetary amount represented as a string to preserve precision."},"reference":{"maxLength":128,"minLength":0,"type":"string","description":"Optional. The reference value for this resource."},"status":{"pattern":"settled|pending_settlement|refunded|reversed","type":"string","description":"Optional. Synthetic receipt outcome: settled = credited (can later be refunded or reversed); pending_settlement = AML hold; refunded = returned to sender (terminal); reversed = credit reversed (terminal). Defaults to settled.","enum":["settled","pending_settlement","refunded","reversed"],"default":"settled"}},"description":"Validated request body. Each field is labelled Required, Conditionally required, or Optional."},"ApiResponseSandboxFiatDepositResponse":{"title":"Sandbox Fiat Deposit API response","required":["code","message"],"type":"object","properties":{"code":{"type":"integer","description":"Application result code: 0 means success; a nonzero value identifies an error.","format":"int32"},"message":{"type":"string","description":"Human-readable result message. For errors, use it together with code."},"data":{"$ref":"#/components/schemas/SandboxFiatDepositResponse"},"details":{"type":"array","description":"The details value for this resource.","items":{"$ref":"#/components/schemas/ErrorDetail"}},"requestId":{"type":"string","description":"The request id value for this resource."}},"description":"Standard response envelope: `code` is 0 on success, `message` explains the result, and `data` is a `SandboxFiatDepositResponse` object. Null envelope properties are omitted from JSON."},"SandboxFiatDepositResponse":{"title":"Sandbox Fiat Deposit","type":"object","properties":{"paymentRecordId":{"type":"string","description":"The payment record id value for this resource.","nullable":true},"referenceNo":{"type":"string","description":"Customer-provided reference number used for reconciliation.","nullable":true},"currency":{"type":"string","description":"ISO currency or enabled asset code used for monetary values.","nullable":true},"amount":{"type":"number","description":"Decimal monetary amount represented as a string to preserve precision.","nullable":true},"status":{"type":"string","description":"Synthetic receipt state: settled = credited (can later be refunded or reversed); pending_settlement = AML hold awaiting credit; refunded = returned to sender (terminal); reversed = prior credit reversed (terminal). Default when status is omitted: settled.","nullable":true,"enum":["settled","pending_settlement","refunded","reversed"]}},"description":"Fields returned in the operation's `data` property. Optional fields may be null or absent for some records or resource states."},"ApiResponseSampleResponse":{"title":"Sample API response","required":["code","message"],"type":"object","properties":{"code":{"type":"integer","description":"Application result code: 0 means success; a nonzero value identifies an error.","format":"int32"},"message":{"type":"string","description":"Human-readable result message. For errors, use it together with code."},"data":{"$ref":"#/components/schemas/SampleResponse"},"details":{"type":"array","description":"The details value for this resource.","items":{"$ref":"#/components/schemas/ErrorDetail"}},"requestId":{"type":"string","description":"The request id value for this resource."}},"description":"Standard response envelope: `code` is 0 on success, `message` explains the result, and `data` is a `SampleResponse` object. Null envelope properties are omitted from JSON."},"SampleResponse":{"title":"Sample","type":"object","properties":{"workspace":{"type":"string","description":"The workspace value for this resource.","nullable":true},"enterpriseId":{"type":"string","description":"The enterprise id value for this resource.","nullable":true},"name":{"type":"string","description":"Customer-facing resource or capability name.","nullable":true},"verificationStatus":{"type":"string","description":"The verification status value for this resource.","nullable":true},"synthetic":{"type":"boolean","description":"The synthetic value for this resource.","nullable":true}},"description":"Fields returned in the operation's `data` property. Optional fields may be null or absent for some records or resource states."},"SandboxCryptoDepositRequest":{"title":"Sandbox Crypto Deposit request","required":["addressId","amount","currency"],"type":"object","properties":{"addressId":{"pattern":"[1-9][0-9]*","type":"string","description":"Required. The address id value for this resource."},"currency":{"pattern":"[A-Za-z0-9]{2,16}","type":"string","description":"Required. ISO currency or enabled asset code used for monetary values."},"amount":{"type":"number","description":"Required. Decimal monetary amount represented as a string to preserve precision."},"status":{"pattern":"settled|pending_settlement|refunded|reversed","type":"string","description":"Optional. Synthetic receipt outcome: settled = credited (can later be refunded or reversed); pending_settlement = AML hold; refunded = returned to sender (terminal); reversed = credit reversed (terminal). Defaults to settled.","enum":["settled","pending_settlement","refunded","reversed"],"default":"settled"}},"description":"Validated request body. Each field is labelled Required, Conditionally required, or Optional."},"ApiResponseSandboxDepositResponse":{"title":"Sandbox Deposit API response","required":["code","message"],"type":"object","properties":{"code":{"type":"integer","description":"Application result code: 0 means success; a nonzero value identifies an error.","format":"int32"},"message":{"type":"string","description":"Human-readable result message. For errors, use it together with code."},"data":{"$ref":"#/components/schemas/SandboxDepositResponse"},"details":{"type":"array","description":"The details value for this resource.","items":{"$ref":"#/components/schemas/ErrorDetail"}},"requestId":{"type":"string","description":"The request id value for this resource."}},"description":"Standard response envelope: `code` is 0 on success, `message` explains the result, and `data` is a `SandboxDepositResponse` object. Null envelope properties are omitted from JSON."},"SandboxDepositResponse":{"title":"Sandbox Deposit","type":"object","properties":{"paymentRecordId":{"type":"string","description":"The payment record id value for this resource.","nullable":true},"txHash":{"type":"string","description":"Public blockchain transaction hash; null until a crypto transaction is broadcast.","nullable":true},"currency":{"type":"string","description":"ISO currency or enabled asset code used for monetary values.","nullable":true},"amount":{"type":"number","description":"Decimal monetary amount represented as a string to preserve precision.","nullable":true},"status":{"type":"string","description":"Synthetic receipt state: settled = credited (can later be refunded or reversed); pending_settlement = AML hold awaiting credit; refunded = returned to sender (terminal); reversed = prior credit reversed (terminal). Default when status is omitted: settled.","nullable":true,"enum":["settled","pending_settlement","refunded","reversed"]}},"description":"Fields returned in the operation's `data` property. Optional fields may be null or absent for some records or resource states."},"ApiResponseInvoiceResponse":{"title":"Invoice API response","required":["code","message"],"type":"object","properties":{"code":{"type":"integer","description":"Application result code: 0 means success; a nonzero value identifies an error.","format":"int32"},"message":{"type":"string","description":"Human-readable result message. For errors, use it together with code."},"data":{"$ref":"#/components/schemas/InvoiceResponse"},"details":{"type":"array","description":"The details value for this resource.","items":{"$ref":"#/components/schemas/ErrorDetail"}},"requestId":{"type":"string","description":"The request id value for this resource."}},"description":"Standard response envelope: `code` is 0 on success, `message` explains the result, and `data` is a `InvoiceResponse` object. Null envelope properties are omitted from JSON."},"InvoiceResponse":{"title":"Invoice","type":"object","properties":{"id":{"type":"string","description":"Stable resource identifier. Treat IDs as opaque strings.","nullable":true},"invoiceNo":{"type":"string","description":"Customer-facing invoice number.","nullable":true},"contactId":{"type":"string","description":"Enterprise contact ID associated with the resource; keep IDs as strings.","nullable":true},"customerType":{"type":"string","description":"Receivable customer type: business = company payer; consumer = individual checkout payer. Consumer checkout defaults to platform_routed.","nullable":true,"enum":["business","consumer"]},"collectionMode":{"type":"string","description":"Collection mode: direct = selected receiving account; platform_routed = platform-assigned crypto collection address. Defaults to direct for business and platform_routed for consumer.","nullable":true,"enum":["direct","platform_routed"]},"customerName":{"type":"string","description":"Customer legal or display name copied to the invoice.","nullable":true},"customerEmail":{"type":"string","description":"Customer email copied to the invoice.","nullable":true},"currency":{"type":"string","description":"ISO currency or enabled asset code used for monetary values.","nullable":true},"paymentMethod":{"type":"string","description":"Invoice payment method: fiat = bank collection; crypto = blockchain collection. Determined by the invoice currency at creation; no caller-supplied default.","nullable":true,"enum":["fiat","crypto"]},"amount":{"type":"string","description":"Decimal monetary amount represented as a string to preserve precision.","nullable":true},"paidAmount":{"type":"string","description":"Amount already paid against the invoice, represented as a decimal string.","nullable":true},"status":{"type":"string","description":"Invoice state: draft = editable (default on creation); sent = issued and awaiting payment; partial_paid = some amount received; fully_paid = target amount received; overpaid = amount exceeds target; overdue = unpaid after due date; cancelled = voided (terminal); refunded = collected funds returned (terminal). Paid states may later change after another payment or refund.","nullable":true,"enum":["draft","sent","partial_paid","fully_paid","overpaid","overdue","cancelled","refunded"]},"issueDate":{"type":"string","description":"Invoice issue date in ISO-8601 date format.","nullable":true},"dueDate":{"type":"string","description":"Invoice due date in ISO-8601 date format.","nullable":true},"description":{"type":"string","description":"Customer-facing or operational description of the resource.","nullable":true},"paymentUrl":{"type":"string","description":"Hosted customer payment URL.","nullable":true},"createdAt":{"type":"string","description":"UTC date-time when the resource was created.","format":"date-time","nullable":true},"updatedAt":{"type":"string","description":"UTC date-time when the resource was most recently updated.","format":"date-time","nullable":true}},"description":"Fields returned in the operation's `data` property. Optional fields may be null or absent for some records or resource states."},"InvoiceLineItemRequest":{"title":"Invoice Line Item request","required":["amount","description","quantity","unitPrice"],"type":"object","properties":{"description":{"maxLength":255,"minLength":0,"type":"string","description":"Required. Line-item description.","example":"Consulting services"},"quantity":{"minimum":0.000001,"exclusiveMinimum":false,"type":"number","description":"Required. Quantity sold.","example":2},"unitPrice":{"minimum":0,"exclusiveMinimum":false,"type":"number","description":"Required. Price per unit.","example":500},"amount":{"minimum":0,"exclusiveMinimum":false,"type":"number","description":"Required. Line total.","example":1000}},"description":"Optional itemized invoice lines."},"InvoiceRequest":{"title":"Invoice request","required":["amount","currency"],"type":"object","properties":{"contactId":{"pattern":"[0-9]+","type":"string","description":"Optional. Contact ID. Omit it to create a consumer checkout link.","example":"123456789012345678"},"currency":{"maxLength":16,"minLength":0,"type":"string","description":"Required. Invoice currency code.","example":"USDT"},"amount":{"minimum":0.01,"exclusiveMinimum":false,"type":"number","description":"Required. Total amount due.","example":1000},"description":{"maxLength":1000,"minLength":0,"type":"string","description":"Optional. Payment purpose or invoice memo.","example":"August consulting services"},"dueDate":{"type":"string","description":"Optional. Due date in ISO-8601 date format.","format":"date","example":"2026-09-30"},"bankAccountId":{"pattern":"[0-9]+","type":"string","description":"Optional. Fiat receiving account ID. Do not supply with blockchainAddressId.","example":"123456789012345681"},"blockchainAddressId":{"pattern":"[0-9]+","type":"string","description":"Optional. Stablecoin receiving-address ID. Do not supply with bankAccountId.","example":"123456789012345682"},"lineItems":{"type":"array","description":"Optional. Itemized invoice lines.","items":{"$ref":"#/components/schemas/InvoiceLineItemRequest"}}},"description":"Validated request body. Each field is labelled Required, Conditionally required, or Optional."},"PaymentLinkRequest":{"title":"Payment Link request","type":"object","properties":{"invoiceId":{"pattern":"[0-9]+","type":"string","description":"Conditionally required: Supply invoiceId, or supply both currency and amount. Existing invoice ID.","example":"123456789012345683"},"currency":{"maxLength":16,"minLength":0,"type":"string","description":"Conditionally required: Required with amount when invoiceId is omitted. Standalone-link currency code.","example":"USDT"},"amount":{"minimum":0.01,"exclusiveMinimum":false,"type":"number","description":"Conditionally required: Required with currency when invoiceId is omitted. Standalone-link amount.","example":250},"description":{"maxLength":1000,"minLength":0,"type":"string","description":"Optional. Customer-facing payment description.","example":"Order 2026-042"},"expiresAt":{"type":"string","description":"Optional. Future expiry in ISO-8601 date-time format.","format":"date-time"}},"description":"Supply invoiceId, or supply both currency and amount for a standalone link."},"ApiResponsePaymentLinkResponse":{"title":"Payment Link API response","required":["code","message"],"type":"object","properties":{"code":{"type":"integer","description":"Application result code: 0 means success; a nonzero value identifies an error.","format":"int32"},"message":{"type":"string","description":"Human-readable result message. For errors, use it together with code."},"data":{"$ref":"#/components/schemas/PaymentLinkResponse"},"details":{"type":"array","description":"The details value for this resource.","items":{"$ref":"#/components/schemas/ErrorDetail"}},"requestId":{"type":"string","description":"The request id value for this resource."}},"description":"Standard response envelope: `code` is 0 on success, `message` explains the result, and `data` is a `PaymentLinkResponse` object. Null envelope properties are omitted from JSON."},"PaymentLinkResponse":{"title":"Payment Link","type":"object","properties":{"id":{"type":"string","description":"Stable resource identifier. Treat IDs as opaque strings.","nullable":true},"invoiceId":{"type":"string","description":"Linked invoice ID; null for a standalone payment link. Keep IDs as strings.","nullable":true},"currency":{"type":"string","description":"ISO currency or enabled asset code used for monetary values.","nullable":true},"amount":{"type":"string","description":"Decimal monetary amount represented as a string to preserve precision.","nullable":true},"description":{"type":"string","description":"Customer-facing or operational description of the resource.","nullable":true},"paymentUrl":{"type":"string","description":"Hosted customer payment URL.","nullable":true},"status":{"type":"string","description":"Payment-link state: active = accepts payment (default on creation); paid = target payment completed (terminal for this link); expired = expiry reached (terminal); cancelled = disabled by owner (terminal).","nullable":true,"enum":["active","paid","expired","cancelled"]},"expiresAt":{"type":"string","description":"UTC date-time after which the link or session can no longer be used.","format":"date-time","nullable":true},"createdAt":{"type":"string","description":"UTC date-time when the resource was created.","format":"date-time","nullable":true}},"description":"Fields returned in the operation's `data` property. Optional fields may be null or absent for some records or resource states."},"CrossChainQuoteRequest":{"title":"Cross Chain Quote request","required":["buyCurrency","sellAmount","sellCurrency","sourceAddressId","targetAddressId"],"type":"object","properties":{"sourceAddressId":{"maxLength":19,"minLength":0,"pattern":"[1-9][0-9]*","type":"string","description":"Required. The source address id value for this resource."},"targetAddressId":{"maxLength":19,"minLength":0,"pattern":"[1-9][0-9]*","type":"string","description":"Required. The target address id value for this resource."},"sellCurrency":{"pattern":"[A-Za-z0-9]{2,16}","type":"string","description":"Required. The sell currency value for this resource."},"buyCurrency":{"pattern":"[A-Za-z0-9]{2,16}","type":"string","description":"Required. The buy currency value for this resource."},"sellAmount":{"minimum":0,"exclusiveMinimum":true,"type":"number","description":"Required. The sell amount value for this resource."}},"description":"Validated request body. Each field is labelled Required, Conditionally required, or Optional."},"ApiResponseOrderResponse":{"title":"Order API response","required":["code","message"],"type":"object","properties":{"code":{"type":"integer","description":"Application result code: 0 means success; a nonzero value identifies an error.","format":"int32"},"message":{"type":"string","description":"Human-readable result message. For errors, use it together with code."},"data":{"$ref":"#/components/schemas/OrderResponse"},"details":{"type":"array","description":"The details value for this resource.","items":{"$ref":"#/components/schemas/ErrorDetail"}},"requestId":{"type":"string","description":"The request id value for this resource."}},"description":"Standard response envelope: `code` is 0 on success, `message` explains the result, and `data` is a `OrderResponse` object. Null envelope properties are omitted from JSON."},"OrderResponse":{"title":"Order","type":"object","properties":{"id":{"type":"string","description":"Stable resource identifier. Treat IDs as opaque strings.","nullable":true},"orderNo":{"type":"string","description":"The order no value for this resource.","nullable":true},"sellCurrency":{"type":"string","description":"The sell currency value for this resource.","nullable":true},"sellAmount":{"type":"number","description":"The sell amount value for this resource.","nullable":true},"buyCurrency":{"type":"string","description":"The buy currency value for this resource.","nullable":true},"buyAmount":{"type":"number","description":"The buy amount value for this resource.","nullable":true},"minimumBuyAmount":{"type":"number","description":"The minimum buy amount value for this resource.","nullable":true},"sourceAccountId":{"type":"string","description":"Funding account ID used for the operation; keep IDs as strings.","nullable":true},"targetAccountId":{"type":"string","description":"The target account id value for this resource.","nullable":true},"sellNetwork":{"type":"string","description":"The sell network value for this resource.","nullable":true},"buyNetwork":{"type":"string","description":"The buy network value for this resource.","nullable":true},"exchangeRate":{"type":"number","description":"The exchange rate value for this resource.","nullable":true},"feeAmount":{"type":"number","description":"Transaction fee represented as a decimal string.","nullable":true},"feeCurrency":{"type":"string","description":"Currency or asset code of the fee.","nullable":true},"status":{"type":"string","description":"Current lifecycle or processing state for the containing resource.","nullable":true},"settlementMode":{"type":"string","description":"The settlement mode value for this resource.","nullable":true},"canCancel":{"type":"boolean","description":"The can cancel value for this resource.","nullable":true},"quoteExpiresAt":{"type":"string","description":"The quote expires at value for this resource.","format":"date-time","nullable":true},"createdAt":{"type":"string","description":"UTC date-time when the resource was created.","format":"date-time","nullable":true},"completedAt":{"type":"string","description":"UTC date-time when task processing completed; null while unfinished.","format":"date-time","nullable":true},"sourceAddress":{"type":"string","description":"The source address value for this resource.","nullable":true},"collectionStatus":{"type":"string","description":"The collection status value for this resource.","nullable":true},"collectionTxHash":{"type":"string","description":"The collection tx hash value for this resource.","nullable":true},"actualBuyAmount":{"type":"number","description":"The actual buy amount value for this resource.","nullable":true},"actualBuyCurrency":{"type":"string","description":"The actual buy currency value for this resource.","nullable":true},"nextStep":{"type":"string","description":"The next step value for this resource.","nullable":true}},"description":"Fields returned in the operation's `data` property. Optional fields may be null or absent for some records or resource states."},"ConfirmQuoteRequest":{"title":"Confirm Quote request","required":["quoteId"],"type":"object","properties":{"quoteId":{"maxLength":19,"minLength":0,"pattern":"[1-9][0-9]*","type":"string","description":"Required. The quote id value for this resource."}},"description":"Validated request body. Each field is labelled Required, Conditionally required, or Optional."},"FiatOrderRequest":{"title":"Fiat Order request","required":["buyCurrency","minimumBuyAmount","sellAmount","sellCurrency","sourceAccountId","targetAccountId"],"type":"object","properties":{"sourceAccountId":{"maxLength":19,"minLength":0,"pattern":"[1-9][0-9]*","type":"string","description":"Required. Funding account ID used for the operation; keep IDs as strings."},"targetAccountId":{"maxLength":19,"minLength":0,"pattern":"[1-9][0-9]*","type":"string","description":"Required. The target account id value for this resource."},"sellCurrency":{"pattern":"[A-Za-z]{3}","type":"string","description":"Required. The sell currency value for this resource."},"buyCurrency":{"pattern":"[A-Za-z]{3}","type":"string","description":"Required. The buy currency value for this resource."},"sellAmount":{"minimum":0,"exclusiveMinimum":true,"type":"number","description":"Required. The sell amount value for this resource."},"minimumBuyAmount":{"minimum":0,"exclusiveMinimum":true,"type":"number","description":"Required. The minimum buy amount value for this resource."}},"description":"Validated request body. Each field is labelled Required, Conditionally required, or Optional."},"CryptoFiatOrderRequest":{"title":"Crypto Fiat Order request","required":["buyCurrency","minimumBuyAmount","sellAmount","sellCurrency","sourceAddressId","targetAccountId"],"type":"object","properties":{"sourceAddressId":{"maxLength":19,"minLength":0,"pattern":"[1-9][0-9]*","type":"string","description":"Required. The source address id value for this resource."},"targetAccountId":{"maxLength":19,"minLength":0,"pattern":"[1-9][0-9]*","type":"string","description":"Required. The target account id value for this resource."},"sellCurrency":{"pattern":"[A-Za-z0-9]{2,16}","type":"string","description":"Required. The sell currency value for this resource."},"buyCurrency":{"pattern":"[A-Za-z]{3}","type":"string","description":"Required. The buy currency value for this resource."},"sellAmount":{"minimum":0,"exclusiveMinimum":true,"type":"number","description":"Required. The sell amount value for this resource."},"minimumBuyAmount":{"minimum":0,"exclusiveMinimum":true,"type":"number","description":"Required. The minimum buy amount value for this resource."}},"description":"Validated request body. Each field is labelled Required, Conditionally required, or Optional."},"MachineKybSubmissionRequest":{"title":"Machine Kyb Submission request","required":["businessScope","businessType","companyType","contactEmail","contactPhone","establishedDate","name","registeredAddress","registrationCountry","registrationDocIds","registrationNumber","relatedParties","website"],"type":"object","properties":{"name":{"type":"string","description":"Required. Customer-facing resource or capability name."},"englishName":{"type":"string","description":"Optional. The english name value for this resource."},"registrationNumber":{"type":"string","description":"Required. Company registration number."},"registrationCountry":{"type":"string","description":"Required. ISO 3166-1 alpha-2 registration country. Query allowedCountries and deniedCountries from GET /api/v1/enterprise-applications/requirements; countryOptions is a suggestion list, not a closed enum."},"registeredAddress":{"type":"string","description":"Required. The registered address value for this resource."},"businessAddress":{"type":"string","description":"Optional. The business address value for this resource."},"companyType":{"pattern":"llc|corporation|partnership|sole_proprietorship|other","type":"string","description":"Required. Company type: llc = limited liability company; corporation = incorporated company; partnership = partnership; sole_proprietorship = sole trader; other = another legal form. Query fixedFieldOptions.companyType from GET /api/v1/enterprise-applications/requirements for current labels. No default.","enum":["llc","corporation","partnership","sole_proprietorship","other"]},"businessType":{"type":"string","description":"Required. Dynamic industry classification: choose a businessTypeSuggestions value from GET /api/v1/enterprise-applications/requirements, or submit an MCC/SIC code or industry keyword. Suggestions are not a complete enum; no default."},"businessScope":{"type":"string","description":"Required. Required free-text description of the company's actual activities"},"establishedDate":{"pattern":"\\d{4}-\\d{2}-\\d{2}","type":"string","description":"Required. Company establishment date","format":"date","example":"2021-03-15"},"registrationExpiryDate":{"pattern":"\\d{4}-\\d{2}-\\d{2}","type":"string","description":"Optional. Business registration document expiry date, when applicable, in YYYY-MM-DD format.","format":"date","example":"2030-12-31"},"website":{"pattern":"(?i)https?://[^\\s/]+\\.[^\\s/]+(?:/[^\\s]*)?","type":"string","description":"Required. The website value for this resource."},"contactEmail":{"type":"string","description":"Required. The contact email value for this resource."},"contactPhone":{"type":"string","description":"Required. The contact phone value for this resource."},"registrationDocIds":{"type":"array","description":"Required. IDs returned by document upload; include a business_license document","items":{"type":"string","description":"IDs returned by document upload; include a business_license document"}},"additionalDocIds":{"type":"array","description":"Optional. The additional doc ids value for this resource.","items":{"type":"string"}},"fieldValues":{"type":"object","additionalProperties":{"type":"object","description":"Values keyed by requirements.fields[].fieldKey. File fields accept one uploaded documentId as a decimal string or number, or an array of document IDs; each ID must belong to this user and the live environment."},"description":"Optional. Values keyed by requirements.fields[].fieldKey. File fields accept one uploaded documentId as a decimal string or number, or an array of document IDs; each ID must belong to this user and the live environment."},"relatedParties":{"type":"array","description":"Required. One entry per person or organization, with all applicable roles in roles[]; CN requires one legal representative, HK one or more directors","items":{"$ref":"#/components/schemas/RelatedParty"}}},"description":"Validated request body. Each field is labelled Required, Conditionally required, or Optional."},"RelatedParty":{"title":"Related Party","required":["fullName","partyType","roles"],"type":"object","properties":{"partyType":{"pattern":"individual|organization","type":"string","description":"Required. Related-party type: individual = natural person; organization = corporate shareholder. Query fixedFieldOptions.relatedParties[].partyType from /enterprise-applications/requirements.","enum":["individual","organization"]},"fullName":{"type":"string","description":"Required. The full name value for this resource."},"roles":{"type":"array","description":"Required. All applicable roles for this person or organization: legal_representative = statutory representative; director = board member; shareholder = equity holder; beneficial_owner = ultimate owner; senior_management = executive manager. Query fixedFieldOptions.relatedParties[].roles from /enterprise-applications/requirements.","items":{"pattern":"legal_representative|director|shareholder|beneficial_owner|senior_management","type":"string","enum":["legal_representative","director","shareholder","beneficial_owner","senior_management"]}},"idType":{"type":"string","description":"Optional. Individual identity document: passport = travel passport; national_id = national identity card; driving_license = driving licence; other = another accepted identity document. Query fixedFieldOptions.relatedParties[].idType from GET /api/v1/enterprise-applications/requirements. No default.","enum":["passport","national_id","driving_license","other"]},"idNumber":{"type":"string","description":"Optional. The id number value for this resource."},"nationality":{"type":"string","description":"Optional. The nationality value for this resource."},"dateOfBirth":{"type":"string","description":"Optional. Contact date of birth in ISO-8601 date format."},"idExpiryDate":{"type":"string","description":"Optional. The id expiry date value for this resource."},"residentialAddress":{"type":"string","description":"Optional. Contact residential-address details."},"isPep":{"type":"boolean","description":"Optional. The is pep value for this resource."},"pepNote":{"type":"string","description":"Optional. The pep note value for this resource."},"registrationCountry":{"type":"string","description":"Optional. The registration country value for this resource."},"registrationNumber":{"type":"string","description":"Optional. Company registration number."},"ownershipPct":{"type":"number","description":"Optional. The ownership pct value for this resource."},"ownershipType":{"type":"string","description":"Optional. Ownership route: direct = held personally; indirect = held through another entity. Defaults to direct when omitted. Query fixedFieldOptions.relatedParties[].ownershipType from /enterprise-applications/requirements.","enum":["direct","indirect"],"default":"direct"},"ownershipLevel":{"type":"integer","description":"Optional. The ownership level value for this resource.","format":"int32"},"isTrust":{"type":"boolean","description":"Optional. The is trust value for this resource."},"sofSowProvided":{"type":"boolean","description":"Optional. The sof sow provided value for this resource."},"docIds":{"type":"array","description":"Optional. The doc ids value for this resource.","items":{"type":"string"}},"handheldDocId":{"type":"string","description":"Optional. The handheld doc id value for this resource."}},"description":"One entry per person or organization, with all applicable roles in roles[]; CN requires one legal representative, HK one or more directors"},"ApiResponsePortfolioItem":{"title":"Portfolio Item API response","required":["code","message"],"type":"object","properties":{"code":{"type":"integer","description":"Application result code: 0 means success; a nonzero value identifies an error.","format":"int32"},"message":{"type":"string","description":"Human-readable result message. For errors, use it together with code."},"data":{"$ref":"#/components/schemas/PortfolioItem"},"details":{"type":"array","description":"The details value for this resource.","items":{"$ref":"#/components/schemas/ErrorDetail"}},"requestId":{"type":"string","description":"The request id value for this resource."}},"description":"Standard response envelope: `code` is 0 on success, `message` explains the result, and `data` is a `PortfolioItem` object. Null envelope properties are omitted from JSON."},"PortfolioItem":{"title":"Portfolio Item","type":"object","properties":{"id":{"type":"string","description":"Stable resource identifier. Treat IDs as opaque strings.","nullable":true},"name":{"type":"string","description":"Customer-facing resource or capability name.","nullable":true},"registrationCountry":{"type":"string","description":"The registration country value for this resource.","nullable":true},"registrationNumber":{"type":"string","description":"Company registration number.","nullable":true},"kybStatus":{"type":"string","description":"KYB state: not_submitted = no complete submission; pending = under review; approved = verified; rejected = declined; review_required = corrections requested; edd_required = enhanced due diligence requested; renewal_required = evidence expired or renewal requested. No permanent terminal state: approved can later require EDD or renewal, and rejected can be resubmitted. Initial default: not_submitted.","nullable":true,"enum":["not_submitted","pending","approved","rejected","review_required","edd_required","renewal_required"]},"kybExpiresAt":{"type":"string","description":"The kyb expires at value for this resource.","format":"date","nullable":true},"submittedAt":{"type":"string","description":"The submitted at value for this resource.","format":"date-time","nullable":true},"membershipStatus":{"type":"string","description":"The membership status value for this resource.","nullable":true},"owner":{"type":"boolean","description":"The owner value for this resource.","nullable":true},"selectable":{"type":"boolean","description":"The selectable value for this resource.","nullable":true},"current":{"type":"boolean","description":"The current value for this resource.","nullable":true},"reviewNote":{"type":"string","description":"The review note value for this resource.","nullable":true}},"description":"Data model used by the machine REST API."},"ApiResponseDocumentUpload":{"title":"Document Upload API response","required":["code","message"],"type":"object","properties":{"code":{"type":"integer","description":"Application result code: 0 means success; a nonzero value identifies an error.","format":"int32"},"message":{"type":"string","description":"Human-readable result message. For errors, use it together with code."},"data":{"$ref":"#/components/schemas/DocumentUpload"},"details":{"type":"array","description":"The details value for this resource.","items":{"$ref":"#/components/schemas/ErrorDetail"}},"requestId":{"type":"string","description":"The request id value for this resource."}},"description":"Standard response envelope: `code` is 0 on success, `message` explains the result, and `data` is a `DocumentUpload` object. Null envelope properties are omitted from JSON."},"DocumentUpload":{"title":"Document Upload","type":"object","properties":{"documentId":{"type":"string","description":"The document id value for this resource.","nullable":true},"documentType":{"type":"string","description":"Generic stored document category, such as business_license or other","nullable":true},"fieldKey":{"type":"string","description":"Exact dynamic KYB requirement key, null for fixed or legacy documents","nullable":true},"fileName":{"type":"string","description":"Original uploaded identity-document file name.","nullable":true},"mimeType":{"type":"string","description":"Detected upload media type.","nullable":true},"precheckStatus":{"type":"string","description":"The precheck status value for this resource.","nullable":true},"reviewStatus":{"type":"string","description":"The review status value for this resource.","nullable":true}},"description":"Data model used by the machine REST API."},"AddressRequest":{"title":"Address request","type":"object","properties":{"countryCode":{"pattern":"(?i)[A-Z]{2}","type":"string","description":"Conditionally required: Required for card issuing. ISO 3166-1 alpha-2 country code.","example":"GB"},"state":{"type":"string","description":"Conditionally required: Required for card issuing. State, province or region.","example":"England"},"city":{"type":"string","description":"Conditionally required: Required for card issuing. City or locality.","example":"London"},"address":{"type":"string","description":"Conditionally required: Required for card issuing. Street address.","example":"10 Downing Street"},"postalCode":{"type":"string","description":"Conditionally required: Required for card issuing. Postal or ZIP code.","example":"SW1A 2AA"}},"description":"Residential address required for card issuing."},"ContactRequest":{"title":"Contact request","type":"object","properties":{"externalReference":{"maxLength":128,"minLength":0,"type":"string","description":"Optional. Your stable contact reference. Reuse it when retrying or reconciling.","example":"customer-42"},"name":{"maxLength":128,"minLength":0,"type":"string","description":"Conditionally required: Required for POST /contacts; optional for PATCH /contacts/{contactId}. Contact display name; use structured name fields for cardholder identity.","example":"Ada Lovelace"},"type":{"pattern":"customer|supplier|employee|partner|contractor|investor|subsidiary|self|other","type":"string","description":"Conditionally required: Required for POST /contacts; optional for PATCH /contacts/{contactId}. Dashboard role: customer (buyer), supplier (vendor), employee, partner, contractor, investor, subsidiary, self, or other.","example":"customer","enum":["customer","supplier","employee","partner","contractor","investor","subsidiary","self","other"]},"entityType":{"pattern":"individual|company","type":"string","description":"Optional. Legal entity type: individual for a person or company for an organization.","example":"individual","enum":["individual","company"],"default":"individual"},"email":{"type":"string","description":"Conditionally required: Required for card issuing. Contact email address. Required when this contact is used as a cardholder.","example":"ada@example.com"},"mobilePrefix":{"type":"string","description":"Conditionally required: Required when phone is supplied. International calling prefix. Required when phone is supplied.","example":"+44"},"phone":{"type":"string","description":"Optional. Phone number without the international prefix.","example":"7700900123"},"dateOfBirth":{"type":"string","description":"Conditionally required: Required for card issuing. Date of birth in ISO-8601 date format.","format":"date","example":"1990-12-10"},"nationalityCountryCode":{"pattern":"(?i)[A-Z]{2}","type":"string","description":"Conditionally required: Required for card issuing. ISO 3166-1 alpha-2 nationality code.","example":"GB"},"identity":{"$ref":"#/components/schemas/IdentityRequest"},"residentialAddress":{"$ref":"#/components/schemas/AddressRequest"},"industry":{"maxLength":128,"minLength":0,"type":"string","description":"Optional. Industry for a company contact.","example":"Software"},"registrationNumber":{"maxLength":128,"minLength":0,"type":"string","description":"Optional. Company registration number.","example":"12345678"},"taxNumber":{"maxLength":128,"minLength":0,"type":"string","description":"Optional. Company tax number.","example":"GB123456789"},"memo":{"maxLength":1000,"minLength":0,"type":"string","description":"Optional. Internal note shown with the contact.","example":"Priority customer"},"givenName":{"maxLength":128,"minLength":0,"type":"string","description":"Optional. The given name value for this resource."},"familyName":{"maxLength":128,"minLength":0,"type":"string","description":"Optional. The family name value for this resource."},"latinGivenName":{"maxLength":128,"minLength":0,"type":"string","description":"Optional. The latin given name value for this resource."},"latinFamilyName":{"maxLength":128,"minLength":0,"type":"string","description":"Optional. The latin family name value for this resource."}},"description":"POST /contacts requires name and type; PATCH accepts changed fields only. Card issuing additionally requires the identity and residential-address details described by their nested models. Each direct field is labelled Required, Conditionally required, or Optional."},"IdentityRequest":{"title":"Identity request","type":"object","properties":{"type":{"pattern":"passport|id_card|resident_permit","type":"string","description":"Conditionally required: Required for card issuing. Document type. Use passport for a passport, id_card for a national identity card, or resident_permit for a residence permit.","example":"passport","enum":["passport","id_card","resident_permit"]},"number":{"type":"string","description":"Conditionally required: Required for card issuing. Identity document number.","example":"123456789"},"countryCode":{"pattern":"(?i)[A-Z]{2}","type":"string","description":"Conditionally required: Required for card issuing. ISO 3166-1 alpha-2 issuing-country code.","example":"GB"},"expiryDate":{"type":"string","description":"Optional. Document expiry date in ISO-8601 date format.","format":"date","example":"2032-12-10"}},"description":"Identity document details required for card issuing."},"AddressResponse":{"title":"Address","type":"object","properties":{"countryCode":{"type":"string","description":"ISO 3166-1 alpha-2 country code.","nullable":true},"state":{"type":"string","description":"State, province or region.","nullable":true},"city":{"type":"string","description":"City or locality.","nullable":true},"address":{"type":"string","description":"Street address or blockchain address, according to the containing resource.","nullable":true},"postalCode":{"type":"string","description":"Postal or ZIP code.","nullable":true}},"description":"Fields returned in the operation's `data` property. Optional fields may be null or absent for some records or resource states."},"ApiResponseContactResponse":{"title":"Contact API response","required":["code","message"],"type":"object","properties":{"code":{"type":"integer","description":"Application result code: 0 means success; a nonzero value identifies an error.","format":"int32"},"message":{"type":"string","description":"Human-readable result message. For errors, use it together with code."},"data":{"$ref":"#/components/schemas/ContactResponse"},"details":{"type":"array","description":"The details value for this resource.","items":{"$ref":"#/components/schemas/ErrorDetail"}},"requestId":{"type":"string","description":"The request id value for this resource."}},"description":"Standard response envelope: `code` is 0 on success, `message` explains the result, and `data` is a `ContactResponse` object. Null envelope properties are omitted from JSON."},"ContactResponse":{"title":"Contact","type":"object","properties":{"id":{"type":"string","description":"Stable resource identifier. Treat IDs as opaque strings.","nullable":true},"externalReference":{"type":"string","description":"Stable contact reference assigned by the API customer.","nullable":true},"name":{"type":"string","description":"Customer-facing resource or capability name.","nullable":true},"type":{"type":"string","description":"Contact role: customer = buyer; supplier = vendor; employee = staff; partner = business partner; contractor = external worker; investor = capital provider; subsidiary = controlled company; self = own entity; other = another relationship.","nullable":true,"enum":["customer","supplier","employee","partner","contractor","investor","subsidiary","self","other"]},"entityType":{"type":"string","description":"Legal entity type: individual = natural person; company = organization.","nullable":true,"enum":["individual","company"]},"email":{"type":"string","description":"Contact email address.","nullable":true},"mobilePrefix":{"type":"string","description":"International telephone calling prefix.","nullable":true},"phone":{"type":"string","description":"Contact phone number without the international calling prefix.","nullable":true},"dateOfBirth":{"type":"string","description":"Contact date of birth in ISO-8601 date format.","format":"date","nullable":true},"nationalityCountryCode":{"type":"string","description":"ISO 3166-1 alpha-2 nationality code.","nullable":true},"identity":{"$ref":"#/components/schemas/IdentityResponse"},"residentialAddress":{"$ref":"#/components/schemas/AddressResponse"},"industry":{"type":"string","description":"Contact company industry.","nullable":true},"registrationNumber":{"type":"string","description":"Company registration number.","nullable":true},"taxNumber":{"type":"string","description":"Company tax identification number.","nullable":true},"memo":{"type":"string","description":"Internal contact note.","nullable":true},"complianceStatus":{"type":"string","description":"AML result: pending = not finished; clear = no blocking match; review_required = manual review needed; blocked = issuing and payment use is prohibited. This is a current screening result and can be re-evaluated; no permanent terminal value.","nullable":true,"enum":["pending","clear","review_required","blocked"]},"cardIssuingStatus":{"type":"string","description":"Cardholder readiness: incomplete = missing fields or documents; pending = checks in progress; ready = can be submitted; approved = accepted by an issuing channel; rejected = not eligible. Current eligibility can be re-evaluated; this field has no permanent terminal value.","nullable":true,"enum":["incomplete","pending","ready","approved","rejected"]},"missingFields":{"type":"array","description":"Contact fields that must be completed before the contact is ready for card issuing.","nullable":true,"items":{"type":"string"}},"createdAt":{"type":"string","description":"UTC date-time when the resource was created.","format":"date-time","nullable":true},"updatedAt":{"type":"string","description":"UTC date-time when the resource was most recently updated.","format":"date-time","nullable":true},"givenName":{"type":"string","description":"The given name value for this resource.","nullable":true},"familyName":{"type":"string","description":"The family name value for this resource.","nullable":true},"latinGivenName":{"type":"string","description":"The latin given name value for this resource.","nullable":true},"latinFamilyName":{"type":"string","description":"The latin family name value for this resource.","nullable":true}},"description":"Fields returned in the operation's `data` property. Optional fields may be null or absent for some records or resource states."},"IdentityResponse":{"title":"Identity","type":"object","properties":{"type":{"type":"string","description":"Identity document type: passport = travel passport; id_card = national identity card; resident_permit = residence permit.","nullable":true,"enum":["passport","id_card","resident_permit"]},"maskedNumber":{"type":"string","description":"Masked identity-document number safe for display.","nullable":true},"countryCode":{"type":"string","description":"ISO 3166-1 alpha-2 country code.","nullable":true},"expiryDate":{"type":"string","description":"Identity document expiry date in ISO-8601 date format; null when not supplied.","format":"date","nullable":true}},"description":"Fields returned in the operation's `data` property. Optional fields may be null or absent for some records or resource states."},"ApiResponseDocumentResponse":{"title":"Document API response","required":["code","message"],"type":"object","properties":{"code":{"type":"integer","description":"Application result code: 0 means success; a nonzero value identifies an error.","format":"int32"},"message":{"type":"string","description":"Human-readable result message. For errors, use it together with code."},"data":{"$ref":"#/components/schemas/DocumentResponse"},"details":{"type":"array","description":"The details value for this resource.","items":{"$ref":"#/components/schemas/ErrorDetail"}},"requestId":{"type":"string","description":"The request id value for this resource."}},"description":"Standard response envelope: `code` is 0 on success, `message` explains the result, and `data` is a `DocumentResponse` object. Null envelope properties are omitted from JSON."},"DocumentResponse":{"title":"Document","type":"object","properties":{"id":{"type":"string","description":"Stable resource identifier. Treat IDs as opaque strings.","nullable":true},"role":{"type":"string","description":"Document role: passport = passport image; identity_front = identity card front; identity_back = identity card back.","nullable":true,"enum":["passport","identity_front","identity_back"]},"fileName":{"type":"string","description":"Original uploaded identity-document file name.","nullable":true},"mimeType":{"type":"string","description":"Detected upload media type.","nullable":true},"fileSize":{"type":"string","description":"Uploaded file size in bytes.","nullable":true},"status":{"type":"string","description":"Document availability: active = available for channel submission (default after upload); deleted = permanently unavailable (terminal).","nullable":true,"enum":["active","deleted"]},"createdAt":{"type":"string","description":"UTC date-time when the resource was created.","format":"date-time","nullable":true}},"description":"Fields returned in the operation's `data` property. Optional fields may be null or absent for some records or resource states."},"ContactAccountRequest":{"title":"Contact Account request","type":"object","properties":{"type":{"pattern":"blockchain|bank","type":"string","description":"Conditionally required: Required when adding an account; optional when updating one. Destination type: blockchain for a chain address or bank for a bank account.","example":"blockchain","enum":["blockchain","bank"]},"network":{"maxLength":32,"minLength":0,"type":"string","description":"Conditionally required: Required when type is blockchain. Blockchain network returned by GET /api/v1/assets.","example":"TRON"},"address":{"maxLength":255,"minLength":0,"type":"string","description":"Conditionally required: Required when type is blockchain. Public blockchain address.","example":"TXYZ..."},"bankName":{"maxLength":128,"minLength":0,"type":"string","description":"Conditionally required: Required when type is bank. Bank name.","example":"Example Bank"},"bankCode":{"maxLength":64,"minLength":0,"type":"string","description":"Optional. Bank or branch code.","example":"026009593"},"accountIdentifierType":{"maxLength":32,"minLength":0,"type":"string","description":"Optional. Extensible beneficiary account identifier type: local = domestic account number; iban = International Bank Account Number. Provider-specific values may also be used; examples are not a complete enum. GET /api/v1/transfers/requirements suggests a type for a country and rail."},"routingCode":{"maxLength":128,"minLength":0,"type":"string","description":"Optional. Local clearing identifier, for example an ABA number or Sort Code."},"routingCodeType":{"maxLength":32,"minLength":0,"type":"string","description":"Optional. Extensible clearing identifier type. Examples: aba = US routing number; sort_code = UK bank sort code. Provider-specific values are allowed; GET /api/v1/transfers/requirements suggests a type for a country and rail. Examples are not a complete enum."},"paymentRail":{"maxLength":32,"minLength":0,"type":"string","description":"Optional. Dynamic payment rail; examples FEDWIRE, CHAPS and SEPA are not a complete enum. Query GET /api/v1/transfers/requirements with country, currency, rail and amount for availability. If omitted, payout submission infers a rail from account details."},"bankCountryCode":{"pattern":"(?i)[A-Z]{2}","type":"string","description":"Optional. ISO 3166-1 alpha-2 country code of the bank. Required for bank destinations.","example":"GB"},"bankAddress":{"maxLength":500,"minLength":0,"type":"string","description":"Optional. Postal address of the bank or branch. Required for bank destinations except mainland CNY accounts."},"beneficiaryIdNumber":{"maxLength":100,"minLength":0,"type":"string","description":"Optional. Beneficiary identity number for a mainland personal CNY account."},"accountNumber":{"maxLength":128,"minLength":0,"type":"string","description":"Conditionally required: Required when type is bank. Bank account number or IBAN.","example":"GB29NWBK60161331926819"},"accountHolder":{"maxLength":128,"minLength":0,"type":"string","description":"Optional. Bank account holder name.","example":"Ada Lovelace"},"currency":{"maxLength":16,"minLength":0,"type":"string","description":"Conditionally required: Required when type is bank; optional when type is blockchain. Asset code accepted by the destination.","example":"USDT"},"swiftCode":{"maxLength":32,"minLength":0,"type":"string","description":"Optional. SWIFT/BIC for a bank account.","example":"NWBKGB2L"},"label":{"maxLength":128,"minLength":0,"type":"string","description":"Optional. Customer-facing label.","example":"Primary payout account"},"defaultPaymentAmount":{"minimum":0,"exclusiveMinimum":true,"type":"number","description":"Optional. Suggested payment amount.","example":100}},"description":"Adding an account requires type plus the fields described for that type; updating accepts changed fields only."},"ApiResponseContactAccountResponse":{"title":"Contact Account API response","required":["code","message"],"type":"object","properties":{"code":{"type":"integer","description":"Application result code: 0 means success; a nonzero value identifies an error.","format":"int32"},"message":{"type":"string","description":"Human-readable result message. For errors, use it together with code."},"data":{"$ref":"#/components/schemas/ContactAccountResponse"},"details":{"type":"array","description":"The details value for this resource.","items":{"$ref":"#/components/schemas/ErrorDetail"}},"requestId":{"type":"string","description":"The request id value for this resource."}},"description":"Standard response envelope: `code` is 0 on success, `message` explains the result, and `data` is a `ContactAccountResponse` object. Null envelope properties are omitted from JSON."},"ContactAccountResponse":{"title":"Contact Account","type":"object","properties":{"id":{"type":"string","description":"Stable resource identifier. Treat IDs as opaque strings.","nullable":true},"contactId":{"type":"string","description":"Enterprise contact ID associated with the resource; keep IDs as strings.","nullable":true},"type":{"type":"string","description":"Saved recipient account type: blockchain = chain address; bank = fiat bank account.","nullable":true,"enum":["blockchain","bank"]},"network":{"type":"string","description":"Enabled blockchain network; null for fiat-only resources.","nullable":true},"address":{"type":"string","description":"Street address or blockchain address, according to the containing resource.","nullable":true},"bankName":{"type":"string","description":"Bank display name.","nullable":true},"bankCode":{"type":"string","description":"Bank, institution or clearing code.","nullable":true},"accountIdentifierType":{"type":"string","description":"Stored extensible account identifier type; examples local and iban are not a closed enum. GET /api/v1/transfers/requirements gives country and rail suggestions.","nullable":true},"routingCode":{"type":"string","description":"Bank routing or clearing code.","nullable":true},"routingCodeType":{"type":"string","description":"Stored extensible bank routing-code type; examples aba and sort_code are not a closed enum. GET /api/v1/transfers/requirements gives country and rail suggestions.","nullable":true},"paymentRail":{"type":"string","description":"Stored dynamic payment rail. Query GET /api/v1/transfers/requirements with country, currency, rail and amount for current route availability; this saved value alone does not prove a route is enabled.","nullable":true},"bankCountryCode":{"type":"string","description":"The bank country code value for this resource.","nullable":true},"bankAddress":{"type":"string","description":"Postal address of the bank or branch.","nullable":true},"accountNumber":{"type":"string","description":"Bank account number or IBAN.","nullable":true},"accountHolder":{"type":"string","description":"Legal name of the bank account holder.","nullable":true},"currency":{"type":"string","description":"ISO currency or enabled asset code used for monetary values.","nullable":true},"swiftCode":{"type":"string","description":"SWIFT/BIC used for international bank routing.","nullable":true},"label":{"type":"string","description":"Customer-facing label for the contact destination account.","nullable":true},"defaultPaymentAmount":{"type":"string","description":"Optional suggested payment amount represented as a decimal string.","nullable":true},"status":{"type":"string","description":"Saved destination state: active = available for use (default after creation); inactive = retained for history but not selectable. These are availability states; neither is a final payment outcome.","nullable":true,"enum":["active","inactive"]},"createdAt":{"type":"string","description":"UTC date-time when the resource was created.","format":"date-time","nullable":true},"updatedAt":{"type":"string","description":"UTC date-time when the resource was most recently updated.","format":"date-time","nullable":true}},"description":"Fields returned in the operation's `data` property. Optional fields may be null or absent for some records or resource states."},"ApiResponseCardResponse":{"title":"Card API response","required":["code","message"],"type":"object","properties":{"code":{"type":"integer","description":"Application result code: 0 means success; a nonzero value identifies an error.","format":"int32"},"message":{"type":"string","description":"Human-readable result message. For errors, use it together with code."},"data":{"$ref":"#/components/schemas/CardResponse"},"details":{"type":"array","description":"The details value for this resource.","items":{"$ref":"#/components/schemas/ErrorDetail"}},"requestId":{"type":"string","description":"The request id value for this resource."}},"description":"Standard response envelope: `code` is 0 on success, `message` explains the result, and `data` is a `CardResponse` object. Null envelope properties are omitted from JSON."},"CardResponse":{"title":"Card","type":"object","properties":{"id":{"type":"string","description":"Stable resource identifier. Treat IDs as opaque strings.","nullable":true},"applicationId":{"type":"string","description":"Card application ID that created the card; keep IDs as strings.","nullable":true},"productId":{"type":"string","description":"Card product ID associated with the resource; keep IDs as strings.","nullable":true},"contactId":{"type":"string","description":"Enterprise contact ID associated with the resource; keep IDs as strings.","nullable":true},"maskedPan":{"type":"string","description":"Masked card number; full PAN is available only through a one-time reveal session.","nullable":true},"last4":{"type":"string","description":"Last four card-number digits, safe for display.","nullable":true},"expiryMonth":{"type":"string","description":"Two-digit card expiry month.","nullable":true},"expiryYear":{"type":"string","description":"Four-digit card expiry year.","nullable":true},"fundingMode":{"type":"string","description":"Configured card funding model. Examples: prepaid_balance = balance funded on this card; shared_budget = spending from a common enterprise budget. Query GET /api/v1/card-products for current product values; examples are not a complete enum.","nullable":true},"formFactor":{"type":"string","description":"Issued-card form factor: virtual = no physical card.","nullable":true,"enum":["virtual"]},"status":{"type":"string","description":"Card lifecycle: normal = usable after issuance; freezing = freeze in progress; frozen = temporarily blocked; unfreezing = unfreeze in progress; cancelling = closure in progress; cancelled = permanently closed (terminal). Initial issued state: normal.","nullable":true,"enum":["normal","freezing","frozen","unfreezing","cancelling","cancelled"]},"activationStatus":{"type":"string","description":"Channel activation state. Machine-issued virtual cards are active after successful issuance.","nullable":true,"enum":["active"]},"balance":{"type":"string","description":"Prepaid card balance. Shared-budget cards report 0 here; read /card-budgets/{budgetId} for the shared available balance.","nullable":true},"currency":{"type":"string","description":"ISO currency or enabled asset code used for monetary values.","nullable":true},"nickname":{"type":"string","description":"Customer-facing card nickname.","nullable":true},"issueCountryOrRegion":{"type":"string","description":"Country or region under which the card was issued.","nullable":true},"scheme":{"type":"string","description":"Card network scheme.","nullable":true},"createdAt":{"type":"string","description":"UTC date-time when the resource was created.","format":"date-time","nullable":true},"updatedAt":{"type":"string","description":"UTC date-time when the resource was most recently updated.","format":"date-time","nullable":true},"budgetId":{"type":"string","description":"The budget id value for this resource.","nullable":true}},"description":"Fields returned in the operation's `data` property. Optional fields may be null or absent for some records or resource states."},"CardTopUpRequest":{"title":"Card Top Up request","required":["amount","sourceAccountId"],"type":"object","properties":{"sourceAccountId":{"pattern":"[0-9]+","type":"string","description":"Required. The card's original funding account ID.","example":"123456789012345680"},"amount":{"minimum":0.01,"exclusiveMinimum":false,"type":"number","description":"Required. Top-up amount in the card currency.","example":50}},"description":"Validated request body. Each field is labelled Required, Conditionally required, or Optional."},"ApiResponseCardTransactionResponse":{"title":"Card Transaction API response","required":["code","message"],"type":"object","properties":{"code":{"type":"integer","description":"Application result code: 0 means success; a nonzero value identifies an error.","format":"int32"},"message":{"type":"string","description":"Human-readable result message. For errors, use it together with code."},"data":{"$ref":"#/components/schemas/CardTransactionResponse"},"details":{"type":"array","description":"The details value for this resource.","items":{"$ref":"#/components/schemas/ErrorDetail"}},"requestId":{"type":"string","description":"The request id value for this resource."}},"description":"Standard response envelope: `code` is 0 on success, `message` explains the result, and `data` is a `CardTransactionResponse` object. Null envelope properties are omitted from JSON."},"CardTransactionResponse":{"title":"Card Transaction","type":"object","properties":{"id":{"type":"string","description":"Stable resource identifier. Treat IDs as opaque strings.","nullable":true},"transactionNo":{"type":"string","description":"Platform card transaction number used for support and reconciliation.","nullable":true},"cardId":{"type":"string","description":"Issued-card ID; null until issuance succeeds. Keep IDs as strings.","nullable":true},"sourceAccountId":{"type":"string","description":"Funding account ID used for the operation; keep IDs as strings.","nullable":true},"type":{"type":"string","description":"Card transaction kind: purchase = card payment; refund = merchant refund; reversal = debit reversal; topup = card funding; fee = service charge; adjustment_credit = operator credit; adjustment_debit = operator debit; verification = card check without posting; atm_inquiry = ATM balance check; atm_withdrawal = cash withdrawal; purchase_reversal = purchase void; refund_reversal = refund clawback; transfer_out = card balance returned elsewhere; unclassified = unknown provider event without assumed balance effect; authorization = hold without posting; authorization_reversal = hold release without posting. No request default; the channel event determines the type.","nullable":true,"enum":["purchase","refund","reversal","topup","fee","adjustment_credit","adjustment_debit","verification","atm_inquiry","atm_withdrawal","purchase_reversal","refund_reversal","transfer_out","unclassified","authorization","authorization_reversal"]},"direction":{"type":"string","description":"Card balance effect: in = credit; out = debit; none = no principal balance movement.","nullable":true,"enum":["in","out","none"]},"amount":{"type":"string","description":"Decimal monetary amount represented as a string to preserve precision.","nullable":true},"currency":{"type":"string","description":"ISO currency or enabled asset code used for monetary values.","nullable":true},"status":{"type":"string","description":"Transaction state: pending = received; processing = settling; authorized = approved but not settled; succeeded = completed (terminal for this transaction); failed = execution failed (terminal); declined = issuer declined (terminal); voided = authorization or transaction cancelled (terminal); cancelled = cancelled before completion (terminal). Initial state depends on the provider event; no universal default.","nullable":true,"enum":["pending","processing","authorized","succeeded","failed","declined","voided","cancelled"]},"merchantName":{"type":"string","description":"Merchant display name supplied by the card network.","nullable":true},"merchantCategoryCode":{"type":"string","description":"ISO 18245 merchant category code supplied by the card network.","nullable":true},"merchantCountry":{"type":"string","description":"Merchant country or region supplied by the card network.","nullable":true},"merchantCity":{"type":"string","description":"Merchant city supplied by the card network.","nullable":true},"occurredAt":{"type":"string","description":"Provider-reported UTC date-time when the card transaction occurred.","nullable":true},"settlementAmount":{"type":"string","description":"Final settlement amount represented as a decimal string; null until available.","nullable":true},"settlementCurrency":{"type":"string","description":"Currency or asset code used for settlement.","nullable":true},"feeAmount":{"type":"string","description":"Transaction fee represented as a decimal string.","nullable":true},"feeCurrency":{"type":"string","description":"Currency or asset code of the fee.","nullable":true},"balanceAfter":{"type":"string","description":"Account or card balance after the transaction, represented as a decimal string.","nullable":true},"failureReason":{"type":"string","description":"Human-readable rejection or failure reason; null when the operation has not failed.","nullable":true},"createdAt":{"type":"string","description":"UTC date-time when the resource was created.","format":"date-time","nullable":true},"updatedAt":{"type":"string","description":"UTC date-time when the resource was most recently updated.","format":"date-time","nullable":true}},"description":"Fields returned in the operation's `data` property. Optional fields may be null or absent for some records or resource states."},"SandboxCardPurchaseRequest":{"title":"Sandbox Card Purchase request","required":["amount"],"type":"object","properties":{"amount":{"minimum":0.01,"exclusiveMinimum":false,"type":"number","description":"Required. Simulated purchase amount in the card currency.","example":12.5},"merchantName":{"maxLength":128,"minLength":0,"type":"string","description":"Optional. Merchant display name.","example":"Sandbox Store"},"merchantCategoryCode":{"maxLength":16,"minLength":0,"type":"string","description":"Optional. ISO 18245 merchant category code.","example":"5734"}},"description":"Validated request body. Each field is labelled Required, Conditionally required, or Optional."},"HostedCardRevealSessionRequest":{"title":"Hosted Card Reveal Session request","required":["verificationMethod","verificationReference","verificationSubject","verifiedAt"],"type":"object","properties":{"verificationSubject":{"maxLength":128,"minLength":0,"type":"string","description":"Required. Opaque cardholder identifier from the customer's system. Do not send a name, email, phone number, PAN or document number.","example":"customer-user-42"},"verificationMethod":{"maxLength":32,"minLength":0,"type":"string","description":"Required. Second-factor method completed in the customer's own application: totp = authenticator code; sms = text message code; email = email code; passkey = device-bound passkey; biometric = biometric check; other = another verified method. No default.","example":"passkey","enum":["totp","sms","email","passkey","biometric","other"]},"verificationReference":{"maxLength":128,"minLength":0,"type":"string","description":"Required. Customer audit reference for the completed verification. It must not contain an OTP or other secret.","example":"verify_01J5Z8YQABCD"},"verifiedAt":{"type":"string","description":"Required. UTC instant when customer verification completed. It must be within the last five minutes.","format":"date-time","example":"2026-08-20T19:15:00Z"}},"description":"Validated request body. Each field is labelled Required, Conditionally required, or Optional."},"ApiResponseHostedCardRevealSessionResponse":{"title":"Hosted Card Reveal Session API response","required":["code","message"],"type":"object","properties":{"code":{"type":"integer","description":"Application result code: 0 means success; a nonzero value identifies an error.","format":"int32"},"message":{"type":"string","description":"Human-readable result message. For errors, use it together with code."},"data":{"$ref":"#/components/schemas/HostedCardRevealSessionResponse"},"details":{"type":"array","description":"The details value for this resource.","items":{"$ref":"#/components/schemas/ErrorDetail"}},"requestId":{"type":"string","description":"The request id value for this resource."}},"description":"Standard response envelope: `code` is 0 on success, `message` explains the result, and `data` is a `HostedCardRevealSessionResponse` object. Null envelope properties are omitted from JSON."},"HostedCardRevealSessionResponse":{"title":"Hosted Card Reveal Session","type":"object","properties":{"id":{"type":"string","description":"Stable resource identifier. Treat IDs as opaque strings.","nullable":true},"revealUrl":{"type":"string","description":"Single-use hosted page URL. Do not log or persist it. Open it in a top-level browser window before expiresAt.","nullable":true},"expiresAt":{"type":"string","description":"UTC date-time after which the link or session can no longer be used.","format":"date-time","nullable":true},"singleUse":{"type":"boolean","description":"Whether the reveal URL becomes invalid after its first successful use.","nullable":true}},"description":"Fields returned in the operation's `data` property. Optional fields may be null or absent for some records or resource states."},"ApiResponseCardCancellationResponse":{"title":"Card Cancellation API response","required":["code","message"],"type":"object","properties":{"code":{"type":"integer","description":"Application result code: 0 means success; a nonzero value identifies an error.","format":"int32"},"message":{"type":"string","description":"Human-readable result message. For errors, use it together with code."},"data":{"$ref":"#/components/schemas/CardCancellationResponse"},"details":{"type":"array","description":"The details value for this resource.","items":{"$ref":"#/components/schemas/ErrorDetail"}},"requestId":{"type":"string","description":"The request id value for this resource."}},"description":"Standard response envelope: `code` is 0 on success, `message` explains the result, and `data` is a `CardCancellationResponse` object. Null envelope properties are omitted from JSON."},"CardCancellationResponse":{"title":"Card Cancellation","type":"object","properties":{"card":{"$ref":"#/components/schemas/CardResponse"},"refundTransaction":{"$ref":"#/components/schemas/CardTransactionResponse"}},"description":"Fields returned in the operation's `data` property. Optional fields may be null or absent for some records or resource states."},"CreateBudgetRequest":{"title":"Create Budget request","required":["currency","name"],"type":"object","properties":{"currency":{"maxLength":16,"minLength":0,"type":"string","description":"Required. ISO currency or enabled asset code used for monetary values."},"name":{"maxLength":128,"minLength":0,"type":"string","description":"Required. Customer-facing resource or capability name."}},"description":"Validated request body. Each field is labelled Required, Conditionally required, or Optional."},"ApiResponseBudgetResponse":{"title":"Budget API response","required":["code","message"],"type":"object","properties":{"code":{"type":"integer","description":"Application result code: 0 means success; a nonzero value identifies an error.","format":"int32"},"message":{"type":"string","description":"Human-readable result message. For errors, use it together with code."},"data":{"$ref":"#/components/schemas/BudgetResponse"},"details":{"type":"array","description":"The details value for this resource.","items":{"$ref":"#/components/schemas/ErrorDetail"}},"requestId":{"type":"string","description":"The request id value for this resource."}},"description":"Standard response envelope: `code` is 0 on success, `message` explains the result, and `data` is a `BudgetResponse` object. Null envelope properties are omitted from JSON."},"BudgetResponse":{"title":"Budget","type":"object","properties":{"id":{"type":"string","description":"Stable resource identifier. Treat IDs as opaque strings.","nullable":true},"name":{"type":"string","description":"Customer-facing resource or capability name.","nullable":true},"currency":{"type":"string","description":"ISO currency or enabled asset code used for monetary values.","nullable":true},"status":{"type":"string","description":"Current lifecycle or processing state for the containing resource.","nullable":true},"availableAmount":{"type":"string","description":"The available amount value for this resource.","nullable":true},"lockedAmount":{"type":"string","description":"The locked amount value for this resource.","nullable":true},"sharedCardIssuanceEnabled":{"type":"boolean","description":"The shared card issuance enabled value for this resource.","nullable":true},"requiresInitialFunding":{"type":"boolean","description":"The requires initial funding value for this resource.","nullable":true}},"description":"Fields returned in the operation's `data` property. Optional fields may be null or absent for some records or resource states."},"WithdrawBudgetRequest":{"title":"Withdraw Budget request","required":["amount","destinationAccountId"],"type":"object","properties":{"destinationAccountId":{"pattern":"[0-9]+","type":"string","description":"Required. The destination account id value for this resource."},"amount":{"minimum":0,"exclusiveMinimum":true,"type":"number","description":"Required. Decimal monetary amount represented as a string to preserve precision."},"twoFaCode":{"type":"string","description":"Optional. The two fa code value for this resource."}},"description":"Validated request body. Each field is labelled Required, Conditionally required, or Optional."},"ApiResponseBudgetTransferResponse":{"title":"Budget Transfer API response","required":["code","message"],"type":"object","properties":{"code":{"type":"integer","description":"Application result code: 0 means success; a nonzero value identifies an error.","format":"int32"},"message":{"type":"string","description":"Human-readable result message. For errors, use it together with code."},"data":{"$ref":"#/components/schemas/BudgetTransferResponse"},"details":{"type":"array","description":"The details value for this resource.","items":{"$ref":"#/components/schemas/ErrorDetail"}},"requestId":{"type":"string","description":"The request id value for this resource."}},"description":"Standard response envelope: `code` is 0 on success, `message` explains the result, and `data` is a `BudgetTransferResponse` object. Null envelope properties are omitted from JSON."},"BudgetTransferResponse":{"title":"Budget Transfer","type":"object","properties":{"id":{"type":"string","description":"Stable resource identifier. Treat IDs as opaque strings.","nullable":true},"transferId":{"type":"string","description":"The transfer id value for this resource.","nullable":true},"transferNo":{"type":"string","description":"The transfer no value for this resource.","nullable":true},"status":{"type":"string","description":"Current lifecycle or processing state for the containing resource.","nullable":true},"direction":{"type":"string","description":"Balance movement direction, such as credit/debit or in/out.","nullable":true},"amount":{"type":"string","description":"Decimal monetary amount represented as a string to preserve precision.","nullable":true},"currency":{"type":"string","description":"ISO currency or enabled asset code used for monetary values.","nullable":true},"idempotencyKey":{"type":"string","description":"The idempotency key value for this resource.","nullable":true},"createdAt":{"type":"string","description":"UTC date-time when the resource was created.","format":"date-time","nullable":true},"errorCode":{"type":"string","description":"The error code value for this resource.","nullable":true}},"description":"Fields returned in the operation's `data` property. Optional fields may be null or absent for some records or resource states."},"FundBudgetRequest":{"title":"Fund Budget request","required":["amount","sourceAccountId"],"type":"object","properties":{"sourceAccountId":{"pattern":"[0-9]+","type":"string","description":"Required. Funding account ID used for the operation; keep IDs as strings."},"amount":{"minimum":0,"exclusiveMinimum":true,"type":"number","description":"Required. Decimal monetary amount represented as a string to preserve precision."},"twoFaCode":{"type":"string","description":"Optional. The two fa code value for this resource."}},"description":"Validated request body. Each field is labelled Required, Conditionally required, or Optional."},"CardApplicationRequest":{"title":"Card Application request","required":["initialAmount","productId","sourceAccountId"],"type":"object","properties":{"contactId":{"pattern":"[0-9]+","type":"string","description":"Conditionally required: Required unless the explicitly selected BIN returns contactRequired=false. Contact ID from /contacts. May be omitted only when the explicitly selected BIN returns contactRequired=false.","example":"123456789012345678"},"productId":{"pattern":"[0-9]+","type":"string","description":"Required. Eligible product ID returned by /card-products.","example":"123456789012345679"},"sourceAccountId":{"pattern":"[0-9]+","type":"string","description":"Required. Funding account ID returned by /accounts.","example":"123456789012345680"},"initialAmount":{"minimum":0,"exclusiveMinimum":false,"type":"number","description":"Required. Initial funding for prepaid cards. Use 0 when the product initialFundingMode is none, or for a shared-budget card. Other products use the advertised minimum; quote before issuing.","example":100},"nickname":{"maxLength":128,"minLength":0,"type":"string","description":"Optional. Customer-facing card nickname.","example":"Marketing"},"purpose":{"maxLength":255,"minLength":0,"type":"string","description":"Optional. Business purpose for compliance review.","example":"Online advertising"},"budgetId":{"pattern":"[0-9]+","type":"string","description":"Optional. Budget ID from /card-budgets. Required for shared-budget cards; omit for prepaid cards."},"singleTransactionLimit":{"minimum":0,"exclusiveMinimum":true,"type":"number","description":"Optional. Reserved field. Custom per-transaction limits are not currently supported."},"sharedCardQuota":{"minimum":0,"exclusiveMinimum":true,"type":"number","description":"Optional. Shared-card spending quota. Required when the budget product enables quotas."},"selectedBinId":{"pattern":"[0-9]+","type":"string","description":"Conditionally required: Required when contactId is omitted; use an ID from card-products.bins. BIN option ID from card-products.bins. Required when omitting contactId."}},"description":"Validated request body. Each field is labelled Required, Conditionally required, or Optional."},"ApiResponseCardApplicationResponse":{"title":"Card Application API response","required":["code","message"],"type":"object","properties":{"code":{"type":"integer","description":"Application result code: 0 means success; a nonzero value identifies an error.","format":"int32"},"message":{"type":"string","description":"Human-readable result message. For errors, use it together with code."},"data":{"$ref":"#/components/schemas/CardApplicationResponse"},"details":{"type":"array","description":"The details value for this resource.","items":{"$ref":"#/components/schemas/ErrorDetail"}},"requestId":{"type":"string","description":"The request id value for this resource."}},"description":"Standard response envelope: `code` is 0 on success, `message` explains the result, and `data` is a `CardApplicationResponse` object. Null envelope properties are omitted from JSON."},"CardApplicationResponse":{"title":"Card Application","required":["id","status"],"type":"object","properties":{"id":{"type":"string","description":"Stable resource identifier. Treat IDs as opaque strings."},"contactId":{"type":"string","description":"Enterprise contact ID associated with the resource; keep IDs as strings.","nullable":true},"productId":{"type":"string","description":"Card product ID associated with the resource; keep IDs as strings.","nullable":true},"sourceAccountId":{"type":"string","description":"Funding account ID used for the operation; keep IDs as strings.","nullable":true},"status":{"type":"string","description":"Application state: validating = checking eligibility (initial); funds_locking = reserving funds; funds_locked = funds reserved; issuing = channel request in progress; reconciling = channel outcome is unknown and being checked; succeeded = card issued (terminal); failed = issuance failed (terminal).","enum":["validating","funds_locking","funds_locked","issuing","succeeded","reconciling","failed"]},"initialAmount":{"type":"string","description":"Initial card funding amount represented as a decimal string.","nullable":true},"estimatedFee":{"type":"string","description":"Estimated platform and channel fee represented as a decimal string.","nullable":true},"feeCurrency":{"type":"string","description":"Currency or asset code of the fee.","nullable":true},"cardId":{"type":"string","description":"Issued-card ID; null until issuance succeeds. Keep IDs as strings.","nullable":true},"failureReason":{"type":"string","description":"Human-readable rejection or failure reason; null when the operation has not failed.","nullable":true},"createdAt":{"type":"string","description":"UTC date-time when the resource was created.","format":"date-time","nullable":true},"updatedAt":{"type":"string","description":"UTC date-time when the resource was most recently updated.","format":"date-time","nullable":true},"budgetId":{"type":"string","description":"The budget id value for this resource.","nullable":true},"sharedCardQuota":{"type":"string","description":"The shared card quota value for this resource.","nullable":true},"singleTransactionLimit":{"type":"string","description":"The single transaction limit value for this resource.","nullable":true}},"description":"Fields returned in the operation's `data` property. Optional fields may be null or absent for some records or resource states."},"ApiResponseCardApplicationQuoteResponse":{"title":"Card Application Quote API response","required":["code","message"],"type":"object","properties":{"code":{"type":"integer","description":"Application result code: 0 means success; a nonzero value identifies an error.","format":"int32"},"message":{"type":"string","description":"Human-readable result message. For errors, use it together with code."},"data":{"$ref":"#/components/schemas/CardApplicationQuoteResponse"},"details":{"type":"array","description":"The details value for this resource.","items":{"$ref":"#/components/schemas/ErrorDetail"}},"requestId":{"type":"string","description":"The request id value for this resource."}},"description":"Standard response envelope: `code` is 0 on success, `message` explains the result, and `data` is a `CardApplicationQuoteResponse` object. Null envelope properties are omitted from JSON."},"CardApplicationQuoteResponse":{"title":"Card Application Quote","type":"object","properties":{"productId":{"type":"string","description":"Card product ID associated with the resource; keep IDs as strings.","nullable":true},"contactId":{"type":"string","description":"Enterprise contact ID associated with the resource; keep IDs as strings.","nullable":true},"sourceAccountId":{"type":"string","description":"Funding account ID used for the operation; keep IDs as strings.","nullable":true},"initialAmount":{"type":"string","description":"Initial card funding amount represented as a decimal string.","nullable":true},"estimatedFee":{"type":"string","description":"Estimated platform and channel fee represented as a decimal string.","nullable":true},"totalDebit":{"type":"string","description":"Total account debit including the initial amount and estimated fee, represented as a decimal string.","nullable":true},"minimumInitialAmount":{"type":"string","description":"Minimum initial funding allowed by this product, represented as a decimal string.","nullable":true},"currency":{"type":"string","description":"ISO currency or enabled asset code used for monetary values.","nullable":true},"budgetId":{"type":"string","description":"The budget id value for this resource.","nullable":true}},"description":"Fields returned in the operation's `data` property. Optional fields may be null or absent for some records or resource states."},"CreateBlockchainAddressRequest":{"title":"Create Blockchain Address request","required":["chain"],"type":"object","properties":{"walletId":{"pattern":"[1-9][0-9]*","type":"string","description":"Optional. The wallet id value for this resource."},"chain":{"type":"string","description":"Required. The chain value for this resource."},"purpose":{"type":"string","description":"Optional. The purpose value for this resource."}},"description":"Validated request body. Each field is labelled Required, Conditionally required, or Optional."},"ApiResponseBlockchainAddressResponse":{"title":"Blockchain Address API response","required":["code","message"],"type":"object","properties":{"code":{"type":"integer","description":"Application result code: 0 means success; a nonzero value identifies an error.","format":"int32"},"message":{"type":"string","description":"Human-readable result message. For errors, use it together with code."},"data":{"$ref":"#/components/schemas/BlockchainAddressResponse"},"details":{"type":"array","description":"The details value for this resource.","items":{"$ref":"#/components/schemas/ErrorDetail"}},"requestId":{"type":"string","description":"The request id value for this resource."}},"description":"Standard response envelope: `code` is 0 on success, `message` explains the result, and `data` is a `BlockchainAddressResponse` object. Null envelope properties are omitted from JSON."},"BlockchainAddressResponse":{"title":"Blockchain Address","required":["address","id","status"],"type":"object","properties":{"id":{"type":"string","description":"Stable resource identifier. Treat IDs as opaque strings."},"network":{"type":"string","description":"Enabled blockchain network; null for fiat-only resources.","nullable":true},"networkType":{"type":"string","description":"Blockchain family or protocol type.","nullable":true},"chainId":{"type":"string","description":"Blockchain chain identifier.","nullable":true},"address":{"type":"string","description":"Street address or blockchain address, according to the containing resource."},"currencies":{"type":"array","description":"Assets enabled for this receiving address and network. Dynamic; returned by GET /api/v1/blockchain-addresses.","nullable":true,"items":{"type":"string","description":"Assets enabled for this receiving address and network. Dynamic; returned by GET /api/v1/blockchain-addresses."}},"status":{"type":"string","description":"Address state: active = available for receiving; inactive = retained for history but cannot be selected. Default on generation: active. Neither value is a final payment outcome.","enum":["active","inactive"]},"createdAt":{"type":"string","description":"UTC date-time when the resource was created.","format":"date-time","nullable":true}},"description":"Fields returned in the operation's `data` property. Optional fields may be null or absent for some records or resource states."},"ApiResponseMapStringString":{"title":"Map String String API response","required":["code","message"],"type":"object","properties":{"code":{"type":"integer","description":"Application result code: 0 means success; a nonzero value identifies an error.","format":"int32"},"message":{"type":"string","description":"Human-readable result message. For errors, use it together with code."},"data":{"type":"object","additionalProperties":{"type":"string"},"description":"Null."},"details":{"type":"array","description":"The details value for this resource.","items":{"$ref":"#/components/schemas/ErrorDetail"}},"requestId":{"type":"string","description":"The request id value for this resource."}},"description":"Standard response envelope: `code` is 0 on success, `message` explains the result, and `data` is null. Null envelope properties are omitted from JSON."},"ApplicationDocument":{"title":"Application Document","required":["code","documentId"],"type":"object","properties":{"code":{"type":"string","description":"Required. Dynamic required document code from the selected bank's applicationDocuments list in GET /api/v1/bank-options/{bankId}/requirements."},"documentId":{"pattern":"[1-9][0-9]*","type":"string","description":"Required. The document id value for this resource."},"expiryDate":{"type":"string","description":"Optional. Document expiry date in YYYY-MM-DD. Required when the selected bank's document rule has expiryDateRequired=true.","format":"date"}},"description":"Validated request body. Each field is labelled Required, Conditionally required, or Optional."},"BankApplicationRequest":{"title":"Bank Application request","required":["bankId","currencies","purpose","requirementsVersion"],"type":"object","properties":{"bankId":{"pattern":"[1-9][0-9]*","type":"string","description":"Required. Bank option ID from GET /api/v1/bank-options; values are dynamic by environment and enterprise."},"currencies":{"type":"array","description":"Required. Choose from currencies returned for this bank by GET /api/v1/bank-options/{bankId}/requirements. Values depend on bank configuration; no fixed enum.","items":{"type":"string","description":"Choose from currencies returned for this bank by GET /api/v1/bank-options/{bankId}/requirements. Values depend on bank configuration; no fixed enum."}},"purpose":{"type":"string","description":"Required. Bank-specific application purpose. Choose a value listed in GET /api/v1/bank-options/{bankId}/requirements; no universal enum or default."},"requirementsVersion":{"type":"string","description":"Required. Opaque current version returned by GET /api/v1/bank-options/{bankId}/requirements. Requery when stale; no fixed enum or default."},"supplements":{"type":"array","description":"Optional. The supplements value for this resource.","items":{"$ref":"#/components/schemas/Supplement"}},"applicationDocuments":{"type":"array","description":"Optional. The application documents value for this resource.","items":{"$ref":"#/components/schemas/ApplicationDocument"}}},"description":"Validated request body. Each field is labelled Required, Conditionally required, or Optional."},"Supplement":{"title":"Supplement","required":["requirementCode"],"type":"object","properties":{"requirementCode":{"type":"string","description":"Required. Dynamic missing KYB material code from the selected bank's requirements response. For DBS handheld ID use director_or_ubo_handheld_id."},"value":{"type":"string","description":"Optional. Text value for website; leave empty for a document requirement"},"personId":{"pattern":"[1-9][0-9]*","type":"string","description":"Optional. The person id value for this resource."},"documentId":{"pattern":"[1-9][0-9]*","type":"string","description":"Optional. The document id value for this resource."}},"description":"Validated request body. Each field is labelled Required, Conditionally required, or Optional."},"ApiResponseApplicationResponse":{"title":"Application API response","required":["code","message"],"type":"object","properties":{"code":{"type":"integer","description":"Application result code: 0 means success; a nonzero value identifies an error.","format":"int32"},"message":{"type":"string","description":"Human-readable result message. For errors, use it together with code."},"data":{"$ref":"#/components/schemas/ApplicationResponse"},"details":{"type":"array","description":"The details value for this resource.","items":{"$ref":"#/components/schemas/ErrorDetail"}},"requestId":{"type":"string","description":"The request id value for this resource."}},"description":"Standard response envelope: `code` is 0 on success, `message` explains the result, and `data` is a `ApplicationResponse` object. Null envelope properties are omitted from JSON."},"ApplicationResponse":{"title":"Application","type":"object","properties":{"id":{"type":"string","description":"Stable resource identifier. Treat IDs as opaque strings.","nullable":true},"bankId":{"type":"string","description":"The bank id value for this resource.","nullable":true},"bankName":{"type":"string","description":"Bank display name.","nullable":true},"region":{"type":"string","description":"Country or region of the bank receiving account.","nullable":true},"currencies":{"type":"array","description":"Enabled currency or asset codes supported by the resource.","nullable":true,"items":{"type":"string"}},"purpose":{"type":"string","description":"The purpose value for this resource.","nullable":true},"status":{"type":"string","description":"Bank-opening application state: pending = submitted; reviewing = under manual review; approved = account opening approved; rejected = declined. Terminal: approved, rejected. Default on submission: pending.","nullable":true,"enum":["pending","reviewing","approved","rejected"]},"reviewNote":{"type":"string","description":"The review note value for this resource.","nullable":true},"createdAt":{"type":"string","description":"UTC date-time when the resource was created.","format":"date-time","nullable":true},"reviewedAt":{"type":"string","description":"The reviewed at value for this resource.","format":"date-time","nullable":true},"applicationDocuments":{"type":"array","description":"The application documents value for this resource.","nullable":true,"items":{"$ref":"#/components/schemas/Evidence"}}},"description":"Fields returned in the operation's `data` property. Optional fields may be null or absent for some records or resource states."},"Evidence":{"title":"Evidence","type":"object","properties":{"code":{"type":"string","description":"Application result code: 0 means success; a nonzero value identifies an error.","nullable":true},"label":{"type":"string","description":"Customer-facing label for the contact destination account.","nullable":true},"documentId":{"type":"string","description":"The document id value for this resource.","nullable":true},"originalName":{"type":"string","description":"The original name value for this resource.","nullable":true},"reviewStatus":{"type":"string","description":"The review status value for this resource.","nullable":true},"expiryDate":{"type":"string","description":"Identity document expiry date in ISO-8601 date format; null when not supplied.","format":"date","nullable":true}},"description":"Data model used by the machine REST API."},"AgentTaskRequest":{"title":"Agent Task request","required":["capability","input","intent"],"type":"object","properties":{"capability":{"maxLength":80,"minLength":0,"type":"string","description":"Required. Capability code returned by /agent/capabilities.","example":"receivable.invoice.create"},"intent":{"maxLength":2000,"minLength":0,"type":"string","description":"Required. Plain-language objective retained for audit and review.","example":"Prepare a draft invoice for customer-42"},"input":{"type":"object","additionalProperties":{"type":"object","description":"Capability-specific structured input. Discover requirements from the capability before creating a task."},"description":"Required. Capability-specific structured input. Discover requirements from the capability before creating a task."}},"description":"Validated request body. Each field is labelled Required, Conditionally required, or Optional."},"AgentTaskResponse":{"title":"Agent Task","type":"object","properties":{"id":{"type":"string","description":"Stable resource identifier. Treat IDs as opaque strings.","nullable":true},"capability":{"type":"string","description":"Treasury Agent capability code selected for the task.","nullable":true},"intent":{"type":"string","description":"Plain-language objective retained for task audit and review.","nullable":true},"status":{"type":"string","description":"Task state: created = saved (initial); waiting_authorization = user action required; authorized = approved to run; running = executing; waiting_approval = workflow approval required; completed = finished successfully (terminal); failed = failed (terminal); cancelled = stopped (terminal).","nullable":true,"enum":["created","waiting_authorization","authorized","running","waiting_approval","completed","failed","cancelled"]},"requiredActions":{"type":"array","description":"Actions still required before the Treasury Agent task can complete.","nullable":true,"items":{"type":"string"}},"errorMessage":{"type":"string","description":"Human-readable failure detail; null when processing has not failed.","nullable":true},"createdAt":{"type":"string","description":"UTC date-time when the resource was created.","format":"date-time","nullable":true},"updatedAt":{"type":"string","description":"UTC date-time when the resource was most recently updated.","format":"date-time","nullable":true},"completedAt":{"type":"string","description":"UTC date-time when task processing completed; null while unfinished.","format":"date-time","nullable":true}},"description":"Fields returned in the operation's `data` property. Optional fields may be null or absent for some records or resource states."},"ApiResponseAgentTaskResponse":{"title":"Agent Task API response","required":["code","message"],"type":"object","properties":{"code":{"type":"integer","description":"Application result code: 0 means success; a nonzero value identifies an error.","format":"int32"},"message":{"type":"string","description":"Human-readable result message. For errors, use it together with code."},"data":{"$ref":"#/components/schemas/AgentTaskResponse"},"details":{"type":"array","description":"The details value for this resource.","items":{"$ref":"#/components/schemas/ErrorDetail"}},"requestId":{"type":"string","description":"The request id value for this resource."}},"description":"Standard response envelope: `code` is 0 on success, `message` explains the result, and `data` is a `AgentTaskResponse` object. Null envelope properties are omitted from JSON."},"WebhookEndpointUpdateRequest":{"title":"Webhook Endpoint Update request","type":"object","properties":{"url":{"maxLength":500,"minLength":0,"type":"string","description":"Optional. Replacement callback URL. Live endpoints must use HTTPS.","example":"https://example.com/webhooks/events"},"events":{"maxItems":32,"minItems":1,"type":"array","description":"Optional. Replacement dynamic event subscriptions; query GET /api/v1/webhook-endpoints/event-types for current concrete sandbox test names.","example":["card.*","invoice.*"],"items":{"type":"string","description":"Replacement dynamic event subscriptions; query GET /api/v1/webhook-endpoints/event-types for current concrete sandbox test names.","example":"[\"card.*\",\"invoice.*\"]"}},"status":{"pattern":"active|inactive","type":"string","description":"Optional. Endpoint state: active = deliveries enabled; inactive = deliveries disabled.","example":"active","enum":["active","inactive"]}},"description":"Validated request body. Each field is labelled Required, Conditionally required, or Optional."},"InvoiceUpdateRequest":{"title":"Invoice Update request","type":"object","properties":{"amount":{"minimum":0.01,"exclusiveMinimum":false,"type":"number","description":"Optional. Replacement invoice amount.","example":1200},"description":{"maxLength":1000,"minLength":0,"type":"string","description":"Optional. Replacement payment purpose or memo.","example":"Updated scope"},"dueDate":{"type":"string","description":"Optional. Replacement due date.","format":"date","example":"2026-10-15"},"lineItems":{"type":"array","description":"Optional. Replacement itemized lines.","items":{"$ref":"#/components/schemas/InvoiceLineItemRequest"}}},"description":"Validated request body. Each field is labelled Required, Conditionally required, or Optional."},"CardUpdateRequest":{"title":"Card Update request","required":["nickname"],"type":"object","properties":{"nickname":{"maxLength":128,"minLength":0,"type":"string","description":"Required. New customer-facing card nickname.","example":"Travel"}},"description":"Validated request body. Each field is labelled Required, Conditionally required, or Optional."},"ApiResponseListWorkspaceItem":{"title":"Workspace Item list response","required":["code","message"],"type":"object","properties":{"code":{"type":"integer","description":"Application result code: 0 means success; a nonzero value identifies an error.","format":"int32"},"message":{"type":"string","description":"Human-readable result message. For errors, use it together with code."},"data":{"type":"array","description":"An array of `WorkspaceItem` objects.","items":{"$ref":"#/components/schemas/WorkspaceItem"}},"details":{"type":"array","description":"The details value for this resource.","items":{"$ref":"#/components/schemas/ErrorDetail"}},"requestId":{"type":"string","description":"The request id value for this resource."}},"description":"Standard response envelope: `code` is 0 on success, `message` explains the result, and `data` is an array of `WorkspaceItem` objects. Null envelope properties are omitted from JSON."},"WorkspaceItem":{"title":"Workspace Item","type":"object","properties":{"workspace":{"type":"string","description":"The workspace value for this resource.","nullable":true},"type":{"type":"string","description":"Resource-specific classification or transaction type.","nullable":true},"id":{"type":"string","description":"Stable resource identifier. Treat IDs as opaque strings.","nullable":true},"name":{"type":"string","description":"Customer-facing resource or capability name.","nullable":true},"verificationStatus":{"type":"string","description":"The verification status value for this resource.","nullable":true},"synthetic":{"type":"boolean","description":"The synthetic value for this resource.","nullable":true}},"description":"Data model used by the machine REST API."},"ApiResponseListWebhookEndpointResponse":{"title":"Webhook Endpoint list response","required":["code","message"],"type":"object","properties":{"code":{"type":"integer","description":"Application result code: 0 means success; a nonzero value identifies an error.","format":"int32"},"message":{"type":"string","description":"Human-readable result message. For errors, use it together with code."},"data":{"type":"array","description":"An array of `WebhookEndpointResponse` objects.","items":{"$ref":"#/components/schemas/WebhookEndpointResponse"}},"details":{"type":"array","description":"The details value for this resource.","items":{"$ref":"#/components/schemas/ErrorDetail"}},"requestId":{"type":"string","description":"The request id value for this resource."}},"description":"Standard response envelope: `code` is 0 on success, `message` explains the result, and `data` is an array of `WebhookEndpointResponse` objects. Null envelope properties are omitted from JSON."},"ApiResponsePageDataWebhookDeliveryResponse":{"title":"Webhook Delivery list response","required":["code","message"],"type":"object","properties":{"code":{"type":"integer","description":"Application result code: 0 means success; a nonzero value identifies an error.","format":"int32"},"message":{"type":"string","description":"Human-readable result message. For errors, use it together with code."},"data":{"$ref":"#/components/schemas/PageDataWebhookDeliveryResponse"},"details":{"type":"array","description":"The details value for this resource.","items":{"$ref":"#/components/schemas/ErrorDetail"}},"requestId":{"type":"string","description":"The request id value for this resource."}},"description":"Standard response envelope: `code` is 0 on success, `message` explains the result, and `data` is a `PageDataWebhookDeliveryResponse` object. Null envelope properties are omitted from JSON."},"PageDataWebhookDeliveryResponse":{"title":"Webhook Delivery page","required":["items","page","pageSize","total"],"type":"object","properties":{"items":{"type":"array","description":"Resources returned on the current result page.","items":{"$ref":"#/components/schemas/WebhookDeliveryResponse"}},"total":{"type":"string","description":"Total number of records matching the filters across all pages."},"page":{"type":"integer","description":"Current one-based result page number.","format":"int32"},"pageSize":{"type":"integer","description":"Maximum records requested for each result page.","format":"int32"}},"description":"Paginated result: `items` is an array of `WebhookDeliveryResponse` objects; `total`, `page`, and `pageSize` describe pagination. Every listed property is present in JSON."},"WebhookDeliveryResponse":{"title":"Webhook Delivery","required":["deliveryId","eventId","status"],"type":"object","properties":{"deliveryId":{"type":"string","description":"Unique webhook delivery-attempt identifier."},"eventId":{"type":"string","description":"Webhook event identifier shared by every attempt to deliver the same event."},"status":{"type":"string","description":"Delivery state: pending = queued or scheduled for retry; delivering = claimed by a worker; delivered = receiver returned 2xx; dead_letter = retries exhausted or endpoint unavailable. Default on enqueue: pending. Terminal: delivered, dead_letter. A manual retry creates another delivery attempt.","enum":["pending","delivering","delivered","dead_letter"]},"attemptCount":{"type":"integer","description":"Number of delivery attempts made for this webhook delivery.","format":"int32","nullable":true},"responseStatus":{"type":"integer","description":"HTTP status returned by the webhook receiver.","format":"int32","nullable":true},"errorMessage":{"type":"string","description":"Human-readable failure detail; null when processing has not failed.","nullable":true},"nextAttemptAt":{"type":"string","description":"UTC date-time when the next webhook retry is scheduled; null when no retry is pending.","format":"date-time","nullable":true},"deliveredAt":{"type":"string","description":"UTC date-time when webhook delivery succeeded; null until delivered.","format":"date-time","nullable":true},"createdAt":{"type":"string","description":"UTC date-time when the resource was created.","format":"date-time","nullable":true},"updatedAt":{"type":"string","description":"UTC date-time when the resource was most recently updated.","format":"date-time","nullable":true}},"description":"Fields returned in the operation's `data` property. Optional fields may be null or absent for some records or resource states."},"ApiResponseListString":{"title":"String list response","required":["code","message"],"type":"object","properties":{"code":{"type":"integer","description":"Application result code: 0 means success; a nonzero value identifies an error.","format":"int32"},"message":{"type":"string","description":"Human-readable result message. For errors, use it together with code."},"data":{"type":"array","description":"An array of string values.","items":{"type":"string"}},"details":{"type":"array","description":"The details value for this resource.","items":{"$ref":"#/components/schemas/ErrorDetail"}},"requestId":{"type":"string","description":"The request id value for this resource."}},"description":"Standard response envelope: `code` is 0 on success, `message` explains the result, and `data` is an array of string values. Null envelope properties are omitted from JSON."},"ApiResponseListLinkItem":{"title":"Link Item list response","required":["code","message"],"type":"object","properties":{"code":{"type":"integer","description":"Application result code: 0 means success; a nonzero value identifies an error.","format":"int32"},"message":{"type":"string","description":"Human-readable result message. For errors, use it together with code."},"data":{"type":"array","description":"An array of `LinkItem` objects.","items":{"$ref":"#/components/schemas/LinkItem"}},"details":{"type":"array","description":"The details value for this resource.","items":{"$ref":"#/components/schemas/ErrorDetail"}},"requestId":{"type":"string","description":"The request id value for this resource."}},"description":"Standard response envelope: `code` is 0 on success, `message` explains the result, and `data` is an array of `LinkItem` objects. Null envelope properties are omitted from JSON."},"LinkItem":{"title":"Link Item","type":"object","properties":{"enterpriseId":{"type":"string","description":"The enterprise id value for this resource.","nullable":true},"status":{"type":"string","description":"Current lifecycle or processing state for the containing resource.","nullable":true}},"description":"Data model used by the machine REST API."},"ApiResponsePageDataTransferResponse":{"title":"Transfer list response","required":["code","message"],"type":"object","properties":{"code":{"type":"integer","description":"Application result code: 0 means success; a nonzero value identifies an error.","format":"int32"},"message":{"type":"string","description":"Human-readable result message. For errors, use it together with code."},"data":{"$ref":"#/components/schemas/PageDataTransferResponse"},"details":{"type":"array","description":"The details value for this resource.","items":{"$ref":"#/components/schemas/ErrorDetail"}},"requestId":{"type":"string","description":"The request id value for this resource."}},"description":"Standard response envelope: `code` is 0 on success, `message` explains the result, and `data` is a `PageDataTransferResponse` object. Null envelope properties are omitted from JSON."},"PageDataTransferResponse":{"title":"Transfer page","required":["items","page","pageSize","total"],"type":"object","properties":{"items":{"type":"array","description":"Resources returned on the current result page.","items":{"$ref":"#/components/schemas/TransferResponse"}},"total":{"type":"string","description":"Total number of records matching the filters across all pages."},"page":{"type":"integer","description":"Current one-based result page number.","format":"int32"},"pageSize":{"type":"integer","description":"Maximum records requested for each result page.","format":"int32"}},"description":"Paginated result: `items` is an array of `TransferResponse` objects; `total`, `page`, and `pageSize` describe pagination. Every listed property is present in JSON."},"ApiResponseRequirements":{"title":"Requirements API response","required":["code","message"],"type":"object","properties":{"code":{"type":"integer","description":"Application result code: 0 means success; a nonzero value identifies an error.","format":"int32"},"message":{"type":"string","description":"Human-readable result message. For errors, use it together with code."},"data":{"$ref":"#/components/schemas/Requirements"},"details":{"type":"array","description":"The details value for this resource.","items":{"$ref":"#/components/schemas/ErrorDetail"}},"requestId":{"type":"string","description":"The request id value for this resource."}},"description":"Standard response envelope: `code` is 0 on success, `message` explains the result, and `data` is a `Requirements` object. Null envelope properties are omitted from JSON."},"Requirements":{"title":"Requirements","type":"object","properties":{"country":{"type":"string","description":"The country value for this resource.","nullable":true},"currency":{"type":"string","description":"ISO currency or enabled asset code used for monetary values.","nullable":true},"beneficiaryType":{"type":"string","description":"Beneficiary type used for this preview: individual = person; business = company. Defaults to individual when omitted.","nullable":true,"enum":["individual","business"]},"paymentRail":{"type":"string","description":"Rail used to derive field suggestions. Defaults to the first suggestedRail when omitted. This is not proof that a channel accepts the rail; POST /transfers can infer a different rail from the actual recipient details.","nullable":true},"suggestedRails":{"type":"array","description":"Country/currency field suggestions, not a list of enabled or channel-supported rails. For actual availability inspect available and unavailableReason for a specific paymentRail and amount.","nullable":true,"items":{"type":"string","description":"Country/currency field suggestions, not a list of enabled or channel-supported rails. For actual availability inspect available and unavailableReason for a specific paymentRail and amount."}},"configuredRails":{"type":"array","description":"Dynamic rails explicitly advertised by eligible payout capabilities for this country, currency and amount. This list is not workspace policy or route availability; query this endpoint for each rail to verify available.","nullable":true,"items":{"type":"string","description":"Dynamic rails explicitly advertised by eligible payout capabilities for this country, currency and amount. This list is not workspace policy or route availability; query this endpoint for each rail to verify available."}},"fieldRulesKnown":{"type":"boolean","description":"True when this service knows rail-specific recipient field rules. False for provider-defined rails; consult the provider's integration requirements and use the generic requiredFields.","nullable":true},"requiredFields":{"type":"array","description":"The required fields value for this resource.","nullable":true,"items":{"type":"string"}},"optionalFields":{"type":"array","description":"The optional fields value for this resource.","nullable":true,"items":{"type":"string"}},"accountIdentifierType":{"type":"string","description":"Suggested account identifier type: iban = International Bank Account Number; local = domestic account number. Submission infers the type from the account number when omitted.","nullable":true,"enum":["iban","local"]},"routingCodeType":{"type":"string","description":"Suggested local routing-code type. Null for rails without a known local code; custom types are provider-specific.","nullable":true},"available":{"type":"boolean","description":"True when the selected execution mode, amount and workspace can accept this payout. Automatic execution requires explicit rail support. Manual execution accepts a manual payout workflow and does not attest to a bank rail. Submission still rechecks all gates.","nullable":true},"unavailableReason":{"type":"string","description":"Why available is false: rail_not_described = neither a field suggestion nor explicit channel rail metadata exists; amount_required = no amount was supplied for a route check; channel_unavailable = no eligible payout capability; workspace_not_enabled = workspace policy denies payout; route_unavailable = routing found no eligible channel; rail_support_unverified = matched historical channel has no explicit rail metadata. Null when available is true; this is a preview reason, not a transfer lifecycle state.","nullable":true,"enum":["rail_not_described","amount_required","channel_unavailable","workspace_not_enabled","route_unavailable","rail_support_unverified"]},"documentPreviewEndpoint":{"type":"string","description":"The document preview endpoint value for this resource.","nullable":true},"executionMode":{"type":"string","description":"Selected payout execution mode: api = automatic processing; manual = operator execution. Null when no route is selected.","nullable":true,"enum":["api","manual"]},"simulated":{"type":"boolean","description":"True only for an automatic platform fiat-payment simulator selected in sandbox. Simulation does not execute a real bank payment.","nullable":true}},"description":"Data model used by the machine REST API."},"ApiResponsePageDataTransferBatchResponse":{"title":"Transfer Batch list response","required":["code","message"],"type":"object","properties":{"code":{"type":"integer","description":"Application result code: 0 means success; a nonzero value identifies an error.","format":"int32"},"message":{"type":"string","description":"Human-readable result message. For errors, use it together with code."},"data":{"$ref":"#/components/schemas/PageDataTransferBatchResponse"},"details":{"type":"array","description":"The details value for this resource.","items":{"$ref":"#/components/schemas/ErrorDetail"}},"requestId":{"type":"string","description":"The request id value for this resource."}},"description":"Standard response envelope: `code` is 0 on success, `message` explains the result, and `data` is a `PageDataTransferBatchResponse` object. Null envelope properties are omitted from JSON."},"PageDataTransferBatchResponse":{"title":"Transfer Batch page","required":["items","page","pageSize","total"],"type":"object","properties":{"items":{"type":"array","description":"Resources returned on the current result page.","items":{"$ref":"#/components/schemas/TransferBatchResponse"}},"total":{"type":"string","description":"Total number of records matching the filters across all pages."},"page":{"type":"integer","description":"Current one-based result page number.","format":"int32"},"pageSize":{"type":"integer","description":"Maximum records requested for each result page.","format":"int32"}},"description":"Paginated result: `items` is an array of `TransferBatchResponse` objects; `total`, `page`, and `pageSize` describe pagination. Every listed property is present in JSON."},"ApiResponsePageDataInvoiceResponse":{"title":"Invoice list response","required":["code","message"],"type":"object","properties":{"code":{"type":"integer","description":"Application result code: 0 means success; a nonzero value identifies an error.","format":"int32"},"message":{"type":"string","description":"Human-readable result message. For errors, use it together with code."},"data":{"$ref":"#/components/schemas/PageDataInvoiceResponse"},"details":{"type":"array","description":"The details value for this resource.","items":{"$ref":"#/components/schemas/ErrorDetail"}},"requestId":{"type":"string","description":"The request id value for this resource."}},"description":"Standard response envelope: `code` is 0 on success, `message` explains the result, and `data` is a `PageDataInvoiceResponse` object. Null envelope properties are omitted from JSON."},"PageDataInvoiceResponse":{"title":"Invoice page","required":["items","page","pageSize","total"],"type":"object","properties":{"items":{"type":"array","description":"Resources returned on the current result page.","items":{"$ref":"#/components/schemas/InvoiceResponse"}},"total":{"type":"string","description":"Total number of records matching the filters across all pages."},"page":{"type":"integer","description":"Current one-based result page number.","format":"int32"},"pageSize":{"type":"integer","description":"Maximum records requested for each result page.","format":"int32"}},"description":"Paginated result: `items` is an array of `InvoiceResponse` objects; `total`, `page`, and `pageSize` describe pagination. Every listed property is present in JSON."},"ApiResponsePageDataPaymentRecordResponse":{"title":"Payment Record list response","required":["code","message"],"type":"object","properties":{"code":{"type":"integer","description":"Application result code: 0 means success; a nonzero value identifies an error.","format":"int32"},"message":{"type":"string","description":"Human-readable result message. For errors, use it together with code."},"data":{"$ref":"#/components/schemas/PageDataPaymentRecordResponse"},"details":{"type":"array","description":"The details value for this resource.","items":{"$ref":"#/components/schemas/ErrorDetail"}},"requestId":{"type":"string","description":"The request id value for this resource."}},"description":"Standard response envelope: `code` is 0 on success, `message` explains the result, and `data` is a `PageDataPaymentRecordResponse` object. Null envelope properties are omitted from JSON."},"PageDataPaymentRecordResponse":{"title":"Payment Record page","required":["items","page","pageSize","total"],"type":"object","properties":{"items":{"type":"array","description":"Resources returned on the current result page.","items":{"$ref":"#/components/schemas/PaymentRecordResponse"}},"total":{"type":"string","description":"Total number of records matching the filters across all pages."},"page":{"type":"integer","description":"Current one-based result page number.","format":"int32"},"pageSize":{"type":"integer","description":"Maximum records requested for each result page.","format":"int32"}},"description":"Paginated result: `items` is an array of `PaymentRecordResponse` objects; `total`, `page`, and `pageSize` describe pagination. Every listed property is present in JSON."},"PaymentRecordResponse":{"title":"Payment Record","required":["amount","createdAt","id","paymentMethod","status"],"type":"object","properties":{"id":{"type":"string","description":"Stable resource identifier. Treat IDs as opaque strings."},"recordNo":{"type":"string","description":"Platform receipt number; may be null on historical records.","nullable":true},"invoiceId":{"type":"string","description":"Related invoice ID when this receipt belongs to an invoice; otherwise null.","nullable":true},"paymentLinkId":{"type":"string","description":"Related payment-link ID when this receipt belongs to a link; otherwise null.","nullable":true},"paymentMethod":{"type":"string","description":"Payment method: crypto = blockchain receipt; fiat = bank receipt. The underlying record defaults to crypto when unspecified.","enum":["crypto","fiat"]},"sourceType":{"type":"string","description":"Origin of this receipt when recorded; may be null on older records. This is an extensible classification, not a fixed enum.","nullable":true},"currency":{"type":"string","description":"Canonical receipt currency or asset code; may be null on historical records without a captured currency.","nullable":true},"amount":{"type":"string","description":"Decimal monetary amount represented as a string to preserve precision."},"feeAmount":{"type":"string","description":"Fee amount when calculated; null when not yet determined or not recorded.","nullable":true},"netAmount":{"type":"string","description":"Amount after fees when calculated; null when not yet determined or not recorded.","nullable":true},"status":{"type":"string","description":"Payment state: pending_payment = awaiting payer; paying = checkout in progress; pending_settlement = received but not yet credited, often pending AML review; settled = credited; failed = unsuccessful; refunded = returned to payer; reversed = previously credited funds reversed. Default for a new payment: pending_payment. Terminal for this payment: failed, refunded, reversed. A settled payment can later become refunded or reversed.","enum":["pending_payment","paying","pending_settlement","settled","failed","refunded","reversed"]},"matchStatus":{"type":"string","description":"Reconciliation label when assigned; may be null. Common values: unmatched = no receivable match, matched = linked, quick_receipt = quick collection, aml_review = held for AML, manual_matched = matched by operator, partial = partial match. This database field is extensible; treat unknown values as non-final and inspect the payment status for settlement.","nullable":true},"riskLevel":{"type":"string","description":"Stored payment AML risk level when assessed; may be null. low = low; normal = standard/default; medium = elevated; high = high; warning = flagged for review; blocked = blocked.","nullable":true,"enum":["low","normal","medium","high","warning","blocked"]},"txHash":{"type":"string","description":"Blockchain transaction hash for a crypto receipt once broadcast or detected; null for fiat and before a hash is known.","nullable":true},"network":{"type":"string","description":"Blockchain network for a crypto receipt; null for fiat or when not recorded.","nullable":true},"fromAddress":{"type":"string","description":"Payer identifier when recorded: blockchain address for crypto, sender bank account number for fiat. May be null.","nullable":true},"toAddress":{"type":"string","description":"Receiving identifier when recorded: blockchain address for crypto, receiving bank account number for fiat. May be null.","nullable":true},"fiatReferenceNo":{"type":"string","description":"Bank payment reference for a fiat receipt when provided; null for crypto or when unavailable.","nullable":true},"fiatSenderName":{"type":"string","description":"Sender name for a fiat receipt when provided; null for crypto or when unavailable.","nullable":true},"fiatSenderAccountNo":{"type":"string","description":"Sender bank account number for a fiat receipt when provided; null for crypto or when unavailable.","nullable":true},"receivingAccountNo":{"type":"string","description":"Receiving bank account number for a fiat receipt when resolved; null for crypto or when unavailable.","nullable":true},"receivingAccountHolder":{"type":"string","description":"Receiving bank account holder for a fiat receipt when resolved; null for crypto or when unavailable.","nullable":true},"confirmedAt":{"type":"string","description":"Confirmation time after settlement; null while pending or when historical confirmation time is unavailable.","format":"date-time","nullable":true},"createdAt":{"type":"string","description":"UTC date-time when the resource was created.","format":"date-time"},"updatedAt":{"type":"string","description":"Last update time when recorded; may be null on historical records.","format":"date-time","nullable":true}},"description":"One fiat or blockchain receipt. paymentMethod selects the method; bank and chain detail fields are conditional and may be null. A null detail means it is inapplicable, not yet known, or unavailable in a historical record."},"ApiResponsePaymentRecordResponse":{"title":"Payment Record API response","required":["code","message"],"type":"object","properties":{"code":{"type":"integer","description":"Application result code: 0 means success; a nonzero value identifies an error.","format":"int32"},"message":{"type":"string","description":"Human-readable result message. For errors, use it together with code."},"data":{"$ref":"#/components/schemas/PaymentRecordResponse"},"details":{"type":"array","description":"The details value for this resource.","items":{"$ref":"#/components/schemas/ErrorDetail"}},"requestId":{"type":"string","description":"The request id value for this resource."}},"description":"Standard response envelope: `code` is 0 on success, `message` explains the result, and `data` is a `PaymentRecordResponse` object. Null envelope properties are omitted from JSON."},"ApiResponsePageDataPaymentLinkResponse":{"title":"Payment Link list response","required":["code","message"],"type":"object","properties":{"code":{"type":"integer","description":"Application result code: 0 means success; a nonzero value identifies an error.","format":"int32"},"message":{"type":"string","description":"Human-readable result message. For errors, use it together with code."},"data":{"$ref":"#/components/schemas/PageDataPaymentLinkResponse"},"details":{"type":"array","description":"The details value for this resource.","items":{"$ref":"#/components/schemas/ErrorDetail"}},"requestId":{"type":"string","description":"The request id value for this resource."}},"description":"Standard response envelope: `code` is 0 on success, `message` explains the result, and `data` is a `PageDataPaymentLinkResponse` object. Null envelope properties are omitted from JSON."},"PageDataPaymentLinkResponse":{"title":"Payment Link page","required":["items","page","pageSize","total"],"type":"object","properties":{"items":{"type":"array","description":"Resources returned on the current result page.","items":{"$ref":"#/components/schemas/PaymentLinkResponse"}},"total":{"type":"string","description":"Total number of records matching the filters across all pages."},"page":{"type":"integer","description":"Current one-based result page number.","format":"int32"},"pageSize":{"type":"integer","description":"Maximum records requested for each result page.","format":"int32"}},"description":"Paginated result: `items` is an array of `PaymentLinkResponse` objects; `total`, `page`, and `pageSize` describe pagination. Every listed property is present in JSON."},"ApiResponseExchangeRateResponse":{"title":"Exchange Rate API response","required":["code","message"],"type":"object","properties":{"code":{"type":"integer","description":"Application result code: 0 means success; a nonzero value identifies an error.","format":"int32"},"message":{"type":"string","description":"Human-readable result message. For errors, use it together with code."},"data":{"$ref":"#/components/schemas/ExchangeRateResponse"},"details":{"type":"array","description":"The details value for this resource.","items":{"$ref":"#/components/schemas/ErrorDetail"}},"requestId":{"type":"string","description":"The request id value for this resource."}},"description":"Standard response envelope: `code` is 0 on success, `message` explains the result, and `data` is a `ExchangeRateResponse` object. Null envelope properties are omitted from JSON."},"ExchangeRateResponse":{"title":"Exchange Rate","type":"object","properties":{"fromCurrency":{"type":"string","description":"The from currency value for this resource.","nullable":true},"toCurrency":{"type":"string","description":"The to currency value for this resource.","nullable":true},"rate":{"type":"number","description":"The rate value for this resource.","nullable":true},"midRate":{"type":"number","description":"The mid rate value for this resource.","nullable":true},"feeRate":{"type":"number","description":"The fee rate value for this resource.","nullable":true},"feeAmount":{"type":"number","description":"Transaction fee represented as a decimal string.","nullable":true},"spreadAmount":{"type":"number","description":"The spread amount value for this resource.","nullable":true},"feeCurrency":{"type":"string","description":"Currency or asset code of the fee.","nullable":true},"spreadCurrency":{"type":"string","description":"The spread currency value for this resource.","nullable":true},"buyAmount":{"type":"number","description":"The buy amount value for this resource.","nullable":true},"timestamp":{"type":"string","description":"The timestamp value for this resource.","nullable":true}},"description":"Fields returned in the operation's `data` property. Optional fields may be null or absent for some records or resource states."},"ApiResponseListExchangePairResponse":{"title":"Exchange Pair list response","required":["code","message"],"type":"object","properties":{"code":{"type":"integer","description":"Application result code: 0 means success; a nonzero value identifies an error.","format":"int32"},"message":{"type":"string","description":"Human-readable result message. For errors, use it together with code."},"data":{"type":"array","description":"An array of `ExchangePairResponse` objects.","items":{"$ref":"#/components/schemas/ExchangePairResponse"}},"details":{"type":"array","description":"The details value for this resource.","items":{"$ref":"#/components/schemas/ErrorDetail"}},"requestId":{"type":"string","description":"The request id value for this resource."}},"description":"Standard response envelope: `code` is 0 on success, `message` explains the result, and `data` is an array of `ExchangePairResponse` objects. Null envelope properties are omitted from JSON."},"ExchangePairResponse":{"title":"Exchange Pair","type":"object","properties":{"fromCurrency":{"type":"string","description":"The from currency value for this resource.","nullable":true},"toCurrency":{"type":"string","description":"The to currency value for this resource.","nullable":true},"minAmount":{"type":"number","description":"The min amount value for this resource.","nullable":true},"maxAmount":{"type":"number","description":"The max amount value for this resource.","nullable":true},"quoteTtlSeconds":{"type":"integer","description":"The quote ttl seconds value for this resource.","format":"int32","nullable":true}},"description":"Fields returned in the operation's `data` property. Optional fields may be null or absent for some records or resource states."},"ApiResponsePageDataOrderResponse":{"title":"Order list response","required":["code","message"],"type":"object","properties":{"code":{"type":"integer","description":"Application result code: 0 means success; a nonzero value identifies an error.","format":"int32"},"message":{"type":"string","description":"Human-readable result message. For errors, use it together with code."},"data":{"$ref":"#/components/schemas/PageDataOrderResponse"},"details":{"type":"array","description":"The details value for this resource.","items":{"$ref":"#/components/schemas/ErrorDetail"}},"requestId":{"type":"string","description":"The request id value for this resource."}},"description":"Standard response envelope: `code` is 0 on success, `message` explains the result, and `data` is a `PageDataOrderResponse` object. Null envelope properties are omitted from JSON."},"PageDataOrderResponse":{"title":"Order page","required":["items","page","pageSize","total"],"type":"object","properties":{"items":{"type":"array","description":"Resources returned on the current result page.","items":{"$ref":"#/components/schemas/OrderResponse"}},"total":{"type":"string","description":"Total number of records matching the filters across all pages."},"page":{"type":"integer","description":"Current one-based result page number.","format":"int32"},"pageSize":{"type":"integer","description":"Maximum records requested for each result page.","format":"int32"}},"description":"Paginated result: `items` is an array of `OrderResponse` objects; `total`, `page`, and `pageSize` describe pagination. Every listed property is present in JSON."},"ApiResponseVerificationResponse":{"title":"Verification API response","required":["code","message"],"type":"object","properties":{"code":{"type":"integer","description":"Application result code: 0 means success; a nonzero value identifies an error.","format":"int32"},"message":{"type":"string","description":"Human-readable result message. For errors, use it together with code."},"data":{"$ref":"#/components/schemas/VerificationResponse"},"details":{"type":"array","description":"The details value for this resource.","items":{"$ref":"#/components/schemas/ErrorDetail"}},"requestId":{"type":"string","description":"The request id value for this resource."}},"description":"Standard response envelope: `code` is 0 on success, `message` explains the result, and `data` is a `VerificationResponse` object. Null envelope properties are omitted from JSON."},"VerificationResponse":{"title":"Verification","type":"object","properties":{"enterpriseId":{"type":"string","description":"The enterprise id value for this resource.","nullable":true},"status":{"type":"string","description":"Enterprise KYB state: not_submitted = no complete submission; pending = under review; approved = verified; rejected = declined; review_required = corrections requested; edd_required = enhanced due diligence; renewal_required = evidence renewal needed. No permanent terminal state.","nullable":true,"enum":["not_submitted","pending","approved","rejected","review_required","edd_required","renewal_required"]},"name":{"type":"string","description":"Customer-facing resource or capability name.","nullable":true},"registrationCountry":{"type":"string","description":"The registration country value for this resource.","nullable":true},"submittedAt":{"type":"string","description":"The submitted at value for this resource.","format":"date-time","nullable":true},"reviewedAt":{"type":"string","description":"The reviewed at value for this resource.","format":"date-time","nullable":true},"expiresAt":{"type":"string","description":"UTC date-time after which the link or session can no longer be used.","format":"date","nullable":true}},"description":"Fields returned in the operation's `data` property. Optional fields may be null or absent for some records or resource states."},"ApiResponseListPortfolioItem":{"title":"Portfolio Item list response","required":["code","message"],"type":"object","properties":{"code":{"type":"integer","description":"Application result code: 0 means success; a nonzero value identifies an error.","format":"int32"},"message":{"type":"string","description":"Human-readable result message. For errors, use it together with code."},"data":{"type":"array","description":"An array of `PortfolioItem` objects.","items":{"$ref":"#/components/schemas/PortfolioItem"}},"details":{"type":"array","description":"The details value for this resource.","items":{"$ref":"#/components/schemas/ErrorDetail"}},"requestId":{"type":"string","description":"The request id value for this resource."}},"description":"Standard response envelope: `code` is 0 on success, `message` explains the result, and `data` is an array of `PortfolioItem` objects. Null envelope properties are omitted from JSON."},"ApiResponseApplicationDetail":{"title":"Application Detail API response","required":["code","message"],"type":"object","properties":{"code":{"type":"integer","description":"Application result code: 0 means success; a nonzero value identifies an error.","format":"int32"},"message":{"type":"string","description":"Human-readable result message. For errors, use it together with code."},"data":{"$ref":"#/components/schemas/ApplicationDetail"},"details":{"type":"array","description":"The details value for this resource.","items":{"$ref":"#/components/schemas/ErrorDetail"}},"requestId":{"type":"string","description":"The request id value for this resource."}},"description":"Standard response envelope: `code` is 0 on success, `message` explains the result, and `data` is a `ApplicationDetail` object. Null envelope properties are omitted from JSON."},"ApplicationDetail":{"title":"Application Detail","type":"object","properties":{"application":{"$ref":"#/components/schemas/PortfolioItem"},"kyb":{"type":"object","additionalProperties":{"type":"object","description":"Saved KYB fields and review details. kyb.status uses the same seven values documented by application.kybStatus; actionRequired tells the customer whether to resubmit. Dynamic fieldValues are returned with their own review notes."},"description":"Saved KYB fields and review details. kyb.status uses the same seven values documented by application.kybStatus; actionRequired tells the customer whether to resubmit. Dynamic fieldValues are returned with their own review notes.","nullable":true}},"description":"Data model used by the machine REST API."},"ApiResponseListDocumentUpload":{"title":"Document Upload list response","required":["code","message"],"type":"object","properties":{"code":{"type":"integer","description":"Application result code: 0 means success; a nonzero value identifies an error.","format":"int32"},"message":{"type":"string","description":"Human-readable result message. For errors, use it together with code."},"data":{"type":"array","description":"An array of `DocumentUpload` objects.","items":{"$ref":"#/components/schemas/DocumentUpload"}},"details":{"type":"array","description":"The details value for this resource.","items":{"$ref":"#/components/schemas/ErrorDetail"}},"requestId":{"type":"string","description":"The request id value for this resource."}},"description":"Standard response envelope: `code` is 0 on success, `message` explains the result, and `data` is an array of `DocumentUpload` objects. Null envelope properties are omitted from JSON."},"ApiResponseMachineKybRequirementsResponse":{"title":"Machine Kyb Requirements API response","required":["code","message"],"type":"object","properties":{"code":{"type":"integer","description":"Application result code: 0 means success; a nonzero value identifies an error.","format":"int32"},"message":{"type":"string","description":"Human-readable result message. For errors, use it together with code."},"data":{"$ref":"#/components/schemas/MachineKybRequirementsResponse"},"details":{"type":"array","description":"The details value for this resource.","items":{"$ref":"#/components/schemas/ErrorDetail"}},"requestId":{"type":"string","description":"The request id value for this resource."}},"description":"Standard response envelope: `code` is 0 on success, `message` explains the result, and `data` is a `MachineKybRequirementsResponse` object. Null envelope properties are omitted from JSON."},"HandheldRule":{"title":"Handheld Rule","type":"object","properties":{"role":{"type":"string","description":"Uploaded identity-image role.","nullable":true},"documentType":{"type":"string","description":"The document type value for this resource.","nullable":true},"countPerPerson":{"type":"integer","description":"The count per person value for this resource.","format":"int32","nullable":true}},"description":"Brand-level handheld document rules by person role; empty when disabled"},"KybFieldDefinitionResponse":{"title":"Kyb Field Definition","type":"object","properties":{"fieldKey":{"type":"string","description":"The field key value for this resource.","nullable":true},"fieldLabel":{"type":"string","description":"The field label value for this resource.","nullable":true},"fieldType":{"type":"string","description":"The field type value for this resource.","nullable":true},"fieldCategory":{"type":"string","description":"The field category value for this resource.","nullable":true},"required":{"type":"boolean","description":"The required value for this resource.","nullable":true},"applicableRegions":{"type":"array","description":"The applicable regions value for this resource.","nullable":true,"items":{"type":"string"}},"applicableIndustries":{"type":"array","description":"The applicable industries value for this resource.","nullable":true,"items":{"type":"string"}},"validationConfig":{"type":"object","description":"The validation config value for this resource.","nullable":true},"description":{"type":"string","description":"Customer-facing or operational description of the resource.","nullable":true},"displayOrder":{"type":"integer","description":"The display order value for this resource.","format":"int32","nullable":true}},"description":"Applicable dynamic KYB fields; submit values in fieldValues"},"MachineKybRequirementsResponse":{"title":"Machine Kyb Requirements","type":"object","properties":{"fields":{"type":"array","description":"Applicable dynamic KYB fields; submit values in fieldValues","nullable":true,"items":{"$ref":"#/components/schemas/KybFieldDefinitionResponse"}},"allowedCountries":{"type":"array","description":"Countries currently allowed for this user; * means all except denied countries","nullable":true,"items":{"type":"string","description":"Countries currently allowed for this user; * means all except denied countries"}},"deniedCountries":{"type":"array","description":"Countries currently denied for this user; * means all","nullable":true,"items":{"type":"string","description":"Countries currently denied for this user; * means all"}},"countryOptions":{"type":"array","description":"Common ISO country-code suggestions and display labels for registration and nationality fields; not exhaustive. Apply allowedCountries and deniedCountries to registrationCountry","nullable":true,"items":{"$ref":"#/components/schemas/Option"}},"fixedFieldOptions":{"type":"object","additionalProperties":{"type":"array","description":"Selectable values for fixed MachineKybSubmissionRequest paths. Values, not labels, are sent in JSON","items":{"$ref":"#/components/schemas/Option"}},"description":"Selectable values for fixed MachineKybSubmissionRequest paths. Values, not labels, are sent in JSON","nullable":true},"businessTypeSuggestions":{"type":"array","description":"Suggested businessType values from the user portal; MCC/SIC codes and industry keywords are also accepted","nullable":true,"items":{"$ref":"#/components/schemas/Option"}},"documentTypes":{"type":"object","additionalProperties":{"type":"array","description":"Document types accepted for each KYB field path","items":{"type":"string","description":"Document types accepted for each KYB field path"}},"description":"Document types accepted for each KYB field path","nullable":true},"uboOwnershipThresholdPct":{"type":"integer","description":"Local ownership threshold for share-based UBO classification; minority shareholders can still be submitted with shareholder role","format":"int32","nullable":true},"minimumLegalRepresentatives":{"type":"integer","description":"Minimum number of relatedParties with legal_representative role; exactly one for CN","format":"int32","nullable":true},"minimumDirectors":{"type":"integer","description":"Minimum number of relatedParties with director role; one for HK, further directors allowed for any country","format":"int32","nullable":true},"handheldDocumentRequired":{"type":"boolean","description":"Whether the brand requires handheld ID photos for representatives and directors during KYB submission; bank-specific requirements are separate","nullable":true},"handheldRules":{"type":"array","description":"Brand-level handheld document rules by person role; empty when disabled","nullable":true,"items":{"$ref":"#/components/schemas/HandheldRule"}}},"description":"Fields returned in the operation's `data` property. Optional fields may be null or absent for some records or resource states."},"Option":{"title":"Option","type":"object","properties":{"value":{"type":"string","description":"Submit this exact value. Fixed-field option lists are exhaustive for the selected requirements response; country and business-type lists are suggestions where documented.","nullable":true},"label":{"type":"string","description":"Human-readable display label; do not submit the label in place of value.","nullable":true}},"description":"Suggested businessType values from the user portal; MCC/SIC codes and industry keywords are also accepted"},"ApiResponsePageDataContactResponse":{"title":"Contact list response","required":["code","message"],"type":"object","properties":{"code":{"type":"integer","description":"Application result code: 0 means success; a nonzero value identifies an error.","format":"int32"},"message":{"type":"string","description":"Human-readable result message. For errors, use it together with code."},"data":{"$ref":"#/components/schemas/PageDataContactResponse"},"details":{"type":"array","description":"The details value for this resource.","items":{"$ref":"#/components/schemas/ErrorDetail"}},"requestId":{"type":"string","description":"The request id value for this resource."}},"description":"Standard response envelope: `code` is 0 on success, `message` explains the result, and `data` is a `PageDataContactResponse` object. Null envelope properties are omitted from JSON."},"PageDataContactResponse":{"title":"Contact page","required":["items","page","pageSize","total"],"type":"object","properties":{"items":{"type":"array","description":"Resources returned on the current result page.","items":{"$ref":"#/components/schemas/ContactResponse"}},"total":{"type":"string","description":"Total number of records matching the filters across all pages."},"page":{"type":"integer","description":"Current one-based result page number.","format":"int32"},"pageSize":{"type":"integer","description":"Maximum records requested for each result page.","format":"int32"}},"description":"Paginated result: `items` is an array of `ContactResponse` objects; `total`, `page`, and `pageSize` describe pagination. Every listed property is present in JSON."},"ApiResponseListDocumentResponse":{"title":"Document list response","required":["code","message"],"type":"object","properties":{"code":{"type":"integer","description":"Application result code: 0 means success; a nonzero value identifies an error.","format":"int32"},"message":{"type":"string","description":"Human-readable result message. For errors, use it together with code."},"data":{"type":"array","description":"An array of `DocumentResponse` objects.","items":{"$ref":"#/components/schemas/DocumentResponse"}},"details":{"type":"array","description":"The details value for this resource.","items":{"$ref":"#/components/schemas/ErrorDetail"}},"requestId":{"type":"string","description":"The request id value for this resource."}},"description":"Standard response envelope: `code` is 0 on success, `message` explains the result, and `data` is an array of `DocumentResponse` objects. Null envelope properties are omitted from JSON."},"ApiResponseListContactAccountResponse":{"title":"Contact Account list response","required":["code","message"],"type":"object","properties":{"code":{"type":"integer","description":"Application result code: 0 means success; a nonzero value identifies an error.","format":"int32"},"message":{"type":"string","description":"Human-readable result message. For errors, use it together with code."},"data":{"type":"array","description":"An array of `ContactAccountResponse` objects.","items":{"$ref":"#/components/schemas/ContactAccountResponse"}},"details":{"type":"array","description":"The details value for this resource.","items":{"$ref":"#/components/schemas/ErrorDetail"}},"requestId":{"type":"string","description":"The request id value for this resource."}},"description":"Standard response envelope: `code` is 0 on success, `message` explains the result, and `data` is an array of `ContactAccountResponse` objects. Null envelope properties are omitted from JSON."},"ApiResponsePageDataCardResponse":{"title":"Card list response","required":["code","message"],"type":"object","properties":{"code":{"type":"integer","description":"Application result code: 0 means success; a nonzero value identifies an error.","format":"int32"},"message":{"type":"string","description":"Human-readable result message. For errors, use it together with code."},"data":{"$ref":"#/components/schemas/PageDataCardResponse"},"details":{"type":"array","description":"The details value for this resource.","items":{"$ref":"#/components/schemas/ErrorDetail"}},"requestId":{"type":"string","description":"The request id value for this resource."}},"description":"Standard response envelope: `code` is 0 on success, `message` explains the result, and `data` is a `PageDataCardResponse` object. Null envelope properties are omitted from JSON."},"PageDataCardResponse":{"title":"Card page","required":["items","page","pageSize","total"],"type":"object","properties":{"items":{"type":"array","description":"Resources returned on the current result page.","items":{"$ref":"#/components/schemas/CardResponse"}},"total":{"type":"string","description":"Total number of records matching the filters across all pages."},"page":{"type":"integer","description":"Current one-based result page number.","format":"int32"},"pageSize":{"type":"integer","description":"Maximum records requested for each result page.","format":"int32"}},"description":"Paginated result: `items` is an array of `CardResponse` objects; `total`, `page`, and `pageSize` describe pagination. Every listed property is present in JSON."},"ApiResponsePageDataCardTransactionResponse":{"title":"Card Transaction list response","required":["code","message"],"type":"object","properties":{"code":{"type":"integer","description":"Application result code: 0 means success; a nonzero value identifies an error.","format":"int32"},"message":{"type":"string","description":"Human-readable result message. For errors, use it together with code."},"data":{"$ref":"#/components/schemas/PageDataCardTransactionResponse"},"details":{"type":"array","description":"The details value for this resource.","items":{"$ref":"#/components/schemas/ErrorDetail"}},"requestId":{"type":"string","description":"The request id value for this resource."}},"description":"Standard response envelope: `code` is 0 on success, `message` explains the result, and `data` is a `PageDataCardTransactionResponse` object. Null envelope properties are omitted from JSON."},"PageDataCardTransactionResponse":{"title":"Card Transaction page","required":["items","page","pageSize","total"],"type":"object","properties":{"items":{"type":"array","description":"Resources returned on the current result page.","items":{"$ref":"#/components/schemas/CardTransactionResponse"}},"total":{"type":"string","description":"Total number of records matching the filters across all pages."},"page":{"type":"integer","description":"Current one-based result page number.","format":"int32"},"pageSize":{"type":"integer","description":"Maximum records requested for each result page.","format":"int32"}},"description":"Paginated result: `items` is an array of `CardTransactionResponse` objects; `total`, `page`, and `pageSize` describe pagination. Every listed property is present in JSON."},"ApiResponseListCardProductResponse":{"title":"Card Product list response","required":["code","message"],"type":"object","properties":{"code":{"type":"integer","description":"Application result code: 0 means success; a nonzero value identifies an error.","format":"int32"},"message":{"type":"string","description":"Human-readable result message. For errors, use it together with code."},"data":{"type":"array","description":"An array of `CardProductResponse` objects.","items":{"$ref":"#/components/schemas/CardProductResponse"}},"details":{"type":"array","description":"The details value for this resource.","items":{"$ref":"#/components/schemas/ErrorDetail"}},"requestId":{"type":"string","description":"The request id value for this resource."}},"description":"Standard response envelope: `code` is 0 on success, `message` explains the result, and `data` is an array of `CardProductResponse` objects. Null envelope properties are omitted from JSON."},"CardBinResponse":{"title":"Card Bin","type":"object","properties":{"id":{"type":"string","description":"Stable resource identifier. Treat IDs as opaque strings.","nullable":true},"bin":{"type":"string","description":"The bin value for this resource.","nullable":true},"threeDsRequirement":{"type":"string","description":"The three ds requirement value for this resource.","nullable":true},"cardholderRequirement":{"type":"string","description":"The cardholder requirement value for this resource.","nullable":true},"contactRequired":{"type":"boolean","description":"The contact required value for this resource.","nullable":true},"initialFundingMode":{"type":"string","description":"Initial funding rule for this selected BIN: none = initialAmount must be zero; required = use at least minimumInitialAmount. Quote before issuing.","nullable":true,"enum":["none","required"]},"minimumInitialAmount":{"type":"string","description":"Minimum initial funding for this BIN, as a decimal string in the product currency. Shared-budget cards use zero; confirm the quote before issuing.","nullable":true}},"description":"Fields returned in the operation's `data` property. Optional fields may be null or absent for some records or resource states."},"CardProductResponse":{"title":"Card Product","type":"object","properties":{"id":{"type":"string","description":"Stable resource identifier. Treat IDs as opaque strings.","nullable":true},"code":{"type":"string","description":"Application result code: 0 means success; a nonzero value identifies an error.","nullable":true},"name":{"type":"string","description":"Customer-facing resource or capability name.","nullable":true},"description":{"type":"string","description":"Customer-facing or operational description of the resource.","nullable":true},"currency":{"type":"string","description":"ISO currency or enabled asset code used for monetary values.","nullable":true},"scheme":{"type":"string","description":"Card network scheme.","nullable":true},"minimumInitialAmount":{"type":"string","description":"Minimum initial funding allowed by this product, represented as a decimal string.","nullable":true},"formFactor":{"type":"string","description":"Card form factor: virtual = issued without a physical card. Machine issuing currently returns virtual products.","nullable":true,"enum":["virtual"]},"fundingMode":{"type":"string","description":"Card funding model: prepaid_balance = balance funded on this card; shared_budget = spending from an enterprise card budget. Product values are configuration-dependent; query GET /api/v1/card-products for the current list rather than treating these examples as a complete enum.","nullable":true},"supportedEntityTypes":{"type":"array","description":"Contact entity types eligible for this card product.","nullable":true,"items":{"type":"string"}},"supportedCountries":{"type":"array","description":"ISO 3166-1 alpha-2 residence countries eligible for this card product.","nullable":true,"items":{"type":"string"}},"kycRequired":{"type":"string","description":"Verification level required before issuing, for example kyb_approved.","nullable":true},"availableCards":{"type":"integer","description":"Remaining cards that can be issued from the product inventory; null means not disclosed.","format":"int32","nullable":true},"limits":{"type":"string","description":"Public card spending limits when available; null when undisclosed.","nullable":true},"status":{"type":"string","description":"Product availability: active = eligible for issuing. Only active products with eligible inventory are returned.","nullable":true,"enum":["active"]},"supportsSharedCardQuota":{"type":"boolean","description":"The supports shared card quota value for this resource.","nullable":true},"initialFundingMode":{"type":"string","description":"Initial funding capability: none = must use 0; required = positive funding required; optional = product minimum applies; mixed = quote the requested amount to select an eligible BIN.","nullable":true},"issueCountriesOrRegions":{"type":"array","description":"Issuing countries of eligible BINs, distinct from cardholder supportedCountries. Empty when not yet confirmed.","nullable":true,"items":{"type":"string","description":"Issuing countries of eligible BINs, distinct from cardholder supportedCountries. Empty when not yet confirmed."}},"bins":{"type":"array","description":"The bins value for this resource.","nullable":true,"items":{"$ref":"#/components/schemas/CardBinResponse"}}},"description":"Fields returned in the operation's `data` property. Optional fields may be null or absent for some records or resource states."},"ApiResponseCardProductResponse":{"title":"Card Product API response","required":["code","message"],"type":"object","properties":{"code":{"type":"integer","description":"Application result code: 0 means success; a nonzero value identifies an error.","format":"int32"},"message":{"type":"string","description":"Human-readable result message. For errors, use it together with code."},"data":{"$ref":"#/components/schemas/CardProductResponse"},"details":{"type":"array","description":"The details value for this resource.","items":{"$ref":"#/components/schemas/ErrorDetail"}},"requestId":{"type":"string","description":"The request id value for this resource."}},"description":"Standard response envelope: `code` is 0 on success, `message` explains the result, and `data` is a `CardProductResponse` object. Null envelope properties are omitted from JSON."},"ApiResponseListBudgetResponse":{"title":"Budget list response","required":["code","message"],"type":"object","properties":{"code":{"type":"integer","description":"Application result code: 0 means success; a nonzero value identifies an error.","format":"int32"},"message":{"type":"string","description":"Human-readable result message. For errors, use it together with code."},"data":{"type":"array","description":"An array of `BudgetResponse` objects.","items":{"$ref":"#/components/schemas/BudgetResponse"}},"details":{"type":"array","description":"The details value for this resource.","items":{"$ref":"#/components/schemas/ErrorDetail"}},"requestId":{"type":"string","description":"The request id value for this resource."}},"description":"Standard response envelope: `code` is 0 on success, `message` explains the result, and `data` is an array of `BudgetResponse` objects. Null envelope properties are omitted from JSON."},"ApiResponseBudgetDetailResponse":{"title":"Budget Detail API response","required":["code","message"],"type":"object","properties":{"code":{"type":"integer","description":"Application result code: 0 means success; a nonzero value identifies an error.","format":"int32"},"message":{"type":"string","description":"Human-readable result message. For errors, use it together with code."},"data":{"$ref":"#/components/schemas/BudgetDetailResponse"},"details":{"type":"array","description":"The details value for this resource.","items":{"$ref":"#/components/schemas/ErrorDetail"}},"requestId":{"type":"string","description":"The request id value for this resource."}},"description":"Standard response envelope: `code` is 0 on success, `message` explains the result, and `data` is a `BudgetDetailResponse` object. Null envelope properties are omitted from JSON."},"BudgetDetailResponse":{"title":"Budget Detail","type":"object","properties":{"budget":{"$ref":"#/components/schemas/BudgetResponse"},"accountBound":{"type":"boolean","description":"The account bound value for this resource.","nullable":true},"accountStatus":{"type":"string","description":"The account status value for this resource.","nullable":true},"fundingBlocked":{"type":"boolean","description":"The funding blocked value for this resource.","nullable":true},"restrictionMessage":{"type":"string","description":"The restriction message value for this resource.","nullable":true}},"description":"Fields returned in the operation's `data` property. Optional fields may be null or absent for some records or resource states."},"ApiResponseListBudgetTransferResponse":{"title":"Budget Transfer list response","required":["code","message"],"type":"object","properties":{"code":{"type":"integer","description":"Application result code: 0 means success; a nonzero value identifies an error.","format":"int32"},"message":{"type":"string","description":"Human-readable result message. For errors, use it together with code."},"data":{"type":"array","description":"An array of `BudgetTransferResponse` objects.","items":{"$ref":"#/components/schemas/BudgetTransferResponse"}},"details":{"type":"array","description":"The details value for this resource.","items":{"$ref":"#/components/schemas/ErrorDetail"}},"requestId":{"type":"string","description":"The request id value for this resource."}},"description":"Standard response envelope: `code` is 0 on success, `message` explains the result, and `data` is an array of `BudgetTransferResponse` objects. Null envelope properties are omitted from JSON."},"ApiResponseListBudgetOptionResponse":{"title":"Budget Option list response","required":["code","message"],"type":"object","properties":{"code":{"type":"integer","description":"Application result code: 0 means success; a nonzero value identifies an error.","format":"int32"},"message":{"type":"string","description":"Human-readable result message. For errors, use it together with code."},"data":{"type":"array","description":"An array of `BudgetOptionResponse` objects.","items":{"$ref":"#/components/schemas/BudgetOptionResponse"}},"details":{"type":"array","description":"The details value for this resource.","items":{"$ref":"#/components/schemas/ErrorDetail"}},"requestId":{"type":"string","description":"The request id value for this resource."}},"description":"Standard response envelope: `code` is 0 on success, `message` explains the result, and `data` is an array of `BudgetOptionResponse` objects. Null envelope properties are omitted from JSON."},"BudgetOptionResponse":{"title":"Budget Option","type":"object","properties":{"currency":{"type":"string","description":"ISO currency or enabled asset code used for monetary values.","nullable":true}},"description":"Fields returned in the operation's `data` property. Optional fields may be null or absent for some records or resource states."},"ApiResponsePageDataCardApplicationResponse":{"title":"Card Application list response","required":["code","message"],"type":"object","properties":{"code":{"type":"integer","description":"Application result code: 0 means success; a nonzero value identifies an error.","format":"int32"},"message":{"type":"string","description":"Human-readable result message. For errors, use it together with code."},"data":{"$ref":"#/components/schemas/PageDataCardApplicationResponse"},"details":{"type":"array","description":"The details value for this resource.","items":{"$ref":"#/components/schemas/ErrorDetail"}},"requestId":{"type":"string","description":"The request id value for this resource."}},"description":"Standard response envelope: `code` is 0 on success, `message` explains the result, and `data` is a `PageDataCardApplicationResponse` object. Null envelope properties are omitted from JSON."},"PageDataCardApplicationResponse":{"title":"Card Application page","required":["items","page","pageSize","total"],"type":"object","properties":{"items":{"type":"array","description":"Resources returned on the current result page.","items":{"$ref":"#/components/schemas/CardApplicationResponse"}},"total":{"type":"string","description":"Total number of records matching the filters across all pages."},"page":{"type":"integer","description":"Current one-based result page number.","format":"int32"},"pageSize":{"type":"integer","description":"Maximum records requested for each result page.","format":"int32"}},"description":"Paginated result: `items` is an array of `CardApplicationResponse` objects; `total`, `page`, and `pageSize` describe pagination. Every listed property is present in JSON."},"ApiResponseListBlockchainAddressResponse":{"title":"Blockchain Address list response","required":["code","message"],"type":"object","properties":{"code":{"type":"integer","description":"Application result code: 0 means success; a nonzero value identifies an error.","format":"int32"},"message":{"type":"string","description":"Human-readable result message. For errors, use it together with code."},"data":{"type":"array","description":"An array of `BlockchainAddressResponse` objects.","items":{"$ref":"#/components/schemas/BlockchainAddressResponse"}},"details":{"type":"array","description":"The details value for this resource.","items":{"$ref":"#/components/schemas/ErrorDetail"}},"requestId":{"type":"string","description":"The request id value for this resource."}},"description":"Standard response envelope: `code` is 0 on success, `message` explains the result, and `data` is an array of `BlockchainAddressResponse` objects. Null envelope properties are omitted from JSON."},"ApiResponseListBankOptionResponse":{"title":"Bank Option list response","required":["code","message"],"type":"object","properties":{"code":{"type":"integer","description":"Application result code: 0 means success; a nonzero value identifies an error.","format":"int32"},"message":{"type":"string","description":"Human-readable result message. For errors, use it together with code."},"data":{"type":"array","description":"An array of `BankOptionResponse` objects.","items":{"$ref":"#/components/schemas/BankOptionResponse"}},"details":{"type":"array","description":"The details value for this resource.","items":{"$ref":"#/components/schemas/ErrorDetail"}},"requestId":{"type":"string","description":"The request id value for this resource."}},"description":"Standard response envelope: `code` is 0 on success, `message` explains the result, and `data` is an array of `BankOptionResponse` objects. Null envelope properties are omitted from JSON."},"BankOptionResponse":{"title":"Bank Option","type":"object","properties":{"id":{"type":"string","description":"Stable resource identifier. Treat IDs as opaque strings.","nullable":true},"name":{"type":"string","description":"Customer-facing resource or capability name.","nullable":true},"countryCode":{"type":"string","description":"ISO 3166-1 alpha-2 country code.","nullable":true},"region":{"type":"string","description":"Country or region of the bank receiving account.","nullable":true},"currencies":{"type":"array","description":"Dynamic currencies accepted by this bank; use these values in a bank application.","nullable":true,"items":{"type":"string","description":"Dynamic currencies accepted by this bank; use these values in a bank application."}},"purposes":{"type":"array","description":"Dynamic bank application purposes; use one value in a bank application.","nullable":true,"items":{"type":"string","description":"Dynamic bank application purposes; use one value in a bank application."}},"eligibleRegistrationCountries":{"type":"array","description":"The eligible registration countries value for this resource.","nullable":true,"items":{"type":"string"}},"requiredKybMaterials":{"type":"array","description":"The required kyb materials value for this resource.","nullable":true,"items":{"type":"string"}},"eligible":{"type":"boolean","description":"The eligible value for this resource.","nullable":true},"missingKybMaterials":{"type":"array","description":"The missing kyb materials value for this resource.","nullable":true,"items":{"type":"string"}},"requirements":{"type":"array","description":"The requirements value for this resource.","nullable":true,"items":{"$ref":"#/components/schemas/Requirement"}},"applicationDocuments":{"type":"array","description":"The application documents value for this resource.","nullable":true,"items":{"$ref":"#/components/schemas/Requirement"}},"requirementsVersion":{"type":"string","description":"Opaque current bank-requirements version to echo in POST /api/v1/bank-account-applications. Dynamic; requery before applying.","nullable":true},"eligiblePeople":{"type":"array","description":"The eligible people value for this resource.","nullable":true,"items":{"$ref":"#/components/schemas/Person"}}},"description":"Fields returned in the operation's `data` property. Optional fields may be null or absent for some records or resource states."},"Person":{"title":"Person","type":"object","properties":{"id":{"type":"string","description":"Stable resource identifier. Treat IDs as opaque strings.","nullable":true},"name":{"type":"string","description":"Customer-facing resource or capability name.","nullable":true},"roles":{"type":"array","description":"The roles value for this resource.","nullable":true,"items":{"type":"string"}},"hasHandheld":{"type":"boolean","description":"The has handheld value for this resource.","nullable":true}},"description":"Data model used by the machine REST API."},"Requirement":{"title":"Requirement","type":"object","properties":{"code":{"type":"string","description":"Application result code: 0 means success; a nonzero value identifies an error.","nullable":true},"label":{"type":"string","description":"Customer-facing label for the contact destination account.","nullable":true},"minCount":{"type":"integer","description":"The min count value for this resource.","format":"int32","nullable":true},"maxCount":{"type":"integer","description":"The max count value for this resource.","format":"int32","nullable":true},"mimeTypes":{"type":"array","description":"The mime types value for this resource.","nullable":true,"items":{"type":"string"}},"maxAgeDays":{"type":"integer","description":"The max age days value for this resource.","format":"int32","nullable":true},"expiryDateRequired":{"type":"boolean","description":"The expiry date required value for this resource.","nullable":true}},"description":"Data model used by the machine REST API."},"ApiResponseBankOptionResponse":{"title":"Bank Option API response","required":["code","message"],"type":"object","properties":{"code":{"type":"integer","description":"Application result code: 0 means success; a nonzero value identifies an error.","format":"int32"},"message":{"type":"string","description":"Human-readable result message. For errors, use it together with code."},"data":{"$ref":"#/components/schemas/BankOptionResponse"},"details":{"type":"array","description":"The details value for this resource.","items":{"$ref":"#/components/schemas/ErrorDetail"}},"requestId":{"type":"string","description":"The request id value for this resource."}},"description":"Standard response envelope: `code` is 0 on success, `message` explains the result, and `data` is a `BankOptionResponse` object. Null envelope properties are omitted from JSON."},"ApiResponseListBankAccountResponse":{"title":"Bank Account list response","required":["code","message"],"type":"object","properties":{"code":{"type":"integer","description":"Application result code: 0 means success; a nonzero value identifies an error.","format":"int32"},"message":{"type":"string","description":"Human-readable result message. For errors, use it together with code."},"data":{"type":"array","description":"An array of `BankAccountResponse` objects.","items":{"$ref":"#/components/schemas/BankAccountResponse"}},"details":{"type":"array","description":"The details value for this resource.","items":{"$ref":"#/components/schemas/ErrorDetail"}},"requestId":{"type":"string","description":"The request id value for this resource."}},"description":"Standard response envelope: `code` is 0 on success, `message` explains the result, and `data` is an array of `BankAccountResponse` objects. Null envelope properties are omitted from JSON."},"BankAccountResponse":{"title":"Bank Account","required":["accountNumber","id","status"],"type":"object","properties":{"id":{"type":"string","description":"Stable resource identifier. Treat IDs as opaque strings."},"region":{"type":"string","description":"Country or region of the bank receiving account.","nullable":true},"bankName":{"type":"string","description":"Bank display name.","nullable":true},"bankCode":{"type":"string","description":"Bank, institution or clearing code.","nullable":true},"bankBranch":{"type":"string","description":"Bank branch name.","nullable":true},"branchCode":{"type":"string","description":"Bank branch code.","nullable":true},"bankAddress":{"type":"string","description":"Postal address of the bank or branch.","nullable":true},"accountNumber":{"type":"string","description":"Bank account number or IBAN."},"accountHolder":{"type":"string","description":"Legal name of the bank account holder.","nullable":true},"swiftCode":{"type":"string","description":"SWIFT/BIC used for international bank routing.","nullable":true},"routingCode":{"type":"string","description":"Bank routing or clearing code.","nullable":true},"routingCodeType":{"type":"string","description":"Dynamic bank routing-code type supplied by the account provider; common examples include swift, aba, iban, sort_code and bsb. May be null. Inspect GET /api/v1/bank-accounts for the actual value of each issued account.","nullable":true},"localClearingNetwork":{"type":"string","description":"Bank-specific local clearing network. Dynamic and possibly null; inspect GET /api/v1/bank-accounts for the actual account rather than inferring from bank country.","nullable":true},"currencies":{"type":"array","description":"Currencies enabled for this issued bank account. Dynamic; returned by GET /api/v1/bank-accounts.","nullable":true,"items":{"type":"string","description":"Currencies enabled for this issued bank account. Dynamic; returned by GET /api/v1/bank-accounts."}},"status":{"type":"string","description":"Receiving-account state: active = available for invoices; inactive = unavailable for new invoices. Default on activation: active. Neither value is a final payment outcome.","enum":["active","inactive"]},"createdAt":{"type":"string","description":"UTC date-time when the resource was created.","format":"date-time","nullable":true}},"description":"Fields returned in the operation's `data` property. Optional fields may be null or absent for some records or resource states."},"ApiResponseBankAccountResponse":{"title":"Bank Account API response","required":["code","message"],"type":"object","properties":{"code":{"type":"integer","description":"Application result code: 0 means success; a nonzero value identifies an error.","format":"int32"},"message":{"type":"string","description":"Human-readable result message. For errors, use it together with code."},"data":{"$ref":"#/components/schemas/BankAccountResponse"},"details":{"type":"array","description":"The details value for this resource.","items":{"$ref":"#/components/schemas/ErrorDetail"}},"requestId":{"type":"string","description":"The request id value for this resource."}},"description":"Standard response envelope: `code` is 0 on success, `message` explains the result, and `data` is a `BankAccountResponse` object. Null envelope properties are omitted from JSON."},"ApiResponsePageDataApplicationResponse":{"title":"Application list response","required":["code","message"],"type":"object","properties":{"code":{"type":"integer","description":"Application result code: 0 means success; a nonzero value identifies an error.","format":"int32"},"message":{"type":"string","description":"Human-readable result message. For errors, use it together with code."},"data":{"$ref":"#/components/schemas/PageDataApplicationResponse"},"details":{"type":"array","description":"The details value for this resource.","items":{"$ref":"#/components/schemas/ErrorDetail"}},"requestId":{"type":"string","description":"The request id value for this resource."}},"description":"Standard response envelope: `code` is 0 on success, `message` explains the result, and `data` is a `PageDataApplicationResponse` object. Null envelope properties are omitted from JSON."},"PageDataApplicationResponse":{"title":"Application page","required":["items","page","pageSize","total"],"type":"object","properties":{"items":{"type":"array","description":"Resources returned on the current result page.","items":{"$ref":"#/components/schemas/ApplicationResponse"}},"total":{"type":"string","description":"Total number of records matching the filters across all pages."},"page":{"type":"integer","description":"Current one-based result page number.","format":"int32"},"pageSize":{"type":"integer","description":"Maximum records requested for each result page.","format":"int32"}},"description":"Paginated result: `items` is an array of `ApplicationResponse` objects; `total`, `page`, and `pageSize` describe pagination. Every listed property is present in JSON."},"ApiResponseListAssetResponse":{"title":"Asset list response","required":["code","message"],"type":"object","properties":{"code":{"type":"integer","description":"Application result code: 0 means success; a nonzero value identifies an error.","format":"int32"},"message":{"type":"string","description":"Human-readable result message. For errors, use it together with code."},"data":{"type":"array","description":"An array of `AssetResponse` objects.","items":{"$ref":"#/components/schemas/AssetResponse"}},"details":{"type":"array","description":"The details value for this resource.","items":{"$ref":"#/components/schemas/ErrorDetail"}},"requestId":{"type":"string","description":"The request id value for this resource."}},"description":"Standard response envelope: `code` is 0 on success, `message` explains the result, and `data` is an array of `AssetResponse` objects. Null envelope properties are omitted from JSON."},"AssetResponse":{"title":"Asset","type":"object","properties":{"currency":{"type":"string","description":"ISO currency or enabled asset code used for monetary values.","nullable":true},"assetType":{"type":"string","description":"Asset class: fiat = government-issued currency; crypto = blockchain asset.","nullable":true,"enum":["fiat","crypto"]},"network":{"type":"string","description":"Enabled blockchain network; null for fiat-only resources.","nullable":true},"networkType":{"type":"string","description":"Blockchain family or protocol type.","nullable":true},"tokenStandard":{"type":"string","description":"Token standard on the selected blockchain network; null for native assets.","nullable":true},"contractAddress":{"type":"string","description":"Token contract address; null for native or fiat assets.","nullable":true},"decimals":{"type":"integer","description":"Number of decimal places supported by the asset.","format":"int32","nullable":true},"capabilities":{"type":"array","description":"Operations currently supported by this asset or account.","nullable":true,"items":{"type":"string"}},"status":{"type":"string","description":"Availability: active = enabled in this environment. Only active assets are returned by these endpoints.","nullable":true,"enum":["active"]}},"description":"Fields returned in the operation's `data` property. Optional fields may be null or absent for some records or resource states."},"AgentTaskEventResponse":{"title":"Agent Task Event","type":"object","properties":{"id":{"type":"string","description":"Stable resource identifier. Treat IDs as opaque strings.","nullable":true},"type":{"type":"string","description":"Task event name: task.created = created; task.waiting_authorization = awaiting user authorization; task.authorized = authorized; task.running = executing; task.waiting_approval = approval pending; task.completed = succeeded; task.failed = failed; task.cancelled = cancelled. The final three correspond to terminal task states.","nullable":true,"enum":["task.created","task.waiting_authorization","task.authorized","task.running","task.waiting_approval","task.completed","task.failed","task.cancelled"]},"previousStatus":{"type":"string","description":"Task state before the event: created = saved; waiting_authorization = awaiting user; authorized = ready to run; running = executing; waiting_approval = awaiting workflow approval; completed = success (terminal); failed = failure (terminal); cancelled = stopped (terminal).","nullable":true,"enum":["created","waiting_authorization","authorized","running","waiting_approval","completed","failed","cancelled"]},"currentStatus":{"type":"string","description":"Task state after the event: created = saved; waiting_authorization = awaiting user; authorized = ready to run; running = executing; waiting_approval = awaiting workflow approval; completed = success (terminal); failed = failure (terminal); cancelled = stopped (terminal).","nullable":true,"enum":["created","waiting_authorization","authorized","running","waiting_approval","completed","failed","cancelled"]},"createdAt":{"type":"string","description":"UTC date-time when the resource was created.","format":"date-time","nullable":true}},"description":"Fields returned in the operation's `data` property. Optional fields may be null or absent for some records or resource states."},"ApiResponseListAgentTaskEventResponse":{"title":"Agent Task Event list response","required":["code","message"],"type":"object","properties":{"code":{"type":"integer","description":"Application result code: 0 means success; a nonzero value identifies an error.","format":"int32"},"message":{"type":"string","description":"Human-readable result message. For errors, use it together with code."},"data":{"type":"array","description":"An array of `AgentTaskEventResponse` objects.","items":{"$ref":"#/components/schemas/AgentTaskEventResponse"}},"details":{"type":"array","description":"The details value for this resource.","items":{"$ref":"#/components/schemas/ErrorDetail"}},"requestId":{"type":"string","description":"The request id value for this resource."}},"description":"Standard response envelope: `code` is 0 on success, `message` explains the result, and `data` is an array of `AgentTaskEventResponse` objects. Null envelope properties are omitted from JSON."},"AgentCapabilityResponse":{"title":"Agent Capability","type":"object","properties":{"code":{"type":"string","description":"Application result code: 0 means success; a nonzero value identifies an error.","nullable":true},"name":{"type":"string","description":"Customer-facing resource or capability name.","nullable":true},"description":{"type":"string","description":"Customer-facing or operational description of the resource.","nullable":true},"riskLevel":{"type":"string","description":"Risk classification assigned to the Treasury Agent capability.","nullable":true},"category":{"type":"string","description":"Functional category of the Treasury Agent capability.","nullable":true},"readOnly":{"type":"boolean","description":"Whether the capability is guaranteed not to create or mutate business data.","nullable":true},"requiresAuthorization":{"type":"boolean","description":"Whether explicit user authorization is required before execution.","nullable":true},"requiresApproval":{"type":"boolean","description":"Whether completion may require an approval workflow.","nullable":true},"idempotencyRequired":{"type":"boolean","description":"Whether task creation or execution requires an idempotency key.","nullable":true}},"description":"Fields returned in the operation's `data` property. Optional fields may be null or absent for some records or resource states."},"ApiResponseListAgentCapabilityResponse":{"title":"Agent Capability list response","required":["code","message"],"type":"object","properties":{"code":{"type":"integer","description":"Application result code: 0 means success; a nonzero value identifies an error.","format":"int32"},"message":{"type":"string","description":"Human-readable result message. For errors, use it together with code."},"data":{"type":"array","description":"An array of `AgentCapabilityResponse` objects.","items":{"$ref":"#/components/schemas/AgentCapabilityResponse"}},"details":{"type":"array","description":"The details value for this resource.","items":{"$ref":"#/components/schemas/ErrorDetail"}},"requestId":{"type":"string","description":"The request id value for this resource."}},"description":"Standard response envelope: `code` is 0 on success, `message` explains the result, and `data` is an array of `AgentCapabilityResponse` objects. Null envelope properties are omitted from JSON."},"AccountResponse":{"title":"Account","type":"object","properties":{"id":{"type":"string","description":"Stable resource identifier. Treat IDs as opaque strings.","nullable":true},"assetType":{"type":"string","description":"Asset class: fiat = government-issued currency; crypto = blockchain asset.","nullable":true,"enum":["fiat","crypto"]},"accountType":{"type":"string","description":"Account role: funding = fiat funding account; asset = blockchain asset balance.","nullable":true,"enum":["funding","asset"]},"currency":{"type":"string","description":"ISO currency or enabled asset code used for monetary values.","nullable":true},"network":{"type":"string","description":"Enabled blockchain network; null for fiat-only resources.","nullable":true},"availableBalance":{"type":"string","description":"Balance currently available for new operations, represented as a decimal string.","nullable":true},"lockedBalance":{"type":"string","description":"Balance reserved by in-progress operations, represented as a decimal string.","nullable":true},"pendingBalance":{"type":"string","description":"Balance awaiting settlement or confirmation, represented as a decimal string.","nullable":true},"status":{"type":"string","description":"Account state: active = usable; frozen = blocked by a control or regulatory order; inactive = unavailable for new operations. These describe current availability; there is no terminal account outcome in this field.","nullable":true,"enum":["active","frozen","inactive"]},"capabilities":{"type":"array","description":"Operations currently supported by this asset or account.","nullable":true,"items":{"type":"string"}},"updatedAt":{"type":"string","description":"UTC date-time when the resource was most recently updated.","format":"date-time","nullable":true}},"description":"Fields returned in the operation's `data` property. Optional fields may be null or absent for some records or resource states."},"ApiResponseListAccountResponse":{"title":"Account list response","required":["code","message"],"type":"object","properties":{"code":{"type":"integer","description":"Application result code: 0 means success; a nonzero value identifies an error.","format":"int32"},"message":{"type":"string","description":"Human-readable result message. For errors, use it together with code."},"data":{"type":"array","description":"An array of `AccountResponse` objects.","items":{"$ref":"#/components/schemas/AccountResponse"}},"details":{"type":"array","description":"The details value for this resource.","items":{"$ref":"#/components/schemas/ErrorDetail"}},"requestId":{"type":"string","description":"The request id value for this resource."}},"description":"Standard response envelope: `code` is 0 on success, `message` explains the result, and `data` is an array of `AccountResponse` objects. Null envelope properties are omitted from JSON."},"ApiResponseAccountResponse":{"title":"Account API response","required":["code","message"],"type":"object","properties":{"code":{"type":"integer","description":"Application result code: 0 means success; a nonzero value identifies an error.","format":"int32"},"message":{"type":"string","description":"Human-readable result message. For errors, use it together with code."},"data":{"$ref":"#/components/schemas/AccountResponse"},"details":{"type":"array","description":"The details value for this resource.","items":{"$ref":"#/components/schemas/ErrorDetail"}},"requestId":{"type":"string","description":"The request id value for this resource."}},"description":"Standard response envelope: `code` is 0 on success, `message` explains the result, and `data` is a `AccountResponse` object. Null envelope properties are omitted from JSON."},"AccountTransactionResponse":{"title":"Account Transaction","type":"object","properties":{"id":{"type":"string","description":"Stable resource identifier. Treat IDs as opaque strings.","nullable":true},"type":{"type":"string","description":"Ledger event code. This is an extensible value rather than a closed enum; reuse an exact value returned here when filtering transactions.","nullable":true},"direction":{"type":"string","description":"Balance effect: credit increases the account balance; debit decreases it.","nullable":true,"enum":["credit","debit"]},"amount":{"type":"string","description":"Decimal monetary amount represented as a string to preserve precision.","nullable":true},"currency":{"type":"string","description":"ISO currency or enabled asset code used for monetary values.","nullable":true},"balanceBefore":{"type":"string","description":"Account balance before the transaction, represented as a decimal string.","nullable":true},"balanceAfter":{"type":"string","description":"Account or card balance after the transaction, represented as a decimal string.","nullable":true},"status":{"type":"string","description":"Posting state: confirmed = final and posted. Account ledger rows returned by this API are final.","nullable":true,"enum":["confirmed"]},"referenceType":{"type":"string","description":"Domain object that created the ledger entry. This is an extensible value; use it with referenceId for reconciliation.","nullable":true},"referenceId":{"type":"string","description":"Related platform resource ID; keep IDs as strings.","nullable":true},"createdAt":{"type":"string","description":"UTC date-time when the resource was created.","format":"date-time","nullable":true}},"description":"Fields returned in the operation's `data` property. Optional fields may be null or absent for some records or resource states."},"ApiResponsePageDataAccountTransactionResponse":{"title":"Account Transaction list response","required":["code","message"],"type":"object","properties":{"code":{"type":"integer","description":"Application result code: 0 means success; a nonzero value identifies an error.","format":"int32"},"message":{"type":"string","description":"Human-readable result message. For errors, use it together with code."},"data":{"$ref":"#/components/schemas/PageDataAccountTransactionResponse"},"details":{"type":"array","description":"The details value for this resource.","items":{"$ref":"#/components/schemas/ErrorDetail"}},"requestId":{"type":"string","description":"The request id value for this resource."}},"description":"Standard response envelope: `code` is 0 on success, `message` explains the result, and `data` is a `PageDataAccountTransactionResponse` object. Null envelope properties are omitted from JSON."},"PageDataAccountTransactionResponse":{"title":"Account Transaction page","required":["items","page","pageSize","total"],"type":"object","properties":{"items":{"type":"array","description":"Resources returned on the current result page.","items":{"$ref":"#/components/schemas/AccountTransactionResponse"}},"total":{"type":"string","description":"Total number of records matching the filters across all pages."},"page":{"type":"integer","description":"Current one-based result page number.","format":"int32"},"pageSize":{"type":"integer","description":"Maximum records requested for each result page.","format":"int32"}},"description":"Paginated result: `items` is an array of `AccountTransactionResponse` objects; `total`, `page`, and `pageSize` describe pagination. Every listed property is present in JSON."},"ApiResponseAccountTransactionResponse":{"title":"Account Transaction API response","required":["code","message"],"type":"object","properties":{"code":{"type":"integer","description":"Application result code: 0 means success; a nonzero value identifies an error.","format":"int32"},"message":{"type":"string","description":"Human-readable result message. For errors, use it together with code."},"data":{"$ref":"#/components/schemas/AccountTransactionResponse"},"details":{"type":"array","description":"The details value for this resource.","items":{"$ref":"#/components/schemas/ErrorDetail"}},"requestId":{"type":"string","description":"The request id value for this resource."}},"description":"Standard response envelope: `code` is 0 on success, `message` explains the result, and `data` is a `AccountTransactionResponse` object. Null envelope properties are omitted from JSON."},"WebhookEventPayload":{"title":"Webhook Event Payload","required":["createdAt","data","environment","eventId","eventType","eventVersion","idempotencyKey","workspaceType"],"type":"object","properties":{"eventId":{"type":"string","description":"Stable event identifier, reused across delivery attempts."},"eventType":{"type":"string","description":"Dynamic event name, for example transfer.succeeded or payment.settled. GET /api/v1/webhook-endpoints/event-types lists the currently supported sandbox test event names; subscriptions may use supported prefix patterns."},"eventVersion":{"type":"string","description":"Payload version: 1 = initial event contract (current version).","enum":["1"]},"createdAt":{"type":"string","description":"Event creation instant in ISO-8601 UTC format."},"environment":{"type":"string","description":"Key environment: sandbox = isolated test data; live = production data.","enum":["sandbox","live"]},"workspaceType":{"type":"string","description":"Workspace that owns the event: personal = the user workspace; enterprise = the identified enterprise workspace.","enum":["personal","enterprise"]},"enterpriseId":{"type":"string","description":"Enterprise ID for enterprise events; null for personal events. Included in the signed JSON body.","nullable":true},"idempotencyKey":{"type":"string","description":"Same stable value as eventId; deduplicate processing by this value."},"resourceType":{"type":"string","description":"Business resource type; omitted for agent task events. Dynamic by eventType.","nullable":true},"resourceId":{"type":"string","description":"Business resource ID; omitted for agent task events.","nullable":true},"taskId":{"type":"string","description":"Agent task ID; omitted for business events.","nullable":true},"capability":{"type":"string","description":"Agent capability; omitted for business events.","nullable":true},"previousStatus":{"type":"string","description":"Previous state of the corresponding resource; null on initial events. Values follow that resource's response status enum.","nullable":true},"currentStatus":{"type":"string","description":"Current state of the corresponding resource. Values follow that resource's response status enum; consult the matching GET endpoint for terminal states.","nullable":true},"data":{"type":"object","additionalProperties":{"type":"object","description":"Event-specific public fields. Dynamic by eventType; no universal fixed schema."},"description":"Event-specific public fields. Dynamic by eventType; no universal fixed schema."},"test":{"type":"boolean","description":"True for a sandbox test event; otherwise omitted.","nullable":true},"manualDispatch":{"type":"boolean","description":"True when an administrator manually dispatched this event; otherwise omitted.","nullable":true}},"description":"Signed JSON delivered to the registered callback URL. Verify X-Webhook-Signature as HMAC-SHA256(secret, X-Webhook-Timestamp + '.' + exact raw body). enterpriseId and workspaceType are inside the signed body; X-Workspace repeats the workspace for routing. Retry the same eventId idempotently. Business events use resourceType/resourceId; agent task events use taskId/capability. The data object and lifecycle statuses depend on eventType."}},"securitySchemes":{"apiKeyAuth":{"type":"apiKey","description":"API key from Dashboard > Developer Center. The sk_sandbox_ or sk_live_ prefix selects the isolated environment; the production API host accepts both modes.","name":"X-API-Key","in":"header"}}}}