---
title: "List settlement captures"
method: GET
path: "/settlements/{settlementId}/captures"
tags: ["Settlements API"]
---

# List settlement captures

`GET /settlements/{settlementId}/captures`

## Request

- Base URL: `https://api.mollie.com/v2`
- URL: `https://api.mollie.com/v2/settlements/{settlementId}/captures`
- Auth: one of:
  - HTTP bearer
  - OAuth 2
    - Authorization code: `https://my.mollie.com/oauth2/authorize`
    - Token URL: `https://api.mollie.com/oauth2/tokens` scopes: `settlements.read`, `payments.read`

Retrieve all captures included in the given settlement.

The response is in the same format as the response of the [List captures endpoint](list-captures).

> 🔑 Access with
>
> [Advanced access token with **settlements.read** **payments.read**](/reference/authentication)
>
> [OAuth access with **settlements.read** **payments.read**](/reference/authentication)

## Query parameters

- `from` string
- `limit` integer, nullable
- `embed` 'payment'

## Response `200`

A list of capture objects.

- object
  - `count` integer, required: The number of items in this result set. If more items are available, a `_links.next` URL will be present in the result as well. The maximum number of items per result set is controlled by the `limit` property provided in the request. The default limit is 50 items.
  - `_embedded` object, required
    - `captures` object[], required: An array of capture objects.
      - `resource` string, required: Indicates the response contains a capture object. Will always contain the string `capture` for this endpoint.
      - `id` string, required: The identifier uniquely referring to this capture. Example: `cpt_mNepDkEtco6ah3QNPUGYH`.
      - `mode` string, required: Whether this entity was created in live mode or in test mode. Settlements are always in live mode. Possible values: `live`
      - `description` string: The description of the capture.
      - `amount` object, nullable, required: The amount captured. If no amount is provided, the full authorized amount is captured.
        - `currency` string, required: A three-character ISO 4217 currency code.
        - `value` string, required: A string containing an exact monetary amount in the given currency.
      - `settlementAmount` object, nullable: The amount settled to your account for this capture, converted to the currency your account is settled in.
        - `currency` string, required: A three-character ISO 4217 currency code.
        - `value` string, required: A string containing an exact monetary amount in the given currency.
      - `status` string, required: The capture's status. Settlement captures always have a status of `succeeded`. Possible values: `succeeded`
      - `metadata` union: Provide any data you like, for example a string or a JSON object. We will save the data alongside the entity. Whenever you fetch the entity with our API, we will also include the metadata. You can use up to approximately 1kB.
        - string
        - number
        - object
        - string[]
      - `paymentId` string, required: The unique identifier of the payment this capture was created for. For example: `tr_5B8cwPMGnU6qLbRvo7qEZo`. The full payment object can be retrieved via the payment URL in the `_links` object.
      - `shipmentId` string, nullable: The unique identifier of the shipment that triggered the creation of this capture, if applicable. For example: `shp_gNapNy9qQTUFZYnCrCF7J`.
      - `settlementId` string, nullable: The identifier referring to the settlement this capture was settled with. For example, `stl_BkEjN2eBb`. This field is omitted if the capture is not settled (yet).
      - `createdAt` string, required: The entity's date and time of creation, in [ISO 8601](https://en.wikipedia.org/wiki/ISO_8601) format.
      - `testmode` boolean, nullable: Whether to create the entity in test mode or live mode. Most API credentials are specifically created for either live mode or test mode, in which case this parameter must not be sent. For organization-level credentials such as OAuth access tokens, you can enable test mode by setting `testmode` to `true`.
      - `_links` object, required: An object with several relevant URLs. Every URL object will contain an `href` and a `type` field.
        - `self` object, required: In v2 endpoints, URLs are commonly represented as objects with an `href` and `type` field.
          - `href` string, required: The actual URL string.
          - `type` string, required: The content type of the page or endpoint the URL points to.
        - `payment` object, required: The API resource URL of the [payment](get-payment) that this capture belongs to.
          - `href` string, required: The actual URL string.
          - `type` string, required: The content type of the page or endpoint the URL points to.
        - `settlement` object, nullable: The API resource URL of the [settlement](get-settlement) this capture has been settled with. Not present if not yet settled.
          - `href` string: The actual URL string.
          - `type` string: The content type of the page or endpoint the URL points to.
        - `shipment` object, nullable: The API resource URL of the [shipment](get-shipment) this capture is associated with. Not present if it isn't associated with a shipment.
          - `href` string: The actual URL string.
          - `type` string: The content type of the page or endpoint the URL points to.
  - `_links` object, required: Links to help navigate through the lists of items. Every URL object will contain an `href` and a `type` field.
    - `self` object, required: The URL to the current set of items.
      - `href` string, required: The actual URL string.
      - `type` string, required: The content type of the page or endpoint the URL points to.
    - `previous` object, nullable, required: The previous set of items, if available.
      - `href` string: The actual URL string.
      - `type` string: The content type of the page or endpoint the URL points to.
    - `next` object, nullable, required: The next set of items, if available.
      - `href` string: The actual URL string.
      - `type` string: The content type of the page or endpoint the URL points to.
    - `documentation` object, required: In v2 endpoints, URLs are commonly represented as objects with an `href` and `type` field.
      - `href` string, required: The actual URL string.
      - `type` string, required: The content type of the page or endpoint the URL points to.

## Other responses

- `400`: The request contains issues. For example, if the specified `from` value is not a valid ID.
- `404`: No entity with this ID exists.
- `429`: Rate Limit has been reached.

---

[API](https://skmtc.dev/mollie/apis/business-operations.md) - [All operations](https://skmtc.dev/mollie/apis/business-operations/llms.txt) - [OpenAPI document](https://skmtc.dev/mollie/apis/business-operations/revisions/d51d76f4e5d9?raw)