MOmollie
Captures API

List captures

Changed on

Retrieve a list of all captures created for a specific payment.

The results are paginated.

🔑 Access with

API key

Advanced access token with payments.read

OAuth access with payments.read

get/payments/{paymentId}/captures

Request

  • Base URL
    https://api.mollie.com/v2
  • URL
    https://api.mollie.com/v2/payments/{paymentId}/captures
  • Auth
    • HTTP bearer
    • or HTTP bearer
    • or OAuth 2
      Authorization code: https://my.mollie.com/oauth2/authorize
      Token URL: https://api.mollie.com/oauth2/tokens scopes: 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.

embed'payment'
Example:payment

This endpoint allows you to embed additional resources via the embed query string parameter.

testmodeboolean

Most API credentials are specifically created for either live mode or test mode. In those cases the testmode query parameter must not be sent. For organization-level credentials such as OAuth access tokens, you can enable test mode by setting the testmode query parameter to true.

Test entities cannot be retrieved when the endpoint is set to live mode, and vice versa.

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"
        },
        "settlementAmount": {
          "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"
          }
        }
      }
    ]
  },
  "_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

  • 64fc448adebbRevision changes
    • info

      added the optional write-only property _embedded/captures/items/allOf[subschema #1]/testmode to the response with the status