Clarafintech Reimbursements API

openapi: 3.2.0
info:
  title: Clara Reimbursements 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: Reimbursements
  description: Retrieve reimbursement data for out-of-pocket expenses.
paths:
  /api/v3/reimbursements:
    get:
      operationId: listReimbursementsV3
      summary: List reimbursements
      description: Retrieve reimbursement records with filters for lifecycle status, requester, creation date, expense date, approval date, payment date, update date, category, and UUID.
      tags:
      - Reimbursements
      parameters:
      - $ref: '#/components/parameters/Page'
      - $ref: '#/components/parameters/Size'
      - name: requestCreationDateStart
        in: query
        description: Request creation date start in YYYY-MM-DD format.
        schema:
          type: string
          format: date
      - name: requestCreationDateEnd
        in: query
        description: Request creation date end in YYYY-MM-DD format.
        schema:
          type: string
          format: date
      - name: expenseDateStart
        in: query
        description: Expense date start in YYYY-MM-DD format.
        schema:
          type: string
          format: date
      - name: expenseDateEnd
        in: query
        description: Expense date end in YYYY-MM-DD format.
        schema:
          type: string
          format: date
      - name: finalApprovalDateStart
        in: query
        description: Final approval date start in YYYY-MM-DD format.
        schema:
          type: string
          format: date
      - name: finalApprovalDateEnd
        in: query
        description: Final approval date end in YYYY-MM-DD format.
        schema:
          type: string
          format: date
      - name: paymentDateStart
        in: query
        description: Payment date start in YYYY-MM-DD format.
        schema:
          type: string
          format: date
      - name: paymentDateEnd
        in: query
        description: Payment date end in YYYY-MM-DD format.
        schema:
          type: string
          format: date
      - name: lastUpdateDateStart
        in: query
        description: Last update date start in YYYY-MM-DD format.
        schema:
          type: string
          format: date
      - name: lastUpdateDateEnd
        in: query
        description: Last update date end in YYYY-MM-DD format.
        schema:
          type: string
          format: date
      - name: categoryCodes
        in: query
        description: Comma-separated category codes.
        schema:
          type: array
          items:
            type: string
        style: form
        explode: false
      - name: requesterUuids
        in: query
        description: Comma-separated requester UUIDs.
        schema:
          type: array
          items:
            type: string
            format: uuid
        style: form
        explode: false
      - name: statuses
        in: query
        description: Comma-separated reimbursement statuses.
        schema:
          type: array
          items:
            $ref: '#/components/schemas/ReimbursementStatus'
        style: form
        explode: false
      - name: requesterName
        in: query
        description: Filter by requester name.
        schema:
          type: string
      - name: uuids
        in: query
        description: Comma-separated reimbursement UUIDs.
        schema:
          type: array
          items:
            type: string
            format: uuid
        style: form
        explode: false
      responses:
        '200':
          description: Paginated reimbursements.
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/ReimbursementPageV3'
        '400':
          $ref: '#/components/responses/BadRequest'
  /api/v3/reimbursements/{uuid}:
    get:
      operationId: getReimbursementV3
      summary: Get a reimbursement
      description: Retrieve a single reimbursement by UUID.
      tags:
      - Reimbursements
      parameters:
      - name: uuid
        in: path
        required: true
        description: Reimbursement UUID.
        schema:
          type: string
          format: uuid
      responses:
        '200':
          description: Reimbursement details.
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/ReimbursementV3'
        '404':
          $ref: '#/components/responses/NotFound'
components:
  responses:
    BadRequest:
      description: Bad request. Fix invalid parameters or missing fields before retrying.
      content:
        application/json:
          schema:
            $ref: '#/components/schemas/ErrorResponse'
    NotFound:
      description: Resource not found.
      content:
        application/json:
          schema:
            $ref: '#/components/schemas/ErrorResponse'
  schemas:
    ReimbursementPageV3:
      type: object
      properties:
        content:
          type: array
          items:
            $ref: '#/components/schemas/ReimbursementV3'
        totalElements:
          type: integer
        totalPages:
          type: integer
        size:
          type: integer
        number:
          type: integer
      additionalProperties: true
    ReimbursementV3:
      type: object
      properties:
        uuid:
          type: string
          format: uuid
        description:
          type: string
        audit:
          type: object
          additionalProperties: true
        labels:
          type: array
          items:
            $ref: '#/components/schemas/LinkedResource'
        merchant:
          type: object
          additionalProperties: true
        requester:
          $ref: '#/components/schemas/CardUser'
        groups:
          type: array
          items:
            $ref: '#/components/schemas/LinkedResource'
        locations:
          type: array
          items:
            $ref: '#/components/schemas/LinkedResource'
        amountValue:
          $ref: '#/components/schemas/Money'
        validationStatus:
          type: object
          properties:
            status:
              $ref: '#/components/schemas/ReimbursementStatus'
            comment:
              type: string
          additionalProperties: true
        attachments:
          type: array
          items:
            type: object
            additionalProperties: true
        paymentDetail:
          type: object
          additionalProperties: true
      additionalProperties: true
    ReimbursementStatus:
      type: string
      enum:
      - PENDING
      - APPROVED
      - SENT_TO_PAY
      - PAYMENT_IN_PROGRESS
      - PAID
      - REJECTED
      - FINANCE_REJECTED
      - CANCELLED
      - NOT_FOUND
      - UNAUTHORIZED
    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
    LinkedResource:
      type: object
      properties:
        uuid:
          type: string
          format: uuid
        name:
          type: string
        links:
          type: array
          items:
            type: object
            additionalProperties: true
        _links:
          type: object
          additionalProperties: true
      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
  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
  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.