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

# Initiate Offramp

> Initiate an offramp transfer. Returns a cryptocurrency deposit address where users should send their crypto. Once crypto is deposited, it will be converted to fiat and sent to the registered destination account.



## OpenAPI

````yaml /api-reference/openapi.json post /payment/api/v1/offramp
openapi: 3.0.0
info:
  title: Carbn Connect API
  version: 1.0.0
  description: >-
    API documentation for Carbn Connect services including user onboarding, KYC,
    wallet management, and transfers.
servers:
  - url: https://api.carbnconnect.com
    description: Production server
security:
  - ApiKeyAuth: []
paths:
  /payment/api/v1/offramp:
    post:
      tags:
        - Payments
      summary: Initiate Offramp
      description: >-
        Initiate an offramp transfer. Returns a cryptocurrency deposit address
        where users should send their crypto. Once crypto is deposited, it will
        be converted to fiat and sent to the registered destination account.
      operationId: offrampCreate
      requestBody:
        required: true
        content:
          application/json:
            schema:
              $ref: '#/components/schemas/OfframpCreateRequest'
      responses:
        '200':
          description: Offramp initiated successfully
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/OfframpCreateResponse'
        '400':
          description: Invalid request
        '401':
          description: Unauthorized - API key is missing or invalid
        '404':
          description: User or account not found
      security:
        - ApiKeyAuth: []
components:
  schemas:
    OfframpCreateRequest:
      type: object
      required:
        - user_id
        - account_id
      properties:
        user_id:
          type: string
          format: uuid
          example: 5d1aabf5-361e-4470-8b99-51d1ce3ef338
          description: The unique identifier of the user
        account_id:
          type: string
          format: uuid
          example: 5bc098b7-027f-48a9-9c67-c1666555f5a6
          description: The unique identifier of the registered destination account
    OfframpCreateResponse:
      type: object
      properties:
        address:
          type: string
          example: 9fV7wU6bnbY1Y2Snhmmow8rtUmxhuze6FYVBjm2dRvmX
          description: Cryptocurrency deposit address where users should send their crypto
        crypto:
          type: string
          example: USDC
          description: Cryptocurrency type (e.g., USDC, BTC, ETH)
        chain:
          type: string
          example: solana
          description: Blockchain network (e.g., solana, ethereum, polygon)
  securitySchemes:
    ApiKeyAuth:
      type: apiKey
      in: header
      name: x-api-key
      description: API key for authentication. Must be included in the x-api-key header.

````