> ## Documentation Index
> Fetch the complete documentation index at: https://docs.orbit.devotel.io/llms.txt
> Use this file to discover all available pages before exploring further.

# Create a crypto balance top-up

> Mints a hosted crypto-payment invoice to top up the prepaid wallet and returns the `checkoutUrl` to open plus the `intentId` to poll for status. Send the amount in USD cents along with trusted `successUrl` and `cancelUrl` redirects, and a stable `Idempotency-Key` header (8–255 chars) so retries return the same invoice instead of minting a new one. Balance is credited asynchronously once the payment confirms on-chain.



## OpenAPI

````yaml /openapi.yaml post /api/v1/billing/balance/top-up-crypto
openapi: 3.1.0
info:
  title: Devotel CPaaS API
  description: Orbit by Devotel — Communications Platform as a Service API
  version: 1.0.0
  contact:
    name: Devotel
    url: https://devotel.io
    email: support@devotel.io
  license:
    name: Proprietary
servers:
  - url: https://api.orbit.devotel.io
    description: Production
security:
  - Bearer: []
  - ApiKey: []
tags:
  - name: Messages
    description: >-
      Send and manage messages across all channels (SMS, WhatsApp, RCS, Email,
      Viber, etc.)
  - name: Fax
    description: >-
      List and track fax (MMS/T.38) transmissions on Telnyx-backed fax numbers
      (sending flows through the Messaging API)
  - name: Agents
    description: AI agent creation, configuration, and execution
  - name: Voice
    description: Voice calls, IVR, conferencing, and SIP trunking
  - name: OnCall
    description: On-call rotations and escalation policy planning for incident alerting
  - name: Webhooks
    description: Webhook endpoint management and delivery logs
  - name: Numbers
    description: Phone number search, provisioning, and configuration
  - name: Brand Identity
    description: >-
      Unified cross-channel brand trust posture (10DLC, toll-free, WhatsApp,
      RCS, branded calling, number KYC)
  - name: Contacts
    description: Contact management, segmentation, and lifecycle tracking
  - name: Campaigns
    description: Marketing campaign orchestration and analytics
  - name: Flows
    description: Automation flow builder and execution engine
  - name: Templates
    description: Message template management and approval workflows
  - name: Settings
    description: Organization, channel, and user preference settings
  - name: Verify
    description: OTP generation and verification across channels
  - name: Push
    description: Push notification delivery via FCM and APNs
  - name: Integrations
    description: Third-party service connections and OAuth management
  - name: CDP
    description: >-
      Customer Data Platform — activation surface (CRM object sync, streaming
      destinations, ad-audience activation)
  - name: Files
    description: >-
      Server-to-server media upload, listing, retrieval, and deletion
      (signed-URL backed)
  - name: Commerce
    description: >-
      Omnichannel conversational-commerce — persistent cart + checkout state
      machine, channel-agnostic hosted pay-by-link, native WhatsApp checkout,
      and AP2-style agent payment mandates.
  - name: Sync
    description: >-
      Real-time shared-state primitive (Twilio Sync parity) — Documents, Maps,
      Lists, and ephemeral Streams, with change events relayed over the
      /api/v1/ws/sync WebSocket gateway
  - name: Risk
    description: >-
      Unified cross-channel Trust & Fraud risk scoring — fuses SMS-pumping,
      URL-reputation, Verify Fraud Guard, and Voice Biometrics signals into one
      composite verdict queryable before a send or a call.
  - name: Orby
    description: >-
      In-dashboard Orby operator assistant: streamed assistant turns,
      conversation threads, product knowledge-base search, and the tool-action
      approval gate. Available to signed-in operators only (dashboard session
      auth — API-key requests are rejected).
paths:
  /api/v1/billing/balance/top-up-crypto:
    post:
      tags:
        - Billing
      summary: Create a crypto balance top-up
      description: >-
        Mints a hosted crypto-payment invoice to top up the prepaid wallet and
        returns the `checkoutUrl` to open plus the `intentId` to poll for
        status. Send the amount in USD cents along with trusted `successUrl` and
        `cancelUrl` redirects, and a stable `Idempotency-Key` header (8–255
        chars) so retries return the same invoice instead of minting a new one.
        Balance is credited asynchronously once the payment confirms on-chain.
      parameters:
        - in: header
          name: Idempotency-Key
          required: true
          schema:
            type: string
            minLength: 8
            maxLength: 255
          description: Stable client-generated key so retries reuse the same invoice.
      requestBody:
        required: true
        content:
          application/json:
            schema:
              type: object
              required:
                - amount
                - successUrl
                - cancelUrl
              additionalProperties: false
              properties:
                amount:
                  type: integer
                  minimum: 100
                  description: Top-up amount in USD cents (minimum 100 = $1.00).
                currency:
                  type: string
                  enum:
                    - usd
                  default: usd
                  description: Wallet currency; only USD is supported today.
                successUrl:
                  type: string
                  format: uri
                  description: >-
                    Trusted Orbit URL the payment provider redirects to on
                    confirmation.
                cancelUrl:
                  type: string
                  format: uri
                  description: >-
                    Trusted Orbit URL the payment provider redirects to on
                    close.
            example:
              amount: 5000
              currency: usd
              successUrl: https://orbit.devotel.io/billing?topup=success
              cancelUrl: https://orbit.devotel.io/billing?topup=cancelled
      responses:
        '200':
          description: >-
            Crypto invoice created; open `checkoutUrl` and poll `intentId` for
            status.
          content:
            application/json:
              schema:
                type: object
                properties:
                  data:
                    type: object
                    properties:
                      checkoutUrl:
                        type: string
                        format: uri
                        description: Hosted crypto-invoice URL to open for payment.
                      intentId:
                        type: string
                        description: Identifier of the top-up intent to poll for status.
                      paymentMethod:
                        type: string
                        description: Payment rail used for this top-up.
                      feeCents:
                        type: integer
                        description: >-
                          Network fee in cents; absorbed by Orbit unless
                          `feePaidByUser` is true.
                      feePaidByUser:
                        type: boolean
                        description: >-
                          True when the network fee is added on top of the
                          amount for the payer.
                  meta:
                    $ref: '#/components/schemas/ResponseMeta'
              example:
                data:
                  checkoutUrl: https://payments.example.com/invoice/4522625843
                  intentId: cryptoIntent_01H8XGJ
                  paymentMethod: crypto_nowpayments
                  feeCents: 0
                  feePaidByUser: false
                meta:
                  request_id: req_01H8XGJ
                  timestamp: '2026-08-02T12:00:00.000Z'
components:
  schemas:
    ResponseMeta:
      type: object
      required:
        - request_id
        - timestamp
      additionalProperties: false
      properties:
        request_id:
          type: string
          description: Unique request identifier (also returned as X-Request-Id header)
        timestamp:
          type: string
          format: date-time
        docs_url:
          type: string
          format: uri
          nullable: true
  securitySchemes:
    Bearer:
      type: http
      scheme: bearer
      bearerFormat: JWT
      description: Dashboard JWT token from Clerk
    ApiKey:
      type: apiKey
      name: X-API-Key
      in: header
      description: Server-to-server API key (dv_live_sk_*)

````