> ## Documentation Index > Fetch the complete documentation index at: https://docs.dynamic.xyz/docs/llms.txt > Use this file to discover all available pages before exploring further. # Create a Coinbase onramp order > Creates a new Coinbase onramp order for the authenticated user. ## OpenAPI ````yaml https://app.dynamic.xyz/api-docs/public-api.yaml post /sdk/{environmentId}/onramps/coinbase/orders openapi: 3.0.1 info: title: Dashboard API description: Dashboard API documentation version: 1.0.0 servers: - url: https://app.dynamicauth.com/api/v0 - url: https://app.dynamic.xyz/api/v0 - url: http://localhost:3333/api/v0 security: [] tags: - name: Analytics description: Query usage analytics and event counts for your environment. - name: SDK description: SDK-facing endpoints consumed by embedded Dynamic clients. - name: Organizations description: >- Manage organizations — the top-level container for all environments and projects. - name: Projects description: Manage projects that group related environments under an organization. - name: Environments description: >- Manage environments (live and sandbox) where your authentication configuration lives. - name: Users description: List, search, and manage authenticated users within an environment. - name: Invites description: >- Manage invitation links that grant specific external users access to your environment. - name: Tokens description: >- Create and manage API tokens used to authenticate requests to the Dynamic API. - name: Origins description: >- Configure allowed origins (CORS) for SDK and API access to your environment. - name: Allowlists description: >- Manage allowlists to control which wallet addresses or email addresses can access your environment. - name: Wallets description: View and manage wallets linked to users in your environment. - name: Members description: Manage team members and their roles within an organization. - name: Sessions description: View and revoke active user sessions within an environment. - name: Settings description: Read and update environment-level configuration settings. - name: Exchanges description: >- Configure exchange integrations (Coinbase, Binance, etc.) for fiat on-ramp within your environment. - name: Providers description: >- List, enable, disable, and configure authentication providers (OAuth, email, wallet, SMS, etc.) for your environment. - name: Captcha description: >- Configure captcha verification (provider, site key, secret key) for your environment. - name: Gates description: >- Define access gates that restrict environment entry to users who meet specific criteria. - name: Chains description: >- Manage the blockchain networks available for wallet connection in your environment. - name: Exports description: Export user and wallet data from your environment as downloadable files. - name: Events description: Browse the event log of actions performed within your environment. - name: Webhooks description: >- Create and manage webhooks to receive real-time events (user.created, wallet.linked, etc.) at your endpoint. - name: Custom Fields description: >- Define and manage custom metadata fields collected from users at sign-up or login. - name: MfaSettings description: >- Configure multi-factor authentication (MFA) policies for your organization. - name: Mfa description: Manage MFA enrollment and verification for individual users. - name: CustomHostnames description: >- Configure custom hostnames for white-labeling the Dynamic authentication experience. - name: TestAccount description: >- Manage test accounts used for automated testing and QA within an environment. - name: NameServices description: >- Configure name service integrations (ENS, Unstoppable Domains, etc.) for human-readable wallet addresses. - name: GlobalWallets description: >- Manage global wallets shared across multiple environments in an organization. - name: GlobalWalletConnections description: Configure which environments can access and use global wallets. - name: GlobalWalletAccessControl description: Control which users and roles can access and operate global wallets. - name: UserApiTokens description: >- Create and manage user-scoped API tokens for programmatic access on behalf of a user. - name: Waas description: Wallet-as-a-Service endpoints for creating and managing embedded wallets. - name: WalletConnect description: Configure WalletConnect integration settings for your environment. - name: Checkout description: >- Accept crypto payments and deposits from any wallet. Settle in any token you choose. - name: Flow description: >- Accept crypto payments, deposits, and withdrawals. Amount and destination are fixed server-side at create; the post-create lifecycle is driven with a capability session token. - name: FlowAnalytics description: >- Query aggregated analytics and paginated transaction lists for the Flow product. - name: Custom Networks description: >- Add and manage custom EVM-compatible networks beyond the built-in chain list. - name: Chainalysis description: >- Configure Chainalysis integration for blockchain address screening and risk assessment. - name: Visits description: Track and query user visit activity within your environment. - name: ExternalJwt description: >- Configure external JWT providers so existing auth tokens can be used with Dynamic. - name: SDK Views description: >- Manage SDK view configurations that customize the appearance of Dynamic modals and flows. - name: DeeplinkUrls description: Configure deep link URLs for mobile app integration with the Dynamic SDK. - name: OrganizationSettings description: >- Read and update organization-level settings such as approval workflow configuration. - name: AdminActions description: >- Manage admin action requests that require approval from another administrator. - name: ClientGrant description: | OAuth 2.0 Device Authorization Grant flow (RFC 8628) used by first-party Dynamic clients (CLI, MCP server, demo apps, IDE plugins) to obtain a revocable, 30-day client JWT without ever seeing the user's dashboard session token. - name: AuthorizedClients description: | Manage first-party clients (CLI / MCP / demo / IDE plugins) authorized to act as a dashboard user. Surfaced under Profile → Authorized Clients. paths: /sdk/{environmentId}/onramps/coinbase/orders: post: tags: - SDK summary: Create a Coinbase onramp order description: Creates a new Coinbase onramp order for the authenticated user. operationId: createCoinbaseOnrampOrder parameters: - $ref: '#/components/parameters/environmentId' requestBody: description: Coinbase onramp order data content: application/json: schema: $ref: '#/components/schemas/CoinbaseOnrampOrderCreateRequest' required: true responses: '200': description: Successfully created a Coinbase onramp order content: application/json: schema: $ref: '#/components/schemas/CoinbaseOnrampOrderResponse' '400': $ref: '#/components/responses/BadRequest' '401': $ref: '#/components/responses/Unauthorized' '500': $ref: '#/components/responses/InternalServerError' security: - bearerAuth: [] components: parameters: environmentId: in: path name: environmentId required: true description: ID of the environment schema: $ref: '#/components/schemas/uuid' schemas: CoinbaseOnrampOrderCreateRequest: type: object required: - agreementAcceptedAt - destinationAddress - destinationNetwork - partnerUserRef - paymentCurrency - paymentMethod - purchaseCurrency properties: agreementAcceptedAt: type: string format: date-time description: >- The timestamp of when the user acknowledged that by using Coinbase Onramp they are accepting the Coinbase Terms (https://www.coinbase.com/legal/guest-checkout/us), User Agreement (https://www.coinbase.com/legal/user_agreement),and Privacy Policy (https://www.coinbase.com/legal/privacy). example: '2025-04-24T00:00:00.000Z' destinationAddress: $ref: '#/components/schemas/WalletPublicKey' destinationNetwork: $ref: '#/components/schemas/NonEmptyStringWith50MaxLength' domain: $ref: '#/components/schemas/origin' isQuote: type: boolean description: >- If true, this API will return a quote without creating any transaction. default: false partnerUserRef: $ref: '#/components/schemas/NonEmptyStringWith255MaxLength' paymentAmount: $ref: '#/components/schemas/NonEmptyAmountString' paymentCurrency: $ref: '#/components/schemas/NonEmptyStringWith50MaxLength' paymentMethod: $ref: '#/components/schemas/CoinbaseOnrampOrderPaymentMethod' purchaseAmount: $ref: '#/components/schemas/NonEmptyAmountString' purchaseCurrency: $ref: '#/components/schemas/NonEmptyStringWith50MaxLength' CoinbaseOnrampOrderResponse: type: object required: - order properties: order: $ref: '#/components/schemas/CoinbaseOnrampOrder' paymentLink: description: Payment link details for completing the purchase type: object required: - url - paymentLinkType properties: url: type: string description: >- The URL to the hosted widget the user should be redirected to. For certain payment link types you can append your own redirect_url query parameter to this URL to ensure the user is redirected back to your app after the widget completes. example: >- https://pay.coinbase.com/v2/api-onramp/apple-pay?sessionToken=MWYwNWQwODktZTZlYy02OTdlLTgzZTYtMTI3NzcyOWJhNjM3 paymentLinkType: $ref: '#/components/schemas/CoinbaseOnrampOrderPaymentLinkType' uuid: type: string pattern: ^[0-9a-f]{8}-[0-9a-f]{4}-[0-9a-f]{4}-[0-9a-f]{4}-[0-9a-f]{12}$ minLength: 36 maxLength: 36 example: 95b11417-f18f-457f-8804-68e361f9164f WalletPublicKey: type: string pattern: ^[A-Za-z0-9_-]{18,100}$ description: >- Valid blockchain wallet address, must be an alphanumeric string (underscores allowed for chains like Midnight, hyphens allowed for chains using base64url-encoded addresses like TON) example: '0xbF394748301603f18d953C90F0b087CBEC0E1834' maxLength: 255 NonEmptyStringWith50MaxLength: type: string pattern: ^(?=\S)[\p{L}\p{N}a-zA-Z _.,:!?&%@\/+\-'|]+(?<=\S)$ example: An example name maxLength: 50 origin: type: string pattern: >- ^(https?|chrome-extension|moz-extension|capacitor):\/\/(?!.*(\*).*(\*).*)[*a-zA-Z0-9._-]{1,256}(:[*0-9]{1,5})?$ description: >- An [RFC 6454](https://www.rfc-editor.org/rfc/rfc6454) valid url. Must not include any paths. A single wildcard (*) can be used as the first subdomain. example: http://*.example.com NonEmptyStringWith255MaxLength: type: string pattern: ^(?=\S)[\p{L}\p{N}a-zA-Z _.,:!?&%@\/+\-'|]+(?<=\S)$ maxLength: 255 example: An example name NonEmptyAmountString: type: string pattern: ^(\d+(\.\d+)?|\.\d+)$ description: Digits with optional decimal part example: '100.00' CoinbaseOnrampOrderPaymentMethod: type: string description: The type of payment method to be used to complete an onramp order. enum: - GUEST_CHECKOUT_APPLE_PAY CoinbaseOnrampOrder: type: object required: - orderId - paymentTotal - paymentSubtotal - paymentCurrency - paymentMethod - purchaseAmount - purchaseCurrency - fees - exchangeRate - destinationAddress - destinationNetwork - status - createdAt - updatedAt properties: orderId: $ref: '#/components/schemas/uuid' paymentTotal: $ref: '#/components/schemas/NonEmptyAmountString' paymentSubtotal: $ref: '#/components/schemas/NonEmptyAmountString' paymentCurrency: $ref: '#/components/schemas/NonEmptyStringWith50MaxLength' paymentMethod: $ref: '#/components/schemas/CoinbaseOnrampOrderPaymentMethod' purchaseAmount: $ref: '#/components/schemas/NonEmptyAmountString' purchaseCurrency: $ref: '#/components/schemas/NonEmptyStringWith50MaxLength' fees: type: array description: The fees associated with the order. items: $ref: '#/components/schemas/CoinbaseOnrampFee' exchangeRate: $ref: '#/components/schemas/NonEmptyAmountString' destinationAddress: $ref: '#/components/schemas/WalletPublicKey' destinationNetwork: $ref: '#/components/schemas/NonEmptyStringWith50MaxLength' status: $ref: '#/components/schemas/CoinbaseOnrampOrderStatus' createdAt: type: string format: date-time description: The date and time the order was created. example: '2025-04-24T00:00:00.000Z' updatedAt: type: string format: date-time description: The date and time the order was last updated. example: '2025-04-24T00:00:00.000Z' txHash: $ref: '#/components/schemas/NonEmptyStringWith4096MaxLength' partnerUserRef: $ref: '#/components/schemas/NonEmptyStringWith255MaxLength' CoinbaseOnrampOrderPaymentLinkType: type: string description: The type of payment link. enum: - PAYMENT_LINK_TYPE_APPLE_PAY_BUTTON BadRequest: type: object properties: error: description: Human-readable error message type: string Unauthorized: type: object properties: error: description: Human-readable error message describing the authentication failure type: string example: No jwt provided! InternalServerError: type: object properties: error: description: Human-readable error message type: string example: Internal Server Error CoinbaseOnrampFee: type: object required: - type - amount - currency properties: type: $ref: '#/components/schemas/CoinbaseOnrampFeeType' amount: $ref: '#/components/schemas/NonEmptyAmountString' currency: $ref: '#/components/schemas/NonEmptyStringWith50MaxLength' CoinbaseOnrampOrderStatus: type: string description: The status of an onramp order. enum: - ONRAMP_ORDER_STATUS_PENDING_AUTH - ONRAMP_ORDER_STATUS_PENDING_PAYMENT - ONRAMP_ORDER_STATUS_PROCESSING - ONRAMP_ORDER_STATUS_COMPLETED - ONRAMP_ORDER_STATUS_FAILED NonEmptyStringWith4096MaxLength: type: string maxLength: 4096 description: A string with a max length of 4096 characters CoinbaseOnrampFeeType: type: string description: The type of fee. enum: - FEE_TYPE_NETWORK - FEE_TYPE_EXCHANGE responses: BadRequest: description: Bad Request content: application/json: schema: $ref: '#/components/schemas/BadRequest' Unauthorized: description: Unauthorized content: application/json: schema: $ref: '#/components/schemas/Unauthorized' InternalServerError: description: Internal Server Error content: application/json: schema: $ref: '#/components/schemas/InternalServerError' securitySchemes: bearerAuth: type: http scheme: bearer bearerFormat: JWT ````