> ## Documentation Index > Fetch the complete documentation index at: https://docs.dakota.xyz/llms.txt > Use this file to discover all available pages before exploring further. # Create a card > Create a card for a cardholder, drawing on the given wallet, gated on the cards capability being available. The card is created synchronously and returns in `pending` status, then transitions to `active` via a `card.updated` webhook. **Sandbox only.** This endpoint is available in sandbox only while we finish development. It is not available in production yet, and its request and response shapes may change before release. ## OpenAPI ````yaml /openapi.yaml post /customers/{customer_id}/cards openapi: 3.0.3 info: title: Dakota Platform API version: 1.0.0 description: >- Combined API specification for Dakota Platform services: - Issuance API: Asset minting and burning operations - Onboarding API: Know Your Business/Customer verification - On/Off Ramp API: Managing on-ramp and off-ramp accounts - Recipients API: Managing destinations for KYB'd entities - Transactions API: Viewing transaction history across platform operations ## Authentication and API Headers All API endpoints require the following headers: - `X-Idempotency-Key`: Required for all POST endpoints to ensure request idempotency - `x-api-key`: Required for authentication across all endpoints Note: On /applications endpoints you need a token for authentication instead of a x-api-key - `x-application-token`: Required for authentication on public /applications endpoints (alternative to `x-api-key` where documented) ## Rate Limits Requests are rate limited per API key. Every response includes the following headers: | Header | Description | | --- | --- | | `X-RateLimit-Limit` | Maximum requests allowed in the current one-minute window. | | `X-RateLimit-Remaining` | Requests remaining in the current window. | | `X-RateLimit-Reset` | Absolute Unix timestamp (seconds since epoch) when the current rate-limit window resets. | When a request is throttled (`429`), responses also include `Retry-After` with seconds to wait before retrying. servers: - url: https://api.platform.dakota.xyz description: Production environment - url: https://api.platform.sandbox.dakota.xyz description: Sandbox — safe for testing with simulated data security: - ApiKeyAuth: [] tags: - name: Agentic Payments x-beta: true description: >- Beta — agent-driven payments: provision agents, draft and approve spending mandates, accept reviewed instructions, and manage scheduled payments. **Prerequisites:** Customer onboarded; signer groups attached for recognition. **Related:** Wallets, Signer Groups, Transactions - name: Mandates x-beta: true description: >- Beta — spending mandates: signed, signer-bound authorizations governing what may be spent, approved or cancelled by a second recognized signer (§8 — the dual-control rule that every mandate mutation must be signed by a recognized signer OTHER than the bound one). Independent of agents and scheduled payments. **Prerequisites:** Signer groups attached for recognition. **Related:** Signer Groups, Transactions - name: Insights x-beta: true description: >- Beta — read-only insight: a deterministic report over a customer's agentic activity (funding balances, upcoming obligations, failures, mandate headroom and expiry), or — via `GET /insights` — over the whole client's book, with portfolio KPIs, daily series and a per-customer roll-up. Never moves money, never creates or changes anything. **Prerequisites:** Customer onboarded; insight is computed from the customer's scheduled payments, mandates, and wallets. **Related:** Agentic Payments, Mandates - name: Customers description: >- Manage customer entities representing businesses and organizations onboarded to Dakota. **Prerequisites:** Complete KYB via Onboarding endpoints before initiating money movement. **Related:** Onboarding, Recipients, Transactions, Accounts, Wallets - name: Wallets description: >- Manage wallets, balances, and wallet-to-signer-group relationships for custody and movement controls. **Prerequisites:** Customer must exist. Configure signer groups before policy-enforced workflows. **Related:** Signer Groups, Policies, Transactions, Customers - name: Transactions description: >- Create, cancel, and retrieve transaction records across account and wallet flows. **Prerequisites:** Accounts or destinations must be configured based on flow type. **Related:** Accounts, Recipients, Policies, Events - name: Recipients description: >- Manage recipient entities and destination rails used by customers for payouts and transfers. **Prerequisites:** Customer must be onboarded and active. **Related:** Customers, Transactions, Accounts, Onboarding - name: Cards description: >- Issue and manage cardholders and cards, and follow card transactions. Every change is also delivered as a webhook event. **Prerequisites:** Customer must be onboarded and the cards capability must be available. **Related:** Customers, Wallets, Events ### Webhook event catalog (v1) Every card-family event a client can subscribe to, in one place: | Event | Fires when | | -- | -- | | `cardholder.created` | A cardholder is created. | | `cardholder.updated` | Any cardholder change, including every review-status transition and deletion (`status: closed`). | | `cardholder.information_requested` | A reviewer asks for more information; the payload lists the open requirements. Not yet emitted; the review pipeline that opens a request for information is still to land. | | `card.created` | A card is created. | | `card.updated` | Any card change: status, spend limit, last4, freeze sources. A close arrives here with `status: closed`. | | `card_transaction.created` | The first event for a transaction, normally an authorization (`status: authorized`) placing a hold. A declined authorization also arrives here, with `status: declined`. | | `card_transaction.updated` | Every later change to the same transaction (see below). | | `wallet.card_enablement.completed` | A wallet's card-settlement enablement became active. | **Card event ordering.** `card.created` and `card.updated` carry the card as it stands after the change, including `version` and `freeze_sources` (always an array, empty when nothing holds the card). `version` is strictly increasing per card and matches the `version` on the card resource. Deliveries can arrive out of order, so keep the highest `version` you have applied for each card and drop any event whose `version` is not greater than it. **One transaction stream.** Holds, releases, partial clearings, settlement, returns, disputes and force posts are not separate event types. They are `status` transitions on the transaction, delivered as `card_transaction.updated` with the same payload shape as `card_transaction.created`: | What happened | `status` on the event | | -- | -- | | Transaction known before its first authorization event | `pending` (on `card_transaction.created`) | | Hold placed (authorization) | `authorized` (on `card_transaction.created`, or `card_transaction.updated` after a `pending` start) | | Hold released without clearing (merchant, issuer or network reversal) | `auth_reversed` | | Hold expired unused | `expired` | | Part of the hold settled | `partially_cleared` (with the new `cleared_amount`) | | Fully settled | `cleared` | | Settled with no prior hold | `force_posted` | | Merchant refund | `returned`, on a new card transaction for the refund; the original purchase stays `cleared`. The network returned the money; read `refund_state` for whether it reached the customer's wallet (`pending` then `paid`). `returned` alone is not proof of payout. | | Chargeback opened | `disputed` (reserved; not emitted yet) | | Authorization refused | `declined` (on `card_transaction.created`, or `card_transaction.updated` when the transaction already exists). Moves no money; read `decline_reason` and `decline_code` for why. | `outstanding_amount` is the part of `cleared_amount` that no authorization covered, less any refunds: non-zero after a force post or an over-capture. **Naming.** A dotted segment names a sub-resource of the resource before it, so `wallet.card_enablement.*` is a wallet's card enablement. `card_transaction.*` carries an underscore because the resource is `card_transactions`, a top-level resource, not a sub-resource of a card. It is not a typo, and there is no `card.transaction.*` family, and no separate settlement event: settlement is a `status` on `card_transaction.updated`. - name: Accounts description: >- Manage account resources used for onramp, offramp, and swap operations. **Prerequisites:** Customer must be created and network/asset constraints must be known. **Related:** Customers, Transactions, Auto Transactions, Info - name: Auto Transactions description: >- Manage automated transaction configurations and execution history for account automation workflows. **Prerequisites:** Source account must exist and be configured for automation. **Related:** Accounts, Transactions, Events - name: Onboarding description: >- Manage KYB/KYC onboarding lifecycle, application documents, attestations, and verification steps. **Prerequisites:** Customer context and required entity/application metadata. **Related:** Customers, Exceptions, Recipients, Transactions - name: Policies description: >- Define and manage policy objects and rules used for transaction governance and risk controls. **Prerequisites:** Wallet and signer group resources should be configured for enforcement scenarios. **Related:** Wallets, Signer Groups, Transactions - name: Signer Groups description: >- Manage signer groups and signer assignments for multi-party authorization models. **Prerequisites:** Wallets should exist before linking signer groups. **Related:** Wallets, Policies, Transactions - name: Authentication description: >- Manage API authentication credentials and key lifecycle for platform access. **Prerequisites:** Client organization must be provisioned. **Related:** Users, Info - name: Users description: >- Manage client users, roles, and identity metadata for platform access control. **Prerequisites:** Auth credentials and client context must be established. **Related:** Authentication - name: Webhooks description: >- Manage outbound webhook targets and delivery configuration for event notifications. **Prerequisites:** Subscriber endpoint must be reachable and secured. **Related:** Events, Authentication - name: Payouts description: >- Manage where Dakota sends your accrued developer-fee payouts. **Prerequisites:** Auth credentials and client context must be established. **Related:** Events - name: RD Marketing Fee description: >- Everything behind your RD marketing fee: read what a month came to, declare the wallets you hold outside Dakota so the RD in them counts, and say where the fee should be sent. **Prerequisites:** Client must be in the RD marketing-fee programme. A month is readable once it has closed. **Related:** Wallets, Events - name: Self Serve description: >- Buy and track prepaid credits, and read the tiers and pricing they are sold at. **Prerequisites:** Auth credentials and client context must be established. **Related:** Billing - name: Events description: >- Retrieve event records emitted by platform operations for audit and troubleshooting. **Prerequisites:** Requesting client must have access to referenced resources. **Related:** Webhooks, Transactions, Onboarding - name: Info description: >- Read platform capability metadata, such as supported rails, networks, and assets. These operations are served under `/capabilities/*` - `GET /capabilities/countries` and `GET /capabilities/networks`. The tag name does not appear in the request paths. **Prerequisites:** Valid authentication headers. **Related:** Accounts, Transactions - name: Sandbox description: >- Trigger sandbox-only simulation endpoints for safe end-to-end integration testing with synthetic data. The sandbox host (`https://api.platform.sandbox.dakota.xyz`) also accepts a family of `X-Sandbox-*` request headers on most write endpoints (`Customers`, `Accounts`, `Transactions`, simulate endpoints) that let integrators drive deterministic failure modes — pick a preset via `X-Sandbox-Scenario`, or compose a custom one with `X-Sandbox-Error-Step`/`X-Sandbox-Error-Status`/`X-Sandbox-Error-Message`. `X-Sandbox-Instant-Completion` collapses async flows to a single synchronous step, and `X-Sandbox-Skip-Auto-Approval` keeps newly created KYB applications in `pending` for manual-review testing. All `X-Sandbox-*` headers are ignored in production. **Prerequisites:** Sandbox environment and test customer data. **Related:** Customers, Accounts, Transactions, Onboarding - name: Legal description: |- The legal documents customers accept — terms of service, privacy policy, e-sign notice, and partner agreements. Dakota publishes these here, and this is the authoritative source: the hosted onboarding flow, the dakota.xyz website, and your own integration all read the same revisions. Present the current revision to your customer before capturing their acceptance so the record reflects the text they actually saw. paths: /customers/{customer_id}/cards: parameters: - name: customer_id in: path required: true schema: $ref: '#/components/schemas/KSUID' post: tags: - Cards summary: Create a card description: > Create a card for a cardholder, drawing on the given wallet, gated on the cards capability being available. The card is created synchronously and returns in `pending` status, then transitions to `active` via a `card.updated` webhook. operationId: createCard parameters: - $ref: '#/components/parameters/IdempotencyKeyHeader' requestBody: description: Card details required: true content: application/json: example: cardholder_id: 31TgvufZK3gDXBcA3BnSeLWiSn7 wallet_id: 2tQRvK9pRzM4nVbW8sHqL5jXmYt spend_limit: interval: monthly amount: 250000 currency: USD nickname: Ads card external_id: ads-card-01 schema: $ref: '#/components/schemas/CreateCardRequest' responses: '201': description: Card created successfully content: application/json: example: id: 2tQRvvnYkN6edEJUTmF1LzTj2ug cardholder_id: 31TgvufZK3gDXBcA3BnSeLWiSn7 customer_id: 2tQRvD3xFcJ7bKpW9qNsT4hZmYr wallet_id: 2tQRvK9pRzM4nVbW8sHqL5jXmYt status: pending version: 1 last4: '4242' spend_limit: interval: monthly amount: 250000 external_id: ads-card-01 nickname: Ads card freeze_sources: [] created_at: 1758211200 updated_at: 1758211200 schema: $ref: '#/components/schemas/CardResponse' '400': description: > Invalid request. `#invalid-request` covers a malformed body, a `currency` other than USD, an invalid `spend_limit`, and a wallet that is not an EVM wallet (cards support EVM wallets only). `#limit-reached` means the cardholder already holds the maximum number of active cards; close cards that are no longer used. content: application/problem+json: schema: $ref: '#/components/schemas/ProblemDetails' '401': description: Unauthorized content: application/problem+json: schema: $ref: '#/components/schemas/ProblemDetails' '403': description: > Forbidden — the cards capability is not available for this customer. The `type` is `#cards-capability-unavailable` in the general case (not in rollout, or more than the Cards ToS outstanding), or the more specific `#cards-tos-not-accepted` when the sole unmet requirement is the Cards ToS `terms_acceptance`. Either way the outstanding requirements ride in `errors`. Also `#cardholder-not-active` when the cardholder is not `active` yet (the error reports its status), and `#wallet-not-card-enabled` when the wallet has no active card-settlement enablement. content: application/problem+json: schema: $ref: '#/components/schemas/ProblemDetails' example: type: >- https://docs.dakota.xyz/api-reference/errors#cards-capability-unavailable title: Cards Capability Unavailable status: 403 detail: The cards capability is not available for this customer. errors: - field: cards_tos message: >- Cards Terms of Service must be accepted before creating a card. code: terms_acceptance '404': description: Not found content: application/problem+json: schema: $ref: '#/components/schemas/ProblemDetails' '409': description: > Conflict. A card already exists for this request, or `#cardholder-reenroll-required`: the cardholder was enrolled before the card program's bank requirements applied, so no card can be issued to it. Close any cards it holds, delete the cardholder, and create it again; the new cardholder can hold cards. content: application/problem+json: schema: $ref: '#/components/schemas/ProblemDetails' '501': description: Not yet implemented content: application/problem+json: schema: $ref: '#/components/schemas/ProblemDetails' '502': description: Card provider unavailable content: application/problem+json: schema: $ref: '#/components/schemas/ProblemDetails' '503': description: Cards is not available in this environment content: application/problem+json: schema: $ref: '#/components/schemas/ProblemDetails' servers: - url: https://api.platform.sandbox.dakota.xyz description: Sandbox components: schemas: KSUID: type: string title: KSUID description: >- KSUID is a 27-character globally unique ID that combines a timestamp with a random component. Used for all entity identifiers in the Dakota platform. pattern: ^[0-9A-Za-z]{27}$ minLength: 27 maxLength: 27 example: 1NFHrqBHb3cTfLVkFSGmHZqdDPi CreateCardRequest: type: object title: Create Card Request description: Request for creating a card. required: - cardholder_id - wallet_id properties: cardholder_id: $ref: '#/components/schemas/KSUID' wallet_id: $ref: '#/components/schemas/KSUID' description: >- The wallet the card draws on; must be owned by the customer and eligible. spend_limit: $ref: '#/components/schemas/SpendLimit' currency: type: string description: Display currency. v1 is USD-only. default: USD example: USD external_id: type: string nullable: true description: Optional client-supplied lookup key. nickname: type: string nullable: true maxLength: 64 description: > Optional client-supplied display name for the card, shown wherever the card is listed. A cardholder may hold many cards, so this is often the only thing that distinguishes them. Duplicates are allowed. example: Ads card CardResponse: type: object title: Card Response description: Response containing card details. required: - id - cardholder_id - customer_id - wallet_id - status - version - created_at - updated_at properties: id: $ref: '#/components/schemas/KSUID' cardholder_id: $ref: '#/components/schemas/KSUID' customer_id: $ref: '#/components/schemas/KSUID' wallet_id: $ref: '#/components/schemas/KSUID' version: type: integer format: int64 minimum: 1 description: >- The card's version, strictly increasing for this card. It is bumped by one on every change that emits a `card.created` or `card.updated` event, including a request that changes nothing, and the same value appears as `version` in that event's payload. Webhook deliveries can arrive out of order, and `updated_at` has only one-second resolution, so neither orders them. Keep the highest `version` you have applied for each card and drop any event or response whose `version` is not greater than it. example: 7 status: type: string description: >- Current status of the card. Returns `pending` on create; flips to `active` via a `card.updated` webhook. enum: - pending - active - frozen - closed example: pending last4: type: string nullable: true description: Non-sensitive last four digits, populated from the card provider. example: '4242' spend_limit: $ref: '#/components/schemas/SpendLimit' nullable: true external_id: type: string nullable: true nickname: type: string nullable: true maxLength: 64 description: Client-supplied display name for the card. Null when none was set. example: Ads card freeze_sources: type: array items: $ref: '#/components/schemas/CardFreezeSource' description: >- What is currently holding a freeze on this card, distinct and sorted. Empty when nothing is. A card is frozen while any source holds it, and lifting one source does not lift another. Read this rather than inferring the cause from `status`: `status` reports the card's state at the issuer, so it says only that the card is frozen, never why. `manual` is a freeze applied through this API and is the only source a client can lift, by sending `status: active` to this card's PATCH endpoint. While any other source is present that request is rejected with a `card-freeze-held` problem, because no card-level action will clear it. example: - manual created_at: type: integer description: Unix timestamp (seconds) of creation. updated_at: type: integer description: Unix timestamp (seconds) of last update. cardholder: $ref: '#/components/schemas/CardholderResponse' description: The cardholder this card belongs to. wallet: $ref: '#/components/schemas/CardWalletResponse' description: >- The wallet this card draws on. Populated on the single-card detail endpoint; omitted from list responses. ProblemDetails: type: object required: - type - title - status description: | Error response following RFC 9457 Problem Details. Public API error responses use this format. example: type: https://docs.dakota.xyz/api-reference/errors#not-found title: Customer Not Found status: 404 detail: Customer cst_2abc123 was not found in your organization. instance: https://api.platform.dakota.xyz/customers/cst_2abc123 request_id: req_7f3a8b2c properties: type: type: string format: uri description: | URI reference identifying the problem type. Resolves to human-readable documentation. example: https://docs.dakota.xyz/api-reference/errors#not-found title: type: string description: >- Short, human-readable summary of the problem type. Stable across occurrences. example: Customer Not Found status: type: integer description: HTTP status code for this occurrence. example: 404 detail: type: string description: Human-readable explanation specific to this occurrence. example: Customer cst_2abc123 was not found in your organization. instance: type: string format: uri description: The request path that triggered this error. example: https://api.platform.dakota.xyz/customers/cst_2abc123 request_id: type: string description: Unique request identifier. Include when contacting support. example: req_7f3a8b2c errors: type: array description: Field-level validation errors (present for validation failures). items: $ref: '#/components/schemas/ValidationError' resolution_url: type: string format: uri description: | A link the customer can follow to CLEAR this error, present only on problems with a concrete self-service remedy. Today this is returned by `#terms-not-accepted`, where it points at the hosted flow in which the outstanding agreement can be signed. The link is token-gated and usable as-is — send the customer to it directly rather than parsing it out of `detail`. example: >- https://onboarding.dakota.xyz/applications/2abc123?token=tok_7f3a8b2c user_message: type: string description: | A plain-language rendition of `detail` written for the end customer, present when one exists for this error. `detail` names request fields and actions so a machine caller (such as a payment agent drafting proposals) can self-correct; `user_message` says the same thing without API vocabulary. Clients that relay errors into a human surface (chat, email, UI) should show `user_message` when present and fall back to `detail`. example: >- ACH payments pay out USD, so a USDC payout isn't possible on this rail. Change the payout currency to USD and try again. SpendLimit: type: object title: Spend Limit description: A single cap on card spend, enforced when a purchase is authorized. required: - interval - amount properties: interval: type: string description: Named calendar window the limit resets on. enum: - per_transaction - daily - weekly - monthly - yearly - lifetime example: monthly amount: type: integer description: Limit amount in minor units (cents). minimum: 1 example: 1000000 CardFreezeSource: type: string title: Card Freeze Source description: >- What is holding a freeze on a card. `manual` is a freeze applied deliberately through this API, and is the only source a client can lift. It is the only value this API emits today. This enum grows as new freeze causes are built — a value is added when it can actually occur, never before. Treat any value other than `manual`, including one your client does not recognise, as a hold no card-level request will clear. enum: - manual example: manual CardholderResponse: type: object title: Cardholder Response description: Response containing cardholder details. required: - id - customer_id - first_name - last_name - email - phone - status - created_at - updated_at properties: id: $ref: '#/components/schemas/KSUID' customer_id: $ref: '#/components/schemas/KSUID' first_name: type: string last_name: type: string email: type: string phone: type: string status: type: string description: >- Current status of the cardholder. Returns `pending` on create; on the clean path it flips to `active` within seconds via a `cardholder.updated` webhook. An enrollment flagged during screening takes a longer route: `pending` → `under_review` (a reviewer holds it) → `request_for_information` (the reviewer needs something from you) → `active` or `declined`. You answer information requests through the API; there is never a cardholder-facing link. Every transition emits `cardholder.updated`, and opening a request also emits `cardholder.information_requested`. `suspended` and `closed` are lifecycle rather than review states. `closed` is terminal and appears only in the `cardholder.updated` webhook emitted when a cardholder is deleted — deleted cardholders are not returned by the REST endpoints. enum: - pending - under_review - request_for_information - active - declined - suspended - closed example: pending open_requirements: $ref: '#/components/schemas/CardholderOpenRequirements' external_id: type: string nullable: true created_at: type: integer description: Unix timestamp (seconds) of creation. updated_at: type: integer description: Unix timestamp (seconds) of last update. CardWalletResponse: type: object title: Card Wallet Response description: Wallet details embedded in a card response. required: - id - address - family properties: id: $ref: '#/components/schemas/KSUID' address: type: string description: The wallet's blockchain address. example: '0x165cd37b4c644c2921454429e7f9358d18a45e14' family: $ref: '#/components/schemas/Family' ValidationError: type: object required: - field - message properties: field: type: string description: Field path using dot notation for nested fields. example: bank_account.routing_number message: type: string description: Human-readable description of the field error. example: Routing number must be exactly 9 digits code: type: string description: Machine-readable error code for this field. example: invalid_format CardholderOpenRequirements: type: object title: Cardholder Open Requirements description: >- Summary of what a reviewer is currently waiting on for this cardholder. `count` is `0` and `types` is empty unless the cardholder is in `request_for_information`. This is a summary only. Read the individual items, with their descriptions, from `GET /cardholders/{cardholder_id}/application`. required: - count - types properties: count: type: integer description: >- Number of requirements still outstanding, that is those with status `missing`. Requirements already satisfied (`on_file`) are excluded, so this can be lower than the length of `requested_information` on the application. example: 0 types: type: array description: >- The distinct kinds of information still outstanding, deduplicated. Satisfied requirements do not contribute a type. items: $ref: '#/components/schemas/CardholderRequirementType' example: [] Family: type: string title: Family description: Blockchain family for the crypto account. enum: - evm - solana example: evm CardholderRequirementType: type: string title: Cardholder Requirement Type description: >- The kind of information a reviewer has asked for. `field` is a value on the cardholder that must be corrected, `question` is free text a reviewer asked, and `document` is a file that must be supplied. enum: - document - field - question example: document parameters: IdempotencyKeyHeader: name: x-idempotency-key in: header required: true description: >- Unique key to ensure request idempotency. If the same key is used within a certain time window, the original response will be returned instead of executing the request again. schema: type: string format: uuid securitySchemes: ApiKeyAuth: type: apiKey in: header name: x-api-key ````