> ## Documentation Index > Fetch the complete documentation index at: https://docs.paybyrd.com/llms.txt > Use this file to discover all available pages before exploring further. # List settlement files > Returns a list of settlement files generated within the specified time period. Days with no settlement file are omitted from the results. When more than one file exists for the same day, all files are complementary and must all be processed to obtain complete settlement information. ## OpenAPI ````yaml /settlements-api.yml get /api/v1/SettlementFiles openapi: 3.0.3 info: title: Paybyrd Settlements API description: | API for retrieving settlement files from the Paybyrd FinanceHub service. version: 1.0.0 servers: - url: https://financehub.paybyrd.com description: Production security: - ApiKeyAuth: [] tags: - name: Settlement files paths: /api/v1/SettlementFiles: get: tags: - Settlement files summary: List settlement files description: > Returns a list of settlement files generated within the specified time period. Days with no settlement file are omitted from the results. When more than one file exists for the same day, all files are complementary and must all be processed to obtain complete settlement information. operationId: listSettlementFiles parameters: - name: createdFrom in: query required: true description: > Start of the time period (ISO 8601, UTC, no timezone offset). To retrieve a full day, set this to 00:00:00 of the target date. schema: type: string format: date-time example: '2022-11-18T00:00:00' - name: createdTo in: query required: true description: > End of the time period (ISO 8601, UTC, no timezone offset). To retrieve a full day, set this to 23:59:59 of the target date. schema: type: string format: date-time example: '2022-11-18T23:59:59' - name: merchantId in: query required: false description: Filter results to files for a specific merchant. schema: type: integer format: int64 - name: storeId in: query required: false description: Filter results to files for a specific store. schema: type: integer format: int64 responses: '200': description: A list of settlement files for the requested period. content: application/json: schema: type: object properties: data: type: array items: $ref: '#/components/schemas/SettlementFileItem' example: data: - checksum: ba421754061547e5d80153d3d2923be4 createdAt: '2026-05-26T13:11:02.390069-03:00' groupId: 1 merchantId: 1 id: 59188227-0811-4e30-8c57-b8dff2ab07e9 url: >- https://financehubstoragestg.blob.core.windows.net/settlements-paybyrd/57/87/2026-05-26T16-11-00-4990180%2B0-PaybyrdSettlement.csv '400': description: Invalid request parameters. content: application/json: schema: $ref: '#/components/schemas/ProblemDetailsResponse' example: data: problemDetails: type: ApplicationBadRequestFail title: Bad request status: 400 instance: bad_request extensions: {} contentType: application/problem+json statusCode: 400 '401': description: Missing or invalid API key. '404': description: No settlement files found for the specified period. content: application/json: schema: $ref: '#/components/schemas/ProblemDetailsResponse' example: data: problemDetails: type: ApplicationNotFoundFail title: Settlement file not found with the specified period. status: 404 instance: not_found extensions: {} contentType: application/problem+json statusCode: 404 '500': description: Unexpected server error. content: application/json: schema: $ref: '#/components/schemas/ProblemDetailsResponse' example: data: problemDetails: type: ApplicationServerErrorFail title: Internal server error status: 500 instance: server_error extensions: {} contentType: application/problem+json statusCode: 500 components: schemas: SettlementFileItem: type: object description: A single settlement file entry returned in the list response. required: - checksum - createdAt - groupId - id - url properties: checksum: type: string description: MD5 hash of the file contents, represented as a hexadecimal string. example: ba421754061547e5d80153d3d2923be4 createdAt: type: string format: date-time description: Timestamp when the file was generated (ISO 8601). example: '2026-05-26T13:11:02.390069-03:00' groupId: type: integer format: int64 description: Customer-defined group or organization hierarchy. example: 1 merchantId: type: integer format: int64 description: > Customer-defined merchant identifier. When present, the file contains data scoped to this merchant and its stores. When absent, the file contains data for all merchants in the group. example: 1 storeId: type: integer format: int64 description: > Customer-facing merchant identification number. When present, the file contains data scoped to this specific store. When absent, the file contains data for all stores of the merchant (or all stores of the group if merchantId is also absent). example: 1 id: type: string format: uuid description: Unique identifier of the settlement file. example: 59188227-0811-4e30-8c57-b8dff2ab07e9 url: type: string format: uri description: > Pre-signed URL to download the settlement CSV file. The URL is valid for 7 days from the time of the API request. To renew an expired URL, make a new request to this endpoint. example: >- https://financehubstoragestg.blob.core.windows.net/settlements-paybyrd/57/87/2026-05-26T16-11-00-4990180%2B0-PaybyrdSettlement.csv ProblemDetailsResponse: type: object properties: data: type: object properties: problemDetails: $ref: '#/components/schemas/ProblemDetails' contentType: type: string example: application/problem+json statusCode: type: integer ProblemDetails: type: object required: - type - title - status - instance properties: type: type: string title: type: string status: type: integer instance: type: string extensions: type: object additionalProperties: true securitySchemes: ApiKeyAuth: type: apiKey in: header name: x-api-key ````