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

# Get credit line details

> Provides overall credit line details, including status, available limit, and outstanding balance.



## OpenAPI

````yaml openapi/credit.yaml get /v1/credit
openapi: 3.0.2
info:
  version: ${version}
  title: Credit API
  description: >
    The Circle Credit API provides access to credit facilities including Line of
    Credit and Settlement Advance products.


    **Line of Credit** enables direct drawdowns with auto-approval and
    asynchronous disbursement. Supports both fiat and crypto repayment.


    **Settlement Advance** requires a reserve-then-request flow with manual
    approval. Requires wire proof upload for disbursement approval. Supports
    fiat repayment only.
servers:
  - url: https://api-sandbox.circle.com
  - url: https://api.circle.com
security: []
tags:
  - name: Credit
    description: Get credit line details.
  - name: Credit Transfers
    description: Create, reserve, and manage credit transfers (drawdowns).
  - name: Credit Fees
    description: View fees charged on credit transfers.
  - name: Credit Repayments
    description: View and initiate repayments on credit transfers.
paths:
  /v1/credit:
    get:
      tags:
        - Credit
      summary: Get credit line details
      description: >-
        Provides overall credit line details, including status, available limit,
        and outstanding balance.
      operationId: getCreditLine
      responses:
        '200':
          description: Successfully retrieved credit line details.
          headers:
            X-Request-Id:
              $ref: '#/components/headers/XRequestId'
          content:
            application/json:
              schema:
                title: GetCreditLineResponse
                properties:
                  data:
                    $ref: '#/components/schemas/CreditLine'
              examples:
                Line of Credit:
                  value:
                    data:
                      id: b3d9d2d5-4c12-4946-a09d-953e82fae2b0
                      product: lineOfCredit
                      status: active
                      limit:
                        amount: '1000000.00'
                        currency: USD
                      used:
                        amount: '250000.00'
                        currency: USD
                      available:
                        amount: '750000.00'
                        currency: USD
                      outstandingTransfers: 2
                      feeRates:
                        recurringFee: '0.0003'
                      unpaidFees:
                        amount: '150.00'
                        currency: USD
                      minBalance:
                        amount: '100000.00'
                        currency: USD
                      feeCadence: daily
                      validationErrors: []
                      createDate: '2024-01-15T10:30:00.000Z'
                      updateDate: '2024-03-20T14:22:00.000Z'
                Settlement Advance:
                  value:
                    data:
                      id: fc988ed5-c129-4f70-a064-e5beb7eb8e32
                      product: settlementAdvance
                      status: active
                      limit:
                        amount: '500000.00'
                        currency: USD
                      used:
                        amount: '100000.00'
                        currency: USD
                      available:
                        amount: '400000.00'
                        currency: USD
                      outstandingTransfers: 1
                      feeRates:
                        drawFee: '0.02'
                        recurringFee: '0.0003'
                      unpaidFees:
                        amount: '0.00'
                        currency: USD
                      minBalance:
                        amount: '50000.00'
                        currency: USD
                      feeCadence: daily
                      validationErrors: []
                      createDate: '2024-01-15T10:30:00.000Z'
                      updateDate: '2024-03-20T14:22:00.000Z'
        '401':
          $ref: '#/components/responses/NotAuthorized'
      security:
        - bearerAuth: []
components:
  headers:
    XRequestId:
      description: >-
        Universally unique identifier (UUID v4) for the request. Helpful for
        identifying a request when communicating with Circle support.
      schema:
        type: string
        format: uuid
        example: 2adba88e-9d63-44bc-b975-9b6ae3440dde
  schemas:
    CreditLine:
      type: object
      description: >-
        Credit line details including status, available limit, and outstanding
        balance.
      required:
        - id
        - product
        - status
        - limit
        - used
        - available
        - outstandingTransfers
        - feeRates
        - unpaidFees
        - minBalance
        - validationErrors
        - feeCadence
        - createDate
        - updateDate
      properties:
        id:
          description: Unique identifier of the credit line.
          type: string
          format: uuid
          example: b3d9d2d5-4c12-4946-a09d-953e82fae2b0
        product:
          description: The credit product type.
          type: string
          enum:
            - lineOfCredit
            - settlementAdvance
          example: lineOfCredit
        status:
          description: Current status of the credit line.
          type: string
          enum:
            - active
          example: active
        limit:
          $ref: '#/components/schemas/FiatMoneyUsd'
          description: Total credit limit.
        used:
          $ref: '#/components/schemas/FiatMoneyUsd'
          description: Amount of credit currently in use.
        available:
          $ref: '#/components/schemas/FiatMoneyUsd'
          description: Amount of credit available for new transfers.
        outstandingTransfers:
          description: Number of transfers that have not yet been fully repaid.
          type: integer
          example: 2
        feeRates:
          $ref: '#/components/schemas/CreditFeeRates'
          description: >-
            Fee rates applicable to the credit line. Line of Credit products
            include only recurringFee. Settlement Advance products include both
            drawFee and recurringFee.
        unpaidFees:
          $ref: '#/components/schemas/FiatMoneyUsd'
          description: Total amount of unpaid fees.
        minBalance:
          $ref: '#/components/schemas/FiatMoneyUsd'
          description: Minimum balance required on the account to create new transfers.
        validationErrors:
          description: >-
            List of validation errors preventing new transfer creation. If
            non-empty, all transfer creation requests will be rejected with HTTP
            400.
          type: array
          items:
            $ref: '#/components/schemas/CreditValidationError'
        feeCadence:
          description: >-
            The cadence at which fees are accrued on the credit line (hourly
            only supported on Line of Credit).
          type: string
          enum:
            - daily
            - hourly
          example: daily
        createDate:
          $ref: '#/components/schemas/UtcTimestamp'
          description: ISO-8601 UTC date/time when the credit line was created.
        updateDate:
          $ref: '#/components/schemas/UtcTimestamp'
          description: ISO-8601 UTC date/time when the credit line was last updated.
    FiatMoneyUsd:
      type: object
      required:
        - amount
        - currency
      properties:
        amount:
          description: Magnitude of the amount, in units of the currency, with a `.`.
          type: string
          example: '3.14'
        currency:
          description: Currency code.
          type: string
          enum:
            - USD
    CreditFeeRates:
      type: object
      description: Fee rates applicable to the credit line.
      properties:
        drawFee:
          description: >-
            One-time fee rate charged on each transfer draw. Only applicable to
            Settlement Advance products.
          type: string
          example: '0.02'
        recurringFee:
          description: >-
            Recurring fee rate charged on outstanding transfer balances every 1
            or 24 hours from the transferDate, depending on whether the
            feeCadence is hourly or daily.
          type: string
          example: '0.0003'
      required:
        - recurringFee
    CreditValidationError:
      type: object
      description: A validation error that prevents new transfer creation.
      required:
        - code
        - message
      properties:
        code:
          description: Machine-readable error code.
          type: string
          enum:
            - INSUFFICIENT_BALANCE
            - PENDING_FEES
            - OVERDUE_TRANSFERS
          example: INSUFFICIENT_BALANCE
        message:
          description: Human-readable error message.
          type: string
          example: Minimum balance requirement not met.
    UtcTimestamp:
      type: string
      description: ISO-8601 UTC date/time format.
      example: '2020-04-10T02:13:30.000Z'
  responses:
    NotAuthorized:
      description: >-
        The request has not been applied because it lacks valid authentication
        credentials.
      headers:
        X-Request-Id:
          $ref: '#/components/headers/XRequestId'
      content:
        application/json:
          schema:
            type: object
            title: NotAuthorized
            required:
              - code
              - message
            properties:
              code:
                type: integer
                example: 400
              message:
                type: string
                example: Something went wrong.
            example:
              code: 401
              message: Malformed authorization.
          examples:
            response:
              value:
                code: 401
                message: Malformed authorization.
  securitySchemes:
    bearerAuth:
      type: http
      scheme: bearer

````