> ## 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 Snapshots > List per-merchant settlement snapshots persisted for a settlement batch, including payout IBAN, account title, and amount breakdowns. `count.filtered_count` reflects optional filters; `count.total_count` is the batch total before those filters. ## OpenAPI ````yaml get /v1/aggregators/{raast-aggregator-id}/settlements/batches/{settlement-batch-id}/snapshots 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/batches/{settlement-batch-id}/snapshots: parameters: - $ref: '#/components/parameters/AggregatorIdParam' - $ref: '#/components/parameters/SettlementBatchIdParam' get: tags: - Settlement Operations summary: List Settlement Snapshots description: > List per-merchant settlement snapshots persisted for a settlement batch, including payout IBAN, account title, and amount breakdowns. `count.filtered_count` reflects optional filters; `count.total_count` is the batch total before those filters. parameters: - $ref: '#/components/parameters/SettlementOpsCursorParam' - $ref: '#/components/parameters/SettlementOpsLimitParam' - $ref: '#/components/parameters/SettlementOpsDirectionParam' - name: settlement_txn_id in: query required: false description: Filter by settlement transaction token (`stxn_…`). schema: type: string example: stxn_9d5bd7bd-863a-487f-944c-f15d30d9bbc5 - name: merchant_id in: query required: false description: Filter by Raast merchant token (`mer_…`). schema: type: string example: mer_ce6df98c-cdde-48bf-bc32-464cecac2ee3 responses: '200': $ref: '#/components/responses/ListSettlementSnapshotsResponse' '400': $ref: '#/components/responses/BadRequest' '401': $ref: '#/components/responses/Unauthorized' '404': $ref: '#/components/responses/NotFound' 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 SettlementBatchIdParam: name: settlement-batch-id in: path required: true description: >- Settlement batch token. Must start with `sb_` and be exactly 39 characters. schema: type: string example: sb_1328a110-2cf5-4e13-993e-55792ec6b76c 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: ListSettlementSnapshotsResponse: description: Paginated list of settlement snapshots for a batch. content: application/json: schema: allOf: - $ref: '#/components/schemas/StandardResponse' - type: object properties: data: type: object properties: settlement_snapshots: type: array items: $ref: '#/components/schemas/SettlementSnapshot' next_cursor: type: string example: '44' count: $ref: '#/components/schemas/SettlementListCount' examples: SettlementSnapshotsListed: value: api_version: v1 data: settlement_snapshots: - id: '44' batch_id: sb_1328a110-2cf5-4e13-993e-55792ec6b76c settlement_transaction_id: stxn_9d5bd7bd-863a-487f-944c-f15d30d9bbc5 merchant_id: mer_ce6df98c-cdde-48bf-bc32-464cecac2ee3 aggregator_id: agg_b49985f2-e099-412e-8eb2-98756059cc0d iban: PK36SCBL0000001123456702 account_title: OPTIVOLVE DIGITAL gross_amount: '7900' net_amount: '7620' fee_amount: '39' sales_tax_on_fee_amount: '4' sales_tax_withholding_amount: '158' income_tax_withholding_amount: '79' digital_tax_amount: '0' currency: PKR created_at: '2026-07-23T11:30:06Z' next_cursor: '44' count: filtered_count: '1' total_count: '5' 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 NotFound: description: Resource not found 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.not_found message: example: Requested resource not found 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 SettlementSnapshot: type: object description: Per-merchant settlement snapshot captured for a batch. properties: id: type: string example: '44' batch_id: type: string example: sb_1328a110-2cf5-4e13-993e-55792ec6b76c settlement_transaction_id: type: string example: stxn_9d5bd7bd-863a-487f-944c-f15d30d9bbc5 merchant_id: type: string example: mer_ce6df98c-cdde-48bf-bc32-464cecac2ee3 aggregator_id: type: string example: agg_b49985f2-e099-412e-8eb2-98756059cc0d iban: type: string example: PK36SCBL0000001123456702 account_title: type: string example: OPTIVOLVE DIGITAL gross_amount: type: string example: '7900' net_amount: type: string example: '7620' fee_amount: type: string example: '39' sales_tax_on_fee_amount: type: string example: '4' sales_tax_withholding_amount: type: string example: '158' income_tax_withholding_amount: type: string example: '79' digital_tax_amount: type: string example: '0' currency: type: string example: PKR 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 ````