Clarafintech Billing Statements API

openapi: 3.2.0
info:
  title: Clara Billing Statements 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: Billing Statements
  description: Retrieve billing statements and statement transactions for reconciliation.
paths:
  /api/v3/billing-statements:
    get:
      operationId: listBillingStatementsV3
      summary: List billing statements
      description: List billing statements for reconciliation workflows.
      tags:
      - Billing Statements
      responses:
        '200':
          description: Billing statements.
          content:
            application/json:
              schema:
                type: array
                items:
                  $ref: '#/components/schemas/BillingStatementV3'
  /api/v3/billing-statements/{uuid}/transactions:
    get:
      operationId: listBillingStatementTransactionsV3
      summary: List billing statement transactions
      description: Retrieve transactions associated with one billing statement. Supports the same pagination and transaction filters as listTransactionsV3.
      tags:
      - Billing Statements
      parameters:
      - name: uuid
        in: path
        required: true
        description: Billing statement UUID.
        schema:
          type: string
          format: uuid
      - $ref: '#/components/parameters/Page'
      - $ref: '#/components/parameters/Size'
      responses:
        '200':
          description: Paginated statement transactions.
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/TransactionPageV3'
        '404':
          $ref: '#/components/responses/NotFound'
components:
  schemas:
    TransactionV3:
      type: object
      required:
      - uuid
      - type
      - status
      - amountValue
      properties:
        uuid:
          type: string
          format: uuid
        type:
          $ref: '#/components/schemas/TransactionType'
        transactionLabel:
          type: string
        status:
          oneOf:
          - $ref: '#/components/schemas/TransactionStatus'
          - $ref: '#/components/schemas/StatusObject'
        amountValue:
          $ref: '#/components/schemas/Money'
        originalAmount:
          $ref: '#/components/schemas/Money'
        merchant:
          type: object
          properties:
            name:
              type: string
            category:
              type: string
            mcc:
              type: string
          additionalProperties: true
        card:
          type: object
          properties:
            uuid:
              type: string
              format: uuid
            lastFourDigits:
              type: string
            maskedPan:
              type: string
          additionalProperties: true
        user:
          $ref: '#/components/schemas/CardUser'
        labels:
          type: array
          items:
            type: object
            additionalProperties: true
        billingStatement:
          $ref: '#/components/schemas/BillingStatementV3'
        hasInvoice:
          type:
          - boolean
          - object
        hasAttachments:
          type:
          - boolean
          - object
        hasExtractedDocuments:
          type:
          - boolean
          - object
        accountingFields:
          type: array
          items:
            type: object
            additionalProperties: true
        accountingStatus:
          $ref: '#/components/schemas/AccountingStatus'
      additionalProperties: true
    StatusObject:
      type: object
      properties:
        code:
          type: string
        description:
          type: string
      additionalProperties: true
    CardUser:
      type: object
      properties:
        uuid:
          type: string
          format: uuid
        name:
          type: string
        fullName:
          type: string
        username:
          type: string
        email:
          type: string
          format: email
      additionalProperties: true
    Money:
      type: object
      properties:
        value:
          type: number
          description: Decimal currency units, not cents.
        amount:
          type: number
          description: Decimal currency units, not cents. Some responses use amount instead of value.
        currency:
          type: string
          enum:
          - MXN
          - BRL
          - COP
      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
    AccountingStatus:
      type: object
      properties:
        status:
          type: string
          enum:
          - NEEDS_REVIEW
          - READY_TO_EXPORT
          - EXPORTED
          description: Accounting Module review status for this transaction, independent from the root-level auth/approval status field. Present for authorized operations (operation types OP and EC, exposed as AUTHORIZED and SYSTEM_TRANSACTION respectively); null for any other operation type.
      additionalProperties: true
    TransactionType:
      type: string
      enum:
      - PURCHASE
      - REFUND
      - FEE
      - CREDIT
      - PAYMENT
    BillingStatementV3:
      type: object
      properties:
        uuid:
          type: string
          format: uuid
        statementStartDate:
          type: string
          format: date
        statementEndDate:
          type: string
          format: date
        currency:
          type: string
          enum:
          - MXN
          - BRL
          - COP
        totalAmount:
          type: number
        status:
          type: string
          enum:
          - OPEN
          - CLOSED
        generatedAt:
          type: string
          format: date-time
      additionalProperties: true
    TransactionStatus:
      type: string
      enum:
      - NOTIFICATION
      - PRE_AUTHORIZED
      - AUTHORIZED
      - REJECTED
      - SYSTEM_TRANSACTION
    TransactionPageV3:
      type: object
      required:
      - content
      - totalElements
      - totalPages
      - size
      - number
      properties:
        content:
          type: array
          items:
            $ref: '#/components/schemas/TransactionV3'
        totalElements:
          type: integer
        totalPages:
          type: integer
        size:
          type: integer
        number:
          type: integer
  parameters:
    Size:
      name: size
      in: query
      description: Number of records per page. Use 100 for large exports unless an endpoint documents a lower limit.
      schema:
        type: integer
        minimum: 1
        maximum: 100
        default: 20
    Page:
      name: page
      in: query
      description: Zero-based page index.
      schema:
        type: integer
        minimum: 0
        default: 0
  responses:
    NotFound:
      description: Resource not found.
      content:
        application/json:
          schema:
            $ref: '#/components/schemas/ErrorResponse'
  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.