MOmollie
Settlements API

List settlement captures

Changed on

Retrieve all captures included in the given settlement.

The response is in the same format as the response of the List captures endpoint.

get/v2/settlements/{settlementId}/captures

Request

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

Query parameters

fromstring
Example:cpt_vytxeTZskVKR7C7WgdSP3d

Provide an ID to start the result set from the item with the given ID and onwards. This allows you to paginate the result set.

limitinteger nullable
Example:50

The maximum number of items to return. Defaults to 50 items.

embedstring nullable

This endpoint allows embedding related API items by appending the following values via the embed query string parameter.

Headers

idempotency-keystring
Example:123e4567-e89b-12d3-a456-426

A unique key to ensure idempotent requests. This key should be a UUID v4 string.

Response

A list of capture objects.

countinteger 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.

Example response

{
  "count": 5,
  "_embedded": {
    "captures": [
      {
        "resource": "capture",
        "id": "cpt_vytxeTZskVKR7C7WgdSP3d",
        "mode": "live",
        "description": "Capture for cart #12345",
        "amount": {
          "currency": "EUR",
          "value": "10.00"
        },
        "status": "succeeded",
        "paymentId": "tr_5B8cwPMGnU",
        "shipmentId": "shp_5x4xQJDWGNcY3tKGL7X5J",
        "settlementId": "stl_5B8cwPMGnU",
        "createdAt": "2024-03-20T09:13:37+00:00",
        "_links": {
          "self": {
            "href": "https://...",
            "type": "application/hal+json"
          },
          "payment": {
            "href": "https://...",
            "type": "application/hal+json"
          },
          "settlement": {
            "href": "https://...",
            "type": "application/hal+json"
          },
          "shipment": {
            "href": "https://...",
            "type": "application/hal+json"
          }
        },
        "settlementAmount": {
          "currency": "EUR",
          "value": "10.00"
        }
      }
    ]
  },
  "_links": {
    "self": {
      "href": "https://...",
      "type": "application/hal+json"
    },
    "previous": {
      "href": "https://...",
      "type": "application/hal+json"
    },
    "next": {
      "href": "https://...",
      "type": "application/hal+json"
    },
    "documentation": {
      "href": "https://...",
      "type": "application/hal+json"
    }
  }
}

Changes

  • 392e474e7edcRevision changes
    • info

      added the optional write-only property _embedded/captures/items/allOf[list-capture-response]/allOf[list-entity-capture]/testmode to the response with the status

  • 1bcb76dbe9eaRevision changes
    • breaking

      the response property's min was decreased from 1.00 to 0.00 for the response status