> ## Documentation Index > Fetch the complete documentation index at: https://help.dash.fi/llms.txt > Use this file to discover all available pages before exploring further. # List card settlements > Retrieves card settlements within a specified date range (max 1 year). Requires `from` and `to` query parameters in YYYY-MM-DD format. Each entry represents a single settlement (presentment or chargeback) and carries `paymentId` linking it to the payment that cleared it. For the full transaction lifecycle (pending / declined / settled / released) or to reconcile against webhook `transactionId`, use `/transactions`. ## OpenAPI ````yaml https://api.dash.fi/v1/public/swagger/doc.json get /settlements openapi: 3.1.0 info: contact: email: support@dash.fi name: Dash.fi Support description: >- Service allows to fetch or operate on the data from the Dash.fi API. Requires API key authentication via Bearer token. Provide your API key as a Bearer token in the `Authorization` header. Example: `Authorization: Bearer YOUR_API_KEY` title: Public Dash.fi API version: '1.0' servers: - url: https://api.dash.fi/v1/public security: - BearerAuth: [] tags: - description: > Subscribe URLs to receive POSTed events as they happen in your account. Each endpoint subscribes to one or more **topics**; when a topic fires, Dash.fi delivers the event to your URL with a JSON body matching the topic's payload schema. There is no envelope — the body is the event payload directly. Event metadata (id, topic, timestamp, signature) is carried in headers. ### Topic → payload schema Topics are versioned: the format is `..v`. Breaking changes ship as a **new** topic (`.v2`) — the old version keeps delivering its existing schema until it's retired, so subscriptions are pinned and never shift schema underneath you. | Topic | Body schema | |---|---| | `card.financial_event.v1` | `CardFinancialEvent` — see `GET /cards/{id}/financial-events` in the **Card** section for the authoritative field list. | ### Delivery shape ``` POST HTTP/1.1 Content-Type: application/json X-Outpost-Event-Id: evt_abc123 X-Outpost-Topic: card.financial_event.v1 X-Outpost-Timestamp: 2026-05-05T10:00:00Z X-Outpost-Signature: v0= { ...payload matching the topic's schema... } ``` | Header | Meaning | |---|---| | `X-Outpost-Event-Id` | Stable event identifier — the same id is sent on retries. Use it to deduplicate; delivery is **at-least-once**. | | `X-Outpost-Topic` | The topic that fired this delivery. | | `X-Outpost-Timestamp` | RFC 3339 time the event was emitted. Reject deliveries where this drifts too far from your clock to mitigate replay. | | `X-Outpost-Signature` | `v0=` HMAC-SHA256 of the raw request body, keyed with your endpoint's signing secret. | ### Verifying the signature The signature is computed over the **raw request body**: ``` HMAC-SHA256(signing_secret, raw_body) ``` Encoded as hex, prefixed with `v0=`. **Use a constant-time comparison** to avoid timing attacks. `rawBody` is the unparsed request body — the exact `Buffer` or string you received over the wire, not a re-serialised JSON object. ```js import { createHmac, timingSafeEqual } from 'node:crypto'; function verify(rawBody, signatureHeader, secret) { if (!signatureHeader) return false; const expected = 'v0=' + createHmac('sha256', secret).update(rawBody).digest('hex'); // Header may carry multiple comma-separated signatures during a rotation window. return signatureHeader.split(',').some((sig) => { const got = Buffer.from(sig.trim()); const want = Buffer.from(expected); return got.length === want.length && timingSafeEqual(got, want); }); } ``` ### Secret rotation Rotating a signing secret keeps the previous secret valid for 24 hours so you can roll the new one out without dropped deliveries. During that window, the `X-Outpost-Signature` header carries comma-separated signatures (`v0=,v0=`); accept either. The new secret is shown **once** at rotation and is never retrievable later. name: Webhooks externalDocs: description: OpenAPI JSON Specification url: /v1/public/swagger/doc.json paths: /settlements: get: tags: - Financial summary: List card settlements description: >- Retrieves card settlements within a specified date range (max 1 year). Requires `from` and `to` query parameters in YYYY-MM-DD format. Each entry represents a single settlement (presentment or chargeback) and carries `paymentId` linking it to the payment that cleared it. For the full transaction lifecycle (pending / declined / settled / released) or to reconcile against webhook `transactionId`, use `/transactions`. parameters: - description: 'Start date for the query range (inclusive), Format: YYYY-MM-DD' example: '2024-01-01' in: query name: from required: true schema: type: string - description: 'End date for the query range (exclusive), Format: YYYY-MM-DD' example: '2024-12-31' in: query name: to required: true schema: type: string responses: '200': content: application/json: schema: $ref: '#/components/schemas/GetSettlementsResponse' description: A list of settlements matching the criteria '400': content: application/json: schema: $ref: '#/components/schemas/ValidationErrorResponse' description: Validation error for query parameters (format, range, etc.) '401': content: application/json: schema: $ref: '#/components/schemas/UnauthorizedErrorResponse' description: Unauthorized access '500': content: application/json: schema: $ref: '#/components/schemas/InternalServerErrorResponse' description: Internal server error components: schemas: GetSettlementsResponse: properties: data: items: $ref: '#/components/schemas/Settlement' type: array uniqueItems: false required: - data type: object ValidationErrorResponse: properties: code: type: string message: type: string required: - code type: object UnauthorizedErrorResponse: properties: code: example: unauthorized type: string message: example: authorization header not provided type: string required: - code type: object InternalServerErrorResponse: properties: code: example: internal-server-error type: string message: type: string required: - code type: object Settlement: properties: cardName: description: Card name. example: Test Card type: string createdAt: description: Settlement creation timestamp. example: '2025-01-11T22:10:43.979Z' format: YYYY-MM-DDTHH:MM:SS.MSZ type: string id: description: Unique identifier for the settlement. example: a1b2c3d4-e5f6-7890-1234-567890abcdef format: uuid type: string merchantName: description: >- Card acceptor / merchant name. Omitted when the settlement carries none. example: TARGET.COM type: string paymentId: description: Identifier of the payment that cleared this settlement, if any. example: b1a2d3c4-e5f6-7890-1234-567890fedcba format: uuid type: string settledAmount: description: Settled amount. example: '123.45' format: decimal multiple of 0.01 type: string settlementDate: description: Date the settlement cleared (UTC), formatted YYYY-MM-DD. example: '2025-01-12' format: YYYY-MM-DD type: string required: - cardName - createdAt - id - settledAmount - settlementDate type: object securitySchemes: BearerAuth: description: >- Type "Bearer" followed by a space and your API token. Obtain your key from the Dash.fi dashboard. Example: "Bearer YOUR_API_KEY" in: header name: Authorization type: apiKey ````