MOmollie
Captures API

Get capture

Changed on

Retrieve a single payment capture by its ID and the ID of its parent payment.

get/v2/payments/{paymentId}/captures/{captureId}

Request

  • Base URL
    https://api.mollie.com
  • URL
    https://api.mollie.com/v2/payments/{paymentId}/captures/{captureId}
  • 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

embedstring nullable

This endpoint allows embedding related API items by appending the following values 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.

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

The capture object.

resourcestring

Indicates the response contains a capture object. Will always contain the string capture for this endpoint.

idstring
mode'live' | 'test'

Whether this entity was created in live mode or in test mode.

descriptionstring

The description of the capture.

status'pending' | 'succeeded' | 'failed'

The capture's status.

paymentIdstring
shipmentIdstring
settlementIdstring
createdAtstring

The entity's date and time of creation, in ISO 8601 format.

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

Example response

{
  "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"
    },
    "documentation": {
      "href": "https://...",
      "type": "application/hal+json"
    }
  }
}

Changes

  • 392e474e7edcRevision changes
    • info

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

  • e8c8cac71380Revision changes
    • info

      removed subschema #2 from the response body allOf list for the response status