> ## 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 credit refund

> Refunds part or all of a credit-purchase lot back to the original payment method. Reference the lot with `credit_transaction_id` and the amount in `amount_cents`; the request only succeeds when the lot is a credit purchase, is within the 30-day refund window, and still has an unused refundable balance. On success the refund is issued at the provider, a matching offset is written to the ledger, and the wallet is debited. Owner-role only.



## OpenAPI

````yaml /openapi.yaml post /api/v1/billing/refunds
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/refunds:
    post:
      tags:
        - Billing
      summary: Create a credit refund
      description: >-
        Refunds part or all of a credit-purchase lot back to the original
        payment method. Reference the lot with `credit_transaction_id` and the
        amount in `amount_cents`; the request only succeeds when the lot is a
        credit purchase, is within the 30-day refund window, and still has an
        unused refundable balance. On success the refund is issued at the
        provider, a matching offset is written to the ledger, and the wallet is
        debited. Owner-role only.
      requestBody:
        required: true
        content:
          application/json:
            schema:
              type: object
              required:
                - credit_transaction_id
                - amount_cents
              properties:
                credit_transaction_id:
                  type: string
                  maxLength: 128
                  description: Id of the credit_purchase lot to refund against.
                amount_cents:
                  type: integer
                  minimum: 1
                  maximum: 1000000000
                  description: >-
                    Amount to refund, in wallet cents. Must not exceed the lot's
                    remaining refundable balance.
                reason:
                  type: string
                  maxLength: 500
                  description: Optional reason attached to the refund and audit log.
            example:
              credit_transaction_id: ctx_01HZY8CREDITLOT
              amount_cents: 5000
              reason: Customer overpaid on top-up
      responses:
        '200':
          description: The created refund request and its processing status.
          content:
            application/json:
              schema:
                type: object
                properties:
                  data:
                    type: object
                    properties:
                      refund:
                        $ref: '#/components/schemas/BillingRefundRequest'
                      duplicate:
                        type: boolean
                        description: >-
                          True when an existing refund for this lot was returned
                          instead of creating a new one.
                  meta:
                    type: object
                    properties:
                      request_id:
                        type: string
                      timestamp:
                        type: string
                        format: date-time
              example:
                data:
                  refund:
                    id: refund_9f2c1a7b4e0d4c6f8a1b2c3d4e5f6071
                    organization_id: org_01HZY8ORG
                    credit_transaction_id: ctx_01HZY8CREDITLOT
                    amount_cents: 5000
                    reason: Customer overpaid on top-up
                    status: processed
                    stripe_refund_id: re_1PEXAMPLE
                    created_at: '2026-08-02T12:00:00.000Z'
                    processed_at: '2026-08-02T12:00:01.000Z'
                meta:
                  request_id: req_01HZY8EXAMPLE
                  timestamp: '2026-08-02T12:00:00.000Z'
components:
  schemas:
    BillingRefundRequest:
      type: object
      description: A credit-refund request and its provider processing status.
      properties:
        id:
          type: string
        organization_id:
          type: string
        credit_transaction_id:
          type: string
        amount_cents:
          type: integer
          description: Refunded amount in wallet cents.
        reason:
          type: string
          nullable: true
        status:
          type: string
          enum:
            - pending
            - approved
            - rejected
            - processed
            - failed
        stripe_refund_id:
          type: string
          nullable: true
        created_at:
          type: string
          format: date-time
        processed_at:
          type: string
          format: date-time
          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_*)

````