Clarafintech Digital Account API

openapi: 3.2.0
info:
  title: Clara Digital Account API
  summary: Corporate card and spend management API for Mexico, Brazil, and Colombia.
  description: Use the Clara API to manage corporate cards, retrieve transactions, provision users, reconcile billing statements, download transaction documents, and automate spend-management workflows. Every API request requires both mutual TLS and an OAuth 2.0 Bearer token. This docs-published schema is derived from the current Clara developer documentation and should be checked against backend-owned API contracts before being treated as exhaustive.
  version: 3.0.0
  contact:
    name: Clara Integration Support
    email: integration.support.mx@clara.team
    url: https://developers.clara.team
servers:
- url: https://public-api.mx.clara.com
  description: Mexico production
- url: https://public-api.br.clara.com
  description: Brazil production
- url: https://public-api.co.clara.com
  description: Colombia production
- url: https://public-api.mx.clara.com/api-test
  description: Mexico sandbox. Use the same paths without the leading /api segment when testing, for example /v3/transactions.
- url: https://public-api.br.clara.com/api-test
  description: Brazil sandbox. Use the same paths without the leading /api segment when testing, for example /v3/transactions.
- url: https://public-api.co.clara.com/api-test
  description: Colombia sandbox. Use the same paths without the leading /api segment when testing, for example /v3/transactions.
security:
- MutualTLS: []
  BearerAuth: []
tags:
- name: Digital Account
  description: Brazil-only digital account movement search.
paths:
  /api/v3/digital-accounts:
    get:
      operationId: listDigitalAccountTransactionsV3
      summary: List digital account transactions
      description: Brazil-only endpoint for listing PIX, TED, bill, and transfer movements in the Clara digital account.
      tags:
      - Digital Account
      parameters:
      - name: startDate
        in: query
        description: Start date in YYYY-MM-DD format.
        schema:
          type: string
          format: date
      - name: endDate
        in: query
        description: End date in YYYY-MM-DD format.
        schema:
          type: string
          format: date
      - name: transactionTypeName
        in: query
        description: Filter by digital account movement type.
        schema:
          type: string
          enum:
          - PIX
          - TED
          - BILL
          - TRANSACTION
      responses:
        '200':
          description: Digital account movements.
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/DigitalAccountTransactionPageV3'
  /api/v3/digital-accounts/balance:
    get:
      operationId: getDigitalAccountBalanceV3
      summary: Get digital account balance
      description: Brazil-only endpoint returning the available balance of the authenticated company's checking and collateral accounts. The company is resolved from the token's taxId; the endpoint takes no parameters and requires the read:digital-account scope.
      tags:
      - Digital Account
      responses:
        '200':
          description: Digital account balance.
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/DigitalAccountBalanceV3'
        '401':
          $ref: '#/components/responses/Unauthorized'
        '403':
          $ref: '#/components/responses/Forbidden'
        '404':
          $ref: '#/components/responses/NotFound'
        '503':
          $ref: '#/components/responses/ServiceUnavailable'
components:
  responses:
    Forbidden:
      description: Forbidden. The token is valid but lacks permission for this resource.
      content:
        application/json:
          schema:
            $ref: '#/components/schemas/ErrorResponse'
    NotFound:
      description: Resource not found.
      content:
        application/json:
          schema:
            $ref: '#/components/schemas/ErrorResponse'
    Unauthorized:
      description: Unauthorized. Refresh the token or verify mTLS certificate configuration.
      content:
        application/json:
          schema:
            $ref: '#/components/schemas/ErrorResponse'
    ServiceUnavailable:
      description: Service unavailable. A downstream dependency did not respond; retry later.
      content:
        application/json:
          schema:
            $ref: '#/components/schemas/ErrorResponse'
  schemas:
    DigitalAccountTransactionPageV3:
      type: object
      properties:
        data:
          type: array
          items:
            type: object
            properties:
              id:
                type: string
              transactionDate:
                type: string
                format: date-time
              amount:
                type: number
              method:
                type: string
              type:
                type: string
              description:
                type: string
            additionalProperties: true
        meta:
          type: object
          properties:
            totalPages:
              type: integer
            totalItems:
              type: integer
            itemsPerPage:
              type: integer
            currentPage:
              type: integer
          additionalProperties: true
      additionalProperties: true
    ErrorResponse:
      type: object
      required:
      - message
      properties:
        code:
          type: string
          description: Machine-readable Clara or HTTP error code when available.
        message:
          type: string
          description: Human-readable error message.
        timestamp:
          type: string
          format: date-time
        details:
          type: array
          items:
            type: object
            additionalProperties: true
      additionalProperties: true
    DigitalAccountBalanceV3:
      type: object
      required:
      - checkingAccount
      properties:
        checkingAccount:
          type: object
          required:
          - available
          properties:
            available:
              type: number
              description: Available balance of the checking account, in account-currency units (not cents).
          additionalProperties: true
        collateralAccount:
          type: object
          required:
          - available
          properties:
            available:
              type: number
              description: Available balance of the collateral account; 0 when the company has none.
          additionalProperties: true
      additionalProperties: true
  securitySchemes:
    MutualTLS:
      type: mutualTLS
      description: All API requests require a valid Clara-issued X.509 client certificate.
    BearerAuth:
      type: http
      scheme: bearer
      bearerFormat: JWT
      description: OAuth 2.0 Bearer token from /oauth/token.
    BasicAuth:
      type: http
      scheme: basic
      description: Use CLIENT_ID:CLIENT_SECRET when requesting an access token.
externalDocs:
  description: Clara API documentation
  url: https://developers.clara.team
x-source: Derived from the developers.clara.team documentation in this repository. Replace with the backend-owned OpenAPI contract if one is available.