> ## 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.

# Request a report

> Submits a report generation request. `reportType` specifies the type of report and required fields.
Supported report types: `camt053`, `managed_payout_transactions`, `managed_payment_wallet_balances`, and `managed_payin_transactions`. The managed-payment reports take a `timeframe` field (`daily` or `monthly`); `managed_payment_wallet_balances` supports `daily` only.
If ready, returns `200` with a pre-signed `downloadUrl`. If not, returns `202` with status `pending`. Poll `GET /v1/reports/{id}` for status, or download using `GET /v1/reports/{id}/content` when ready.
Requests are idempotent: the same entity and request parameters always produce the same report ID. Retries return the existing report.




## OpenAPI

````yaml openapi/account.yaml post /v1/reports
openapi: 3.0.2
info:
  version: ${version}
  title: Core Functionality
  description: >
    All of Circle's APIs share a common set of core functionality that lets you
    manage your Circle Account in a programmatic way.


    With a Circle Account your business can deposit traditional money from 80+
    countries and seamlessly convert them into "digital currency dollars": USDC.
    You can then use USDC for everyday payments and treasury flows.
servers:
  - url: https://api-sandbox.circle.com
  - url: https://api.circle.com
security: []
tags:
  - name: Balances
    description: Get information on settled and unsettled balances.
  - name: Payouts
    description: Create and get information on 1st party payouts.
  - name: Wires
    description: >-
      Create, get instructions, and get information on 1st party bank accounts
      for wire transfers.
  - name: CUBIX
    description: Create and get information on CUBIX accounts.
  - name: PIX
    description: Create and get information on PIX accounts.
  - name: Transfers
    description: Create and get information on 1st party transfers.
  - name: Addresses
    description: Generate and get information on blockchain addresses.
  - name: Deposits
    description: Get information on 1st party deposits.
  - name: Payments
    description: Create, cancel, refund, and get updates on card payments.
  - name: Settlement Bank Routing
    description: View and manage settlement bank routing preferences for fiat accounts.
  - name: Reporting
    description: >-
      Retrieve transaction and balance reports, including ISO 20022 (CAMT.053)
      statements and managed-payment reports.
paths:
  /v1/reports:
    post:
      tags:
        - Reporting
      summary: Request a report
      description: >
        Submits a report generation request. `reportType` specifies the type of
        report and required fields.

        Supported report types: `camt053`, `managed_payout_transactions`,
        `managed_payment_wallet_balances`, and `managed_payin_transactions`. The
        managed-payment reports take a `timeframe` field (`daily` or `monthly`);
        `managed_payment_wallet_balances` supports `daily` only.

        If ready, returns `200` with a pre-signed `downloadUrl`. If not, returns
        `202` with status `pending`. Poll `GET /v1/reports/{id}` for status, or
        download using `GET /v1/reports/{id}/content` when ready.

        Requests are idempotent: the same entity and request parameters always
        produce the same report ID. Retries return the existing report.
      operationId: requestReport
      requestBody:
        required: true
        content:
          application/json:
            schema:
              $ref: '#/components/schemas/ReportRequest'
      responses:
        '200':
          description: >-
            Report is ready. Use the pre-signed `downloadUrl` to download the
            file.
          headers:
            X-Request-Id:
              $ref: '#/components/headers/XRequestId'
          content:
            application/json:
              schema:
                title: RequestReportResponse
                properties:
                  data:
                    $ref: '#/components/schemas/ReportRecord'
              example:
                data:
                  id: 550e8400-e29b-41d4-a716-446655440000
                  reportType: camt053
                  status: ready
                  downloadUrl: https://s3.amazonaws.com/...
                  expiresAt: '2025-01-15T15:00:00Z'
        '202':
          description: >
            Report generation is in progress. Use `GET /v1/reports/{id}` to
            check the status.
          headers:
            X-Request-Id:
              $ref: '#/components/headers/XRequestId'
          content:
            application/json:
              schema:
                title: RequestReportAcceptedResponse
                properties:
                  data:
                    $ref: '#/components/schemas/ReportRecord'
              example:
                data:
                  id: 550e8400-e29b-41d4-a716-446655440000
                  reportType: camt053
                  status: pending
        '400':
          $ref: '#/components/responses/BadRequest'
        '401':
          $ref: '#/components/responses/NotAuthorized'
        '403':
          $ref: '#/components/responses/Forbidden'
        '404':
          $ref: '#/components/responses/NotFound'
        '500':
          $ref: '#/components/responses/InternalServerError'
      security:
        - bearerAuth: []
components:
  schemas:
    ReportRequest:
      description: >
        Request body for generating a report. The `reportType` field determines
        the

        type of report and which additional fields are required.
      oneOf:
        - $ref: '#/components/schemas/Camt053StatementRequest'
        - $ref: '#/components/schemas/ManagedPayoutTransactionsRequest'
        - $ref: '#/components/schemas/ManagedPaymentWalletBalancesRequest'
        - $ref: '#/components/schemas/ManagedPayinTransactionsRequest'
      discriminator:
        propertyName: reportType
        mapping:
          camt053:
            $ref: '#/components/schemas/Camt053StatementRequest'
          managed_payout_transactions:
            $ref: '#/components/schemas/ManagedPayoutTransactionsRequest'
          managed_payment_wallet_balances:
            $ref: '#/components/schemas/ManagedPaymentWalletBalancesRequest'
          managed_payin_transactions:
            $ref: '#/components/schemas/ManagedPayinTransactionsRequest'
    ReportRecord:
      type: object
      description: >
        Metadata for a unified report. `status` reflects whether the generated
        file is available.


        If `status` is `ready`, the response includes a pre-signed
        `downloadUrl`. If `pending`, generation is still in progress. Poll `GET
        /v1/reports/{id}` until `ready`, then download using `GET
        /v1/reports/{id}/content`.


        Requests are idempotent: the same entity and request parameters always
        produce the same report ID. Subsequent `POST` requests return the
        existing report.
      required:
        - id
        - reportType
        - status
      properties:
        id:
          type: string
          format: uuid
          description: >
            Unique, deterministic identifier for this report. The same entity
            and

            request parameters always produce the same ID. Safe to retry as
            subsequent

            POST requests return the same report.
          example: 550e8400-e29b-41d4-a716-446655440000
        reportType:
          type: string
          enum:
            - camt053
            - managed_payout_transactions
            - managed_payment_wallet_balances
            - managed_payin_transactions
          description: Report type identifier.
          example: camt053
        status:
          type: string
          enum:
            - pending
            - ready
            - failed
          description: >
            Current lifecycle status of the report.

            - `ready`: Report is available to download. Use `downloadUrl` or the
            content endpoint.

            - `pending`: Report generation is in process. Poll `GET
            /v1/reports/{id}` until `ready`.

            - `failed`: Report generation failed.
          example: ready
        downloadUrl:
          type: string
          format: uri
          nullable: true
          description: |
            Pre-signed URL to download the report.
            Present only when status is `ready`; omitted otherwise.
          example: https://s3.amazonaws.com/...
        expiresAt:
          type: string
          format: date-time
          nullable: true
          description: >
            Expiration time of `downloadUrl` in ISO 8601 format. After
            expiration, call

            GET `/v1/reports/{id}` to obtain a fresh URL.
          example: '2025-01-15T15:00:00Z'
    Camt053StatementRequest:
      type: object
      description: Request body for a CAMT.053 daily statement for a specific date.
      required:
        - reportType
        - date
      properties:
        reportType:
          type: string
          enum:
            - camt053
          description: Report type identifier.
          example: camt053
        date:
          type: string
          description: |
            The date of the daily CAMT.053 statement to retrieve (YYYY-MM-DD).
            Must be a past date for which a statement has been generated.
          format: date
          example: '2025-01-15'
    ManagedPayoutTransactionsRequest:
      type: object
      description: >
        Request body for a managed payout transactions report. Supported for
        both `daily` and `monthly` timeframes.
      required:
        - reportType
        - timeframe
        - date
      properties:
        reportType:
          type: string
          enum:
            - managed_payout_transactions
          description: Report type identifier.
          example: managed_payout_transactions
        timeframe:
          type: string
          enum:
            - daily
            - monthly
          description: |
            Reporting period granularity.
            - `daily`: the report covers the single day given by `date`.
            - `monthly`: the report covers the calendar month of `date`; the day
              component of `date` is ignored.
          example: daily
        date:
          type: string
          format: date
          description: >
            The report date (YYYY-MM-DD). Must be a past date for which a report
            has

            been generated. For `monthly`, only the year and month are used.
          example: '2026-05-20'
        clientEntityId:
          type: string
          format: uuid
          nullable: true
          description: >
            Optional client entity identifier for multi-tenant lookups. When
            omitted,

            the entity is resolved from the authenticated caller.
          example: 9b2c1f7e-4d3a-4f8b-bc2a-1e0d5a6c7b88
    ManagedPaymentWalletBalancesRequest:
      type: object
      description: >
        Request body for a managed payment wallet balances report. Only the
        `daily` timeframe is supported; `monthly` is rejected with a `400`.
      required:
        - reportType
        - timeframe
        - date
      properties:
        reportType:
          type: string
          enum:
            - managed_payment_wallet_balances
          description: Report type identifier.
          example: managed_payment_wallet_balances
        timeframe:
          type: string
          enum:
            - daily
          description: >
            Reporting period granularity. Only `daily` is supported for this
            report

            type; `monthly` is rejected with a `400`.
          example: daily
        date:
          type: string
          format: date
          description: >
            The report date (YYYY-MM-DD). Must be a past date for which a report
            has

            been generated.
          example: '2026-05-20'
        clientEntityId:
          type: string
          format: uuid
          nullable: true
          description: >
            Optional client entity identifier for multi-tenant lookups. When
            omitted,

            the entity is resolved from the authenticated caller.
          example: 9b2c1f7e-4d3a-4f8b-bc2a-1e0d5a6c7b88
    ManagedPayinTransactionsRequest:
      type: object
      description: >
        Request body for a managed payin transactions report. Supported for both
        `daily` and `monthly` timeframes.
      required:
        - reportType
        - timeframe
        - date
      properties:
        reportType:
          type: string
          enum:
            - managed_payin_transactions
          description: Report type identifier.
          example: managed_payin_transactions
        timeframe:
          type: string
          enum:
            - daily
            - monthly
          description: |
            Reporting period granularity.
            - `daily`: the report covers the single day given by `date`.
            - `monthly`: the report covers the calendar month of `date`; the day
              component of `date` is ignored.
          example: daily
        date:
          type: string
          format: date
          description: >
            The report date (YYYY-MM-DD). Must be a past date for which a report
            has

            been generated. For `monthly`, only the year and month are used.
          example: '2026-05-20'
        clientEntityId:
          type: string
          format: uuid
          nullable: true
          description: >
            Optional client entity identifier for multi-tenant lookups. When
            omitted,

            the entity is resolved from the authenticated caller.
          example: 9b2c1f7e-4d3a-4f8b-bc2a-1e0d5a6c7b88
  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
  responses:
    BadRequest:
      description: The request cannot be processed due to a client error.
      headers:
        X-Request-Id:
          $ref: '#/components/headers/XRequestId'
      content:
        application/json:
          schema:
            type: object
            title: BadRequest
            required:
              - code
              - message
            properties:
              code:
                type: integer
                example: 400
              message:
                type: string
                example: Something went wrong.
            example:
              code: 400
              message: Bad request.
          examples:
            response:
              value:
                code: 400
                message: Bad request.
    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.
    Forbidden:
      description: >-
        The request provides authentication, but the authenticated user does not
        possess sufficient permissions for accessing this resource.
      headers:
        X-Request-Id:
          $ref: '#/components/headers/XRequestId'
      content:
        application/json:
          schema:
            type: object
            title: Forbidden
            required:
              - code
              - message
            properties:
              code:
                type: integer
                example: 400
              message:
                type: string
                example: Something went wrong.
            example:
              code: 3
              message: Forbidden
          examples:
            response:
              value:
                code: 3
                message: Forbidden
    NotFound:
      description: The specified resource was not found.
      headers:
        X-Request-Id:
          $ref: '#/components/headers/XRequestId'
      content:
        application/json:
          schema:
            type: object
            title: NotFound
            required:
              - code
              - message
            properties:
              code:
                type: integer
                example: 400
              message:
                type: string
                example: Something went wrong.
            example:
              code: 404
              message: Not found.
          examples:
            response:
              value:
                code: 404
                message: Not found.
    InternalServerError:
      description: Unexpected server error.
      headers:
        X-Request-Id:
          $ref: '#/components/headers/XRequestId'
      content:
        application/json:
          schema:
            type: object
            title: InternalServerError
            required:
              - code
              - message
            properties:
              code:
                type: integer
                example: 400
              message:
                type: string
                example: Something went wrong.
            example:
              code: 500
              message: Internal server error.
          examples:
            response:
              value:
                code: 500
                message: Internal server error.
  securitySchemes:
    bearerAuth:
      type: http
      scheme: bearer

````