Sign in
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.

Changes

Changed in 5 of the 92 revisions of this API.8

  • 392e474e7edc2See the full diff
    • ○

      added the new optional request property

      new-optional-request-property

    • ○

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

      response-optional-write-only-property-added

  • e8c8cac713801See the full diff
    • ○

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

      response-body-all-of-removed

  • 7cab62b218301See the full diff
    • ○

      added the non-success response with the status

      response-non-success-status-added

  • ef4b5a97b56a2See the full diff
    • ○

      the endpoint scheme security advancedAccessToken was added to the API

      api-security-added

    • ○

      the endpoint scheme security organizationAccessToken was removed from the API

      api-security-removed

    This revision also has 4 changes that name no endpoint, such as unreferenced schemas being removed. See the revision's changelog

  • 18e0e58eb54d2See the full diff
    • ○

      request property deprecated

      request-property-deprecated

    • ○

      response property allOf[entity-capture-response]/settlementAmount deprecated

      response-property-deprecated

Of the 92 revisions, 9 have no diff computed.