> ## Documentation Index > Fetch the complete documentation index at: https://safepay.mintlify.site/llms.txt > Use this file to discover all available pages before exploring further. # List Settlement Job Runs > List settlement-engine job runs visible to the aggregator. Results are scoped to jobs that created settlement batches containing settlement transactions for this aggregator. Use this to inspect ledger poster, ledger settler, and payout generator runs related to your settlement activity. ## OpenAPI ````yaml get /v1/aggregators/{raast-aggregator-id}/settlements/job-runs openapi: 3.1.0 info: title: Raast Wire version: 1.0.0 description: '' servers: - url: https://api.getsafepay.com/raastwire security: [] tags: - name: Aggregators - name: Access Keys - name: Merchants - name: Raast Merchants - name: Payments - name: Refunds - name: QRs - name: Utilities - name: Aliases - name: Ledgers - name: Webhooks - name: Settlement Operations - name: Settlement Reports paths: /v1/aggregators/{raast-aggregator-id}/settlements/job-runs: parameters: - $ref: '#/components/parameters/AggregatorIdParam' get: tags: - Settlement Operations summary: List Settlement Job Runs description: > List settlement-engine job runs visible to the aggregator. Results are scoped to jobs that created settlement batches containing settlement transactions for this aggregator. Use this to inspect ledger poster, ledger settler, and payout generator runs related to your settlement activity. parameters: - $ref: '#/components/parameters/SettlementOpsCursorParam' - $ref: '#/components/parameters/SettlementOpsLimitParam' - $ref: '#/components/parameters/SettlementOpsDirectionParam' - name: job_id in: query required: false description: >- Restrict results to a single job run token (`job_…`, exactly 40 characters). schema: type: string example: job_76b08225-5372-46db-9acb-086ac9c2f7d6 - name: job_type in: query required: false description: > Filter by job type integer enum (`1=LEDGER_POSTER_JOB`, `2=LEDGER_SETTLER_JOB`, `3=PAYOUT_GENERATOR_JOB`). Response `job_type` is the string enum name. schema: type: integer format: int32 enum: - 1 - 2 - 3 example: 2 - name: job_status in: query required: false description: > Filter by job status integer enum (`1=JOB_STATUS_STARTED`, `2=JOB_STATUS_SUCCESS`, `3=JOB_STATUS_FAILED`). Response `status` is the string enum name. schema: type: integer format: int32 enum: - 1 - 2 - 3 example: 2 - name: start_date in: query required: false description: >- Inclusive lower bound on job `started_at`, as a Unix timestamp in seconds. schema: type: integer format: int64 example: 1744531200 - name: end_date in: query required: false description: >- Inclusive upper bound on job `ended_at`, as a Unix timestamp in seconds. Must be greater than or equal to `start_date` when both are set. schema: type: integer format: int64 example: 1744617600 responses: '200': $ref: '#/components/responses/ListSettlementJobRunsResponse' '400': $ref: '#/components/responses/BadRequest' '401': $ref: '#/components/responses/Unauthorized' security: - apiKey: [] components: parameters: AggregatorIdParam: name: raast-aggregator-id in: path required: true schema: type: string example: agg_2288490a-2176-4de5-b373-0ffb6f8e2e6e description: The unique identifier for the aggregator SettlementOpsCursorParam: name: cursor in: query required: false description: >- Cursor for pagination. Pass the previous response `next_cursor`, or omit/`0` for the first page. schema: type: integer format: int64 example: 0 SettlementOpsLimitParam: name: limit in: query required: false description: Page size. Default `30`. Maximum `100`. `0` is treated as the default. schema: type: integer format: int32 example: 30 SettlementOpsDirectionParam: name: direction in: query required: false description: >- Sort direction on the underlying numeric id. Must be uppercase `ASC` or `DESC`. Invalid or empty values default to `DESC`. schema: type: string enum: - ASC - DESC example: DESC responses: ListSettlementJobRunsResponse: description: Paginated list of settlement-engine job runs. content: application/json: schema: allOf: - $ref: '#/components/schemas/StandardResponse' - type: object properties: data: type: object properties: job_run: type: array items: $ref: '#/components/schemas/SettlementJobRun' next_cursor: type: string example: '42' count: $ref: '#/components/schemas/SettlementListCount' examples: SettlementJobRunsListed: value: api_version: v1 data: job_run: - id: '42' token: job_76b08225-5372-46db-9acb-086ac9c2f7d6 job_type: LEDGER_SETTLER_JOB status: JOB_STATUS_SUCCESS started_at: '2026-04-13T11:30:00Z' ended_at: '2026-04-13T11:30:04Z' error_message: '' created_at: '2026-04-13T11:30:00Z' next_cursor: '42' count: filtered_count: '1' total_count: '3' BadRequest: description: Bad request headers: Content-Length: $ref: '#/components/headers/ContentLengthHeader' Date: $ref: '#/components/headers/DateHeader' content: application/json: schema: allOf: - $ref: '#/components/schemas/ErrorResponse' - type: object properties: code: example: error.bad_request message: example: Invalid request parameters Unauthorized: description: Unauthorized headers: Content-Length: $ref: '#/components/headers/ContentLengthHeader' Date: $ref: '#/components/headers/DateHeader' content: application/json: schema: $ref: '#/components/schemas/ApiErrorEnvelope' examples: Unauthorized: value: api_version: v1 error: code: error.unauthorized_access message: partner access key is required in request header schemas: StandardResponse: type: object description: Standard response structure for successful operations properties: api_version: type: string example: v1 description: The current version of the API spec data: type: object description: Contains the response data SettlementJobRun: type: object description: >- Settlement-engine job run metadata (ledger poster, ledger settler, or payout generator). properties: id: type: string example: '42' token: type: string example: job_76b08225-5372-46db-9acb-086ac9c2f7d6 job_type: type: string enum: - UNSPECIFIED_JOB - LEDGER_POSTER_JOB - LEDGER_SETTLER_JOB - PAYOUT_GENERATOR_JOB example: LEDGER_SETTLER_JOB status: type: string enum: - JOB_STATUS_UNSPECIFIED - JOB_STATUS_STARTED - JOB_STATUS_SUCCESS - JOB_STATUS_FAILED example: JOB_STATUS_SUCCESS started_at: $ref: '#/components/schemas/Timestamp' ended_at: allOf: - $ref: '#/components/schemas/Timestamp' nullable: true error_message: type: string example: '' created_at: $ref: '#/components/schemas/Timestamp' SettlementListCount: type: object description: Count metadata for settlement list responses. properties: filtered_count: type: string description: Number of records matching the current filters. example: '1' total_count: type: string description: Total records in the same scope before optional filters. example: '5' ErrorResponse: type: object description: Standard error response structure properties: code: type: string description: Error code identifying the type of error message: type: string description: Human-readable error message ApiErrorEnvelope: type: object description: Error wrapper that includes the API version and error metadata properties: api_version: type: string description: Indicates the API version associated with the response example: v1 error: description: Structured error details describing why the request failed allOf: - $ref: '#/components/schemas/ErrorResponse' example: code: error.unauthorized_access message: partner access key is required in request header Timestamp: type: string format: date-time description: ISO 8601 timestamp in UTC example: '2025-03-13T09:12:34.000Z' headers: ContentLengthHeader: schema: type: string example: '256' DateHeader: schema: type: string example: Sat, 12 Aug 2023 08:55:04 GMT securitySchemes: apiKey: type: apiKey name: X-SFPY-AGGREGATOR-SECRET-KEY in: header ````