v1

latestOpenAPI 3.1.0CC-BY-NC-SA-4.02026-07-2413803.8 MB

Captures API

Get capture

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

🔑 Access with

API key

Advanced access token with payments.read

OAuth access with payments.read

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

Query parameters

embed'payment'

Example:payment

This endpoint allows you to embed additional resources 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.

Response

The capture object.