Sign in
Captures API

Get capture

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

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

Query parameters

embedstring nullable

This endpoint allows embedding related API items by appending the following values 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.

Headers

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

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

Response

The capture object.

Changes

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

  • 392e474e7edc1See the full diff
    • ○

      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

  • 18e0e58eb54d1See the full diff
    • ○

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

      response-property-deprecated

Of the 92 revisions, 9 have no diff computed.