v64

latestOpenAPI 3.1.0CC-BY-NC-SA-4.0raw.githubusercontent.com2026-08-071243861.8 MB

Captures API

Create capture

Capture an authorized payment.

Some payment methods allow you to first collect a customer's authorization, and capture the amount at a later point.

By default, Mollie captures payments automatically. If however you configured your payment with captureMode: manual, you can capture the payment using this endpoint after having collected the customer's authorization.

post/v2/payments/{paymentId}/captures

Headers

idempotency-keystring

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

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

Request body

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 request

{
  "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"
    }
  }
}

Response

The newly created capture object. For a complete reference of the capture object, refer to the Get capture endpoint documentation.