Create capture

post

https://api.mollie.com/v2/payments/{paymentId}/captures

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.

🔑
Access with
API key Advanced access token with payments.writeOAuth access with payments.write

Path Params

paymentId

string

required

^tr_.+$

Provide the ID of the related payment.

Body Params

description

string

length ≤ 255

The description of the capture.

amount

object | null

The amount captured. If no amount is provided, the full authorized amount is captured.

metadata

Provide any data you like, for example a string or a JSON object. We will save the data alongside the entity. Whenever you fetch the entity with our API, we will also include the metadata. You can use up to approximately 1kB.

testmode

boolean | null

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.

Responses

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

404No entity with this ID exists.

422The request contains issues. For example, if the capture amount is missing.

429Rate Limit has been reached.