# Get capture

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

> 🔑 Access with
>
> [API key](/reference/authentication)
>
> [Organization access token with **payments.read**](/reference/authentication)
>
> [OAuth access with **payments.read**](/reference/authentication)

# OpenAPI definition

```json
{
  "openapi": "3.1.0",
  "info": {
    "title": "Accepting payments",
    "version": "1.0.0",
    "license": {
      "name": "Attribution-NonCommercial-ShareAlike 4.0 International",
      "identifier": "CC-BY-NC-SA-4.0"
    }
  },
  "servers": [
    {
      "url": "https://api.mollie.com/v2"
    }
  ],
  "security": [
    {
      "apiKey": []
    },
    {
      "organizationAccessToken": []
    },
    {
      "oAuth": []
    }
  ],
  "paths": {
    "/payments/{paymentId}/captures/{captureId}": {
      "parameters": [
        {
          "name": "paymentId",
          "description": "Provide the ID of the related payment.",
          "in": "path",
          "required": true,
          "schema": {
            "type": "string",
            "pattern": "^tr_.+$",
            "example": "tr_5B8cwPMGnU"
          }
        },
        {
          "name": "captureId",
          "description": "Provide the ID of the related capture.",
          "in": "path",
          "required": true,
          "schema": {
            "type": "string",
            "pattern": "^cpt_.+$",
            "example": "cpt_vytxeTZskVKR7C7WgdSP3d"
          }
        }
      ],
      "get": {
        "summary": "Get capture",
        "x-speakeasy-name-override": "get",
        "tags": [
          "Captures API"
        ],
        "operationId": "get-capture",
        "security": [
          {
            "apiKey": []
          },
          {
            "organizationAccessToken": [
              "payments.read"
            ]
          },
          {
            "oAuth": [
              "payments.read"
            ]
          }
        ],
        "description": "Retrieve a single payment capture by its ID and the ID of its parent payment.\n\n> 🔑 Access with\n>\n> [API key](/reference/authentication)\n>\n> [Organization access token with **payments.read**](/reference/authentication)\n>\n> [OAuth access with **payments.read**](/reference/authentication)",
        "parameters": [
          {
            "description": "This endpoint allows you to embed additional resources via the `embed` query string parameter.",
            "schema": {
              "type": "string",
              "enum": [
                "payment"
              ],
              "x-enumDescriptions": {
                "payment": "Embed the payment this capture was created for."
              },
              "example": "payment"
            },
            "name": "embed",
            "in": "query"
          },
          {
            "name": "testmode",
            "description": "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`.\n\nTest entities cannot be retrieved when the endpoint is set to live mode, and vice versa.",
            "in": "query",
            "schema": {
              "type": "boolean",
              "example": false
            }
          }
        ],
        "responses": {
          "200": {
            "description": "The capture object.",
            "content": {
              "application/hal+json": {
                "schema": {
                  "allOf": [
                    {
                      "type": "object",
                      "properties": {
                        "resource": {
                          "type": "string",
                          "description": "Indicates the response contains a capture object. Will always contain the string `capture` for this endpoint.",
                          "readOnly": true,
                          "example": "capture"
                        },
                        "id": {
                          "allOf": [
                            {
                              "type": "string",
                              "pattern": "^cpt_.+$",
                              "example": "cpt_vytxeTZskVKR7C7WgdSP3d"
                            }
                          ],
                          "description": "The identifier uniquely referring to this capture. Example: `cpt_mNepDkEtco6ah3QNPUGYH`.",
                          "readOnly": true
                        },
                        "mode": {
                          "type": "string",
                          "description": "Whether this entity was created in live mode or in test mode.\n\nPossible values: `live` `test`",
                          "readOnly": true,
                          "example": "live"
                        },
                        "description": {
                          "type": "string",
                          "description": "The description of the capture.",
                          "maxLength": 255,
                          "example": "Capture for cart #12345"
                        },
                        "amount": {
                          "description": "The amount captured. If no amount is provided, the full authorized amount is captured.",
                          "type": [
                            "object",
                            "null"
                          ],
                          "required": [
                            "currency",
                            "value"
                          ],
                          "properties": {
                            "currency": {
                              "type": "string",
                              "description": "A three-character ISO 4217 currency code.",
                              "example": "EUR"
                            },
                            "value": {
                              "type": "string",
                              "description": "A string containing an exact monetary amount in the given currency.",
                              "example": "10.00"
                            }
                          }
                        },
                        "settlementAmount": {
                          "allOf": [
                            {
                              "type": [
                                "object",
                                "null"
                              ],
                              "description": "In v2 endpoints, monetary amounts are represented as objects with a `currency` and `value` field.",
                              "required": [
                                "currency",
                                "value"
                              ],
                              "properties": {
                                "currency": {
                                  "type": "string",
                                  "description": "A three-character ISO 4217 currency code.",
                                  "example": "EUR"
                                },
                                "value": {
                                  "type": "string",
                                  "description": "A string containing an exact monetary amount in the given currency.",
                                  "example": "10.00"
                                }
                              }
                            }
                          ],
                          "description": "This optional field will contain the approximate amount that will be settled to your account, converted to the currency your account is settled in.\n\nSince the field contains an estimated amount during capture processing, it may change over time. To retrieve accurate settlement amounts we recommend using the [List balance transactions endpoint](list-balance-transactions) instead.",
                          "readOnly": true
                        },
                        "status": {
                          "allOf": [
                            {
                              "type": "string",
                              "description": "The capture's status.\n\nPossible values: `pending` `succeeded` `failed`",
                              "example": "succeeded"
                            }
                          ],
                          "readOnly": true
                        },
                        "metadata": {
                          "oneOf": [
                            {
                              "type": "string"
                            },
                            {
                              "type": "number"
                            },
                            {
                              "type": "object",
                              "properties": {},
                              "additionalProperties": true
                            },
                            {
                              "type": "array",
                              "items": {
                                "type": "string"
                              }
                            },
                            {
                              "type": "null"
                            }
                          ],
                          "description": "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."
                        },
                        "paymentId": {
                          "allOf": [
                            {
                              "type": "string",
                              "pattern": "^tr_.+$",
                              "example": "tr_5B8cwPMGnU"
                            }
                          ],
                          "description": "The unique identifier of the payment this capture was created for. For example: `tr_5B8cwPMGnU6qLbRvo7qEZo`. The full payment object can be retrieved via the payment URL in the `_links` object.",
                          "readOnly": true
                        },
                        "shipmentId": {
                          "type": [
                            "string",
                            "null"
                          ],
                          "allOf": [
                            {
                              "type": "string",
                              "pattern": "^shp_.+$",
                              "example": "shp_5x4xQJDWGNcY3tKGL7X5J"
                            }
                          ],
                          "description": "The unique identifier of the shipment that triggered the creation of this capture, if applicable. For example: `shp_gNapNy9qQTUFZYnCrCF7J`.",
                          "readOnly": true
                        },
                        "settlementId": {
                          "type": [
                            "string",
                            "null"
                          ],
                          "allOf": [
                            {
                              "type": "string",
                              "pattern": "^stl_.+$",
                              "example": "stl_5B8cwPMGnU"
                            }
                          ],
                          "description": "The identifier referring to the settlement this capture was settled with. For example, `stl_BkEjN2eBb`. This field is omitted if the capture is not settled (yet).",
                          "readOnly": true
                        },
                        "createdAt": {
                          "type": "string",
                          "description": "The entity's date and time of creation, in [ISO 8601](https://en.wikipedia.org/wiki/ISO_8601) format.",
                          "readOnly": true,
                          "example": "2024-03-20T09:13:37+00:00"
                        },
                        "_links": {
                          "type": "object",
                          "description": "An object with several relevant URLs. Every URL object will contain an `href` and a `type` field.",
                          "required": [
                            "self",
                            "payment",
                            "documentation"
                          ],
                          "properties": {
                            "self": {
                              "type": "object",
                              "description": "In v2 endpoints, URLs are commonly represented as objects with an `href` and `type` field.",
                              "required": [
                                "href",
                                "type"
                              ],
                              "properties": {
                                "href": {
                                  "type": "string",
                                  "description": "The actual URL string.",
                                  "example": "https://..."
                                },
                                "type": {
                                  "type": "string",
                                  "description": "The content type of the page or endpoint the URL points to.",
                                  "example": "application/hal+json"
                                }
                              }
                            },
                            "payment": {
                              "description": "The API resource URL of the [payment](get-payment) that this capture belongs to.",
                              "type": "object",
                              "required": [
                                "href",
                                "type"
                              ],
                              "properties": {
                                "href": {
                                  "type": "string",
                                  "description": "The actual URL string.",
                                  "example": "https://..."
                                },
                                "type": {
                                  "type": "string",
                                  "description": "The content type of the page or endpoint the URL points to.",
                                  "example": "application/hal+json"
                                }
                              }
                            },
                            "settlement": {
                              "description": "The API resource URL of the [settlement](get-settlement) this capture has been settled with. Not present if not yet settled.",
                              "type": [
                                "object",
                                "null"
                              ],
                              "properties": {
                                "href": {
                                  "type": "string",
                                  "description": "The actual URL string.",
                                  "example": "https://..."
                                },
                                "type": {
                                  "type": "string",
                                  "description": "The content type of the page or endpoint the URL points to.",
                                  "example": "application/hal+json"
                                }
                              }
                            },
                            "shipment": {
                              "description": "The API resource URL of the [shipment](get-shipment) this capture is associated with. Not present if it isn't associated with a shipment.",
                              "type": [
                                "object",
                                "null"
                              ],
                              "properties": {
                                "href": {
                                  "type": "string",
                                  "description": "The actual URL string.",
                                  "example": "https://..."
                                },
                                "type": {
                                  "type": "string",
                                  "description": "The content type of the page or endpoint the URL points to.",
                                  "example": "application/hal+json"
                                }
                              }
                            },
                            "documentation": {
                              "type": "object",
                              "description": "In v2 endpoints, URLs are commonly represented as objects with an `href` and `type` field.",
                              "required": [
                                "href",
                                "type"
                              ],
                              "properties": {
                                "href": {
                                  "type": "string",
                                  "description": "The actual URL string.",
                                  "example": "https://..."
                                },
                                "type": {
                                  "type": "string",
                                  "description": "The content type of the page or endpoint the URL points to.",
                                  "example": "application/hal+json"
                                }
                              }
                            }
                          },
                          "readOnly": true
                        }
                      }
                    },
                    {
                      "type": "object",
                      "required": [
                        "resource",
                        "id",
                        "mode",
                        "amount",
                        "status",
                        "createdAt",
                        "paymentId",
                        "_links"
                      ]
                    }
                  ]
                },
                "examples": {
                  "get-capture-200-1": {
                    "summary": "The capture object",
                    "value": {
                      "resource": "capture",
                      "id": "cpt_vytxeTZskVKR7C7WgdSP3d",
                      "mode": "live",
                      "description": "Capture for cart #12345",
                      "amount": {
                        "currency": "EUR",
                        "value": "35.95"
                      },
                      "metadata": "{\"bookkeeping_id\":12345}",
                      "status": "pending",
                      "paymentId": "tr_5B8cwPMGnU6qLbRvo7qEZo",
                      "createdAt": "2023-08-02T09:29:56+00:00",
                      "_links": {
                        "self": {
                          "href": "...",
                          "type": "application/hal+json"
                        },
                        "payment": {
                          "href": "https://api.mollie.com/v2/payments/tr_5B8cwPMGnU6qLbRvo7qEZo",
                          "type": "application/hal+json"
                        },
                        "documentation": {
                          "href": "...",
                          "type": "text/html"
                        }
                      }
                    }
                  },
                  "get-capture-200-2": {
                    "summary": "Get capture",
                    "value": {
                      "resource": "capture",
                      "id": "cpt_vytxeTZskVKR7C7WgdSP3d",
                      "mode": "test",
                      "amount": {
                        "value": "467.92",
                        "currency": "EUR"
                      },
                      "settlementAmount": {
                        "value": "467.92",
                        "currency": "EUR"
                      },
                      "createdAt": "2021-06-03T11:50:58+00:00",
                      "status": "pending",
                      "paymentId": "tr_V9kqkGtyUH",
                      "shipmentId": "shp_5x4xQJDWGNcY3tKGL7X5J",
                      "_links": {
                        "self": {
                          "href": "...",
                          "type": "application/hal+json"
                        },
                        "payment": {
                          "href": "https://api.mollie.com/v2/payments/tr_V9kqkGtyUH",
                          "type": "application/hal+json"
                        },
                        "shipment": {
                          "href": "https://api.mollie.com/v2/orders/ord_uvpptr/shipments/shp_5x4xQJDWGNcY3tKGL7X5J",
                          "type": "application/hal+json"
                        },
                        "documentation": {
                          "href": "...",
                          "type": "text/html"
                        }
                      }
                    }
                  }
                }
              }
            }
          },
          "404": {
            "description": "No entity with this ID exists.",
            "content": {
              "application/hal+json": {
                "schema": {
                  "type": "object",
                  "description": "An error response object.",
                  "required": [
                    "status",
                    "title",
                    "detail",
                    "_links"
                  ],
                  "properties": {
                    "status": {
                      "type": "integer",
                      "description": "The status code of the error message. This is always the same code as the status code of the HTTP message itself.",
                      "minimum": 400,
                      "maximum": 599,
                      "example": 404
                    },
                    "title": {
                      "type": "string",
                      "description": "The HTTP reason phrase of the error. For example, for a `404` error, the `title` will be `Not Found`.",
                      "example": "Not Found"
                    },
                    "detail": {
                      "type": "string",
                      "description": "A detailed human-readable description of the error that occurred.",
                      "example": "The resource does not exist"
                    },
                    "field": {
                      "type": "string",
                      "description": "If the error was caused by a value provided by you in a specific field, the `field` property will contain the name of the field that caused the issue.",
                      "example": "description"
                    },
                    "_links": {
                      "type": "object",
                      "required": [
                        "documentation"
                      ],
                      "properties": {
                        "documentation": {
                          "type": "object",
                          "description": "The URL to the generic Mollie API error handling guide.",
                          "required": [
                            "href",
                            "type"
                          ],
                          "properties": {
                            "href": {
                              "type": "string",
                              "example": "https://docs.mollie.com/errors"
                            },
                            "type": {
                              "type": "string",
                              "example": "text/html"
                            }
                          }
                        }
                      }
                    }
                  }
                },
                "example": {
                  "status": 404,
                  "title": "Not Found",
                  "detail": "No entity exists with token 'uct_abcDEFghij123456789'",
                  "_links": {
                    "documentation": {
                      "href": "...",
                      "type": "text/html"
                    }
                  }
                }
              }
            }
          }
        },
        "x-readme": {
          "code-samples": [
            {
              "language": "shell",
              "code": "curl -X GET https://api.mollie.com/v2/payments/tr_5B8cwPMGnU6qLbRvo7qEZo/captures/cpt_vytxeTZskVKR7C7WgdSP3d \\\n    -H \"Authorization: Bearer live_dHar4XY7LxsDOtmnkVtjNVWXLSlXsM\""
            },
            {
              "language": "php",
              "code": "<?php\nuse Mollie\\Api\\Http\\Requests\\GetPaymentCaptureRequest;\n\n$mollie = new \\Mollie\\Api\\MollieApiClient();\n$mollie->setApiKey(\"live_dHar4XY7LxsDOtmnkVtjNVWXLSlXsM\");\n\n$capture = $mollie->send(\n    new GetPaymentCaptureRequest(\n        paymentId: \"tr_5B8cwPMGnU6qLbRvo7qEZo\",\n        captureId: \"cpt_vytxeTZskVKR7C7WgdSP3d\"\n    )\n);",
              "install": "composer require mollie/mollie-api-php"
            },
            {
              "language": "node",
              "code": "const { createMollieClient } = require('@mollie/api-client');\nconst mollieClient = createMollieClient({ apiKey: 'live_dHar4XY7LxsDOtmnkVtjNVWXLSlXsM' });\n\nconst capture = await mollieClient.paymentCaptures.get('cpt_vytxeTZskVKR7C7WgdSP3d', {\n  paymentId: 'tr_5B8cwPMGnU6qLbRvo7qEZo'\n});",
              "install": "npm install @mollie/api-client"
            },
            {
              "language": "python",
              "code": "from mollie.api.client import Client\n\nmollie_client = Client()\nmollie_client.set_api_key(\"live_dHar4XY7LxsDOtmnkVtjNVWXLSlXsM\")\n\npayment = mollie_client.payments.get(\"tr_5B8cwPMGnU6qLbRvo7qEZo\")\ncapture = payment.captures.get(\"cpt_vytxeTZskVKR7C7WgdSP3d\")",
              "install": "pip install mollie-api-python"
            },
            {
              "language": "ruby",
              "code": "require 'mollie-api-ruby'\n\nMollie::Client.configure do |config|\n  config.api_key = 'live_dHar4XY7LxsDOtmnkVtjNVWXLSlXsM'\nend\n\ncapture = Mollie::Payment::Capture.get(\n  'cpt_vytxeTZskVKR7C7WgdSP3d',\n  payment_id: 'tr_5B8cwPMGnU6qLbRvo7qEZo'\n)",
              "install": "gem install mollie-api-ruby"
            }
          ]
        }
      }
    }
  },
  "components": {
    "securitySchemes": {
      "apiKey": {
        "type": "http",
        "scheme": "bearer",
        "x-default": "live_dHar4XY7LxsDOtmnkVtjNVWXLSlXsM"
      },
      "organizationAccessToken": {
        "type": "http",
        "scheme": "bearer",
        "x-default": "access_dHar4XY7LxsDOtmnkVtjNVWXLSlXsM"
      },
      "oAuth": {
        "type": "oauth2",
        "flows": {
          "authorizationCode": {
            "authorizationUrl": "https://my.mollie.com/oauth2/authorize",
            "tokenUrl": "https://api.mollie.com/oauth2/tokens",
            "scopes": {}
          }
        }
      }
    }
  },
  "x-readme": {
    "explorer-enabled": false,
    "samples-languages": [
      "shell",
      "php",
      "node",
      "python",
      "ruby"
    ]
  }
}
```