---
title: "aid_settlements_list"
method: GET
path: "/accounts/{aid}/settlements"
tags: ["settlements"]
---

# aid_settlements_list

`GET /accounts/{aid}/settlements`

List settlements

*scopes*:
  - admin:billing
  - read:billing
  - admin:reports
  - read:reports
  - admin:settlements
  - read:settlements

## Path parameters

- `aid` string, ^[PT]{1}\d{8}$, required

## Query parameters

- `limit` integer
- `starting_after_id` string
- `starting_after_date` string
- `created_at.gte` string, date
- `created_at.lte` string, date
- `item_created_at.gte` string, date
- `item_created_at.lte` string, date
- `payment_provider` string[]
- `payout_destination_id` string
- `search` string

## Response `200`

Settlements List

- SettlementResponse
  - `items` SettlementItem[]
    - `id` string — Unique identifier for the settlement
    - `start_at` string, datetime — Time of first payment event in this settlement
    - `end_at` string, datetime — Time of last payment event in this settlement
    - `created_at` string, datetime
    - `updated_at` string, datetime
    - `settled_at` string, datetime — Settlement date
    - `email_received_at` string — Time of email received in Dintero's system
    - `provider` string — Name of payment provider.
    - `provider_reference` string — The provider's unique id of the settlement
    - `attachments` object[]
      - `id` string — Unique id of the attachment
      - `key` string — Attachment path
      - `content_type` string
      - `extension` string
      - `created_by` string — Where the attachment was created. Might be created by dintero, or might be created by the providers, e.g. payex, vipps, collector
    - `amounts` object[]
      - `amount` number — The amount paid out, unless payment_status is postponed. `amount = capture - refund - fee`
      - `capture` number — The amount captured on the orders in the settlement period.
      - `refund` number — The amount refunded on the orders in the settlement period.
      - `fee` number — The sum of fees on the orders in the settlement period.
      - `currency` string, iso4217-code
    - `payment_status` 'paid' | 'postponed' — Whether the amount in the report has actually been paid or not. The payment might be postponed for later.
    - `store_id` string — The sales location this report is for. Will only be set if all transactions share the same store_id.
    - `payout_destination_id` string — The seller id this report is for. Will only be set if all transactions share the same payout_destination_id.
  - `last_evaluated_key` object — Details included for use in pagination. Use the value of `settled_at`| or `created_at` and `id` as `starting_after_id` and `starting_after_date` parameter to retrieve the next page of settlements.
    - `id` string
    - `account_id` string
    - `settled_at` string, datetime
    - `created_at` string, datetime — Included when filtering by `item_created_at.gte` and/or `item_created_at.lte`, the value to use for `starting_after_date`

## Other responses

- `400` — Bad request - invalid filters
- `401` — Unauthorized
- `403` — Forbidden
- `500` — Unexpected Error

---

[API](https://skmtc.net/dintero/apis/account-management-api.md) · [All operations](https://skmtc.net/dintero/apis/account-management-api/llms.txt) · [OpenAPI document](https://skmtc-service-staging.skmtc.workers.dev/v1/apis/dintero/account-management-api/revisions/9b83a4199008/schema)