> ## 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.

# Initiate a DCB charge

> Validate a charge against the merchant's coverage + per-transaction cap and return an `initiated` charge snapshot. The operator dip is submitted separately via the carrier-billing route.



## OpenAPI

````yaml /openapi.yaml post /api/v1/commerce/dcb/charge
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
paths:
  /api/v1/commerce/dcb/charge:
    post:
      tags:
        - Commerce
      summary: Initiate a DCB charge
      description: >-
        Validate a charge against the merchant's coverage + per-transaction cap
        and return an `initiated` charge snapshot. The operator dip is submitted
        separately via the carrier-billing route.
      requestBody:
        required: true
        content:
          application/json:
            schema:
              type: object
              additionalProperties: true
              required:
                - merchant
                - charge
              properties:
                merchant:
                  type: object
                  additionalProperties: true
                  description: >-
                    Serializable DCB merchant config — settlement currency,
                    per-transaction cap, and tenant-level operator coverage map.
                  properties:
                    merchantId:
                      type: string
                    displayName:
                      type: string
                    currency:
                      type: string
                    category:
                      type: string
                    maxChargeAmount:
                      type: number
                    coverage:
                      type: array
                      items:
                        type: object
                        additionalProperties: true
                        properties:
                          country:
                            type: string
                            description: ISO-3166-1 alpha-2.
                          operator:
                            type: string
                          status:
                            type: string
                            enum:
                              - live
                              - pilot
                              - unsupported
                            description: >-
                              Tenant-level billing readiness on a
                              country+operator pair. Only `live` pairs may be
                              charged.
                    createdAt:
                      type: number
                    updatedAt:
                      type: number
                charge:
                  type: object
                  additionalProperties: true
                  required:
                    - id
                    - phoneNumber
                    - country
                    - operator
                    - amount
                    - currency
                    - description
                  properties:
                    id:
                      type: string
                    phoneNumber:
                      type: string
                    country:
                      type: string
                    operator:
                      type: string
                    amount:
                      type: number
                    currency:
                      type: string
                    description:
                      type: string
                    merchantReference:
                      type: string
                    idempotencyKey:
                      type: string
      responses:
        '200':
          description: The initiated charge.
          content:
            application/json:
              schema:
                type: object
                additionalProperties: true
                required:
                  - data
                  - meta
                properties:
                  data:
                    type: object
                    additionalProperties: true
                    description: >-
                      Serializable DCB charge snapshot. The buyer MSISDN is
                      stored masked; the operator dip rides the carrier-billing
                      route.
                    properties:
                      id:
                        type: string
                      merchantId:
                        type: string
                      country:
                        type: string
                      operator:
                        type: string
                      buyerMsisdnMasked:
                        type: string
                      amount:
                        type: number
                      currency:
                        type: string
                      description:
                        type: string
                      merchantReference:
                        type:
                          - string
                          - 'null'
                      status:
                        type: string
                        enum:
                          - initiated
                          - captured
                          - partially_refunded
                          - refunded
                          - charged_back
                          - failed
                      capturedAmount:
                        type: number
                      refundedAmount:
                        type: number
                      createdAt:
                        type: number
                      updatedAt:
                        type: number
                      settledAt:
                        type:
                          - number
                          - 'null'
                  meta:
                    type: object
                    additionalProperties: true
                    properties:
                      request_id:
                        type: string
                      timestamp:
                        type: string
                        format: date-time
components:
  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_*)

````